initial version

1 files changed, 291 insertions, 0 deletions

diff --git a/src/filedef.cpp b/src/filedef.cpp
new file mode 100644
index 0000000..54266a5
--- /dev/null
+++ b/src/filedef.cpp
@@ -0,0 +1,291 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ * Copyright (C) 1997-1999 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.
+ *
+ * All output generated with Doxygen is not covered by this license.
+ *
+ */
+
+#include "memberlist.h"
+#include "classlist.h"
+#include "define.h"
+#include "filedef.h"
+#include "scanner.h"
+#include "doxygen.h"
+#include "memberdef.h"
+#include "classdef.h"
+#include "namespacedef.h"
+#include "util.h"
+#include "language.h"
+
+/*! create a new file definition, where \a p is the file path, 
+    \a the file name, and \a ref is an HTML anchor name if the
+    file was read from a tag file or 0 otherwise
+*/
+FileDef::FileDef(const char *p,const char *nm,const char *ref)
+   : Definition(nm)
+{
+  path=p;
+  filepath=path+nm;
+  filename=nameToFile(nm);
+  reference=ref;
+  memList      = new MemberList;
+  classList     = new ClassList;
+  includeList   = new FileList;
+  defineList    = new DefineList;
+  namespaceList = new NamespaceList;
+}
+
+/*! destroy the file definition */
+FileDef::~FileDef()
+{
+  delete memList;
+  delete classList;
+  delete includeList;
+  delete defineList;
+}
+
+/*! Compute the HTML anchor names for all members in the class */ 
+void FileDef::computeAnchors()
+{
+  setAnchors('a',memList);
+}
+
+/*! Write the documentation page for this file to the file of output
+    generators \a ol. 
+*/
+void FileDef::writeDocumentation(OutputList &ol)
+{
+  //funcList->countDecMembers();
+  
+  QString pageTitle=name()+" File Reference";
+  startFile(ol,diskname,pageTitle);
+  startTitle(ol);
+  ol.docify(pageTitle);
+  endTitle(ol,name());
+  //ol.newParagraph();
+  
+  if (genTagFile.length()>0) tagFile << "&" << name() << ":\n";
+  
+  //brief=brief.stripWhiteSpace();
+  //int bl=brief.length();
+  OutputList briefOutput(&ol); 
+  if (briefDescription()) 
+  {
+    //if (brief.at(bl-1)!='.' && brief.at(bl-1)!='!' && brief.at(bl!='?')) 
+    //  brief+='.';
+    parseDoc(briefOutput,0,0,briefDescription());
+    ol+=briefOutput;
+    ol.writeString(" \n");
+    ol.disableAllBut(OutputGenerator::Html);
+    ol.startTextLink(0,"details");
+    parseDoc(ol,0,0,theTranslator->trMore());
+    ol.endTextLink();
+    ol.enableAll();
+  }
+  ol.disable(OutputGenerator::Man);
+  ol.newParagraph();
+  ol.enable(OutputGenerator::Man);
+  ol.writeSynopsis();
+ 
+  if (classList->count()>0)
+  {
+    ClassDef *cd=classList->first();
+    bool found=FALSE;
+    while (cd)
+    {
+      if (//cd->name()[0]!='@' &&
+          //(cd->protection()!=Private || extractPrivateFlag) &&
+          //(cd->hasDocumentation() || !hideClassFlag))
+          cd->isVisibleExt()
+         )
+      {
+        if (!found)
+        {
+          ol.startMemberHeader();
+          parseDoc(ol,0,0,theTranslator->trCompounds());
+          ol.endMemberHeader();
+          ol.startMemberList();
+          found=TRUE;
+        }
+        ol.startMemberItem();
+        switch (cd->compoundType())
+        {
+          case ClassDef::Class:  ol.writeString("class");  break;
+          case ClassDef::Struct: ol.writeString("struct"); break;
+          case ClassDef::Union:  ol.writeString("union");  break;
+        }
+        ol.writeString(" ");
+        if (cd->hasDocumentation()) 
+        {
+          ol.writeObjectLink(cd->getReference(),
+                            cd->classFile(),
+                            0,
+                            cd->name()
+                           );
+        }
+        else
+        {
+          ol.startBold();
+          ol.docify(cd->name());
+          ol.endBold();
+        }
+        ol.endMemberItem();
+      }
+      cd=classList->next();
+    }
+    if (found) ol.endMemberList();
+  }
+  
+  writeMemberDecs(ol,0,0,this,0,0,memList);
+
+  //doc=doc.stripWhiteSpace();
+  //int bl=brief.length();
+  //int dl=doc.length();
+  if (!briefDescription().isEmpty() || !documentation().isEmpty())
+  {
+    ol.writeRuler();
+    ol.writeAnchor("details"); 
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trDetailedDescription());
+    ol.endGroupHeader();
+    if (!briefDescription().isEmpty())
+    {
+      ol+=briefOutput;
+      ol.newParagraph();
+    }
+    if (!documentation().isEmpty())
+    {
+      //if (doc.at(dl-1)!='.' && doc.at(dl-1)!='!' && doc.at(dl-1)!='?') 
+      //  doc+='.';
+      parseDoc(ol,0,0,documentation()+"\n");
+      ol.newParagraph();
+    }
+  }
+
+  memList->countDocMembers();
+  
+  if ( memList->defineCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trDefineDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Define);
+  }
+  
+  if ( memList->protoCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trFunctionPrototypeDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Prototype);
+  }
+
+  if ( memList->typedefCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trTypedefDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Typedef);
+  }
+  
+  if ( memList->enumCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trEnumerationTypeDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Enumeration);
+  }
+
+  if ( memList->enumValueCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trEnumerationValueDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::EnumValue);
+  }
+
+  if ( memList->funcCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trFunctionDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Function);
+  }
+  
+  if ( memList->varCount()>0 )
+  {
+    ol.writeRuler();
+    ol.startGroupHeader();
+    parseDoc(ol,0,0,theTranslator->trVariableDocumentation());
+    ol.endGroupHeader();
+    writeMemberDocs(ol,memList,name(),MemberDef::Variable);
+  }
+  
+  // write Author section (Man only)
+  ol.disableAllBut(OutputGenerator::Man);
+  ol.startGroupHeader();
+  parseDoc(ol,0,0,theTranslator->trAuthor());
+  ol.endGroupHeader();
+  parseDoc(ol,0,0,theTranslator->trGeneratedAutomatically(projectName));
+  ol.enableAll();
+  endFile(ol);
+}
+
+/*! Adds member definition \a md to the list of all members of this file */
+void FileDef::insertMember(MemberDef *md)
+{
+  memList->append(md); 
+}
+
+/*! Adds compound definition \a cd to the list of all compounds of this file */
+void FileDef::insertClass(ClassDef *cd)
+{
+  classList->append(cd);
+}
+
+/*! Adds namespace definition \a nd to the list of all compounds of this file */
+void FileDef::insertNamespace(NamespaceDef *nd)
+{
+  namespaceList->append(nd);
+}
+
+//-----------------------------------------------------------------------------
+
+/*! Creates a file list. */
+FileList::FileList() : QList<FileDef>()
+{
+}
+
+/*! Destroys a file list */
+FileList::~FileList()
+{
+}
+
+/*! Compares two files by name. */
+int FileList::compareItems(GCI item1, GCI item2)
+{
+  FileDef *c1=(FileDef *)item1;
+  FileDef *c2=(FileDef *)item2;
+  return strcmp(c1->name(),c2->name());
+}
+
+/*! Create a file list iterator. */
+FileListIterator::FileListIterator(const FileList &cllist) :
+  QListIterator<FileDef>(cllist)
+{
+}