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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/******************************************************************************
*
*
*
*
* 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 <stdio.h>
#include "reflist.h"
#include "util.h"
#include "ftextstream.h"
#include "definition.h"
/*! Create a list of items that are cross referenced with documentation blocks
* @param listName String representing the name of the list.
* @param pageTitle String representing the title of the list page.
* @param secTitle String representing the title of the section.
*/
RefList::RefList(const char *listName,
const char *pageTitle,
const char *secTitle
)
{
m_itemList = 0;
m_dict = 0;
m_dictIterator = 0;
m_id = 0;
m_listName = listName;
m_fileName = convertNameToFile(listName,FALSE,TRUE);
m_pageTitle = pageTitle;
m_secTitle = secTitle;
}
/*! Destroy the todo list. Currently not called! */
RefList::~RefList()
{
delete m_dictIterator;
delete m_dict;
delete m_itemList;
}
/*! Adds a new item to the list.
* \returns A unique id for this item.
*/
int RefList::addRefItem()
{
if (m_dict==0)
{
m_dict = new QIntDict<RefItem>(1009);
m_dict->setAutoDelete(TRUE);
m_dictIterator = new QIntDictIterator<RefItem>(*m_dict);
}
RefItem *item = new RefItem;
m_id++;
m_dict->insert(m_id,item);
return m_id;
}
/*! Returns an item given it's id that is obtained with addRefItem()
* \param itemId item's identifier.
* \returns A pointer to the todo item's structure.
*/
RefItem *RefList::getRefItem(int itemId)
{
return m_dict ? m_dict->find(itemId) : 0;
}
/*! Returns the first item in the dictionary or 0 if
* non is available.
* Items are not sorted.
*/
RefItem *RefList::getFirstRefItem()
{
return m_dictIterator ? m_dictIterator->toFirst() : 0;
}
/*! Returns the next item in the dictionary or 0 if
* we are at the end of the list.
* Items are not sorted.
*/
RefItem *RefList::getNextRefItem()
{
return m_dictIterator ? m_dictIterator->operator++() : 0;
}
/*! Returns the name of the list as set in the constructor. */
QCString RefList::listName() const
{
return m_listName;
}
QCString RefList::fileName() const
{
return m_fileName;
}
QCString RefList::pageTitle() const
{
return m_pageTitle;
}
QCString RefList::sectionTitle() const
{
return m_secTitle;
}
void RefList::insertIntoList(const char *key,RefItem *item)
{
if (m_itemList==0)
{
m_itemList = new SortedRefItems(1009);
}
RefItem *ri = m_itemList->find(key);
if (ri==0)
{
m_itemList->append(key,item);
}
else // item already added to the list (i.e. multiple item for the same
// entity)
{
if (ri!=item)
{
// We also have to check if the item is not already in the "extra" list
QListIterator<RefItem> li(ri->extraItems);
RefItem *extraItem;
bool doubleItem = false;
for (li.toFirst();(extraItem=li.current());++li)
{
if (item == extraItem) doubleItem = true;
}
if (!doubleItem) ri->extraItems.append(item);
}
}
}
void RefList::generatePage()
{
if (m_itemList==0) return;
m_itemList->sort();
SDict<RefItem>::Iterator it(*m_itemList);
RefItem *item;
QCString doc;
doc += "<dl class=\"reflist\">";
for (it.toFirst();(item=it.current());++it)
{
doc += " <dt>";
doc += "\n";
if (item->scope)
{
if (item->scope->name() != "<globalScope>")
{
doc += "\\_setscope ";
doc += item->scope->name();
doc += " ";
}
}
doc += item->prefix;
doc += " \\_internalref ";
doc += item->name;
// escape \'s in title, see issue #5901
QCString escapedTitle = substitute(item->title,"\\","\\\\");
if (item->scope &&
(item->scope->definitionType()==Definition::TypeClass ||
item->scope->definitionType()==Definition::TypeNamespace ||
item->scope->definitionType()==Definition::TypeMember ||
item->scope->definitionType()==Definition::TypePackage)
)
{
// prevent Obj-C names in e.g. todo list are seen as emoji
escapedTitle = substitute(escapedTitle,":","∷");
}
doc += " \""+escapedTitle+"\" ";
// write declaration in case a function with arguments
if (!item->args.isEmpty())
{
// escape @'s in argument list, needed for Java annotations (see issue #6208)
// escape \'s in argument list (see issue #6533)
doc += substitute(substitute(item->args,"@","@@"),"\\","\\\\");
}
doc += "</dt><dd> \\anchor ";
doc += item->listAnchor;
doc += " ";
doc += item->text;
QListIterator<RefItem> li(item->extraItems);
RefItem *extraItem;
for (li.toFirst();(extraItem=li.current());++li)
{
doc += "<p> \\anchor ";
doc += extraItem->listAnchor;
doc += " ";
doc += extraItem->text;
}
doc += "</dd>";
}
doc += "</dl>\n";
//printf("generatePage('%s')\n",doc.data());
addRelatedPage(m_listName,m_pageTitle,doc,m_fileName,1,std::vector<ListItemInfo>(),0,0,TRUE);
}
|
