]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetBibtex.cpp
cosmetics. mainly replace #include "dostring.h" by #include "strfwd.h"
[features.git] / src / insets / InsetBibtex.cpp
index bb8cd53987ccd6e548db252b4b68e2780c8e8536..d5a076671fbcfc876690bc639bd6ed61cf8de43c 100644 (file)
@@ -4,6 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
+ * \author Richard Heck (BibTeX parser improvements)
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -25,6 +26,8 @@
 
 #include "frontends/alert.h"
 
+#include "support/ExceptionMessage.h"
+#include "support/docstream.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
@@ -45,7 +48,6 @@ using support::copy;
 using support::DocFileName;
 using support::FileName;
 using support::findtexfile;
-using support::isFileReadable;
 using support::isValidLaTeXFilename;
 using support::latex_path;
 using support::ltrim;
@@ -77,9 +79,19 @@ InsetBibtex::InsetBibtex(InsetCommandParams const & p)
 {}
 
 
-std::auto_ptr<Inset> InsetBibtex::doClone() const
+CommandInfo const * InsetBibtex::findInfo(std::string const & /* cmdName */)
 {
-       return std::auto_ptr<Inset>(new InsetBibtex(*this));
+       static const char * const paramnames[] = 
+               {"options", "btprint", "bibfiles", ""};
+       static const bool isoptional[] = {true, true, false};
+       static const CommandInfo info = {3, paramnames, isoptional};
+       return &info;
+}
+
+
+Inset * InsetBibtex::clone() const
+{
+       return new InsetBibtex(*this);
 }
 
 
@@ -88,13 +100,23 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY: {
-               InsetCommandParams p("bibtex");
-               InsetCommandMailer::string2params("bibtex", to_utf8(cmd.argument()), p);
-               if (!p.getCmdName().empty()) {
-                       setParams(p);
-                       cur.buffer().updateBibfilesCache();
-               } else
-                       cur.noUpdate();
+               InsetCommandParams p(BIBTEX_CODE);
+               try {
+                       if (!InsetCommandMailer::string2params("bibtex", 
+                                       to_utf8(cmd.argument()), p)) {
+                               cur.noUpdate();
+                               break;
+                       }
+               } catch (support::ExceptionMessage const & message) {
+                       if (message.type_ == support::WarningException) {
+                               Alert::warning(message.title_, message.details_);
+                               cur.noUpdate();
+                       } else 
+                               throw message;
+                       break;
+               }
+               setParams(p);
+               cur.buffer().updateBibfilesCache();
                break;
        }
 
