summaryrefslogtreecommitdiffstats
path: root/src/filedef.h
diff options
context:
space:
mode:
authormueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:25:10 (GMT)
committermueller <mueller@afe2bf4a-e733-0410-8a33-86f594647bc7>1999-12-15 19:25:10 (GMT)
commit719f0a35063be88eddcc4ed8fe7a940de47ef20c (patch)
treecc1cd70cf5761ddf72ff114c0b65576c3f4c1d2a /src/filedef.h
parentbd30c025c4651ddda467f1af09d4c7ccab397bde (diff)
downloadDoxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.zip
Doxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.tar.gz
Doxygen-719f0a35063be88eddcc4ed8fe7a940de47ef20c.tar.bz2
initial version
Diffstat (limited to 'src/filedef.h')
-rw-r--r--src/filedef.h158
1 files changed, 158 insertions, 0 deletions
diff --git a/src/filedef.h b/src/filedef.h
new file mode 100644
index 0000000..36ce9cb
--- /dev/null
+++ b/src/filedef.h
@@ -0,0 +1,158 @@
+/******************************************************************************
+ *
+ * $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.
+ *
+ */
+
+#ifndef FILEDEF_H
+#define FILEDEF_H
+
+#include <qlist.h>
+#include "index.h"
+#include "config.h"
+#include "definition.h"
+
+class MemberList;
+class FileList;
+class ClassList;
+class MemberDef;
+class ClassDef;
+class OutputList;
+class DefineList;
+class NamespaceDef;
+class NamespaceList;
+
+/*! \class FileDef filedef.h
+ \brief A File definition.
+
+ An object of this class contains all file information that is gathered.
+ This includes the members and compounds defined in the file.
+
+ The member writeDocumentation() can be used to generate the page of
+ documentation to HTML and LaTeX.
+*/
+
+class FileDef : public Definition
+{
+ friend class FileName;
+
+ public:
+ //enum FileType { Source, Header, Unknown };
+
+ FileDef(const char *p,const char *n,const char *ref=0);
+ ~FileDef();
+
+ /*! Returns the unique file name (this may include part of the path). */
+ QString name() const
+ {
+ if (fullPathNameFlag)
+ return filename;
+ else
+ return Definition::name();
+ }
+
+ /*! Returns nameString with all slashes replaced by underscores. */
+ const char *diskName() const { return diskname; }
+
+ /*! Returns the absolute path including the file name. */
+ QString absFilePath() const { return filepath; }
+
+ /*! Returns the name of the verbatim copy of this file (if any). */
+ const char *includeName() const { return incName; }
+
+ /*! Returns the documentation that was available for this file. */
+ //const char *documentation() const { return doc; }
+
+ /*! Returns the brief description that was given for this file. */
+ //const char *briefDescription() const { return brief; }
+
+ /*! Sets the name of the include file to \a n. */
+ void setIncludeName(const char *n_) { incName=n_; }
+
+ /*! Sets the name of the include file to \a n. */
+ //void setBriefDescription(const char *b) { brief=b; }
+
+ /*! Sets the documentaton of this file to \a d. */
+ //void setDocumentation(const char *d) { doc=d; }
+
+ /*! Returns the absolute path of this file. */
+ QString getPath() const { return path; }
+
+ /*! Returns true iff any documentation for this file is found. */
+ //bool hasDocumentation()
+ // { return extractAllFlag || !doc.isNull() || !brief.isNull(); }
+
+ /*! Returns true iff this file was externally defined
+ (i.e. read from a tag file) */
+ bool isReference() { return !reference.isNull(); }
+
+ /*! Returns the reference name of the external file, if any or 0
+ if the file is not defined. */
+ const char *getReference() { return reference; }
+
+ //void setFileType(FileType ft) { ftype = ft; }
+ //FileType fileType() const { return ftype; }
+
+ void writeDocumentation(OutputList &ol);
+ friend void generatedFileNames();
+ void insertMember(MemberDef *fd);
+ void insertClass(ClassDef *cd);
+ void insertNamespace(NamespaceDef *nd);
+ void computeAnchors();
+
+ private:
+ MemberList *memList;
+ ClassList *classList;
+ FileList *includeList;
+ NamespaceList *namespaceList;
+ DefineList *defineList;
+ //QString n;
+ //QString doc;
+ //QString brief;
+ QString reference;
+ QString path;
+ QString filepath;
+ QString diskname;
+ QString filename;
+ QString incName;
+ //FileType ftype;
+};
+
+/*! \class FileList filedef.h
+ \brief This class is list of file definitions.
+
+ It is based on QList.
+*/
+
+class FileList : public QList<FileDef>
+{
+ public:
+ FileList();
+ ~FileList();
+
+ int compareItems(GCI item1,GCI item2);
+};
+
+/*! \class FileListIterator filedef.h
+ \brief This class represents a file list iterator.
+
+ It is based on QListIterator.
+*/
+
+class FileListIterator : public QListIterator<FileDef>
+{
+ public:
+ FileListIterator(const FileList &list);
+};
+
+#endif