A helper class for HtmlHelp that manages a two level index in alphabetical order. More...

Collaboration diagram for HtmlHelpIndex:

Public Member Functions
	HtmlHelpIndex (HtmlHelpRecoder &recoder)
	~HtmlHelpIndex ()
void	addItem (const QCString &first, const QCString &second, const QCString &url, const QCString &anchor, bool hasLink, bool reversed)
void	writeFields (std::ostream &t)
size_t	size () const

Private Attributes
LinkedMap< IndexField >	m_map
HtmlHelpRecoder &	m_recoder

Detailed Description

A helper class for HtmlHelp that manages a two level index in alphabetical order.

Definition at line 113 of file htmlhelp.cpp.

Constructor & Destructor Documentation

◆ HtmlHelpIndex()

HtmlHelpIndex::HtmlHelpIndex ( HtmlHelpRecoder & recoder )

Constructs a new HtmlHelp index

Definition at line 130 of file htmlhelp.cpp.

                                                     : m_recoder(recoder)
{
}

References m_recoder.

Referenced by ~HtmlHelpIndex().

◆ ~HtmlHelpIndex()

HtmlHelpIndex::~HtmlHelpIndex ( )

default

Destroys the HtmlHelp index

References HtmlHelpIndex().

Member Function Documentation

◆ addItem()

void HtmlHelpIndex::addItem	(	const QCString &	level1,
		const QCString &	level2,
		const QCString &	url,
		const QCString &	anchor,
		bool	hasLink,
		bool	reversed )

Stores an item in the index if it is not already present. Items are stored in alphabetical order, by sorting on the concatenation of level1 and level2 (if present).

Parameters

level1	the string at level 1 in the index.
level2	the string at level 2 in the index (or 0 if not applicable).
url	the url of the documentation (without .html extension).
anchor	the anchor of the documentation within the page.
hasLink	if true, the url (without anchor) can be used in the level1 item, when writing the header of a list of level2 items.
reversed	TRUE if level1 is the member name and level2 the compound name.

Definition at line 151 of file htmlhelp.cpp.

{
  static const reg::Ex re(R"(@\d+)");
  std::string key = substitute(level1,"?","&quest;").str();
  if (!level2.isEmpty()) key+= std::string("?") + substitute(level2,"?","&quest;").str();
  if (reg::search(key,re)) // skip anonymous stuff
  {
    return;
  }
  std::string key_anchor;
  if (!anchor.isEmpty())
  {
    key_anchor = key+anchor.str();
  }
  else
  {
    key_anchor = key;
  }
  m_map.add(key_anchor.c_str(),key.c_str(),url,anchor,hasLink,reversed);
}

References QCString::isEmpty(), m_map, reg::search(), QCString::str(), and substitute().

◆ size()

size_t HtmlHelpIndex::size ( ) const

inline

Definition at line 123 of file htmlhelp.cpp.

123{ return m_map.size(); }

References m_map.

◆ writeFields()

void HtmlHelpIndex::writeFields ( std::ostream & t )

Writes the sorted list of index items into a html like list.

An list of calls with name = level1,level2 as follows:

  a1,b1
  a1,b2
  a2,b1
  a2,b2
  a3
  a4,b1

Will result in the following list:

  a1       -> link to url if hasLink==TRUE
    b1     -> link to url#anchor
    b2     -> link to url#anchor
  a2       -> link to url if hasLink==TRUE
    b1     -> link to url#anchor
    b2     -> link to url#anchor
  a3       -> link to url if hasLink==TRUE
  a4       -> link to url if hasLink==TRUE
    b1     -> link to url#anchor

Definition at line 238 of file htmlhelp.cpp.

{
  std::stable_sort(std::begin(m_map),
            std::end(m_map),
            [](const auto &e1,const auto &e2) { return qstricmp_sort(e1->name,e2->name)<0; }
           );
  QCString prevLevel1;
  bool level2Started=FALSE;
  for (auto it = std::begin(m_map); it!=std::end(m_map); ++it)
  {
    auto &f = *it;
    QCString level1,level2;
    int i = f->name.find('?');
    if (i!=-1)
    {
      level1 = f->name.left(i);
      level2 = f->name.right(f->name.length()-i-1);
    }
    else
    {
      level1  = f->name;
    }
 
    { // finish old list at level 2
      if (level2Started) t << "  </UL>\n";
      level2Started=FALSE;
 
      // <Antony>
      // Added this code so that an item with only one subitem is written
      // without any subitem.
      // For example:
      //   a1, b1 -> will create only a1, not separate subitem for b1
      //   a2, b2
      //   a2, b3
      QCString nextLevel1;
      auto it_next = std::next(it);
      if (it_next!=std::end(m_map))
      {
        auto &fnext = *it_next;
        int j = fnext->name.find('?');
        if (j<0) j=0;
        nextLevel1 = fnext->name.left(j);
      }
      if (!(level1 == prevLevel1 || level1 == nextLevel1))
      {
        level2 = "";
      }
      prevLevel1 = level1;
      // </Antony>
 
      if (level2.isEmpty())
      {
        t << "  <LI><OBJECT type=\"text/sitemap\">";
        t << "<param name=\"Local\" value=\"" << field2URL(f.get(),FALSE);
        t << "\">";
        t << "<param name=\"Name\" value=\"" << convertToHtmlAndTruncate(m_recoder.recode(level1)) << "\">"
           "</OBJECT>\n";
      }
      else
      {
        if (f->link)
        {
          t << "  <LI><OBJECT type=\"text/sitemap\">";
          t << "<param name=\"Local\" value=\"" << field2URL(f.get(),TRUE);
          t << "\">";
          t << "<param name=\"Name\" value=\"" << convertToHtmlAndTruncate(m_recoder.recode(level1)) << "\">"
               "</OBJECT>\n";
        }
        else
        {
          t << "  <LI><OBJECT type=\"text/sitemap\">";
          t << "<param name=\"See Also\" value=\"" << convertToHtml(m_recoder.recode(level1)) << "\">";
          t << "<param name=\"Name\" value=\"" << convertToHtmlAndTruncate(m_recoder.recode(level1)) << "\">"
               "</OBJECT>\n";
        }
      }
    }
    if (!level2Started && !level2.isEmpty())
    { // start new list at level 2
      t << "  <UL>\n";
      level2Started=TRUE;
    }
    else if (level2Started && level2.isEmpty())
    { // end list at level 2
      t << "  </UL>\n";
      level2Started=FALSE;
    }
    if (level2Started)
    {
      t << "    <LI><OBJECT type=\"text/sitemap\">";
      t << "<param name=\"Local\" value=\"" << field2URL(f.get(),FALSE);
      t << "\">";
      t << "<param name=\"Name\" value=\"" << convertToHtmlAndTruncate(m_recoder.recode(level2)) << "\">"
         "</OBJECT>\n";
    }
  }
  if (level2Started) t << "  </UL>\n";
}

References convertToHtml(), convertToHtmlAndTruncate(), FALSE, field2URL(), QCString::find(), QCString::isEmpty(), QCString::left(), m_map, m_recoder, qstricmp_sort(), QCString::right(), and TRUE.

Member Data Documentation

◆ m_map

LinkedMap<IndexField> HtmlHelpIndex::m_map

private

Definition at line 125 of file htmlhelp.cpp.

Referenced by addItem(), size(), and writeFields().

◆ m_recoder

HtmlHelpRecoder& HtmlHelpIndex::m_recoder