/******************************************************************************

*

* 

*

* Copyright (C) 1997-2015 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 <stdlib.h>

#include <qdir.h>

#include <qfile.h>

#include <qtextstream.h>

#include <qintdict.h>

#include "docbookgen.h"

#include "doxygen.h"

#include "message.h"

#include "config.h"

#include "classlist.h"

#include "util.h"

#include "defargs.h"

#include "outputgen.h"

#include "dot.h"

#include "pagedef.h"

#include "filename.h"

#include "version.h"

#include "docbookvisitor.h"

#include "docparser.h"

#include "language.h"

#include "parserintf.h"

#include "arguments.h"

#include "memberlist.h"

#include "groupdef.h"

#include "memberdef.h"

#include "namespacedef.h"

#include "membername.h"

#include "membergroup.h"

#include "dirdef.h"

#include "section.h"

// no debug info

#define Docbook_DB(x) do {} while(0)

// debug to stdout

//#define Docbook_DB(x) printf x

// debug inside output

//#define Docbook_DB(x) QCString __t;__t.sprintf x;m_t << __t

//------------------

class DocbookSectionMapper : public QIntDict<char>

{

  public:

    DocbookSectionMapper() : QIntDict<char>(47)

  {

    insert(MemberListType_pubTypes,"public-type");

    insert(MemberListType_pubMethods,"public-func");

    insert(MemberListType_pubAttribs,"public-attrib");

    insert(MemberListType_pubSlots,"public-slot");

    insert(MemberListType_signals,"signal");

    insert(MemberListType_dcopMethods,"dcop-func");

    insert(MemberListType_properties,"property");

    insert(MemberListType_events,"event");

    insert(MemberListType_pubStaticMethods,"public-static-func");

    insert(MemberListType_pubStaticAttribs,"public-static-attrib");

    insert(MemberListType_proTypes,"protected-type");

    insert(MemberListType_proMethods,"protected-func");

    insert(MemberListType_proAttribs,"protected-attrib");

    insert(MemberListType_proSlots,"protected-slot");

    insert(MemberListType_proStaticMethods,"protected-static-func");

    insert(MemberListType_proStaticAttribs,"protected-static-attrib");

    insert(MemberListType_pacTypes,"package-type");

    insert(MemberListType_pacMethods,"package-func");

    insert(MemberListType_pacAttribs,"package-attrib");

    insert(MemberListType_pacStaticMethods,"package-static-func");

    insert(MemberListType_pacStaticAttribs,"package-static-attrib");

    insert(MemberListType_priTypes,"private-type");

    insert(MemberListType_priMethods,"private-func");

    insert(MemberListType_priAttribs,"private-attrib");

    insert(MemberListType_priSlots,"private-slot");

    insert(MemberListType_priStaticMethods,"private-static-func");

    insert(MemberListType_priStaticAttribs,"private-static-attrib");

    insert(MemberListType_friends,"friend");

    insert(MemberListType_related,"related");

    insert(MemberListType_decDefineMembers,"define");

    insert(MemberListType_decProtoMembers,"prototype");

    insert(MemberListType_decTypedefMembers,"typedef");

    insert(MemberListType_decEnumMembers,"enum");

    insert(MemberListType_decFuncMembers,"func");

    insert(MemberListType_decVarMembers,"var");

  }

};

static DocbookSectionMapper g_docbookSectionMapper;

inline void writeDocbookString(FTextStream &t,const char *s)

{

  t << convertToXML(s);

}

inline void writeDocbookCodeString(FTextStream &t,const char *s, int &col)

{

  char c;

  while ((c=*s++))

  {

    switch(c)

    {

      case '\t':

        {

          static int tabSize = Config_getInt(TAB_SIZE);

          int spacesToNextTabStop = tabSize - (col%tabSize);

          col+=spacesToNextTabStop;

          while (spacesToNextTabStop--) t << " ";

          break;

        }

      case ' ':  t << " "; col++;  break;

      case '<':  t << "<"; col++;   break;

      case '>':  t << ">"; col++;   break;

      case '&':  t << "&"; col++;  break;

      case '\'': t << "'"; col++; break;

      case '"':  t << """; col++; break;

      default:   t << c; col++;        break;

    }

  }

}

static void writeDocbookHeaderMainpage(FTextStream &t)

{

  t << "" << endl;;

  t << "<chapter xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">" << endl;

}

static void writeDocbookHeader_ID(FTextStream &t, QCString id)

{

  t << "" << endl;;

  t << "<section xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xml:id=\"" << id << "\">" << endl;

}

void writeDocbookLink(FTextStream &t,const char * /*extRef*/,const char *compoundId,

    const char *anchorId,const char * text,const char * /*tooltip*/)

