CompoundHandler Class Reference

#include <compoundhandler.h>

Inheritance diagram for CompoundHandler:

Public Member Functions
virtual void	startSection (const QXmlAttributes &attrib)
virtual void	startCompound (const QXmlAttributes &attrib)
virtual void	startSuperClass (const QXmlAttributes &attrib)
virtual void	endSuperClass ()
virtual void	startSubClass (const QXmlAttributes &attrib)
virtual void	endSubClass ()
virtual void	endCompound ()
virtual void	endCompoundName ()
virtual void	startBriefDesc (const QXmlAttributes &attrib)
virtual void	startDetailedDesc (const QXmlAttributes &attrib)
virtual void	startLocation (const QXmlAttributes &attrib)
virtual void	startProgramListing (const QXmlAttributes &attrib)
virtual void	startInheritanceGraph (const QXmlAttributes &attrib)
virtual void	startCollaborationGraph (const QXmlAttributes &attrib)
virtual void	startIncludeDependencyGraph (const QXmlAttributes &attrib)
virtual void	startIncludedByDependencyGraph (const QXmlAttributes &attrib)
virtual void	startIncludes (const QXmlAttributes &attrib)
virtual void	startIncludedBy (const QXmlAttributes &attrib)
virtual void	startInnerDir (const QXmlAttributes &attrib)
virtual void	startInnerClass (const QXmlAttributes &attrib)
virtual void	startInnerNamespace (const QXmlAttributes &attrib)
virtual void	startInnerFile (const QXmlAttributes &attrib)
virtual void	startInnerGroup (const QXmlAttributes &attrib)
virtual void	startInnerPage (const QXmlAttributes &attrib)
virtual void	startTitle (const QXmlAttributes &attrib)
virtual void	startTemplateParamList (const QXmlAttributes &attrib)
virtual void	startListOfAllMembers (const QXmlAttributes &attrib)
virtual void	addref ()
	CompoundHandler (const QString &dirName)
virtual	~CompoundHandler ()
bool	parseXML (const char *compId)
void	initialize (MainHandler *mh)
void	insertMember (MemberHandler *mh)
ICompound *	toICompound () const
const IString *	name () const
const IString *	id () const
CompoundKind	kind () const
const IString *	kindString () const
ISectionIterator *	sections () const
IDocRoot *	briefDescription () const
IDocRoot *	detailedDescription () const
IMember *	memberById (const char *id) const
IMemberIterator *	memberByName (const char *name) const
IParamIterator *	templateParameters () const
void	release ()
IGraph *	inheritanceGraph () const
IGraph *	collaborationGraph () const
IRelatedCompoundIterator *	baseCompounds () const
IRelatedCompoundIterator *	derivedCompounds () const
ICompoundIterator *	nestedCompounds () const
ICompoundIterator *	nestedGroup () const
const IString *	locationFile () const
int	locationLine () const
const IString *	locationBodyFile () const
int	locationBodyStartLine () const
int	locationBodyEndLine () const
IMemberReferenceIterator *	members () const
IGraph *	includeDependencyGraph () const
IGraph *	includedByDependencyGraph () const
IDocProgramListing *	source () const
IIncludeIterator *	includes () const
IIncludeIterator *	includedBy () const
const IDocTitle *	title () const
Public Member Functions inherited from BaseHandler< CompoundHandler >
	BaseHandler ()
virtual	~BaseHandler ()
virtual bool	startDocument ()
virtual bool	startElement (const QString &namespaceURI, const QString &localName, const QString &name, const QXmlAttributes &attrib)
virtual bool	endElement (const QString &namespaceURI, const QString &localName, const QString &name)
bool	skippedEntity (const QString &s)
virtual bool	characters (const QString &ch)
void	setDelegate (QXmlDefaultHandler *delegate)
QXmlDefaultHandler *	delegate () const
void	setFallBackHandler (IFallBackHandler *h)
IFallBackHandler *	fallBackHandler () const
void	setDocumentLocator (QXmlLocator *locator)
Public Member Functions inherited from QXmlDefaultHandler
	QXmlDefaultHandler ()
