A class that generated the HTML Help specific files. More...

#include <src/htmlhelp.h>

Inheritance diagram for HtmlHelp:

Collaboration diagram for HtmlHelp:

Classes
class	Private

Public Member Functions
	HtmlHelp ()
	~HtmlHelp ()
void	initialize ()
void	finalize ()
void	incContentsDepth ()
void	decContentsDepth ()
void	addContentsItem (bool isDir, const QCString &name, const QCString &ref, const QCString &file, const QCString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const QCString &nameAsHtml)
void	addIndexItem (const Definition context, const MemberDef md, const QCString &sectionAnchor, const QCString &title)
void	addIndexFile (const QCString &name)
void	addImageFile (const QCString &)
void	addStyleSheetFile (const QCString &)

Static Public Attributes
static const QCString	hhcFileName = "index.hhc"
static const QCString	hhkFileName = "index.hhk"
static const QCString	hhpFileName = "index.hhp"

Private Types

enum ImageNumber {
BOOK_CLOSED =1 , BOOK_OPEN , BOOK_CLOSED_NEW , BOOK_OPEN_NEW ,
FOLDER_CLOSED , FOLDER_OPEN , FOLDER_CLOSED_NEW , FOLDER_OPEN_NEW ,
QUERY , QUERY_NEW , TEXT , TEXT_NEW ,
WEB_DOC , WEB_DOC_NEW , WEB_LINK , WEB_LINK_NEW ,
INFO , INFO_NEW , LINK , LINK_NEW ,
BOOKLET , BOOKLET_NEW , EMAIL , EMAIL_NEW ,
EMAIL2 , EMAIL2_NEW , IMAGE , IMAGE_NEW ,
AUDIO , AUDIO_NEW , MUSIC , MUSIC_NEW ,
VIDEO , VIDEO_NEW , INDEX , INDEX_NEW ,
IDEA , IDEA_NEW , NOTE , NOTE_NEW ,
TOOL , TOOL_NEW
}

Private Member Functions
QCString	recode (const QCString &s)

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

A class that generated the HTML Help specific files.

These files can be used with the Microsoft HTML Help workshop to generate compressed HTML files (.chm).

Definition at line 35 of file htmlhelp.h.

Member Enumeration Documentation

◆ ImageNumber

enum HtmlHelp::ImageNumber

private

used in imageNumber param of HTMLHelp::addContentsItem() function to specify document icon in tree view. Writes <param name="ImageNumber" value="xx"> in .HHC file.

Enumerator
BOOK_CLOSED
BOOK_OPEN
BOOK_CLOSED_NEW
BOOK_OPEN_NEW
FOLDER_CLOSED
FOLDER_OPEN
FOLDER_CLOSED_NEW
FOLDER_OPEN_NEW
QUERY
QUERY_NEW
TEXT
TEXT_NEW
WEB_DOC
WEB_DOC_NEW
WEB_LINK
WEB_LINK_NEW
INFO
INFO_NEW
LINK
LINK_NEW
BOOKLET
BOOKLET_NEW
EMAIL
EMAIL_NEW
EMAIL2
EMAIL2_NEW
IMAGE
IMAGE_NEW
AUDIO
AUDIO_NEW
MUSIC
MUSIC_NEW
VIDEO
VIDEO_NEW
INDEX
INDEX_NEW
IDEA
IDEA_NEW
NOTE
NOTE_NEW
TOOL
TOOL_NEW

Definition at line 40 of file htmlhelp.h.

                     {
      BOOK_CLOSED=1,    BOOK_OPEN,
      BOOK_CLOSED_NEW,  BOOK_OPEN_NEW,
      FOLDER_CLOSED,    FOLDER_OPEN,
      FOLDER_CLOSED_NEW,FOLDER_OPEN_NEW,
      QUERY,            QUERY_NEW,
      TEXT,             TEXT_NEW,
      WEB_DOC,          WEB_DOC_NEW,
      WEB_LINK,         WEB_LINK_NEW,
      INFO,             INFO_NEW,
      LINK,             LINK_NEW,
      BOOKLET,          BOOKLET_NEW,
      EMAIL,            EMAIL_NEW,
      EMAIL2,           EMAIL2_NEW,
      IMAGE,            IMAGE_NEW,
      AUDIO,            AUDIO_NEW,
      MUSIC,            MUSIC_NEW,
      VIDEO,            VIDEO_NEW,
      INDEX,            INDEX_NEW,
      IDEA,             IDEA_NEW,
      NOTE,             NOTE_NEW,
      TOOL,             TOOL_NEW
    };

Constructor & Destructor Documentation

◆ HtmlHelp()

HtmlHelp::HtmlHelp ( )

Constructs an html object. The object has to be initialized before it can be used.

Definition at line 361 of file htmlhelp.cpp.

361: p(std::make_unique<Private>()) {}

HtmlHelp::p

std::unique_ptr< Private > p

Definition htmlhelp.h:92

References p.

Referenced by ~HtmlHelp().

◆ ~HtmlHelp()

HtmlHelp::~HtmlHelp ( )

default

References HtmlHelp().

Member Function Documentation

◆ addContentsItem()

void HtmlHelp::addContentsItem	(	bool	isDir,
		const QCString &	name,
		const QCString &	ref,
		const QCString &	file,
		const QCString &	anchor,
		bool	separateIndex,
		bool	addToNavIndex,
		const Definition *	def,
		const QCString &	nameAsHtml )

virtual

Add an list item to the contents file.

Parameters

isDir	boolean indicating if this is a dir or file entry
name	the name of the item.
ref	the URL of to the item.
file	the file in which the item is defined.
anchor	the anchor of the item.
separateIndex	not used.
addToNavIndex	not used.
def	not used.
nameAsHtml	name parameter in HTML format

Implements IndexIntf.

Definition at line 548 of file htmlhelp.cpp.

{
  p->ctsItemPresent = true;
  for (int i=0; i<p->dc; i++) p->cts << "  ";
  p->cts << "<LI><OBJECT type=\"text/sitemap\">";
  p->cts << "<param name=\"Name\" value=\"" << convertToHtml(p->recoder.recode(name),TRUE) << "\">";
  if (!file.isEmpty())      // made file optional param - KPW
  {
    if (file[0]=='!' || file[0]=='^') // special markers for user defined URLs
    {
      p->cts << "<param name=\"";
      if (file[0]=='^') p->cts << "URL"; else p->cts << "Local";
      p->cts << "\" value=\"";
      p->cts << &file[1];
      p->cts << "\">";
    }
    else
    {
      QCString currFile = file;
      addHtmlExtensionIfMissing(currFile);
      QCString currAnc = anchor;
      p->cts << "<param name=\"Local\" value=\"";
      if (!ref.isEmpty()) p->cts << externalRef("",ref,true);
      p->cts << currFile;
      if (p->prevFile == currFile && p->prevAnc.isEmpty() && currAnc.isEmpty())
      {
        currAnc = "top";
      }
      if (!currAnc.isEmpty()) p->cts << "#" << currAnc;
      p->cts << "\">";
      p->prevFile = currFile;
      p->prevAnc = currAnc;
    }
  }
  p->cts << "<param name=\"ImageNumber\" value=\"";
  if (isDir)  // added - KPW
  {
    p->cts << static_cast<int>(BOOK_CLOSED);
  }
  else
  {
    p->cts << static_cast<int>(TEXT);
  }
  p->cts << "\">";
  p->cts << "</OBJECT>\n";
}

References addHtmlExtensionIfMissing(), BOOK_CLOSED, convertToHtml(), externalRef(), QCString::isEmpty(), p, TEXT, and TRUE.

◆ addImageFile()

void HtmlHelp::addImageFile ( const QCString & fileName )

virtual

Implements IndexIntf.

Definition at line 629 of file htmlhelp.cpp.

{
  p->imageFiles.insert(fileName.str());
}

References p, and QCString::str().

◆ addIndexFile()

void HtmlHelp::addIndexFile ( const QCString & name )

virtual

Implements IndexIntf.

Definition at line 485 of file htmlhelp.cpp.

{
  p->indexFiles.insert(s.str());
}

References p, and QCString::str().

◆ addIndexItem()

void HtmlHelp::addIndexItem	(	const Definition *	context,
		const MemberDef *	md,
		const QCString &	sectionAnchor,
		const QCString &	title )

virtual

Implements IndexIntf.

Definition at line 604 of file htmlhelp.cpp.

{
  if (context && md)
  {
    QCString cfname  = md->getOutputFileBase();
    QCString argStr  = md->argsString();
    QCString level1  = context->name();
    QCString level2  = md->name() + argStr;
    QCString anchor  = !sectionAnchor.isEmpty() ? sectionAnchor : md->anchor();
    p->index.addItem(level1,level2,cfname,anchor,TRUE,FALSE);
    p->index.addItem(level2,level1,cfname,anchor,TRUE,TRUE);
  }
  else if (context)
  {
    QCString level1  = !word.isEmpty() ? word : context->name();
    p->index.addItem(level1,QCString(),context->getOutputFileBase(),sectionAnchor,TRUE,FALSE);
  }
}

References Definition::anchor(), MemberDef::argsString(), FALSE, Definition::getOutputFileBase(), QCString::isEmpty(), Definition::name(), p, and TRUE.

◆ addStyleSheetFile()

void HtmlHelp::addStyleSheetFile ( const QCString & fileName )

virtual

Implements IndexIntf.

Definition at line 624 of file htmlhelp.cpp.

{
  p->styleFiles.insert(fileName.str());
}

References p, and QCString::str().

◆ decContentsDepth()

void HtmlHelp::decContentsDepth ( )

