The DocIncOperator Class Reference

Node representing a include/dontinclude operator block. More...

Declaration

class DocIncOperator { ... }

Included Headers

#include <src/docnode.h>

Base class

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

Enumerations Index

enum	Type { ... }

Public Constructors Index

	DocIncOperator (DocParser *parser, DocNodeVariant *parent, Type t, const QCString &pat, const QCString &context, bool stripCodeComments, bool isExample, const QCString &exampleFile)

Public Member Functions Index

Type	type () const
const char *	typeAsString () const
int	line () const
bool	showLineNo () const
QCString	text () const
QCString	pattern () const
QCString	context () const
bool	isFirst () const
bool	isLast () const
void	markFirst (bool v=TRUE)
void	markLast (bool v=TRUE)
bool	stripCodeComments () const
bool	isExample () const
QCString	exampleFile () const
QCString	includeFileName () const
void	parse ()

Private Member Attributes Index

Type	m_type = Line
int	m_line = 0
bool	m_showLineNo = false
QCString	m_text
QCString	m_pattern
QCString	m_context
bool	m_isFirst = false
bool	m_isLast = false
bool	m_stripCodeComments = true
bool	m_isExample = false
QCString	m_exampleFile
QCString	m_includeFileName

Description

Node representing a include/dontinclude operator block.

Definition at line 476 of file docnode.h.

Enumerations

Type

enum DocIncOperator::Type

Enumeration values

Line
SkipLine
Skip
Until

Definition at line 479 of file docnode.h.

479 enum Type { Line, SkipLine, Skip, Until };

Public Constructors

DocIncOperator()

DocIncOperator::DocIncOperator (DocParser * parser, DocNodeVariant * parent, Type t, const QCString & pat, const QCString & context, bool stripCodeComments, bool isExample, const QCString & exampleFile)

inline

Definition at line 480 of file docnode.h.

480 DocIncOperator(DocParser *parser,DocNodeVariant *parent,Type t,const QCString &pat,

481 const QCString &context,bool stripCodeComments,bool isExample,const QCString &exampleFile)

482 : DocNode(parser,parent), m_type(t), m_pattern(pat), m_context(context),

483 m_isFirst(FALSE), m_isLast(FALSE), m_stripCodeComments(stripCodeComments),

484 m_isExample(isExample), m_exampleFile(exampleFile) {}

References context, DocNode::DocNode, exampleFile, FALSE, isExample, m_context, m_exampleFile, m_isExample, m_isFirst, m_isLast, m_pattern, m_stripCodeComments, m_type, DocNode::parent, DocNode::parser and stripCodeComments.

Public Member Functions

context()

QCString DocIncOperator::context ()

inline

Definition at line 501 of file docnode.h.

501 QCString context() const { return m_context; }

Reference m_context.

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

exampleFile()

QCString DocIncOperator::exampleFile ()

inline

Definition at line 508 of file docnode.h.

508 QCString exampleFile() const { return m_exampleFile; }

Reference m_exampleFile.

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

includeFileName()

QCString DocIncOperator::includeFileName ()

inline

Definition at line 509 of file docnode.h.

509 QCString includeFileName() const { return m_includeFileName; }

Reference m_includeFileName.

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

isExample()

bool DocIncOperator::isExample ()

inline

Definition at line 507 of file docnode.h.

507 bool isExample() const { return m_isExample; }

Reference m_isExample.

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

isFirst()

bool DocIncOperator::isFirst ()

inline

Definition at line 502 of file docnode.h.

502 bool isFirst() const { return m_isFirst; }

Reference m_isFirst.

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

isLast()

bool DocIncOperator::isLast ()

inline

Definition at line 503 of file docnode.h.

503 bool isLast() const { return m_isLast; }

Reference m_isLast.

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

line()

int DocIncOperator::line ()

inline

Definition at line 497 of file docnode.h.

497 int line() const { return m_line; }

Reference m_line.

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

markFirst()

void DocIncOperator::markFirst (bool v=TRUE)

inline

Definition at line 504 of file docnode.h.

504 void markFirst(bool v=TRUE) { m_isFirst = v; }

References m_isFirst and TRUE.

markLast()

void DocIncOperator::markLast (bool v=TRUE)

inline

Definition at line 505 of file docnode.h.

505 void markLast(bool v=TRUE) { m_isLast = v; }

References m_isLast and TRUE.

