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 "EmbeddedFiles.h"
  20 #include "Encoding.h"
  21 #include "FuncRequest.h"
  22 #include "LaTeXFeatures.h"
  23 #include "MetricsInfo.h"
  24 #include "OutputParams.h"
  25 #include "TextClass.h"
  26
  27 #include "frontends/alert.h"
  28
  29 #include "support/debug.h"
  30 #include "support/ExceptionMessage.h"
  31 #include "support/docstream.h"
  32 #include "support/filetools.h"
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35 #include "support/os.h"
  36 #include "support/Path.h"
  37 #include "support/textutils.h"
  38
  39 #include <boost/tokenizer.hpp>
  40 #include <limits>
  41
  42 using namespace std;
  43 using namespace lyx::support;
  44
  45 namespace lyx {
  46
  47 namespace Alert = frontend::Alert;
  48 namespace os = support::os;
  49
  50
  51 InsetBibtex::InsetBibtex(InsetCommandParams const & p)
  52         : InsetCommand(p, "bibtex")
  53 {}
  54
  55
  56 ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
  57 {
  58         static ParamInfo param_info_;
  59         if (param_info_.empty()) {
  60                 param_info_.add("btprint", ParamInfo::LATEX_OPTIONAL);
  61                 param_info_.add("bibfiles", ParamInfo::LATEX_REQUIRED);
  62                 param_info_.add("embed", ParamInfo::LYX_INTERNAL);
  63                 param_info_.add("options", ParamInfo::LYX_INTERNAL);
  64         }
  65         return param_info_;
  66 }
  67
  68
  69 Inset * InsetBibtex::clone() const
  70 {
  71         return new InsetBibtex(*this);
  72 }
  73
  74
  75 void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
  76 {
  77         switch (cmd.action) {
  78
  79         case LFUN_INSET_MODIFY: {
  80                 InsetCommandParams p(BIBTEX_CODE);
  81                 try {
  82                         if (!InsetCommandMailer::string2params("bibtex",
  83                                         to_utf8(cmd.argument()), p)) {
  84                                 cur.noUpdate();
  85                                 break;
  86                         }
  87                 } catch (ExceptionMessage const & message) {
  88                         if (message.type_ == WarningException) {
  89                                 Alert::warning(message.title_, message.details_);
  90                                 cur.noUpdate();
  91                         } else
  92                                 throw message;
  93                         break;
  94                 }
  95                 //
  96                 InsetCommandParams orig = params();
  97                 // returned "embed" is composed of "true" or "false", which needs to be adjusted
  98                 string tmp;
  99                 string emb;
 100
 101                 string newBibfiles;
 102                 string newEmbedStatus;
 103
 104                 string bibfiles = to_utf8(p["bibfiles"]);
 105                 string embedStatus = to_utf8(p["embed"]);
 106
 107                 bibfiles = split(bibfiles, tmp, ',');
 108                 embedStatus = split(embedStatus, emb, ',');
 109                 while (!tmp.empty()) {
 110                         EmbeddedFile file(changeExtension(tmp, "bib"), buffer().filePath());
 111                         if (!newBibfiles.empty())
 112                                 newBibfiles += ",";
 113                         newBibfiles += tmp;
 114                         if (!newEmbedStatus.empty())
 115                                 newEmbedStatus += ",";
 116                         if (emb == "true")
 117                                 newEmbedStatus += file.inzipName();
 118                         // Get next file name
 119                         bibfiles = split(bibfiles, tmp, ',');
 120                         embedStatus = split(embedStatus, emb, ',');
 121                 }
 122                 LYXERR(Debug::FILES, "Update parameters from " << p["bibfiles"]
 123                         << " " << p["embed"] << " to " << newBibfiles << " "
 124                         << newEmbedStatus);
 125                 p["bibfiles"] = from_utf8(newBibfiles);
 126                 p["embed"] = from_utf8(newEmbedStatus);
 127
 128                 setParams(p);
 129                 try {
 130                         // test parameter and copy files
 131                         embeddedFiles();
 132                 } catch (ExceptionMessage const & message) {
 133                         Alert::error(message.title_, message.details_);
 134                         // do not set parameter if an error happens
 135                         setParams(orig);
 136                         break;
 137                 }
 138                 buffer().updateBibfilesCache();
 139                 break;
 140         }
 141
 142         default:
 143                 InsetCommand::doDispatch(cur, cmd);
 144                 break;
 145         }
 146 }
 147
 148
 149 docstring InsetBibtex::screenLabel() const
 150 {
 151         return _("BibTeX Generated Bibliography");
 152 }
 153
 154
 155 static string normalizeName(Buffer const & buffer,
 156         OutputParams const & runparams, string const & name, string const & ext)
 157 {
 158         string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
 159         if (FileName(name).isAbsolute() || !FileName(fname + ext).isReadableFile())
 160                 return name;
 161         if (!runparams.nice)
 162                 return fname;
 163
 164         // FIXME UNICODE
 165         return to_utf8(makeRelPath(from_utf8(fname),
 166                                          from_utf8(buffer.masterBuffer()->filePath())));
 167 }
 168
 169
 170 int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
 171 {
 172         // the sequence of the commands:
 173         // 1. \bibliographystyle{style}
 174         // 2. \addcontentsline{...} - if option bibtotoc set
 175         // 3. \bibliography{database}
 176         // and with bibtopic:
 177         // 1. \bibliographystyle{style}
 178         // 2. \begin{btSect}{database}
 179         // 3. \btPrint{Cited|NotCited|All}
 180         // 4. \end{btSect}
 181
 182         // Database(s)
 183         // If we are processing the LaTeX file in a temp directory then
 184         // copy the .bib databases to this temp directory, mangling their
 185         // names in the process. Store this mangled name in the list of
 186         // all databases.
 187         // (We need to do all this because BibTeX *really*, *really*
 188         // can't handle "files with spaces" and Windows users tend to
 189         // use such filenames.)
 190         // Otherwise, store the (maybe absolute) path to the original,
 191         // unmangled database name.
 192         EmbeddedFileList const bibs = embeddedFiles();
 193         EmbeddedFileList::const_iterator it = bibs.begin();
 194         EmbeddedFileList::const_iterator it_end = bibs.end();
 195         odocstringstream dbs;
 196         for (; it != it_end; ++it) {
 197                 string utf8input = removeExtension(it->availableFile().absFilename());
 198                 string database =
 199                         normalizeName(buffer(), runparams, utf8input, ".bib");
 200                 FileName const try_in_file =
 201                         makeAbsPath(database + ".bib", buffer().filePath());
 202                 bool const not_from_texmf = try_in_file.isReadableFile();
 203
 204                 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
 205                     not_from_texmf) {
 206
 207                         // mangledFilename() needs the extension
 208                         DocFileName const in_file = DocFileName(try_in_file);
 209                         database = removeExtension(in_file.mangledFilename());
 210                         FileName const out_file = makeAbsPath(database + ".bib",
 211                                         buffer().masterBuffer()->temppath());
 212
 213                         bool const success = in_file.copyTo(out_file);
 214                         if (!success) {
 215                                 lyxerr << "Failed to copy '" << in_file
 216                                        << "' to '" << out_file << "'"
 217                                        << endl;
 218                         }
 219                 } else if (!runparams.inComment && runparams.nice && not_from_texmf &&
 220                            !isValidLaTeXFilename(database)) {
 221                                 frontend::Alert::warning(_("Invalid filename"),
 222                                                          _("The following filename is likely to cause trouble "
 223                                                            "when running the exported file through LaTeX: ") +
 224                                                             from_utf8(database));
 225                 }
 226
 227                 if (it != bibs.begin())
 228                         dbs << ',';
 229                 // FIXME UNICODE
 230                 dbs << from_utf8(latex_path(database));
 231         }
 232         docstring const db_out = dbs.str();
 233
 234         // Post this warning only once.
 235         static bool warned_about_spaces = false;
 236         if (!warned_about_spaces &&
 237             runparams.nice && db_out.find(' ') != docstring::npos) {
 238                 warned_about_spaces = true;
 239
 240                 Alert::warning(_("Export Warning!"),
 241                                _("There are spaces in the paths to your BibTeX databases.\n"
 242                                               "BibTeX will be unable to find them."));
 243         }
 244
 245         // Style-Options
 246         string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
 247         string bibtotoc;
 248         if (prefixIs(style, "bibtotoc")) {
 249                 bibtotoc = "bibtotoc";
 250                 if (contains(style, ','))
 251                         style = split(style, bibtotoc, ',');
 252         }
 253
 254         // line count
 255         int nlines = 0;
 256
 257         if (!style.empty()) {
 258                 string base = normalizeName(buffer(), runparams, style, ".bst");
 259                 FileName const try_in_file =
 260                         makeAbsPath(base + ".bst", buffer().filePath());
 261                 bool const not_from_texmf = try_in_file.isReadableFile();
 262                 // If this style does not come from texmf and we are not
 263                 // exporting to .tex copy it to the tmp directory.
 264                 // This prevents problems with spaces and 8bit charcaters
 265                 // in the file name.
 266                 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
 267                     not_from_texmf) {
 268                         // use new style name
 269                         DocFileName const in_file = DocFileName(try_in_file);
 270                         base = removeExtension(in_file.mangledFilename());
 271                         FileName const out_file = makeAbsPath(base + ".bst",
 272                                         buffer().masterBuffer()->temppath());
 273                         bool const success = in_file.copyTo(out_file);
 274                         if (!success) {
 275                                 lyxerr << "Failed to copy '" << in_file
 276                                        << "' to '" << out_file << "'"
 277                                        << endl;
 278                         }
 279                 }
 280                 // FIXME UNICODE
 281                 os << "\\bibliographystyle{"
 282                    << from_utf8(latex_path(normalizeName(buffer(), runparams, base, ".bst")))
 283                    << "}\n";
 284                 nlines += 1;
 285         }
 286
 287         // Post this warning only once.
 288         static bool warned_about_bst_spaces = false;
 289         if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
 290                 warned_about_bst_spaces = true;
 291                 Alert::warning(_("Export Warning!"),
 292                                _("There are spaces in the path to your BibTeX style file.\n"
 293                                               "BibTeX will be unable to find it."));
 294         }
 295
 296         if (!db_out.empty() && buffer().params().use_bibtopic){
 297                 os << "\\begin{btSect}{" << db_out << "}\n";
 298                 docstring btprint = getParam("btprint");
 299                 if (btprint.empty())
 300                         // default
 301                         btprint = from_ascii("btPrintCited");
 302                 os << "\\" << btprint << "\n"
 303                    << "\\end{btSect}\n";
 304                 nlines += 3;
 305         }
 306
 307         // bibtotoc-Option
 308         if (!bibtotoc.empty() && !buffer().params().use_bibtopic) {
 309                 // maybe a problem when a textclass has no "art" as
 310                 // part of its name, because it's than book.
 311                 // For the "official" lyx-layouts it's no problem to support
 312                 // all well
 313                 if (!contains(buffer().params().textClass().name(),
 314                               "art")) {
 315                         if (buffer().params().sides == OneSide) {
 316                                 // oneside
 317                                 os << "\\clearpage";
 318                         } else {
 319                                 // twoside
 320                                 os << "\\cleardoublepage";
 321                         }
 322
 323                         // bookclass
 324                         os << "\\addcontentsline{toc}{chapter}{\\bibname}";
 325
 326                 } else {
 327                         // article class
 328                         os << "\\addcontentsline{toc}{section}{\\refname}";
 329                 }
 330         }
 331
 332         if (!db_out.empty() && !buffer().params().use_bibtopic) {
 333                 docstring btprint = getParam("btprint");
 334                 if (btprint == "btPrintAll") {
 335                         os << "\\nocite{*}\n";
 336                         nlines += 1;
 337                 }
 338                 os << "\\bibliography{" << db_out << "}\n";
 339                 nlines += 1;
 340         }
 341
 342         return nlines;
 343 }
 344
 345
 346 EmbeddedFileList InsetBibtex::embeddedFiles() const
 347 {
 348         FileName path(buffer().filePath());
 349         PathChanger p(path);
 350
 351         EmbeddedFileList vec;
 352
 353         string tmp;
 354         string emb;
 355         // FIXME UNICODE
 356         string bibfiles = to_utf8(getParam("bibfiles"));
 357         string embedStatus = to_utf8(getParam("embed"));
 358         bibfiles = split(bibfiles, tmp, ',');
 359         embedStatus = split(embedStatus, emb, ',');
 360         while (!tmp.empty()) {
 361                 if (!emb.empty()) {
 362                         EmbeddedFile file(changeExtension(tmp, "bib"), buffer().filePath());
 363                         // If the file structure is correct, this should not fail.
 364                         file.setEmbed(true);
 365                         file.enable(buffer().embedded(), &buffer());
 366                         vec.push_back(file);
 367                 } else {
 368                         // this includes the cases when the embed parameter is empty
 369                         FileName const file = findtexfile(changeExtension(tmp, "bib"), "bib");
 370
 371                         // If we didn't find a matching file name just fail silently
 372                         if (!file.empty()) {
 373                                 EmbeddedFile efile = EmbeddedFile(file.absFilename(), buffer().filePath());
 374                                 efile.setEmbed(false);
 375                                 efile.enable(buffer().embedded(), &buffer());
 376                                 vec.push_back(efile);
 377                         }
 378                 }
 379
 380                 // Get next file name
 381                 bibfiles = split(bibfiles, tmp, ',');
 382                 embedStatus = split(embedStatus, emb, ',');
 383         }
 384
 385         return vec;
 386 }
 387
 388 namespace {
 389
 390         // methods for parsing bibtex files
 391
 392         typedef map<docstring, docstring> VarMap;
 393
 394         /// remove whitespace characters, optionally a single comma,
 395         /// and further whitespace characters from the stream.
 396         /// @return true if a comma was found, false otherwise
 397         ///
 398         bool removeWSAndComma(idocfstream & ifs) {
 399                 char_type ch;
 400
 401                 if (!ifs)
 402                         return false;
 403
 404                 // skip whitespace
 405                 do {
 406                         ifs.get(ch);
 407                 } while (ifs && isSpace(ch));
 408
 409                 if (!ifs)
 410                         return false;
 411
 412                 if (ch != ',') {
 413                         ifs.putback(ch);
 414                         return false;
 415                 }
 416
 417                 // skip whitespace
 418                 do {
 419                         ifs.get(ch);
 420                 } while (ifs && isSpace(ch));
 421
 422                 if (ifs) {
 423                         ifs.putback(ch);
 424                 }
 425
 426                 return true;
 427         }
 428
 429
 430         enum charCase {
 431                 makeLowerCase,
 432                 keepCase
 433         };
 434
 435         /// remove whitespace characters, read characer sequence
 436         /// not containing whitespace characters or characters in
 437         /// delimChars, and remove further whitespace characters.
 438         ///
 439         /// @return true if a string of length > 0 could be read.
 440         ///
 441         bool readTypeOrKey(docstring & val, idocfstream & ifs,
 442                 docstring const & delimChars, docstring const &illegalChars,
 443                 charCase chCase) {
 444
 445                 char_type ch;
 446
 447                 val.clear();
 448
 449                 if (!ifs)
 450                         return false;
 451
 452                 // skip whitespace
 453                 do {
 454                         ifs.get(ch);
 455                 } while (ifs && isSpace(ch));
 456
 457                 if (!ifs)
 458                         return false;
 459
 460                 // read value
 461                 bool legalChar = true;
 462                 while (ifs && !isSpace(ch) &&
 463                                                  delimChars.find(ch) == docstring::npos &&
 464                                                  (legalChar = (illegalChars.find(ch) == docstring::npos))
 465                                         )
 466                 {
 467                         if (chCase == makeLowerCase)
 468                                 val += lowercase(ch);
 469                         else
 470                                 val += ch;
 471                         ifs.get(ch);
 472                 }
 473
 474                 if (!legalChar) {
 475                         ifs.putback(ch);
 476                         return false;
 477                 }
 478
 479                 // skip whitespace
 480                 while (ifs && isSpace(ch)) {
 481                         ifs.get(ch);
 482                 }
 483
 484                 if (ifs) {
 485                         ifs.putback(ch);
 486                 }
 487
 488                 return val.length() > 0;
 489         }
 490
 491         /// read subsequent bibtex values that are delimited with a #-character.
 492         /// Concatenate all parts and replace names with the associated string in
 493         /// the variable strings.
 494         /// @return true if reading was successfull (all single parts were delimited
 495         /// correctly)
 496         bool readValue(docstring & val, idocfstream & ifs, const VarMap & strings) {
 497
 498                 char_type ch;
 499
 500                 val.clear();
 501
 502                 if (!ifs)
 503                         return false;
 504
 505                 do {
 506                         // skip whitespace
 507                         do {
 508                                 ifs.get(ch);
 509                         } while (ifs && isSpace(ch));
 510
 511                         if (!ifs)
 512                                 return false;
 513
 514                         // check for field type
 515                         if (isDigit(ch)) {
 516
 517                                 // read integer value
 518                                 do {
 519                                         val += ch;
 520                                         ifs.get(ch);
 521                                 } while (ifs && isDigit(ch));
 522
 523                                 if (!ifs)
 524                                         return false;
 525
 526                         } else if (ch == '"' || ch == '{') {
 527                                 // set end delimiter
 528                                 char_type delim = ch == '"' ? '"': '}';
 529
 530                                 //Skip whitespace
 531                                 do {
 532                                         ifs.get(ch);
 533                                 } while (ifs && isSpace(ch));
 534
 535                                 if (!ifs)
 536                                         return false;
 537
 538                                 //We now have the first non-whitespace character
 539                                 //We'll collapse adjacent whitespace.
 540                                 bool lastWasWhiteSpace = false;
 541
 542                                 // inside this delimited text braces must match.
 543                                 // Thus we can have a closing delimiter only
 544                                 // when nestLevel == 0
 545                                 int nestLevel = 0;
 546
 547                                 while (ifs && (nestLevel > 0 || ch != delim)) {
 548                                         if (isSpace(ch)) {
 549                                                 lastWasWhiteSpace = true;
 550                                                 ifs.get(ch);
 551                                                 continue;
 552                                         }
 553                                         //We output the space only after we stop getting
 554                                         //whitespace so as not to output any whitespace
 555                                         //at the end of the value.
 556                                         if (lastWasWhiteSpace) {
 557                                                 lastWasWhiteSpace = false;
 558                                                 val += ' ';
 559                                         }
 560
 561                                         val += ch;
 562
 563                                         // update nesting level
 564                                         switch (ch) {
 565                                                 case '{':
 566                                                         ++nestLevel;
 567                                                         break;
 568                                                 case '}':
 569                                                         --nestLevel;
 570                                                         if (nestLevel < 0) return false;
 571                                                         break;
 572                                         }
 573
 574                                         ifs.get(ch);
 575                                 }
 576
 577                                 if (!ifs)
 578                                         return false;
 579
 580                                 ifs.get(ch);
 581
 582                                 if (!ifs)
 583                                         return false;
 584
 585                         } else {
 586
 587                                 // reading a string name
 588                                 docstring strName;
 589
 590                                 while (ifs && !isSpace(ch) && ch != '#' && ch != ',' && ch != '}' && ch != ')') {
 591                                         strName += lowercase(ch);
 592                                         ifs.get(ch);
 593                                 }
 594
 595                                 if (!ifs)
 596                                         return false;
 597
 598                                 // replace the string with its assigned value or
 599                                 // discard it if it's not assigned
 600                                 if (strName.length()) {
 601                                         VarMap::const_iterator pos = strings.find(strName);
 602                                         if (pos != strings.end()) {
 603                                                 val += pos->second;
 604                                         }
 605                                 }
 606                         }
 607
 608                         // skip WS
 609                         while (ifs && isSpace(ch)) {
 610                                 ifs.get(ch);
 611                         }
 612
 613                         if (!ifs)
 614                                 return false;
 615
 616                         // continue reading next value on concatenate with '#'
 617                 } while (ch == '#');
 618
 619                 ifs.putback(ch);
 620
 621                 return true;
 622         }
 623 }
 624
 625
 626 // This method returns a comma separated list of Bibtex entries
 627 void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
 628         InsetIterator const & /*di*/) const
 629 {
 630         EmbeddedFileList const files = embeddedFiles();
 631         for (vector<EmbeddedFile>::const_iterator it = files.begin();
 632              it != files.end(); ++ it) {
 633                 // This bibtex parser is a first step to parse bibtex files
 634                 // more precisely.
 635                 //
 636                 // - it reads the whole bibtex entry and does a syntax check
 637                 //   (matching delimiters, missing commas,...
 638                 // - it recovers from errors starting with the next @-character
 639                 // - it reads @string definitions and replaces them in the
 640                 //   field values.
 641                 // - it accepts more characters in keys or value names than
 642                 //   bibtex does.
 643                 //
 644                 // Officially bibtex does only support ASCII, but in practice
 645                 // you can use the encoding of the main document as long as
 646                 // some elements like keys and names are pure ASCII. Therefore
 647                 // we convert the file from the buffer encoding.
 648                 // We don't restrict keys to ASCII in LyX, since our own
 649                 // InsetBibitem can generate non-ASCII keys, and nonstandard
 650                 // 8bit clean bibtex forks exist.
 651
 652                 idocfstream ifs(it->availableFile().toFilesystemEncoding().c_str(),
 653                         ios_base::in, buffer().params().encoding().iconvName());
 654
 655                 char_type ch;
 656                 VarMap strings;
 657
 658                 while (ifs) {
 659
 660                         ifs.get(ch);
 661                         if (!ifs)
 662                                 break;
 663
 664                         if (ch != '@')
 665                                 continue;
 666
 667                         docstring entryType;
 668
 669                         if (!readTypeOrKey(entryType, ifs, from_ascii("{("),
 670                                            docstring(), makeLowerCase) || !ifs)
 671                                 continue;
 672
 673                         if (entryType == from_ascii("comment")) {
 674
 675                                 ifs.ignore(numeric_limits<int>::max(), '\n');
 676                                 continue;
 677                         }
 678
 679                         ifs.get(ch);
 680                         if (!ifs)
 681                                 break;
 682
 683                         if ((ch != '(') && (ch != '{')) {
 684                                 // invalid entry delimiter
 685                                 ifs.putback(ch);
 686                                 continue;
 687                         }
 688
 689                         // process the entry
 690                         if (entryType == from_ascii("string")) {
 691
 692                                 // read string and add it to the strings map
 693                                 // (or replace it's old value)
 694                                 docstring name;
 695                                 docstring value;
 696
 697                                 if (!readTypeOrKey(name, ifs, from_ascii("="),
 698                                                    from_ascii("#{}(),"), makeLowerCase) || !ifs)
 699                                         continue;
 700
 701                                 // next char must be an equal sign
 702                                 ifs.get(ch);
 703                                 if (!ifs || ch != '=')
 704                                         continue;
 705
 706                                 if (!readValue(value, ifs, strings))
 707                                         continue;
 708
 709                                 strings[name] = value;
 710
 711                         } else if (entryType == from_ascii("preamble")) {
 712
 713                                 // preamble definitions are discarded.
 714                                 // can they be of any use in lyx?
 715                                 docstring value;
 716
 717                                 if (!readValue(value, ifs, strings))
 718                                         continue;
 719
 720                         } else {
 721
 722                                 // Citation entry. Try to read the key.
 723                                 docstring key;
 724
 725                                 if (!readTypeOrKey(key, ifs, from_ascii(","),
 726                                                    from_ascii("}"), keepCase) || !ifs)
 727                                         continue;
 728
 729                                 /////////////////////////////////////////////
 730                                 // now we have a key, so we will add an entry
 731                                 // (even if it's empty, as bibtex does)
 732                                 //
 733                                 // we now read the field = value pairs.
 734                                 // all items must be separated by a comma. If
 735                                 // it is missing the scanning of this entry is
 736                                 // stopped and the next is searched.
 737                                 docstring fields;
 738                                 docstring name;
 739                                 docstring value;
 740                                 docstring commaNewline;
 741                                 docstring data;
 742                                 BibTeXInfo keyvalmap(key, entryType);
 743
 744                                 bool readNext = removeWSAndComma(ifs);
 745
 746                                 while (ifs && readNext) {
 747
 748                                         // read field name
 749                                         if (!readTypeOrKey(name, ifs, from_ascii("="),
 750                                                            from_ascii("{}(),"), makeLowerCase) || !ifs)
 751                                                 break;
 752
 753                                         // next char must be an equal sign
 754                                         ifs.get(ch);
 755                                         if (!ifs)
 756                                                 break;
 757                                         if (ch != '=') {
 758                                                 ifs.putback(ch);
 759                                                 break;
 760                                         }
 761
 762                                         // read field value
 763                                         if (!readValue(value, ifs, strings))
 764                                                 break;
 765
 766                                         keyvalmap[name] = value;
 767                                         data += "\n\n" + value;
 768                                         keylist.addFieldName(name);
 769                                         readNext = removeWSAndComma(ifs);
 770                                 }
 771
 772                                 // add the new entry
 773                                 keylist.addEntryType(entryType);
 774                                 keyvalmap.setAllData(data);
 775                                 keylist[key] = keyvalmap;
 776                         }
 777                 } //< searching '@'
 778         } //< for loop over files
 779 }
 780
 781
 782
 783 bool InsetBibtex::addDatabase(string const & db)
 784 {
 785         // FIXME UNICODE
 786         string bibfiles(to_utf8(getParam("bibfiles")));
 787         if (tokenPos(bibfiles, ',', db) == -1) {
 788                 if (!bibfiles.empty())
 789                         bibfiles += ',';
 790                 setParam("bibfiles", from_utf8(bibfiles + db));
 791                 return true;
 792         }
 793         return false;
 794 }
 795
 796
 797 bool InsetBibtex::delDatabase(string const & db)
 798 {
 799         // FIXME UNICODE
 800         string bibfiles(to_utf8(getParam("bibfiles")));
 801         if (contains(bibfiles, db)) {
 802                 int const n = tokenPos(bibfiles, ',', db);
 803                 string bd = db;
 804                 if (n > 0) {
 805                         // this is not the first database
 806                         string tmp = ',' + bd;
 807                         setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
 808                 } else if (n == 0)
 809                         // this is the first (or only) database
 810                         setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
 811                 else
 812                         return false;
 813         }
 814         return true;
 815 }
 816
 817
 818 void InsetBibtex::validate(LaTeXFeatures & features) const
 819 {
 820         if (features.bufferParams().use_bibtopic)
 821                 features.require("bibtopic");
 822 }
 823
 824
 825 void InsetBibtex::registerEmbeddedFiles(EmbeddedFileList & files) const
 826 {
 827         EmbeddedFileList const dbs = embeddedFiles();
 828         for (vector<EmbeddedFile>::const_iterator it = dbs.begin();
 829                 it != dbs.end(); ++it)
 830                 files.registerFile(*it, this, buffer());
 831 }
 832
 833
 834 void InsetBibtex::updateEmbeddedFile(EmbeddedFile const & file)
 835 {
 836         // look for the item and update status
 837         docstring bibfiles;
 838         docstring embed;
 839
 840         bool first = true;
 841         EmbeddedFileList dbs = embeddedFiles();
 842         for (EmbeddedFileList::iterator it = dbs.begin();
 843                 it != dbs.end(); ++it) {
 844                 // update from file
 845                 if (it->absFilename() == file.absFilename())
 846                         it->setEmbed(file.embedded());
 847                 // write parameter string
 848                 if (!first) {
 849                         bibfiles += ',';
 850                         embed += ',';
 851                 } else {
 852                         first = false;
 853                 }
 854                 bibfiles += from_utf8(it->outputFilename(buffer().filePath()));
 855                 if (it->embedded())
 856                         embed += from_utf8(it->inzipName());
 857         }
 858         setParam("bibfiles", bibfiles);
 859         setParam("embed", embed);
 860 }
 861
 862
 863 } // namespace lyx