Doxygen
Loading...
Searching...
No Matches
DocDiaFile Class Reference

Node representing a dia file. More...

#include <src/docnode.h>

Inheritance diagram for DocDiaFile:
Collaboration diagram for DocDiaFile:

Public Member Functions

 DocDiaFile (DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
bool parse ()
Public Member Functions inherited from DocDiagramFileBase
 DocDiagramFileBase (DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
QCString name () const
QCString file () const
QCString relPath () const
bool hasCaption () const
QCString width () const
QCString height () const
QCString context () const
QCString srcFile () const
int srcLine () const
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
Protected Attributes inherited from DocDiagramFileBase
std::unique_ptr< Privatep

Detailed Description

Node representing a dia file.

Definition at line 730 of file docnode.h.

Constructor & Destructor Documentation

◆ DocDiaFile()

DocDiaFile::DocDiaFile ( DocParser * parser,
DocNodeVariant * parent,
const QCString & name,
const QCString & context,
const QCString & srcFile,
int srcLine )

Definition at line 1180 of file docnode.cpp.

1181 :
1183{
1184 p->relPath = parser->context.relPath;
1185}
QCString srcFile() const
Definition docnode.h:691
std::unique_ptr< Private > p
Definition docnode.h:708
int srcLine() const
Definition docnode.h:692
DocDiagramFileBase(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Definition docnode.h:681
QCString context() const
Definition docnode.h:690
QCString name() const
Definition docnode.h:684
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

References DocDiagramFileBase::context(), DocDiagramFileBase::DocDiagramFileBase(), DocDiagramFileBase::name(), DocDiagramFileBase::p, parent(), DocNode::parser(), DocDiagramFileBase::srcFile(), and DocDiagramFileBase::srcLine().

Member Function Documentation

◆ parse()

bool DocDiaFile::parse ( )

Definition at line 1187 of file docnode.cpp.

1188{
1189 bool ok = false;
1191
1192 bool ambig = false;
1193 FileDef *fd = findFileDef(Doxygen::diaFileNameLinkedMap,p->name,ambig);
1194 if (fd==nullptr && !p->name.endsWith(".dia")) // try with .dia extension as well
1195 {
1196 fd = findFileDef(Doxygen::diaFileNameLinkedMap,p->name+".dia",ambig);
1197 }
1198 if (fd)
1199 {
1200 p->file = fd->absFilePath();
1201 ok = true;
1202 if (ambig)
1203 {
1204 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dia file name '{}' is ambiguous.\n"
1205 "Possible candidates:\n{}",p->name,
1207 );
1208 }
1209 }
1210 else
1211 {
1212 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dia file '{}' is not found "
1213 "in any of the paths specified via DIAFILE_DIRS!",p->name);
1214 }
1215 return ok;
1216}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void defaultHandleTitleAndSize(const CommandType cmd, DocNodeVariant *parent, DocNodeList &children, QCString &width, QCString &height)
static FileNameLinkedMap * diaFileNameLinkedMap
Definition doxygen.h:109
virtual QCString absFilePath() const =0
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
QCString showFileDefMatches(const FileNameLinkedMap *fnMap, const QCString &n)
Definition util.cpp:3545
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
Definition util.cpp:3417

References FileDef::absFilePath(), DocCompoundNode::children(), CMD_DIAFILE, DocDiagramFileBase::context(), DocParser::defaultHandleTitleAndSize(), Doxygen::diaFileNameLinkedMap, findFileDef(), DocDiagramFileBase::p, DocNode::parser(), showFileDefMatches(), DocNode::thisVariant(), and warn_doc_error.


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