#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/os.h"
+#include "support/TempFile.h"
#include <algorithm>
#include <fstream>
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 = 62; //spitz PassThru for arguments.
+
+
+// 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> {
docstring name_;
};
-// Keep the changes documented in the Customization manual.
-int const FORMAT = 26;
-
-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()) {
LYXERR0("Could not find layout conversion "
- "script layout2layout.py.");
+ "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);
if (ret.first != 0) {
- LYXERR0("Could not run layout conversion script layout2layout.py.");
+ if (format == LAYOUT_FORMAT)
+ LYXERR0("Conversion of layout with layout2layout.py has failed.");
return false;
}
return true;
}
-string translateRT(TextClass::ReadType rt)
+string translateReadType(TextClass::ReadType rt)
{
switch (rt) {
case TextClass::BASECLASS:
} // namespace anon
-// This string should not be translated here,
+// This string should not be translated here,
// because it is a layout identifier.
-docstring const TextClass::plain_layout_ = from_ascii("Plain Layout");
-
-
-InsetLayout DocumentClass::plain_insetlayout_;
+docstring const TextClass::plain_layout_ = from_ascii(N_("Plain Layout"));
/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
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),
+ cite_full_author_list_(true)
{
- outputType_ = LATEX;
- outputFormat_ = "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;
- _("Plain Layout"); // a hack to make this translatable
}
TC_OUTPUTFORMAT,
TC_INPUT,
TC_STYLE,
- TC_IFSTYLE,
+ TC_MODIFYSTYLE,
+ TC_PROVIDESTYLE,
TC_DEFAULTSTYLE,
TC_INSETLAYOUT,
+ TC_NOINSETLAYOUT,
TC_NOSTYLE,
TC_COLUMNS,
TC_SIDES,
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_FORMAT,
TC_ADDTOPREAMBLE,
TC_ADDTOHTMLPREAMBLE,
+ TC_ADDTOHTMLSTYLES,
TC_DEFAULTMODULE,
TC_PROVIDESMODULE,
TC_EXCLUDESMODULE,
TC_HTMLTOCSECTION,
- TC_CITEFORMAT
+ TC_CITEENGINE,
+ TC_CITEENGINETYPE,
+ TC_CITEFORMAT,
+ TC_DEFAULTBIBLIO,
+ TC_FULLAUTHORLIST,
+ TC_OUTLINERNAME
};
namespace {
- LexerKeyword textClassTags[] = {
- { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE },
- { "addtopreamble", TC_ADDTOPREAMBLE },
- { "citeformat", TC_CITEFORMAT },
- { "classoptions", TC_CLASSOPTIONS },
- { "columns", TC_COLUMNS },
- { "counter", TC_COUNTER },
- { "defaultfont", TC_DEFAULTFONT },
- { "defaultmodule", TC_DEFAULTMODULE },
- { "defaultstyle", TC_DEFAULTSTYLE },
- { "excludesmodule", TC_EXCLUDESMODULE },
- { "float", TC_FLOAT },
- { "format", TC_FORMAT },
- { "htmlpreamble", TC_HTMLPREAMBLE },
- { "htmltocsection", TC_HTMLTOCSECTION },
- { "ifcounter", TC_IFCOUNTER },
- { "ifstyle", TC_IFSTYLE },
- { "input", TC_INPUT },
- { "insetlayout", TC_INSETLAYOUT },
- { "leftmargin", TC_LEFTMARGIN },
- { "nofloat", TC_NOFLOAT },
- { "nostyle", TC_NOSTYLE },
- { "outputformat", TC_OUTPUTFORMAT },
- { "outputtype", TC_OUTPUTTYPE },
- { "pagestyle", TC_PAGESTYLE },
- { "preamble", TC_PREAMBLE },
- { "provides", TC_PROVIDES },
- { "providesmodule", TC_PROVIDESMODULE },
- { "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 },
+ { "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 },
+ { "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("convert_layout");
+ 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;
- tempfile.removeFile();
return success;
}
+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()) {
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 plain 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(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())));
+
+ LYXERR(Debug::TCLASS, "Finished reading " + translateReadType(rt) + ": " +
+ to_utf8(makeDisplayPath(filename.absFileName())));
return retval;
}
return retval == OK;
bool const worx = convertLayoutFormat(filename, rt);
- if (!worx) {
- LYXERR0 ("Unable to convert " << filename <<
- " to format " << FORMAT);
- 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);
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("TextClass_read");
+ TempFile tmp("TextClass_read");
+ FileName const tempfile = tmp.name();
ofstream os(tempfile.toFilesystemEncoding().c_str());
if (!os) {
LYXERR0("Unable to create temporary file");
- return false;
+ return ERROR;
}
os << str;
os.close();
- // now try to convert it
- bool const worx = convertLayoutFormat(tempfile, rt);
- if (!worx) {
- LYXERR0("Unable to convert internal layout information to format "
- << FORMAT);
+ // 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) {
}
// used below to track whether we are in an IfStyle or IfCounter tag.
- bool ifstyle = false;
- bool ifcounter = false;
+ bool modifystyle = false;
+ bool providestyle = false;
+ bool ifcounter = false;
switch (static_cast<TextClassTags>(le)) {
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_IFSTYLE:
- ifstyle = true;
- // fall through
+ 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'.");
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());
+ 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);
- } else if (hasLayout(name)) {
+ 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);
- } else if (!ifstyle) {
+ }
+ // 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);
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 {
- // scan the rest and discard it
Layout lay;
+ // false positive from coverity
+ // coverity[CHECKED_RETURN]
readStyle(lexrc, lay);
- error = false;
}
-
- // reset flag
- ifstyle = false;
break;
}
}
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_ = from_utf8(lexrc.getLongString("EndPreamble"));
+ 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_ += from_utf8(lexrc.getLongString("EndPreamble"));
+ 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 (name.empty()) {
string s = "Could not read name for InsetLayout: `$$Token' "
+ lexrc.getString() + " is probably not valid UTF-8!";
- lexrc.printError(s.c_str());
+ lexrc.printError(s);
InsetLayout il;
// Since we couldn't read the name, we just scan the rest
// of the style and discard it.
il.read(lexrc, *this);
- error = true;
+ // Let's try to continue rather than abort.
+ // error = true;
} else if (hasInsetLayout(name)) {
InsetLayout & il = insetlayoutlist_[name];
error = !il.read(lexrc, *this);
}
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:
- readCiteFormat(lexrc);
+ error = !readCiteFormat(lexrc);
+ break;
+
+ case TC_DEFAULTBIBLIO:
+ if (lexrc.next())
+ cite_default_biblio_style_ = rtrim(lexrc.getString());
+ 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:
if (lexrc.next()) {
docstring const name = lexrc.getDocString();
lexrc.printError("No name given for style: `$$Token'.");
error = true;
}
- // reset flag
- ifcounter = false;
break;
case TC_TITLELATEXTYPE:
floatlist_.erase(nofloat);
}
break;
- } // end of switch
- //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()) {
LYXERR0("Error: Textclass '" << name_
<< "' is missing a defaultstyle.");
- error = true;
+ return ERROR;
}
-
- // Try to erase "stdinsets" from the provides_ set.
+
+ // Try to erase "stdinsets" from the provides_ set.
// The
// Provides stdinsets 1
// declaration simply tells us that the standard insets have been
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;
}
case Lexer::LEX_UNDEF:
lexrc.printError("Unknown ClassOption tag `$$Token'");
continue;
- default: break;
+ default:
+ break;
}
switch (le) {
case CO_FONTSIZE:
}
-void TextClass::readCiteFormat(Lexer & lexrc)
+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;
+ }
+ string cmd;
+ CitationStyle cs;
+ char ichar = def[0];
+ if (ichar == '#')
+ continue;
+ if (ichar == 'C') {
+ cs.forceUpperCase = true;
+ def[0] = 'c';
+ }
+
+ size_t const n = def.size();
+ for (size_t i = 0; i != n; ++i) {
+ ichar = def[i];
+ if (ichar == '*')
+ cs.fullAuthorList = true;
+ else if (ichar == '[' && cs.textAfter)
+ cs.textBefore = true;
+ else if (ichar == '[')
+ cs.textAfter = true;
+ else if (ichar != ']')
+ cmd += ichar;
+ }
+
+ cs.cmd = cmd;
+ 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;
+}
+
+
+int TextClass::readCiteEngineType(Lexer & lexrc) const
+{
+ 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 (!lexrc.isOK() || compare_ascii_no_case(etype, "end") == 0)
+ 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 == '_')
- cite_macros_[etype] = definition;
- else
- cite_formats_[etype] = definition;
+ 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;
}
-void TextClass::readFloat(Lexer & lexrc)
+bool TextClass::readFloat(Lexer & lexrc)
{
enum {
FT_TYPE = 1,
FT_WITHIN,
FT_STYLE,
FT_LISTNAME,
- FT_NEEDSFLOAT,
+ 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 },
{ "htmlattr", FT_HTMLATTR },
{ "htmlstyle", FT_HTMLSTYLE },
{ "htmltag", FT_HTMLTAG },
+ { "ispredefined", FT_PREDEFINED },
{ "listcommand", FT_LISTCOMMAND },
{ "listname", FT_LISTNAME },
- { "needsfloatpkg", FT_NEEDSFLOAT },
{ "numberwithin", FT_WITHIN },
{ "placement", FT_PLACEMENT },
{ "refprefix", FT_REFPREFIX },
{ "style", FT_STYLE },
- { "type", FT_TYPE }
+ { "type", FT_TYPE },
+ { "usesfloatpkg", FT_USESFLOAT }
};
lexrc.pushTable(floatTags);
string ext;
string htmlattr;
- string htmlstyle;
+ docstring htmlstyle;
string htmltag;
string listname;
string listcommand;
string name;
string placement;
+ string allowed_placement = "!htbpH";
string refprefix;
string style;
string type;
string within;
- bool needsfloat = true;
+ 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 (le) {
case FT_TYPE:
style = fl.style();
name = fl.name();
listname = fl.listName();
- needsfloat = fl.needsFloatPkg();
+ 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();
listname = lexrc.getString();
break;
- case FT_NEEDSFLOAT:
+ case FT_USESFLOAT:
lexrc.next();
- needsfloat = lexrc.getBool();
+ 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();
break;
case FT_HTMLSTYLE:
lexrc.next();
- htmlstyle = lexrc.getLongString("EndHTMLStyle");
+ htmlstyle = lexrc.getLongString(from_ascii("EndHTMLStyle"));
break;
case FT_HTMLTAG:
lexrc.next();
}
}
+ lexrc.popTable();
+
// Here we have a full float if getout == true
if (getout) {
- if (!needsfloat && listcommand.empty())
- LYXERR0("The layout does not provide a list command " <<
- "for the builtin float `" << type << "'. LyX will " <<
- "not be able to produce a float list.");
- Floating fl(type, placement, ext, within, style, name,
- listname, listcommand, refprefix,
- htmltag, htmlattr, htmlstyle, needsfloat);
+ 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());
}
+ return getout;
+}
- lexrc.popTable();
+
+bool TextClass::readOutlinerName(Lexer & lexrc)
+{
+ std::string type;
+ docstring name;
+ 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;
+}
+
+
+docstring TextClass::outlinerName(std::string const & type) const
+{
+ std::map<std::string,docstring>::const_iterator const it
+ = outliner_names_.find(type);
+ if (it == outliner_names_.end()) {
+ LYXERR0("Missing OutlinerName for " << type << "!");
+ return from_utf8(type);
+ } else
+ return it->second;
}
-string const & TextClass::prerequisites() const
-{
+string const & TextClass::prerequisites(string const & sep) const
+{
if (contains(prerequisites_, ',')) {
vector<string> const pres = getVectorFromString(prerequisites_);
- prerequisites_ = getStringFromVector(pres, "\n\t");
+ prerequisites_ = getStringFromVector(pres, sep);
}
- return prerequisites_;
+ return prerequisites_;
}
+
bool TextClass::hasLayout(docstring const & n) const
{
docstring const name = n.empty() ? defaultLayoutName() : n;
bool TextClass::hasInsetLayout(docstring const & n) const
{
- if (n.empty())
+ if (n.empty())
return false;
- InsetLayouts::const_iterator it = insetlayoutlist_.begin();
- InsetLayouts::const_iterator en = insetlayoutlist_.end();
- for (; it != en; ++it)
- if (n == it->first)
- return true;
- return false;
+ InsetLayouts::const_iterator it = insetlayoutlist_.find(n);
+ return it != insetlayoutlist_.end();
}
Layout const & TextClass::operator[](docstring const & name) const
{
- LASSERT(!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
- LASSERT(false, /**/);
+ // We require the name to exist
+ static const Layout dummy;
+ LASSERT(false, return dummy);
}
return *it;
Layout & TextClass::operator[](docstring const & name)
{
- LASSERT(!name.empty(), /**/);
+ LATTEST(!name.empty());
+ // Safe to continue, given what we do below.
iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
LYXERR0(" " << to_utf8(cit->name()));
// we require the name to exist
- LASSERT(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::deleteInsetLayout(docstring const & name)
+{
+ return insetlayoutlist_.erase(name);
+}
+
+
// Load textclass info if not loaded yet
bool TextClass::load(string const & path) const
{
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_;
}
-void DocumentClass::addLayoutIfNeeded(docstring const & n) 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
{
- if (!hasLayout(n))
- layoutlist_.push_back(createBasicLayout(n, true));
+ 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
+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.
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);
}
+ // 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 & layout) const
+bool TextClass::isDefaultLayout(Layout const & layout) const
{
return layout.name() == defaultLayoutName();
}
-bool TextClass::isPlainLayout(Layout const & layout) const
+bool TextClass::isPlainLayout(Layout const & layout) const
{
return layout.name() == plainLayoutName();
}
if (!readStyle(lex, *defaultLayout)) {
// The only way this happens is because the hardcoded layout above
// is wrong.
- LASSERT(false, /**/);
+ LATTEST(false);
};
return *defaultLayout;
}
-/////////////////////////////////////////////////////////////////////////
-//
-// DocumentClassBundle
-//
-/////////////////////////////////////////////////////////////////////////
-
-DocumentClassBundle::~DocumentClassBundle()
-{
- for (size_t i = 0; i != documentClasses_.size(); ++i)
- delete documentClasses_[i];
- documentClasses_.clear();
-}
-
-DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
-{
- DocumentClass * dc = new DocumentClass(baseClass);
- documentClasses_.push_back(dc);
- return *documentClasses_.back();
-}
-
-
-DocumentClassBundle & DocumentClassBundle::get()
+DocumentClassPtr getDocumentClass(
+ LayoutFile const & baseClass, LayoutModuleList const & modlist,
+ bool const clone)
{
- static DocumentClassBundle singleton;
- return singleton;
-}
-
-
-DocumentClass & DocumentClassBundle::makeDocumentClass(
- LayoutFile const & baseClass, LayoutModuleList const & modlist)
-{
- DocumentClass & doc_class = newClass(baseClass);
+ DocumentClassPtr doc_class =
+ DocumentClassPtr(new DocumentClass(baseClass));
LayoutModuleList::const_iterator it = modlist.begin();
LayoutModuleList::const_iterator en = modlist.end();
- for (; it != en; it++) {
+ for (; it != en; ++it) {
string const modName = *it;
LyXModule * lm = theModuleList[modName];
if (!lm) {
"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));
- ExceptionMessage(WarningException,_("Module not available"),
- msg + _("Some layouts may not be available."));
+ if (!clone)
+ frontend::Alert::warning(_("Module not available"), msg);
continue;
}
- if (!lm->isAvailable()) {
+ 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\n"
- "not available in your LaTeX installation. LaTeX output\n"
- "may not be possible.\n"), from_utf8(modName));
- ExceptionMessage(WarningException, _("Package not available"), 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)) {
+ if (!doc_class->read(layout_file, TextClass::MODULE)) {
docstring const msg =
bformat(_("Error reading module %1$s\n"), from_utf8(modName));
- throw ExceptionMessage(WarningException, _("Read Error"), msg);
+ frontend::Alert::warning(_("Read Error"), msg);
}
}
return doc_class;
}
-Layout const & DocumentClass::htmlTOCLayout() const
+Layout const & DocumentClass::getTOCLayout() const
{
- if (html_toc_section_.empty()) {
- // 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
- if (level == Layout::NOT_IN_TOC || level < 0 || level >= minlevel)
- continue;
- lay = &*lit;
- minlevel = level;
- }
- if (lay)
- html_toc_section_ = lay->name();
- else
- // hmm. that is very odd, so we'll do our best
- html_toc_section_ = defaultLayoutName();
+ // 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(string const & entry_type) const
+string const & DocumentClass::getCiteFormat(CiteEngineType const & type,
+ string const & entry, string const & fallback) const
{
- static string default_format = N_("{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!<i>!}%journal%{!</i>!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}.");
-
- map<string, string>::const_iterator it = cite_formats_.find(entry_type);
- if (it != cite_formats_.end())
- return it->second;
- return default_format;
+ static string default_format = "{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!<i>!}%journal%{!</i>!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}.";
+
+ 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;
+ return it->second;
}
-string const & DocumentClass::getCiteMacro(string const & macro) const
+string const & DocumentClass::getCiteMacro(CiteEngineType const & type,
+ string const & macro) const
{
static string empty;
- map<string, string>::const_iterator it = cite_macros_.find(macro);
- if (it != cite_macros_.end())
- return it->second;
- return 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.cmd);
+ }
+ 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;
}
projects / lyx.git / blobdiff