ftvhelp.cpp 文件参考

#include <stdio.h>
#include <stdlib.h>
#include <algorithm>
#include "ftvhelp.h"
#include "config.h"
#include "message.h"
#include "doxygen.h"
#include "language.h"
#include "htmlgen.h"
#include "layout.h"
#include "pagedef.h"
#include "docparser.h"
#include "htmldocvisitor.h"
#include "filedef.h"
#include "classdef.h"
#include "util.h"
#include "resourcemgr.h"

ftvhelp.cpp 的引用(Include)关系图:

浏览源代码.

类
struct	FTVNode
struct	NavIndexEntry
class	NavIndexEntryList

函数
static QCString	node2URL (const FTVNode *n, bool overruleFile=FALSE, bool srcLink=FALSE)
static void	generateBriefDoc (TextStream &t, const Definition *def)
static char	compoundIcon (const ClassDef *cd)
static QCString	pathToNode (const FTVNode *leaf, const FTVNode *n)
static bool	dupOfParent (const FTVNode *n)
static void	generateJSLink (TextStream &t, const FTVNode *n)
static QCString	convertFileId2Var (const QCString &fileId)
static bool	generateJSTree (NavIndexEntryList &navIndex, TextStream &t, const std::vector< FTVNode * > &nl, int level, bool &first)
static void	generateJSNavTree (const std::vector< FTVNode * > &nodeList)

变量
static int	folderId =1
const char *	JAVASCRIPT_LICENSE_TEXT

函数说明

compoundIcon()

static char compoundIcon ( const ClassDef *  cd )

static

在文件 ftvhelp.cpp 第 365 行定义.

{
  char icon='C';
  if (cd->getLanguage() == SrcLangExt_Slice)
  {
    if (cd->compoundType()==ClassDef::Interface)
    {
      icon='I';
    }
    else if (cd->compoundType()==ClassDef::Struct)
    {
      icon='S';
    }
    else if (cd->compoundType()==ClassDef::Exception)
    {
      icon='E';
    }
  }
  return icon;
}

引用了 ClassDef::compoundType(), ClassDef::Exception, Definition::getLanguage(), ClassDef::Interface, SrcLangExt_Slice , 以及 ClassDef::Struct.

被这些函数引用 FTVHelp::generateTree().

convertFileId2Var()

static QCString convertFileId2Var ( const QCString &  fileId )

static

在文件 ftvhelp.cpp 第 555 行定义.

{
  QCString varId = fileId;
  int i=varId.findRev('/');
  if (i>=0) varId = varId.mid(i+1);
  return substitute(varId,"-","_");
}

引用了 QCString::findRev(), QCString::mid() , 以及 substitute().

被这些函数引用 generateJSTree().

dupOfParent()

static bool dupOfParent ( const FTVNode *  n )

static

在文件 ftvhelp.cpp 第 533 行定义.

{
  if (n->parent==0) return FALSE;
  if (n->file==n->parent->file) return TRUE;
  return FALSE;
}

引用了 FALSE, FTVNode::file, FTVNode::parent , 以及 TRUE.

被这些函数引用 generateJSTree().

generateBriefDoc()

static void generateBriefDoc ( TextStream &  t, const Definition *  def  )

static

在文件 ftvhelp.cpp 第 347 行定义.

{
  QCString brief = def->briefDescription(TRUE);
  //printf("*** %p: generateBriefDoc(%s)='%s'\n",def,qPrint(def->name()),qPrint(brief));
  if (!brief.isEmpty())
  {
    std::unique_ptr<IDocParser> parser { createDocParser() };
    std::unique_ptr<DocRoot>    root   { validatingParseDoc(*parser.get(),
                                         def->briefFile(),def->briefLine(),
                                         def,0,brief,FALSE,FALSE,
                                         QCString(),TRUE,TRUE,Config_getBool(MARKDOWN_SUPPORT)) };
    QCString relPath = relativePathToRoot(def->getOutputFileBase());
    HtmlCodeGenerator htmlGen(t,relPath);
    auto visitor = std::make_unique<HtmlDocVisitor>(t,htmlGen,def);
    root->accept(visitor.get());
  }
}

