X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=612539843f0b2148574d4eb3cb512ce113786e6e;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=6027a2358302f40cfafeb830b492f814326b3bf4;hpb=eb748d6330f6bbf727c28804c4a88dbc16d82830;p=lyx.git diff --git a/src/TextClass.cpp b/src/TextClass.cpp index 6027a23583..612539843f 100644 --- a/src/TextClass.cpp +++ b/src/TextClass.cpp @@ -17,6 +17,7 @@ #include "TextClass.h" #include "LayoutFile.h" +#include "CiteEnginesList.h" #include "Color.h" #include "Counters.h" #include "Floating.h" @@ -61,7 +62,13 @@ namespace lyx { // You should also run the development/tools/updatelayouts.py script, // to update the format of all of our layout files. // -int const LAYOUT_FORMAT = 57; //spitz: New Layout tag ParagraphGroup +int const LAYOUT_FORMAT = 63; //spitz: new tags CiteFramework, MaxCiteNames, extended InsetCite syntax. + + +// Layout format for the current lyx file format. Controls which format is +// targeted by Local Layout > Convert. In master, equal to LAYOUT_FORMAT. +int const LYXFILE_LAYOUT_FORMAT = LAYOUT_FORMAT; + namespace { @@ -79,26 +86,29 @@ private: }; -bool layout2layout(FileName const & filename, FileName const & tempfile) +bool layout2layout(FileName const & filename, FileName const & tempfile, + int const format = LAYOUT_FORMAT) { FileName const script = libFileSearch("scripts", "layout2layout.py"); if (script.empty()) { LYXERR0("Could not find layout conversion " - "script layout2layout.py."); + "script layout2layout.py."); return false; } ostringstream command; command << os::python() << ' ' << quoteName(script.toFilesystemEncoding()) - << ' ' << quoteName(filename.toFilesystemEncoding()) - << ' ' << quoteName(tempfile.toFilesystemEncoding()); + << " -t " << format + << ' ' << quoteName(filename.toFilesystemEncoding()) + << ' ' << quoteName(tempfile.toFilesystemEncoding()); string const command_str = command.str(); LYXERR(Debug::TCLASS, "Running `" << command_str << '\''); cmd_ret const ret = runCommand(command_str); if (ret.first != 0) { - LYXERR0("Could not run layout conversion script layout2layout.py."); + if (format == LAYOUT_FORMAT) + LYXERR0("Conversion of layout with layout2layout.py has failed."); return false; } return true; @@ -114,6 +124,8 @@ string translateReadType(TextClass::ReadType rt) return "input file"; case TextClass::MODULE: return "module file"; + case TextClass::CITE_ENGINE: + return "cite engine"; case TextClass::VALIDATION: return "validation"; } @@ -129,9 +141,6 @@ string translateReadType(TextClass::ReadType rt) docstring const TextClass::plain_layout_ = from_ascii(N_("Plain Layout")); -InsetLayout DocumentClass::plain_insetlayout_; - - ///////////////////////////////////////////////////////////////////////// // // TextClass @@ -139,22 +148,16 @@ InsetLayout DocumentClass::plain_insetlayout_; ///////////////////////////////////////////////////////////////////////// TextClass::TextClass() + : loaded_(false), tex_class_avail_(false), + opt_enginetype_("authoryear|numerical"), opt_fontsize_("10|11|12"), + opt_pagestyle_("empty|plain|headings|fancy"), pagestyle_("default"), + columns_(1), sides_(OneSide), secnumdepth_(3), tocdepth_(3), + outputType_(LATEX), outputFormat_("latex"), + defaultfont_(sane_font), + titletype_(TITLE_COMMAND_AFTER), titlename_("maketitle"), + min_toclevel_(0), max_toclevel_(0), maxcitenames_(2), + cite_full_author_list_(true) { - 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; } @@ -179,7 +182,8 @@ enum TextClassTags { TC_OUTPUTFORMAT, TC_INPUT, TC_STYLE, - TC_IFSTYLE, + TC_MODIFYSTYLE, + TC_PROVIDESTYLE, TC_DEFAULTSTYLE, TC_INSETLAYOUT, TC_NOINSETLAYOUT, @@ -217,8 +221,11 @@ enum TextClassTags { TC_CITEENGINE, TC_CITEENGINETYPE, TC_CITEFORMAT, + TC_CITEFRAMEWORK, + TC_MAXCITENAMES, TC_DEFAULTBIBLIO, - TC_FULLAUTHORLIST + TC_FULLAUTHORLIST, + TC_OUTLINERNAME }; @@ -231,6 +238,7 @@ LexerKeyword textClassTags[] = { { "citeengine", TC_CITEENGINE }, { "citeenginetype", TC_CITEENGINETYPE }, { "citeformat", TC_CITEFORMAT }, + { "citeframework", TC_CITEFRAMEWORK }, { "classoptions", TC_CLASSOPTIONS }, { "columns", TC_COLUMNS }, { "counter", TC_COUNTER }, @@ -246,14 +254,16 @@ LexerKeyword textClassTags[] = { { "htmlstyles", TC_HTMLSTYLES }, { "htmltocsection", TC_HTMLTOCSECTION }, { "ifcounter", TC_IFCOUNTER }, - { "ifstyle", TC_IFSTYLE }, { "input", TC_INPUT }, { "insetlayout", TC_INSETLAYOUT }, { "leftmargin", TC_LEFTMARGIN }, + { "maxcitenames", TC_MAXCITENAMES }, + { "modifystyle", TC_MODIFYSTYLE }, { "nocounter", TC_NOCOUNTER }, { "nofloat", TC_NOFLOAT }, { "noinsetlayout", TC_NOINSETLAYOUT }, { "nostyle", TC_NOSTYLE }, + { "outlinername", TC_OUTLINERNAME }, { "outputformat", TC_OUTPUTFORMAT }, { "outputtype", TC_OUTPUTTYPE }, { "packageoptions", TC_PKGOPTS }, @@ -261,6 +271,7 @@ LexerKeyword textClassTags[] = { { "preamble", TC_PREAMBLE }, { "provides", TC_PROVIDES }, { "providesmodule", TC_PROVIDESMODULE }, + { "providestyle", TC_PROVIDESTYLE }, { "requires", TC_REQUIRES }, { "rightmargin", TC_RIGHTMARGIN }, { "secnumdepth", TC_SECNUMDEPTH }, @@ -295,7 +306,7 @@ std::string TextClass::convert(std::string const & str) os.close(); TempFile tmp2("convert_localXXXXXX.layout"); FileName const tempfile = tmp2.name(); - bool success = layout2layout(fn, tempfile); + bool success = layout2layout(fn, tempfile, LYXFILE_LAYOUT_FORMAT); if (!success) return ""; ifstream is(tempfile.toFilesystemEncoding().c_str()); @@ -380,13 +391,13 @@ TextClass::ReturnValues TextClass::read(std::string const & str, ReadType rt) os << str; os.close(); - // now try to convert it - bool const worx = convertLayoutFormat(tempfile, rt); - if (!worx) { + // now try to convert it to LAYOUT_FORMAT + if (!convertLayoutFormat(tempfile, rt)) { LYXERR0("Unable to convert internal layout information to format " << LAYOUT_FORMAT); return ERROR; } + return OK_OLDFORMAT; } @@ -419,8 +430,9 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } // used below to track whether we are in an IfStyle or IfCounter tag. - bool ifstyle = false; - bool ifcounter = false; + bool modifystyle = false; + bool providestyle = false; + bool ifcounter = false; switch (static_cast(le)) { @@ -451,8 +463,13 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) case TC_INPUT: // Include file if (lexrc.next()) { + FileName tmp; string const inc = lexrc.getString(); - FileName tmp = libFileSearch("layouts", inc, + if (!path().empty() && (prefixIs(inc, "./") || + prefixIs(inc, "../"))) + tmp = fileSearch(path(), inc, "layout"); + else + tmp = libFileSearch("layouts", inc, "layout"); if (tmp.empty()) { @@ -473,9 +490,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) } break; - case TC_IFSTYLE: - ifstyle = true; - // fall through + case TC_MODIFYSTYLE: + modifystyle = true; + // fall through + case TC_PROVIDESTYLE: + // if modifystyle is true, then we got here by falling through + // so we are not in an ProvideStyle block + if (!modifystyle) + providestyle = true; + // fall through case TC_STYLE: { if (!lexrc.next()) { lexrc.printError("No name given for style: `$$Token'."); @@ -492,10 +515,21 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) // 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)) { + break; + } + + bool const have_layout = hasLayout(name); + + // If the layout already exists, then we want to add it to + // the existing layout, as long as we are not in an ProvideStyle + // block. + if (have_layout && !providestyle) { Layout & lay = operator[](name); error = !readStyle(lexrc, lay); - } else if (!ifstyle) { + } + // If the layout does not exist, then we want to create a new + // one, but not if we are in a ModifyStyle block. + else if (!have_layout && !modifystyle) { Layout layout; layout.setName(name); error = !readStyle(lexrc, layout); @@ -508,15 +542,16 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) defaultlayout_ = name; } } + // There are two ways to get here: + // (i) The layout exists but we are in an ProvideStyle block + // (ii) The layout doesn't exist, but we are in an ModifyStyle + // block. + // Either way, we just scan the rest and discard it else { - // this was an ifstyle where we didn't have the style - // scan the rest and discard it Layout lay; - readStyle(lexrc, lay); + // signal to coverity that we do not care about the result + (void)readStyle(lexrc, lay); } - - // reset flag - ifstyle = false; break; } @@ -590,15 +625,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) break; case TC_PREAMBLE: - preamble_ = from_utf8(lexrc.getLongString("EndPreamble")); + preamble_ = lexrc.getLongString(from_ascii("EndPreamble")); break; case TC_HTMLPREAMBLE: - htmlpreamble_ = from_utf8(lexrc.getLongString("EndPreamble")); + htmlpreamble_ = lexrc.getLongString(from_ascii("EndPreamble")); break; case TC_HTMLSTYLES: - htmlstyles_ = from_utf8(lexrc.getLongString("EndStyles")); + htmlstyles_ = lexrc.getLongString(from_ascii("EndStyles")); break; case TC_HTMLTOCSECTION: @@ -606,15 +641,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) break; case TC_ADDTOPREAMBLE: - preamble_ += from_utf8(lexrc.getLongString("EndPreamble")); + preamble_ += lexrc.getLongString(from_ascii("EndPreamble")); break; case TC_ADDTOHTMLPREAMBLE: - htmlpreamble_ += from_utf8(lexrc.getLongString("EndPreamble")); + htmlpreamble_ += lexrc.getLongString(from_ascii("EndPreamble")); break; case TC_ADDTOHTMLSTYLES: - htmlstyles_ += from_utf8(lexrc.getLongString("EndStyles")); + htmlstyles_ += lexrc.getLongString(from_ascii("EndStyles")); break; case TC_PROVIDES: { @@ -731,9 +766,35 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) error = !readCiteFormat(lexrc); break; + case TC_CITEFRAMEWORK: + lexrc.next(); + citeframework_ = rtrim(lexrc.getString()); + break; + + case TC_MAXCITENAMES: + lexrc.next(); + maxcitenames_ = size_t(lexrc.getInteger()); + break; + case TC_DEFAULTBIBLIO: - if (lexrc.next()) - cite_default_biblio_style_ = rtrim(lexrc.getString()); + if (lexrc.next()) { + vector const dbs = + getVectorFromString(rtrim(lexrc.getString()), "|"); + vector::const_iterator it = dbs.begin(); + vector::const_iterator end = dbs.end(); + for (; it != end; ++it) { + if (!contains(*it, ':')) { + vector const enginetypes = + getVectorFromString(opt_enginetype_, "|"); + for (string const &s: enginetypes) + cite_default_biblio_style_[s] = *it; + } else { + string eng; + string const db = split(*it, eng, ':'); + cite_default_biblio_style_[eng] = db; + } + } + } break; case TC_FULLAUTHORLIST: @@ -751,6 +812,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) case TC_IFCOUNTER: ifcounter = true; + // fall through case TC_COUNTER: if (lexrc.next()) { docstring const name = lexrc.getDocString(); @@ -769,8 +831,6 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) lexrc.printError("No name given for style: `$$Token'."); error = true; } - // reset flag - ifcounter = false; break; case TC_TITLELATEXTYPE: @@ -788,6 +848,10 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) floatlist_.erase(nofloat); } break; + + case TC_OUTLINERNAME: + error = !readOutlinerName(lexrc); + break; } // end of switch // Note that this is triggered the first time through the loop unless @@ -802,7 +866,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) return ERROR; if (rt != BASECLASS) - return (error ? ERROR : OK); + return OK; if (defaultlayout_.empty()) { LYXERR0("Error: Textclass '" << name_ @@ -986,30 +1050,85 @@ bool TextClass::readCiteEngine(Lexer & lexrc) getout = true; continue; } - string cmd; CitationStyle cs; char ichar = def[0]; if (ichar == '#') continue; - if (ichar == 'C') { + if (isUpperCase(ichar)) { cs.forceUpperCase = true; - def[0] = 'c'; + def[0] = lowercase(ichar); } + /** For portability reasons (between different + * cite engines such as natbib and biblatex), + * we distinguish between: + * 1. The LyX name as output in the LyX file + * 2. Possible aliases that might fall back to + * the given LyX name in the current engine + * 3. The actual LaTeX command that is output + * (2) and (3) are optional. + * Also, the GUI string for the starred version can + * be changed + * The syntax is: + * LyXName|alias,nextalias*[][]=latexcmd + */ + enum ScanMode { + LyXName, + Alias, + LaTeXCmd, + StarDesc + }; + + ScanMode mode = LyXName; + ScanMode oldmode = LyXName; + string lyx_cmd; + string alias; + string latex_cmd; + string stardesc; size_t const n = def.size(); for (size_t i = 0; i != n; ++i) { ichar = def[i]; - if (ichar == '*') - cs.fullAuthorList = true; + if (ichar == '|') + mode = Alias; + else if (ichar == '=') + mode = LaTeXCmd; + else if (ichar == '<') { + oldmode = mode; + mode = StarDesc; + } else if (ichar == '>') + mode = oldmode; + else if (mode == LaTeXCmd) + latex_cmd += ichar; + else if (mode == StarDesc) + stardesc += ichar; + else if (ichar == '$') + cs.hasQualifiedList = true; + else if (ichar == '*') + cs.hasStarredVersion = true; else if (ichar == '[' && cs.textAfter) cs.textBefore = true; else if (ichar == '[') cs.textAfter = true; - else if (ichar != ']') - cmd += ichar; + else if (ichar != ']') { + if (mode == Alias) + alias += ichar; + else + lyx_cmd += ichar; + } } - - cs.cmd = cmd; + cs.name = lyx_cmd; + cs.cmd = latex_cmd.empty() ? lyx_cmd : latex_cmd; + if (!alias.empty()) { + vector const aliases = getVectorFromString(alias); + for (string const &s: aliases) + cite_command_aliases_[s] = lyx_cmd; + } + vector const stardescs = getVectorFromString(stardesc, "!"); + int size = stardesc.size(); + if (size > 0) + cs.stardesc = stardescs[0]; + if (size > 1) + cs.startooltip = stardescs[1]; if (type & ENGINE_TYPE_AUTHORYEAR) cite_styles_[ENGINE_TYPE_AUTHORYEAR].push_back(cs); if (type & ENGINE_TYPE_NUMERICAL) @@ -1128,7 +1247,7 @@ bool TextClass::readFloat(Lexer & lexrc) string ext; string htmlattr; - string htmlstyle; + docstring htmlstyle; string htmltag; string listname; string listcommand; @@ -1232,7 +1351,7 @@ bool TextClass::readFloat(Lexer & lexrc) break; case FT_HTMLSTYLE: lexrc.next(); - htmlstyle = lexrc.getLongString("EndHTMLStyle"); + htmlstyle = lexrc.getLongString(from_ascii("EndHTMLStyle")); break; case FT_HTMLTAG: lexrc.next(); @@ -1282,6 +1401,27 @@ bool TextClass::readFloat(Lexer & lexrc) } +bool TextClass::readOutlinerName(Lexer & lexrc) +{ + std::string type; + docstring name; + if (lexrc.next()) + type = lexrc.getString(); + else { + lexrc.printError("No type given for OutlinerName: `$$Token'."); + return false; + } + if (lexrc.next()) + name = lexrc.getDocString(); + else { + lexrc.printError("No name given for OutlinerName: `$$Token'."); + return false; + } + outliner_names_[type] = name; + return true; +} + + string const & TextClass::prerequisites(string const & sep) const { if (contains(prerequisites_, ',')) { @@ -1457,6 +1597,12 @@ InsetLayout const & DocumentClass::insetLayout(docstring const & name) const n = n.substr(0, i); } // Layout "name" not found. + return plainInsetLayout(); +} + + +InsetLayout const & DocumentClass::plainInsetLayout() { + static const InsetLayout plain_insetlayout_; return plain_insetlayout_; } @@ -1519,6 +1665,7 @@ Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const DocumentClassPtr getDocumentClass( LayoutFile const & baseClass, LayoutModuleList const & modlist, + LayoutModuleList const & celist, bool const clone) { DocumentClassPtr doc_class = @@ -1557,6 +1704,42 @@ DocumentClassPtr getDocumentClass( frontend::Alert::warning(_("Read Error"), msg); } } + + LayoutModuleList::const_iterator cit = celist.begin(); + LayoutModuleList::const_iterator cen = celist.end(); + for (; cit != cen; ++cit) { + string const ceName = *cit; + LyXCiteEngine * ce = theCiteEnginesList[ceName]; + if (!ce) { + docstring const msg = + bformat(_("The cite engine %1$s has been requested by\n" + "this document but has not been found in the list of\n" + "available engines. If you recently installed it, you\n" + "probably need to reconfigure LyX.\n"), from_utf8(ceName)); + if (!clone) + frontend::Alert::warning(_("Cite Engine not available"), msg); + continue; + } + if (!ce->isAvailable() && !clone) { + docstring const prereqs = from_utf8(getStringFromVector(ce->prerequisites(), "\n\t")); + docstring const msg = + bformat(_("The cite engine %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(ceName), prereqs); + frontend::Alert::warning(_("Package not available"), msg, true); + } + FileName layout_file = libFileSearch("citeengines", ce->getFilename()); + if (!doc_class->read(layout_file, TextClass::CITE_ENGINE)) { + docstring const msg = + bformat(_("Error reading cite engine %1$s\n"), from_utf8(ceName)); + frontend::Alert::warning(_("Read Error"), msg); + } + } + return doc_class; } @@ -1626,10 +1809,12 @@ Layout const & DocumentClass::htmlTOCLayout() const } -string const & DocumentClass::getCiteFormat(CiteEngineType const & type, - string const & entry, string const & fallback) const +string const DocumentClass::getCiteFormat(CiteEngineType const & type, + string const & entry, bool const punct, string const & fallback) const { - static string default_format = "{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!!}%journal%{!!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}."; + string default_format = "{%fullnames:author%[[%fullnames:author%, ]][[{%fullnames:editor%[[%fullnames:editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!!}%journal%{!!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}"; + if (punct) + default_format += "."; map >::const_iterator itype = cite_formats_.find(type); if (itype == cite_formats_.end()) @@ -1639,6 +1824,8 @@ string const & DocumentClass::getCiteFormat(CiteEngineType const & type, it = itype->second.find(fallback); if (it == itype->second.end()) return default_format; + if (punct) + return it->second + "."; return it->second; } @@ -1666,7 +1853,7 @@ vector const DocumentClass::citeCommands( vector cmds; for (; it != end; ++it) { CitationStyle const cite = *it; - cmds.push_back(cite.cmd); + cmds.push_back(cite.name); } return cmds; }