The filedef.h File Reference

Included Headers

#include <memory> #include <unordered_set> #include "definition.h" #include "memberlist.h" #include "containers.h"

Classes Index

struct	IncludeInfo
	Class representing the data associated with a #include statement. More...
class	IncludeInfoList
class	FileDef
	A model of a file symbol. More...
class	FileList
struct	FilesInDir

Typedefs Index

using	FileDefSet = std::unordered_set< const FileDef * >

Enumerations Index

enum class	IncludeKind : uint32_t { ... }

Operators Index

constexpr uint32_t	operator| (IncludeKind a, IncludeKind b)
constexpr uint32_t	operator| (uint32_t a, IncludeKind b)
constexpr uint32_t	operator& (IncludeKind a, uint32_t mask)

Functions Index

QCString	includeStatement (SrcLangExt lang, IncludeKind kind)
QCString	includeOpen (SrcLangExt lang, IncludeKind kind)
QCString	includeClose (SrcLangExt lang, IncludeKind kind)
bool	compareFileDefs (const FileDef *fd1, const FileDef *fd2)
std::unique_ptr< FileDef >	createFileDef (const QCString &p, const QCString &n, const QCString &ref=QCString(), const QCString &dn=QCString())
FileDef *	toFileDef (Definition *d)
const FileDef *	toFileDef (const Definition *d)

Variables Index

constexpr uint32_t	IncludeKind_LocalMask = IncludeKind::IncludeLocal | IncludeKind::ImportLocalObjC | IncludeKind::ImportLocal
constexpr uint32_t	IncludeKind_SystemMask = IncludeKind::IncludeSystem | IncludeKind::ImportSystemObjC | IncludeKind::ImportSystem
constexpr uint32_t	IncludeKind_ImportMask = ...
constexpr uint32_t	IncludeKind_ObjCMask = IncludeKind::ImportSystemObjC | IncludeKind::ImportLocalObjC

Typedefs

FileDefSet

using FileDefSet = std::unordered_set<const FileDef*>

Definition at line 44 of file filedef.h.

44using FileDefSet = std::unordered_set<const FileDef*>;

Enumerations

IncludeKind

enum class IncludeKind : uint32_t

strong

Enumeration values

IncludeSystem	(= 0x0001)
IncludeLocal	(= 0x0002)
ImportSystemObjC	(= 0x0004)
ImportLocalObjC	(= 0x0008)
ImportSystem	(= 0x0010)
ImportLocal	(= 0x0020)
ImportModule	(= 0x0040)

Definition at line 46 of file filedef.h.

47{

48 // bits

49 IncludeSystem = 0x0001,

50 IncludeLocal = 0x0002,

51 ImportSystemObjC = 0x0004,

52 ImportLocalObjC = 0x0008,

53 ImportSystem = 0x0010, // C++20 header import

54 ImportLocal = 0x0020, // C++20 header import

55 ImportModule = 64 // C++20/Java module import

56};

Operators

operator&()

uint32_t operator& (IncludeKind a, uint32_t mask)

inline constexpr

Definition at line 60 of file filedef.h.

60inline constexpr uint32_t operator&(IncludeKind a, uint32_t mask) { return static_cast<uint32_t>(a) & mask; }

operator|()

uint32_t operator| (IncludeKind a, IncludeKind b)

inline constexpr

Definition at line 58 of file filedef.h.

58inline constexpr uint32_t operator|(IncludeKind a, IncludeKind b) { return static_cast<uint32_t>(a) | static_cast<uint32_t>(b); }

operator|()

uint32_t operator| (uint32_t a, IncludeKind b)

inline constexpr

Definition at line 59 of file filedef.h.

59inline constexpr uint32_t operator|(uint32_t a, IncludeKind b) { return a | static_cast<uint32_t>(b); }

Functions

compareFileDefs()

bool compareFileDefs (const FileDef * fd1, const FileDef * fd2)

Declaration at line 88 of file filedef.h, definition at line 1925 of file filedef.cpp.

1925bool compareFileDefs(const FileDef *fd1, const FileDef *fd2)

1926{

1927 return qstricmp_sort(fd1->name(),fd2->name()) < 0;

1928}

References Definition::name and qstricmp_sort.

Referenced by DirDefImpl::sort and writeFileIndex.

createFileDef()

std::unique_ptr< FileDef > createFileDef (const QCString & p, const QCString & n, const QCString & ref=QCString(), const QCString & dn=QCString())

Declaration at line 212 of file filedef.h, definition at line 268 of file filedef.cpp.

268std::unique_ptr<FileDef> createFileDef(const QCString &p,const QCString &n,const QCString &ref,const QCString &dn)

269{

270 return std::make_unique<FileDefImpl>(p,n,ref,dn);

271}

Referenced by anonymous{tagreader.cpp}::TagFileParser::buildLists, DocbookDocVisitor::operator(), DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), LatexDocVisitor::operator(), ManDocVisitor::operator(), ManDocVisitor::operator(), RTFDocVisitor::operator(), RTFDocVisitor::operator(), XmlDocVisitor::operator(), XmlDocVisitor::operator(), FileDef::overrideIncludedByGraph, CCodeParser::parseCode, FortranCodeParser::parseCode, LexCodeParser::parseCode, PythonCodeParser::parseCode, SQLCodeParser::parseCode, VHDLCodeParser::parseCode, XMLCodeParser::parseCode, CodeFragmentManager::parseCodeFragment, readDir, readFileOrDirectory and writeGraphInfo.

includeClose()

QCString includeClose (SrcLangExt lang, IncludeKind kind)

Declaration at line 71 of file filedef.h, definition at line 86 of file filedef.cpp.

86QCString includeClose(SrcLangExt lang,IncludeKind kind)

87{

88 if (lang==SrcLangExt::IDL) return "\";";

89 else if (lang==SrcLangExt::Java) return ";";

90

91 switch (kind)

92 {

93 case IncludeKind::ImportLocal: return "\";";

94 case IncludeKind::ImportLocalObjC: return "\"";

95 case IncludeKind::IncludeLocal: return "\"";

96 case IncludeKind::ImportSystem: return ">;";

97 case IncludeKind::ImportSystemObjC: return ">";

98 case IncludeKind::IncludeSystem: return ">";

99 case IncludeKind::ImportModule: return ";";

100 }

101 return "";

102}

References ImportLocal, ImportLocalObjC, ImportModule, ImportSystem, ImportSystemObjC, IncludeLocal and IncludeSystem.

Referenced by ClassDefImpl::writeIncludeFiles, ConceptDefImpl::writeIncludeFiles and FileDefImpl::writeIncludeFiles.

includeOpen()

QCString includeOpen (SrcLangExt lang, IncludeKind kind)

Declaration at line 70 of file filedef.h, definition at line 73 of file filedef.cpp.

73QCString includeOpen(SrcLangExt lang,IncludeKind kind)

74{

75 if (lang==SrcLangExt::Java || kind==IncludeKind::ImportModule) return "";

76 if ((kind & IncludeKind_LocalMask) || (lang==SrcLangExt::IDL))

77 {

78 return "\"";

79 }

80 else

81 {

82 return "<";

83 }

84}

References ImportModule and IncludeKind_LocalMask.

Referenced by ClassDefImpl::writeIncludeFiles, ConceptDefImpl::writeIncludeFiles and FileDefImpl::writeIncludeFiles.

includeStatement()

QCString includeStatement (SrcLangExt lang, IncludeKind kind)

Declaration at line 69 of file filedef.h, definition at line 56 of file filedef.cpp.

56QCString includeStatement(SrcLangExt lang,IncludeKind kind)

57{

58 bool isIDLorJava = lang==SrcLangExt::IDL || lang==SrcLangExt::Java;

59 if (isIDLorJava || (kind & IncludeKind_ImportMask))

60 {

61 return "import ";

62 }

63 else if (kind & IncludeKind_ObjCMask)

64 {

65 return "#import ";

66 }

67 else

68 {

69 return "#include ";

70 }

71}

