src/frontends/controllers/biblio.h

   1 // -*- C++ -*-
   2 /**
   3  * \file biblio.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  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 #ifndef BIBLIOHELPERS_H
  13 #define BIBLIOHELPERS_H
  14
  15
  16 #include "LString.h"
  17 #include <map>
  18 #include <vector>
  19
  20 /** Functions of use to citation and bibtex GUI controllers and views */
  21 namespace biblio {
  22
  23 ///
  24 enum CiteStyle {
  25         CITE,
  26         CITET,
  27         CITEP,
  28         CITEALT,
  29         CITEALP,
  30         CITEAUTHOR,
  31         CITEYEAR,
  32         CITEYEARPAR
  33 };
  34
  35 ///
  36 enum Search {
  37         ///
  38         SIMPLE,
  39         ///
  40         REGEX
  41 };
  42
  43 ///
  44 enum Direction {
  45         ///
  46         FORWARD,
  47         ///
  48         BACKWARD
  49 };
  50
  51 /// First entry is the bibliography key, second the data
  52 typedef std::map<string, string> InfoMap;
  53
  54 /// Returns a vector of bibliography keys
  55 std::vector<string> const getKeys(InfoMap const &);
  56
  57 /** Returns the BibTeX data associated with a given key.
  58     Empty if no info exists. */
  59 string const getInfo(InfoMap const &, string const &);
  60
  61 // rturn the year from the bibtex data record
  62 string const getYear(InfoMap const & map, string const & key);
  63
  64 /// return the short form of an authorlist
  65 string const getAbbreviatedAuthor(InfoMap const & map, string const & key);
  66
  67 // return only the family name
  68 string const familyName(string const & name);
  69
  70 /** Search a BibTeX info field for the given key and return the
  71     associated field. */
  72 string const parseBibTeX(string data, string const & findkey);
  73
  74 /** Returns an iterator to the first key that meets the search
  75     criterion, or end() if unsuccessful.
  76
  77     User supplies :
  78     the InfoMap of bibkeys info,
  79     the vector of keys to be searched,
  80     the search criterion,
  81     an iterator defining the starting point of the search,
  82     an enum defining a Simple or Regex search,
  83     an enum defining the search direction.
  84 */
  85
  86 std::vector<string>::const_iterator
  87 searchKeys(InfoMap const & map,
  88            std::vector<string> const & keys_to_search,
  89            string const & search_expression,
  90            std::vector<string>::const_iterator start,
  91            Search,
  92            Direction,
  93            bool caseSensitive=false);
  94
  95 /// Type returned by getCitationStyle, below
  96 struct CitationStyle {
  97         ///
  98         CitationStyle() : style(CITE), full(false), forceUCase(false) {}
  99         ///
 100         CiteStyle style;
 101         ///
 102         bool full;
 103         ///
 104         bool forceUCase;
 105 };
 106
 107 /// Given the LaTeX command, return the appropriate CitationStyle
 108 CitationStyle const getCitationStyle(string const & command);
 109
 110 /** Returns the LaTeX citation command
 111
 112 User supplies :
 113 The CiteStyle enum,
 114 a flag forcing the full author list,
 115 a flag forcing upper case, e.g. "della Casa" becomes "Della Case"
 116 */
 117 string const getCiteCommand(CiteStyle, bool full, bool forceUCase);
 118
 119 /// Returns a vector of available Citation styles.
 120 std::vector<CiteStyle> const getCiteStyles(bool usingNatbib);
 121
 122 /**
 123    "Translates" the available Citation Styles into strings for this key.
 124    The returned string is displayed by the GUI.
 125
 126
 127    [XX] is used in place of the actual reference
 128    Eg, the vector will contain: [XX], Jones et al. [XX], ...
 129
 130    User supplies :
 131    the key,
 132    the InfoMap of bibkeys info,
 133    the available citation styles
 134 */
 135 std::vector<string> const
 136 getNumericalStrings(string const & key,
 137                     InfoMap const & map,
 138                     std::vector<CiteStyle> const & styles);
 139
 140 /**
 141    "Translates" the available Citation Styles into strings for this key.
 142    The returned string is displayed by the GUI.
 143
 144    Eg, the vector will contain:
 145    Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ...
 146
 147    User supplies :
 148    the key,
 149    the InfoMap of bibkeys info,
 150    the available citation styles
 151 */
 152 std::vector<string> const
 153 getAuthorYearStrings(string const & key,
 154                      InfoMap const & map,
 155                      std::vector<CiteStyle> const & styles);
 156 } // namespace biblio
 157
 158 #endif // BIBLIOHELPERS_H