#include <sectionhandler.h>

Inheritance diagram for SectionHandler:

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

virtual void	startHeader (const QXmlAttributes &attrib)

virtual void	startSection (const QXmlAttributes &attrib)

virtual void	startDescription (const QXmlAttributes &attrib)

virtual void	endSection ()

virtual void	endHeader ()

	SectionHandler (IBaseHandler *parent)

virtual	~SectionHandler ()

virtual const IString *	kindString () const

virtual SectionKind	kind () const

IDocRoot *	description () const

virtual IMemberIterator *	members () const

virtual bool	isStatic () const

virtual bool	isPublic () const

virtual bool	isProtected () const

virtual bool	isPrivate () const

void	initialize (CompoundHandler *c)

virtual const IString *	header () const

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

virtual	~ElementMapper ()

void	addStartHandler (const char *key)

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

void	addEndHandler (const char *key)

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

Public Member Functions inherited from IBaseHandler
virtual	~IBaseHandler ()

Private Attributes
IBaseHandler *	m_parent

StringImpl	m_header

DocHandler *	m_description

QList< MemberHandler >	m_members

SectionKind	m_kind

StringImpl	m_kindString

Additional Inherited Members
Public Types inherited from ISection
enum	SectionKind { Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables, Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables }

enum	SectionKind { Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables, Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables }

Public Types inherited from BaseHandler< SectionHandler >
typedef ElementMapper< SectionHandler >::StartElementHandlerT	StartElementHandlerT

typedef ElementMapper< SectionHandler >::EndElementHandlerT	EndElementHandlerT

Public Types inherited from ElementMapper< SectionHandler >
typedef StartElementHandler	StartElementHandlerT

typedef EndElementHandler	EndElementHandlerT

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

Protected Attributes inherited from BaseHandler< SectionHandler >
QString	m_curString

QString	m_skipUntil

int	m_skipCount

QXmlDefaultHandler *	m_delegateHandler

IFallBackHandler *	m_fallBackHandler

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

QDict< EndElementHandlerT >	m_endHandlers

Detailed Description

Definition at line 35 of file sectionhandler.h.

Constructor & Destructor Documentation

SectionHandler::SectionHandler ( IBaseHandler * parent )

Definition at line 92 of file sectionhandler.cpp.

                                                    : m_parent(parent)
 {
   //printf("SectionHandler::SectionHandler()\n");
   m_members.setAutoDelete(TRUE);
   addEndHandler("sectiondef",this,&SectionHandler::endSection);
   addStartHandler("memberdef",this,&SectionHandler::startMember);
   addStartHandler("header",this,&SectionHandler::startHeader);
   addEndHandler("header",this,&SectionHandler::endHeader);
   addStartHandler("description",this,&SectionHandler::startDescription);
 }

SectionHandler::~SectionHandler ( )

virtual

Definition at line 103 of file sectionhandler.cpp.

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

Member Function Documentation

IDocRoot * SectionHandler::description ( ) const

virtual

Returns the description attached to this section (for user defined sections, also known as member groups).

Implements ISection.

Definition at line 159 of file sectionhandler.cpp.

 { 
   return m_description; 
 }

void SectionHandler::endHeader ( )

virtual

Definition at line 141 of file sectionhandler.cpp.

 {
   m_header = m_curString.stripWhiteSpace();
   debug(2,"member header=`%s'\n",m_header.data());
 }

void SectionHandler::endSection ( )

virtual

Definition at line 123 of file sectionhandler.cpp.

 {
   m_parent->setDelegate(0);
 }

virtual const IString* SectionHandler::header ( ) const

inlinevirtual

Implements IUserDefined.

Definition at line 79 of file sectionhandler.h.

     {
       return &m_header;
     }

void SectionHandler::initialize ( CompoundHandler * c )

Definition at line 147 of file sectionhandler.cpp.

 {
   QListIterator<MemberHandler> mli(m_members);
   MemberHandler *mh;
   for (;(mh=mli.current());++mli)
   {
     mh->setCompoundHandler(ch);
     ch->insertMember(mh);
     mh->setSectionHandler(this);
   }
 }

