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  * \author Julien Rioux
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef BIBLIOINFO_H
  16 #define BIBLIOINFO_H
  17
  18 #include "support/docstring.h"
  19
  20 #include "BufferParams.h"
  21 #include "Citation.h"
  22
  23 #include <map>
  24 #include <set>
  25 #include <vector>
  26
  27
  28 namespace lyx {
  29
  30 class Buffer;
  31
  32 /// \param latex_str a LaTeX command, "cite", "Citep*", etc
  33 CitationStyle citationStyleFromString(std::string const & latex_str,
  34                                       BufferParams const &);
  35 /// the other way round
  36 std::string citationStyleToString(CitationStyle const &, bool const latex = false);
  37
  38
  39 /// Class to represent information about a BibTeX or
  40 /// bibliography entry.
  41 /// This class basically wraps a std::map, and many of its
  42 /// methods simply delegate to the corresponding methods of
  43 /// std::map.
  44 class BibTeXInfo {
  45 public:
  46         /// The keys are BibTeX fields (e.g., author, title, etc),
  47         /// and the values are the associated field values.
  48         typedef std::map<docstring, docstring>::const_iterator const_iterator;
  49         ///
  50         typedef std::vector<BibTeXInfo const *> const BibTeXInfoList;
  51         ///
  52         BibTeXInfo() : is_bibtex_(true), modifier_(0) {}
  53         /// argument sets isBibTeX_, so should be false only if it's coming
  54         /// from a bibliography environment
  55         BibTeXInfo(bool ib) : is_bibtex_(ib), modifier_(0) {}
  56         /// constructor that sets the entryType
  57         BibTeXInfo(docstring const & key, docstring const & type);
  58         /// \return an author or editor list (short form by default),
  59         /// used for sorting.
  60         /// This will be translated to the UI language if buf is null
  61         /// otherwise, it will be translated to the buffer language.
  62         docstring const getAuthorOrEditorList(Buffer const * buf = 0, bool full = false,
  63                                       bool forceshort = false) const;
  64         /// Same for a specific author role (editor, author etc.)
  65         docstring const getAuthorList(Buffer const * buf = 0, docstring author = docstring(),
  66                                       bool full = false, bool forceshort = false,
  67                                       bool allnames = false, bool beginning = true) const;
  68         ///
  69         docstring const getYear() const;
  70         /// \return formatted BibTeX data suitable for framing.
  71         /// \param vector of pointers to crossref/xdata information
  72         docstring const & getInfo(BibTeXInfoList const xrefs,
  73                         Buffer const & buf, CiteItem const & ci) const;
  74         /// \return formatted BibTeX data for a citation label
  75         docstring const getLabel(BibTeXInfoList const xrefs,
  76                 Buffer const & buf, docstring const & format,
  77                 CiteItem const & ci, bool next = false, bool second = false) const;
  78         ///
  79         const_iterator find(docstring const & f) const { return bimap_.find(f); }
  80         ///
  81         const_iterator end() const { return bimap_.end(); }
  82         /// \return value for field f
  83         /// note that this will create an empty field if it does not exist
  84         docstring & operator[](docstring const & f)
  85                 { return bimap_[f]; }
  86         /// \return value for field f
  87         /// this one, since it is const, will simply return docstring() if
  88         /// we don't have the field and will NOT create an empty field
  89         docstring const & operator[](docstring const & field) const;
  90         ///
  91         docstring const & operator[](std::string const & field) const;
  92         ///
  93         docstring const & allData() const { return all_data_; }
  94         ///
  95         void setAllData(docstring const & d) { all_data_ = d; }
  96         ///
  97         void label(docstring const & d) { label_= d; }
  98         ///
  99         void key(docstring const & d) { bib_key_= d; }
 100         ///
 101         docstring const & label() const { return label_; }
 102         ///
 103         docstring const & key() const { return bib_key_; }
 104         /// numerical key for citing this entry. currently used only
 105         /// by XHTML output routines.
 106         docstring citeNumber() const { return cite_number_; }
 107         ///
 108         void setCiteNumber(docstring const & num) { cite_number_ = num; }
 109         /// a,b,c, etc, for author-year. currently used only by XHTML
 110         /// output routines.
 111         char modifier() const { return modifier_; }
 112         ///
 113         void setModifier(char c) { modifier_ = c; }
 114         ///
 115         docstring entryType() const { return entry_type_; }
 116         ///
 117         bool isBibTeX() const { return is_bibtex_; }
 118 private:
 119         /// like operator[], except, if the field is empty, it will attempt
 120         /// to get the data from xref BibTeXInfo objects, which would normally
 121         /// be the one referenced in the crossref or xdata field.
 122         docstring getValueForKey(std::string const & key, Buffer const & buf,
 123                 CiteItem const & ci, BibTeXInfoList const xrefs, size_t maxsize = 4096) const;
 124         /// replace %keys% in a format string with their values
 125         /// called from getInfo()
 126         /// format strings may contain:
 127         ///   %key%, which represents a key
 128         ///   {%key%[[format]]}, which prints format if key is non-empty
 129         /// the latter may optionally contain an `else' clause as well:
 130         ///   {%key%[[if format]][[else format]]}
 131         /// Material intended only for rich text (HTML) output should be
 132         /// wrapped in "{!" and "!}". These markers are to be postprocessed
 133         /// by processRichtext(); this step is left as a separate routine since
 134         /// expandFormat() is recursive while postprocessing should be done
 135         /// only once on the final string (just like convertLaTeXCommands).
 136         /// a simple macro facility is also available. keys that look like
 137         /// "%!key%" are substituted with their definition.
 138         /// moreover, keys that look like "%_key%" are treated as translatable
 139         /// so that things like "pp." and "vol." can be translated.
 140         docstring expandFormat(docstring const & fmt,
 141                 BibTeXInfoList const xrefs, int & counter,
 142                 Buffer const & buf, CiteItem const & ci,
 143                 bool next = false, bool second = false) const;
 144         /// true if from BibTeX; false if from bibliography environment
 145         bool is_bibtex_;
 146         /// the BibTeX key for this entry
 147         docstring bib_key_;
 148         /// the label that will appear in citations
 149         /// this is easily set from bibliography environments, but has
 150         /// to be calculated for entries we get from BibTeX
 151         docstring label_;
 152         /// a single string containing all BibTeX data associated with this key
 153         docstring all_data_;
 154         /// the BibTeX entry type (article, book, incollection, ...)
 155         docstring entry_type_;
 156         /// a cache for getInfo()
 157         mutable docstring info_;
 158         /// a cache for getInfo(richtext = true)
 159         mutable docstring info_richtext_;
 160         ///
 161         docstring cite_number_;
 162         ///
 163         char modifier_;
 164         /// our map: <field, value>
 165         std::map <docstring, docstring> bimap_;
 166 };
 167
 168
 169 /// Class to represent a collection of bibliographical data, whether
 170 /// from BibTeX or from bibliography environments.
 171 class BiblioInfo {
 172 public:
 173         ///
 174         typedef std::vector<BibTeXInfo const *> BibTeXInfoList;
 175         /// bibliography key --> data for that key
 176         typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
 177         /// Get a vector with all external data (crossref, xdata)
 178         std::vector<docstring> const getXRefs(BibTeXInfo const & data,
 179                                               bool const nested = false) const;
 180         /// \return a sorted vector of bibliography keys
 181         std::vector<docstring> const getKeys() const;
 182         /// \return a sorted vector of present BibTeX fields
 183         std::vector<docstring> const getFields() const;
 184         /// \return a sorted vector of BibTeX entry types in use
 185         std::vector<docstring> const getEntries() const;
 186         /// \return author or editor list (abbreviated form by default)
 187         docstring const getAuthorOrEditorList(docstring const & key, Buffer const & buf) const;
 188         /// \return the year from the bibtex data record for \param key
 189         /// if \param use_modifier is true, then we will also append any
 190         /// modifier for this entry (e.g., 1998b).
 191         /// If no legacy year field is present, check for date (common in
 192         /// biblatex) and extract the year from there.
 193         /// Note further that this will get the year from the crossref or xdata
 194         /// if it's not present in the record itself.
 195         docstring const getYear(docstring const & key,
 196                         bool use_modifier = false) const;
 197         /// \return the year from the bibtex data record for \param key
 198         /// if \param use_modifier is true, then we will also append any
 199         /// modifier for this entry (e.g., 1998b).
 200         /// If no legacy year field is present, check for date (common in
 201         /// biblatex) and extract the year from there.
 202         /// Note further that this will get the year from the crossref or xdata
 203         /// if it's not present in the record itself.
 204         /// If no year is found, \return "No year" translated to the buffer
 205         /// language.
 206         docstring const getYear(docstring const & key, Buffer const & buf,
 207                         bool use_modifier = false) const;
 208         ///
 209         docstring const getCiteNumber(docstring const & key) const;
 210         /// \return formatted BibTeX data associated with a given key.
 211         /// Empty if no info exists.
 212         /// Note that this will retrieve data from the crossref or xdata as needed.
 213         /// \param ci contains further context information, such as if it should
 214         /// output any richtext tags marked in the citation format and escape < and >
 215         /// elsewhere, and the general output context.
 216         docstring const getInfo(docstring const & key, Buffer const & buf,
 217                         CiteItem const & ci) const;
 218         /// \return formatted BibTeX data for citation labels.
 219         /// Citation labels can have more than one key.
 220         docstring const getLabel(std::vector<docstring> keys, Buffer const & buf,
 221                                  std::string const & style, CiteItem const & ci) const;
 222         /// Is this a reference from a bibtex database
 223         /// or from a bibliography environment?
 224         bool isBibtex(docstring const & key) const;
 225         /// Translates the available citation styles into strings for a given
 226         /// list of keys, using either numerical or author-year style depending
 227         /// upon the active engine.
 228         std::vector<docstring> const getCiteStrings(std::vector<docstring> const & keys,
 229                 std::vector<CitationStyle> const & styles, Buffer const & buf,
 230                 CiteItem const & ci) const;
 231         /// A list of BibTeX keys cited in the current document, sorted by
 232         /// the last name of the author.
 233         /// Make sure you have called collectCitedEntries() before you try to
 234         /// use this. You should probably call it just before you use this.
 235         std::vector<docstring> const & citedEntries() const
 236                 { return cited_entries_; }
 237         ///
 238         void makeCitationLabels(Buffer const & buf);
 239         ///
 240         const_iterator begin() const { return bimap_.begin(); }
 241         ///
 242         void clear() { bimap_.clear(); }
 243         ///
 244         bool empty() const { return bimap_.empty(); }
 245         ///
 246         const_iterator end() const { return bimap_.end(); }
 247         ///
 248         const_iterator find(docstring const & f) const { return bimap_.find(f); }
 249         ///
 250         void mergeBiblioInfo(BiblioInfo const & info);
 251         ///
 252         BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
 253         ///
 254         void addFieldName(docstring const & f) { field_names_.insert(f); }
 255         ///
 256         void addEntryType(docstring const & f) { entry_types_.insert(f); }
 257 private:
 258         /// Collects the cited entries from buf.
 259         void collectCitedEntries(Buffer const & buf);
 260         ///
 261         std::set<docstring> field_names_;
 262         ///
 263         std::set<docstring> entry_types_;
 264         /// our map: keys --> BibTeXInfo
 265         std::map<docstring, BibTeXInfo> bimap_;
 266         /// a possibly sorted list of entries cited in our Buffer.
 267         /// do not try to make this a vector<BibTeXInfo *> or anything of
 268         /// the sort, because reloads will invalidate those pointers.
 269         std::vector<docstring> cited_entries_;
 270 };
 271
 272 } // namespace lyx
 273
 274 #endif // BIBLIOINFO_H