]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetbibtex.C
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetbibtex.C
index 259f18ff692e3514cc137b0d7267271a0237d861..fa604fddd381159f9b1e90203dcfaab0bbae44ed 100644 (file)
@@ -16,6 +16,7 @@
 #include "bufferparams.h"
 #include "dispatchresult.h"
 #include "debug.h"
+#include "encoding.h"
 #include "funcrequest.h"
 #include "gettext.h"
 #include "LaTeXFeatures.h"
@@ -24,7 +25,6 @@
 
 #include "frontends/Alert.h"
 
-#include "support/filename.h"
 #include "support/filetools.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
 
 #include <boost/tokenizer.hpp>
 
-#include <fstream>
-#include <sstream>
-
-using lyx::support::AbsolutePath;
-using lyx::support::ascii_lowercase;
-using lyx::support::ChangeExtension;
-using lyx::support::contains;
-using lyx::support::copy;
-using lyx::support::FileName;
-using lyx::support::findtexfile;
-using lyx::support::IsFileReadable;
-using lyx::support::latex_path;
-using lyx::support::ltrim;
-using lyx::support::MakeAbsPath;
-using lyx::support::MakeRelPath;
-using lyx::support::Path;
-using lyx::support::prefixIs;
-using lyx::support::rtrim;
-using lyx::support::split;
-using lyx::support::subst;
-using lyx::support::tokenPos;
-using lyx::support::trim;
-
-namespace os = lyx::support::os;
+
+namespace lyx {
+
+using support::absolutePath;
+using support::ascii_lowercase;
+using support::changeExtension;
+using support::contains;
+using support::copy;
+using support::DocFileName;
+using support::FileName;
+using support::findtexfile;
+using support::isFileReadable;
+using support::latex_path;
+using support::ltrim;
+using support::makeAbsPath;
+using support::makeRelPath;
+using support::Path;
+using support::prefixIs;
+using support::removeExtension;
+using support::rtrim;
+using support::split;
+using support::subst;
+using support::tokenPos;
+using support::trim;
+
+namespace Alert = frontend::Alert;
+namespace os = support::os;
 
 using std::endl;
 using std::getline;
 using std::string;
-using std::ifstream;
 using std::ostream;
 using std::pair;
 using std::vector;
@@ -83,11 +85,12 @@ void InsetBibtex::doDispatch(LCursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY: {
-               InsetCommandParams p;
-               InsetCommandMailer::string2params("bibtex", cmd.argument, p);
-               if (!p.getCmdName().empty())
+               InsetCommandParams p("bibtex");
+               InsetCommandMailer::string2params("bibtex", to_utf8(cmd.argument()), p);
+               if (!p.getCmdName().empty()) {
                        setParams(p);
-               else
+                       cur.buffer().updateBibfilesCache();
+               } else
                        cur.noUpdate();
                break;
        }
@@ -99,7 +102,7 @@ void InsetBibtex::doDispatch(LCursor & cur, FuncRequest & cmd)
 }
 
 
-string const InsetBibtex::getScreenLabel(Buffer const &) const
+docstring const InsetBibtex::getScreenLabel(Buffer const &) const
 {
        return _("BibTeX Generated Bibliography");
 }
@@ -110,19 +113,19 @@ namespace {
 string normalize_name(Buffer const & buffer, OutputParams const & runparams,
                      string const & name, string const & ext)
 {
-       string const fname = MakeAbsPath(name, buffer.filePath());
-       if (AbsolutePath(name) || !IsFileReadable(fname + ext))
+       string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
+       if (absolutePath(name) || !isFileReadable(FileName(fname + ext)))
                return name;
        else if (!runparams.nice)
                return fname;
        else
-               return MakeRelPath(fname, buffer.getMasterBuffer()->filePath());
+               return makeRelPath(fname, buffer.getMasterBuffer()->filePath());
 }
 
 }
 
 
-int InsetBibtex::latex(Buffer const & buffer, ostream & os,
+int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
                       OutputParams const & runparams) const
 {
        // the sequence of the commands:
@@ -145,27 +148,35 @@ int InsetBibtex::latex(Buffer const & buffer, ostream & os,
        // use such filenames.)
        // Otherwise, store the (maybe absolute) path to the original,
        // unmangled database name.
-       typedef boost::char_separator<char> Separator;
-       typedef boost::tokenizer<Separator> Tokenizer;
-
-       Separator const separator(",");
-       Tokenizer const tokens(getContents(), separator);
+       typedef boost::char_separator<char_type> Separator;
+       typedef boost::tokenizer<Separator, docstring::const_iterator, docstring> Tokenizer;
+
+       Separator const separator(from_ascii(",").c_str());
+       // The tokenizer must not be called with temporary strings, since
+       // it does not make a copy and uses iterators of the string further
+       // down. getParam returns a reference, so this is OK.
+       Tokenizer const tokens(getParam("bibfiles"), separator);
        Tokenizer::const_iterator const begin = tokens.begin();
        Tokenizer::const_iterator const end = tokens.end();
 
-       std::ostringstream dbs;
+       odocstringstream dbs;
        for (Tokenizer::const_iterator it = begin; it != end; ++it) {
-               string const input = trim(*it);
+               docstring const input = trim(*it);
+               // FIXME UNICODE
+               string utf8input(to_utf8(input));
                string database =
-                       normalize_name(buffer, runparams, input, ".bib");
-               string const in_file = database + ".bib";
+                       normalize_name(buffer, runparams, utf8input, ".bib");
+               FileName const try_in_file(makeAbsPath(database + ".bib", buffer.filePath()));
+               bool const not_from_texmf = isFileReadable(try_in_file);
 
-               if (!runparams.inComment && !runparams.nice &&
-                   IsFileReadable(in_file)) {
+               if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
+                   not_from_texmf) {
 
-                       database = FileName(database).mangledFilename();
-                       string const out_file = MakeAbsPath(database + ".bib",
-                                       buffer.getMasterBuffer()->temppath());
+                       // 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()));
 
                        bool const success = copy(in_file, out_file);
                        if (!success) {
@@ -177,24 +188,25 @@ int InsetBibtex::latex(Buffer const & buffer, ostream & os,
 
                if (it != begin)
                        dbs << ',';
-               dbs << latex_path(database);
+               // FIXME UNICODE
+               dbs << from_utf8(latex_path(database));
        }
-       string const db_out = dbs.str();
+       docstring const db_out = dbs.str();
 
        // Post this warning only once.
        static bool warned_about_spaces = false;
        if (!warned_about_spaces &&
-           runparams.nice && db_out.find(' ') != string::npos) {
+           runparams.nice && db_out.find(' ') != docstring::npos) {
                warned_about_spaces = true;
 
                Alert::warning(_("Export Warning!"),
                               _("There are spaces in the paths to your BibTeX databases.\n"
-                                "BibTeX will be unable to find them."));
+                                             "BibTeX will be unable to find them."));
 
        }
 
        // Style-Options
-       string style = getOptions(); // maybe empty! and with bibtotoc
+       string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
        string bibtotoc;
        if (prefixIs(style, "bibtotoc")) {
                bibtotoc = "bibtotoc";
@@ -207,18 +219,50 @@ int InsetBibtex::latex(Buffer const & buffer, ostream & os,
        int nlines = 0;
 
        if (!style.empty()) {
+               string base =
+                       normalize_name(buffer, runparams, style, ".bst");
+               FileName const try_in_file(makeAbsPath(base + ".bst", buffer.filePath()));
+               bool const not_from_texmf = isFileReadable(try_in_file);
+               // 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
+               // in the file name.
+               if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
+                   not_from_texmf) {
+                       // use new style name
+                       DocFileName const in_file = DocFileName(try_in_file);
+                       base = removeExtension(in_file.mangledFilename());
+                       FileName const out_file(makeAbsPath(base + ".bst",
+                                       buffer.getMasterBuffer()->temppath()));
+                       bool const success = copy(in_file, out_file);
+                       if (!success) {
+                               lyxerr << "Failed to copy '" << in_file
+                                      << "' to '" << out_file << "'"
+                                      << endl;
+                       }
+               }
+               // FIXME UNICODE
                os << "\\bibliographystyle{"
-                  << latex_path(normalize_name(buffer, runparams, style, ".bst"))
+                  << from_utf8(latex_path(normalize_name(buffer, runparams, base, ".bst")))
                   << "}\n";
                nlines += 1;
        }
 
+       // Post this warning only once.
+       static bool warned_about_bst_spaces = false;
+       if (!warned_about_bst_spaces && runparams.nice && contains(style, ' ')) {
+               warned_about_bst_spaces = true;
+               Alert::warning(_("Export Warning!"),
+                              _("There are spaces in the path to your BibTeX style file.\n"
+                                             "BibTeX will be unable to find it."));
+       }
+
        if (!db_out.empty() && buffer.params().use_bibtopic){
                os << "\\begin{btSect}{" << db_out << "}\n";
-               string btprint = getSecOptions();
+               docstring btprint = getParam("btprint");
                if (btprint.empty())
                        // default
-                       btprint = "btPrintCited";
+                       btprint = from_ascii("btPrintCited");
                os << "\\" << btprint << "\n"
                   << "\\end{btSect}\n";
                nlines += 3;
@@ -258,17 +302,18 @@ int InsetBibtex::latex(Buffer const & buffer, ostream & os,
 }
 
 
-vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
+vector<FileName> const InsetBibtex::getFiles(Buffer const & buffer) const
 {
        Path p(buffer.filePath());
 
-       vector<string> vec;
+       vector<FileName> vec;
 
        string tmp;
-       string bibfiles = getContents();
+       // FIXME UNICODE
+       string bibfiles = to_utf8(getParam("bibfiles"));
        bibfiles = split(bibfiles, tmp, ',');
        while (!tmp.empty()) {
-               string file = findtexfile(ChangeExtension(tmp, "bib"), "bib");
+               FileName const file = findtexfile(changeExtension(tmp, "bib"), "bib");
                lyxerr[Debug::LATEX] << "Bibfile: " << file << endl;
 
                // If we didn't find a matching file name just fail silently
@@ -285,36 +330,48 @@ vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
 
 // This method returns a comma separated list of Bibtex entries
 void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
-                                 std::vector<std::pair<string, string> > & keys) const
+               std::vector<std::pair<string, docstring> > & keys) const
 {
-       vector<string> const files = getFiles(buffer);
-       for (vector<string>::const_iterator it = files.begin();
+       vector<FileName> const files = getFiles(buffer);
+       for (vector<FileName>::const_iterator it = files.begin();
             it != files.end(); ++ it) {
                // This is a _very_ simple parser for Bibtex database
                // files. All it does is to look for lines starting
                // in @ and not being @preamble and @string entries.
                // It does NOT do any syntax checking!
-               ifstream ifs(it->c_str());
-               string linebuf0;
+
+               // 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
+               // we convert the file from the buffer encoding.
+               // 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());
+               docstring linebuf0;
                while (getline(ifs, linebuf0)) {
-                       string linebuf = trim(linebuf0);
-                       if (linebuf.empty()) continue;
-                       if (prefixIs(linebuf, "@")) {
+                       docstring linebuf = trim(linebuf0);
+                       if (linebuf.empty())
+                               continue;
+                       if (prefixIs(linebuf, '@')) {
                                linebuf = subst(linebuf, '{', '(');
-                               string tmp;
+                               docstring tmp;
                                linebuf = split(linebuf, tmp, '(');
                                tmp = ascii_lowercase(tmp);
-                               if (!prefixIs(tmp, "@string")
-                                   && !prefixIs(tmp, "@preamble")) {
+                               if (!prefixIs(tmp, from_ascii("@string")) &&
+                                   !prefixIs(tmp, from_ascii("@preamble"))) {
                                        linebuf = split(linebuf, tmp, ',');
                                        tmp = ltrim(tmp, " \t");
                                        if (!tmp.empty()) {
-                                               keys.push_back(pair<string,string>(tmp,string()));
+                                               // FIXME UNICODE
+                                               keys.push_back(pair<string, docstring>(
+                                                       to_utf8(tmp), docstring()));
                                        }
                                }
-                       } else if (!keys.empty()) {
-                               keys.back().second += linebuf + "\n";
-                       }
+                       } else if (!keys.empty())
+                               keys.back().second += linebuf + '\n';
                }
        }
 }
@@ -322,11 +379,12 @@ void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
 
 bool InsetBibtex::addDatabase(string const & db)
 {
-       string contents(getContents());
-       if (tokenPos(contents, ',', db) == -1) {
-               if (!contents.empty())
-                       contents += ',';
-               setContents(contents + db);
+       // FIXME UNICODE
+       string bibfiles(to_utf8(getParam("bibfiles")));
+       if (tokenPos(bibfiles, ',', db) == -1) {
+               if (!bibfiles.empty())
+                       bibfiles += ',';
+               setParam("bibfiles", from_utf8(bibfiles + db));
                return true;
        }
        return false;
@@ -335,17 +393,18 @@ bool InsetBibtex::addDatabase(string const & db)
 
 bool InsetBibtex::delDatabase(string const & db)
 {
-       string contents(getContents());
-       if (contains(contents, db)) {
-               int const n = tokenPos(contents, ',', db);
+       // FIXME UNICODE
+       string bibfiles(to_utf8(getParam("bibfiles")));
+       if (contains(bibfiles, db)) {
+               int const n = tokenPos(bibfiles, ',', db);
                string bd = db;
                if (n > 0) {
                        // this is not the first database
                        string tmp = ',' + bd;
-                       setContents(subst(contents, tmp, ""));
+                       setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
                } else if (n == 0)
                        // this is the first (or only) database
-                       setContents(split(contents, bd, ','));
+                       setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
                else
                        return false;
        }
@@ -358,3 +417,6 @@ void InsetBibtex::validate(LaTeXFeatures & features) const
        if (features.bufferParams().use_bibtopic)
                features.require("bibtopic");
 }
+
+
+} // namespace lyx