CitationManager类 参考

Citation manager class. 更多...

#include <cite.h>

类
struct	Private

Public 成员函数
void	insert (const QCString &label)
	Insert a citation identified by label into the database 更多...
const CiteInfo *	find (const QCString &label) const
	Return the citation info for a given label. 更多...
void	generatePage ()
	Generate the citations page 更多...
void	clear ()
	clears the database 更多...
bool	isEmpty () const
	return TRUE if there are no citations. 更多...
QCString	latexBibFiles ()
	lists the bibtex cite files in a comma separated list 更多...
QCString	fileName () const
QCString	anchorPrefix () const

静态 Public 成员函数
static CitationManager &	instance ()

Private 成员函数
	CitationManager ()
	Create the database, with an expected maximum of size entries 更多...
void	insertCrossReferencesForBibFile (const QCString &bibFile)

Private 属性
std::unique_ptr< Private >	p

详细描述

Citation manager class.

This class provides access do the database of bibliographic references through the bibtex backend.

在文件 cite.h 第 37 行定义.

构造及析构函数说明

CitationManager()

CitationManager::CitationManager ( )

private

Create the database, with an expected maximum of size entries

在文件 cite.cpp 第 62 行定义.

                                 : p(new Private)
{
}

成员函数说明

anchorPrefix()

QCString CitationManager::anchorPrefix

(

)

const

在文件 cite.cpp 第 101 行定义.

{
  return "CITEREF_";
}

被这些函数引用 DocAnchor::DocAnchor(), DocCite::DocCite() , 以及 LatexDocVisitor::visit().

clear()

void CitationManager::clear

(

)

clears the database

在文件 cite.cpp 第 85 行定义.

{
  p->entries.clear();
}

引用了 p.

被这些函数引用 clearAll().

fileName()

QCString CitationManager::fileName

(

)

const

在文件 cite.cpp 第 96 行定义.

{
  return "citelist";
}

被这些函数引用 DocAnchor::DocAnchor(), DocCite::DocCite() , 以及 generatePage().

find()

const CiteInfo * CitationManager::find

(

const QCString &

label

)

const

Return the citation info for a given label.

Ownership of the info stays with the manager.

在文件 cite.cpp 第 75 行定义.

{
  auto it = p->entries.find(label.str());
  if (it!=p->entries.end())
  {
    return it->second.get();
  }
  return 0;
}

引用了 p , 以及 QCString::str().

被这些函数引用 DocAnchor::DocAnchor() , 以及 DocCite::DocCite().

generatePage()

void CitationManager::generatePage

(

)

Generate the citations page

在文件 cite.cpp 第 192 行定义.

