#include <entry.h>

Public Types
enum	Sections { CLASS_SEC = 0x00000001, NAMESPACE_SEC = 0x00000010, COMPOUND_MASK = CLASS_SEC, SCOPE_MASK = COMPOUND_MASK \| NAMESPACE_SEC, CLASSDOC_SEC = 0x00000800, STRUCTDOC_SEC = 0x00001000, UNIONDOC_SEC = 0x00002000, EXCEPTIONDOC_SEC = 0x00004000, NAMESPACEDOC_SEC = 0x00008000, INTERFACEDOC_SEC = 0x00010000, PROTOCOLDOC_SEC = 0x00020000, CATEGORYDOC_SEC = 0x00040000, SERVICEDOC_SEC = 0x00080000, SINGLETONDOC_SEC = 0x00100000, COMPOUNDDOC_MASK, SOURCE_SEC = 0x00400000, HEADER_SEC = 0x00800000, FILE_MASK = SOURCE_SEC \| HEADER_SEC, ENUMDOC_SEC = 0x01000000, ENUM_SEC = 0x02000000, EMPTY_SEC = 0x03000000, PAGEDOC_SEC = 0x04000000, VARIABLE_SEC = 0x05000000, FUNCTION_SEC = 0x06000000, TYPEDEF_SEC = 0x07000000, MEMBERDOC_SEC = 0x08000000, OVERLOADDOC_SEC = 0x09000000, EXAMPLE_SEC = 0x0a000000, VARIABLEDOC_SEC = 0x0b000000, FILEDOC_SEC = 0x0c000000, DEFINEDOC_SEC = 0x0d000000, INCLUDE_SEC = 0x0e000000, DEFINE_SEC = 0x0f000000, GROUPDOC_SEC = 0x10000000, USINGDIR_SEC = 0x11000000, MAINPAGEDOC_SEC = 0x12000000, MEMBERGRP_SEC = 0x13000000, USINGDECL_SEC = 0x14000000, PACKAGE_SEC = 0x15000000, PACKAGEDOC_SEC = 0x16000000, OBJCIMPL_SEC = 0x17000000, DIRDOC_SEC = 0x18000000, EXPORTED_INTERFACE_SEC = 0x19000000, INCLUDED_SERVICE_SEC = 0x1A000000 }

enum	GroupDocType { GROUPDOC_NORMAL, GROUPDOC_ADD, GROUPDOC_WEAK }

Public Member Functions
	Entry ()

	Entry (const Entry &)

	~Entry ()

int	getSize ()

void	addSpecialListItem (const char *listName, int index)

void	createNavigationIndex (EntryNav rootNav, FileStorage storage, FileDef *fd)

void	setParent (Entry *parent)

Entry *	parent () const

const QList< Entry > *	children () const

void	addSubEntry (Entry *e)

Entry *	removeSubEntry (Entry *e)

void	reset ()

void	marshall (StorageIntf *)

void	unmarshall (StorageIntf *)

const char *	groupDocCmd () const
	return the command name used to define GROUPDOC_SEC

Grouping::GroupPri_t	groupingPri () const

Public Attributes
int	section
	entry type (see Sections);

QCString	type
	member type

QCString	name
	member name

TagInfo *	tagInfo
	tag file info

Protection	protection
	class protection

MethodTypes	mtype
	signal, slot, (dcop) method, or property?

uint64	spec
	class/member specifiers

int	initLines
	define/variable initializer lines to show

bool	stat
	static ?

bool	explicitExternal
	explicitly defined as external?

bool	proto
	prototype ?

bool	subGrouping
	automatically group class members?

bool	callGraph
	do we need to draw the call graph?

bool	callerGraph
	do we need to draw the caller graph?

Specifier	virt
	virtualness of the entry

QCString	args
	member argument string

QCString	bitfields
	member's bit fields

ArgumentList *	argList
	member arguments as a list

QList< ArgumentList > *	tArgLists
	template argument declarations

QGString	program
	the program text

QGString	initializer
	initial value (for variables)

QCString	includeFile
	include file (2 arg of \class, must be unique)

QCString	includeName
	include name (3 arg of \class)

QCString	doc
	documentation block (partly parsed)

int	docLine
	line number at which the documentation was found

QCString	docFile
	file in which the documentation was found

QCString	brief
	brief description (doc block)

int	briefLine
	line number at which the brief desc. was found

QCString	briefFile
	file in which the brief desc. was found

QCString	inbodyDocs
	documentation inside the body of a function

int	inbodyLine
	line number at which the body doc was found

QCString	inbodyFile
	file in which the body doc was found

QCString	relates
	related class (doc block)

RelatesType	relatesType
	how relates is handled

QCString	read
	property read accessor

QCString	write
	property write accessor

QCString	inside
	name of the class in which documents are found

QCString	exception
	throw specification

ArgumentList *	typeConstr
	where clause (C#) for type constraints

int	bodyLine
	line number of the definition in the source

int	endBodyLine
	line number where the definition ends

int	mGrpId
	member group id

QList< BaseInfo > *	extends
	list of base classes

QList< Grouping > *	groups
	list of groups this entry belongs to

QList< SectionInfo > *	anchors
	list of anchors defined in this entry

QCString	fileName
	file this entry was extracted from

int	startLine
	start line of entry in the source

int	startColumn
	start column of entry in the source

QList< ListItemInfo > *	sli
	special lists (test/todo/bug/deprecated/..) this entry is in

SrcLangExt	lang
	programming language in which this entry was found

bool	hidden
	does this represent an entity that is hidden from the output

bool	artificial
	Artificially introduced item.

GroupDocType	groupDocType

QCString	id
	libclang id

Static Public Attributes
static const uint64	Template = (1ULL<<0)

static const uint64	Generic = (1ULL<<1)

static const uint64	Ref = (1ULL<<2)

static const uint64	Value = (1ULL<<3)

static const uint64	Interface = (1ULL<<4)

static const uint64	Struct = (1ULL<<5)

static const uint64	Union = (1ULL<<6)

static const uint64	Exception = (1ULL<<7)

static const uint64	Protocol = (1ULL<<8)

static const uint64	Category = (1ULL<<9)

static const uint64	SealedClass = (1ULL<<10)

static const uint64	AbstractClass = (1ULL<<11)

static const uint64	Enum = (1ULL<<12)

static const uint64	Service = (1ULL<<13)

static const uint64	Singleton = (1ULL<<14)

static const uint64	ForwardDecl = (1ULL<<15)

static const uint64	PrivateGettable = (1ULL<<20)

static const uint64	ProtectedGettable = (1ULL<<21)

static const uint64	PrivateSettable = (1ULL<<22)

static const uint64	ProtectedSettable = (1ULL<<23)

static const uint64	Inline = (1ULL<<24)

static const uint64	Explicit = (1ULL<<25)

static const uint64	Mutable = (1ULL<<26)

static const uint64	Settable = (1ULL<<27)

static const uint64	Gettable = (1ULL<<28)

static const uint64	Readable = (1ULL<<29)

static const uint64	Writable = (1ULL<<30)

static const uint64	Final = (1ULL<<31)

static const uint64	Abstract = (1ULL<<32)

static const uint64	Addable = (1ULL<<33)

static const uint64	Removable = (1ULL<<34)

static const uint64	Raisable = (1ULL<<35)

static const uint64	Override = (1ULL<<36)

static const uint64	New = (1ULL<<37)

static const uint64	Sealed = (1ULL<<38)

static const uint64	Initonly = (1ULL<<39)

static const uint64	Optional = (1ULL<<40)

static const uint64	Required = (1ULL<<41)

static const uint64	NonAtomic = (1ULL<<42)

static const uint64	Copy = (1ULL<<43)

static const uint64	Retain = (1ULL<<44)

static const uint64	Assign = (1ULL<<45)

static const uint64	Strong = (1ULL<<46)

static const uint64	Weak = (1ULL<<47)

static const uint64	Unretained = (1ULL<<48)

static const uint64	Alias = (1ULL<<49)

static const uint64	ConstExp = (1ULL<<50)

static const uint64	Default = (1ULL<<51)

static const uint64	Delete = (1ULL<<52)

static const uint64	NoExcept = (1ULL<<53)

static const uint64	Attribute = (1ULL<<54)

static const uint64	Property = (1ULL<<55)

static const uint64	Readonly = (1ULL<<56)

static const uint64	Bound = (1ULL<<57)

static const uint64	Constrained = (1ULL<<58)

static const uint64	Transient = (1ULL<<59)

static const uint64	MaybeVoid = (1ULL<<60)

static const uint64	MaybeDefault = (1ULL<<61)

static const uint64	MaybeAmbiguous = (1ULL<<62)

static const uint64	Published = (1ULL<<63)

static int	num =0
	counts the total number of entries

Private Member Functions
void	createSubtreeIndex (EntryNav nav, FileStorage storage, FileDef *fd)

Entry &	operator= (const Entry &)

Private Attributes
Entry *	m_parent
	parent node in the tree

QList< Entry > *	m_sublist
	entries that are children of this one

Detailed Description

Represents an unstructured piece of information, about an entity found in the sources.

parseMain() in scanner.l will generate a tree of these entries.

Definition at line 63 of file entry.h.

Member Enumeration Documentation

enum Entry::GroupDocType

Enumerator
GROUPDOC_NORMAL	defgroup
GROUPDOC_ADD	addgroup
GROUPDOC_WEAK	weakgroup

Definition at line 184 of file entry.h.

    {
      GROUPDOC_NORMAL,        
      GROUPDOC_ADD,           
      GROUPDOC_WEAK           
    };                        

enum Entry::Sections

Kind of entries that are supported

Enumerator
CLASS_SEC
NAMESPACE_SEC
COMPOUND_MASK
SCOPE_MASK
CLASSDOC_SEC
STRUCTDOC_SEC
UNIONDOC_SEC
EXCEPTIONDOC_SEC
NAMESPACEDOC_SEC
INTERFACEDOC_SEC
PROTOCOLDOC_SEC
CATEGORYDOC_SEC
SERVICEDOC_SEC
SINGLETONDOC_SEC
COMPOUNDDOC_MASK
SOURCE_SEC
HEADER_SEC
FILE_MASK
ENUMDOC_SEC
ENUM_SEC
EMPTY_SEC
PAGEDOC_SEC
VARIABLE_SEC
FUNCTION_SEC
TYPEDEF_SEC
MEMBERDOC_SEC
OVERLOADDOC_SEC
EXAMPLE_SEC
VARIABLEDOC_SEC
FILEDOC_SEC
DEFINEDOC_SEC
INCLUDE_SEC
DEFINE_SEC
GROUPDOC_SEC
USINGDIR_SEC
MAINPAGEDOC_SEC
MEMBERGRP_SEC
USINGDECL_SEC
PACKAGE_SEC
PACKAGEDOC_SEC
OBJCIMPL_SEC
DIRDOC_SEC
EXPORTED_INTERFACE_SEC
INCLUDED_SERVICE_SEC

Definition at line 68 of file entry.h.

                  { 
      CLASS_SEC        = 0x00000001, 
      NAMESPACE_SEC    = 0x00000010,
      COMPOUND_MASK    = CLASS_SEC,
      SCOPE_MASK       = COMPOUND_MASK | NAMESPACE_SEC,
      
      CLASSDOC_SEC     = 0x00000800, 
      STRUCTDOC_SEC    = 0x00001000,
      UNIONDOC_SEC     = 0x00002000,
      EXCEPTIONDOC_SEC = 0x00004000,
      NAMESPACEDOC_SEC = 0x00008000,
      INTERFACEDOC_SEC = 0x00010000,
      PROTOCOLDOC_SEC  = 0x00020000,
      CATEGORYDOC_SEC  = 0x00040000,
      SERVICEDOC_SEC   = 0x00080000,
      SINGLETONDOC_SEC = 0x00100000,
      COMPOUNDDOC_MASK = CLASSDOC_SEC | STRUCTDOC_SEC | UNIONDOC_SEC | 
                         INTERFACEDOC_SEC | EXCEPTIONDOC_SEC | PROTOCOLDOC_SEC |
                         CATEGORYDOC_SEC | SERVICEDOC_SEC | SINGLETONDOC_SEC,
      SOURCE_SEC       = 0x00400000,
      HEADER_SEC       = 0x00800000,
      FILE_MASK        = SOURCE_SEC | HEADER_SEC,
      ENUMDOC_SEC      = 0x01000000,
      ENUM_SEC         = 0x02000000,
      EMPTY_SEC        = 0x03000000, 
      PAGEDOC_SEC      = 0x04000000, 
      VARIABLE_SEC     = 0x05000000,
      FUNCTION_SEC     = 0x06000000,
      TYPEDEF_SEC      = 0x07000000,
      MEMBERDOC_SEC    = 0x08000000, 
      OVERLOADDOC_SEC  = 0x09000000,
      EXAMPLE_SEC      = 0x0a000000, 
      VARIABLEDOC_SEC  = 0x0b000000,
      FILEDOC_SEC      = 0x0c000000,
      DEFINEDOC_SEC    = 0x0d000000,
      INCLUDE_SEC      = 0x0e000000,
      DEFINE_SEC       = 0x0f000000,
      GROUPDOC_SEC     = 0x10000000,
      USINGDIR_SEC     = 0x11000000,
      MAINPAGEDOC_SEC  = 0x12000000,
      MEMBERGRP_SEC    = 0x13000000,
      USINGDECL_SEC    = 0x14000000,
      PACKAGE_SEC      = 0x15000000,
      PACKAGEDOC_SEC   = 0x16000000,
      OBJCIMPL_SEC     = 0x17000000,
      DIRDOC_SEC       = 0x18000000
      ,EXPORTED_INTERFACE_SEC = 0x19000000
      ,INCLUDED_SERVICE_SEC = 0x1A000000
    };

Constructor & Destructor Documentation

Entry::Entry ( )

Definition at line 36 of file entry.cpp.

References anchors, argList, EMPTY_SEC, extends, GROUPDOC_NORMAL, groupDocType, groups, hidden, m_parent, m_sublist, mGrpId, num, relatesType, reset(), section, Simple, sli, tagInfo, tArgLists, and typeConstr.

Referenced by Entry(), and getSize().

{
  //printf("Entry::Entry(%p)\n",this);
  num++;
  m_parent=0;
  section = EMPTY_SEC;
  m_sublist = new QList<Entry>;
  m_sublist->setAutoDelete(TRUE);
  extends = new QList<BaseInfo>;
  extends->setAutoDelete(TRUE);
  groups = new QList<Grouping>;
  groups->setAutoDelete(TRUE);
  anchors = new QList<SectionInfo>; // Doxygen::sectionDict takes ownership of the items!
  argList = new ArgumentList;
  argList->setAutoDelete(TRUE);
  //printf("Entry::Entry() tArgList=0\n");
  tArgLists = 0;
  typeConstr = 0;
  mGrpId = -1;
  tagInfo = 0;
  sli = 0;
  relatesType = Simple;
  hidden = FALSE;
  groupDocType = GROUPDOC_NORMAL;
  reset();
}

Entry::Entry ( const Entry & e )

Definition at line 63 of file entry.cpp.

References anchors, argList, args, artificial, bitfields, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, copyArgumentLists(), ArgumentList::deepCopy(), doc, docFile, docLine, endBodyLine, Entry(), exception, explicitExternal, extends, fileName, groupDocType, groups, hidden, id, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, lang, m_parent, m_sublist, mGrpId, mtype, name, num, program, protection, proto, read, relates, relatesType, section, sli, spec, startColumn, startLine, stat, subGrouping, tagInfo, tArgLists, type, typeConstr, virt, and write.

{
  //printf("Entry::Entry(%p):copy\n",this);
  num++;
  section     = e.section;
  type        = e.type;
  name        = e.name;
  tagInfo     = e.tagInfo;
  protection  = e.protection;
  mtype       = e.mtype;
  spec        = e.spec;
  initLines   = e.initLines;
  stat        = e.stat;
  explicitExternal = e.explicitExternal;
  proto       = e.proto;
  subGrouping = e.subGrouping;
  callGraph   = e.callGraph;
  callerGraph = e.callerGraph;
  virt        = e.virt;
  args        = e.args;
  bitfields   = e.bitfields;
  argList     = e.argList->deepCopy();
  tArgLists = 0;
  program     = e.program;
  initializer = e.initializer;
  includeFile = e.includeFile;
  includeName = e.includeName;
  doc         = e.doc;
  docLine     = e.docLine;
  docFile     = e.docFile;
  brief       = e.brief;
  briefLine   = e.briefLine;
  briefFile   = e.briefFile;
  inbodyDocs  = e.inbodyDocs;
  inbodyLine  = e.inbodyLine;
  inbodyFile  = e.inbodyFile;
  relates     = e.relates;
  relatesType = e.relatesType;
  read        = e.read;
  write       = e.write;
  inside      = e.inside;
  exception   = e.exception;
  typeConstr  = 0;
  bodyLine    = e.bodyLine;
  endBodyLine = e.endBodyLine;
  mGrpId      = e.mGrpId;
  extends     = new QList<BaseInfo>;
  extends->setAutoDelete(TRUE);
  groups      = new QList<Grouping>;
  groups->setAutoDelete(TRUE);
  anchors     = new QList<SectionInfo>;
  fileName    = e.fileName;
  startLine   = e.startLine;
  startColumn = e.startColumn;
  if (e.sli)
  {
    sli = new QList<ListItemInfo>;
    sli->setAutoDelete(TRUE);
    QListIterator<ListItemInfo> slii(*e.sli);
    ListItemInfo *ili;
    for (slii.toFirst();(ili=slii.current());++slii)
    {
      sli->append(new ListItemInfo(*ili));
    }
  }
  else
  {
    sli=0;
  }
  lang        = e.lang;
  hidden      = e.hidden;
  artificial  = e.artificial;
  groupDocType = e.groupDocType;
  id          = e.id;
  m_parent    = e.m_parent;
  m_sublist   = new QList<Entry>;
  m_sublist->setAutoDelete(TRUE);
  // deep copy of the child entry list
  QListIterator<Entry> eli(*e.m_sublist);
  Entry *cur;
  for (;(cur=eli.current());++eli)
  {
    m_sublist->append(new Entry(*cur));
  }
  
  // deep copy base class list
  QListIterator<BaseInfo> bli(*e.extends);
  BaseInfo *bi;
  for (;(bi=bli.current());++bli)
  {
    extends->append(new BaseInfo(*bi));
  }
  
  // deep copy group list
  QListIterator<Grouping> gli(*e.groups);
  Grouping *g;
  for (;(g=gli.current());++gli)
  {
    groups->append(new Grouping(*g));
  }
  
  QListIterator<SectionInfo> sli2(*e.anchors);
  SectionInfo *s;
  for (;(s=sli2.current());++sli2)
  {
    anchors->append(new SectionInfo(*s));
  }
  // deep copy type constraint list
  if (e.typeConstr)
  {
    typeConstr  = e.typeConstr->deepCopy();
  }
  // deep copy template argument lists
  if (e.tArgLists)
  {
    tArgLists = copyArgumentLists(e.tArgLists);
  }
}

Entry::~Entry ( )

Definition at line 187 of file entry.cpp.

References anchors, argList, extends, groups, m_sublist, num, sli, tagInfo, tArgLists, and typeConstr.

{
  //printf("Entry::~Entry(%p) num=%d\n",this,num);
  //printf("Deleting entry %d name %s type %x children %d\n",
  //       num,name.data(),section,sublist->count());
  
  delete m_sublist; // each element is now own by a EntryNav so we do no longer own
                  // our children.
  delete extends;
  delete groups;
  delete anchors;
  delete argList;
  delete tArgLists;
  delete tagInfo;
  delete typeConstr;
  delete sli;
  num--;
}

Member Function Documentation

void Entry::addSpecialListItem	(	const char *	listName,
		int	index
	)

Definition at line 309 of file entry.cpp.

References ListItemInfo::itemId, sli, and ListItemInfo::type.

{
  if (sli==0)
  {
    sli = new QList<ListItemInfo>;
    sli->setAutoDelete(TRUE);
  }
  ListItemInfo *ili=new ListItemInfo;
  ili->type = listName;
  ili->itemId = itemId;
  sli->append(ili);
}

void Entry::addSubEntry ( Entry * e )

Adds entry e as a child to this entry

Definition at line 206 of file entry.cpp.

References m_parent, and m_sublist.

Referenced by TagFileParser::buildLists(), TagFileParser::buildMemberList(), initUCF(), makeInlineDoc(), MarkdownFileParser::parseInput(), and unmarshalEntryTree().

{
  //printf("Entry %d with name %s type 0x%x added to %s type 0x%x\n",
  //    current->num,current->name.data(),current->section,
  //    name.data(),section);
  //printf("Entry::addSubEntry(%s:%p) to %s\n",current->name.data(),
  //    current,name.data());
  current->m_parent=this;
  m_sublist->append(current);  
}

const QList<Entry>* Entry::children ( ) const

inline

Returns the list of children for this Entry

See Also: addSubEntry() and removeSubEntry()

Definition at line 210 of file entry.h.

References m_sublist.

Referenced by getEntryAtLine(), and marshalEntryTree().

{ return m_sublist; }

void Entry::createNavigationIndex	(	EntryNav *	rootNav,
		FileStorage *	storage,
		FileDef *	fd
	)

Definition at line 304 of file entry.cpp.

References createSubtreeIndex().

Referenced by parseFile(), and parseInput().

{
  createSubtreeIndex(rootNav,storage,fd);
}

void Entry::createSubtreeIndex	(	EntryNav *	nav,
		FileStorage *	storage,
		FileDef *	fd
	)

private

Definition at line 284 of file entry.cpp.

References EntryNav::addChild(), createSubtreeIndex(), m_sublist, EntryNav::saveEntry(), and EntryNav::setFileDef().

Referenced by createNavigationIndex(), and createSubtreeIndex().

{
  EntryNav *childNav = new EntryNav(nav,this);
  nav->addChild(childNav);
  childNav->setFileDef(fd);
  childNav->saveEntry(this,storage);
  if (m_sublist)
  {
    //printf("saveEntry: %d children\n",node->sublist->count());
    QListIterator<Entry> eli(*m_sublist);
    Entry *childNode;
    for (eli.toFirst();(childNode=eli.current());++eli)
    {
      childNode->createSubtreeIndex(childNav,storage,fd);
    }
    //m_sublist->setAutoDelete(FALSE);
    m_sublist->clear();
  }
}

int Entry::getSize ( )

Returns the static size of the Entry (so excluding any dynamic memory)

Definition at line 279 of file entry.cpp.

References Entry().

{
  return sizeof(Entry);
}

const char* Entry::groupDocCmd ( ) const

inline

return the command name used to define GROUPDOC_SEC

Definition at line 296 of file entry.h.

References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_WEAK, and groupDocType.

    {
      switch( groupDocType ) 
      {
        case GROUPDOC_NORMAL: return "\\defgroup";
        case GROUPDOC_ADD: return "\\addgroup";
        case GROUPDOC_WEAK: return "\\weakgroup";
        default: return "unknown group command";
      }
    }

Grouping::GroupPri_t Entry::groupingPri ( ) const

inline

Definition at line 306 of file entry.h.

References GROUPDOC_ADD, GROUPDOC_NORMAL, GROUPDOC_SEC, GROUPDOC_WEAK, groupDocType, Grouping::GROUPING_AUTO_ADD, Grouping::GROUPING_AUTO_DEF, Grouping::GROUPING_AUTO_WEAK, Grouping::GROUPING_LOWEST, and section.

    {
      if( section != GROUPDOC_SEC ) 
      {
        return Grouping::GROUPING_LOWEST;
      }
      switch( groupDocType ) 
      {
        case GROUPDOC_NORMAL: return Grouping::GROUPING_AUTO_DEF;
        case GROUPDOC_ADD:    return Grouping::GROUPING_AUTO_ADD;
        case GROUPDOC_WEAK:   return Grouping::GROUPING_AUTO_WEAK;
        default: return Grouping::GROUPING_LOWEST;
      }
    }

void Entry::marshall ( StorageIntf * )

Serialize this entry to a persistent storage stream.

Entry& Entry::operator= ( const Entry & )

private

Entry* Entry::parent ( ) const

inline

Returns the parent for this Entry or 0 if this entry has no parent.

Definition at line 205 of file entry.h.

References m_parent.

Referenced by setParent().

{ return m_parent; }

Entry * Entry::removeSubEntry ( Entry * e )

Removes entry e from the list of children. Returns a pointer to the entry or 0 if the entry was not a child. Note the entry will not be deleted.

Definition at line 322 of file entry.cpp.

References m_sublist.

{
 int i = m_sublist->find(e);
 return i!=-1 ? m_sublist->take(i) : 0;
}

void Entry::reset ( )

Restore the state of this Entry to the default value it has at construction time.

Definition at line 217 of file entry.cpp.

References anchors, argList, args, artificial, bitfields, bodyLine, brief, briefFile, briefLine, callerGraph, callGraph, Config_getBool, doc, docFile, docLine, EMPTY_SEC, endBodyLine, exception, explicitExternal, extends, fileName, GROUPDOC_NORMAL, groupDocType, groups, hidden, inbodyDocs, inbodyFile, inbodyLine, includeFile, includeName, initializer, initLines, inside, lang, m_sublist, Method, mGrpId, mtype, name, Normal, program, protection, proto, Public, relates, relatesType, section, Simple, sli, spec, SrcLangExt_Unknown, startColumn, startLine, stat, subGrouping, tagInfo, tArgLists, type, typeConstr, and virt.

Referenced by Entry(), makeInlineDoc(), and startCodeBlock().

{
  static bool entryCallGraph   = Config_getBool(CALL_GRAPH);
  static bool entryCallerGraph = Config_getBool(CALLER_GRAPH);
  //printf("Entry::reset()\n");
  name.resize(0);
  type.resize(0);
  args.resize(0);
  bitfields.resize(0);
  exception.resize(0);
  program.resize(0);
  includeFile.resize(0);
  includeName.resize(0);
  doc.resize(0);
  docFile.resize(0);
  docLine=-1;
  relates.resize(0);
  relatesType=Simple;
  brief.resize(0);
  briefFile.resize(0);
  briefLine=-1;
  inbodyDocs.resize(0);
  inbodyFile.resize(0);
  inbodyLine=-1;
  inside.resize(0);
  fileName.resize(0);
  initializer.resize(0);
  initLines = -1;
  startLine = 1;
  startColumn = 1;
  bodyLine = -1;
  endBodyLine = -1;
  mGrpId = -1;
  callGraph   = entryCallGraph;
  callerGraph = entryCallerGraph;
  section = EMPTY_SEC;
  mtype   = Method;
  virt    = Normal;
  stat    = FALSE;
  proto   = FALSE;
  explicitExternal = FALSE;
  spec  = 0;
  lang = SrcLangExt_Unknown;
  hidden = FALSE;
  artificial = FALSE;
  subGrouping = TRUE;
  protection = Public;
  groupDocType = GROUPDOC_NORMAL;
  id.resize(0);
  m_sublist->clear();
  extends->clear();
  groups->clear();
  anchors->clear();
  argList->clear();
  if (tagInfo)    { delete tagInfo; tagInfo=0; }
  if (tArgLists)  { delete tArgLists; tArgLists=0; }
  if (sli)        { delete sli; sli=0; }
  if (typeConstr) { delete typeConstr; typeConstr=0; }
  //if (mtArgList) { delete mtArgList; mtArgList=0; }
}

void Entry::setParent ( Entry * parent )

inline

Definition at line 202 of file entry.h.

References m_parent, and parent().

{ m_parent = parent; }

void Entry::unmarshall ( StorageIntf * )

Reinitialize this entry from a persistent storage stream.

Member Data Documentation

const uint64 Entry::Abstract = (1ULL<<32)

static

Definition at line 151 of file entry.h.

Referenced by MemberDef::isAbstract(), and ClassDef::isAbstract().

const uint64 Entry::AbstractClass = (1ULL<<11)

static

Definition at line 132 of file entry.h.

const uint64 Entry::Addable = (1ULL<<33)

static

Definition at line 152 of file entry.h.

Referenced by MemberDef::isAddable().

const uint64 Entry::Alias = (1ULL<<49)

static

Definition at line 168 of file entry.h.

Referenced by addMethodToClass(), addVariable(), addVariableToClass(), addVariableToFile(), and MemberDef::isAlias().

QList<SectionInfo>* Entry::anchors

list of anchors defined in this entry

Definition at line 281 of file entry.h.

Referenced by addClassToContext(), TagFileParser::addDocAnchors(), addEnumValuesToEnums(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMainPageTagFiles(), findMember(), findUsingDeclImports(), findUsingDirectives(), marshalEntry(), processBlocks(), reset(), unmarshalEntry(), writeOneLineHeaderOrRuler(), and ~Entry().

ArgumentList* Entry::argList

member arguments as a list

Definition at line 254 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), buildFunctionList(), TagFileParser::buildMemberList(), Entry(), findGlobalMember(), findMember(), isVarWithConstructor(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

QCString Entry::args

member argument string

Definition at line 252 of file entry.h.

Referenced by addEnumValuesToEnums(), addMethodToClass(), addRelatedPage(), addSTLClasses(), addVariable(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFunctionList(), buildInterfaceAndServiceList(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildPageList(), VhdlDocGen::computeVhdlComponentRelations(), Entry(), filterMemberDocumentation(), findDefineDocumentation(), findEnums(), findMainPage(), findObjCMethodDefinitions(), initUCF(), marshalEntry(), reset(), and unmarshalEntry().

bool Entry::artificial

Artificially introduced item.

Definition at line 288 of file entry.h.

Referenced by addClassToContext(), addSTLClasses(), addSTLIterator(), addSTLMember(), addVariableToClass(), buildNamespaceList(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Assign = (1ULL<<45)

static

Definition at line 164 of file entry.h.

Referenced by MemberDef::isAssign().

const uint64 Entry::Attribute = (1ULL<<54)

static

Definition at line 173 of file entry.h.

Referenced by MemberDef::isAttribute(), and MemberDef::isDetailedSectionLinkable().

QCString Entry::bitfields

member's bit fields

Definition at line 253 of file entry.h.

Referenced by addVariableToClass(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

int Entry::bodyLine

line number of the definition in the source

Definition at line 276 of file entry.h.

Referenced by addClassToContext(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), buildNamespaceList(), Entry(), findDefineDocumentation(), findEnums(), findMember(), initUCF(), marshalEntry(), reset(), startCodeBlock(), and unmarshalEntry().

const uint64 Entry::Bound = (1ULL<<57)

static

Definition at line 176 of file entry.h.

Referenced by MemberDef::isBound().

QCString Entry::brief

QCString Entry::briefFile

file in which the brief desc. was found

Definition at line 265 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), initUCF(), marshalEntry(), reset(), and unmarshalEntry().

int Entry::briefLine

line number at which the brief desc. was found

Definition at line 264 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), checkMultiComment(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), initUCF(), marshalEntry(), reset(), and unmarshalEntry().

bool Entry::callerGraph

do we need to draw the caller graph?

Definition at line 250 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), Entry(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

bool Entry::callGraph

do we need to draw the call graph?

Definition at line 249 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), Entry(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Category = (1ULL<<9)

static

Definition at line 130 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

const uint64 Entry::ConstExp = (1ULL<<50)

static

Definition at line 169 of file entry.h.

const uint64 Entry::Constrained = (1ULL<<58)

static

Definition at line 177 of file entry.h.

Referenced by MemberDef::isConstrained().

const uint64 Entry::Copy = (1ULL<<43)

static

Definition at line 162 of file entry.h.

Referenced by MemberDef::isCopy().

const uint64 Entry::Default = (1ULL<<51)

static

Definition at line 170 of file entry.h.

Referenced by MemberDef::isDefault().

const uint64 Entry::Delete = (1ULL<<52)

static

Definition at line 171 of file entry.h.

Referenced by MemberDef::isDelete().

QCString Entry::doc

documentation block (partly parsed)

Definition at line 260 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addIncludeFile(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMemberToGroups(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), makeInlineDoc(), marshalEntry(), reset(), and unmarshalEntry().

QCString Entry::docFile

file in which the documentation was found

Definition at line 262 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), marshalEntry(), MarkdownFileParser::parseInput(), reset(), and unmarshalEntry().

int Entry::docLine

line number at which the documentation was found

Definition at line 261 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), findUsingDirectives(), marshalEntry(), MarkdownFileParser::parseInput(), reset(), and unmarshalEntry().

int Entry::endBodyLine

line number where the definition ends

Definition at line 277 of file entry.h.

Referenced by addClassToContext(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildNamespaceList(), Entry(), findDefineDocumentation(), findEnums(), findMember(), makeInlineDoc(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Enum = (1ULL<<12)

static

Definition at line 133 of file entry.h.

Referenced by addClassToContext(), and TagFileParser::buildLists().

const uint64 Entry::Exception = (1ULL<<7)

static

Definition at line 128 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

QCString Entry::exception

throw specification

Definition at line 274 of file entry.h.

Referenced by addMethodToClass(), addVariableToClass(), assignBinding(), buildFunctionList(), Entry(), filterMemberDocumentation(), marshalEntry(), reset(), unmarshalEntry(), writeExceptionList(), and writeExceptionListImpl().

const uint64 Entry::Explicit = (1ULL<<25)

static

Definition at line 144 of file entry.h.

Referenced by findMember(), and MemberDef::isExplicit().

bool Entry::explicitExternal

explicitly defined as external?

Definition at line 246 of file entry.h.

Referenced by addEnumValuesToEnums(), addVariableToFile(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

QList<BaseInfo>* Entry::extends

list of base classes

Definition at line 279 of file entry.h.

Referenced by addSTLClasses(), TagFileParser::buildLists(), computePageRelations(), computeTemplateClassRelations(), Entry(), findBaseClassesForClass(), isClassSection(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

QCString Entry::fileName

file this entry was extracted from

Definition at line 282 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addGroupToGroups(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMemberToGroups(), addMethodToClass(), addSTLClasses(), addSTLIterator(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildNamespaceList(), computeClassRelations(), Entry(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMainPage(), findMember(), findTemplateInstanceRelation(), findUsingDeclImports(), findUsingDirectives(), initUCF(), makeInlineDoc(), marshalEntry(), MarkdownFileParser::parseInput(), reset(), unmarshalEntry(), res2cc_cmd.VerbatimFile::writeDirEntry(), res2cc_cmd.CSSFile::writeDirEntry(), res2cc_cmd.LumFile::writeDirEntry(), and res2cc_cmd.LumaFile::writeDirEntry().

const uint64 Entry::Final = (1ULL<<31)

static

Definition at line 150 of file entry.h.

Referenced by MemberDef::isFinal(), and ClassDef::isFinal().

const uint64 Entry::ForwardDecl = (1ULL<<15)

static

Definition at line 136 of file entry.h.

Referenced by addClassToContext(), and ClassDef::isForwardDeclared().

const uint64 Entry::Generic = (1ULL<<1)

static

Definition at line 122 of file entry.h.

const uint64 Entry::Gettable = (1ULL<<28)

static

Definition at line 147 of file entry.h.

Referenced by MemberDef::isGettable().

GroupDocType Entry::groupDocType

Definition at line 289 of file entry.h.

Referenced by buildGroupListFiltered(), Entry(), groupDocCmd(), groupingPri(), marshalEntry(), organizeSubGroupsFiltered(), reset(), and unmarshalEntry().

QList<Grouping>* Entry::groups

list of groups this entry belongs to

Definition at line 280 of file entry.h.

Referenced by addClassToGroups(), addDirToGroups(), addExampleToGroups(), addGroupToGroups(), addMemberToGroups(), addNamespaceToGroups(), addRelatedPage(), buildFileList(), buildFunctionList(), TagFileParser::buildMemberList(), Entry(), findEnumDocumentation(), findUsingDirectives(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

bool Entry::hidden

does this represent an entity that is hidden from the output

Definition at line 287 of file entry.h.

Referenced by addClassToContext(), addSTLClasses(), addSTLIterator(), addSTLMember(), addVariableToClass(), buildNamespaceList(), Entry(), findUsingDirectives(), marshalEntry(), reset(), and unmarshalEntry().

QCString Entry::id

libclang id

Definition at line 290 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildNamespaceList(), Entry(), findEnums(), findMember(), findUsingDeclImports(), findUsingDirectives(), marshalEntry(), and unmarshalEntry().

QCString Entry::inbodyDocs

documentation inside the body of a function

Definition at line 266 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFunctionList(), buildGroupListFiltered(), Entry(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMainPage(), findMember(), findUsingDeclImports(), makeInlineDoc(), marshalEntry(), reset(), and unmarshalEntry().

QCString Entry::inbodyFile

file in which the body doc was found

Definition at line 268 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildGroupListFiltered(), Entry(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

int Entry::inbodyLine

line number at which the body doc was found

Definition at line 267 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildGroupListFiltered(), Entry(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

QCString Entry::includeFile

include file (2 arg of \class, must be unique)

Definition at line 258 of file entry.h.

Referenced by addIncludeFile(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

QCString Entry::includeName

include name (3 arg of \class)

Definition at line 259 of file entry.h.

Referenced by addIncludeFile(), VhdlDocGen::computeVhdlComponentRelations(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

QGString Entry::initializer

initial value (for variables)

Definition at line 257 of file entry.h.

Referenced by addEnumValuesToEnums(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

int Entry::initLines

define/variable initializer lines to show

Definition at line 244 of file entry.h.

Referenced by addEnumValuesToEnums(), addMemberDocs(), addVariableToClass(), addVariableToFile(), Entry(), findDefineDocumentation(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Initonly = (1ULL<<39)

static

Definition at line 158 of file entry.h.

Referenced by MemberDef::isInitonly().

const uint64 Entry::Inline = (1ULL<<24)

static

Definition at line 143 of file entry.h.

Referenced by findMember(), MemberDef::getLabels(), and MemberDef::isInline().

QCString Entry::inside

name of the class in which documents are found

Definition at line 273 of file entry.h.

Referenced by Entry(), filterMemberDocumentation(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Interface = (1ULL<<4)

static

Definition at line 125 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

SrcLangExt Entry::lang

programming language in which this entry was found

Definition at line 286 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), addRelatedPage(), addVariable(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFunctionList(), buildGroupListFiltered(), TagFileParser::buildLists(), buildNamespaceList(), Entry(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findEnums(), findMember(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDeclImports(), findUsingDirectives(), initUCF(), makeInlineDoc(), marshalEntry(), MarkdownFileParser::parseInput(), reset(), and unmarshalEntry().

Entry* Entry::m_parent

private

parent node in the tree

Definition at line 323 of file entry.h.

Referenced by addSubEntry(), Entry(), parent(), and setParent().

QList<Entry>* Entry::m_sublist

private

entries that are children of this one

Definition at line 324 of file entry.h.

Referenced by addSubEntry(), children(), createSubtreeIndex(), Entry(), removeSubEntry(), reset(), and ~Entry().

const uint64 Entry::MaybeAmbiguous = (1ULL<<62)

static

Definition at line 181 of file entry.h.

Referenced by MemberDef::isMaybeAmbiguous().

const uint64 Entry::MaybeDefault = (1ULL<<61)

static

Definition at line 180 of file entry.h.

Referenced by MemberDef::isMaybeDefault().

const uint64 Entry::MaybeVoid = (1ULL<<60)

static

Definition at line 179 of file entry.h.

Referenced by MemberDef::isMaybeVoid().

int Entry::mGrpId

member group id

Definition at line 278 of file entry.h.

Referenced by addEnumValuesToEnums(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), filterMemberDocumentation(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

MethodTypes Entry::mtype

signal, slot, (dcop) method, or property?

Definition at line 242 of file entry.h.

Referenced by addMethodToClass(), addVariable(), addVariableToClass(), TagFileParser::buildMemberList(), Entry(), findMember(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Mutable = (1ULL<<26)

static

Definition at line 145 of file entry.h.

Referenced by findMember(), and MemberDef::isMutable().

QCString Entry::name

member name

Definition at line 237 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addRelatedPage(), addSTLClasses(), addSTLIterator(), addSTLMember(), addVariable(), addVariableToFile(), assignBinding(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildListOfUsingDecls(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildNamespaceList(), buildPageList(), computeClassRelations(), computePageRelations(), computeTemplateClassRelations(), Entry(), filterMemberDocumentation(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMember(), findObjCMethodDefinitions(), findTemplateInstanceRelation(), findUsingDeclarations(), findUsingDirectives(), initUCF(), EntryNav::loadEntry(), marshalEntry(), organizeSubGroupsFiltered(), reset(), startCodeBlock(), and unmarshalEntry().

const uint64 Entry::New = (1ULL<<37)

static

Definition at line 156 of file entry.h.

Referenced by MemberDef::isNew().

const uint64 Entry::NoExcept = (1ULL<<53)

static

Definition at line 172 of file entry.h.

Referenced by MemberDef::isNoExcept().

const uint64 Entry::NonAtomic = (1ULL<<42)

static

Definition at line 161 of file entry.h.

Referenced by MemberDef::isNonAtomic().

int Entry::num =0

static

counts the total number of entries

Definition at line 293 of file entry.h.

Referenced by Entry(), and ~Entry().

const uint64 Entry::Optional = (1ULL<<40)

static

Definition at line 159 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), and MemberDef::isOptional().

const uint64 Entry::Override = (1ULL<<36)

static

Definition at line 155 of file entry.h.

Referenced by MemberDef::isOverride().

const uint64 Entry::PrivateGettable = (1ULL<<20)

static

Definition at line 139 of file entry.h.

Referenced by MemberDef::isPrivateGettable().

const uint64 Entry::PrivateSettable = (1ULL<<22)

static

Definition at line 141 of file entry.h.

Referenced by MemberDef::isPrivateSettable().

QGString Entry::program

the program text

Definition at line 256 of file entry.h.

Referenced by Entry(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Property = (1ULL<<55)

static

Definition at line 174 of file entry.h.

Referenced by MemberDef::isDetailedSectionLinkable(), and MemberDef::isUNOProperty().

const uint64 Entry::ProtectedGettable = (1ULL<<21)

static

Definition at line 140 of file entry.h.

Referenced by MemberDef::isProtectedGettable().

const uint64 Entry::ProtectedSettable = (1ULL<<23)

static

Definition at line 142 of file entry.h.

Referenced by MemberDef::isProtectedSettable().

Protection Entry::protection

class protection

Definition at line 241 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addIncludeFile(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), addSTLClasses(), addSTLMember(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), TagFileParser::buildMemberList(), computeClassRelations(), Entry(), findEnums(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

bool Entry::proto

prototype ?

Definition at line 247 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), findDefineDocumentation(), findEnumDocumentation(), findEnums(), findMember(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Protocol = (1ULL<<8)

static

Definition at line 129 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

const uint64 Entry::Published = (1ULL<<63)

static

Definition at line 182 of file entry.h.

Referenced by buildNamespaceList(), MemberDef::isPublished(), and ClassDef::isPublished().

const uint64 Entry::Raisable = (1ULL<<35)

static

Definition at line 154 of file entry.h.

Referenced by MemberDef::isRaisable().

QCString Entry::read

property read accessor

Definition at line 271 of file entry.h.

Referenced by addVariableToClass(), Entry(), marshalEntry(), and unmarshalEntry().

const uint64 Entry::Readable = (1ULL<<29)

static

Definition at line 148 of file entry.h.

Referenced by MemberDef::isReadable().

const uint64 Entry::Readonly = (1ULL<<56)

static

Definition at line 175 of file entry.h.

Referenced by MemberDef::isReadonly().

const uint64 Entry::Ref = (1ULL<<2)

static

Definition at line 123 of file entry.h.

QCString Entry::relates

related class (doc block)

Definition at line 269 of file entry.h.

Referenced by addEnumValuesToEnums(), addMethodToClass(), addVariable(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), filterMemberDocumentation(), findEnums(), findMember(), marshalEntry(), reset(), and unmarshalEntry().

RelatesType Entry::relatesType

how relates is handled

Definition at line 270 of file entry.h.

Referenced by addMethodToClass(), addVariable(), buildFunctionList(), buildInterfaceAndServiceList(), Entry(), filterMemberDocumentation(), findEnums(), findGlobalMember(), findMember(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Removable = (1ULL<<34)

static

Definition at line 153 of file entry.h.

Referenced by MemberDef::isRemovable().

const uint64 Entry::Required = (1ULL<<41)

static

Definition at line 160 of file entry.h.

Referenced by MemberDef::isRequired().

const uint64 Entry::Retain = (1ULL<<44)

static

Definition at line 163 of file entry.h.

Referenced by MemberDef::isRetain().

const uint64 Entry::Sealed = (1ULL<<38)

static

Definition at line 157 of file entry.h.

Referenced by MemberDef::isSealed(), and ClassDef::isSealed().

const uint64 Entry::SealedClass = (1ULL<<10)

static

Definition at line 131 of file entry.h.

int Entry::section

entry type (see Sections);

Definition at line 235 of file entry.h.

Referenced by addClassToContext(), addSTLClasses(), addSTLIterator(), addSTLMember(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildNamespaceList(), computePageRelations(), Entry(), filterMemberDocumentation(), findGlobalMember(), findMember(), findObjCMethodDefinitions(), findUsingDeclarations(), groupingPri(), initUCF(), EntryNav::loadEntry(), makeInlineDoc(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Service = (1ULL<<13)

static

Definition at line 134 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

const uint64 Entry::Settable = (1ULL<<27)

static

Definition at line 146 of file entry.h.

Referenced by MemberDef::isSettable().

const uint64 Entry::Singleton = (1ULL<<14)

static

Definition at line 135 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

QList<ListItemInfo>* Entry::sli

special lists (test/todo/bug/deprecated/..) this entry is in

Definition at line 285 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addRelatedPage(), addSpecialListItem(), addVariableToClass(), addVariableToFile(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildNamespaceList(), buildPageList(), Entry(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findMember(), findUsingDirectives(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

uint64 Entry::spec

class/member specifiers

Definition at line 243 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMethodToClass(), addVariable(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), TagFileParser::buildLists(), TagFileParser::buildMemberList(), buildNamespaceList(), Entry(), filterMemberDocumentation(), findEnums(), findMember(), initUCF(), VhdlDocGen::isVhdlClass(), makeInlineDoc(), marshalEntry(), reset(), and unmarshalEntry().

int Entry::startColumn

start column of entry in the source

Definition at line 284 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildNamespaceList(), Entry(), findClassRelation(), findEnums(), findMember(), findTemplateInstanceRelation(), findUsingDeclImports(), findUsingDirectives(), and reset().

int Entry::startLine

start line of entry in the source

Definition at line 283 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addGroupToGroups(), addIncludeFile(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMemberDocs(), addMemberToGroups(), addMethodToClass(), addSTLClasses(), addSTLIterator(), addVariableToClass(), addVariableToFile(), buildExampleList(), buildFileList(), buildFunctionList(), buildGroupListFiltered(), buildInterfaceAndServiceList(), buildNamespaceList(), computeClassRelations(), Entry(), findClassRelation(), findDefineDocumentation(), findDirDocumentation(), findEnumDocumentation(), findEnums(), findGlobalMember(), findMainPage(), findMember(), findTemplateInstanceRelation(), findUsingDeclImports(), findUsingDirectives(), marshalEntry(), reset(), startCodeBlock(), and unmarshalEntry().

bool Entry::stat

static ?

Definition at line 245 of file entry.h.

Referenced by addClassToContext(), addEnumValuesToEnums(), addInstance(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), addRelatedPage(), addVariableToClass(), addVariableToFile(), assignBinding(), buildFunctionList(), TagFileParser::buildMemberList(), VhdlDocGen::computeVhdlComponentRelations(), Entry(), findMainPage(), findMember(), marshalEntry(), processLink(), reset(), and unmarshalEntry().

const uint64 Entry::Strong = (1ULL<<46)

static

Definition at line 165 of file entry.h.

Referenced by addEnumValuesToEnums(), TagFileParser::buildMemberList(), and MemberDef::isStrong().

const uint64 Entry::Struct = (1ULL<<5)

static

Definition at line 126 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

bool Entry::subGrouping

automatically group class members?

Definition at line 248 of file entry.h.

Referenced by addClassToContext(), Entry(), marshalEntry(), reset(), and unmarshalEntry().

TagInfo* Entry::tagInfo

tag file info

Definition at line 238 of file entry.h.

Referenced by TagFileParser::buildLists(), TagFileParser::buildMemberList(), Entry(), EntryNav::EntryNav(), reset(), and ~Entry().

QList<ArgumentList>* Entry::tArgLists

template argument declarations

Definition at line 255 of file entry.h.

Referenced by addClassToContext(), addMethodToClass(), addSTLClasses(), addVariableToClass(), addVariableToFile(), buildFunctionList(), buildInterfaceAndServiceList(), TagFileParser::buildLists(), Entry(), findGlobalMember(), findMember(), findUsingDeclarations(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

const uint64 Entry::Template = (1ULL<<0)

static

Definition at line 121 of file entry.h.

const uint64 Entry::Transient = (1ULL<<59)

static

Definition at line 178 of file entry.h.

Referenced by MemberDef::isTransient().

ArgumentList* Entry::typeConstr

where clause (C#) for type constraints

Definition at line 275 of file entry.h.

Referenced by addClassToContext(), addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), buildFunctionList(), Entry(), findMember(), marshalEntry(), reset(), unmarshalEntry(), and ~Entry().

const uint64 Entry::Union = (1ULL<<6)

static

Definition at line 127 of file entry.h.

Referenced by TagFileParser::buildLists(), and convertToCompoundType().

const uint64 Entry::Unretained = (1ULL<<48)

static

Definition at line 167 of file entry.h.

Referenced by MemberDef::isUnretained().

const uint64 Entry::Value = (1ULL<<3)

static

Definition at line 124 of file entry.h.

Specifier Entry::virt

virtualness of the entry

Definition at line 251 of file entry.h.

Referenced by addInterfaceOrServiceToServiceOrSingleton(), addMethodToClass(), buildFunctionList(), TagFileParser::buildMemberList(), Entry(), findMember(), findUsingDeclImports(), marshalEntry(), reset(), and unmarshalEntry().

const uint64 Entry::Weak = (1ULL<<47)

static

Definition at line 166 of file entry.h.

Referenced by MemberDef::isWeak().

const uint64 Entry::Writable = (1ULL<<30)

static

Definition at line 149 of file entry.h.

Referenced by MemberDef::isWritable().

QCString Entry::write

property write accessor

Definition at line 272 of file entry.h.

Referenced by addInstance(), addVariableToClass(), Entry(), marshalEntry(), and unmarshalEntry().

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation