---

biblio Namespace Reference

Functions of use to citation and bibtex GUI controllers and views. More...

Compounds
struct	biblio::CitationStyle
	Type returned by getCitationStyle, below. More...
struct	biblio::compareNoCase
struct	biblio::RegexMatch
Typedefs
typedef std::map< string, string >	InfoMap
	First entry is the bibliography key, second the data. More...
Enumerations
enum	CiteStyle {   CITE, CITET, CITEP, CITEALT,   CITEALP, CITEAUTHOR, CITEYEAR, CITEYEARPAR }
enum	Search { SIMPLE, REGEX }
enum	Direction { FORWARD, BACKWARD }
Functions
string const	familyName (string const &name)
string const	getAbbreviatedAuthor (InfoMap const &map, string const &key)
	return the short form of an authorlist. More...
string const	getYear (InfoMap const &map, string const &key)
vector< string > const	getKeys (InfoMap const &map)
	Returns a vector of bibliography keys. More...
string const	getInfo (InfoMap const &map, string const &key)
	Returns the BibTeX data associated with a given key. More...
string const	escape_special_chars (string const &expr)
vector< string >::const_iterator	searchKeys (InfoMap const &theMap, vector< string > const &keys, string const &search_expr, vector< string >::const_iterator start, Search type, Direction dir, bool caseSensitive)
	Returns an iterator to the first key that meets the search criterion, or end() if unsuccessful. More...
string const	parseBibTeX (string data, string const &findkey)
	Search a BibTeX info field for the given key and return the associated field. More...
CitationStyle const	getCitationStyle (string const &command)
	Given the LaTeX command, return the appropriate CitationStyle. More...
string const	getCiteCommand (CiteStyle command, bool full, bool forceUCase)
	Returns the LaTeX citation command. More...
vector< CiteStyle > const	getCiteStyles (bool usingNatbib)
	Returns a vector of available Citation styles. More...
vector< string > const	getNumericalStrings (string const &key, InfoMap const &map, vector< CiteStyle > const &styles)
	"Translates" the available Citation Styles into strings for this key. More...
vector< string > const	getAuthorYearStrings (string const &key, InfoMap const &map, vector< CiteStyle > const &styles)
	"Translates" the available Citation Styles into strings for this key. More...
Variables
char const *const	citeCommands []
unsigned int const	nCiteCommands
CiteStyle const	citeStyles []
unsigned int const	nCiteStyles
CiteStyle const	citeStylesFull []
unsigned int const	nCiteStylesFull
CiteStyle const	citeStylesUCase []
unsigned int const	nCiteStylesUCase

---

Detailed Description

Functions of use to citation and bibtex GUI controllers and views.

---

Typedef Documentation

typedef std::map<string, string> biblio::InfoMap

First entry is the bibliography key, second the data. Definition at line 52 of file biblio.h. Referenced by biblio::RegexMatch::RegexMatch.

---

Enumeration Type Documentation

enum biblio::CiteStyle

Enumeration values: CITE  CITET  CITEP  CITEALT  CITEALP  CITEAUTHOR  CITEYEAR  CITEYEARPAR  Definition at line 24 of file biblio.h. { CITE, CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR, CITEYEAR, CITEYEARPAR };

enum biblio::Direction

Enumeration values: FORWARD  BACKWARD  Definition at line 44 of file biblio.h. { FORWARD, BACKWARD };

enum biblio::Search

Enumeration values: SIMPLE  REGEX  Definition at line 36 of file biblio.h. { SIMPLE, REGEX };

---

Function Documentation

string const escape_special_chars (  string const &    expr )  [static]

