* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author Angus Leeming
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include "TextClass.h"
#include "LayoutFile.h"
+#include "CiteEnginesList.h"
#include "Color.h"
#include "Counters.h"
#include "Floating.h"
#include "Layout.h"
#include "Lexer.h"
#include "Font.h"
+#include "ModuleList.h"
#include "frontends/alert.h"
+#include "support/lassert.h"
#include "support/debug.h"
#include "support/ExceptionMessage.h"
#include "support/FileName.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/os.h"
+#include "support/TempFile.h"
#include <algorithm>
#include <fstream>
#include <sstream>
-#include "boost/assert.hpp"
+#ifdef ERROR
+#undef ERROR
+#endif
using namespace std;
using namespace lyx::support;
namespace lyx {
+// Keep the changes documented in the Customization manual.
+//
+// If you change this format, then you MUST also make sure that
+// your changes do not invalidate the hardcoded layout file in
+// LayoutFile.cpp. Additions will never do so, but syntax changes
+// could. See LayoutFileList::addEmptyClass() and, especially, the
+// definition of the layoutpost string.
+// You should also run the development/tools/updatelayouts.py script,
+// to update the format of all of our layout files.
+//
+int const LAYOUT_FORMAT = 63; //spitz: new tags CiteFramework, MaxCiteNames, extended InsetCite syntax.
+
+
+// Layout format for the current lyx file format. Controls which format is
+// targeted by Local Layout > Convert. In master, equal to LAYOUT_FORMAT.
+int const LYXFILE_LAYOUT_FORMAT = LAYOUT_FORMAT;
+
+
namespace {
class LayoutNamesEqual : public unary_function<Layout, bool> {
};
-int const FORMAT = 7;
-
-
-bool layout2layout(FileName const & filename, FileName const & tempfile)
+bool layout2layout(FileName const & filename, FileName const & tempfile,
+ int const format = LAYOUT_FORMAT)
{
FileName const script = libFileSearch("scripts", "layout2layout.py");
if (script.empty()) {
- lyxerr << "Could not find layout conversion "
- "script layout2layout.py." << endl;
+ LYXERR0("Could not find layout conversion "
+ "script layout2layout.py.");
return false;
}
ostringstream command;
command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
- << ' ' << quoteName(filename.toFilesystemEncoding())
- << ' ' << quoteName(tempfile.toFilesystemEncoding());
+ << " -t " << format
+ << ' ' << quoteName(filename.toFilesystemEncoding())
+ << ' ' << quoteName(tempfile.toFilesystemEncoding());
string const command_str = command.str();
LYXERR(Debug::TCLASS, "Running `" << command_str << '\'');
- cmd_ret const ret =
- runCommand(command_str);
+ cmd_ret const ret = runCommand(command_str);
if (ret.first != 0) {
- lyxerr << "Could not run layout conversion "
- "script layout2layout.py." << endl;
+ if (format == LAYOUT_FORMAT)
+ LYXERR0("Conversion of layout with layout2layout.py has failed.");
return false;
}
return true;
}
-std::string translateRT(TextClass::ReadType rt)
+string translateReadType(TextClass::ReadType rt)
{
switch (rt) {
case TextClass::BASECLASS:
return "input file";
case TextClass::MODULE:
return "module file";
+ case TextClass::CITE_ENGINE:
+ return "cite engine";
case TextClass::VALIDATION:
return "validation";
}
} // namespace anon
-docstring const TextClass::emptylayout_ = from_ascii(N_("Plain Layout"));
+// This string should not be translated here,
+// because it is a layout identifier.
+docstring const TextClass::plain_layout_ = from_ascii(N_("Plain Layout"));
-InsetLayout DocumentClass::empty_insetlayout_;
-
+/////////////////////////////////////////////////////////////////////////
+//
+// TextClass
+//
+/////////////////////////////////////////////////////////////////////////
TextClass::TextClass()
+ : loaded_(false), tex_class_avail_(false),
+ opt_enginetype_("authoryear|numerical"), opt_fontsize_("10|11|12"),
+ opt_pagestyle_("empty|plain|headings|fancy"), pagestyle_("default"),
+ columns_(1), sides_(OneSide), secnumdepth_(3), tocdepth_(3),
+ outputType_(LATEX), outputFormat_("latex"),
+ defaultfont_(sane_font),
+ titletype_(TITLE_COMMAND_AFTER), titlename_("maketitle"),
+ min_toclevel_(0), max_toclevel_(0), maxcitenames_(2),
+ cite_full_author_list_(true)
{
- outputType_ = LATEX;
- columns_ = 1;
- sides_ = OneSide;
- secnumdepth_ = 3;
- tocdepth_ = 3;
- pagestyle_ = "default";
- defaultfont_ = sane_font;
- opt_fontsize_ = "10|11|12";
- opt_pagestyle_ = "empty|plain|headings|fancy";
- titletype_ = TITLE_COMMAND_AFTER;
- titlename_ = "maketitle";
- loaded_ = false;
}
-bool TextClass::readStyle(Lexer & lexrc, Layout & lay)
+bool TextClass::readStyle(Lexer & lexrc, Layout & lay) const
{
LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name()));
if (!lay.read(lexrc, *this)) {
- lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
+ LYXERR0("Error parsing style `" << to_utf8(lay.name()) << '\'');
return false;
}
// Resolve fonts
enum TextClassTags {
TC_OUTPUTTYPE = 1,
+ TC_OUTPUTFORMAT,
TC_INPUT,
TC_STYLE,
+ TC_MODIFYSTYLE,
+ TC_PROVIDESTYLE,
TC_DEFAULTSTYLE,
TC_INSETLAYOUT,
- TC_ENVIRONMENT,
+ TC_NOINSETLAYOUT,
TC_NOSTYLE,
TC_COLUMNS,
TC_SIDES,
TC_TOCDEPTH,
TC_CLASSOPTIONS,
TC_PREAMBLE,
+ TC_HTMLPREAMBLE,
+ TC_HTMLSTYLES,
TC_PROVIDES,
TC_REQUIRES,
+ TC_PKGOPTS,
TC_LEFTMARGIN,
TC_RIGHTMARGIN,
TC_FLOAT,
TC_COUNTER,
+ TC_NOCOUNTER,
+ TC_IFCOUNTER,
TC_NOFLOAT,
TC_TITLELATEXNAME,
TC_TITLELATEXTYPE,
TC_FORMAT,
- TC_ADDTOPREAMBLE
+ TC_ADDTOPREAMBLE,
+ TC_ADDTOHTMLPREAMBLE,
+ TC_ADDTOHTMLSTYLES,
+ TC_DEFAULTMODULE,
+ TC_PROVIDESMODULE,
+ TC_EXCLUDESMODULE,
+ TC_HTMLTOCSECTION,
+ TC_CITEENGINE,
+ TC_CITEENGINETYPE,
+ TC_CITEFORMAT,
+ TC_CITEFRAMEWORK,
+ TC_MAXCITENAMES,
+ TC_DEFAULTBIBLIO,
+ TC_FULLAUTHORLIST,
+ TC_OUTLINERNAME
};
namespace {
- keyword_item textClassTags[] = {
- { "addtopreamble", TC_ADDTOPREAMBLE },
- { "classoptions", TC_CLASSOPTIONS },
- { "columns", TC_COLUMNS },
- { "counter", TC_COUNTER },
- { "defaultfont", TC_DEFAULTFONT },
- { "defaultstyle", TC_DEFAULTSTYLE },
- { "environment", TC_ENVIRONMENT },
- { "float", TC_FLOAT },
- { "format", TC_FORMAT },
- { "input", TC_INPUT },
- { "insetlayout", TC_INSETLAYOUT },
- { "leftmargin", TC_LEFTMARGIN },
- { "nofloat", TC_NOFLOAT },
- { "nostyle", TC_NOSTYLE },
- { "outputtype", TC_OUTPUTTYPE },
- { "pagestyle", TC_PAGESTYLE },
- { "preamble", TC_PREAMBLE },
- { "provides", TC_PROVIDES },
- { "requires", TC_REQUIRES },
- { "rightmargin", TC_RIGHTMARGIN },
- { "secnumdepth", TC_SECNUMDEPTH },
- { "sides", TC_SIDES },
- { "style", TC_STYLE },
- { "titlelatexname", TC_TITLELATEXNAME },
- { "titlelatextype", TC_TITLELATEXTYPE },
- { "tocdepth", TC_TOCDEPTH }
- };
-
+LexerKeyword textClassTags[] = {
+ { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE },
+ { "addtohtmlstyles", TC_ADDTOHTMLSTYLES },
+ { "addtopreamble", TC_ADDTOPREAMBLE },
+ { "citeengine", TC_CITEENGINE },
+ { "citeenginetype", TC_CITEENGINETYPE },
+ { "citeformat", TC_CITEFORMAT },
+ { "citeframework", TC_CITEFRAMEWORK },
+ { "classoptions", TC_CLASSOPTIONS },
+ { "columns", TC_COLUMNS },
+ { "counter", TC_COUNTER },
+ { "defaultbiblio", TC_DEFAULTBIBLIO },
+ { "defaultfont", TC_DEFAULTFONT },
+ { "defaultmodule", TC_DEFAULTMODULE },
+ { "defaultstyle", TC_DEFAULTSTYLE },
+ { "excludesmodule", TC_EXCLUDESMODULE },
+ { "float", TC_FLOAT },
+ { "format", TC_FORMAT },
+ { "fullauthorlist", TC_FULLAUTHORLIST },
+ { "htmlpreamble", TC_HTMLPREAMBLE },
+ { "htmlstyles", TC_HTMLSTYLES },
+ { "htmltocsection", TC_HTMLTOCSECTION },
+ { "ifcounter", TC_IFCOUNTER },
+ { "input", TC_INPUT },
+ { "insetlayout", TC_INSETLAYOUT },
+ { "leftmargin", TC_LEFTMARGIN },
+ { "maxcitenames", TC_MAXCITENAMES },
+ { "modifystyle", TC_MODIFYSTYLE },
+ { "nocounter", TC_NOCOUNTER },
+ { "nofloat", TC_NOFLOAT },
+ { "noinsetlayout", TC_NOINSETLAYOUT },
+ { "nostyle", TC_NOSTYLE },
+ { "outlinername", TC_OUTLINERNAME },
+ { "outputformat", TC_OUTPUTFORMAT },
+ { "outputtype", TC_OUTPUTTYPE },
+ { "packageoptions", TC_PKGOPTS },
+ { "pagestyle", TC_PAGESTYLE },
+ { "preamble", TC_PREAMBLE },
+ { "provides", TC_PROVIDES },
+ { "providesmodule", TC_PROVIDESMODULE },
+ { "providestyle", TC_PROVIDESTYLE },
+ { "requires", TC_REQUIRES },
+ { "rightmargin", TC_RIGHTMARGIN },
+ { "secnumdepth", TC_SECNUMDEPTH },
+ { "sides", TC_SIDES },
+ { "style", TC_STYLE },
+ { "titlelatexname", TC_TITLELATEXNAME },
+ { "titlelatextype", TC_TITLELATEXTYPE },
+ { "tocdepth", TC_TOCDEPTH }
+};
+
} //namespace anon
bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
{
- LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT);
- FileName const tempfile = FileName::tempName();
- bool success = layout2layout(filename, tempfile);
- if (success)
- success = read(tempfile, rt);
- tempfile.removeFile();
- return success;
+ LYXERR(Debug::TCLASS, "Converting layout file to " << LAYOUT_FORMAT);
+ TempFile tmp("convertXXXXXX.layout");
+ FileName const tempfile = tmp.name();
+ bool success = layout2layout(filename, tempfile);
+ if (success)
+ success = readWithoutConv(tempfile, rt) == OK;
+ return success;
}
-bool TextClass::read(FileName const & filename, ReadType rt)
+
+std::string TextClass::convert(std::string const & str)
+{
+ TempFile tmp1("localXXXXXX.layout");
+ FileName const fn = tmp1.name();
+ ofstream os(fn.toFilesystemEncoding().c_str());
+ os << str;
+ os.close();
+ TempFile tmp2("convert_localXXXXXX.layout");
+ FileName const tempfile = tmp2.name();
+ bool success = layout2layout(fn, tempfile, LYXFILE_LAYOUT_FORMAT);
+ if (!success)
+ return "";
+ ifstream is(tempfile.toFilesystemEncoding().c_str());
+ string ret;
+ string tmp;
+ while (!is.eof()) {
+ getline(is, tmp);
+ ret += tmp + '\n';
+ }
+ is.close();
+ return ret;
+}
+
+
+TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, ReadType rt)
{
if (!filename.isReadableFile()) {
lyxerr << "Cannot read layout file `" << filename << "'."
<< endl;
- return false;
+ return ERROR;
}
- LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " +
- to_utf8(makeDisplayPath(filename.absFilename())));
+ LYXERR(Debug::TCLASS, "Reading " + translateReadType(rt) + ": " +
+ to_utf8(makeDisplayPath(filename.absFileName())));
- // Define the `empty' layout used in table cells, ert, etc. Note that
- // we do this before loading any layout file, so that classes can
+ // Define the plain layout used in table cells, ert, etc. Note that
+ // we do this before loading any layout file, so that classes can
// override features of this layout if they should choose to do so.
- if (rt == BASECLASS && !hasLayout(emptylayout_)) {
- static char const * s = "Margin Static\n"
- "LatexType Paragraph\n"
- "LatexName dummy\n"
- "Align Block\n"
- "AlignPossible Left, Right, Center\n"
- "LabelType No_Label\n"
- "End";
- istringstream ss(s);
- Lexer lex(textClassTags, sizeof(textClassTags) / sizeof(textClassTags[0]));
- lex.setStream(ss);
- Layout lay;
- lay.setName(emptylayout_);
- if (!readStyle(lex, lay)) {
- // The only way this happens is because the hardcoded layout above
- // is wrong.
- BOOST_ASSERT(false);
- };
- layoutlist_.push_back(lay);
- }
- Lexer lexrc(textClassTags,
- sizeof(textClassTags) / sizeof(textClassTags[0]));
+ if (rt == BASECLASS && !hasLayout(plain_layout_))
+ layoutlist_.push_back(createBasicLayout(plain_layout_));
+ Lexer lexrc(textClassTags);
lexrc.setFile(filename);
ReturnValues retval = read(lexrc, rt);
-
- LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
- to_utf8(makeDisplayPath(filename.absFilename())));
-
- if (retval != FORMAT_MISMATCH)
+
+ LYXERR(Debug::TCLASS, "Finished reading " + translateReadType(rt) + ": " +
+ to_utf8(makeDisplayPath(filename.absFileName())));
+
+ return retval;
+}
+
+
+bool TextClass::read(FileName const & filename, ReadType rt)
+{
+ ReturnValues const retval = readWithoutConv(filename, rt);
+ if (retval != FORMAT_MISMATCH)
return retval == OK;
-
+
bool const worx = convertLayoutFormat(filename, rt);
- if (!worx) {
- lyxerr << "Unable to convert " << filename <<
- " to format " << FORMAT << std::endl;
- return false;
- }
- return true;
+ if (!worx)
+ LYXERR0 ("Unable to convert " << filename <<
+ " to format " << LAYOUT_FORMAT);
+ return worx;
}
-bool TextClass::validate(std::string const & str)
+TextClass::ReturnValues TextClass::validate(std::string const & str)
{
TextClass tc;
return tc.read(str, VALIDATION);
}
-bool TextClass::read(std::string const & str, ReadType rt)
+TextClass::ReturnValues TextClass::read(std::string const & str, ReadType rt)
{
- Lexer lexrc(textClassTags,
- sizeof(textClassTags) / sizeof(textClassTags[0]));
+ Lexer lexrc(textClassTags);
istringstream is(str);
lexrc.setStream(is);
ReturnValues retval = read(lexrc, rt);
- if (retval != FORMAT_MISMATCH)
- return retval == OK;
+ if (retval != FORMAT_MISMATCH)
+ return retval;
// write the layout string to a temporary file
- FileName const tempfile = FileName::tempName();
+ TempFile tmp("TextClass_read");
+ FileName const tempfile = tmp.name();
ofstream os(tempfile.toFilesystemEncoding().c_str());
if (!os) {
- lyxerr << "Unable to create tempoary file in TextClass::read!!"
- << std::endl;
- return false;
+ LYXERR0("Unable to create temporary file");
+ return ERROR;
}
os << str;
os.close();
- // now try to convert it
- bool const worx = convertLayoutFormat(tempfile, rt);
- if (!worx) {
- lyxerr << "Unable to convert internal layout information to format "
- << FORMAT << std::endl;
+ // now try to convert it to LAYOUT_FORMAT
+ if (!convertLayoutFormat(tempfile, rt)) {
+ LYXERR0("Unable to convert internal layout information to format "
+ << LAYOUT_FORMAT);
+ return ERROR;
}
- tempfile.removeFile();
- return worx;
+
+ return OK_OLDFORMAT;
}
// Reads a textclass structure from file.
-TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
+TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
{
- bool error = !lexrc.isOK();
+ if (!lexrc.isOK())
+ return ERROR;
// Format of files before the 'Format' tag was introduced
int format = 1;
+ bool error = false;
// parsing
while (lexrc.isOK() && !error) {
break;
}
+ // used below to track whether we are in an IfStyle or IfCounter tag.
+ bool modifystyle = false;
+ bool providestyle = false;
+ bool ifcounter = false;
+
switch (static_cast<TextClassTags>(le)) {
case TC_FORMAT:
format = lexrc.getInteger();
break;
- case TC_OUTPUTTYPE: // output type definition
+ case TC_OUTPUTFORMAT:
+ if (lexrc.next())
+ outputFormat_ = lexrc.getString();
+ break;
+
+ case TC_OUTPUTTYPE:
readOutputType(lexrc);
+ switch(outputType_) {
+ case LATEX:
+ outputFormat_ = "latex";
+ break;
+ case DOCBOOK:
+ outputFormat_ = "docbook";
+ break;
+ case LITERATE:
+ outputFormat_ = "literate";
+ break;
+ }
break;
case TC_INPUT: // Include file
if (lexrc.next()) {
+ FileName tmp;
string const inc = lexrc.getString();
- FileName tmp = libFileSearch("layouts", inc,
+ if (!path().empty() && (prefixIs(inc, "./") ||
+ prefixIs(inc, "../")))
+ tmp = fileSearch(path(), inc, "layout");
+ else
+ tmp = libFileSearch("layouts", inc,
"layout");
if (tmp.empty()) {
lexrc.printError("Could not find input file: " + inc);
error = true;
} else if (!read(tmp, MERGE)) {
- lexrc.printError("Error reading input"
- "file: " + tmp.absFilename());
+ lexrc.printError("Error reading input file: " + tmp.absFileName());
error = true;
}
}
}
break;
- case TC_ENVIRONMENT:
- case TC_STYLE:
- if (lexrc.next()) {
- docstring const name = from_utf8(subst(lexrc.getString(),
- '_', ' '));
- if (name.empty()) {
- string s = "Could not read name for style: `$$Token' "
- + lexrc.getString() + " is probably not valid UTF-8!";
- lexrc.printError(s.c_str());
- Layout lay;
- // Since we couldn't read the name, we just scan the rest
- // of the style and discard it.
- error = !readStyle(lexrc, lay);
- } else if (hasLayout(name)) {
- Layout & lay = operator[](name);
- error = !readStyle(lexrc, lay);
- } else {
- Layout lay;
- lay.setName(name);
- if (le == TC_ENVIRONMENT)
- lay.is_environment = true;
- error = !readStyle(lexrc, lay);
- if (!error)
- layoutlist_.push_back(lay);
-
- if (defaultlayout_.empty()) {
- // We do not have a default layout yet, so we choose
- // the first layout we encounter.
- defaultlayout_ = name;
- }
+ case TC_MODIFYSTYLE:
+ modifystyle = true;
+ // fall through
+ case TC_PROVIDESTYLE:
+ // if modifystyle is true, then we got here by falling through
+ // so we are not in an ProvideStyle block
+ if (!modifystyle)
+ providestyle = true;
+ // fall through
+ case TC_STYLE: {
+ if (!lexrc.next()) {
+ lexrc.printError("No name given for style: `$$Token'.");
+ error = true;
+ break;
+ }
+ docstring const name = from_utf8(subst(lexrc.getString(),
+ '_', ' '));
+ if (name.empty()) {
+ string s = "Could not read name for style: `$$Token' "
+ + lexrc.getString() + " is probably not valid UTF-8!";
+ lexrc.printError(s);
+ Layout lay;
+ // Since we couldn't read the name, we just scan the rest
+ // of the style and discard it.
+ error = !readStyle(lexrc, lay);
+ break;
+ }
+
+ bool const have_layout = hasLayout(name);
+
+ // If the layout already exists, then we want to add it to
+ // the existing layout, as long as we are not in an ProvideStyle
+ // block.
+ if (have_layout && !providestyle) {
+ Layout & lay = operator[](name);
+ error = !readStyle(lexrc, lay);
+ }
+ // If the layout does not exist, then we want to create a new
+ // one, but not if we are in a ModifyStyle block.
+ else if (!have_layout && !modifystyle) {
+ Layout layout;
+ layout.setName(name);
+ error = !readStyle(lexrc, layout);
+ if (!error)
+ layoutlist_.push_back(layout);
+
+ if (defaultlayout_.empty()) {
+ // We do not have a default layout yet, so we choose
+ // the first layout we encounter.
+ defaultlayout_ = name;
}
}
+ // There are two ways to get here:
+ // (i) The layout exists but we are in an ProvideStyle block
+ // (ii) The layout doesn't exist, but we are in an ModifyStyle
+ // block.
+ // Either way, we just scan the rest and discard it
else {
- //FIXME Should we also eat the style here? viz:
- //Layout lay;
- //readStyle(lexrc, lay);
- //as above...
- lexrc.printError("No name given for style: `$$Token'.");
- error = true;
+ Layout lay;
+ // signal to coverity that we do not care about the result
+ (void)readStyle(lexrc, lay);
}
break;
+ }
case TC_NOSTYLE:
if (lexrc.next()) {
}
break;
+ case TC_NOINSETLAYOUT:
+ if (lexrc.next()) {
+ docstring const style = from_utf8(subst(lexrc.getString(),
+ '_', ' '));
+ if (!deleteInsetLayout(style))
+ LYXERR0("Style `" << style << "' cannot be removed\n"
+ "because it was not found!");
+ }
+ break;
+
case TC_COLUMNS:
if (lexrc.next())
columns_ = lexrc.getInteger();
break;
case TC_PREAMBLE:
- preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
+ preamble_ = lexrc.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case TC_HTMLPREAMBLE:
+ htmlpreamble_ = lexrc.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case TC_HTMLSTYLES:
+ htmlstyles_ = lexrc.getLongString(from_ascii("EndStyles"));
+ break;
+
+ case TC_HTMLTOCSECTION:
+ html_toc_section_ = from_utf8(trim(lexrc.getString()));
break;
case TC_ADDTOPREAMBLE:
- preamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
+ preamble_ += lexrc.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case TC_ADDTOHTMLPREAMBLE:
+ htmlpreamble_ += lexrc.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case TC_ADDTOHTMLSTYLES:
+ htmlstyles_ += lexrc.getLongString(from_ascii("EndStyles"));
break;
case TC_PROVIDES: {
case TC_REQUIRES: {
lexrc.eatLine();
- vector<string> const req
+ vector<string> const req
= getVectorFromString(lexrc.getString());
requires_.insert(req.begin(), req.end());
break;
}
+ case TC_PKGOPTS : {
+ lexrc.next();
+ string const pkg = lexrc.getString();
+ lexrc.next();
+ string const options = lexrc.getString();
+ package_options_[pkg] = options;
+ break;
+ }
+
+ case TC_DEFAULTMODULE: {
+ lexrc.next();
+ string const module = lexrc.getString();
+ if (find(default_modules_.begin(), default_modules_.end(), module) == default_modules_.end())
+ default_modules_.push_back(module);
+ break;
+ }
+
+ case TC_PROVIDESMODULE: {
+ lexrc.next();
+ string const module = lexrc.getString();
+ if (find(provided_modules_.begin(), provided_modules_.end(), module) == provided_modules_.end())
+ provided_modules_.push_back(module);
+ break;
+ }
+
+ case TC_EXCLUDESMODULE: {
+ lexrc.next();
+ string const module = lexrc.getString();
+ // modules already have their own way to exclude other modules
+ if (rt == MODULE) {
+ LYXERR0("ExcludesModule tag cannot be used in a module!");
+ break;
+ }
+ if (find(excluded_modules_.begin(), excluded_modules_.end(), module) == excluded_modules_.end())
+ excluded_modules_.push_back(module);
+ break;
+ }
+
case TC_LEFTMARGIN: // left margin type
if (lexrc.next())
leftmargin_ = lexrc.getDocString();
rightmargin_ = lexrc.getDocString();
break;
- case TC_INSETLAYOUT:
- if (lexrc.next()) {
+ case TC_INSETLAYOUT: {
+ if (!lexrc.next()) {
+ lexrc.printError("No name given for InsetLayout: `$$Token'.");
+ error = true;
+ break;
+ }
+ docstring const name = subst(lexrc.getDocString(), '_', ' ');
+ if (name.empty()) {
+ string s = "Could not read name for InsetLayout: `$$Token' "
+ + lexrc.getString() + " is probably not valid UTF-8!";
+ lexrc.printError(s);
InsetLayout il;
- if (il.read(lexrc)) {
- insetlayoutlist_[il.name()] = il;
- }
- // else there was an error, so forget it
+ // Since we couldn't read the name, we just scan the rest
+ // of the style and discard it.
+ il.read(lexrc, *this);
+ // Let's try to continue rather than abort.
+ // error = true;
+ } else if (hasInsetLayout(name)) {
+ InsetLayout & il = insetlayoutlist_[name];
+ error = !il.read(lexrc, *this);
+ } else {
+ InsetLayout il;
+ il.setName(name);
+ error = !il.read(lexrc, *this);
+ if (!error)
+ insetlayoutlist_[name] = il;
}
break;
+ }
case TC_FLOAT:
- readFloat(lexrc);
+ error = !readFloat(lexrc);
break;
+ case TC_CITEENGINE:
+ error = !readCiteEngine(lexrc);
+ break;
+
+ case TC_CITEENGINETYPE:
+ if (lexrc.next())
+ opt_enginetype_ = rtrim(lexrc.getString());
+ break;
+
+ case TC_CITEFORMAT:
+ error = !readCiteFormat(lexrc);
+ break;
+
+ case TC_CITEFRAMEWORK:
+ lexrc.next();
+ citeframework_ = rtrim(lexrc.getString());
+ break;
+
+ case TC_MAXCITENAMES:
+ lexrc.next();
+ maxcitenames_ = size_t(lexrc.getInteger());
+ break;
+
+ case TC_DEFAULTBIBLIO:
+ if (lexrc.next()) {
+ vector<string> const dbs =
+ getVectorFromString(rtrim(lexrc.getString()), "|");
+ vector<string>::const_iterator it = dbs.begin();
+ vector<string>::const_iterator end = dbs.end();
+ for (; it != end; ++it) {
+ if (!contains(*it, ':')) {
+ vector<string> const enginetypes =
+ getVectorFromString(opt_enginetype_, "|");
+ for (string const &s: enginetypes)
+ cite_default_biblio_style_[s] = *it;
+ } else {
+ string eng;
+ string const db = split(*it, eng, ':');
+ cite_default_biblio_style_[eng] = db;
+ }
+ }
+ }
+ break;
+
+ case TC_FULLAUTHORLIST:
+ if (lexrc.next())
+ cite_full_author_list_ &= lexrc.getBool();
+ break;
+
+ case TC_NOCOUNTER:
+ if (lexrc.next()) {
+ docstring const cnt = lexrc.getDocString();
+ if (!counters_.remove(cnt))
+ LYXERR0("Unable to remove counter: " + to_utf8(cnt));
+ }
+ break;
+
+ case TC_IFCOUNTER:
+ ifcounter = true;
+ // fall through
case TC_COUNTER:
- readCounter(lexrc);
+ if (lexrc.next()) {
+ docstring const name = lexrc.getDocString();
+ if (name.empty()) {
+ string s = "Could not read name for counter: `$$Token' "
+ + lexrc.getString() + " is probably not valid UTF-8!";
+ lexrc.printError(s.c_str());
+ Counter c;
+ // Since we couldn't read the name, we just scan the rest
+ // and discard it.
+ c.read(lexrc);
+ } else
+ error = !counters_.read(lexrc, name, !ifcounter);
+ }
+ else {
+ lexrc.printError("No name given for style: `$$Token'.");
+ error = true;
+ }
break;
case TC_TITLELATEXTYPE:
floatlist_.erase(nofloat);
}
break;
- }
- //Note that this is triggered the first time through the loop unless
- //we hit a format tag.
- if (format != FORMAT)
+ case TC_OUTLINERNAME:
+ error = !readOutlinerName(lexrc);
break;
+ } // end of switch
+
+ // Note that this is triggered the first time through the loop unless
+ // we hit a format tag.
+ if (format != LAYOUT_FORMAT)
+ return FORMAT_MISMATCH;
}
- if (format != FORMAT)
- return FORMAT_MISMATCH;
+ // at present, we abort if we encounter an error,
+ // so there is no point continuing.
+ if (error)
+ return ERROR;
- if (rt != BASECLASS)
- return (error ? ERROR : OK);
+ if (rt != BASECLASS)
+ return OK;
if (defaultlayout_.empty()) {
- lyxerr << "Error: Textclass '" << name_
- << "' is missing a defaultstyle." << endl;
- error = true;
+ LYXERR0("Error: Textclass '" << name_
+ << "' is missing a defaultstyle.");
+ return ERROR;
}
-
- //Try to erase "stdinsets" from the provides_ set.
- //The
- // Provides stdinsets 1
- //declaration simply tells us that the standard insets have been
- //defined. (It's found in stdinsets.inc but could also be used in
- //user-defined files.) There isn't really any such package. So we
- //might as well go ahead and erase it.
- //If we do not succeed, then it was not there, which means that
- //the textclass did not provide the definitions of the standard
- //insets. So we need to try to load them.
+
+ // Try to erase "stdinsets" from the provides_ set.
+ // The
+ // Provides stdinsets 1
+ // declaration simply tells us that the standard insets have been
+ // defined. (It's found in stdinsets.inc but could also be used in
+ // user-defined files.) There isn't really any such package. So we
+ // might as well go ahead and erase it.
+ // If we do not succeed, then it was not there, which means that
+ // the textclass did not provide the definitions of the standard
+ // insets. So we need to try to load them.
int erased = provides_.erase("stdinsets");
if (!erased) {
FileName tmp = libFileSearch("layouts", "stdinsets.inc");
if (tmp.empty()) {
- throw ExceptionMessage(WarningException, _("Missing File"),
+ frontend::Alert::warning(_("Missing File"),
_("Could not find stdinsets.inc! This may lead to data loss!"));
error = true;
} else if (!read(tmp, MERGE)) {
- throw ExceptionMessage(WarningException, _("Corrupt File"),
+ frontend::Alert::warning(_("Corrupt File"),
_("Could not read stdinsets.inc! This may lead to data loss!"));
error = true;
}
void TextClass::readTitleType(Lexer & lexrc)
{
- keyword_item titleTypeTags[] = {
+ LexerKeyword titleTypeTags[] = {
{ "commandafter", TITLE_COMMAND_AFTER },
- { "environment", TITLE_ENVIRONMENT }
+ { "environment", TITLE_ENVIRONMENT }
};
- PushPopHelper pph(lexrc, titleTypeTags, TITLE_ENVIRONMENT);
+ PushPopHelper pph(lexrc, titleTypeTags);
int le = lexrc.lex();
switch (le) {
case Lexer::LEX_UNDEF:
lexrc.printError("Unknown output type `$$Token'");
- return;
+ break;
case TITLE_COMMAND_AFTER:
case TITLE_ENVIRONMENT:
titletype_ = static_cast<TitleLatexType>(le);
break;
default:
- lyxerr << "Unhandled value " << le
- << " in TextClass::readTitleType." << endl;
-
+ LYXERR0("Unhandled value " << le << " in TextClass::readTitleType.");
break;
}
}
void TextClass::readOutputType(Lexer & lexrc)
{
- keyword_item outputTypeTags[] = {
- { "docbook", DOCBOOK },
- { "latex", LATEX },
+ LexerKeyword outputTypeTags[] = {
+ { "docbook", DOCBOOK },
+ { "latex", LATEX },
{ "literate", LITERATE }
};
- PushPopHelper pph(lexrc, outputTypeTags, LITERATE);
+ PushPopHelper pph(lexrc, outputTypeTags);
int le = lexrc.lex();
switch (le) {
outputType_ = static_cast<OutputType>(le);
break;
default:
- lyxerr << "Unhandled value " << le
- << " in TextClass::readOutputType." << endl;
-
+ LYXERR0("Unhandled value " << le);
break;
}
}
-enum ClassOptionsTags {
- CO_FONTSIZE = 1,
- CO_PAGESTYLE,
- CO_OTHER,
- CO_HEADER,
- CO_END
-};
-
-
void TextClass::readClassOptions(Lexer & lexrc)
{
- keyword_item classOptionsTags[] = {
- {"end", CO_END },
- {"fontsize", CO_FONTSIZE },
- {"header", CO_HEADER },
- {"other", CO_OTHER },
+ enum {
+ CO_FONTSIZE = 1,
+ CO_PAGESTYLE,
+ CO_OTHER,
+ CO_HEADER,
+ CO_END
+ };
+
+ LexerKeyword classOptionsTags[] = {
+ {"end", CO_END },
+ {"fontsize", CO_FONTSIZE },
+ {"header", CO_HEADER },
+ {"other", CO_OTHER },
{"pagestyle", CO_PAGESTYLE }
};
- lexrc.pushTable(classOptionsTags, CO_END);
+ lexrc.pushTable(classOptionsTags);
bool getout = false;
while (!getout && lexrc.isOK()) {
int le = lexrc.lex();
case Lexer::LEX_UNDEF:
lexrc.printError("Unknown ClassOption tag `$$Token'");
continue;
- default: break;
+ default:
+ break;
}
- switch (static_cast<ClassOptionsTags>(le)) {
+ switch (le) {
case CO_FONTSIZE:
lexrc.next();
opt_fontsize_ = rtrim(lexrc.getString());
break;
case CO_OTHER:
lexrc.next();
- options_ = lexrc.getString();
+ if (options_.empty())
+ options_ = lexrc.getString();
+ else
+ options_ += ',' + lexrc.getString();
break;
case CO_HEADER:
lexrc.next();
}
-enum FloatTags {
- FT_TYPE = 1,
- FT_NAME,
- FT_PLACEMENT,
- FT_EXT,
- FT_WITHIN,
- FT_STYLE,
- FT_LISTNAME,
- FT_BUILTIN,
- FT_END
-};
+bool TextClass::readCiteEngine(Lexer & lexrc)
+{
+ int const type = readCiteEngineType(lexrc);
+ if (type & ENGINE_TYPE_AUTHORYEAR)
+ cite_styles_[ENGINE_TYPE_AUTHORYEAR].clear();
+ if (type & ENGINE_TYPE_NUMERICAL)
+ cite_styles_[ENGINE_TYPE_NUMERICAL].clear();
+ if (type & ENGINE_TYPE_DEFAULT)
+ cite_styles_[ENGINE_TYPE_DEFAULT].clear();
+ string def;
+ bool getout = false;
+ while (!getout && lexrc.isOK()) {
+ lexrc.eatLine();
+ def = lexrc.getString();
+ def = subst(def, " ", "");
+ def = subst(def, "\t", "");
+ if (compare_ascii_no_case(def, "end") == 0) {
+ getout = true;
+ continue;
+ }
+ CitationStyle cs;
+ char ichar = def[0];
+ if (ichar == '#')
+ continue;
+ if (isUpperCase(ichar)) {
+ cs.forceUpperCase = true;
+ def[0] = lowercase(ichar);
+ }
+
+ /** For portability reasons (between different
+ * cite engines such as natbib and biblatex),
+ * we distinguish between:
+ * 1. The LyX name as output in the LyX file
+ * 2. Possible aliases that might fall back to
+ * the given LyX name in the current engine
+ * 3. The actual LaTeX command that is output
+ * (2) and (3) are optional.
+ * Also, the GUI string for the starred version can
+ * be changed
+ * The syntax is:
+ * LyXName|alias,nextalias*<!stardesc!stardesctooltip>[][]=latexcmd
+ */
+ enum ScanMode {
+ LyXName,
+ Alias,
+ LaTeXCmd,
+ StarDesc
+ };
+
+ ScanMode mode = LyXName;
+ ScanMode oldmode = LyXName;
+ string lyx_cmd;
+ string alias;
+ string latex_cmd;
+ string stardesc;
+ size_t const n = def.size();
+ for (size_t i = 0; i != n; ++i) {
+ ichar = def[i];
+ if (ichar == '|')
+ mode = Alias;
+ else if (ichar == '=')
+ mode = LaTeXCmd;
+ else if (ichar == '<') {
+ oldmode = mode;
+ mode = StarDesc;
+ } else if (ichar == '>')
+ mode = oldmode;
+ else if (mode == LaTeXCmd)
+ latex_cmd += ichar;
+ else if (mode == StarDesc)
+ stardesc += ichar;
+ else if (ichar == '$')
+ cs.hasQualifiedList = true;
+ else if (ichar == '*')
+ cs.hasStarredVersion = true;
+ else if (ichar == '[' && cs.textAfter)
+ cs.textBefore = true;
+ else if (ichar == '[')
+ cs.textAfter = true;
+ else if (ichar != ']') {
+ if (mode == Alias)
+ alias += ichar;
+ else
+ lyx_cmd += ichar;
+ }
+ }
+ cs.name = lyx_cmd;
+ cs.cmd = latex_cmd.empty() ? lyx_cmd : latex_cmd;
+ if (!alias.empty()) {
+ vector<string> const aliases = getVectorFromString(alias);
+ for (string const &s: aliases)
+ cite_command_aliases_[s] = lyx_cmd;
+ }
+ vector<string> const stardescs = getVectorFromString(stardesc, "!");
+ int size = stardesc.size();
+ if (size > 0)
+ cs.stardesc = stardescs[0];
+ if (size > 1)
+ cs.startooltip = stardescs[1];
+ if (type & ENGINE_TYPE_AUTHORYEAR)
+ cite_styles_[ENGINE_TYPE_AUTHORYEAR].push_back(cs);
+ if (type & ENGINE_TYPE_NUMERICAL)
+ cite_styles_[ENGINE_TYPE_NUMERICAL].push_back(cs);
+ if (type & ENGINE_TYPE_DEFAULT)
+ cite_styles_[ENGINE_TYPE_DEFAULT].push_back(cs);
+ }
+ return getout;
+}
-void TextClass::readFloat(Lexer & lexrc)
+int TextClass::readCiteEngineType(Lexer & lexrc) const
{
- keyword_item floatTags[] = {
+ LATTEST(ENGINE_TYPE_DEFAULT ==
+ (ENGINE_TYPE_AUTHORYEAR | ENGINE_TYPE_NUMERICAL));
+ if (!lexrc.next()) {
+ lexrc.printError("No cite engine type given for token: `$$Token'.");
+ return ENGINE_TYPE_DEFAULT;
+ }
+ string const type = rtrim(lexrc.getString());
+ if (compare_ascii_no_case(type, "authoryear") == 0)
+ return ENGINE_TYPE_AUTHORYEAR;
+ else if (compare_ascii_no_case(type, "numerical") == 0)
+ return ENGINE_TYPE_NUMERICAL;
+ else if (compare_ascii_no_case(type, "default") != 0) {
+ string const s = "Unknown cite engine type `" + type
+ + "' given for token: `$$Token',";
+ lexrc.printError(s);
+ }
+ return ENGINE_TYPE_DEFAULT;
+}
+
+
+bool TextClass::readCiteFormat(Lexer & lexrc)
+{
+ int const type = readCiteEngineType(lexrc);
+ string etype;
+ string definition;
+ while (lexrc.isOK()) {
+ lexrc.next();
+ etype = lexrc.getString();
+ if (compare_ascii_no_case(etype, "end") == 0)
+ break;
+ if (!lexrc.isOK())
+ return false;
+ lexrc.eatLine();
+ definition = lexrc.getString();
+ char initchar = etype[0];
+ if (initchar == '#')
+ continue;
+ if (initchar == '!' || initchar == '_') {
+ if (type & ENGINE_TYPE_AUTHORYEAR)
+ cite_macros_[ENGINE_TYPE_AUTHORYEAR][etype] = definition;
+ if (type & ENGINE_TYPE_NUMERICAL)
+ cite_macros_[ENGINE_TYPE_NUMERICAL][etype] = definition;
+ if (type & ENGINE_TYPE_DEFAULT)
+ cite_macros_[ENGINE_TYPE_DEFAULT][etype] = definition;
+ } else {
+ if (type & ENGINE_TYPE_AUTHORYEAR)
+ cite_formats_[ENGINE_TYPE_AUTHORYEAR][etype] = definition;
+ if (type & ENGINE_TYPE_NUMERICAL)
+ cite_formats_[ENGINE_TYPE_NUMERICAL][etype] = definition;
+ if (type & ENGINE_TYPE_DEFAULT)
+ cite_formats_[ENGINE_TYPE_DEFAULT][etype] = definition;
+ }
+ }
+ return true;
+}
+
+
+bool TextClass::readFloat(Lexer & lexrc)
+{
+ enum {
+ FT_TYPE = 1,
+ FT_NAME,
+ FT_PLACEMENT,
+ FT_EXT,
+ FT_WITHIN,
+ FT_STYLE,
+ FT_LISTNAME,
+ FT_USESFLOAT,
+ FT_PREDEFINED,
+ FT_HTMLSTYLE,
+ FT_HTMLATTR,
+ FT_HTMLTAG,
+ FT_LISTCOMMAND,
+ FT_REFPREFIX,
+ FT_ALLOWED_PLACEMENT,
+ FT_ALLOWS_SIDEWAYS,
+ FT_ALLOWS_WIDE,
+ FT_END
+ };
+
+ LexerKeyword floatTags[] = {
+ { "allowedplacement", FT_ALLOWED_PLACEMENT },
+ { "allowssideways", FT_ALLOWS_SIDEWAYS },
+ { "allowswide", FT_ALLOWS_WIDE },
{ "end", FT_END },
{ "extension", FT_EXT },
{ "guiname", FT_NAME },
- { "latexbuiltin", FT_BUILTIN },
+ { "htmlattr", FT_HTMLATTR },
+ { "htmlstyle", FT_HTMLSTYLE },
+ { "htmltag", FT_HTMLTAG },
+ { "ispredefined", FT_PREDEFINED },
+ { "listcommand", FT_LISTCOMMAND },
{ "listname", FT_LISTNAME },
{ "numberwithin", FT_WITHIN },
{ "placement", FT_PLACEMENT },
+ { "refprefix", FT_REFPREFIX },
{ "style", FT_STYLE },
- { "type", FT_TYPE }
+ { "type", FT_TYPE },
+ { "usesfloatpkg", FT_USESFLOAT }
};
- lexrc.pushTable(floatTags, FT_END);
+ lexrc.pushTable(floatTags);
- string type;
- string placement;
string ext;
- string within;
- string style;
+ string htmlattr;
+ docstring htmlstyle;
+ string htmltag;
+ string listname;
+ string listcommand;
string name;
- string listName;
- bool builtin = false;
+ string placement;
+ string allowed_placement = "!htbpH";
+ string refprefix;
+ string style;
+ string type;
+ string within;
+ bool usesfloat = true;
+ bool ispredefined = false;
+ bool allowswide = true;
+ bool allowssideways = true;
bool getout = false;
while (!getout && lexrc.isOK()) {
case Lexer::LEX_UNDEF:
lexrc.printError("Unknown float tag `$$Token'");
continue;
- default: break;
+ default:
+ break;
}
- switch (static_cast<FloatTags>(le)) {
+ switch (le) {
case FT_TYPE:
lexrc.next();
type = lexrc.getString();
within = fl.within();
style = fl.style();
name = fl.name();
- listName = fl.listName();
- builtin = fl.builtin();
- }
+ listname = fl.listName();
+ usesfloat = fl.usesFloatPkg();
+ ispredefined = fl.isPredefined();
+ listcommand = fl.listCommand();
+ refprefix = fl.refPrefix();
+ }
break;
case FT_NAME:
lexrc.next();
lexrc.next();
placement = lexrc.getString();
break;
+ case FT_ALLOWED_PLACEMENT:
+ lexrc.next();
+ allowed_placement = lexrc.getString();
+ break;
case FT_EXT:
lexrc.next();
ext = lexrc.getString();
lexrc.next();
style = lexrc.getString();
break;
+ case FT_LISTCOMMAND:
+ lexrc.next();
+ listcommand = lexrc.getString();
+ break;
+ case FT_REFPREFIX:
+ lexrc.next();
+ refprefix = lexrc.getString();
+ break;
case FT_LISTNAME:
lexrc.next();
- listName = lexrc.getString();
+ listname = lexrc.getString();
+ break;
+ case FT_USESFLOAT:
+ lexrc.next();
+ usesfloat = lexrc.getBool();
+ break;
+ case FT_PREDEFINED:
+ lexrc.next();
+ ispredefined = lexrc.getBool();
+ break;
+ case FT_ALLOWS_SIDEWAYS:
+ lexrc.next();
+ allowssideways = lexrc.getBool();
+ break;
+ case FT_ALLOWS_WIDE:
+ lexrc.next();
+ allowswide = lexrc.getBool();
+ break;
+ case FT_HTMLATTR:
+ lexrc.next();
+ htmlattr = lexrc.getString();
break;
- case FT_BUILTIN:
+ case FT_HTMLSTYLE:
lexrc.next();
- builtin = lexrc.getBool();
+ htmlstyle = lexrc.getLongString(from_ascii("EndHTMLStyle"));
+ break;
+ case FT_HTMLTAG:
+ lexrc.next();
+ htmltag = lexrc.getString();
break;
case FT_END:
getout = true;
}
}
- // Here if have a full float if getout == true
+ lexrc.popTable();
+
+ // Here we have a full float if getout == true
if (getout) {
- Floating fl(type, placement, ext, within,
- style, name, listName, builtin);
+ if (!usesfloat && listcommand.empty()) {
+ // if this float uses the same auxfile as an existing one,
+ // there is no need for it to provide a list command.
+ FloatList::const_iterator it = floatlist_.begin();
+ FloatList::const_iterator en = floatlist_.end();
+ bool found_ext = false;
+ for (; it != en; ++it) {
+ if (it->second.ext() == ext) {
+ found_ext = true;
+ break;
+ }
+ }
+ if (!found_ext)
+ LYXERR0("The layout does not provide a list command " <<
+ "for the float `" << type << "'. LyX will " <<
+ "not be able to produce a float list.");
+ }
+ Floating fl(type, placement, ext, within, style, name,
+ listname, listcommand, refprefix, allowed_placement,
+ htmltag, htmlattr, htmlstyle, usesfloat, ispredefined,
+ allowswide, allowssideways);
floatlist_.newFloat(fl);
// each float has its own counter
counters_.newCounter(from_ascii(type), from_ascii(within),
counters_.newCounter(subtype, from_ascii(type),
"\\alph{" + subtype + "}", docstring());
}
-
- lexrc.popTable();
+ return getout;
}
-enum CounterTags {
- CT_NAME = 1,
- CT_WITHIN,
- CT_LABELSTRING,
- CT_LABELSTRING_APPENDIX,
- CT_END
-};
-
-
-void TextClass::readCounter(Lexer & lexrc)
+bool TextClass::readOutlinerName(Lexer & lexrc)
{
- keyword_item counterTags[] = {
- { "end", CT_END },
- { "labelstring", CT_LABELSTRING },
- { "labelstringappendix", CT_LABELSTRING_APPENDIX },
- { "name", CT_NAME },
- { "within", CT_WITHIN }
- };
-
- lexrc.pushTable(counterTags, CT_END);
-
+ std::string type;
docstring name;
- docstring within;
- docstring labelstring;
- docstring labelstring_appendix;
-
- bool getout = false;
- while (!getout && lexrc.isOK()) {
- int le = lexrc.lex();
- switch (le) {
- case Lexer::LEX_UNDEF:
- lexrc.printError("Unknown counter tag `$$Token'");
- continue;
- default: break;
- }
- switch (static_cast<CounterTags>(le)) {
- case CT_NAME:
- lexrc.next();
- name = lexrc.getDocString();
- if (counters_.hasCounter(name))
- LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
- else
- LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
- break;
- case CT_WITHIN:
- lexrc.next();
- within = lexrc.getDocString();
- if (within == "none")
- within.erase();
- break;
- case CT_LABELSTRING:
- lexrc.next();
- labelstring = lexrc.getDocString();
- labelstring_appendix = labelstring;
- break;
- case CT_LABELSTRING_APPENDIX:
- lexrc.next();
- labelstring_appendix = lexrc.getDocString();
- break;
- case CT_END:
- getout = true;
- break;
- }
+ if (lexrc.next())
+ type = lexrc.getString();
+ else {
+ lexrc.printError("No type given for OutlinerName: `$$Token'.");
+ return false;
+ }
+ if (lexrc.next())
+ name = lexrc.getDocString();
+ else {
+ lexrc.printError("No name given for OutlinerName: `$$Token'.");
+ return false;
}
+ outliner_names_[type] = name;
+ return true;
+}
- // Here if have a full counter if getout == true
- if (getout)
- counters_.newCounter(name, within,
- labelstring, labelstring_appendix);
- lexrc.popTable();
+string const & TextClass::prerequisites(string const & sep) const
+{
+ if (contains(prerequisites_, ',')) {
+ vector<string> const pres = getVectorFromString(prerequisites_);
+ prerequisites_ = getStringFromVector(pres, sep);
+ }
+ return prerequisites_;
}
}
+bool TextClass::hasInsetLayout(docstring const & n) const
+{
+ if (n.empty())
+ return false;
+ InsetLayouts::const_iterator it = insetlayoutlist_.find(n);
+ return it != insetlayoutlist_.end();
+}
+
Layout const & TextClass::operator[](docstring const & name) const
{
- BOOST_ASSERT(!name.empty());
+ LATTEST(!name.empty());
- const_iterator it =
+ const_iterator it =
find_if(begin(), end(), LayoutNamesEqual(name));
if (it == end()) {
- lyxerr << "We failed to find the layout '" << to_utf8(name)
- << "' in the layout list. You MUST investigate!"
- << endl;
+ LYXERR0("We failed to find the layout '" << name
+ << "' in the layout list. You MUST investigate!");
for (const_iterator cit = begin(); cit != end(); ++cit)
lyxerr << " " << to_utf8(cit->name()) << endl;
- // we require the name to exist
- BOOST_ASSERT(false);
+ // We require the name to exist
+ static const Layout dummy;
+ LASSERT(false, return dummy);
}
return *it;
Layout & TextClass::operator[](docstring const & name)
{
- BOOST_ASSERT(!name.empty());
+ LATTEST(!name.empty());
+ // Safe to continue, given what we do below.
iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
if (it == end()) {
- lyxerr << "We failed to find the layout '" << to_utf8(name)
- << "' in the layout list. You MUST investigate!"
- << endl;
+ LYXERR0("We failed to find the layout '" << to_utf8(name)
+ << "' in the layout list. You MUST investigate!");
for (const_iterator cit = begin(); cit != end(); ++cit)
- lyxerr << " " << to_utf8(cit->name()) << endl;
+ LYXERR0(" " << to_utf8(cit->name()));
// we require the name to exist
- BOOST_ASSERT(false);
+ LATTEST(false);
+ // we are here only in release mode
+ layoutlist_.push_back(createBasicLayout(name, true));
+ it = find_if(begin(), end(), LayoutNamesEqual(name));
}
return *it;
bool TextClass::deleteLayout(docstring const & name)
{
- if (name == defaultLayoutName() || name == emptyLayoutName())
+ if (name == defaultLayoutName() || name == plainLayoutName())
return false;
LayoutList::iterator it =
}
+bool TextClass::deleteInsetLayout(docstring const & name)
+{
+ return insetlayoutlist_.erase(name);
+}
+
+
// Load textclass info if not loaded yet
bool TextClass::load(string const & path) const
{
return true;
// Read style-file, provided path is searched before the system ones
- FileName layout_file;
- if (!path.empty())
+ // If path is a file, it is loaded directly.
+ FileName layout_file(path);
+ if (!path.empty() && !layout_file.isReadableFile())
layout_file = FileName(addName(path, name_ + ".layout"));
if (layout_file.empty() || !layout_file.exists())
layout_file = libFileSearch("layouts", name_, "layout");
if (!loaded_) {
lyxerr << "Error reading `"
- << to_utf8(makeDisplayPath(layout_file.absFilename()))
+ << to_utf8(makeDisplayPath(layout_file.absFileName()))
<< "'\n(Check `" << name_
<< "')\nCheck your installation and "
- "try Options/Reconfigure..." << endl;
+ "try Options/Reconfigure..."
+ << endl;
}
return loaded_;
}
-InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
+bool DocumentClass::addLayoutIfNeeded(docstring const & n) const
+{
+ if (hasLayout(n))
+ return false;
+
+ layoutlist_.push_back(createBasicLayout(n, true));
+ return true;
+}
+
+
+string DocumentClass::forcedLayouts() const
{
+ ostringstream os;
+ bool first = true;
+ const_iterator const e = end();
+ for (const_iterator i = begin(); i != e; ++i) {
+ if (i->forcelocal > 0) {
+ if (first) {
+ os << "Format " << LAYOUT_FORMAT << '\n';
+ first = false;
+ }
+ i->write(os);
+ }
+ }
+ return os.str();
+}
+
+
+InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
+{
+ // FIXME The fix for the InsetLayout part of 4812 would be here:
+ // Add the InsetLayout to the document class if it is not found.
docstring n = name;
InsetLayouts::const_iterator cen = insetlayoutlist_.end();
while (!n.empty()) {
InsetLayouts::const_iterator cit = insetlayoutlist_.lower_bound(n);
- if (cit != cen && cit->first == n)
- return cit->second;
+ if (cit != cen && cit->first == n) {
+ if (cit->second.obsoleted_by().empty())
+ return cit->second;
+ n = cit->second.obsoleted_by();
+ return insetLayout(n);
+ }
+ // If we have a generic prefix (e.g., "Note:"),
+ // try if this one alone is found.
size_t i = n.find(':');
if (i == string::npos)
break;
- n = n.substr(0,i);
+ n = n.substr(0, i);
}
- return empty_insetlayout_;
+ // Layout "name" not found.
+ return plainInsetLayout();
+}
+
+
+InsetLayout const & DocumentClass::plainInsetLayout() {
+ static const InsetLayout plain_insetlayout_;
+ return plain_insetlayout_;
}
docstring const & TextClass::defaultLayoutName() const
{
- // This really should come from the actual layout... (Lgb)
return defaultlayout_;
}
}
-bool TextClass::isDefaultLayout(Layout const & lay) const
+bool TextClass::isDefaultLayout(Layout const & layout) const
{
- return lay.name() == defaultLayoutName();
+ return layout.name() == defaultLayoutName();
}
-bool TextClass::isEmptyLayout(Layout const & lay) const
+bool TextClass::isPlainLayout(Layout const & layout) const
{
- return lay.name() == emptyLayoutName();
+ return layout.name() == plainLayoutName();
}
-DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
+Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
{
- DocumentClass * dc = new DocumentClass(baseClass);
- tc_list_.push_back(dc);
- return *tc_list_.back();
+ static Layout * defaultLayout = NULL;
+
+ if (defaultLayout) {
+ defaultLayout->setUnknown(unknown);
+ defaultLayout->setName(name);
+ return *defaultLayout;
+ }
+
+ static char const * s = "Margin Static\n"
+ "LatexType Paragraph\n"
+ "LatexName dummy\n"
+ "Align Block\n"
+ "AlignPossible Left, Right, Center\n"
+ "LabelType No_Label\n"
+ "End";
+ istringstream ss(s);
+ Lexer lex(textClassTags);
+ lex.setStream(ss);
+ defaultLayout = new Layout;
+ defaultLayout->setUnknown(unknown);
+ defaultLayout->setName(name);
+ if (!readStyle(lex, *defaultLayout)) {
+ // The only way this happens is because the hardcoded layout above
+ // is wrong.
+ LATTEST(false);
+ };
+ return *defaultLayout;
}
-DocumentClassBundle & DocumentClassBundle::get()
+DocumentClassPtr getDocumentClass(
+ LayoutFile const & baseClass, LayoutModuleList const & modlist,
+ LayoutModuleList const & celist,
+ bool const clone)
{
- static DocumentClassBundle singleton;
- return singleton;
+ DocumentClassPtr doc_class =
+ DocumentClassPtr(new DocumentClass(baseClass));
+ LayoutModuleList::const_iterator it = modlist.begin();
+ LayoutModuleList::const_iterator en = modlist.end();
+ for (; it != en; ++it) {
+ string const modName = *it;
+ LyXModule * lm = theModuleList[modName];
+ if (!lm) {
+ docstring const msg =
+ bformat(_("The module %1$s has been requested by\n"
+ "this document but has not been found in the list of\n"
+ "available modules. If you recently installed it, you\n"
+ "probably need to reconfigure LyX.\n"), from_utf8(modName));
+ if (!clone)
+ frontend::Alert::warning(_("Module not available"), msg);
+ continue;
+ }
+ if (!lm->isAvailable() && !clone) {
+ docstring const prereqs = from_utf8(getStringFromVector(lm->prerequisites(), "\n\t"));
+ docstring const msg =
+ bformat(_("The module %1$s requires a package that is not\n"
+ "available in your LaTeX installation, or a converter that\n"
+ "you have not installed. LaTeX output may not be possible.\n"
+ "Missing prerequisites:\n"
+ "\t%2$s\n"
+ "See section 3.1.2.3 (Modules) of the User's Guide for more information."),
+ from_utf8(modName), prereqs);
+ frontend::Alert::warning(_("Package not available"), msg, true);
+ }
+ FileName layout_file = libFileSearch("layouts", lm->getFilename());
+ if (!doc_class->read(layout_file, TextClass::MODULE)) {
+ docstring const msg =
+ bformat(_("Error reading module %1$s\n"), from_utf8(modName));
+ frontend::Alert::warning(_("Read Error"), msg);
+ }
+ }
+
+ LayoutModuleList::const_iterator cit = celist.begin();
+ LayoutModuleList::const_iterator cen = celist.end();
+ for (; cit != cen; ++cit) {
+ string const ceName = *cit;
+ LyXCiteEngine * ce = theCiteEnginesList[ceName];
+ if (!ce) {
+ docstring const msg =
+ bformat(_("The cite engine %1$s has been requested by\n"
+ "this document but has not been found in the list of\n"
+ "available engines. If you recently installed it, you\n"
+ "probably need to reconfigure LyX.\n"), from_utf8(ceName));
+ if (!clone)
+ frontend::Alert::warning(_("Cite Engine not available"), msg);
+ continue;
+ }
+ if (!ce->isAvailable() && !clone) {
+ docstring const prereqs = from_utf8(getStringFromVector(ce->prerequisites(), "\n\t"));
+ docstring const msg =
+ bformat(_("The cite engine %1$s requires a package that is not\n"
+ "available in your LaTeX installation, or a converter that\n"
+ "you have not installed. LaTeX output may not be possible.\n"
+ "Missing prerequisites:\n"
+ "\t%2$s\n"
+ "See section 3.1.2.3 (Modules) of the User's Guide for more information."),
+ from_utf8(ceName), prereqs);
+ frontend::Alert::warning(_("Package not available"), msg, true);
+ }
+ FileName layout_file = libFileSearch("citeengines", ce->getFilename());
+ if (!doc_class->read(layout_file, TextClass::CITE_ENGINE)) {
+ docstring const msg =
+ bformat(_("Error reading cite engine %1$s\n"), from_utf8(ceName));
+ frontend::Alert::warning(_("Read Error"), msg);
+ }
+ }
+
+ return doc_class;
}
+/////////////////////////////////////////////////////////////////////////
+//
+// DocumentClass
+//
+/////////////////////////////////////////////////////////////////////////
+
DocumentClass::DocumentClass(LayoutFile const & tc)
: TextClass(tc)
{}
}
+Layout const & DocumentClass::getTOCLayout() const
+{
+ // we're going to look for the layout with the minimum toclevel
+ TextClass::LayoutList::const_iterator lit = begin();
+ TextClass::LayoutList::const_iterator const len = end();
+ int minlevel = 1000;
+ Layout const * lay = NULL;
+ for (; lit != len; ++lit) {
+ int const level = lit->toclevel;
+ // we don't want Part or unnumbered sections
+ if (level == Layout::NOT_IN_TOC || level < 0
+ || level >= minlevel || lit->counter.empty())
+ continue;
+ lay = &*lit;
+ minlevel = level;
+ }
+ if (lay)
+ return *lay;
+ // hmm. that is very odd, so we'll do our best.
+ return operator[](defaultLayoutName());
+}
+
+
+Layout const & DocumentClass::htmlTOCLayout() const
+{
+ if (html_toc_section_.empty())
+ html_toc_section_ = getTOCLayout().name();
+ return operator[](html_toc_section_);
+}
+
+
+string const DocumentClass::getCiteFormat(CiteEngineType const & type,
+ string const & entry, bool const punct, string const & fallback) const
+{
+ string default_format = "{%fullnames:author%[[%fullnames:author%, ]][[{%fullnames:editor%[[%fullnames:editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!<i>!}%journal%{!</i>!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}";
+ if (punct)
+ default_format += ".";
+
+ map<CiteEngineType, map<string, string> >::const_iterator itype = cite_formats_.find(type);
+ if (itype == cite_formats_.end())
+ return default_format;
+ map<string, string>::const_iterator it = itype->second.find(entry);
+ if (it == itype->second.end() && !fallback.empty())
+ it = itype->second.find(fallback);
+ if (it == itype->second.end())
+ return default_format;
+ if (punct)
+ return it->second + ".";
+ return it->second;
+}
+
+
+string const & DocumentClass::getCiteMacro(CiteEngineType const & type,
+ string const & macro) const
+{
+ static string empty;
+ map<CiteEngineType, map<string, string> >::const_iterator itype = cite_macros_.find(type);
+ if (itype == cite_macros_.end())
+ return empty;
+ map<string, string>::const_iterator it = itype->second.find(macro);
+ if (it == itype->second.end())
+ return empty;
+ return it->second;
+}
+
+
+vector<string> const DocumentClass::citeCommands(
+ CiteEngineType const & type) const
+{
+ vector<CitationStyle> const styles = citeStyles(type);
+ vector<CitationStyle>::const_iterator it = styles.begin();
+ vector<CitationStyle>::const_iterator end = styles.end();
+ vector<string> cmds;
+ for (; it != end; ++it) {
+ CitationStyle const cite = *it;
+ cmds.push_back(cite.name);
+ }
+ return cmds;
+}
+
+
+vector<CitationStyle> const & DocumentClass::citeStyles(
+ CiteEngineType const & type) const
+{
+ static vector<CitationStyle> empty;
+ map<CiteEngineType, vector<CitationStyle> >::const_iterator it = cite_styles_.find(type);
+ if (it == cite_styles_.end())
+ return empty;
+ return it->second;
+}
+
+
+/////////////////////////////////////////////////////////////////////////
+//
+// PageSides
+//
+/////////////////////////////////////////////////////////////////////////
+
ostream & operator<<(ostream & os, PageSides p)
{
switch (p) {
projects / lyx.git / blobdiff