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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/******************************************************************************
*
* 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 <fstream>
#include "eclipsehelp.h"
#include "util.h"
#include "config.h"
#include "message.h"
#include "doxygen.h"
struct EclipseHelp::Private
{
int depth = 0;
bool endtag = false;
int openTags = 0;
std::ofstream tocstream;
QCString pathprefix;
/* -- formatting helpers */
void indent()
{
for (int i=0; i<depth; i++)
{
tocstream << " ";
}
}
void closedTag()
{
if (endtag)
{
tocstream << "/>\n";
endtag = FALSE;
}
}
void openedTag()
{
if (endtag)
{
tocstream << ">\n";
endtag = FALSE;
++openTags;
}
}
};
EclipseHelp::EclipseHelp() : p(std::make_unique<Private>()) {}
EclipseHelp::~EclipseHelp() = default;
EclipseHelp::EclipseHelp(EclipseHelp&&) = default;
/*!
* \brief Initialize the Eclipse generator
*
* This method opens the XML TOC file and writes headers of the files.
* \sa finalize()
*/
void EclipseHelp::initialize()
{
// -- open the contents file
QCString name = Config_getString(HTML_OUTPUT) + "/toc.xml";
p->tocstream.open(name.str(), std::ofstream::out | std::ofstream::binary);
if (!p->tocstream.is_open())
{
term("Could not open file %s for writing\n", qPrint(name));
}
// -- write the opening tag
QCString title = Config_getString(PROJECT_NAME);
if (title.isEmpty())
{
title = "Doxygen generated documentation";
}
p->tocstream << "<toc label=\"" << convertToXML(title)
<< "\" topic=\"" << convertToXML(p->pathprefix)
<< "index" << Doxygen::htmlFileExtension << "\">\n";
++ p->depth;
}
/*!
* \brief Finish generation of the Eclipse specific help files
*
* This method writes footers of the files and closes them.
* \sa initialize()
*/
void EclipseHelp::finalize()
{
p->closedTag(); // -- close previous tag
// -- write ending tag
--p->depth;
p->tocstream << "</toc>\n";
// -- close the content file
p->tocstream.close();
QCString name = Config_getString(HTML_OUTPUT) + "/plugin.xml";
std::ofstream t(name.str(),std::ofstream::out | std::ofstream::binary);
if (t.is_open())
{
QCString docId = Config_getString(ECLIPSE_DOC_ID);
t << "<plugin name=\"" << docId << "\" id=\"" << docId << "\"\n";
t << " version=\"1.0.0\" provider-name=\"Doxygen\">\n";
t << " <extension point=\"org.eclipse.help.toc\">\n";
t << " <toc file=\"toc.xml\" primary=\"true\" />\n";
t << " </extension>\n";
t << "</plugin>\n";
}
}
/*!
* \brief Increase the level of content hierarchy
*/
void EclipseHelp::incContentsDepth()
{
p->openedTag();
++p->depth;
}
/*!
* \brief Decrease the level of content hierarchy
*
* It closes currently opened topic tag.
*/
void EclipseHelp::decContentsDepth()
{
// -- end of the opened topic
p->closedTag();
--p->depth;
if (p->openTags==p->depth)
{
--p->openTags;
p->indent();
p->tocstream << "</topic>\n";
}
}
/*!
* \brief Add an item to the content
*
* @param isDir Flag whether the argument \a file is a directory or a file entry
* @param name Name of the item
* @param ref URL of the item
* @param file Name of a file which the item is defined in (without extension)
* @param anchor Name of an anchor of the item.
* @param separateIndex not used.
* @param addToNavIndex not used.
* @param def not used.
*/
void EclipseHelp::addContentsItem(
bool /* isDir */,
const QCString &name,
const QCString & /* ref */,
const QCString &file,
const QCString &anchor,
bool /* separateIndex */,
bool /* addToNavIndex */,
const Definition * /*def*/)
{
// -- write the topic tag
p->closedTag();
if (!file.isEmpty())
{
switch (file[0]) // check for special markers (user defined URLs)
{
case '^':
// URL not supported by eclipse toc.xml
break;
case '!':
p->indent();
p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
p->tocstream << " href=\"" << convertToXML(p->pathprefix) << &file[1] << "\"";
p->endtag = TRUE;
break;
default:
p->indent();
p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
p->tocstream << " href=\"" << convertToXML(p->pathprefix)
<< addHtmlExtensionIfMissing(file);
if (!anchor.isEmpty())
{
p->tocstream << "#" << anchor;
}
p->tocstream << "\"";
p->endtag = TRUE;
break;
}
}
else
{
p->indent();
p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
p->endtag = TRUE;
}
}
void EclipseHelp::addIndexItem(
const Definition * /* context */,
const MemberDef * /* md */,
const QCString & /* sectionAnchor */,
const QCString & /* title */)
{
}
void EclipseHelp::addIndexFile(const QCString & /* name */)
{
}
void EclipseHelp::addImageFile(const QCString & /* name */)
{
}
void EclipseHelp::addStyleSheetFile(const QCString & /* name */)
{
}
|
