htmlhelp.cpp File Reference

#include "htmlhelp.h"
#include <algorithm>
#include <cstdio>
#include <cstdlib>
#include "config.h"
#include "doxygen.h"
#include "filedef.h"
#include "fileinfo.h"
#include "language.h"
#include "linkedmap.h"
#include "memberdef.h"
#include "message.h"
#include "portable.h"
#include "regex.h"
#include "util.h"

Include dependency graph for htmlhelp.cpp:

Go to the source code of this file.

Classes
class	HtmlHelpRecoder
	Helper class to deal with recoding the UTF8 encoded text back to the native encoding specified by CHM_INDEX_ENCODING. More...
struct	IndexField
	Class representing a field in the HTML help index. More...
class	HtmlHelpIndex
	A helper class for HtmlHelp that manages a two level index in alphabetical order. More...
class	HtmlHelp::Private

Functions
static DString	field2URL (const IndexField *f, bool checkReversed)
static DString	convertToHtmlAndTruncate (const DString &s)

Function Documentation

convertToHtmlAndTruncate()

DString convertToHtmlAndTruncate ( const DString & s )

static

Definition at line 183 of file htmlhelp.cpp.

{
  /* to prevent
   *  Warning: Keyword string:
   *    ...
   *  is too long.  The maximum size is 488 characters.
   */
  int maxLen = 400;
  size_t maxExpandedLen = maxLen+50;
  DString result = convertToHtml(s,true);
  if (result.length()>maxExpandedLen) // we need to truncate the string
  {
    // in the unlikely case that the string after conversion grows from maxLen to maxExpandedLen, we try smaller parts
    // until we end up below the limit
    while (maxLen>0 && result.length()>maxExpandedLen)
    {
      result = convertToHtml(s.left(maxLen));
      maxLen-=20;
    }
    return result+"...";
  }
  else
  {
    return result;
  }
}

References convertToHtml(), DString::left(), and DString::length().

Referenced by HtmlHelpIndex::writeFields().

field2URL()

DString field2URL ( const IndexField * f, bool checkReversed )

static

Definition at line 172 of file htmlhelp.cpp.

{
  DString result = f->url;
  addHtmlExtensionIfMissing(result);
  if (!f->anchor.empty() && (!checkReversed || f->reversed))
  {
    result+="#"+f->anchor;
  }
  return result;
}

References addHtmlExtensionIfMissing(), IndexField::anchor, DString::empty(), IndexField::reversed, and IndexField::url.

Referenced by HtmlHelpIndex::writeFields().