X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=f1b1df7eaab855ac78b1d13843d9f45479f23ac1;hb=c4db1d0f5a05429726d244caebd207bf29c58d71;hp=2072b08d785a5afebd4962c04db5b00d9819a8fe;hpb=897436efbb9bd641b61467d185a2dfae9839e575;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index 2072b08d78..f1b1df7eaa 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -15,22 +15,30 @@ #include #include "TextClass.h" -#include "debug.h" -#include "Lexer.h" + +#include "Color.h" #include "Counters.h" +#include "debug.h" +#include "gettext.h" #include "Floating.h" #include "FloatList.h" +#include "Layout.h" +#include "Lexer.h" + +#include "frontends/alert.h" #include "support/lstrings.h" #include "support/lyxlib.h" #include "support/filetools.h" #include "support/os.h" -#include -namespace fs = boost::filesystem; - #include +using std::endl; +using std::find_if; +using std::remove_if; +using std::string; +using std::ostream; namespace lyx { @@ -42,30 +50,25 @@ 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; - +extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font); namespace { -class LayoutNamesEqual : public std::unary_function { +class LayoutNamesEqual : public std::unary_function { public: - LayoutNamesEqual(string const & name) + LayoutNamesEqual(docstring const & name) : name_(name) {} - bool operator()(Layout_ptr const & c) const + bool operator()(LayoutPtr const & c) const { return c->name() == name_; } private: - string name_; + docstring name_; }; -int const FORMAT = 4; +int const FORMAT = 5; bool layout2layout(FileName const & filename, FileName const & tempfile) @@ -101,16 +104,17 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) TextClass::TextClass(string const & fn, string const & cln, string const & desc, bool texClassAvail ) : name_(fn), latexname_(cln), description_(desc), - floatlist_(new FloatList), ctrs_(new Counters), + 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; @@ -125,9 +129,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 " << lay.name() << endl; + LYXERR(Debug::TCLASS) << "Reading style " << to_utf8(lay.name()) << endl; if (!lay.read(lexrc, *this)) { // Resolve fonts lay.resfont = lay.font; @@ -136,7 +140,7 @@ bool TextClass::do_readStyle(Lexer & lexrc, Layout & lay) lay.reslabelfont.realize(defaultfont()); return false; // no errors } - lyxerr << "Error parsing style `" << lay.name() << '\'' << endl; + lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl; return true; } @@ -146,7 +150,7 @@ enum TextClassTags { TC_INPUT, TC_STYLE, TC_DEFAULTSTYLE, - TC_CHARSTYLE, + TC_INSETLAYOUT, TC_ENVIRONMENT, TC_NOSTYLE, TC_COLUMNS, @@ -170,16 +174,15 @@ 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.isFileReadable()) { lyxerr << "Cannot read layout file `" << filename << "'." << endl; return true; } keyword_item textClassTags[] = { - { "charstyle", TC_CHARSTYLE }, { "classoptions", TC_CLASSOPTIONS }, { "columns", TC_COLUMNS }, { "counter", TC_COUNTER }, @@ -189,6 +192,7 @@ bool TextClass::read(FileName const & filename, bool merge) { "float", TC_FLOAT }, { "format", TC_FORMAT }, { "input", TC_INPUT }, + { "insetlayout", TC_INSETLAYOUT }, { "leftmargin", TC_LEFTMARGIN }, { "nofloat", TC_NOFLOAT }, { "nostyle", TC_NOSTYLE }, @@ -205,14 +209,21 @@ 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; + switch (rt) { + case BASECLASS: + LYXERR(Debug::TCLASS) << "Reading textclass "; + break; + case MERGE: + LYXERR(Debug::TCLASS) << "Reading input file "; + break; + case MODULE: + LYXERR(Debug::TCLASS) << "Reading module file "; + break; + default: + BOOST_ASSERT(false); + } + LYXERR(Debug::TCLASS) << to_utf8(makeDisplayPath(filename.absFilename())) + << endl; Lexer lexrc(textClassTags, sizeof(textClassTags) / sizeof(textClassTags[0])); @@ -261,7 +272,7 @@ bool TextClass::read(FileName const & filename, bool merge) 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; @@ -271,8 +282,8 @@ bool TextClass::read(FileName const & filename, bool merge) case TC_DEFAULTSTYLE: if (lexrc.next()) { - string const name = subst(lexrc.getString(), - '_', ' '); + docstring const name = from_utf8(subst(lexrc.getString(), + '_', ' ')); defaultlayout_ = name; } break; @@ -280,17 +291,23 @@ bool TextClass::read(FileName const & filename, bool merge) case TC_ENVIRONMENT: case TC_STYLE: if (lexrc.next()) { - string const name = subst(lexrc.getString(), - '_', ' '); - if (hasLayout(name)) { + 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; + 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)) @@ -313,11 +330,11 @@ bool TextClass::read(FileName const & filename, bool merge) case TC_NOSTYLE: if (lexrc.next()) { - string const style = subst(lexrc.getString(), - '_', ' '); - if (!delete_layout(style)) + docstring const style = from_utf8(subst(lexrc.getString(), + '_', ' ')); + if (!deleteLayout(style)) lyxerr << "Cannot delete style `" - << style << '\'' << endl; + << to_utf8(style) << '\'' << endl; // lexrc.printError("Cannot delete style" // " `$$Token'"); } @@ -349,11 +366,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; @@ -389,17 +406,17 @@ bool TextClass::read(FileName const & filename, bool merge) 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_CHARSTYLE: + case TC_INSETLAYOUT: if (lexrc.next()) { - string const name = subst(lexrc.getString(), '_', ' '); - readCharStyle(lexrc, name); + docstring const name = subst(lexrc.getDocString(), '_', ' '); + readInsetLayout(lexrc, name); } break; case TC_FLOAT: @@ -432,12 +449,20 @@ bool TextClass::read(FileName const & filename, bool merge) FileName const tempfile(support::tempName()); error = !layout2layout(filename, tempfile); if (!error) - error = read(tempfile, merge); + error = read(tempfile, rt); support::unlink(tempfile); return error; } - if (!merge) { // we are at top level here. + if (rt == MODULE) + LYXERR(Debug::TCLASS) << "Finished reading module file " + << to_utf8(makeDisplayPath(filename.absFilename())) + << endl; + else if (rt == MERGE) + LYXERR(Debug::TCLASS) << "Finished reading input file " + << to_utf8(makeDisplayPath(filename.absFilename())) + << endl; + else { // we are at top level here. LYXERR(Debug::TCLASS) << "Finished reading textclass " << to_utf8(makeDisplayPath(filename.absFilename())) << endl; @@ -467,10 +492,7 @@ bool TextClass::read(FileName const & filename, bool merge) << "Minimum TocLevel is " << min_toclevel_ << ", maximum is " << max_toclevel_ <(le); + titletype_ = static_cast(le); break; default: lyxerr << "Unhandled value " << le @@ -586,37 +608,68 @@ void TextClass::readClassOptions(Lexer & lexrc) lexrc.popTable(); } -enum CharStyleTags { - CS_FONT = 1, - CS_LABELFONT, - CS_LATEXTYPE, - CS_LATEXNAME, - CS_LATEXPARAM, - CS_PREAMBLE, - CS_END + +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_END }; -void TextClass::readCharStyle(Lexer & lexrc, string const & name) +void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name) { keyword_item elementTags[] = { - { "end", CS_END }, - { "font", CS_FONT }, - { "labelfont", CS_LABELFONT }, - { "latexname", CS_LATEXNAME }, - { "latexparam", CS_LATEXPARAM }, - { "latextype", CS_LATEXTYPE }, - { "preamble", CS_PREAMBLE} + { "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 } }; - lexrc.pushTable(elementTags, CS_END); + lexrc.pushTable(elementTags, IL_END); + 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; + 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()) { @@ -627,53 +680,109 @@ void TextClass::readCharStyle(Lexer & lexrc, string const & name) continue; default: break; } - switch (static_cast(le)) { - case CS_LATEXTYPE: + switch (static_cast(le)) { + case IL_LYXTYPE: + lexrc.next(); + lyxtype = lexrc.getString(); + break; + case IL_LATEXTYPE: lexrc.next(); latextype = lexrc.getString(); break; - case CS_LATEXNAME: + 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 CS_LATEXPARAM: + case IL_LATEXPARAM: lexrc.next(); latexparam = subst(lexrc.getString(), """, "\""); break; - case CS_LABELFONT: - labelfont.lyxRead(lexrc); + 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 CS_FONT: - font.lyxRead(lexrc); + case IL_FONT: + font = lyxRead(lexrc, inherit_font); + // So: define font before labelfont labelfont = font; break; - case CS_PREAMBLE: + case IL_BGCOLOR: { + lexrc.next(); + string const token = lexrc.getString(); + bgcolor = lcolor.getFromLyXName(token); + break; + } + case IL_PREAMBLE: preamble = lexrc.getLongString("EndPreamble"); break; - case CS_END: + case IL_END: getout = true; break; } } - // // Here add element to list if getout == true if (getout) { - CharStyle cs; - cs.name = name; - cs.latextype = latextype; - cs.latexname = latexname; - cs.latexparam = latexparam; - cs.font = font; - cs.labelfont = labelfont; - cs.preamble = from_utf8(preamble); - charstyles().push_back(cs); + 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; + insetlayoutlist_[name] = il; } lexrc.popTable(); } + enum FloatTags { FT_TYPE = 1, FT_NAME, @@ -709,7 +818,7 @@ void TextClass::readFloat(Lexer & lexrc) string within; string style; string name; - string listname; + string listName; bool builtin = false; bool getout = false; @@ -725,8 +834,16 @@ void TextClass::readFloat(Lexer & lexrc) case FT_TYPE: lexrc.next(); type = lexrc.getString(); - // Here we could check if this type is already defined - // and modify it with the rest of the vars instead. + if (floatlist_->typeExist(type)) { + Floating const & fl = floatlist_->getType(type); + placement = fl.placement(); + ext = fl.ext(); + within = fl.within(); + style = fl.style(); + name = fl.name(); + listName = fl.listName(); + builtin = fl.builtin(); + } break; case FT_NAME: lexrc.next(); @@ -752,7 +869,7 @@ void TextClass::readFloat(Lexer & lexrc) break; case FT_LISTNAME: lexrc.next(); - listname = lexrc.getString(); + listName = lexrc.getString(); break; case FT_BUILTIN: lexrc.next(); @@ -766,9 +883,12 @@ void TextClass::readFloat(Lexer & lexrc) // Here if have a full float if getout == true if (getout) { - Floating newfloat(type, placement, ext, within, - style, name, listname, builtin); - floatlist_->newFloat(newfloat); + Floating fl(type, placement, ext, within, + style, name, listName, builtin); + floatlist_->newFloat(fl); + // each float has its own counter + counters_->newCounter(from_ascii(type), from_ascii(within), + docstring(), docstring()); } lexrc.popTable(); @@ -778,6 +898,8 @@ void TextClass::readFloat(Lexer & lexrc) enum CounterTags { CT_NAME = 1, CT_WITHIN, + CT_LABELSTRING, + CT_LABELSTRING_APPENDIX, CT_END }; @@ -785,6 +907,8 @@ void TextClass::readCounter(Lexer & lexrc) { keyword_item counterTags[] = { { "end", CT_END }, + { "labelstring", CT_LABELSTRING }, + { "labelstringappendix", CT_LABELSTRING_APPENDIX }, { "name", CT_NAME }, { "within", CT_WITHIN } }; @@ -793,6 +917,8 @@ void TextClass::readCounter(Lexer & lexrc) docstring name; docstring within; + docstring labelstring; + docstring labelstring_appendix; bool getout = false; while (!getout && lexrc.isOK()) { @@ -806,14 +932,31 @@ void TextClass::readCounter(Lexer & lexrc) switch (static_cast(le)) { case CT_NAME: lexrc.next(); - name = from_ascii(lexrc.getString()); + name = lexrc.getDocString(); + if (counters_->hasCounter(name)) + LYXERR(Debug::TCLASS) + << "Reading existing counter " + << to_utf8(name) << endl; + else + LYXERR(Debug::TCLASS) + << "Reading new counter " + << to_utf8(name) << endl; break; case CT_WITHIN: lexrc.next(); - within = from_ascii(lexrc.getString()); + 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; @@ -821,38 +964,35 @@ void TextClass::readCounter(Lexer & lexrc) } // Here if have a full counter if getout == true - if (getout) { - if (within.empty()) - ctrs_->newCounter(name); - else - ctrs_->newCounter(name, within); - } + if (getout) + counters_->newCounter(name, within, + labelstring, labelstring_appendix); lexrc.popTable(); } -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_; } -bool TextClass::hasLayout(string const & n) const +bool TextClass::hasLayout(docstring const & n) const { - string const name = (n.empty() ? defaultLayoutName() : n); + docstring const name = n.empty() ? defaultLayoutName() : n; return find_if(layoutlist_.begin(), layoutlist_.end(), LayoutNamesEqual(name)) @@ -861,7 +1001,7 @@ bool TextClass::hasLayout(string const & n) const -Layout_ptr const & TextClass::operator[](string const & name) const +LayoutPtr const & TextClass::operator[](docstring const & name) const { BOOST_ASSERT(!name.empty()); @@ -871,23 +1011,22 @@ Layout_ptr const & TextClass::operator[](string const & name) const LayoutNamesEqual(name)); if (cit == layoutlist_.end()) { - lyxerr << "We failed to find the layout '" << name + 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 << " " << it->get()->name() << endl; + lyxerr << " " << to_utf8(it->get()->name()) << endl; // we require the name to exist BOOST_ASSERT(false); } - return (*cit); + return *cit; } - -bool TextClass::delete_layout(string const & name) +bool TextClass::deleteLayout(docstring const & name) { if (name == defaultLayoutName()) return false; @@ -913,7 +1052,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; @@ -943,30 +1082,45 @@ FloatList const & TextClass::floats() const Counters & TextClass::counters() const { - return *ctrs_.get(); + return *counters_.get(); } -CharStyles::iterator TextClass::charstyle(string const & s) const +// 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 { - CharStyles::iterator cs = charstyles().begin(); - CharStyles::iterator csend = charstyles().end(); - for (; cs != csend; ++cs) { - if (cs->name == s) - return cs; + docstring n = name; + while (!n.empty()) { + if (insetlayoutlist_.count(n) > 0) + return insetlayoutlist_[n]; + docstring::size_type i = n.find(':'); + if (i == string::npos) + break; + n = n.substr(0,i); } - return csend; + static InsetLayout empty; + empty.labelstring = from_utf8("UNDEFINED"); + empty.labelfont = sane_font; + empty.labelfont.setColor(Color_error); + empty.bgcolor = Color_error; + return empty; } -string const & TextClass::defaultLayoutName() const +docstring const & TextClass::defaultLayoutName() const { // This really should come from the actual layout... (Lgb) return defaultlayout_; } -Layout_ptr const & TextClass::defaultLayout() const +LayoutPtr const & TextClass::defaultLayout() const { return operator[](defaultLayoutName()); } @@ -1027,7 +1181,7 @@ docstring const & TextClass::preamble() const } -TextClass::PageSides TextClass::sides() const +PageSides TextClass::sides() const { return sides_; } @@ -1063,7 +1217,7 @@ unsigned int TextClass::columns() const } -LYX_TITLE_LATEX_TYPES TextClass::titletype() const +TitleLatexType TextClass::titletype() const { return titletype_; } @@ -1099,13 +1253,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; }