引用了 Definition::briefDescription(), Definition::briefFile(), Definition::briefLine(), Config_getBool, createDocParser(), FALSE, Definition::getOutputFileBase(), QCString::isEmpty(), relativePathToRoot(), TRUE , 以及 validatingParseDoc().

被这些函数引用 FTVHelp::generateTree().

generateJSLink()

static void generateJSLink ( TextStream &  t, const FTVNode *  n  )

static

在文件 ftvhelp.cpp 第 540 行定义.

{
  if (n->file.isEmpty()) // no link
  {
    t << "\"" << convertToJSString(n->name) << "\", null, ";
  }
  else // link into other page
  {
    t << "\"" << convertToJSString(n->name) << "\", \"";
    t << externalRef("",n->ref,TRUE);
    t << node2URL(n);
    t << "\", ";
  }
}

引用了 convertToJSString(), externalRef(), FTVNode::file, QCString::isEmpty(), FTVNode::name, node2URL(), FTVNode::ref , 以及 TRUE.

被这些函数引用 generateJSTree().

generateJSNavTree()

static void generateJSNavTree ( const std::vector< FTVNode * > &  nodeList )

static

在文件 ftvhelp.cpp 第 653 行定义.

{
  QCString htmlOutput = Config_getString(HTML_OUTPUT);
  std::ofstream f(htmlOutput.str()+"/navtreedata.js",std::ofstream::out | std::ofstream::binary);
  NavIndexEntryList navIndex;
  if (f.is_open())
  {
    TextStream t(&f);
    //TextStream tidx(&fidx);
    //tidx << "var NAVTREEINDEX =\n";
    //tidx << "{\n";
    t << JAVASCRIPT_LICENSE_TEXT;
    t << "var NAVTREE =\n";
    t << "[\n";
    t << "  [ ";
    QCString projName = Config_getString(PROJECT_NAME);
    if (projName.isEmpty())
    {
      if (mainPageHasTitle()) // Use title of main page as root
      {
        t << "\"" << convertToJSString(Doxygen::mainPage->title()) << "\", ";
      }
      else // Use default section title as root
      {
        LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::MainPage);
        t << "\"" << convertToJSString(lne->title()) << "\", ";
      }
    }
    else // use PROJECT_NAME as root tree element
    {
      t << "\"" << convertToJSString(projName) << "\", ";
    }
    t << "\"index" << Doxygen::htmlFileExtension << "\", ";
 
    // add special entry for index page
    navIndex.emplace_back("index"+Doxygen::htmlFileExtension,"");
    // related page index is written as a child of index.html, so add this as well
    navIndex.emplace_back("pages"+Doxygen::htmlFileExtension,"");
 
    bool first=TRUE;
    generateJSTree(navIndex,t,nodeList,1,first);
 
    if (first)
      t << "]\n";
    else
      t << "\n  ] ]\n";
    t << "];\n\n";
 
    // write the navigation index (and sub-indices)
    std::sort(navIndex.begin(),navIndex.end(),[](const auto &n1,const auto &n2)
        { return !n1.url.isEmpty() && (n2.url.isEmpty() || (n1.url<n2.url)); });
 
    int subIndex=0;
    int elemCount=0;
    const int maxElemCount=250;
    std::ofstream tsidx(htmlOutput.str()+"/navtreeindex0.js",std::ofstream::out | std::ofstream::binary);
    if (tsidx.is_open())
    {
      t << "var NAVTREEINDEX =\n";
      t << "[\n";
      tsidx << "var NAVTREEINDEX" << subIndex << " =\n";
      tsidx << "{\n";
      first=TRUE;
      auto it = navIndex.begin();
      while (it!=navIndex.end())
      {
        const NavIndexEntry &e = *it;
        if (elemCount==0)
        {
          if (!first)
          {
            t << ",\n";
          }
          else
          {
            first=FALSE;
          }
          t << "\"" << e.url << "\"";
        }
        tsidx << "\"" << e.url << "\":[" << e.path << "]";
        ++it;
        if (it!=navIndex.end() && elemCount<maxElemCount-1) tsidx << ","; // not last entry
        tsidx << "\n";
 
        elemCount++;
        if (it!=navIndex.end() && elemCount>=maxElemCount) // switch to new sub-index
        {
          tsidx << "};\n";
          elemCount=0;
          tsidx.close();
          subIndex++;
          QCString fileName = htmlOutput+"/navtreeindex"+QCString().setNum(subIndex)+".js";
          tsidx.open(fileName.str(),std::ofstream::out | std::ofstream::binary);
          if (!tsidx.is_open()) break;
          tsidx << "var NAVTREEINDEX" << subIndex << " =\n";
          tsidx << "{\n";
        }
      }
      tsidx << "};\n";
      t << "\n];\n";
    }
    t << "\nvar SYNCONMSG = '"  << theTranslator->trPanelSynchronisationTooltip(FALSE) << "';";
    t << "\nvar SYNCOFFMSG = '" << theTranslator->trPanelSynchronisationTooltip(TRUE)  << "';";
  }
  ResourceMgr::instance().copyResource("navtree.js",htmlOutput);
}