virtual bool SectionHandler::isPrivate ( ) const

inlinevirtual

Returns true if this section belongs to a private section of a class

Implements ISection.

Definition at line 70 of file sectionhandler.h.

     {
       return m_kind==PriTypes || m_kind==PriFuncs || m_kind==PriAttribs ||
              m_kind==PriSlots || m_kind==PriStatFuncs || m_kind==PriStatAttribs;
     }

virtual bool SectionHandler::isProtected ( ) const

inlinevirtual

Returns true if this section belongs to a protected section of a class

Implements ISection.

Definition at line 65 of file sectionhandler.h.

     {
       return m_kind==ProTypes || m_kind==ProFuncs || m_kind==ProAttribs ||
              m_kind==ProSlots || m_kind==ProStatFuncs || m_kind==ProStatAttribs;
     }

virtual bool SectionHandler::isPublic ( ) const

inlinevirtual

Returns true if this section belongs to a public section of a class

Implements ISection.

Definition at line 61 of file sectionhandler.h.

     {
       return !isProtected() && !isPrivate();
     }

virtual bool SectionHandler::isStatic ( ) const

inlinevirtual

Returns true if this section contains statics

Implements ISection.

Definition at line 55 of file sectionhandler.h.

     { 
       return m_kind==PubStatFuncs || m_kind==PubStatAttribs || 
              m_kind==ProStatFuncs || m_kind==ProStatAttribs || 
              m_kind==PriStatFuncs || m_kind==PriStatAttribs;
     }

virtual SectionKind SectionHandler::kind ( ) const

inlinevirtual

Returns what kind of section this is

Implements ISection.

Definition at line 51 of file sectionhandler.h.

52 { return m_kind; }

SectionHandler::m_kind

SectionKind m_kind

Definition: sectionhandler.h:95

virtual const IString* SectionHandler::kindString ( ) const

inlinevirtual

Returns a string representation of the value returned by kind()

Implements ISection.

Definition at line 49 of file sectionhandler.h.

50 { return &m_kindString; }

SectionHandler::m_kindString

StringImpl m_kindString

Definition: sectionhandler.h:96

IMemberIterator * SectionHandler::members ( ) const

virtual

Returns an iterator for the members of this section

Implements ISection.

Definition at line 164 of file sectionhandler.cpp.

 { 
   return new MemberIterator(m_members); 
 }

void SectionHandler::startDescription ( const QXmlAttributes & attrib )

virtual

Definition at line 116 of file sectionhandler.cpp.

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

void SectionHandler::startHeader ( const QXmlAttributes & attrib )

virtual

Definition at line 135 of file sectionhandler.cpp.

 {
   m_header="";
   m_curString="";
 }

void SectionHandler::startMember ( const QXmlAttributes & attrib )

virtual

Definition at line 128 of file sectionhandler.cpp.

 {
   MemberHandler *memHandler = new MemberHandler(this);
   memHandler->startMember(attrib);
   m_members.append(memHandler);
 }

void SectionHandler::startSection ( const QXmlAttributes & attrib )

virtual

Definition at line 108 of file sectionhandler.cpp.

 {
   m_parent->setDelegate(this);
   m_kindString = attrib.value("kind");
   m_kind = s_typeMap->map(m_kindString);
   debug(2,"section kind=`%s'\n",m_kindString.data());
 }

Member Data Documentation

DocHandler* SectionHandler::m_description

private

Definition at line 90 of file sectionhandler.h.

StringImpl SectionHandler::m_header

private

Definition at line 89 of file sectionhandler.h.

SectionKind SectionHandler::m_kind

private

Definition at line 95 of file sectionhandler.h.

StringImpl SectionHandler::m_kindString

private

Definition at line 96 of file sectionhandler.h.

QList<MemberHandler> SectionHandler::m_members

private

Definition at line 91 of file sectionhandler.h.

IBaseHandler* SectionHandler::m_parent

private

Definition at line 85 of file sectionhandler.h.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation