EclipseHelp Class Reference

Generator for Eclipse help files. More...

#include <src/eclipsehelp.h>

Inheritance diagram for EclipseHelp:

Collaboration diagram for EclipseHelp:

Classes
struct	Private

Public Member Functions
	EclipseHelp ()
virtual	~EclipseHelp ()
virtual void	initialize ()
	Initialize the Eclipse generator.
virtual void	finalize ()
	Finish generation of the Eclipse specific help files.
virtual void	incContentsDepth ()
	Increase the level of content hierarchy.
virtual void	decContentsDepth ()
	Decrease the level of content hierarchy.
virtual void	addContentsItem (bool isDir, const DString &name, const DString &ref, const DString &file, const DString &anchor, bool separateIndex, bool addToNavIndex, const Definition *def, const DString &nameAsHtml)
	Add an item to the content.
virtual void	addIndexItem (const Definition *context, const MemberDef *md, const DString &sectionAnchor, const DString &title)
virtual void	addIndexFile (const DString &name)
virtual void	addImageFile (const DString &name)
virtual void	addStyleSheetFile (const DString &name)

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Generator for Eclipse help files.

This class generates the Eclipse specific help files. These files can be used to generate a help plugin readable by the Eclipse IDE.

Definition at line 41 of file eclipsehelp.h.

Constructor & Destructor Documentation

EclipseHelp()

EclipseHelp::EclipseHelp

(

)

Definition at line 62 of file eclipsehelp.cpp.

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

References p.

Referenced by ~EclipseHelp().

~EclipseHelp()

EclipseHelp::~EclipseHelp ( )

virtualdefault

References EclipseHelp().

Member Function Documentation

addContentsItem()

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

virtual

Add an item to the content.

Parameters

isDir	Flag whether the argument file is a directory or a file entry
name	Name of the item
ref	URL of the item
file	Name of a file which the item is defined in (without extension)
anchor	Name of an anchor of the item.
separateIndex	not used.
addToNavIndex	not used.
def	not used.
nameAsHtml	name parameter in HTML format

Implements IndexIntf.

Definition at line 165 of file eclipsehelp.cpp.

{
  // -- write the topic tag
  p->closedTag();
  if (!file.empty())
  {
    DString fn = file;
    addHtmlExtensionIfMissing(fn);
    switch (file[0]) // check for special markers (user defined URLs)
    {
      case '^':
        // URL not supported by eclipse toc.xml
        break;
 
      case '!':
        p->indent();
        p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
        p->tocstream << " href=\"" << convertToXML(p->pathprefix) << &file[1] << "\"";
        p->endtag = true;
        break;
 
      default:
        p->indent();
        p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
        p->tocstream << " href=\"" << convertToXML(p->pathprefix) << fn;
        if (!anchor.empty())
        {
          p->tocstream << "#" << anchor;
        }
        p->tocstream << "\"";
        p->endtag = true;
        break;
    }
  }
  else
  {
    p->indent();
    p->tocstream << "<topic label=\"" << convertToXML(name) << "\"";
    p->endtag = true;
  }
}

References addHtmlExtensionIfMissing(), convertToXML(), DString::empty(), and p.

addImageFile()

void EclipseHelp::addImageFile ( const DString & name )

virtual

Implements IndexIntf.

Definition at line 228 of file eclipsehelp.cpp.

{
}

addIndexFile()

void EclipseHelp::addIndexFile ( const DString & name )

virtual

Implements IndexIntf.

Definition at line 224 of file eclipsehelp.cpp.

{
}

addIndexItem()

void EclipseHelp::addIndexItem ( const Definition * context, const MemberDef * md, const DString & sectionAnchor, const DString & title )

virtual

Implements IndexIntf.

Definition at line 216 of file eclipsehelp.cpp.

{
}

addStyleSheetFile()

void EclipseHelp::addStyleSheetFile ( const DString & name )

virtual

Implements IndexIntf.

Definition at line 232 of file eclipsehelp.cpp.

{
}

decContentsDepth()

void EclipseHelp::decContentsDepth ( )

virtual

Decrease the level of content hierarchy.

It closes currently opened topic tag.

Implements IndexIntf.

Definition at line 138 of file eclipsehelp.cpp.

{
  // -- end of the opened topic
  p->closedTag();
  --p->depth;
 
  if (p->openTags==p->depth)
  {
    --p->openTags;
    p->indent();
    p->tocstream << "</topic>\n";
  }
}

References p.

finalize()

void EclipseHelp::finalize ( )

virtual

Finish generation of the Eclipse specific help files.

This method writes footers of the files and closes them.

See also

initialize()

Implements IndexIntf.

Definition at line 99 of file eclipsehelp.cpp.

{
  p->closedTag(); // -- close previous tag
 
  // -- write ending tag
  --p->depth;
  p->tocstream << "</toc>\n";
 
  // -- close the content file
  p->tocstream.close();
 
  DString name = Config_getString(HTML_OUTPUT) + "/plugin.xml";
  std::ofstream t = Portable::openOutputStream(name);
  if (t.is_open())
  {
    DString docId = Config_getString(ECLIPSE_DOC_ID);
    t << "<plugin name=\""  << docId << "\" id=\"" << docId << "\"\n";
    t << "        version=\"1.0.0\" provider-name=\"Doxygen\">\n";
    t << "  <extension point=\"org.eclipse.help.toc\">\n";
    t << "    <toc file=\"toc.xml\" primary=\"true\" />\n";
    t << "  </extension>\n";
    t << "</plugin>\n";
  }
}

References Config_getString, Portable::openOutputStream(), and p.

incContentsDepth()

void EclipseHelp::incContentsDepth ( )

virtual

Increase the level of content hierarchy.

Implements IndexIntf.

Definition at line 127 of file eclipsehelp.cpp.

{
  p->openedTag();
  ++p->depth;
}

References p.

initialize()

void EclipseHelp::initialize ( )

virtual

Initialize the Eclipse generator.

This method opens the XML TOC file and writes headers of the files.

See also

finalize()

Implements IndexIntf.

Definition at line 71 of file eclipsehelp.cpp.

{
  // -- open the contents file
  DString name = Config_getString(HTML_OUTPUT) + "/toc.xml";
  p->tocstream = Portable::openOutputStream(name);
  if (!p->tocstream.is_open())
  {
    term("Could not open file {} for writing\n", name);
  }
 
  // -- write the opening tag
  DString title = Config_getString(PROJECT_NAME);
  if (title.empty())
  {
    title = "Doxygen generated documentation";
  }
  p->tocstream << "<toc label=\"" << convertToXML(title)
              << "\" topic=\"" << convertToXML(p->pathprefix)
              << "index" << Doxygen::htmlFileExtension << "\">\n";
  ++ p->depth;
}

References Config_getString, convertToXML(), DString::empty(), Doxygen::htmlFileExtension, Portable::openOutputStream(), p, and term.

Member Data Documentation

p

std::unique_ptr<Private> EclipseHelp::p

private

Definition at line 64 of file eclipsehelp.h.

Referenced by addContentsItem(), decContentsDepth(), EclipseHelp(), finalize(), incContentsDepth(), and initialize().

---

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

• src/eclipsehelp.h
• src/eclipsehelp.cpp