X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetCommandParams.cpp;h=1f7d32110810fe3e18ed6aee8680e75c4dac11d0;hb=23abb5aaa36af07aadfa5e565869104778ba0d6d;hp=87084c3ee9a3c27f2311b9e0358faa27b903466d;hpb=0e7ab29f49c899cb4fa3b9134cca238ff540a48f;p=lyx.git diff --git a/src/insets/InsetCommandParams.cpp b/src/insets/InsetCommandParams.cpp index 87084c3ee9..1f7d321108 100644 --- a/src/insets/InsetCommandParams.cpp +++ b/src/insets/InsetCommandParams.cpp @@ -12,12 +12,15 @@ #include #include +#include + #include "InsetCommandParams.h" #include "InsetBibitem.h" #include "InsetBibtex.h" #include "InsetCitation.h" +#include "InsetCounter.h" #include "InsetFloatList.h" #include "InsetHyperlink.h" #include "InsetInclude.h" @@ -28,6 +31,7 @@ #include "InsetRef.h" #include "InsetTOC.h" +#include "Buffer.h" #include "Encoding.h" #include "Lexer.h" #include "OutputParams.h" @@ -49,7 +53,6 @@ using namespace lyx::support; namespace lyx { /// Get information for \p code and command \p cmdName. -/// Returns 0 if the combination is not known. [FIXME: 0?] /// Don't call this without first making sure the command name is /// acceptable to the inset. static ParamInfo const & findInfo(InsetCode code, string const & cmdName) @@ -61,6 +64,8 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName) return InsetBibtex::findInfo(cmdName); case CITE_CODE: return InsetCitation::findInfo(cmdName); + case COUNTER_CODE: + return InsetCounter::findInfo(cmdName); case FLOAT_LIST_CODE: return InsetFloatList::findInfo(cmdName); case HYPERLINK_CODE: @@ -82,10 +87,11 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName) case TOC_CODE: return InsetTOC::findInfo(cmdName); default: - LASSERT(false, /**/); + LATTEST(false); + // fall through in release mode } static const ParamInfo pi; - return pi; // to silence the warning + return pi; } @@ -96,8 +102,10 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName) ///////////////////////////////////////////////////////////////////// ParamInfo::ParamData::ParamData(std::string const & s, ParamType t, - ParamHandling h) - : name_(s), type_(t), handling_(h) + ParamHandling h, bool ignore, + docstring default_value) + : name_(s), type_(t), handling_(h), ignore_(ignore), + default_value_(default_value) {} @@ -127,9 +135,10 @@ bool ParamInfo::hasParam(std::string const & name) const void ParamInfo::add(std::string const & name, ParamType type, - ParamHandling handling) -{ - info_.push_back(ParamData(name, type, handling)); + ParamHandling handling, bool ignoreval, + docstring default_value) +{ + info_.push_back(ParamData(name, type, handling, ignoreval, default_value)); } @@ -141,17 +150,19 @@ bool ParamInfo::operator==(ParamInfo const & rhs) const } -ParamInfo::ParamData const & +ParamInfo::ParamData const & ParamInfo::operator[](std::string const & name) const { - LASSERT(hasParam(name), /**/); const_iterator it = begin(); const_iterator last = end(); for (; it != last; ++it) { if (it->name() == name) return *it; } - return *it; // silence warning + LATTEST(false); + // we will try to continue in release mode + static const ParamData pd("asdfghjkl", LYX_INTERNAL); + return pd; } @@ -187,12 +198,14 @@ std::string InsetCommandParams::insetType() const string InsetCommandParams::getDefaultCmd(InsetCode code) { switch (code) { - case BIBITEM_CODE: + case BIBITEM_CODE: return InsetBibitem::defaultCommand(); case BIBTEX_CODE: return InsetBibtex::defaultCommand(); case CITE_CODE: return InsetCitation::defaultCommand(); + case COUNTER_CODE: + return InsetCounter::defaultCommand(); case FLOAT_LIST_CODE: return InsetFloatList::defaultCommand(); case HYPERLINK_CODE: @@ -214,21 +227,24 @@ string InsetCommandParams::getDefaultCmd(InsetCode code) case TOC_CODE: return InsetTOC::defaultCommand(); default: - LASSERT(false, /**/); + LATTEST(false); + // fall through in release mode } - return string(); // silence the warning + return string(); } bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s) { switch (code) { - case BIBITEM_CODE: + case BIBITEM_CODE: return InsetBibitem::isCompatibleCommand(s); case BIBTEX_CODE: return InsetBibtex::isCompatibleCommand(s); case CITE_CODE: return InsetCitation::isCompatibleCommand(s); + case COUNTER_CODE: + return InsetCounter::isCompatibleCommand(s); case FLOAT_LIST_CODE: return InsetFloatList::isCompatibleCommand(s); case HYPERLINK_CODE: @@ -249,17 +265,18 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s) return InsetRef::isCompatibleCommand(s); case TOC_CODE: return InsetTOC::isCompatibleCommand(s); - default: - LASSERT(false, /**/); + default: + LATTEST(false); + // fall through in release mode } - return false; // silence the warning + return false; } void InsetCommandParams::setCmdName(string const & name) { if (!isCompatibleCommand(insetCode_, name)) { - LYXERR0("InsetCommand: Incompatible command name " << + LYXERR0("InsetCommand: Incompatible command name " << name << "."); throw ExceptionMessage(WarningException, _("InsetCommand Error: "), _("Incompatible command name.")); @@ -271,6 +288,12 @@ void InsetCommandParams::setCmdName(string const & name) void InsetCommandParams::read(Lexer & lex) +{ + Read(lex, nullptr); +} + + +void InsetCommandParams::Read(Lexer & lex, Buffer const * buffer) { lex.setContext("InsetCommandParams::read"); lex >> insetName(insetCode_).c_str(); @@ -283,7 +306,12 @@ void InsetCommandParams::read(Lexer & lex) } info_ = findInfo(insetCode_, cmdName_); - + + for (ParamInfo::ParamData const & param : info_) + if (param.ignore()) { + params_[param.name()] = param.defaultValue(); + } + string token; while (lex.isOK()) { lex.next(); @@ -297,7 +325,25 @@ void InsetCommandParams::read(Lexer & lex) } if (info_.hasParam(token)) { lex.next(true); - params_[token] = lex.getDocString(); + docstring data = lex.getDocString(); + if (buffer && token == "filename") { + data = from_utf8(buffer->includedFilePath(to_utf8(data))); + } else if (buffer && token == "bibfiles") { + int i = 0; + docstring newdata; + docstring bib = support::token(data, ',', i); + while (!bib.empty()) { + bib = from_utf8(buffer->includedFilePath(to_utf8(bib), "bib")); + if (!newdata.empty()) + newdata.append(1, ','); + newdata.append(bib); + bib = support::token(data, ',', ++i); + } + data = newdata; + } else if (buffer && token == "options") { + data = from_utf8(buffer->includedFilePath(to_utf8(data), "bst")); + } + params_[token] = data; } else { lex.printError("Unknown parameter name `$$Token' for command " + cmdName_); throw ExceptionMessage(WarningException, @@ -316,6 +362,12 @@ void InsetCommandParams::read(Lexer & lex) void InsetCommandParams::write(ostream & os) const +{ + Write(os, nullptr); +} + + +void InsetCommandParams::Write(ostream & os, Buffer const * buffer) const { os << "CommandInset " << insetType() << '\n'; os << "LatexCommand " << cmdName_ << '\n'; @@ -324,12 +376,31 @@ void InsetCommandParams::write(ostream & os) const ParamInfo::const_iterator it = info_.begin(); ParamInfo::const_iterator end = info_.end(); for (; it != end; ++it) { - std::string const & name = it->name(); - docstring const & data = (*this)[name]; + if (it->ignore()) + continue; + string const & name = it->name(); + string data = to_utf8((*this)[name]); if (!data.empty()) { - // FIXME UNICODE + // Adjust path of files if document was moved + if (buffer && name == "filename") { + data = buffer->includedFilePath(data); + } else if (buffer && name == "bibfiles") { + int i = 0; + string newdata; + string bib = token(data, ',', i); + while (!bib.empty()) { + bib = buffer->includedFilePath(bib, "bib"); + if (!newdata.empty()) + newdata.append(1, ','); + newdata.append(bib); + bib = token(data, ',', ++i); + } + data = newdata; + } else if (buffer && name == "options") { + data = buffer->includedFilePath(data, "bst"); + } os << name << ' ' - << Lexer::quoteString(to_utf8(data)) + << Lexer::quoteString(data) << '\n'; } } @@ -338,9 +409,8 @@ void InsetCommandParams::write(ostream & os) const bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const { - if (!ci->isOptional()) { - LASSERT(false, /**/); - } + LASSERT(ci->isOptional(), return false); + ++ci; // we want to start with the next one ParamInfo::const_iterator end = info_.end(); for (; ci != end; ++ci) { @@ -365,42 +435,123 @@ bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const } - docstring InsetCommandParams::prepareCommand(OutputParams const & runparams, docstring const & command, ParamInfo::ParamHandling handling) const { docstring result; - if (handling == ParamInfo::HANDLING_LATEXIFY) { + bool ltrimmed = false; + // Trimming can be done on top of any of the other handlings + // We check this here since handling might be changed below. + if (handling & ParamInfo::HANDLING_LTRIM) { + // this is used if no other handling is done + result = command; + ltrimmed = true; + } + if (handling & ParamInfo::HANDLING_LATEXIFY + || handling & ParamInfo::HANDLING_INDEX_ESCAPE) + if ((*this)["literal"] == "true") + handling = ParamInfo::HANDLING_NONE; + + // LATEXIFY, ESCAPE and NONE are mutually exclusive + if (handling & ParamInfo::HANDLING_LATEXIFY) { + // First handle backslash + result = subst(command, from_ascii("\\"), from_ascii("\\textbackslash{}")); + // Then get LaTeX macros + pair command_latexed = + runparams.encoding->latexString(result, runparams.dryrun); + result = command_latexed.first; + if (!command_latexed.second.empty()) { + // Issue a warning about omitted characters + // FIXME: should be passed to the error dialog + frontend::Alert::warning(_("Uncodable characters"), + bformat(_("The following characters that are used in the inset %1$s are not\n" + "representable in the current encoding and therefore have been omitted:\n%2$s."), + from_utf8(insetType()), command_latexed.second)); + } + // Now escape special commands + static docstring const backslash = from_ascii("\\"); + int const nchars_escape = 8; + static char_type const chars_escape[nchars_escape] = { + '&', '_', '$', '%', '#', '^', '{', '}'}; + + if (!result.empty()) { + int previous; + // The characters in chars_name[] need to be changed to a command when + // they are LaTeXified. + for (int k = 0; k < nchars_escape; k++) + for (size_t i = 0, pos; + (pos = result.find(chars_escape[k], i)) != string::npos; + i = pos + 2) { + //(Only) \\^ needs to be terminated + docstring const term = (k == 5) ? from_ascii("{}") : docstring(); + if (pos == 0) + previous = 0; + else + previous = pos - 1; + // only if not already escaped + if (result[previous] != '\\') + result.replace(pos, 1, backslash + chars_escape[k] + term); + } + } + } + else if (handling & ParamInfo::HANDLING_ESCAPE) + result = escape(command); + else if (handling & ParamInfo::HANDLING_NONE) { + // we can only output characters covered by the current + // encoding! docstring uncodable; - for (size_t n = 0; n < command.size(); ++n) { + for (size_type i = 0 ; i < command.size() ; ++i) { + char_type c = command[i]; try { - result += runparams.encoding->latexChar(command[n]); + if (runparams.encoding->encodable(c)) + result += c; + else if (runparams.dryrun) { + result += "<" + _("LyX Warning: ") + + _("uncodable character") + " '"; + result += docstring(1, c); + result += "'>"; + } else + uncodable += c; } catch (EncodingException & /* e */) { - LYXERR0("Uncodable character in command inset!"); if (runparams.dryrun) { result += "<" + _("LyX Warning: ") - + _("uncodable character") + " '"; - result += docstring(1, command[n]); + + _("uncodable character") + " '"; + result += docstring(1, c); result += "'>"; } else - uncodable += command[n]; + uncodable += c; } } - if (!uncodable.empty()) { + if (!uncodable.empty() && !runparams.silent) { // issue a warning about omitted characters // FIXME: should be passed to the error dialog - frontend::Alert::warning(_("Uncodable characters"), - bformat(_("The following characters that are used in the inset %1$s are not\n" - "representable in the current encoding and therefore have been omitted:\n%2$s."), - from_utf8(insetType()), uncodable)); + frontend::Alert::warning(_("Uncodable characters in inset"), + bformat(_("The following characters in one of the insets are\n" + "not representable in the current encoding and have been omitted: %1$s.\n" + "Unchecking 'Literal' in the respective inset dialog might help."), + uncodable)); } - } else if (handling == ParamInfo::HANDLING_ESCAPE) - result = escape(command); - else - result = command; + } + // INDEX_ESCAPE is independent of the others + if (handling & ParamInfo::HANDLING_INDEX_ESCAPE) { + // Now escape special commands + static docstring const quote = from_ascii("\""); + int const nchars_escape = 4; + static char_type const chars_escape[nchars_escape] = { '"', '@', '|', '!' }; + + if (!result.empty()) { + // The characters in chars_name[] need to be changed to a command when + // they are LaTeXified. + for (int k = 0; k < nchars_escape; k++) + for (size_t i = 0, pos; + (pos = result.find(chars_escape[k], i)) != string::npos; + i = pos + 2) + result.replace(pos, 1, quote + chars_escape[k]); + } + } - return result; + return ltrimmed ? ltrim(result) : result; } @@ -417,24 +568,24 @@ docstring InsetCommandParams::getCommand(OutputParams const & runparams) const break; case ParamInfo::LATEX_REQUIRED: { - docstring const & data = + docstring const data = prepareCommand(runparams, (*this)[name], it->handling()); s += '{' + data + '}'; noparam = false; break; } case ParamInfo::LATEX_OPTIONAL: { - docstring const & data = + docstring data = prepareCommand(runparams, (*this)[name], it->handling()); if (!data.empty()) { - s += '[' + data + ']'; + s += '[' + protectArgument(data) + ']'; noparam = false; } else if (writeEmptyOptional(it)) { s += "[]"; noparam = false; } break; - } + } } //end switch } if (noparam) @@ -447,30 +598,35 @@ docstring InsetCommandParams::getCommand(OutputParams const & runparams) const docstring InsetCommandParams::getFirstNonOptParam() const { - ParamInfo::const_iterator it = - find_if(info_.begin(), info_.end(), + ParamInfo::const_iterator it = + find_if(info_.begin(), info_.end(), not1(mem_fun_ref(&ParamInfo::ParamData::isOptional))); - if (it == info_.end()) { - LASSERT(false, return docstring()); - } + LASSERT(it != info_.end(), return docstring()); return (*this)[it->name()]; } docstring const & InsetCommandParams::operator[](string const & name) const { - static const docstring dummy; //so we don't return a ref to temporary + static const docstring dummy; LASSERT(info_.hasParam(name), return dummy); ParamMap::const_iterator data = params_.find(name); if (data == params_.end() || data->second.empty()) return dummy; + ParamInfo::ParamData const & param = info_[name]; + if (param.ignore()) + return param.defaultValue(); return data->second; } docstring & InsetCommandParams::operator[](string const & name) { - LASSERT(info_.hasParam(name), /**/); + LATTEST(info_.hasParam(name)); + // this will add the name in release mode + ParamInfo::ParamData const & param = info_[name]; + if (param.ignore()) + params_[name] = param.defaultValue(); return params_[name]; } @@ -478,6 +634,7 @@ docstring & InsetCommandParams::operator[](string const & name) void InsetCommandParams::clear() { params_.clear(); + preview(false); }