Htags Struct Reference

This class is a namespace for HTAGS related functions. More...

#include <src/htags.h>

Static Public Member Functions
static bool	loadFilemap (const QCString &htmldir)
static QCString	path2URL (const QCString &path)
static bool	execute (const QCString &htmldir)

Static Public Attributes
static bool	useHtags = FALSE

Detailed Description

This class is a namespace for HTAGS related functions.

Definition at line 21 of file htags.h.

Member Function Documentation

execute()

bool Htags::execute ( const QCString & htmldir )

static

constructs command line of htags(1) and executes it.

Return values

TRUE	success
FALSE	an error has occurred.

Definition at line 38 of file htags.cpp.

{
  const StringVector &inputSource = Config_getList(INPUT);
  bool quiet = Config_getBool(QUIET);
  bool warnings = Config_getBool(WARNINGS);
  QCString htagsOptions = ""; //Config_getString(HTAGS_OPTIONS);
  QCString projectName = Config_getString(PROJECT_NAME);
  QCString projectNumber = Config_getString(PROJECT_NUMBER);
 
  if (inputSource.empty())
  {
    g_inputDir.setPath(Dir::currentDirPath());
  }
  else if (inputSource.size()==1)
  {
    g_inputDir.setPath(inputSource.back());
    if (!g_inputDir.exists())
      err("Cannot find directory {}. "
          "Check the value of the INPUT tag in the configuration file.\n",
          inputSource.back()
         );
  }
  else
  {
    err("If you use USE_HTAGS then INPUT should specify a single directory.\n");
    return FALSE;
  }
 
  /*
   * Construct command line for htags(1).
   */
  QCString commandLine = " -g -s -a -n ";
  if (!quiet)   commandLine += "-v ";
  if (warnings) commandLine += "-w ";
  if (!htagsOptions.isEmpty())
  {
    commandLine += ' ';
    commandLine += htagsOptions;
  }
  if (!projectName.isEmpty())
  {
    commandLine += "-t \"";
    commandLine += projectName;
    if (!projectNumber.isEmpty())
    {
      commandLine += '-';
      commandLine += projectNumber;
    }
    commandLine += "\" ";
  }
  commandLine += " \"" + htmldir + "\"";
  std::string oldDir = Dir::currentDirPath();
  Dir::setCurrent(g_inputDir.absPath());
  //printf("CommandLine=[%s]\n",qPrint(commandLine));
  bool result=Portable::system("htags",commandLine,FALSE)==0;
  if (!result)
  {
    err("Problems running htags. Check your installation\n");
  }
  Dir::setCurrent(oldDir);
  return result;
}

References Config_getBool, Config_getList, Config_getString, Dir::currentDirPath(), err, FALSE, g_inputDir, QCString::isEmpty(), Dir::setCurrent(), and Portable::system().

Referenced by generateOutput().

loadFilemap()

bool Htags::loadFilemap ( const QCString & htmlDir )

static

load filemap and make index.

Parameters

htmlDir

of HTML directory generated by htags(1).

Return values

TRUE	success
FALSE	error

Definition at line 107 of file htags.cpp.

{
  QCString fileMapName = htmlDir+"/HTML/FILEMAP";
  FileInfo fi(fileMapName.str());
  /*
   * Construct FILEMAP dictionary.
   *
   * In FILEMAP, URL includes 'html' suffix but we cut it off according
   * to the method of FileDef class.
   *
   * FILEMAP format:
   * <NAME>\t<HREF>.html\n
   * QDICT:
   * dict[<NAME>] = <HREF>
   */
  if (fi.exists() && fi.isReadable())
  {
    std::ifstream f = Portable::openInputStream(fileMapName);
    if (f.is_open())
    {
      std::string lineStr;
      while (getline(f,lineStr))
      {
        QCString line(lineStr);
        //printf("Read line: %s",qPrint(line));
        int sep = line.find('\t');
        if (sep!=-1)
        {
          QCString key   = line.left(sep).stripWhiteSpace();
          QCString value = line.mid(sep+1).stripWhiteSpace();
          int ext=value.findRev('.');
          if (ext!=-1) value=value.left(ext); // strip extension
          g_symbolMap.emplace(key.str(),value.str());
          //printf("Key/Value=(%s,%s)\n",qPrint(key),qPrint(value));
        }
      }
      return true;
    }
    else
    {
      err("file {} cannot be opened\n",fileMapName);
    }
  }
  return false;
}

References err, FileInfo::exists(), QCString::find(), QCString::findRev(), g_symbolMap, FileInfo::isReadable(), QCString::left(), QCString::mid(), Portable::openInputStream(), QCString::str(), and QCString::stripWhiteSpace().

Referenced by generateOutput().

path2URL()

QCString Htags::path2URL ( const QCString & path )

static

convert path name into the url in the hypertext generated by htags.

Parameters

path

path name

Returns

URL nullptr: not found.

Definition at line 157 of file htags.cpp.

{
  QCString url,symName=path;
  QCString dir = g_inputDir.absPath();
  size_t dl=dir.length();
  if (symName.length()>dl+1)
  {
    symName = symName.mid(dl+1);
  }
  if (!symName.isEmpty())
  {
    auto it = g_symbolMap.find(symName.str());
    //printf("path2URL=%s symName=%s result=%p\n",qPrint(path),qPrint(symName),result);
    if (it!=g_symbolMap.end())
    {
      url = QCString("HTML/"+it->second);
    }
  }
  return url;
}

References g_inputDir, g_symbolMap, QCString::isEmpty(), QCString::length(), QCString::mid(), and QCString::str().

Referenced by FileDefImpl::getSourceFileBase().

Member Data Documentation

useHtags

bool Htags::useHtags = FALSE

static

Definition at line 23 of file htags.h.

Referenced by generateFileSources(), generateOutput(), DefinitionImpl::getSourceAnchor(), and FileDefImpl::getSourceFileBase().

---

The documentation for this struct was generated from the following files:

• src/htags.h
• src/htags.cpp