引用了 Config_getString, convertToJSString(), ResourceMgr::copyResource(), FALSE, LayoutNavEntry::find(), generateJSTree(), Doxygen::htmlFileExtension, ResourceMgr::instance(), LayoutDocManager::instance(), QCString::isEmpty(), JAVASCRIPT_LICENSE_TEXT, Doxygen::mainPage, LayoutNavEntry::MainPage, mainPageHasTitle(), NavIndexEntry::path, LayoutDocManager::rootNavEntry(), QCString::setNum(), QCString::str(), theTranslator, LayoutNavEntry::title(), Translator::trPanelSynchronisationTooltip(), TRUE , 以及 NavIndexEntry::url.

被这些函数引用 FTVHelp::generateTreeViewScripts().

generateJSTree()

static bool generateJSTree ( NavIndexEntryList &  navIndex, TextStream &  t, const std::vector< FTVNode * > &  nl, int  level, bool &  first  )

static

在文件 ftvhelp.cpp 第 563 行定义.

{
  static QCString htmlOutput = Config_getString(HTML_OUTPUT);
  QCString indentStr;
  indentStr.fill(' ',level*2);
  bool found=FALSE;
  for (const auto &n : nl)
  {
    // terminate previous entry
    if (!first) t << ",\n";
    first=FALSE;
 
    // start entry
    if (!found)
    {
      t << "[\n";
    }
    found=TRUE;
 
    if (n->addToNavIndex) // add entry to the navigation index
    {
      if (n->def && n->def->definitionType()==Definition::TypeFile)
      {
        const FileDef *fd = toFileDef(n->def);
        bool doc,src;
        doc = fileVisibleInIndex(fd,src);
        if (doc)
        {
          navIndex.emplace_back(node2URL(n,TRUE,FALSE),pathToNode(n,n));
        }
        if (src)
        {
          navIndex.emplace_back(node2URL(n,TRUE,TRUE),pathToNode(n,n));
        }
      }
      else
      {
        navIndex.emplace_back(node2URL(n),pathToNode(n,n));
      }
    }
 
    if (n->separateIndex) // store items in a separate file for dynamic loading
    {
      bool firstChild=TRUE;
      t << indentStr << "  [ ";
      generateJSLink(t,n);
      if (!n->children.empty()) // write children to separate file for dynamic loading
      {
        QCString fileId = n->file;
        if (!n->anchor.isEmpty())
        {
          fileId+="_"+n->anchor;
        }
        if (dupOfParent(n))
        {
          fileId+="_dup";
        }
        QCString fileName = htmlOutput+"/"+fileId+".js";
        std::ofstream f(fileName.str(),std::ofstream::out | std::ofstream::binary);
        if (f.is_open())
        {
          TextStream tt(&f);
          tt << "var " << convertFileId2Var(fileId) << " =\n";
          generateJSTree(navIndex,tt,n->children,1,firstChild);
          tt << "\n];";
        }
        f.close();
        t << "\"" << fileId << "\" ]";
      }
      else // no children
      {
        t << "null ]";
      }
    }
    else // show items in this file
    {
      bool firstChild=TRUE;
      t << indentStr << "  [ ";
      generateJSLink(t,n);
      bool emptySection = !generateJSTree(navIndex,t,n->children,level+1,firstChild);
      if (emptySection)
        t << "null ]";
      else
        t << "\n" << indentStr << "  ] ]";
    }
  }
  return found;
}

