The DocInclude Class Reference

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

Declaration

class DocInclude { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocNode
	Abstract node interface with type information. More...

Enumerations Index

enum	Type { ... }

Public Constructors Index

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

Public Member Functions Index

QCString	file () const
QCString	extension () const
Type	type () const
QCString	text () const
QCString	context () const
QCString	blockId () const
bool	stripCodeComments () const
bool	isExample () const
QCString	exampleFile () const
bool	isBlock () const
bool	trimLeft () const
void	parse ()

Private Member Attributes Index

QCString	m_file
QCString	m_context
QCString	m_text
Type	m_type
bool	m_stripCodeComments
bool	m_isExample
bool	m_isBlock
bool	m_trimLeft
QCString	m_exampleFile
QCString	m_blockId

Description

Node representing an included text block from file.

Definition at line 434 of file docnode.h.

Enumerations

Type

enum DocInclude::Type

Enumeration values

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

Definition at line 437 of file docnode.h.

437 enum Type { Include, DontInclude, VerbInclude, HtmlInclude, LatexInclude,

438 IncWithLines, Snippet , SnippetWithLines,

439 DontIncWithLines, RtfInclude, ManInclude, DocbookInclude, XmlInclude

440 };

Public Constructors

DocInclude()

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

inline

Definition at line 441 of file docnode.h.

441 DocInclude(DocParser *parser,DocNodeVariant *parent,const QCString &file,

442 const QCString &context, Type t, bool stripCodeComments,

443 bool isExample,const QCString &exampleFile,

444 const QCString &blockId, bool isBlock, bool trimLeft)

445 : DocNode(parser,parent), m_file(file), m_context(context), m_type(t),

446 m_stripCodeComments(stripCodeComments),

447 m_isExample(isExample), m_isBlock(isBlock), m_trimLeft(trimLeft),

448 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.

Public Member Functions

blockId()

QCString DocInclude::blockId ()

inline

Definition at line 454 of file docnode.h.

454 QCString blockId() const { return m_blockId; }

Reference m_blockId.

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

context()

QCString DocInclude::context ()

inline

Definition at line 453 of file docnode.h.

453 QCString context() const { return m_context; }

Reference m_context.

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

exampleFile()

QCString DocInclude::exampleFile ()

inline

Definition at line 457 of file docnode.h.

457 QCString exampleFile() const { return m_exampleFile; }

Reference m_exampleFile.

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

extension()

QCString DocInclude::extension ()

inline

Definition at line 450 of file docnode.h.

450 QCString extension() const { int i=m_file.findRev('.'); return i!=-1 ? m_file.mid(i) : QCString(); }

Reference m_file.

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

file()

QCString DocInclude::file ()

inline

Definition at line 449 of file docnode.h.

449 QCString file() const { return m_file; }

Reference m_file.

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

isBlock()

bool DocInclude::isBlock ()

inline

Definition at line 458 of file docnode.h.

458 bool isBlock() const { return m_isBlock; }

Reference m_isBlock.

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

isExample()

bool DocInclude::isExample ()

inline

Definition at line 456 of file docnode.h.

456 bool isExample() const { return m_isExample; }

Reference m_isExample.

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

parse()

void DocInclude::parse ()

Declaration at line 460 of file docnode.h, definition at line 268 of file docnode.cpp.

268void DocInclude::parse()

269{

270 AUTO_TRACE("file={} text={}",m_file,Trace::trunc(m_text));

271 switch(m_type)

272 {

273 case DontIncWithLines:

274 // fall through

275 case IncWithLines:

276 // fall through

277 case Include:

278 // fall through

279 case DontInclude:

280 parser()->readTextFileByName(m_file,m_text);

281 parser()->context.includeFileName = m_file;

282 parser()->context.includeFileText = m_text;

283 parser()->context.includeFileOffset = 0;

284 parser()->context.includeFileLength = m_text.length();

285 parser()->context.includeFileLine = 0;

286 parser()->context.includeFileShowLineNo = (m_type == DontIncWithLines || m_type == IncWithLines);

287 parser()->context.stripCodeComments = m_stripCodeComments;

288 //printf("parser->context.includeFile=<<%s>>\n",qPrint(parser->context.includeFileText));

289 break;

290 case VerbInclude:

291 // fall through

292 case HtmlInclude:

293 case LatexInclude:

294 case DocInclude::RtfInclude:

295 case DocInclude::ManInclude:

296 case DocInclude::XmlInclude:

297 case DocInclude::DocbookInclude:

298 parser()->readTextFileByName(m_file,m_text);

299 break;

300 case Snippet:

301 case SnippetWithLines:

302 parser()->readTextFileByName(m_file,m_text);

303 // check here for the existence of the blockId inside the file, so we

304 // only generate the warning once.

305 int count = 0;

306 if (!m_blockId.isEmpty() && (count=m_text.contains(m_blockId.data()))!=2)

307 {

308 warn_doc_error(parser()->context.fileName,

309 parser()->tokenizer.getLineNr(),

310 "block marked with {} for \\snippet should appear twice in file {}, found it {:d} times",

311 m_blockId,m_file,count);

312 }

313 break;

314 }

315}

References AUTO_TRACE, context, DocParser::context, DocbookInclude, DontInclude, DontIncWithLines, HtmlInclude, Include, DocParserContext::includeFileLength, DocParserContext::includeFileLine, DocParserContext::includeFileName, DocParserContext::includeFileOffset, DocParserContext::includeFileShowLineNo, DocParserContext::includeFileText, IncWithLines, LatexInclude, 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 ()

inline

Definition at line 455 of file docnode.h.

455 bool stripCodeComments() const { return m_stripCodeComments; }

Reference m_stripCodeComments.

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

text()

QCString DocInclude::text ()

inline

Definition at line 452 of file docnode.h.

452 QCString text() const { return m_text; }

Reference m_text.

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

trimLeft()

bool DocInclude::trimLeft ()

inline

Definition at line 459 of file docnode.h.

459 bool trimLeft() const { return m_trimLeft; }

Reference m_trimLeft.

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

type()

Type DocInclude::type ()

inline

Definition at line 451 of file docnode.h.

451 Type type() const { return m_type; }

Reference m_type.

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

Private Member Attributes

m_blockId

QCString DocInclude::m_blockId

Definition at line 472 of file docnode.h.

472 QCString m_blockId;

Referenced by blockId, DocInclude and parse.

m_context

QCString DocInclude::m_context

Definition at line 464 of file docnode.h.

464 QCString m_context;

Referenced by context and DocInclude.

m_exampleFile

QCString DocInclude::m_exampleFile

Definition at line 471 of file docnode.h.

471 QCString m_exampleFile;

Referenced by DocInclude and exampleFile.

m_file

QCString DocInclude::m_file

Definition at line 463 of file docnode.h.

463 QCString m_file;

Referenced by DocInclude, extension, file and parse.

m_isBlock

bool DocInclude::m_isBlock

Definition at line 469 of file docnode.h.

469 bool m_isBlock;

Referenced by DocInclude and isBlock.

m_isExample

bool DocInclude::m_isExample

Definition at line 468 of file docnode.h.

468 bool m_isExample;

Referenced by DocInclude and isExample.

m_stripCodeComments

bool DocInclude::m_stripCodeComments

Definition at line 467 of file docnode.h.

467 bool m_stripCodeComments;

Referenced by DocInclude, parse and stripCodeComments.

m_text

QCString DocInclude::m_text

Definition at line 465 of file docnode.h.

465 QCString m_text;

Referenced by parse and text.

m_trimLeft

bool DocInclude::m_trimLeft

Definition at line 470 of file docnode.h.

470 bool m_trimLeft;

Referenced by DocInclude and trimLeft.

m_type

Type DocInclude::m_type

Definition at line 466 of file docnode.h.

466 Type m_type;

Referenced by DocInclude, parse and type.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.