]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.cpp
Fix mis-nomer
[lyx.git] / src / insets / InsetCommandParams.cpp
index d3db765d3f5f2d74c5231391cf6912deaa07e5aa..931e1bb09376111ee656618b3956beffb678d170 100644 (file)
@@ -12,6 +12,8 @@
 
 #include <config.h>
 #include <algorithm>
+#include <functional>
+
 
 #include "InsetCommandParams.h"
 
 #include "InsetInclude.h"
 #include "InsetIndex.h"
 #include "InsetLabel.h"
+#include "InsetLine.h"
 #include "InsetNomencl.h"
 #include "InsetRef.h"
 #include "InsetTOC.h"
 
+#include "Buffer.h"
+#include "Encoding.h"
 #include "Lexer.h"
+#include "OutputParams.h"
+
+#include "frontends/alert.h"
 
 #include "support/debug.h"
 #include "support/docstream.h"
@@ -44,7 +52,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)
@@ -55,7 +62,7 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
        case BIBTEX_CODE:
                return InsetBibtex::findInfo(cmdName);
        case CITE_CODE:
-               return InsetCitation::findInfo(cmdName);        
+               return InsetCitation::findInfo(cmdName);
        case FLOAT_LIST_CODE:
                return InsetFloatList::findInfo(cmdName);
        case HYPERLINK_CODE:
@@ -65,7 +72,9 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
        case INDEX_PRINT_CODE:
                return InsetPrintIndex::findInfo(cmdName);
        case LABEL_CODE:
-               return InsetLabel::findInfo(cmdName);   
+               return InsetLabel::findInfo(cmdName);
+       case LINE_CODE:
+               return InsetLine::findInfo(cmdName);
        case NOMENCL_CODE:
                return InsetNomencl::findInfo(cmdName);
        case NOMENCL_PRINT_CODE:
@@ -75,10 +84,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;
 }
 
 
@@ -88,8 +98,9 @@ static ParamInfo const & findInfo(InsetCode code, string const & cmdName)
 //
 /////////////////////////////////////////////////////////////////////
 
-ParamInfo::ParamData::ParamData(std::string const & s, ParamType t)
-       : name_(s), type_(t)
+ParamInfo::ParamData::ParamData(std::string const & s, ParamType t,
+                               ParamHandling h)
+       : name_(s), type_(t), handling_(h)
 {}
 
 
@@ -101,7 +112,8 @@ bool ParamInfo::ParamData::isOptional() const
 
 bool ParamInfo::ParamData::operator==(ParamInfo::ParamData const & rhs) const
 {
-       return name() == rhs.name() && type() == rhs.type();
+       return name() == rhs.name() && type() == rhs.type()
+               && handling() == rhs.handling();
 }
 
 
@@ -117,9 +129,10 @@ bool ParamInfo::hasParam(std::string const & name) const
 }
 
 
-void ParamInfo::add(std::string const & name, ParamType type)
+void ParamInfo::add(std::string const & name, ParamType type,
+                   ParamHandling handling)
 { 
-       info_.push_back(ParamData(name, type)); 
+       info_.push_back(ParamData(name, type, handling)); 
 }
 
 
@@ -134,14 +147,16 @@ bool ParamInfo::operator==(ParamInfo const & rhs) 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;
 }
 
 
@@ -193,6 +208,8 @@ string InsetCommandParams::getDefaultCmd(InsetCode code)
                        return InsetPrintIndex::defaultCommand();
                case LABEL_CODE:
                        return InsetLabel::defaultCommand();
+               case LINE_CODE:
+                       return InsetLine::defaultCommand();
                case NOMENCL_CODE:
                        return InsetNomencl::defaultCommand();
                case NOMENCL_PRINT_CODE:
@@ -202,9 +219,10 @@ 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();
 }
 
 
@@ -227,6 +245,8 @@ bool InsetCommandParams::isCompatibleCommand(InsetCode code, string const & s)
                        return InsetPrintIndex::isCompatibleCommand(s);
                case LABEL_CODE:
                        return InsetLabel::isCompatibleCommand(s);
+               case LINE_CODE:
+                       return InsetLine::isCompatibleCommand(s);
                case NOMENCL_CODE:
                        return InsetNomencl::isCompatibleCommand(s);
                case NOMENCL_PRINT_CODE:
@@ -235,16 +255,17 @@ 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_, cmdName_)) {
+       if (!isCompatibleCommand(insetCode_, name)) {
                LYXERR0("InsetCommand: Incompatible command name " << 
                                name << ".");
                throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
@@ -257,6 +278,12 @@ void InsetCommandParams::setCmdName(string const & name)
 
 
 void InsetCommandParams::read(Lexer & lex)
+{
+       Read(lex, 0);
+}
+
+
+void InsetCommandParams::Read(Lexer & lex, Buffer const * buffer)
 {
        lex.setContext("InsetCommandParams::read");
        lex >> insetName(insetCode_).c_str();
@@ -283,7 +310,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,
@@ -302,6 +347,12 @@ void InsetCommandParams::read(Lexer & lex)
 
 
 void InsetCommandParams::write(ostream & os) const
+{
+       Write(os, 0);
+}
+
+
+void InsetCommandParams::Write(ostream & os, Buffer const * buffer) const
 {
        os << "CommandInset " << insetType() << '\n';
        os << "LatexCommand " << cmdName_ << '\n';
@@ -310,12 +361,29 @@ 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];
+               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';
                }
        }
@@ -324,9 +392,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) {
@@ -351,7 +418,39 @@ bool InsetCommandParams::writeEmptyOptional(ParamInfo::const_iterator ci) const
 }
 
 
-docstring InsetCommandParams::getCommand() const
+docstring InsetCommandParams::prepareCommand(OutputParams const & runparams,
+                                            docstring const & command,
+                                            ParamInfo::ParamHandling handling) const
+{
+       docstring result;
+       switch (handling) {
+       case ParamInfo::HANDLING_LATEXIFY: {
+               pair<docstring, docstring> command_latexed =
+                       runparams.encoding->latexString(command, 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));
+               }
+               break;
+       } 
+       case ParamInfo::HANDLING_ESCAPE:
+               result = escape(command);
+               break;
+       case ParamInfo::HANDLING_NONE:
+               result = command;
+               break;
+       } // switch
+
+       return result;
+}
+
+
+docstring InsetCommandParams::getCommand(OutputParams const & runparams) const
 {
        docstring s = '\\' + from_ascii(cmdName_);
        bool noparam = true;
@@ -364,13 +463,15 @@ docstring InsetCommandParams::getCommand() const
                        break;
 
                case ParamInfo::LATEX_REQUIRED: {
-                       docstring const & data = (*this)[name];
+                       docstring const data =
+                               prepareCommand(runparams, (*this)[name], it->handling());
                        s += '{' + data + '}';
                        noparam = false;
                        break;
                }
                case ParamInfo::LATEX_OPTIONAL: {
-                       docstring const & data = (*this)[name];
+                       docstring const data =
+                               prepareCommand(runparams, (*this)[name], it->handling());
                        if (!data.empty()) {
                                s += '[' + data + ']';
                                noparam = false;
@@ -395,16 +496,14 @@ docstring InsetCommandParams::getFirstNonOptParam() const
        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())
@@ -415,7 +514,8 @@ docstring const & InsetCommandParams::operator[](string const & name) const
 
 docstring & InsetCommandParams::operator[](string const & name)
 {
-       LASSERT(info_.hasParam(name), /**/);
+       LATTEST(info_.hasParam(name));
+       // this will add the name in release mode
        return params_[name];
 }