Referenced by DocPara::handleIncludeOperator.

parse()

void DocIncOperator::parse ()

Declaration at line 510 of file docnode.h, definition at line 319 of file docnode.cpp.

319void DocIncOperator::parse()

320{

321 if (parser()->context.includeFileName.isEmpty())

322 {

323 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),

324 "No previous '\\include' or '\\dontinclude' command for '\\{}' present",

325 typeAsString());

326 }

327 bool found = false;

328

329 m_includeFileName = parser()->context.includeFileName;

330 const char *p = parser()->context.includeFileText.data();

331 size_t l = parser()->context.includeFileLength;

332 size_t o = parser()->context.includeFileOffset;

333 int il = parser()->context.includeFileLine;

334 AUTO_TRACE("text={} off={} len={}",Trace::trunc(p),o,l);

335 size_t so = o, bo = 0;

336 bool nonEmpty = FALSE;

337 switch(type())

338 {

339 case Line:

340 while (o<l)

341 {

342 char c = p[o];

343 if (c=='\n')

344 {

345 parser()->context.includeFileLine++;

346 if (nonEmpty) break; // we have a pattern to match

347 so=o+1; // no pattern, skip empty line

348 }

349 else if (!isspace(static_cast<uint8_t>(c))) // no white space char

350 {

351 nonEmpty=TRUE;

352 }

353 o++;

354 }

355 if (parser()->context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)

356 {

357 m_line = il;

358 m_text = parser()->context.includeFileText.mid(so,o-so);

359 found = true;

360 AUTO_TRACE_ADD("\\line {}",Trace::trunc(m_text));

361 }

362 parser()->context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line

363 m_showLineNo = parser()->context.includeFileShowLineNo;

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

365 break;

366 case SkipLine:

367 while (o<l)

368 {

369 so=o;

370 while (o<l)

371 {

372 char c = p[o];

373 if (c=='\n')

374 {

375 parser()->context.includeFileLine++;

376 if (nonEmpty) break; // we have a pattern to match

377 so=o+1; // no pattern, skip empty line

378 }

379 else if (!isspace(static_cast<uint8_t>(c))) // no white space char

380 {

381 nonEmpty=TRUE;

382 }

383 o++;

384 }

385 if (parser()->context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)

386 {

387 m_line = il;

388 m_text = parser()->context.includeFileText.mid(so,o-so);

389 found = true;

390 AUTO_TRACE_ADD("\\skipline {}",Trace::trunc(m_text));

391 break;

392 }

393 o++; // skip new line

394 }

395 parser()->context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line

396 m_showLineNo = parser()->context.includeFileShowLineNo;

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

398 break;

399 case Skip:

400 while (o<l)

401 {

402 so=o;

403 while (o<l)

404 {

405 char c = p[o];

406 if (c=='\n')

407 {

408 parser()->context.includeFileLine++;

409 if (nonEmpty) break; // we have a pattern to match

410 so=o+1; // no pattern, skip empty line

411 }

412 else if (!isspace(static_cast<uint8_t>(c))) // no white space char

413 {

414 nonEmpty=TRUE;

415 }

416 o++;

417 }

418 if (parser()->context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)

419 {

420 found = true;

421 break;

422 }

423 o++; // skip new line

424 }

425 parser()->context.includeFileOffset = so; // set pointer to start of new line

426 m_showLineNo = parser()->context.includeFileShowLineNo;

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

428 break;

429 case Until:

430 bo=o;

431 while (o<l)

432 {

433 so=o;

434 while (o<l)

435 {

436 char c = p[o];

437 if (c=='\n')

438 {

439 parser()->context.includeFileLine++;

440 if (nonEmpty) break; // we have a pattern to match

441 so=o+1; // no pattern, skip empty line

442 }

443 else if (!isspace(static_cast<uint8_t>(c))) // no white space char

444 {

445 nonEmpty=TRUE;

446 }

447 o++;

448 }

449 if (parser()->context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)

450 {

451 m_line = il;

452 m_text = parser()->context.includeFileText.mid(bo,o-bo);

453 found = true;

454 AUTO_TRACE_ADD("\\until {}",Trace::trunc(m_text));

455 break;

456 }

457 o++; // skip new line

458 }

459 parser()->context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line

460 m_showLineNo = parser()->context.includeFileShowLineNo;

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

462 break;

463 }

464 if (!found)

465 {

466 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),

