EclipseHelp Class Reference

#include <eclipsehelp.h>

Inheritance diagram for EclipseHelp:

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

Private Member Functions
	EclipseHelp (const EclipseHelp &)
EclipseHelp &	operator= (const EclipseHelp &)
void	indent ()
void	closedTag ()
void	openedTag ()

Private Attributes
int	m_depth
bool	m_endtag
int	m_openTags
QFile *	m_tocfile
FTextStream	m_tocstream
QCString	m_pathprefix

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 40 of file eclipsehelp.h.

Constructor & Destructor Documentation

EclipseHelp::EclipseHelp

(

)

Definition at line 22 of file eclipsehelp.cpp.

                         : m_depth(0), m_endtag(FALSE), m_openTags(0), m_tocfile(0) 
{
}

EclipseHelp::~EclipseHelp ( )

virtual

Definition at line 26 of file eclipsehelp.cpp.

{
}

EclipseHelp::EclipseHelp ( const EclipseHelp &  )

private

Member Function Documentation

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

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.

Implements IndexIntf.

Definition at line 169 of file eclipsehelp.cpp.

{
  // -- write the topic tag 
  closedTag();
  if (file) 
  { 
    switch (file[0]) // check for special markers (user defined URLs)
    {
      case '^':
        // URL not supported by eclipse toc.xml
        break;

      case '!':
        indent();
        m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
        m_tocstream << " href=\"" << convertToXML(m_pathprefix) << &file[1] << "\"";
        m_endtag = TRUE;
        break;

      default:
        indent();
        m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
        m_tocstream << " href=\"" << convertToXML(m_pathprefix) 
                    << file << Doxygen::htmlFileExtension;
        if (anchor)
        {
          m_tocstream << "#" << anchor;
        }
        m_tocstream << "\"";
        m_endtag = TRUE;
        break;
    }
  }
  else
  {
    indent();
    m_tocstream << "<topic label=\"" << convertToXML(name) << "\"";
    m_endtag = TRUE;
  }
}

void EclipseHelp::addImageFile ( const char *  name )

virtual

Implements IndexIntf.

Definition at line 230 of file eclipsehelp.cpp.

{
}

void EclipseHelp::addIndexFile ( const char *  name )

virtual

Implements IndexIntf.

Definition at line 226 of file eclipsehelp.cpp.

{
}

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

virtual

Implements IndexIntf.

Definition at line 218 of file eclipsehelp.cpp.

{
}

void EclipseHelp::addStyleSheetFile ( const char *  name )

virtual

Implements IndexIntf.

Definition at line 234 of file eclipsehelp.cpp.

{
}

void EclipseHelp::closedTag ( )

private

Definition at line 39 of file eclipsehelp.cpp.

{
  if (m_endtag) 
  {
    m_tocstream << "/>" << endl;
    m_endtag = FALSE;
  }
}

void EclipseHelp::decContentsDepth ( )

virtual

Decrease the level of content hierarchy.

It closes currently opened topic tag.

Implements IndexIntf.

Definition at line 143 of file eclipsehelp.cpp.

{
  // -- end of the opened topic
  closedTag();
  --m_depth;

  if (m_openTags==m_depth)
  {
    --m_openTags;
    indent();
    m_tocstream << "</topic>" << endl;
  }
}

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 101 of file eclipsehelp.cpp.

{
  closedTag(); // -- close previous tag

  // -- write ending tag 
  --m_depth;
  m_tocstream << "</toc>" << endl;

  // -- close the content file
  m_tocstream.unsetDevice();
  m_tocfile->close();
  delete m_tocfile; m_tocfile = 0;

  QCString name = Config_getString("HTML_OUTPUT") + "/plugin.xml";
  QFile pluginFile(name);
  if (pluginFile.open(IO_WriteOnly))
  {
    QString docId = Config_getString("ECLIPSE_DOC_ID");
    FTextStream t(&pluginFile);
    t << "<plugin name=\""  << docId << "\" id=\"" << docId << "\"" << endl;
    t << "        version=\"1.0.0\" provider-name=\"Doxygen\">" << endl;
    t << "  <extension point=\"org.eclipse.help.toc\">" << endl;
    t << "    <toc file=\"toc.xml\" primary=\"true\" />" << endl;
    t << "  </extension>" << endl;
    t << "</plugin>" << endl;
  }
}

void EclipseHelp::incContentsDepth ( )

virtual

Increase the level of content hierarchy.

Implements IndexIntf.

Definition at line 132 of file eclipsehelp.cpp.

{
  openedTag();
  ++m_depth;
}

void EclipseHelp::indent ( )

private

Definition at line 30 of file eclipsehelp.cpp.

{
  int i;
  for (i=0; i<m_depth; i++)
  {
    m_tocstream << "  ";
  }
}

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 64 of file eclipsehelp.cpp.

{
  // -- read path prefix from the configuration
  //m_pathprefix = Config_getString("ECLIPSE_PATHPREFIX");
  //if (m_pathprefix.isEmpty()) m_pathprefix = "html/";

  // -- open the contents file 
  QCString name = Config_getString("HTML_OUTPUT") + "/toc.xml";
  m_tocfile = new QFile(name);
  if (!m_tocfile->open(IO_WriteOnly)) 
  {
    err("Could not open file %s for writing\n", name.data());
    exit(1);
  }

  // -- initialize its text stream
  m_tocstream.setDevice(m_tocfile);
  //m_tocstream.setEncoding(FTextStream::UnicodeUTF8);

  // -- write the opening tag
  QCString title = Config_getString("PROJECT_NAME");
  if (title.isEmpty())
  {
    title = "Doxygen generated documentation";
  }
  m_tocstream << "<toc label=\"" << convertToXML(title) 
              << "\" topic=\"" << convertToXML(m_pathprefix) 
              << "index" << Doxygen::htmlFileExtension << "\">" << endl;
  ++ m_depth;
}

void EclipseHelp::openedTag ( )

private

Definition at line 48 of file eclipsehelp.cpp.

{
  if (m_endtag) 
  {
    m_tocstream << ">" << endl;
    m_endtag = FALSE;
    ++m_openTags;
  }
}

EclipseHelp& EclipseHelp::operator= ( const EclipseHelp &  )

private

Member Data Documentation

int EclipseHelp::m_depth

private

Definition at line 61 of file eclipsehelp.h.

bool EclipseHelp::m_endtag

private

Definition at line 62 of file eclipsehelp.h.

int EclipseHelp::m_openTags

private

Definition at line 63 of file eclipsehelp.h.

QCString EclipseHelp::m_pathprefix

private

Definition at line 67 of file eclipsehelp.h.

QFile* EclipseHelp::m_tocfile

private

Definition at line 65 of file eclipsehelp.h.

FTextStream EclipseHelp::m_tocstream

private

Definition at line 66 of file eclipsehelp.h.

---

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

• doxygen-1.8.11/src/eclipsehelp.h
• doxygen-1.8.11/src/eclipsehelp.cpp