@@ -113,18 +135,18 @@ docstring const InsetBibtex::getScreenLabel(Buffer const &) const
 
 namespace {
 
-string normalize_name(Buffer const & buffer, OutputParams const & runparams,
+string normalizeName(Buffer const & buffer, OutputParams const & runparams,
                      string const & name, string const & ext)
 {
        string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
-       if (absolutePath(name) || !isFileReadable(FileName(fname + ext)))
+       if (absolutePath(name) || !FileName(fname + ext).isFileReadable())
                return name;
-       else if (!runparams.nice)
+       if (!runparams.nice)
                return fname;
-       else
-               // FIXME UNICODE
-               return to_utf8(makeRelPath(from_utf8(fname),
-                                          from_utf8(buffer.getMasterBuffer()->filePath())));
+
+       // FIXME UNICODE
+       return to_utf8(makeRelPath(from_utf8(fname),
+                                        from_utf8(buffer.masterBuffer()->filePath())));
 }
 
 }
@@ -168,11 +190,11 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
        for (Tokenizer::const_iterator it = begin; it != end; ++it) {
                docstring const input = trim(*it);
                // FIXME UNICODE
-               string utf8input(to_utf8(input));
+               string utf8input = to_utf8(input);
                string database =
-                       normalize_name(buffer, runparams, utf8input, ".bib");
+                       normalizeName(buffer, runparams, utf8input, ".bib");
                FileName const try_in_file(makeAbsPath(database + ".bib", buffer.filePath()));
-               bool const not_from_texmf = isFileReadable(try_in_file);
+               bool const not_from_texmf = try_in_file.isFileReadable();
 
                if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
                    not_from_texmf) {
@@ -180,8 +202,8 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
                        // mangledFilename() needs the extension
                        DocFileName const in_file = DocFileName(try_in_file);
                        database = removeExtension(in_file.mangledFilename());
-                       FileName const out_file(makeAbsPath(database + ".bib",
-                                       buffer.getMasterBuffer()->temppath()));
+                       FileName const out_file = makeAbsPath(database + ".bib",
+                                       buffer.masterBuffer()->temppath());
 
                        bool const success = copy(in_file, out_file);
                        if (!success) {
@@ -213,7 +235,6 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
                Alert::warning(_("Export Warning!"),
                               _("There are spaces in the paths to your BibTeX databases.\n"
                                              "BibTeX will be unable to find them."));
-
        }
 
        // Style-Options
@@ -221,19 +242,17 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
        string bibtotoc;
        if (prefixIs(style, "bibtotoc")) {
                bibtotoc = "bibtotoc";
-               if (contains(style, ',')) {
+               if (contains(style, ','))
                        style = split(style, bibtotoc, ',');
-               }
        }
 
        // line count
        int nlines = 0;
 
        if (!style.empty()) {
-               string base =
-                       normalize_name(buffer, runparams, style, ".bst");
+               string base = normalizeName(buffer, runparams, style, ".bst");
                FileName const try_in_file(makeAbsPath(base + ".bst", buffer.filePath()));
-               bool const not_from_texmf = isFileReadable(try_in_file);
+               bool const not_from_texmf = try_in_file.isFileReadable();
                // If this style does not come from texmf and we are not
                // exporting to .tex copy it to the tmp directory.
                // This prevents problems with spaces and 8bit charcaters
@@ -244,7 +263,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
                        DocFileName const in_file = DocFileName(try_in_file);
                        base = removeExtension(in_file.mangledFilename());
                        FileName const out_file(makeAbsPath(base + ".bst",
-                                       buffer.getMasterBuffer()->temppath()));
+                                       buffer.masterBuffer()->temppath()));
                        bool const success = copy(in_file, out_file);
                        if (!success) {
                                lyxerr << "Failed to copy '" << in_file
@@ -254,7 +273,7 @@ int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
                }
                // FIXME UNICODE
                os << "\\bibliographystyle{"
-                  << from_utf8(latex_path(normalize_name(buffer, runparams, base, ".bst")))
+                  << from_utf8(latex_path(normalizeName(buffer, runparams, base, ".bst")))
                   << "}\n";
                nlines += 1;
        }
