Code

Merge and cleanup of GSoC C++-ification project.
[inkscape.git] / src / extension / effect.cpp
index fc8715248edc09f14cac2a4a8fbdbda2d0da75b2..51aa42da67fe8699770247393ed1931f235e7572 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * Authors:
  *   Ted Gould <ted@gould.cx>
+ *   Abhishek Sharma
  *
  * Copyright (C) 2002-2007 Authors
  *
@@ -13,7 +14,7 @@
 #include "desktop-handles.h"
 #include "selection.h"
 #include "sp-namedview.h"
-#include "document.h"
+#include "desktop.h"
 #include "implementation/implementation.h"
 #include "effect.h"
 #include "execution-env.h"
@@ -28,6 +29,10 @@ namespace Extension {
 
 Effect * Effect::_last_effect = NULL;
 Inkscape::XML::Node * Effect::_effects_list = NULL;
+Inkscape::XML::Node * Effect::_filters_list = NULL;
+
+#define  EFFECTS_LIST  "effects-list"
+#define  FILTERS_LIST  "filters-list"
 
 Effect::Effect (Inkscape::XML::Node * in_repr, Implementation::Implementation * in_imp)
     : Extension(in_repr, in_imp),
@@ -35,7 +40,8 @@ Effect::Effect (Inkscape::XML::Node * in_repr, Implementation::Implementation *
       _name_noprefs(Glib::ustring(get_name()) + _(" (No preferences)")),
       _verb(get_id(), get_name(), NULL, NULL, this, true),
       _verb_nopref(_id_noprefs.c_str(), _name_noprefs.c_str(), NULL, NULL, this, false),
-      _menu_node(NULL), _workingDialog(true)
+      _menu_node(NULL), _workingDialog(true),
+      _prefDialog(NULL)
 {
     Inkscape::XML::Node * local_effects_menu = NULL;
 
@@ -46,29 +52,33 @@ Effect::Effect (Inkscape::XML::Node * in_repr, Implementation::Implementation *
     bool hidden = false;
 
     no_doc = false;
+    no_live_preview = false;
 
     if (repr != NULL) {
 
         for (Inkscape::XML::Node *child = sp_repr_children(repr); child != NULL; child = child->next()) {
-            if (!strcmp(child->name(), "effect")) {
-                if (child->attribute("needs-document") && !strcmp(child->attribute("needs-document"), "no")) {
+            if (!strcmp(child->name(), INKSCAPE_EXTENSION_NS "effect")) {
+                if (child->attribute("needs-document") && !strcmp(child->attribute("needs-document"), "false")) {
                   no_doc = true;
                 }
+                if (child->attribute("needs-live-preview") && !strcmp(child->attribute("needs-live-preview"), "false")) {
+                  no_live_preview = true;
+                }
                 for (Inkscape::XML::Node *effect_child = sp_repr_children(child); effect_child != NULL; effect_child = effect_child->next()) {
-                    if (!strcmp(effect_child->name(), "effects-menu")) {
+                    if (!strcmp(effect_child->name(), INKSCAPE_EXTENSION_NS "effects-menu")) {
                         // printf("Found local effects menu in %s\n", this->get_name());
                         local_effects_menu = sp_repr_children(effect_child);
-                        if (effect_child->attribute("hidden") && !strcmp(effect_child->attribute("hidden"), "yes")) {
+                        if (effect_child->attribute("hidden") && !strcmp(effect_child->attribute("hidden"), "true")) {
                             hidden = true;
                         }
                     }
-                    if (!strcmp(effect_child->name(), "menu-name") ||
-                            !strcmp(effect_child->name(), "_menu-name")) {
+                    if (!strcmp(effect_child->name(), INKSCAPE_EXTENSION_NS "menu-name") ||
+                            !strcmp(effect_child->name(), INKSCAPE_EXTENSION_NS "_menu-name")) {
                         // printf("Found local effects menu in %s\n", this->get_name());
                         _verb.set_name(sp_repr_children(effect_child)->content());
                     }
-                    if (!strcmp(effect_child->name(), "menu-tip") ||
-                            !strcmp(effect_child->name(), "_menu-tip")) {
+                    if (!strcmp(effect_child->name(), INKSCAPE_EXTENSION_NS "menu-tip") ||
+                            !strcmp(effect_child->name(), INKSCAPE_EXTENSION_NS "_menu-tip")) {
                         // printf("Found local effects menu in %s\n", this->get_name());
                         _verb.set_tip(sp_repr_children(effect_child)->content());
                     }
@@ -78,18 +88,29 @@ Effect::Effect (Inkscape::XML::Node * in_repr, Implementation::Implementation *
         } // children of "inkscape-extension"
     } // if we have an XML file
 
-    if (_effects_list == NULL && INKSCAPE != NULL) {
-        find_effects_list(inkscape_get_menus(INKSCAPE));
+    if (INKSCAPE != NULL) {
+        if (_effects_list == NULL)
+            _effects_list = find_menu(inkscape_get_menus(INKSCAPE), EFFECTS_LIST);
+        if (_filters_list == NULL)
+            _filters_list = find_menu(inkscape_get_menus(INKSCAPE), FILTERS_LIST);
     }
 
-    if (_effects_list != NULL) {
+    if ((_effects_list != NULL || _filters_list != NULL)) {
         Inkscape::XML::Document *xml_doc;
         xml_doc = _effects_list->document();
         _menu_node = xml_doc->createElement("verb");
         _menu_node->setAttribute("verb-id", this->get_id(), false);
 
-        if (!hidden)
-            merge_menu(_effects_list->parent(), _effects_list, local_effects_menu, _menu_node);
+        if (!hidden) {
+            if (_filters_list &&
+                local_effects_menu && 
+                local_effects_menu->attribute("name") && 
+                !strcmp(local_effects_menu->attribute("name"), ("Filters"))) {
+                merge_menu(_filters_list->parent(), _filters_list, sp_repr_children(local_effects_menu), _menu_node);
+            } else if (_effects_list) {
+                merge_menu(_effects_list->parent(), _effects_list, local_effects_menu, _menu_node);
+            }
+        }
     }
 
     return;
@@ -130,12 +151,13 @@ Effect::merge_menu (Inkscape::XML::Node * base,
 
     if (start != NULL) {
         Inkscape::XML::Node * menupass;
-        for (menupass = start->next(); menupass != NULL; menupass = menupass->next()) {
+        for (menupass = start; menupass != NULL && strcmp(menupass->name(), "separator"); menupass = menupass->next()) {
             gchar const * compare_char = NULL;
             if (!strcmp(menupass->name(), "verb")) {
                 gchar const * verbid = menupass->attribute("verb-id");
                 Inkscape::Verb * verb = Inkscape::Verb::getbyid(verbid);
                 if (verb == NULL) {
+                                       g_warning("Unable to find verb '%s' which is referred to in the menus.", verbid);
                     continue;
                 }
                 compare_char = verb->get_name();
@@ -145,6 +167,8 @@ Effect::merge_menu (Inkscape::XML::Node * base,
                     compare_char = menupass->attribute("_name");
             }
 
+            position = menupass->position() + 1;
+
             /* This will cause us to skip tags we don't understand */
             if (compare_char == NULL) {
                 continue;
@@ -186,6 +210,8 @@ Effect::~Effect (void)
 {
     if (get_last_effect() == this)
         set_last_effect(NULL);
+    if (_menu_node)
+        Inkscape::GC::release(_menu_node);
     return;
 }
 
@@ -206,21 +232,22 @@ Effect::check (void)
 bool
 Effect::prefs (Inkscape::UI::View::View * doc)
 {
+    if (_prefDialog != NULL) {
+        _prefDialog->raise();
+        return true;
+    }
+
+    if (param_visible_count() == 0) {
+        effect(doc);
+        return true;
+    }
+
     if (!loaded())
         set_state(Extension::STATE_LOADED);
     if (!loaded()) return false;
 
-    sigc::signal<void> changeSignal;
-
-    Gtk::Widget * controls;
-    controls = imp->prefs_effect(this, doc, &changeSignal);
-
-    ExecutionEnv executionEnv(this, doc, controls);
-    changeSignal.connect(sigc::mem_fun(executionEnv, &ExecutionEnv::preferencesChange));
-
-    timer->lock();
-    executionEnv.run();
-    timer->unlock();
+    _prefDialog = new PrefDialog(this->get_name(), this->get_help(), NULL, this);
+    _prefDialog->show();
 
     return true;
 }
@@ -232,20 +259,27 @@ Effect::prefs (Inkscape::UI::View::View * doc)
     This function first insures that the extension is loaded, and if not,
     loads it.  It then calls the implemention to do the actual work.  It
     also resets the last effect pointer to be this effect.  Finally, it
-    executes a \c sp_document_done to commit the changes to the undo
+    executes a \c SPDocumentUndo::done to commit the changes to the undo
     stack.
 */
 void
 Effect::effect (Inkscape::UI::View::View * doc)
 {
-    printf("Execute effect\n");
+    //printf("Execute effect\n");
     if (!loaded())
         set_state(Extension::STATE_LOADED);
     if (!loaded()) return;
 
 
-    ExecutionEnv executionEnv(this, doc, NULL);
+    ExecutionEnv executionEnv(this, doc);
+    timer->lock();
     executionEnv.run();
+    if (executionEnv.wait()) {
+        executionEnv.commit();
+    } else {
+        executionEnv.cancel();
+    }
+    timer->unlock();
 
     return;
 }
@@ -262,6 +296,19 @@ Effect::effect (Inkscape::UI::View::View * doc)
 void
 Effect::set_last_effect (Effect * in_effect)
 {
+    gchar const * verb_id = in_effect->get_verb()->get_id();
+    gchar const * help_id_prefix = "org.inkscape.help.";
+
+    // We don't want these "effects" to register as the last effect,
+    // this wouldn't be helpful to the user who selects a real effect,
+    // then goes to the help file (implemented as an effect), then goes
+    // back to the effect, only to see it written over by the help file
+    // selection.
+
+    // This snippet should fix this bug:
+    // https://bugs.launchpad.net/inkscape/+bug/600671
+    if (strncmp(verb_id, help_id_prefix, strlen(help_id_prefix)) == 0) return;
+
     if (in_effect == NULL) {
         Inkscape::Verb::get(SP_VERB_EFFECT_LAST)->sensitive(NULL, false);
         Inkscape::Verb::get(SP_VERB_EFFECT_LAST_PREF)->sensitive(NULL, false);
@@ -274,33 +321,40 @@ Effect::set_last_effect (Effect * in_effect)
     return;
 }
 
-#define  EFFECTS_LIST  "effects-list"
-
-bool
-Effect::find_effects_list (Inkscape::XML::Node * menustruct)
+Inkscape::XML::Node *
+Effect::find_menu (Inkscape::XML::Node * menustruct, const gchar *name)
 {
     if (menustruct == NULL) return false;
     for (Inkscape::XML::Node * child = menustruct;
             child != NULL;
             child = child->next()) {
-        if (!strcmp(child->name(), EFFECTS_LIST)) {
-            _effects_list = child;
-            return true;
+        if (!strcmp(child->name(), name)) {
+            return child;
         }
         Inkscape::XML::Node * firstchild = child->firstChild();
-        if (firstchild != NULL)
-            if (find_effects_list(firstchild))
-                return true;
+        if (firstchild != NULL) {
+            Inkscape::XML::Node *found = find_menu (firstchild, name);
+            if (found)
+                return found;
+        }
     }
-    return false;
+    return NULL;
 }
 
+
 Gtk::VBox *
 Effect::get_info_widget(void)
 {
     return Extension::get_info_widget();
 }
 
+void
+Effect::set_pref_dialog (PrefDialog * prefdialog)
+{
+    _prefDialog = prefdialog;
+    return;
+}
+
 /** \brief  Create an action for a \c EffectVerb
     \param  view  Which view the action should be created for
     \return The built action.
@@ -315,7 +369,7 @@ Effect::EffectVerb::make_action (Inkscape::UI::View::View * view)
 
 /** \brief  Decode the verb code and take appropriate action */
 void
-Effect::EffectVerb::perform (SPAction *action, void * data, void *pdata)
+Effect::EffectVerb::perform( SPAction *action, void * data, void */*pdata*/ )
 {
     Inkscape::UI::View::View * current_view = sp_action_get_view(action);
 //  SPDocument * current_document = current_view->doc;