References IncludeKind_ImportMask and IncludeKind_ObjCMask.

Referenced by ClassDefImpl::writeIncludeFiles, ConceptDefImpl::writeIncludeFiles and FileDefImpl::writeIncludeFiles.

toFileDef()

FileDef * toFileDef (Definition * d)

Declaration at line 217 of file filedef.h, definition at line 1932 of file filedef.cpp.

1932FileDef *toFileDef(Definition *d)

1933{

1934 if (d==nullptr) return nullptr;

1935 if (d && typeid(*d)==typeid(FileDefImpl))

1936 {

1937 return static_cast<FileDef*>(d);

1938 }

1939 else

1940 {

1941 return nullptr;

1942 }

1943}

Referenced by DocSets::addIndexItem, DocLink::DocLink, DocRef::DocRef, findModuleDef, SymbolResolver::Private::followPath, generateJSTree, FTVHelp::Private::generateTree, SymbolResolver::Private::getResolvedSymbolRec, DocParser::handleLinkedWord, NamespaceDefImpl::insertMember, insertMemberAlias, SymbolResolver::Private::isAccessibleFrom, ClassDefImpl::moveTo, MemberDefImpl::moveTo, DefinitionImpl::navigationPathAsString, node2URL, FileDef::overrideIncludedByGraph, SearchIndex::setCurrentDoc and SearchIndexExternal::setCurrentDoc.

toFileDef()

const FileDef * toFileDef (const Definition * d)

Declaration at line 218 of file filedef.h, definition at line 1945 of file filedef.cpp.

1945const FileDef *toFileDef(const Definition *d)

1946{

1947 if (d==nullptr) return nullptr;

1948 if (d && typeid(*d)==typeid(FileDefImpl))

1949 {

1950 return static_cast<const FileDef*>(d);

1951 }

1952 else

1953 {

1954 return nullptr;

1955 }

1956}

Variables

IncludeKind_ImportMask

uint32_t IncludeKind_ImportMask

constexpr

Initialiser

= IncludeKind::ImportSystemObjC | IncludeKind::ImportLocalObjC | IncludeKind::ImportSystem | IncludeKind::ImportLocal | IncludeKind::ImportModule

Definition at line 65 of file filedef.h.

65constexpr uint32_t IncludeKind_ImportMask = IncludeKind::ImportSystemObjC | IncludeKind::ImportLocalObjC | IncludeKind::ImportSystem |

Referenced by generateSqlite3ForFile, includeStatement and includeTagFileAttributes.

IncludeKind_LocalMask

uint32_t IncludeKind_LocalMask = IncludeKind::IncludeLocal | IncludeKind::ImportLocalObjC | IncludeKind::ImportLocal

constexpr

Definition at line 63 of file filedef.h.

63constexpr uint32_t IncludeKind_LocalMask = IncludeKind::IncludeLocal | IncludeKind::ImportLocalObjC | IncludeKind::ImportLocal;

Referenced by generateSqlite3ForFile, generateXMLForFile, includeOpen, includeTagFileAttributes and writeIncludeInfo.

IncludeKind_ObjCMask

uint32_t IncludeKind_ObjCMask = IncludeKind::ImportSystemObjC | IncludeKind::ImportLocalObjC

constexpr

Definition at line 67 of file filedef.h.

67constexpr uint32_t IncludeKind_ObjCMask = IncludeKind::ImportSystemObjC | IncludeKind::ImportLocalObjC;

Referenced by includeStatement and includeTagFileAttributes.

IncludeKind_SystemMask

uint32_t IncludeKind_SystemMask = IncludeKind::IncludeSystem | IncludeKind::ImportSystemObjC | IncludeKind::ImportSystem

constexpr

Definition at line 64 of file filedef.h.

64constexpr uint32_t IncludeKind_SystemMask = IncludeKind::IncludeSystem | IncludeKind::ImportSystemObjC | IncludeKind::ImportSystem;

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.