From ecb8f53e30524a6eca3c28db4d1a1d708a5a0976 Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Wed, 1 Aug 2001 18:08:50 +0000 Subject: Release-1.2.9 --- INSTALL | 4 +- LANGUAGE.HOWTO | 10 +- Makefile.in | 16 +- README | 4 +- VERSION | 2 +- addon/xmlgen/Makefile.in | 16 - addon/xmlgen/doxygen.dtd | 117 ------- addon/xmlgen/main.cpp | 40 --- addon/xmlgen/xml.cpp | 521 ------------------------------ addon/xmlgen/xml.h | 26 -- addon/xmlgen/xml_dtd.h | 117 ------- addon/xmlgen/xmlgen.pro.in | 20 -- addon/xmlgen/xmlgen.t | 20 -- addon/xmlparse/Doxyfile | 161 +++++++++ addon/xmlparse/Makefile.in | 16 + addon/xmlparse/basehandler.h | 252 +++++++++++++++ addon/xmlparse/compoundhandler.cpp | 100 ++++++ addon/xmlparse/compoundhandler.h | 57 ++++ addon/xmlparse/dochandler.cpp | 316 ++++++++++++++++++ addon/xmlparse/dochandler.h | 154 +++++++++ addon/xmlparse/main.cpp | 54 ++++ addon/xmlparse/mainhandler.cpp | 23 ++ addon/xmlparse/mainhandler.h | 18 ++ addon/xmlparse/memberhandler.cpp | 77 +++++ addon/xmlparse/memberhandler.h | 39 +++ addon/xmlparse/paramhandler.cpp | 79 +++++ addon/xmlparse/paramhandler.h | 34 ++ addon/xmlparse/sectionhandler.cpp | 34 ++ addon/xmlparse/sectionhandler.h | 26 ++ addon/xmlparse/xmlparse.pro.in | 26 ++ addon/xmlread/Doxyfile | 142 -------- addon/xmlread/Makefile.in | 12 - addon/xmlread/README | 9 - addon/xmlread/compounddef.h | 186 ----------- addon/xmlread/main.cpp | 133 -------- addon/xmlread/qtbc.h | 45 --- addon/xmlread/saxhandlers.cpp | 185 ----------- addon/xmlread/saxhandlers.h | 101 ------ addon/xmlread/strx.h | 24 -- addon/xmlread/xmlread.pro.in | 7 - configure | 76 ++--- doc/Doxyfile | 2 +- doc/config.doc | 11 +- doc/index.doc | 10 +- doc/install.doc | 18 +- doc/language.doc | 14 +- doc/language.tpl | 4 +- doc/maintainers.txt | 4 +- doc/translator.pl | 2 +- packages/rpm/doxygen.spec | 22 +- src/classdef.cpp | 16 +- src/classdef.h | 8 + src/code.l | 18 +- src/config.l | 68 +++- src/defargs.l | 6 +- src/definition.cpp | 2 +- src/doc.l | 8 +- src/dot.cpp | 3 +- src/doxygen.cpp | 83 ++--- src/doxygen.h | 3 +- src/entry.h | 30 +- src/htmlgen.cpp | 77 +++-- src/htmlgen.h | 8 +- src/htmlhelp.cpp | 10 +- src/htmlhelp.h | 1 + src/index.cpp | 6 +- src/latexgen.cpp | 10 +- src/latexgen.h | 8 +- src/mangen.h | 8 +- src/memberdef.cpp | 54 +++- src/outputgen.h | 8 +- src/outputlist.h | 16 +- src/pre.l | 2 +- src/rtfgen.h | 8 +- src/scanner.l | 66 ++-- src/translator.h | 367 +-------------------- src/translator_br.h | 31 +- src/translator_de.h | 13 +- src/translator_es.h | 2 + src/translator_fr.h | 2 +- src/translator_sk.h | 2 +- src/util.cpp | 297 ++++++++++++----- src/util.h | 5 +- src/xmlgen.cpp | 645 ++++++++++++++++++++++++++++++++++++- 84 files changed, 2796 insertions(+), 2481 deletions(-) delete mode 100644 addon/xmlgen/Makefile.in delete mode 100644 addon/xmlgen/doxygen.dtd delete mode 100644 addon/xmlgen/main.cpp delete mode 100644 addon/xmlgen/xml.cpp delete mode 100644 addon/xmlgen/xml.h delete mode 100644 addon/xmlgen/xml_dtd.h delete mode 100644 addon/xmlgen/xmlgen.pro.in delete mode 100644 addon/xmlgen/xmlgen.t create mode 100644 addon/xmlparse/Doxyfile create mode 100644 addon/xmlparse/Makefile.in create mode 100644 addon/xmlparse/basehandler.h create mode 100644 addon/xmlparse/compoundhandler.cpp create mode 100644 addon/xmlparse/compoundhandler.h create mode 100644 addon/xmlparse/dochandler.cpp create mode 100644 addon/xmlparse/dochandler.h create mode 100644 addon/xmlparse/main.cpp create mode 100644 addon/xmlparse/mainhandler.cpp create mode 100644 addon/xmlparse/mainhandler.h create mode 100644 addon/xmlparse/memberhandler.cpp create mode 100644 addon/xmlparse/memberhandler.h create mode 100644 addon/xmlparse/paramhandler.cpp create mode 100644 addon/xmlparse/paramhandler.h create mode 100644 addon/xmlparse/sectionhandler.cpp create mode 100644 addon/xmlparse/sectionhandler.h create mode 100644 addon/xmlparse/xmlparse.pro.in delete mode 100644 addon/xmlread/Doxyfile delete mode 100644 addon/xmlread/Makefile.in delete mode 100644 addon/xmlread/README delete mode 100644 addon/xmlread/compounddef.h delete mode 100644 addon/xmlread/main.cpp delete mode 100644 addon/xmlread/qtbc.h delete mode 100644 addon/xmlread/saxhandlers.cpp delete mode 100644 addon/xmlread/saxhandlers.h delete mode 100644 addon/xmlread/strx.h delete mode 100644 addon/xmlread/xmlread.pro.in diff --git a/INSTALL b/INSTALL index 87a9ab1..a4c0bfc 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ -DOXYGEN Version 1.2.8-20010723 +DOXYGEN Version 1.2.9 Please read the installation section of the manual for instructions. -------- -Dimitri van Heesch (23 July 2001) +Dimitri van Heesch (01 August 2001) diff --git a/LANGUAGE.HOWTO b/LANGUAGE.HOWTO index d4d0210..306b4bf 100644 --- a/LANGUAGE.HOWTO +++ b/LANGUAGE.HOWTO @@ -11,20 +11,18 @@ Just follow these steps: I'll use xx in the rest of this document. 3) Edit language.cpp: - Add a #include - - in setTranslator() add + - In setTranslator() add else if (L_EQUAL("your_language_name")) { - theTranslator = new TranslatorYourlanguage; + theTranslator = new TranslatorYourLanguage; } after the if { ... } 4) Edit libdoxygen.pro.in and add translator_xx.h to the HEADERS line. 5) Edit translator_xx.h: - Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice. - - Rename TranslatorEnglish to TranslatorYourlanguage - - In the member latexBabelPackage() change "english" into the name of the - latex package that adds support for your language. + - Rename TranslatorEnglish to TranslatorYourLanguage - In the member idLanguage() change "english" into the name of your language (use lower case characters only). Depending on the language you may also wish to change the member functions latexLanguageSupportCommand() @@ -44,6 +42,8 @@ Just follow these steps: 7) Now you can use OUTPUT_LANGUAGE = your_language_name in the config file to generate output in your language. 8) Send translator_xx.h to me so I can add it to doxygen. + Send also your name and e-mail address to be included in the + maintainers.txt list. Good luck, and let me know if there are problems. diff --git a/Makefile.in b/Makefile.in index 70ab622..c3d7d81 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,5 +1,3 @@ -DOCDIR = $(INSTALL)/share/doc/packages/doxygen - #all: src/version.cpp doxywizard # cd qtools ; $(MAKE) # cd src ; $(MAKE) @@ -10,16 +8,14 @@ clean: FORCE cd qtools ; $(MAKE) clean cd src ; $(MAKE) clean cd addon/doxywizard ; $(MAKE) clean - cd addon/xmlread ; $(MAKE) clean - cd addon/xmlgen ; $(MAKE) clean + cd addon/xmlparse ; $(MAKE) clean -rm -f bin/doxy* -rm -f objects/*.o distclean: clean cd src ; $(MAKE) distclean cd addon/doxywizard ; $(MAKE) distclean - cd addon/xmlread ; $(MAKE) distclean - cd addon/xmlgen ; $(MAKE) distclean + cd addon/xmlparse ; $(MAKE) distclean -rm -f lib/lib* -rm -f bin/doxy* -rm -f html @@ -37,15 +33,9 @@ distclean: clean -rm -f addon/doxywizard/obj/*.o -rm -f addon/doxywizard/moc/moc_* -rm -f addon/doxywizard/config.cpp - -rm -f addon/xmlread/xmlread.pro - -rm -f addon/xmlread/Makefile addon/xmlread/Makefile.xmlread - -rm -f addon/xmlread/*.o - -rm -f addon/xmlgen/xmlgen.pro - -rm -f addon/xmlgen/Makefile addon/xmlgen/Makefile.xmlgen - -rm -f addon/xmlgen/*.o -install: doxywizard_install xmlgen_install +install: doxywizard_install $(INSTTOOL) -d $(INSTALL)/bin $(INSTTOOL) -m 755 bin/doxygen $(INSTALL)/bin $(INSTTOOL) -m 755 bin/doxytag $(INSTALL)/bin diff --git a/README b/README index cd6ae99..9dcc607 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.2.8_20010723 +DOXYGEN Version 1.2.9 Please read INSTALL for compilation instructions. @@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (23 July 2001) +Dimitri van Heesch (dimitri@stack.nl) (01 August 2001) diff --git a/VERSION b/VERSION index 1501ac7..9d4f823 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.8-20010723 +1.2.9 diff --git a/addon/xmlgen/Makefile.in b/addon/xmlgen/Makefile.in deleted file mode 100644 index d0e2dc5..0000000 --- a/addon/xmlgen/Makefile.in +++ /dev/null @@ -1,16 +0,0 @@ -all clean depend: Makefile.xmlgen - $(MAKE) -f Makefile.xmlgen $@ - -distclean: clean - $(RM) -f Makefile.xmlgen - -tmake: - $(ENV) $(PERL) $(TMAKE) xmlgen.pro >Makefile.xmlgen - -Makefile.xmlgen: xmlgen.pro - $(ENV) $(PERL) $(TMAKE) xmlgen.pro >Makefile.xmlgen - -install: - $(INSTTOOL) -d $(INSTALL)/bin - $(INSTTOOL) -m 755 ../../bin/doxygen_xml $(INSTALL)/bin - diff --git a/addon/xmlgen/doxygen.dtd b/addon/xmlgen/doxygen.dtd deleted file mode 100644 index 62727b8..0000000 --- a/addon/xmlgen/doxygen.dtd +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/addon/xmlgen/main.cpp b/addon/xmlgen/main.cpp deleted file mode 100644 index 30f9071..0000000 --- a/addon/xmlgen/main.cpp +++ /dev/null @@ -1,40 +0,0 @@ -/****************************************************************************** - * - * $Id$ - * - * - * Copyright (C) 1997-2001 by Dimitri van Heesch. - * - * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - * Documents produced by Doxygen are derivative works derived from the - * input used in their production; they are not affected by this license. - * - */ - -#include "doxygen.h" -#include "message.h" -#include "xml.h" - -/*! \file - * \brief main entry point for doxygen's XML generator - * - * This file contains main() - */ - -/*! Main that generate XML output - * - */ -int main(int argc,char **argv) -{ - initDoxygen(); - readConfiguration(argc,argv); - parseInput(); - msg("Generating XML output\n"); - generateXML(); - return 0; -} diff --git a/addon/xmlgen/xml.cpp b/addon/xmlgen/xml.cpp deleted file mode 100644 index 6e3a7d6..0000000 --- a/addon/xmlgen/xml.cpp +++ /dev/null @@ -1,521 +0,0 @@ -/****************************************************************************** - * - * $Id$ - * - * - * Copyright (C) 1997-2001 by Dimitri van Heesch. - * - * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - * Documents produced by Doxygen are derivative works derived from the - * input used in their production; they are not affected by this license. - * - */ - -#include - -#include "qtbc.h" -#include "xml.h" -#include "doxygen.h" -#include "message.h" -#include "config.h" -#include "classlist.h" -#include "util.h" -#include "defargs.h" - -#include -#include -#include - -const char dtd_data[]= -#include "xml_dtd.h" -; - -class TextGeneratorXMLImpl : public TextGeneratorIntf -{ - public: - TextGeneratorXMLImpl(QTextStream &t): m_t(t) {} - void writeString(const char *s) const - { - writeXMLString(m_t,s); - } - void writeBreak() const {} - void writeLink(const char *extRef,const char *file, - const char *anchor,const char *text - ) const - { - if (extRef==0) - { writeXMLLink(m_t,file,anchor,text); } - else // external references are not supported for XML - { writeXMLString(m_t,text); } - } - private: - QTextStream &m_t; -}; - - -void generateDTD() -{ - QCString fileName=Config_getString("OUTPUT_DIRECTORY")+"/xml/doxygen.dtd"; - QFile f(fileName); - if (!f.open(IO_WriteOnly)) - { - err("Cannot open file %s for writing!\n",fileName.data()); - return; - } - QTextStream t(&f); - t << dtd_data; -} - -void writeXMLString(QTextStream &t,const char *s) -{ - t << convertToXML(s); -} - -void writeXMLLink(QTextStream &t,const char *compoundId,const char *memId, - const char *text) -{ - if (memId==0) - { - t << ""; - writeXMLString(t,text); - t << ""; - } - else - { - t << ""; - writeXMLString(t,text); - t << ""; - } -} - -void generateXMLForMember(MemberDef *md,QTextStream &t,Definition *def) -{ - if (md->memberType()==MemberDef::EnumValue) return; - - QCString scopeName; - if (md->getClassDef()) - scopeName=md->getClassDef()->name(); - else if (md->getNamespaceDef()) - scopeName=md->getNamespaceDef()->name(); - - t << " <"; - enum { define_t,variable_t,typedef_t,enum_t,function_t } xmlType = function_t; - switch (md->memberType()) - { - case MemberDef::Define: t << "definedef"; xmlType=define_t; break; - case MemberDef::EnumValue: // fall through - case MemberDef::Property: // fall through - case MemberDef::Variable: t << "variabledef"; xmlType=variable_t; break; - case MemberDef::Typedef: t << "typedef"; xmlType=typedef_t; break; - case MemberDef::Enumeration: t << "enumdef"; xmlType=enum_t; break; - case MemberDef::Function: // fall through - case MemberDef::Signal: // fall through - case MemberDef::Prototype: // fall through - case MemberDef::Friend: // fall through - case MemberDef::DCOP: // fall through - case MemberDef::Slot: t << "functiondef"; xmlType=function_t; break; - } - t << " id=\""; - t << def->getOutputFileBase() - << "__" // can we change this to a non ID char? - // : do not seem allowed for some parsers! - << md->anchor(); - t << "\""; - if (xmlType==function_t && md->virtualness()!=Normal) - // functions has an extra "virt" attribute - { - t << " virt=\""; - switch (md->virtualness()) - { - case Virtual: t << "virtual"; break; - case Pure: t << "pure-virtual"; break; - default: ASSERT(0); - } - t << "\""; - } - t << ">" << endl; - - if (xmlType!=define_t && xmlType!=enum_t && // These don't have types. - (xmlType!=function_t || md->typeString()!=0) // Type is optional here. - ) - { - QCString typeStr = replaceAnonymousScopes(md->typeString()); - if (xmlType==typedef_t && typeStr.left(8)=="typedef ") - typeStr=typeStr.right(typeStr.length()-8); - if (xmlType==function_t && typeStr.left(8)=="virtual ") - typeStr=typeStr.right(typeStr.length()-8); - t << " "; - linkifyText(TextGeneratorXMLImpl(t),scopeName,md->name(),typeStr); - t << "" << endl; - } - - t << " "; - writeXMLString(t,md->name()); - t << "" << endl; - if (xmlType==function_t) //function - { - t << " " << endl; - ArgumentList *declAl = new ArgumentList; - ArgumentList *defAl = md->argumentList(); - stringToArgumentList(md->argsString(),declAl); - if (declAl->count()>0) - { - ArgumentListIterator declAli(*declAl); - ArgumentListIterator defAli(*defAl); - Argument *a; - for (declAli.toFirst();(a=declAli.current());++declAli) - { - Argument *defArg = defAli.current(); - t << " " << endl; - if (!a->attrib.isEmpty()) - { - t << " "; - writeXMLString(t,a->attrib); - t << "" << endl; - } - if (!a->type.isEmpty()) - { - t << " "; - linkifyText(TextGeneratorXMLImpl(t),scopeName,md->name(),a->type); - t << "" << endl; - } - if (!a->name.isEmpty()) - { - t << " "; - writeXMLString(t,a->name); - t << "" << endl; - } - if (defArg && !defArg->name.isEmpty() && defArg->name!=a->name) - { - t << " "; - writeXMLString(t,defArg->name); - t << "" << endl; - } - if (!a->array.isEmpty()) - { - t << " "; - writeXMLString(t,a->array); - t << "" << endl; - } - if (!a->defval.isEmpty()) - { - t << " "; - linkifyText(TextGeneratorXMLImpl(t),scopeName,md->name(),a->defval); - t << "" << endl; - } - t << " " << endl; - if (defArg) ++defAli; - } - } - delete declAl; - t << " " << endl; - } - else if (xmlType==define_t && md->argsString()!=0) // define - { - t << " " << endl; - ArgumentListIterator ali(*md->argumentList()); - Argument *a; - for (ali.toFirst();(a=ali.current());++ali) - { - t << " " << a->type << "" << endl; - } - t << " " << endl; - if (!md->initializer().isEmpty()) - { - t << " "; - linkifyText(TextGeneratorXMLImpl(t),scopeName,md->name(),md->initializer()); - t << "" << endl; - } - } - else if (xmlType==enum_t) // enum - { - t << " " << endl; - if (md->enumFieldList()) - { - MemberListIterator emli(*md->enumFieldList()); - MemberDef *emd; - for (emli.toFirst();(emd=emli.current());++emli) - { - t << " " << endl; - t << " "; - writeXMLString(t,emd->name()); - t << "" << endl; - if (!emd->initializer().isEmpty()) - { - t << " "; - writeXMLString(t,emd->initializer()); - t << "" << endl; - } - t << " " << endl; - } - } - t << " " << endl; - } - t << " memberType()) - { - case MemberDef::Define: t << "definedef"; break; - case MemberDef::EnumValue: // fall through - case MemberDef::Property: // fall through - case MemberDef::Variable: t << "variabledef"; break; - case MemberDef::Typedef: t << "typedef"; break; - case MemberDef::Enumeration: t << "enumdef"; break; - case MemberDef::Function: // fall through - case MemberDef::Signal: // fall through - case MemberDef::Prototype: // fall through - case MemberDef::Friend: // fall through - case MemberDef::DCOP: // fall through - case MemberDef::Slot: t << "functiondef"; break; - } - t << ">" << endl; -} - - -void generateXMLClassSection(ClassDef *cd,QTextStream &t,MemberList *ml,const char *type) -{ - if (ml->count()>0) - { - t << " " << endl; - t << " " << endl; - MemberListIterator mli(*ml); - MemberDef *md; - for (mli.toFirst();(md=mli.current());++mli) - { - generateXMLForMember(md,t,cd); - } - t << " " << endl; - t << " " << endl; - } -} - -void generateXMLForClass(ClassDef *cd,QTextStream &t) -{ - if (cd->name().find('@')!=-1) return; // skip anonymous compounds - t << " getOutputFileBase() << "\" type=\"" - << cd->compoundTypeString() << "\">" << endl; - t << " "; - writeXMLString(t,cd->name()); - t << "" << endl; - if (cd->baseClasses()->count()>0) - { - t << " " << endl; - BaseClassListIterator bcli(*cd->baseClasses()); - BaseClassDef *bcd; - for (bcli.toFirst();(bcd=bcli.current());++bcli) - { - t << " classDef->getOutputFileBase() - << "\" prot=\""; - switch (bcd->prot) - { - case Public: t << "public"; break; - case Protected: t << "protected"; break; - case Private: t << "private"; break; - } - t << "\" virt=\""; - switch(bcd->virt) - { - case Normal: t << "non-virtual"; break; - case Virtual: t << "virtual"; break; - case Pure: t <<"pure-virtual"; break; - } - t << "\"/>" << endl; - } - t << " " << endl; - } - if (cd->subClasses()->count()>0) - { - t << " " << endl; - BaseClassListIterator bcli(*cd->subClasses()); - BaseClassDef *bcd; - for (bcli.toFirst();(bcd=bcli.current());++bcli) - { - t << " classDef->getOutputFileBase() - << "\" prot=\""; - switch (bcd->prot) - { - case Public: t << "public"; break; - case Protected: t << "protected"; break; - case Private: t << "private"; break; - } - t << "\" virt=\""; - switch(bcd->virt) - { - case Normal: t << "non-virtual"; break; - case Virtual: t << "virtual"; break; - case Pure: t << "pure-virtual"; break; - } - t << "\"/>" << endl; - } - t << " " << endl; - } - int numMembers = - cd->pubTypes.count()+cd->pubMembers.count()+cd->pubAttribs.count()+ - cd->pubSlots.count()+cd->signals.count()+cd->dcopMethods.count()+ - cd->pubStaticMembers.count()+ - cd->pubStaticAttribs.count()+cd->proTypes.count()+cd->proMembers.count()+ - cd->proAttribs.count()+cd->proSlots.count()+cd->proStaticMembers.count()+ - cd->proStaticAttribs.count()+cd->priTypes.count()+cd->priMembers.count()+ - cd->priAttribs.count()+cd->priSlots.count()+cd->priStaticMembers.count()+ - cd->priStaticAttribs.count()+cd->friends.count()+cd->related.count(); - if (numMembers>0) - { - t << " " << endl; - generateXMLClassSection(cd,t,&cd->pubTypes,"public-type"); - generateXMLClassSection(cd,t,&cd->pubMembers,"public-func"); - generateXMLClassSection(cd,t,&cd->pubAttribs,"public-attrib"); - generateXMLClassSection(cd,t,&cd->pubSlots,"public-slot"); - generateXMLClassSection(cd,t,&cd->signals,"signal"); - generateXMLClassSection(cd,t,&cd->dcopMethods,"dcop-func"); - generateXMLClassSection(cd,t,&cd->properties,"property"); - generateXMLClassSection(cd,t,&cd->pubStaticMembers,"public-static-func"); - generateXMLClassSection(cd,t,&cd->pubStaticAttribs,"public-static-attrib"); - generateXMLClassSection(cd,t,&cd->proTypes,"protected-type"); - generateXMLClassSection(cd,t,&cd->proMembers,"protected-func"); - generateXMLClassSection(cd,t,&cd->proAttribs,"protected-attrib"); - generateXMLClassSection(cd,t,&cd->proSlots,"protected-slot"); - generateXMLClassSection(cd,t,&cd->proStaticMembers,"protected-static-func"); - generateXMLClassSection(cd,t,&cd->proStaticAttribs,"protected-static-attrib"); - generateXMLClassSection(cd,t,&cd->priTypes,"private-type"); - generateXMLClassSection(cd,t,&cd->priMembers,"private-func"); - generateXMLClassSection(cd,t,&cd->priAttribs,"private-attrib"); - generateXMLClassSection(cd,t,&cd->priSlots,"private-slot"); - generateXMLClassSection(cd,t,&cd->priStaticMembers,"private-static-func"); - generateXMLClassSection(cd,t,&cd->priStaticAttribs,"private-static-attrib"); - generateXMLClassSection(cd,t,&cd->friends,"signal"); - generateXMLClassSection(cd,t,&cd->related,"related"); - t << " " << endl; - } - t << " " << endl; -} - -void generateXMLFileSection(FileDef *fd,QTextStream &t,MemberList *ml,const char *type) -{ - if (ml->count()>0) - { - t << " " << endl; - t << " " << endl; - MemberListIterator mli(*ml); - MemberDef *md; - for (mli.toFirst();(md=mli.current());++mli) - { - generateXMLForMember(md,t,fd); - } - t << " " << endl; - t << " " << endl; - } -} - -void generateXMLForFile(FileDef *fd,QTextStream &t) -{ - t << " getOutputFileBase() << "\" type=\"file\">" << endl; - t << " "; - writeXMLString(t,fd->name()); - t << "" << endl; - int numMembers = fd->decDefineMembers.count()+fd->decProtoMembers.count()+ - fd->decTypedefMembers.count()+fd->decEnumMembers.count()+ - fd->decFuncMembers.count()+fd->decVarMembers.count(); - if (numMembers>0) - { - t << " " << endl; - generateXMLFileSection(fd,t,&fd->decDefineMembers,"define"); - generateXMLFileSection(fd,t,&fd->decProtoMembers,"prototype"); - generateXMLFileSection(fd,t,&fd->decTypedefMembers,"typedef"); - generateXMLFileSection(fd,t,&fd->decEnumMembers,"enum"); - generateXMLFileSection(fd,t,&fd->decFuncMembers,"func"); - generateXMLFileSection(fd,t,&fd->decVarMembers,"var"); - t << " " << endl; - } - t << " " << endl; -} - - -void generateXML() -{ - if (Config_getString("OUTPUT_DIRECTORY").isEmpty()) - Config_getString("OUTPUT_DIRECTORY")=QDir::currentDirPath(); - else - { - QDir dir(Config_getString("OUTPUT_DIRECTORY")); - if (!dir.exists()) - { - dir.setPath(QDir::currentDirPath()); - if (!dir.mkdir(Config_getString("OUTPUT_DIRECTORY"))) - { - err("Error: tag OUTPUT_DIRECTORY: Output directory `%s' does not " - "exist and cannot be created\n",Config_getString("OUTPUT_DIRECTORY").data()); - exit(1); - } - else if (!Config_getBool("QUIET")) - { - err("Notice: Output directory `%s' does not exist. " - "I have created it for you.\n", Config_getString("OUTPUT_DIRECTORY").data()); - } - dir.cd(Config_getString("OUTPUT_DIRECTORY")); - } - Config_getString("OUTPUT_DIRECTORY")=dir.absPath(); - } - - QDir dir(Config_getString("OUTPUT_DIRECTORY")); - if (!dir.exists()) - { - dir.setPath(QDir::currentDirPath()); - if (!dir.mkdir(Config_getString("OUTPUT_DIRECTORY"))) - { - err("Cannot create directory %s\n",Config_getString("OUTPUT_DIRECTORY").data()); - return; - } - } - QDir xmlDir(Config_getString("OUTPUT_DIRECTORY")+"/xml"); - if (!xmlDir.exists() && !xmlDir.mkdir(Config_getString("OUTPUT_DIRECTORY")+"/xml")) - { - err("Could not create xml directory in %s\n",Config_getString("OUTPUT_DIRECTORY").data()); - return; - } - generateDTD(); - - QCString fileName=Config_getString("OUTPUT_DIRECTORY")+"/xml/doxygen.xml"; - QFile f(fileName); - if (!f.open(IO_WriteOnly)) - { - err("Cannot open file %s for writing!\n",fileName.data()); - return; - } - QTextStream t(&f); - t << "" << endl; - t << "" << endl; - t << "" << endl; - if (Doxygen::classSDict.count()+Doxygen::inputNameList.count()>0) - { - t << " " << endl; - ClassSDict::Iterator cli(Doxygen::classSDict); - ClassDef *cd; - for (cli.toFirst();(cd=cli.current());++cli) - { - generateXMLForClass(cd,t); - } - FileNameListIterator fnli(Doxygen::inputNameList); - FileName *fn; - for (;(fn=fnli.current());++fnli) - { - FileNameIterator fni(*fn); - FileDef *fd; - for (;(fd=fni.current());++fni) - { - generateXMLForFile(fd,t); - } - } - t << " " << endl; - } - t << "" << endl; -} - - diff --git a/addon/xmlgen/xml.h b/addon/xmlgen/xml.h deleted file mode 100644 index 6a249db..0000000 --- a/addon/xmlgen/xml.h +++ /dev/null @@ -1,26 +0,0 @@ -/****************************************************************************** - * - * $Id$ - * - * Copyright (C) 1997-2001 by Dimitri van Heesch. - * - * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - */ - -#ifndef XML_H -#define XML_H - -class QTextStream; - -void generateXML(); -void writeXMLString(QTextStream &t,const char *s); -void writeXMLString(QTextStream &t,const char *s); -void writeXMLLink(QTextStream &t,const char *compoundRef,const char *memAnchor, - const char *text); - -#endif diff --git a/addon/xmlgen/xml_dtd.h b/addon/xmlgen/xml_dtd.h deleted file mode 100644 index 010a465..0000000 --- a/addon/xmlgen/xml_dtd.h +++ /dev/null @@ -1,117 +0,0 @@ -"\n" -"\n" -"\n" -"\n" -" \n" -" \n" -" \n" -" \n" -" \n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" -"\n" diff --git a/addon/xmlgen/xmlgen.pro.in b/addon/xmlgen/xmlgen.pro.in deleted file mode 100644 index 2f29fd3..0000000 --- a/addon/xmlgen/xmlgen.pro.in +++ /dev/null @@ -1,20 +0,0 @@ -TEMPLATE = xmlgen.t -CONFIG = console warn_on $extraopt -HEADERS = xml.h xml_dtd.h -SOURCES = main.cpp xml.cpp -DEPENDPATH = ../../src -unix:LIBS += -L../../lib -ldoxygen -ldoxycfg -lqtools -win32:INCLUDEPATH += . -win32-mingw:LIBS += -L../../lib -ldoxygen -ldoxycfg -lqtools -win32-msvc:LIBS += qtools.lib doxygen.lib doxycfg.lib shell32.lib -win32-msvc:TMAKE_LFLAGS += /LIBPATH:..\..\lib -win32-borland:LIBS += qtools.lib doxygen.lib doxycfg.lib shell32.lib -win32-borland:TMAKE_LFLAGS += -L..\..\lib -win32:TMAKE_CXXFLAGS += -DQT_NODLL -INCLUDEPATH += ../../qtools ../../src -DESTDIR = ../../bin -TARGET = doxygen_xml -unix:TARGETDEPS = ../../lib/libdoxygen.a ../../lib/libdoxycfg.a -win32:TARGETDEPS = ..\..\lib\doxygen.lib ../../lib/doxycfg.lib -OBJECTS_DIR = obj - diff --git a/addon/xmlgen/xmlgen.t b/addon/xmlgen/xmlgen.t deleted file mode 100644 index 5c3ab67..0000000 --- a/addon/xmlgen/xmlgen.t +++ /dev/null @@ -1,20 +0,0 @@ -# -# $Id$ -# -# Copyright (C) 1997-2001 by Dimitri van Heesch. -# -# Permission to use, copy, modify, and distribute this software and its -# documentation under the terms of the GNU General Public License is hereby -# granted. No representations are made about the suitability of this software -# for any purpose. It is provided "as is" without express or implied warranty. -# See the GNU General Public License for more details. -# -# Documents produced by Doxygen are derivative works derived from the -# input used in their production; they are not affected by this license. -#! -#! doxygen.t: This is a custom template for building Doxygen -#! -#$ IncludeTemplate("app.t"); - -xml_dtd.h: doxygen.dtd - cat doxygen.dtd | sed -e "s/\"/\\\\\"/g" -e "s/^/\"/g" -e "s/$$/\\\\n\"/g" >xml_dtd.h diff --git a/addon/xmlparse/Doxyfile b/addon/xmlparse/Doxyfile new file mode 100644 index 0000000..bec9537 --- /dev/null +++ b/addon/xmlparse/Doxyfile @@ -0,0 +1,161 @@ +# Doxyfile 1.2.8-20010715 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = dox2html +PROJECT_NUMBER = +OUTPUT_DIRECTORY = doc +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +INTERNAL_DOCS = NO +CLASS_DIAGRAMS = YES +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +CASE_SENSE_NAMES = YES +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 8 +ENABLED_SECTIONS = +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +ALIASES = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = . +FILE_PATTERNS = *.h *.cpp +RECURSIVE = NO +EXCLUDE = +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +IMAGE_PATH = +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = +MAN_EXTENSION = +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = YES +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = ../../qtools_docs/qtools.tag=../../../../qtools_docs/html +GENERATE_TAGFILE = +ALLEXTERNALS = NO +PERL_PATH = +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_PATH = +MAX_DOT_GRAPH_WIDTH = 3024 +MAX_DOT_GRAPH_HEIGHT = 3024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = +EXT_DOC_PATHS = diff --git a/addon/xmlparse/Makefile.in b/addon/xmlparse/Makefile.in new file mode 100644 index 0000000..5fe8421 --- /dev/null +++ b/addon/xmlparse/Makefile.in @@ -0,0 +1,16 @@ +all clean depend: Makefile.xmlparse + $(MAKE) -f Makefile.xmlparse $@ + +distclean: clean + $(RM) -rf Makefile.xmlparse xmlparse.pro Makefile obj + +tmake: + $(ENV) $(PERL) $(TMAKE) xmlparse.pro >Makefile.xmlparse + +Makefile.xmlparse: xmlparse.pro + $(ENV) $(PERL) $(TMAKE) xmlparse.pro >Makefile.xmlparse + +install: + $(INSTTOOL) -d $(INSTALL)/bin + $(INSTTOOL) -m 755 ../../bin/xmlparse $(INSTALL)/bin + diff --git a/addon/xmlparse/basehandler.h b/addon/xmlparse/basehandler.h new file mode 100644 index 0000000..2d037e0 --- /dev/null +++ b/addon/xmlparse/basehandler.h @@ -0,0 +1,252 @@ +#ifndef _BASEHANDLER_H +#define _BASEHANDLER_H + +#include +#include +#include + +class IBaseHandler +{ + public: + virtual void setDelegate(QXmlDefaultHandler *delegate) = 0; + virtual QXmlDefaultHandler *delegate() const = 0; +}; + +class IFallBackHandler +{ + public: + virtual bool handleStartElement(const QString & name, + const QXmlAttributes & attrib) = 0; + virtual bool handleEndElement(const QString &name) = 0; +}; + +template class ElementMapper +{ + class StartElementHandler + { + typedef void (T::*Handler)(const QXmlAttributes &attrib); + public: + StartElementHandler() : m_parent(0) {} + StartElementHandler(T *parent, Handler h) + : m_parent(parent), m_handler(h) {} + void operator()(const QXmlAttributes &attrib) + { if (m_parent) (m_parent->*m_handler)(attrib); } + private: + T *m_parent; + Handler m_handler; + }; + + class EndElementHandler + { + typedef void (T::*Handler)(); + public: + EndElementHandler() : m_parent(0) {} + EndElementHandler(T *parent, Handler h) + : m_parent(parent), m_handler(h) {} + void operator()() + { if (m_parent) (m_parent->*m_handler)(); } + private: + T *m_parent; + Handler m_handler; + }; + + typedef StartElementHandler StartElementHandlerT; + typedef EndElementHandler EndElementHandlerT; + + public: + ElementMapper() : m_startHandlers(67), m_endHandlers(67) + { + m_startHandlers.setAutoDelete(TRUE); + m_endHandlers.setAutoDelete(TRUE); + } + virtual ~ElementMapper() + { + } + + void addStartHandler(const char *key) + { + m_startHandlers.insert(key,new StartElementHandlerT); + } + + void addStartHandler(const char *key, T *obj, void (T::*handler)(const QXmlAttributes &)) + { + m_startHandlers.insert(key,new StartElementHandlerT(obj,handler)); + } + + void addEndHandler(const char *key) + { + m_endHandlers.insert(key,new EndElementHandlerT); + } + + void addEndHandler(const char *key, T *obj, void (T::*handler)()) + { + m_endHandlers.insert(key,new EndElementHandlerT(obj,handler)); + } + + + protected: + QDict m_startHandlers; + QDict m_endHandlers; +}; + +template class BaseHandler : public IBaseHandler, + public QXmlDefaultHandler, + public ElementMapper +{ + public: + BaseHandler() : m_delegateHandler(0), m_fallBackHandler(0) + { + } + + virtual ~BaseHandler() + { + delete m_fallBackHandler; + } + + virtual bool startDocument() + { + return TRUE; + } + + virtual bool startElement( const QString & namespaceURI, + const QString & localName, + const QString & name, + const QXmlAttributes & attrib + ) + { + if (m_delegateHandler) + { + return m_delegateHandler->startElement(namespaceURI,localName,name,attrib); + } + if (!m_skipUntil.isEmpty()) // skip mode + { + if (m_skipUntil==name) m_skipCount++; + printf("skipping start tag %s count=%d\n",name.data(),m_skipCount); + return TRUE; + } + + StartElementHandlerT *handler = m_startHandlers[name]; + if (handler) + { + (*handler)(attrib); + //printf("found start tag %s\n",name.data()); + } + else if (m_fallBackHandler && + !m_fallBackHandler->handleStartElement(name,attrib) + ) + { + printf("found unexpected tag `%s', skipping until matching end tag\n",name.data()); + m_skipUntil = name; + m_skipCount=1; + } + return TRUE; + } + + virtual bool endElement( const QString& namespaceURI, const QString& localName, const QString& name ) + { + if (m_delegateHandler) + { + return m_delegateHandler->endElement(namespaceURI,localName,name); + } + + if (name==m_skipUntil) + { + m_skipCount--; + printf("skipping end tag %s count=%d\n",name.data(),m_skipCount); + if (m_skipCount==0) + { + m_skipUntil=""; + } + //printf("found end tag %s\n",name.data()); + } + else if (m_skipUntil.isEmpty()) + { + EndElementHandlerT *handler = m_endHandlers[name]; + if (handler) + { + (*handler)(); + //printf("found end tag %s\n",name.data()); + } + else if (m_fallBackHandler) + { + m_fallBackHandler->handleEndElement(name); + } + } + m_curString=""; + return TRUE; + } + + virtual bool characters ( const QString & ch ) + { + if (m_delegateHandler) + { + return m_delegateHandler->characters(ch); + } + + m_curString+=ch; + return TRUE; + } + + void setDelegate(QXmlDefaultHandler *delegate) + { + m_delegateHandler = delegate; + } + + QXmlDefaultHandler *delegate() const + { + return m_delegateHandler; + } + + void setFallBackHandler(IFallBackHandler *h) + { + m_fallBackHandler = h; + } + + IFallBackHandler *fallBackHandler() const + { + return m_fallBackHandler; + } + + protected: + QString m_curString; + QString m_skipUntil; + int m_skipCount; + QXmlDefaultHandler *m_delegateHandler; + IFallBackHandler *m_fallBackHandler; +}; + +template class BaseFallBackHandler : public ElementMapper, + public IFallBackHandler +{ + public: + BaseFallBackHandler() + { + } + virtual ~BaseFallBackHandler() + { + } + bool handleStartElement(const QString & name, + const QXmlAttributes & attrib) + { + StartElementHandlerT *handler = m_startHandlers[name]; + if (handler) + { + (*handler)(attrib); + return TRUE; + } + return FALSE; + } + bool handleEndElement(const QString &name) + { + EndElementHandlerT *handler = m_endHandlers[name]; + if (handler) + { + (*handler)(); + return TRUE; + } + return FALSE; + } +}; + + +#endif diff --git a/addon/xmlparse/compoundhandler.cpp b/addon/xmlparse/compoundhandler.cpp new file mode 100644 index 0000000..4949f63 --- /dev/null +++ b/addon/xmlparse/compoundhandler.cpp @@ -0,0 +1,100 @@ +#include "mainhandler.h" +#include "compoundhandler.h" +#include "dochandler.h" + +CompoundHandler::CompoundHandler(IBaseHandler *parent) + : m_parent(parent), m_brief(0), m_detailed(0) +{ + m_superClasses.setAutoDelete(TRUE); + + addEndHandler("compounddef",this,&CompoundHandler::endCompound); + + addStartHandler("compoundname"); + addEndHandler("compoundname",this,&CompoundHandler::endCompoundName); + + addStartHandler("derivedcompoundref",this,&CompoundHandler::addSubClass); + addEndHandler("derivedcompoundref"); + + addStartHandler("basecompoundref",this,&CompoundHandler::addSuperClass); + addEndHandler("basecompoundref"); + + addStartHandler("briefdescription",this,&CompoundHandler::startBriefDesc); + + addStartHandler("detaileddescription",this,&CompoundHandler::startDetailedDesc); + + addStartHandler("sectiondef",this,&CompoundHandler::startSection); +} + +CompoundHandler::~CompoundHandler() +{ +} + +void CompoundHandler::startSection(const QXmlAttributes& attrib) +{ + SectionHandler *sectHandler = new SectionHandler(this); + sectHandler->startSection(attrib); + m_sections.append(sectHandler); +} + +void CompoundHandler::startBriefDesc(const QXmlAttributes& attrib) +{ + DocHandler *docHandler = new DocHandler(this); + docHandler->startDoc(attrib); + m_brief = docHandler; +} + +void CompoundHandler::startDetailedDesc(const QXmlAttributes& attrib) +{ + DocHandler *docHandler = new DocHandler(this); + docHandler->startDoc(attrib); + m_detailed = docHandler; +} + +void CompoundHandler::startCompound(const QXmlAttributes& attrib) +{ + m_parent->setDelegate(this); + m_id = attrib.value("id"); + m_kind = attrib.value("kind"); + printf("startCompound(id=`%s' type=`%s')\n",m_id.data(),m_kind.data()); +} + +void CompoundHandler::endCompound() +{ + printf("endCompound()\n"); + m_parent->setDelegate(0); +} + +void CompoundHandler::endCompoundName() +{ + m_name = m_curString.stripWhiteSpace(); + printf("Compound name `%s'\n",m_name.data()); +} + +void CompoundHandler::addSuperClass(const QXmlAttributes& attrib) +{ + SuperClass *sc=new SuperClass( + attrib.value("idref"), + attrib.value("prot"), + attrib.value("virt") + ); + printf("super class id=`%s' prot=`%s' virt=`%s'\n", + sc->m_id.data(), + sc->m_protection.data(), + sc->m_virtualness.data()); + m_superClasses.append(sc); +} + +void CompoundHandler::addSubClass(const QXmlAttributes& attrib) +{ + SubClass *sc = new SubClass( + attrib.value("idref"), + attrib.value("prot"), + attrib.value("virt") + ); + printf("sub class id=`%s' prot=`%s' virt=`%s'\n", + sc->m_id.data(), + sc->m_protection.data(), + sc->m_virtualness.data()); + m_subClasses.append(sc); +} + diff --git a/addon/xmlparse/compoundhandler.h b/addon/xmlparse/compoundhandler.h new file mode 100644 index 0000000..cd7da55 --- /dev/null +++ b/addon/xmlparse/compoundhandler.h @@ -0,0 +1,57 @@ +#ifndef _COMPOUNDHANDLER_H +#define _COMPOUNDHANDLER_H + +#include +#include +#include + +#include "basehandler.h" +#include "sectionhandler.h" + +class DocHandler; + +class CompoundHandler : public BaseHandler +{ + public: + virtual void startSection(const QXmlAttributes& attrib); + virtual void startCompound(const QXmlAttributes& attrib); + virtual void addSuperClass(const QXmlAttributes& attrib); + virtual void addSubClass(const QXmlAttributes& attrib); + virtual void endCompound(); + virtual void endCompoundName(); + virtual void startBriefDesc(const QXmlAttributes& attrib); + virtual void startDetailedDesc(const QXmlAttributes& attrib); + + CompoundHandler(IBaseHandler *parent); + virtual ~CompoundHandler(); + private: + struct SuperClass + { + SuperClass(const QString &id,const QString &prot,const QString &virt) : + m_id(id),m_protection(prot),m_virtualness(virt) {} + + QString m_id; + QString m_protection; + QString m_virtualness; + }; + struct SubClass + { + SubClass(const QString &id,const QString &prot,const QString &virt) : + m_id(id),m_protection(prot),m_virtualness(virt) {} + + QString m_id; + QString m_protection; + QString m_virtualness; + }; + QList m_superClasses; + QList m_subClasses; + QList m_sections; + IBaseHandler *m_parent; + DocHandler *m_brief; + DocHandler *m_detailed; + QString m_id; + QString m_kind; + QString m_name; +}; + +#endif diff --git a/addon/xmlparse/dochandler.cpp b/addon/xmlparse/dochandler.cpp new file mode 100644 index 0000000..c9a96c4 --- /dev/null +++ b/addon/xmlparse/dochandler.cpp @@ -0,0 +1,316 @@ +#include "dochandler.h" + +//---------------------------------------------------------------------- +// MarkupHandler +//---------------------------------------------------------------------- + +MarkupHandler::MarkupHandler(QList &children,QString &curString) + : m_children(children), m_curString(curString), m_curMarkup(DocNode::Normal) +{ + addStartHandler("bold",this,&MarkupHandler::startBold); + addEndHandler("bold",this,&MarkupHandler::endBold); + + addStartHandler("emphasis",this,&MarkupHandler::startEmphasis); + addEndHandler("emphasis",this,&MarkupHandler::endEmphasis); + + addStartHandler("computeroutput",this,&MarkupHandler::startComputerOutput); + addEndHandler("computeroutput",this,&MarkupHandler::endComputerOutput); + + addStartHandler("center",this,&MarkupHandler::startCenter); + addEndHandler("center",this,&MarkupHandler::endCenter); + + addStartHandler("small",this,&MarkupHandler::startSmallFont); + addEndHandler("small",this,&MarkupHandler::endSmallFont); + + addStartHandler("subscript",this,&MarkupHandler::startSubscript); + addEndHandler("subscript",this,&MarkupHandler::endSubscript); + + addStartHandler("superscript",this,&MarkupHandler::startSuperscript); + addEndHandler("superscript",this,&MarkupHandler::endSuperscript); +} + +MarkupHandler::~MarkupHandler() +{ +} + +void MarkupHandler::addTextNode() +{ + if (!m_curString.isEmpty()) + { + m_children.append(new TextNode(m_curString,m_curMarkup)); + printf("addTextNode() text=%s markup=%x\n",m_curString.data(),m_curMarkup); + m_curString=""; + } +} + +void MarkupHandler::startBold(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Bold,TRUE)); + m_curMarkup |= DocNode::Bold; +} + +void MarkupHandler::endBold() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Bold,FALSE)); + m_curMarkup &= ~DocNode::Bold; +} + +void MarkupHandler::startEmphasis(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Emphasis,TRUE)); + m_curMarkup |= DocNode::Emphasis; +} + +void MarkupHandler::endEmphasis() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Emphasis,FALSE)); + m_curMarkup &= ~DocNode::Emphasis; +} + +void MarkupHandler::startComputerOutput(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::ComputerOutput,TRUE)); + m_curMarkup |= DocNode::ComputerOutput; +} + +void MarkupHandler::endComputerOutput() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::ComputerOutput,FALSE)); + m_curMarkup &= ~DocNode::ComputerOutput; +} + +void MarkupHandler::startCenter(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Center,TRUE)); + m_curMarkup |= DocNode::Center; +} + +void MarkupHandler::endCenter() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Center,FALSE)); + m_curMarkup &= ~DocNode::Center; +} + +void MarkupHandler::startSmallFont(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::SmallFont,TRUE)); + m_curMarkup |= DocNode::SmallFont; +} + +void MarkupHandler::endSmallFont() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::SmallFont,FALSE)); + m_curMarkup &= ~DocNode::SmallFont; +} + +void MarkupHandler::startSubscript(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Subscript,TRUE)); + m_curMarkup |= DocNode::Subscript; +} + +void MarkupHandler::endSubscript() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Subscript,FALSE)); + m_curMarkup &= ~DocNode::Subscript; +} + +void MarkupHandler::startSuperscript(const QXmlAttributes & /*attrib*/) +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Superscript,TRUE)); + m_curMarkup |= DocNode::Superscript; +} + +void MarkupHandler::endSuperscript() +{ + addTextNode(); + m_children.append(new MarkupModifierNode(DocNode::Superscript,FALSE)); + m_curMarkup &= ~DocNode::Superscript; +} + +//---------------------------------------------------------------------- +// ListItemHandler +//---------------------------------------------------------------------- + +ListItemHandler::ListItemHandler(IBaseHandler *parent) + : DocNode(ListItem), m_parent(parent) +{ + addEndHandler("listitem",this,&ListItemHandler::endListItem); + + addStartHandler("para",this,&ListItemHandler::startParagraph); +} + +ListItemHandler::~ListItemHandler() +{ +} + +void ListItemHandler::startListItem(const QXmlAttributes& /*attrib*/) +{ + m_parent->setDelegate(this); + printf("start list item handler\n"); +} + +void ListItemHandler::endListItem() +{ + printf("end list item handler\n"); + m_parent->setDelegate(0); +} + +void ListItemHandler::startParagraph(const QXmlAttributes& attrib) +{ + ParagraphHandler *parHandler = new ParagraphHandler(this); + parHandler->startParagraph(attrib); + m_children.append(parHandler); +} + +//---------------------------------------------------------------------- +// ListHandler +//---------------------------------------------------------------------- + +ListHandler::ListHandler(NodeKind k,IBaseHandler *parent) + : DocNode(k), m_parent(parent) +{ + m_children.setAutoDelete(TRUE); + const char *endListName=0; + switch(k) + { + case ItemizedList : endListName="itemizedlist"; break; + case OrderedList : endListName="orderedlist"; break; + default: ASSERT(0); + } + addEndHandler(endListName,this,&ListHandler::endList); + + addStartHandler("listitem",this,&ListHandler::startListItem); +} + +ListHandler::~ListHandler() +{ +} + +void ListHandler::startList(const QXmlAttributes& /*attrib*/) +{ + m_parent->setDelegate(this); +} + +void ListHandler::endList() +{ + m_parent->setDelegate(0); +} + +void ListHandler::startListItem(const QXmlAttributes& attrib) +{ + ListItemHandler *liHandler = new ListItemHandler(this); + liHandler->startListItem(attrib); + m_children.append(liHandler); +} + +//---------------------------------------------------------------------- +// ParagraphHandler +//---------------------------------------------------------------------- + +ParagraphHandler::ParagraphHandler(IBaseHandler *parent) + : DocNode(Para), m_parent(parent) +{ + m_children.setAutoDelete(TRUE); + + m_markupHandler = new MarkupHandler(m_children,m_curString); + setFallBackHandler(m_markupHandler); + + addEndHandler("para",this,&ParagraphHandler::endParagraph); + + addStartHandler("itemizedlist",this,&ParagraphHandler::startItemizedList); + addStartHandler("orderedlist",this,&ParagraphHandler::startOrderedList); +} + +ParagraphHandler::~ParagraphHandler() +{ +} + +void ParagraphHandler::startParagraph(const QXmlAttributes& /*attrib*/) +{ + m_parent->setDelegate(this); + printf("para\n"); +} + +void ParagraphHandler::endParagraph() +{ + addTextNode(); + printf("end para\n"); + m_parent->setDelegate(0); +} + +void ParagraphHandler::startItemizedList(const QXmlAttributes& attrib) +{ + addTextNode(); + ListHandler *listHandler = new ListHandler(ItemizedList,this); + listHandler->startList(attrib); + m_children.append(listHandler); +} + +void ParagraphHandler::startOrderedList(const QXmlAttributes& attrib) +{ + addTextNode(); + ListHandler *listHandler = new ListHandler(OrderedList,this); + listHandler->startList(attrib); + m_children.append(listHandler); +} + +void ParagraphHandler::addTextNode() +{ + if (!m_curString.isEmpty()) + { + m_children.append(new TextNode(m_curString,m_markupHandler->markup())); + printf("addTextNode() text=%s markup=%x\n", + m_curString.data(),m_markupHandler->markup()); + m_curString=""; + } +} + +//---------------------------------------------------------------------- +// DocHandler +//---------------------------------------------------------------------- + +DocHandler::DocHandler(IBaseHandler *parent) : m_parent(parent) +{ + addEndHandler("briefdescription",this,&DocHandler::endDoc); + addEndHandler("detaileddescription",this,&DocHandler::endDoc); + + addStartHandler("para",this,&DocHandler::startParagraph); +} + +DocHandler::~DocHandler() +{ +} + +void DocHandler::startDoc(const QXmlAttributes& /*attrib*/) +{ + m_parent->setDelegate(this); + printf("start dochandler\n"); +} + +void DocHandler::endDoc() +{ + printf("end dochandler\n"); + m_parent->setDelegate(0); +} + +void DocHandler::startParagraph(const QXmlAttributes& attrib) +{ + ParagraphHandler *parHandler = new ParagraphHandler(this); + parHandler->startParagraph(attrib); + m_children.append(parHandler); +} + diff --git a/addon/xmlparse/dochandler.h b/addon/xmlparse/dochandler.h new file mode 100644 index 0000000..761842f --- /dev/null +++ b/addon/xmlparse/dochandler.h @@ -0,0 +1,154 @@ +#ifndef _DOCHANDLER_H +#define _DOCHANDLER_H + +#include +#include +#include + +#include "basehandler.h" + +class DocNode +{ + public: + enum Markup + { + Normal = 0x00, + Bold = 0x01, + Emphasis = 0x02, + ComputerOutput = 0x04, + Subscript = 0x08, + Superscript = 0x10, + SmallFont = 0x20, + Center = 0x40 + }; + enum NodeKind + { + Para, + Text, + MarkupModifier, + ItemizedList, + OrderedList, + ListItem + }; + DocNode(NodeKind k) : m_kind(k) {} + virtual ~DocNode() {} + + private: + NodeKind m_kind; +}; + +class TextNode : public DocNode +{ + public: + TextNode(const QString &t,int markup) + : DocNode(Text), m_text(t), m_markup(markup) {} + + private: + QString m_text; + int m_markup; +}; + +class MarkupModifierNode : public DocNode +{ + public: + MarkupModifierNode(int markup,bool enabled) + : DocNode(MarkupModifier), m_markup(markup), m_enabled(enabled) {} + + private: + int m_markup; + bool m_enabled; +}; + +class MarkupHandler : public BaseFallBackHandler +{ + public: + MarkupHandler(QList &children,QString &curString); + virtual ~MarkupHandler(); + int markup() const { return m_curMarkup; } + + virtual void startBold(const QXmlAttributes &attrib); + virtual void endBold(); + virtual void startEmphasis(const QXmlAttributes &attrib); + virtual void endEmphasis(); + virtual void startComputerOutput(const QXmlAttributes &attrib); + virtual void endComputerOutput(); + virtual void startCenter(const QXmlAttributes &attrib); + virtual void endCenter(); + virtual void startSmallFont(const QXmlAttributes &attrib); + virtual void endSmallFont(); + virtual void startSubscript(const QXmlAttributes &attrib); + virtual void endSubscript(); + virtual void startSuperscript(const QXmlAttributes &attrib); + virtual void endSuperscript(); + + + private: + void addTextNode(); + + QList &m_children; + QString &m_curString; + int m_curMarkup; +}; + +class ListItemHandler : public DocNode, public BaseHandler +{ + public: + ListItemHandler(IBaseHandler *parent); + virtual ~ListItemHandler(); + virtual void startListItem(const QXmlAttributes& attrib); + virtual void endListItem(); + virtual void startParagraph(const QXmlAttributes& attrib); + + private: + IBaseHandler *m_parent; + QList m_children; +}; + +class ListHandler : public DocNode, public BaseHandler +{ + public: + ListHandler(NodeKind k,IBaseHandler *parent); + virtual ~ListHandler(); + virtual void startList(const QXmlAttributes& attrib); + virtual void endList(); + virtual void startListItem(const QXmlAttributes& attrib); + + private: + IBaseHandler *m_parent; + QList m_children; +}; + +class ParagraphHandler : public DocNode, public BaseHandler +{ + public: + virtual void startParagraph(const QXmlAttributes& attrib); + virtual void endParagraph(); + virtual void startItemizedList(const QXmlAttributes& attrib); + virtual void startOrderedList(const QXmlAttributes& attrib); + + ParagraphHandler(IBaseHandler *parent); + virtual ~ParagraphHandler(); + + private: + void addTextNode(); + IBaseHandler *m_parent; + QList m_children; + MarkupHandler *m_markupHandler; +}; + + +class DocHandler : public BaseHandler +{ + public: + virtual void startDoc(const QXmlAttributes& attrib); + virtual void endDoc(); + virtual void startParagraph(const QXmlAttributes& attrib); + + DocHandler(IBaseHandler *parent); + virtual ~DocHandler(); + private: + IBaseHandler *m_parent; + QList m_children; +}; + +#endif diff --git a/addon/xmlparse/main.cpp b/addon/xmlparse/main.cpp new file mode 100644 index 0000000..82cc849 --- /dev/null +++ b/addon/xmlparse/main.cpp @@ -0,0 +1,54 @@ +#include "mainhandler.h" + +#include +#include +#include +#include +#include + +class ErrorHandler : public QXmlErrorHandler +{ + public: + virtual ~ErrorHandler() {} + bool warning( const QXmlParseException & ) + { + return FALSE; + } + bool error( const QXmlParseException & ) + { + return FALSE; + } + bool fatalError( const QXmlParseException &exception ) + { + fprintf(stderr,"Fatal error at line %d column %d: %s\n", + exception.lineNumber(),exception.columnNumber(), + exception.message().data()); + return FALSE; + } + QString errorString() { return ""; } + + private: + QString errorMsg; +}; + + +int main(int argc,char **argv) +{ + if (argc==1) + { + printf("Usage: %s file.xml\n",argv[0]); + exit(1); + } + + QFile xmlFile(argv[1]); + MainHandler handler; + ErrorHandler errorHandler; + QXmlInputSource source( xmlFile ); + QXmlSimpleReader reader; + reader.setContentHandler( &handler ); + reader.setErrorHandler( &errorHandler ); + reader.parse( source ); + + return 0; +} + diff --git a/addon/xmlparse/mainhandler.cpp b/addon/xmlparse/mainhandler.cpp new file mode 100644 index 0000000..b062578 --- /dev/null +++ b/addon/xmlparse/mainhandler.cpp @@ -0,0 +1,23 @@ +#include "mainhandler.h" + +void MainHandler::startCompound(const QXmlAttributes& attrib) +{ + CompoundHandler *compHandler = new CompoundHandler(this); + compHandler->startCompound(attrib); + m_compounds.append(compHandler); +} + +MainHandler::MainHandler() +{ + m_compounds.setAutoDelete(TRUE); + addStartHandler("doxygen"); + addStartHandler("compounddef",this,&MainHandler::startCompound); + addEndHandler("doxygen"); + addEndHandler("compounddef"); +} + +MainHandler::~MainHandler() +{ +} + + diff --git a/addon/xmlparse/mainhandler.h b/addon/xmlparse/mainhandler.h new file mode 100644 index 0000000..20eedc3 --- /dev/null +++ b/addon/xmlparse/mainhandler.h @@ -0,0 +1,18 @@ +#ifndef _MAINHANDLER_H +#define _MAINHANDLER_H + +#include +#include "basehandler.h" +#include "compoundhandler.h" + +class MainHandler : public BaseHandler +{ + public: + virtual void startCompound(const QXmlAttributes& attrib); + MainHandler(); + virtual ~MainHandler(); + private: + QList m_compounds; +}; + +#endif diff --git a/addon/xmlparse/memberhandler.cpp b/addon/xmlparse/memberhandler.cpp new file mode 100644 index 0000000..1130f8d --- /dev/null +++ b/addon/xmlparse/memberhandler.cpp @@ -0,0 +1,77 @@ +#include "memberhandler.h" +#include "sectionhandler.h" +#include "dochandler.h" + +MemberHandler::MemberHandler(IBaseHandler *parent) + : m_parent(parent), m_brief(0), m_detailed(0) +{ + addEndHandler("memberdef",this,&MemberHandler::endMember); + + addStartHandler("type"); + addEndHandler("type",this,&MemberHandler::endType); + + addStartHandler("name"); + addEndHandler("name",this,&MemberHandler::endName); + + addStartHandler("param",this,&MemberHandler::startParam); + + addStartHandler("briefdescription",this,&MemberHandler::startBriefDesc); + + addStartHandler("detaileddescription",this,&MemberHandler::startDetailedDesc); + +} + +MemberHandler::~MemberHandler() +{ +} + +void MemberHandler::startMember(const QXmlAttributes& attrib) +{ + m_parent->setDelegate(this); + m_kind = attrib.value("kind"); + m_id = attrib.value("id"); + m_protection = attrib.value("prot"); + m_virtualness = attrib.value("virtualness"); + printf("member kind=`%s' id=`%s' prot=`%s' virt=`%s'\n", + m_kind.data(),m_id.data(),m_protection.data(),m_virtualness.data()); +} + +void MemberHandler::startBriefDesc(const QXmlAttributes& attrib) +{ + DocHandler *docHandler = new DocHandler(this); + docHandler->startDoc(attrib); + m_brief = docHandler; +} + +void MemberHandler::startDetailedDesc(const QXmlAttributes& attrib) +{ + DocHandler *docHandler = new DocHandler(this); + docHandler->startDoc(attrib); + m_detailed = docHandler; +} + +void MemberHandler::endMember() +{ + m_parent->setDelegate(0); +} + +void MemberHandler::endType() +{ + m_type = m_curString.stripWhiteSpace(); + printf("member type=`%s'\n",m_type.data()); +} + +void MemberHandler::endName() +{ + m_name = m_curString.stripWhiteSpace(); + printf("member name=`%s'\n",m_name.data()); +} + +void MemberHandler::startParam(const QXmlAttributes& attrib) +{ + ParamHandler *paramHandler = new ParamHandler(this); + paramHandler->startParam(attrib); + m_params.append(paramHandler); +} + + diff --git a/addon/xmlparse/memberhandler.h b/addon/xmlparse/memberhandler.h new file mode 100644 index 0000000..5f19ee2 --- /dev/null +++ b/addon/xmlparse/memberhandler.h @@ -0,0 +1,39 @@ +#ifndef _MEMBERHANDLER_H +#define _MEMBERHANDLER_H + +#include +#include +#include + +#include "basehandler.h" +#include "paramhandler.h" + +class DocHandler; + +class MemberHandler : public BaseHandler +{ + public: + virtual void startMember(const QXmlAttributes& attrib); + virtual void endMember(); + virtual void startParam(const QXmlAttributes& attrib); + virtual void endType(); + virtual void endName(); + virtual void startBriefDesc(const QXmlAttributes& attrib); + virtual void startDetailedDesc(const QXmlAttributes& attrib); + + MemberHandler(IBaseHandler *parent); + virtual ~MemberHandler(); + private: + IBaseHandler *m_parent; + QString m_kind; + QString m_id; + QString m_protection; + QString m_virtualness; + QString m_type; + QString m_name; + DocHandler *m_brief; + DocHandler *m_detailed; + QList m_params; +}; + +#endif diff --git a/addon/xmlparse/paramhandler.cpp b/addon/xmlparse/paramhandler.cpp new file mode 100644 index 0000000..3563ebd --- /dev/null +++ b/addon/xmlparse/paramhandler.cpp @@ -0,0 +1,79 @@ +#include "paramhandler.h" +#include "memberhandler.h" + +ParamHandler::ParamHandler(IBaseHandler *parent) : m_parent(parent) +{ + addEndHandler("param",this,&ParamHandler::endParam); + + addStartHandler("type"); + addEndHandler("type",this,&ParamHandler::endType); + + addStartHandler("declname"); + addEndHandler("declname",this,&ParamHandler::endDeclName); + + addStartHandler("defname"); + addEndHandler("defname",this,&ParamHandler::endDefName); + + addStartHandler("array"); + addEndHandler("array",this,&ParamHandler::endArray); + + addStartHandler("attrib"); + addEndHandler("attrib",this,&ParamHandler::endAttrib); + + addStartHandler("defval"); + addEndHandler("defval",this,&ParamHandler::endDefVal); +} + +ParamHandler::~ParamHandler() +{ +} + +void ParamHandler::startParam(const QXmlAttributes& /*attrib*/) +{ + m_parent->setDelegate(this); + printf("param\n"); +} + +void ParamHandler::endParam() +{ + m_parent->setDelegate(0); +} + +void ParamHandler::endType() +{ + m_type = m_curString.stripWhiteSpace(); + printf("param type=`%s'\n",m_type.data()); +} + +void ParamHandler::endDeclName() +{ + m_declName = m_curString.stripWhiteSpace(); + printf("member declName=`%s'\n",m_declName.data()); +} + +void ParamHandler::endDefName() +{ + m_defName = m_curString.stripWhiteSpace(); + printf("member defName=`%s'\n",m_defName.data()); +} + +void ParamHandler::endAttrib() +{ + m_attrib = m_curString.stripWhiteSpace(); + printf("member attrib=`%s'\n",m_attrib.data()); +} + +void ParamHandler::endArray() +{ + m_array = m_curString.stripWhiteSpace(); + printf("member array=`%s'\n",m_array.data()); +} + +void ParamHandler::endDefVal() +{ + m_defVal = m_curString.stripWhiteSpace(); + printf("member defVal=`%s'\n",m_defVal.data()); +} + + + diff --git a/addon/xmlparse/paramhandler.h b/addon/xmlparse/paramhandler.h new file mode 100644 index 0000000..062bab1 --- /dev/null +++ b/addon/xmlparse/paramhandler.h @@ -0,0 +1,34 @@ +#ifndef _PARAMHANDLER_H +#define _PARAMHANDLER_H + +#include +#include +#include + +#include "basehandler.h" + +class ParamHandler : public BaseHandler +{ + public: + virtual void startParam(const QXmlAttributes& attrib); + virtual void endParam(); + virtual void endType(); + virtual void endDeclName(); + virtual void endDefName(); + virtual void endAttrib(); + virtual void endArray(); + virtual void endDefVal(); + + ParamHandler(IBaseHandler *parent); + virtual ~ParamHandler(); + private: + IBaseHandler *m_parent; + QString m_type; + QString m_declName; + QString m_defName; + QString m_attrib; + QString m_array; + QString m_defVal; +}; + +#endif diff --git a/addon/xmlparse/sectionhandler.cpp b/addon/xmlparse/sectionhandler.cpp new file mode 100644 index 0000000..0b63832 --- /dev/null +++ b/addon/xmlparse/sectionhandler.cpp @@ -0,0 +1,34 @@ +#include "compoundhandler.h" +#include "sectionhandler.h" + +SectionHandler::SectionHandler(IBaseHandler *parent) : m_parent(parent) +{ + m_members.setAutoDelete(TRUE); + addEndHandler("sectiondef",this,&SectionHandler::endSection); + addStartHandler("memberdef",this,&SectionHandler::startMember); +} + +SectionHandler::~SectionHandler() +{ +} + +void SectionHandler::startSection(const QXmlAttributes& attrib) +{ + m_parent->setDelegate(this); + m_kind = attrib.value("kind"); + printf("section kind=`%s'\n",m_kind.data()); +} + +void SectionHandler::endSection() +{ + m_parent->setDelegate(0); +} + +void SectionHandler::startMember(const QXmlAttributes& attrib) +{ + MemberHandler *memHandler = new MemberHandler(this); + memHandler->startMember(attrib); + m_members.append(memHandler); +} + + diff --git a/addon/xmlparse/sectionhandler.h b/addon/xmlparse/sectionhandler.h new file mode 100644 index 0000000..b2d1ce1 --- /dev/null +++ b/addon/xmlparse/sectionhandler.h @@ -0,0 +1,26 @@ +#ifndef _SECTIONHANDLER_H +#define _SECTIONHANDLER_H + +#include +#include +#include + +#include "basehandler.h" +#include "memberhandler.h" + +class SectionHandler : public BaseHandler +{ + public: + virtual void startMember(const QXmlAttributes& attrib); + virtual void startSection(const QXmlAttributes& attrib); + virtual void endSection(); + + SectionHandler(IBaseHandler *parent); + virtual ~SectionHandler(); + private: + IBaseHandler *m_parent; + QString m_kind; + QList m_members; +}; + +#endif diff --git a/addon/xmlparse/xmlparse.pro.in b/addon/xmlparse/xmlparse.pro.in new file mode 100644 index 0000000..9e3b6aa --- /dev/null +++ b/addon/xmlparse/xmlparse.pro.in @@ -0,0 +1,26 @@ +TEMPLATE = app.t +CONFIG = console warn_on $extraopt +HEADERS = basehandler.h mainhandler.h \ + compoundhandler.h sectionhandler.h \ + memberhandler.h paramhandler.h \ + dochandler.h +SOURCES = main.cpp mainhandler.cpp \ + compoundhandler.cpp sectionhandler.cpp \ + memberhandler.cpp paramhandler.cpp \ + dochandler.cpp +DEPENDPATH = ../../src +unix:LIBS += -L../../lib -ldoxycfg -lqtools +win32:INCLUDEPATH += . +win32-mingw:LIBS += -L../../lib -ldoxycfg -lqtools +win32-msvc:LIBS += qtools.lib doxycfg.lib shell32.lib +win32-msvc:TMAKE_LFLAGS += /LIBPATH:..\..\lib +win32-borland:LIBS += qtools.lib doxycfg.lib shell32.lib +win32-borland:TMAKE_LFLAGS += -L..\..\lib +win32:TMAKE_CXXFLAGS += -DQT_NODLL +INCLUDEPATH += ../../qtools ../../src +DESTDIR = +TARGET = xmlparse +unix:TARGETDEPS = ../../lib/libdoxycfg.a +win32:TARGETDEPS = ../../lib/doxycfg.lib +OBJECTS_DIR = obj + diff --git a/addon/xmlread/Doxyfile b/addon/xmlread/Doxyfile deleted file mode 100644 index fa17d6f..0000000 --- a/addon/xmlread/Doxyfile +++ /dev/null @@ -1,142 +0,0 @@ -# Doxyfile 1.2.0 - -#--------------------------------------------------------------------------- -# General configuration options -#--------------------------------------------------------------------------- -PROJECT_NAME = xmlread -PROJECT_NUMBER = -OUTPUT_DIRECTORY = doc -OUTPUT_LANGUAGE = English -DISABLE_INDEX = NO -EXTRACT_ALL = NO -EXTRACT_PRIVATE = NO -EXTRACT_STATIC = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = YES -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ALWAYS_DETAILED_SEC = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -INTERNAL_DOCS = NO -CLASS_DIAGRAMS = YES -SOURCE_BROWSER = YES -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = NO -VERBATIM_HEADERS = YES -SHOW_INCLUDE_FILES = YES -JAVADOC_AUTOBRIEF = YES -INHERIT_DOCS = YES -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -TAB_SIZE = 8 -ENABLED_SECTIONS = -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_FORMAT = "$file:$line: $text" -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = . -FILE_PATTERNS = *.h *.cpp -RECURSIVE = NO -EXCLUDE = -EXCLUDE_PATTERNS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -IMAGE_PATH = -INPUT_FILTER = -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_ALIGN_MEMBERS = YES -GENERATE_HTMLHELP = NO -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_OUTPUT = latex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO -LATEX_BATCHMODE = NO -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = YES -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -#--------------------------------------------------------------------------- -# Configuration::addtions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -HAVE_DOT = YES -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DOT_PATH = -MAX_DOT_GRAPH_WIDTH = 1024 -MAX_DOT_GRAPH_HEIGHT = 1024 -#--------------------------------------------------------------------------- -# Configuration::addtions related to the search engine -#--------------------------------------------------------------------------- -SEARCHENGINE = NO -CGI_NAME = search.cgi -CGI_URL = -DOC_URL = -DOC_ABSPATH = -BIN_ABSPATH = /usr/local/bin/ -EXT_DOC_PATHS = diff --git a/addon/xmlread/Makefile.in b/addon/xmlread/Makefile.in deleted file mode 100644 index 723887e..0000000 --- a/addon/xmlread/Makefile.in +++ /dev/null @@ -1,12 +0,0 @@ -all clean depend: Makefile.xmlread - $(MAKE) -f Makefile.xmlread $@ - -distclean: clean - $(RM) -f Makefile.xmlread - -tmake: - export TMAKEPATH=$(TMAKEPATH) ; $(PERL) $(TMAKE) xmlread.pro >Makefile.xmlread - -Makefile.xmlread: xmlread.pro - export TMAKEPATH=$(TMAKEPATH) ; $(PERL) $(TMAKE) xmlread.pro >Makefile.xmlread - diff --git a/addon/xmlread/README b/addon/xmlread/README deleted file mode 100644 index 9420de6..0000000 --- a/addon/xmlread/README +++ /dev/null @@ -1,9 +0,0 @@ -This is a small utility that is used to test and validate the -XML output generated by doxygen (when GENERATE_XML = YES). - -It uses the Xerces-C XML parser/validator (see http://xml.apache.org) -and expects the environment variable XERCESCROOT to point to the root -of the Xerces package. - -Currently is reads an XML file, validates it, and prints the class -hierarchy contained in it. diff --git a/addon/xmlread/compounddef.h b/addon/xmlread/compounddef.h deleted file mode 100644 index 95f5b84..0000000 --- a/addon/xmlread/compounddef.h +++ /dev/null @@ -1,186 +0,0 @@ -#ifndef COMPOUNDDEF_H -#define COMPOUNDDEF_H - -#include "qtbc.h" -#include -#include -#include - -/*! Abstract interface for a compound as presented to the user */ -class CompoundDef -{ - public: - /*! Possible compound types */ - enum Type { Unknown_t, Class_t, Struct_t, Union_t, - File_t, Namespace_t, Group_t, Interface_t }; - /*! Destructor */ - virtual ~CompoundDef() {} - - /*! Returns the name of this compound */ - virtual QCString name() const = 0; - /*! Returns the type of this compound */ - virtual Type type() const = 0; - /*! Returns the unique identifier for this compound */ - virtual QCString id() const = 0; - /*! Returns the list of base compounds from which this compound inherits */ - virtual QList *baseCompounds() const = 0; - /*! Returns the list of compounds that derive from this one */ - virtual QList *derivedCompounds() const = 0; -}; - -/*! Ordered dictionary of abstract compounds. */ -class CompoundSDict : public QList -{ - friend class CompoundSDictIterator; - - public: - /*! Create an ordered dictionary. - * \param size The size of the dictionary. Should be a prime number for - * best distribution of elements. - */ - CompoundSDict(int size) - { - m_list = new QList; - m_list->setAutoDelete(TRUE); - m_dict = new QDict(size); - } - /*! Destroys the dictionary */ - ~CompoundSDict() - { - delete m_list; - delete m_dict; - } - /*! Appends a compound to the dictionary. The element is owned by the - * dictionary. - * \param key The unique key to use to quicky find the item later on. - * \param d The compound to add. - * \sa find() - */ - void append(const char *key,CompoundDef *d) - { - m_list->append(d); - m_dict->insert(key,d); - } - /*! Looks up a compound given its key. - * \param key The key to identify this element. - * \return The requested compound or zero if it cannot be found. - * \sa append() - */ - CompoundDef *find(const char *key) - { - return m_dict->find(key); - } - - private: - QList *m_list; - QDict *m_dict; -}; - -/*! Simple iterator for CompoundSDict. It iterates in the order the - * element were appended. - */ -class CompoundSDictIterator -{ - public: - /*! Create an iterator given the dictionary. */ - CompoundSDictIterator(const CompoundSDict &dict) - { - m_li = new QListIterator(*dict.m_list); - } - /*! Destroys the dictionary */ - ~CompoundSDictIterator() - { - delete m_li; - } - /*! Set the iterator to the first element in the list. - * \return The first compound, or zero if the list was empty. - */ - CompoundDef *toFirst() const - { - return m_li->toFirst(); - } - /*! Returns the current compound */ - CompoundDef *current() const - { - return m_li->current(); - } - /*! Moves the iterator to the next element. - * \return the new "current" element, or zero if the iterator was - * already pointing at the last element. - */ - CompoundDef *operator++() - { - return m_li->operator++(); - } - - private: - QListIterator *m_li; -}; - -/*! Concrete compound implementation. Used internally by the sax handlers */ -class CompoundDef_Impl : public CompoundDef -{ - public: - /*! Create an compound implementation object */ - CompoundDef_Impl() - { - m_type = Unknown_t; - m_baseCompounds = new QList; - m_derivedCompounds = new QList; - } - /*! Destroy the implementation object */ - ~CompoundDef_Impl() - { - delete m_baseCompounds; - delete m_derivedCompounds; - } - - /* implementation of the abstract interface */ - Type type() const { return m_type; } - QCString name() const { return m_name; } - QCString id() const { return m_id; } - QList *baseCompounds() const { return m_baseCompounds; } - QList *derivedCompounds() const { return m_derivedCompounds; } - - /*! Sets the type of the compound to \a t. */ - void setType(Type t) { m_type = t; } - /*! Sets the name of the compound to \a name. */ - void setName(const char *name) { m_name=name; } - /*! Sets the Id of the compound to \a id. */ - void setId(const char *id) { m_id=id; } - /*! Adds a new reference to the internal base class reference list */ - void addBaseRef(const char *name) { m_baseRefs.append(name); } - /*! Adds a new reference to the internal derived class reference list */ - void addDerivedRef(const char *name) { m_derivedRefs.append(name); } - - /*! Resolve the base and derived compound references. */ - void resolveReferences(CompoundSDict *dict) - { - char *refId; - refId = m_baseRefs.first(); - while (refId) - { - CompoundDef *cd = dict->find(refId); - m_baseCompounds->append(cd); - refId = m_baseRefs.next(); - } - refId = m_derivedRefs.first(); - while (refId) - { - CompoundDef *cd = dict->find(refId); - m_derivedCompounds->append(cd); - refId = m_derivedRefs.next(); - } - } - - private: - Type m_type; - QCString m_name; - QCString m_id; - QStrList m_derivedRefs; - QStrList m_baseRefs; - QList *m_baseCompounds; - QList *m_derivedCompounds; -}; - -#endif diff --git a/addon/xmlread/main.cpp b/addon/xmlread/main.cpp deleted file mode 100644 index 3f607f4..0000000 --- a/addon/xmlread/main.cpp +++ /dev/null @@ -1,133 +0,0 @@ -// --------------------------------------------------------------------------- -// Includes -// --------------------------------------------------------------------------- -#include -#include -#include "strx.h" -#include "saxhandlers.h" -#include "compounddef.h" - -// --------------------------------------------------------------------------- -// Local data -// -// xmlFile -// The path to the file to parser. Set via command line. -// -// --------------------------------------------------------------------------- -static char* xmlFile = 0; - -// --------------------------------------------------------------------------- -// Local helper methods -// --------------------------------------------------------------------------- -static void usage() -{ - cout << "\nUsage: xmlread file.xml\n" - << " Extracts the class hierarchy from a doxygen generated XML file.\n" - << endl; -} - -// recursively display non-root compounds -static void showDerivedCompounds(QList *compoundList,int level) -{ - if (compoundList->count()>0) - { - QListIterator cli(*compoundList); - CompoundDef *cd; - for (cli.toFirst();(cd=cli.current());++cli) - { - int i; - for (i=0;iname() << endl; - showDerivedCompounds(cd->derivedCompounds(),level+1); - } - } -} - -// show compound hierarchy -static void showCompoundHierarchy(CompoundSDict *compounds) -{ - CompoundSDictIterator cdi(*compounds); - CompoundDef *cd; - for (cdi.toFirst();(cd=cdi.current());++cdi) - { - if (cd->type()==CompoundDef::Class_t && - cd->baseCompounds()->count()==0) // root compound - { - cout << cd->name() << endl; - showDerivedCompounds(cd->derivedCompounds(),1); - } - } -} - -// --------------------------------------------------------------------------- -// Program entry point -// --------------------------------------------------------------------------- -int main(int argC, char* argV[]) -{ - // Initialize the XML4C2 system - try - { - XMLPlatformUtils::Initialize(); - } - catch (const XMLException& toCatch) - { - cerr << "Error during initialization! :\n" - << StrX(toCatch.getMessage()) << endl; - return 1; - } - - // Check command line and extract arguments. - if (argC!=2) - { - usage(); - return 1; - } - - // Watch for special case help request - if (strcmp(argV[1], "-?") == 0) - { - usage(); - return 0; - } - - // Assume the argument is a file name - xmlFile = argV[1]; - - // - // Create a SAX validating parser object. - // - SAXParser parser; - parser.setDoValidation(TRUE); - - // Create a compound dictionary, where the results will be stored. - // The size of the dictionary is 1009 entries (should be a prime number) - CompoundSDict compounds(1009); - - // - // Create the handler object and install it as the document and error - // handler for the parser. - // - SaxPass1Handlers handler(&compounds); - parser.setDocumentHandler(&handler); - parser.setErrorHandler(&handler); - - // Parse the file and catch any exceptions that propogate out - try - { - parser.parse(xmlFile); - } - catch (const XMLException& toCatch) - { - cerr << "\nFile not found: '" << xmlFile << "'\n" - << "Exception message is: \n" - << StrX(toCatch.getMessage()) - << "\n" << endl; - return -1; - } - - // Show the class hierarchy that we extracted - showCompoundHierarchy(&compounds); - - return 0; -} - diff --git a/addon/xmlread/qtbc.h b/addon/xmlread/qtbc.h deleted file mode 100644 index 51f62dd..0000000 --- a/addon/xmlread/qtbc.h +++ /dev/null @@ -1,45 +0,0 @@ -/****************************************************************************** - * - * - * - * Copyright (C) 1997-2001 by Dimitri van Heesch. - * - * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software - * for any purpose. It is provided "as is" without express or implied warranty. - * See the GNU General Public License for more details. - * - * Documents produced by Doxygen are derivative works derived from the - * input used in their production; they are not affected by this license. - * - */ - -#ifndef QTBC_H -#define QTBC_H - -/*! This file contains some hacks to make Doxygen work with - * Qt version 2.00 and Qt version 1.xx - */ - -#include - -#if QT_VERSION >= 200 - -#include - -#define GCI QCollection::Item - -#include -#include -inline QCString convertToQCString(const QString &s) { return s.latin1(); } - -#else /* QT_VERSION < 200 */ - -#include -#define QCString QString -inline QCString convertToQCString(const QCString &s) { return s; } - -#endif - -#endif diff --git a/addon/xmlread/saxhandlers.cpp b/addon/xmlread/saxhandlers.cpp deleted file mode 100644 index de8de89..0000000 --- a/addon/xmlread/saxhandlers.cpp +++ /dev/null @@ -1,185 +0,0 @@ - -// --------------------------------------------------------------------------- -// Includes -// --------------------------------------------------------------------------- -#include -#include -#include "saxhandlers.h" -#include "strx.h" -#include - -static void error(const SAXParseException& e) -{ - cerr << "\nError at (file " << StrX(e.getSystemId()) - << ", line " << e.getLineNumber() - << ", char " << e.getColumnNumber() - << "): " << StrX(e.getMessage()) << endl; - exit(1); -} - -static void fatalError(const SAXParseException& e) -{ - cerr << "\nFatal Error at (file " << StrX(e.getSystemId()) - << ", line " << e.getLineNumber() - << ", char " << e.getColumnNumber() - << "): " << StrX(e.getMessage()) << endl; - exit(1); -} - -static void warning(const SAXParseException& e) -{ - cerr << "\nWarning at (file " << StrX(e.getSystemId()) - << ", line " << e.getLineNumber() - << ", char " << e.getColumnNumber() - << "): " << StrX(e.getMessage()) << endl; - exit(1); -} - -// --------------------------------------------------------------------------- -// SaxPass1Handlers: Constructors and Destructor -// --------------------------------------------------------------------------- -SaxPass1Handlers::SaxPass1Handlers(CompoundSDict *comp) : m_compounds(comp) -{ - m_currentCompound = 0; -} - -SaxPass1Handlers::~SaxPass1Handlers() -{ -} - -// --------------------------------------------------------------------------- -// SaxPass1Handlers: Overrides of the SAX ErrorHandler interface -// --------------------------------------------------------------------------- -void SaxPass1Handlers::error(const SAXParseException& e) -{ - ::error(e); -} - -void SaxPass1Handlers::fatalError(const SAXParseException& e) -{ - ::fatalError(e); -} - -void SaxPass1Handlers::warning(const SAXParseException& e) -{ - ::warning(e); -} - -// --------------------------------------------------------------------------- -// SaxPass1Handlers: Overrides of the SAX DocumentHandler interface -// --------------------------------------------------------------------------- -void SaxPass1Handlers::characters(const XMLCh* const chars, - const unsigned int /*length*/ - ) -{ - if (m_charAction==ReadCompoundName) - { - m_compoundName=StrX(chars); - m_charAction=Done; - } -} - -void SaxPass1Handlers::endDocument() -{ - // resolve all references - CompoundSDictIterator cdi(*m_compounds); - CompoundDef *cd; - for (cdi.toFirst();(cd=cdi.current());++cdi) - { - CompoundDef_Impl *impl = dynamic_cast(cd); - impl->resolveReferences(m_compounds); - } -} - -void SaxPass1Handlers::startElement(const XMLCh* const name, - AttributeList& attributes - ) -{ - QCString sname = StrX(name); - if (sname=="compounddef") - { - m_currentCompound = new CompoundDef_Impl; - unsigned int len = attributes.getLength(),index; - for (index = 0; index < len; index++) - { - QCString attName = StrX(attributes.getName(index)); - QCString attValue = StrX(attributes.getValue(index)); - if (attName == "id") - { - m_currentCompound->setId(attValue); - } - else if (attName=="type") - { - if (attValue=="class") - { - m_currentCompound->setType(CompoundDef::Class_t); - } - else if (attValue=="struct") - { - m_currentCompound->setType(CompoundDef::Struct_t); - } - else if (attValue=="union") - { - m_currentCompound->setType(CompoundDef::Union_t); - } - else if (attValue=="interface") - { - m_currentCompound->setType(CompoundDef::Interface_t); - } - else if (attValue=="file") - { - m_currentCompound->setType(CompoundDef::File_t); - } - else - { - cerr << "Unsupported compound type: " << attValue << "\n"; - } - } - } - } - else if (sname=="compoundname") - { - m_charAction = ReadCompoundName; - } - else if (sname=="basecompoundref") - { - unsigned int len = attributes.getLength(),index; - for (index = 0; index < len; index++) - { - QCString attName = StrX(attributes.getName(index)); - QCString attValue = StrX(attributes.getValue(index)); - if (attName=="idref") - { - m_currentCompound->addBaseRef(attValue); - } - } - } - else if (sname=="derivedcompoundref") - { - unsigned int len = attributes.getLength(),index; - for (index = 0; index < len; index++) - { - QCString attName = StrX(attributes.getName(index)); - QCString attValue = StrX(attributes.getValue(index)); - if (attName=="idref") - { - m_currentCompound->addDerivedRef(attValue); - } - } - } -} - -void SaxPass1Handlers::endElement(const XMLCh* const name) -{ - QCString sname = StrX(name); - if (sname=="compounddef") - { - m_compounds->append(m_currentCompound->id(),m_currentCompound); - m_currentCompound=0; - } - else if (sname=="compoundname") - { - m_currentCompound->setName(m_compoundName); - } -} - diff --git a/addon/xmlread/saxhandlers.h b/addon/xmlread/saxhandlers.h deleted file mode 100644 index c9f38b8..0000000 --- a/addon/xmlread/saxhandlers.h +++ /dev/null @@ -1,101 +0,0 @@ -#ifndef _SAXHANDLERS_H -#define _SAXHANDLERS_H - -#include "compounddef.h" -#include - -/*! SAX Handlers used for pass 1. */ -class SaxPass1Handlers : public HandlerBase -{ - public: - // ----------------------------------------------------------------------- - //! @name Constructors - // ----------------------------------------------------------------------- - //@{ - /*! Constructor */ - SaxPass1Handlers(CompoundSDict *comp); - /*! Destructor */ - ~SaxPass1Handlers(); - //@} - - // ----------------------------------------------------------------------- - //! @name Implementations of the SAX DocumentHandler interface - // ----------------------------------------------------------------------- - //@{ - /*! Handler called at the start of the XML document */ - void startDocument() {} - /*! Handler called at the end of the XML document */ - void endDocument(); - /*! Handler called when an element is found in the XML file - * \param name The element's name. - * \param attributes The list of attributes for the element. - */ - void startElement(const XMLCh* const name, AttributeList& attributes); - /*! Handler called when the element of an element is found in the XML file - * \param name The element's name. - */ - void endElement(const XMLCh* const name); - /*! Handler called when a character string is found in the XML file. - * \param chars Zero terminated string of characters. - * \param length The number of characters in the string. - */ - void characters(const XMLCh* const chars, const unsigned int length); - - /*! Handler called when an amount of whitespace is found, that is not - * Part of the text. - */ - void ignorableWhitespace(const XMLCh* const /*chars*/, - const unsigned int /*length*/ - ) {} - - /*! Handler called when a preprocessing intruction is found. - */ - void processingInstruction(const XMLCh* const /*target*/, - const XMLCh* const /*data*/ - ) {} - //@} - - // ----------------------------------------------------------------------- - //! @name Implementations of the SAX ErrorHandler interface - // ----------------------------------------------------------------------- - //@{ - /*! Handler called for a parser warning. */ - void warning(const SAXParseException& exception); - /*! Handler called for a parser error. */ - void error(const SAXParseException& exception); - /*! Handler called for a parser fatal error. */ - void fatalError(const SAXParseException& exception); - //@} - - // ----------------------------------------------------------------------- - //! @name Implementation of the SAX DTDHandler interface - // ----------------------------------------------------------------------- - //@{ - /*! Handler for DTD notation declaration. */ - void notationDecl(const XMLCh* const /*name*/, - const XMLCh* const /*publicId*/, - const XMLCh* const /*systemId*/ - ) {} - - /*! Handler for DTD unparsed entity declaration. */ - void unparsedEntityDecl(const XMLCh* const /*name*/, - const XMLCh* const /*publicId*/, - const XMLCh* const /*systemId*/, - const XMLCh* const /*notationName*/ - ) {} - //@} - - private: - // ----------------------------------------------------------------------- - // Private data members - // - // ----------------------------------------------------------------------- - - enum CharActions { Done, ReadCompoundName }; - CompoundSDict *m_compounds; - CompoundDef_Impl *m_currentCompound; - QCString m_compoundName; - CharActions m_charAction; -}; - -#endif diff --git a/addon/xmlread/strx.h b/addon/xmlread/strx.h deleted file mode 100644 index ee58791..0000000 --- a/addon/xmlread/strx.h +++ /dev/null @@ -1,24 +0,0 @@ -#ifndef _STRX_H -#define _STRX_H - -// --------------------------------------------------------------------------- -// Includes for all the program files to see -// --------------------------------------------------------------------------- -#include "qtbc.h" -#include - -/*! - * This is a simple wrapper class around QCString that lets us do easy - * trancoding of XMLCh data to local code page for display. - */ -class StrX : public QCString -{ - public: - /*! Constructor */ - StrX(const XMLCh* const toTranscode) : - QCString(XMLString::transcode(toTranscode)) {} - /*! Destructor */ - ~StrX() {} -}; - -#endif diff --git a/addon/xmlread/xmlread.pro.in b/addon/xmlread/xmlread.pro.in deleted file mode 100644 index 0a59a9a..0000000 --- a/addon/xmlread/xmlread.pro.in +++ /dev/null @@ -1,7 +0,0 @@ -TEMPLATE = app -CONFIG = console qt warn_on debug -HEADERS = saxhandler.h strx.h compounddef.h -SOURCES = main.cpp \ - saxhandlers.cpp -LIBS = -lxerces-c1_2 -L$(XERCESCROOT)/lib -INCLUDEPATH = $(XERCESCROOT)/include diff --git a/configure b/configure index 99768ca..d0a8605 100755 --- a/configure +++ b/configure @@ -27,49 +27,48 @@ f_prefix=/usr f_insttool=NO f_english=NO f_wizard=NO -f_xmlgen=NO while test -n "$1"; do case $1 in - --prefix) + --prefix | -prefix) shift; f_prefix=$1 ;; - --shared) + --docdir | -docdir) + shift; f_docdir=$1/doxygen + ;; + --shared | -shared) f_shared=YES ;; - --static) + --static | -static) f_shared=NO ;; - --release) + --release | -release) f_debug=NO ;; - --debug) + --debug | -debug) f_debug=YES ;; - --english-only) + --english-only | -english-only) f_english=YES ;; - --platform) + --platform | -platform) shift; f_platform=$1 ;; - --make) + --make | -make) shift; f_make=$1 ;; - --dot) + --dot | -dot) shift; f_dot=$1 ;; - --perl) + --perl | -perl) shift; f_perl=$1 ;; - --install) + --install | -install) shift; f_insttool=$1 ;; - --with-doxywizard) + --with-doxywizard | -with-doxywizard) f_wizard=YES ;; - --with-xmlgen) - f_xmlgen=YES - ;; -h | -help | --help) f_help=y ;; @@ -86,46 +85,36 @@ if test "$f_help" = y; then cat </dev/null | grep GNU >/dev/null; then - install_prog="$j/$i" - break 2 - fi + install_prog="$j/$i" + break 2 fi done done @@ -371,6 +362,7 @@ VERSION = `cat VERSION` INSTALL = $f_prefix INSTTOOL = $f_insttool DOXYDOCS = .. +DOCDIR = $f_docdir EOF if test "$f_dot" != NO; then @@ -406,7 +398,7 @@ TMAKE_CXXFLAGS += -DENGLISH_ONLY EOF fi -f_inmakefiles="Makefile.in addon/xmlgen/Makefile.in qtools/Makefile.in src/Makefile.in examples/Makefile.in doc/Makefile.in addon/doxywizard/Makefile.in addon/xmlread/Makefile.in" +f_inmakefiles="Makefile.in qtools/Makefile.in src/Makefile.in examples/Makefile.in doc/Makefile.in addon/doxywizard/Makefile.in addon/xmlparse/Makefile.in" for i in $f_inmakefiles ; do SRC=$i @@ -427,26 +419,18 @@ EOF if test $f_wizard = YES; then echo " \$(MAKE) -C addon/doxywizard" >> $DST fi - if test $f_xmlgen = YES; then - echo " \$(MAKE) -C addon/xmlgen" >> $DST - fi echo "" >> $DST echo "doxywizard_install:" >> $DST if test $f_wizard = YES; then echo " \$(MAKE) -C addon/doxywizard install" >> $DST fi echo "" >> $DST - echo "xmlgen_install:" >> $DST - if test $f_xmlgen = YES; then - echo " \$(MAKE) -C addon/xmlgen install" >> $DST - fi - echo "" >> $DST fi cat $SRC >> $DST echo " Created $DST from $SRC..." done -f_inprofiles="qtools/qtools.pro.in src/libdoxygen.pro.in src/libdoxycfg.pro.in src/doxygen.pro.in src/doxytag.pro.in src/doxysearch.pro.in addon/doxywizard/doxywizard.pro.in addon/xmlread/xmlread.pro.in addon/xmlgen/xmlgen.pro.in" +f_inprofiles="qtools/qtools.pro.in src/libdoxygen.pro.in src/libdoxycfg.pro.in src/doxygen.pro.in src/doxytag.pro.in src/doxysearch.pro.in addon/doxywizard/doxywizard.pro.in addon/xmlparse/xmlparse.pro.in" for i in $f_inprofiles ; do SRC=$i diff --git a/doc/Doxyfile b/doc/Doxyfile index f992010..ca536a7 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -12,7 +12,7 @@ # Documents produced by Doxygen are derivative works derived from the # input used in their production; they are not affected by this license. -PROJECT_NAME = +PROJECT_NAME = "Doxygen manual" OUTPUT_DIRECTORY = .. HTML_HEADER = HTML_FOOTER = diff --git a/doc/config.doc b/doc/config.doc index bf5bac2..e4f021d 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -756,11 +756,8 @@ followed by the descriptions of the tags grouped by category. doxygen generates three additional HTML index files: \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a project file that can be read by - - Microsoft HTML Help Workshop - \latexonly - (see http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download\_main.htm) - \endlatexonly + + Microsoft's HTML Help Workshop on Windows. The HTML Help Workshop contains a compiler that can convert all HTML output @@ -1007,7 +1004,7 @@ EXTRA_PACKAGES = times \anchor cfg_man_links
\c MAN_LINKS
- \addindex MAN_LINKs + \addindex MAN_LINKS If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output, then it will generate one additional man file for each entity documented in the real man page(s). These additional files only source the real man page, @@ -1208,7 +1205,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... \anchor cfg_dot_cleanup
\c DOT_CLEANUP
\addindex DOT_CLEANUP - This tag can be used to ?? cleanup any mess DOT left behind? + This tag can be used to cleanup any mess DOT left behind. If left blank, "NO" is assumed. diff --git a/doc/index.doc b/doc/index.doc index c260a81..99e6d7c 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -79,7 +79,7 @@ sections. The first part forms a user manual:
  • Section \ref install discusses how to - download, compile and install + download, compile and install doxygen for your platform.
  • Section \ref starting tells you how to generate your first piece of documentation quickly. @@ -126,11 +126,11 @@ The second part forms a reference manual: I have compiled a \htmlonly -list of projects +list of projects that use doxygen. \endhtmlonly \latexonly -list of projects that use doxygen (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/projects.html}). +list of projects that use doxygen (see {\tt http://www.doxygen.org/projects.html}). \endlatexonly If you know other projects, let me know and I'll add them. @@ -138,10 +138,10 @@ If you know other projects, let me know and I'll add them. Although doxygen is used successfully by a lot of people already, there is always room for improvement. Therefore, I have compiled a \htmlonly -todo/wish list +todo/wish list \endhtmlonly \latexonly -todo/wish list (see {\tt http://www.stack.nl/$\sim$dimitri/doxygen/todo.html}) +todo/wish list (see {\tt http://www.doxygen.org/todo.html}) \endlatexonly of possible and/or requested enhancements. diff --git a/doc/install.doc b/doc/install.doc index 557df69..99e8e56 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -147,9 +147,9 @@ Compilation is now done by performing the following steps: make pdf \endverbatim - The postscript manual doxygen_manual.ps will be located + The PostScript manual doxygen_manual.ps will be located in the latex directory of the distribution. Just send it to a - postscript printer to print it or use ghostview to view it. + PostScript printer to print it or use ghostview to view it. @@ -165,13 +165,14 @@ Compilation is now done by performing the following steps: \endverbatim Binaries are installed into the directory \/bin. - Use make install_docs DOCDIR=\ to install the - documentation and examples into the \ directory. + Use make install_docs to install the + documentation and examples into \/doxygen. - \ defaults to /usr but can be changed with + \ defaults to /usr but can be changed with the --prefix option of the configure script. - The default DOCDIR directory is - \/share/doc/packages/doxygen + The default \ directory is + \/share/doc/packages and can be changed with + the --docdir option of the configure script. Alternatively, you can also copy the binaries from the bin directory manually to some bin directory in your search path. @@ -445,7 +446,7 @@ Here is what is required: (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the config file, then you need the Microsoft HTML help workshop. You can download it at: - http://msdn.microsoft.com/library/tools/htmlhelp/wkshp/download_main.htm + http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/vsconHH1Start.asp
  • If you used WinZip to extract the tar archive it will (apparently) not create empty folders, so you have to add the folders @@ -454,6 +455,7 @@ Here is what is required:
  • the Graph visualization toolkit version 1.5
    + \latexonly(see {\tt http://www.graphviz.org/})\endlatexonly. Needed for the include dependency graphs, the graphical inheritance graphs, and the collaboration graphs.
diff --git a/doc/language.doc b/doc/language.doc index 111616c..daf3178 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.8-20010723), 24 languages +Currently (version 1.2.8-20010726), 24 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Croatian, Czech, Danish, Dutch, English, Finnish, French, German, @@ -101,13 +101,13 @@ when the translator was updated. French Xavier Outhier - xavier.outhier@NOSPAM.anfdata.cz + xouthier@NOSPAM.yahoo.fr up-to-date German Jens Seidel
Jens Breitenstein - jensseidel@NOSPAM.users.sourceforge.net
Jens.Breitenstein@NOSPAM.tlc.de + jensseidel@NOSPAM.users.sf.net
Jens.Breitenstein@NOSPAM.tlc.de up-to-date @@ -222,9 +222,9 @@ when the translator was updated. \hline Finnish & Olli Korhonen & {\tt Olli.Korhonen@ccc.fi} & 1.0.0 \\ \hline - French & Xavier Outhier & {\tt xavier.outhier@anfdata.cz} & up-to-date \\ + French & Xavier Outhier & {\tt xouthier@yahoo.fr} & up-to-date \\ \hline - German & Jens Seidel & {\tt jensseidel@users.sourceforge.net} & up-to-date \\ + German & Jens Seidel & {\tt jensseidel@users.sf.net} & up-to-date \\ & Jens Breitenstein & {\tt Jens.Breitenstein@tlc.de} & \\ \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ @@ -295,13 +295,13 @@ Just follow these steps: \endverbatim after the if { ... }
  • Edit libdoxygen.pro.in and add \c translator_xx.h to - the \c HEADERS line in the file doxygen.pro. + the \c HEADERS line.
  • Edit translator_xx.h:
    • Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice.
    • Rename TranslatorEnglish to TranslatorYourLanguage
    • In the member idLanguage() change "english" into the - name of the your language (use lower case characters only). Depending + name of your language (use lower case characters only). Depending on the language you may also wish to change the member functions latexLanguageSupportCommand(), idLanguageCharset() and others (you will recognize them when you start the work). diff --git a/doc/language.tpl b/doc/language.tpl index 7390f02..7497bea 100644 --- a/doc/language.tpl +++ b/doc/language.tpl @@ -68,13 +68,13 @@ Just follow these steps: \endverbatim after the if { ... }
    • Edit libdoxygen.pro.in and add \c translator_xx.h to - the \c HEADERS line in the file doxygen.pro. + the \c HEADERS line.
    • Edit translator_xx.h:
      • Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice.
      • Rename TranslatorEnglish to TranslatorYourLanguage
      • In the member idLanguage() change "english" into the - name of the your language (use lower case characters only). Depending + name of your language (use lower case characters only). Depending on the language you may also wish to change the member functions latexLanguageSupportCommand(), idLanguageCharset() and others (you will recognize them when you start the work). diff --git a/doc/maintainers.txt b/doc/maintainers.txt index 7c60bcb..5d654e0 100644 --- a/doc/maintainers.txt +++ b/doc/maintainers.txt @@ -27,10 +27,10 @@ Finnish Olli Korhonen: Olli.Korhonen@ccc.fi French -Xavier Outhier: xavier.outhier@anfdata.cz +Xavier Outhier: xouthier@yahoo.fr German -Jens Seidel: jensseidel@users.sourceforge.net +Jens Seidel: jensseidel@users.sf.net Jens Breitenstein: Jens.Breitenstein@tlc.de Hungarian diff --git a/doc/translator.pl b/doc/translator.pl index 4c4bdac..a19a6d8 100644 --- a/doc/translator.pl +++ b/doc/translator.pl @@ -575,7 +575,7 @@ xxxTABLE_FOOTxxx ##}}} # Finish the tables, and substitute the mark in the doc - # template by the contatenation of the tables. Add NOSPAM to + # template by the concatenation of the tables. Add NOSPAM to # email addresses in the HTML table. Replace the special # character sequences. #{{{ # diff --git a/packages/rpm/doxygen.spec b/packages/rpm/doxygen.spec index b0df409..e84f38d 100644 --- a/packages/rpm/doxygen.spec +++ b/packages/rpm/doxygen.spec @@ -1,7 +1,7 @@ Name: doxygen -Version: 1.2.8_20010723 +Version: 1.2.9 Summary: documentation system for C, C++ and IDL -Release: 3 +Release: 4 Source: doxygen-%{version}.src.tar.gz Copyright: GPL @@ -41,13 +41,20 @@ Autor: %setup -n doxygen-%{version} %build -CFLAGS="$RPM_OPT_FLAGS" ./configure --with-doxywizard +CFLAGS="$RPM_OPT_FLAGS" ./configure --with-doxywizard --with-xmlgen +# the next path is Suse specific +QTDIR=/usr/lib/qt2 +PATH=${QTDIR}/bin:$PATH +export QTDIR PATH make %install rm -rf $RPM_BUILD_ROOT -make install INSTALL=$RPM_BUILD_ROOT/usr DOCDIR=$RPM_BUILD_ROOT%{_docdir}/doxygen -install -m 644 LICENSE LANGUAGE.HOWTO PLATFORMS README VERSION $RPM_BUILD_ROOT%{_docdir}/doxygen +make install install_docs INSTALL=$RPM_BUILD_ROOT/usr \ + DOCDIR=$RPM_BUILD_ROOT%{_docdir}/doxygen +install -m 644 LICENSE LANGUAGE.HOWTO PLATFORMS README VERSION \ + $RPM_BUILD_ROOT%{_docdir}/doxygen + find $RPM_BUILD_ROOT -name CVS -type d -depth -exec rm -r {} \; %files @@ -59,6 +66,11 @@ find $RPM_BUILD_ROOT -name CVS -type d -depth -exec rm -r {} \; rm -rf $RPM_BUILD_ROOT %changelog +* Sun Jun 10 2001 Matthias Andree + - update to 1.2.8.1 +* Tue Jun 5 2001 Matthias Andree + - update to 1.2.8 + - enable XML-Generator * Mon Apr 16 2001 Jens Seidel - new decription (english, german) - use of %{_docdir} diff --git a/src/classdef.cpp b/src/classdef.cpp index 6dbc086..0a600a2 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -103,6 +103,7 @@ ClassDef::ClassDef( m_templateMaster =0; m_templBaseClassNames = 0; m_artificial = FALSE; + m_isAbstract = FALSE; } // destroy the class definition @@ -453,6 +454,11 @@ void ClassDef::insertMember(MemberDef *md) } + if (md->virtualness()==Pure) + { + m_isAbstract=TRUE; + } + MemberInfo *mi = new MemberInfo((MemberDef *)md, md->protection(),md->virtualness(),FALSE); MemberNameInfo *mni=0; @@ -660,7 +666,10 @@ static void writeTemplateSpec(OutputList &ol,Definition *d, if (a) ol.docify(", "); } ol.docify(">"); + ol.pushGeneratorState(); + ol.disableAllBut(OutputGenerator::Html); ol.lineBreak(); + ol.popGeneratorState(); } ol.docify(type.lower()+" "+name); ol.endSubsubsection(); @@ -1186,8 +1195,11 @@ void ClassDef::writeDocumentation(OutputList &ol) ClassDef *innerCd; for (cli.toFirst();(innerCd=cli.current());++cli) { - msg("Generating docs for nested compound %s...\n",innerCd->name().data()); - innerCd->writeDocumentation(ol); + if (innerCd->isLinkableInProject() && innerCd->templateMaster()==0) + { + msg("Generating docs for nested compound %s...\n",innerCd->name().data()); + innerCd->writeDocumentation(ol); + } } } } diff --git a/src/classdef.h b/src/classdef.h index e662152..924c56f 100644 --- a/src/classdef.h +++ b/src/classdef.h @@ -195,6 +195,11 @@ class ClassDef : public Definition QCString qualifiedNameWithTemplateParameters( QList *actualParams=0) const; + /*! Returns TRUE if there is at least one pure virtual member in this + * class. + */ + bool isAbstract() const { return m_isAbstract; } + /* member lists by protection */ MemberList pubMembers; MemberList proMembers; @@ -402,6 +407,9 @@ class ClassDef : public Definition * the inheritance tree. */ bool m_artificial; + + /*! Is this an abstact class? */ + bool m_isAbstract; }; /*! \brief Class that contains information about a usage relation. diff --git a/src/code.l b/src/code.l index 69bf1a3..1c6506c 100644 --- a/src/code.l +++ b/src/code.l @@ -328,7 +328,7 @@ static void addVariable() else { int i; - if ((getResolvedClass(g_cvd.type)) || (g_codeClassDict[g_cvd.type])) + if ((getResolvedClass(g_currentDefinition,g_cvd.type)) || (g_codeClassDict[g_cvd.type])) { //printf("adding variable `%s' `%s'\n",g_cvd.type.data(),g_cvd.name.data()); g_cvd.classScope=g_classScope; @@ -337,7 +337,7 @@ static void addVariable() else if ((i=g_cvd.type.find('<'))>0) { g_cvd.type = g_cvd.type.left(i); - if ((getResolvedClass(g_cvd.type)) || (g_codeClassDict[g_cvd.type.left(i)])) + if ((getResolvedClass(g_currentDefinition,g_cvd.type)) || (g_codeClassDict[g_cvd.type.left(i)])) { //printf("adding template type variable `%s' `%s'\n",g_cvd.type.data(),g_cvd.name.data()); g_cvd.classScope=g_classScope; @@ -359,7 +359,7 @@ static void addParameter() else { int i; - if ((getResolvedClass(g_cvd.type)) || (g_codeClassDict[g_cvd.type])) + if ((getResolvedClass(g_currentDefinition,g_cvd.type)) || (g_codeClassDict[g_cvd.type])) { //printf("adding parameter `%s' `%s'\n",g_cvd.type.data(),g_cvd.name.data()); g_cvd.classScope=g_classScope; @@ -368,7 +368,7 @@ static void addParameter() else if ((i=g_cvd.type.find('<'))>0) { g_cvd.type = g_cvd.type.left(i); - if ((getResolvedClass(g_cvd.type)) || (g_codeClassDict[g_cvd.type.left(i)])) + if ((getResolvedClass(g_currentDefinition,g_cvd.type)) || (g_codeClassDict[g_cvd.type.left(i)])) { //printf("adding template type parameter `%s' `%s'\n",g_cvd.type.data(),g_cvd.name.data()); g_cvd.classScope=g_classScope; @@ -409,10 +409,10 @@ static void generateClassLink(OutputDocInterface &ol,char *clName,int *clNameLen QCString className=clName; if (clNameLen) *clNameLen=0; if (className.isEmpty()) return; - ClassDef *cd=getResolvedClass(className); + ClassDef *cd=getResolvedClass(g_currentDefinition,className); if (cd==0 && (i=className.find('<'))!=-1) { - cd=getResolvedClass(className.left(i)); + cd=getResolvedClass(g_currentDefinition,className.left(i)); } if (cd && cd->isLinkable()) { @@ -458,11 +458,11 @@ static ClassDef *stripClassName(const char *s) //printf("g_classScope=`%s' clName=`%s'\n",g_classScope.data(),clName.data()); if (!g_classScope.isEmpty()) { - cd=getResolvedClass(g_classScope+"::"+clName); + cd=getResolvedClass(g_currentDefinition,g_classScope+"::"+clName); } if (cd==0) { - cd=getResolvedClass(clName); + cd=getResolvedClass(g_currentDefinition,clName); } if (cd) { @@ -632,7 +632,7 @@ static void generateMemberLink(OutputDocInterface &ol,const char *varName, } else { - ClassDef *vcd = getResolvedClass(g_classScope); + ClassDef *vcd = getResolvedClass(g_currentDefinition,g_classScope); if (vcd && vcd->isLinkable()) { //printf("Found class %s for variable `%s'\n",g_classScope.data(),varName); diff --git a/src/config.l b/src/config.l index 583195c..3a887a6 100644 --- a/src/config.l +++ b/src/config.l @@ -2165,28 +2165,68 @@ void Config::create() // The IMAGE_PATTERNS tag is now officially obsolete. } - -bool Config::parse(const char *fn) +static QCString configFileToString(const char *name) { - QFileInfo fi( fn ); - if (!fi.exists()) + if (name==0 || name[0]==0) return 0; + QFile f; + + bool fileOpened=FALSE; + if (name[0]=='-' && name[1]==0) // read from stdin { - return FALSE; + fileOpened=f.open(IO_ReadOnly,stdin); + if (fileOpened) + { + const int bSize=4096; + QCString contents(bSize); + int totalSize=0; + int size; + while ((size=f.readBlock(contents.data()+totalSize,bSize))==bSize) + { + totalSize+=bSize; + contents.resize(totalSize+bSize); + } + totalSize+=size+2; + contents.resize(totalSize); + contents.at(totalSize-2)='\n'; // to help the scanner + contents.at(totalSize-1)='\0'; + return contents; + } } - QFile f( fn ); - if (!f.open(IO_ReadOnly)) + else // read from file { - return FALSE; + QFileInfo fi(name); + if (!fi.exists() || !fi.isFile()) + { + config_err("Error: file `%s' not found\n",name); + return ""; + } + f.setName(name); + fileOpened=f.open(IO_ReadOnly); + if (fileOpened) + { + int fsize=f.size(); + QCString contents(fsize+2); + f.readBlock(contents.data(),fsize); + if (fsize==0 || contents[fsize-1]=='\n') + contents[fsize]='\0'; + else + contents[fsize]='\n'; // to help the scanner + contents[fsize+1]='\0'; + f.close(); + return contents; + } } - // read file into a string buffer - int fsize = fi.size(); - QCString contents(fsize+1); // add room for \0 terminator - if (f.readBlock(contents.data(),fsize)!=fsize) + if (!fileOpened) { - return FALSE; + config_err("Error: cannot open file `%s' for reading\n",name); } - contents[fsize]='\0'; + return ""; +} + +bool Config::parse(const char *fn) +{ + QCString contents = configFileToString(fn); config = Config::instance(); inputString = contents.data(); inputPosition = 0; diff --git a/src/defargs.l b/src/defargs.l index ebdb6ad..3fa6e65 100644 --- a/src/defargs.l +++ b/src/defargs.l @@ -262,12 +262,12 @@ ID [a-z_A-Z][a-z_A-Z0-9]* a->attrib = g_curArgAttrib.copy(); if (i>=0 && g_curArgTypeName.at(i)!=':') { // type contains a name - a->type = g_curArgTypeName.left(i+1).stripWhiteSpace(); + a->type = removeRedundantWhiteSpace(g_curArgTypeName.left(i+1)); a->name = g_curArgTypeName.right(g_curArgTypeName.length()-i-1); } else // assume only the type was specified, try to determine name later { - a->type = g_curArgTypeName.stripWhiteSpace(); + a->type = removeRedundantWhiteSpace(g_curArgTypeName); } a->array = removeRedundantWhiteSpace(g_curArgArray); a->defval = g_curArgDefValue.copy(); @@ -365,7 +365,6 @@ void stringToArgumentList(const char *argsString,ArgumentList* &al) if (al==0) return; if (argsString==0) return; g_inputString = argsString; - //printf("stringToArgumentList(%s)\n",argsString); g_inputPosition = 0; g_curArgTypeName.resize(0); g_curArgDefValue.resize(0); @@ -374,6 +373,7 @@ void stringToArgumentList(const char *argsString,ArgumentList* &al) defargsYYrestart( defargsYYin ); BEGIN( Start ); defargsYYlex(); + //printf("stringToArgumentList(%s) result=%s\n",argsString,argListToString(al).data()); } extern "C" { // some bogus code to keep the compiler happy diff --git a/src/definition.cpp b/src/definition.cpp index f17d980..e4ea9c3 100644 --- a/src/definition.cpp +++ b/src/definition.cpp @@ -50,7 +50,7 @@ Definition::Definition(const char *df,int dl, m_todoId=0; m_testId=0; m_bugId=0; - m_outerScope=0; + m_outerScope=Doxygen::globalScope; } Definition::~Definition() diff --git a/src/doc.l b/src/doc.l index 017a4f0..2d7ddbe 100644 --- a/src/doc.l +++ b/src/doc.l @@ -2050,10 +2050,10 @@ OPMASK ({B}*{OPNORM}({OPARG}?))|({OPCAST}{OPARG}) "" "<"{TD}{ATTR}">" { if (curTable) curTable->newElem(); } "" -"<"{OL}{ATTR}">" { outDoc->startEnumList(); +"<"{OL}{ATTR}">"{BN}* { outDoc->startEnumList(); currentListIndent.push("O"); } -"" { +""{BN}* { if (currentListIndent.isEmpty()) { warn(yyFileName,yyLineNr, @@ -2072,10 +2072,10 @@ OPMASK ({B}*{OPNORM}({OPARG}?))|({OPCAST}{OPARG}) currentListIndent.pop(); } } -"<"{UL}{ATTR}">" { outDoc->startItemList(); +"<"{UL}{ATTR}">"{BN}* { outDoc->startItemList(); currentListIndent.push("U"); } -"" { +""{BN}* { if (currentListIndent.isEmpty()) { warn(yyFileName,yyLineNr, diff --git a/src/dot.cpp b/src/dot.cpp index 20666e6..88e0571 100644 --- a/src/dot.cpp +++ b/src/dot.cpp @@ -97,7 +97,8 @@ static bool convertMapFile(QTextStream &t,const char *mapName) if ((dest=Doxygen::tagDestinationDict[refPtr])) t << *dest << "/"; } t << urlPtr << "\" shape=\"rect\" coords=\"" - << x1 << "," << y1 << "," << x2 << "," << y2 << "\">" << endl; + << x1 << "," << y1 << "," << x2 << "," << y2 << "\"" + << " alt=\"\">" << endl; } } } diff --git a/src/doxygen.cpp b/src/doxygen.cpp index 01a22f2..a0dd54c 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -98,7 +98,7 @@ StringDict Doxygen::aliasDict(257); // aliases FileNameDict *Doxygen::includeNameDict; // include names FileNameDict *Doxygen::exampleNameDict; // examples FileNameDict *Doxygen::imageNameDict; // images -StringDict Doxygen::typedefDict(1009); // all typedefs +//TypedefDict Doxygen::typedefDict(1009); // all typedefs StringDict Doxygen::namespaceAliasDict(257); // all namespace aliases StringDict Doxygen::tagDestinationDict(257); // all tag locations // a member group @@ -140,7 +140,7 @@ void clearAll() Doxygen::includeNameDict->clear(); Doxygen::exampleNameDict->clear(); Doxygen::imageNameDict->clear(); - Doxygen::typedefDict.clear(); + //Doxygen::typedefDict.clear(); Doxygen::groupDict.clear(); Doxygen::formulaDict.clear(); Doxygen::formulaNameDict.clear(); @@ -172,7 +172,7 @@ void statistics() fprintf(stderr,"--- aliasDict stats ----\n"); Doxygen::aliasDict.statistics(); fprintf(stderr,"--- typedefDict stats ----\n"); - Doxygen::typedefDict.statistics(); + //Doxygen::typedefDict.statistics(); fprintf(stderr,"--- namespaceAliasDict stats ----\n"); Doxygen::namespaceAliasDict.statistics(); fprintf(stderr,"--- groupDict stats ----\n"); @@ -937,9 +937,6 @@ static void buildClassList(Entry *root) Definition *d = findScopeFromQualifiedName(Doxygen::globalScope,fullName); if (d==0) { - // TODO: Due to the order in which the tag file is written - // a nested class can be found before its parent! - // //warn(root->fileName,root->startLine, // "Warning: Internal inconsistency: scope for class %s not " // "found!\n",fullName.data() @@ -1263,8 +1260,6 @@ static void findUsingDeclarations(Entry *root) } } - - //---------------------------------------------------------------------- static MemberDef *addVariableToClass( @@ -1401,6 +1396,7 @@ static MemberDef *addVariableToClass( //TODO: insert FileDef instead of filename strings. cd->insertUsedFile(root->fileName); + root->section = Entry::EMPTY_SEC; return md; } @@ -1569,6 +1565,7 @@ static MemberDef *addVariableToFile( Doxygen::functionNameDict.insert(name,mn); Doxygen::functionNameList.append(mn); } + root->section = Entry::EMPTY_SEC; return md; } @@ -1983,6 +1980,7 @@ static void buildMemberList(Entry *root) cd->insertUsedFile(root->fileName); addMemberToGroups(root,md); + root->section = Entry::EMPTY_SEC; } else if (root->parent && !(root->parent->section & Entry::COMPOUND_MASK) && @@ -2176,6 +2174,7 @@ static void buildMemberList(Entry *root) Doxygen::functionNameList.append(mn); } addMemberToGroups(root,md); + root->section = Entry::EMPTY_SEC; } else { @@ -2397,28 +2396,6 @@ static void replaceNamespaceAliases(QCString &scope,int i) //printf("replaceNamespaceAliases() result=%s\n",scope.data()); } -static QCString resolveTypeDef(const QCString &name) -{ - QCString typeName; - if (!name.isEmpty()) - { - QCString *subst = Doxygen::typedefDict[name]; - if (subst) - { - int count=0; - typeName=*subst; - QCString *newSubst; - while ((newSubst=Doxygen::typedefDict[typeName]) && count<10) - { - if (typeName==*newSubst) break; // prevent lock-up - typeName=*newSubst; - count++; - } - } - } - return typeName; -} - /*! make a dictionary of all template arguments of class cd * that are part of the base class name. * Example: A template class A with template arguments @@ -2507,7 +2484,7 @@ static void findUsedClassesForClass(Entry *root, //printf("extractClassNameFromType(%s)\n",type.data()); while (!found && extractClassNameFromType(type,pos,usedClassName,templSpec)) { - QCString typeName = resolveTypeDef(usedClassName); + QCString typeName = resolveTypeDef(masterCd,usedClassName); QCString usedName = usedClassName+templSpec; if (!typeName.isEmpty()) { @@ -2566,14 +2543,14 @@ static void findUsedClassesForClass(Entry *root, QCString scopeName = scope ? scope->qualifiedName().data() : 0; if (!scopeName.isEmpty()) { - usedCd=getResolvedClass(scopeName+"::"+usedName,0,&templSpec); - if (usedCd==0) usedCd=getResolvedClass(scopeName+"::"+usedClassName,0,&templSpec); + usedCd=getResolvedClass(masterCd,scopeName+"::"+usedName,0,&templSpec); + if (usedCd==0) usedCd=getResolvedClass(masterCd,scopeName+"::"+usedClassName,0,&templSpec); //printf("Search for class %s result=%p\n",(scopeName+"::"+usedName).data(),usedCd); } else { - usedCd=getResolvedClass(usedName,0,&templSpec); - if (usedCd==0) usedCd=getResolvedClass(usedClassName,0,&templSpec); + usedCd=getResolvedClass(masterCd,usedName,0,&templSpec); + if (usedCd==0) usedCd=getResolvedClass(masterCd,usedClassName,0,&templSpec); //printf("Search for class %s result=%p\n",usedName.data(),usedCd); } if (scope) scope=scope->getOuterScope(); @@ -2735,17 +2712,19 @@ static bool findClassRelation( //printf("scopePrefix=`%s' bi->name=`%s'\n", // scopeName.left(scopeOffset).data(),bi->name.data()); - QCString baseClassName=stripTemplateSpecifiersFromScope - (removeRedundantWhiteSpace(bi->name)); + QCString baseClassName=bi->name; if (scopeOffset>0) { baseClassName.prepend(scopeName.left(scopeOffset)+"::"); } + baseClassName=stripTemplateSpecifiersFromScope + (removeRedundantWhiteSpace(baseClassName)); bool baseClassIsTypeDef; QCString templSpec; - ClassDef *baseClass=getResolvedClass(baseClassName,&baseClassIsTypeDef,&templSpec); + ClassDef *baseClass=getResolvedClass(cd,baseClassName,&baseClassIsTypeDef,&templSpec); + //printf("baseClassName=%s baseClass=%p cd=%p\n",baseClassName.data(),baseClass,cd); //printf(" baseClassName=`%s' baseClass=%s templSpec=%s\n", - // baseClassName.data(), + // baseClassName.data(), // baseClass?baseClass->name().data():"", // templSpec.data() // ); @@ -2787,7 +2766,7 @@ static bool findClassRelation( { templSpec=baseClassName.mid(i,e-i); baseClassName=baseClassName.left(i)+baseClassName.right(baseClassName.length()-e); - baseClass=getResolvedClass(baseClassName); + baseClass=getResolvedClass(cd,baseClassName); //printf("baseClass=%p -> baseClass=%s templSpec=%s\n", // baseClass,baseClassName.data(),templSpec.data()); } @@ -2799,7 +2778,7 @@ static bool findClassRelation( { // replace any namespace aliases replaceNamespaceAliases(baseClassName,i); - baseClass=getResolvedClass(baseClassName); + baseClass=getResolvedClass(cd,baseClassName); found=baseClass!=0 && baseClass!=cd; } @@ -2818,7 +2797,7 @@ static bool findClassRelation( for (nli.toFirst() ; (nd=nli.current()) && !found ; ++nli) { QCString fName = nd->name()+"::"+baseClassName; - found = (baseClass=getResolvedClass(fName))!=0 && baseClass!=cd && + found = (baseClass=getResolvedClass(cd,fName))!=0 && baseClass!=cd && root->name!=fName; } } @@ -2844,7 +2823,7 @@ static bool findClassRelation( { NamespaceList *nl = nd->getUsedNamespaces(); QCString fName = nd->name()+"::"+baseClassName; - found = (baseClass=getResolvedClass(fName))!=0 && root->name!=fName; + found = (baseClass=getResolvedClass(cd,fName))!=0 && root->name!=fName; if (nl) // try to prepend any of the using namespace scopes. { NamespaceListIterator nli(*nl); @@ -2852,7 +2831,7 @@ static bool findClassRelation( for (nli.toFirst() ; (nd=nli.current()) && !found ; ++nli) { fName = nd->name()+"::"+baseClassName; - found = (baseClass=getResolvedClass(fName))!=0 && baseClass!=cd && + found = (baseClass=getResolvedClass(cd,fName))!=0 && baseClass!=cd && root->name!=fName; } } @@ -3849,13 +3828,13 @@ static void findMember(Entry *root, if (!funcDecl.isEmpty() && funcDecl[0]!=' ') funcDecl.prepend(" "); // remove some superfluous spaces - funcDecl=substitute( - substitute( - substitute(funcDecl,"~ ","~"), - ":: ","::" - ), - " ::","::" - ); + funcDecl= substitute( + substitute( + substitute(funcDecl,"~ ","~"), + ":: ","::" + ), + " ::","::" + ); // extract information from the declarations parseFuncDecl(funcDecl,scopeName,classTempList,funcType,funcName, @@ -7005,7 +6984,7 @@ void parseInput() msg("Building class list...\n"); buildClassList(root); findUsingDeclarations(root); - + msg("Building example list...\n"); buildExampleList(root); diff --git a/src/doxygen.h b/src/doxygen.h index 47310b8..8b80676 100644 --- a/src/doxygen.h +++ b/src/doxygen.h @@ -49,6 +49,7 @@ class StringDict : public QDict virtual ~StringDict() {} }; + extern QCString spaces; /*! \brief This class serves as a namespace for global variables used by doxygen. @@ -78,7 +79,7 @@ class Doxygen static QTextStream tagFile; static SectionDict sectionDict; static FileNameList inputNameList; - static StringDict typedefDict; + //static TypedefDict typedefDict; static StringDict namespaceAliasDict; static GroupList groupList; static GroupDict groupDict; diff --git a/src/entry.h b/src/entry.h index 476fea5..3a68808 100644 --- a/src/entry.h +++ b/src/entry.h @@ -289,17 +289,10 @@ class Entry const char *groupdoccmd() const { switch( this->groupdoctype ) { - case GROUPDOC_NORMAL: - return "\\defgroup"; - break; - case GROUPDOC_ADD: - return "\\addgroup"; - break; - case GROUPDOC_WEAK: - return "\\weakgroup"; - break; - default: - return "unknown group command"; + case GROUPDOC_NORMAL: return "\\defgroup"; break; + case GROUPDOC_ADD: return "\\addgroup"; break; + case GROUPDOC_WEAK: return "\\weakgroup"; break; + default: return "unknown group command"; } } Grouping::GroupPri_t groupingpri() const @@ -308,17 +301,10 @@ class Entry return Grouping::GROUPING_LOWEST; } switch( this->groupdoctype ) { - case GROUPDOC_NORMAL: - return Grouping::GROUPING_AUTO_DEF; - break; - case GROUPDOC_ADD: - return Grouping::GROUPING_AUTO_ADD; - break; - case GROUPDOC_WEAK: - return Grouping::GROUPING_AUTO_WEAK; - break; - default: - return Grouping::GROUPING_LOWEST; + case GROUPDOC_NORMAL: return Grouping::GROUPING_AUTO_DEF; break; + case GROUPDOC_ADD: return Grouping::GROUPING_AUTO_ADD; break; + case GROUPDOC_WEAK: return Grouping::GROUPING_AUTO_WEAK; break; + default: return Grouping::GROUPING_LOWEST; } } private: diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp index 117b8ac..da43e85 100644 --- a/src/htmlgen.cpp +++ b/src/htmlgen.cpp @@ -48,7 +48,8 @@ static const char *defaultStyleSheet = "DL.el { margin-left: -1cm }\n" "DIV.fragment { width: 100%; border: none; background-color: #eeeeee }\n" "DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }\n" - "TD.md { background-color: #f2f2ff }\n" + "TD.md { background-color: #f2f2ff; font-weight: bold; }\n" + "TD.mdname { background-color: #f2f2ff; font-weight: bold; font-style: italic }\n" "DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }\n" "DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }\n" "FONT.keyword { color: #008000 }\n" @@ -160,6 +161,7 @@ void HtmlGenerator::writeFooterFile(QFile &file) void HtmlGenerator::startFile(const char *name,const char *, const char *title,bool external) { + //printf("HtmlGenerator::startFile(%s)\n",name); QCString fileName=name; lastTitle=title; if (fileName.right(5)!=".html") fileName+=".html"; @@ -870,13 +872,13 @@ void HtmlGenerator::startMemberDocPrefixItem() { DBG_HTML(t << "" << endl;) t << " " << endl; - t << " " << endl; + t << " " << endl; } void HtmlGenerator::endMemberDocPrefixItem() { DBG_HTML(t << "" << endl;) - t << " " << endl; + t << " " << endl; t << " " << endl; } @@ -884,51 +886,86 @@ void HtmlGenerator::startMemberDocName() { DBG_HTML(t << "" << endl;) t << " " << endl; - t << " " << endl; + t << " " << endl; } void HtmlGenerator::endMemberDocName() { DBG_HTML(t << "" << endl;) t << endl; - t << " " << endl; + t << " " << endl; } -void HtmlGenerator::startParameter(bool first) +void HtmlGenerator::startParameterList() +{ + DBG_HTML(t << "" << endl;) + t << " ( " << endl; +} + +void HtmlGenerator::startParameterType(bool first) { if (first) { - DBG_HTML(t << "" << endl;) - t << " " << endl; + DBG_HTML(t << "" << endl;) + t << " "; } else { - DBG_HTML(t << "" << endl;) + DBG_HTML(t << "" << endl;) t << " " << endl; t << " " << endl; - t << " " << endl; + t << " " << endl; + t << " "; } } -void HtmlGenerator::endParameter(bool first) +void HtmlGenerator::endParameterType() { - if (first) + DBG_HTML(t << "" << endl;) + t << " " << endl; +} + +void HtmlGenerator::startParameterName() +{ + DBG_HTML(t << "" << endl;) + t << " "; +} + +void HtmlGenerator::endParameterName(bool last,bool emptyList) +{ + DBG_HTML(t << "" << endl;) + if (last) { - DBG_HTML(t << "" << endl;) - t << endl; - t << " " << endl; - //t << " " << endl; - t << " " << endl; + if (emptyList) + { + t << " " << endl; + t << " ) " << endl; + t << " "; + } + else + { + t << " " << endl; + t << " " << endl; + t << " " << endl; + t << " " << endl; + t << " ) " << endl; + t << " "; + } } else { - DBG_HTML(t << "" << endl;) - t << endl; - t << " " << endl; + t << " " << endl; t << " " << endl; } } +void HtmlGenerator::endParameterList() +{ + DBG_HTML(t << "" << endl;) + t << " " << endl; + t << " " << endl; +} + void HtmlGenerator::endMemberDoc() { DBG_HTML(t << "" << endl;) diff --git a/src/htmlgen.h b/src/htmlgen.h index e334572..a471433 100644 --- a/src/htmlgen.h +++ b/src/htmlgen.h @@ -232,8 +232,12 @@ class HtmlGenerator : public OutputGenerator void endMemberDocPrefixItem(); void startMemberDocName(); void endMemberDocName(); - void startParameter(bool first); - void endParameter(bool last); + void startParameterType(bool first); + void endParameterType(); + void startParameterName(); + void endParameterName(bool last,bool emptyList); + void startParameterList(); + void endParameterList(); void startFontClass(const char *s) { t << ""; } void endFontClass() { t << ""; } diff --git a/src/htmlhelp.cpp b/src/htmlhelp.cpp index 482b53a..e024585 100644 --- a/src/htmlhelp.cpp +++ b/src/htmlhelp.cpp @@ -231,7 +231,7 @@ HtmlHelp *HtmlHelp::theInstance = 0; * The object has to be \link initialize() initialized\endlink before it can * be used. */ -HtmlHelp::HtmlHelp() +HtmlHelp::HtmlHelp() : indexFileDict(1009) { /* initial depth */ dc = 0; @@ -330,7 +330,7 @@ void HtmlHelp::createProjectFile() while (s) { t << s << endl; - s=indexFiles.next(); + s = indexFiles.next(); } f.close(); } @@ -342,7 +342,11 @@ void HtmlHelp::createProjectFile() void HtmlHelp::addIndexFile(const char *s) { - indexFiles.append(s); + if (indexFileDict.find(s)==0) + { + indexFiles.append(s); + indexFileDict.insert(s,(void *)0x8); + } } /*! Finalizes the HTML help. This will finish and close the diff --git a/src/htmlhelp.h b/src/htmlhelp.h index affadb2..319e25d 100644 --- a/src/htmlhelp.h +++ b/src/htmlhelp.h @@ -87,6 +87,7 @@ class HtmlHelp HtmlHelpIndex *index; int dc; QStrList indexFiles; + QDict indexFileDict; static HtmlHelp *theInstance; }; diff --git a/src/index.cpp b/src/index.cpp index 624e190..2f149dd 100644 --- a/src/index.cpp +++ b/src/index.cpp @@ -871,6 +871,8 @@ void writeFileIndex(OutputList &ol) { path=stripFromPath(fd->getPath().copy()); } + QCString fullName=fd->name(); + if (!path.isEmpty()) fullName.prepend(path+"/"); // --------------- LaTeX/RTF only ------------------------- if (doc) @@ -907,11 +909,11 @@ void writeFileIndex(OutputList &ol) ol.writeObjectLink(0,fd->getOutputFileBase(),0,fd->name()); if (hasHtmlHelp) { - htmlHelp->addContentsItem(FALSE,fd->name(),fd->getOutputFileBase()); + htmlHelp->addContentsItem(FALSE,fullName,fd->getOutputFileBase()); } if (hasFtvHelp) { - ftvHelp->addContentsItem(FALSE,fd->getReference(),fd->getOutputFileBase(),0,fd->name()); + ftvHelp->addContentsItem(FALSE,fd->getReference(),fd->getOutputFileBase(),0,fullName); } } else diff --git a/src/latexgen.cpp b/src/latexgen.cpp index 3031384..fb7777e 100644 --- a/src/latexgen.cpp +++ b/src/latexgen.cpp @@ -606,9 +606,13 @@ void LatexGenerator::endIndexSection(IndexSections is) } break; case isMainPage: - t << "}\n\\label{index}"; - if (Config_getBool("PDF_HYPERLINKS")) t << "\\hypertarget{index}{}"; - t << "\\input{index}\n"; + { + QCString indexName="index"; + if (Config_getBool("GENERATE_TREEVIEW")) indexName="main"; + t << "}\n\\label{index}"; + if (Config_getBool("PDF_HYPERLINKS")) t << "\\hypertarget{index}{}"; + t << "\\input{" << indexName << "}\n"; + } break; case isPackageIndex: t << "}\n\\input{packages}\n"; diff --git a/src/latexgen.h b/src/latexgen.h index 08c9370..2e2c8e4 100644 --- a/src/latexgen.h +++ b/src/latexgen.h @@ -239,8 +239,12 @@ class LatexGenerator : public OutputGenerator void endMemberDocPrefixItem() {} void startMemberDocName() {} void endMemberDocName() {} - void startParameter(bool) {} - void endParameter(bool) {} + void startParameterType(bool) {} + void endParameterType() {} + void startParameterName() {} + void endParameterName(bool,bool) {} + void startParameterList() {} + void endParameterList() {} void startFontClass(const char *) {} void endFontClass() {} diff --git a/src/mangen.h b/src/mangen.h index ba362fd..4d0f774 100644 --- a/src/mangen.h +++ b/src/mangen.h @@ -220,8 +220,12 @@ class ManGenerator : public OutputGenerator void endMemberDocPrefixItem() {} void startMemberDocName() {} void endMemberDocName() {} - void startParameter(bool) {} - void endParameter(bool) {} + void startParameterType(bool) {} + void endParameterType() {} + void startParameterName() {} + void endParameterName(bool,bool) {} + void startParameterList() {} + void endParameterList() {} void startFontClass(const char *) {} void endFontClass() {} diff --git a/src/memberdef.cpp b/src/memberdef.cpp index a91f821..3b22fd7 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -75,8 +75,18 @@ static void writeDefArgumentList(OutputList &ol,ClassDef *cd, ArgumentList *argList=md->argumentList(); if (argList==0) return; // member has no function like argument list if (!md->isDefine()) ol.docify(" "); + + ol.pushGeneratorState(); + ol.disableAllBut(OutputGenerator::Html); + ol.endMemberDocName(); + ol.startParameterList(); + ol.enableAll(); + ol.disable(OutputGenerator::Html); ol.docify("("); // start argument list ol.endMemberDocName(); + ol.popGeneratorState(); + //printf("===> name=%s isDefine=%d\n",md->name().data(),md->isDefine()); + Argument *a=argList->first(); QCString cName; //if (md->scopeDefTemplateArguments()) @@ -106,10 +116,10 @@ static void writeDefArgumentList(OutputList &ol,ClassDef *cd, //printf("~~~ %s cName=%s\n",md->name().data(),cName.data()); //if (!md->isDefine()) ol.startParameter(TRUE); else ol.docify(" "); - ol.startParameter(TRUE); bool first=TRUE; while (a) { + if (!md->isDefine() || first) ol.startParameterType(first); QRegExp re(")("); int vp; if (!a->attrib.isEmpty()) // argument has an IDL attribute @@ -128,6 +138,11 @@ static void writeDefArgumentList(OutputList &ol,ClassDef *cd, if (!cName.isEmpty()) n=addTemplateNames(n,cd->name(),cName); linkifyText(TextGeneratorOLImpl(ol),scopeName,md->name(),n); } + if (!md->isDefine()) + { + ol.endParameterType(); + ol.startParameterName(); + } if (!a->name.isEmpty()) // argument has a name { ol.docify(" "); @@ -146,7 +161,8 @@ static void writeDefArgumentList(OutputList &ol,ClassDef *cd, if (vp!=-1) // write the part of the argument type // that comes after the name { - linkifyText(TextGeneratorOLImpl(ol),scopeName,md->name(),a->type.right(a->type.length()-vp)); + linkifyText(TextGeneratorOLImpl(ol),scopeName, + md->name(),a->type.right(a->type.length()-vp)); } if (!a->defval.isEmpty()) // write the default value { @@ -161,17 +177,30 @@ static void writeDefArgumentList(OutputList &ol,ClassDef *cd, ol.docify(", "); // there are more arguments if (!md->isDefine()) { - ol.endParameter(first); - ol.startParameter(FALSE); + ol.endParameterName(FALSE,FALSE); + ol.startParameterType(FALSE); } } first=FALSE; } ol.pushGeneratorState(); + ol.disable(OutputGenerator::Html); + //if (!first) ol.writeString(" "); + ol.docify(")"); // end argument list + ol.enableAll(); ol.disableAllBut(OutputGenerator::Html); - if (!first) ol.writeString(" "); + if (!md->isDefine()) + { + if (first) ol.startParameterName(); + ol.endParameterName(TRUE,argList->count()<2); + } + else + { + ol.endParameterType(); + ol.startParameterName(); + ol.endParameterName(TRUE,TRUE); + } ol.popGeneratorState(); - ol.docify(")"); // end argument list if (argList->constSpecifier) { ol.docify(" const"); @@ -250,6 +279,12 @@ MemberDef::MemberDef(const char *df,int dl, m_defTmpArgLists=0; initLines=0; type=t; + if (mt==Typedef && type.left(8)=="typedef ") type=type.mid(8); + if (type.left(7)=="struct ") type=type.right(type.length()-7); + if (type.left(6)=="class " ) type=type.right(type.length()-6); + if (type.left(6)=="union " ) type=type.right(type.length()-6); + type=removeRedundantWhiteSpace(type); + args=a; args=removeRedundantWhiteSpace(args); if (type.isEmpty()) decl=name()+args; else decl=type+" "+name()+args; @@ -635,6 +670,7 @@ void MemberDef::writeDeclaration(OutputList &ol, } QCString ltype(type); + if (mtype==Typedef) ltype.prepend("typedef "); // strip `static' keyword from ltype if (ltype.left(7)=="static ") ltype=ltype.right(ltype.length()-7); // strip `friend' keyword from ltype @@ -1092,7 +1128,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, ol.docify("]"); ol.endTypewriter(); } - if (!isDefine()) ol.endParameter(TRUE); + if (!isDefine() && argList) ol.endParameterList(); ol.endMemberDoc(); ol.endDoxyAnchor(cfname,anchor()); ol.startIndent(); @@ -1108,6 +1144,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, ) ) { + //printf("md=%s initLines=%d init=`%s'\n",name().data(),initLines,init.data()); ol.startBold(); if (mtype==Define) parseText(ol,theTranslator->trDefineValue()); @@ -1439,7 +1476,8 @@ bool MemberDef::isLinkableInProject() const ((hasDocumentation() && !isReference()) ) && (prot!=Private || Config_getBool("EXTRACT_PRIVATE")) && // not a private class member - (classDef!=0 || Config_getBool("EXTRACT_STATIC") || !isStatic()); // not a static file/namespace member + (classDef!=0 || Config_getBool("EXTRACT_STATIC") || + !isStatic()); // not a static file/namespace member } bool MemberDef::isLinkable() const diff --git a/src/outputgen.h b/src/outputgen.h index d8c7917..7253c11 100644 --- a/src/outputgen.h +++ b/src/outputgen.h @@ -357,8 +357,12 @@ class OutputGenerator : public BaseOutputDocInterface virtual void endMemberDocPrefixItem() = 0; virtual void startMemberDocName() = 0; virtual void endMemberDocName() = 0; - virtual void startParameter(bool) = 0; - virtual void endParameter(bool) = 0; + virtual void startParameterType(bool) = 0; + virtual void endParameterType() = 0; + virtual void startParameterName() = 0; + virtual void endParameterName(bool,bool) = 0; + virtual void startParameterList() = 0; + virtual void endParameterList() = 0; protected: QTextStream fs; diff --git a/src/outputlist.h b/src/outputlist.h index c19d5d5..065144a 100644 --- a/src/outputlist.h +++ b/src/outputlist.h @@ -399,10 +399,18 @@ class OutputList : public OutputDocInterface { forall(&OutputGenerator::startMemberDocName); } void endMemberDocName() { forall(&OutputGenerator::endMemberDocName); } - void startParameter(bool first) - { forall(&OutputGenerator::startParameter,first); } - void endParameter(bool last) - { forall(&OutputGenerator::endParameter,last); } + void startParameterType(bool first) + { forall(&OutputGenerator::startParameterType,first); } + void endParameterType() + { forall(&OutputGenerator::endParameterType); } + void startParameterName() + { forall(&OutputGenerator::startParameterName); } + void endParameterName(bool last,bool emptyList) + { forall(&OutputGenerator::endParameterName,last,emptyList); } + void startParameterList() + { forall(&OutputGenerator::startParameterList); } + void endParameterList() + { forall(&OutputGenerator::endParameterList); } void startFontClass(const char *c) { forall(&OutputGenerator::startFontClass,c); } diff --git a/src/pre.l b/src/pre.l index cf673fc..3832f27 100644 --- a/src/pre.l +++ b/src/pre.l @@ -859,7 +859,7 @@ void addDefine() while ((c=*p++) && (c==' ' || c=='\t')) k++; g_defLitText=g_defLitText.mid(l+1,k-l-1)+g_defLitText.stripWhiteSpace(); } - md->setInitializer(g_defLitText); + md->setInitializer(g_defLitText.stripWhiteSpace()); //md->setDefFile(g_yyFileName); //md->setDefLine(g_yyLineNr); diff --git a/src/rtfgen.h b/src/rtfgen.h index 9dcfb70..d2189a8 100644 --- a/src/rtfgen.h +++ b/src/rtfgen.h @@ -223,8 +223,12 @@ class RTFGenerator : public OutputGenerator void endMemberDocPrefixItem() {} void startMemberDocName() {} void endMemberDocName() {} - void startParameter(bool) {} - void endParameter(bool) {} + void startParameterType(bool) {} + void endParameterType() {} + void startParameterName() {} + void endParameterName(bool,bool) {} + void startParameterList() {} + void endParameterList() {} void startFontClass(const char *) {} void endFontClass() {} diff --git a/src/scanner.l b/src/scanner.l index 54128b2..239af2e 100644 --- a/src/scanner.l +++ b/src/scanner.l @@ -329,6 +329,7 @@ static void checkDocs() } } +#if 0 static QCString extractName(const QCString &s) { //static const QRegExp id("[a-z_A-Z][a-z_A-Z0-9]*"); @@ -354,6 +355,7 @@ static QCString extractName(const QCString &s) ) l--; return removeRedundantWhiteSpace(result.left(l+1)); } +#endif static void setContext() { @@ -1459,16 +1461,18 @@ TITLE [tT][iI][tT][lL][eE] current->type=current->type.simplifyWhiteSpace(); current->args=current->args.simplifyWhiteSpace(); current->name=current->name.stripWhiteSpace(); - if (!current->name.isEmpty() && current->type.left(8)=="typedef ") - { - // add typedef to dictionary - QCString dest = extractName(current->type.right(current->type.length()-8)); - if (Doxygen::typedefDict[current->name]==0 && !dest.isEmpty()) - { - //printf("1>>>>>>>>>> adding %s->%s\n",current->name.data(),dest.data()); - Doxygen::typedefDict.insert(current->name, new QCString(dest)); - } - } + //if (!current->name.isEmpty() && current->type.left(8)=="typedef ") + //{ + // // add typedef to dictionary + // QCString dest = extractName(current->type.right(current->type.length()-8)); + // if (Doxygen::typedefDict[current->name]==0 && !dest.isEmpty()) + // { + // //printf("1>>>>>>>>>> adding %s->%s\n",current->name.data(),dest.data()); + // QCString scope; + // if (current_root->section & Entry::SCOPE_MASK) scope=current_root->name; + // Doxygen::typedefDict.insert(current->name, new TypedefInfo(dest,scope)); + // } + //} current->section = Entry::VARIABLE_SEC ; current->fileName = yyFileName; current->startLine = yyLineNr; @@ -1714,16 +1718,18 @@ TITLE [tT][iI][tT][lL][eE] //if (!current->name.isEmpty() && current->name[0]!='@' && // current->parent->section & Entry::COMPOUND_MASK) // varEntry->type+=current->parent->name+"::"; - if (isTypedef) - { - varEntry->type.prepend("typedef "); - //printf("current->name = %s %s\n",current->name.data(),msName.data()); - if (!current->name.isEmpty() && current->name.at(0)!='@') - { - //printf("2>>>>>>>>>> adding %s->%s\n",msName.data(),current->name.data()); - Doxygen::typedefDict.insert(msName,new QCString(current->name)); - } - } + //if (isTypedef) + //{ + // varEntry->type.prepend("typedef "); + // //printf("current->name = %s %s\n",current->name.data(),msName.data()); + // if (!current->name.isEmpty() && current->name.at(0)!='@') + // { + // //printf("2>>>>>>>>>> adding %s->%s\n",msName.data(),current->name.data()); + // QCString scope; + // if (current_root->section & Entry::SCOPE_MASK) scope=current_root->name; + // Doxygen::typedefDict.insert(msName,new TypedefInfo(current->name,scope)); + // } + //} varEntry->type+=current->name+msType; varEntry->fileName = yyFileName; varEntry->startLine = yyLineNr; @@ -2397,15 +2403,17 @@ TITLE [tT][iI][tT][lL][eE] } else { - if (isTypedef) - { - //QCString dest = extractName(current->name); - //printf("3>>>>>>>>>> adding %s->%s\n",yytext,current->name.data()); - Doxygen::typedefDict.insert(yytext,new QCString(current->name)); - //current->extends->append( - // new BaseInfo(yytext,Public,Normal) - // ); - } + //if (isTypedef) + //{ + // //QCString dest = extractName(current->name); + // //printf("3>>>>>>>>>> adding %s->%s\n",yytext,current->name.data()); + // QCString scope; + // if (current_root->section & Entry::SCOPE_MASK) scope=current_root->name; + // Doxygen::typedefDict.insert(yytext,new TypedefInfo(current->name,scope)); + // //current->extends->append( + // // new BaseInfo(yytext,Public,Normal) + // // ); + //} current->type += ' ' ; current->type += current->name ; current->name = yytext ; diff --git a/src/translator.h b/src/translator.h index c216deb..81fd7ff 100644 --- a/src/translator.h +++ b/src/translator.h @@ -53,353 +53,125 @@ class Translator */ virtual QCString updateNeededMessage() { return ""; } - + // Please, have a look at comments inside the translator_en.h file + // to learn the meaning of the following methods. The translator_en.h + // file contains the TranslatorEnglish implementation, which is + // always up-to-date (by definition). + // --- Language control methods ------------------- - /*! Used for identification of the language. - * See the comment for the translator_en.h method implementation - * for details. - */ virtual QCString idLanguage() = 0; - - /*! Used to get the command(s) for the language support. - * See the comment for the translator_en.h method implementation - * for details. - */ virtual QCString latexLanguageSupportCommand() = 0; - - /*! return the language charset. This will be used for the HTML output */ virtual QCString idLanguageCharset() = 0; // --- Language translation methods ------------------- - /*! used in the compound documentation before a list of related functions. */ virtual QCString trRelatedFunctions() = 0; - - /*! subscript for the related functions. */ virtual QCString trRelatedSubscript() = 0; - - /*! header that is put before the detailed description of files, classes and namespaces. */ virtual QCString trDetailedDescription() = 0; - - /*! header that is put before the list of typedefs. */ virtual QCString trMemberTypedefDocumentation() = 0; - - /*! header that is put before the list of enumerations. */ virtual QCString trMemberEnumerationDocumentation() = 0; - - /*! header that is put before the list of member functions. */ virtual QCString trMemberFunctionDocumentation() = 0; - - /*! header that is put before the list of member attributes. */ virtual QCString trMemberDataDocumentation() = 0; - - /*! this is the text of a link put after brief descriptions. */ virtual QCString trMore() = 0; - - /*! put in the class documentation */ virtual QCString trListOfAllMembers() = 0; - - /*! used as the title of the "list of all members" page of a class */ virtual QCString trMemberList() = 0; - - /*! this is the first part of a sentence that is followed by a class name */ virtual QCString trThisIsTheListOfAllMembers() = 0; - - /*! this is the remainder of the sentence after the class name */ virtual QCString trIncludingInheritedMembers() = 0; - - /*! this is put at the author sections at the bottom of man pages. - * parameter s is name of the project name. - */ virtual QCString trGeneratedAutomatically(const char *s) = 0; - - virtual QCString trEnumName() = 0; - - /*! put after an enum value in the list of all members */ virtual QCString trEnumValue() = 0; - - /*! put after an undocumented member in the list of all members */ virtual QCString trDefinedIn() = 0; // quick reference sections - /*! This is put above each page as a link to the list of all groups of - * compounds or files (see the \\group command). - */ virtual QCString trModules() = 0; - - /*! This is put above each page as a link to the class hierarchy */ virtual QCString trClassHierarchy() = 0; - - /*! This is put above each page as a link to the list of annotated classes */ virtual QCString trCompoundList() = 0; - - /*! This is put above each page as a link to the list of documented files */ virtual QCString trFileList() = 0; - - /*! This is put above each page as a link to the list of all verbatim headers */ virtual QCString trHeaderFiles() = 0; - - /*! This is put above each page as a link to all members of compounds. */ virtual QCString trCompoundMembers() = 0; - - /*! This is put above each page as a link to all members of files. */ virtual QCString trFileMembers() = 0; - - /*! This is put above each page as a link to all related pages. */ virtual QCString trRelatedPages() = 0; - - /*! This is put above each page as a link to all examples. */ virtual QCString trExamples() = 0; - - /*! This is put above each page as a link to the search engine. */ virtual QCString trSearch() = 0; - - /*! This is an introduction to the class hierarchy. */ virtual QCString trClassHierarchyDescription() = 0; - - /*! This is an introduction to the list with all files. */ virtual QCString trFileListDescription(bool extractAll) = 0; - - /*! This is an introduction to the annotated compound list. */ virtual QCString trCompoundListDescription() = 0; - - /*! This is an introduction to the page with all class members. */ virtual QCString trCompoundMembersDescription(bool extractAll) = 0; - - /*! This is an introduction to the page with all file members. */ virtual QCString trFileMembersDescription(bool extractAll) = 0; - - /*! This is an introduction to the page with the list of all header files. */ virtual QCString trHeaderFilesDescription() = 0; - - /*! This is an introduction to the page with the list of all examples */ virtual QCString trExamplesDescription() = 0; - - /*! This is an introduction to the page with the list of related pages */ virtual QCString trRelatedPagesDescription() = 0; - - /*! This is an introduction to the page with the list of class/file groups */ virtual QCString trModulesDescription() = 0; - - /*! This sentences is used in the annotated class/file lists if no brief - * description is given. - */ virtual QCString trNoDescriptionAvailable() = 0; // index titles (the project name is prepended for these) - - /*! This is used in HTML as the title of index.html. */ virtual QCString trDocumentation() = 0; - - /*! This is used in LaTeX as the title of the chapter with the - * index of all groups. - */ virtual QCString trModuleIndex() = 0; - - /*! This is used in LaTeX as the title of the chapter with the - * class hierarchy. - */ virtual QCString trHierarchicalIndex() = 0; - - /*! This is used in LaTeX as the title of the chapter with the - * annotated compound index. - */ virtual QCString trCompoundIndex() = 0; - - /*! This is used in LaTeX as the title of the chapter with the - * list of all files. - */ virtual QCString trFileIndex() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all groups. - */ virtual QCString trModuleDocumentation() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all classes, structs and unions. - */ virtual QCString trClassDocumentation() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all files. - */ virtual QCString trFileDocumentation() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all examples. - */ virtual QCString trExampleDocumentation() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all related pages. - */ virtual QCString trPageDocumentation() = 0; - - /*! This is used in LaTeX as the title of the document */ virtual QCString trReferenceManual() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of defines - */ virtual QCString trDefines() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of function prototypes - */ virtual QCString trFuncProtos() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of typedefs - */ virtual QCString trTypedefs() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of enumerations - */ virtual QCString trEnumerations() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of (global) functions - */ virtual QCString trFunctions() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of (global) variables - */ virtual QCString trVariables() = 0; - - /*! This is used in the documentation of a file as a header before the - * list of (global) variables - */ virtual QCString trEnumerationValues() = 0; - - /*! This is used in the documentation of a file before the list of - * documentation blocks for defines - */ virtual QCString trDefineDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for function prototypes - */ virtual QCString trFunctionPrototypeDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for typedefs - */ virtual QCString trTypedefDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for enumeration types - */ virtual QCString trEnumerationTypeDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for enumeration values - */ virtual QCString trEnumerationValueDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for functions - */ virtual QCString trFunctionDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace before the list - * of documentation blocks for variables - */ virtual QCString trVariableDocumentation() = 0; - - /*! This is used in the documentation of a file/namespace/group before - * the list of links to documented compounds - */ virtual QCString trCompounds() = 0; - - /*! This is used in the standard footer of each page and indicates when - * the page was generated - */ virtual QCString trGeneratedAt(const char *date,const char *projName) = 0; - - /*! This is part of the sentence used in the standard footer of each page. - */ virtual QCString trWrittenBy() = 0; - - /*! this text is put before a class diagram */ virtual QCString trClassDiagram(const char *clName) = 0; - - /*! this text is generated when the \\internal command is used. */ virtual QCString trForInternalUseOnly() = 0; - - /*! this text is generated when the \\reimp command is used. */ virtual QCString trReimplementedForInternalReasons() = 0; - - /*! this text is generated when the \\warning command is used. */ virtual QCString trWarning() = 0; - - /*! this text is generated when the \\bug command is used. */ virtual QCString trBugsAndLimitations() = 0; - - /*! this text is generated when the \\version command is used. */ virtual QCString trVersion() = 0; - - /*! this text is generated when the \\date command is used. */ virtual QCString trDate() = 0; - - /*! this text is generated when the \\return command is used. */ virtual QCString trReturns() = 0; - - /*! this text is generated when the \\sa command is used. */ virtual QCString trSeeAlso() = 0; - - /*! this text is generated when the \\param command is used. */ virtual QCString trParameters() = 0; - - /*! this text is generated when the \\exception command is used. */ virtual QCString trExceptions() = 0; - - /*! this text is used in the title page of a LaTeX document. */ virtual QCString trGeneratedBy() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990307 ////////////////////////////////////////////////////////////////////////// - /*! used as the title of page containing all the index of all namespaces. */ virtual QCString trNamespaceList() = 0; - - /*! used as an introduction to the namespace list */ virtual QCString trNamespaceListDescription(bool extractAll) = 0; - - /*! used in the class documentation as a header before the list of all - * friends of a class - */ virtual QCString trFriends() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990405 ////////////////////////////////////////////////////////////////////////// - /*! used in the class documentation as a header before the list of all - * related classes - */ virtual QCString trRelatedFunctionDocumentation() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990425 ////////////////////////////////////////////////////////////////////////// - /*! used as the title of the HTML page of a class/struct/union */ virtual QCString trCompoundReference(const char *clName, ClassDef::CompoundType compType, bool isTemplate) = 0; - /*! used as the title of the HTML page of a file */ virtual QCString trFileReference(const char *fileName) = 0; - - /*! used as the title of the HTML page of a namespace */ virtual QCString trNamespaceReference(const char *namespaceName) = 0; virtual QCString trPublicMembers() = 0; @@ -412,86 +184,36 @@ class Translator virtual QCString trPrivateMembers() = 0; virtual QCString trPrivateSlots() = 0; virtual QCString trStaticPrivateMembers() = 0; - - /*! this function is used to produce a comma-separated list of items. - * Use generateMarker(i) to indicate where item i should be put. - */ virtual QCString trWriteList(int numEntries) = 0; - - /*! used in class documentation to produce a list of base classes, - * if class diagrams are disabled. - */ virtual QCString trInheritsList(int numEntries) = 0; - - /*! used in class documentation to produce a list of super classes, - * if class diagrams are disabled. - */ virtual QCString trInheritedByList(int numEntries) = 0; - - /*! used in member documentation blocks to produce a list of - * members that are hidden by this one. - */ virtual QCString trReimplementedFromList(int numEntries) = 0; - - /*! used in member documentation blocks to produce a list of - * all member that overwrite the implementation of this member. - */ virtual QCString trReimplementedInList(int numEntries) = 0; - - /*! This is put above each page as a link to all members of namespaces. */ virtual QCString trNamespaceMembers() = 0; - - /*! This is an introduction to the page with all namespace members */ virtual QCString trNamespaceMemberDescription(bool extractAll) = 0; - - /*! This is used in LaTeX as the title of the chapter with the - * index of all namespaces. - */ virtual QCString trNamespaceIndex() = 0; - - /*! This is used in LaTeX as the title of the chapter containing - * the documentation of all namespaces. - */ virtual QCString trNamespaceDocumentation() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990522 ////////////////////////////////////////////////////////////////////////// - /*! This is used in the documentation before the list of all - * namespaces in a file. - */ virtual QCString trNamespaces() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990728 ////////////////////////////////////////////////////////////////////////// - /*! This is put at the bottom of a class documentation page and is - * followed by a list of files that were used to generate the page. - */ virtual QCString trGeneratedFromFiles(ClassDef::CompoundType compType, - bool single) = 0; - - /*! This is in the (quick) index as a link to the alphabetical compound - * list. - */ + bool single) = 0; virtual QCString trAlphabeticalList() = 0; ////////////////////////////////////////////////////////////////////////// // new since 0.49-990901 ////////////////////////////////////////////////////////////////////////// - /*! This is used as the heading text for the retval command. */ virtual QCString trReturnValues() = 0; - - /*! This is in the (quick) index as a link to the main page (index.html) - */ virtual QCString trMainPage() = 0; - - /*! This is used in references to page that are put in the LaTeX - * documentation. It should be an abbreviation of the word page. - */ virtual QCString trPageAbbreviation() = 0; ////////////////////////////////////////////////////////////////////////// @@ -499,9 +221,7 @@ class Translator ////////////////////////////////////////////////////////////////////////// virtual QCString trSources() = 0; - virtual QCString trDefinedAtLineInSourceFile() = 0; - virtual QCString trDefinedInSourceFile() = 0; ////////////////////////////////////////////////////////////////////////// @@ -514,34 +234,15 @@ class Translator // new since 1.0.0 ////////////////////////////////////////////////////////////////////////// - /*! this text is put before a collaboration diagram */ virtual QCString trCollaborationDiagram(const char *clName) = 0; - - /*! this text is put before an include dependency graph */ virtual QCString trInclDepGraph(const char *fName) = 0; - - /*! header that is put before the list of constructor/destructors. */ virtual QCString trConstructorDocumentation() = 0; - - /*! Used in the file documentation to point to the corresponding sources. */ virtual QCString trGotoSourceCode() = 0; - - /*! Used in the file sources to point to the corresponding documentation. */ virtual QCString trGotoDocumentation() = 0; - - /*! Text for the \\pre command */ virtual QCString trPrecondition() = 0; - - /*! Text for the \\post command */ virtual QCString trPostcondition() = 0; - - /*! Text for the \\invariant command */ virtual QCString trInvariant() = 0; - - /*! Text shown before a multi-line variable/enum initialization */ virtual QCString trInitialValue() = 0; - - /*! Text used the source code in the file index */ virtual QCString trCode() = 0; virtual QCString trGraphicalHierarchy() = 0; @@ -568,10 +269,7 @@ class Translator // new since 1.1.3 ////////////////////////////////////////////////////////////////////////// - /*! Used as a marker that is put before a \\todo item */ virtual QCString trTodo() = 0; - - /*! Used as the header of the todo list */ virtual QCString trTodoList() = 0; ////////////////////////////////////////////////////////////////////////// @@ -588,98 +286,61 @@ class Translator // new since 1.1.5 ////////////////////////////////////////////////////////////////////////// - /*! title of the graph legend page */ virtual QCString trLegendTitle() = 0; - - /*! page explaining how the dot graph's should be interpreted */ virtual QCString trLegendDocs() = 0; - - /*! text for the link to the legend page */ virtual QCString trLegend() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.0 ////////////////////////////////////////////////////////////////////////// - /*! Used as a marker that is put before a test item */ virtual QCString trTest() = 0; - - /*! Used as the header of the test list */ virtual QCString trTestList() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.1 ////////////////////////////////////////////////////////////////////////// - /*! Used as a section header for KDE-2 IDL methods */ virtual QCString trDCOPMethods() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.2 ////////////////////////////////////////////////////////////////////////// - /*! Used as a section header for IDL properties */ virtual QCString trProperties() = 0; - - /*! Used as a section header for IDL property documentation */ virtual QCString trPropertyDocumentation() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.4 ////////////////////////////////////////////////////////////////////////// - /*! Used for Java interfaces in the summary section of Java packages */ virtual QCString trInterfaces() = 0; - - /*! Used for Java classes in the summary section of Java packages */ virtual QCString trClasses() = 0; - - /*! Used as the title of a Java package */ virtual QCString trPackage(const char *name) = 0; - - /*! Title of the package index page */ virtual QCString trPackageList() = 0; - - /*! The description of the package index page */ virtual QCString trPackageListDescription() = 0; - - /*! The link name in the Quick links header for each page */ virtual QCString trPackages() = 0; - - /*! Used as a chapter title for Latex & RTF output */ virtual QCString trPackageDocumentation() = 0; - - /*! Text shown before a multi-line define */ virtual QCString trDefineValue() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.5 ////////////////////////////////////////////////////////////////////////// - /*! Used as a marker that is put before a \\bug item */ virtual QCString trBug() = 0; - - /*! Used as the header of the bug list */ virtual QCString trBugList() = 0; ////////////////////////////////////////////////////////////////////////// // new since 1.2.6 ////////////////////////////////////////////////////////////////////////// - /*! Used as ansicpg for RTF file */ virtual QCString trRTFansicp() = 0; - - /*! Used as ansicpg for RTF fcharset */ virtual QCString trRTFCharSet() = 0; - - /*! Used as header RTF general index */ virtual QCString trRTFGeneralIndex() = 0; - /*! The following are used for translation of the word that will - * possibly be followed by a single name or by a list of names - * of the category. - */ - virtual QCString trClass(bool first_capital, bool singular) = 0; + // Translation of the word + + virtual QCString trClass(bool first_capital, bool singular) = 0; virtual QCString trFile(bool first_capital, bool singular) = 0; virtual QCString trNamespace(bool first_capital, bool singular) = 0; virtual QCString trGroup(bool first_capital, bool singular) = 0; @@ -688,14 +349,10 @@ class Translator virtual QCString trField(bool first_capital, bool singular) = 0; virtual QCString trGlobal(bool first_capital, bool singular) = 0; - - ////////////////////////////////////////////////////////////////////////// - // new since 1.2.7 - ////////////////////////////////////////////////////////////////////////// +////////////////////////////////////////////////////////////////////////// +// new since 1.2.7 +////////////////////////////////////////////////////////////////////////// - /*! This text is generated when the \\author command is used and - * for the author section in man pages. - */ virtual QCString trAuthor(bool first_capital, bool singular) = 0; }; diff --git a/src/translator_br.h b/src/translator_br.h index 3d1e30f..8446771 100644 --- a/src/translator_br.h +++ b/src/translator_br.h @@ -12,9 +12,8 @@ * * Brazilian Portuguese version by * Fabio "FJTC" Jun Takada Chino - * Version: 1.2.6.1 (2001/04/13) + * Version: 1.2.8.2 (2001/07/24) */ - #ifndef TRANSLATOR_BR_H #define TRANSLATOR_BR_H @@ -33,8 +32,9 @@ class TranslatorBrazilian: public Translator */ virtual QCString idLanguage() { + /* I'm not sure if it is correct. I did not found the documentation + of BabelPackage. If you know the right string, please contact me. */ return "portuges"; - /* I'm not sure if it is correct. I did not found the documentation of BabelPackage*/ } /*! Used to get the command(s) for the language support. This method @@ -47,10 +47,6 @@ class TranslatorBrazilian: public Translator return "Brazilian"; } - /*! returns the name of the package that is included by LaTeX */ - virtual QCString latexBabelPackage() - { return ""; } - /*! return the language charset. This will be used for the HTML output */ virtual QCString idLanguageCharset() { @@ -138,12 +134,6 @@ class TranslatorBrazilian: public Translator virtual QCString trDefinedIn() { return "definida em"; } - /*! put as in introduction in the verbatim header file of a class. - * parameter f is the name of the include file. - */ - virtual QCString trVerbatimText(const char *f) - { return (QCString)"Este é o texto original do arquivo "+f+"."; } - // quick reference sections /*! This is put above each page as a link to the list of all groups of @@ -417,10 +407,6 @@ class TranslatorBrazilian: public Translator virtual QCString trEnumerationValues() { return "Valores Enumerados"; } - /*! This is used in man pages as the author section. */ - virtual QCString trAuthor() - { return "Autor"; } - /*! This is used in the documentation of a file before the list of * documentation blocks for defines */ @@ -478,12 +464,6 @@ class TranslatorBrazilian: public Translator } } - /*! This is used in the documentation of a group before the list of - * links to documented files - */ - virtual QCString trFiles() - { return "Arquivos"; } - /*! This is used in the standard footer of each page and indicates when * the page was generated */ @@ -531,10 +511,6 @@ class TranslatorBrazilian: public Translator virtual QCString trDate() { return "Data"; } - /*! this text is generated when the \\author command is used. */ - virtual QCString trAuthors() - { return "Autor(es)"; } - /*! this text is generated when the \\return command is used. */ virtual QCString trReturns() { return "Retorna"; } @@ -1322,6 +1298,5 @@ and if (!singular) result+="es"; return result; } - }; #endif diff --git a/src/translator_de.h b/src/translator_de.h index 65a5fe6..8e95779 100644 --- a/src/translator_de.h +++ b/src/translator_de.h @@ -49,6 +49,9 @@ // - Update for "new since 1.2.7-20010524" version: // removed trAuthors(), trAuthor(), added trAuthor(bool, bool) // +// 2001/07/24 Jens Seidel (jensseidel@users.sourceforge.net) +// - trClassDocumentation() updated as in the English translator. +// // Todo: // - translation of all Config_getBool("OPTIMIZE_OUTPUT_FOR_C") // strings (see translator_en.h) @@ -334,7 +337,12 @@ class TranslatorGerman : public Translator * the documentation of all classes, structs and unions. */ virtual QCString trClassDocumentation() - { return "Klassen-Dokumentation"; } + { + if (Config_getBool("OPTIMIZE_OUTPUT_FOR_C")) + return "Datenstruktur-Dokumentation"; + else + return "Klassen-Dokumentation"; + } /* This is used in LaTeX as the title of the chapter containing * the documentation of all files. @@ -990,7 +998,8 @@ class TranslatorGerman : public Translator return "Erklärung des Graphen"; } - /* page explaining how the dot graph's should be interpreted */ + /* page explaining how the dot graph's should be interpreted + The %A in the text below are to prevent link to classes called "A". */ virtual QCString trLegendDocs() { return diff --git a/src/translator_es.h b/src/translator_es.h index 88f4fb7..7da4ebe 100644 --- a/src/translator_es.h +++ b/src/translator_es.h @@ -1092,6 +1092,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_2_7 /*! Used as ansicpg for RTF file * * The following table shows the correlation of Charset name, Charset Value and + * 
              * Codepage number:
      * Charset Name       Charset Value(hex)  Codepage number
      * ------------------------------------------------------
@@ -1110,6 +1111,7 @@ class TranslatorSpanish : public TranslatorAdapter_1_2_7
      * HANGEUL_CHARSET         129 (x81)             949
      * GB2313_CHARSET          134 (x86)             936
      * CHINESEBIG5_CHARSET     136 (x88)             950
+     *
        * */ virtual QCString trRTFansicp() diff --git a/src/translator_fr.h b/src/translator_fr.h index c7a7f3f..bb3d415 100644 --- a/src/translator_fr.h +++ b/src/translator_fr.h @@ -16,7 +16,7 @@ * The translation into French was provided by * Christophe Bordeux (bordeux@lig.di.epfl.ch) * and after version 1.2.0 by Xavier Outhier (xouthier@yahoo.fr) - * member of of the non for profit association D2SET (http://www.d2set.org, + * member of the non for profit association D2SET (http://www.d2set.org, * d2set@d2set.org). */ diff --git a/src/translator_sk.h b/src/translator_sk.h index 4cb840f..5cb8621 100644 --- a/src/translator_sk.h +++ b/src/translator_sk.h @@ -34,7 +34,7 @@ class TranslatorSlovak : public TranslatorAdapter_1_2_7 } public: - // --- Language contol methods ------------------- + // --- Language control methods ------------------- virtual QCString idLanguage() { return "slovak"; } diff --git a/src/util.cpp b/src/util.cpp index 52045cb..576e1c1 100644 --- a/src/util.cpp +++ b/src/util.cpp @@ -332,6 +332,77 @@ int guessSection(const char *name) return 0; } +QCString resolveTypeDef(Definition *d,const QCString &name) +{ + //printf("resolveTypeDef(%s,%s)\n",d ? d->name().data() : "",name.data()); + QCString result; + if (name.isEmpty()) return result; + Definition *mContext=d; + MemberDef *md=0; + while (mContext && md==0) + { + MemberNameDict *mnd=0; + if (mContext->definitionType()==Definition::TypeClass) + { + mnd=&Doxygen::memberNameDict; + } + else + { + mnd=&Doxygen::functionNameDict; + } + MemberName *mn=mnd->find(name); + if (mn) + { + MemberNameIterator mni(*mn); + MemberDef *tmd=0; + for (;(tmd=mni.current());++mni) + { + //printf("Found member %s scope=%p mContext=%p\n",tmd->name().data(), + // tmd->getOuterScope(),mContext); + if (tmd->isTypedef() && tmd->getOuterScope()==mContext) + { + md=tmd; + } + } + } + mContext=mContext->getOuterScope(); + } + if (md) + { + //printf("Found typedef name `%s' in scope `%s' value=`%s'\n", + // name.data(),d->name().data(),md->typeString() + // ); + result=md->typeString(); + } + else + { + //printf("Typedef `%s' not found in scope `%s'!\n", + // name.data(),d ? d->name().data() : ""); + } + return result; + +#if 0 + QCString typeName; + if (!name.isEmpty()) + { + TypedefInfo *ti = Doxygen::typedefDict[name]; + if (ti) + { + int count=0; + typeName=ti->value; + TypedefInfo *newTi; + while ((newTi=Doxygen::typedefDict[typeName]) && count<10) + { + if (typeName==newTi->value) break; // prevent lock-up + typeName=newTi->value; + count++; + } + } + } + return typeName; +#endif +} + /*! Get a class definition given its name. * Returns 0 if the class is not found. */ @@ -366,32 +437,54 @@ NamespaceDef *getResolvedNamespace(const char *name) } } -ClassDef *getResolvedClass(const char *n,bool *pIsTypeDef,QCString *pTemplSpec) +ClassDef *getResolvedClass( + Definition *scope, + const char *n, + bool *pIsTypeDef, + QCString *pTemplSpec + ) { + //printf("getResolvedClass(%s,%s)\n",scope ? scope->name().data() : "", + // n); QCString name = n; if (name.isEmpty()) return 0; + if (scope==0) scope=Doxygen::globalScope; int i = name.findRev("::"); - QCString *subst = 0; - if (i!=-1) subst = Doxygen::typedefDict[name.right(name.length()-i-2)]; - if (subst==0) subst = Doxygen::typedefDict[name],i=-1; - if (subst) // there is a typedef with this name + //QCString subst = 0; + //if (i!=-1) subst = Doxygen::typedefDict[name.right(name.length()-i-2)]; + //if (subst==0) subst = Doxygen::typedefDict[name],i=-1; + //if (subst) // there is a typedef with this name + QCString subst; + if (i!=-1) + { + subst = resolveTypeDef(scope,name.right(name.length()-i-2)); + } + else + { + subst = resolveTypeDef(scope,name); + } + + if (!subst.isEmpty()) { if (pIsTypeDef) *pIsTypeDef=TRUE; //printf("getResolvedClass `%s'->`%s'\n",name.data(),subst->data()); - if (*subst==name) // avoid resolving typedef struct foo foo; + if (subst==name) // avoid resolving typedef struct foo foo; { return Doxygen::classSDict.find(name); } int count=0; // recursion detection guard - QCString *newSubst; - QCString typeName = *subst; + QCString newSubst; + QCString typeName = subst; if (i!=-1) typeName.prepend(name.left(i)+"::"); - while ((newSubst=Doxygen::typedefDict[typeName]) && count<10) + while (!(newSubst=resolveTypeDef(scope,typeName)).isEmpty() + && count<10) { - if (typeName==*newSubst) - return Doxygen::classSDict.find(subst->data()); // for breaking typedef struct A A; + if (typeName==newSubst) + { + return Doxygen::classSDict.find(subst); // for breaking typedef struct A A; + } subst=newSubst; - typeName=*newSubst; + typeName=newSubst; if (i!=-1) typeName.prepend(name.left(i)+"::"); count++; } @@ -437,15 +530,19 @@ static bool findOperator(const QCString &s,int i) return TRUE; } +static const char constScope[] = { 'c', 'o', 'n', 's', 't', ':' }; + QCString removeRedundantWhiteSpace(const QCString &s) { if (s.isEmpty()) return s; QCString result; uint i; uint l=s.length(); + uint csp=0; for (i=0;i' || s.at(i-1)==']') && @@ -914,46 +1016,24 @@ int minClassDistance(ClassDef *cd,ClassDef *bcd,int level) // strip any template specifiers that follow className in string s static QCString trimTemplateSpecifiers(const QCString &className,const QCString &s) { - // first we resolve any defines - //int i=0,p,l; - //QCString result; - //QRegExp r("[A-Z_a-z][A-Z_a-z0-9]*"); - //while ((p=r.match(s,i,&l))!=-1) - //{ - // if (p>i) result+=s.mid(i,p-i); - // result+=resolveDefines(s.mid(p,l)); - // i=p+l; - //} - //if (i<(int)s.length()) result+=s.mid(i,s.length()-i); - + //printf("trimTemplateSpecifiers(%s,%s)\n",className.data(),s.data()); + ClassDef *cd=getClass(className); + if (cd==0) return s; + + QCString qualName=cd->qualifiedNameWithTemplateParameters(); + //printf("QualifiedName = %s\n",qualName.data()); // We strip the template arguments following className (if any) - QCString result=s.copy(); - int l=className.length(); - if (l>0) // there is a class name + QCString result=s; + if (!qualName.isEmpty()) // there is a class name { int i,p=0; - while ((i=result.find(className,p))!=-1) // class name is in the argument type + // TODO: also try smaller parts of the qualName, since we + // could be inside a namespace or class. + while ((i=result.find(qualName,p))!=-1) // class name is in the argument type { - uint s=i+l; - if (s0 && e - { - if (result.at(e)=='<') b++; - else if (result.at(e)=='>') b--; - e++; - } - // remove template argument - result=result.left(s)+result.right(result.length()-e); - if (result.length()>s && (result.at(s)=='*' || result.at(s)=='&')) - { - // insert a space to keep the argument in the canonical form - result=result.left(s)+" "+result.right(result.length()-s); - } - } - p=i+l; + int ql=qualName.length(); + result=result.left(i)+cd->name()+result.right(result.length()-i-ql); + p=i+cd->name().length(); } } return result; @@ -981,6 +1061,7 @@ static QCString trimScope(const QCString &name,const QCString &s) scopeOffset=name.findRev("::",scopeOffset-1); result = tmp; } while (scopeOffset>0); + //printf("trimScope(name=%s,scope=%s)=%s\n",name.data(),s.data(),result.data()); return result; } @@ -1085,6 +1166,23 @@ void stripIrrelevantConstVolatile(QCString &s) } } +#if 0 // should be done differently +static QCString resolveTypeDefs(const QCString &s) +{ + QCString result; + static QRegExp re("[a-z_A-Z][a-z_A-Z0-9]*"); + int p=0,l,i; + while ((i=re.match(s,p,&l))!=-1) + { + result += s.mid(p,i-p); + result += resolveTypeDef(s.mid(i,l)); + p=i+l; + } + result+=s.right(s.length()-p); + return result; +} +#endif + // a bit of debug support for matchArguments #define MATCH #define NOMATCH @@ -1097,6 +1195,15 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA, NamespaceList *usingNamespaces, ClassList *usingClasses) { + //printf("match argument start %s:%s <-> %s:%s\n", + // srcA->type.data(),srcA->name.data(), + // dstA->type.data(),dstA->name.data()); + + // TODO: resolve any typedefs names that are part of srcA->type + // before matching. This should use className and namespaceName + // and usingNamespaces and usingClass to determine which typedefs + // are in-scope, so it will not be very efficient :-( + QCString srcAType=trimTemplateSpecifiers(className,srcA->type); QCString dstAType=trimTemplateSpecifiers(className,dstA->type); if (srcAType.left(6)=="class ") srcAType=srcAType.right(srcAType.length()-6); @@ -1106,21 +1213,34 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA, // from a syntactic point of view they would be two names of the same // type "const". This is not fool prove ofcourse, but should at least // catch the most common cases. - if (srcAType=="const" && !srcA->name.isEmpty()) + if ((srcAType=="const" || srcAType=="volatile") && !srcA->name.isEmpty()) { srcAType+=" "; srcAType+=srcA->name; } - if (dstAType=="const" && !dstA->name.isEmpty()) + if ((dstAType=="const" || dstAType=="volatile") && !dstA->name.isEmpty()) { dstAType+=" "; dstAType+=dstA->name; } - //printf("scope=`%s': `%s' <=> `%s'\n",className.data(),srcAType.data(),dstAType.data()); + if (srcA->name=="const" || srcA->name=="volatile") + { + srcAType+=srcA->name; + } + if (dstA->name=="const" || dstA->name=="volatile") + { + dstAType+=dstA->name; + } stripIrrelevantConstVolatile(srcAType); stripIrrelevantConstVolatile(dstAType); + //srcAType=stripTemplateSpecifiersFromScope(srcAType,FALSE); + //dstAType=stripTemplateSpecifiersFromScope(dstAType,FALSE); + + //printf("srcA=%s:%s dstA=%s:%s\n",srcAType.data(),srcA->name.data(), + // dstAType.data(),dstA->name.data()); + if (srcA->array!=dstA->array) // nomatch for char[] against char { NOMATCH @@ -1132,7 +1252,7 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA, // remove a namespace scope that is only in one type // (assuming a using statement was used) trimNamespaceScope(srcAType,dstAType); - + //QCString srcScope; //QCString dstScope; @@ -1192,7 +1312,8 @@ static bool matchArgument(const Argument *srcA,const Argument *dstA, MATCH return TRUE; } - //printf("srcA=%s::%s dstA=%s::%s\n",srcAType.data(),srcA->name.data(), + + //printf("2. srcA=%s:%s dstA=%s:%s\n",srcAType.data(),srcA->name.data(), // dstAType.data(),dstA->name.data()); uint srcPos=0,dstPos=0; @@ -1309,10 +1430,28 @@ static void mergeArgument(Argument *srcA,Argument *dstA, NamespaceList *usingNamespaces, ClassList *usingClasses) { + //printf("merge argument start %s:%s <-> %s:%s\n", + // srcA->type.data(),srcA->name.data(), + // dstA->type.data(),dstA->name.data()); + + if ((srcA->type=="const" || srcA->type=="volatile") && !srcA->name.isEmpty()) + { + srcA->type+=" "; + srcA->type+=srcA->name; + srcA->name.resize(0); + } + if ((dstA->type=="const" || dstA->type=="volatile") && !dstA->name.isEmpty()) + { + dstA->type+=" "; + dstA->type+=dstA->name; + dstA->name.resize(0); + } + QCString srcAType=trimTemplateSpecifiers(className,srcA->type); QCString dstAType=trimTemplateSpecifiers(className,dstA->type); if (srcAType.left(6)=="class ") srcAType=srcAType.right(srcAType.length()-6); if (dstAType.left(6)=="class ") dstAType=dstAType.right(dstAType.length()-6); + stripIrrelevantConstVolatile(srcAType); stripIrrelevantConstVolatile(dstAType); @@ -1324,6 +1463,7 @@ static void mergeArgument(Argument *srcA,Argument *dstA, // (assuming a using statement was used) trimNamespaceScope(srcAType,dstAType); + //QCString srcScope; //QCString dstScope; @@ -1376,14 +1516,14 @@ static void mergeArgument(Argument *srcA,Argument *dstA, { srcA->type=srcAType+" "+srcA->name; srcA->name.resize(0); - return; + goto done; } else if (!dstA->name.isEmpty() && !srcA->type.isEmpty() && (dstAType+" "+dstA->name)==srcAType) { dstA->type=dstAType+" "+dstA->name; dstA->name.resize(0); - return; + goto done; } //printf("srcA=%s::%s dstA=%s::%s\n",srcAType.data(),srcA->name.data(), // dstAType.data(),dstA->name.data()); @@ -1465,7 +1605,7 @@ static void mergeArgument(Argument *srcA,Argument *dstA, srcA->type=srcAType.left(startPos).stripWhiteSpace(); } } - return; + goto done; } //printf("match exactly\n"); if (srcA->name.isEmpty() && dstA->name.isEmpty()) @@ -1491,6 +1631,10 @@ static void mergeArgument(Argument *srcA,Argument *dstA, { dstA->name = srcA->name.copy(); } +done: + //printf("merge argument result %s:%s <-> %s:%s\n", + // srcA->type.data(),srcA->name.data(), + // dstA->type.data(),dstA->name.data()); return; } @@ -1632,23 +1776,26 @@ void mergeArguments(ArgumentList *srcAl,ArgumentList *dstAl) //printf("Defval changing `%s'->`%s'\n",dstA->defval.data(),srcA->defval.data()); dstA->defval=srcA->defval.copy(); } - if (srcA->name.isEmpty() && !dstA->name.isEmpty()) + if (srcA->type==dstA->type) { - //printf("type: `%s':=`%s'\n",srcA->type.data(),dstA->type.data()); - //printf("name: `%s':=`%s'\n",srcA->name.data(),dstA->name.data()); - srcA->type = dstA->type.copy(); - srcA->name = dstA->name.copy(); - } - else if (!srcA->name.isEmpty() && dstA->name.isEmpty()) - { - //printf("type: `%s':=`%s'\n",dstA->type.data(),srcA->type.data()); - //printf("name: `%s':=`%s'\n",dstA->name.data(),srcA->name.data()); - dstA->type = srcA->type.copy(); - dstA->name = dstA->name.copy(); - } - else if (!srcA->name.isEmpty() && !dstA->name.isEmpty()) - { - srcA->name = dstA->name.copy(); + if (srcA->name.isEmpty() && !dstA->name.isEmpty()) + { + //printf("type: `%s':=`%s'\n",srcA->type.data(),dstA->type.data()); + //printf("name: `%s':=`%s'\n",srcA->name.data(),dstA->name.data()); + srcA->type = dstA->type.copy(); + srcA->name = dstA->name.copy(); + } + else if (!srcA->name.isEmpty() && dstA->name.isEmpty()) + { + //printf("type: `%s':=`%s'\n",dstA->type.data(),srcA->type.data()); + //printf("name: `%s':=`%s'\n",dstA->name.data(),srcA->name.data()); + dstA->type = srcA->type.copy(); + dstA->name = dstA->name.copy(); + } + else if (!srcA->name.isEmpty() && !dstA->name.isEmpty()) + { + srcA->name = dstA->name.copy(); + } } int i1=srcA->type.find("::"), i2=dstA->type.find("::"), @@ -1766,7 +1913,7 @@ bool getDefs(const QCString &scName,const QCString &memberName, //printf("Trying class scope %s\n",className.data()); ClassDef *fcd=0; - if ((fcd=getResolvedClass(className)) && // is it a documented class + if ((fcd=getResolvedClass(Doxygen::globalScope,className)) && // is it a documented class fcd->isLinkable() ) { @@ -2002,7 +2149,7 @@ bool getDefs(const QCString &scName,const QCString &memberName, bmd = 0; break; } - if (!(md->isStatic())) bmd = md; + if (!(md->isStatic()) || Config_getBool("EXTRACT_STATIC")) bmd = md; } if (bmd) md=bmd; } @@ -2195,7 +2342,7 @@ bool generateRef(OutputDocInterface &od,const char *scName, if (getDefs(scopeStr,nameStr,argsStr,md,cd,fd,nd,gd, scopePos==0 && !memberScopeFirst)) { - //printf("after getDefs nd=%p\n",nd); + //printf("after getDefs md=%p cd=%p fd=%p nd=%p gd=%p\n",md,cd,fd,nd,gd); QCString anchor; if (md->isLinkable()) anchor = md->anchor(); QCString cName,aName; diff --git a/src/util.h b/src/util.h index 1a00394..e15f516 100644 --- a/src/util.h +++ b/src/util.h @@ -41,6 +41,7 @@ class NamespaceList; class ClassList; class MemberGroupList; class MemberGroupDict; +class Definition; //-------------------------------------------------------------------- @@ -104,7 +105,8 @@ extern QCString substituteClassNames(const QCString &s); extern QCString substitute(const char *s,const char *src,const char *dst); extern QCString resolveDefines(const char *n); extern ClassDef *getClass(const char *key); -extern ClassDef *getResolvedClass(const char *key, +extern ClassDef *getResolvedClass(Definition *scope, + const char *key, bool *pIsTypeDef=0, QCString *pTemplSpec=0); extern NamespaceDef *getResolvedNamespace(const char *key); @@ -157,6 +159,7 @@ ArgumentList *copyArgumentList(const ArgumentList *src); QList *copyArgumentLists(const QList *srcLists); QCString stripTemplateSpecifiersFromScope(const QCString &fullName, bool parentOnly=TRUE); +QCString resolveTypeDef(Definition *d,const QCString &name); #endif diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp index 4bb20e0..8b9ed39 100644 --- a/src/xmlgen.cpp +++ b/src/xmlgen.cpp @@ -26,12 +26,14 @@ #include "classlist.h" #include "util.h" #include "defargs.h" +#include "outputgen.h" +#include "doc.h" #include #include #include -static void writeXMLString(QTextStream &t,const char *s) +static inline void writeXMLString(QTextStream &t,const char *s) { t << convertToXML(s); } @@ -75,6 +77,629 @@ class TextGeneratorXMLImpl : public TextGeneratorIntf QTextStream &m_t; }; +template class ValStack +{ + public: + ValStack() : m_values(10), m_sp(0), m_size(10) {} + virtual ~ValStack() {} + ValStack(const ValStack &s) + { + m_values=s.m_values.copy(); + m_sp=s.m_sp; + m_size=s.m_size; + } + ValStack &operator=(const ValStack &s) + { + m_values=s.m_values.copy(); + m_sp=s.m_sp; + m_size=s.m_size; + return *this; + } + void push(T v) + { + m_sp++; + if (m_sp>=m_size) + { + m_size+=10; + m_values.resize(m_size); + } + m_values[m_sp]=v; + } + T pop() + { + ASSERT(m_sp!=0); + return m_values[m_sp--]; + } + T& top() + { + ASSERT(m_sp!=0); + return m_values[m_sp]; + } + bool isEmpty() + { + return m_sp==0; + } + + private: + QArray m_values; + int m_sp; + int m_size; +}; + +/*! This class is used by the documentation parser. + * Its methods are called when some XML text or markup + * needs to be written. + */ +class XMLGenerator : public OutputDocInterface +{ + public: + + // helper functions + + void startParMode() + { + if (!m_inParStack.isEmpty() && !m_inParStack.top()) + { + m_inParStack.top() = TRUE; + m_t << "" << endl; + } + else if (m_inParStack.isEmpty()) + { + m_inParStack.push(TRUE); + m_t << "" << endl; + } + } + void endParMode() + { + if (!m_inParStack.isEmpty() && m_inParStack.top()) + { + m_inParStack.top() = FALSE; + m_t << "" << endl; + } + } + void startNestedPar() + { + m_inParStack.push(FALSE); + } + void endNestedPar() + { + if (m_inParStack.pop()) + { + m_t << "" << endl; + } + } + + // Standard generator functions to be implemented by all generators + + void docify(const char *s) + { + startParMode(); + writeXMLString(m_t,s); + } + void writeChar(char c) + { + startParMode(); + char s[2];s[0]=c;s[1]=0; + docify(s); + } + void writeString(const char *text) + { + startParMode(); + m_t << text; + } + void startItemList() + { + m_t << "" << endl;; + m_inListStack.push(TRUE); + } + void startEnumList() + { + m_t << ""; + m_inListStack.push(TRUE); + } + void writeListItem() + { + if (!m_inListStack.isEmpty() && m_inListStack.top()) // first element + { + m_inListStack.top()=FALSE; + } + else // not first element, end previous element first + { + endParMode(); + endNestedPar(); + m_t << "" << endl; + } + m_t << ""; + startNestedPar(); + } + void endItemList() + { + if (!m_inListStack.isEmpty() && !m_inListStack.pop()) // first element + { + endParMode(); + endNestedPar(); + m_t << "" << endl; + } + m_t << "" << endl; + } + void endEnumList() + { + if (!m_inListStack.isEmpty() && !m_inListStack.pop()) // first element + { + endParMode(); + m_t << "" << endl; + endNestedPar(); + } + m_t << "" << endl; + } + void newParagraph() + { + endParMode(); + startParMode(); + } + void startBold() + { + startParMode(); + m_t << ""; // non DocBook + } + void endBold() + { + m_t << ""; // non DocBook + } + void startTypewriter() + { + startParMode(); + m_t << ""; + } + void endTypewriter() + { + m_t << ""; + } + void startEmphasis() + { + startParMode(); + m_t << ""; + } + void endEmphasis() + { + m_t << ""; + } + void startCodeFragment() + { + endParMode(); + m_t << ""; + } + void endCodeFragment() + { + m_t << ""; + } + void startPreFragment() + { + endParMode(); + m_t << ""; + } + void endPreFragment() + { + m_t << ""; + } + void writeRuler() + { + endParMode(); + m_t << ""; + } + void startDescription() + { + m_t << ""; + m_inListStack.push(TRUE); + } + void endDescription() + { + if (!m_inListStack.isEmpty() && !m_inListStack.pop()) // first element + { + endNestedPar(); + m_t << "" << endl; + } + m_t << ""; + if (!m_inListStack.isEmpty()) m_inListStack.pop(); + } + void startDescItem() + { + if (!m_inListStack.isEmpty() && m_inListStack.top()) // first element + { + m_inListStack.top()=FALSE; + } + else // not first element, end previous element first + { + endNestedPar(); + m_t << ""; + } + m_t << ""; + } + void endDescItem() + { + m_t << ""; + startNestedPar(); + } + void startDescList() + { + m_t << ""; + } + void endDescList() + { + endNestedPar(); + m_t << "</simplesect>"; + } + void startParamList() + { + m_t << "<parameterlist><title>"; // non DocBook + // TODO: what kind of list + // param, retval, exception + m_inParamList = TRUE; + } + void endParamList() + { + m_inParamList = FALSE; + m_t << "</parameterlist>"; + } + void endDescTitle() + { + m_t << ""; + if (!m_inParamList) startNestedPar(); + } + void writeDescItem() { } + void startDescTable() { } + void endDescTable() { } + void startDescTableTitle() + { + m_t << ""; // non docbook + } + void endDescTableTitle() + { + m_t << ""; // non docbook + } + void startDescTableData() + { + m_t << ""; // non docbook + startNestedPar(); + } + void endDescTableData() + { + endNestedPar(); + m_t << ""; // non docbook + } + void lineBreak() + { + m_t << ""; // non docbook + } + void writeNonBreakableSpace(int num) + { + int i;for (i=0;i"; // non docbook + } + + //// TODO: translate these as well.... + + void writeObjectLink(const char *ref,const char *file, + const char *anchor, const char *text) + { + if (ref) // TODO: add support for external references + { + docify(text); + } + else + { + writeXMLLink(m_t,file,anchor,text); + } + } + void writeCodeLink(const char *ref,const char *file, + const char *anchor,const char *text) + { + if (ref) // TODO: add support for external references + { + docify(text); + } + else + { + writeXMLLink(m_t,file,anchor,text); + } + } + void startHtmlLink(const char *url) + { + m_t << ""; + } + void endHtmlLink() + { + m_t << ""; + } + void writeMailLink(const char *url) + { + m_t << ""; + docify(url); + m_t << ""; + } + void startSection(const char *id,const char *,bool) + { + m_t << ""; + } + void endSection(const char *,bool) + { + m_t << ""; + } + void startSubsection() + { + m_t << ""; + } + void endSubsection() + { + m_t << ""; + } + void startSubsubsection() + { + m_t << ""; + } + void endSubsubsection() + { + m_t << ""; + } + void startCenter() + { + m_t << "
        "; // non docbook + } + void endCenter() + { + m_t << "
        "; // non docbook + } + void startSmall() + { + m_t << ""; // non docbook + } + void endSmall() + { + m_t << ""; // non docbook + } + void startSubscript() + { + m_t << ""; + } + void endSubscript() + { + m_t << ""; + } + void startSuperscript() + { + m_t << ""; + } + void endSuperscript() + { + m_t << ""; + } + void startTable(int cols) + { + m_t << "\n"; + } + void endTable() + { + m_t << "\n
        "; + } + void nextTableRow() + { + m_t << ""; + } + void endTableRow() + { + m_t << "" << endl; + } + void nextTableColumn() + { + m_t << ""; + } + void endTableColumn() + { + m_t << ""; + } + + void writeQuote() { m_t << "\""; } + void writeCopyright() { m_t << "©"; } + void writeUmlaut(char c) { m_t << "&" << c << "uml;"; } + void writeAcute(char c) { m_t << "&" << c << "acute;"; } + void writeGrave(char c) { m_t << "&" << c << "grave;"; } + void writeCirc(char c) { m_t << "&" << c << "circ;"; } + void writeTilde(char c) { m_t << "&" << c << "tilde;"; } + void writeRing(char c) { m_t << "&" << c << "ring;"; } + void writeSharpS() { m_t << "ß"; } + void writeCCedil(char c) { m_t << "&" << c << "cedil;"; } + + void startTitle() + { + m_t << ""; + } + void endTitle() + { + m_t << "" << endl; + } + void writeAnchor(const char *id,const char *name) + { + m_t << ""; + } + void writeSectionRef(const char *,const char *id, + const char *name,const char *text) + { + m_t << ""; + docify(text); + m_t << ""; + } + void writeSectionRefItem(const char *,const char *,const char *) + { + m_t << "(writeSectionRefItem)"; + } + void addIndexItem(const char *primaryie,const char *secondaryie) + { + m_t << ""; + docify(primaryie); + m_t << ""; + docify(secondaryie); + m_t << ""; + } + void writeFormula(const char *id,const char *text) + { + m_t << ""; // non Docbook + docify(text); + m_t << ""; + } + void startImage(const char *name,const char *size,bool caption) + { + m_t << ""; // non docbook + } + void endImage(bool) + { + m_t << ""; + } + void startTextLink(const char *name,const char *anchor) + { + m_t << ""; + } + void endTextLink() + { + m_t << ""; + } + void startPageRef() + { + } + void endPageRef(const char *,const char *) + { + } + void startCodeLine() + { + m_t << ""; // non DocBook + } + void endCodeLine() + { + m_t << ""; // non DocBook + } + void startCodeAnchor(const char *id) + { + m_t << ""; + } + void endCodeAnchor() + { + m_t << ""; + } + void startFontClass(const char *colorClass) + { + m_t << ""; // non DocBook + } + void codify(const char *text) + { + docify(text); + } + + // Generator specific functions + + /*! Create a clone of this generator. Uses the copy constructor */ + OutputDocInterface *clone() + { + return new XMLGenerator(this); + } + /*! Append the output written to generator \a g to this generator */ + void append(const OutputDocInterface *g) + { + const XMLGenerator *xg = (const XMLGenerator *)g; + + //if (m_inPar && !mifgen->m_inParStart) + //{ + // endParMode(); + //} + //else if (!m_inPar && mifgen->m_inParStart) + //{ + // startParMode(); + //} + //printf("Appending \n>>>>\n`%s'\n<<<<\n and \n>>>>\n`%s'\n<<<<\n",getContents().data(),mifgen->getContents().data()); + m_t << xg->getContents(); + m_inParStack = xg->m_inParStack; + m_inListStack = xg->m_inListStack; + m_inParamList = xg->m_inParamList; + } + /*! constructor. + */ + XMLGenerator() + { + m_b.setBuffer(m_a); + m_b.open( IO_WriteOnly ); + m_t.setDevice(&m_b); + m_t.setEncoding(QTextStream::Latin1); + } + /*! copy constructor */ + XMLGenerator(const XMLGenerator *xg) + { + m_b.setBuffer(m_a); + m_b.open( IO_WriteOnly ); + m_t.setDevice(&m_b); + m_t.setEncoding(QTextStream::Latin1); + + // copy state variables + m_inParStack = xg->m_inParStack; + m_inListStack = xg->m_inListStack; + m_inParamList = xg->m_inParamList; + } + /*! destructor */ + virtual ~XMLGenerator() + { + } + /*! Returns the output written to this generator as a string */ + QCString getContents() const + { + QCString s; + s.resize(m_a.size()+1); + memcpy(s.data(),m_a.data(),m_a.size()); + s.at(m_a.size())='\0'; + return s; + } + + private: + // only one destination stream, so these do not have to be implemented + void pushGeneratorState() {} + void popGeneratorState() {} + void disableAllBut(OutputGenerator::OutputType) {} + void enableAll() {} + void disableAll() {} + void disable(OutputGenerator::OutputType) {} + void enable(OutputGenerator::OutputType) {} + bool isEnabled(OutputGenerator::OutputType) { return TRUE; } + + QTextStream m_t; + QByteArray m_a; + QBuffer m_b; + + ValStack m_inParStack; + ValStack m_inListStack; + bool m_inParamList; +}; + +void writeXMLDocBlock(QTextStream &t, + const QCString &fileName, + int lineNr, + const QCString &scope, + const QCString &name, + const QCString &text) +{ + XMLGenerator *xmlGen = new XMLGenerator; + parseDoc(*xmlGen, + fileName, // input definition file + lineNr, // input definition line + scope, // scope (which should not be linked to) + name, // member (which should not be linked to) + text // actual text + ); + xmlGen->endParMode(); + t << xmlGen->getContents(); + delete xmlGen; +} + + void generateXMLForMember(MemberDef *md,QTextStream &t,Definition *def) { @@ -235,6 +860,12 @@ void generateXMLForMember(MemberDef *md,QTextStream &t,Definition *def) } } } + t << " " << endl; + writeXMLDocBlock(t,md->getDefFileName(),md->getDefLine(),scopeName,md->name(),md->briefDescription()); + t << " " << endl; + t << " " << endl; + writeXMLDocBlock(t,md->getDefFileName(),md->getDefLine(),scopeName,md->name(),md->documentation()); + t << " " << endl; t << " " << endl; } @@ -370,6 +1001,12 @@ void generateXMLForClass(ClassDef *cd,QTextStream &t) generateXMLClassSection(cd,t,&cd->related,"related"); //t << " " << endl; } + t << " " << endl; + writeXMLDocBlock(t,cd->getDefFileName(),cd->getDefLine(),cd->name(),0,cd->briefDescription()); + t << " " << endl; + t << " " << endl; + writeXMLDocBlock(t,cd->getDefFileName(),cd->getDefLine(),cd->name(),0,cd->documentation()); + t << " " << endl; t << " " << endl; } @@ -411,6 +1048,12 @@ void generateXMLForFile(FileDef *fd,QTextStream &t) generateXMLFileSection(fd,t,&fd->decVarMembers,"var"); //t << " " << endl; } + t << " " << endl; + writeXMLDocBlock(t,fd->getDefFileName(),fd->getDefLine(),0,0,fd->briefDescription()); + t << " " << endl; + t << " " << endl; + writeXMLDocBlock(t,fd->getDefFileName(),fd->getDefLine(),0,0,fd->documentation()); + t << " " << endl; t << " " << endl; } -- cgit v0.12