DocInclude Class Reference

Node representing an included text block from file. More...

#include <src/docnode.h>

Inheritance diagram for DocInclude:

Collaboration diagram for DocInclude:

Public Types
enum	Type {   Include , DontInclude , VerbInclude , HtmlInclude ,   LatexInclude , IncWithLines , Snippet , SnippetWithLines ,   DontIncWithLines , RtfInclude , ManInclude , DocbookInclude ,   XmlInclude }

Public Member Functions
	DocInclude (DocParser *parser, DocNodeVariant *parent, const DString &file, const DString &context, Type t, bool stripCodeComments, bool isExample, const DString &exampleFile, const DString &blockId, bool isBlock, bool trimLeft)
DString	file () const
DString	extension () const
Type	type () const
DString	text () const
DString	context () const
DString	blockId () const
bool	stripCodeComments () const
bool	isExample () const
DString	exampleFile () const
bool	isBlock () const
bool	trimLeft () const
void	parse ()
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Private Attributes
DString	m_file
DString	m_context
DString	m_text
Type	m_type
bool	m_stripCodeComments
bool	m_isExample
bool	m_isBlock
bool	m_trimLeft
DString	m_exampleFile
DString	m_blockId

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType {   Unknown , Anchor , Section , Table ,   Requirement }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing an included text block from file.

Definition at line 434 of file docnode.h.

Member Enumeration Documentation

Type

enum DocInclude::Type

Enumerator
Include
DontInclude
VerbInclude
HtmlInclude
LatexInclude
IncWithLines
Snippet
SnippetWithLines
DontIncWithLines
RtfInclude
ManInclude
DocbookInclude
XmlInclude

Definition at line 437 of file docnode.h.

            { Include, DontInclude, VerbInclude, HtmlInclude, LatexInclude,
              IncWithLines, Snippet , SnippetWithLines,
              DontIncWithLines, RtfInclude, ManInclude, DocbookInclude, XmlInclude
            };

Constructor & Destructor Documentation

DocInclude()

DocInclude::DocInclude ( DocParser * parser, DocNodeVariant * parent, const DString & file, const DString & context, Type t, bool stripCodeComments, bool isExample, const DString & exampleFile, const DString & blockId, bool isBlock, bool trimLeft )

inline

Definition at line 441 of file docnode.h.

    : DocNode(parser,parent), m_file(file), m_context(context), m_type(t),
      m_stripCodeComments(stripCodeComments),
      m_isExample(isExample), m_isBlock(isBlock), m_trimLeft(trimLeft),
      m_exampleFile(exampleFile), m_blockId(blockId) {}

References blockId(), context(), DocNode::DocNode(), exampleFile(), file(), isBlock(), isExample(), m_blockId, m_context, m_exampleFile, m_file, m_isBlock, m_isExample, m_stripCodeComments, m_trimLeft, m_type, DocNode::parent(), DocNode::parser(), stripCodeComments(), and trimLeft().

Member Function Documentation

blockId()

DString DocInclude::blockId ( ) const

inline

Definition at line 454 of file docnode.h.

{ return m_blockId; }

References m_blockId.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

context()

DString DocInclude::context ( ) const

inline

Definition at line 453 of file docnode.h.

{ return m_context; }

References m_context.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), XmlDocVisitor::operator()(), and parse().

exampleFile()

DString DocInclude::exampleFile ( ) const

inline

Definition at line 457 of file docnode.h.

{ return m_exampleFile; }

References m_exampleFile.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

extension()

DString DocInclude::extension ( ) const

inline

Definition at line 450 of file docnode.h.

{ size_t i=m_file.rfind('.'); return i!=DString::npos ? m_file.mid(i) : DString(); }

References DString::DString(), m_file, DString::mid(), DString::npos, and DString::rfind().

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

file()

DString DocInclude::file ( ) const

inline

Definition at line 449 of file docnode.h.

{ return m_file; }

References m_file.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

isBlock()

bool DocInclude::isBlock ( ) const

inline

Definition at line 458 of file docnode.h.

{ return m_isBlock; }

References m_isBlock.

Referenced by DocInclude(), HtmlDocVisitor::operator()(), PrintDocVisitor::operator()(), and XmlDocVisitor::operator()().

isExample()

bool DocInclude::isExample ( ) const

inline

Definition at line 456 of file docnode.h.

{ return m_isExample; }

References m_isExample.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

parse()

void DocInclude::parse

(

)

Definition at line 272 of file docnode.cpp.

{
  AUTO_TRACE("file={} text={}",m_file,Trace::trunc(m_text));
  switch(m_type)
  {
    case DontIncWithLines:
      // fall through
    case IncWithLines:
      // fall through
    case Include:
      // fall through
    case DontInclude:
      parser()->readTextFileByName(m_file,m_text);
      parser()->context.includeFileName   = m_file;
      parser()->context.includeFileText   = m_text;
      parser()->context.includeFileOffset = 0;
      parser()->context.includeFileLength = m_text.length();
      parser()->context.includeFileLine   = 0;
      parser()->context.includeFileShowLineNo = (m_type == DontIncWithLines || m_type == IncWithLines);
      parser()->context.stripCodeComments = m_stripCodeComments;
      //printf("parser->context.includeFile=<<%s>>\n",qPrint(parser->context.includeFileText));
      break;
    case VerbInclude:
      // fall through
    case HtmlInclude:
    case LatexInclude:
    case DocInclude::RtfInclude:
    case DocInclude::ManInclude:
    case DocInclude::XmlInclude:
    case DocInclude::DocbookInclude:
      parser()->readTextFileByName(m_file,m_text);
      break;
    case Snippet:
    case SnippetWithLines:
      parser()->readTextFileByName(m_file,m_text);
      // check here for the existence of the blockId inside the file, so we
      // only generate the warning once.
      int count = 0;
      if (!m_blockId.empty() && (count=m_text.contains(m_blockId.data()))!=2)
      {
        warn_doc_error(parser()->context.fileName,
                       parser()->tokenizer.getLineNr(),
                       "block marked with {} for \\snippet should appear twice in file {}, found it {:d} times",
                       m_blockId,m_file,count);
      }
      break;
  }
}

References AUTO_TRACE, DString::contains(), context(), DocParser::context, DString::data(), DocbookInclude, DontInclude, DontIncWithLines, DString::empty(), HtmlInclude, Include, DocParserContext::includeFileLength, DocParserContext::includeFileLine, DocParserContext::includeFileName, DocParserContext::includeFileOffset, DocParserContext::includeFileShowLineNo, DocParserContext::includeFileText, IncWithLines, LatexInclude, DString::length(), m_blockId, m_file, m_stripCodeComments, m_text, m_type, ManInclude, DocNode::parser(), DocParser::readTextFileByName(), RtfInclude, Snippet, SnippetWithLines, DocParserContext::stripCodeComments, Trace::trunc(), VerbInclude, warn_doc_error, and XmlInclude.

stripCodeComments()

bool DocInclude::stripCodeComments ( ) const

inline

Definition at line 455 of file docnode.h.

{ return m_stripCodeComments; }

References m_stripCodeComments.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

text()

DString DocInclude::text ( ) const

inline

Definition at line 452 of file docnode.h.

{ return m_text; }

References m_text.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

trimLeft()

bool DocInclude::trimLeft ( ) const

inline

Definition at line 459 of file docnode.h.

{ return m_trimLeft; }

References m_trimLeft.

Referenced by DocInclude(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

type()

Type DocInclude::type ( ) const

inline

Definition at line 451 of file docnode.h.

{ return m_type; }

References m_type.

Referenced by isDocIncludeVisible(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

Member Data Documentation

m_blockId

DString DocInclude::m_blockId

private

Definition at line 472 of file docnode.h.

Referenced by blockId(), DocInclude(), and parse().

m_context

DString DocInclude::m_context

private

Definition at line 464 of file docnode.h.

Referenced by context(), and DocInclude().

m_exampleFile

DString DocInclude::m_exampleFile

private

Definition at line 471 of file docnode.h.

Referenced by DocInclude(), and exampleFile().

m_file

DString DocInclude::m_file

private

Definition at line 463 of file docnode.h.

Referenced by DocInclude(), extension(), file(), and parse().

m_isBlock

bool DocInclude::m_isBlock

private

Definition at line 469 of file docnode.h.

Referenced by DocInclude(), and isBlock().

m_isExample

bool DocInclude::m_isExample

private

Definition at line 468 of file docnode.h.

Referenced by DocInclude(), and isExample().

m_stripCodeComments

bool DocInclude::m_stripCodeComments

private

Definition at line 467 of file docnode.h.

Referenced by DocInclude(), parse(), and stripCodeComments().

m_text

DString DocInclude::m_text

private

Definition at line 465 of file docnode.h.

Referenced by parse(), and text().

m_trimLeft

bool DocInclude::m_trimLeft

private

Definition at line 470 of file docnode.h.

Referenced by DocInclude(), and trimLeft().

m_type

Type DocInclude::m_type

private

Definition at line 466 of file docnode.h.

Referenced by DocInclude(), parse(), and type().

---

The documentation for this class was generated from the following files:

• src/docnode.h
• src/docnode.cpp