引用了 Config_getString, convertFileId2Var(), dupOfParent(), FALSE, fileVisibleInIndex(), QCString::fill(), generateJSLink(), node2URL(), pathToNode(), QCString::str(), toFileDef(), TRUE , 以及 Definition::TypeFile.

被这些函数引用 generateJSNavTree().

node2URL()

static QCString node2URL ( const FTVNode *  n, bool  overruleFile = FALSE, bool  srcLink = FALSE  )

static

在文件 ftvhelp.cpp 第 239 行定义.

{
  QCString url = n->file;
  if (!url.isEmpty() && url.at(0)=='!')  // relative URL
  {
    // remove leading !
    url = url.mid(1);
  }
  else if (!url.isEmpty() && url.at(0)=='^') // absolute URL
  {
    // skip, keep ^ in the output
  }
  else // local file (with optional anchor)
  {
    if (overruleFile && n->def && n->def->definitionType()==Definition::TypeFile)
    {
      const FileDef *fd = toFileDef(n->def);
      if (srcLink)
      {
        url = fd->getSourceFileBase();
      }
      else
      {
        url = fd->getOutputFileBase();
      }
    }
    url = addHtmlExtensionIfMissing(url);
    if (!n->anchor.isEmpty()) url+="#"+n->anchor;
  }
  return url;
}

引用了 addHtmlExtensionIfMissing(), FTVNode::anchor, QCString::at(), FTVNode::def, Definition::definitionType(), FTVNode::file, FileDef::getOutputFileBase(), FileDef::getSourceFileBase(), QCString::isEmpty(), QCString::mid(), toFileDef() , 以及 Definition::TypeFile.

被这些函数引用 generateJSLink(), generateJSTree() , 以及 FTVHelp::generateLink().

pathToNode()

static QCString pathToNode ( const FTVNode *  leaf, const FTVNode *  n  )

static

在文件 ftvhelp.cpp 第 521 行定义.

{
  QCString result;
  if (n->parent)
  {
    result+=pathToNode(leaf,n->parent);
  }
  result+=QCString().setNum(n->index);
  if (leaf!=n) result+=",";
  return result;
}

引用了 FTVNode::index, FTVNode::parent , 以及 QCString::setNum().

被这些函数引用 generateJSTree().

变量说明

folderId

int folderId =1

static

在文件 ftvhelp.cpp 第 40 行定义.

被这些函数引用 FTVHelp::generateTree().

JAVASCRIPT_LICENSE_TEXT

const char* JAVASCRIPT_LICENSE_TEXT

初始值:

= R"LIC(/*
 @licstart  The following is the entire license notice for the JavaScript code in this file.
 
 The MIT License (MIT)
 
 Copyright (C) 1997-2020 by Dimitri van Heesch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 and associated documentation files (the "Software"), to deal in the Software without restriction,
 including without limitation the rights to use, copy, modify, merge, publish, distribute,
 sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or
 substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 @licend  The above is the entire license notice for the JavaScript code in this file
*/
)LIC"

在文件 ftvhelp.cpp 第 42 行定义.

被这些函数引用 generateJSNavTree() , 以及 writeMenuData().