#include "TextClass.h"
+#include "BaseClassList.h"
#include "Color.h"
#include "Counters.h"
-#include "support/debug.h"
-#include "support/gettext.h"
#include "Floating.h"
#include "FloatList.h"
#include "Layout.h"
#include "frontends/alert.h"
-#include "support/lstrings.h"
+#include "support/debug.h"
+#include "support/ExceptionMessage.h"
#include "support/FileName.h"
#include "support/filetools.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
#include "support/os.h"
#include <sstream>
namespace {
-class LayoutNamesEqual : public unary_function<LayoutPtr, bool> {
+class LayoutNamesEqual : public unary_function<Layout, bool> {
public:
LayoutNamesEqual(docstring const & name)
: name_(name)
{}
- bool operator()(LayoutPtr const & c) const
+ bool operator()(Layout const & c) const
{
- return c->name() == name_;
+ return c.name() == name_;
}
private:
docstring name_;
case TextClass::MODULE:
return "module file";
}
+ // shutup warning
+ return string();
}
} // namespace anon
-TextClass::TextClass(string const & fn, string const & cln,
- string const & desc, bool texClassAvail )
- : name_(fn), latexname_(cln), description_(desc),
- floatlist_(new FloatList), counters_(new Counters),
- texClassAvail_(texClassAvail)
+docstring const TextClass::emptylayout_ = from_ascii("PlainLayout");
+
+
+InsetLayout DocumentClass::empty_insetlayout_;
+
+
+TextClass::TextClass()
{
- modular_ = false;
+ floatlist_ = boost::shared_ptr<FloatList>(new FloatList);
+ counters_ = boost::shared_ptr<Counters>(new Counters);
outputType_ = LATEX;
columns_ = 1;
sides_ = OneSide;
titletype_ = TITLE_COMMAND_AFTER;
titlename_ = "maketitle";
loaded_ = false;
-}
-
-
-bool TextClass::isTeXClassAvailable() const
-{
- return texClassAvail_;
+ // a hack to make this available for translation
+ // i'm sure there must be a better way (rgh)
+ _("PlainLayout");
}
{
LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name()));
if (!lay.read(lexrc, *this)) {
- // Resolve fonts
- lay.resfont = lay.font;
- lay.resfont.realize(defaultfont());
- lay.reslabelfont = lay.labelfont;
- lay.reslabelfont.realize(defaultfont());
- return false; // no errors
+ lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
+ return false;
}
- lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
- return true;
+ // Resolve fonts
+ lay.resfont = lay.font;
+ lay.resfont.realize(defaultfont_);
+ lay.reslabelfont = lay.labelfont;
+ lay.reslabelfont.realize(defaultfont_);
+ return true; // no errors
}
if (!filename.isReadableFile()) {
lyxerr << "Cannot read layout file `" << filename << "'."
<< endl;
- return true;
+ return false;
}
keyword_item textClassTags[] = {
LYXERR(Debug::TCLASS, "Reading " + translateRT(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
+ // override features of this layout if they should choose to do so.
+ if (rt == BASECLASS) {
+ 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 (tmp.empty()) {
lexrc.printError("Could not find input file: " + inc);
error = true;
- } else if (read(tmp, MERGE)) {
+ } else if (!read(tmp, MERGE)) {
lexrc.printError("Error reading input"
"file: " + tmp.absFilename());
error = true;
+ lexrc.getString() + " is probably not valid UTF-8!";
lexrc.printError(s.c_str());
Layout lay;
- error = readStyle(lexrc, lay);
+ //FIXME If we're just dropping this layout, do we really
+ //care whether there's an error?? Or should we just set
+ //error to true, since we couldn't even read the name?
+ error = !readStyle(lexrc, lay);
} else if (hasLayout(name)) {
- Layout * lay = operator[](name).get();
- error = readStyle(lexrc, *lay);
+ 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);
+ error = !readStyle(lexrc, lay);
if (!error)
- layoutlist_.push_back(
- boost::shared_ptr<Layout>(new Layout(lay))
- );
+ layoutlist_.push_back(lay);
if (defaultlayout_.empty()) {
- // We do not have a default
- // layout yet, so we choose
- // the first layout we
- // encounter.
+ // 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 lay;
+ //readStyle(lexrc, lay);
+ //as above...
lexrc.printError("No name given for style: `$$Token'.");
error = true;
}
if (!deleteLayout(style))
lyxerr << "Cannot delete style `"
<< to_utf8(style) << '\'' << endl;
-// lexrc.printError("Cannot delete style"
-// " `$$Token'");
}
break;
tocdepth_ = lexrc.getInteger();
break;
- // First step to support options
+ // First step to support options
case TC_CLASSOPTIONS:
readClassOptions(lexrc);
break;
if (lexrc.next())
rightmargin_ = lexrc.getDocString();
break;
+
case TC_INSETLAYOUT:
if (lexrc.next()) {
- docstring const name = subst(lexrc.getDocString(), '_', ' ');
- readInsetLayout(lexrc, name);
+ InsetLayout il;
+ if (il.read(lexrc)) {
+ insetlayoutlist_[il.name()] = il;
+ }
+ // else there was an error, so forget it
}
break;
+
case TC_FLOAT:
readFloat(lexrc);
break;
+
case TC_COUNTER:
readCounter(lexrc);
break;
+
case TC_TITLELATEXTYPE:
readTitleType(lexrc);
break;
+
case TC_TITLELATEXNAME:
if (lexrc.next())
titlename_ = lexrc.getString();
break;
+
case TC_NOFLOAT:
if (lexrc.next()) {
string const nofloat = lexrc.getString();
}
break;
}
+
+ //Note that this is triggered the first time through the loop unless
+ //we hit a format tag.
if (format != FORMAT)
break;
}
LYXERR(Debug::TCLASS, "Converting layout file from format "
<< format << " to " << FORMAT);
FileName const tempfile = FileName::tempName();
- error = !layout2layout(filename, tempfile);
- if (!error)
- error = read(tempfile, rt);
+ bool success = layout2layout(filename, tempfile);
+ if (success)
+ read(tempfile, rt);
tempfile.removeFile();
- return error;
+ return success;
}
LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
to_utf8(makeDisplayPath(filename.absFilename())));
- if (rt == BASECLASS) {
- if (defaultlayout_.empty()) {
- lyxerr << "Error: Textclass '" << name_
- << "' is missing a defaultstyle." << endl;
+ if (rt != BASECLASS)
+ return !error;
+
+ if (defaultlayout_.empty()) {
+ lyxerr << "Error: Textclass '" << name_
+ << "' is missing a defaultstyle." << endl;
+ error = true;
+ }
+
+ //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"),
+ _("Could not find stdinsets.inc! This may lead to data loss!"));
+ error = true;
+ } else if (!read(tmp, MERGE)) {
+ throw ExceptionMessage(WarningException, _("Corrupt File"),
+ _("Could not read stdinsets.inc! This may lead to data loss!"));
error = true;
}
+ }
- min_toclevel_ = Layout::NOT_IN_TOC;
- max_toclevel_ = Layout::NOT_IN_TOC;
- const_iterator cit = begin();
- const_iterator the_end = end();
- for ( ; cit != the_end ; ++cit) {
- int const toclevel = (*cit)->toclevel;
- if (toclevel != Layout::NOT_IN_TOC) {
- if (min_toclevel_ == Layout::NOT_IN_TOC)
- min_toclevel_ = toclevel;
- else
- min_toclevel_ = min(min_toclevel_,
- toclevel);
- max_toclevel_ = max(max_toclevel_,
- toclevel);
- }
+ min_toclevel_ = Layout::NOT_IN_TOC;
+ max_toclevel_ = Layout::NOT_IN_TOC;
+ const_iterator lit = begin();
+ const_iterator len = end();
+ for (; lit != len; ++lit) {
+ int const toclevel = lit->toclevel;
+ if (toclevel != Layout::NOT_IN_TOC) {
+ if (min_toclevel_ == Layout::NOT_IN_TOC)
+ min_toclevel_ = toclevel;
+ else
+ min_toclevel_ = min(min_toclevel_, toclevel);
+ max_toclevel_ = max(max_toclevel_, toclevel);
}
- LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_
- << ", maximum is " << max_toclevel_);
-
}
+ LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_
+ << ", maximum is " << max_toclevel_);
- return error;
+ return !error;
}
}
-enum InsetLayoutTags {
- IL_FONT = 1,
- IL_BGCOLOR,
- IL_DECORATION,
- IL_FREESPACING,
- IL_FORCELTR,
- IL_LABELFONT,
- IL_LABELSTRING,
- IL_LATEXNAME,
- IL_LATEXPARAM,
- IL_LATEXTYPE,
- IL_LYXTYPE,
- IL_KEEPEMPTY,
- IL_MULTIPAR,
- IL_NEEDPROTECT,
- IL_PASSTHRU,
- IL_PREAMBLE,
- IL_REQUIRES,
- IL_END
-};
-
-
-void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
-{
- keyword_item elementTags[] = {
- { "bgcolor", IL_BGCOLOR },
- { "decoration", IL_DECORATION },
- { "end", IL_END },
- { "font", IL_FONT },
- { "forceltr", IL_FORCELTR },
- { "freespacing", IL_FREESPACING },
- { "keepempty", IL_KEEPEMPTY },
- { "labelfont", IL_LABELFONT },
- { "labelstring", IL_LABELSTRING },
- { "latexname", IL_LATEXNAME },
- { "latexparam", IL_LATEXPARAM },
- { "latextype", IL_LATEXTYPE },
- { "lyxtype", IL_LYXTYPE },
- { "multipar", IL_MULTIPAR },
- { "needprotect", IL_NEEDPROTECT },
- { "passthru", IL_PASSTHRU },
- { "preamble", IL_PREAMBLE },
- { "requires", IL_REQUIRES }
- };
-
- lexrc.pushTable(elementTags, IL_END);
-
- string lyxtype;
- docstring labelstring;
- string latextype;
- string decoration;
- string latexname;
- string latexparam;
- FontInfo font = inherit_font;
- FontInfo labelfont = inherit_font;
- ColorCode bgcolor(Color_background);
- string preamble;
- set<string> requires;
- bool multipar = false;
- bool passthru = false;
- bool needprotect = false;
- bool keepempty = false;
- bool freespacing = false;
- bool forceltr = false;
-
- bool getout = false;
- while (!getout && lexrc.isOK()) {
- int le = lexrc.lex();
- switch (le) {
- case Lexer::LEX_UNDEF:
- lexrc.printError("Unknown InsetLayout tag `$$Token'");
- continue;
- default: break;
- }
- switch (static_cast<InsetLayoutTags>(le)) {
- case IL_LYXTYPE:
- lexrc.next();
- lyxtype = lexrc.getString();
- break;
- case IL_LATEXTYPE:
- lexrc.next();
- latextype = lexrc.getString();
- break;
- case IL_LABELSTRING:
- lexrc.next();
- labelstring = lexrc.getDocString();
- break;
- case IL_DECORATION:
- lexrc.next();
- decoration = lexrc.getString();
- break;
- case IL_LATEXNAME:
- lexrc.next();
- latexname = lexrc.getString();
- break;
- case IL_LATEXPARAM:
- lexrc.next();
- latexparam = subst(lexrc.getString(), """, "\"");
- break;
- case IL_LABELFONT:
- labelfont = lyxRead(lexrc, inherit_font);
- break;
- case IL_FORCELTR:
- lexrc.next();
- forceltr = lexrc.getBool();
- break;
- case IL_MULTIPAR:
- lexrc.next();
- multipar = lexrc.getBool();
- break;
- case IL_PASSTHRU:
- lexrc.next();
- passthru = lexrc.getBool();
- break;
- case IL_KEEPEMPTY:
- lexrc.next();
- keepempty = lexrc.getBool();
- break;
- case IL_FREESPACING:
- lexrc.next();
- freespacing = lexrc.getBool();
- break;
- case IL_NEEDPROTECT:
- lexrc.next();
- needprotect = lexrc.getBool();
- break;
- case IL_FONT:
- font = lyxRead(lexrc, inherit_font);
- // So: define font before labelfont
- labelfont = font;
- break;
- case IL_BGCOLOR: {
- lexrc.next();
- string const token = lexrc.getString();
- bgcolor = lcolor.getFromLyXName(token);
- break;
- }
- case IL_PREAMBLE:
- preamble = lexrc.getLongString("EndPreamble");
- break;
- case IL_REQUIRES: {
- lexrc.eatLine();
- vector<string> const req
- = getVectorFromString(lexrc.getString());
- requires.insert(req.begin(), req.end());
- break;
- }
- case IL_END:
- getout = true;
- break;
- }
- }
-
- // Here add element to list if getout == true
- if (getout) {
- InsetLayout il;
- il.name = to_ascii(name);
- il.lyxtype = lyxtype;
- il.labelstring = labelstring;
- il.decoration = decoration;
- il.latextype = latextype;
- il.latexname = latexname;
- il.latexparam = latexparam;
- il.multipar = multipar;
- il.passthru = passthru;
- il.needprotect = needprotect;
- il.freespacing = freespacing;
- il.forceltr = forceltr;
- il.keepempty = keepempty;
- il.font = font;
- // The label font is generally used as-is without
- // any realization against a given context.
- labelfont.realize(sane_font);
- il.labelfont = labelfont;
- il.bgcolor = bgcolor;
- il.preamble = preamble;
- il.requires = requires;
- insetlayoutlist_[name] = il;
- }
-
- lexrc.popTable();
-}
-
-
-
enum FloatTags {
FT_TYPE = 1,
FT_NAME,
style, name, listName, builtin);
floatlist_->newFloat(fl);
// each float has its own counter
- counters_->newCounter(from_ascii(type), from_ascii(within),
+ counters_->newCounter(from_ascii(type), from_ascii(within),
docstring(), docstring());
+ // also define sub-float counters
+ docstring const subtype = "sub-" + from_ascii(type);
+ counters_->newCounter(subtype, from_ascii(type),
+ "\\alph{" + subtype + "}", docstring());
}
lexrc.popTable();
}
-FontInfo const & TextClass::defaultfont() const
+bool TextClass::hasLayout(docstring const & n) const
{
- return defaultfont_;
-}
-
+ docstring const name = n.empty() ? defaultLayoutName() : n;
-docstring const & TextClass::leftmargin() const
-{
- return leftmargin_;
+ return find_if(layoutlist_.begin(), layoutlist_.end(),
+ LayoutNamesEqual(name))
+ != layoutlist_.end();
}
-docstring const & TextClass::rightmargin() const
+
+Layout const & TextClass::operator[](docstring const & name) const
{
- return rightmargin_;
-}
+ BOOST_ASSERT(!name.empty());
+ const_iterator it =
+ find_if(begin(), end(), LayoutNamesEqual(name));
-bool TextClass::hasLayout(docstring const & n) const
-{
- docstring const name = n.empty() ? defaultLayoutName() : n;
+ if (it == end()) {
+ lyxerr << "We failed to find the layout '" << to_utf8(name)
+ << "' in the layout list. You MUST investigate!"
+ << endl;
+ for (const_iterator cit = begin(); cit != end(); ++cit)
+ lyxerr << " " << to_utf8(cit->name()) << endl;
- return find_if(layoutlist_.begin(), layoutlist_.end(),
- LayoutNamesEqual(name))
- != layoutlist_.end();
-}
+ // we require the name to exist
+ BOOST_ASSERT(false);
+ }
+ return *it;
+}
-LayoutPtr const & TextClass::operator[](docstring const & name) const
+Layout & TextClass::operator[](docstring const & name)
{
BOOST_ASSERT(!name.empty());
- LayoutList::const_iterator cit =
- find_if(layoutlist_.begin(),
- layoutlist_.end(),
- LayoutNamesEqual(name));
+ iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
- if (cit == layoutlist_.end()) {
+ if (it == end()) {
lyxerr << "We failed to find the layout '" << to_utf8(name)
<< "' in the layout list. You MUST investigate!"
<< endl;
- for (LayoutList::const_iterator it = layoutlist_.begin();
- it != layoutlist_.end(); ++it)
- lyxerr << " " << to_utf8(it->get()->name()) << endl;
+ for (const_iterator cit = begin(); cit != end(); ++cit)
+ lyxerr << " " << to_utf8(cit->name()) << endl;
// we require the name to exist
BOOST_ASSERT(false);
}
- return *cit;
+ return *it;
}
bool TextClass::deleteLayout(docstring const & name)
{
- if (name == defaultLayoutName())
+ if (name == defaultLayoutName() || name == emptyLayoutName())
return false;
LayoutList::iterator it =
layout_file = FileName(addName(path, name_ + ".layout"));
if (layout_file.empty() || !layout_file.exists())
layout_file = libFileSearch("layouts", name_, "layout");
- loaded_ = const_cast<TextClass*>(this)->read(layout_file) == 0;
+ loaded_ = const_cast<TextClass*>(this)->read(layout_file);
if (!loaded_) {
lyxerr << "Error reading `"
}
-FloatList & TextClass::floats()
-{
- return *floatlist_.get();
-}
-
-
-FloatList const & TextClass::floats() const
-{
- return *floatlist_.get();
-}
-
-
-Counters & TextClass::counters() const
-{
- return *counters_.get();
-}
-
-
-// Return the layout object of an inset given by name. If the name
-// is not found as such, the part after the ':' is stripped off, and
-// searched again. In this way, an error fallback can be provided:
-// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
-// will invoke the layout object defined by name = 'CharStyle'.
-// If that doesn't work either, an empty object returns (shouldn't
-// happen). -- Idea JMarc, comment MV
-InsetLayout const & TextClass::insetlayout(docstring const & name) const
+InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
{
docstring n = name;
while (!n.empty()) {
if (insetlayoutlist_.count(n) > 0)
return insetlayoutlist_[n];
- docstring::size_type i = n.find(':');
+ size_t i = n.find(':');
if (i == string::npos)
break;
n = n.substr(0,i);
}
- static InsetLayout empty;
- empty.labelstring = from_utf8("UNDEFINED");
- empty.labelfont = sane_font;
- empty.labelfont.setColor(Color_error);
- empty.bgcolor = Color_error;
- return empty;
+ return empty_insetlayout_;
}
}
-LayoutPtr const & TextClass::defaultLayout() const
+Layout const & TextClass::defaultLayout() const
{
return operator[](defaultLayoutName());
}
-string const & TextClass::name() const
+bool TextClass::isDefaultLayout(Layout const & lay) const
{
- return name_;
+ return lay.name() == defaultLayoutName();
}
-string const & TextClass::latexname() const
+bool TextClass::isEmptyLayout(Layout const & lay) const
{
- const_cast<TextClass*>(this)->load();
- return latexname_;
+ return lay.name() == emptyLayoutName();
}
-string const & TextClass::description() const
+DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
{
- return description_;
+ DocumentClass dc(baseClass);
+ tc_list_.push_back(dc);
+ return tc_list_.back();
}
-string const & TextClass::opt_fontsize() const
+DocumentClassBundle & DocumentClassBundle::get()
{
- return opt_fontsize_;
+ static DocumentClassBundle singleton;
+ return singleton;
}
-string const & TextClass::opt_pagestyle() const
-{
- return opt_pagestyle_;
-}
-
-
-string const & TextClass::options() const
-{
- return options_;
-}
+DocumentClass::DocumentClass(LayoutFile const & tc)
+ : TextClass(tc)
+{}
-string const & TextClass::class_header() const
+bool DocumentClass::hasLaTeXLayout(std::string const & lay) const
{
- return class_header_;
+ LayoutList::const_iterator it = layoutlist_.begin();
+ LayoutList::const_iterator end = layoutlist_.end();
+ for (; it != end; ++it)
+ if (it->latexname() == lay)
+ return true;
+ return false;
}
-string const & TextClass::pagestyle() const
-{
- return pagestyle_;
-}
-
-
-docstring const & TextClass::preamble() const
-{
- return preamble_;
-}
-
-
-PageSides TextClass::sides() const
-{
- return sides_;
-}
-
-
-int TextClass::secnumdepth() const
-{
- return secnumdepth_;
-}
-
-
-int TextClass::tocdepth() const
-{
- return tocdepth_;
-}
-
-
-OutputType TextClass::outputType() const
-{
- return outputType_;
-}
-
-
-bool TextClass::provides(string const & p) const
+bool DocumentClass::provides(string const & p) const
{
return provides_.find(p) != provides_.end();
}
-unsigned int TextClass::columns() const
-{
- return columns_;
-}
-
-
-TitleLatexType TextClass::titletype() const
-{
- return titletype_;
-}
-
-
-string const & TextClass::titlename() const
-{
- return titlename_;
-}
-
-
-int TextClass::size() const
-{
- return layoutlist_.size();
-}
-
-
-int TextClass::min_toclevel() const
-{
- return min_toclevel_;
-}
-
-
-int TextClass::max_toclevel() const
-{
- return max_toclevel_;
-}
-
-
-bool TextClass::hasTocLevels() const
+bool DocumentClass::hasTocLevels() const
{
return min_toclevel_ != Layout::NOT_IN_TOC;
}