X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=7a51403dd365596c1e34872fa3d7d6bcbea834df;hb=1cbeb0b244fd631344ce167f4209b8454c5d41ee;hp=b19c1377fbe1605cd207a3e8d4ea106573011391;hpb=f20ff85503818f15f13e927704c2f0e3af3b2f97;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index b19c1377fb..7a51403dd3 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -15,51 +15,40 @@ #include #include "TextClass.h" -#include "debug.h" -#include "Lexer.h" + +#include "Color.h" #include "Counters.h" -#include "gettext.h" +#include "support/debug.h" +#include "support/gettext.h" #include "Floating.h" #include "FloatList.h" +#include "Layout.h" +#include "Lexer.h" +#include "Font.h" #include "frontends/alert.h" +#include "support/ExceptionMessage.h" #include "support/lstrings.h" -#include "support/lyxlib.h" +#include "support/FileName.h" #include "support/filetools.h" #include "support/os.h" -#include -namespace fs = boost::filesystem; - #include +using namespace std; +using namespace lyx::support; namespace lyx { -using support::FileName; -using support::libFileSearch; -using support::makeDisplayPath; -using support::quoteName; -using support::rtrim; -using support::subst; -using support::addName; - -using std::endl; -using std::find_if; -using std::remove_if; -using std::string; -using std::ostream; - - namespace { -class LayoutNamesEqual : public std::unary_function { +class LayoutNamesEqual : public unary_function { public: LayoutNamesEqual(docstring const & name) : name_(name) {} - bool operator()(Layout_ptr const & c) const + bool operator()(LayoutPtr const & c) const { return c->name() == name_; } @@ -68,7 +57,7 @@ private: }; -int const FORMAT = 4; +int const FORMAT = 6; bool layout2layout(FileName const & filename, FileName const & tempfile) @@ -80,16 +69,16 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) return false; } - std::ostringstream command; - command << support::os::python() << ' ' << quoteName(script.toFilesystemEncoding()) + ostringstream command; + command << os::python() << ' ' << quoteName(script.toFilesystemEncoding()) << ' ' << quoteName(filename.toFilesystemEncoding()) << ' ' << quoteName(tempfile.toFilesystemEncoding()); string const command_str = command.str(); - LYXERR(Debug::TCLASS) << "Running `" << command_str << '\'' << endl; + LYXERR(Debug::TCLASS, "Running `" << command_str << '\''); - support::cmd_ret const ret = - support::runCommand(command_str); + cmd_ret const ret = + runCommand(command_str); if (ret.first != 0) { lyxerr << "Could not run layout conversion " "script layout2layout.py." << endl; @@ -98,6 +87,21 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) return true; } + +std::string translateRT(TextClass::ReadType rt) +{ + switch (rt) { + case TextClass::BASECLASS: + return "textclass"; + case TextClass::MERGE: + return "input file"; + case TextClass::MODULE: + return "module file"; + } + // shutup warning + return string(); +} + } // namespace anon @@ -107,13 +111,14 @@ TextClass::TextClass(string const & fn, string const & cln, floatlist_(new FloatList), counters_(new Counters), texClassAvail_(texClassAvail) { + modular_ = false; outputType_ = LATEX; columns_ = 1; sides_ = OneSide; secnumdepth_ = 3; tocdepth_ = 3; pagestyle_ = "default"; - defaultfont_ = Font(Font::ALL_SANE); + defaultfont_ = sane_font; opt_fontsize_ = "10|11|12"; opt_pagestyle_ = "empty|plain|headings|fancy"; titletype_ = TITLE_COMMAND_AFTER; @@ -128,9 +133,9 @@ bool TextClass::isTeXClassAvailable() const } -bool TextClass::do_readStyle(Lexer & lexrc, Layout & lay) +bool TextClass::readStyle(Lexer & lexrc, Layout & lay) { - LYXERR(Debug::TCLASS) << "Reading style " << to_utf8(lay.name()) << endl; + LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name())); if (!lay.read(lexrc, *this)) { // Resolve fonts lay.resfont = lay.font; @@ -161,6 +166,7 @@ enum TextClassTags { TC_CLASSOPTIONS, TC_PREAMBLE, TC_PROVIDES, + TC_REQUIRES, TC_LEFTMARGIN, TC_RIGHTMARGIN, TC_FLOAT, @@ -173,9 +179,9 @@ enum TextClassTags { // Reads a textclass structure from file. -bool TextClass::read(FileName const & filename, bool merge) +bool TextClass::read(FileName const & filename, ReadType rt) { - if (!support::isFileReadable(filename)) { + if (!filename.isReadableFile()) { lyxerr << "Cannot read layout file `" << filename << "'." << endl; return true; @@ -199,6 +205,7 @@ bool TextClass::read(FileName const & filename, bool merge) { "pagestyle", TC_PAGESTYLE }, { "preamble", TC_PREAMBLE }, { "provides", TC_PROVIDES }, + { "requires", TC_REQUIRES }, { "rightmargin", TC_RIGHTMARGIN }, { "secnumdepth", TC_SECNUMDEPTH }, { "sides", TC_SIDES }, @@ -208,14 +215,8 @@ bool TextClass::read(FileName const & filename, bool merge) { "tocdepth", TC_TOCDEPTH } }; - if (!merge) - LYXERR(Debug::TCLASS) << "Reading textclass " - << to_utf8(makeDisplayPath(filename.absFilename())) - << endl; - else - LYXERR(Debug::TCLASS) << "Reading input file " - << to_utf8(makeDisplayPath(filename.absFilename())) - << endl; + LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " + + to_utf8(makeDisplayPath(filename.absFilename()))); Lexer lexrc(textClassTags, sizeof(textClassTags) / sizeof(textClassTags[0])); @@ -261,10 +262,9 @@ bool TextClass::read(FileName const & filename, bool merge) "layout"); if (tmp.empty()) { - lexrc.printError("Could not find input" - "file: " + inc); + lexrc.printError("Could not find input file: " + inc); error = true; - } else if (read(tmp, true)) { + } else if (read(tmp, MERGE)) { lexrc.printError("Error reading input" "file: " + tmp.absFilename()); error = true; @@ -290,16 +290,16 @@ bool TextClass::read(FileName const & filename, bool merge) + lexrc.getString() + " is probably not valid UTF-8!"; lexrc.printError(s.c_str()); Layout lay; - error = do_readStyle(lexrc, lay); + error = readStyle(lexrc, lay); } else if (hasLayout(name)) { Layout * lay = operator[](name).get(); - error = do_readStyle(lexrc, *lay); + error = readStyle(lexrc, *lay); } else { Layout lay; lay.setName(name); if (le == TC_ENVIRONMENT) lay.is_environment = true; - error = do_readStyle(lexrc, lay); + error = readStyle(lexrc, lay); if (!error) layoutlist_.push_back( boost::shared_ptr(new Layout(lay)) @@ -324,7 +324,7 @@ bool TextClass::read(FileName const & filename, bool merge) if (lexrc.next()) { docstring const style = from_utf8(subst(lexrc.getString(), '_', ' ')); - if (!delete_layout(style)) + if (!deleteLayout(style)) lyxerr << "Cannot delete style `" << to_utf8(style) << '\'' << endl; // lexrc.printError("Cannot delete style" @@ -358,11 +358,11 @@ bool TextClass::read(FileName const & filename, bool merge) break; case TC_DEFAULTFONT: - defaultfont_.lyxRead(lexrc); + defaultfont_ = lyxRead(lexrc); if (!defaultfont_.resolved()) { lexrc.printError("Warning: defaultfont should " "be fully instantiated!"); - defaultfont_.realize(Font(Font::ALL_SANE)); + defaultfont_.realize(sane_font); } break; @@ -396,14 +396,22 @@ bool TextClass::read(FileName const & filename, bool merge) break; } + case TC_REQUIRES: { + lexrc.eatLine(); + vector const req + = getVectorFromString(lexrc.getString()); + requires_.insert(req.begin(), req.end()); + break; + } + case TC_LEFTMARGIN: // left margin type if (lexrc.next()) - leftmargin_ = lexrc.getString(); + leftmargin_ = lexrc.getDocString(); break; case TC_RIGHTMARGIN: // right margin type if (lexrc.next()) - rightmargin_ = lexrc.getString(); + rightmargin_ = lexrc.getDocString(); break; case TC_INSETLAYOUT: if (lexrc.next()) { @@ -436,50 +444,71 @@ bool TextClass::read(FileName const & filename, bool merge) } if (format != FORMAT) { - LYXERR(Debug::TCLASS) << "Converting layout file from format " - << format << " to " << FORMAT << endl; - FileName const tempfile(support::tempName()); + 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, merge); - support::unlink(tempfile); + error = read(tempfile, rt); + tempfile.removeFile(); return error; } - if (!merge) { // we are at top level here. - LYXERR(Debug::TCLASS) << "Finished reading textclass " - << to_utf8(makeDisplayPath(filename.absFilename())) - << endl; - if (defaultlayout_.empty()) { - lyxerr << "Error: Textclass '" << name_ - << "' is missing a defaultstyle." << endl; + LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " + + to_utf8(makeDisplayPath(filename.absFilename()))); + + 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_ = std::min(min_toclevel_, - toclevel); - max_toclevel_ = std::max(max_toclevel_, - toclevel); - } + 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); } - LYXERR(Debug::TCLASS) - << "Minimum TocLevel is " << min_toclevel_ - << ", maximum is " << max_toclevel_ <(le); + titletype_ = static_cast(le); break; default: lyxerr << "Unhandled value " << le @@ -598,13 +627,22 @@ void TextClass::readClassOptions(Lexer & lexrc) enum InsetLayoutTags { IL_FONT = 1, - IL_LYXTYPE, + IL_BGCOLOR, + IL_DECORATION, + IL_FREESPACING, + IL_FORCELTR, IL_LABELFONT, IL_LABELSTRING, - IL_LATEXTYPE, IL_LATEXNAME, IL_LATEXPARAM, + IL_LATEXTYPE, + IL_LYXTYPE, + IL_KEEPEMPTY, + IL_MULTIPAR, + IL_NEEDPROTECT, + IL_PASSTHRU, IL_PREAMBLE, + IL_REQUIRES, IL_END }; @@ -612,15 +650,24 @@ enum InsetLayoutTags { 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 }, - { "preamble", IL_PREAMBLE} + { "multipar", IL_MULTIPAR }, + { "needprotect", IL_NEEDPROTECT }, + { "passthru", IL_PASSTHRU }, + { "preamble", IL_PREAMBLE }, + { "requires", IL_REQUIRES } }; lexrc.pushTable(elementTags, IL_END); @@ -628,18 +675,27 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name) string lyxtype; docstring labelstring; string latextype; + string decoration; string latexname; string latexparam; - Font font(Font::ALL_INHERIT); - Font labelfont(Font::ALL_INHERIT); + FontInfo font = inherit_font; + FontInfo labelfont = inherit_font; + ColorCode bgcolor(Color_background); string preamble; + set 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 ClassOption tag `$$Token'"); + lexrc.printError("Unknown InsetLayout tag `$$Token'"); continue; default: break; } @@ -656,6 +712,10 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name) lexrc.next(); labelstring = lexrc.getDocString(); break; + case IL_DECORATION: + lexrc.next(); + decoration = lexrc.getString(); + break; case IL_LATEXNAME: lexrc.next(); latexname = lexrc.getString(); @@ -665,42 +725,84 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name) latexparam = subst(lexrc.getString(), """, "\""); break; case IL_LABELFONT: - labelfont.lyxRead(lexrc); - labelfont.realize(defaultfont()); + 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); - font.realize(defaultfont()); + 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 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.preamble = from_utf8(preamble); + il.bgcolor = bgcolor; + il.preamble = preamble; + il.requires = requires; insetlayoutlist_[name] = il; - - // test name for CS: - if (il.lyxtype == "charstyle") { - charstyles().push_back(il); - } } lexrc.popTable(); @@ -751,7 +853,7 @@ void TextClass::readFloat(Lexer & lexrc) int le = lexrc.lex(); switch (le) { case Lexer::LEX_UNDEF: - lexrc.printError("Unknown ClassOption tag `$$Token'"); + lexrc.printError("Unknown float tag `$$Token'"); continue; default: break; } @@ -828,6 +930,7 @@ enum CounterTags { CT_END }; + void TextClass::readCounter(Lexer & lexrc) { keyword_item counterTags[] = { @@ -850,7 +953,7 @@ void TextClass::readCounter(Lexer & lexrc) int le = lexrc.lex(); switch (le) { case Lexer::LEX_UNDEF: - lexrc.printError("Unknown ClassOption tag `$$Token'"); + lexrc.printError("Unknown counter tag `$$Token'"); continue; default: break; } @@ -859,13 +962,9 @@ void TextClass::readCounter(Lexer & lexrc) lexrc.next(); name = lexrc.getDocString(); if (counters_->hasCounter(name)) - LYXERR(Debug::TCLASS) - << "Reading existing counter " - << to_utf8(name) << endl; + LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name)); else - LYXERR(Debug::TCLASS) - << "Reading new counter " - << to_utf8(name) << endl; + LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name)); break; case CT_WITHIN: lexrc.next(); @@ -897,19 +996,19 @@ void TextClass::readCounter(Lexer & lexrc) } -Font const & TextClass::defaultfont() const +FontInfo const & TextClass::defaultfont() const { return defaultfont_; } -string const & TextClass::leftmargin() const +docstring const & TextClass::leftmargin() const { return leftmargin_; } -string const & TextClass::rightmargin() const +docstring const & TextClass::rightmargin() const { return rightmargin_; } @@ -926,7 +1025,7 @@ bool TextClass::hasLayout(docstring const & n) const -Layout_ptr const & TextClass::operator[](docstring const & name) const +LayoutPtr const & TextClass::operator[](docstring const & name) const { BOOST_ASSERT(!name.empty()); @@ -947,12 +1046,11 @@ Layout_ptr const & TextClass::operator[](docstring const & name) const BOOST_ASSERT(false); } - return (*cit); + return *cit; } - -bool TextClass::delete_layout(docstring const & name) +bool TextClass::deleteLayout(docstring const & name) { if (name == defaultLayoutName()) return false; @@ -978,7 +1076,7 @@ bool TextClass::load(string const & path) const FileName layout_file; if (!path.empty()) layout_file = FileName(addName(path, name_ + ".layout")); - if (layout_file.empty() || !fs::exists(layout_file.toFilesystemEncoding())) + if (layout_file.empty() || !layout_file.exists()) layout_file = libFileSearch("layouts", name_, "layout"); loaded_ = const_cast(this)->read(layout_file) == 0; @@ -1011,6 +1109,14 @@ 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 { docstring n = name; @@ -1022,23 +1128,15 @@ InsetLayout const & TextClass::insetlayout(docstring const & name) const break; n = n.substr(0,i); } - static const InsetLayout empty; + static InsetLayout empty; + empty.labelstring = from_utf8("UNDEFINED"); + empty.labelfont = sane_font; + empty.labelfont.setColor(Color_error); + empty.bgcolor = Color_error; return empty; } -CharStyles::iterator TextClass::charstyle(string const & s) const -{ - CharStyles::iterator cs = charstyles().begin(); - CharStyles::iterator csend = charstyles().end(); - for (; cs != csend; ++cs) { - if (cs->name == s) - return cs; - } - return csend; -} - - docstring const & TextClass::defaultLayoutName() const { // This really should come from the actual layout... (Lgb) @@ -1046,7 +1144,7 @@ docstring const & TextClass::defaultLayoutName() const } -Layout_ptr const & TextClass::defaultLayout() const +LayoutPtr const & TextClass::defaultLayout() const { return operator[](defaultLayoutName()); } @@ -1107,7 +1205,7 @@ docstring const & TextClass::preamble() const } -TextClass::PageSides TextClass::sides() const +PageSides TextClass::sides() const { return sides_; } @@ -1143,7 +1241,7 @@ unsigned int TextClass::columns() const } -LYX_TITLE_LATEX_TYPES TextClass::titletype() const +TitleLatexType TextClass::titletype() const { return titletype_; } @@ -1179,13 +1277,13 @@ bool TextClass::hasTocLevels() const } -ostream & operator<<(ostream & os, TextClass::PageSides p) +ostream & operator<<(ostream & os, PageSides p) { switch (p) { - case TextClass::OneSide: + case OneSide: os << '1'; break; - case TextClass::TwoSides: + case TwoSides: os << '2'; break; }