Controllable focus notification API
[ardour.git] / libs / pbd / controllable.cc
index 35f760554189d09d59195343f0a4100fff4ee780..c289ee0287db76d51427c9445eb73ddf69edfd1c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2007 Paul Davis 
+    Copyright (C) 2000-2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 */
 
 #include "pbd/controllable.h"
+#include "pbd/enumwriter.h"
 #include "pbd/xml++.h"
 #include "pbd/error.h"
+#include "pbd/types_convert.h"
+#include "pbd/string_convert.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace PBD;
 using namespace std;
 
-sigc::signal<void,Controllable*> Controllable::Destroyed;
-sigc::signal<bool,Controllable*> Controllable::StartLearning;
-sigc::signal<void,Controllable*> Controllable::StopLearning;
-sigc::signal<void,Controllable*,int,int> Controllable::CreateBinding;
-sigc::signal<void,Controllable*> Controllable::DeleteBinding;
+PBD::Signal1<void,Controllable*> Controllable::Destroyed;
+PBD::Signal1<bool,Controllable*> Controllable::StartLearning;
+PBD::Signal1<void,Controllable*> Controllable::StopLearning;
+PBD::Signal3<void,Controllable*,int,int> Controllable::CreateBinding;
+PBD::Signal1<void,Controllable*> Controllable::DeleteBinding;
+PBD::Signal1<void, boost::weak_ptr<PBD::Controllable> > Controllable::GUIFocusChanged;
 
-Glib::StaticRWLock Controllable::registry_lock = GLIBMM_STATIC_RW_LOCK_INIT;
+Glib::Threads::RWLock Controllable::registry_lock;
 Controllable::Controllables Controllable::registry;
-Controllable::ControllablesByURI Controllable::registry_by_uri;
+PBD::ScopedConnectionList* registry_connections = 0;
+const std::string Controllable::xml_node_name = X_("Controllable");
 
-Controllable::Controllable (const string& name, const string& uri)
+Controllable::Controllable (const string& name, Flag f)
        : _name (name)
-       , _uri (uri)
+       , _flags (f)
        , _touching (false)
 {
-       add ();
+       add (*this);
 }
 
 void
-Controllable::add ()
+Controllable::add (Controllable& ctl)
 {
-       Glib::RWLock::WriterLock lm (registry_lock);
-       registry.insert (this);
-
-       if (!_uri.empty()) {
-               pair<string,Controllable*> newpair;
-               newpair.first = _uri;
-               newpair.second = this;
-               registry_by_uri.insert (newpair);
-       }
-
-       this->GoingAway.connect (mem_fun (this, &Controllable::remove));
-}
+       using namespace boost;
 
