definition.cpp 文件参考

#include <algorithm>
#include <iterator>
#include <unordered_map>
#include <string>
#include <ctype.h>
#include "md5.h"
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include "regex.h"
#include "config.h"
#include "definitionimpl.h"
#include "doxygen.h"
#include "language.h"
#include "message.h"
#include "portable.h"
#include "outputlist.h"
#include "code.h"
#include "util.h"
#include "groupdef.h"
#include "pagedef.h"
#include "section.h"
#include "htags.h"
#include "parserintf.h"
#include "debug.h"
#include "vhdldocgen.h"
#include "memberlist.h"
#include "namespacedef.h"
#include "filedef.h"
#include "dirdef.h"
#include "bufstr.h"
#include "reflist.h"
#include "utf8.h"

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

浏览源代码.

类
class	DefinitionImpl::IMPL
	Private data associated with a Symbol DefinitionImpl object. 更多...
struct	FilterCacheItem
class	FilterCache

函数
static bool	matchExcludedSymbols (const QCString &name)
static void	addToMap (const QCString &name, Definition *d)
static void	removeFromMap (const QCString &name, Definition *d)
bool	readCodeFragment (const QCString &fileName, int &startLine, int &endLine, QCString &result)
	Reads a fragment from file fileName starting with line startLine and ending with line endLine. 更多...
static MemberVector	refMapToVector (const std::unordered_map< std::string, const MemberDef * > &map)
static bool	stripWord (QCString &s, QCString w)
static QCString	abbreviate (const QCString &s, const QCString &name)
Definition *	toDefinition (DefinitionMutable *dm)
DefinitionMutable *	toDefinitionMutable (Definition *d)
DefinitionMutable *	toDefinitionMutable (const Definition *d)

变量
static FilterCache	g_filterCache

函数说明

abbreviate()

static QCString abbreviate ( const QCString &  s, const QCString &  name  )

static

在文件 definition.cpp 第 1592 行定义.

{
  QCString scopelessName=name;
  int i=scopelessName.findRev("::");
  if (i!=-1) scopelessName=scopelessName.mid(i+2);
  QCString result=s;
  result=result.stripWhiteSpace();
  // strip trailing .
  if (!result.isEmpty() && result.at(result.length()-1)=='.')
    result=result.left(result.length()-1);
 
  // strip any predefined prefix
  const StringVector &briefDescAbbrev = Config_getList(ABBREVIATE_BRIEF);
  for (const auto &p : briefDescAbbrev)
  {
    QCString str = substitute(p.c_str(),"$name",scopelessName); // replace $name with entity name
    str += " ";
    stripWord(result,str);
  }
 
  // capitalize first word
  if (!result.isEmpty())
  {
    char c=result[0];
    if (c>='a' && c<='z') c+='A'-'a';
    result[0]=c;
  }
  return result;
}

