]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.cpp
Embedding: display a pin at the top left corner of embedded figures
[lyx.git] / src / insets / InsetCommandParams.cpp
index 5ac876a43824a58cf7cc8081dfc724944a965107..90fe6cca8ad813cd38ac067f29b1e13ee25610ff 100644 (file)
@@ -5,6 +5,7 @@
  *
  * \author Angus Leeming
  * \author Georg Baum
+ * \author Richard Heck
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "InsetCommandParams.h"
 
-#include "debug.h"
-#include "gettext.h"
+#include "InsetBibitem.h"
+#include "InsetBibtex.h"
+#include "InsetCitation.h"
+#include "InsetFloatList.h"
+#include "InsetHFill.h"
+#include "InsetHyperlink.h"
+#include "InsetInclude.h"
+#include "InsetIndex.h"
+#include "InsetLabel.h"
+#include "InsetNomencl.h"
+#include "InsetRef.h"
+#include "InsetTOC.h"
+
+#include "support/debug.h"
+#include "support/gettext.h"
 #include "Lexer.h"
 
 #include "support/ExceptionMessage.h"
 #include "support/lstrings.h"
+#include "support/docstream.h"
 
 #include <boost/assert.hpp>
 
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::findToken;
-
-using std::string;
-using std::endl;
-using std::ostream;
-
-using support::ExceptionMessage;
-using support::WarningException;
-
 
 InsetCommandParams::InsetCommandParams(InsetCode code)
        : insetCode_(code), preview_(false)
@@ -55,101 +63,36 @@ InsetCommandParams::InsetCommandParams(InsetCode code,
 }
 
 
