blob: da3545e59957bff950f8d616266b7607233d5311 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/******************************************************************************
*
* Copyright (C) 2020 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 CITE_H
#define CITE_H
#include <memory>
#include "qcstring.h"
/// Citation-related data.
struct CiteInfo
{
virtual ~CiteInfo() = default;
virtual QCString label() const = 0;
virtual QCString text() const = 0;
};
/**
* @brief Citation manager class.
* @details This class provides access do the database of bibliographic
* references through the bibtex backend.
*/
class CitationManager
{
public:
static CitationManager &instance();
/** Insert a citation identified by \a label into the database */
void insert(const QCString &label);
/** Return the citation info for a given \a label.
* Ownership of the info stays with the manager.
*/
const CiteInfo *find(const QCString &label) const;
/** Generate the citations page */
void generatePage();
/** clears the database */
void clear();
/** return TRUE if there are no citations.
*/
bool isEmpty() const;
/** lists the bibtex cite files in a comma separated list
*/
QCString latexBibFiles();
QCString fileName() const;
QCString anchorPrefix() const;
private:
/** Create the database, with an expected maximum of \a size entries */
CitationManager();
void insertCrossReferencesForBibFile(const QCString &bibFile);
struct Private;
std::unique_ptr<Private> p;
};
#endif // CITE_H
|