引用了 QCString::at(), Config_getList, QCString::findRev(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::mid(), DefinitionImpl::name(), QCString::stripWhiteSpace(), stripWord() , 以及 substitute().

被这些函数引用 DefinitionImpl::briefDescription(), DefinitionMixin< DirDef >::briefDescription() , 以及 DefinitionAliasMixin< ConceptDef >::briefDescription().

addToMap()

static void addToMap ( const QCString &  name, Definition *  d  )

static

在文件 definition.cpp 第 203 行定义.

{
  bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
  QCString symbolName = name;
  int index=computeQualifiedIndex(symbolName);
  if (!vhdlOpt && index!=-1) symbolName=symbolName.mid(index+2);
  if (!symbolName.isEmpty())
  {
    Doxygen::symbolMap->add(symbolName,d);
 
    d->_setSymbolName(symbolName);
  }
}

引用了 Definition::_setSymbolName(), SymbolMap< T >::add(), computeQualifiedIndex(), Config_getBool, QCString::isEmpty(), QCString::mid(), DefinitionImpl::name(), Doxygen::symbolMap , 以及 DefinitionImpl::symbolName().

被这些函数引用 DefinitionImpl::DefinitionImpl() , 以及 DefinitionAliasImpl::init().

matchExcludedSymbols()

static bool matchExcludedSymbols ( const QCString &  name )

static

在文件 definition.cpp 第 148 行定义.

{
  const StringVector &exclSyms = Config_getList(EXCLUDE_SYMBOLS);
  if (exclSyms.empty()) return FALSE; // nothing specified
  std::string symName = name.str();
  for (const auto &pat : exclSyms)
  {
    QCString pattern = pat.c_str();
    bool forceStart=FALSE;
    bool forceEnd=FALSE;
    if (pattern.at(0)=='^')
      pattern=pattern.mid(1),forceStart=TRUE;
    if (pattern.at(pattern.length()-1)=='$')
      pattern=pattern.left(pattern.length()-1),forceEnd=TRUE;
    if (pattern.find('*')!=-1) // wildcard mode
    {
      const reg::Ex re(substitute(pattern,"*",".*").str());
      reg::Match match;
      if (reg::search(symName,match,re)) // wildcard match
      {
        size_t ui = match.position();
        size_t pl = match.length();
        size_t sl = symName.length();
        if ((ui==0     || pattern.at(0)=='*'                  || (!isId(symName.at(ui-1))  && !forceStart)) &&
            (ui+pl==sl || pattern.at(pattern.length()-1)=='*' || (!isId(symName.at(ui+pl)) && !forceEnd))
           )
        {
          //printf("--> name=%s pattern=%s match at %d\n",qPrint(symName),qPrint(pattern),i);
          return TRUE;
        }
      }
    }
    else if (!pattern.isEmpty()) // match words
    {
      size_t i = symName.find(pattern.str());
      if (i!=std::string::npos) // we have a match!
      {
        size_t ui=i;
        size_t pl=pattern.length();
        size_t sl=symName.length();
        // check if it is a whole word match
        if ((ui==0     || (!isId(symName.at(ui-1))  && !forceStart)) &&
            (ui+pl==sl || (!isId(symName.at(ui+pl)) && !forceEnd))
           )
        {
          //printf("--> name=%s pattern=%s match at %d\n",qPrint(symName),qPrint(pattern),i);
          return TRUE;
        }
      }
    }
  }
  //printf("--> name=%s: no match\n",name);
  return FALSE;
}

引用了 QCString::at(), Config_getList, FALSE, QCString::find(), QCString::isEmpty(), isId(), QCString::left(), QCString::length(), reg::match(), QCString::mid(), DefinitionImpl::name(), reg::search(), QCString::str(), substitute() , 以及 TRUE.

被这些函数引用 DefinitionImpl::DefinitionImpl().

readCodeFragment()

bool readCodeFragment	(	const QCString &	fileName,
		int &	startLine,
		int &	endLine,
		QCString &	result
	)

Reads a fragment from file fileName starting with line startLine and ending with line endLine.

Reads a fragment of code from file fileName starting at line startLine and ending at line endLine (inclusive). The fragment is stored in result. If FALSE is returned the code fragment could not be found.

The file is scanned for a opening bracket ('{') from startLine onward The line actually containing the bracket is returned via startLine. The file is scanned for a closing bracket ('}') from endLine backward. The line actually containing the bracket is returned via endLine. Note that for VHDL code the bracket search is not done.

在文件 definition.cpp 第 719 行定义.

{
  //printf("readCodeFragment(%s,startLine=%d,endLine=%d)\n",fileName,startLine,endLine);
  static bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
  QCString filter = getFileFilter(fileName,TRUE);
  bool usePipe = !filter.isEmpty() && filterSourceFiles;
  int tabSize = Config_getInt(TAB_SIZE);
  SrcLangExt lang = getLanguageFromFileName(fileName);
  const int blockSize = 4096;
  BufStr str(blockSize);
  g_filterCache.getFileContents(fileName,str);
 
  bool found = lang==SrcLangExt_VHDL   ||
               lang==SrcLangExt_Python ||
               lang==SrcLangExt_Fortran;
               // for VHDL, Python, and Fortran no bracket search is possible
  char *p=str.data();
  if (p)
  {
    char c=0;
    int col=0;
    int lineNr=1;
    // skip until the startLine has reached
    while (lineNr<startLine && *p)
    {
      while ((c=*p++)!='\n' && c!=0) /* skip */;
      lineNr++;
      if (found && c == '\n') c = '\0';
    }
    if (*p)
    {
      // skip until the opening bracket or lonely : is found
      char cn=0;
      while (lineNr<=endLine && *p && !found)
      {
        int pc=0;
        while ((c=*p++)!='{' && c!=':' && c!=0)
        {
          //printf("parsing char '%c'\n",c);
          if (c=='\n')
          {
            lineNr++,col=0;
          }
          else if (c=='\t')
          {
            col+=tabSize - (col%tabSize);
          }
          else if (pc=='/' && c=='/') // skip single line comment
          {
            while ((c=*p++)!='\n' && c!=0) pc=c;
            if (c=='\n') lineNr++,col=0;
          }
          else if (pc=='/' && c=='*') // skip C style comment
          {
            while (((c=*p++)!='/' || pc!='*') && c!=0)
            {
              if (c=='\n') lineNr++,col=0;
              pc=c;
            }
          }
          else
          {
            col++;
          }
          pc = c;
        }
        if (c==':')
        {
          cn=*p++;
          if (cn!=':') found=TRUE;
        }
        else if (c=='{')
        {
          found=TRUE;
        }
      }
      //printf(" -> readCodeFragment(%s,%d,%d) lineNr=%d\n",fileName,startLine,endLine,lineNr);
      if (found)
      {
        // For code with more than one line,
        // fill the line with spaces until we are at the right column
        // so that the opening brace lines up with the closing brace
        if (endLine!=startLine)
        {
          QCString spaces;
          spaces.fill(' ',col);
          result+=spaces;
        }
        // copy until end of line
        if (c) result+=c;
        startLine=lineNr;
        if (c==':')
        {
          result+=cn;
          if (cn=='\n') lineNr++;
        }
        char lineStr[blockSize];
        do
        {
          //printf("reading line %d in range %d-%d\n",lineNr,startLine,endLine);
          int size_read;
          do
          {
            // read up to maxLineLength-1 bytes, the last byte being zero
            int i=0;
            while ((c=*p++) && i<blockSize-1)
            {
              lineStr[i++]=c;
              if (c=='\n') break; // stop at end of the line
            }
            lineStr[i]=0;
            size_read=i;
            result+=lineStr; // append line to the output
          } while (size_read == (blockSize-1)); // append more if line does not fit in buffer
          lineNr++;
        } while (lineNr<=endLine && *p);
 
        // strip stuff after closing bracket
        int newLineIndex = result.findRev('\n');
        int braceIndex   = result.findRev('}');
        if (braceIndex > newLineIndex)
        {
          result.truncate((uint)braceIndex+1);
        }
        endLine=lineNr-1;
      }
    }
    if (usePipe)
    {
      Debug::print(Debug::FilterOutput, 0, "Filter output\n");
      Debug::print(Debug::FilterOutput,0,"-------------\n%s\n-------------\n",qPrint(result));
    }
  }
  result = transcodeCharacterStringToUTF8(result);
  if (!result.isEmpty() && result.at(result.length()-1)!='\n') result += "\n";
  //printf("readCodeFragment(%d-%d)=%s\n",startLine,endLine,qPrint(result));
  return found;
}

引用了 QCString::at(), Config_getBool, Config_getInt, BufStr::data(), QCString::fill(), Debug::FilterOutput, QCString::findRev(), g_filterCache, FilterCache::getFileContents(), getFileFilter(), getLanguageFromFileName(), QCString::isEmpty(), QCString::length(), Debug::print(), qPrint(), SrcLangExt_Fortran, SrcLangExt_Python, SrcLangExt_VHDL, transcodeCharacterStringToUTF8(), TRUE , 以及 QCString::truncate().

被这些函数引用 VhdlDocGen::createFlowChart(), MemberContext::Private::createSourceCode() , 以及 DefinitionImpl::writeInlineCode().

refMapToVector()

static MemberVector refMapToVector ( const std::unordered_map< std::string, const MemberDef * > &  map )

inlinestatic

在文件 definition.cpp 第 1009 行定义.

{
  // convert map to a vector of values
  MemberVector result;
  std::transform(map.begin(),map.end(),      // iterate over map
                 std::back_inserter(result), // add results to vector
                 [](const auto &item)
                 { return item.second; }     // extract value to add from map Key,Value pair
                );
  // and sort it
  std::sort(result.begin(),result.end(),
              [](const auto &m1,const auto &m2) { return genericCompareMembers(m1,m2)<0; });
  return result;
}

引用了 MemberVector::begin() , 以及 MemberVector::end().

被这些函数引用 DefinitionImpl::_writeSourceRefList(), DefinitionImpl::getReferencedByMembers() , 以及 DefinitionImpl::getReferencesMembers().

removeFromMap()

static void removeFromMap ( const QCString &  name, Definition *  d  )

static

在文件 definition.cpp 第 217 行定义.

{
  Doxygen::symbolMap->remove(name,d);
}

引用了 DefinitionImpl::name(), SymbolMap< T >::remove() , 以及 Doxygen::symbolMap.

被这些函数引用 DefinitionAliasImpl::deinit() , 以及 DefinitionImpl::~DefinitionImpl().

stripWord()

static bool stripWord ( QCString &  s, QCString  w  )

static

在文件 definition.cpp 第 1579 行定义.

{
  bool success=FALSE;
  if (s.left(w.length())==w)
  {
    success=TRUE;
    s=s.right(s.length()-w.length());
  }
  return success;
}

引用了 FALSE, QCString::left(), QCString::length(), QCString::right() , 以及 TRUE.

被这些函数引用 abbreviate().

toDefinition()

Definition* toDefinition

(

DefinitionMutable *

dm

)

在文件 definition.cpp 第 1950 行定义.

{
  if (dm==0) return 0;
  return dm->toDefinition_();
}

引用了 DefinitionMutable::toDefinition_().

被这些函数引用 buildScopeFromQualifiedName(), computeTooltipTexts(), findScopeFromQualifiedName(), toClassDef(), toConceptDef(), toMemberDef(), toNamespaceDef() , 以及 MemberList::writeDocumentationPage().

toDefinitionMutable() [1/2]

DefinitionMutable* toDefinitionMutable

(

const Definition *

d

)

在文件 definition.cpp 第 1962 行定义.

{
  return toDefinitionMutable(const_cast<Definition*>(d));
}

引用了 toDefinitionMutable().

toDefinitionMutable() [2/2]

DefinitionMutable* toDefinitionMutable

(

Definition *

d

)

在文件 definition.cpp 第 1956 行定义.

{
  if (d==0) return 0;
  return d->toDefinitionMutable_();
}

引用了 Definition::toDefinitionMutable_().

被这些函数引用 addConceptToContext(), buildNamespaceList(), buildScopeFromQualifiedName(), computeTooltipTexts(), createTagLessInstance(), resolveClassNestingRelations() , 以及 toDefinitionMutable().

变量说明

g_filterCache

FilterCache g_filterCache

static

在文件 definition.cpp 第 703 行定义.

被这些函数引用 readCodeFragment().