List of cross-referenced items. More...

#include <src/reflist.h>

Collaboration diagram for RefList:

Public Member Functions
	RefList (const QCString &listName, const QCString &pageTitle, const QCString &secTitle)

bool	isEnabled () const

RefItem *	add ()

RefItem *	find (int itemId)

QCString	listName () const

QCString	fileName () const

QCString	pageTitle () const

QCString	sectionTitle () const

void	generatePage ()

Private Attributes
int	m_id = 0

QCString	m_listName

QCString	m_fileName

QCString	m_pageTitle

QCString	m_secTitle

std::vector< std::unique_ptr< RefItem > >	m_entries

std::unordered_map< int, RefItem * >	m_lookup

Detailed Description

List of cross-referenced items.

This class represents a list of items that are put at a certain point in the documentation by some special command and are collected in a list. The items cross-reference the documentation and the list.

Examples are the todo list, the test list and the bug list, introduced by the \todo, \test, and \bug commands respectively.

Definition at line 79 of file reflist.h.

Constructor & Destructor Documentation

◆ RefList()

RefList::RefList	(	const QCString &	listName,
		const QCString &	pageTitle,
		const QCString &	secTitle )

Create a list of items that are cross referenced with documentation blocks

Parameters

listName	String representing the name of the list.
pageTitle	String representing the title of the list page.
secTitle	String representing the title of the section.

Definition at line 24 of file reflist.cpp.

                                                                                              :
       m_listName(listName), m_fileName(convertNameToFile(listName,FALSE,TRUE)),
       m_pageTitle(pageTitle), m_secTitle(secTitle)
{
}

References convertNameToFile(), FALSE, listName(), m_fileName, m_listName, m_pageTitle, m_secTitle, pageTitle(), and TRUE.

Member Function Documentation

◆ add()

RefItem * RefList::add ( )

Adds a new item to the list.

Returns: A unique id for this item.

Definition at line 30 of file reflist.cpp.

{
  m_id++;
  std::unique_ptr<RefItem> item = std::make_unique<RefItem>(m_id,this);
  RefItem *result = item.get();
  m_entries.push_back(std::move(item));
  m_lookup.emplace(m_id,result);
  return result;
}

References m_entries, m_id, and m_lookup.

Referenced by addXRefItem().

◆ fileName()

QCString RefList::fileName ( ) const

inline

Definition at line 102 of file reflist.h.

102{ return m_fileName; }

References m_fileName.

Referenced by DocXRefItem::parse().

◆ find()

RefItem * RefList::find ( int itemId )

Returns an item given it's id that is obtained with addRefItem()

Parameters

itemId item's identifier.

Returns: A pointer to the todo item's structure.

Definition at line 40 of file reflist.cpp.

{
  auto it = m_lookup.find(itemId);
  return it!=m_lookup.end() ? it->second : nullptr;
}

References m_lookup.

Referenced by DocXRefItem::parse().

◆ generatePage()

void RefList::generatePage ( )

Definition at line 55 of file reflist.cpp.

{
  if (!isEnabled()) return;
 
  std::stable_sort(m_entries.begin(),m_entries.end(),
            [](const std::unique_ptr<RefItem> &left,const std::unique_ptr<RefItem> &right)
            { return qstricmp_sort(left->title(),right->title()) < 0; });
  //RefItem *item;
  QCString doc;
  int cnt = 0;
  doc += "<dl class=\"reflist\">";
  QCString lastGroup;
  bool first=true;
  for (const std::unique_ptr<RefItem> &item : m_entries)
  {
    if (item->name().isEmpty()) continue;
    cnt++;
    bool startNewGroup = item->group()!=lastGroup;
    if (startNewGroup)
    {
      if (!first)
      {
        doc += "</dd>";
      }
      doc += " <dt>";
      doc += "\n";
      if (item->scope())
      {
        if (item->scope()->name() != "<globalScope>")
        {
          doc += "\\_setscope ";
          doc += item->scope()->name();
          doc += " ";
        }
      }
      doc += item->prefix();
      doc += " \\_internalref ";
      doc += item->name();
      // escape \'s in title, see issue #5901
      QCString escapedTitle = substitute(item->title(),"\\","\\\\");
      doc += " \""+escapedTitle+"\" ";
      // write declaration in case a function with arguments
      if (!item->args().isEmpty())
      {
        // escape @'s in argument list, needed for Java annotations (see issue #6208)
        // escape \'s in argument list (see issue #6533)
        doc += substitute(substitute(item->args(),"@","@@"),"\\","\\\\");
      }
      doc += "</dt><dd>";
    }
    else
    {
      doc += "<p>";
    }
    doc += " \\anchor ";
    doc += item->anchor();
    doc += " ";
    doc += item->text();
    lastGroup = item->group();
    first = false;
  }
  if (!first)
  {
    doc += "</dd>";
  }
  doc += "</dl>\n";
  //printf("generatePage('%s')\n",doc.data());
  if (cnt>0)
  {
    addRelatedPage(m_listName,m_pageTitle,doc,m_fileName,1,1,RefItemVector(),nullptr,nullptr,TRUE);
  }
}

