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 710 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 1129 of file docnode.cpp.

1130 :
1132{
1133 p->relPath = parser->context.relPath;
1134}
QCString srcFile() const
Definition docnode.h:671
std::unique_ptr< Private > p
Definition docnode.h:688
int srcLine() const
Definition docnode.h:672
DocDiagramFileBase(DocParser *parser, DocNodeVariant *parent, const QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
Definition docnode.h:661
QCString context() const
Definition docnode.h:670
QCString name() const
Definition docnode.h:664
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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 1136 of file docnode.cpp.

1137{
1138 bool ok = false;
1140
1141 bool ambig = false;
1142 FileDef *fd = findFileDef(Doxygen::diaFileNameLinkedMap,p->name,ambig);
1143 if (fd==nullptr && !p->name.endsWith(".dia")) // try with .dia extension as well
1144 {
1145 fd = findFileDef(Doxygen::diaFileNameLinkedMap,p->name+".dia",ambig);
1146 }
1147 if (fd)
1148 {
1149 p->file = fd->absFilePath();
1150 ok = true;
1151 if (ambig)
1152 {
1153 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dia file name '%s' is ambiguous.\n"
1154 "Possible candidates:\n%s",qPrint(p->name),
1156 );
1157 }
1158 }
1159 else
1160 {
1161 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"included dia file '%s' is not found "
1162 "in any of the paths specified via DIAFILE_DIRS!",qPrint(p->name));
1163 }
1164 return ok;
1165}
DocNodeList & children()
Definition docnode.h:142
DocNodeVariant * thisVariant()
Definition docnode.h:92
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:74
const char * qPrint(const char *s)
Definition qcstring.h:661
QCString showFileDefMatches(const FileNameLinkedMap *fnMap, const QCString &n)
Definition util.cpp:3388
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
Definition util.cpp:3262

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


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