src/BiblioInfo.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BiblioInfo.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  * \author Herbert Voß
   9  * \author Richard Heck
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef BIBLIO_H
  15 #define BIBLIO_H
  16
  17 #include "support/docstring.h"
  18
  19 #include <vector>
  20 #include <map>
  21 #include <set>
  22
  23
  24 namespace lyx {
  25
  26 class Buffer;
  27
  28 namespace biblio {
  29
  30 enum CiteEngine {
  31         ENGINE_BASIC,
  32         ENGINE_NATBIB_AUTHORYEAR,
  33         ENGINE_NATBIB_NUMERICAL,
  34         ENGINE_JURABIB
  35 };
  36
  37 enum CiteStyle {
  38         CITE,
  39         NOCITE,
  40         CITET,
  41         CITEP,
  42         CITEALT,
  43         CITEALP,
  44         CITEAUTHOR,
  45         CITEYEAR,
  46         CITEYEARPAR
  47 };
  48
  49
  50 class CitationStyle {
  51 public:
  52         ///
  53         CitationStyle(CiteStyle s = CITE, bool f = false, bool force = false)
  54                 : style(s), full(f), forceUCase(force) {}
  55         /// \param latex_str a LaTeX command, "cite", "Citep*", etc
  56         CitationStyle(std::string const & latex_str);
  57         ///
  58         std::string const asLatexStr() const;
  59         ///
  60         CiteStyle style;
  61         ///
  62         bool full;
  63         ///
  64         bool forceUCase;
  65 };
  66
  67 /// Returns a vector of available Citation styles.
  68 std::vector<CiteStyle> const getCiteStyles(CiteEngine const );
  69
  70 } // namespace biblio
  71
  72 /// Class to represent information about a BibTeX or
  73 /// bibliography entry.
  74 /// The keys are BibTeX fields (e.g., author, title, etc),
  75 /// and the values are the associated field values.
  76 class BibTeXInfo {
  77 public:
  78         ///
  79         typedef std::map<docstring, docstring>::const_iterator const_iterator;
  80         /// argument sets isBibTeX_, so should be false only if it's coming
  81         /// from a bibliography environment
  82         BibTeXInfo(bool ib = true);
  83         /// constructor that sets the entryType
  84         BibTeXInfo(docstring const & key, docstring const & type);
  85         /// Search for the given field and return the associated info.
  86         /// The point of this is that BibTeXInfo::operator[] has no const
  87         /// form.
  88         docstring const & getValueForField(docstring const & field) const;
  89         ///
  90         docstring const & getValueForField(std::string const & field) const;
  91         ///
  92         bool hasField(docstring const & field) const;
  93         /// return the short form of an authorlist
  94         docstring const getAbbreviatedAuthor() const;
  95         ///
  96         docstring const getYear() const;
  97         /// Returns formatted BibTeX data suitable for framing.
  98         docstring const getInfo() const;
  99         ///
 100         int count(docstring const & f) const { return bimap_.count(f); }
 101         ///
 102         const_iterator find(docstring const & f) const { return bimap_.find(f); }
 103         ///
 104         const_iterator end() const { return bimap_.end(); }
 105         ///
 106         docstring & operator[](docstring const & f)
 107                 { return bimap_[f]; }
 108         ///
 109         docstring const & allData() const { return all_data_; }
 110         ///
 111         void setAllData(docstring const & d) { all_data_ = d; }
 112         ///
 113         docstring entryType() const { return entry_type_; }
 114 private:
 115         /// true if from BibTeX; false if from bibliography environment
 116         bool is_bibtex_;
 117         /// the BibTeX key for this entry
 118         docstring bib_key_;
 119         /// a single string containing all BibTeX data associated with this key
 120         docstring all_data_;
 121         /// the BibTeX entry type (article, book, incollection, ...)
 122         docstring entry_type_;
 123         /// our map: <field, value>
 124         std::map <docstring, docstring> bimap_;
 125 };
 126
 127
 128 /// Class to represent a collection of bibliographical data, whether
 129 /// from BibTeX or from bibliography environments.
 130 /// BiblioInfo.first is the bibliography key
 131 /// BiblioInfo.second is the data for that key
 132 class BiblioInfo {
 133 public:
 134         ///
 135         BiblioInfo() {}
 136         ///
 137         typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
 138         /// Returns a sorted vector of bibliography keys
 139         std::vector<docstring> const getKeys() const;
 140         /// Returns a sorted vector of present BibTeX fields
 141         std::vector<docstring> const getFields() const;
 142         /// Returns a sorted vector of BibTeX entry types in use
 143         std::vector<docstring> const getEntries() const;
 144         /// Fills keys with BibTeX information derived from the various insets
 145         /// in a given buffer, in its master document.
 146         void fillWithBibKeys(Buffer const * const buf);
 147         /// return the short form of an authorlist
 148         docstring const getAbbreviatedAuthor(docstring const & key) const;
 149         /// return the year from the bibtex data record
 150         docstring const getYear(docstring const & key) const;
 151         /// Returns formatted BibTeX data associated with a given key.
 152         /// Empty if no info exists.
 153         docstring const getInfo(docstring const & key) const;
 154
 155         /**
 156           * "Translates" the available Citation Styles into strings for a given key,
 157           * either numerical or author-year depending upon the active engine. (See
 158           * below for those methods.)
 159           */
 160         std::vector<docstring> const
 161                         getCiteStrings(docstring const & key, Buffer const & buf) const;
 162         /**
 163                 * "Translates" the available Citation Styles into strings for a given key.
 164                 * The returned string is displayed by the GUI.
 165                 * [XX] is used in place of the actual reference
 166                 * Eg, the vector will contain: [XX], Jones et al. [XX], ...
 167                 * User supplies :
 168                 *  the key,
 169                 *  the buffer
 170                 */
 171         std::vector<docstring> const
 172                         getNumericalStrings(docstring const & key, Buffer const & buf) const;
 173         /**
 174                 * "Translates" the available Citation Styles into strings for a given key.
 175                 * The returned string is displayed by the GUI.
 176                 * Eg, the vector will contain:
 177                 *  Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
 178                 * User supplies :
 179                 *  the key,
 180                 *  the buffer
 181                 */
 182         std::vector<docstring> const
 183                         getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
 184         ///
 185         const_iterator begin() const { return bimap_.begin(); }
 186         ///
 187         void clear() { bimap_.clear(); }
 188         ///
 189         bool empty() const { return bimap_.empty(); }
 190         ///
 191         const_iterator end() const { return bimap_.end(); }
 192         ///
 193         const_iterator find(docstring const & f) const { return bimap_.find(f); }
 194         ///
 195         BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
 196         ///
 197         void addFieldName(docstring const & f) { field_names_.insert(f); }
 198         ///
 199         void addEntryType(docstring const & f) { entry_types_.insert(f); }
 200 private:
 201         ///
 202         std::set<docstring> field_names_;
 203         ///
 204         std::set<docstring> entry_types_;
 205         /// our map: keys --> BibTeXInfo
 206         std::map<docstring, BibTeXInfo> bimap_;
 207 };
 208
 209 } // namespace lyx
 210 #endif