{
  //printf("** CitationManager::generatePage() count=%d\n",m_ordering.count());
 
  // do not generate an empty citations page
  if (isEmpty()) return; // nothing to cite
 
  bool citeDebug = Debug::isFlagSet(Debug::Cite);
 
  // 0. add cross references from the bib files to the cite dictionary
  const StringVector &citeDataList = Config_getList(CITE_BIB_FILES);
  for (const auto &bibdata : citeDataList)
  {
    QCString bibFile = bibdata.c_str();
    if (!bibFile.isEmpty() && bibFile.right(4)!=".bib") bibFile+=".bib";
    insertCrossReferencesForBibFile(bibFile);
  }
 
  // 1. generate file with markers and citations to OUTPUT_DIRECTORY
  QCString outputDir = Config_getString(OUTPUT_DIRECTORY);
  QCString citeListFile = outputDir+"/citelist.doc";
  {
    std::ofstream t(citeListFile.str(),std::ofstream::out | std::ofstream::binary);
    if (!t.is_open())
    {
      err("could not open file %s for writing\n",qPrint(citeListFile));
    }
    t << "<!-- BEGIN CITATIONS -->\n";
    t << "<!--\n";
    for (const auto &it : p->entries)
    {
      t << "\\citation{" << it.second->label() << "}\n";
    }
    t << "-->\n";
    t << "<!-- END CITATIONS -->\n";
    t << "<!-- BEGIN BIBLIOGRAPHY -->\n";
    t << "<!-- END BIBLIOGRAPHY -->\n";
    t.close();
  }
 
  // 2. generate bib2xhtml
  QCString bib2xhtmlFile  = outputDir+"/bib2xhtml.pl";
  ResourceMgr::instance().copyResource("bib2xhtml.pl",outputDir);
 
  // 3. generate doxygen.bst
  QCString doxygenBstFile = outputDir+"/doxygen.bst";
  ResourceMgr::instance().copyResource("doxygen.bst",outputDir);
 
  // 4. for all formats we just copy the bib files to as special output directory
  //    so bibtex can find them without path (bibtex doesn't support paths or
  //    filenames with spaces!)
  //    Strictly not required when only latex is generated
  QCString bibOutputDir = outputDir+"/"+bibTmpDir;
  QCString bibOutputFiles = "";
  Dir thisDir;
  if (!thisDir.exists(bibOutputDir.str()) && !thisDir.mkdir(bibOutputDir.str()))
  {
    err("Failed to create temporary output directory '%s', skipping citations\n",qPrint(bibOutputDir));
    return;
  }
  int i = 0;
  for (const auto &bibdata : citeDataList)
  {
    QCString bibFile = bibdata.c_str();
    if (!bibFile.isEmpty() && bibFile.right(4)!=".bib") bibFile+=".bib";
    FileInfo fi(bibFile.str());
    if (fi.exists())
    {
      if (!bibFile.isEmpty())
      {
        ++i;
        copyFile(bibFile,bibOutputDir + bibTmpFile + QCString().setNum(i) + ".bib");
        bibOutputFiles = bibOutputFiles + " " + bibTmpDir + bibTmpFile + QCString().setNum(i) + ".bib";
      }
    }
  }
 
  std::string oldDir = Dir::currentDirPath();
  Dir::setCurrent(outputDir.str());
 
  // 5. run bib2xhtml perl script on the generated file which will insert the
  //    bibliography in citelist.doc
  int exitCode;
  Portable::sysTimerStop();
  QCString perlArgs = "\""+bib2xhtmlFile+"\" "+bibOutputFiles+" \""+ citeListFile+"\"";
  if (citeDebug) perlArgs+=" -d";
  if ((exitCode=Portable::system("perl",perlArgs)) != 0)
  {
    err("Problems running bibtex. Verify that the command 'perl --version' works from the command line. Exit code: %d\n",
        exitCode);
  }
  Portable::sysTimerStop();
 
  Dir::setCurrent(oldDir);
 
  // 6. read back the file
  QCString doc;
  {
    std::ifstream f(citeListFile.str(),std::ifstream::in);
    if (!f.is_open())
    {
      err("could not open file %s for reading\n",qPrint(citeListFile));
    }
 
    bool insideBib=FALSE;
    //printf("input=[%s]\n",qPrint(input));
    std::string lineStr;
    while (getline(f,lineStr))
    {
      QCString line(lineStr);
      //printf("pos=%d s=%d line=[%s]\n",pos,s,qPrint(line));
 
      if      (line.find("<!-- BEGIN BIBLIOGRAPHY")!=-1) insideBib=TRUE;
      else if (line.find("<!-- END BIBLIOGRAPH")!=-1)    insideBib=FALSE;
      // determine text to use at the location of the @cite command
      if (insideBib && (i=line.find("name=\"CITEREF_"))!=-1)
      {
        int j=line.find("\">[");
        int k=line.find("]</a>");
        if (j!=-1 && k!=-1)
        {
          uint ui=(uint)i;
          uint uj=(uint)j;
          uint uk=(uint)k;
          QCString label = line.mid(ui+14,uj-ui-14);
          QCString number = line.mid(uj+2,uk-uj-1);
          label = substitute(substitute(label,"&ndash;","--"),"&mdash;","---");
          line = line.left(ui+14) + label + line.right(line.length()-uj);
          auto it = p->entries.find(label.str());
          //printf("label='%s' number='%s' => %p\n",qPrint(label),qPrint(number),it->second.get());
          if (it!=p->entries.end())
          {
            it->second->setText(number);
          }
        }
      }
      if (insideBib) doc+=line+"\n";
    }
    //printf("doc=[%s]\n",qPrint(doc));
  }
 
  // 7. add it as a page
  addRelatedPage(fileName(),theTranslator->trCiteReferences(),doc,fileName(),1,1);
 
  // 8. for latex we just copy the bib files to the output and let
  //    latex do this work.
  if (Config_getBool(GENERATE_LATEX))
  {
    // copy bib files to the latex output dir
    QCString latexOutputDir = Config_getString(LATEX_OUTPUT)+"/";
    i = 0;
    for (const auto &bibdata : citeDataList)
    {
      QCString bibFile = bibdata.c_str();
      // Note: file can now have multiple dots
      if (!bibFile.isEmpty() && bibFile.right(4)!=".bib") bibFile+=".bib";
      FileInfo fi(bibFile.str());
      if (fi.exists())
      {
        if (!bibFile.isEmpty())
        {
          // bug_700510, multiple times the same name were overwriting; creating new names
          // also for names with spaces
          ++i;
          copyFile(bibFile,latexOutputDir + bibTmpFile + QCString().setNum(i) + ".bib");
        }
      }
      else
      {
        err("bib file %s not found!\n",qPrint(bibFile));
      }
    }
  }
 
  // 9. Remove temporary files
  if (!citeDebug)
  {
    thisDir.remove(citeListFile.str());
    thisDir.remove(doxygenBstFile.str());
    thisDir.remove(bib2xhtmlFile.str());
    // we might try to remove too many files as empty files didn't get a corresponding new file
    // but the remove function does not emit an error for it and we don't catch the error return
    // so no problem.
    for (size_t j = 1; j <= citeDataList.size(); j++)
    {
      QCString bibFile = bibOutputDir + bibTmpFile + QCString().setNum(static_cast<ulong>(j)) + ".bib";
      thisDir.remove(bibFile.str());
    }
    thisDir.rmdir(bibOutputDir.str());
  }
}

