X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=9cf75a7669debf447b09e46b512a6c7b877954f6;hb=04e6076ebb889a3215eaa4ff5cb200822611185c;hp=740a4c336b5c703190e48e0830a522c7fe4ad446;hpb=b2475f6625efbaacbd574d5b9a2402b4d20c4047;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index 740a4c336b..9cf75a7669 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -3,11 +3,11 @@ * 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. */ @@ -16,6 +16,7 @@ #include "TextClass.h" +#include "LayoutFile.h" #include "Color.h" #include "Counters.h" #include "Floating.h" @@ -23,49 +24,66 @@ #include "Layout.h" #include "Lexer.h" #include "Font.h" +#include "ModuleList.h" #include "frontends/alert.h" +#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 "support/lstrings.h" #include "support/os.h" +#include +#include #include +#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 { +class LayoutNamesEqual : public unary_function { 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_; }; -int const FORMAT = 6; - - bool layout2layout(FileName const & filename, FileName const & tempfile) { FileName const script = libFileSearch("scripts", "layout2layout.py"); if (script.empty()) { - lyxerr << "Could not find layout conversion " - "script layout2layout.py." << endl; + LYXERR0("Could not find layout conversion " + "script layout2layout.py."); return false; } @@ -77,18 +95,16 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) LYXERR(Debug::TCLASS, "Running `" << command_str << '\''); - cmd_ret const ret = - runCommand(command_str); + cmd_ret const ret = runCommand(command_str); if (ret.first != 0) { - lyxerr << "Could not run layout conversion " - "script layout2layout.py." << endl; + LYXERR0("Could not run layout conversion script layout2layout.py."); return false; } return true; } -std::string translateRT(TextClass::ReadType rt) +string translateReadType(TextClass::ReadType rt) { switch (rt) { case TextClass::BASECLASS: @@ -97,6 +113,8 @@ std::string translateRT(TextClass::ReadType rt) return "input file"; case TextClass::MODULE: return "module file"; + case TextClass::VALIDATION: + return "validation"; } // shutup warning return string(); @@ -105,14 +123,24 @@ std::string translateRT(TextClass::ReadType rt) } // 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) +// This string should not be translated here, +// because it is a layout identifier. +docstring const TextClass::plain_layout_ = from_ascii("Plain Layout"); + + +InsetLayout DocumentClass::plain_insetlayout_; + + +///////////////////////////////////////////////////////////////////////// +// +// TextClass +// +///////////////////////////////////////////////////////////////////////// + +TextClass::TextClass() { - modular_ = false; outputType_ = LATEX; + outputFormat_ = "latex"; columns_ = 1; sides_ = OneSide; secnumdepth_ = 3; @@ -124,47 +152,34 @@ TextClass::TextClass(string const & fn, string const & cln, titletype_ = TITLE_COMMAND_AFTER; titlename_ = "maketitle"; loaded_ = false; - // a hack to make this available for translation - // i'm sure there must be a better way (rgh) - _("PlainLayout"); -} - - -docstring const TextClass::emptylayout_ = from_ascii("PlainLayout"); - - -InsetLayout TextClass::empty_insetlayout_; - - -bool TextClass::isTeXClassAvailable() const -{ - return texClassAvail_; + _("Plain Layout"); // a hack to make this translatable } -bool TextClass::readStyle(Lexer & lexrc, Layout & lay) +bool TextClass::readStyle(Lexer & lexrc, Layout & lay) const { LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name())); if (!lay.read(lexrc, *this)) { - lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl; + LYXERR0("Error parsing style `" << to_utf8(lay.name()) << '\''); return false; } // Resolve fonts lay.resfont = lay.font; - lay.resfont.realize(defaultfont()); + lay.resfont.realize(defaultfont_); lay.reslabelfont = lay.labelfont; - lay.reslabelfont.realize(defaultfont()); + lay.reslabelfont.realize(defaultfont_); return true; // no errors } enum TextClassTags { TC_OUTPUTTYPE = 1, + TC_OUTPUTFORMAT, TC_INPUT, TC_STYLE, + TC_IFSTYLE, TC_DEFAULTSTYLE, TC_INSETLAYOUT, - TC_ENVIRONMENT, TC_NOSTYLE, TC_COLUMNS, TC_SIDES, @@ -174,91 +189,174 @@ enum TextClassTags { 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_FORMAT, + TC_ADDTOPREAMBLE, + TC_ADDTOHTMLPREAMBLE, + TC_DEFAULTMODULE, + TC_PROVIDESMODULE, + TC_EXCLUDESMODULE, + TC_HTMLTOCSECTION, + TC_CITEFORMAT }; -// Reads a textclass structure from file. -bool TextClass::read(FileName const & filename, ReadType rt) +namespace { + + LexerKeyword textClassTags[] = { + { "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 " << LAYOUT_FORMAT); + FileName const tempfile = FileName::tempName("convert_layout"); + bool success = layout2layout(filename, tempfile); + if (success) + success = readWithoutConv(tempfile, rt) == OK; + tempfile.removeFile(); + return success; +} + + +TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, ReadType rt) { if (!filename.isReadableFile()) { lyxerr << "Cannot read layout file `" << filename << "'." << endl; - return false; + return ERROR; } - keyword_item textClassTags[] = { - { "classoptions", TC_CLASSOPTIONS }, - { "columns", TC_COLUMNS }, - { "counter", TC_COUNTER }, - { "defaultfont", TC_DEFAULTFONT }, - { "defaultstyle", TC_DEFAULTSTYLE }, - { "environment", TC_ENVIRONMENT }, - { "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 } - }; - - LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " + - to_utf8(makeDisplayPath(filename.absFilename()))); + LYXERR(Debug::TCLASS, "Reading " + translateReadType(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) { - 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(boost::shared_ptr(new Layout(lay))); + if (rt == BASECLASS && !hasLayout(plain_layout_)) + layoutlist_.push_back(createBasicLayout(plain_layout_)); + + Lexer lexrc(textClassTags); + lexrc.setFile(filename); + ReturnValues retval = read(lexrc, rt); + + LYXERR(Debug::TCLASS, "Finished reading " + translateReadType(rt) + ": " + + to_utf8(makeDisplayPath(filename.absFileName()))); + + 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) { + LYXERR0 ("Unable to convert " << filename << + " to format " << LAYOUT_FORMAT); + return false; } + return true; +} - Lexer lexrc(textClassTags, - sizeof(textClassTags) / sizeof(textClassTags[0])); - lexrc.setFile(filename); - bool error = !lexrc.isOK(); +bool TextClass::validate(std::string const & str) +{ + TextClass tc; + return tc.read(str, VALIDATION); +} + + +bool TextClass::read(std::string const & str, ReadType rt) +{ + Lexer lexrc(textClassTags); + istringstream is(str); + lexrc.setStream(is); + ReturnValues retval = read(lexrc, rt); + + if (retval != FORMAT_MISMATCH) + return retval == OK; + + // write the layout string to a temporary file + FileName const tempfile = FileName::tempName("TextClass_read"); + ofstream os(tempfile.toFilesystemEncoding().c_str()); + if (!os) { + LYXERR0("Unable to create temporary file"); + return false; + } + os << str; + os.close(); + + // now try to convert it + bool const worx = convertLayoutFormat(tempfile, rt); + if (!worx) { + LYXERR0("Unable to convert internal layout information to format " + << LAYOUT_FORMAT); + } + tempfile.removeFile(); + return worx; +} + + +// Reads a textclass structure from file. +TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) +{ + 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) { @@ -277,6 +375,10 @@ bool TextClass::read(FileName const & filename, ReadType rt) break; } + // used below to track whether we are in an IfStyle or IfCounter tag. + bool ifstyle = false; + bool ifcounter = false; + switch (static_cast(le)) { case TC_FORMAT: @@ -284,8 +386,24 @@ bool TextClass::read(FileName const & filename, ReadType rt) 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 @@ -298,8 +416,7 @@ bool TextClass::read(FileName const & filename, ReadType rt) 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; } } @@ -313,48 +430,52 @@ bool TextClass::read(FileName const & filename, ReadType rt) } break; - case TC_ENVIRONMENT: - 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; - //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); - } else { - Layout lay; - lay.setName(name); - if (le == TC_ENVIRONMENT) - lay.is_environment = true; - error = !readStyle(lexrc, lay); - if (!error) - layoutlist_.push_back(boost::shared_ptr(new Layout(lay))); - - 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); + 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 lay; - //readStyle(lexrc, lay); - //as above... - lexrc.printError("No name given for style: `$$Token'."); - error = true; + // 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_NOSTYLE: if (lexrc.next()) { @@ -419,6 +540,22 @@ bool TextClass::read(FileName const & filename, ReadType rt) 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(); @@ -438,6 +575,35 @@ bool TextClass::read(FileName const & filename, ReadType rt) break; } + 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(); + // 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; + } + case TC_LEFTMARGIN: // left margin type if (lexrc.next()) leftmargin_ = lexrc.getDocString(); @@ -448,22 +614,66 @@ bool TextClass::read(FileName const & filename, ReadType rt) 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); InsetLayout il; - if (il.read(lexrc)) { - insetlayoutlist_[il.name()] = il; - } - // else there was an error, so forget it + // Since we couldn't read the name, we just scan the rest + // of the style and discard it. + il.read(lexrc, *this); + // Let's try to continue rather than abort. + // error = true; + } else if (hasInsetLayout(name)) { + InsetLayout & il = insetlayoutlist_[name]; + error = !il.read(lexrc, *this); + } else { + InsetLayout il; + il.setName(name); + error = !il.read(lexrc, *this); + if (!error) + insetlayoutlist_[name] = il; } break; + } case TC_FLOAT: - readFloat(lexrc); + error = !readFloat(lexrc); + break; + + case TC_CITEFORMAT: + readCiteFormat(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: @@ -478,60 +688,51 @@ bool TextClass::read(FileName const & filename, ReadType rt) case TC_NOFLOAT: if (lexrc.next()) { string const nofloat = lexrc.getString(); - floatlist_->erase(nofloat); + floatlist_.erase(nofloat); } break; - } - - //Note that this is triggered the first time through the loop unless - //we hit a format tag. - if (format != FORMAT) - break; - } + } // end of switch - if (format != FORMAT) { - 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); - tempfile.removeFile(); - return !error; + // Note that this is triggered the first time through the loop unless + // we hit a format tag. + if (format != LAYOUT_FORMAT) + return FORMAT_MISMATCH; } - LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " + - to_utf8(makeDisplayPath(filename.absFilename()))); + // at present, we abort if we encounter an error, + // so there is no point continuing. + if (error) + return ERROR; - if (rt != BASECLASS) - return !error; + if (rt != BASECLASS) + return (error ? ERROR : OK); if (defaultlayout_.empty()) { - lyxerr << "Error: Textclass '" << name_ - << "' is missing a defaultstyle." << endl; - error = true; + LYXERR0("Error: Textclass '" << name_ + << "' is missing a defaultstyle."); + return ERROR; } - //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. + // 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"), + 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; } @@ -539,8 +740,10 @@ bool TextClass::read(FileName const & filename, ReadType rt) min_toclevel_ = Layout::NOT_IN_TOC; max_toclevel_ = Layout::NOT_IN_TOC; - for (size_t i = 0; i != layoutCount(); ++i) { - int const toclevel = layout(i)->toclevel; + 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; @@ -552,32 +755,30 @@ bool TextClass::read(FileName const & filename, ReadType rt) LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_ << ", maximum is " << max_toclevel_); - return !error; + return (error ? ERROR : OK); } void TextClass::readTitleType(Lexer & lexrc) { - keyword_item titleTypeTags[] = { + LexerKeyword titleTypeTags[] = { { "commandafter", TITLE_COMMAND_AFTER }, - { "environment", TITLE_ENVIRONMENT } + { "environment", TITLE_ENVIRONMENT } }; - PushPopHelper pph(lexrc, titleTypeTags, TITLE_ENVIRONMENT); + PushPopHelper pph(lexrc, titleTypeTags); int le = lexrc.lex(); switch (le) { case Lexer::LEX_UNDEF: lexrc.printError("Unknown output type `$$Token'"); - return; + break; case TITLE_COMMAND_AFTER: case TITLE_ENVIRONMENT: titletype_ = static_cast(le); break; default: - lyxerr << "Unhandled value " << le - << " in TextClass::readTitleType." << endl; - + LYXERR0("Unhandled value " << le << " in TextClass::readTitleType."); break; } } @@ -585,13 +786,13 @@ void TextClass::readTitleType(Lexer & lexrc) void TextClass::readOutputType(Lexer & lexrc) { - keyword_item outputTypeTags[] = { - { "docbook", DOCBOOK }, - { "latex", LATEX }, + LexerKeyword outputTypeTags[] = { + { "docbook", DOCBOOK }, + { "latex", LATEX }, { "literate", LITERATE } }; - PushPopHelper pph(lexrc, outputTypeTags, LITERATE); + PushPopHelper pph(lexrc, outputTypeTags); int le = lexrc.lex(); switch (le) { @@ -604,34 +805,31 @@ void TextClass::readOutputType(Lexer & lexrc) outputType_ = static_cast(le); break; default: - lyxerr << "Unhandled value " << le - << " in TextClass::readOutputType." << endl; - + LYXERR0("Unhandled value " << le); break; } } -enum ClassOptionsTags { - CO_FONTSIZE = 1, - CO_PAGESTYLE, - CO_OTHER, - CO_HEADER, - CO_END -}; - - void TextClass::readClassOptions(Lexer & lexrc) { - keyword_item classOptionsTags[] = { - {"end", CO_END }, - {"fontsize", CO_FONTSIZE }, - {"header", CO_HEADER }, - {"other", CO_OTHER }, + enum { + CO_FONTSIZE = 1, + CO_PAGESTYLE, + CO_OTHER, + CO_HEADER, + CO_END + }; + + LexerKeyword classOptionsTags[] = { + {"end", CO_END }, + {"fontsize", CO_FONTSIZE }, + {"header", CO_HEADER }, + {"other", CO_OTHER }, {"pagestyle", CO_PAGESTYLE } }; - lexrc.pushTable(classOptionsTags, CO_END); + lexrc.pushTable(classOptionsTags); bool getout = false; while (!getout && lexrc.isOK()) { int le = lexrc.lex(); @@ -639,9 +837,10 @@ void TextClass::readClassOptions(Lexer & lexrc) case Lexer::LEX_UNDEF: lexrc.printError("Unknown ClassOption tag `$$Token'"); continue; - default: break; + default: + break; } - switch (static_cast(le)) { + switch (le) { case CO_FONTSIZE: lexrc.next(); opt_fontsize_ = rtrim(lexrc.getString()); @@ -652,7 +851,10 @@ void TextClass::readClassOptions(Lexer & lexrc) 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(); @@ -667,43 +869,79 @@ void TextClass::readClassOptions(Lexer & lexrc) } -enum FloatTags { - FT_TYPE = 1, - FT_NAME, - FT_PLACEMENT, - FT_EXT, - FT_WITHIN, - FT_STYLE, - FT_LISTNAME, - FT_BUILTIN, - FT_END -}; +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; + } +} -void TextClass::readFloat(Lexer & lexrc) +bool TextClass::readFloat(Lexer & lexrc) { - keyword_item floatTags[] = { + enum { + FT_TYPE = 1, + FT_NAME, + FT_PLACEMENT, + FT_EXT, + FT_WITHIN, + FT_STYLE, + FT_LISTNAME, + FT_NEEDSFLOAT, + FT_HTMLSTYLE, + FT_HTMLATTR, + FT_HTMLTAG, + FT_LISTCOMMAND, + FT_REFPREFIX, + FT_END + }; + + LexerKeyword floatTags[] = { { "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, FT_END); + 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()) { @@ -712,21 +950,24 @@ void TextClass::readFloat(Lexer & lexrc) case Lexer::LEX_UNDEF: lexrc.printError("Unknown float tag `$$Token'"); continue; - default: break; + default: + break; } - switch (static_cast(le)) { + switch (le) { case FT_TYPE: lexrc.next(); type = lexrc.getString(); - if (floatlist_->typeExist(type)) { - Floating const & fl = floatlist_->getType(type); + 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(); + listname = fl.listName(); + needsfloat = fl.needsFloatPkg(); + listcommand = fl.listCommand(); + refprefix = fl.refPrefix(); } break; case FT_NAME: @@ -751,126 +992,73 @@ void TextClass::readFloat(Lexer & lexrc) lexrc.next(); style = lexrc.getString(); break; - case FT_LISTNAME: + case FT_LISTCOMMAND: lexrc.next(); - listName = lexrc.getString(); + listcommand = lexrc.getString(); break; - case FT_BUILTIN: + case FT_REFPREFIX: lexrc.next(); - builtin = lexrc.getBool(); + refprefix = lexrc.getString(); break; - case FT_END: - getout = true; + case FT_LISTNAME: + lexrc.next(); + listname = lexrc.getString(); break; - } - } - - // Here if have a full float if getout == true - if (getout) { - 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(); -} - - -enum CounterTags { - CT_NAME = 1, - CT_WITHIN, - CT_LABELSTRING, - CT_LABELSTRING_APPENDIX, - CT_END -}; - - -void TextClass::readCounter(Lexer & lexrc) -{ - keyword_item counterTags[] = { - { "end", CT_END }, - { "labelstring", CT_LABELSTRING }, - { "labelstringappendix", CT_LABELSTRING_APPENDIX }, - { "name", CT_NAME }, - { "within", CT_WITHIN } - }; - - lexrc.pushTable(counterTags, CT_END); - - 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 (static_cast(le)) { - case CT_NAME: + case FT_NEEDSFLOAT: 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)); + needsfloat = lexrc.getBool(); break; - case CT_WITHIN: + case FT_HTMLATTR: lexrc.next(); - within = lexrc.getDocString(); - if (within == "none") - within.erase(); + htmlattr = lexrc.getString(); break; - case CT_LABELSTRING: + case FT_HTMLSTYLE: lexrc.next(); - labelstring = lexrc.getDocString(); - labelstring_appendix = labelstring; + htmlstyle = lexrc.getLongString("EndHTMLStyle"); break; - case CT_LABELSTRING_APPENDIX: + case FT_HTMLTAG: lexrc.next(); - labelstring_appendix = lexrc.getDocString(); + htmltag = lexrc.getString(); break; - case CT_END: + case FT_END: getout = true; break; } } - // Here if have a full counter if getout == true - if (getout) - counters_->newCounter(name, within, - labelstring, labelstring_appendix); - lexrc.popTable(); -} - -FontInfo const & TextClass::defaultfont() const -{ - return defaultfont_; -} - - -docstring const & TextClass::leftmargin() const -{ - return leftmargin_; + // Here we have a full float if getout == true + if (getout) { + 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), + docstring(), docstring()); + // also define sub-float counters + docstring const subtype = "sub-" + from_ascii(type); + counters_.newCounter(subtype, from_ascii(type), + "\\alph{" + subtype + "}", docstring()); + } + return getout; } -docstring const & TextClass::rightmargin() const -{ - return rightmargin_; +string const & TextClass::prerequisites() const +{ + if (contains(prerequisites_, ',')) { + vector 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; @@ -881,35 +1069,64 @@ bool TextClass::hasLayout(docstring const & n) const } +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; +} -LayoutPtr const & TextClass::operator[](docstring const & name) const + +Layout const & TextClass::operator[](docstring const & name) const { - BOOST_ASSERT(!name.empty()); + LASSERT(!name.empty(), /**/); - LayoutList::const_iterator cit = - find_if(layoutlist_.begin(), - layoutlist_.end(), - LayoutNamesEqual(name)); + const_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 + LASSERT(false, /**/); + } + + return *it; +} + + +Layout & TextClass::operator[](docstring const & name) +{ + LASSERT(!name.empty(), /**/); + + iterator it = find_if(begin(), end(), LayoutNamesEqual(name)); + + if (it == end()) { + LYXERR0("We failed to find the layout '" << to_utf8(name) + << "' in the layout list. You MUST investigate!"); + for (const_iterator cit = begin(); cit != end(); ++cit) + LYXERR0(" " << to_utf8(cit->name())); // we require the name to exist - BOOST_ASSERT(false); + LASSERT(false, /**/); } - return *cit; + return *it; } bool TextClass::deleteLayout(docstring const & name) { - if (name == defaultLayoutName() || name == emptyLayoutName()) + if (name == defaultLayoutName() || name == plainLayoutName()) return false; LayoutList::iterator it = @@ -930,8 +1147,9 @@ bool TextClass::load(string const & path) const return true; // Read style-file, provided path is searched before the system ones - FileName layout_file; - if (!path.empty()) + // If path is a file, it is loaded directly. + FileName layout_file(path); + if (!path.empty() && !layout_file.isReadableFile()) layout_file = FileName(addName(path, name_ + ".layout")); if (layout_file.empty() || !layout_file.exists()) layout_file = libFileSearch("layouts", name_, "layout"); @@ -939,53 +1157,40 @@ bool TextClass::load(string const & path) const 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_; } -FloatList & TextClass::floats() -{ - return *floatlist_.get(); -} - - -FloatList const & TextClass::floats() const -{ - return *floatlist_.get(); -} - - -Counters & TextClass::counters() const +void DocumentClass::addLayoutIfNeeded(docstring const & n) const { - return *counters_.get(); + if (!hasLayout(n)) + layoutlist_.push_back(createBasicLayout(n, true)); } -// 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 { + // FIXME The fix for the InsetLayout part of 4812 would be here: + // Add the InsetLayout to the document class if it is not found. docstring n = name; + InsetLayouts::const_iterator cen = insetlayoutlist_.end(); while (!n.empty()) { - if (insetlayoutlist_.count(n) > 0) - return insetlayoutlist_[n]; + InsetLayouts::const_iterator cit = insetlayoutlist_.lower_bound(n); + if (cit != cen && cit->first == n) + return cit->second; 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_; } @@ -996,165 +1201,207 @@ docstring const & TextClass::defaultLayoutName() const } -LayoutPtr const & TextClass::defaultLayout() const +Layout const & TextClass::defaultLayout() const { return operator[](defaultLayoutName()); } -string const & TextClass::name() const +bool TextClass::isDefaultLayout(Layout const & layout) const { - return name_; + return layout.name() == defaultLayoutName(); } -string const & TextClass::latexname() const +bool TextClass::isPlainLayout(Layout const & layout) const { - // No buffer path information is needed here because on-demand layout files - // have already been loaded, and no path is needed for system layouts. - const_cast(this)->load(); - return latexname_; + return layout.name() == plainLayoutName(); } -string const & TextClass::description() const +Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const { - return description_; -} + static Layout * defaultLayout = NULL; + if (defaultLayout) { + defaultLayout->setUnknown(unknown); + defaultLayout->setName(name); + return *defaultLayout; + } -string const & TextClass::opt_fontsize() const -{ - return opt_fontsize_; + 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); + lex.setStream(ss); + defaultLayout = new Layout; + defaultLayout->setUnknown(unknown); + defaultLayout->setName(name); + if (!readStyle(lex, *defaultLayout)) { + // The only way this happens is because the hardcoded layout above + // is wrong. + LASSERT(false, /**/); + }; + return *defaultLayout; } -string const & TextClass::opt_pagestyle() const -{ - return opt_pagestyle_; -} - +///////////////////////////////////////////////////////////////////////// +// +// DocumentClassBundle +// +///////////////////////////////////////////////////////////////////////// -string const & TextClass::options() const +DocumentClassBundle::~DocumentClassBundle() { - return options_; + for (size_t i = 0; i != documentClasses_.size(); ++i) + delete documentClasses_[i]; + documentClasses_.clear(); } - -string const & TextClass::class_header() const +DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass) { - return class_header_; + DocumentClass * dc = new DocumentClass(baseClass); + documentClasses_.push_back(dc); + return *documentClasses_.back(); } -string const & TextClass::pagestyle() const +DocumentClassBundle & DocumentClassBundle::get() { - return pagestyle_; + static DocumentClassBundle singleton; + return singleton; } -docstring const & TextClass::preamble() const +DocumentClass & DocumentClassBundle::makeDocumentClass( + LayoutFile const & baseClass, LayoutModuleList const & modlist) { - return preamble_; + 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)); + frontend::Alert::warning(_("Module not available"), msg); + 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)); + 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)); + frontend::Alert::warning(_("Read Error"), msg); + } + } + return doc_class; } -PageSides TextClass::sides() const -{ - return sides_; -} +///////////////////////////////////////////////////////////////////////// +// +// DocumentClass +// +///////////////////////////////////////////////////////////////////////// +DocumentClass::DocumentClass(LayoutFile const & tc) + : TextClass(tc) +{} -int TextClass::secnumdepth() const -{ - return secnumdepth_; -} - -int TextClass::tocdepth() const -{ - return tocdepth_; -} - - -OutputType TextClass::outputType() const +bool DocumentClass::hasLaTeXLayout(std::string const & lay) const { - return outputType_; + LayoutList::const_iterator it = layoutlist_.begin(); + LayoutList::const_iterator end = layoutlist_.end(); + for (; it != end; ++it) + if (it->latexname() == lay) + return true; + return false; } -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; } -TextClassPtr TextClassBundle::newClass(TextClass const & baseClass) +Layout const & DocumentClass::htmlTOCLayout() const { - TextClass * tc = new TextClass(baseClass); - tc_list_.push_back(tc); - return tc; + 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_); } -TextClassBundle & TextClassBundle::get() +string const & DocumentClass::getCiteFormat(string const & entry_type) const { - static TextClassBundle singleton; - return singleton; + static string default_format = N_("{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!!}%journal%{!!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}."); + + map::const_iterator it = cite_formats_.find(entry_type); + if (it != cite_formats_.end()) + return it->second; + return default_format; } -TextClassBundle::~TextClassBundle() +string const & DocumentClass::getCiteMacro(string const & macro) const { - std::list::iterator it = tc_list_.begin(); - std::list::iterator end = tc_list_.end(); - for (; it != end; ++it) - delete *it; + static string empty; + map::const_iterator it = cite_macros_.find(macro); + if (it != cite_macros_.end()) + return it->second; + return empty; } +///////////////////////////////////////////////////////////////////////// +// +// PageSides +// +///////////////////////////////////////////////////////////////////////// + ostream & operator<<(ostream & os, PageSides p) { switch (p) {