#include <mainhandler.h>

Inheritance diagram for MainHandler:

Public Member Functions
virtual void	startCompound (const QXmlAttributes &attrib)

virtual void	startMember (const QXmlAttributes &attrib)

virtual void	endMember ()

virtual void	startName (const QXmlAttributes &attrib)

virtual void	endName ()

	MainHandler ()

virtual	~MainHandler ()

ICompoundIterator *	compounds () const

ICompound *	compoundById (const char *id) const

virtual ICompound *	compoundByName (const char *name) const

virtual ICompound *	memberById (const char *id) const

virtual ICompoundIterator *	memberByName (const char *name) const

virtual void	release ()

void	setDebugLevel (int level)

bool	readXMLDir (const char *dirName)

void	dump ()

void	unloadCompound (CompoundHandler *ch)

Public Member Functions inherited from BaseHandler< MainHandler >
	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< MainHandler >
	ElementMapper ()

virtual	~ElementMapper ()

void	addStartHandler (const char *key)

void	addStartHandler (const char key, MainHandler obj, void(MainHandler::*handler)(const QXmlAttributes &))

void	addEndHandler (const char *key)

void	addEndHandler (const char key, MainHandler obj, void(MainHandler::*handler)())

Public Member Functions inherited from IBaseHandler
virtual	~IBaseHandler ()

Private Attributes
CompoundEntry *	m_curCompound

MemberEntry *	m_curMember

QList< CompoundEntry >	m_compounds

QDict< CompoundEntry >	m_compoundDict

QDict< CompoundEntry >	m_compoundNameDict

QDict< MemberEntry >	m_memberDict

QDict< QList< CompoundEntry > >	m_memberNameDict

QString	m_xmlDirName

QDict< CompoundHandler >	m_compoundsLoaded

bool	m_insideMember

Additional Inherited Members
Public Types inherited from BaseHandler< MainHandler >
typedef ElementMapper< MainHandler >::StartElementHandlerT	StartElementHandlerT

typedef ElementMapper< MainHandler >::EndElementHandlerT	EndElementHandlerT

Public Types inherited from ElementMapper< MainHandler >
typedef StartElementHandler	StartElementHandlerT

typedef EndElementHandler	EndElementHandlerT

Static Public Attributes inherited from LocatorContainer
static QXmlLocator *	s_theLocator =0

Protected Attributes inherited from BaseHandler< MainHandler >
QString	m_curString

QString	m_skipUntil

int	m_skipCount

QXmlDefaultHandler *	m_delegateHandler

IFallBackHandler *	m_fallBackHandler

Protected Attributes inherited from ElementMapper< MainHandler >
QDict< StartElementHandlerT >	m_startHandlers

QDict< EndElementHandlerT >	m_endHandlers

Detailed Description

Definition at line 45 of file mainhandler.h.

Constructor & Destructor Documentation

MainHandler::MainHandler ( )

Definition at line 91 of file mainhandler.cpp.

                          : m_compoundDict(2999), m_compoundNameDict(2999),
                              m_memberDict(12251), m_memberNameDict(12251),
                              m_compoundsLoaded(1009)
 {
   m_compounds.setAutoDelete(TRUE);
   m_memberNameDict.setAutoDelete(TRUE);
   addStartHandler("doxygenindex"); 
   addEndHandler("doxygenindex");
   addStartHandler("compound",this,&MainHandler::startCompound);
   addEndHandler("compound");
   addStartHandler("member",this,&MainHandler::startMember);
   addEndHandler("member",this,&MainHandler::endMember);
   addStartHandler("name",this,&MainHandler::startName);
   addEndHandler("name",this,&MainHandler::endName);
   m_curCompound = 0;
   m_insideMember = FALSE;
 }

MainHandler::~MainHandler ( )

virtual

Definition at line 109 of file mainhandler.cpp.

 {
   debug(2,"MainHandler::~MainHandler()\n");
 }

Member Function Documentation

ICompound * MainHandler::compoundById ( const char * id ) const

virtual

Returns a compound given its unique id. If you have a compound id this function is much more efficient than iterating over the compound list. Returns 0 if the id is not valid.

Implements IDoxygen.

