X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=e5d84c82e1d5fd34d9239bb89fe98fd1a1a2c6d2;hb=1a48d5a96712c72879487542e3f1a7e61ce3f78c;hp=2b5f52f5e408d591de5e9c7d2ab12f57f355b5f6;hpb=cd27d171d5b94eb3345d4be435271030e015bdb6;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index 2b5f52f5e4..e5d84c82e1 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -24,12 +24,12 @@ #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" @@ -40,11 +40,28 @@ #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/tools/updatelayouts.sh script, to update the format of +// all of our layout files. +// +int const LAYOUT_FORMAT = 43; // spitz: extended InsetCaption format + namespace { class LayoutNamesEqual : public unary_function { @@ -60,8 +77,6 @@ private: docstring name_; }; -int const FORMAT = 12; - bool layout2layout(FileName const & filename, FileName const & tempfile) { @@ -89,7 +104,7 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) } -std::string translateRT(TextClass::ReadType rt) +string translateReadType(TextClass::ReadType rt) { switch (rt) { case TextClass::BASECLASS: @@ -108,7 +123,7 @@ std::string translateRT(TextClass::ReadType rt) } // namespace anon -// This string should not be translated here, +// This string should not be translated here, // because it is a layout identifier. docstring const TextClass::plain_layout_ = from_ascii("Plain Layout"); @@ -125,14 +140,17 @@ InsetLayout DocumentClass::plain_insetlayout_; TextClass::TextClass() { outputType_ = LATEX; + outputFormat_ = "latex"; columns_ = 1; sides_ = OneSide; secnumdepth_ = 3; tocdepth_ = 3; pagestyle_ = "default"; defaultfont_ = sane_font; + opt_enginetype_ = "authoryear|numerical"; opt_fontsize_ = "10|11|12"; opt_pagestyle_ = "empty|plain|headings|fancy"; + cite_full_author_list_ = true; titletype_ = TITLE_COMMAND_AFTER; titlename_ = "maketitle"; loaded_ = false; @@ -158,8 +176,10 @@ bool TextClass::readStyle(Lexer & lexrc, Layout & lay) const enum TextClassTags { TC_OUTPUTTYPE = 1, + TC_OUTPUTFORMAT, TC_INPUT, TC_STYLE, + TC_IFSTYLE, TC_DEFAULTSTYLE, TC_INSETLAYOUT, TC_NOSTYLE, @@ -171,83 +191,133 @@ enum TextClassTags { TC_TOCDEPTH, TC_CLASSOPTIONS, TC_PREAMBLE, + TC_HTMLPREAMBLE, + TC_HTMLSTYLES, TC_PROVIDES, TC_REQUIRES, TC_LEFTMARGIN, TC_RIGHTMARGIN, TC_FLOAT, TC_COUNTER, + TC_NOCOUNTER, + TC_IFCOUNTER, TC_NOFLOAT, TC_TITLELATEXNAME, TC_TITLELATEXTYPE, TC_FORMAT, TC_ADDTOPREAMBLE, + TC_ADDTOHTMLPREAMBLE, + TC_ADDTOHTMLSTYLES, TC_DEFAULTMODULE, TC_PROVIDESMODULE, - TC_EXCLUDESMODULE + TC_EXCLUDESMODULE, + TC_HTMLTOCSECTION, + TC_CITEENGINE, + TC_CITEENGINETYPE, + TC_CITEFORMAT, + TC_DEFAULTBIBLIO, + TC_FULLAUTHORLIST, }; namespace { - LexerKeyword textClassTags[] = { - { "addtopreamble", TC_ADDTOPREAMBLE }, - { "classoptions", TC_CLASSOPTIONS }, - { "columns", TC_COLUMNS }, - { "counter", TC_COUNTER }, - { "defaultfont", TC_DEFAULTFONT }, - { "defaultmodule", TC_DEFAULTMODULE }, - { "defaultstyle", TC_DEFAULTSTYLE }, - { "excludesmodule", TC_EXCLUDESMODULE }, - { "float", TC_FLOAT }, - { "format", TC_FORMAT }, - { "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 }, - { "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 } - }; - +LexerKeyword textClassTags[] = { + { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE }, + { "addtohtmlstyles", TC_ADDTOHTMLSTYLES }, + { "addtopreamble", TC_ADDTOPREAMBLE }, + { "citeengine", TC_CITEENGINE }, + { "citeenginetype", TC_CITEENGINETYPE }, + { "citeformat", TC_CITEFORMAT }, + { "classoptions", TC_CLASSOPTIONS }, + { "columns", TC_COLUMNS }, + { "counter", TC_COUNTER }, + { "defaultbiblio", TC_DEFAULTBIBLIO }, + { "defaultfont", TC_DEFAULTFONT }, + { "defaultmodule", TC_DEFAULTMODULE }, + { "defaultstyle", TC_DEFAULTSTYLE }, + { "excludesmodule", TC_EXCLUDESMODULE }, + { "float", TC_FLOAT }, + { "format", TC_FORMAT }, + { "fullauthorlist", TC_FULLAUTHORLIST }, + { "htmlpreamble", TC_HTMLPREAMBLE }, + { "htmlstyles", TC_HTMLSTYLES }, + { "htmltocsection", TC_HTMLTOCSECTION }, + { "ifcounter", TC_IFCOUNTER }, + { "ifstyle", TC_IFSTYLE }, + { "input", TC_INPUT }, + { "insetlayout", TC_INSETLAYOUT }, + { "leftmargin", TC_LEFTMARGIN }, + { "nocounter", TC_NOCOUNTER }, + { "nofloat", TC_NOFLOAT }, + { "nostyle", TC_NOSTYLE }, + { "outputformat", TC_OUTPUTFORMAT }, + { "outputtype", TC_OUTPUTTYPE }, + { "pagestyle", TC_PAGESTYLE }, + { "preamble", TC_PREAMBLE }, + { "provides", TC_PROVIDES }, + { "providesmodule", TC_PROVIDESMODULE }, + { "requires", TC_REQUIRES }, + { "rightmargin", TC_RIGHTMARGIN }, + { "secnumdepth", TC_SECNUMDEPTH }, + { "sides", TC_SIDES }, + { "style", TC_STYLE }, + { "titlelatexname", TC_TITLELATEXNAME }, + { "titlelatextype", TC_TITLELATEXTYPE }, + { "tocdepth", TC_TOCDEPTH } +}; + } //namespace anon bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt) { - LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT); + LYXERR(Debug::TCLASS, "Converting layout file to " << LAYOUT_FORMAT); FileName const tempfile = FileName::tempName("convert_layout"); bool success = layout2layout(filename, tempfile); if (success) - success = read(tempfile, rt); + success = readWithoutConv(tempfile, rt) == OK; tempfile.removeFile(); return success; } -bool TextClass::read(FileName const & filename, ReadType rt) + +std::string TextClass::convert(std::string const & str) +{ + FileName const fn = FileName::tempName("locallayout"); + ofstream os(fn.toFilesystemEncoding().c_str()); + os << str; + os.close(); + FileName const tempfile = FileName::tempName("convert_locallayout"); + bool success = layout2layout(fn, tempfile); + if (!success) + return ""; + ifstream is(tempfile.toFilesystemEncoding().c_str()); + string ret; + string tmp; + while (!is.eof()) { + getline(is, tmp); + ret += tmp + '\n'; + } + is.close(); + tempfile.removeFile(); + return ret; +} + + +TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, ReadType rt) { if (!filename.isReadableFile()) { lyxerr << "Cannot read layout file `" << filename << "'." << endl; - return false; + return ERROR; } - LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " + - to_utf8(makeDisplayPath(filename.absFilename()))); + LYXERR(Debug::TCLASS, "Reading " + translateReadType(rt) + ": " + + to_utf8(makeDisplayPath(filename.absFileName()))); - // Define the plain layout used in table cells, ert, etc. Note that - // we do this before loading any layout file, so that classes can + // Define the plain layout used in table cells, ert, etc. Note that + // we do this before loading any layout file, so that classes can // override features of this layout if they should choose to do so. if (rt == BASECLASS && !hasLayout(plain_layout_)) layoutlist_.push_back(createBasicLayout(plain_layout_)); @@ -255,46 +325,51 @@ bool TextClass::read(FileName const & filename, ReadType rt) Lexer lexrc(textClassTags); lexrc.setFile(filename); ReturnValues retval = read(lexrc, rt); - - LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " + - to_utf8(makeDisplayPath(filename.absFilename()))); - - if (retval != FORMAT_MISMATCH) + + 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 " << FORMAT); - return false; - } - return true; + if (!worx) + LYXERR0 ("Unable to convert " << filename << + " to format " << LAYOUT_FORMAT); + return worx; } -bool TextClass::validate(std::string const & str) +TextClass::ReturnValues TextClass::validate(std::string const & str) { TextClass tc; return tc.read(str, VALIDATION); } -bool TextClass::read(std::string const & str, ReadType rt) +TextClass::ReturnValues 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; + if (retval != FORMAT_MISMATCH) + return retval; // 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; + return ERROR; } os << str; os.close(); @@ -302,21 +377,24 @@ bool TextClass::read(std::string const & str, ReadType rt) // now try to convert it bool const worx = convertLayoutFormat(tempfile, rt); if (!worx) { - LYXERR0("Unable to convert internal layout information to format " - << FORMAT); + LYXERR0("Unable to convert internal layout information to format " + << LAYOUT_FORMAT); + return ERROR; } tempfile.removeFile(); - return worx; + return OK_OLDFORMAT; } // Reads a textclass structure from file. -TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) +TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) { - bool error = !lexrc.isOK(); + 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) { @@ -335,6 +413,10 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, 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: @@ -342,8 +424,24 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, 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 @@ -356,8 +454,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, 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; } } @@ -371,6 +468,9 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } break; + case TC_IFSTYLE: + ifstyle = true; + // fall through case TC_STYLE: { if (!lexrc.next()) { lexrc.printError("No name given for style: `$$Token'."); @@ -382,7 +482,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) 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()); + lexrc.printError(s); Layout lay; // Since we couldn't read the name, we just scan the rest // of the style and discard it. @@ -390,7 +490,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } else if (hasLayout(name)) { Layout & lay = operator[](name); error = !readStyle(lexrc, lay); - } else { + } else if (!ifstyle) { Layout layout; layout.setName(name); error = !readStyle(lexrc, layout); @@ -403,6 +503,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) defaultlayout_ = name; } } + else { + // 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; } @@ -469,10 +578,30 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) preamble_ = from_utf8(lexrc.getLongString("EndPreamble")); break; + case TC_HTMLPREAMBLE: + htmlpreamble_ = from_utf8(lexrc.getLongString("EndPreamble")); + break; + + case TC_HTMLSTYLES: + htmlstyles_ = from_utf8(lexrc.getLongString("EndStyles")); + 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_ADDTOHTMLSTYLES: + htmlstyles_ += from_utf8(lexrc.getLongString("EndStyles")); + break; + case TC_PROVIDES: { lexrc.next(); string const feature = lexrc.getString(); @@ -486,7 +615,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) case TC_REQUIRES: { lexrc.eatLine(); - vector const req + vector const req = getVectorFromString(lexrc.getString()); requires_.insert(req.begin(), req.end()); break; @@ -541,12 +670,13 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) if (name.empty()) { string s = "Could not read name for InsetLayout: `$$Token' " + lexrc.getString() + " is probably not valid UTF-8!"; - lexrc.printError(s.c_str()); + lexrc.printError(s); InsetLayout il; // Since we couldn't read the name, we just scan the rest // of the style and discard it. il.read(lexrc, *this); - error = true; + // Let's try to continue rather than abort. + // error = true; } else if (hasInsetLayout(name)) { InsetLayout & il = insetlayoutlist_[name]; error = !il.read(lexrc, *this); @@ -561,9 +691,42 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } case TC_FLOAT: - readFloat(lexrc); + error = !readFloat(lexrc); + break; + + case TC_CITEENGINE: + error = !readCiteEngine(lexrc); break; + case TC_CITEENGINETYPE: + if (lexrc.next()) + opt_enginetype_ = rtrim(lexrc.getString()); + break; + + case TC_CITEFORMAT: + error = !readCiteFormat(lexrc); + break; + + case TC_DEFAULTBIBLIO: + if (lexrc.next()) + cite_default_biblio_style_ = rtrim(lexrc.getString()); + break; + + case TC_FULLAUTHORLIST: + if (lexrc.next()) + cite_full_author_list_ &= lexrc.getBool(); + break; + + case TC_NOCOUNTER: + if (lexrc.next()) { + docstring const cnt = lexrc.getDocString(); + if (!counters_.remove(cnt)) + LYXERR0("Unable to remove counter: " + to_utf8(cnt)); + } + break; + + case TC_IFCOUNTER: + ifcounter = true; case TC_COUNTER: if (lexrc.next()) { docstring const name = lexrc.getDocString(); @@ -576,12 +739,14 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) // and discard it. c.read(lexrc); } else - error = !counters_.read(lexrc, name); + 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: @@ -601,25 +766,27 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) break; } // end of switch - //Note that this is triggered the first time through the loop unless - //we hit a format tag. - if (format != FORMAT) - break; + // Note that this is triggered the first time through the loop unless + // we hit a format tag. + if (format != LAYOUT_FORMAT) + return FORMAT_MISMATCH; } - if (format != FORMAT) - return FORMAT_MISMATCH; + // at present, we abort if we encounter an error, + // so there is no point continuing. + if (error) + return ERROR; - if (rt != BASECLASS) + if (rt != BASECLASS) return (error ? ERROR : OK); if (defaultlayout_.empty()) { LYXERR0("Error: Textclass '" << name_ << "' is missing a defaultstyle."); - error = true; + return ERROR; } - - // Try to erase "stdinsets" from the provides_ set. + + // Try to erase "stdinsets" from the provides_ set. // The // Provides stdinsets 1 // declaration simply tells us that the standard insets have been @@ -634,11 +801,11 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) 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; } @@ -743,7 +910,8 @@ void TextClass::readClassOptions(Lexer & lexrc) case Lexer::LEX_UNDEF: lexrc.printError("Unknown ClassOption tag `$$Token'"); continue; - default: break; + default: + break; } switch (le) { case CO_FONTSIZE: @@ -756,7 +924,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(); @@ -771,7 +942,113 @@ void TextClass::readClassOptions(Lexer & lexrc) } -void TextClass::readFloat(Lexer & lexrc) +bool TextClass::readCiteEngine(Lexer & lexrc) +{ + int const type = readCiteEngineType(lexrc); + if (type & ENGINE_TYPE_AUTHORYEAR) + cite_styles_[ENGINE_TYPE_AUTHORYEAR].clear(); + if (type & ENGINE_TYPE_NUMERICAL) + cite_styles_[ENGINE_TYPE_NUMERICAL].clear(); + string def; + bool getout = false; + while (!getout && lexrc.isOK()) { + lexrc.eatLine(); + def = lexrc.getString(); + def = subst(def, " ", ""); + def = subst(def, "\t", ""); + if (compare_ascii_no_case(def, "end") == 0) { + getout = true; + continue; + } + string cmd; + CitationStyle cs; + char ichar = def[0]; + if (ichar == '#') + continue; + if (ichar == 'C') { + cs.forceUpperCase = true; + def[0] = 'c'; + } + + size_t const n = def.size(); + for (size_t i = 0; i != n; ++i) { + ichar = def[i]; + if (ichar == '*') + cs.fullAuthorList = true; + else if (ichar == '[' && cs.textAfter) + cs.textBefore = true; + else if (ichar == '[') + cs.textAfter = true; + else if (ichar != ']') + cmd += ichar; + } + + cs.cmd = cmd; + if (type & ENGINE_TYPE_AUTHORYEAR) + cite_styles_[ENGINE_TYPE_AUTHORYEAR].push_back(cs); + if (type & ENGINE_TYPE_NUMERICAL) + cite_styles_[ENGINE_TYPE_NUMERICAL].push_back(cs); + } + return getout; +} + + +int TextClass::readCiteEngineType(Lexer & lexrc) const +{ + int const ENGINE_TYPE_DEFAULT = + ENGINE_TYPE_AUTHORYEAR | ENGINE_TYPE_NUMERICAL; + if (!lexrc.next()) { + lexrc.printError("No cite engine type given for token: `$$Token'."); + return ENGINE_TYPE_DEFAULT; + } + string const type = rtrim(lexrc.getString()); + if (compare_ascii_no_case(type, "authoryear") == 0) + return ENGINE_TYPE_AUTHORYEAR; + else if (compare_ascii_no_case(type, "numerical") == 0) + return ENGINE_TYPE_NUMERICAL; + else if (compare_ascii_no_case(type, "default") != 0) { + string const s = "Unknown cite engine type `" + type + + "' given for token: `$$Token',"; + lexrc.printError(s); + } + return ENGINE_TYPE_DEFAULT; +} + + +bool TextClass::readCiteFormat(Lexer & lexrc) +{ + int const type = readCiteEngineType(lexrc); + string etype; + string definition; + while (lexrc.isOK()) { + lexrc.next(); + etype = lexrc.getString(); + if (compare_ascii_no_case(etype, "end") == 0) + break; + if (!lexrc.isOK()) + return false; + lexrc.eatLine(); + definition = lexrc.getString(); + char initchar = etype[0]; + if (initchar == '#') + continue; + if (initchar == '!' || initchar == '_') { + if (type & ENGINE_TYPE_AUTHORYEAR) + cite_macros_[ENGINE_TYPE_AUTHORYEAR][etype] = definition; + if (type & ENGINE_TYPE_NUMERICAL) + cite_macros_[ENGINE_TYPE_NUMERICAL][etype] = definition; + } else { + if (type & ENGINE_TYPE_AUTHORYEAR) + cite_formats_[ENGINE_TYPE_AUTHORYEAR][etype] = definition; + if (type & ENGINE_TYPE_NUMERICAL) + cite_formats_[ENGINE_TYPE_NUMERICAL][etype] = definition; + } + } + return true; +} + + +bool TextClass::readFloat(Lexer & lexrc) { enum { FT_TYPE = 1, @@ -781,7 +1058,13 @@ void TextClass::readFloat(Lexer & lexrc) FT_WITHIN, FT_STYLE, FT_LISTNAME, - FT_BUILTIN, + FT_USESFLOAT, + FT_PREDEFINED, + FT_HTMLSTYLE, + FT_HTMLATTR, + FT_HTMLTAG, + FT_LISTCOMMAND, + FT_REFPREFIX, FT_END }; @@ -789,24 +1072,36 @@ void TextClass::readFloat(Lexer & lexrc) { "end", FT_END }, { "extension", FT_EXT }, { "guiname", FT_NAME }, - { "latexbuiltin", FT_BUILTIN }, + { "htmlattr", FT_HTMLATTR }, + { "htmlstyle", FT_HTMLSTYLE }, + { "htmltag", FT_HTMLTAG }, + { "ispredefined", FT_PREDEFINED }, + { "listcommand", FT_LISTCOMMAND }, { "listname", FT_LISTNAME }, { "numberwithin", FT_WITHIN }, { "placement", FT_PLACEMENT }, + { "refprefix", FT_REFPREFIX }, { "style", FT_STYLE }, - { "type", FT_TYPE } + { "type", FT_TYPE }, + { "usesfloatpkg", FT_USESFLOAT } }; 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 usesfloat = true; + bool ispredefined = false; bool getout = false; while (!getout && lexrc.isOK()) { @@ -815,7 +1110,8 @@ void TextClass::readFloat(Lexer & lexrc) case Lexer::LEX_UNDEF: lexrc.printError("Unknown float tag `$$Token'"); continue; - default: break; + default: + break; } switch (le) { case FT_TYPE: @@ -828,9 +1124,12 @@ void TextClass::readFloat(Lexer & lexrc) within = fl.within(); style = fl.style(); name = fl.name(); - listName = fl.listName(); - builtin = fl.builtin(); - } + listname = fl.listName(); + usesfloat = fl.usesFloatPkg(); + ispredefined = fl.isPredefined(); + listcommand = fl.listCommand(); + refprefix = fl.refPrefix(); + } break; case FT_NAME: lexrc.next(); @@ -854,13 +1153,37 @@ void TextClass::readFloat(Lexer & lexrc) lexrc.next(); style = lexrc.getString(); break; + case FT_LISTCOMMAND: + lexrc.next(); + listcommand = lexrc.getString(); + break; + case FT_REFPREFIX: + lexrc.next(); + refprefix = lexrc.getString(); + break; case FT_LISTNAME: lexrc.next(); - listName = lexrc.getString(); + listname = lexrc.getString(); + break; + case FT_USESFLOAT: + lexrc.next(); + usesfloat = lexrc.getBool(); + break; + case FT_PREDEFINED: + lexrc.next(); + ispredefined = lexrc.getBool(); + break; + case FT_HTMLATTR: + lexrc.next(); + htmlattr = lexrc.getString(); + break; + case FT_HTMLSTYLE: + lexrc.next(); + htmlstyle = lexrc.getLongString("EndHTMLStyle"); break; - case FT_BUILTIN: + case FT_HTMLTAG: lexrc.next(); - builtin = lexrc.getBool(); + htmltag = lexrc.getString(); break; case FT_END: getout = true; @@ -868,10 +1191,30 @@ void TextClass::readFloat(Lexer & lexrc) } } - // Here if have a full float if getout == true + lexrc.popTable(); + + // Here we have a full float if getout == true if (getout) { - Floating fl(type, placement, ext, within, - style, name, listName, builtin); + if (!usesfloat && listcommand.empty()) { + // if this float uses the same auxfile as an existing one, + // there is no need for it to provide a list command. + FloatList::const_iterator it = floatlist_.begin(); + FloatList::const_iterator en = floatlist_.end(); + bool found_ext = false; + for (; it != en; ++it) { + if (it->second.ext() == ext) { + found_ext = true; + break; + } + } + if (!found_ext) + LYXERR0("The layout does not provide a list command " << + "for the 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, usesfloat, ispredefined); floatlist_.newFloat(fl); // each float has its own counter counters_.newCounter(from_ascii(type), from_ascii(within), @@ -881,8 +1224,17 @@ void TextClass::readFloat(Lexer & lexrc) counters_.newCounter(subtype, from_ascii(type), "\\alph{" + subtype + "}", docstring()); } + return getout; +} - lexrc.popTable(); + +string const & TextClass::prerequisites(string const & sep) const +{ + if (contains(prerequisites_, ',')) { + vector const pres = getVectorFromString(prerequisites_); + prerequisites_ = getStringFromVector(pres, sep); + } + return prerequisites_; } @@ -898,7 +1250,7 @@ bool TextClass::hasLayout(docstring const & n) const bool TextClass::hasInsetLayout(docstring const & n) const { - if (n.empty()) + if (n.empty()) return false; InsetLayouts::const_iterator it = insetlayoutlist_.begin(); InsetLayouts::const_iterator en = insetlayoutlist_.end(); @@ -913,7 +1265,7 @@ Layout const & TextClass::operator[](docstring const & name) const { LASSERT(!name.empty(), /**/); - const_iterator it = + const_iterator it = find_if(begin(), end(), LayoutNamesEqual(name)); if (it == end()) { @@ -984,24 +1336,28 @@ 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_; } -void DocumentClass::addLayoutIfNeeded(docstring const & n) const +bool DocumentClass::addLayoutIfNeeded(docstring const & n) const { - if (!hasLayout(n)) - layoutlist_.push_back(createBasicLayout(n, true)); + if (hasLayout(n)) + return false; + + layoutlist_.push_back(createBasicLayout(n, true)); + return true; } -InsetLayout const & DocumentClass::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. @@ -1022,7 +1378,6 @@ InsetLayout const & DocumentClass::insetLayout(docstring const & name) const docstring const & TextClass::defaultLayoutName() const { - // This really should come from the actual layout... (Lgb) return defaultlayout_; } @@ -1033,13 +1388,13 @@ Layout const & TextClass::defaultLayout() const } -bool TextClass::isDefaultLayout(Layout const & layout) const +bool TextClass::isDefaultLayout(Layout const & layout) const { return layout.name() == defaultLayoutName(); } -bool TextClass::isPlainLayout(Layout const & layout) const +bool TextClass::isPlainLayout(Layout const & layout) const { return layout.name() == plainLayoutName(); } @@ -1076,31 +1431,46 @@ Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const return *defaultLayout; } -///////////////////////////////////////////////////////////////////////// -// -// DocumentClassBundle -// -///////////////////////////////////////////////////////////////////////// - -DocumentClassBundle::~DocumentClassBundle() -{ - for (size_t i = 0; i != documentClasses_.size(); ++i) - delete documentClasses_[i]; - documentClasses_.clear(); -} - -DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass) -{ - DocumentClass * dc = new DocumentClass(baseClass); - documentClasses_.push_back(dc); - return *documentClasses_.back(); -} - -DocumentClassBundle & DocumentClassBundle::get() +DocumentClassPtr getDocumentClass( + LayoutFile const & baseClass, LayoutModuleList const & modlist) { - static DocumentClassBundle singleton; - return singleton; + DocumentClassPtr doc_class = + DocumentClassPtr(new DocumentClass(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 prereqs = from_utf8(getStringFromVector(lm->prerequisites(), "\n\t")); + docstring const msg = + bformat(_("The module %1$s requires a package that is not\n" + "available in your LaTeX installation, or a converter that\n" + "you have not installed. LaTeX output may not be possible.\n" + "Missing prerequisites:\n" + "\t%2$s\n" + "See section 3.1.2.3 (Modules) of the User's Guide for more information."), + from_utf8(modName), prereqs); + frontend::Alert::warning(_("Package not available"), msg, true); + } + 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; } @@ -1138,6 +1508,93 @@ bool DocumentClass::hasTocLevels() const } +Layout const & DocumentClass::getTOCLayout() const +{ + // 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) + return *lay; + // hmm. that is very odd, so we'll do our best. + return operator[](defaultLayoutName()); +} + + +Layout const & DocumentClass::htmlTOCLayout() const +{ + if (html_toc_section_.empty()) + html_toc_section_ = getTOCLayout().name(); + return operator[](html_toc_section_); +} + + +string const & DocumentClass::getCiteFormat(CiteEngineType const & type, + string const & entry, string const & fallback) const +{ + static string default_format = "{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!!}%journal%{!!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}."; + + map >::const_iterator itype = cite_formats_.find(type); + if (itype == cite_formats_.end()) + return default_format; + map::const_iterator it = itype->second.find(entry); + if (it == itype->second.end() && !fallback.empty()) + it = itype->second.find(fallback); + if (it == itype->second.end()) + return default_format; + return it->second; +} + + +string const & DocumentClass::getCiteMacro(CiteEngineType const & type, + string const & macro) const +{ + static string empty; + map >::const_iterator itype = cite_macros_.find(type); + if (itype == cite_macros_.end()) + return empty; + map::const_iterator it = itype->second.find(macro); + if (it == itype->second.end()) + return empty; + return it->second; +} + + +vector const DocumentClass::citeCommands( + CiteEngineType const & type) const +{ + vector const styles = citeStyles(type); + vector::const_iterator it = styles.begin(); + vector::const_iterator end = styles.end(); + vector cmds; + for (; it != end; ++it) { + CitationStyle const cite = *it; + cmds.push_back(cite.cmd); + } + return cmds; +} + + +vector const & DocumentClass::citeStyles( + CiteEngineType const & type) const +{ + static vector empty; + map >::const_iterator it = cite_styles_.find(type); + if (it == cite_styles_.end()) + return empty; + return it->second; +} + + ///////////////////////////////////////////////////////////////////////// // // PageSides