/****************************************************************************** * * * * 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. * * The code is this file is largely based on a contribution from * Harm van der Heijden * Please send thanks to him and bug reports to me :-) */ #include #include #include #include #include "htmlhelp.h" #include "config.h" #include "message.h" //---------------------------------------------------------------------------- struct IndexField { QCString name; QCString url; QCString anchor; bool link; }; class IndexFieldList : public QList { public: int compareItems(GCI item1, GCI item2) { return stricmp(((IndexField *)item1)->name,((IndexField *)item2)->name); } ~IndexFieldList() {} }; class IndexFieldListIterator : public QListIterator { public: IndexFieldListIterator( const IndexFieldList &list) : QListIterator(list) {} }; class IndexFieldDict : public QDict { public: IndexFieldDict(int size) : QDict(size) {} ~IndexFieldDict() {} }; /*! A helper class for HtmlHelp that manages a two level index in * alphabetical order */ class HtmlHelpIndex { public: HtmlHelpIndex(); ~HtmlHelpIndex(); void addItem(const char *first,const char *second, const char *url, const char *anchor,bool hasLink); void writeFields(QTextStream &t); private: IndexFieldList *list; IndexFieldDict *dict; }; /*! Constructs a new HtmlHelp index */ HtmlHelpIndex::HtmlHelpIndex() { list = new IndexFieldList; dict = new IndexFieldDict(10007); list->setAutoDelete(TRUE); } /*! Destroys the HtmlHelp index */ HtmlHelpIndex::~HtmlHelpIndex() { delete list; delete dict; } /*! Stores an item in the index if it is not already present. * Items are stored in alphetical order, by sorting on the * concatenation of \a level1 and \a level2 (if present). * * \param level1 the string at level 1 in the index. * \param level2 the string at level 2 in the index (or 0 if not applicable). * \param url the url of the documentation (without .html extension). * \param anchor the anchor of the documentation within the page. * \param hasLink if true, the url (without anchor) can be used in the * level1 item, when writing the header of a list of level2 items. */ void HtmlHelpIndex::addItem(const char *level1,const char *level2, const char *url,const char *anchor,bool hasLink) { QCString key = level1; if (level2) key+= (QCString)"?" + level2; if (dict->find(key)==0) // new key { //printf(">>>>>>>>> HtmlHelpIndex::addItem(%s,%s,%s,%s)\n", // level1,level2,url,anchor); IndexField *f = new IndexField; f->name = key; f->url = url; f->anchor = anchor; f->link = hasLink; list->inSort(f); dict->insert(key,f); } } /*! Writes the sorted list of index items into a html like list. * * An list of calls with name = level1,level2 as follows: *
 *    a1,b1
 *    a1,b2
 *    a2,b1
 *    a2,b2
 *    a3
 *    a4,b1
 *  
* * Will result in the following list: * *
 *    a1       -> link to url if hasLink==TRUE
 *      b1     -> link to url#anchor
 *      b2     -> link to url#anchor
 *    a2       -> link to url if hasLink==TRUE
 *      b1     -> link to url#anchor
 *      b2     -> link to url#anchor
 *    a3       -> link to url if hasLink==TRUE
 *    a4       -> link to url if hasLink==TRUE
 *      b1     -> link to url#anchor 
 *  
