ClassDefImpl Class Reference

Public Member Functions
	ClassDefImpl ()
	~ClassDefImpl ()
void	init (const char *defFileName, const char *name, const QCString &ctStr, const char *fName)

Public Attributes
QCString	fileName
QCString	memberListFileName
QCString	collabFileName
QCString	inheritFileName
IncludeInfo *	incInfo
BaseClassList *	inherits
BaseClassList *	inheritedBy
NamespaceDef *	nspace
FileDef *	fileDef
MemberNameInfoSDict *	allMemberNameInfoSDict
ArgumentList *	tempArgs
ArgumentList *	typeConstraints
FileList	files
ExampleSDict *	exampleSDict
ClassDef::CompoundType	compType
Protection	prot
ClassSDict *	innerClasses
UsesClassDict *	usesImplClassDict
UsesClassDict *	usedByImplClassDict
UsesClassDict *	usesIntfClassDict
ConstraintClassDict *	constraintClassDict
QDict< ClassDef > *	templateInstances
QDict< ClassDef > *	variableInstances
QDict< int > *	templBaseClassNames
ClassDef *	templateMaster
QCString	className
ClassDef *	categoryOf
QList< MemberList >	memberLists
MemberGroupSDict *	memberGroupSDict
bool	isAbstract
bool	isStatic
bool	membersMerged
bool	isLocal
bool	isTemplArg
bool	subGrouping
bool	usedOnly
SDict< QCString >	vhdlSummaryTitles
bool	isSimple
MemberDef *	arrowOperator
ClassList *	taggedInnerClasses
ClassDef *	tagLessRef
bool	isJavaEnum
bool	isGeneric
bool	isAnonymous
uint64	spec

Detailed Description

Private data associated with a ClassDef object.

Definition at line 51 of file classdef.cpp.

Constructor & Destructor Documentation

ClassDefImpl::ClassDefImpl

(

)

Definition at line 268 of file classdef.cpp.

References SDict< T >::setAutoDelete(), and vhdlSummaryTitles.

                           : vhdlSummaryTitles(17)
{
  vhdlSummaryTitles.setAutoDelete(TRUE);
}

ClassDefImpl::~ClassDefImpl

(

)

Definition at line 273 of file classdef.cpp.

References allMemberNameInfoSDict, constraintClassDict, exampleSDict, incInfo, inheritedBy, inherits, innerClasses, memberGroupSDict, taggedInnerClasses, tempArgs, templateInstances, templBaseClassNames, typeConstraints, usedByImplClassDict, usesImplClassDict, usesIntfClassDict, and variableInstances.

{
  delete inherits;
  delete inheritedBy;
  delete allMemberNameInfoSDict;
  delete exampleSDict;
  delete usesImplClassDict;
  delete usedByImplClassDict;
  delete usesIntfClassDict;
  delete constraintClassDict;
  delete incInfo;
  delete memberGroupSDict;
  delete innerClasses;
  delete templateInstances;
  delete variableInstances;
  delete templBaseClassNames;
  delete tempArgs;
  delete typeConstraints;
  delete taggedInnerClasses;
}

Member Function Documentation

void ClassDefImpl::init	(	const char *	defFileName,
		const char *	name,
		const QCString &	ctStr,
		const char *	fName
	)

Definition at line 206 of file classdef.cpp.

References allMemberNameInfoSDict, arrowOperator, categoryOf, Config_getBool, constraintClassDict, exampleSDict, fileDef, fileName, getLanguageFromFileName(), guessSection(), incInfo, inheritedBy, inherits, innerClasses, isAbstract, isAnonymous, isGeneric, isLocal, isSimple, isStatic, isTemplArg, memberGroupSDict, membersMerged, nspace, prot, Public, Entry::SOURCE_SEC, spec, SrcLangExt_Cpp, SrcLangExt_CSharp, SrcLangExt_Java, SrcLangExt_ObjC, stripExtension(), subGrouping, taggedInnerClasses, tagLessRef, tempArgs, templateInstances, templateMaster, templBaseClassNames, typeConstraints, usedByImplClassDict, usedOnly, usesImplClassDict, usesIntfClassDict, and variableInstances.

Referenced by ClassDef::ClassDef().

{
  if (fName)
  {
    fileName=stripExtension(fName);
  }
  else
  {
    fileName=ctStr+name;
  }
  exampleSDict = 0;
  inherits    = 0;
  inheritedBy = 0;
  allMemberNameInfoSDict = 0;
  incInfo=0;
  tempArgs=0;
  typeConstraints=0;
  prot=Public;
  nspace=0;
  fileDef=0;
  usesImplClassDict=0;
  usedByImplClassDict=0;
  usesIntfClassDict=0;
  constraintClassDict=0;
  memberGroupSDict = 0;
  innerClasses = 0;
  subGrouping=Config_getBool(SUBGROUPING);
  templateInstances = 0;
  variableInstances = 0;
  templateMaster =0;
  templBaseClassNames = 0;
  isAbstract = FALSE;
  isStatic = FALSE;
  isTemplArg = FALSE;
  membersMerged = FALSE;
  categoryOf = 0;
  usedOnly = FALSE;
  isSimple = Config_getBool(INLINE_SIMPLE_STRUCTS);
  arrowOperator = 0;
  taggedInnerClasses = 0;
  tagLessRef = 0;
  spec=0;
  //QCString ns;
  //extractNamespaceName(name,className,ns);
  //printf("m_name=%s m_className=%s ns=%s\n",m_name.data(),m_className.data(),ns.data());

  // we cannot use getLanguage at this point, as setLanguage has not been called.
  SrcLangExt lang = getLanguageFromFileName(defFileName);
  if ((lang==SrcLangExt_Cpp || lang==SrcLangExt_ObjC) &&
      guessSection(defFileName)==Entry::SOURCE_SEC)
  {
    isLocal=TRUE;
  }
  else
  {
    isLocal=FALSE;
  }
  isGeneric = (lang==SrcLangExt_CSharp || lang==SrcLangExt_Java) && QCString(name).find('<')!=-1;
  isAnonymous = QCString(name).find('@')!=-1;
}

Member Data Documentation

MemberNameInfoSDict* ClassDefImpl::allMemberNameInfoSDict

List of all members (including inherited members)

Definition at line 97 of file classdef.cpp.

Referenced by ClassDef::getMemberByName(), init(), ClassDef::internalInsertMember(), ClassDef::memberNameInfoSDict(), ClassDef::mergeCategory(), ClassDef::mergeMembers(), ClassDef::setGroupDefForAllMembers(), ClassDef::writeMemberList(), ClassDef::writeQuickMemberLinks(), ClassDef::writeSummaryLinks(), and ~ClassDefImpl().

MemberDef* ClassDefImpl::arrowOperator

Does this class overloaded the -> operator?

Definition at line 191 of file classdef.cpp.

Referenced by init(), ClassDef::internalInsertMember(), and ClassDef::isSmartPointer().

ClassDef* ClassDefImpl::categoryOf

If this class is a Objective-C category, then this points to the class which is extended.

Definition at line 154 of file classdef.cpp.

Referenced by ClassDef::categoryOf(), init(), and ClassDef::setCategoryOf().

QCString ClassDefImpl::className

local class name which could be a typedef'ed alias name.

Definition at line 149 of file classdef.cpp.

Referenced by ClassDef::className(), and ClassDef::setClassName().

QCString ClassDefImpl::collabFileName

file name used for the collaboration diagram

Definition at line 69 of file classdef.cpp.

Referenced by ClassDef::ClassDef(), and ClassDef::collaborationGraphFileName().

ClassDef::CompoundType ClassDefImpl::compType

Holds the kind of "class" this is.

Definition at line 112 of file classdef.cpp.

Referenced by ClassDef::ClassDef(), ClassDef::compoundType(), ClassDef::compoundTypeString(), ClassDef::displayName(), ClassDef::generatedFromFiles(), ClassDef::setCompoundType(), and ClassDef::title().

ConstraintClassDict* ClassDefImpl::constraintClassDict

Definition at line 130 of file classdef.cpp.

Referenced by ClassDef::addTypeConstraint(), init(), ClassDef::templateTypeConstraints(), and ~ClassDefImpl().

ExampleSDict* ClassDefImpl::exampleSDict

Examples that use this class

Definition at line 109 of file classdef.cpp.

Referenced by ClassDef::addExample(), ClassDef::exampleList(), ClassDef::hasExamples(), init(), ClassDef::writeDetailedDocumentationBody(), and ~ClassDefImpl().

FileDef* ClassDefImpl::fileDef

File this class is defined in

Definition at line 94 of file classdef.cpp.

Referenced by ClassDef::getFileDef(), init(), and ClassDef::setFileDef().

QCString ClassDefImpl::fileName

file name that forms the base for the output file containing the class documentation. For compatibility with Qt (e.g. links via tag files) this name cannot be derived from the class name directly.

Definition at line 63 of file classdef.cpp.

Referenced by ClassDef::anchor(), ClassDef::ClassDef(), ClassDef::getInstanceOutputFileBase(), ClassDef::getOutputFileBase(), init(), res2cc_cmd.VerbatimFile::writeDirEntry(), res2cc_cmd.CSSFile::writeDirEntry(), res2cc_cmd.LumFile::writeDirEntry(), and res2cc_cmd.LumaFile::writeDirEntry().

FileList ClassDefImpl::files

Files that were used for generating the class documentation.

Definition at line 106 of file classdef.cpp.

Referenced by ClassDef::generatedFromFiles(), ClassDef::insertUsedFile(), ClassDef::showUsedFiles(), and ClassDef::usedFiles().

IncludeInfo* ClassDefImpl::incInfo

Include information about the header file should be included in the documentation. 0 by default, set by setIncludeFile().

Definition at line 77 of file classdef.cpp.

Referenced by ClassDef::includeInfo(), init(), ClassDef::setIncludeFile(), ClassDef::writeIncludeFiles(), and ~ClassDefImpl().

BaseClassList* ClassDefImpl::inheritedBy

List of sub-classes that directly derive from this class

Definition at line 86 of file classdef.cpp.

Referenced by ClassDef::countInheritanceNodes(), ClassDef::hasNonReferenceSuperClass(), init(), ClassDef::insertSubClass(), ClassDef::subClasses(), ClassDef::writeInheritanceGraph(), and ~ClassDefImpl().

QCString ClassDefImpl::inheritFileName

file name used for the inheritance graph

Definition at line 72 of file classdef.cpp.

Referenced by ClassDef::ClassDef(), and ClassDef::inheritanceGraphFileName().

BaseClassList* ClassDefImpl::inherits

List of base class (or super-classes) from which this class derives directly.

Definition at line 82 of file classdef.cpp.

Referenced by ClassDef::baseClasses(), ClassDef::countInheritanceNodes(), ClassDef::countInheritedDecMembers(), init(), ClassDef::insertBaseClass(), ClassDef::writeInheritanceGraph(), ClassDef::writeInheritedMemberDeclarations(), ClassDef::writeTagFile(), and ~ClassDefImpl().

ClassSDict* ClassDefImpl::innerClasses

The inner classes contained in this class. Will be 0 if there are no inner classes.

Definition at line 123 of file classdef.cpp.

Referenced by ClassDef::addInnerCompound(), ClassDef::findInnerCompound(), ClassDef::getClassSDict(), init(), ClassDef::innerClasses(), ClassDef::sortMemberLists(), ClassDef::writeDocumentationForInnerClasses(), ClassDef::writeInlineClasses(), ClassDef::writeNestedClasses(), ClassDef::writeSummaryLinks(), ClassDef::writeTagFile(), and ~ClassDefImpl().

bool ClassDefImpl::isAbstract

Is this an abstact class?

Definition at line 162 of file classdef.cpp.

Referenced by init(), ClassDef::internalInsertMember(), and ClassDef::isAbstract().

bool ClassDefImpl::isAnonymous

Definition at line 201 of file classdef.cpp.

Referenced by init(), ClassDef::isAnonymous(), and ClassDef::setName().

bool ClassDefImpl::isGeneric