References addRelatedPage(), isEnabled(), m_entries, m_fileName, m_listName, m_pageTitle, substitute(), and TRUE.

◆ isEnabled()

bool RefList::isEnabled ( ) const

Definition at line 46 of file reflist.cpp.

{
  if      (m_listName=="todo"       && !Config_getBool(GENERATE_TODOLIST))       return false;
  else if (m_listName=="test"       && !Config_getBool(GENERATE_TESTLIST))       return false;
  else if (m_listName=="bug"        && !Config_getBool(GENERATE_BUGLIST))        return false;
  else if (m_listName=="deprecated" && !Config_getBool(GENERATE_DEPRECATEDLIST)) return false;
  return true;
}

References Config_getBool, and m_listName.

Referenced by generatePage(), and DocXRefItem::parse().

◆ listName()

QCString RefList::listName ( ) const

inline

Definition at line 101 of file reflist.h.

101{ return m_listName; }

References m_listName.

Referenced by DefinitionImpl::_getXRefListId(), addXRefItem(), and RefList().

◆ pageTitle()

QCString RefList::pageTitle ( ) const

inline

Definition at line 103 of file reflist.h.

103{ return m_pageTitle; }

References m_pageTitle.

Referenced by RefList().

◆ sectionTitle()

QCString RefList::sectionTitle ( ) const

inline

Definition at line 104 of file reflist.h.

104{ return m_secTitle; }

References m_secTitle.

Referenced by DocXRefItem::parse().

Member Data Documentation

◆ m_entries

std::vector< std::unique_ptr< RefItem > > RefList::m_entries

private

Definition at line 114 of file reflist.h.

Referenced by add(), and generatePage().

◆ m_fileName

QCString RefList::m_fileName

private

Definition at line 111 of file reflist.h.

Referenced by fileName(), generatePage(), and RefList().

◆ m_id

int RefList::m_id = 0

private

Definition at line 109 of file reflist.h.

Referenced by add().

◆ m_listName

QCString RefList::m_listName

private

Definition at line 110 of file reflist.h.

Referenced by generatePage(), isEnabled(), listName(), and RefList().

◆ m_lookup

std::unordered_map< int, RefItem* > RefList::m_lookup

private

Definition at line 115 of file reflist.h.

Referenced by add(), and find().

◆ m_pageTitle

QCString RefList::m_pageTitle

private

Definition at line 112 of file reflist.h.

Referenced by generatePage(), pageTitle(), and RefList().

◆ m_secTitle

QCString RefList::m_secTitle

private

Definition at line 113 of file reflist.h.

Referenced by RefList(), and sectionTitle().

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

src/reflist.h
src/reflist.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RefList()

Member Function Documentation

◆ add()

◆ fileName()

◆ find()

◆ generatePage()

◆ isEnabled()

◆ listName()

◆ pageTitle()

◆ sectionTitle()

Member Data Documentation

◆ m_entries

◆ m_fileName

◆ m_id

◆ m_listName

◆ m_lookup

◆ m_pageTitle

◆ m_secTitle