*/ void HtmlHelpIndex::writeFields(QTextStream &t) { IndexFieldListIterator ifli(*list); IndexField *f; QCString lastLevel1; bool level2Started=FALSE; for (;(f=ifli.current());++ifli) { QCString level1,level2; int i; if ((i=f->name.find('?'))!=-1) { level1 = f->name.left(i); level2 = f->name.right(f->name.length()-i-1); } else { level1 = f->name.copy(); } if (level1!=lastLevel1) { // finish old list at level 2 if (level2Started) t << " " << endl; level2Started=FALSE; if (level2.isEmpty()) { t << "
  • "; t << "url << ".html"; if (!f->anchor.isEmpty()) t << "#" << f->anchor; t << "\">"; t << "" "\n"; } else { if (f->link) { t << "
  • "; t << "url << ".html\">"; t << "" "\n"; } else { t << "
  • "; t << ""; t << "" "\n"; } } } if (!level2Started && !level2.isEmpty()) { // start new list at level 2 t << "
      " << endl; level2Started=TRUE; } else if (level2Started && level2.isEmpty()) { // end list at level 2 t << "
    " << endl; level2Started=FALSE; } if (level2Started) { t << "
  • "; t << "url << ".html"; if (!f->anchor.isEmpty()) t << "#" << f->anchor; t << "\">"; t << "" "\n"; } lastLevel1 = level1.copy(); } } //---------------------------------------------------------------------------- HtmlHelp *HtmlHelp::theInstance = 0; /*! Constructs an html object. * The object has to be \link initialize() initialized\endlink before it can * be used. */ HtmlHelp::HtmlHelp() { /* initial depth */ dc = 0; cf = kf = 0; index = new HtmlHelpIndex; } /*! return a reference to the one and only instance of this class. */ HtmlHelp *HtmlHelp::getInstance() { if (theInstance==0) theInstance = new HtmlHelp; return theInstance; } /*! This will create a contents file (index.hhc) and a index file (index.hhk) * and write the header of those files. * It also creates a project file (index.hhp) * \sa finalize() */ void HtmlHelp::initialize() { /* open the contents file */ QCString fName = Config::htmlOutputDir + "/index.hhc"; cf = new QFile(fName); if (!cf->open(IO_WriteOnly)) { err("Could not open file %s for writing\n",fName.data()); exit(1); } /* Write the header of the contents file */ cts.setDevice(cf); cts << "\n" "\n" "\n" "\n" "\n" "
      \n"; /* open the contents file */ fName = Config::htmlOutputDir + "/index.hhk"; kf = new QFile(fName); if (!kf->open(IO_WriteOnly)) { err("Could not open file %s for writing\n",fName.data()); exit(1); } /* Write the header of the contents file */ kts.setDevice(kf); kts << "\n" "\n" "\n" "\n" "\n" "
        \n"; } void HtmlHelp::createProjectFile() { /* Write the project file */ QCString fName = Config::htmlOutputDir + "/index.hhp"; QFile f(fName); if (f.open(IO_WriteOnly)) { QTextStream t(&f); QCString indexName="index.html"; if (Config::ftvHelpFlag) indexName="main.html"; t << "[OPTIONS]\n" "Compatibility=1.1\n" "Full-text search=Yes\n" "Contents file=index.hhc\n" "Default Window=main\n" "Default topic=" << indexName << "\n" "Index file=index.hhk\n"; if (Config::htmlHelpTocFlag) t << "Binary TOC=YES\n"; if (Config::htmlHelpChiFlag) t << "Create CHI file=YES\n"; t << "Title=" << Config::projectName << endl << endl; t << "[WINDOWS]" << endl; t << "main=\"" << Config::projectName << "\",\"index.hhc\"," "\"index.hhk\",\"" << indexName << "\",\"" << indexName << "\",,,,,0x23520,,0x3006,,,,,,,,0" << endl << endl; t << "[FILES]" << endl; char *s = indexFiles.first(); while (s) { t << s << endl; s=indexFiles.next(); } f.close(); } else { err("Could not open file %s for writing\n",fName.data()); } } void HtmlHelp::addIndexFile(const char *s) { indexFiles.append(s); } /*! Finalizes the HTML help. This will finish and close the * contents file (index.hhc) and the index file (index.hhk). * \sa initialize() */ void HtmlHelp::finalize() { // end the contents file cts << "
      \n"; cts.unsetDevice(); cf->close(); delete cf; index->writeFields(kts); // end the index file kts << "
    \n"; kts.unsetDevice(); kf->close(); delete kf; createProjectFile(); } /*! Increase the level of the contents hierarchy. * This will start a new unnumbered HTML list in contents file. * \sa decContentsDepth() */ int HtmlHelp::incContentsDepth() { int i; for (i=0;i\n"; return ++dc; } /*! Decrease the level of the contents hierarchy. * This will end the unnumber HTML list. * \sa incContentsDepth() */ int HtmlHelp::decContentsDepth() { int i; for (i=0;i\n"; return --dc; } /*! Add an list item to the contents file. * \param name the name of the item. * \param ref the URL of to the item. */ void HtmlHelp::addContentsItem(bool isDir, const char *name,const char *ref, const char *anchor) { // If we're using a binary toc then folders cannot have links. if(Config::htmlHelpTocFlag && isDir) { ref = 0; anchor = 0; } int i; for (i=0;i"; cts << ""; if (ref) // made ref optional param - KPW { cts << ""; } cts << ""; cts << "\n"; } /*! Add an list item to the index file. * \param name the name of the item. * \param ref the URL of to the item. * \sa HtmlHelpIndex */ void HtmlHelp::addIndexItem(const char *level1, const char *level2, const char *ref, const char *anchor) { index->addItem(level1,level2,ref,anchor,TRUE); index->addItem(level2,level1,ref,anchor,FALSE); }