2002-09-25 14:26:13 +00:00
|
|
|
/**
|
2007-04-25 01:24:38 +00:00
|
|
|
* \file InsetBibtex.cpp
|
2002-09-25 14:26:13 +00:00
|
|
|
* This file is part of LyX, the document processor.
|
|
|
|
* Licence details can be found in the file COPYING.
|
|
|
|
*
|
|
|
|
* \author Alejandro Aguilar Sierra
|
|
|
|
*
|
2003-08-23 00:17:00 +00:00
|
|
|
* Full author contact details are available in file CREDITS.
|
2002-09-25 14:26:13 +00:00
|
|
|
*/
|
1999-09-27 18:44:28 +00:00
|
|
|
|
2003-06-02 10:03:27 +00:00
|
|
|
#include <config.h>
|
1999-09-27 18:44:28 +00:00
|
|
|
|
2007-04-25 01:24:38 +00:00
|
|
|
#include "InsetBibtex.h"
|
2003-09-05 09:01:27 +00:00
|
|
|
|
1999-09-27 18:44:28 +00:00
|
|
|
#include "buffer.h"
|
2003-09-09 11:24:33 +00:00
|
|
|
#include "bufferparams.h"
|
2003-10-29 10:47:21 +00:00
|
|
|
#include "dispatchresult.h"
|
2003-02-21 09:20:18 +00:00
|
|
|
#include "debug.h"
|
2006-12-15 16:09:05 +00:00
|
|
|
#include "encoding.h"
|
2003-02-26 19:28:38 +00:00
|
|
|
#include "funcrequest.h"
|
1999-09-27 18:44:28 +00:00
|
|
|
#include "gettext.h"
|
2005-07-14 12:53:12 +00:00
|
|
|
#include "LaTeXFeatures.h"
|
2003-09-05 09:01:27 +00:00
|
|
|
#include "metricsinfo.h"
|
2003-11-05 12:06:20 +00:00
|
|
|
#include "outputparams.h"
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
#include "frontends/Alert.h"
|
|
|
|
|
1999-10-02 16:21:10 +00:00
|
|
|
#include "support/filetools.h"
|
2001-07-29 17:39:01 +00:00
|
|
|
#include "support/lstrings.h"
|
2005-07-14 12:53:12 +00:00
|
|
|
#include "support/lyxlib.h"
|
2003-09-05 09:01:27 +00:00
|
|
|
#include "support/os.h"
|
|
|
|
#include "support/path.h"
|
2007-04-04 20:06:34 +00:00
|
|
|
#include "support/textutils.h"
|
2001-12-28 13:26:54 +00:00
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
#include <boost/tokenizer.hpp>
|
|
|
|
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
namespace lyx {
|
|
|
|
|
|
|
|
using support::absolutePath;
|
|
|
|
using support::ascii_lowercase;
|
|
|
|
using support::changeExtension;
|
|
|
|
using support::contains;
|
|
|
|
using support::copy;
|
2006-11-18 12:49:47 +00:00
|
|
|
using support::DocFileName;
|
2006-11-26 21:30:39 +00:00
|
|
|
using support::FileName;
|
2006-10-21 00:16:43 +00:00
|
|
|
using support::findtexfile;
|
|
|
|
using support::isFileReadable;
|
|
|
|
using support::latex_path;
|
|
|
|
using support::ltrim;
|
|
|
|
using support::makeAbsPath;
|
|
|
|
using support::makeRelPath;
|
|
|
|
using support::prefixIs;
|
|
|
|
using support::removeExtension;
|
|
|
|
using support::rtrim;
|
|
|
|
using support::split;
|
|
|
|
using support::subst;
|
|
|
|
using support::tokenPos;
|
|
|
|
using support::trim;
|
2007-04-04 20:06:34 +00:00
|
|
|
using support::lowercase;
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
namespace Alert = frontend::Alert;
|
|
|
|
namespace os = support::os;
|
2003-09-16 11:03:20 +00:00
|
|
|
|
2000-03-28 02:18:55 +00:00
|
|
|
using std::endl;
|
2003-09-05 09:01:27 +00:00
|
|
|
using std::getline;
|
2003-10-06 15:43:21 +00:00
|
|
|
using std::string;
|
2003-09-05 09:01:27 +00:00
|
|
|
using std::ostream;
|
2000-06-07 08:53:40 +00:00
|
|
|
using std::pair;
|
2003-09-05 09:01:27 +00:00
|
|
|
using std::vector;
|
2007-04-04 20:06:34 +00:00
|
|
|
using std::map;
|
2003-02-18 12:36:02 +00:00
|
|
|
|
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
InsetBibtex::InsetBibtex(InsetCommandParams const & p)
|
2003-12-11 15:23:15 +00:00
|
|
|
: InsetCommand(p, "bibtex")
|
2000-07-15 23:51:46 +00:00
|
|
|
{}
|
|
|
|
|
1999-09-27 18:44:28 +00:00
|
|
|
|
2004-11-23 23:04:52 +00:00
|
|
|
std::auto_ptr<InsetBase> InsetBibtex::doClone() const
|
2003-09-03 17:28:39 +00:00
|
|
|
{
|
2003-09-03 17:40:58 +00:00
|
|
|
return std::auto_ptr<InsetBase>(new InsetBibtex(*this));
|
2003-09-03 17:28:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2004-11-24 21:58:42 +00:00
|
|
|
void InsetBibtex::doDispatch(LCursor & cur, FuncRequest & cmd)
|
2003-02-26 19:28:38 +00:00
|
|
|
{
|
2003-03-07 21:44:48 +00:00
|
|
|
switch (cmd.action) {
|
2003-05-16 07:44:00 +00:00
|
|
|
|
2003-03-07 21:44:48 +00:00
|
|
|
case LFUN_INSET_MODIFY: {
|
Rework InsetCommandParams interface and file storage
* src/insets/insetcommandparams.[Ch]:
(operator[]): New, access a parameter
(clear): New, clear all parameters
(info_): New, stire info about this command
(cmdname): Rename to name_
(contents, options, sec_options): Replace with params_. Parameters
are now stored as docstring.
(findInfo): New factor for command info for all commands
(read, write): Use new syntax
(parameter set and get methods): reimplemenmt for new parameter storage
* src/insets/insetcommand.h
(getParam): New, get a parameter
(setParam): New, set a parameter
(parameter set and get methods): Adjust to InsetCommandParams changes
* src/insets/insetbibitem.[Ch]
(write): Remove, not needed anymore
(directWrite): ditto
* src/insets/insetbibitem.C
(InsetBibitem::read): Use InsetCommand::read
* src/insets/insetref.C
(InsetRef::latex): Use new InsetCommandParams interface
* src/mathed/InsetMathHull.C
(InsetMathHull::doDispatch): ditto
* src/text3.C
(LyXText::dispatch): ditto
* src/factory.C
(createInset): Create InsetCommandParams with command name
(readInset): ditto
(readInset): Remove error message for bibitem, since bibitem is
now a normal command inset
* src/buffer.C: Bump file format number
* src/frontends/controllers/ControlCommand.[Ch]
(ControlCommand): take an additional command name parameter
* src/text.C
(readParToken): Remove code for \bibitem
* lib/lyx2lyx/LyX.py: Bump latest file format number
* lib/lyx2lyx/lyx_1_5.py
(convert_bibitem, convert_commandparams): new, convert to new format
(revert_commandparams): new, convert to old format
* development/FORMAT: document new format
* many other files: Adjust to the changes above
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@15357 a592a061-630c-0410-9148-cb99ea01b6c8
2006-10-17 21:07:16 +00:00
|
|
|
InsetCommandParams p("bibtex");
|
2006-10-21 00:16:43 +00:00
|
|
|
InsetCommandMailer::string2params("bibtex", to_utf8(cmd.argument()), p);
|
2006-04-15 11:46:17 +00:00
|
|
|
if (!p.getCmdName().empty()) {
|
2003-11-03 19:52:47 +00:00
|
|
|
setParams(p);
|
2006-04-15 11:46:17 +00:00
|
|
|
cur.buffer().updateBibfilesCache();
|
|
|
|
} else
|
2005-05-17 11:11:45 +00:00
|
|
|
cur.noUpdate();
|
2004-02-16 11:58:51 +00:00
|
|
|
break;
|
2003-03-07 21:44:48 +00:00
|
|
|
}
|
2004-04-03 08:37:12 +00:00
|
|
|
|
2003-03-07 21:44:48 +00:00
|
|
|
default:
|
2004-11-24 21:58:42 +00:00
|
|
|
InsetCommand::doDispatch(cur, cmd);
|
2004-02-16 11:58:51 +00:00
|
|
|
break;
|
2003-02-26 19:28:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2003-11-03 19:52:47 +00:00
|
|
|
|
2006-10-11 19:40:50 +00:00
|
|
|
docstring const InsetBibtex::getScreenLabel(Buffer const &) const
|
1999-09-27 18:44:28 +00:00
|
|
|
{
|
2006-10-11 19:40:50 +00:00
|
|
|
return _("BibTeX Generated Bibliography");
|
1999-09-27 18:44:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2004-04-20 12:46:15 +00:00
|
|
|
namespace {
|
|
|
|
|
|
|
|
string normalize_name(Buffer const & buffer, OutputParams const & runparams,
|
|
|
|
string const & name, string const & ext)
|
|
|
|
{
|
2006-12-27 10:56:11 +00:00
|
|
|
string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
|
2006-11-26 21:30:39 +00:00
|
|
|
if (absolutePath(name) || !isFileReadable(FileName(fname + ext)))
|
2004-04-20 12:46:15 +00:00
|
|
|
return name;
|
2004-04-29 07:58:52 +00:00
|
|
|
else if (!runparams.nice)
|
2004-04-20 12:46:15 +00:00
|
|
|
return fname;
|
2004-04-29 07:58:52 +00:00
|
|
|
else
|
2007-03-27 07:24:16 +00:00
|
|
|
// FIXME UNICODE
|
|
|
|
return to_utf8(makeRelPath(from_utf8(fname),
|
|
|
|
from_utf8(buffer.getMasterBuffer()->filePath())));
|
2004-04-20 12:46:15 +00:00
|
|
|
}
|
2004-04-29 07:58:52 +00:00
|
|
|
|
2004-04-20 12:46:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2006-10-19 16:51:30 +00:00
|
|
|
int InsetBibtex::latex(Buffer const & buffer, odocstream & os,
|
2003-11-05 12:06:20 +00:00
|
|
|
OutputParams const & runparams) const
|
1999-09-27 18:44:28 +00:00
|
|
|
{
|
2004-03-29 13:17:25 +00:00
|
|
|
// the sequence of the commands:
|
2001-08-20 13:42:29 +00:00
|
|
|
// 1. \bibliographystyle{style}
|
2003-09-03 17:40:58 +00:00
|
|
|
// 2. \addcontentsline{...} - if option bibtotoc set
|
|
|
|
// 3. \bibliography{database}
|
2004-03-29 13:17:25 +00:00
|
|
|
// and with bibtopic:
|
|
|
|
// 1. \bibliographystyle{style}
|
|
|
|
// 2. \begin{btSect}{database}
|
|
|
|
// 3. \btPrint{Cited|NotCited|All}
|
|
|
|
// 4. \end{btSect}
|
2004-04-03 08:37:12 +00:00
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
// Database(s)
|
|
|
|
// If we are processing the LaTeX file in a temp directory then
|
|
|
|
// copy the .bib databases to this temp directory, mangling their
|
|
|
|
// names in the process. Store this mangled name in the list of
|
|
|
|
// all databases.
|
|
|
|
// (We need to do all this because BibTeX *really*, *really*
|
|
|
|
// can't handle "files with spaces" and Windows users tend to
|
|
|
|
// use such filenames.)
|
|
|
|
// Otherwise, store the (maybe absolute) path to the original,
|
|
|
|
// unmangled database name.
|
2006-11-14 19:54:56 +00:00
|
|
|
typedef boost::char_separator<char_type> Separator;
|
|
|
|
typedef boost::tokenizer<Separator, docstring::const_iterator, docstring> Tokenizer;
|
2005-07-14 12:53:12 +00:00
|
|
|
|
2006-11-14 19:54:56 +00:00
|
|
|
Separator const separator(from_ascii(",").c_str());
|
2006-11-14 20:33:13 +00:00
|
|
|
// 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.
|
2006-11-14 19:54:56 +00:00
|
|
|
Tokenizer const tokens(getParam("bibfiles"), separator);
|
2005-07-14 12:53:12 +00:00
|
|
|
Tokenizer::const_iterator const begin = tokens.begin();
|
|
|
|
Tokenizer::const_iterator const end = tokens.end();
|
|
|
|
|
2006-11-14 19:54:56 +00:00
|
|
|
odocstringstream dbs;
|
2005-07-14 12:53:12 +00:00
|
|
|
for (Tokenizer::const_iterator it = begin; it != end; ++it) {
|
2006-11-14 19:54:56 +00:00
|
|
|
docstring const input = trim(*it);
|
|
|
|
// FIXME UNICODE
|
|
|
|
string utf8input(to_utf8(input));
|
2005-07-14 12:53:12 +00:00
|
|
|
string database =
|
2006-11-14 19:54:56 +00:00
|
|
|
normalize_name(buffer, runparams, utf8input, ".bib");
|
2006-12-27 10:56:11 +00:00
|
|
|
FileName const try_in_file(makeAbsPath(database + ".bib", buffer.filePath()));
|
|
|
|
bool const not_from_texmf = isFileReadable(try_in_file);
|
2005-07-14 12:53:12 +00:00
|
|
|
|
2006-04-10 16:27:59 +00:00
|
|
|
if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
|
2006-11-26 21:30:39 +00:00
|
|
|
not_from_texmf) {
|
2005-07-14 12:53:12 +00:00
|
|
|
|
2006-04-01 10:49:58 +00:00
|
|
|
// mangledFilename() needs the extension
|
2006-11-26 21:30:39 +00:00
|
|
|
DocFileName const in_file = DocFileName(try_in_file);
|
|
|
|
database = removeExtension(in_file.mangledFilename());
|
2006-12-27 10:56:11 +00:00
|
|
|
FileName const out_file(makeAbsPath(database + ".bib",
|
2006-11-26 21:30:39 +00:00
|
|
|
buffer.getMasterBuffer()->temppath()));
|
2005-07-14 12:53:12 +00:00
|
|
|
|
|
|
|
bool const success = copy(in_file, out_file);
|
|
|
|
if (!success) {
|
|
|
|
lyxerr << "Failed to copy '" << in_file
|
|
|
|
<< "' to '" << out_file << "'"
|
|
|
|
<< endl;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (it != begin)
|
|
|
|
dbs << ',';
|
2006-11-14 19:54:56 +00:00
|
|
|
// FIXME UNICODE
|
|
|
|
dbs << from_utf8(latex_path(database));
|
2005-07-14 12:53:12 +00:00
|
|
|
}
|
2006-11-14 19:54:56 +00:00
|
|
|
docstring const db_out = dbs.str();
|
2005-07-14 12:53:12 +00:00
|
|
|
|
|
|
|
// Post this warning only once.
|
|
|
|
static bool warned_about_spaces = false;
|
|
|
|
if (!warned_about_spaces &&
|
2006-10-20 16:12:49 +00:00
|
|
|
runparams.nice && db_out.find(' ') != docstring::npos) {
|
2005-07-14 12:53:12 +00:00
|
|
|
warned_about_spaces = true;
|
|
|
|
|
2006-09-11 08:54:10 +00:00
|
|
|
Alert::warning(_("Export Warning!"),
|
|
|
|
_("There are spaces in the paths to your BibTeX databases.\n"
|
|
|
|
"BibTeX will be unable to find them."));
|
2005-07-14 12:53:12 +00:00
|
|
|
|
2004-03-29 13:17:25 +00:00
|
|
|
}
|
2003-09-03 17:40:58 +00:00
|
|
|
|
|
|
|
// Style-Options
|
2006-10-21 00:16:43 +00:00
|
|
|
string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
|
2003-09-03 17:40:58 +00:00
|
|
|
string bibtotoc;
|
|
|
|
if (prefixIs(style, "bibtotoc")) {
|
|
|
|
bibtotoc = "bibtotoc";
|
|
|
|
if (contains(style, ',')) {
|
|
|
|
style = split(style, bibtotoc, ',');
|
|
|
|
}
|
|
|
|
}
|
2004-04-03 08:37:12 +00:00
|
|
|
|
2004-03-29 13:17:25 +00:00
|
|
|
// line count
|
2005-07-14 12:53:12 +00:00
|
|
|
int nlines = 0;
|
2001-08-20 13:42:29 +00:00
|
|
|
|
2004-03-29 13:17:25 +00:00
|
|
|
if (!style.empty()) {
|
2006-04-01 10:49:58 +00:00
|
|
|
string base =
|
|
|
|
normalize_name(buffer, runparams, style, ".bst");
|
2006-12-27 10:56:11 +00:00
|
|
|
FileName const try_in_file(makeAbsPath(base + ".bst", buffer.filePath()));
|
|
|
|
bool const not_from_texmf = isFileReadable(try_in_file);
|
2006-04-01 10:49:58 +00:00
|
|
|
// 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.
|
2006-04-10 16:27:59 +00:00
|
|
|
if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
|
2006-11-26 21:30:39 +00:00
|
|
|
not_from_texmf) {
|
2006-04-01 10:49:58 +00:00
|
|
|
// use new style name
|
2006-11-26 21:30:39 +00:00
|
|
|
DocFileName const in_file = DocFileName(try_in_file);
|
|
|
|
base = removeExtension(in_file.mangledFilename());
|
2006-12-27 10:56:11 +00:00
|
|
|
FileName const out_file(makeAbsPath(base + ".bst",
|
2006-11-26 21:30:39 +00:00
|
|
|
buffer.getMasterBuffer()->temppath()));
|
2006-04-01 10:49:58 +00:00
|
|
|
bool const success = copy(in_file, out_file);
|
|
|
|
if (!success) {
|
|
|
|
lyxerr << "Failed to copy '" << in_file
|
|
|
|
<< "' to '" << out_file << "'"
|
|
|
|
<< endl;
|
|
|
|
}
|
|
|
|
}
|
2006-10-19 16:51:30 +00:00
|
|
|
// FIXME UNICODE
|
2004-04-20 12:46:15 +00:00
|
|
|
os << "\\bibliographystyle{"
|
2006-10-21 00:16:43 +00:00
|
|
|
<< from_utf8(latex_path(normalize_name(buffer, runparams, base, ".bst")))
|
2004-04-20 12:46:15 +00:00
|
|
|
<< "}\n";
|
2005-07-14 12:53:12 +00:00
|
|
|
nlines += 1;
|
2004-03-29 13:17:25 +00:00
|
|
|
}
|
2004-04-03 08:37:12 +00:00
|
|
|
|
2006-04-01 10:49:58 +00:00
|
|
|
// 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;
|
2006-09-11 08:54:10 +00:00
|
|
|
Alert::warning(_("Export Warning!"),
|
|
|
|
_("There are spaces in the path to your BibTeX style file.\n"
|
|
|
|
"BibTeX will be unable to find it."));
|
2006-04-01 10:49:58 +00:00
|
|
|
}
|
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
if (!db_out.empty() && buffer.params().use_bibtopic){
|
2006-10-20 16:12:49 +00:00
|
|
|
os << "\\begin{btSect}{" << db_out << "}\n";
|
2006-10-19 16:51:30 +00:00
|
|
|
docstring btprint = getParam("btprint");
|
2004-03-29 13:17:25 +00:00
|
|
|
if (btprint.empty())
|
|
|
|
// default
|
2006-10-21 00:16:43 +00:00
|
|
|
btprint = from_ascii("btPrintCited");
|
2004-03-29 13:17:25 +00:00
|
|
|
os << "\\" << btprint << "\n"
|
|
|
|
<< "\\end{btSect}\n";
|
2005-07-14 12:53:12 +00:00
|
|
|
nlines += 3;
|
2001-08-20 13:42:29 +00:00
|
|
|
}
|
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
// bibtotoc-Option
|
2004-03-29 13:17:25 +00:00
|
|
|
if (!bibtotoc.empty() && !buffer.params().use_bibtopic) {
|
2003-09-03 17:40:58 +00:00
|
|
|
// maybe a problem when a textclass has no "art" as
|
|
|
|
// part of its name, because it's than book.
|
|
|
|
// For the "official" lyx-layouts it's no problem to support
|
|
|
|
// all well
|
2003-09-09 09:47:59 +00:00
|
|
|
if (!contains(buffer.params().getLyXTextClass().name(),
|
2003-09-03 17:40:58 +00:00
|
|
|
"art")) {
|
2003-09-09 09:47:59 +00:00
|
|
|
if (buffer.params().sides == LyXTextClass::OneSide) {
|
2003-09-03 17:40:58 +00:00
|
|
|
// oneside
|
|
|
|
os << "\\clearpage";
|
2001-08-20 13:42:29 +00:00
|
|
|
} else {
|
2003-09-03 17:40:58 +00:00
|
|
|
// twoside
|
|
|
|
os << "\\cleardoublepage";
|
2001-08-20 13:42:29 +00:00
|
|
|
}
|
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
// bookclass
|
|
|
|
os << "\\addcontentsline{toc}{chapter}{\\bibname}";
|
|
|
|
|
2001-08-20 13:42:29 +00:00
|
|
|
} else {
|
|
|
|
// article class
|
2003-09-03 17:40:58 +00:00
|
|
|
os << "\\addcontentsline{toc}{section}{\\refname}";
|
2001-08-20 13:42:29 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
if (!db_out.empty() && !buffer.params().use_bibtopic){
|
2006-10-20 16:12:49 +00:00
|
|
|
os << "\\bibliography{" << db_out << "}\n";
|
2005-07-14 12:53:12 +00:00
|
|
|
nlines += 1;
|
2000-03-02 02:19:43 +00:00
|
|
|
}
|
2004-04-03 08:37:12 +00:00
|
|
|
|
2005-07-14 12:53:12 +00:00
|
|
|
return nlines;
|
2003-09-03 17:28:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2006-12-01 20:09:08 +00:00
|
|
|
vector<FileName> const InsetBibtex::getFiles(Buffer const & buffer) const
|
1999-09-27 18:44:28 +00:00
|
|
|
{
|
2007-04-06 18:03:29 +00:00
|
|
|
FileName path(buffer.filePath());
|
|
|
|
support::Path p(path);
|
2001-08-20 13:42:29 +00:00
|
|
|
|
2006-12-01 20:09:08 +00:00
|
|
|
vector<FileName> vec;
|
2000-05-17 13:40:40 +00:00
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
string tmp;
|
2006-10-20 16:12:49 +00:00
|
|
|
// FIXME UNICODE
|
2006-10-21 00:16:43 +00:00
|
|
|
string bibfiles = to_utf8(getParam("bibfiles"));
|
2003-09-03 17:40:58 +00:00
|
|
|
bibfiles = split(bibfiles, tmp, ',');
|
|
|
|
while (!tmp.empty()) {
|
2006-12-01 20:09:08 +00:00
|
|
|
FileName const file = findtexfile(changeExtension(tmp, "bib"), "bib");
|
2007-04-01 10:09:49 +00:00
|
|
|
LYXERR(Debug::LATEX) << "Bibfile: " << file << endl;
|
2001-08-20 13:42:29 +00:00
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
// If we didn't find a matching file name just fail silently
|
|
|
|
if (!file.empty())
|
|
|
|
vec.push_back(file);
|
2002-03-21 17:09:55 +00:00
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
// Get next file name
|
|
|
|
bibfiles = split(bibfiles, tmp, ',');
|
2001-08-20 13:42:29 +00:00
|
|
|
}
|
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
return vec;
|
2001-08-20 13:42:29 +00:00
|
|
|
}
|
|
|
|
|
2007-04-04 20:06:34 +00:00
|
|
|
namespace {
|
|
|
|
|
|
|
|
// methods for parsing bibtex files
|
|
|
|
|
|
|
|
typedef map<docstring, docstring> VarMap;
|
|
|
|
|
|
|
|
/// remove whitespace characters, optionally a single comma,
|
|
|
|
/// and further whitespace characters from the stream.
|
|
|
|
/// @return true if a comma was found, false otherwise
|
|
|
|
///
|
|
|
|
bool removeWSAndComma(idocfstream & ifs) {
|
|
|
|
char_type ch;
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// skip whitespace
|
|
|
|
do {
|
|
|
|
ifs.get(ch);
|
|
|
|
} while (ifs && isSpace(ch));
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
if (ch != ',') {
|
|
|
|
ifs.putback(ch);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// skip whitespace
|
|
|
|
do {
|
|
|
|
ifs.get(ch);
|
|
|
|
} while (ifs && isSpace(ch));
|
|
|
|
|
|
|
|
if (ifs) {
|
|
|
|
ifs.putback(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2007-04-23 15:18:01 +00:00
|
|
|
|
|
|
|
enum charCase {
|
|
|
|
makeLowerCase,
|
|
|
|
keepCase
|
|
|
|
};
|
|
|
|
|
2007-04-04 20:06:34 +00:00
|
|
|
/// remove whitespace characters, read characer sequence
|
|
|
|
/// not containing whitespace characters or characters in
|
|
|
|
/// delimChars, and remove further whitespace characters.
|
|
|
|
///
|
|
|
|
/// @return true if a string of length > 0 could be read.
|
|
|
|
///
|
2007-04-23 15:18:01 +00:00
|
|
|
bool readTypeOrKey(docstring & val, idocfstream & ifs,
|
|
|
|
docstring const & delimChars, charCase chCase) {
|
2007-04-04 20:06:34 +00:00
|
|
|
|
|
|
|
char_type ch;
|
|
|
|
|
|
|
|
val.clear();
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// skip whitespace
|
|
|
|
do {
|
|
|
|
ifs.get(ch);
|
|
|
|
} while (ifs && isSpace(ch));
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// read value
|
|
|
|
while (ifs && !isSpace(ch) && delimChars.find(ch) == docstring::npos) {
|
2007-04-23 15:18:01 +00:00
|
|
|
if (chCase == makeLowerCase) {
|
|
|
|
val += lowercase(ch);
|
|
|
|
} else {
|
|
|
|
val += ch;
|
|
|
|
}
|
2007-04-04 20:06:34 +00:00
|
|
|
ifs.get(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
// skip whitespace
|
|
|
|
while (ifs && isSpace(ch)) {
|
|
|
|
ifs.get(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (ifs) {
|
|
|
|
ifs.putback(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
return val.length() > 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// read subsequent bibtex values that are delimited with a #-character.
|
|
|
|
/// Concatenate all parts and replace names with the associated string in
|
|
|
|
/// the variable strings.
|
|
|
|
/// @return true if reading was successfull (all single parts were delimited
|
|
|
|
/// correctly)
|
|
|
|
bool readValue(docstring & val, idocfstream & ifs, const VarMap & strings) {
|
|
|
|
|
|
|
|
char_type ch;
|
|
|
|
|
|
|
|
val.clear();
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
do {
|
|
|
|
// skip whitespace
|
|
|
|
do {
|
|
|
|
ifs.get(ch);
|
|
|
|
} while (ifs && isSpace(ch));
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// check for field type
|
|
|
|
if (isDigit(ch)) {
|
|
|
|
|
|
|
|
// read integer value
|
|
|
|
do {
|
|
|
|
val += ch;
|
|
|
|
ifs.get(ch);
|
|
|
|
} while (ifs && isDigit(ch));
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
} else if (ch == '"' || 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
|
|
|
|
int nestLevel = 0;
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
while (ifs && (nestLevel > 0 || ch != delim)) {
|
|
|
|
val += ch;
|
|
|
|
|
|
|
|
// update nesting level
|
|
|
|
switch (ch) {
|
|
|
|
case '{':
|
|
|
|
++nestLevel;
|
|
|
|
break;
|
|
|
|
case '}':
|
|
|
|
--nestLevel;
|
|
|
|
if (nestLevel < 0) return false;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
// reading a string name
|
|
|
|
docstring strName;
|
|
|
|
|
|
|
|
while (ifs && !isSpace(ch) && ch != '#' && ch != ',' && ch != '}' && ch != ')') {
|
|
|
|
strName += lowercase(ch);
|
|
|
|
ifs.get(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// replace the string with its assigned value or
|
|
|
|
// discard it if it's not assigned
|
|
|
|
if (strName.length()) {
|
|
|
|
VarMap::const_iterator pos = strings.find(strName);
|
|
|
|
if (pos != strings.end()) {
|
|
|
|
val += pos->second;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// skip WS
|
|
|
|
while (ifs && isSpace(ch)) {
|
|
|
|
ifs.get(ch);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!ifs)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// continue reading next value on concatenate with '#'
|
|
|
|
} while (ch == '#');
|
|
|
|
|
|
|
|
ifs.putback(ch);
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2003-02-18 12:36:02 +00:00
|
|
|
|
2001-08-20 13:42:29 +00:00
|
|
|
// This method returns a comma separated list of Bibtex entries
|
2003-08-28 07:41:31 +00:00
|
|
|
void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
|
2006-12-17 10:52:04 +00:00
|
|
|
std::vector<std::pair<string, docstring> > & keys) const
|
2001-08-20 13:42:29 +00:00
|
|
|
{
|
2006-12-01 20:09:08 +00:00
|
|
|
vector<FileName> const files = getFiles(buffer);
|
|
|
|
for (vector<FileName>::const_iterator it = files.begin();
|
2001-08-20 13:42:29 +00:00
|
|
|
it != files.end(); ++ it) {
|
2007-04-23 15:18:01 +00:00
|
|
|
// This bibtex parser is a first step to parse bibtex files
|
2007-04-04 20:06:34 +00:00
|
|
|
// more precisely.
|
|
|
|
//
|
|
|
|
// - it reads the whole bibtex entry and does a syntax check
|
|
|
|
// (matching delimiters, missing commas,...
|
|
|
|
// - it recovers from errors starting with the next @-character
|
|
|
|
// - it reads @string definitions and replaces them in the
|
|
|
|
// field values.
|
|
|
|
// - 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.
|
|
|
|
//
|
2006-12-15 16:09:05 +00:00
|
|
|
|
|
|
|
// 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.
|
2006-12-17 10:52:04 +00:00
|
|
|
// 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.
|
2006-12-15 16:09:05 +00:00
|
|
|
idocfstream ifs(it->toFilesystemEncoding().c_str(),
|
|
|
|
std::ios_base::in,
|
|
|
|
buffer.params().encoding().iconvName());
|
2007-04-04 20:06:34 +00:00
|
|
|
|
|
|
|
char_type ch;
|
|
|
|
VarMap strings;
|
|
|
|
|
|
|
|
while (ifs) {
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
if (!ifs)
|
|
|
|
break;
|
|
|
|
|
|
|
|
if (ch != '@')
|
|
|
|
continue;
|
|
|
|
|
|
|
|
docstring entryType;
|
|
|
|
|
2007-04-23 15:18:01 +00:00
|
|
|
if (!readTypeOrKey(entryType, ifs, from_ascii("{("), makeLowerCase) || !ifs)
|
2006-12-17 10:52:04 +00:00
|
|
|
continue;
|
2007-04-04 20:06:34 +00:00
|
|
|
|
|
|
|
if (entryType == from_ascii("comment")) {
|
|
|
|
|
|
|
|
ifs.ignore(std::numeric_limits<int>::max(), '\n');
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
if (!ifs)
|
|
|
|
break;
|
|
|
|
|
2007-04-23 15:18:01 +00:00
|
|
|
if ((ch != '(') && (ch != '{')) {
|
2007-04-04 20:06:34 +00:00
|
|
|
// invalid entry delimiter
|
|
|
|
ifs.putback(ch);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
// process the entry
|
|
|
|
if (entryType == from_ascii("string")) {
|
|
|
|
|
|
|
|
// read string and add it to the strings map
|
|
|
|
// (or replace it's old value)
|
|
|
|
docstring name;
|
|
|
|
docstring value;
|
|
|
|
|
2007-04-23 15:18:01 +00:00
|
|
|
if (!readTypeOrKey(name, ifs, from_ascii("#=}),"), makeLowerCase) || !ifs)
|
2007-04-04 20:06:34 +00:00
|
|
|
continue;
|
|
|
|
|
|
|
|
ifs.get(ch);
|
|
|
|
if (!ifs || ch != '=')
|
|
|
|
continue;
|
|
|
|
|
|
|
|
if (!readValue(value, ifs, strings))
|
|
|
|
continue;
|
|
|
|
|
|
|
|
strings[name] = value;
|
|
|
|
|
|
|
|
} else if (entryType == from_ascii("preamble")) {
|
|
|
|
|
|
|
|
// preamble definitions are discarded.
|
|
|
|
// can they be of any use in lyx?
|
|
|
|
docstring value;
|
|
|
|
|
|
|
|
if (!readValue(value, ifs, strings))
|
|
|
|
continue;
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
// Citation entry. Read the key and all name = value pairs
|
|
|
|
docstring key;
|
|
|
|
docstring fields;
|
|
|
|
docstring name;
|
|
|
|
docstring value;
|
|
|
|
docstring commaNewline;
|
|
|
|
|
2007-04-23 15:18:01 +00:00
|
|
|
if (!readTypeOrKey(key, ifs, from_ascii(",})"), keepCase) || !ifs)
|
2007-04-04 20:06:34 +00:00
|
|
|
continue;
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
bool readNext = removeWSAndComma(ifs);
|
|
|
|
|
|
|
|
while (ifs && readNext) {
|
|
|
|
|
|
|
|
// read field name
|
2007-04-23 15:18:01 +00:00
|
|
|
if (!readTypeOrKey(name, ifs, from_ascii("=}),"), makeLowerCase) || !ifs)
|
2007-04-04 20:06:34 +00:00
|
|
|
break;
|
|
|
|
|
|
|
|
// next char must be an equal sign
|
|
|
|
ifs.get(ch);
|
|
|
|
if (!ifs)
|
|
|
|
break;
|
|
|
|
if (ch != '=') {
|
|
|
|
ifs.putback(ch);
|
|
|
|
break;
|
1999-09-27 18:44:28 +00:00
|
|
|
}
|
2007-04-04 20:06:34 +00:00
|
|
|
|
|
|
|
// read field value
|
|
|
|
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");
|
|
|
|
|
|
|
|
readNext = removeWSAndComma(ifs);
|
1999-09-27 18:44:28 +00:00
|
|
|
}
|
2007-04-04 20:06:34 +00:00
|
|
|
|
|
|
|
// add the new entry
|
|
|
|
keys.push_back(pair<string, docstring>(
|
|
|
|
to_utf8(key), fields));
|
|
|
|
}
|
|
|
|
|
|
|
|
} //< searching '@'
|
|
|
|
|
|
|
|
} //< for loop over files
|
1999-09-27 18:44:28 +00:00
|
|
|
}
|
|
|
|
|
1999-11-24 22:14:46 +00:00
|
|
|
|
2007-04-04 20:06:34 +00:00
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
bool InsetBibtex::addDatabase(string const & db)
|
1999-09-27 18:44:28 +00:00
|
|
|
{
|
2006-10-20 16:12:49 +00:00
|
|
|
// FIXME UNICODE
|
2006-10-21 00:16:43 +00:00
|
|
|
string bibfiles(to_utf8(getParam("bibfiles")));
|
2006-10-20 16:12:49 +00:00
|
|
|
if (tokenPos(bibfiles, ',', db) == -1) {
|
|
|
|
if (!bibfiles.empty())
|
|
|
|
bibfiles += ',';
|
2006-10-21 00:16:43 +00:00
|
|
|
setParam("bibfiles", from_utf8(bibfiles + db));
|
1999-09-27 18:44:28 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2003-09-03 17:40:58 +00:00
|
|
|
bool InsetBibtex::delDatabase(string const & db)
|
1999-09-27 18:44:28 +00:00
|
|
|
{
|
2006-10-20 16:12:49 +00:00
|
|
|
// FIXME UNICODE
|
2006-10-21 00:16:43 +00:00
|
|
|
string bibfiles(to_utf8(getParam("bibfiles")));
|
2006-10-20 16:12:49 +00:00
|
|
|
if (contains(bibfiles, db)) {
|
|
|
|
int const n = tokenPos(bibfiles, ',', db);
|
1999-10-02 16:21:10 +00:00
|
|
|
string bd = db;
|
1999-09-27 18:44:28 +00:00
|
|
|
if (n > 0) {
|
2005-06-25 15:57:15 +00:00
|
|
|
// this is not the first database
|
|
|
|
string tmp = ',' + bd;
|
2006-10-21 00:16:43 +00:00
|
|
|
setParam("bibfiles", from_utf8(subst(bibfiles, tmp, string())));
|
1999-11-15 10:58:38 +00:00
|
|
|
} else if (n == 0)
|
2005-06-25 15:57:15 +00:00
|
|
|
// this is the first (or only) database
|
2006-10-21 00:16:43 +00:00
|
|
|
setParam("bibfiles", from_utf8(split(bibfiles, bd, ',')));
|
2002-03-21 17:09:55 +00:00
|
|
|
else
|
1999-09-27 18:44:28 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
2004-03-29 13:17:25 +00:00
|
|
|
|
|
|
|
|
|
|
|
void InsetBibtex::validate(LaTeXFeatures & features) const
|
|
|
|
{
|
|
|
|
if (features.bufferParams().use_bibtopic)
|
|
|
|
features.require("bibtopic");
|
|
|
|
}
|
2006-10-21 00:16:43 +00:00
|
|
|
|
|
|
|
|
|
|
|
} // namespace lyx
|