gtk2_ardour/gui_object.h

   1 /*
   2  * Copyright (C) 2011-2012 Carl Hetherington <carl@carlh.net>
   3  * Copyright (C) 2011-2015 Paul Davis <paul@linuxaudiosystems.com>
   4  * Copyright (C) 2015-2016 Robin Gareus <robin@gareus.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef __gtk_ardour_gui_object_h__
  22 #define __gtk_ardour_gui_object_h__
  23
  24 #include <map>
  25 #include <string>
  26
  27 #include "pbd/xml++.h"
  28 #include "pbd/id.h"
  29
  30 class GUIObjectState
  31 {
  32 public:
  33         GUIObjectState ();
  34
  35         static const std::string xml_node_name;
  36         void load (const XMLNode&);
  37
  38         int set_state (const XMLNode&);
  39         XMLNode& get_state () const;
  40
  41         /** Get a string from our state.
  42          *  @param id property of Object node to look for.
  43          *  @param prop_name name of the Object property to return.
  44          *  @param empty if non-0, filled in with true if the property is currently non-existant, otherwise false.
  45          *  @return value of property `prop_name', or empty.
  46          */
  47         std::string get_string (const std::string& id, const std::string& prop_name, bool* empty = 0);
  48
  49         template<typename T> void set_property (const std::string& id, const std::string& prop_name, const T& val) {
  50                 XMLNode* child = get_or_add_node (id);
  51                 child->set_property (prop_name.c_str(), val);
  52         }
  53
  54         /** Remove node with provided id.
  55          *  @param id property of Object node to look for.
  56          */
  57         void remove_node (const std::string& id);
  58         std::list<std::string> all_ids () const;
  59
  60         XMLNode* get_or_add_node (const std::string &);
  61
  62         static XMLNode* get_node (const XMLNode *, const std::string &);
  63         static XMLNode* get_or_add_node (XMLNode *, const std::string &);
  64
  65   private:
  66         // no copy construction. object_map saves pointers to _state XMLNodes
  67         // use set_state(get_state())
  68         GUIObjectState (const GUIObjectState& other);
  69
  70         XMLNode _state;
  71         // ideally we'd use a O(1) hash table here,
  72         // but O(log(N)) is fine already.
  73         std::map <std::string, XMLNode*> object_map;
  74 };
  75
  76 #endif /* __gtk_ardour_gui_object_h__ */