virtual

Decrease the level of the contents hierarchy. This will end the unnumber HTML list.

See also: incContentsDepth()

Implements IndexIntf.

Definition at line 530 of file htmlhelp.cpp.

{
  for (int i=0; i<p->dc; i++) p->cts << "  ";
  p->cts << "</UL>\n";
  --p->dc;
}

References p.

◆ finalize()

void HtmlHelp::finalize ( )

virtual

Finalizes the HTML help. This will finish and close the htmlhelp contents file and the htmlhelp index file.

See also: initialize()

Implements IndexIntf.

Definition at line 494 of file htmlhelp.cpp.

{
  // end the contents file
  p->cts << "</UL>\n";
  p->cts << "</BODY>\n";
  p->cts << "</HTML>\n";
  p->cts.close();
 
  p->index.writeFields(p->kts);
 
  // end the index file
  p->kts << "</UL>\n";
  p->kts << "</BODY>\n";
  p->kts << "</HTML>\n";
  p->kts.close();
 
  p->createProjectFile();
 
  p->recoder.finalize();
}

References p.

◆ incContentsDepth()

void HtmlHelp::incContentsDepth ( )

virtual

Increase the level of the contents hierarchy. This will start a new unnumbered HTML list in contents file.

See also: decContentsDepth()

Implements IndexIntf.

Definition at line 519 of file htmlhelp.cpp.

{
  for (int i=0; i<p->dc+1; i++) p->cts << "  ";
  p->cts << "<UL>\n";
  ++p->dc;
}

References p.

◆ initialize()

void HtmlHelp::initialize ( )

virtual

This will create a contents file (index.hhc) and a index file (index.hhk) and write the header of those files. It also creates a project file (index.hhp)

See also: finalize()

Implements IndexIntf.

Definition at line 369 of file htmlhelp.cpp.

{
  p->recoder.initialize();
 
  /* open the contents file */
  QCString fName = Config_getString(HTML_OUTPUT) + "/" + hhcFileName;
  p->cts = Portable::openOutputStream(fName);
  if (!p->cts.is_open())
  {
    term("Could not open file {} for writing\n",fName);
  }
  /* Write the header of the contents file */
  p->cts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
         "<HTML><HEAD></HEAD><BODY>\n"
         "<OBJECT type=\"text/site properties\">\n"
         "<param name=\"FrameName\" value=\"right\">\n"
         "</OBJECT>\n"
         "<UL>\n";
 
  /* open the index file */
  fName = Config_getString(HTML_OUTPUT) + "/" + hhkFileName;
  p->kts = Portable::openOutputStream(fName);
  if (!p->kts.is_open())
  {
    term("Could not open file {} for writing\n",fName);
  }
  /* Write the header of the contents file */
  p->kts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
         "<HTML><HEAD></HEAD><BODY>\n"
         "<OBJECT type=\"text/site properties\">\n"
         "<param name=\"FrameName\" value=\"right\">\n"
         "</OBJECT>\n"
         "<UL>\n";
 
}

References Config_getString, hhcFileName, hhkFileName, Portable::openOutputStream(), p, and term.

◆ recode()

QCString HtmlHelp::recode ( const QCString & s )

private

Member Data Documentation

◆ hhcFileName

const QCString HtmlHelp::hhcFileName = "index.hhc"

inlinestatic

Definition at line 87 of file htmlhelp.h.

Referenced by HtmlHelp::Private::createProjectFile(), and initialize().

◆ hhkFileName

const QCString HtmlHelp::hhkFileName = "index.hhk"

inlinestatic

Definition at line 88 of file htmlhelp.h.

Referenced by HtmlHelp::Private::createProjectFile(), and initialize().

◆ hhpFileName

const QCString HtmlHelp::hhpFileName = "index.hhp"

inlinestatic

Definition at line 89 of file htmlhelp.h.

Referenced by HtmlHelp::Private::createProjectFile(), and runHtmlHelpCompiler().

◆ p

std::unique_ptr<Private> HtmlHelp::p

private

Definition at line 92 of file htmlhelp.h.

Referenced by addContentsItem(), addImageFile(), addIndexFile(), addIndexItem(), addStyleSheetFile(), decContentsDepth(), finalize(), HtmlHelp(), incContentsDepth(), and initialize().

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

src/htmlhelp.h
src/htmlhelp.cpp

Classes

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ImageNumber

Constructor & Destructor Documentation

◆ HtmlHelp()

◆ ~HtmlHelp()

Member Function Documentation

◆ addContentsItem()

◆ addImageFile()

◆ addIndexFile()

◆ addIndexItem()

◆ addStyleSheetFile()

◆ decContentsDepth()

◆ finalize()

◆ incContentsDepth()

◆ initialize()

◆ recode()

Member Data Documentation

◆ hhcFileName

◆ hhkFileName

◆ hhpFileName

◆ p