Definition at line 199 of file classdef.cpp.

Referenced by init(), and ClassDef::isGeneric().

bool ClassDefImpl::isJavaEnum

Does this class represent a Java style enum?

Definition at line 197 of file classdef.cpp.

Referenced by ClassDef::ClassDef(), and ClassDef::isJavaEnum().

bool ClassDefImpl::isLocal

TRUE if the class is defined in a source file rather than a header file.

Definition at line 171 of file classdef.cpp.

Referenced by init(), ClassDef::isLinkableInProject(), and ClassDef::isLocal().

bool ClassDefImpl::isSimple

Is this a simple (non-nested) C structure?

Definition at line 188 of file classdef.cpp.

Referenced by ClassDef::getOutputFileBase(), init(), ClassDef::insertBaseClass(), ClassDef::insertSubClass(), ClassDef::internalInsertMember(), ClassDef::isEmbeddedInOuterScope(), ClassDef::isSimple(), and ClassDef::writeInlineDocumentation().

bool ClassDefImpl::isStatic

Is the class part of an unnamed namespace?

Definition at line 165 of file classdef.cpp.

Referenced by init(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), and ClassDef::setIsStatic().

bool ClassDefImpl::isTemplArg

Definition at line 173 of file classdef.cpp.

Referenced by init(), ClassDef::isTemplateArgument(), and ClassDef::makeTemplateArgument().

MemberGroupSDict* ClassDefImpl::memberGroupSDict

Definition at line 159 of file classdef.cpp.

Referenced by ClassDef::addGroupedInheritedMembers(), ClassDef::addListReferences(), ClassDef::addMembersToMemberGroup(), ClassDef::computeAnchors(), ClassDef::countMemberDeclarations(), ClassDef::countMembersIncludingGrouped(), ClassDef::distributeMemberGroupDocumentation(), ClassDef::findSectionsInDocumentation(), ClassDef::getMemberGroupSDict(), init(), ClassDef::writeDeclaration(), ClassDef::writeMemberGroups(), ClassDef::writeTagFile(), and ~ClassDefImpl().

QCString ClassDefImpl::memberListFileName

file name used for the list of all members

Definition at line 66 of file classdef.cpp.

Referenced by ClassDef::ClassDef(), and ClassDef::getMemberListFileName().

QList<MemberList> ClassDefImpl::memberLists

Definition at line 156 of file classdef.cpp.

Referenced by ClassDef::addListReferences(), ClassDef::addMembersToMemberGroup(), ClassDef::computeAnchors(), ClassDef::createMemberList(), ClassDef::findSectionsInDocumentation(), ClassDef::getMemberList(), ClassDef::getMemberLists(), ClassDef::reclassifyMember(), ClassDef::removeMemberFromLists(), ClassDef::sortMemberLists(), and ClassDef::writeMemberPages().

bool ClassDefImpl::membersMerged

TRUE if classes members are merged with those of the base classes.

Definition at line 168 of file classdef.cpp.

Referenced by init(), and ClassDef::mergeMembers().

NamespaceDef* ClassDefImpl::nspace

Namespace this class is part of (this is the inner most namespace in case of nested namespaces)

Definition at line 91 of file classdef.cpp.

Referenced by ClassDef::getNamespaceDef(), init(), and ClassDef::setNamespace().

Protection ClassDefImpl::prot

The protection level in which this class was found. Typically Public, but for nested classes this can also be Protected or Private.

Definition at line 118 of file classdef.cpp.

Referenced by init(), ClassDef::isLinkableInProject(), ClassDef::isVisibleInHierarchy(), ClassDef::protection(), and ClassDef::setProtection().

uint64 ClassDefImpl::spec

Definition at line 203 of file classdef.cpp.

Referenced by init(), ClassDef::isAbstract(), ClassDef::isFinal(), ClassDef::isForwardDeclared(), ClassDef::isPublished(), ClassDef::isSealed(), and ClassDef::setClassSpecifier().

bool ClassDefImpl::subGrouping

Does this class group its user-grouped members as a sub-section of the normal (public/protected/..) groups?

Definition at line 179 of file classdef.cpp.

Referenced by ClassDef::addGroupedInheritedMembers(), ClassDef::addMembersToMemberGroup(), ClassDef::countMembersIncludingGrouped(), init(), ClassDef::setSubGrouping(), ClassDef::subGrouping(), and ClassDef::writeMemberGroups().

ClassList* ClassDefImpl::taggedInnerClasses

Definition at line 193 of file classdef.cpp.

Referenced by ClassDef::addTaggedInnerClass(), init(), ClassDef::taggedInnerClasses(), and ~ClassDefImpl().

ClassDef* ClassDefImpl::tagLessRef

Definition at line 194 of file classdef.cpp.

Referenced by init(), ClassDef::setTagLessReference(), and ClassDef::tagLessReference().

ArgumentList* ClassDefImpl::tempArgs

Template arguments of this class

Definition at line 100 of file classdef.cpp.

Referenced by ClassDef::addTypeConstraints(), init(), ClassDef::isTemplate(), ClassDef::setTemplateArguments(), ClassDef::templateArguments(), ClassDef::title(), ClassDef::writeTagFile(), and ~ClassDefImpl().

QDict<ClassDef>* ClassDefImpl::templateInstances

Template instances that exists of this class, the key in the dictionary is the template argument list.

Definition at line 135 of file classdef.cpp.

Referenced by ClassDef::getTemplateInstances(), init(), ClassDef::insertTemplateInstance(), ClassDef::insertUsedFile(), and ~ClassDefImpl().

ClassDef* ClassDefImpl::templateMaster

The class this class is an instance of.

Definition at line 146 of file classdef.cpp.

Referenced by ClassDef::anchor(), ClassDef::getOutputFileBase(), ClassDef::getReference(), ClassDef::getSourceFileBase(), init(), ClassDef::isLinkable(), ClassDef::isLinkableInProject(), ClassDef::isReference(), ClassDef::isVisibleInHierarchy(), ClassDef::setTemplateMaster(), and ClassDef::templateMaster().

QDict<int>* ClassDefImpl::templBaseClassNames

Definition at line 143 of file classdef.cpp.

Referenced by ClassDef::getTemplateBaseClassNames(), init(), ClassDef::setTemplateBaseClassNames(), and ~ClassDefImpl().

ArgumentList* ClassDefImpl::typeConstraints

Type constraints for template parameters

Definition at line 103 of file classdef.cpp.

Referenced by init(), ClassDef::setTypeConstraints(), ClassDef::typeConstraints(), ClassDef::writeDetailedDocumentationBody(), and ~ClassDefImpl().

UsesClassDict* ClassDefImpl::usedByImplClassDict

Definition at line 127 of file classdef.cpp.

Referenced by ClassDef::addUsedByClass(), init(), ClassDef::usedByImplementationClasses(), and ~ClassDefImpl().

bool ClassDefImpl::usedOnly

Reason of existence is a "use" relation

Definition at line 182 of file classdef.cpp.

Referenced by init(), ClassDef::isUsedOnly(), and ClassDef::setUsedOnly().

UsesClassDict* ClassDefImpl::usesImplClassDict

Definition at line 126 of file classdef.cpp.

Referenced by ClassDef::addUsedClass(), init(), ClassDef::usedImplementationClasses(), and ~ClassDefImpl().

UsesClassDict* ClassDefImpl::usesIntfClassDict

Definition at line 128 of file classdef.cpp.

Referenced by init(), ClassDef::usedInterfaceClasses(), and ~ClassDefImpl().

QDict<ClassDef>* ClassDefImpl::variableInstances

Template instances that exists of this class, as defined by variables. We do NOT want to document these individually. The key in the dictionary is the template argument list.

Definition at line 141 of file classdef.cpp.

Referenced by ClassDef::getVariableInstance(), init(), and ~ClassDefImpl().

SDict<QCString> ClassDefImpl::vhdlSummaryTitles

List of titles to use for the summary

Definition at line 185 of file classdef.cpp.

Referenced by ClassDefImpl(), ClassDef::internalInsertMember(), and ClassDef::writeSummaryLinks().

---

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

• classdef.cpp