引用了 addRelatedPage(), bibTmpDir, bibTmpFile, Debug::Cite, Config_getBool, Config_getList, Config_getString, copyFile(), ResourceMgr::copyResource(), Dir::currentDirPath(), err(), FileInfo::exists(), Dir::exists(), FALSE, fileName(), QCString::find(), insertCrossReferencesForBibFile(), ResourceMgr::instance(), isEmpty(), QCString::isEmpty(), Debug::isFlagSet(), QCString::left(), QCString::length(), QCString::mid(), Dir::mkdir(), p, qPrint(), Dir::remove(), QCString::right(), Dir::rmdir(), Dir::setCurrent(), QCString::setNum(), QCString::str(), substitute(), Portable::system(), Portable::sysTimerStop(), theTranslator, Translator::trCiteReferences() , 以及 TRUE.

被这些函数引用 parseInput().

insert()

void CitationManager::insert

(

const QCString &

label

)

Insert a citation identified by label into the database

在文件 cite.cpp 第 66 行定义.

{
  p->entries.insert(
      std::make_pair(
        label.str(),
        std::make_unique<CiteInfoImpl>(label)
      ));
}

引用了 p , 以及 QCString::str().

被这些函数引用 insertCrossReferencesForBibFile().

insertCrossReferencesForBibFile()

void CitationManager::insertCrossReferencesForBibFile ( const QCString &  bibFile )

private

在文件 cite.cpp 第 106 行定义.

{
  // sanity checks
  if (bibFile.isEmpty())
  {
    return;
  }
  FileInfo fi(bibFile.str());
  if (!fi.exists())
  {
    err("bib file %s not found!\n",qPrint(bibFile));
    return;
  }
  std::ifstream f(bibFile.str(), std::ifstream::in);
  if (!f.is_open())
  {
    err("could not open file %s for reading\n",qPrint(bibFile));
    return;
  }
 
  // search for citation cross references
  QCString citeName;
 
  std::string lineStr;
  while (getline(f,lineStr))
  {
    int i;
    QCString line(lineStr);
    if (line.stripWhiteSpace().startsWith("@"))
    {
      // assumption entry like: "@book { name," or "@book { name" (spaces optional)
      int j = line.find('{');
      // when no {, go hunting for it
      while (j==-1 && getline(f,lineStr))
      {
        line = lineStr;
        j = line.find('{');
      }
      // search for the name
      citeName = "";
      if (!f.eof() && j!=-1) // to prevent something like "@manual ," and no { found
      {
        int k = line.find(',',j);
        j++;
        // found a line "@....{.....,...." or "@.....{....."
        //                     ^=j  ^=k               ^=j   k=-1
        while (!f.eof() && citeName.isEmpty())
        {
          if (k!=-1)
          {
            citeName = line.mid((uint)(j),(uint)(k-j));
          }
          else
          {
            citeName = line.mid((uint)(j));
          }
          citeName = citeName.stripWhiteSpace();
          j = 0;
          if (citeName.isEmpty() && getline(f,lineStr))
          {
            line = lineStr;
            k = line.find(',');
          }
        }
      }
      //printf("citeName = #%s#\n",qPrint(citeName));
    }
    else if ((i=line.find("crossref"))!=-1 && !citeName.isEmpty()) /* assumption cross reference is on one line and the only item */
    {
      int j = line.find('{',i);
      int k = line.find('}',i);
      if (j>i && k>j)
      {
        QCString crossrefName = line.mid((uint)(j+1),(uint)(k-j-1));
        // check if the reference with the cross reference is used
        // insert cross reference when cross reference has not yet been added.
        if ((p->entries.find(citeName.str())!=p->entries.end()) &&
            (p->entries.find(crossrefName.str())==p->entries.end())) // not found yet
        {
          insert(crossrefName);
        }
      }
    }
  }
}

引用了 err(), FileInfo::exists(), QCString::find(), insert(), QCString::isEmpty(), QCString::mid(), p, qPrint(), QCString::startsWith(), QCString::str() , 以及 QCString::stripWhiteSpace().

被这些函数引用 generatePage().

instance()

CitationManager & CitationManager::instance ( )

static

在文件 cite.cpp 第 56 行定义.

{
  static CitationManager ct;
  return ct;
}

被这些函数引用 clearAll(), DocAnchor::DocAnchor(), DocCite::DocCite(), parseInput(), substituteLatexKeywords(), LatexDocVisitor::visit(), writeLatexMakefile() , 以及 writeMakeBat().

isEmpty()

bool CitationManager::isEmpty

(

)

const

return TRUE if there are no citations.

在文件 cite.cpp 第 90 行定义.

{
  size_t numFiles = Config_getList(CITE_BIB_FILES).size();
  return (numFiles==0 || p->entries.empty());
}

引用了 Config_getList , 以及 p.

被这些函数引用 generatePage(), writeLatexMakefile() , 以及 writeMakeBat().

latexBibFiles()

QCString CitationManager::latexBibFiles

(

)

lists the bibtex cite files in a comma separated list

在文件 cite.cpp 第 384 行定义.

{
  QCString result;
  const StringVector &citeDataList = Config_getList(CITE_BIB_FILES);
  int i = 0;
  for (const auto &bibdata : citeDataList)
  {
    QCString bibFile = bibdata.c_str();
    // Note: file can now have multiple dots
    if (!bibFile.isEmpty() && bibFile.right(4)!=".bib") bibFile+=".bib";
    FileInfo fi(bibFile.str());
    if (fi.exists())
    {
      if (!bibFile.isEmpty())
      {
        if (i) result += ",";
        i++;
        result += bibTmpFile;
        result += QCString().setNum(i);
      }
    }
  }
  return result;
}

引用了 bibTmpFile, Config_getList, FileInfo::exists(), QCString::isEmpty(), QCString::right(), QCString::setNum() , 以及 QCString::str().

类成员变量说明

p

std::unique_ptr<Private> CitationManager::p

private

在文件 cite.h 第 71 行定义.

被这些函数引用 clear(), find(), generatePage(), insert(), insertCrossReferencesForBibFile() , 以及 isEmpty().

---

该类的文档由以下文件生成:

• src/cite.h
• src/cite.cpp