@@ -412,16 +431,16 @@ namespace {
                        return false;
 
                // read value
-               bool legalChar;
+               bool legalChar = true;
                while (ifs && !isSpace(ch) && 
-                          delimChars.find(ch) == docstring::npos &&
-                          (legalChar = illegalChars.find(ch) == docstring::npos)
-                          ) {
-                       if (chCase == makeLowerCase) {
+                                                delimChars.find(ch) == docstring::npos &&
+                                                (legalChar = (illegalChars.find(ch) == docstring::npos))
+                                       ) 
+               {
+                       if (chCase == makeLowerCase)
                                val += lowercase(ch);
-                       } else {
+                       else
                                val += ch;
-                       }
                        ifs.get(ch);
                }
                
@@ -478,17 +497,40 @@ namespace {
                                        return false;
 
                        } else if (ch == '"' || ch == '{') {
+                               // set end delimiter
+                               char_type delim = ch == '"' ? '"': '}';
 
-                               // read delimited text - set end delimiter
-                               char_type delim = ch == '"'? '"': '}';
-
-                               // inside this delimited text braces must match.
-                               // Thus we can have a closing delimiter only
-                               // when nestLevel == 0
+                               //Skip whitespace
+                               do {
+                                       ifs.get(ch);
+                               } while (ifs && isSpace(ch));
+                               
+                               if (!ifs)
+                                       return false;
+                               
+                               //We now have the first non-whitespace character
+                               //We'll collapse adjacent whitespace.
+                               bool lastWasWhiteSpace = false;
+                               
+                               // inside this delimited text braces must match.
+                               // Thus we can have a closing delimiter only
+                               // when nestLevel == 0
                                int nestLevel = 0;
-
-                               ifs.get(ch);
                                while (ifs && (nestLevel > 0 || ch != delim)) {
+                                       if (isSpace(ch)) {
+                                               lastWasWhiteSpace = true;
+                                               ifs.get(ch);
+                                               continue;
+                                       }
+                                       //We output the space only after we stop getting 
+                                       //whitespace so as not to output any whitespace
+                                       //at the end of the value.
+                                       if (lastWasWhiteSpace) {
+                                               lastWasWhiteSpace = false;
+                                               val += ' ';
+                                       }
+                                       
                                        val += ch;
 
                                        // update nesting level
@@ -556,7 +598,7 @@ namespace {
 
 // This method returns a comma separated list of Bibtex entries
 void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
-               std::vector<std::pair<string, docstring> > & keys) const
+               BiblioInfo & keylist, InsetIterator const & /*di*/) const
 {
        vector<FileName> const files = getFiles(buffer);
        for (vector<FileName>::const_iterator it = files.begin();
@@ -572,15 +614,6 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
                // - it accepts more characters in keys or value names than
                //   bibtex does.
                //
-               // TODOS:
-               // - the entries are split into name = value pairs by the
-               //   parser. These have to be merged again because of the
-               //   way lyx treats the entries ( pair<...>(...) ). The citation
-               //   mechanism in lyx should be changed such that it can use
-               //   the split entries.
-               // - messages on parsing errors can be generated.
-               //
-
                // Officially bibtex does only support ASCII, but in practice
                // you can use the encoding of the main document as long as
                // some elements like keys and names are pure ASCII. Therefore
@@ -588,9 +621,10 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
                // We don't restrict keys to ASCII in LyX, since our own
                // InsetBibitem can generate non-ASCII keys, and nonstandard
                // 8bit clean bibtex forks exist.
+               
                idocfstream ifs(it->toFilesystemEncoding().c_str(),
-                               std::ios_base::in,
-                               buffer.params().encoding().iconvName());
+                       std::ios_base::in,
+                       buffer.params().encoding().iconvName());
 
                char_type ch;
                VarMap strings;
@@ -659,25 +693,31 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
 
                        } else {
 
-                               // Citation entry. Read the key and all name = value pairs
+                               // Citation entry. Try to read the key.
                                docstring key;
-                               docstring fields;
-                               docstring name;
-                               docstring value;
-                               docstring commaNewline;
 
                                if (!readTypeOrKey(key, ifs, from_ascii(","), 
                                                   from_ascii("}"), keepCase) || !ifs)
                                        continue;
 
-                               // now we have a key, so we will add an entry
-                               // (even if it's empty, as bibtex does)
+                               /////////////////////////////////////////////
+                               // now we have a key, so we will add an entry 
+                               // (even if it's empty, as bibtex does)
                                //
-                               // all items must be separated by a comma. If
-                               // it is missing the scanning of this entry is
-                               // stopped and the next is searched.
+                               // we now read the field = value pairs.
+                               // all items must be separated by a comma. If
+                               // it is missing the scanning of this entry is
+                               // stopped and the next is searched.
+                               docstring fields;
+                               docstring name;
+                               docstring value;
+                               docstring commaNewline;
+                               docstring data;
+                               BibTeXInfo keyvalmap;
+                               keyvalmap.entryType = entryType;
+                               
                                bool readNext = removeWSAndComma(ifs);
-
                                while (ifs && readNext) {
 
                                        // read field name
@@ -698,27 +738,20 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
                                        if (!readValue(value, ifs, strings))
                                                break;
 
-                                       // append field to the total entry string.
-                                       //
-                                       // TODO: Here is where the fields can be put in
-                                       //       a more intelligent structure that preserves
-                                       //           the already known parts.
-                                       fields += commaNewline;
-                                       fields += name + from_ascii(" = {") + value + '}';
-
-                                       if (!commaNewline.length())
-                                               commaNewline = from_ascii(",\n");
-
+                                       keyvalmap[name] = value;
+                                       data += "\n\n" + value;
+                                       keylist.fieldNames.insert(name);
                                        readNext = removeWSAndComma(ifs);
                                }
 
                                // add the new entry
-                               keys.push_back(pair<string, docstring>(
-                               to_utf8(key), fields));
+                               keylist.entryTypes.insert(entryType);
+                               keyvalmap.allData = data;
+                               keyvalmap.isBibTeX = true;
+                               keyvalmap.bibKey = key;
+                               keylist[key] = keyvalmap;
                        }
-
                } //< searching '@'
-
        } //< for loop over files
 }