libs/pbd/controllable.cc

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "pbd/controllable.h"
  21 #include "pbd/enumwriter.h"
  22 #include "pbd/xml++.h"
  23 #include "pbd/error.h"
  24 #include "pbd/types_convert.h"
  25 #include "pbd/string_convert.h"
  26
  27 #include "pbd/i18n.h"
  28
  29 using namespace PBD;
  30 using namespace std;
  31
  32 PBD::Signal1<void,Controllable*> Controllable::Destroyed;
  33 PBD::Signal1<bool, boost::weak_ptr<PBD::Controllable> > Controllable::StartLearning;
  34 PBD::Signal1<void, boost::weak_ptr<PBD::Controllable> > Controllable::StopLearning;
  35 PBD::Signal1<void, boost::weak_ptr<PBD::Controllable> > Controllable::GUIFocusChanged;
  36
  37 const std::string Controllable::xml_node_name = X_("Controllable");
  38
  39 Controllable::Controllable (const string& name, Flag f)
  40         : _name (name)
  41         , _flags (f)
  42         , _touching (false)
  43 {}
  44
  45 XMLNode&
  46 Controllable::get_state ()
  47 {
  48         XMLNode* node = new XMLNode (xml_node_name);
  49
  50         /* Waves' "Pressure3" has a parameter called "µ-iness"
  51          * which causes a  parser error : Input is not proper UTF-8, indicate encoding !
  52          *  Bytes: 0xB5 0x2D 0x69 0x6E
  53          *          <Controllable name="�-iness" id="2391" flags="" value="0.000000000000" p
  54          */
  55
  56         // this is not reloaded from XML, but it must be present because it is
  57         // used to find and identify XML nodes by various Controllable-derived objects
  58
  59         node->set_property (X_("name"), _name);
  60         node->set_property (X_("id"), id());
  61         node->set_property (X_("flags"), _flags);
  62         node->set_property (X_("value"), get_save_value());
  63
  64         if (_extra_xml) {
  65                 node->add_child_copy (*_extra_xml);
  66         }
  67
  68         return *node;
  69 }
  70
  71 int
  72 Controllable::set_state (const XMLNode& node, int /*version*/)
  73 {
  74         Stateful::save_extra_xml (node);
  75
  76         set_id (node);
  77
  78         if (node.get_property (X_("flags"), _flags)) {
  79                 _flags = Flag(_flags | (_flags & Controllable::RealTime));
  80         }
  81
  82         float val;
  83         if (node.get_property (X_("value"), val)) {
  84                         set_value (val, NoGroup);
  85         }
  86         return 0;
  87 }
  88
  89 void
  90 Controllable::set_flags (Flag f)
  91 {
  92         _flags = f;
  93 }