X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=92adfdc7507dd7173dfa7c9bfe6f764baff46fcc;hb=55a3dd7b346d29a52ba305a4558e9e380ef50f47;hp=c6e759dcf025d7a254273ff86f282bc47c295806;hpb=2078e09e67ece00640277eb93b87e378904244f7;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index c6e759dcf0..92adfdc750 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. */ @@ -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/updatelayouts.sh script, to update the format of +// all of our layout files. +// +int const LAYOUT_FORMAT = 36; + namespace { class LayoutNamesEqual : public unary_function { @@ -61,9 +78,6 @@ private: }; -int const FORMAT = 10; - - bool layout2layout(FileName const & filename, FileName const & tempfile) { FileName const script = libFileSearch("scripts", "layout2layout.py"); @@ -90,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: @@ -109,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"); @@ -126,6 +140,7 @@ InsetLayout DocumentClass::plain_insetlayout_; TextClass::TextClass() { outputType_ = LATEX; + outputFormat_ = "latex"; columns_ = 1; sides_ = OneSide; secnumdepth_ = 3; @@ -159,8 +174,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, @@ -172,79 +189,125 @@ 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_USEMODULE + TC_ADDTOHTMLPREAMBLE, + TC_ADDTOHTMLSTYLES, + TC_DEFAULTMODULE, + TC_PROVIDESMODULE, + TC_EXCLUDESMODULE, + TC_HTMLTOCSECTION, + TC_CITEFORMAT }; namespace { LexerKeyword textClassTags[] = { - { "addtopreamble", TC_ADDTOPREAMBLE }, - { "classoptions", TC_CLASSOPTIONS }, - { "columns", TC_COLUMNS }, - { "counter", TC_COUNTER }, - { "defaultfont", TC_DEFAULTFONT }, - { "defaultstyle", TC_DEFAULTSTYLE }, - { "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 }, - { "usemodule", TC_USEMODULE } + { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE }, + { "addtohtmlstyles", TC_ADDTOHTMLSTYLES }, + { "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 }, + { "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_)); @@ -252,46 +315,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(); @@ -299,21 +367,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) { @@ -332,6 +403,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: @@ -339,8 +414,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 @@ -353,8 +444,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; } } @@ -368,40 +458,52 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } break; - 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; - // 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 { - 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; - } + 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 { - 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()) { @@ -466,10 +568,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(); @@ -483,17 +605,38 @@ 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; } - case TC_USEMODULE: { + 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(usemod_.begin(), usemod_.end(), module) == usemod_.end()) - usemod_.push_back(module); + 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; } @@ -507,19 +650,54 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, 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; + // 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; - if (il.read(lexrc, *this)) - insetlayoutlist_[il.name()] = il; - // else there was an error, so forget it + 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_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(); @@ -532,12 +710,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: @@ -557,25 +737,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 @@ -590,11 +772,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; } @@ -699,7 +881,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: @@ -712,7 +895,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(); @@ -727,7 +913,29 @@ void TextClass::readClassOptions(Lexer & lexrc) } -void TextClass::readFloat(Lexer & lexrc) +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; + } +} + + +bool TextClass::readFloat(Lexer & lexrc) { enum { FT_TYPE = 1, @@ -737,7 +945,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 }; @@ -745,24 +959,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()) { @@ -771,7 +997,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: @@ -784,9 +1011,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(); @@ -810,13 +1040,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_BUILTIN: + case FT_USESFLOAT: lexrc.next(); - builtin = lexrc.getBool(); + 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_HTMLTAG: + lexrc.next(); + htmltag = lexrc.getString(); break; case FT_END: getout = true; @@ -824,10 +1078,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), @@ -837,11 +1111,19 @@ void TextClass::readFloat(Lexer & lexrc) counters_.newCounter(subtype, from_ascii(type), "\\alph{" + subtype + "}", docstring()); } - - lexrc.popTable(); + return getout; } +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; @@ -852,11 +1134,24 @@ 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; +} + + 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()) { @@ -927,24 +1222,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. @@ -965,7 +1264,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_; } @@ -976,13 +1274,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(); } @@ -1019,6 +1317,7 @@ Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const return *defaultLayout; } + ///////////////////////////////////////////////////////////////////////// // // DocumentClassBundle @@ -1042,8 +1341,49 @@ DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass) DocumentClassBundle & DocumentClassBundle::get() { - static DocumentClassBundle singleton; - return singleton; + static DocumentClassBundle singleton; + return singleton; +} + + +DocumentClass & DocumentClassBundle::makeDocumentClass( + LayoutFile const & baseClass, LayoutModuleList const & modlist) +{ + 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 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; } @@ -1081,6 +1421,53 @@ bool DocumentClass::hasTocLevels() const } +Layout const & DocumentClass::htmlTOCLayout() const +{ + 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_); +} + + +string const & DocumentClass::getCiteFormat(string const & entry_type) const +{ + static string default_format = "{%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; +} + + +string const & DocumentClass::getCiteMacro(string const & macro) const +{ + static string empty; + map::const_iterator it = cite_macros_.find(macro); + if (it != cite_macros_.end()) + return it->second; + return empty; +} + + ///////////////////////////////////////////////////////////////////////// // // PageSides