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 the short form of an authorlist, used for sorting
  59         /// this will be translated to the UI language if buf is null
  60         /// otherwise, it will be translated to the buffer language.
  61         docstring const getAbbreviatedAuthor(
  62             Buffer const * buf = 0, bool jurabib_style = false) const;
  63         ///
  64         docstring const getYear() const;
  65         /// \return formatted BibTeX data suitable for framing.
  66         /// \param vector of pointers to crossref/xdata information
  67         docstring const & getInfo(BibTeXInfoList const xrefs,
  68                         Buffer const & buf, bool richtext) const;
  69         /// \return formatted BibTeX data for a citation label
  70         docstring const getLabel(BibTeXInfoList const xrefs,
  71                 Buffer const & buf, docstring const & format, bool richtext,
  72                 const docstring & before, const docstring & after,
  73                 const docstring & dialog, bool next = false) const;
  74         ///
  75         const_iterator find(docstring const & f) const { return bimap_.find(f); }
  76         ///
  77         const_iterator end() const { return bimap_.end(); }
  78         /// \return value for field f
  79         /// note that this will create an empty field if it does not exist
  80         docstring & operator[](docstring const & f)
  81                 { return bimap_[f]; }
  82         /// \return value for field f
  83         /// this one, since it is const, will simply return docstring() if
  84         /// we don't have the field and will NOT create an empty field
  85         docstring const & operator[](docstring const & field) const;
  86         ///
  87         docstring const & operator[](std::string const & field) const;
  88         ///
  89         docstring const & allData() const { return all_data_; }
  90         ///
  91         void setAllData(docstring const & d) { all_data_ = d; }
  92         ///
  93         void label(docstring const & d) { label_= d; }
  94         ///
  95         void key(docstring const & d) { bib_key_= d; }
  96         ///
  97         docstring const & label() const { return label_; }
  98         ///
  99         docstring const & key() const { return bib_key_; }
 100         /// numerical key for citing this entry. currently used only
 101         /// by XHTML output routines.
 102         docstring citeNumber() const { return cite_number_; }
 103         ///
 104         void setCiteNumber(docstring const & num) { cite_number_ = num; }
 105         /// a,b,c, etc, for author-year. currently used only by XHTML
 106         /// output routines.
 107         char modifier() const { return modifier_; }
 108         ///
 109         void setModifier(char c) { modifier_ = c; }
 110         ///
 111         docstring entryType() const { return entry_type_; }
 112         ///
 113         bool isBibTeX() const { return is_bibtex_; }
 114 private:
 115         /// like operator[], except, if the field is empty, it will attempt
 116         /// to get the data from xref BibTeXInfo objects, which would normally
 117         /// be the one referenced in the crossref or xdata field.
 118         docstring getValueForKey(std::string const & key, Buffer const & buf,
 119                 docstring const & before, docstring const & after, docstring const & dialog,
 120                 BibTeXInfoList const xrefs, size_t maxsize = 4096) const;
 121         /// replace %keys% in a format string with their values
 122         /// called from getInfo()
 123         /// format strings may contain:
 124         ///   %key%, which represents a key
 125         ///   {%key%[[format]]}, which prints format if key is non-empty
 126         /// the latter may optionally contain an `else' clause as well:
 127         ///   {%key%[[if format]][[else format]]}
 128         /// Material intended only for rich text (HTML) output should be
 129         /// wrapped in "{!" and "!}". These markers are to be postprocessed
 130         /// by processRichtext(); this step is left as a separate routine since
 131         /// expandFormat() is recursive while postprocessing should be done
 132         /// only once on the final string (just like convertLaTeXCommands).
 133         /// a simple macro facility is also available. keys that look like
 134         /// "%!key%" are substituted with their definition.
 135         /// moreover, keys that look like "%_key%" are treated as translatable
 136         /// so that things like "pp." and "vol." can be translated.
 137         docstring expandFormat(docstring const & fmt,
 138                 BibTeXInfoList const xrefs, int & counter,
 139                 Buffer const & buf, docstring before = docstring(),
 140                 docstring after = docstring(), docstring dialog = docstring(),
 141                 bool next = false) const;
 142         /// true if from BibTeX; false if from bibliography environment
 143         bool is_bibtex_;
 144         /// the BibTeX key for this entry
 145         docstring bib_key_;
 146         /// the label that will appear in citations
 147         /// this is easily set from bibliography environments, but has
 148         /// to be calculated for entries we get from BibTeX
 149         docstring label_;
 150         /// a single string containing all BibTeX data associated with this key
 151         docstring all_data_;
 152         /// the BibTeX entry type (article, book, incollection, ...)
 153         docstring entry_type_;
 154         /// a cache for getInfo()
 155         mutable docstring info_;
 156         /// a cache for getInfo(richtext = true)
 157         mutable docstring info_richtext_;
 158         ///
 159         docstring cite_number_;
 160         ///
 161         char modifier_;
 162         /// our map: <field, value>
 163         std::map <docstring, docstring> bimap_;
 164 };
 165
 166
 167 /// Class to represent a collection of bibliographical data, whether
 168 /// from BibTeX or from bibliography environments.
 169 class BiblioInfo {
 170 public:
 171         ///
 172         typedef std::vector<BibTeXInfo const *> BibTeXInfoList;
 173         /// bibliography key --> data for that key
 174         typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
 175         /// Get a vector with all external data (crossref, xdata)
 176         std::vector<docstring> const getXRefs(BibTeXInfo const & data,
 177                                               bool const nested = false) const;
 178         /// \return a sorted vector of bibliography keys
 179         std::vector<docstring> const getKeys() const;
 180         /// \return a sorted vector of present BibTeX fields
 181         std::vector<docstring> const getFields() const;
 182         /// \return a sorted vector of BibTeX entry types in use
 183         std::vector<docstring> const getEntries() const;
 184         /// \return the short form of an authorlist
 185         docstring const getAbbreviatedAuthor(docstring const & key, Buffer const & buf) const;
 186         /// \return the year from the bibtex data record for \param key
 187         /// if \param use_modifier is true, then we will also append any
 188         /// modifier for this entry (e.g., 1998b).
 189         /// If no legacy year field is present, check for date (common in
 190         /// biblatex) and extract the year from there.
 191         /// Note further that this will get the year from the crossref or xdata
 192         /// if it's not present in the record itself.
 193         docstring const getYear(docstring const & key,
 194                         bool use_modifier = false) const;
 195         /// \return the year from the bibtex data record for \param key
 196         /// if \param use_modifier is true, then we will also append any
 197         /// modifier for this entry (e.g., 1998b).
 198         /// If no legacy year field is present, check for date (common in
 199         /// biblatex) and extract the year from there.
 200         /// Note further that this will get the year from the crossref or xdata
 201         /// if it's not present in the record itself.
 202         /// If no year is found, \return "No year" translated to the buffer
 203         /// language.
 204         docstring const getYear(docstring const & key, Buffer const & buf,
 205                         bool use_modifier = false) const;
 206         ///
 207         docstring const getCiteNumber(docstring const & key) const;
 208         /// \return formatted BibTeX data associated with a given key.
 209         /// Empty if no info exists.
 210         /// Note that this will retrieve data from the crossref or xdata as needed.
 211         /// If \param richtext is true, then it will output any richtext tags
 212         /// marked in the citation format and escape < and > elsewhere.
 213         docstring const getInfo(docstring const & key, Buffer const & buf,
 214                         bool richtext = false) const;
 215         /// \return formatted BibTeX data for citation labels.
 216         /// Citation labels can have more than one key.
 217         docstring const getLabel(std::vector<docstring> keys,
 218                 Buffer const & buf, std::string const & style, bool for_xhtml,
 219                 size_t max_size, docstring const & before, docstring const & after,
 220                 docstring const & dialog = docstring()) const;
 221         /// Is this a reference from a bibtex database
 222         /// or from a bibliography environment?
 223         bool isBibtex(docstring const & key) const;
 224         /// Translates the available citation styles into strings for a given
 225         /// list of keys, using either numerical or author-year style depending
 226         /// upon the active engine.
 227         std::vector<docstring> const getCiteStrings(std::vector<docstring> const & keys,
 228                 std::vector<CitationStyle> const & styles, Buffer const & buf,
 229                 docstring const & before, docstring const & after, docstring const & dialog,
 230           size_t max_size) 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