mangen.cpp File Reference

#include <stdlib.h>
#include <string.h>
#include "config.h"
#include "datetime.h"
#include "dir.h"
#include "docparser.h"
#include "doxygen.h"
#include "fileinfo.h"
#include "language.h"
#include "mandocvisitor.h"
#include "mangen.h"
#include "message.h"
#include "outputlist.h"
#include "portable.h"
#include "utf8.h"
#include "util.h"

Include dependency graph for mangen.cpp:

Go to the source code of this file.

Functions
static DString	getExtension ()
static DString	getSubdir ()
static DString	docifyToString (const DString &str)
static DString	objectLinkToString (const DString &text)
static DString	buildFileName (const DString &name)

Function Documentation

buildFileName()

DString buildFileName ( const DString & name )

static

Definition at line 297 of file mangen.cpp.

{
  DString fileName;
  if (name.empty()) return "noname";
 
  const char *p=name.data();
  char c = 0;
  while ((c=*p++))
  {
    switch (c)
    {
      case ':':
        fileName+="_";
        if (*p==':') p++;
        break;
      case '<':
      case '>':
      case '&':
      case '*':
      case '!':
      case '^':
      case '~':
      case '%':
      case '+':
      case '/':
        fileName+="_";
        break;
      default:
        fileName+=c;
    }
  }
 
  DString manExtension = "." + getExtension();
  if (fileName.right(manExtension.length())!=manExtension)
  {
    fileName+=manExtension;
  }
 
  return fileName;
}

References DString::data(), DString::empty(), getExtension(), DString::length(), and DString::right().

Referenced by ManGenerator::startDoxyAnchor(), and ManGenerator::startFile().

docifyToString()

DString docifyToString ( const DString & str )

static

Definition at line 80 of file mangen.cpp.

{
  DString result;
  result.reserve(str.length());
  if (!str.empty())
  {
    const char *p=str.data();
    char c=0;
    while ((c=*p++))
    {
      switch(c)
      {
        case '-':  result += "\\-";  break; // see  bug747780
        case '.':  result += "\\&."; break; // see  bug652277
        case '\\': result += "\\\\"; break;
        case '\n': result += "\n";   break;
        case '\"': c = '\'';   // no break!
        default:   result += c;      break;
      }
    }
    //printf("%s",str);fflush(stdout);
  }
  return result;
}

References DString::data(), DString::empty(), DString::length(), and DString::reserve().

Referenced by objectLinkToString(), and ManGenerator::writeInheritedSectionTitle().

getExtension()

DString getExtension ( )

static

Definition at line 37 of file mangen.cpp.

{
  /*
   * [.][number][rest]
   * in case of . missing, just ignore it
   * in case number missing, just place a 3 in front of it
   */
  DString ext = Config_getString(MAN_EXTENSION);
  if (ext.empty())
  {
    ext = "3";
  }
  else
  {
    if (ext.at(0)=='.')
    {
      if (ext.length()==1)
      {
        ext = "3";
      }
      else // strip .
      {
        ext = ext.mid(1);
      }
    }
    if (ext.at(0)<'0' || ext.at(0)>'9')
    {
      ext.prepend("3");
    }
  }
  return ext;
}

References DString::at(), Config_getString, DString::empty(), DString::length(), DString::mid(), and DString::prepend().

Referenced by buildFileName(), ManGenerator::endTitleHead(), and getSubdir().

getSubdir()

DString getSubdir ( )

static

Definition at line 70 of file mangen.cpp.

{
  DString dir = Config_getString(MAN_SUBDIR);
  if (dir.empty())
  {
    dir = "man" + getExtension();
  }
  return dir;
}

References Config_getString, DString::empty(), and getExtension().

Referenced by ManGenerator::init(), ManGenerator::ManGenerator(), and ManGenerator::startDoxyAnchor().

objectLinkToString()

DString objectLinkToString ( const DString & text )

static

Definition at line 105 of file mangen.cpp.

{
  return "\\fB" + docifyToString(text) + "\\fP";
}

References docifyToString().

Referenced by ManGenerator::writeInheritedSectionTitle().