cite.h

Go to the documentation of this file.

/******************************************************************************
 *
 * 
 *
 * Copyright (C) 2011 by Dimitri van Heesch
 * Based on a patch by David Munger
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef CITEDB_H
#define CITEDB_H

#include <qdict.h>

class FTextStream;

struct CiteConsts
{
  static const QCString fileName;
  static const QCString anchorPrefix;
};

struct CiteInfo
{
  CiteInfo(const char *label_, const char *text_=0, const char *fullText_=0,
      const char *ref_=0) :
    label(label_), text(text_), fullText(fullText_), ref(ref_)
  { }

  CiteInfo(const CiteInfo &o)
  { label=o.label.copy(); text=o.text.copy(); fullText=o.fullText.copy(); ref=o.ref.copy(); }

  QCString label; 
  QCString text;
  QCString fullText;
  QCString ref;

};

class CiteDict 
{
  public:
    CiteDict(int size);

//    /** Resolve references to citations */
//    void resolve();

    void insert(const char *label);

    CiteInfo *find(const char *label) const;

    void generatePage() const;

    void clear();

    bool isEmpty() const;

    void writeLatexBibliography(FTextStream &t);

  private:
//    bool writeAux();
//    bool writeBst();
//    bool execute();
//    void parse();
//    void clean();
    QDict<CiteInfo> m_entries;
//    QList<QCString> m_ordering;
    QCString m_baseFileName;
};

#endif