Definition at line 249 of file biblio.C. { // Search for all chars '.|*?+(){}[^$]\' // Note that '[' and '\' must be escaped. // This is a limitation of boost::regex, but all other chars in BREs // are assumed literal. boost::RegEx reg("[].|*?+(){}^$\\[\\\\]"); // $& is a perl-like expression that expands to all of the current match // The '$' must be prefixed with the escape character '\' for // boost to treat it as a literal. // Thus, to prefix a matched expression with '\', we use: return STRCONV(reg.Merge(STRCONV(expr), "\\\\$&")); }

string const biblio::familyName (  string const &    name )

Definition at line 36 of file biblio.C. { // Very simple parser string fname = name; // possible authorname combinations are: // "Surname, FirstName" // "Surname, F." // "FirstName Surname" // "F. Surname" string::size_type idx = fname.find(','); if (idx != string::npos) return ltrim(fname.substr(0, idx)); idx = fname.rfind('.'); if (idx != string::npos) fname = ltrim(fname.substr(idx + 1)); // test if we have a LaTeX Space in front if (fname[0] == '\\') return fname.substr(2); return rtrim(fname); }

string const biblio::getAbbreviatedAuthor (  InfoMap const &    map, string const &    key )

return the short form of an authorlist. Definition at line 60 of file biblio.C. { Assert(!map.empty()); InfoMap::const_iterator it = map.find(key); if (it == map.end()) return string(); string const & data = it->second; // Is the entry a BibTeX one or one from lyx-layout "bibliography"? string::size_type const pos = data.find("TheBibliographyRef"); if (pos != string::npos) { if (pos <= 2) { return string(); } string const opt = trim(data.substr(0, pos - 1)); if (opt.empty()) return string(); string authors; split(opt, authors, '('); return authors; } string author = parseBibTeX(data, "author"); if (author.empty()) author = parseBibTeX(data, "editor"); if (author.empty()) { author = parseBibTeX(data, "key"); if (author.empty()) author = key; return author; } vector<string> const authors = getVectorFromString(author, " and "); if (authors.empty()) return author; if (authors.size() == 2) return bformat(_("%1$s and %2$s"), familyName(authors[0]), familyName(authors[1])); if (authors.size() > 2) return bformat(_("%1$s et al."), familyName(authors[0])); return familyName(authors[0]); }

std::vector< string > const biblio::getAuthorYearStrings (  string const &    key, InfoMap const &    map, std::vector< CiteStyle > const &    styles )

"Translates" the available Citation Styles into strings for this key. The returned string is displayed by the GUI. Eg, the vector will contain: Jones et al. (1990), (Jones et al. 1990), Jones et al. 1990, ... User supplies : the key, the InfoMap of bibkeys info, the available citation styles Definition at line 633 of file biblio.C. Referenced by ControlCitation::getCiteStrings. { if (map.empty()) { return vector<string>(); } string const author = getAbbreviatedAuthor(map, key); string const year = getYear(map, key); if (author.empty() || year.empty()) return vector<string>(); vector<string> vec(styles.size()); for (vector<string>::size_type i = 0; i != vec.size(); ++i) { string str; switch (styles[i]) { case CITE: case CITET: str = author + " (" + year + ')'; break; case CITEP: str = '(' + author + ", " + year + ')'; break; case CITEALT: str = author + ' ' + year ; break; case CITEALP: str = author + ", " + year ; break; case CITEAUTHOR: str = author; break; case CITEYEAR: str = year; break; case CITEYEARPAR: str = '(' + year + ')'; break; } vec[i] = str; } return vec; }

CitationStyle const biblio::getCitationStyle (  string const &    command )

Given the LaTeX command, return the appropriate CitationStyle. Definition at line 507 of file biblio.C. Referenced by QCitation::updateStyle, and updateStyle. { if (command.empty()) return CitationStyle(); CitationStyle cs; string cmd = command; if (cmd[0] == 'C') { cs.forceUCase = true; cmd[0] = 'c'; } size_t n = cmd.size() - 1; if (cmd[n] == '*') { cs.full = true; cmd = cmd.substr(0,n); } char const * const * const last = citeCommands + nCiteCommands; char const * const * const ptr = std::find(citeCommands, last, cmd); if (ptr != last) { size_t idx = ptr - citeCommands; cs.style = citeStyles[idx]; } return cs; }

string const biblio::getCiteCommand (  CiteStyle   , bool    full, bool    forceUCase )

Returns the LaTeX citation command. User supplies : The CiteStyle enum, a flag forcing the full author list, a flag forcing upper case, e.g. "della Casa" becomes "Della Case" Definition at line 537 of file biblio.C. Referenced by QCitation::apply, and FormCitation::apply. { string cite = citeCommands[command]; if (full) { CiteStyle const * last = citeStylesFull + nCiteStylesFull; if (std::find(citeStylesFull, last, command) != last) cite += '*'; } if (forceUCase) { CiteStyle const * last = citeStylesUCase + nCiteStylesUCase; if (std::find(citeStylesUCase, last, command) != last) cite[0] = 'C'; } return cite; }

std::vector< CiteStyle > const biblio::getCiteStyles (  bool    usingNatbib )

Returns a vector of available Citation styles. Definition at line 556 of file biblio.C. Referenced by ControlCitation::getCiteStrings, and ControlCitation::initialiseParams. { unsigned int nStyles = 1; unsigned int start = 0; if (usingNatbib) { nStyles = nCiteStyles - 1; start = 1; } vector<CiteStyle> styles(nStyles); vector<CiteStyle>::size_type i = 0; int j = start; for (; i != styles.size(); ++i, ++j) { styles[i] = citeStyles[j]; } return styles; }

string const biblio::getInfo (  InfoMap const &   , string const &    )

Returns the BibTeX data associated with a given key. Empty if no info exists. Definition at line 176 of file biblio.C. { Assert(!map.empty()); InfoMap::const_iterator it = map.find(key); if (it == map.end()) return string(); string const & data = it->second; // is the entry a BibTeX one or one from lyx-layout "bibliography"? string const separator("TheBibliographyRef"); string::size_type const pos = data.find(separator); if (pos != string::npos) { string::size_type const pos2 = pos + separator.size(); string const info = trim(data.substr(pos2)); return info; } // Search for all possible "required" keys string author = parseBibTeX(data, "author"); if (author.empty()) author = parseBibTeX(data, "editor"); string year = parseBibTeX(data, "year"); string title = parseBibTeX(data, "title"); string booktitle = parseBibTeX(data, "booktitle"); string chapter = parseBibTeX(data, "chapter"); string number = parseBibTeX(data, "number"); string volume = parseBibTeX(data, "volume"); string pages = parseBibTeX(data, "pages"); string media = parseBibTeX(data, "journal"); if (media.empty()) media = parseBibTeX(data, "publisher"); if (media.empty()) media = parseBibTeX(data, "school"); if (media.empty()) media = parseBibTeX(data, "institution"); ostringstream result; if (!author.empty()) result << author << ", "; if (!title.empty()) result << title; if (!booktitle.empty()) result << ", in " << booktitle; if (!chapter.empty()) result << ", Ch. " << chapter; if (!media.empty()) result << ", " << media; if (!volume.empty()) result << ", vol. " << volume; if (!number.empty()) result << ", no. " << number; if (!pages.empty()) result << ", pp. " << pages; if (!year.empty()) result << ", " << year; string const result_str = rtrim(STRCONV(result.str())); if (!result_str.empty()) return result_str; // This should never happen (or at least be very unusual!) return data; }

std::vector< string > const biblio::getKeys (  InfoMap const &    map )

Returns a vector of bibliography keys. Definition at line 162 of file biblio.C. Referenced by FormCitation::update, and QCitation::update_contents. { vector<string> bibkeys; InfoMap::const_iterator it = map.begin(); InfoMap::const_iterator end = map.end(); for (; it != end; ++it) { bibkeys.push_back(it->first); } std::sort(bibkeys.begin(), bibkeys.end(), compareNoCase()); return bibkeys; }

std::vector< string > const biblio::getNumericalStrings (  string const &    key, InfoMap const &    map, std::vector< CiteStyle > const &    styles )

"Translates" the available Citation Styles into strings for this key. The returned string is displayed by the GUI. [XX] is used in place of the actual reference Eg, the vector will contain: [XX], Jones et al. [XX], ... User supplies : the key, the InfoMap of bibkeys info, the available citation styles Definition at line 578 of file biblio.C. Referenced by ControlCitation::getCiteStrings. { if (map.empty()) { return vector<string>(); } string const author = getAbbreviatedAuthor(map, key); string const year = getYear(map, key); if (author.empty() || year.empty()) return vector<string>(); vector<string> vec(styles.size()); for (vector<string>::size_type i = 0; i != vec.size(); ++i) { string str; switch (styles[i]) { case CITE: case CITEP: str = "[#ID]"; break; case CITET: str = author + " [#ID]"; break; case CITEALT: str = author + " #ID"; break; case CITEALP: str = "#ID"; break; case CITEAUTHOR: str = author; break; case CITEYEAR: str = year; break; case CITEYEARPAR: str = '(' + year + ')'; break; } vec[i] = str; } return vec; }

string const biblio::getYear (  InfoMap const &    map, string const &    key )

Definition at line 112 of file biblio.C. { Assert(!map.empty()); InfoMap::const_iterator it = map.find(key); if (it == map.end()) return string(); string const & data = it->second; // Is the entry a BibTeX one or one from lyx-layout "bibliography"? string::size_type const pos = data.find("TheBibliographyRef"); if (pos != string::npos) { if (pos <= 2) { return string(); } string const opt = trim(data.substr(0, pos - 1)); if (opt.empty()) return string(); string authors; string const tmp = split(opt, authors, '('); string year; split(tmp, year, ')'); return year; } string year = parseBibTeX(data, "year"); if (year.empty()) year = _("No year"); return year; }

string const biblio::parseBibTeX (  string    data, string const &    findkey )

Search a BibTeX info field for the given key and return the associated field. Definition at line 344 of file biblio.C. { string keyvalue; // at first we delete all characters right of '%' and // replace tabs through a space and remove leading spaces // we read the data line by line so that the \n are // ignored, too. string data_; int Entries = 0; string dummy = token(data,'\n', Entries); while (!dummy.empty()) { dummy = subst(dummy, '\t', ' '); // no tabs dummy = ltrim(dummy); // no leading spaces // ignore lines with a beginning '%' or ignore all right of % string::size_type const idx = dummy.empty() ? string::npos : dummy.find('%'); if (idx != string::npos) dummy.erase(idx, string::npos); // do we have a new token or a new line of // the same one? In the first case we ignore // the \n and in the second we replace it // with a space if (!dummy.empty()) { if (!contains(dummy, "=")) data_ += ' ' + dummy; else data_ += dummy; } dummy = token(data, '\n', ++Entries); } // replace double commas with "" for easy scanning data = subst(data_, ",,", "\"\""); // unlikely! if (data.empty()) return string(); // now get only the important line of the bibtex entry. // all entries are devided by ',' except the last one. data += ','; // now we have same behaviour for all entries // because the last one is "blah ... }" Entries = 0; bool found = false; // parsing of title and booktitle is different from the // others, because booktitle contains title do { dummy = token(data, ',', Entries++); if (!dummy.empty()) { found = contains(ascii_lowercase(dummy), findkey); if (findkey == "title" && contains(ascii_lowercase(dummy), "booktitle")) found = false; } } while (!found && !dummy.empty()); if (dummy.empty()) // no such keyword return string(); // we are not sure, if we get all, because "key= "blah, blah" is // allowed. // Therefore we read all until the next "=" character, which follows a // new keyword keyvalue = dummy; dummy = token(data, ',', Entries++); while (!contains(dummy, '=') && !dummy.empty()) { keyvalue += ',' + dummy; dummy = token(data, ',', Entries++); } // replace double "" with originals ,, (two commas) // leaving us with the all-important line data = subst(keyvalue, "\"\"", ",,"); // Clean-up. // 1. Spaces data = rtrim(data); // 2. if there is no opening '{' then a closing '{' is probably cruft. if (!contains(data, '{')) data = rtrim(data, "}"); // happens, when last keyword string::size_type const idx = !data.empty() ? data.find('=') : string::npos; if (idx == string::npos) return string(); data = trim(data.substr(idx)); if (data.length() < 2 || data[0] != '=') { // a valid entry? return string(); } else { // delete '=' and the following spaces data = ltrim(data, " ="); if (data.length() < 2) { return data; // not long enough to find delimiters } else { string::size_type keypos = 1; char enclosing; if (data[0] == '{') { enclosing = '}'; } else if (data[0] == '"') { enclosing = '"'; } else { // no {} and no "", pure data but with a // possible ',' at the end return rtrim(data, ","); } string tmp = data.substr(keypos); while (tmp.find('{') != string::npos && tmp.find('}') != string::npos && tmp.find('{') < tmp.find('}') && tmp.find('{') < tmp.find(enclosing)) { keypos += tmp.find('{') + 1; tmp = data.substr(keypos); keypos += tmp.find('}') + 1; tmp = data.substr(keypos); } if (tmp.find(enclosing) == string::npos) return data; else { keypos += tmp.find(enclosing); return data.substr(1, keypos - 1); } } } }

std::vector< string >::const_iterator biblio::searchKeys (  InfoMap const &    map, std::vector< string > const &    keys_to_search, string const &    search_expression, std::vector< string >::const_iterator    start, Search   , Direction   , bool    caseSensitive = false )

Returns an iterator to the first key that meets the search criterion, or end() if unsuccessful. User supplies : the InfoMap of bibkeys info, the vector of keys to be searched, the search criterion, an iterator defining the starting point of the search, an enum defining a Simple or Regex search, an enum defining the search direction. Definition at line 301 of file biblio.C. Referenced by QCitationDialog::find, and FormCitation::findBiblio. { // Preliminary checks if (start < keys.begin() || start >= keys.end()) return keys.end(); string expr = trim(search_expr); if (expr.empty()) return keys.end(); if (type == SIMPLE) // We must escape special chars in the search_expr so that // it is treated as a simple string by boost::regex. expr = escape_special_chars(expr); // Build the functor that will be passed to find_if. RegexMatch const match(theMap, expr, !caseSensitive); if (!match.validRE()) return keys.end(); // Search the vector of 'keys' from 'start' for one that matches the // predicate 'match'. Searching can be forward or backward from start. if (dir == FORWARD) return std::find_if(start, keys.end(), match); vector<string>::const_reverse_iterator rit(start); vector<string>::const_reverse_iterator rend = keys.rend(); rit = std::find_if(rit, rend, match); if (rit == rend) return keys.end(); // This is correct and always safe. // (See Meyer's Effective STL, Item 28.) return (++rit).base(); }

---

Variable Documentation

char const* const biblio::citeCommands[] [static]

Initial value: { "cite", "citet", "citep", "citealt", "citealp", "citeauthor", "citeyear", "citeyearpar" } Definition at line 478 of file biblio.C.

CiteStyle const biblio::citeStyles[] [static]

Initial value: { CITE, CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR, CITEYEAR, CITEYEARPAR } Definition at line 485 of file biblio.C.

CiteStyle const biblio::citeStylesFull[] [static]

Initial value: { CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR } Definition at line 492 of file biblio.C.

CiteStyle const biblio::citeStylesUCase[] [static]

Initial value: { CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR } Definition at line 498 of file biblio.C.

unsigned int const biblio::nCiteCommands [static]

Initial value: sizeof(citeCommands) / sizeof(char *) Definition at line 482 of file biblio.C.

unsigned int const biblio::nCiteStyles [static]

Initial value: sizeof(citeStyles) / sizeof(CiteStyle) Definition at line 489 of file biblio.C.

unsigned int const biblio::nCiteStylesFull [static]

Initial value: sizeof(citeStylesFull) / sizeof(CiteStyle) Definition at line 495 of file biblio.C.

unsigned int const biblio::nCiteStylesUCase [static]

Initial value: sizeof(citeStylesUCase) / sizeof(CiteStyle) Definition at line 501 of file biblio.C.

---