* 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 "Layout.h"
#include "Lexer.h"
#include "Font.h"
+#include "ModuleList.h"
#include "frontends/alert.h"
#include <fstream>
#include <sstream>
+#ifdef ERROR
+#undef ERROR
+#endif
+
using namespace std;
using namespace lyx::support;
docstring name_;
};
-
-int const FORMAT = 8;
+// Keep the changes documented in the Customization manual.
+int const FORMAT = 22;
bool layout2layout(FileName const & filename, FileName const & tempfile)
// This string should not be translated here,
// because it is a layout identifier.
-docstring const TextClass::emptylayout_ = from_ascii("Plain Layout");
+docstring const TextClass::plain_layout_ = from_ascii("Plain Layout");
-InsetLayout DocumentClass::empty_insetlayout_;
+InsetLayout DocumentClass::plain_insetlayout_;
/////////////////////////////////////////////////////////////////////////
TextClass::TextClass()
{
outputType_ = LATEX;
+ outputFormat_ = "latex";
columns_ = 1;
sides_ = OneSide;
secnumdepth_ = 3;
enum TextClassTags {
TC_OUTPUTTYPE = 1,
+ TC_OUTPUTFORMAT,
TC_INPUT,
TC_STYLE,
+ TC_IFSTYLE,
TC_DEFAULTSTYLE,
TC_INSETLAYOUT,
TC_NOSTYLE,
TC_TOCDEPTH,
TC_CLASSOPTIONS,
TC_PREAMBLE,
+ TC_HTMLPREAMBLE,
TC_PROVIDES,
TC_REQUIRES,
TC_LEFTMARGIN,
TC_RIGHTMARGIN,
TC_FLOAT,
TC_COUNTER,
+ TC_IFCOUNTER,
TC_NOFLOAT,
TC_TITLELATEXNAME,
TC_TITLELATEXTYPE,
TC_FORMAT,
TC_ADDTOPREAMBLE,
- TC_USEMODULE
+ TC_ADDTOHTMLPREAMBLE,
+ TC_DEFAULTMODULE,
+ TC_PROVIDESMODULE,
+ TC_EXCLUDESMODULE,
+ TC_HTMLTOCSECTION
};
namespace {
LexerKeyword textClassTags[] = {
- { "addtopreamble", TC_ADDTOPREAMBLE },
- { "classoptions", TC_CLASSOPTIONS },
- { "columns", TC_COLUMNS },
- { "counter", TC_COUNTER },
- { "defaultfont", TC_DEFAULTFONT },
- { "defaultstyle", TC_DEFAULTSTYLE },
- { "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 },
- { "usemodule", TC_USEMODULE }
+ { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE },
+ { "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 },
+ { "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);
- FileName const tempfile = FileName::tempName("convert_layout");
- bool success = layout2layout(filename, tempfile);
- if (success)
- success = read(tempfile, rt);
- tempfile.removeFile();
- return success;
+ FileName const tempfile = FileName::tempName("convert_layout");
+ bool success = layout2layout(filename, tempfile);
+ if (success)
+ success = readWithoutConv(tempfile, rt) == OK;
+ tempfile.removeFile();
+ return success;
}
-bool TextClass::read(FileName const & filename, ReadType rt)
+
+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())));
- // Define the `empty' layout used in table cells, ert, etc. Note that
+ // 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_))
- layoutlist_.push_back(createEmptyLayout(emptylayout_));
+ if (rt == BASECLASS && !hasLayout(plain_layout_))
+ layoutlist_.push_back(createBasicLayout(plain_layout_));
Lexer lexrc(textClassTags);
lexrc.setFile(filename);
LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
to_utf8(makeDisplayPath(filename.absFilename())));
-
- if (retval != FORMAT_MISMATCH)
+
+ 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;
+ LYXERR0 ("Unable to convert " << filename <<
+ " to format " << FORMAT);
return false;
}
return true;
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:
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
}
break;
- 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 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;
- }
+ case TC_IFSTYLE:
+ ifstyle = 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.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 if (!ifstyle) {
+ 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;
}
}
else {
- //FIXME Should we also eat the style here? viz:
- //Layout layout;
- //readStyle(lexrc, layout);
- //as above...
- lexrc.printError("No name given for style: `$$Token'.");
- error = true;
+ // scan the rest and discard it
+ Layout lay;
+ readStyle(lexrc, lay);
+ error = false;
}
+
+ // reset flag
+ ifstyle = false;
break;
+ }
case TC_NOSTYLE:
if (lexrc.next()) {
preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
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();
break;
}
- case TC_USEMODULE: {
+ 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();
- usemod_.insert(module);
+ // 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;
}
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.c_str());
+ 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;
+ } else if (hasInsetLayout(name)) {
+ InsetLayout & il = insetlayoutlist_[name];
+ error = !il.read(lexrc, *this);
+ } else {
InsetLayout il;
- if (il.read(lexrc, *this))
- insetlayoutlist_[il.name()] = il;
- // else there was an error, so forget it
+ il.setName(name);
+ error = !il.read(lexrc, *this);
+ if (!error)
+ insetlayoutlist_[name] = il;
}
break;
+ }
case TC_FLOAT:
readFloat(lexrc);
break;
+ case TC_IFCOUNTER:
+ ifcounter = true;
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;
+ }
+ // 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.
FT_STYLE,
FT_LISTNAME,
FT_BUILTIN,
+ FT_HTMLSTYLE,
+ FT_HTMLATTR,
+ FT_HTMLTAG,
FT_END
};
{ "end", FT_END },
{ "extension", FT_EXT },
{ "guiname", FT_NAME },
+ { "htmlattr", FT_HTMLATTR },
+ { "htmlstyle", FT_HTMLSTYLE },
+ { "htmltag", FT_HTMLTAG },
{ "latexbuiltin", FT_BUILTIN },
{ "listname", FT_LISTNAME },
{ "numberwithin", FT_WITHIN },
lexrc.pushTable(floatTags);
- string type;
- string placement;
string ext;
- string within;
- string style;
- string name;
+ string htmlattr;
+ string htmlstyle;
+ string htmltag;
string listName;
+ string name;
+ string placement;
+ string style;
+ string type;
+ string within;
bool builtin = false;
bool getout = false;
lexrc.next();
builtin = lexrc.getBool();
break;
+ case FT_HTMLATTR:
+ lexrc.next();
+ htmlattr = lexrc.getString();
+ break;
+ case FT_HTMLSTYLE:
+ lexrc.next();
+ htmlstyle = lexrc.getLongString("EndHTMLStyle");
+ break;
+ case FT_HTMLTAG:
+ lexrc.next();
+ htmltag = lexrc.getString();
+ break;
case FT_END:
getout = true;
break;
// Here if have a full float if getout == true
if (getout) {
- Floating fl(type, placement, ext, within,
- style, name, listName, builtin);
+ Floating fl(type, placement, ext, within, style, name,
+ listName, htmltag, htmlattr, htmlstyle, builtin);
floatlist_.newFloat(fl);
// each float has its own counter
counters_.newCounter(from_ascii(type), from_ascii(within),
}
-void TextClass::readCounter(Lexer & lexrc)
-{
- enum {
- CT_NAME = 1,
- CT_WITHIN,
- CT_LABELSTRING,
- CT_LABELSTRING_APPENDIX,
- CT_END
- };
-
- LexerKeyword counterTags[] = {
- { "end", CT_END },
- { "labelstring", CT_LABELSTRING },
- { "labelstringappendix", CT_LABELSTRING_APPENDIX },
- { "name", CT_NAME },
- { "within", CT_WITHIN }
- };
-
- lexrc.pushTable(counterTags);
-
- 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 (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;
- }
- }
-
- // Here if have a full counter if getout == true
- if (getout)
- counters_.newCounter(name, within,
- labelstring, labelstring_appendix);
-
- lexrc.popTable();
-}
-
-
bool TextClass::hasLayout(docstring const & n) const
{
docstring const name = n.empty() ? defaultLayoutName() : n;
}
+bool TextClass::hasInsetLayout(docstring const & n) const
+{
+ 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;
+}
+
+
Layout const & TextClass::operator[](docstring const & name) const
{
LASSERT(!name.empty(), /**/);
bool TextClass::deleteLayout(docstring const & name)
{
- if (name == defaultLayoutName() || name == emptyLayoutName())
+ if (name == defaultLayoutName() || name == plainLayoutName())
return false;
LayoutList::iterator it =
void DocumentClass::addLayoutIfNeeded(docstring const & n) const
{
if (!hasLayout(n))
- layoutlist_.push_back(createEmptyLayout(n, true));
+ layoutlist_.push_back(createBasicLayout(n, true));
}
size_t i = n.find(':');
if (i == string::npos)
break;
- n = n.substr(0,i);
+ n = n.substr(0, i);
}
- return empty_insetlayout_;
+ return plain_insetlayout_;
}
bool TextClass::isPlainLayout(Layout const & layout) const
{
- return layout.name() == emptyLayoutName();
+ return layout.name() == plainLayoutName();
}
-Layout TextClass::createEmptyLayout(docstring const & name, bool unknown) const
+Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
{
static Layout * defaultLayout = NULL;
return *defaultLayout;
}
+
/////////////////////////////////////////////////////////////////////////
//
// DocumentClassBundle
}
+DocumentClass & DocumentClassBundle::makeDocumentClass(
+ LayoutFile const & baseClass, LayoutModuleList const & modlist)
+{
+ DocumentClass & doc_class = newClass(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));
+ ExceptionMessage(WarningException,_("Module not available"),
+ msg + _("Some layouts may not be available."));
+ continue;
+ }
+ if (!lm->isAvailable()) {
+ 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);
+ }
+ 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);
+ }
+ }
+ return doc_class;
+}
+
+
/////////////////////////////////////////////////////////////////////////
//
// DocumentClass
}
+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_);
+}
+
+
/////////////////////////////////////////////////////////////////////////
//
// PageSides
projects / lyx.git / blobdiff