|
Packit |
1c1d7e |
/******************************************************************************
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Permission to use, copy, modify, and distribute this software and its
|
|
Packit |
1c1d7e |
* documentation under the terms of the GNU General Public License is hereby
|
|
Packit |
1c1d7e |
* granted. No representations are made about the suitability of this software
|
|
Packit |
1c1d7e |
* for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit |
1c1d7e |
* See the GNU General Public License for more details.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
* Documents produced by Doxygen are derivative works derived from the
|
|
Packit |
1c1d7e |
* input used in their production; they are not affected by this license.
|
|
Packit |
1c1d7e |
*
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
#include <stdio.h>
|
|
Packit |
1c1d7e |
#include "reflist.h"
|
|
Packit |
1c1d7e |
#include "util.h"
|
|
Packit |
1c1d7e |
#include "ftextstream.h"
|
|
Packit |
1c1d7e |
#include "definition.h"
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Create a list of items that are cross referenced with documentation blocks
|
|
Packit |
1c1d7e |
* @param listName String representing the name of the list.
|
|
Packit |
1c1d7e |
* @param pageTitle String representing the title of the list page.
|
|
Packit |
1c1d7e |
* @param secTitle String representing the title of the section.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
RefList::RefList(const char *listName,
|
|
Packit |
1c1d7e |
const char *pageTitle,
|
|
Packit |
1c1d7e |
const char *secTitle
|
|
Packit |
1c1d7e |
)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
m_itemList = 0;
|
|
Packit |
1c1d7e |
m_dict = 0;
|
|
Packit |
1c1d7e |
m_dictIterator = 0;
|
|
Packit |
1c1d7e |
m_id = 0;
|
|
Packit |
1c1d7e |
m_listName = listName;
|
|
Packit |
1c1d7e |
m_fileName = convertNameToFile(listName,FALSE,TRUE);
|
|
Packit |
1c1d7e |
m_pageTitle = pageTitle;
|
|
Packit |
1c1d7e |
m_secTitle = secTitle;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Destroy the todo list. Currently not called! */
|
|
Packit |
1c1d7e |
RefList::~RefList()
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
delete m_dictIterator;
|
|
Packit |
1c1d7e |
delete m_dict;
|
|
Packit |
1c1d7e |
delete m_itemList;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Adds a new item to the list.
|
|
Packit |
1c1d7e |
* \returns A unique id for this item.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
int RefList::addRefItem()
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
if (m_dict==0)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
m_dict = new QIntDict<RefItem>(1009);
|
|
Packit |
1c1d7e |
m_dict->setAutoDelete(TRUE);
|
|
Packit |
1c1d7e |
m_dictIterator = new QIntDictIterator<RefItem>(*m_dict);
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
RefItem *item = new RefItem;
|
|
Packit |
1c1d7e |
m_id++;
|
|
Packit |
1c1d7e |
m_dict->insert(m_id,item);
|
|
Packit |
1c1d7e |
return m_id;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Returns an item given it's id that is obtained with addRefItem()
|
|
Packit |
1c1d7e |
* \param itemId item's identifier.
|
|
Packit |
1c1d7e |
* \returns A pointer to the todo item's structure.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
RefItem *RefList::getRefItem(int itemId)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_dict ? m_dict->find(itemId) : 0;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Returns the first item in the dictionary or 0 if
|
|
Packit |
1c1d7e |
* non is available.
|
|
Packit |
1c1d7e |
* Items are not sorted.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
RefItem *RefList::getFirstRefItem()
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_dictIterator ? m_dictIterator->toFirst() : 0;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Returns the next item in the dictionary or 0 if
|
|
Packit |
1c1d7e |
* we are at the end of the list.
|
|
Packit |
1c1d7e |
* Items are not sorted.
|
|
Packit |
1c1d7e |
*/
|
|
Packit |
1c1d7e |
RefItem *RefList::getNextRefItem()
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_dictIterator ? m_dictIterator->operator++() : 0;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
/*! Returns the name of the list as set in the constructor. */
|
|
Packit |
1c1d7e |
QCString RefList::listName() const
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_listName;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
QCString RefList::fileName() const
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_fileName;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
QCString RefList::pageTitle() const
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_pageTitle;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
QCString RefList::sectionTitle() const
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
return m_secTitle;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
void RefList::insertIntoList(const char *key,RefItem *item)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
if (m_itemList==0)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
m_itemList = new SortedRefItems(1009);
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
RefItem *ri = m_itemList->find(key);
|
|
Packit |
1c1d7e |
if (ri==0)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
m_itemList->append(key,item);
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
else // item already added to the list (i.e. multiple item for the same
|
|
Packit |
1c1d7e |
// entity)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
if (ri!=item)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
ri->extraItems.append(item);
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
void RefList::generatePage()
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
if (m_itemList==0) return;
|
|
Packit |
1c1d7e |
m_itemList->sort();
|
|
Packit |
1c1d7e |
SDict<RefItem>::Iterator it(*m_itemList);
|
|
Packit |
1c1d7e |
RefItem *item;
|
|
Packit |
1c1d7e |
QCString doc;
|
|
Packit |
1c1d7e |
doc += "";
|
|
Packit |
1c1d7e |
for (it.toFirst();(item=it.current());++it)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
doc += " ";
|
|
Packit |
1c1d7e |
doc += "\\anchor ";
|
|
Packit |
1c1d7e |
doc += item->listAnchor;
|
|
Packit |
1c1d7e |
doc += "\n";
|
|
Packit |
1c1d7e |
if (item->scope)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
if (item->scope->name() != "<globalScope>")
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
doc += "\\_setscope ";
|
|
Packit |
1c1d7e |
doc += item->scope->name();
|
|
Packit |
1c1d7e |
doc += " ";
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
doc += item->prefix;
|
|
Packit |
1c1d7e |
doc += " \\_internalref ";
|
|
Packit |
1c1d7e |
doc += item->name;
|
|
Packit |
1c1d7e |
doc += " \"";
|
|
Packit |
1c1d7e |
doc += item->title;
|
|
Packit |
1c1d7e |
doc += "\" ";
|
|
Packit |
1c1d7e |
// write declaration in case a function with arguments
|
|
Packit |
1c1d7e |
if (!item->args.isEmpty())
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
doc += item->args;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
doc += " ";
|
|
Packit |
1c1d7e |
doc += item->text;
|
|
Packit |
1c1d7e |
QListIterator<RefItem> li(item->extraItems);
|
|
Packit |
1c1d7e |
RefItem *extraItem;
|
|
Packit |
1c1d7e |
for (li.toFirst();(extraItem=li.current());++li)
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
doc += "" + extraItem->text;
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
doc += "";
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
doc += "\n";
|
|
Packit |
1c1d7e |
//printf("generatePage('%s')\n",doc.data());
|
|
Packit |
1c1d7e |
addRelatedPage(m_listName,m_pageTitle,doc,0,m_fileName,1,0,0,0);
|
|
Packit |
1c1d7e |
}
|
|
Packit |
1c1d7e |
|