X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetLayout.cpp;h=d579132a2129d5f2d3839461b830eff23f8414f9;hb=21f62c7184859eb8aadcf8c6efba2f3cdd810da4;hp=900881764999652e943c0921b78d7da58145bfc8;hpb=94e0c24753f4902a18bce858e1332cb181f0ab1c;p=lyx.git diff --git a/src/insets/InsetLayout.cpp b/src/insets/InsetLayout.cpp index 9008817649..d579132a21 100644 --- a/src/insets/InsetLayout.cpp +++ b/src/insets/InsetLayout.cpp @@ -14,10 +14,14 @@ #include "InsetLayout.h" -#include "Color.h" -#include "Font.h" +#include "ColorSet.h" +#include "Layout.h" #include "Lexer.h" +#include "TextClass.h" + +#include "support/debug.h" #include "support/lstrings.h" +#include "support/textutils.h" #include @@ -28,167 +32,377 @@ using std::vector; namespace lyx { InsetLayout::InsetLayout() : - name_(from_ascii("undefined")), labelstring_(from_ascii("UNDEFINED")), - decoration_(InsetLayout::Default), - font_(sane_font), labelfont_(sane_font), bgcolor_(Color_error), - multipar_(false), passthru_(false), needprotect_(false), - freespacing_(false), keepempty_(false), forceltr_(false) + name_(from_ascii("undefined")), lyxtype_(STANDARD), + labelstring_(from_ascii("UNDEFINED")), contentaslabel_(false), + decoration_(DEFAULT), latextype_(NOLATEXTYPE), font_(inherit_font), + labelfont_(sane_font), bgcolor_(Color_error), + htmlforcecss_ (false), htmlisblock_(true), + multipar_(true), custompars_(true), forceplain_(false), + passthru_(false), parbreakisnewline_(false), freespacing_(false), + keepempty_(false), forceltr_(false), + needprotect_(false), intoc_(false), spellcheck_(true), + resetsfont_(false), display_(true), forcelocalfontswitch_(false) { - labelfont_.setColor(Color_error); + labelfont_.setColor(Color_error); } -enum InsetLayoutTags { - IL_FONT = 1, - IL_BGCOLOR, - IL_DECORATION, - IL_FREESPACING, - IL_FORCELTR, - IL_LABELFONT, - IL_LABELSTRING, - IL_LATEXNAME, - IL_LATEXPARAM, - IL_LATEXTYPE, - IL_LYXTYPE, - IL_KEEPEMPTY, - IL_MULTIPAR, - IL_NEEDPROTECT, - IL_PASSTHRU, - IL_PREAMBLE, - IL_REQUIRES, - IL_END -}; - +InsetLayout::InsetDecoration translateDecoration(std::string const & str) +{ + if (support::compare_ascii_no_case(str, "classic") == 0) + return InsetLayout::CLASSIC; + if (support::compare_ascii_no_case(str, "minimalistic") == 0) + return InsetLayout::MINIMALISTIC; + if (support::compare_ascii_no_case(str, "conglomerate") == 0) + return InsetLayout::CONGLOMERATE; + return InsetLayout::DEFAULT; +} namespace { - InsetLayout::InsetDecoration translateDecoration(std::string const & str) - { - if (str == "classic") - return InsetLayout::Classic; - if (str == "minimalistic") - return InsetLayout::Minimalistic; - if (str == "conglomerate") - return InsetLayout::Conglomerate; - return InsetLayout::Default; - } + +InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str) +{ + if (support::compare_ascii_no_case(str, "command") == 0) + return InsetLayout::COMMAND; + if (support::compare_ascii_no_case(str, "environment") == 0) + return InsetLayout::ENVIRONMENT; + if (support::compare_ascii_no_case(str, "none") == 0) + return InsetLayout::NOLATEXTYPE; + return InsetLayout::ILT_ERROR; } +} // namespace anon -bool InsetLayout::read(Lexer & lexrc) + +bool InsetLayout::read(Lexer & lex, TextClass const & tclass) { - name_ = support::subst(lexrc.getDocString(), '_', ' '); + enum { + IL_ARGUMENT, + IL_BABELPREAMBLE, + IL_BGCOLOR, + IL_CONTENTASLABEL, + IL_COPYSTYLE, + IL_COUNTER, + IL_CUSTOMPARS, + IL_DECORATION, + IL_DISPLAY, + IL_FONT, + IL_FORCE_LOCAL_FONT_SWITCH, + IL_FORCELTR, + IL_FORCEPLAIN, + IL_FREESPACING, + IL_HTMLTAG, + IL_HTMLATTR, + IL_HTMLFORCECSS, + IL_HTMLINNERTAG, + IL_HTMLINNERATTR, + IL_HTMLISBLOCK, + IL_HTMLLABEL, + IL_HTMLSTYLE, + IL_HTMLPREAMBLE, + IL_INTOC, + IL_LABELFONT, + IL_LABELSTRING, + IL_LANGPREAMBLE, + IL_LATEXNAME, + IL_LATEXPARAM, + IL_LATEXTYPE, + IL_LEFTDELIM, + IL_LYXTYPE, + IL_KEEPEMPTY, + IL_MULTIPAR, + IL_NEEDPROTECT, + IL_PASSTHRU, + IL_PARBREAKISNEWLINE, + IL_PREAMBLE, + IL_REQUIRES, + IL_RIGHTDELIM, + IL_REFPREFIX, + IL_RESETARGS, + IL_RESETSFONT, + IL_SPELLCHECK, + IL_END + }; + - keyword_item elementTags[] = { + LexerKeyword elementTags[] = { + { "argument", IL_ARGUMENT }, + { "babelpreamble", IL_BABELPREAMBLE }, { "bgcolor", IL_BGCOLOR }, + { "contentaslabel", IL_CONTENTASLABEL }, + { "copystyle", IL_COPYSTYLE }, + { "counter", IL_COUNTER}, + { "custompars", IL_CUSTOMPARS }, { "decoration", IL_DECORATION }, + { "display", IL_DISPLAY }, { "end", IL_END }, { "font", IL_FONT }, + { "forcelocalfontswitch", IL_FORCE_LOCAL_FONT_SWITCH }, { "forceltr", IL_FORCELTR }, + { "forceplain", IL_FORCEPLAIN }, { "freespacing", IL_FREESPACING }, + { "htmlattr", IL_HTMLATTR }, + { "htmlforcecss", IL_HTMLFORCECSS }, + { "htmlinnerattr", IL_HTMLINNERATTR}, + { "htmlinnertag", IL_HTMLINNERTAG}, + { "htmlisblock", IL_HTMLISBLOCK}, + { "htmllabel", IL_HTMLLABEL }, + { "htmlpreamble", IL_HTMLPREAMBLE }, + { "htmlstyle", IL_HTMLSTYLE }, + { "htmltag", IL_HTMLTAG }, + { "intoc", IL_INTOC }, { "keepempty", IL_KEEPEMPTY }, { "labelfont", IL_LABELFONT }, { "labelstring", IL_LABELSTRING }, + { "langpreamble", IL_LANGPREAMBLE }, { "latexname", IL_LATEXNAME }, { "latexparam", IL_LATEXPARAM }, { "latextype", IL_LATEXTYPE }, + { "leftdelim", IL_LEFTDELIM }, { "lyxtype", IL_LYXTYPE }, { "multipar", IL_MULTIPAR }, { "needprotect", IL_NEEDPROTECT }, + { "parbreakisnewline", IL_PARBREAKISNEWLINE }, { "passthru", IL_PASSTHRU }, { "preamble", IL_PREAMBLE }, - { "requires", IL_REQUIRES } + { "refprefix", IL_REFPREFIX }, + { "requires", IL_REQUIRES }, + { "resetargs", IL_RESETARGS }, + { "resetsfont", IL_RESETSFONT }, + { "rightdelim", IL_RIGHTDELIM }, + { "spellcheck", IL_SPELLCHECK } }; - lexrc.pushTable(elementTags, IL_END); + lex.pushTable(elementTags); - FontInfo font = inherit_font; labelfont_ = inherit_font; - bgcolor_ = Color_background; + bgcolor_ = Color_none; bool getout = false; - - while (!getout && lexrc.isOK()) { - int le = lexrc.lex(); + // whether we've read the CustomPars or ForcePlain tag + // for issuing a warning in case MultiPars comes later + bool readCustomOrPlain = false; + + string tmp; + while (!getout && lex.isOK()) { + int le = lex.lex(); switch (le) { case Lexer::LEX_UNDEF: - lexrc.printError("Unknown InsetLayout tag `$$Token'"); + lex.printError("Unknown InsetLayout tag"); continue; - default: break; + default: + break; } - switch (static_cast(le)) { - case IL_LYXTYPE: - lexrc.next(); - lyxtype_ = lexrc.getString(); + switch (le) { + // FIXME + // Perhaps a more elegant way to deal with the next two would be the + // way this sort of thing is handled in Layout::read(), namely, by + // using the Lexer. + case IL_LYXTYPE: { + // make sure that we have the right sort of name. + if (name_ != from_ascii("undefined") + && name_.substr(0,5) != from_ascii("Flex:")) { + LYXERR0("Flex insets must have names of the form `Flex:'.\n" + "This one has the name `" << to_utf8(name_) << "'\n" + "Ignoring LyXType declaration."); + break; + } + string lt; + lex >> lt; + lyxtype_ = translateLyXType(lt); + if (lyxtype_ == NOLYXTYPE) + LYXERR0("Unknown LyXType `" << lt << "'."); + if (lyxtype_ == CHARSTYLE) + multipar_ = false; break; - case IL_LATEXTYPE: - lexrc.next(); - latextype_ = lexrc.getString(); + } + case IL_LATEXTYPE: { + string lt; + lex >> lt; + latextype_ = translateLaTeXType(lt); + if (latextype_ == ILT_ERROR) + LYXERR0("Unknown LaTeXType `" << lt << "'."); break; + } case IL_LABELSTRING: - lexrc.next(); - labelstring_ = lexrc.getDocString(); + lex >> labelstring_; break; case IL_DECORATION: - lexrc.next(); - decoration_ = translateDecoration(lexrc.getString()); + lex >> tmp; + decoration_ = translateDecoration(tmp); break; case IL_LATEXNAME: - lexrc.next(); - latexname_ = lexrc.getString(); + lex >> latexname_; break; case IL_LATEXPARAM: - lexrc.next(); - latexparam_ = support::subst(lexrc.getString(), """, "\""); + lex >> tmp; + latexparam_ = support::subst(tmp, """, "\""); + break; + case IL_LEFTDELIM: + lex >> leftdelim_; + leftdelim_ = support::subst(leftdelim_, from_ascii("
"), + from_ascii("\n")); + break; + case IL_FORCE_LOCAL_FONT_SWITCH: + lex >> forcelocalfontswitch_; + break; + case IL_RIGHTDELIM: + lex >> rightdelim_; + rightdelim_ = support::subst(rightdelim_, from_ascii("
"), + from_ascii("\n")); break; case IL_LABELFONT: - labelfont_ = lyxRead(lexrc, inherit_font); + labelfont_ = lyxRead(lex, inherit_font); break; case IL_FORCELTR: - lexrc.next(); - forceltr_ = lexrc.getBool(); + lex >> forceltr_; + break; + case IL_INTOC: + lex >> intoc_; break; case IL_MULTIPAR: - lexrc.next(); - multipar_ = lexrc.getBool(); + lex >> multipar_; + // the defaults for these depend upon multipar_ + if (readCustomOrPlain) + LYXERR0("Warning: Read MultiPar after CustomPars or ForcePlain. " + "Previous value may be overwritten!"); + readCustomOrPlain = false; + custompars_ = multipar_; + forceplain_ = !multipar_; + break; + case IL_COUNTER: + lex >> counter_; + break; + case IL_CUSTOMPARS: + lex >> custompars_; + readCustomOrPlain = true; + break; + case IL_FORCEPLAIN: + lex >> forceplain_; + readCustomOrPlain = true; break; case IL_PASSTHRU: - lexrc.next(); - passthru_ = lexrc.getBool(); + lex >> passthru_; + break; + case IL_PARBREAKISNEWLINE: + lex >> parbreakisnewline_; break; case IL_KEEPEMPTY: - lexrc.next(); - keepempty_ = lexrc.getBool(); + lex >> keepempty_; break; case IL_FREESPACING: - lexrc.next(); - freespacing_ = lexrc.getBool(); + lex >> freespacing_; break; case IL_NEEDPROTECT: - lexrc.next(); - needprotect_ = lexrc.getBool(); + lex >> needprotect_; + break; + case IL_CONTENTASLABEL: + lex >> contentaslabel_; break; + case IL_COPYSTYLE: { + // initialize with a known style + docstring style; + lex >> style; + style = support::subst(style, '_', ' '); + + // We don't want to apply the algorithm in DocumentClass::insetLayout() + // here. So we do it the long way. + TextClass::InsetLayouts::const_iterator it = + tclass.insetLayouts().find(style); + if (it != tclass.insetLayouts().end()) { + docstring const tmpname = name_; + this->operator=(it->second); + name_ = tmpname; + } else { + LYXERR0("Cannot copy unknown InsetLayout `" + << style << "'\n" + << "All InsetLayouts so far:"); + TextClass::InsetLayouts::const_iterator lit = + tclass.insetLayouts().begin(); + TextClass::InsetLayouts::const_iterator len = + tclass.insetLayouts().end(); + for (; lit != len; ++lit) + lyxerr << lit->second.name() << "\n"; + } + break; + } + case IL_FONT: { - font_ = lyxRead(lexrc, inherit_font); + font_ = lyxRead(lex, inherit_font); // If you want to define labelfont, you need to do so after // font is defined. labelfont_ = font_; break; } - case IL_BGCOLOR: { - lexrc.next(); - string const token = lexrc.getString(); - bgcolor_ = lcolor.getFromLyXName(token); + case IL_RESETARGS: + bool reset; + lex >> reset; + if (reset) { + latexargs_.clear(); + postcommandargs_.clear(); + } + break; + case IL_ARGUMENT: + readArgument(lex); + break; + case IL_BGCOLOR: + lex >> tmp; + bgcolor_ = lcolor.getFromLyXName(tmp); break; - } case IL_PREAMBLE: - preamble_ = lexrc.getLongString("EndPreamble"); + preamble_ = from_utf8(lex.getLongString("EndPreamble")); + break; + case IL_BABELPREAMBLE: + babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble")); + break; + case IL_LANGPREAMBLE: + langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble")); + break; + case IL_REFPREFIX: + lex >> refprefix_; + break; + case IL_HTMLTAG: + lex >> htmltag_; + break; + case IL_HTMLATTR: + lex >> htmlattr_; + break; + case IL_HTMLFORCECSS: + lex >> htmlforcecss_; + break; + case IL_HTMLINNERTAG: + lex >> htmlinnertag_; + break; + case IL_HTMLINNERATTR: + lex >> htmlinnerattr_; + break; + case IL_HTMLLABEL: + lex >> htmllabel_; + break; + case IL_HTMLISBLOCK: + lex >> htmlisblock_; + break; + case IL_HTMLSTYLE: + htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle")); + break; + case IL_HTMLPREAMBLE: + htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble")); break; case IL_REQUIRES: { - lexrc.eatLine(); + lex.eatLine(); vector const req - = support::getVectorFromString(lexrc.getString()); + = support::getVectorFromString(lex.getString()); requires_.insert(req.begin(), req.end()); break; } + case IL_SPELLCHECK: + lex >> spellcheck_; + break; + case IL_RESETSFONT: + lex >> resetsfont_; + break; + case IL_DISPLAY: + lex >> display_; + break; case IL_END: getout = true; break; @@ -203,8 +417,206 @@ bool InsetLayout::read(Lexer & lexrc) // any realization against a given context. labelfont_.realize(sane_font); - lexrc.popTable(); + lex.popTable(); return true; } + +InsetLayout::InsetLyXType translateLyXType(std::string const & str) +{ + + if (support::compare_ascii_no_case(str, "charstyle") == 0) + return InsetLayout::CHARSTYLE; + if (support::compare_ascii_no_case(str, "custom") == 0) + return InsetLayout::CUSTOM; + if (support::compare_ascii_no_case(str, "element") == 0) + return InsetLayout::ELEMENT; + if (support::compare_ascii_no_case(str, "end") == 0) + return InsetLayout::END; + if (support::compare_ascii_no_case(str, "standard") == 0) + return InsetLayout::STANDARD; + return InsetLayout::NOLYXTYPE; +} + + +string const & InsetLayout::htmltag() const +{ + if (htmltag_.empty()) + htmltag_ = multipar_ ? "div" : "span"; + return htmltag_; +} + + +string const & InsetLayout::htmlattr() const +{ + if (htmlattr_.empty()) + htmlattr_ = "class=\"" + defaultCSSClass() + "\""; + return htmlattr_; +} + + +string const & InsetLayout::htmlinnerattr() const +{ + if (htmlinnerattr_.empty()) + htmlinnerattr_ = "class=\"" + defaultCSSClass() + "_inner\""; + return htmlinnerattr_; +} + + +string InsetLayout::defaultCSSClass() const +{ + if (!defaultcssclass_.empty()) + return defaultcssclass_; + string d; + string n = to_utf8(name()); + string::const_iterator it = n.begin(); + string::const_iterator en = n.end(); + for (; it != en; ++it) { + if (!isAlphaASCII(*it)) + d += "_"; + else if (isLower(*it)) + d += *it; + else + d += support::lowercase(*it); + } + // are there other characters we need to remove? + defaultcssclass_ = d; + return defaultcssclass_; +} + + +void InsetLayout::makeDefaultCSS() const +{ + if (!htmldefaultstyle_.empty()) + return; + docstring const mainfontCSS = font_.asCSS(); + if (!mainfontCSS.empty()) + htmldefaultstyle_ = + from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") + + mainfontCSS + from_ascii("\n}\n"); +} + + +docstring InsetLayout::htmlstyle() const +{ + if (!htmlstyle_.empty() && !htmlforcecss_) + return htmlstyle_; + if (htmldefaultstyle_.empty()) + makeDefaultCSS(); + docstring retval = htmldefaultstyle_; + if (!htmlstyle_.empty()) + retval += '\n' + htmlstyle_ + '\n'; + return retval; +} + +void InsetLayout::readArgument(Lexer & lex) +{ + Layout::latexarg arg; + arg.mandatory = false; + arg.autoinsert = false; + bool error = false; + bool finished = false; + arg.font = inherit_font; + arg.labelfont = inherit_font; + string nr; + lex >> nr; + bool const postcmd = support::prefixIs(nr, "post:"); + while (!finished && lex.isOK() && !error) { + lex.next(); + string const tok = support::ascii_lowercase(lex.getString()); + + if (tok.empty()) { + continue; + } else if (tok == "endargument") { + finished = true; + } else if (tok == "labelstring") { + lex.next(); + arg.labelstring = lex.getDocString(); + } else if (tok == "menustring") { + lex.next(); + arg.menustring = lex.getDocString(); + } else if (tok == "mandatory") { + lex.next(); + arg.mandatory = lex.getBool(); + } else if (tok == "autoinsert") { + lex.next(); + arg.autoinsert = lex.getBool(); + } else if (tok == "leftdelim") { + lex.next(); + arg.ldelim = lex.getDocString(); + arg.ldelim = support::subst(arg.ldelim, + from_ascii("
"), from_ascii("\n")); + } else if (tok == "rightdelim") { + lex.next(); + arg.rdelim = lex.getDocString(); + arg.rdelim = support::subst(arg.rdelim, + from_ascii("
"), from_ascii("\n")); + } else if (tok == "defaultarg") { + lex.next(); + arg.defaultarg = lex.getDocString(); + } else if (tok == "presetarg") { + lex.next(); + arg.presetarg = lex.getDocString(); + } else if (tok == "tooltip") { + lex.next(); + arg.tooltip = lex.getDocString(); + } else if (tok == "requires") { + lex.next(); + arg.requires = lex.getString(); + } else if (tok == "decoration") { + lex.next(); + arg.decoration = lex.getString(); + } else if (tok == "font") { + arg.font = lyxRead(lex, arg.font); + } else if (tok == "labelfont") { + arg.labelfont = lyxRead(lex, arg.labelfont); + } else { + lex.printError("Unknown tag"); + error = true; + } + } + if (arg.labelstring.empty()) + LYXERR0("Incomplete Argument definition!"); + else if (postcmd) + postcommandargs_[nr] = arg; + else + latexargs_[nr] = arg; +} + + +Layout::LaTeXArgMap InsetLayout::args() const +{ + Layout::LaTeXArgMap args = latexargs_; + if (!postcommandargs_.empty()) + args.insert(postcommandargs_.begin(), postcommandargs_.end()); + return args; +} + + +unsigned int InsetLayout::optArgs() const +{ + unsigned int nr = 0; + Layout::LaTeXArgMap const args = InsetLayout::args(); + Layout::LaTeXArgMap::const_iterator it = args.begin(); + for (; it != args.end(); ++it) { + if (!(*it).second.mandatory) + ++nr; + } + return nr; +} + + +unsigned int InsetLayout::requiredArgs() const +{ + unsigned int nr = 0; + Layout::LaTeXArgMap const args = InsetLayout::args(); + Layout::LaTeXArgMap::const_iterator it = args.begin(); + for (; it != args.end(); ++it) { + if ((*it).second.mandatory) + ++nr; + } + return nr; +} + + } //namespace lyx