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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
|
/***************************************************************************
* Copyright (C) 2001 by Bernd Gehrmann *
* [email protected] *
* Copyright (C) 2004 by Jonas Jacobi *
* [email protected] *
* *
* This program 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. *
* *
***************************************************************************/
#include "doxygenpart.h"
#include "doxygenconfigwidget.h"
#include "configwidgetproxy.h"
#include "config.h"
#include "kdevappfrontend.h"
#include <kdevmainwindow.h>
#include <kdevproject.h>
#include <kdevmakefrontend.h>
#include <kdevcore.h>
#include <codemodel.h>
#include <codemodel_utils.h>
#include <domutil.h>
#include <kdebug.h>
#include <tdelocale.h>
#include <kdevgenericfactory.h>
#include <tdeaction.h>
#include <tdemessagebox.h>
#include <tdemainwindow.h>
#include <tdeparts/part.h>
#include <tdetexteditor/document.h>
#include <tdetexteditor/viewcursorinterface.h>
#include <tdetexteditor/editinterface.h>
#include <partcontroller.h>
#include <kdialogbase.h>
#include <kdevplugininfo.h>
#include <tqvbox.h>
#include <tqfile.h>
#include <tqtextstream.h>
#include <tqpopupmenu.h>
#include <tqfileinfo.h>
#define PROJECTOPTIONS 1
typedef KDevGenericFactory<DoxygenPart> DoxygenFactory;
static const KDevPluginInfo data("kdevdoxygen");
K_EXPORT_COMPONENT_FACTORY( libkdevdoxygen, DoxygenFactory( data ) )
DoxygenPart::DoxygenPart(TQObject *parent, const char *name, const TQStringList &)
: KDevPlugin(&data, parent, name ? name : "DoxygenPart"), m_activeEditor(0), m_cursor(0)
{
setInstance(DoxygenFactory::instance());
setXMLFile("kdevdoxygen.rc");
TDEAction *action;
action = new TDEAction( i18n("Build API Documentation"), 0,
this, TQT_SLOT(slotDoxygen()),
actionCollection(), "build_doxygen" );
action->setToolTip(i18n("Build API documentation"));
action->setWhatsThis(i18n("<b>Build API documentation</b><p>Runs doxygen on a project Doxyfile to generate API documentation. "
"If the search engine is enabled in Doxyfile, this also runs doxytag to create it."));
action = new TDEAction( i18n("Clean API Documentation"), 0,
this, TQT_SLOT(slotDoxClean()),
actionCollection(), "clean_doxygen" );
action->setToolTip(i18n("Clean API documentation"));
action->setWhatsThis(i18n("<b>Clean API documentation</b><p>Removes all generated by doxygen files."));
// connect( core(), TQT_SIGNAL(projectConfigWidget(KDialogBase*)), this, TQT_SLOT(projectConfigWidget(KDialogBase*)) );
_configProxy = new ConfigWidgetProxy( core() );
_configProxy->createProjectConfigPage( i18n("Doxygen"), PROJECTOPTIONS, info()->icon() );
connect( _configProxy, TQT_SIGNAL(insertConfigWidget(const KDialogBase*, TQWidget*, unsigned int )),
this, TQT_SLOT(insertConfigWidget(const KDialogBase*, TQWidget*, unsigned int )) );
m_actionDocumentFunction = new TDEAction(i18n("Document Current Function"), 0, CTRL+SHIFT+Key_S, this, TQT_SLOT(slotDocumentFunction()), actionCollection(), "edit_document_function");
m_actionDocumentFunction->setToolTip( i18n("Create a documentation template above a function"));
m_actionDocumentFunction->setWhatsThis(i18n("<b>Document Current Function</b><p>Creates a documentation template according to a function's signature above a function definition/declaration."));
m_tmpDir.setAutoDelete(true);
connect( partController(), TQT_SIGNAL(activePartChanged(KParts::Part*)), this, TQT_SLOT(slotActivePartChanged(KParts::Part* )));
m_actionPreview = new TDEAction(i18n("Preview Doxygen Output"), 0, CTRL+ALT+Key_P, this, TQT_SLOT(slotRunPreview()), actionCollection(), "show_preview_doxygen_output");
m_actionPreview->setToolTip( i18n("Show a preview of the Doxygen output of this file") );
m_actionPreview->setWhatsThis( i18n("<b>Preview Doxygen output</b><p>Runs Doxygen over the current file and shows the created index.html.") );
//read Doxygen configuration, if none exists yet, create it with some defaults
adjustDoxyfile();
TQString fileName = project()->projectDirectory() + "/Doxyfile";
TQFile file(fileName);
if (file.open(IO_ReadOnly)) {
TQTextStream is(&file);
Config::instance()->parse(TQFile::encodeName(fileName));
Config::instance()->convertStrToVal();
file.close();
}
}
DoxygenPart::~DoxygenPart()
{
delete _configProxy;
}
void DoxygenPart::insertConfigWidget( const KDialogBase * dlg, TQWidget * page, unsigned int pagenumber )
{
if ( pagenumber == PROJECTOPTIONS )
{
adjustDoxyfile();
DoxygenConfigWidget *w = new DoxygenConfigWidget(project()->projectDirectory() + "/Doxyfile", page );
connect( dlg, TQT_SIGNAL(okClicked()), w, TQT_SLOT(accept()) );
}
}
/** If a Doxygen configuration file doesn't exist, create one.
* And copy some of the project settings to it.
*/
void DoxygenPart::adjustDoxyfile()
{
TQString fileName = project()->projectDirectory() + "/Doxyfile";
if (TQFile::exists(fileName))
return;
// Initialize configuration
Config::instance()->init();
// Do some checks and improve the configuration a bit
Config::instance()->check();
// set "General/PROJECT_NAME"
ConfigString *name = dynamic_cast<ConfigString*>(Config::instance()->get("PROJECT_NAME"));
if (name)
{
name->setDefaultValue(project()->projectName().latin1());
name->init();
}
// set "General/PROJECT_NUMBER"
ConfigString *version = dynamic_cast<ConfigString*>(Config::instance()->get("PROJECT_NUMBER"));
if (version)
{
version->setDefaultValue(DomUtil::readEntry(*projectDom(), "/general/version").latin1());
version->init();
}
// insert input files into "Input/INPUT"
ConfigList *input_files = dynamic_cast<ConfigList*>(Config::instance()->get("INPUT"));
if (input_files)
{
input_files->init();
input_files->addValue(TQFile::encodeName(project()->projectDirectory()));
}
// insert file patterns into "Input/FILE_PATTERNS"
ConfigList *patterns = dynamic_cast<ConfigList*>(Config::instance()->get("FILE_PATTERNS"));
if (patterns)
{
// Remove Doxygen's default patterns
// patterns->init();
// Add this ones:
patterns->addValue("*.C");
patterns->addValue("*.H");
patterns->addValue("*.tlh");
patterns->addValue("*.diff");
patterns->addValue("*.patch");
patterns->addValue("*.moc");
patterns->addValue("*.xpm");
patterns->addValue("*.dox");
}
// set "Input/RECURSIVE" to recurse into subdirectories
ConfigBool *recursive = dynamic_cast<ConfigBool*>(Config::instance()->get("RECURSIVE"));
if (recursive)
{
recursive->setValueString("yes");
}
// set "XML/GENERATE_XML" to generate XML information to be used with code hinting
ConfigBool *gen_xml = dynamic_cast<ConfigBool*>(Config::instance()->get("GENERATE_XML"));
if (gen_xml)
{
gen_xml->setValueString("yes");
}
// set "Enternal/GENERATE_TAGFILE" to generate tag file for documentation browser
ConfigString *gen_tag = dynamic_cast<ConfigString*>(Config::instance()->get("GENERATE_TAGFILE"));
if (gen_tag)
{
gen_tag->setDefaultValue(TQString(project()->projectName()+".tag").latin1());
gen_tag->init();
}
// write doxy file
TQFile f2(fileName);
if (!f2.open(IO_WriteOnly))
KMessageBox::information(mainWindow()->main(), i18n("Cannot write Doxyfile."));
else
{
TQTextStream ts_file(&f2);
Config::instance()->writeTemplate(ts_file, true, true);
f2.close();
}
}
void DoxygenPart::slotDoxygen()
{
if ( !partController()->saveAllFiles() ) return;
bool searchDatabase = false;
TQString outputDirectory;
TQString htmlDirectory;
adjustDoxyfile();
TQString fileName = project()->projectDirectory() + "/Doxyfile";
Config::instance()->init();
TQFile f(fileName);
if (f.open(IO_ReadOnly))
{
TQTextStream is(&f);
Config::instance()->parse(TQFile::encodeName(fileName));
Config::instance()->convertStrToVal();
f.close();
}
// search engine
ConfigBool *search = dynamic_cast<ConfigBool*>(Config::instance()->get("SEARCHENGINE"));
if (search)
{
searchDatabase = Config_getBool("SEARCHENGINE");
if (searchDatabase)
{
// get input files
outputDirectory = Config_getString("OUTPUT_DIRECTORY");
if ( outputDirectory.isEmpty() == false )
outputDirectory += "/";
htmlDirectory = Config_getString("HTML_OUTPUT");
if ( htmlDirectory.isEmpty() == true )
htmlDirectory = "html";
htmlDirectory.prepend(outputDirectory);
}
}
TQString dir = project()->projectDirectory();
TQString cmdline = "cd ";
cmdline += KShellProcess::quote( dir );
cmdline += " && doxygen Doxyfile";
if (searchDatabase)
{
// create search database in the same directory where the html docs are
if ( htmlDirectory.length() > 0 )
cmdline += " && cd " + KShellProcess::quote( htmlDirectory );
cmdline += " && doxytag -s search.idx ";
}
kdDebug(9026) << "Doxygen command line: " << cmdline << endl;
if (KDevMakeFrontend *makeFrontend = extension<KDevMakeFrontend>("TDevelop/MakeFrontend"))
makeFrontend->queueCommand(dir, cmdline);
}
void DoxygenPart::slotDoxClean()
{
bool could_be_dirty = false;
TQString outputDirectory = Config_getString("OUTPUT_DIRECTORY");
if ( outputDirectory.isEmpty() )
outputDirectory = project()->projectDirectory();
if ( outputDirectory.right(1) != "/" )
outputDirectory += "/";
TQString cmdline = "cd " + KShellProcess::quote( outputDirectory );
if ( Config_getBool("GENERATE_HTML") ) {
TQString htmlDirectory = Config_getString("HTML_OUTPUT");
if ( htmlDirectory.isEmpty() )
htmlDirectory = "html";
if ( htmlDirectory.right(1) != "/" )
htmlDirectory += "/";
cmdline += " && rm -f " + KShellProcess::quote( htmlDirectory ) + "*";
could_be_dirty= true;
}
if ( Config_getBool("GENERATE_LATEX") ) {
TQString latexDirectory = Config_getString("LATEX_OUTPUT");
if ( latexDirectory.isEmpty() )
latexDirectory = "latex";
if ( latexDirectory.right(1) != "/" )
latexDirectory += "/";
cmdline += " && rm -f " + KShellProcess::quote( latexDirectory ) + "*";
could_be_dirty= true;
}
if ( Config_getBool("GENERATE_RTF") ) {
TQString rtfDirectory = Config_getString("RTF_OUTPUT");
if ( rtfDirectory.isEmpty() )
rtfDirectory = "rtf";
if ( rtfDirectory.right(1) != "/" )
rtfDirectory += "/";
cmdline += " && rm -f " + KShellProcess::quote( rtfDirectory ) + "*";
could_be_dirty= true;
}
if ( Config_getBool("GENERATE_MAN") ) {
TQString manDirectory = Config_getString("MAN_OUTPUT");
if ( manDirectory.isEmpty() )
manDirectory = "man";
if ( manDirectory.right(1) != "/" )
manDirectory += "/";
cmdline += " && rm -f " + KShellProcess::quote( manDirectory ) + "*";
could_be_dirty= true;
}
if ( Config_getBool("GENERATE_XML") ) {
TQString xmlDirectory = Config_getString("XML_OUTPUT");
if ( xmlDirectory.isEmpty() )
xmlDirectory = "xml";
if ( xmlDirectory.right(1) != "/" )
xmlDirectory += "/";
cmdline += " && rm -f " + KShellProcess::quote( xmlDirectory ) + "*";
could_be_dirty= true;
}
if (could_be_dirty) {
kdDebug(9026) << "Cleaning Doxygen generated API documentation using: " << cmdline << endl;
if (KDevMakeFrontend *makeFrontend = extension<KDevMakeFrontend>("TDevelop/MakeFrontend"))
makeFrontend->queueCommand(KShellProcess::quote(project()->projectDirectory()), cmdline);
}
else
kdDebug(9026) << "No Doxygen generated API documentation exists. There's nothing to clean!" << endl;
}
void DoxygenPart::slotPreviewProcessExited( )
{
KDevAppFrontend *appFrontend = extension<KDevAppFrontend>("TDevelop/AppFrontend");
if ( appFrontend != 0 )
disconnect(appFrontend, 0, this, 0);
partController()->showDocument(KURL(m_tmpDir.name()+"html/index.html"));
}
void DoxygenPart::slotRunPreview( )
{
if (m_file.isNull())
return;
KDevAppFrontend *appFrontend = extension<KDevAppFrontend>("TDevelop/AppFrontend");
if ( appFrontend == 0 )
return;
if ( appFrontend->isRunning() ) {
KMessageBox::information( mainWindow()->main(),
i18n("Another process is still running. Please wait until it's finished."));
return;
}
m_tmpDir.unlink();
m_tmpDir = KTempDir();
m_tmpDir.setAutoDelete(true);
Config* config = Config::instance();
ConfigString* poDir = dynamic_cast<ConfigString*>(config->get("OUTPUT_DIRECTORY"));
ConfigList* pInput = dynamic_cast<ConfigList*>(config->get("INPUT"));
ConfigString* pHeader = dynamic_cast<ConfigString*>(config->get("HTML_HEADER"));
ConfigString* pFooter = dynamic_cast<ConfigString*>(config->get("HTML_FOOTER"));
ConfigString* pStyle = dynamic_cast<ConfigString*>(config->get("HTML_STYLESHEET"));
//store config values to restore them later | override config values to get only the current file processed
TQCString dirVal;
if (poDir != 0) {
dirVal = *poDir->valueRef();
*poDir->valueRef() = m_tmpDir.name().ascii();
}
TQStrList inputVal;
if (pInput != 0) {
inputVal = *pInput->valueRef();
TQStrList xl;
xl.append(m_file.ascii());
*pInput->valueRef() = xl;
} else {
config->addList("INPUT", "# The INPUT tag can be used to specify the files and/or directories that contain\n"
"# documented source files. You may enter file names like \"myfile.cpp\" or\n"
"# directories like \"/usr/src/myproject\". Separate the files or directories\n"
"# with spaces.");
pInput = dynamic_cast<ConfigList*>(config->get("INPUT")); //pinput now has to be != 0
TQStrList xl;
xl.append(m_file.ascii());
*pInput->valueRef() = xl;
}
TQCString header;
TQCString footer;
TQCString stylesheet;
//if header/footer/stylesheets are set, make sure they get found in the doxygen run
TQString projectDir = project()->projectDirectory();
if (pHeader != 0 && !pHeader->valueRef()->isEmpty()){
header = *pHeader->valueRef();
TQFileInfo info (header);
if (info.isRelative())
*pHeader->valueRef() = TQString(projectDir + "/" + TQString(header)).ascii();
else
header = 0;
}
if (pFooter != 0 && !pFooter->valueRef()->isEmpty()){
footer = *pFooter->valueRef();
TQFileInfo info (footer);
if (info.isRelative())
*pFooter->valueRef() = TQString(projectDir + "/" + TQString(footer)).ascii();
else
footer = 0;
}
if (pStyle != 0 && !pStyle->valueRef()->isEmpty()){
stylesheet = *pStyle->valueRef();
TQFileInfo info (stylesheet);
if (info.isRelative())
*pStyle->valueRef() = TQString(projectDir +"/" + TQString(stylesheet)).ascii();
else
stylesheet = 0;
}
TQFile file(m_tmpDir.name() +"PreviewDoxyfile"); //file gets deleted automatically 'cause of tempdir
if (!file.open(IO_WriteOnly)){
//restore config values
if (pInput != 0)
*pInput->valueRef() = inputVal;
if (poDir != 0)
*poDir->valueRef() = dirVal;
KMessageBox::error(mainWindow()->main(), i18n("Cannot create temporary file '%1'").arg(file.name()));
return;
}
TQTextStream ts_file(&file);
config->writeTemplate(ts_file, false, false);
file.close();
if (inputVal.count() == 0) //pInput is always != 0
*pInput->valueRef() = TQStrList();
else
*pInput->valueRef() = inputVal;
if (poDir != 0)
*poDir->valueRef() = dirVal;
if (pHeader != 0 && !header.isNull())
*pHeader->valueRef() = header;
if (pFooter != 0 && !footer.isNull())
*pFooter->valueRef() = footer;
if (pStyle != 0 && !stylesheet.isNull())
*pStyle->valueRef() = stylesheet;
connect(appFrontend, TQT_SIGNAL(processExited()), this, TQT_SLOT(slotPreviewProcessExited()));
appFrontend->startAppCommand("", "doxygen \"" + file.name() + "\"", false);
}
void DoxygenPart::slotActivePartChanged( KParts::Part * part )
{
// -> idea from cppsupportpart.cpp
KTextEditor::Document* doc = dynamic_cast<KTextEditor::Document*>(part);
if (doc != 0)
m_file = doc->url().path();
else
m_file = TQString();
// <-
m_activeEditor = dynamic_cast<KTextEditor::EditInterface*>(part);
m_cursor = part ? dynamic_cast<KTextEditor::ViewCursorInterface*>(part->widget()) : 0;
}
void DoxygenPart::slotDocumentFunction(){
if (m_activeEditor != 0 && m_cursor != 0){
if ( codeModel()->hasFile( m_file ) ) {
unsigned int cursorLine, cursorCol;
m_cursor->cursorPosition(&cursorLine, &cursorCol);
FunctionDom function = 0;
FunctionDefinitionDom functionDef = 0;
FileDom file = codeModel()->fileByName( m_file );
FunctionList functionList = CodeModelUtils::allFunctions(file);
FunctionList::ConstIterator theend = functionList.end();
for( FunctionList::ConstIterator ci = functionList.begin(); ci!= theend; ++ci ){
int sline, scol;
int eline, ecol;
(*ci)->getStartPosition(&sline, &scol);
(*ci)->getEndPosition(&eline, &ecol);
if(cursorLine >= sline && cursorLine <= eline )
function = *ci;
}
if (function == 0){
FunctionDefinitionList functionDefList = CodeModelUtils::allFunctionDefinitionsDetailed(file).functionList;
FunctionDefinitionList::ConstIterator theend = functionDefList.end();
for( FunctionDefinitionList::ConstIterator ci = functionDefList.begin(); ci!= theend; ++ci ){
int sline, scol;
int eline, ecol;
(*ci)->getStartPosition(&sline, &scol);
(*ci)->getEndPosition(&eline, &ecol);
if(cursorLine >= sline && cursorLine <= eline)
functionDef = *ci;
}
}
int line, col;
if (function != 0)
function->getStartPosition(&line, &col);
else if (functionDef != 0)
functionDef->getStartPosition(&line, &col);
else
return;
TQString funcLine = m_activeEditor->textLine(line);
unsigned int pos = 0;
unsigned int length = funcLine.length();
while (pos < length && funcLine.at(pos).isSpace())
++pos;
//store chars used for indenting the line and put it in front of every created doc line
TQString indentChars = funcLine.left(pos);
TQString text = indentChars + "/**\n" + indentChars + " * \n";
ArgumentList args;
TQString resultType;
if (function != 0) {
args = function->argumentList();
resultType = function->resultType();
} else {
args = functionDef->argumentList();
resultType = functionDef->resultType();
}
for( ArgumentList::ConstIterator ci = args.begin(); ci != args.end(); ++ci)
text += indentChars + " * @param " + (*ci)->name() +" \n";
if (resultType != "void" && !resultType.isEmpty())
text += indentChars + " * @return \n";
text += indentChars + " */\n";
m_activeEditor->insertText(line, 0, text);
m_cursor->setCursorPosition( line + 1, indentChars.length() + 3);
}
}
}
#include "doxygenpart.moc"
|