X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FTextClass.cpp;h=0ab0c5ce88c1ce31b5ef6a5e0f86606ddfcd9bc8;hb=0bff66b8a5a8a289dfb36bfb339e9586b3a02d51;hp=a158116d3eadb8dbd5ef63848a86da701ddf43d3;hpb=287612cfba4c749decf848f585300c826e2217e6;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index a158116d3e..0ab0c5ce88 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -49,6 +49,19 @@ 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 = 35; + namespace { class LayoutNamesEqual : public unary_function { @@ -64,9 +77,6 @@ private: docstring name_; }; -// Keep the changes documented in the Customization manual. -int const FORMAT = 26; - bool layout2layout(FileName const & filename, FileName const & tempfile) { @@ -94,7 +104,7 @@ bool layout2layout(FileName const & filename, FileName const & tempfile) } -string translateRT(TextClass::ReadType rt) +string translateReadType(TextClass::ReadType rt) { switch (rt) { case TextClass::BASECLASS: @@ -186,6 +196,7 @@ enum TextClassTags { TC_RIGHTMARGIN, TC_FLOAT, TC_COUNTER, + TC_NOCOUNTER, TC_IFCOUNTER, TC_NOFLOAT, TC_TITLELATEXNAME, @@ -223,6 +234,7 @@ namespace { { "input", TC_INPUT }, { "insetlayout", TC_INSETLAYOUT }, { "leftmargin", TC_LEFTMARGIN }, + { "nocounter", TC_NOCOUNTER }, { "nofloat", TC_NOFLOAT }, { "nostyle", TC_NOSTYLE }, { "outputformat", TC_OUTPUTFORMAT }, @@ -246,7 +258,7 @@ namespace { 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) @@ -256,6 +268,29 @@ bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType } +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()) { @@ -264,8 +299,8 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re 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 @@ -277,8 +312,8 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re lexrc.setFile(filename); ReturnValues retval = read(lexrc, rt); - LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " + - to_utf8(makeDisplayPath(filename.absFilename()))); + LYXERR(Debug::TCLASS, "Finished reading " + translateReadType(rt) + ": " + + to_utf8(makeDisplayPath(filename.absFileName()))); return retval; } @@ -291,23 +326,21 @@ bool TextClass::read(FileName const & filename, ReadType rt) return retval == OK; bool const worx = convertLayoutFormat(filename, rt); - if (!worx) { + if (!worx) LYXERR0 ("Unable to convert " << filename << - " to format " << FORMAT); - return false; - } - return true; + " 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); @@ -315,14 +348,14 @@ bool TextClass::read(std::string const & str, ReadType rt) ReturnValues retval = read(lexrc, rt); if (retval != FORMAT_MISMATCH) - return retval == OK; + 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(); @@ -331,10 +364,11 @@ bool TextClass::read(std::string const & str, ReadType rt) bool const worx = convertLayoutFormat(tempfile, rt); if (!worx) { LYXERR0("Unable to convert internal layout information to format " - << FORMAT); + << LAYOUT_FORMAT); + return ERROR; } tempfile.removeFile(); - return worx; + return OK_OLDFORMAT; } @@ -406,7 +440,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; } } @@ -635,13 +669,21 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } case TC_FLOAT: - error = 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: @@ -685,7 +727,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) // Note that this is triggered the first time through the loop unless // we hit a format tag. - if (format != FORMAT) + if (format != LAYOUT_FORMAT) return FORMAT_MISMATCH; } @@ -891,7 +933,8 @@ bool TextClass::readFloat(Lexer & lexrc) FT_WITHIN, FT_STYLE, FT_LISTNAME, - FT_NEEDSFLOAT, + FT_USESFLOAT, + FT_PREDEFINED, FT_HTMLSTYLE, FT_HTMLATTR, FT_HTMLTAG, @@ -907,14 +950,15 @@ bool TextClass::readFloat(Lexer & lexrc) { "htmlattr", FT_HTMLATTR }, { "htmlstyle", FT_HTMLSTYLE }, { "htmltag", FT_HTMLTAG }, + { "ispredefined", FT_PREDEFINED }, { "listcommand", FT_LISTCOMMAND }, { "listname", FT_LISTNAME }, - { "needsfloatpkg", FT_NEEDSFLOAT }, { "numberwithin", FT_WITHIN }, { "placement", FT_PLACEMENT }, { "refprefix", FT_REFPREFIX }, { "style", FT_STYLE }, - { "type", FT_TYPE } + { "type", FT_TYPE }, + { "usesfloatpkg", FT_USESFLOAT } }; lexrc.pushTable(floatTags); @@ -931,7 +975,8 @@ bool TextClass::readFloat(Lexer & lexrc) string style; string type; string within; - bool needsfloat = true; + bool usesfloat = true; + bool ispredefined = false; bool getout = false; while (!getout && lexrc.isOK()) { @@ -955,7 +1000,8 @@ bool TextClass::readFloat(Lexer & lexrc) style = fl.style(); name = fl.name(); listname = fl.listName(); - needsfloat = fl.needsFloatPkg(); + usesfloat = fl.usesFloatPkg(); + ispredefined = fl.isPredefined(); listcommand = fl.listCommand(); refprefix = fl.refPrefix(); } @@ -994,9 +1040,13 @@ bool TextClass::readFloat(Lexer & lexrc) lexrc.next(); listname = lexrc.getString(); break; - case FT_NEEDSFLOAT: + case FT_USESFLOAT: lexrc.next(); - needsfloat = lexrc.getBool(); + usesfloat = lexrc.getBool(); + break; + case FT_PREDEFINED: + lexrc.next(); + ispredefined = lexrc.getBool(); break; case FT_HTMLATTR: lexrc.next(); @@ -1020,13 +1070,26 @@ bool TextClass::readFloat(Lexer & lexrc) // 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."); + 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, needsfloat); + htmltag, htmlattr, htmlstyle, usesfloat, ispredefined); floatlist_.newFloat(fl); // each float has its own counter counters_.newCounter(from_ascii(type), from_ascii(within), @@ -1036,7 +1099,6 @@ bool TextClass::readFloat(Lexer & lexrc) counters_.newCounter(subtype, from_ascii(type), "\\alph{" + subtype + "}", docstring()); } - return getout; } @@ -1148,7 +1210,7 @@ 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..." @@ -1159,10 +1221,13 @@ bool TextClass::load(string const & path) const } -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; } @@ -1187,7 +1252,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_; } @@ -1289,11 +1353,16 @@ DocumentClass & DocumentClassBundle::makeDocumentClass( 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\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); + 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)) { @@ -1368,7 +1437,7 @@ Layout const & DocumentClass::htmlTOCLayout() const string const & DocumentClass::getCiteFormat(string const & entry_type) const { - static string default_format = N_("{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!!}%journal%{!!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}."); + 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())