#include "support/lassert.h"
#include "support/debug.h"
-#include "support/ExceptionMessage.h"
#include "support/FileName.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include <fstream>
#include <sstream>
+#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 (or ask someone who has bash to run) the
+// development/updatelayouts.sh script, to update the format of
+// all of our layout files.
+//
+int const LAYOUT_FORMAT = 30;
+
namespace {
class LayoutNamesEqual : public unary_function<Layout, bool> {
docstring name_;
};
-// Keep the changes documented in the Customization manual.
-int const FORMAT = 15;
-
bool layout2layout(FileName const & filename, FileName const & tempfile)
{
}
-std::string translateRT(TextClass::ReadType rt)
+string translateReadType(TextClass::ReadType rt)
{
switch (rt) {
case TextClass::BASECLASS:
TC_OUTPUTFORMAT,
TC_INPUT,
TC_STYLE,
+ TC_IFSTYLE,
TC_DEFAULTSTYLE,
TC_INSETLAYOUT,
TC_NOSTYLE,
TC_RIGHTMARGIN,
TC_FLOAT,
TC_COUNTER,
+ TC_IFCOUNTER,
TC_NOFLOAT,
TC_TITLELATEXNAME,
TC_TITLELATEXTYPE,
TC_FORMAT,
TC_ADDTOPREAMBLE,
+ TC_ADDTOHTMLPREAMBLE,
TC_DEFAULTMODULE,
TC_PROVIDESMODULE,
- TC_EXCLUDESMODULE
+ TC_EXCLUDESMODULE,
+ TC_HTMLTOCSECTION,
+ TC_CITEFORMAT
};
namespace {
LexerKeyword textClassTags[] = {
- { "addtopreamble", TC_ADDTOPREAMBLE },
- { "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 },
- { "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 }
+ { "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 }
};
} //namespace anon
bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
{
- LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT);
+ LYXERR(Debug::TCLASS, "Converting layout file to " << LAYOUT_FORMAT);
FileName const tempfile = FileName::tempName("convert_layout");
bool success = layout2layout(filename, tempfile);
if (success)
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
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;
}
bool const worx = convertLayoutFormat(filename, rt);
if (!worx) {
LYXERR0 ("Unable to convert " << filename <<
- " to format " << FORMAT);
+ " to format " << LAYOUT_FORMAT);
return false;
}
return true;
bool const worx = convertLayoutFormat(tempfile, rt);
if (!worx) {
LYXERR0("Unable to convert internal layout information to format "
- << FORMAT);
+ << LAYOUT_FORMAT);
}
tempfile.removeFile();
return worx;
// Reads a textclass structure from file.
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 ifstyle = false;
+ bool ifcounter = false;
+
switch (static_cast<TextClassTags>(le)) {
case TC_FORMAT:
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_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.
} else if (hasLayout(name)) {
Layout & lay = operator[](name);
error = !readStyle(lexrc, lay);
- } else {
+ } else if (!ifstyle) {
Layout layout;
layout.setName(name);
error = !readStyle(lexrc, layout);
defaultlayout_ = name;
}
}
+ else {
+ // this was an ifstyle where we didn't have the style
+ // scan the rest and discard it
+ Layout lay;
+ readStyle(lexrc, lay);
+ }
+
+ // reset flag
+ ifstyle = false;
break;
}
case TC_HTMLPREAMBLE:
htmlpreamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
break;
+
+ case TC_HTMLTOCSECTION:
+ html_toc_section_ = from_utf8(trim(lexrc.getString()));
+ break;
case TC_ADDTOPREAMBLE:
preamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
break;
+ case TC_ADDTOHTMLPREAMBLE:
+ htmlpreamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
+ break;
+
case TC_PROVIDES: {
lexrc.next();
string const feature = 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_CITEFORMAT:
+ readCiteFormat(lexrc);
break;
+ case TC_IFCOUNTER:
+ ifcounter = true;
case TC_COUNTER:
if (lexrc.next()) {
docstring const name = lexrc.getDocString();
// and discard it.
c.read(lexrc);
} else
- error = !counters_.read(lexrc, name);
+ error = !counters_.read(lexrc, name, !ifcounter);
}
else {
lexrc.printError("No name given for style: `$$Token'.");
error = true;
}
+ // reset flag
+ ifcounter = false;
break;
case TC_TITLELATEXTYPE:
break;
} // end of switch
- //Note that this is triggered the first time through the loop unless
- //we hit a format tag.
- if (format != FORMAT)
- break;
+ // 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)
+ if (rt != BASECLASS)
return (error ? ERROR : OK);
if (defaultlayout_.empty()) {
LYXERR0("Error: Textclass '" << name_
<< "' is missing a defaultstyle.");
- error = true;
+ return ERROR;
}
// Try to erase "stdinsets" from the provides_ set.
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:
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();
}
-void TextClass::readFloat(Lexer & lexrc)
+void TextClass::readCiteFormat(Lexer & lexrc)
+{
+ string etype;
+ string definition;
+ while (lexrc.isOK()) {
+ lexrc.next();
+ etype = lexrc.getString();
+ if (!lexrc.isOK() || compare_ascii_no_case(etype, "end") == 0)
+ break;
+ lexrc.eatLine();
+ definition = lexrc.getString();
+ char initchar = etype[0];
+ if (initchar == '#')
+ continue;
+ if (initchar == '!' || initchar == '_')
+ cite_macros_[etype] = definition;
+ else
+ cite_formats_[etype] = definition;
+ }
+}
+
+
+bool TextClass::readFloat(Lexer & lexrc)
{
enum {
FT_TYPE = 1,
FT_WITHIN,
FT_STYLE,
FT_LISTNAME,
- FT_BUILTIN,
+ FT_NEEDSFLOAT,
+ FT_HTMLSTYLE,
+ FT_HTMLATTR,
+ FT_HTMLTAG,
+ FT_LISTCOMMAND,
+ FT_REFPREFIX,
FT_END
};
{ "end", FT_END },
{ "extension", FT_EXT },
{ "guiname", FT_NAME },
- { "latexbuiltin", FT_BUILTIN },
+ { "htmlattr", FT_HTMLATTR },
+ { "htmlstyle", FT_HTMLSTYLE },
+ { "htmltag", FT_HTMLTAG },
+ { "listcommand", FT_LISTCOMMAND },
{ "listname", FT_LISTNAME },
+ { "needsfloatpkg", FT_NEEDSFLOAT },
{ "numberwithin", FT_WITHIN },
{ "placement", FT_PLACEMENT },
+ { "refprefix", FT_REFPREFIX },
{ "style", FT_STYLE },
{ "type", FT_TYPE }
};
lexrc.pushTable(floatTags);
- string type;
- string placement;
string ext;
- string within;
- string style;
+ string htmlattr;
+ string htmlstyle;
+ string htmltag;
+ string listname;
+ string listcommand;
string name;
- string listName;
- bool builtin = false;
+ string placement;
+ string refprefix;
+ string style;
+ string type;
+ string within;
+ bool needsfloat = 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:
within = fl.within();
style = fl.style();
name = fl.name();
- listName = fl.listName();
- builtin = fl.builtin();
+ listname = fl.listName();
+ needsfloat = fl.needsFloatPkg();
+ listcommand = fl.listCommand();
+ refprefix = fl.refPrefix();
}
break;
case FT_NAME:
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_NEEDSFLOAT:
+ lexrc.next();
+ needsfloat = lexrc.getBool();
+ break;
+ case FT_HTMLATTR:
+ lexrc.next();
+ htmlattr = lexrc.getString();
+ break;
+ case FT_HTMLSTYLE:
+ lexrc.next();
+ htmlstyle = lexrc.getLongString("EndHTMLStyle");
break;
- case FT_BUILTIN:
+ case FT_HTMLTAG:
lexrc.next();
- builtin = lexrc.getBool();
+ 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 (!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);
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;
}
+string const & TextClass::prerequisites() const
+{
+ if (contains(prerequisites_, ',')) {
+ vector<string> const pres = getVectorFromString(prerequisites_);
+ prerequisites_ = getStringFromVector(pres, "\n\t");
+ }
+ return prerequisites_;
+}
+
bool TextClass::hasLayout(docstring const & n) const
{
docstring const name = n.empty() ? defaultLayoutName() : n;
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_;
return *defaultLayout;
}
+
/////////////////////////////////////////////////////////////////////////
//
// DocumentClassBundle
LayoutModuleList::const_iterator en = modlist.end();
for (; it != en; it++) {
string const modName = *it;
- LyXModule * lm = moduleList[modName];
+ 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));
- ExceptionMessage(WarningException,_("Module not available"),
- msg + _("Some layouts may not be available."));
+ frontend::Alert::warning(_("Module not available"), msg);
continue;
}
if (!lm->isAvailable()) {
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);
+ frontend::Alert::warning(_("Package not available"), msg);
}
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));
- throw ExceptionMessage(WarningException, _("Read Error"), msg);
+ frontend::Alert::warning(_("Read Error"), msg);
}
}
return doc_class;
}
+Layout const & DocumentClass::htmlTOCLayout() 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();
+ }
+ return operator[](html_toc_section_);
+}
+
+
+string const & DocumentClass::getCiteFormat(string const & entry_type) 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;
+}
+
+
+string const & DocumentClass::getCiteMacro(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;
+}
+
+
/////////////////////////////////////////////////////////////////////////
//
// PageSides
projects / lyx.git / blobdiff