467 "referenced pattern '{}' for command '\\{}' not found",m_pattern,typeAsString());

468 }

469}

References AUTO_TRACE, AUTO_TRACE_ADD, context, DocParser::context, QCString::data, FALSE, DocParserContext::includeFileLength, DocParserContext::includeFileLine, DocParserContext::includeFileName, DocParserContext::includeFileOffset, DocParserContext::includeFileShowLineNo, DocParserContext::includeFileText, Line, m_includeFileName, m_line, m_pattern, m_showLineNo, m_stripCodeComments, m_text, QCString::mid, DocNode::parser, Skip, SkipLine, DocParserContext::stripCodeComments, TRUE, Trace::trunc, type, typeAsString, Until and warn_doc_error.

pattern()

QCString DocIncOperator::pattern ()

inline

Definition at line 500 of file docnode.h.

500 QCString pattern() const { return m_pattern; }

Reference m_pattern.

Referenced by PrintDocVisitor::operator().

showLineNo()

bool DocIncOperator::showLineNo ()

inline

Definition at line 498 of file docnode.h.

498 bool showLineNo() const { return m_showLineNo; }

Reference m_showLineNo.

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

stripCodeComments()

bool DocIncOperator::stripCodeComments ()

inline

Definition at line 506 of file docnode.h.

506 bool stripCodeComments() const { return m_stripCodeComments; }

Reference m_stripCodeComments.

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

text()

QCString DocIncOperator::text ()

inline

Definition at line 499 of file docnode.h.

499 QCString text() const { return m_text; }

Reference m_text.

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

type()

Type DocIncOperator::type ()

inline

Definition at line 485 of file docnode.h.

485 Type type() const { return m_type; }

Reference m_type.

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

typeAsString()

const char * DocIncOperator::typeAsString ()

inline

Definition at line 486 of file docnode.h.

486 const char *typeAsString() const

487 {

488 switch(m_type)

489 {

490 case Line: return "line";

491 case SkipLine: return "skipline";

492 case Skip: return "skip";

493 case Until: return "until";

494 }

495 return "";

496 }

References Line, m_type, Skip, SkipLine and Until.

Referenced by parse.

Private Member Attributes

m_context

QCString DocIncOperator::m_context

Definition at line 518 of file docnode.h.

518 QCString m_context;

Referenced by context and DocIncOperator.

m_exampleFile

QCString DocIncOperator::m_exampleFile

Definition at line 523 of file docnode.h.

523 QCString m_exampleFile;

Referenced by DocIncOperator and exampleFile.

m_includeFileName

QCString DocIncOperator::m_includeFileName

Definition at line 524 of file docnode.h.

524 QCString m_includeFileName;

Referenced by includeFileName and parse.

m_isExample

bool DocIncOperator::m_isExample = false

Definition at line 522 of file docnode.h.

522 bool m_isExample = false;

Referenced by DocIncOperator and isExample.

m_isFirst

bool DocIncOperator::m_isFirst = false

Definition at line 519 of file docnode.h.

519 bool m_isFirst = false;

Referenced by DocIncOperator, isFirst and markFirst.

m_isLast

bool DocIncOperator::m_isLast = false

Definition at line 520 of file docnode.h.

520 bool m_isLast = false;

Referenced by DocIncOperator, isLast and markLast.

m_line

int DocIncOperator::m_line = 0

Definition at line 514 of file docnode.h.

514 int m_line = 0;

Referenced by line and parse.

m_pattern

QCString DocIncOperator::m_pattern

Definition at line 517 of file docnode.h.

517 QCString m_pattern;

Referenced by DocIncOperator, parse and pattern.

m_showLineNo

bool DocIncOperator::m_showLineNo = false

Definition at line 515 of file docnode.h.

515 bool m_showLineNo = false;

Referenced by parse and showLineNo.

m_stripCodeComments

bool DocIncOperator::m_stripCodeComments = true

Definition at line 521 of file docnode.h.

521 bool m_stripCodeComments = true;

Referenced by DocIncOperator, parse and stripCodeComments.

m_text

QCString DocIncOperator::m_text

Definition at line 516 of file docnode.h.

516 QCString m_text;

Referenced by parse and text.

m_type

Type DocIncOperator::m_type = Line

Definition at line 513 of file docnode.h.

513 Type m_type = Line;

Referenced by DocIncOperator, type and typeAsString.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.