#include <reflist.h>

Public Member Functions
int	addRefItem ()

RefItem *	getRefItem (int todoItemId)

RefItem *	getFirstRefItem ()

RefItem *	getNextRefItem ()

QCString	listName () const

QCString	fileName () const

QCString	pageTitle () const

QCString	sectionTitle () const

	RefList (const char listName, const char pageTitle, const char *secTitle)

	~RefList ()

void	insertIntoList (const char key, RefItem item)

void	generatePage ()

Private Attributes
int	m_id

QCString	m_listName

QCString	m_fileName

QCString	m_pageTitle

QCString	m_secTitle

SortedRefItems *	m_itemList

QIntDict< RefItem > *	m_dict

QIntDictIterator< RefItem > *	m_dictIterator

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 67 of file reflist.h.

Constructor & Destructor Documentation

RefList::RefList	(	const char *	listName,
		const char *	pageTitle,
		const char *	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 30 of file reflist.cpp.

References convertNameToFile(), listName(), m_dict, m_dictIterator, m_fileName, m_id, m_itemList, m_listName, m_pageTitle, m_secTitle, and pageTitle().

{
  m_itemList = 0;
  m_dict = 0;
  m_dictIterator = 0;
  m_id = 0;
  m_listName = listName;
  m_fileName = convertNameToFile(listName,FALSE,TRUE);
  m_pageTitle = pageTitle;
  m_secTitle = secTitle;
}

RefList::~RefList ( )

Destroy the todo list. Currently not called!

Definition at line 46 of file reflist.cpp.

References m_dict, m_dictIterator, and m_itemList.

{
  delete m_dictIterator;
  delete m_dict;
  delete m_itemList;
}

Member Function Documentation

int RefList::addRefItem ( )

Adds a new item to the list.

Returns: A unique id for this item.

Definition at line 56 of file reflist.cpp.

References m_dict, m_dictIterator, and m_id.

{
  if (m_dict==0)
  {
    m_dict = new QIntDict<RefItem>(1009);
    m_dict->setAutoDelete(TRUE);
    m_dictIterator = new QIntDictIterator<RefItem>(*m_dict);
  }
  RefItem *item = new RefItem;
  m_id++;
  m_dict->insert(m_id,item);
  return m_id;
}

QCString RefList::fileName ( ) const

Definition at line 103 of file reflist.cpp.

References m_fileName.

Referenced by DocXRefItem::parse().

{
  return m_fileName;
}

void RefList::generatePage ( )

Definition at line 140 of file reflist.cpp.

References addRelatedPage(), RefItem::args, doc, RefItem::extraItems, RefItem::listAnchor, m_fileName, m_itemList, m_listName, m_pageTitle, RefItem::name, Definition::name(), RefItem::prefix, RefItem::scope, SDict< T >::sort(), RefItem::text, and RefItem::title.

Referenced by generateXRefPages().

{
  if (m_itemList==0) return;
  m_itemList->sort();
  SDict<RefItem>::Iterator it(*m_itemList);
  RefItem *item;
  QCString doc;
  doc += "<dl class=\"reflist\">";
  for (it.toFirst();(item=it.current());++it)
  {
    doc += " <dt>";
    doc +=  "\\anchor ";
    doc += item->listAnchor;
    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;
    doc += " \"";
    doc += item->title;
    doc += "\" ";
    // write declaration in case a function with arguments
    if (!item->args.isEmpty()) 
    {
      doc += item->args;
    }
    doc += "</dt><dd> ";
    doc += item->text;
    QListIterator<RefItem> li(item->extraItems);
    RefItem *extraItem;
    for (li.toFirst();(extraItem=li.current());++li)
    {
      doc += "<p>" + extraItem->text;
    }
    doc += "</dd>";
  }
  doc += "</dl>\n";
  //printf("generatePage('%s')\n",doc.data());
  addRelatedPage(m_listName,m_pageTitle,doc,0,m_fileName,1,0,0,0);
}

RefItem * RefList::getFirstRefItem ( )

Returns the first item in the dictionary or 0 if non is available. Items are not sorted.

Definition at line 83 of file reflist.cpp.

References m_dictIterator.

{
  return m_dictIterator ? m_dictIterator->toFirst() : 0;
}

RefItem * RefList::getNextRefItem ( )

Returns the next item in the dictionary or 0 if we are at the end of the list. Items are not sorted.

Definition at line 92 of file reflist.cpp.

References m_dictIterator.

{
  return m_dictIterator ? m_dictIterator->operator++() : 0;
}

RefItem * RefList::getRefItem ( 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 74 of file reflist.cpp.

References m_dict.

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

{
  return m_dict ? m_dict->find(itemId) : 0;
}

void RefList::insertIntoList	(	const char *	key,
		RefItem *	item
	)

Definition at line 118 of file reflist.cpp.

References SDict< T >::append(), RefItem::extraItems, SDict< T >::find(), and m_itemList.

Referenced by addRefItem().

{
  if (m_itemList==0)
  {
    m_itemList = new SortedRefItems(1009);
  }
  RefItem *ri = m_itemList->find(key);
  if (ri==0)
  {
    m_itemList->append(key,item);
  }
  else // item already added to the list (i.e. multiple item for the same
       // entity)
  {
    if (ri!=item)
    {
      ri->extraItems.append(item);
    }
  }
}