virtual	~QXmlDefaultHandler ()
bool	endDocument ()
bool	startPrefixMapping (const QString &prefix, const QString &uri)
bool	endPrefixMapping (const QString &prefix)
bool	ignorableWhitespace (const QString &ch)
bool	processingInstruction (const QString &target, const QString &data)
bool	warning (const QXmlParseException &exception)
bool	error (const QXmlParseException &exception)
bool	fatalError (const QXmlParseException &exception)
bool	notationDecl (const QString &name, const QString &publicId, const QString &systemId)
bool	unparsedEntityDecl (const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
bool	resolveEntity (const QString &publicId, const QString &systemId, QXmlInputSource *&ret)
bool	startDTD (const QString &name, const QString &publicId, const QString &systemId)
bool	endDTD ()
bool	startCDATA ()
bool	endCDATA ()
bool	comment (const QString &ch)
bool	attributeDecl (const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)
bool	internalEntityDecl (const QString &name, const QString &value)
bool	externalEntityDecl (const QString &name, const QString &publicId, const QString &systemId)
QString	errorString ()
Public Member Functions inherited from QXmlContentHandler
virtual	~QXmlContentHandler ()
Public Member Functions inherited from QXmlErrorHandler
virtual	~QXmlErrorHandler ()
Public Member Functions inherited from QXmlDTDHandler
virtual	~QXmlDTDHandler ()
Public Member Functions inherited from QXmlEntityResolver
virtual	~QXmlEntityResolver ()
Public Member Functions inherited from QXmlLexicalHandler
virtual	~QXmlLexicalHandler ()
Public Member Functions inherited from QXmlDeclHandler
virtual	~QXmlDeclHandler ()
Public Member Functions inherited from ElementMapper< CompoundHandler >
	ElementMapper ()
virtual	~ElementMapper ()
void	addStartHandler (const char *key)
void	addStartHandler (const char *key, CompoundHandler *obj, void(CompoundHandler::*handler)(const QXmlAttributes &))
void	addEndHandler (const char *key)
void	addEndHandler (const char *key, CompoundHandler *obj, void(CompoundHandler::*handler)())
Public Member Functions inherited from IBaseHandler
virtual	~IBaseHandler ()

Private Attributes
StringImpl	m_name
TitleHandler *	m_titleHandler
QList< RelatedCompound >	m_subClasses
QList< RelatedCompound >	m_superClasses
QList< IncludeHandler >	m_includes
QList< IncludeHandler >	m_includedBy
GraphHandler *	m_includeDependencyGraph
GraphHandler *	m_includedByDependencyGraph
QList< QString >	m_innerCompounds
TemplateParamListHandler *	m_templateParamList
QList< SectionHandler >	m_sections
DocHandler *	m_brief
DocHandler *	m_detailed
GraphHandler *	m_inheritanceGraph
GraphHandler *	m_collaborationGraph
ProgramListingHandler *	m_programListing
StringImpl	m_defFile
int	m_defLine
StringImpl	m_defBodyFile
int	m_defBodyStart
int	m_defBodyEnd
ListOfAllMembersHandler *	m_members
StringImpl	m_id
CompoundKind	m_kind
StringImpl	m_kindString
StringImpl	m_protection
QString	m_xmlDir
int	m_refCount
QDict< MemberHandler >	m_memberDict
QDict< QList< MemberHandler > >	m_memberNameDict
MainHandler *	m_mainHandler

Friends
class	RelatedCompound

Additional Inherited Members
Public Types inherited from ICompound
enum	CompoundKind {   Invalid =0, Class, Struct, Union,   Interface, Protocol, Category, Exception,   File, Namespace, Group, Page,   Example, Dir, Invalid =0, Class,   Struct, Union, Interface, Protocol,   Category, Exception, File, Namespace,   Group, Page, Example, Dir }
enum	CompoundKind {   Invalid =0, Class, Struct, Union,   Interface, Protocol, Category, Exception,   File, Namespace, Group, Page,   Example, Dir, Invalid =0, Class,   Struct, Union, Interface, Protocol,   Category, Exception, File, Namespace,   Group, Page, Example, Dir }
Public Types inherited from BaseHandler< CompoundHandler >
typedef ElementMapper< CompoundHandler >::StartElementHandlerT	StartElementHandlerT
typedef ElementMapper< CompoundHandler >::EndElementHandlerT	EndElementHandlerT
Public Types inherited from ElementMapper< CompoundHandler >
typedef StartElementHandler	StartElementHandlerT
typedef EndElementHandler	EndElementHandlerT
Static Public Attributes inherited from LocatorContainer
static QXmlLocator *	s_theLocator =0
Protected Attributes inherited from BaseHandler< CompoundHandler >
QString	m_curString
QString	m_skipUntil
int	m_skipCount
QXmlDefaultHandler *	m_delegateHandler
IFallBackHandler *	m_fallBackHandler
Protected Attributes inherited from ElementMapper< CompoundHandler >
QDict< StartElementHandlerT >	m_startHandlers
QDict< EndElementHandlerT >	m_endHandlers

Detailed Description

Definition at line 104 of file compoundhandler.h.

Constructor & Destructor Documentation

CompoundHandler::CompoundHandler

(

const QString &

dirName

)

Definition at line 178 of file compoundhandler.cpp.

  : m_titleHandler(0), 
    m_includeDependencyGraph(0), 
    m_includedByDependencyGraph(0), 
    m_templateParamList(0),
    m_brief(0), 
    m_detailed(0), 
    m_inheritanceGraph(0), 
    m_collaborationGraph(0),
    m_programListing(0),
    m_members(0),
    m_xmlDir(xmlDir), 
    m_refCount(1), 
    m_memberDict(257), 
    m_memberNameDict(257),
    m_mainHandler(0)
{
  m_superClasses.setAutoDelete(TRUE);
  m_subClasses.setAutoDelete(TRUE);
  m_sections.setAutoDelete(TRUE);
  m_memberNameDict.setAutoDelete(TRUE);
  m_innerCompounds.setAutoDelete(TRUE);
  m_includes.setAutoDelete(TRUE);
  m_includedBy.setAutoDelete(TRUE);

  addStartHandler("doxygen");
  addEndHandler("doxygen");
  
  addStartHandler("compounddef",this,&CompoundHandler::startCompound);
  addEndHandler("compounddef",this,&CompoundHandler::endCompound);

  addStartHandler("compoundname");
  addEndHandler("compoundname",this,&CompoundHandler::endCompoundName);

  addStartHandler("title",this,&CompoundHandler::startTitle);

  addStartHandler("basecompoundref",this,&CompoundHandler::startSuperClass);
  addEndHandler("basecompoundref",this,&CompoundHandler::endSuperClass);

  addStartHandler("derivedcompoundref",this,&CompoundHandler::startSubClass);
  addEndHandler("derivedcompoundref",this,&CompoundHandler::endSubClass);

  addStartHandler("includes",this,&CompoundHandler::startIncludes);
  addStartHandler("includedby",this,&CompoundHandler::startIncludedBy);

  addStartHandler("incdepgraph",this,&CompoundHandler::startIncludeDependencyGraph);

  addStartHandler("invincdepgraph",this,&CompoundHandler::startIncludedByDependencyGraph);

  addStartHandler("innerdir",this,&CompoundHandler::startInnerDir);
  addEndHandler("innerdir");

  addStartHandler("innerfile",this,&CompoundHandler::startInnerFile);
  addEndHandler("innerfile");

  addStartHandler("innerclass",this,&CompoundHandler::startInnerClass);
  addEndHandler("innerclass");

  addStartHandler("innernamespace",this,&CompoundHandler::startInnerNamespace);
  addEndHandler("innernamespace");

  addStartHandler("innerpage",this,&CompoundHandler::startInnerPage);
  addEndHandler("innerpage");
  
  addStartHandler("innergroup",this,&CompoundHandler::startInnerGroup);
  addEndHandler("innergroup");

  addStartHandler("templateparamlist",this,&CompoundHandler::startTemplateParamList);

  addStartHandler("sectiondef",this,&CompoundHandler::startSection);

  addStartHandler("briefdescription",this,&CompoundHandler::startBriefDesc);

  addStartHandler("detaileddescription",this,&CompoundHandler::startDetailedDesc);
  
  addStartHandler("inheritancegraph",this,&CompoundHandler::startInheritanceGraph);
  
  addStartHandler("collaborationgraph",this,&CompoundHandler::startCollaborationGraph);

  addStartHandler("programlisting",this,&CompoundHandler::startProgramListing);

  addStartHandler("location",this,&CompoundHandler::startLocation);
  addEndHandler("location");

  addStartHandler("listofallmembers",this,&CompoundHandler::startListOfAllMembers);
}

CompoundHandler::~CompoundHandler ( )

virtual

Definition at line 265 of file compoundhandler.cpp.

{
  debug(2,"CompoundHandler::~CompoundHandler()\n");
  delete m_titleHandler;
  delete m_brief;
  delete m_detailed;
  delete m_programListing;
  delete m_inheritanceGraph;
  delete m_collaborationGraph;
  delete m_includeDependencyGraph;
  delete m_includedByDependencyGraph;
  delete m_templateParamList;
  delete m_members;
}

Member Function Documentation

virtual void CompoundHandler::addref ( )

inlinevirtual

Definition at line 146 of file compoundhandler.h.

{ m_refCount++; }

IRelatedCompoundIterator * CompoundHandler::baseCompounds ( ) const

virtual

Implements IClass.

Definition at line 609 of file compoundhandler.cpp.

{
  return new RelatedCompoundIterator(m_superClasses);
}

IDocRoot * CompoundHandler::briefDescription ( ) const

virtual

Returns a tree-structured representation of the brief description that is attached to this compound.

Implements ICompound.

Definition at line 574 of file compoundhandler.cpp.

{ 
  return m_brief; 
}

IGraph * CompoundHandler::collaborationGraph ( ) const

virtual

Implements IClass.

Definition at line 594 of file compoundhandler.cpp.

{ 
  return m_collaborationGraph; 
}

IRelatedCompoundIterator * CompoundHandler::derivedCompounds ( ) const

virtual

Implements IClass.

Definition at line 614 of file compoundhandler.cpp.

{
  return new RelatedCompoundIterator(m_subClasses);
}

IDocRoot * CompoundHandler::detailedDescription ( ) const

virtual

Returns a tree-structured representation of the detailed description that is attached to this compound.

Implements ICompound.

Definition at line 579 of file compoundhandler.cpp.

{ 
  return m_detailed; 
}

void CompoundHandler::endCompound ( )

virtual

Definition at line 331 of file compoundhandler.cpp.

{
   debug(2,"endCompound()\n");
}

void CompoundHandler::endCompoundName ( )

virtual

Definition at line 345 of file compoundhandler.cpp.

{
  m_name = m_curString.stripWhiteSpace();
  debug(2,"Compound name `%s'\n",m_name.data());
}

void CompoundHandler::endSubClass ( )

virtual

Definition at line 453 of file compoundhandler.cpp.

{
  m_subClasses.getLast()->setName(m_curString);
}

void CompoundHandler::endSuperClass ( )

virtual

Definition at line 423 of file compoundhandler.cpp.

{
  m_superClasses.getLast()->setName(m_curString);
}

const IString* CompoundHandler::id ( ) const

inlinevirtual

Returns the id of this compound. The id is a unique string representing a specific compound object.

Implements ICompound.

Definition at line 157 of file compoundhandler.h.

{ return &m_id;   }

IIncludeIterator * CompoundHandler::includedBy ( ) const

virtual

Implements IFile.

Definition at line 634 of file compoundhandler.cpp.

{
  return new IncludeIterator(m_includedBy);
}

IGraph * CompoundHandler::includedByDependencyGraph ( ) const

virtual

Implements IFile.

Definition at line 604 of file compoundhandler.cpp.

{
  return m_includedByDependencyGraph;
}

IGraph * CompoundHandler::includeDependencyGraph ( ) const

virtual

Implements IFile.

Definition at line 599 of file compoundhandler.cpp.

{
  return m_includeDependencyGraph;
}

IIncludeIterator * CompoundHandler::includes ( ) const

virtual

Implements IFile.

Definition at line 629 of file compoundhandler.cpp.

{
  return new IncludeIterator(m_includes);
}

IGraph * CompoundHandler::inheritanceGraph ( ) const

virtual

Implements IClass.

Definition at line 589 of file compoundhandler.cpp.

{ 
  return m_inheritanceGraph; 
}

void CompoundHandler::initialize

(

MainHandler *

mh

)

Definition at line 478 of file compoundhandler.cpp.

{
  m_mainHandler = mh;
  QListIterator<SectionHandler> msi(m_sections);
  SectionHandler *sec;
  for (;(sec=msi.current());++msi)
  {
    sec->initialize(this);
  }
  if (m_members)
  {
    m_members->initialize(mh);
  }
}

void CompoundHandler::insertMember

(

MemberHandler *

mh

)

Definition at line 493 of file compoundhandler.cpp.

{
  m_memberDict.insert(mh->id()->latin1(),mh);
  mh->initialize(m_mainHandler);
  QList<MemberHandler> *mhl = m_memberNameDict.find(mh->id()->latin1());
  if (mhl==0)
  {
    mhl = new QList<MemberHandler>;
    m_memberNameDict.insert(mh->name()->latin1(),mhl);
  }
  mhl->append(mh);
}

CompoundKind CompoundHandler::kind ( ) const

inlinevirtual

Returns the kind of compound. See CompoundKind for possible values.

Implements ICompound.

Definition at line 158 of file compoundhandler.h.

{ return m_kind; }

const IString* CompoundHandler::kindString ( ) const

inlinevirtual

Returns a string representation of the compound kind.

See also

kind()

Implements ICompound.

Definition at line 159 of file compoundhandler.h.

{ return &m_kindString; }

int CompoundHandler::locationBodyEndLine ( ) const

inlinevirtual

Implements IClass.

Definition at line 179 of file compoundhandler.h.

{ return m_defBodyEnd; }

const IString* CompoundHandler::locationBodyFile ( ) const

inlinevirtual

Implements IClass.

Definition at line 177 of file compoundhandler.h.

{ return &m_defBodyFile; }

int CompoundHandler::locationBodyStartLine ( ) const

inlinevirtual

Implements IClass.

Definition at line 178 of file compoundhandler.h.

{ return m_defBodyStart; }

const IString* CompoundHandler::locationFile ( ) const

inlinevirtual

Implements IClass.

Definition at line 175 of file compoundhandler.h.

{ return &m_defFile; }

int CompoundHandler::locationLine ( ) const

inlinevirtual

Implements IClass.

Definition at line 176 of file compoundhandler.h.

{ return m_defLine; }

IMember * CompoundHandler::memberById ( const char *  id ) const

virtual

Returns an interface to a member given its id.

Parameters

id	The member id.

Implements ICompound.

Definition at line 584 of file compoundhandler.cpp.

{ 
  return (IFunction*)m_memberDict[id]; 
}

IMemberIterator * CompoundHandler::memberByName ( const char *  name ) const

virtual

Returns a list of all members within the compound having a certain name. Member overloading is the reason why there can be more than one member.

Parameters

name	The name of the member.

Implements ICompound.

Definition at line 543 of file compoundhandler.cpp.

{ 
  QList<MemberHandler> *ml = m_memberNameDict[name]; 
  if (ml==0) return 0;
  return new MemberIterator(*ml);
}

IMemberReferenceIterator * CompoundHandler::members

(

)

const

Definition at line 649 of file compoundhandler.cpp.

{
  return m_members ? m_members->members() : 0;
}

const IString* CompoundHandler::name ( ) const

inlinevirtual

Returns the name of this compound

Implements ICompound.

Definition at line 156 of file compoundhandler.h.

{ return &m_name; }

ICompoundIterator * CompoundHandler::nestedCompounds ( ) const

virtual

Implements IClass.

Definition at line 619 of file compoundhandler.cpp.

{
  return new CompoundIdIterator(m_mainHandler,m_innerCompounds);
}

ICompoundIterator* CompoundHandler::nestedGroup

(

)

const

bool CompoundHandler::parseXML

(

const char *

compId

)

Definition at line 465 of file compoundhandler.cpp.

{
  QFile xmlFile(m_xmlDir+"/"+compId+".xml");
  if (!xmlFile.exists()) return FALSE;
  CompoundErrorHandler errorHandler;
  QXmlInputSource source( xmlFile );
  QXmlSimpleReader reader;
  reader.setContentHandler( this );
  reader.setErrorHandler( &errorHandler );
  reader.parse( source );
  return TRUE;
}

void CompoundHandler::release ( )

virtual

Decreases the reference counter for this compound. If it reaches zero, the memory for the compound will be released.

Implements ICompound.

Definition at line 528 of file compoundhandler.cpp.

{ 
  debug(2,"CompoundHandler::release() %d->%d\n",m_refCount,m_refCount-1);
  if (--m_refCount<=0)
  {
    m_mainHandler->unloadCompound(this);
    delete this; 
  }
}

ISectionIterator * CompoundHandler::sections ( ) const

virtual

Returns an iterator for the different member sections in this compound.

Implements ICompound.

Definition at line 538 of file compoundhandler.cpp.

{ 
  return new SectionIterator(m_sections); 
}

IDocProgramListing * CompoundHandler::source ( ) const

virtual

Implements IFile.

Definition at line 624 of file compoundhandler.cpp.

{
  return m_programListing;
}

void CompoundHandler::startBriefDesc ( const QXmlAttributes &  attrib )

virtual

Definition at line 287 of file compoundhandler.cpp.

{
  DocHandler *docHandler = new DocHandler(this);
  docHandler->startDoc(attrib);
  m_brief = docHandler;
}

void CompoundHandler::startCollaborationGraph ( const QXmlAttributes &  attrib )

virtual

Definition at line 556 of file compoundhandler.cpp.

{
  m_collaborationGraph = new GraphHandler(this,"collaborationgraph");
  m_collaborationGraph->startGraph(attrib);
}

void CompoundHandler::startCompound ( const QXmlAttributes &  attrib )

virtual

Definition at line 322 of file compoundhandler.cpp.

{
  m_id         = attrib.value("id");
  m_kindString = attrib.value("kind");
  m_kind       = s_typeMap->map(m_kindString);
  m_protection = attrib.value("prot");
  debug(2,"startCompound(id=`%s' type=`%s')\n",m_id.data(),m_kindString.data());
}

void CompoundHandler::startDetailedDesc ( const QXmlAttributes &  attrib )

virtual

Definition at line 294 of file compoundhandler.cpp.

{
  DocHandler *docHandler = new DocHandler(this);
  docHandler->startDoc(attrib);
  m_detailed = docHandler;
}

void CompoundHandler::startIncludedBy ( const QXmlAttributes &  attrib )

virtual

Definition at line 315 of file compoundhandler.cpp.

{
  IncludeHandler *inc = new IncludeHandler(this,"includedby");
  m_includedBy.append(inc);
  inc->startInclude(attrib);
}

void CompoundHandler::startIncludedByDependencyGraph ( const QXmlAttributes &  attrib )

virtual

Definition at line 568 of file compoundhandler.cpp.

{
  m_includedByDependencyGraph = new GraphHandler(this,"invincdepgraph");
  m_includedByDependencyGraph->startGraph(attrib);
}

void CompoundHandler::startIncludeDependencyGraph ( const QXmlAttributes &  attrib )

virtual

Definition at line 562 of file compoundhandler.cpp.

{
  m_includeDependencyGraph = new GraphHandler(this,"incdepgraph");
  m_includeDependencyGraph->startGraph(attrib);
}

void CompoundHandler::startIncludes ( const QXmlAttributes &  attrib )

virtual

Definition at line 308 of file compoundhandler.cpp.

{
  IncludeHandler *inc = new IncludeHandler(this,"includes");
  m_includes.append(inc);
  inc->startInclude(attrib);
}

void CompoundHandler::startInheritanceGraph ( const QXmlAttributes &  attrib )

virtual

Definition at line 550 of file compoundhandler.cpp.

{
  m_inheritanceGraph = new GraphHandler(this,"inheritancegraph");
  m_inheritanceGraph->startGraph(attrib);
}

void CompoundHandler::startInnerClass ( const QXmlAttributes &  attrib )

virtual

Definition at line 351 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startInnerDir ( const QXmlAttributes &  attrib )

virtual

Definition at line 376 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startInnerFile ( const QXmlAttributes &  attrib )

virtual

Definition at line 361 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startInnerGroup ( const QXmlAttributes &  attrib )

virtual

Definition at line 366 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startInnerNamespace ( const QXmlAttributes &  attrib )

virtual

Definition at line 356 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startInnerPage ( const QXmlAttributes &  attrib )

virtual

Definition at line 371 of file compoundhandler.cpp.

{
  m_innerCompounds.append(new QString(attrib.value("refid")));
}

void CompoundHandler::startListOfAllMembers ( const QXmlAttributes &  attrib )

virtual

Definition at line 387 of file compoundhandler.cpp.

{
  m_members = new ListOfAllMembersHandler(this);
  m_members->startListOfAllMembers(attrib);
}

void CompoundHandler::startLocation ( const QXmlAttributes &  attrib )

virtual

Definition at line 336 of file compoundhandler.cpp.

{
  m_defFile      = attrib.value("file");
  m_defLine      = attrib.value("line").toInt();
  m_defBodyFile  = attrib.value("bodyfile");
  m_defBodyStart = attrib.value("bodystart").toInt();
  m_defBodyEnd   = attrib.value("bodyend").toInt();
}

void CompoundHandler::startProgramListing ( const QXmlAttributes &  attrib )

virtual

Definition at line 301 of file compoundhandler.cpp.

{
  ProgramListingHandler *plHandler = new ProgramListingHandler(this);
  plHandler->startProgramListing(attrib);
  m_programListing = plHandler;
}

void CompoundHandler::startSection ( const QXmlAttributes &  attrib )

virtual

Definition at line 280 of file compoundhandler.cpp.

{
  SectionHandler *sectHandler = new SectionHandler(this);
  sectHandler->startSection(attrib);
  m_sections.append(sectHandler);
}

void CompoundHandler::startSubClass ( const QXmlAttributes &  attrib )

virtual

Definition at line 428 of file compoundhandler.cpp.

{
  IRelatedCompound::Protection prot = IRelatedCompound::Public;
  QString protString = attrib.value("prot");
  if (protString=="protected") prot = IRelatedCompound::Protected;
  else if (protString=="private") prot = IRelatedCompound::Private;

  IRelatedCompound::Kind kind = IRelatedCompound::Normal;
  QString kindString = attrib.value("virt");
  if (kindString=="virtual") kind = IRelatedCompound::Virtual;
  
  RelatedCompound *sc = new RelatedCompound(
          this,
          attrib.value("refid"),
          prot,
          kind
         );
  debug(2,"sub class id=`%s' prot=`%s' virt=`%s'\n",
      attrib.value("refid").data(),
      protString.data(),
      kindString.data());
  m_subClasses.append(sc);
  m_curString = "";
}

void CompoundHandler::startSuperClass ( const QXmlAttributes &  attrib )

virtual

Definition at line 393 of file compoundhandler.cpp.

{
  IRelatedCompound::Protection prot = IRelatedCompound::Public;
  QString protString = attrib.value("prot");
  if (protString=="protected") 
  {
    prot = IRelatedCompound::Protected;
  }
  else if (protString=="private") 
  {
    prot = IRelatedCompound::Private;
  }
  IRelatedCompound::Kind kind = IRelatedCompound::Normal;
  QString kindString = attrib.value("virt");
  if (kindString=="virtual") kind = IRelatedCompound::Virtual;
  
  RelatedCompound *sc=new RelatedCompound(
          this,
          attrib.value("refid"),
          prot,
          kind
         );
  debug(2,"super class id=`%s' prot=`%s' virt=`%s'\n",
      attrib.value("refid").data(),
      protString.data(),
      kindString.data());
  m_superClasses.append(sc);
  m_curString = "";
}

void CompoundHandler::startTemplateParamList ( const QXmlAttributes &  attrib )

virtual

Definition at line 381 of file compoundhandler.cpp.

{
  m_templateParamList = new TemplateParamListHandler(this);
  m_templateParamList->startTemplateParamList(attrib);
}

void CompoundHandler::startTitle ( const QXmlAttributes &  attrib )

virtual

Definition at line 458 of file compoundhandler.cpp.

{
  ASSERT(m_titleHandler==0);
  m_titleHandler = new TitleHandler(this);
  m_titleHandler->startTitle(attrib);
}

IParamIterator * CompoundHandler::templateParameters ( ) const

virtual

Implements IClass.

Definition at line 639 of file compoundhandler.cpp.

{
  return m_templateParamList ? m_templateParamList->templateParams() : 0;
}

const IDocTitle * CompoundHandler::title ( ) const

virtual

Implements IPage.

Definition at line 644 of file compoundhandler.cpp.

{
  return m_titleHandler;
}

ICompound * CompoundHandler::toICompound

(

)

const

Definition at line 506 of file compoundhandler.cpp.

{
  switch (m_kind)
  {
    case ICompound::Class:     return (IClass *)this;
    case ICompound::Struct:    return (IStruct *)this;
    case ICompound::Union:     return (IUnion *)this;
    case ICompound::Interface: return (IInterface *)this;
    case ICompound::Protocol:  return (IClass *)this;
    case ICompound::Category:  return (IClass *)this;
    case ICompound::Exception: return (IException *)this;
    case ICompound::File:      return (IFile *)this;
    case ICompound::Namespace: return (INamespace *)this;
    case ICompound::Group:     return (IGroup *)this;
    case ICompound::Page:      return (IPage *)this;
    case ICompound::Example:   return (IPage *)this;
    case ICompound::Dir:       return (IDir *)this;
    default:   return 0;
  }
  return 0;
}

Friends And Related Function Documentation

friend class RelatedCompound

friend

Definition at line 116 of file compoundhandler.h.

Member Data Documentation

DocHandler* CompoundHandler::m_brief

private

Definition at line 206 of file compoundhandler.h.

GraphHandler* CompoundHandler::m_collaborationGraph

private

Definition at line 209 of file compoundhandler.h.

int CompoundHandler::m_defBodyEnd

private

Definition at line 216 of file compoundhandler.h.

StringImpl CompoundHandler::m_defBodyFile

private

Definition at line 214 of file compoundhandler.h.

int CompoundHandler::m_defBodyStart

private

Definition at line 215 of file compoundhandler.h.

StringImpl CompoundHandler::m_defFile

private

Definition at line 212 of file compoundhandler.h.

int CompoundHandler::m_defLine

private

Definition at line 213 of file compoundhandler.h.

DocHandler* CompoundHandler::m_detailed

private

Definition at line 207 of file compoundhandler.h.

StringImpl CompoundHandler::m_id

private

Definition at line 221 of file compoundhandler.h.

QList<IncludeHandler> CompoundHandler::m_includedBy

private

Definition at line 200 of file compoundhandler.h.

GraphHandler* CompoundHandler::m_includedByDependencyGraph

private

Definition at line 202 of file compoundhandler.h.

GraphHandler* CompoundHandler::m_includeDependencyGraph

private

Definition at line 201 of file compoundhandler.h.

QList<IncludeHandler> CompoundHandler::m_includes

private

Definition at line 199 of file compoundhandler.h.

GraphHandler* CompoundHandler::m_inheritanceGraph

private

Definition at line 208 of file compoundhandler.h.

QList<QString> CompoundHandler::m_innerCompounds

private

Definition at line 203 of file compoundhandler.h.

CompoundKind CompoundHandler::m_kind

private

Definition at line 222 of file compoundhandler.h.

StringImpl CompoundHandler::m_kindString

private

Definition at line 223 of file compoundhandler.h.

MainHandler* CompoundHandler::m_mainHandler

private

Definition at line 231 of file compoundhandler.h.

QDict<MemberHandler> CompoundHandler::m_memberDict

private

Definition at line 229 of file compoundhandler.h.

QDict<QList<MemberHandler> > CompoundHandler::m_memberNameDict

private

Definition at line 230 of file compoundhandler.h.

ListOfAllMembersHandler* CompoundHandler::m_members

private

Definition at line 217 of file compoundhandler.h.

StringImpl CompoundHandler::m_name

private

Definition at line 195 of file compoundhandler.h.

ProgramListingHandler* CompoundHandler::m_programListing

private

Definition at line 210 of file compoundhandler.h.

StringImpl CompoundHandler::m_protection

private

Definition at line 224 of file compoundhandler.h.

int CompoundHandler::m_refCount

private

Definition at line 228 of file compoundhandler.h.

QList<SectionHandler> CompoundHandler::m_sections

private

Definition at line 205 of file compoundhandler.h.

QList<RelatedCompound> CompoundHandler::m_subClasses

private

Definition at line 197 of file compoundhandler.h.

QList<RelatedCompound> CompoundHandler::m_superClasses

private

Definition at line 198 of file compoundhandler.h.

TemplateParamListHandler* CompoundHandler::m_templateParamList

private

Definition at line 204 of file compoundhandler.h.

TitleHandler* CompoundHandler::m_titleHandler

private

Definition at line 196 of file compoundhandler.h.

QString CompoundHandler::m_xmlDir

private

Definition at line 227 of file compoundhandler.h.

---

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

• doxygen-1.8.11/addon/doxmlparser/src/compoundhandler.h
• doxygen-1.8.11/addon/doxmlparser/src/compoundhandler.cpp