summaryrefslogtreecommitdiffstats
path: root/src/pagedef.h
blob: 77b7cee892bd000b71824c3b374fb52c5a6e7d81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/******************************************************************************
 *
 * 
 *
 * Copyright (C) 1997-2003 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 "definition.h"
#include "sortdict.h"
//#include "config.h"
//#include "docparser.h"

//#include "section.h"
//#include "doxygen.h"

class PageDef : public Definition
{
  public:
    PageDef(const char *f,int l,const char *n,const char *d,const char *t);
   ~PageDef();
    DefType definitionType() { return TypePage; }
    bool isLinkableInProject() const 
    { 
      return hasDocumentation() && !isReference();
    }
    bool isLinkable() const 
    {
      return isLinkableInProject() || isReference();
    } 

    // functions to get a uniform interface with Definitions
    QCString getOutputFileBase() const { return m_fileName; }
    void findSectionsInDocumentation();
    QCString title() const { return m_title; }
    GroupDef *getGroupDef() const;
    void setFileName(const char *name) { m_fileName = name; }
#if 0
   
    bool isReference() const { return !reference.isEmpty(); }
    QCString getReference() const { return reference; }
    PageInfo(const char *f, int l,const char *n,const char *d,const char *t) :
      defFileName(f), defLine(l), name(n), 
      doc(d), title(t), context(0), xrefListItems(0),m_inGroup(0)
    {
      sectionDict = new SectionDict(17);
    }
    ~PageInfo()
    {
      delete sectionDict;
    }

    // where the page definition was found
    QCString defFileName;
    int defLine;

    // contents of the page
    QCString name;
    QCString doc;
    QCString title;

    // external reference? if so then this is the tag file name
    QCString reference;
    QCString fileName;

    // class, file or namespace in which the page was found
    Definition *context;

    
    //void addSections(QList<QCString> *anchorList)
    //{
    //  if (anchorList)
    //  {
    //    QCString *s=anchorList->first();
    //    while (s)
    //    {
    //      SectionInfo *si=0;
    //      if (!s->isEmpty() && (si=Doxygen::sectionDict[*s]))
    //      {
    //        //printf("Add section `%s' to definition `%s'\n",
    //        //    si->label.data(),n.data());
    //        if (sectionDict==0) 
    //        {
    //          sectionDict = new SectionDict(17);
    //        }
    //        if (sectionDict->find(*s)==0)
    //        {
    //          sectionDict->insert(*s,si);
    //        }
    //        si->pageRef = this;
    //        si->fileName = fileName;
    //      }
    //      s=anchorList->next();
    //    }
    //  }
    //}
    void findSectionsInDocumentation()
    {
      docFindSections(doc,this,0,0,defFileName);
    }
    
    void writeDocAnchorsToTagFile()
    {
      if (!Config_getString("GENERATE_TAGFILE").isEmpty() && sectionDict)
      {
        QDictIterator<SectionInfo> sdi(*sectionDict);
        SectionInfo *si;
        for (;(si=sdi.current());++sdi)
        {
          if (!si->generated)
          {
            Doxygen::tagFile << "    <docanchor>" << si->label << "</docanchor>" << endl;
          }
        }
      }
    }


    void makePartOfGroup(GroupDef *gd) { m_inGroup = gd; }
    GroupDef *getGroupDef() const { return m_inGroup; }

    // is this page part of a group
    SectionDict *sectionDict;
    QList<ListItemInfo> *xrefListItems;

  private:
    GroupDef *m_inGroup;
#endif
  private:
    QCString m_fileName;
    QCString m_title;
    GroupDef *m_inGroup;
};

class PageSDict : public SDict<PageDef>
{
  public:
    PageSDict(int size) : SDict<PageDef>(size) {}
    virtual ~PageSDict() {}
    int compareItems(GCI i1,GCI i2)
    {
      return stricmp(((PageDef *)i1)->name(),((PageDef *)i2)->name());
    }
};