-void
-Controllable::remove ()
-{
-       Glib::RWLock::WriterLock lm (registry_lock);
-
-       for (Controllables::iterator i = registry.begin(); i != registry.end(); ++i) {
-               if ((*i) == this) {
-                       registry.erase (i);
-                       break;
-               }
-       }
+       Glib::Threads::RWLock::WriterLock lm (registry_lock);
+       registry.insert (&ctl);
 
-       if (!_uri.empty()) {
-               ControllablesByURI::iterator i = registry_by_uri.find (_uri);
-               if (i != registry_by_uri.end()) {
-                       registry_by_uri.erase (i);
-               }
+       if (!registry_connections) {
+               registry_connections = new ScopedConnectionList;
        }
 
+       /* Controllable::remove() is static - no need to manage this connection */
 
+       ctl.DropReferences.connect_same_thread (*registry_connections, boost::bind (&Controllable::remove, &ctl));
 }
 
 void
-Controllable::set_uri (const string& new_uri)
+Controllable::remove (Controllable* ctl)
 {
-       Glib::RWLock::WriterLock lm (registry_lock);
+       Glib::Threads::RWLock::WriterLock lm (registry_lock);
 
-       if (!_uri.empty()) {
-               ControllablesByURI::iterator i = registry_by_uri.find (_uri);
-               if (i != registry_by_uri.end()) {
-                       registry_by_uri.erase (i);
+       for (Controllables::iterator i = registry.begin(); i != registry.end(); ++i) {
+               if ((*i) == ctl) {
+                       registry.erase (i);
+                       break;
                }
        }
-
-       _uri = new_uri;
-
-       if (!_uri.empty()) {
-               pair<string,Controllable*> newpair;
-               newpair.first = _uri;
-               newpair.second = this;
-               registry_by_uri.insert (newpair);
-       }
 }
 
 Controllable*
 Controllable::by_id (const ID& id)
 {
-       Glib::RWLock::ReaderLock lm (registry_lock);
+       Glib::Threads::RWLock::ReaderLock lm (registry_lock);
 
        for (Controllables::iterator i = registry.begin(); i != registry.end(); ++i) {
                if ((*i)->id() == id) {
@@ -117,22 +92,10 @@ Controllable::by_id (const ID& id)
        return 0;
 }
 
-Controllable*
-Controllable::by_uri (const string& uri)
-{
-       Glib::RWLock::ReaderLock lm (registry_lock);
-       ControllablesByURI::iterator i;
-
-       if ((i = registry_by_uri.find (uri)) != registry_by_uri.end()) {
-               return i->second;
-       }
-       return 0;
-}
-
 Controllable*
 Controllable::by_name (const string& str)
 {
-       Glib::RWLock::ReaderLock lm (registry_lock);
+       Glib::Threads::RWLock::ReaderLock lm (registry_lock);
 
        for (Controllables::iterator i = registry.begin(); i != registry.end(); ++i) {
                if ((*i)->_name == str) {
@@ -145,34 +108,49 @@ Controllable::by_name (const string& str)
 XMLNode&
 Controllable::get_state ()
 {
-       XMLNode* node = new XMLNode (X_("Controllable"));
-       char buf[64];
+       XMLNode* node = new XMLNode (xml_node_name);
+
+       /* Waves' "Pressure3" has a parameter called "µ-iness"
+        * which causes a  parser error : Input is not proper UTF-8, indicate encoding !
+        *  Bytes: 0xB5 0x2D 0x69 0x6E
+        *          <Controllable name="�-iness" id="2391" flags="" value="0.000000000000" p
+        */
+
+       // this is not reloaded from XML, but it must be present because it is
+       // used to find and identify XML nodes by various Controllable-derived objects
 
-       node->add_property (X_("name"), _name); // not reloaded from XML state, just there to look at
-       _id.print (buf, sizeof (buf));
-       node->add_property (X_("id"), buf);
+       node->set_property (X_("name"), _name);
+       node->set_property (X_("id"), id());
+       node->set_property (X_("flags"), _flags);
+       node->set_property (X_("value"), get_save_value());
 
-       if (!_uri.empty()) {
-               node->add_property (X_("uri"), _uri);
+       if (_extra_xml) {
+               node->add_child_copy (*_extra_xml);
        }
-               
+
        return *node;
 }
 
 int
 Controllable::set_state (const XMLNode& node, int /*version*/)
 {
-       const XMLProperty* prop;
-
-       if ((prop = node.property (X_("id"))) != 0) {
-               _id = prop->value();
-               return 0;
-       } else {
-               error << _("Controllable state node has no ID property") << endmsg;
-               return -1;
+       Stateful::save_extra_xml (node);
+
+       set_id (node);
+
+       if (node.get_property (X_("flags"), _flags)) {
+               _flags = Flag(_flags | (_flags & Controllable::RealTime));
        }
 
-       if ((prop = node.property (X_("uri"))) != 0) {
-               set_uri (prop->value());
+       float val;
+       if (node.get_property (X_("value"), val)) {
+                       set_value (val, NoGroup);
        }
+       return 0;
+}
+
+void
+Controllable::set_flags (Flag f)
+{
+       _flags = f;
 }