{

  t << "

  if (anchorId) t << "_1" << anchorId;

  t << "\"";

  t << ">";

  writeDocbookString(t,text);

  t << "</link>";

}

class TextGeneratorDocbookImpl : public TextGeneratorIntf

{

  public:

    TextGeneratorDocbookImpl(FTextStream &t): m_t(t) {}

    void writeString(const char *s,bool /*keepSpaces*/) const

    {

      writeDocbookString(m_t,s);

    }

    void writeBreak(int) const {}

    void writeLink(const char *extRef,const char *file,

        const char *anchor,const char *text

        ) const

    {

      writeDocbookLink(m_t,extRef,file,anchor,text,0);

    }

  private:

    FTextStream &m_;;

};

class DocbookCodeGenerator : public CodeOutputInterface

{

  public:

    DocbookCodeGenerator(FTextStream &t) : m_t(t), m_lineNumber(-1), m_col(0),

    m_insideCodeLine(FALSE), m_insideSpecialHL(FALSE) {}

    virtual ~DocbookCodeGenerator() {}

    void codify(const char *text)

    {

      Docbook_DB(("(codify \"%s\")\n",text));

      writeDocbookCodeString(m_t,text,m_col);

    }

    void writeCodeLink(const char *ref,const char *file,

        const char *anchor,const char *name,

        const char *tooltip)

    {

      Docbook_DB(("(writeCodeLink)\n"));

      writeDocbookLink(m_t,ref,file,anchor,name,tooltip);

      m_col+=strlen(name);

    }

    void writeTooltip(const char *, const DocLinkInfo &, const char *,

                      const char *, const SourceLinkInfo &, const SourceLinkInfo &

                     )

    {

      Docbook_DB(("(writeToolTip)\n"));

    }

    void startCodeLine(bool)

    {

      Docbook_DB(("(startCodeLine)\n"));

      if (m_lineNumber!=-1)

      {

        if (!m_refId.isEmpty())

        {

          m_t << "<link linkend=\"" << m_refId << "\">";

        }

        m_t << m_lineNumber << " ";

        if (!m_refId.isEmpty())

        {

          m_t << "</link>";

        }

      }

      m_insideCodeLine=TRUE;

      m_col=0;

    }

    void endCodeLine()

    {

      m_t << endl;

      Docbook_DB(("(endCodeLine)\n"));

      m_lineNumber = -1;

      m_refId.resize(0);

      m_external.resize(0);

      m_insideCodeLine=FALSE;

    }

    void startFontClass(const char *colorClass)

    {

      Docbook_DB(("(startFontClass)\n"));

      m_t << "<emphasis class=\"" << colorClass << "\">";

      m_insideSpecialHL=TRUE;

    }

    void endFontClass()

    {

      Docbook_DB(("(endFontClass)\n"));

      m_t << "</emphasis>"; // non DocBook

      m_insideSpecialHL=FALSE;

    }

    void writeCodeAnchor(const char *)

    {

      Docbook_DB(("(writeCodeAnchor)\n"));

    }

    void writeLineNumber(const char *extRef,const char *compId,

        const char *anchorId,int l)

    {

      Docbook_DB(("(writeLineNumber)\n"));

      // we remember the information provided here to use it

      // at the <codeline> start tag.

      m_lineNumber = l;

      if (compId)

      {

        m_refId=compId;

        if (anchorId) m_refId+=(QCString)"_1"+anchorId;

        if (extRef) m_external=extRef;

      }

    }

    void setCurrentDoc(Definition *,const char *,bool)

    {

    }

    void addWord(const char *,bool)

    {

    }

    void finish()

    {

      if (m_insideCodeLine) endCodeLine();

    }

  private:

    FTextStream &m_;;

    QCString m_refId;

    QCString m_external;

    int m_lineNumber;

