src/insets/InsetBibtex.cpp

   1 /**
   2  * \file InsetBibtex.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author Richard Heck (BibTeX parser improvements)
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetBibtex.h"
  15
  16 #include "Buffer.h"
  17 #include "BufferParams.h"
  18 #include "DispatchResult.h"
  19 #include "Encoding.h"
  20 #include "Format.h"
  21 #include "FuncRequest.h"
  22 #include "FuncStatus.h"
  23 #include "LaTeXFeatures.h"
  24 #include "MetricsInfo.h"
  25 #include "output_xhtml.h"
  26 #include "OutputParams.h"
  27 #include "TextClass.h"
  28 #include "TocBackend.h"
  29
  30 #include "frontends/alert.h"
  31
  32 #include "support/convert.h"
  33 #include "support/debug.h"
  34 #include "support/docstream.h"
  35 #include "support/ExceptionMessage.h"
  36 #include "support/filetools.h"
  37 #include "support/gettext.h"
  38 #include "support/lstrings.h"
  39 #include "support/os.h"
  40 #include "support/Path.h"
  41 #include "support/textutils.h"
  42
  43 #include <limits>
  44
  45 using namespace std;
  46 using namespace lyx::support;
  47
  48 namespace lyx {
  49
  50 namespace Alert = frontend::Alert;
  51 namespace os = support::os;
  52
  53
  54 InsetBibtex::InsetBibtex(Buffer * buf, InsetCommandParams const & p)
  55         : InsetCommand(buf, p, "bibtex")
  56 {
  57         buffer_->invalidateBibinfoCache();
  58 }
  59
  60
  61 InsetBibtex::~InsetBibtex()
  62 {
  63         if (isBufferValid())
  64                 buffer_->invalidateBibinfoCache();
  65 }
  66
  67
  68 ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
  69 {
  70         static ParamInfo param_info_;
  71         if (param_info_.empty()) {
  72                 param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL);
  73                 param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED);
  74                 param_info_.add("options", ParamInfo::LYX_INTERNAL);
  75         }
  76         return param_info_;
  77 }
  78
  79
  80 void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
  81 {
  82         switch (cmd.action) {
  83
  84         case LFUN_INSET_EDIT:
  85                 editDatabases();
  86                 break;
  87
  88         case LFUN_INSET_MODIFY: {
  89                 InsetCommandParams p(BIBTEX_CODE);
  90                 try {
  91                         if (!InsetCommand::string2params("bibtex",
  92                                         to_utf8(cmd.argument()), p)) {
  93                                 cur.noUpdate();
  94                                 break;
  95                         }
  96                 } catch (ExceptionMessage const & message) {
  97                         if (message.type_ == WarningException) {
  98                                 Alert::warning(message.title_, message.details_);
  99                                 cur.noUpdate();
 100                         } else
 101                                 throw message;
 102                         break;
 103                 }
 104                 //
 105                 setParams(p);
 106                 buffer().updateBibfilesCache();
 107                 break;
 108         }
 109
 110         default:
 111                 InsetCommand::doDispatch(cur, cmd);
 112                 break;
 113         }
 114 }
 115
 116
 117 bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd,
 118                 FuncStatus & flag) const
 119 {
 120         switch (cmd.action) {
 121         case LFUN_INSET_EDIT:
 122                 flag.setEnabled(true);
 123                 return true;
 124
 125         default:
 126                 return InsetCommand::getStatus(cur, cmd, flag);
 127         }
 128 }
 129
 130
 131 void InsetBibtex::editDatabases() const
 132 {
 133         vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
 134
 135         if (bibfilelist.empty())
 136                 return;
 137
 138         int nr_databases = bibfilelist.size();
 139         if (nr_databases > 1) {
 140                         docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n"
 141                                                        "If you proceed, all of them will be opened."),
 142                                                         convert<docstring>(nr_databases));
 143                         int const ret = Alert::prompt(_("Open Databases?"),
 144                                 message, 0, 1, _("&Cancel"), _("&Proceed"));
 145
 146                         if (ret == 0)
 147                                 return;
 148         }
 149
 150         vector<docstring>::const_iterator it = bibfilelist.begin();
 151         vector<docstring>::const_iterator en = bibfilelist.end();
 152         for (; it != en; ++it) {
 153                 FileName bibfile = getBibTeXPath(*it, buffer());
 154                 formats.edit(buffer(), bibfile,
 155                      formats.getFormatFromFile(bibfile));
 156         }
 157 }
 158
 159
 160 docstring InsetBibtex::screenLabel() const
 161 {
 162         return _("BibTeX Generated Bibliography");
 163 }
 164
 165
 166 docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
 167 {
 168         docstring item = from_ascii("* ");
 169         docstring tip = _("Databases:") + "\n";
 170         vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
 171
 172         if (bibfilelist.empty()) {
 173                 tip += item;
 174                 tip += _("none");
 175         } else {
 176                 vector<docstring>::const_iterator it = bibfilelist.begin();
 177                 vector<docstring>::const_iterator en = bibfilelist.end();
 178                 for (; it != en; ++it) {
 179                         tip += item;
 180                         tip += *it + "\n";
 181                 }
 182         }
 183
 184         // Style-Options
 185         bool toc = false;
 186         docstring style = getParam("options"); // maybe empty! and with bibtotoc
 187         docstring bibtotoc = from_ascii("bibtotoc");
 188         if (prefixIs(style, bibtotoc)) {
 189                 toc = true;
 190                 if (contains(style, char_type(',')))
 191                         style = split(style, bibtotoc, char_type(','));
 192         }
 193
 194         tip += _("Style File:") +"\n";
 195         tip += item;
 196         if (!style.empty())
 197                 tip += style;
 198         else
 199                 tip += _("none");
 200
 201         tip += "\n" + _("Lists:") + " ";
 202         docstring btprint = getParam("btprint");
 203                 if (btprint == "btPrintAll")
 204                         tip += _("all references");
 205                 else if (btprint == "btPrintNotCited")
 206                         tip += _("all uncited references");
 207                 else
 208                         tip += _("all cited references");
 209
 210         if (toc) {
 211                 tip += ", ";
 212                 tip += _("included in TOC");
 213         }
 214
 215         return tip;
 216 }
 217
 218
 219 static string normalizeName(Buffer const & buffer,
 220         OutputParams const & runparams, string const & name, string const & ext)
 221 {
 222         string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
 223         if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
 224                 return name;
 225         if (!runparams.nice)
 226                 return fname;
 227
 228         // FIXME UNICODE
 229         return to_utf8(makeRelPath(from_utf8(fname),
 230                                          from_utf8(buffer.masterBuffer()->filePath())));
 231 }
 232
 233
 234 int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
 235 {
 236         // the sequence of the commands:
 237         // 1. \bibliographystyle{style}
 238         // 2. \addcontentsline{...} - if option bibtotoc set
 239         // 3. \bibliography{database}
 240         // and with bibtopic:
 241         // 1. \bibliographystyle{style}
 242         // 2. \begin{btSect}{database}
 243         // 3. \btPrint{Cited|NotCited|All}
 244         // 4. \end{btSect}
 245
 246         // Database(s)
 247         // If we are processing the LaTeX file in a temp directory then
 248         // copy the .bib databases to this temp directory, mangling their
 249         // names in the process. Store this mangled name in the list of
 250         // all databases.
 251         // (We need to do all this because BibTeX *really*, *really*
 252         // can't handle "files with spaces" and Windows users tend to
 253         // use such filenames.)
 254         // Otherwise, store the (maybe absolute) path to the original,
 255         // unmangled database name.
 256         vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
 257         vector<docstring>::const_iterator it = bibfilelist.begin();
 258         vector<docstring>::const_iterator en = bibfilelist.end();
 259         odocstringstream dbs;
 260         bool didone = false;
 261
 262         for (; it != en; ++it) {
 263                 string utf8input = to_utf8(*it);
 264                 string database =
 265                         normalizeName(buffer(), runparams, utf8input, ".bib");
 266                 FileName const try_in_file =
 267                         makeAbsPath(database + ".bib", buffer().filePath());
 268                 bool const not_from_texmf = try_in_file.isReadableFile();
 269
 270                 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
 271                     not_from_texmf) {
 272                         // mangledFilename() needs the extension
 273                         DocFileName const in_file = DocFileName(try_in_file);
 274                         database = removeExtension(in_file.mangledFilename());
 275                         FileName const out_file = makeAbsPath(database + ".bib",
 276                                         buffer().masterBuffer()->temppath());
 277
 278                         bool const success = in_file.copyTo(out_file);
 279                         if (!success) {
 280                                 lyxerr << "Failed to copy '" << in_file
 281                                        << "' to '" << out_file << "'"
 282                                        << endl;
 283                         }
 284                 } else if (!runparams.inComment && runparams.nice && not_from_texmf &&
 285                            !isValidLaTeXFilename(database)) {
 286                                 frontend::Alert::warning(_("Invalid filename"),
 287                                                          _("The following filename is likely to cause trouble "
 288                                                            "when running the exported file through LaTeX: ") +
 289                                                             from_utf8(database));
 290                 }
 291
 292                 if (didone)
 293                         dbs << ',';
 294                 else
 295                         didone = true;
 296                 // FIXME UNICODE
 297                 dbs << from_utf8(latex_path(database));
 298         }
 299         docstring const db_out = dbs.str();
 300
 301         // Post this warning only once.
 302         static bool warned_about_spaces = false;
 303         if (!warned_about_spaces &&
 304             runparams.nice && db_out.find(' ') != docstring::npos) {
 305                 warned_about_spaces = true;
 306                 Alert::warning(_("Export Warning!"),
 307                                _("There are spaces in the paths to your BibTeX databases.\n"
 308                                               "BibTeX will be unable to find them."));
 309         }
 310         // Style-Options
 311         string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
 312         string bibtotoc;
 313         if (prefixIs(style, "bibtotoc")) {
 314                 bibtotoc = "bibtotoc";
 315                 if (contains(style, ','))
 316                         style = split(style, bibtotoc, ',');
 317         }
 318
 319         // line count
 320         int nlines = 0;
 321
 322         if (!style.empty()) {
 323                 string base = normalizeName(buffer(), runparams, style, ".bst");
 324                 FileName const try_in_file =
 325                         makeAbsPath(base + ".bst", buffer().filePath());
 326                 bool const not_from_texmf = try_in_file.isReadableFile();
 327                 // If this style does not come from texmf and we are not
 328                 // exporting to .tex copy it to the tmp directory.
 329                 // This prevents problems with spaces and 8bit charcaters
 330                 // in the file name.
 331                 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
 332                     not_from_texmf) {
 333                         // use new style name
 334                         DocFileName const in_file = DocFileName(try_in_file);
 335                         base = removeExtension(in_file.mangledFilename());
 336                         FileName const out_file = makeAbsPath(base + ".bst",
 337                                         buffer().masterBuffer()->temppath());
 338                         bool const success = in_file.copyTo(out_file);
 339                         if (!success) {
 340                                 lyxerr << "Failed to copy '" << in_file
 341                                        << "' to '" << out_file << "'"
 342                                        << endl;
 343                         }
 344                 }
 345                 // FIXME UNICODE
 346                 os << "\\bibliographystyle{"
 347                    << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst")))
 348                    << "}\n";
 349                 nlines += 1;
 350         }
 351
 352         // Post this warning only once.
 353         static bool warned_about_bst_spaces = false;
 354         if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
 355                 warned_about_bst_spaces = true;
 356                 Alert::warning(_("Export Warning!"),
 357                                _("There are spaces in the path to your BibTeX style file.\n"
 358                                               "BibTeX will be unable to find it."));
 359         }
 360
 361         if (!db_out.empty() && buffer().params().use_bibtopic) {
 362                 os << "\\begin{btSect}{" << db_out << "}\n";
 363                 docstring btprint = getParam("btprint");
 364                 if (btprint.empty())
 365                         // default
 366                         btprint = from_ascii("btPrintCited");
 367                 os << "\\" << btprint << "\n"
 368                    << "\\end{btSect}\n";
 369                 nlines += 3;
 370         }
 371
 372         // bibtotoc-Option
 373         if (!bibtotoc.empty() && !buffer().params().use_bibtopic) {
 374                 if (buffer().params().documentClass().hasLaTeXLayout("chapter")) {
 375                         if (buffer().params().sides == OneSide) {
 376                                 // oneside
 377                                 os << "\\clearpage";
 378                         } else {
 379                                 // twoside
 380                                 os << "\\cleardoublepage";
 381                         }
 382                         os << "\\addcontentsline{toc}{chapter}{\\bibname}";
 383                 } else if (buffer().params().documentClass().hasLaTeXLayout("section"))
 384                         os << "\\addcontentsline{toc}{section}{\\refname}";
 385         }
 386
 387         if (!db_out.empty() && !buffer().params().use_bibtopic) {
 388                 docstring btprint = getParam("btprint");
 389                 if (btprint == "btPrintAll") {
 390                         os << "\\nocite{*}\n";
 391                         nlines += 1;
 392                 }
 393                 os << "\\bibliography{" << db_out << "}\n";
 394                 nlines += 1;
 395         }
 396
 397         return nlines;
 398 }
 399
 400
 401 support::FileNameList InsetBibtex::getBibFiles() const
 402 {
 403         FileName path(buffer().filePath());
 404         support::PathChanger p(path);
 405
 406         support::FileNameList vec;
 407
 408         vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
 409         vector<docstring>::const_iterator it = bibfilelist.begin();
 410         vector<docstring>::const_iterator en = bibfilelist.end();
 411         for (; it != en; ++it) {
 412                 FileName const file = getBibTeXPath(*it, buffer());
 413
 414                 if (!file.empty())
 415                         vec.push_back(file);
 416                 else
 417                         LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
 418         }
 419
 420         return vec;
 421
 422 }
 423
 424 namespace {
 425
 426         // methods for parsing bibtex files
 427
 428         typedef map<docstring, docstring> VarMap;
 429
 430         /// remove whitespace characters, optionally a single comma,
 431         /// and further whitespace characters from the stream.
 432         /// @return true if a comma was found, false otherwise
 433         ///
 434         bool removeWSAndComma(ifdocstream & ifs) {
 435                 char_type ch;
 436
 437                 if (!ifs)
 438                         return false;
 439
 440                 // skip whitespace
 441                 do {
 442                         ifs.get(ch);
 443                 } while (ifs && isSpace(ch));
 444
 445                 if (!ifs)
 446                         return false;
 447
 448                 if (ch != ',') {
 449                         ifs.putback(ch);
 450                         return false;
 451                 }
 452
 453                 // skip whitespace
 454                 do {
 455                         ifs.get(ch);
 456                 } while (ifs && isSpace(ch));
 457
 458                 if (ifs) {
 459                         ifs.putback(ch);
 460                 }
 461
 462                 return true;
 463         }
 464
 465
 466         enum charCase {
 467                 makeLowerCase,
 468                 keepCase
 469         };
 470
 471         /// remove whitespace characters, read characer sequence
 472         /// not containing whitespace characters or characters in
 473         /// delimChars, and remove further whitespace characters.
 474         ///
 475         /// @return true if a string of length > 0 could be read.
 476         ///
 477         bool readTypeOrKey(docstring & val, ifdocstream & ifs,
 478                 docstring const & delimChars, docstring const &illegalChars,
 479                 charCase chCase) {
 480
 481                 char_type ch;
 482
 483                 val.clear();
 484
 485                 if (!ifs)
 486                         return false;
 487
 488                 // skip whitespace
 489                 do {
 490                         ifs.get(ch);
 491                 } while (ifs && isSpace(ch));
 492
 493                 if (!ifs)
 494                         return false;
 495
 496                 // read value
 497                 bool legalChar = true;
 498                 while (ifs && !isSpace(ch) &&
 499                                                  delimChars.find(ch) == docstring::npos &&
 500                                                  (legalChar = (illegalChars.find(ch) == docstring::npos))
 501                                         )
 502                 {
 503                         if (chCase == makeLowerCase)
 504                                 val += lowercase(ch);
 505                         else
 506                                 val += ch;
 507                         ifs.get(ch);
 508                 }
 509
 510                 if (!legalChar) {
 511                         ifs.putback(ch);
 512                         return false;
 513                 }
 514
 515                 // skip whitespace
 516                 while (ifs && isSpace(ch)) {
 517                         ifs.get(ch);
 518                 }
 519
 520                 if (ifs) {
 521                         ifs.putback(ch);
 522                 }
 523
 524                 return val.length() > 0;
 525         }
 526
 527         /// read subsequent bibtex values that are delimited with a #-character.
 528         /// Concatenate all parts and replace names with the associated string in
 529         /// the variable strings.
 530         /// @return true if reading was successfull (all single parts were delimited
 531         /// correctly)
 532         bool readValue(docstring & val, ifdocstream & ifs, const VarMap & strings) {
 533
 534                 char_type ch;
 535
 536                 val.clear();
 537
 538                 if (!ifs)
 539                         return false;
 540
 541                 do {
 542                         // skip whitespace
 543                         do {
 544                                 ifs.get(ch);
 545                         } while (ifs && isSpace(ch));
 546
 547                         if (!ifs)
 548                                 return false;
 549
 550                         // check for field type
 551                         if (isDigit(ch)) {
 552
 553                                 // read integer value
 554                                 do {
 555                                         val += ch;
 556                                         ifs.get(ch);
 557                                 } while (ifs && isDigit(ch));
 558
 559                                 if (!ifs)
 560                                         return false;
 561
 562                         } else if (ch == '"' || ch == '{') {
 563                                 // set end delimiter
 564                                 char_type delim = ch == '"' ? '"': '}';
 565
 566                                 // Skip whitespace
 567                                 do {
 568                                         ifs.get(ch);
 569                                 } while (ifs && isSpace(ch));
 570
 571                                 if (!ifs)
 572                                         return false;
 573
 574                                 // We now have the first non-whitespace character
 575                                 // We'll collapse adjacent whitespace.
 576                                 bool lastWasWhiteSpace = false;
 577
 578                                 // inside this delimited text braces must match.
 579                                 // Thus we can have a closing delimiter only
 580                                 // when nestLevel == 0
 581                                 int nestLevel = 0;
 582
 583                                 while (ifs && (nestLevel > 0 || ch != delim)) {
 584                                         if (isSpace(ch)) {
 585                                                 lastWasWhiteSpace = true;
 586                                                 ifs.get(ch);
 587                                                 continue;
 588                                         }
 589                                         // We output the space only after we stop getting
 590                                         // whitespace so as not to output any whitespace
 591                                         // at the end of the value.
 592                                         if (lastWasWhiteSpace) {
 593                                                 lastWasWhiteSpace = false;
 594                                                 val += ' ';
 595                                         }
 596
 597                                         val += ch;
 598
 599                                         // update nesting level
 600                                         switch (ch) {
 601                                                 case '{':
 602                                                         ++nestLevel;
 603                                                         break;
 604                                                 case '}':
 605                                                         --nestLevel;
 606                                                         if (nestLevel < 0) return false;
 607                                                         break;
 608                                         }
 609
 610                                         ifs.get(ch);
 611                                 }
 612
 613                                 if (!ifs)
 614                                         return false;
 615
 616                                 ifs.get(ch);
 617
 618                                 if (!ifs)
 619                                         return false;
 620
 621                         } else {
 622
 623                                 // reading a string name
 624                                 docstring strName;
 625
 626                                 while (ifs && !isSpace(ch) && ch != '#' && ch != ',' && ch != '}' && ch != ')') {
 627                                         strName += lowercase(ch);
 628                                         ifs.get(ch);
 629                                 }
 630
 631                                 if (!ifs)
 632                                         return false;
 633
 634                                 // replace the string with its assigned value or
 635                                 // discard it if it's not assigned
 636                                 if (strName.length()) {
 637                                         VarMap::const_iterator pos = strings.find(strName);
 638                                         if (pos != strings.end()) {
 639                                                 val += pos->second;
 640                                         }
 641                                 }
 642                         }
 643
 644                         // skip WS
 645                         while (ifs && isSpace(ch)) {
 646                                 ifs.get(ch);
 647                         }
 648
 649                         if (!ifs)
 650                                 return false;
 651
 652                         // continue reading next value on concatenate with '#'
 653                 } while (ch == '#');
 654
 655                 ifs.putback(ch);
 656
 657                 return true;
 658         }
 659 }
 660
 661
 662 // This method returns a comma separated list of Bibtex entries
 663 void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
 664         InsetIterator const & /*di*/) const
 665 {
 666         // This bibtex parser is a first step to parse bibtex files
 667         // more precisely.
 668         //
 669         // - it reads the whole bibtex entry and does a syntax check
 670         //   (matching delimiters, missing commas,...
 671         // - it recovers from errors starting with the next @-character
 672         // - it reads @string definitions and replaces them in the
 673         //   field values.
 674         // - it accepts more characters in keys or value names than
 675         //   bibtex does.
 676         //
 677         // Officially bibtex does only support ASCII, but in practice
 678         // you can use the encoding of the main document as long as
 679         // some elements like keys and names are pure ASCII. Therefore
 680         // we convert the file from the buffer encoding.
 681         // We don't restrict keys to ASCII in LyX, since our own
 682         // InsetBibitem can generate non-ASCII keys, and nonstandard
 683         // 8bit clean bibtex forks exist.
 684         support::FileNameList const files = getBibFiles();
 685         support::FileNameList::const_iterator it = files.begin();
 686         support::FileNameList::const_iterator en = files.end();
 687         for (; it != en; ++ it) {
 688                 ifdocstream ifs(it->toFilesystemEncoding().c_str(),
 689                         ios_base::in, buffer().params().encoding().iconvName());
 690
 691                 char_type ch;
 692                 VarMap strings;
 693
 694                 while (ifs) {
 695
 696                         ifs.get(ch);
 697                         if (!ifs)
 698                                 break;
 699
 700                         if (ch != '@')
 701                                 continue;
 702
 703                         docstring entryType;
 704
 705                         if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) {
 706                                 lyxerr << "InsetBibtex::fillWithBibKeys: Error reading entry type." << std::endl;
 707                                 continue;
 708                         }
 709
 710                         if (!ifs) {
 711                                 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
 712                                 continue;
 713                         }
 714
 715                         if (entryType == from_ascii("comment")) {
 716                                 ifs.ignore(numeric_limits<int>::max(), '\n');
 717                                 continue;
 718                         }
 719
 720                         ifs.get(ch);
 721                         if (!ifs) {
 722                                 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
 723                                 break;
 724                         }
 725
 726                         if ((ch != '(') && (ch != '{')) {
 727                                 lyxerr << "InsetBibtex::fillWithBibKeys: Invalid entry delimiter." << std::endl;
 728                                 ifs.putback(ch);
 729                                 continue;
 730                         }
 731
 732                         // process the entry
 733                         if (entryType == from_ascii("string")) {
 734
 735                                 // read string and add it to the strings map
 736                                 // (or replace it's old value)
 737                                 docstring name;
 738                                 docstring value;
 739
 740                                 if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) {
 741                                         lyxerr << "InsetBibtex::fillWithBibKeys: Error reading string name." << std::endl;
 742                                         continue;
 743                                 }
 744
 745                                 if (!ifs) {
 746                                         lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
 747                                         continue;
 748                                 }
 749
 750                                 // next char must be an equal sign
 751                                 ifs.get(ch);
 752                                 if (!ifs || ch != '=') {
 753                                         lyxerr << "InsetBibtex::fillWithBibKeys: No `=' after string name: " <<
 754                                                         name << "." << std::endl;
 755                                         continue;
 756                                 }
 757
 758                                 if (!readValue(value, ifs, strings)) {
 759                                         lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for string: " <<
 760                                                         name << "." << std::endl;
 761                                         continue;
 762                                 }
 763
 764                                 strings[name] = value;
 765
 766                         } else if (entryType == from_ascii("preamble")) {
 767
 768                                 // preamble definitions are discarded.
 769                                 // can they be of any use in lyx?
 770                                 docstring value;
 771
 772                                 if (!readValue(value, ifs, strings)) {
 773                                         lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read preamble value." << std::endl;
 774                                         continue;
 775                                 }
 776
 777                         } else {
 778
 779                                 // Citation entry. Try to read the key.
 780                                 docstring key;
 781
 782                                 if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) {
 783                                         lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read key for entry type:" <<
 784                                                         entryType << "." << std::endl;
 785                                         continue;
 786                                 }
 787
 788                                 if (!ifs) {
 789                                         lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
 790                                         continue;
 791                                 }
 792
 793                                 /////////////////////////////////////////////
 794                                 // now we have a key, so we will add an entry
 795                                 // (even if it's empty, as bibtex does)
 796                                 //
 797                                 // we now read the field = value pairs.
 798                                 // all items must be separated by a comma. If
 799                                 // it is missing the scanning of this entry is
 800                                 // stopped and the next is searched.
 801                                 docstring fields;
 802                                 docstring name;
 803                                 docstring value;
 804                                 docstring commaNewline;
 805                                 docstring data;
 806                                 BibTeXInfo keyvalmap(key, entryType);
 807
 808                                 bool readNext = removeWSAndComma(ifs);
 809
 810                                 while (ifs && readNext) {
 811
 812                                         // read field name
 813                                         if (!readTypeOrKey(name, ifs, from_ascii("="),
 814                                                            from_ascii("{}(),"), makeLowerCase) || !ifs)
 815                                                 break;
 816
 817                                         // next char must be an equal sign
 818                                         ifs.get(ch);
 819                                         if (!ifs) {
 820                                                 lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
 821                                                 break;
 822                                         }
 823                                         if (ch != '=') {
 824                                                 lyxerr << "InsetBibtex::fillWithBibKeys: Missing `=' after field name: " <<
 825                                                                 name << ", for key: " << key << "." << std::endl;
 826                                                 ifs.putback(ch);
 827                                                 break;
 828                                         }
 829
 830                                         // read field value
 831                                         if (!readValue(value, ifs, strings)) {
 832                                                 lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for field: " <<
 833                                                                 name << ", for key: " << key << "." << std::endl;
 834                                                 break;
 835                                         }
 836
 837                                         keyvalmap[name] = value;
 838                                         data += "\n\n" + value;
 839                                         keylist.addFieldName(name);
 840                                         readNext = removeWSAndComma(ifs);
 841                                 }
 842
 843                                 // add the new entry
 844                                 keylist.addEntryType(entryType);
 845                                 keyvalmap.setAllData(data);
 846                                 keylist[key] = keyvalmap;
 847                         } //< else (citation entry)
 848                 } //< searching '@'
 849         } //< for loop over files
 850 }
 851
 852
 853 FileName InsetBibtex::getBibTeXPath(docstring const & filename, Buffer const & buf)
 854 {
 855         string texfile = changeExtension(to_utf8(filename), "bib");
 856         // note that, if the filename can be found directly from the path,
 857         // findtexfile will just return a FileName object for that path.
 858         FileName file(findtexfile(texfile, "bib"));
 859         if (file.empty())
 860                 file = FileName(makeAbsPath(texfile, buf.filePath()));
 861         return file;
 862 }
 863
 864
 865 bool InsetBibtex::addDatabase(docstring const & db)
 866 {
 867         docstring bibfiles = getParam("bibfiles");
 868         if (tokenPos(bibfiles, ',', db) != -1)
 869                 return false;
 870         if (!bibfiles.empty())
 871                 bibfiles += ',';
 872         setParam("bibfiles", bibfiles + db);
 873         return true;
 874 }
 875
 876
 877 bool InsetBibtex::delDatabase(docstring const & db)
 878 {
 879         docstring bibfiles = getParam("bibfiles");
 880         if (contains(bibfiles, db)) {
 881                 int const n = tokenPos(bibfiles, ',', db);
 882                 docstring bd = db;
 883                 if (n > 0) {
 884                         // this is not the first database
 885                         docstring tmp = ',' + bd;
 886                         setParam("bibfiles", subst(bibfiles, tmp, docstring()));
 887                 } else if (n == 0)
 888                         // this is the first (or only) database
 889                         setParam("bibfiles", split(bibfiles, bd, ','));
 890                 else
 891                         return false;
 892         }
 893         return true;
 894 }
 895
 896
 897 void InsetBibtex::validate(LaTeXFeatures & features) const
 898 {
 899         if (features.bufferParams().use_bibtopic)
 900                 features.require("bibtopic");
 901 }
 902
 903
 904 namespace {
 905         // used in xhtml to sort a list of BibTeXInfo objects
 906         bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
 907         {
 908                 return lhs->getAbbreviatedAuthor() < rhs->getAbbreviatedAuthor();
 909         }
 910 }
 911
 912
 913 docstring InsetBibtex::xhtml(odocstream & os, OutputParams const &) const
 914 {
 915         // We are going to collect all the citation keys used in the document,
 916         // getting them from the TOC.
 917         Toc const & toc = buffer().tocBackend().toc("citation");
 918         Toc::const_iterator it = toc.begin();
 919         Toc::const_iterator en = toc.end();
 920         vector<docstring> citekeys;
 921         for (; it != en; ++it) {
 922                 if (it->str().empty())
 923                         continue;
 924                 vector<docstring> keys = getVectorFromString(it->str());
 925                 vector<docstring>::const_iterator dit = keys.begin();
 926                 vector<docstring>::const_iterator den = keys.end();
 927                 for (; dit != den; ++dit)
 928                         citekeys.push_back(*dit);
 929         }
 930         if (citekeys.empty())
 931                 return docstring();
 932         sort(citekeys.begin(), citekeys.end());
 933         unique(citekeys.begin(), citekeys.end());
 934         // We now have a sorted, unique list of the keys used in this document.
 935         // We will now convert it to a list of the BibTeXInfo objects used in
 936         // this document...
 937         // FIXME We need to do something here about cross-references, if we
 938         // want to be able to display them AS cross-references. Probably the
 939         // easiest thing to do is to loop over the list again and add whatever
 940         // cross-references we find, then sort and unique it, planning just to
 941         // add the cross-references to the bibliography.
 942         vector<BibTeXInfo const *> binfo;
 943         vector<docstring>::const_iterator cit = citekeys.begin();
 944         vector<docstring>::const_iterator cen = citekeys.end();
 945         BiblioInfo const & bi = buffer().masterBibInfo();
 946         for (; cit != cen; ++cit) {
 947                 BiblioInfo::const_iterator bt = bi.find(*cit);
 948                 if (bt == bi.end())
 949                         continue;
 950                 binfo.push_back(&(bt->second));
 951         }
 952         // ...and sort it.
 953         sort(binfo.begin(), binfo.end(), lSorter);
 954         // Finally, then, we are ready for output.
 955         os << "<h2 class='bibliography'>" << _("References") << "</h2>\n";
 956         os << "<div class='bibliography'>\n";
 957         vector<BibTeXInfo const *>::const_iterator vit = binfo.begin();
 958         vector<BibTeXInfo const *>::const_iterator ven = binfo.end();
 959         // Now we loop over the entries
 960         for (; vit != ven; ++vit) {
 961                 BibTeXInfo const * bip = *vit;
 962                 os << "<p class='bibliography'>";
 963                 os << "<a name='" << html::htmlize(bip->key()) << "'></a>";
 964                 docstring label = bip->label();
 965                 if (label.empty())
 966                         label = bip->key();
 967                 os << "<span class='biblabel'>[" << label << "]</span> ";
 968                 // FIXME Right now, we are calling BibInfo::getInfo on the key,
 969                 // which will give us all the cross-referenced info. But for every
 970                 // entry.
 971                 os << "<span class='bibinfo'>" << bi.getInfo(bip->key()) << "</span>";
 972                 os << "</p>\n";
 973         }
 974
 975         os << "</div>\n";
 976         return docstring();
 977 }
 978
 979
 980 docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
 981 {
 982         return from_ascii("context-bibtex");
 983 }
 984
 985
 986 } // namespace lyx