Doxygen
Loading...
Searching...
No Matches
ftvhelp.cpp
Go to the documentation of this file.
1/******************************************************************************
2 * ftvhelp.cpp,v 1.0 2000/09/06 16:09:00
3 *
4 * Copyright (C) 1997-2015 by Dimitri van Heesch.
5 *
6 * Permission to use, copy, modify, and distribute this software and its
7 * documentation under the terms of the GNU General Public License is hereby
8 * granted. No representations are made about the suitability of this software
9 * for any purpose. It is provided "as is" without express or implied warranty.
10 * See the GNU General Public License for more details.
11 *
12 * Documents produced by Doxygen are derivative works derived from the
13 * input used in their production; they are not affected by this license.
14 *
15 * Original version contributed by Kenney Wong <kwong@ea.com>
16 * Modified by Dimitri van Heesch
17 *
18 * Folder Tree View for offline help on browsers that do not support HTML Help.
19 */
20
21#include <stdio.h>
22#include <stdlib.h>
23#include <algorithm>
24
25#include "ftvhelp.h"
26#include "config.h"
27#include "message.h"
28#include "doxygen.h"
29#include "language.h"
30#include "htmlgen.h"
31#include "layout.h"
32#include "pagedef.h"
33#include "docparser.h"
34#include "htmldocvisitor.h"
35#include "filedef.h"
36#include "classdef.h"
37#include "util.h"
38#include "resourcemgr.h"
39#include "portable.h"
40#include "outputlist.h"
41#include "threadpool.h"
42
43static int folderId=1;
44
45
46struct FTVNode;
47using FTVNodePtr = std::shared_ptr<FTVNode>;
48using FTVNodeWeakPtr = std::weak_ptr<FTVNode>;
49using FTVNodes = std::vector<FTVNodePtr>;
50
51struct FTVNode
52{
53 FTVNode(bool dir,const QCString &r,const QCString &f,const QCString &a,
54 const QCString &n,bool sepIndex,bool navIndex,const Definition *df,
55 const QCString &nameAsHtml_)
56 : isLast(TRUE), isDir(dir), ref(r), file(f), anchor(a), name(n), nameAsHtml(nameAsHtml_),
57 separateIndex(sepIndex), addToNavIndex(navIndex), def(df) {}
58 int computeTreeDepth(int level) const;
59 int numNodesAtLevel(int level,int maxLevel) const;
60 bool isLast;
61 bool isDir;
67 int index = 0;
73};
74
75int FTVNode::computeTreeDepth(int level) const
76{
77 int maxDepth=level;
78 for (const auto &n : children)
79 {
80 if (!n->children.empty())
81 {
82 int d = n->computeTreeDepth(level+1);
83 if (d>maxDepth) maxDepth=d;
84 }
85 }
86 return maxDepth;
87}
88
89int FTVNode::numNodesAtLevel(int level,int maxLevel) const
90{
91 int num=0;
92 if (level<maxLevel)
93 {
94 num++; // this node
95 for (const auto &n : children)
96 {
97 num+=n->numNodesAtLevel(level+1,maxLevel);
98 }
99 }
100 return num;
101}
102
103//----------------------------------------------------------------------------
104
106{
107 Private(bool TLI) : topLevelIndex(TLI) { indentNodes.resize(1); }
108 std::vector<FTVNodes> indentNodes;
109 int indent = 0;
111
112 void generateTree(TextStream &t,const FTVNodes &nl,int level,int maxLevel,int &index);
113 void generateLink(TextStream &t,const FTVNodePtr &n);
114};
115
116/*! Constructs an ftv help object.
117 * The object has to be \link initialize() initialized\endlink before it can
118 * be used.
119 */
120FTVHelp::FTVHelp(bool TLI) : p(std::make_unique<Private>(TLI)) {}
121FTVHelp::~FTVHelp() = default;
122
123/*! This will create a folder tree view table of contents file (tree.js).
124 * \sa finalize()
125 */
127{
128}
129
130/*! Finalizes the FTV help. This will finish and close the
131 * contents file (index.js).
132 * \sa initialize()
133 */
135{
137}
138
139/*! Increase the level of the contents hierarchy.
140 * This will start a new sublist in contents file.
141 * \sa decContentsDepth()
142 */
144{
145 //printf("%p: incContentsDepth() indent=%d\n",this,p->indent);
146 p->indent++;
147 p->indentNodes.resize(p->indent+1);
148}
149
150/*! Decrease the level of the contents hierarchy.
151 * This will end the current sublist.
152 * \sa incContentsDepth()
153 */
155{
156 //printf("%p: decContentsDepth() indent=%d\n",this,p->indent);
157 ASSERT(p->indent>0);
158 if (p->indent>0)
159 {
160 p->indent--;
161 auto &nl = p->indentNodes[p->indent];
162 if (!nl.empty())
163 {
164 auto &parent = nl.back();
165 auto &children = p->indentNodes[p->indent+1];
166 for (const auto &child : children)
167 {
168 parent->children.push_back(child);
169 }
170 children.clear();
171 }
172 }
173}
174
175/*! Add a list item to the contents file.
176 * \param isDir TRUE if the item is a directory, FALSE if it is a text
177 * \param name the name of the item.
178 * \param nameAsHtml the name of the item in HTML format.
179 * \param ref the URL of to the item.
180 * \param file the file containing the definition of the item
181 * \param anchor the anchor within the file.
182 * \param separateIndex put the entries in a separate index file
183 * \param addToNavIndex add this entry to the quick navigation index
184 * \param def Definition corresponding to this entry
185 */
187 const QCString &name,
188 const QCString &ref,
189 const QCString &file,
190 const QCString &anchor,
191 bool separateIndex,
192 bool addToNavIndex,
193 const Definition *def,
194 const QCString &nameAsHtml
195 )
196{
197 //printf("%p: p->indent=%d addContentsItem(%d,%s,%s,%s,%s)\n",(void*)this,p->indent,isDir,qPrint(name),qPrint(ref),qPrint(file),qPrint(anchor));
198 auto &nl = p->indentNodes[p->indent];
199 if (!nl.empty())
200 {
201 nl.back()->isLast=FALSE;
202 }
203 auto newNode = std::make_shared<FTVNode>(isDir,ref,file,anchor,name,separateIndex,addToNavIndex,def,nameAsHtml);
204 nl.push_back(newNode);
205 newNode->index = static_cast<int>(nl.size()-1);
206 if (p->indent>0)
207 {
208 auto &pnl = p->indentNodes[p->indent-1];
209 if (!pnl.empty())
210 {
211 newNode->parent = pnl.back();
212 }
213 }
214}
215
216static QCString node2URL(const FTVNodePtr &n,bool overruleFile=FALSE,bool srcLink=FALSE)
217{
218 QCString url = n->file;
219 if (!url.isEmpty() && url.at(0)=='!') // relative URL
220 {
221 // remove leading !
222 url = url.mid(1);
223 }
224 else if (!url.isEmpty() && url.at(0)=='^') // absolute URL
225 {
226 // skip, keep ^ in the output
227 }
228 else // local file (with optional anchor)
229 {
230 if (overruleFile && n->def && n->def->definitionType()==Definition::TypeFile)
231 {
232 const FileDef *fd = toFileDef(n->def);
233 if (srcLink)
234 {
235 url = fd->getSourceFileBase();
236 }
237 else
238 {
239 url = fd->getOutputFileBase();
240 }
241 }
243 if (!n->anchor.isEmpty()) url+="#"+n->anchor;
244 }
245 return url;
246}
247
248static QCString generateIndentLabel(const FTVNodePtr &n,int level)
249{
250 QCString result;
251 auto parent = n->parent.lock();
252 if (parent)
253 {
254 result=generateIndentLabel(parent,level+1);
255 }
256 result+=QCString().setNum(n->index)+"_";
257 return result;
258}
259
260static void generateIndent(TextStream &t, const FTVNodePtr &n,bool opened)
261{
262 int indent=0;
263 auto parent = n->parent.lock();
264 while (parent) { indent++; parent=parent->parent.lock(); }
265 if (n->isDir)
266 {
267 const char *ARROW_DOWN = "<span class=\"arrowhead opened\"></span>";
268 const char *ARROW_RIGHT = "<span class=\"arrowhead closed\"></span>";
269 QCString dir = opened ? ARROW_DOWN : ARROW_RIGHT;
270 t << "<span style=\"width:" << (indent*16) << "px;display:inline-block;\">&#160;</span>"
271 << "<span id=\"arr_" << generateIndentLabel(n,0) << "\" class=\"arrow\" ";
272 t << "onclick=\"dynsection.toggleFolder('" << generateIndentLabel(n,0) << "')\"";
273 t << ">" << dir
274 << "</span>";
275 }
276 else
277 {
278 t << "<span style=\"width:" << ((indent+1)*16) << "px;display:inline-block;\">&#160;</span>";
279 }
280}
281
283{
284 //printf("FTVHelp::generateLink(ref=%s,file=%s,anchor=%s\n",
285 // qPrint(n->ref),qPrint(n->file),qPrint(n->anchor));
286 bool setTarget = FALSE;
287 bool nameAsHtml = !n->nameAsHtml.isEmpty();
288 QCString text = nameAsHtml ? n->nameAsHtml : convertToHtml(n->name);
289 if (n->file.isEmpty()) // no link
290 {
291 t << "<b>" << text << "</b>";
292 }
293 else // link into other frame
294 {
295 if (!n->ref.isEmpty()) // link to entity imported via tag file
296 {
297 t << "<a class=\"elRef\" ";
298 QCString result = externalLinkTarget();
299 if (result != "") setTarget = TRUE;
300 t << result;
301 }
302 else // local link
303 {
304 t << "<a class=\"el\" ";
305 }
306 t << "href=\"";
307 t << externalRef("",n->ref,TRUE);
308 t << node2URL(n);
309 if (!setTarget)
310 {
311 if (topLevelIndex)
312 t << "\" target=\"basefrm\">";
313 else
314 t << "\" target=\"_self\">";
315 }
316 else
317 {
318 t << "\">";
319 }
320 t << text;
321 t << "</a>";
322 if (!n->ref.isEmpty())
323 {
324 t << "&#160;[external]";
325 }
326 }
327}
328
329static void generateBriefDoc(TextStream &t,const Definition *def)
330{
331 QCString brief = def->briefDescription(TRUE);
332 //printf("*** %p: generateBriefDoc(%s)='%s'\n",def,qPrint(def->name()),qPrint(brief));
333 if (!brief.isEmpty())
334 {
335 auto parser { createDocParser() };
336 auto ast { validatingParseDoc(*parser.get(),
337 def->briefFile(),
338 def->briefLine(),
339 def,
340 nullptr,
341 brief,
342 DocOptions()
343 .setSingleLine(true)
344 .setLinkFromIndex(true))
345 };
346 const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast.get());
347 if (astImpl)
348 {
350 OutputCodeList htmlList;
351 htmlList.add<HtmlCodeGenerator>(&t,relPath);
352 HtmlDocVisitor visitor(t,htmlList,def);
353 std::visit(visitor,astImpl->root);
354 }
355 }
356}
357
358static char compoundIcon(const ClassDef *cd)
359{
360 char icon='C';
361 if (cd->getLanguage() == SrcLangExt::Slice)
362 {
364 {
365 icon='I';
366 }
367 else if (cd->compoundType()==ClassDef::Struct)
368 {
369 icon='S';
370 }
371 else if (cd->compoundType()==ClassDef::Exception)
372 {
373 icon='E';
374 }
375 }
376 return icon;
377}
378
379void FTVHelp::Private::generateTree(TextStream &t, const FTVNodes &nl,int level,int maxLevel,int &index)
380{
381 for (const auto &n : nl)
382 {
383 t << "<tr id=\"row_" << generateIndentLabel(n,0) << "\"";
384 if ((index&1)==0) // even row
385 t << " class=\"even\"";
386 else
387 t << " class=\"odd\"";
388 if (level>=maxLevel) // item invisible by default
389 t << " style=\"display:none;\"";
390 else // item visible by default
391 index++;
392 t << "><td class=\"entry\">";
393 bool nodeOpened = level+1<maxLevel;
394 generateIndent(t,n,nodeOpened);
395 if (n->isDir)
396 {
397 if (n->def && n->def->definitionType()==Definition::TypeGroup)
398 {
399 // no icon
400 }
401 else if (n->def && n->def->definitionType()==Definition::TypePage)
402 {
403 // no icon
404 }
405 else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
406 {
407 if ((n->def->getLanguage() == SrcLangExt::Slice) || (n->def->getLanguage() == SrcLangExt::Fortran))
408 {
409 t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
410 }
411 else if ((n->def->getLanguage() == SrcLangExt::Java) || (n->def->getLanguage() == SrcLangExt::VHDL))
412 {
413 t << "<span class=\"icona\"><span class=\"icon\">P</span></span>";
414 }
415 else
416 {
417 t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
418 }
419 }
420 else if (n->def && n->def->definitionType()==Definition::TypeModule)
421 {
422 t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
423 }
424 else if (n->def && n->def->definitionType()==Definition::TypeClass)
425 {
426 char icon=compoundIcon(toClassDef(n->def));
427 t << "<span class=\"icona\"><span class=\"icon\">" << icon << "</span></span>";
428 }
429 else
430 {
431 t << "<span id=\"img_" << generateIndentLabel(n,0) << "\" class=\"iconfolder"
432 << "\" onclick=\"dynsection.toggleFolder('" << generateIndentLabel(n,0)
433 << "')\"><div class=\"folder-icon"
434 << (nodeOpened ? " open" : "")
435 << "\"></div></span>";
436 }
437 generateLink(t,n);
438 t << "</td><td class=\"desc\">";
439 if (n->def)
440 {
441 generateBriefDoc(t,n->def);
442 }
443 t << "</td></tr>\n";
444 folderId++;
445 generateTree(t,n->children,level+1,maxLevel,index);
446 }
447 else // leaf node
448 {
449 const FileDef *srcRef=nullptr;
450 if (n->def && n->def->definitionType()==Definition::TypeFile &&
451 (toFileDef(n->def))->generateSourceFile())
452 {
453 srcRef = toFileDef(n->def);
454 }
455 if (srcRef)
456 {
457 QCString fn=srcRef->getSourceFileBase();
459 t << "<a href=\"" << fn << "\">";
460 }
461 if (n->def && n->def->definitionType()==Definition::TypeGroup)
462 {
463 // no icon
464 }
465 else if (n->def && n->def->definitionType()==Definition::TypePage)
466 {
467 // no icon
468 }
469 else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
470 {
471 if ((n->def->getLanguage() == SrcLangExt::Slice) || (n->def->getLanguage() == SrcLangExt::Fortran))
472 {
473 t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
474 }
475 else if ((n->def->getLanguage() == SrcLangExt::Java) || (n->def->getLanguage() == SrcLangExt::VHDL))
476 {
477 t << "<span class=\"icona\"><span class=\"icon\">P</span></span>";
478 }
479 else
480 {
481 t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
482 }
483 }
484 else if (n->def && n->def->definitionType()==Definition::TypeModule)
485 {
486 t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
487 }
488 else if (n->def && n->def->definitionType()==Definition::TypeClass)
489 {
490 char icon=compoundIcon(toClassDef(n->def));
491 t << "<span class=\"icona\"><span class=\"icon\">" << icon << "</span></span>";
492 }
493 else if (n->def && n->def->definitionType()==Definition::TypeConcept)
494 {
495 t << "<span class=\"icona\"><span class=\"icon\">R</span></span>";
496 }
497 else if (n->def && n->def->definitionType()==Definition::TypeDir)
498 {
499 t << "<span class=\"iconfolder\"><div class=\"folder-icon\"></div></span>";
500 }
501 else
502 {
503 t << "<span class=\"icondoc\"><div class=\"doc-icon\"></div></span>";
504 }
505 if (srcRef)
506 {
507 t << "</a>";
508 }
509 generateLink(t,n);
510 t << "</td><td class=\"desc\">";
511 if (n->def)
512 {
513 generateBriefDoc(t,n->def);
514 }
515 t << "</td></tr>\n";
516 }
517 }
518}
519
520//-----------------------------------------------------------
521
523{
524 NavIndexEntry(const QCString &u,const QCString &p) : url(u), path(p) {}
527};
528
529class NavIndexEntryList : public std::vector<NavIndexEntry>
530{
531};
532
533static QCString pathToNode(const FTVNodePtr &leaf,const FTVNodePtr &n)
534{
535 QCString result;
536 auto parent = n->parent.lock();
537 if (parent)
538 {
539 result+=pathToNode(leaf,parent);
540 }
541 result+=QCString().setNum(n->index);
542 if (leaf!=n) result+=",";
543 return result;
544}
545
546static bool dupOfParent(const FTVNodePtr &n)
547{
548 auto parent = n->parent.lock();
549 if (!parent) return FALSE;
550 if (n->file==parent->file) return TRUE;
551 return FALSE;
552}
553
554static void generateJSLink(TextStream &t,const FTVNodePtr &n)
555{
556 bool nameAsHtml = !n->nameAsHtml.isEmpty();
557 QCString result = nameAsHtml ? n->nameAsHtml : n->name;
558 QCString link = convertToJSString(result,nameAsHtml);
559 if (n->file.isEmpty()) // no link
560 {
561 t << "\"" << link << "\", null, ";
562 }
563 else // link into other page
564 {
565 if (Config_getBool(HIDE_SCOPE_NAMES)) result=stripScope(result);
566 t << "\"" << link << "\", \"";
567 t << externalRef("",n->ref,TRUE);
568 t << node2URL(n);
569 t << "\", ";
570 }
571}
572
574{
575 QCString varId = fileId;
576 int i=varId.findRev('/');
577 if (i>=0) varId = varId.mid(i+1);
578 return substitute(varId,"-","_");
579}
580
581
583{
584 JSTreeFile(const QCString &fi,const FTVNodePtr &n) : fileId(fi), node(n) {}
587};
588
589using JSTreeFiles = std::vector<JSTreeFile>;
590
591static void collectJSTreeFiles(const FTVNodes &nl,JSTreeFiles &files)
592{
593 QCString htmlOutput = Config_getString(HTML_OUTPUT);
594 for (const auto &n : nl)
595 {
596 if (n->separateIndex) // add new file if there are children
597 {
598 if (!n->children.empty())
599 {
600 QCString fileId = n->file;
601 files.emplace_back(fileId,n);
602 collectJSTreeFiles(n->children,files);
603 }
604 }
605 else // traverse without adding a new file
606 {
607 collectJSTreeFiles(n->children,files);
608 }
609 }
610}
611
612static std::mutex g_navIndexMutex;
613
615 const FTVNodes &nl,int level,bool &first)
616{
617 QCString htmlOutput = Config_getString(HTML_OUTPUT);
618 QCString indentStr;
619 indentStr.fill(' ',level*2);
620
621 bool found=FALSE;
622 for (const auto &n : nl)
623 {
624 // terminate previous entry
625 if (!first) t << ",\n";
626 first=FALSE;
627
628 // start entry
629 if (!found)
630 {
631 t << "[\n";
632 }
633 found=TRUE;
634
635 if (n->addToNavIndex) // add entry to the navigation index
636 {
637 std::lock_guard lock(g_navIndexMutex);
638 if (n->def && n->def->definitionType()==Definition::TypeFile)
639 {
640 const FileDef *fd = toFileDef(n->def);
641 bool src = false;
642 bool doc = fileVisibleInIndex(fd,src);
643 if (doc)
644 {
645 navIndex.emplace_back(node2URL(n,TRUE,FALSE),pathToNode(n,n));
646 }
647 if (src)
648 {
649 navIndex.emplace_back(node2URL(n,TRUE,TRUE),pathToNode(n,n));
650 }
651 }
652 else
653 {
654 navIndex.emplace_back(node2URL(n),pathToNode(n,n));
655 }
656 }
657
658 if (n->separateIndex) // store items in a separate file for dynamic loading
659 {
660 t << indentStr << " [ ";
661 generateJSLink(t,n);
662 if (!n->children.empty()) // write children to separate file for dynamic loading
663 {
664 QCString fileId = n->file;
665 if (!n->anchor.isEmpty())
666 {
667 fileId+="_"+n->anchor;
668 }
669 if (dupOfParent(n))
670 {
671 fileId+="_dup";
672 }
673 t << "\"" << fileId << "\" ]";
674 }
675 else // no children
676 {
677 t << "null ]";
678 }
679 }
680 else // show items in this file
681 {
682 bool firstChild=TRUE;
683 t << indentStr << " [ ";
684 generateJSLink(t,n);
685 bool emptySection = !generateJSTree(navIndex,t,n->children,level+1,firstChild);
686 if (emptySection)
687 t << "null ]";
688 else
689 t << "\n" << indentStr << " ] ]";
690 }
691 }
692 return found;
693}
694
695static void generateJSTreeFiles(NavIndexEntryList &navIndex,TextStream &t,const FTVNodes &nodeList)
696{
697 QCString htmlOutput = Config_getString(HTML_OUTPUT);
698
699 auto getVarName = [](const FTVNodePtr n)
700 {
701 QCString fileId = n->file;
702 if (!n->anchor.isEmpty()) fileId+="_"+n->anchor;
703 if (dupOfParent(n)) fileId+="_dup";
704 return fileId;
705 };
706
707 auto generateJSFile = [&](const JSTreeFile &tf)
708 {
709 QCString fileId = getVarName(tf.node);
710 QCString fileName = htmlOutput+"/"+fileId+".js";
711 std::ofstream ff = Portable::openOutputStream(fileName);
712 if (ff.is_open())
713 {
714 bool firstChild = true;
715 TextStream tt(&ff);
716 tt << "var " << convertFileId2Var(fileId) << " =\n";
717 generateJSTree(navIndex,tt,tf.node->children,1,firstChild);
718 tt << "\n];";
719 }
720 };
721
722 JSTreeFiles jsTreeFiles;
723 collectJSTreeFiles(nodeList,jsTreeFiles);
724
725 std::size_t numThreads = static_cast<std::size_t>(Config_getInt(NUM_PROC_THREADS));
726 if (numThreads>1) // multi threaded version
727 {
728 ThreadPool threadPool(numThreads);
729 std::vector< std::future<void> > results;
730 for (const auto &tf : jsTreeFiles)
731 {
732 results.emplace_back(threadPool.queue([&](){ generateJSFile(tf); }));
733 }
734 // wait for the results
735 for (auto &f : results) f.get();
736 }
737 else // single threaded version
738 {
739 for (const auto &tf : jsTreeFiles)
740 {
741 generateJSFile(tf);
742 }
743 }
744}
745
746static void generateJSNavTree(const FTVNodes &nodeList)
747{
748 QCString htmlOutput = Config_getString(HTML_OUTPUT);
749 std::ofstream f = Portable::openOutputStream(htmlOutput+"/navtreedata.js");
750 NavIndexEntryList navIndex;
751 if (f.is_open())
752 {
753 TextStream t(&f);
754 //TextStream tidx(&fidx);
755 //tidx << "var NAVTREEINDEX =\n";
756 //tidx << "{\n";
758 t << "var NAVTREE =\n";
759 t << "[\n";
760 t << " [ ";
761 QCString projName = Config_getString(PROJECT_NAME);
762 if (projName.isEmpty())
763 {
764 if (mainPageHasTitle()) // Use title of main page as root
765 {
766 t << "\"" << convertToJSString(Doxygen::mainPage->title()) << "\", ";
767 }
768 else // Use default section title as root
769 {
770 LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::MainPage);
771 t << "\"" << convertToJSString(lne->title()) << "\", ";
772 }
773 }
774 else // use PROJECT_NAME as root tree element
775 {
776 t << "\"" << convertToJSString(projName) << "\", ";
777 }
778 t << "\"index" << Doxygen::htmlFileExtension << "\", ";
779
780 // add special entry for index page
781 navIndex.emplace_back("index"+Doxygen::htmlFileExtension,"");
782 // related page index is written as a child of index.html, so add this as well
783 navIndex.emplace_back("pages"+Doxygen::htmlFileExtension,"");
784
785 bool first=TRUE;
786 generateJSTree(navIndex,t,nodeList,1,first);
787 generateJSTreeFiles(navIndex,t,nodeList);
788
789 if (first)
790 t << "]\n";
791 else
792 t << "\n ] ]\n";
793 t << "];\n\n";
794
795 // write the navigation index (and sub-indices)
796 std::stable_sort(navIndex.begin(),navIndex.end(),[](const auto &n1,const auto &n2)
797 { return !n1.url.isEmpty() && (n2.url.isEmpty() || (n1.url<n2.url)); });
798
799 int subIndex=0;
800 int elemCount=0;
801 const int maxElemCount=250;
802 std::ofstream tsidx = Portable::openOutputStream(htmlOutput+"/navtreeindex0.js");
803 if (tsidx.is_open())
804 {
805 t << "var NAVTREEINDEX =\n";
806 t << "[\n";
807 tsidx << "var NAVTREEINDEX" << subIndex << " =\n";
808 tsidx << "{\n";
809 first=TRUE;
810 auto it = navIndex.begin();
811 while (it!=navIndex.end())
812 {
813 const NavIndexEntry &e = *it;
814 if (elemCount==0)
815 {
816 if (!first)
817 {
818 t << ",\n";
819 }
820 else
821 {
822 first=FALSE;
823 }
824 t << "\"" << e.url << "\"";
825 }
826 tsidx << "\"" << e.url << "\":[" << e.path << "]";
827 ++it;
828 if (it!=navIndex.end() && elemCount<maxElemCount-1) tsidx << ","; // not last entry
829 tsidx << "\n";
830
831 elemCount++;
832 if (it!=navIndex.end() && elemCount>=maxElemCount) // switch to new sub-index
833 {
834 tsidx << "};\n";
835 elemCount=0;
836 tsidx.close();
837 subIndex++;
838 QCString fileName = htmlOutput+"/navtreeindex"+QCString().setNum(subIndex)+".js";
839 tsidx = Portable::openOutputStream(fileName);
840 if (!tsidx.is_open()) break;
841 tsidx << "var NAVTREEINDEX" << subIndex << " =\n";
842 tsidx << "{\n";
843 }
844 }
845 tsidx << "};\n";
846 t << "\n];\n";
847 }
848 t << "\nvar SYNCONMSG = '" << theTranslator->trPanelSynchronisationTooltip(FALSE) << "';";
849 t << "\nvar SYNCOFFMSG = '" << theTranslator->trPanelSynchronisationTooltip(TRUE) << "';";
850 t << "\nvar LISTOFALLMEMBERS = '" << theTranslator->trListOfAllMembers() << "';";
851 }
852
853 auto &mgr = ResourceMgr::instance();
854 {
855 std::ofstream fn = Portable::openOutputStream(htmlOutput+"/navtree.js");
856 if (fn.is_open())
857 {
858 TextStream t(&fn);
859 t << substitute(
860 substitute(mgr.getAsString("navtree.js"),
861 "$TREEVIEW_WIDTH", QCString().setNum(Config_getInt(TREEVIEW_WIDTH))),
862 "$PROJECTID",getProjectId());
863 }
864 }
865}
866
867//-----------------------------------------------------------
868
869// new style scripts
871{
872 QCString htmlOutput = Config_getString(HTML_OUTPUT);
873
874 // generate navtree.js & navtreeindex.js
875 generateJSNavTree(p->indentNodes[0]);
876}
877
878// write tree inside page
880{
881 int preferredNumEntries = Config_getInt(HTML_INDEX_NUM_ENTRIES);
882 t << "<div class=\"directory\">\n";
883 int d=1, depth=1;
884 for (const auto &n : p->indentNodes[0])
885 {
886 if (!n->children.empty())
887 {
888 d = n->computeTreeDepth(2);
889 if (d>depth) depth=d;
890 }
891 }
892 int preferredDepth = depth;
893 // write level selector
894 if (depth>1)
895 {
896 t << "<div class=\"levels\">[";
897 t << theTranslator->trDetailLevel();
898 t << " ";
899 for (int i=1;i<=depth;i++)
900 {
901 t << "<span onclick=\"javascript:dynsection.toggleLevel(" << i << ");\">" << i << "</span>";
902 }
903 t << "]</div>";
904
905 if (preferredNumEntries>0)
906 {
907 preferredDepth=1;
908 for (int i=1;i<=depth;i++)
909 {
910 int num=0;
911 for (const auto &n : p->indentNodes[0])
912 {
913 num+=n->numNodesAtLevel(0,i);
914 }
915 if (num<=preferredNumEntries)
916 {
917 preferredDepth=i;
918 }
919 else
920 {
921 break;
922 }
923 }
924 }
925 }
926 //printf("preferred depth=%d\n",preferredDepth);
927
928 if (!p->indentNodes[0].empty())
929 {
930 t << "<table class=\"directory\">\n";
931 int index=0;
932 p->generateTree(t,p->indentNodes[0],0,preferredDepth,index);
933 t << "</table>\n";
934 }
935
936 t << "</div><!-- directory -->\n";
937}
938
939// write old style index.html and tree.html
A abstract class representing of a compound symbol.
Definition classdef.h:104
@ Interface
Definition classdef.h:112
@ Exception
Definition classdef.h:115
virtual CompoundType compoundType() const =0
Returns the type of compound this is, i.e.
The common base class of all entity definitions found in the sources.
Definition definition.h:76
virtual SrcLangExt getLanguage() const =0
Returns the programming language this definition was written in.
virtual int briefLine() const =0
virtual QCString briefDescription(bool abbreviate=FALSE) const =0
virtual QCString getSourceFileBase() const =0
virtual QCString briefFile() const =0
virtual QCString getOutputFileBase() const =0
Class representing the abstract syntax tree of a documentation block.
Definition docnode.h:1466
DocNodeVariant root
Definition docnode.h:1491
static std::unique_ptr< PageDef > mainPage
Definition doxygen.h:101
static QCString htmlFileExtension
Definition doxygen.h:122
std::unique_ptr< Private > p
Definition ftvhelp.h:69
void generateTreeView()
Definition ftvhelp.cpp:940
void decContentsDepth()
Definition ftvhelp.cpp:154
void finalize()
Definition ftvhelp.cpp:134
void initialize()
Definition ftvhelp.cpp:126
FTVHelp(bool LTI)
Definition ftvhelp.cpp:120
void incContentsDepth()
Definition ftvhelp.cpp:143
void addContentsItem(bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const QCString &nameAsHtml=QCString())
Definition ftvhelp.cpp:186
void generateTreeViewScripts()
Definition ftvhelp.cpp:870
void generateTreeViewInline(TextStream &t)
Definition ftvhelp.cpp:879
A model of a file symbol.
Definition filedef.h:99
Generator for HTML code fragments.
Definition htmlgen.h:26
Concrete visitor implementation for HTML output.
static LayoutDocManager & instance()
Returns a reference to this singleton.
Definition layout.cpp:1435
LayoutNavEntry * rootNavEntry() const
returns the (invisible) root of the navigation tree.
Definition layout.cpp:1446
Definition ftvhelp.cpp:530
Class representing a list of different code generators.
Definition outputlist.h:165
void add(OutputCodeIntfPtr &&p)
Definition outputlist.h:195
This is an alternative implementation of QCString.
Definition qcstring.h:101
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:241
char & at(size_t i)
Returns a reference to the character at index i.
Definition qcstring.h:593
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
QCString fill(char c, int len=-1)
Fills a string with a predefined character.
Definition qcstring.h:193
QCString & setNum(short n)
Definition qcstring.h:459
int findRev(char c, int index=-1, bool cs=TRUE) const
Definition qcstring.cpp:96
static ResourceMgr & instance()
Returns the one and only instance of this class.
Text streaming class that buffers data.
Definition textstream.h:36
Class managing a pool of worker threads.
Definition threadpool.h:48
auto queue(F &&f, Args &&... args) -> std::future< decltype(f(args...))>
Queue the callable function f for the threads to execute.
Definition threadpool.h:77
ClassDef * toClassDef(Definition *d)
#define Config_getInt(name)
Definition config.h:34
#define Config_getBool(name)
Definition config.h:33
#define Config_getString(name)
Definition config.h:32
constexpr DocNodeVariant * parent(DocNodeVariant *n)
returns the parent node of a given node n or nullptr if the node has no parent.
Definition docnode.h:1330
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, const DocOptions &options)
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:55
FileDef * toFileDef(Definition *d)
Definition filedef.cpp:1954
static void generateLink(yyscan_t yyscanner, OutputCodeList &ol, const QCString &lname)
static bool dupOfParent(const FTVNodePtr &n)
Definition ftvhelp.cpp:546
static bool generateJSTree(NavIndexEntryList &navIndex, TextStream &t, const FTVNodes &nl, int level, bool &first)
Definition ftvhelp.cpp:614
static int folderId
Definition ftvhelp.cpp:43
static void generateJSLink(TextStream &t, const FTVNodePtr &n)
Definition ftvhelp.cpp:554
static QCString node2URL(const FTVNodePtr &n, bool overruleFile=FALSE, bool srcLink=FALSE)
Definition ftvhelp.cpp:216
static void generateBriefDoc(TextStream &t, const Definition *def)
Definition ftvhelp.cpp:329
static void collectJSTreeFiles(const FTVNodes &nl, JSTreeFiles &files)
Definition ftvhelp.cpp:591
static char compoundIcon(const ClassDef *cd)
Definition ftvhelp.cpp:358
static std::mutex g_navIndexMutex
Definition ftvhelp.cpp:612
static QCString pathToNode(const FTVNodePtr &leaf, const FTVNodePtr &n)
Definition ftvhelp.cpp:533
std::vector< FTVNodePtr > FTVNodes
Definition ftvhelp.cpp:49
std::weak_ptr< FTVNode > FTVNodeWeakPtr
Definition ftvhelp.cpp:48
static void generateIndent(TextStream &t, const FTVNodePtr &n, bool opened)
Definition ftvhelp.cpp:260
std::shared_ptr< FTVNode > FTVNodePtr
Definition ftvhelp.cpp:47
static void generateJSTreeFiles(NavIndexEntryList &navIndex, TextStream &t, const FTVNodes &nodeList)
Definition ftvhelp.cpp:695
std::vector< JSTreeFile > JSTreeFiles
Definition ftvhelp.cpp:589
static void generateJSNavTree(const FTVNodes &nodeList)
Definition ftvhelp.cpp:746
static QCString convertFileId2Var(const QCString &fileId)
Definition ftvhelp.cpp:573
static QCString generateIndentLabel(const FTVNodePtr &n, int level)
Definition ftvhelp.cpp:248
constexpr auto JAVASCRIPT_LICENSE_TEXT
Definition ftvhelp.h:72
Translator * theTranslator
Definition language.cpp:71
std::ofstream openOutputStream(const QCString &name, bool append=false)
Definition portable.cpp:649
Portable versions of functions that are platform dependent.
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition qcstring.cpp:482
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
#define ASSERT(x)
Definition qcstring.h:39
void generateTree(TextStream &t, const FTVNodes &nl, int level, int maxLevel, int &index)
Definition ftvhelp.cpp:379
void generateLink(TextStream &t, const FTVNodePtr &n)
Definition ftvhelp.cpp:282
std::vector< FTVNodes > indentNodes
Definition ftvhelp.cpp:108
Private(bool TLI)
Definition ftvhelp.cpp:107
FTVNode(bool dir, const QCString &r, const QCString &f, const QCString &a, const QCString &n, bool sepIndex, bool navIndex, const Definition *df, const QCString &nameAsHtml_)
Definition ftvhelp.cpp:53
bool separateIndex
Definition ftvhelp.cpp:70
bool isLast
Definition ftvhelp.cpp:60
const Definition * def
Definition ftvhelp.cpp:72
bool addToNavIndex
Definition ftvhelp.cpp:71
FTVNodeWeakPtr parent
Definition ftvhelp.cpp:69
FTVNodes children
Definition ftvhelp.cpp:68
QCString ref
Definition ftvhelp.cpp:62
int numNodesAtLevel(int level, int maxLevel) const
Definition ftvhelp.cpp:89
QCString anchor
Definition ftvhelp.cpp:64
QCString file
Definition ftvhelp.cpp:63
int computeTreeDepth(int level) const
Definition ftvhelp.cpp:75
QCString name
Definition ftvhelp.cpp:65
bool isDir
Definition ftvhelp.cpp:61
int index
Definition ftvhelp.cpp:67
QCString nameAsHtml
Definition ftvhelp.cpp:66
JSTreeFile(const QCString &fi, const FTVNodePtr &n)
Definition ftvhelp.cpp:584
FTVNodePtr node
Definition ftvhelp.cpp:586
QCString fileId
Definition ftvhelp.cpp:585
Base class for the layout of a navigation item at the top of the HTML pages.
Definition layout.h:156
QCString title() const
Definition layout.h:216
LayoutNavEntry * find(LayoutNavEntry::Kind k, const QCString &file=QCString()) const
Definition layout.cpp:133
Definition ftvhelp.cpp:523
QCString url
Definition ftvhelp.cpp:525
QCString path
Definition ftvhelp.cpp:526
NavIndexEntry(const QCString &u, const QCString &p)
Definition ftvhelp.cpp:524
QCString externalRef(const QCString &relPath, const QCString &ref, bool href)
Definition util.cpp:5665
QCString convertToJSString(const QCString &s, bool keepEntities, bool singleQuotes)
Definition util.cpp:3944
bool mainPageHasTitle()
Definition util.cpp:6194
QCString convertToHtml(const QCString &s, bool keepEntities)
Definition util.cpp:3884
QCString relativePathToRoot(const QCString &name)
Definition util.cpp:3500
bool fileVisibleInIndex(const FileDef *fd, bool &genSourceFile)
Definition util.cpp:5999
QCString stripScope(const QCString &name)
Definition util.cpp:3700
QCString getProjectId()
Definition util.cpp:6721
QCString externalLinkTarget(const bool parent)
Definition util.cpp:5621
void addHtmlExtensionIfMissing(QCString &fName)
Definition util.cpp:4823
A bunch of utility functions.