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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
/*LICENSE_START*/
/*
* Copyright 1995-2002 Washington University School of Medicine
*
* http://brainmap.wustl.edu
*
* This file is part of CARET.
*
* CARET is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* CARET is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with CARET; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
/*LICENSE_END*/
#include <iostream>
#include <QDate>
#include <QDir>
#include <QFile>
#include <QMap>
#include <QTextStream>
#include "CommandCaretHelpCreateHtmlIndexFile.h"
#include "DebugControl.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
/**
* constructor.
*/
CommandCaretHelpCreateHtmlIndexFile::CommandCaretHelpCreateHtmlIndexFile()
: CommandBase("-caret-help-create-html-index-file",
"CARET CREATE HTML INDEX FILE")
{
}
/**
* destructor.
*/
CommandCaretHelpCreateHtmlIndexFile::~CommandCaretHelpCreateHtmlIndexFile()
{
}
/**
* get the script builder parameters.
*/
void
CommandCaretHelpCreateHtmlIndexFile::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{
paramsOut.clear();
paramsOut.addFile("Output HTML File",
"HTML Files (*.htm *.html)",
"index.html");
paramsOut.addString("Page Title", "Title Goes Here");
}
/**
* get full help information.
*/
QString
CommandCaretHelpCreateHtmlIndexFile::getHelpInformation() const
{
QString helpInfo =
(indent3 + getShortDescription() + "\n"
+ indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + " \n"
+ indent9 + "<output-html-file-name>\n"
+ indent9 + "<page-title> \n"
+ indent9 + "\n"
+ indent9 + "This command should be run from the top level Caret Help \n"
+ indent9 + "directory. It generates an HTML file that links to all of\n"
+ indent9 + "HTML files in the current directory's subdirectories.\n"
+ indent9 + "\n"
+ indent9 + "Each subdirectory will become a topic. Each HTML file found \n"
+ indent9 + "in the subdirectories will be searched for a title element.\n"
+ indent9 + "The title element will be the name of the page listed in the\n"
+ indent9 + "output file. If a title element is not found, the name of\n"
+ indent9 + "the HTML file will be used.\n"
+ indent9 + "\n"
+ indent9 + "If the title contains spaces, it must be enclosed in \n"
+ indent9 + "double quotes. \n"
+ indent9 + "\n");
return helpInfo;
}
/**
* execute the command.
*/
void
CommandCaretHelpCreateHtmlIndexFile::executeCommand() throw (BrainModelAlgorithmException,
CommandException,
FileException,
ProgramParametersException,
StatisticException)
{
//
// Get parameters
//
const QString outputHtmlFileName =
parameters->getNextParameterAsString("Output HTML File Name");
const QString theTitle =
parameters->getNextParameterAsString("Title");
//
// Open the output file
//
QFile fileOut(outputHtmlFileName);
if (fileOut.open(QFile::WriteOnly) == false) {
throw CommandException("Unable to open "
+ outputHtmlFileName
+ " for writing.");
}
QTextStream streamOut(&fileOut);
//
// Output start of HTML tags
//
streamOut << "<html> \n";
streamOut << "<head> \n";
streamOut << " <title>" << theTitle << "</title> \n";
streamOut << " <meta http-equiv=\"content-type\""
<< " content=\"text/html; charset=ISO-8859-1\"> \n";
streamOut << "</head> \n";
streamOut << "<body> \n";
streamOut << "<center><h1>" << theTitle << "</h1></center> \n";
streamOut << "<center>" << "Generated " << QDate::currentDate().toString("dd MMM yyyy") << "</center><br> \n";
//
// Get all subdirectories of the current directory
//
QDir topDir(".");
QStringList subDirList = topDir.entryList((QDir::AllDirs | QDir::NoDotAndDotDot),
QDir::Name);
//
// HTML filters
//
QStringList htmlFilters;
htmlFilters << "*.html";
htmlFilters << "*.htm";
//
// Loop through the subdirectories
//
for (int i = 0; i < subDirList.count(); i++) {
//
// Name of a directory
//
const QString dirName(subDirList.at(i));
if (DebugControl::getDebugOn()) {
std::cout << "SubDir: " << dirName.toAscii().constData() << std::endl;
}
//
// Get the HTML files
//
QDir subDir(dirName);
QStringList htmlFileList = subDir.entryList(htmlFilters,
(QDir::Files
| QDir::NoSymLinks),
QDir::Name);
//
// If HTML files in directory
//
if (htmlFileList.count() > 0) {
//
// Place titles and URLs into multimap with title being the key
//
QMap<QString,QString> pagesMap;
for (int j = 0; j < htmlFileList.count(); j++) {
//
// Name of html file and its title
//
const QString fileName(htmlFileList.at(j));
const QString title = getHtmlPageTitle(dirName, fileName);
//
// Output List and Link HTML
//
const QString hrefTag("<li> <a href=\""
+ dirName
+ "/"
+ fileName
+ "\">");
//
// Add to list of pages
//
if (pagesMap.find(title) != pagesMap.end()) {
std::cout << "ERROR: more than one page in the directory "
<< dirName.toAscii().constData()
<< " has the same title \""
<< title.toAscii().constData()
<< "\""
<< std::endl
<< " Page not output: "
<< fileName.toAscii().constData()
<< std::endl;
}
else {
pagesMap[title] = hrefTag;
}
if (DebugControl::getDebugOn()) {
std::cout << " HTML: "
<< fileName.toAscii().constData()
<< std::endl;
std::cout << " "
<< " TITLE: "
<< title.toAscii().constData()
<< std::endl;
}
}
if (pagesMap.isEmpty() == false) {
//
// Add Directory Name as H2 to HTML files
//
addHtml(streamOut,
"<h2>",
"</h2>",
convertDirectoryNameToTitle(dirName),
3);
//
// Start an unordered list
//
addHtml(streamOut,
"<ul>",
"",
"",
3);
//
// Output the pages
//
QStringList pageNames = pagesMap.keys();
pageNames.sort();
for (int k = 0; k < pageNames.count(); k++) {
const QString pageTitle = pageNames.at(k);
const QString pageHREF = pagesMap[pageTitle];
addHtml(streamOut,
pageHREF,
"</a>",
pageTitle,
6,
true);
}
//
// Close the unordered list
//
addHtml(streamOut,
"</ul>",
"",
"",
3);
}
}
}
//
// End of HTML tags
//
streamOut << "</body> \n";
streamOut << "</html> \n";
//
// Close output file
//
fileOut.close();
}
/**
* add to the output file.
*/
void
CommandCaretHelpCreateHtmlIndexFile::addHtml(QTextStream& streamOut,
const QString& htmlStartTag,
const QString& htmlEndTag,
const QString& text,
const int indentation,
const bool addLineBreakFlag)
{
QString breakTag;
if (addLineBreakFlag) {
breakTag = " <br>";
}
streamOut << QString(indentation, ' ')
<< htmlStartTag
<< text
<< htmlEndTag
<< breakTag
<< "\n";
}
/**
* get the title from an HTML page.
*/
QString
CommandCaretHelpCreateHtmlIndexFile::getHtmlPageTitle(const QString& directoryName,
const QString& fileName)
{
//
// Default title to the name of the file
//
QString title(fileName);
if (fileName.endsWith(".htm")) {
title = fileName.left(fileName.length() - QString(".htm").length());
}
else if (fileName.endsWith(".html")) {
title = fileName.left(fileName.length() - QString(".html").length());
}
//
// Open the file
//
QFile file(directoryName + "/" + fileName);
if (file.open(QFile::ReadOnly)) {
//
// Read the entire file
//
QTextStream stream(&file);
const QString fileText = stream.readAll();
//
// Find the start and end title flags
//
const QString startTag("<title>");
const QString endTag("</title>");
const int startIndex = fileText.indexOf(startTag,
Qt::CaseInsensitive);
if (startIndex >= 0) {
const int endIndex = fileText.indexOf(endTag,
startIndex + 1,
Qt::CaseInsensitive);
if (endIndex > 0) {
const int textStart = startIndex + startTag.length();
const int textLength = endIndex - textStart;
if ((textStart > 0) &&
(textLength > 0)) {
title = fileText.mid(textStart, textLength);
}
}
}
//
// Close the file
//
file.close();
}
return title;
}
/**
* convert directory name to title.
*/
QString
CommandCaretHelpCreateHtmlIndexFile::convertDirectoryNameToTitle(const QString& dirNameIn)
{
QString dirName(dirNameIn);
QString title(dirName.replace('_', ' '));
//
// Make first character and first after blanks capitals
//
for (int i = 0; i < title.length(); i++) {
QChar ch = title[i];
if (i == 0) {
ch = ch.toUpper();
}
else if (title[i - 1] == ' ') {
ch = ch.toUpper();
}
title[i] = ch;
}
return title;
}
|