-//FIXME This should go into the Insets themselves...so they will tell
-//us what parameters they want.
-//Should this just vanish in favor of the two arg version, or is there
-//a reason to use it in some cases? What should happen in the single
-//arg case, then? Maybe use the default? or leave that up to the inset?
-InsetCommandParams::CommandInfo const *
-       InsetCommandParams::findInfo(InsetCode code)
+CommandInfo const * InsetCommandParams::findInfo(
+       InsetCode code, string const & cmdName)
 {
-       // No parameter may be named "preview", because that is a required
-       // flag for all commands.
-
        switch (code) {
-       case BIBITEM_CODE: {
-               static const char * const paramnames[] = {"label", "key", ""};
-               static const bool isoptional[] = {true, false};
-               static const CommandInfo info = {2, paramnames, isoptional};
-               return &info;
-       }
-       case BIBTEX_CODE: {
-               static const char * const paramnames[] =
-                               {"options", "btprint", "bibfiles", ""};
-               static const bool isoptional[] = {true, true, false};
-               static const CommandInfo info = {3, paramnames, isoptional};
-               return &info;
-       }
-       case CITE_CODE: {
-               // standard cite does only take one argument if jurabib is
-               // not used, but jurabib extends this to two arguments, so
-               // we have to allow both here. InsetCitation takes care that
-               // LaTeX output is nevertheless correct.
-               static const char * const paramnames[] =
-                               {"after", "before", "key", ""};
-               static const bool isoptional[] = {true, true, false};
-               static const CommandInfo info = {3, paramnames, isoptional};
-               return &info;
-       }
-       case FLOAT_LIST_CODE: {
-               static const char * const paramnames[] = {"type", ""};
-               static const bool isoptional[] = {false};
-               static const CommandInfo info = {1, paramnames, isoptional};
-               return &info;
-       }
-       case HFILL_CODE: {
-               static const char * const paramnames[] = {""};
-               static const CommandInfo info = {0, paramnames, 0};
-               return &info;
-       }
-       case HYPERLINK_CODE: {
-               static const char * const paramnames[] =
-                               {"name", "target", ""};
-               static const bool isoptional[] = {true, false};
-               static const CommandInfo info = {2, paramnames, isoptional};
-               return &info;
-       }
-       case INCLUDE_CODE: {
-               //This is only correct for the case of listings, but it'll do for now.
-               //In the other cases, this second parameter should just be empty.
-               static const char * const paramnames[] = {"filename", "lstparams", ""};
-               static const bool isoptional[] = {false, true};
-               static const CommandInfo info = {2, paramnames, isoptional};
-               return &info;
-       }
-       case INDEX_CODE: 
+       case BIBITEM_CODE:
+               return InsetBibitem::findInfo(cmdName);
+       case BIBTEX_CODE:
+               return InsetBibtex::findInfo(cmdName);
+       case CITE_CODE:
+               return InsetCitation::findInfo(cmdName);        
+       case FLOAT_LIST_CODE:
+               return InsetFloatList::findInfo(cmdName);
+       case HFILL_CODE:
+               return InsetHFill::findInfo(cmdName);
+       case HYPERLINK_CODE:
+               return InsetHyperlink::findInfo(cmdName);
+       case INCLUDE_CODE:
+               return InsetInclude::findInfo(cmdName);
        case INDEX_PRINT_CODE:
-       case LABEL_CODE: {
-               static const char * const paramnames[] = {"name", ""};
-               static const bool isoptional[] = {false};
-               static const CommandInfo info = {1, paramnames, isoptional};
-               return &info;
-       }
-       case NOMENCL_CODE: {
-               static const char * const paramnames[] = {"prefix", "symbol", "description", ""};
-               static const bool isoptional[] = {true, false, false};
-               static const CommandInfo info = {3, paramnames, isoptional};
-               return &info;
-       }
-       case NOMENCL_PRINT_CODE: {
-               static const char * const paramnames[] = {"labelwidth", ""};
-               static const bool isoptional[] = {true};
-               static const CommandInfo info = {1, paramnames, isoptional};
-               return &info;
-       }
-       case REF_CODE: {
-               static const char * const paramnames[] =
-                               {"name", "reference", ""};
-               static const bool isoptional[] = {true, false};
-               static const CommandInfo info = {2, paramnames, isoptional};
-               return &info;
-       }
-       case TOC_CODE: {
-               static const char * const paramnames[] = {"type", ""};
-               static const bool isoptional[] = {false};
-               static const CommandInfo info = {1, paramnames, isoptional};
-               return &info;
-       }
+               return InsetPrintIndex::findInfo(cmdName);
+       case LABEL_CODE:
+               return InsetLabel::findInfo(cmdName);   
+       case NOMENCL_CODE:
+               return InsetNomencl::findInfo(cmdName);
+       case NOMENCL_PRINT_CODE:
+               return InsetPrintNomencl::findInfo(cmdName);
+       case REF_CODE:
+               return InsetRef::findInfo(cmdName);
+       case TOC_CODE:
+               return InsetTOC::findInfo(cmdName);
        default:
                BOOST_ASSERT(false);
        }
@@ -157,61 +100,92 @@ InsetCommandParams::CommandInfo const *
 }
 
 
