src/frontends/controllers/biblio.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 2001 The LyX Team.
   7  *
   8  * ======================================================
   9  *
  10  * \file biblio.C
  11  * \author Angus Leeming <a.leeming@ic.ac.uk>
  12  * \author Herbert Voss <voss@perce.de>
  13  */
  14
  15 #include <config.h>
  16
  17 #ifdef __GNUG__
  18 #pragma implementation
  19 #endif
  20
  21 #include "LString.h"
  22 #include "biblio.h"
  23 #include "gettext.h" // for _()
  24 #include "helper_funcs.h"
  25 #include "support/lstrings.h"
  26 #include "support/LAssert.h"
  27
  28 #include <boost/regex.hpp>
  29
  30 #include <algorithm>
  31
  32 using std::find;
  33 using std::min;
  34 using std::vector;
  35 using std::sort;
  36
  37 namespace biblio
  38 {
  39
  40 namespace {
  41
  42 using namespace biblio;
  43
  44 char const * const citeCommands[] = {
  45         "cite", "citet", "citep", "citealt", "citealp", "citeauthor",
  46         "citeyear", "citeyearpar" };
  47
  48 unsigned int const nCiteCommands =
  49         sizeof(citeCommands) / sizeof(char *);
  50
  51 CiteStyle const citeStyles[] = {
  52         CITE, CITET, CITEP, CITEALT, CITEALP,
  53         CITEAUTHOR, CITEYEAR, CITEYEARPAR };
  54
  55 unsigned int const nCiteStyles =
  56         sizeof(citeStyles) / sizeof(CiteStyle);
  57
  58 CiteStyle const citeStylesFull[] = {
  59         CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR };
  60
  61 unsigned int const nCiteStylesFull =
  62         sizeof(citeStylesFull) / sizeof(CiteStyle);
  63
  64 CiteStyle const citeStylesUCase[] = {
  65         CITET, CITEP, CITEALT, CITEALP, CITEAUTHOR };
  66
  67 unsigned int const nCiteStylesUCase =
  68         sizeof(citeStylesUCase) / sizeof(CiteStyle);
  69
  70
  71 // The functions doing the dirty work for the search.
  72 vector<string>::const_iterator
  73 simpleSearch(InfoMap const & theMap,
  74              vector<string> const & keys,
  75              string const & expr,
  76              vector<string>::const_iterator start,
  77              Direction dir,
  78              bool caseSensitive)
  79 {
  80         string tmp = expr;
  81         if (!caseSensitive)
  82                 tmp = lowercase(tmp);
  83
  84         vector<string> searchwords = getVectorFromString(tmp, " ");
  85
  86         // Loop over all keys from start...
  87         for (vector<string>::const_iterator it = start;
  88              // End condition is direction-dependent.
  89              (dir == FORWARD) ? (it<keys.end()) : (it>=keys.begin());
  90              // increment is direction-dependent.
  91              (dir == FORWARD) ? (++it) : (--it)) {
  92
  93                 string data = (*it);
  94                 InfoMap::const_iterator info = theMap.find(*it);
  95                 if (info != theMap.end())
  96                         data += " " + info->second;
  97                 if (!caseSensitive)
  98                         data = lowercase(data);
  99
 100                 bool found = true;
 101
 102                 // Loop over all search words...
 103                 for (vector<string>::const_iterator sit = searchwords.begin();
 104                      sit != searchwords.end(); ++sit) {
 105                         if (data.find(*sit) == string::npos) {
 106                                 found = false;
 107                                 break;
 108                         }
 109                 }
 110
 111                 if (found) return it;
 112         }
 113
 114         return keys.end();
 115 }
 116
 117
 118 vector<string>::const_iterator
 119 regexSearch(InfoMap const & theMap,
 120             vector<string> const & keys,
 121             string const & expr,
 122             vector<string>::const_iterator start,
 123             Direction dir)
 124 {
 125         boost::regex reg(expr);
 126
 127         for (vector<string>::const_iterator it = start;
 128              // End condition is direction-dependent.
 129              (dir == FORWARD) ? (it < keys.end()) : (it >= keys.begin());
 130              // increment is direction-dependent.
 131              (dir == FORWARD) ? (++it) : (--it)) {
 132
 133                 string data = (*it);
 134                 InfoMap::const_iterator info = theMap.find(*it);
 135                 if (info != theMap.end())
 136                         data += " " + info->second;
 137
 138                 if (boost::regex_match(data, reg)) {
 139                         return it;
 140                 }
 141         }
 142
 143         return keys.end();
 144 }
 145
 146
 147 } // namespace anon
 148
 149
 150 string const familyName(string const & name)
 151 {
 152         // Very simple parser
 153         string fname = name;
 154
 155         // possible authorname combinations are:
 156         // "Surname, FirstName"
 157         // "Surname, F."
 158         // "FirstName Surname"
 159         // "F. Surname"
 160         string::size_type idx = fname.find(",");
 161         if (idx != string::npos)
 162                 return ltrim(fname.substr(0, idx));
 163         idx = fname.rfind(".");
 164         if (idx != string::npos)
 165                 fname = ltrim(fname.substr(idx + 1));
 166         // test if we have a LaTeX Space in front
 167         if (fname[0] == '\\')
 168                 return fname.substr(2);
 169
 170         return fname;
 171 }
 172
 173
 174 string const getAbbreviatedAuthor(InfoMap const & map, string const & key)
 175 {
 176         lyx::Assert(!map.empty());
 177
 178         InfoMap::const_iterator it = map.find(key);
 179         if (it == map.end())
 180                 return string();
 181
 182         string::size_type const pos = it->second.find("TheBibliographyRef");
 183         if (pos != string::npos) {
 184                 if (pos <= 2) {
 185                         return string();
 186                 }
 187
 188                 string const opt = trim(it->second.substr(0, pos - 1));
 189                 if (opt.empty())
 190                         return string();
 191
 192                 string authors;
 193                 split(opt, authors, '(');
 194                 return authors;
 195         }
 196
 197         string author = parseBibTeX(it->second, "author");
 198         if (author.empty())
 199                 author = parseBibTeX(it->second, "editor");
 200
 201         if (author.empty()) {
 202                 author = parseBibTeX(it->second, "key");
 203                 if (author.empty())
 204                         author = key;
 205                 return author;
 206         }
 207
 208         vector<string> authors = getVectorFromString(author, " and");
 209
 210         if (!authors.empty()) {
 211                 author.erase();
 212
 213                 for (vector<string>::iterator it = authors.begin();
 214                      it != authors.end(); ++it) {
 215                         *it = familyName(rtrim(*it));
 216                 }
 217
 218                 author = authors[0];
 219                 if (authors.size() == 2)
 220                         author += _(" and ") + authors[1];
 221                 else if (authors.size() > 2)
 222                         author += _(" et al.");
 223         }
 224
 225         return author;
 226 }
 227
 228
 229 string const getYear(InfoMap const & map, string const & key)
 230 {
 231         lyx::Assert(!map.empty());
 232
 233         InfoMap::const_iterator it = map.find(key);
 234         if (it == map.end())
 235                 return string();
 236
 237         string::size_type const pos = it->second.find("TheBibliographyRef");
 238         if (pos != string::npos) {
 239                 if (pos <= 2) {
 240                         return string();
 241                 }
 242
 243                 string const opt =
 244                         trim(it->second.substr(0, pos - 1));
 245                 if (opt.empty())
 246                         return string();
 247
 248                 string authors;
 249                 string const tmp = split(opt, authors, '(');
 250                 string year;
 251                 split(tmp, year, ')');
 252                 return year;
 253
 254         }
 255
 256         string year = parseBibTeX(it->second, "year");
 257         if (year.empty())
 258                 year = _("No year");
 259
 260         return year;
 261 }
 262
 263
 264 // A functor for use with std::sort, leading to case insensitive sorting
 265 struct compareNoCase: public std::binary_function<string, string, bool>
 266 {
 267         bool operator()(string const & s1, string const & s2) const {
 268                 return compare_ascii_no_case(s1, s2) < 0;
 269         }
 270 };
 271
 272 vector<string> const getKeys(InfoMap const & map)
 273 {
 274         vector<string> bibkeys;
 275
 276         for (InfoMap::const_iterator it = map.begin(); it != map.end(); ++it) {
 277                 bibkeys.push_back(it->first);
 278         }
 279
 280         sort(bibkeys.begin(), bibkeys.end(), compareNoCase());
 281         return bibkeys;
 282 }
 283
 284
 285 string const getInfo(InfoMap const & map, string const & key)
 286 {
 287         lyx::Assert(!map.empty());
 288
 289         InfoMap::const_iterator it = map.find(key);
 290         if (it == map.end())
 291                 return string();
 292
 293         // is the entry a BibTeX one or one from lyx-layout "bibliography"?
 294         string const separator("TheBibliographyRef");
 295         string::size_type const pos = it->second.find(separator);
 296         if (pos != string::npos) {
 297                 string::size_type const pos2 = pos + separator.size();
 298                 string const info = trim(it->second.substr(pos2));
 299                 return info;
 300         }
 301
 302         // Search for all possible "required" keys
 303         string author = parseBibTeX(it->second, "author");
 304         if (author.empty())
 305                 author = parseBibTeX(it->second, "editor");
 306
 307         string year       = parseBibTeX(it->second, "year");
 308         string title      = parseBibTeX(it->second, "title");
 309         string booktitle  = parseBibTeX(it->second, "booktitle");
 310         string chapter    = parseBibTeX(it->second, "chapter");
 311         string number     = parseBibTeX(it->second, "number");
 312         string volume     = parseBibTeX(it->second, "volume");
 313         string pages      = parseBibTeX(it->second, "pages");
 314
 315         string media      = parseBibTeX(it->second, "journal");
 316         if (media.empty())
 317                 media = parseBibTeX(it->second, "publisher");
 318         if (media.empty())
 319                 media = parseBibTeX(it->second, "school");
 320         if (media.empty())
 321                 media = parseBibTeX(it->second, "institution");
 322
 323         ostringstream result;
 324         if (!author.empty())
 325                 result << author << ", ";
 326         if (!title.empty())
 327                 result << title;
 328         if (!booktitle.empty())
 329                 result << ", in " << booktitle;
 330         if (!chapter.empty())
 331                 result << ", Ch. " << chapter;
 332         if (!media.empty())
 333                 result << ", " << media;
 334         if (!volume.empty())
 335                 result << ", vol. " << volume;
 336         if (!number.empty())
 337                 result << ", no. " << number;
 338         if (!pages.empty())
 339                 result << ", pp. " << pages;
 340         if (!year.empty())
 341                 result << ", " << year;
 342
 343         string const result_str = rtrim(result.str().c_str());
 344         if (!result_str.empty())
 345                 return result_str;
 346
 347         // This should never happen (or at least be very unusual!)
 348         return it->second;
 349 }
 350
 351
 352 vector<string>::const_iterator
 353 searchKeys(InfoMap const & theMap,
 354            vector<string> const & keys,
 355            string const & expr,
 356            vector<string>::const_iterator start,
 357            Search type,
 358            Direction dir,
 359            bool caseSensitive)
 360 {
 361         // Preliminary checks
 362         if (start < keys.begin() || start >= keys.end())
 363                 return keys.end();
 364
 365         string search_expr = trim(expr);
 366         if (search_expr.empty())
 367                 return keys.end();
 368
 369         if (type == SIMPLE)
 370                 return simpleSearch(theMap, keys, search_expr, start, dir,
 371                                     caseSensitive);
 372
 373         return regexSearch(theMap, keys, search_expr, start, dir);
 374 }
 375
 376
 377 string const parseBibTeX(string data, string const & findkey)
 378 {
 379         string keyvalue;
 380         // at first we delete all characters right of '%' and
 381         // replace tabs through a space and remove leading spaces
 382         // we read the data line by line so that the \n are
 383         // ignored, too.
 384         string data_;
 385         int Entries = 0;
 386         string dummy = token(data,'\n', Entries);
 387         while (!dummy.empty()) {
 388                 dummy = subst(dummy, '\t', ' ');        // no tabs
 389                 dummy = ltrim(dummy);           // no leading spaces
 390                 // ignore lines with a beginning '%' or ignore all right of %
 391                 string::size_type const idx =
 392                         dummy.empty() ? string::npos : dummy.find('%');
 393                 if (idx != string::npos)
 394                         dummy.erase(idx, string::npos);
 395                 // do we have a new token or a new line of
 396                 // the same one? In the first case we ignore
 397                 // the \n and in the second we replace it
 398                 // with a space
 399                 if (!dummy.empty()) {
 400                         if (!contains(dummy, "="))
 401                                 data_ += (' ' + dummy);
 402                         else
 403                                 data_ += dummy;
 404                 }
 405                 dummy = token(data, '\n', ++Entries);
 406         }
 407
 408         // replace double commas with "" for easy scanning
 409         data = subst(data_, ",,", "\"\"");
 410
 411         // unlikely!
 412         if (data.empty())
 413                 return string();
 414
 415         // now get only the important line of the bibtex entry.
 416         // all entries are devided by ',' except the last one.
 417         data += ',';  // now we have same behaviour for all entries
 418                       // because the last one is "blah ... }"
 419         Entries = 0;
 420         bool found = false;
 421         // parsing of title and booktitle is different from the
 422         // others, because booktitle contains title
 423         do {
 424                 dummy = token(data, ',', Entries++);
 425                 if (!dummy.empty()) {
 426                         found = contains(ascii_lowercase(dummy), findkey);
 427                         if (findkey == "title" &&
 428                                 contains(ascii_lowercase(dummy), "booktitle"))
 429                                 found = false;
 430                 }
 431         } while (!found && !dummy.empty());
 432         if (dummy.empty())
 433                 // no such keyword
 434                 return string();
 435
 436         // we are not sure, if we get all, because "key= "blah, blah" is
 437         // allowed.
 438         // Therefore we read all until the next "=" character, which follows a
 439         // new keyword
 440         keyvalue = dummy;
 441         dummy = token(data, ',', Entries++);
 442         while (!contains(dummy, '=') && !dummy.empty()) {
 443                 keyvalue += (',' + dummy);
 444                 dummy = token(data, ',', Entries++);
 445         }
 446
 447         // replace double "" with originals ,, (two commas)
 448         // leaving us with the all-important line
 449         data = subst(keyvalue, "\"\"", ",,");
 450
 451         // Clean-up.
 452         // 1. Spaces
 453         data = rtrim(data);
 454         // 2. if there is no opening '{' then a closing '{' is probably cruft.
 455         if (!contains(data, '{'))
 456                 data = rtrim(data, "}");
 457         // happens, when last keyword
 458         string::size_type const idx =
 459                 !data.empty() ? data.find('=') : string::npos;
 460
 461         if (idx == string::npos)
 462                 return string();
 463
 464         data = trim(data.substr(idx));
 465
 466         if (data.length() < 2 || data[0] != '=') {      // a valid entry?
 467                 return string();
 468         } else {
 469                 // delete '=' and the following spaces
 470                 data = ltrim(data, " =");
 471                 if (data.length() < 2) {
 472                         return data;    // not long enough to find delimiters
 473                 } else {
 474                         string::size_type keypos = 1;
 475                         char enclosing;
 476                         if (data[0] == '{') {
 477                                 enclosing = '}';
 478                         } else if (data[0] == '"') {
 479                                 enclosing = '"';
 480                         } else {
 481                                 // no {} and no "", pure data but with a
 482                                 // possible ',' at the end
 483                                 return rtrim(data, ",");
 484                         }
 485                         string tmp = data.substr(keypos);
 486                         while (tmp.find('{') != string::npos &&
 487                                tmp.find('}') != string::npos &&
 488                                tmp.find('{') < tmp.find('}') &&
 489                                tmp.find('{') < tmp.find(enclosing)) {
 490
 491                                 keypos += tmp.find('{') + 1;
 492                                 tmp = data.substr(keypos);
 493                                 keypos += tmp.find('}') + 1;
 494                                 tmp = data.substr(keypos);
 495                         }
 496                         if (tmp.find(enclosing) == string::npos)
 497                                 return data;
 498                         else {
 499                                 keypos += tmp.find(enclosing);
 500                                 return data.substr(1, keypos - 1);
 501                         }
 502                 }
 503         }
 504 }
 505
 506
 507 CitationStyle const getCitationStyle(string const & command)
 508 {
 509         if (command.empty()) return CitationStyle();
 510
 511         CitationStyle cs;
 512         string cmd = command;
 513
 514         if (cmd[0] == 'C') {
 515                 cs.forceUCase = true;
 516                 cmd[0] = 'c';
 517         }
 518
 519         size_t n = cmd.size()-1;
 520         if (cmd[n] == '*') {
 521                 cs.full = true;
 522                 cmd = cmd.substr(0,n);
 523         }
 524
 525         char const * const * const last = citeCommands + nCiteCommands;
 526         char const * const * const ptr = std::find(citeCommands, last, cmd);
 527
 528         if (ptr != last) {
 529                 size_t idx = ptr - citeCommands;
 530                 cs.style = citeStyles[idx];
 531         }
 532
 533         return cs;
 534 }
 535
 536
 537 string const getCiteCommand(CiteStyle command, bool full, bool forceUCase)
 538 {
 539         string cite = citeCommands[command];
 540         if (full) {
 541                 CiteStyle const * last = citeStylesFull + nCiteStylesFull;
 542                 if (std::find(citeStylesFull, last, command) != last)
 543                         cite += "*";
 544         }
 545
 546         if (forceUCase) {
 547                 CiteStyle const * last = citeStylesUCase + nCiteStylesUCase;
 548                 if (std::find(citeStylesUCase, last, command) != last)
 549                         cite[0] = 'C';
 550         }
 551
 552         return cite;
 553 }
 554
 555
 556 vector<CiteStyle> const getCiteStyles(bool usingNatbib)
 557 {
 558         unsigned int nStyles = 1;
 559         unsigned int start = 0;
 560         if (usingNatbib) {
 561                 nStyles = nCiteStyles - 1;
 562                 start = 1;
 563         }
 564
 565         vector<CiteStyle> styles(nStyles);
 566
 567         vector<CiteStyle>::size_type i = 0;
 568         int j = start;
 569         for (; i != styles.size(); ++i, ++j) {
 570                 styles[i] = citeStyles[j];
 571         }
 572
 573         return styles;
 574 }
 575
 576
 577 vector<string> const
 578 getNumericalStrings(string const & key,
 579                     InfoMap const & map, vector<CiteStyle> const & styles)
 580 {
 581         if (map.empty()) {
 582                 return vector<string>();
 583         }
 584
 585         string const author = getAbbreviatedAuthor(map, key);
 586         string const year   = getYear(map, key);
 587         if (author.empty() || year.empty())
 588                 return vector<string>();
 589
 590         vector<string> vec(styles.size());
 591         for (vector<string>::size_type i = 0; i != vec.size(); ++i) {
 592                 string str;
 593
 594                 switch (styles[i]) {
 595                 case CITE:
 596                 case CITEP:
 597                         str = "[#ID]";
 598                         break;
 599
 600                 case CITET:
 601                         str = author + " [#ID]";
 602                         break;
 603
 604                 case CITEALT:
 605                         str = author + " #ID";
 606                         break;
 607
 608                 case CITEALP:
 609                         str = "#ID";
 610                         break;
 611
 612                 case CITEAUTHOR:
 613                         str = author;
 614                         break;
 615
 616                 case CITEYEAR:
 617                         str = year;
 618                         break;
 619
 620                 case CITEYEARPAR:
 621                         str = "(" + year + ")";
 622                         break;
 623                 }
 624
 625                 vec[i] = str;
 626         }
 627
 628         return vec;
 629 }
 630
 631
 632 vector<string> const
 633 getAuthorYearStrings(string const & key,
 634                     InfoMap const & map, vector<CiteStyle> const & styles)
 635 {
 636         if (map.empty()) {
 637                 return vector<string>();
 638         }
 639
 640         string const author = getAbbreviatedAuthor(map, key);
 641         string const year   = getYear(map, key);
 642         if (author.empty() || year.empty())
 643                 return vector<string>();
 644
 645         vector<string> vec(styles.size());
 646         for (vector<string>::size_type i = 0; i != vec.size(); ++i) {
 647                 string str;
 648
 649                 switch (styles[i]) {
 650                 case CITE:
 651                 case CITET:
 652                         str = author + " (" + year + ")";
 653                         break;
 654
 655                 case CITEP:
 656                         str = "(" + author + ", " + year + ")";
 657                         break;
 658
 659                 case CITEALT:
 660                         str = author + " " + year ;
 661                         break;
 662
 663                 case CITEALP:
 664                         str = author + ", " + year ;
 665                         break;
 666
 667                 case CITEAUTHOR:
 668                         str = author;
 669                         break;
 670
 671                 case CITEYEAR:
 672                         str = year;
 673                         break;
 674
 675                 case CITEYEARPAR:
 676                         str = "(" + year + ")";
 677                         break;
 678                 }
 679
 680                 vec[i] = str;
 681         }
 682
 683         return vec;
 684 }
 685
 686 } // namespace biblio