    int m_col;

    bool m_insideCodeLine;

    bool m_insideSpecialHL;

};

static void writeTemplateArgumentList(ArgumentList *al,

    FTextStream &t,

    Definition *scope,

    FileDef *fileScope,

    int indent)

{

  QCString indentStr;

  indentStr.fill(' ',indent);

  if (al)

  {

    t << indentStr << "<templateparamlist>" << endl;

    ArgumentListIterator ali(*al);

    Argument *a;

    for (ali.toFirst();(a=ali.current());++ali)

    {

      t << indentStr << "  <param>" << endl;

      if (!a->type.isEmpty())

      {

        t << indentStr <<  "    <type>";

        linkifyText(TextGeneratorDocbookImpl(t),scope,fileScope,0,a->type);

        t << "</type>" << endl;

      }

      if (!a->name.isEmpty())

      {

        t << indentStr <<  "    <declname>" << a->name << "</declname>" << endl;

        t << indentStr <<  "    <defname>" << a->name << "</defname>" << endl;

      }

      if (!a->defval.isEmpty())

      {

        t << indentStr << "    <defval>";

        linkifyText(TextGeneratorDocbookImpl(t),scope,fileScope,0,a->defval);

        t << "</defval>" << endl;

      }

      t << indentStr << "  </param>" << endl;

    }

    t << indentStr << "</templateparamlist>" << endl;

  }

}

static void writeTemplateList(ClassDef *cd,FTextStream &t)

{

  writeTemplateArgumentList(cd->templateArguments(),t,cd,0,4);

}

static void writeDocbookDocBlock(FTextStream &t,

    const QCString &fileName,

    int lineNr,

    Definition *scope,

    MemberDef * md,

    const QCString &text)

{

  QCString stext = text.stripWhiteSpace();

  if (stext.isEmpty()) return;

  // convert the documentation string into an abstract syntax tree

  DocNode *root = validatingParseDoc(fileName,lineNr,scope,md,text,FALSE,FALSE);

  // create a code generator

  DocbookCodeGenerator *docbookCodeGen = new DocbookCodeGenerator(t);

  // create a parse tree visitor for Docbook

  DocbookDocVisitor *visitor = new DocbookDocVisitor(t,*docbookCodeGen);

  // visit all nodes

  root->accept(visitor);

  // clean up

  delete visitor;

  delete docbookCodeGen;

  delete root;

}

void writeDocbookCodeBlock(FTextStream &t,FileDef *fd)

{

  ParserInterface *pIntf=Doxygen::parserManager->getParser(fd->getDefFileExtension());

  SrcLangExt langExt = getLanguageFromFileName(fd->getDefFileExtension());

  pIntf->resetCodeParserState();

  DocbookCodeGenerator *docbookGen = new DocbookCodeGenerator(t);

  pIntf->parseCode(*docbookGen,  // codeOutIntf

      0,           // scopeName

      fileToString(fd->absFilePath(),Config_getBool(FILTER_SOURCE_FILES)),

      langExt,     // lang

      FALSE,       // isExampleBlock

      0,           // exampleName

      fd,          // fileDef

      -1,          // startLine

      -1,          // endLine

      FALSE,       // inlineFragement

      0,           // memberDef

      TRUE         // showLineNumbers

      );

  docbookGen->finish();

  delete docbookGen;

}

static QCString classOutputFileBase(ClassDef *cd)

{

  //static bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);

  //if (inlineGroupedClasses && cd->partOfGroups()!=0)

  return cd->getOutputFileBase();

  //else

  //  return cd->getOutputFileBase();

}

static QCString memberOutputFileBase(MemberDef *md)

{

  //static bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);

  //if (inlineGroupedClasses && md->getClassDef() && md->getClassDef()->partOfGroups()!=0)

  //  return md->getClassDef()->getDocbookOutputFileBase();

  //else

  //  return md->getOutputFileBase();

  return md->getOutputFileBase();

}

static void generateDocbookForMember(MemberDef *md,FTextStream &t,Definition *def, bool detailed=0)

