qhp.cpp File Reference

#include "qhp.h"
#include <algorithm>
#include <memory>
#include <string.h>
#include <vector>
#include <mutex>
#include "config.h"
#include "debug.h"
#include "doxygen.h"
#include "groupdef.h"
#include "language.h"
#include "memberdef.h"
#include "message.h"
#include "portable.h"
#include "stringutil.h"
#include "textstream.h"
#include "util.h"
#include "version.h"

Include dependency graph for qhp.cpp:

Go to the source code of this file.

Classes
class	QhpSectionTree
struct	QhpSectionTree::Node
class	Qhp::Private

Functions
static void	writeIndent (TextStream &t, int indent)
static DString	getFullProjectName ()
static DString	makeFileName (const DString &withoutExtension)
static DString	makeRef (const DString &withoutExtension, const DString &anchor)

Variables
static std::once_flag	g_blankWritten

Function Documentation

getFullProjectName()

DString getFullProjectName ( )

static

Definition at line 165 of file qhp.cpp.

{
  DString projectName = Config_getString(PROJECT_NAME);
  DString versionText = Config_getString(PROJECT_NUMBER);
  if (projectName.empty()) projectName="Root";
  if (!versionText.empty()) projectName+=" "+versionText;
  return projectName;
}

References Config_getString, and DString::empty().

Referenced by Qhp::initialize().

makeFileName()

DString makeFileName ( const DString & withoutExtension )

static

Definition at line 174 of file qhp.cpp.

{
  DString result=withoutExtension;
  if (!result.empty())
  {
    if (result.at(0)=='!') // relative URL -> strip marker
    {
      result=result.mid(1);
    }
    else // add specified HTML extension
    {
      addHtmlExtensionIfMissing(result);
    }
  }
  return result;
}

References addHtmlExtensionIfMissing(), DString::at(), DString::empty(), and DString::mid().

Referenced by makeRef().

makeRef()

DString makeRef ( const DString & withoutExtension, const DString & anchor )

static

Definition at line 191 of file qhp.cpp.

{
  //printf("QHP::makeRef(%s,%s)\n",withoutExtension,anchor);
  if (withoutExtension.empty()) return DString();
  DString result = makeFileName(withoutExtension);
  if (anchor.empty()) return result;
  return result+"#"+anchor;
}

References DString::empty(), and makeFileName().

Referenced by Qhp::addContentsItem(), and Qhp::addIndexItem().

writeIndent()

void writeIndent ( TextStream & t, int indent )

inlinestatic

Definition at line 41 of file qhp.cpp.

{
  if (Debug::isFlagSet(Debug::Qhp))
  {
    for (int i=0;i<indent;i++) t << "  ";
  }
}

References Debug::isFlagSet(), and Debug::Qhp.

Referenced by Qhp::addIndexItem(), Qhp::finalize(), Qhp::initialize(), QhpSectionTree::traverse(), and QhpSectionTree::writeToc().

Variable Documentation

g_blankWritten

std::once_flag g_blankWritten

static

Definition at line 38 of file qhp.cpp.

Referenced by Qhp::addContentsItem().