gtk2_ardour/gui_object.h

   1 /*
   2     Copyright (C) 2011 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 #ifndef __gtk_ardour_gui_object_h__
  21 #define __gtk_ardour_gui_object_h__
  22
  23 #include <map>
  24 #include <string>
  25
  26 #include <boost/variant.hpp>
  27
  28 #include "pbd/xml++.h"
  29 #include "pbd/id.h"
  30
  31 class GUIObjectState
  32 {
  33 public:
  34         GUIObjectState ();
  35
  36         static const std::string xml_node_name;
  37         void load (const XMLNode&);
  38
  39         int set_state (const XMLNode&);
  40         XMLNode& get_state () const;
  41
  42         /** Get a string from our state.
  43          *  @param id property of Object node to look for.
  44          *  @param prop_name name of the Object property to return.
  45          *  @param empty if non-0, filled in with true if the property is currently non-existant, otherwise false.
  46          *  @return value of property `prop_name', or empty.
  47          */
  48         std::string get_string (const std::string& id, const std::string& prop_name, bool* empty = 0);
  49
  50         template<typename T> void set_property (const std::string& id, const std::string& prop_name, const T& val) {
  51                 XMLNode* child = get_or_add_node (id);
  52                 std::stringstream s;
  53                 s << val;
  54                 child->add_property (prop_name.c_str(), s.str());
  55         }
  56
  57         /** Remove node with provided id.
  58          *  @param id property of Object node to look for.
  59          */
  60         void remove_node (const std::string& id);
  61         std::list<std::string> all_ids () const;
  62
  63         XMLNode* get_or_add_node (const std::string &);
  64
  65         static XMLNode* get_node (const XMLNode *, const std::string &);
  66         static XMLNode* get_or_add_node (XMLNode *, const std::string &);
  67
  68   private:
  69         // no copy construction. object_map saves pointers to _state XMLNodes
  70         // use set_state(get_state())
  71         GUIObjectState (const GUIObjectState& other);
  72
  73         XMLNode _state;
  74         // ideally we'd use a O(1) hash table here,
  75         // but O(log(N)) is fine already.
  76         std::map <std::string, XMLNode*> object_map;
  77 };
  78
  79 #endif /* __gtk_ardour_gui_object_h__ */