{

  // + declaration/definition arg lists

  // + reimplements

  // + reimplementedBy

  // + exceptions

  // + const/volatile specifiers

  // - examples

  // + source definition

  // + source references

  // + source referenced by

  // - body code

  // + template arguments

  //     (templateArguments(), definitionTemplateParameterLists())

  // - call graph

  // enum values are written as part of the enum

  if (md->memberType()==MemberType_EnumValue) return;

  if (md->isHidden()) return;

  //if (md->name().at(0)=='@') return; // anonymous member

  // group members are only visible in their group

  //if (def->definitionType()!=Definition::TypeGroup && md->getGroupDef()) return;

  QCString memType;

  switch (md->memberType())

  {

    case MemberType_Define:      memType="define";    break;

    case MemberType_Function:    memType="function";  break;

    case MemberType_Variable:    memType="variable";  break;

    case MemberType_Typedef:     memType="typedef";   break;

    case MemberType_Enumeration: memType="enum";      break;

    case MemberType_EnumValue:   ASSERT(0);           break;

    case MemberType_Signal:      memType="signal";    break;

    case MemberType_Slot:        memType="slot";      break;

    case MemberType_Friend:      memType="friend";    break;

    case MemberType_DCOP:        memType="dcop";      break;

    case MemberType_Property:    memType="property";  break;

    case MemberType_Event:       memType="event";     break;

    case MemberType_Interface:   memType="interface"; break;

    case MemberType_Service:     memType="service";   break;

  }

  QCString scopeName;

  if (md->getClassDef())

  {

    scopeName=md->getClassDef()->name();

  }

  else if (md->getNamespaceDef())

  {

    scopeName=md->getNamespaceDef()->name();

  }

  if (detailed==0) 

  {

    t << "            <para>" << endl;

    t << "                <itemizedlist>" << endl;

    t << "                    <listitem>" << endl;

    //enum

    bool closePara=TRUE;

    if (md->memberType()==MemberType_Enumeration) 

    {

      MemberList *enumFields = md->enumFieldList();

      t << "                            <para><literallayout>" << memType << " 

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";

      if (enumFields!=0) 

      {

        MemberListIterator emli(*enumFields);

        MemberDef *emd;

        t << " {" << endl;

        int cnt=0;

        for (emli.toFirst();(emd=emli.current());++emli) 

        {

          if (cnt!=0) 

          {

            t << "," << endl;

          }

          t << "<link linkend=\"" << memberOutputFileBase(emd) << "_1" << emd->anchor() << "\">";

          writeDocbookString(t,emd->name());

          t << "</link>";

          if (!emd->initializer().isEmpty()) 

          {

            writeDocbookString(t,emd->initializer());

          }

          cnt++;

        }

        t << endl << "}";

      }

      t << "</literallayout>" << endl;

      if (md->briefDescription())

      {

          t << "<para><emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis></para>" << endl;

      }

    }

    else if (md->memberType()==MemberType_Define) 

    {

      t << "                            <para>" << "#" << memType << " 

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";

      if (!md->initializer().isEmpty() && md->initializer().length()<2000) 

      {

        t << " ";

        linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->initializer());

      }

      if (md->briefDescription()) 

      {

        t << "<para><emphasis>";

        writeDocbookString(t,md->briefDescription());

        t << "</emphasis></para>" << endl;

      }

    }

    else if (md->memberType()==MemberType_Variable) 

    {

      if (md->getClassDef()) 

      {

        t << "                        <para>" << convertToXML(md->declaration());

        if (md->briefDescription()) 

        {

          t << "<para><emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis></para>";

        }

      } 

      else 

      {

        t << "                        <para>";

        linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());

        t << " 

        if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

        {

          t << md->getGroupDef()->getOutputFileBase();

        }

        else

        {

          t << memberOutputFileBase(md);

        }

        t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";

        if (md->briefDescription())

        {

            t << "<para><emphasis>";

            writeDocbookString(t,md->briefDescription());

            t << "</emphasis></para>" << endl;

        }

      }

    }

    else if (md->memberType()==MemberType_Typedef) 

    {

      t << "                            <para>" << memType;

      t << " ";

      linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());

      t << " ";

      t << " 

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";

      if (md->briefDescription())

      {

          t << "<para><emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis></para>" << endl;

      }

    }

    else if (md->memberType()==MemberType_Function) 

    {

      t << "                        <para>";

      linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());

      t << " 

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";

      t << " (" << endl;

      ArgumentList *declAl = md->declArgumentList();

      if (declAl && declAl->count()>0)

      {

        ArgumentListIterator declAli(*declAl);

        Argument *a;

        int cnt=0;

        for (declAli.toFirst();(a=declAli.current());++declAli)

        {

          if (cnt!=0) 

          {

            t << ", ";

          }

          if (!a->type.isEmpty())

          {

            linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,a->type);

          }

          t << " ";

          if (!a->name.isEmpty())

          {

            writeDocbookString(t,a->name);

          }

          cnt++;

        }

      }

      t << ")";

      if (md->briefDescription())

      {

          t << "<para><emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis></para>" << endl;

      }

    }

    else

    {

      closePara = FALSE;

    }

    if (closePara) t << "</para>" << endl;

    t << "                    </listitem>" << endl;

    t << "                </itemizedlist>" << endl;

    t << "            </para>" << endl;

  }

  else

  {

    if (md->memberType()==MemberType_Enumeration)

    {

      MemberList *enumFields = md->enumFieldList();

      t << "            

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << endl;

      t << "               <title>" << memType << " " << convertToXML(md->name()) << " " << "</title>" << endl;

      t << "               ";

      writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

      t << endl;

      if (enumFields!=0) 

      {

        MemberListIterator emli(*enumFields);

        MemberDef *emd;

        t << "               <formalpara>" << endl;

        t << "                    <title>" << theTranslator->trEnumerationValues() << ":</title>" << endl;

        t << "                    <variablelist>" << endl;

        for (emli.toFirst();(emd=emli.current());++emli) 

        {

          t << "                        

          t << memberOutputFileBase(emd) << "_1" << emd->anchor() << "\">" << endl;

          t << "                            <term>";

          writeDocbookString(t,emd->name());

          t << "</term>" << endl;

          t << "                            <listitem>" << endl;

          if(Config_getBool(REPEAT_BRIEF))

          {

              t << "                                <para>";

              writeDocbookString(t,emd->briefDescription());

              t << "</para>" << endl;

          }

          t << "                            </listitem>" << endl;

          t << "                        </varlistentry>" << endl;

        }

        t << "                     </variablelist>" << endl;

        t << "                </formalpara>" << endl;

        t << "                <para>";

        t << "Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << endl;

        t << "                    <computeroutput><literallayout>" << endl;

        t << "{" << endl;

        for (emli.toFirst();(emd=emli.current());++emli) 

        {

          writeDocbookString(t,emd->name());

          if (!emd->initializer().isEmpty()) 

          {

            writeDocbookString(t,emd->initializer());

          }

          t << ", " << endl;

        }

        t << "}" << convertToXML(md->name()) << ";" << endl;

        t << "                    </literallayout></computeroutput>" << endl;

        t << "                </para>" << endl;

        t << "            </section>" << endl;

      }

    }

    else if (md->memberType()==MemberType_Typedef) 

    {

      t << "            

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << endl;

      t << "                <title>" << convertToXML(md->definition()) << "</title>";

      if(Config_getBool(REPEAT_BRIEF))

      {

          t << " <emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis>" << endl;

      }

      t << "                ";

      writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

      t << endl;

      t << "            </section>" << endl;

    }

    else if (md->memberType()==MemberType_Function) 

    {

      t << "            

      if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

      {

        t << md->getGroupDef()->getOutputFileBase();

      }

      else

      {

        t << memberOutputFileBase(md);

      }

      t << "_1" << md->anchor() << "\">" << endl;

      t << "                <title>" << convertToXML(md->definition()) << " " << convertToXML(md->argsString()) << "</title>";

      if(Config_getBool(REPEAT_BRIEF))

      {

          t << " <emphasis>";

          writeDocbookString(t,md->briefDescription());

          t << "</emphasis>" << endl;

      }

      t << "                ";

      writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

      t << endl;

      t << "            </section>" << endl;

    }

    else if (md->memberType()==MemberType_Define) 

    {

      if (md->documentation()) 

      {

        t << "            

        if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

        {

          t << md->getGroupDef()->getOutputFileBase();

        }

        else

        {

          t << memberOutputFileBase(md);

        }

        t << "_1" << md->anchor() << "\">" << endl;

        t << "                <title>" << convertToXML(md->definition()) << "</title>";

        t << "                ";

        writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

        t << endl;

        t << "                <para>Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << "</para>" << endl;

        t << "                <para>The Documentation for this define was generated from the following file: </para>" << endl;

        t << "                <para><itemizedlist><listitem><para>" << stripPath(md->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;

        t << "            </section>" << endl;

      }

    }

    else if (md->memberType()==MemberType_Variable) 

    {

      if (md->getClassDef()) 

      {

        if (md->documentation()) 

        {

          t << "            <simplesect>" << endl;

          t << "                <title>" << convertToXML(md->definition()) << "</title>";

          t << "                ";

          writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

          t << endl;

          t << "                <para>Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << "</para>" << endl;

          t << "                <para>The Documentation for this struct was generated from the following file: </para>" << endl;

          t << "                <para><itemizedlist><listitem><para>" << stripPath(md->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;

          t << "            </simplesect>" << endl;

        }

      }

      else 

      {

        t << "            

        if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)

        {

          t << md->getGroupDef()->getOutputFileBase();

        }

        else

        {

          t << memberOutputFileBase(md);

        }

        t << "_1" << md->anchor() << "\">" << endl;

        t << "                <title>" << convertToXML(md->definition()) << "</title>";

        if(Config_getBool(REPEAT_BRIEF))

        {

            t << " <emphasis>";

            writeDocbookString(t,md->briefDescription());

            t << "</emphasis>" << endl;

        }

        t << "                ";

        writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());

        t << endl;

        t << "            </section>" << endl;

      }

    }

  }

}