Definition at line 209 of file mainhandler.cpp.

 {
   QString ids = id;
   if (ids.isEmpty()) return 0;
   CompoundHandler *ch = m_compoundsLoaded[ids.utf8()];
   if (ch) // compound already in memory
   {
     ch->addref(); // returning alias -> increase reference counter
     return ch->toICompound(); 
   }
   CompoundEntry *ce = m_compoundDict.find(ids.utf8());
   if (ce==0) return 0; // id not found
   // create and load a new compound
   ch = new CompoundHandler(m_xmlDirName);
   if (!ch->parseXML(id))
   {
     // compound could not be initialized.
     delete ch;
     return 0;
   }
 
   // we disregard the constness here, because the object stays conceptually
   // unchanged.
   MainHandler *that = (MainHandler *)this;
   ch->initialize(that);
   //printf("loading compound %s in memory\n",id);
   that->m_compoundsLoaded.insert(id,ch);
   return ch->toICompound();
 }

ICompound * MainHandler::compoundByName ( const char * name ) const

virtual

Returns a compound given its name (including the scope). Returns 0 if the name is not found in the project.

Implements IDoxygen.

Definition at line 246 of file mainhandler.cpp.

 {
   QString nameStr = name;
   if (nameStr.isEmpty()) return 0;
   CompoundEntry *ce = m_compoundNameDict[name];
   if (ce==0) return 0; // name not found
   return compoundById(ce->id.utf8());
 }

ICompoundIterator * MainHandler::compounds ( ) const

virtual

Returns an iterator that can be used to iterate over the list of compounds found in the project.

Implements IDoxygen.

Definition at line 204 of file mainhandler.cpp.

 {
   return new CompoundEntryIterator(this,m_compounds);
 }

void MainHandler::dump ( )

Definition at line 167 of file mainhandler.cpp.

 {
   QListIterator<CompoundEntry> cli(m_compounds);
   CompoundEntry *ce;
   for (cli.toFirst();(ce=cli.current());++cli)
   {
     debug(2,"compound id=`%s' name=`%s'\n",ce->id.data(),ce->name.data());
     QDictIterator<MemberEntry> mdi(ce->memberDict);
     MemberEntry *me;
     for (mdi.toFirst();(me=mdi.current());++mdi)
     {
       debug(2,"  member id=`%s' name=`%s'\n",me->id.data(),me->name.data());
     }
   }
 }

void MainHandler::endMember ( )

virtual

Definition at line 149 of file mainhandler.cpp.

 {
   m_curCompound->memberDict.insert(m_curMember->name.utf8(),m_curMember);
   QList<CompoundEntry> *cel=0;
   if ((cel=m_memberNameDict.find(m_curMember->name.utf8()))==0)
   {
     cel = new QList<CompoundEntry>;
     m_memberNameDict.insert(m_curMember->name.utf8(),cel);
   }
   cel->append(m_curCompound);
   m_insideMember = FALSE;
 }

void MainHandler::endName ( )

virtual

Definition at line 127 of file mainhandler.cpp.

 {
   if (m_insideMember)
   {
     m_curMember->name = m_curString;
   }
   else
   {
     m_curCompound->name = m_curString;
     m_compoundNameDict.insert(m_curString.utf8(),m_curCompound);
   }
 }

ICompound * MainHandler::memberById ( const char * id ) const

virtual

Returns an interface to a compound containing a member given it the member's id. Given the ICompound interface one can use the same id to obtain the IMember interface.

Parameters

id	The member id.

Implements IDoxygen.

Definition at line 255 of file mainhandler.cpp.

 {
   QString ids = id;
   if (ids.isEmpty()) return 0;
   MemberEntry *me = m_memberDict[id];
   if (me==0) return 0; // id not found
   return compoundById(me->compound->id.utf8());
 }

ICompoundIterator * MainHandler::memberByName ( const char * name ) const

virtual

Returns a list of all compounds containing at least one members with a certain name. Each compound can be asked to return the list of members with that name.

Parameters

name	The name of the member.

Implements IDoxygen.

Definition at line 264 of file mainhandler.cpp.

 {
   QString nameStr = name;
   if (nameStr.isEmpty()) return 0;
   QList<CompoundEntry> *cel = m_memberNameDict[name];
   if (cel==0) return 0; // name not found
   return new CompoundEntryIterator(this,*cel);
 }

bool MainHandler::readXMLDir ( const char * xmlDirName )

virtual

Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.

Implements IDoxygen.