-//FIXME Will eventually call a static method, etc.
-InsetCommandParams::CommandInfo const *
-               InsetCommandParams::findInfo(InsetCode code,
-                                            std::string const &/* cmdName*/)
-{
-       return findInfo(code);
+string InsetCommandParams::getDefaultCmd(InsetCode code) {
+       switch (code) {
+               case BIBITEM_CODE: 
+                       return InsetBibitem::defaultCommand();
+               case BIBTEX_CODE:
+                       return InsetBibtex::defaultCommand();
+               case CITE_CODE:
+                       return InsetCitation::defaultCommand();
+               case FLOAT_LIST_CODE:
+                       return InsetFloatList::defaultCommand();
+               case HFILL_CODE:
+                       return InsetHFill::defaultCommand();
+               case HYPERLINK_CODE:
+                       return InsetHyperlink::defaultCommand();
+               case INCLUDE_CODE:
+                       return InsetInclude::defaultCommand();
+               case INDEX_PRINT_CODE:
+                       return InsetPrintIndex::defaultCommand();
+               case LABEL_CODE:
+                       return InsetLabel::defaultCommand();
+               case NOMENCL_CODE:
+                       return InsetNomencl::defaultCommand();
+               case NOMENCL_PRINT_CODE:
+                       return InsetPrintNomencl::defaultCommand();
+               case REF_CODE:
+                       return InsetRef::defaultCommand();
+               case TOC_CODE:
+                       return InsetTOC::defaultCommand();
+               default:
+                       BOOST_ASSERT(false);
+       }
+       return string(); //silence the warning
 }
 
 
-//FIXME Should call InsetBibitem::getDefaultCmd(), eg
-std::string InsetCommandParams::getDefaultCmd(InsetCode code) {
+bool InsetCommandParams::isCompatibleCommand(
+               InsetCode code, string const & s)
+{
        switch (code) {
                case BIBITEM_CODE: 
-                       return "bibitem";
+                       return InsetBibitem::isCompatibleCommand(s);
                case BIBTEX_CODE:
-                       return "bibtex"; //this is an unused dummy
+                       return InsetBibtex::isCompatibleCommand(s);
                case CITE_CODE:
-                       return "cite";
+                       return InsetCitation::isCompatibleCommand(s);
                case FLOAT_LIST_CODE:
-                       return "listoftables";
+                       return InsetFloatList::isCompatibleCommand(s);
                case HFILL_CODE:
-                       return "hfill";
+                       return InsetHFill::isCompatibleCommand(s);
                case HYPERLINK_CODE:
-                       return "href";
+                       return InsetHyperlink::isCompatibleCommand(s);
                case INCLUDE_CODE:
-                       return "include";
-               case INDEX_CODE: 
-                       return "index";
+                       return InsetInclude::isCompatibleCommand(s);
                case INDEX_PRINT_CODE:
-                       return "printindex";
+                       return InsetPrintIndex::isCompatibleCommand(s);
                case LABEL_CODE:
-                       return "label";
+                       return InsetLabel::isCompatibleCommand(s);
                case NOMENCL_CODE:
-                       return "nomenclature";
+                       return InsetNomencl::isCompatibleCommand(s);
                case NOMENCL_PRINT_CODE:
-                       return "printnomenclature";
+                       return InsetPrintNomencl::isCompatibleCommand(s);
                case REF_CODE:
-                       return "ref";
+                       return InsetRef::isCompatibleCommand(s);
                case TOC_CODE:
-                       return "tableofcontents";
+                       return InsetTOC::isCompatibleCommand(s);
                default:
                        BOOST_ASSERT(false);
        }
-       return "";
+       return false; //silence the warning
 }
 
 
 void InsetCommandParams::setCmdName(string const & name)
 {
-       //FIXME Check command compatibility
+       if (!isCompatibleCommand(insetCode_, cmdName_)){
+               LYXERR0("InsetCommand: Incompatible command name " << 
+                               name << ".");
+               throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
+                                      from_utf8("Incompatible command name."));
+       }
+
        cmdName_ = name;
        CommandInfo const * const info = findInfo(insetCode_, cmdName_);
        if (!info) {
-               lyxerr << "Command '" << name << "' is not compatible with a '" <<
-                       insetType() << "' inset." << std::endl;
+               LYXERR0("Command '" << name << "' is not compatible with a '" <<
+                       insetType() << "' inset.");
                return;
        }
        ParamVector params(info->n);
@@ -222,7 +196,7 @@ void InsetCommandParams::setCmdName(string const & name)
                        params[j] = params_[i];
        }
        info_ = info;
-       std::swap(params, params_);
+       swap(params, params_);
 }
 
 
@@ -250,12 +224,12 @@ void InsetCommandParams::read(Lexer & lex)
        }
        lex.next();
        cmdName_ = lex.getString();
-       //FIXME
-       //check that this command is ok with the inset...
-       //so that'll be some kind of static call, depending 
-       //upon what insetType_ is.
-       //it's possible that should go into InsetCommand.cpp,
-       //or maybe it's a standalone function.
+       if (!isCompatibleCommand(insetCode_, cmdName_)){
+               lex.printError("InsetCommand: Incompatible command name " + cmdName_ + ".");
+               throw ExceptionMessage(WarningException, _("InsetCommand Error: "),
+                                      from_utf8("Incompatible command name."));
+       }
+
        info_ = findInfo(insetCode_, cmdName_);
        if (!info_) {
                lex.printError("InsetCommand: Unknown inset name `$$Token'");