static void generateDocbookSection(Definition *d,FTextStream &t,MemberList *ml,const char *,

    bool detailed=0, const char *header=0,const char *documentation=0)

{

  if (ml==0) return;

  MemberListIterator mli(*ml);

  MemberDef *md;

  int count=0;

  int doc_count=0;

  QCString title, desctitle;

  for (mli.toFirst();(md=mli.current());++mli) 

  {

    // namespace members are also inserted in the file scope, but

    // to prevent this duplication in the Docbook output, we filter those here.

    if (d->definitionType()!=Definition::TypeFile || md->getNamespaceDef()==0) 

    {

      count++;

    }

  }

  if (count==0) return; // empty list

  switch (ml->listType())

  {

    case MemberListType_decDefineMembers:  title=theTranslator->trDefines();             desctitle=theTranslator->trDefineDocumentation();            break;

    case MemberListType_decTypedefMembers: title=theTranslator->trTypedefs();            desctitle=theTranslator->trTypedefDocumentation();           break;

    case MemberListType_decEnumMembers:    title=theTranslator->trEnumerations();        desctitle=theTranslator->trEnumerationTypeDocumentation();   break;

    case MemberListType_decFuncMembers:    title=theTranslator->trFunctions();           desctitle=theTranslator->trFunctionDocumentation();          break;

    case MemberListType_decVarMembers:     title=theTranslator->trVariables();           desctitle=theTranslator->trVariableDocumentation();          break;

    case MemberListType_pubAttribs:        title=theTranslator->trPublicAttribs();       desctitle=theTranslator->trMemberDataDocumentation();        break;

    case MemberListType_priAttribs:        title=theTranslator->trPrivateAttribs();      desctitle=theTranslator->trMemberDataDocumentation();        break;

    case MemberListType_proAttribs:        title=theTranslator->trProtectedAttribs();    desctitle=theTranslator->trMemberDataDocumentation();        break;

    default:                               title="";                    desctitle="";                                  break;

  }

  if (detailed) 

  {

    for (mli.toFirst();(md=mli.current());++mli)

    {

        if (md->documentation().isEmpty() && !Config_getBool(REPEAT_BRIEF))

        {

            continue;

        }

        doc_count = 1;

        break;

    }

    if(doc_count == 0)

    {

        return;

    }

    if (desctitle)

    {

        t << "        <section>" << endl;

        t << "            <title>" << desctitle << "</title>" << endl;

    }

  } else 

  {

    t << "        <section>" << endl;

    if (header) 

    {

      t << "            <title>" << convertToXML(header) << "</title>" << endl;

    } 

    else 

    {

      t << "            <title>" << title << "</title>" << endl;

    }