Definition at line 183 of file mainhandler.cpp.

 {
   m_xmlDirName = xmlDirName;
   QString xmlFileName=m_xmlDirName+"/index.xml";
   QFile xmlFile(xmlFileName);
   //printf("Trying %s xmlFile.exists()=%d isReadable()=%d\n",
   //    xmlFileName.data(),xmlFile.exists(),xmlFile.isReadable());
   if (xmlFile.exists())
   {
     ErrorHandler errorHandler;
     QXmlInputSource source( xmlFile );
     QXmlSimpleReader reader;
     reader.setContentHandler( this );
     reader.setErrorHandler( &errorHandler );
     reader.parse( source );
     dump();
     return TRUE;
   }
   return FALSE;
 }

void MainHandler::release ( )

virtual

Releases the memory for the object hierarchy obtained by createdObjecModelFromXML(). First release all iterators before calling this function.

Implements IDoxygen.

Definition at line 283 of file mainhandler.cpp.

 {
   //printf("MainHandler::release()\n");
   QDictIterator<CompoundHandler> chi(m_compoundsLoaded);
   CompoundHandler *ch;
   for (chi.toFirst();(ch=chi.current());++chi)
   {
     debug(1,"Compound %s not released\n",ch->name()->latin1());
   }
   graphhandler_exit();
   dochandler_exit();
   memberhandler_exit();
   sectionhandler_exit();
   compoundhandler_exit();
   delete this;
 }

void MainHandler::setDebugLevel ( int level )

virtual

Sets the debug level.

0 all debugging messages are disabled (the default).
1 display important messages only
2 display any messages.

Implements IDoxygen.

Definition at line 162 of file mainhandler.cpp.

 {
   ::setDebugLevel(level);
 }

void MainHandler::startCompound ( const QXmlAttributes & attrib )

virtual

Definition at line 114 of file mainhandler.cpp.

 {
   m_curCompound = new CompoundEntry(257);
   m_curCompound->id = attrib.value("refid");
   m_compounds.append(m_curCompound);
   m_compoundDict.insert(m_curCompound->id.utf8(),m_curCompound);
 }

void MainHandler::startMember ( const QXmlAttributes & attrib )

virtual

Definition at line 140 of file mainhandler.cpp.

 {
   m_insideMember = TRUE;
   m_curMember = new MemberEntry;
   m_curMember->id = attrib.value("refid");
   m_curMember->compound = m_curCompound;
   m_memberDict.insert(m_curMember->id.utf8(),m_curMember);
 }

void MainHandler::startName ( const QXmlAttributes & attrib )

virtual

Definition at line 122 of file mainhandler.cpp.

 {
   m_curString = "";
 }

void MainHandler::unloadCompound ( CompoundHandler * ch )

Definition at line 239 of file mainhandler.cpp.

 {
   //printf("unloading compound %s from memory\n",ch->id()->latin1());
   bool result = m_compoundsLoaded.remove(ch->id()->latin1()); 
   if (!result) debug(1,"Failed to unload component!\n");
 }

Member Data Documentation

QDict<CompoundEntry> MainHandler::m_compoundDict

private

Definition at line 73 of file mainhandler.h.

QDict<CompoundEntry> MainHandler::m_compoundNameDict

private

Definition at line 74 of file mainhandler.h.

QList<CompoundEntry> MainHandler::m_compounds

private

Definition at line 72 of file mainhandler.h.

QDict<CompoundHandler> MainHandler::m_compoundsLoaded

private

Definition at line 78 of file mainhandler.h.

CompoundEntry* MainHandler::m_curCompound

private

Definition at line 70 of file mainhandler.h.

MemberEntry* MainHandler::m_curMember

private

Definition at line 71 of file mainhandler.h.

bool MainHandler::m_insideMember

private

Definition at line 79 of file mainhandler.h.

QDict<MemberEntry> MainHandler::m_memberDict

private

Definition at line 75 of file mainhandler.h.

QDict<QList<CompoundEntry> > MainHandler::m_memberNameDict

private

Definition at line 76 of file mainhandler.h.

QString MainHandler::m_xmlDirName

private

Definition at line 77 of file mainhandler.h.

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

doxygen-1.8.11/addon/doxmlparser/src/mainhandler.h
doxygen-1.8.11/addon/doxmlparser/src/mainhandler.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation