libs/ardour/ardour/configuration.h

   1 /*
   2     Copyright (C) 1999 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 __ardour_configuration_h__
  21 #define __ardour_configuration_h__
  22
  23 #include <map>
  24 #include <vector>
  25
  26 #include <sys/types.h>
  27 #include <string>
  28
  29 #include <pbd/stateful.h>
  30
  31 #include <ardour/types.h>
  32 #include <ardour/utils.h>
  33 #include <ardour/configuration_variable.h>
  34
  35 class XMLNode;
  36
  37 namespace ARDOUR {
  38
  39 class Configuration : public PBD::Stateful
  40 {
  41   public:
  42         Configuration();
  43         virtual ~Configuration();
  44
  45         struct MidiPortDescriptor {
  46                 std::string tag;
  47                 std::string device;
  48                 std::string type;
  49                 std::string mode;
  50
  51                 MidiPortDescriptor (const XMLNode&);
  52                 XMLNode& get_state();
  53         };
  54
  55         std::map<std::string,MidiPortDescriptor *> midi_ports;
  56
  57         std::vector<ConfigVariable<uint32_t> *> canvas_colors;
  58
  59         void map_parameters (sigc::slot<void,const char*> theSlot);
  60
  61         int load_state ();
  62         int save_state ();
  63
  64         /// calls Stateful::*instant_xml methods using
  65         /// ARDOUR::get_user_ardour_path for the directory
  66         void add_instant_xml (XMLNode&);
  67         XMLNode * instant_xml (const std::string& str);
  68
  69         int set_state (const XMLNode&);
  70         XMLNode& get_state (void);
  71         XMLNode& get_variables (sigc::slot<bool,ConfigVariableBase::Owner>, std::string which_node = "Config");
  72         void set_variables (const XMLNode&, ConfigVariableBase::Owner owner);
  73         void pack_canvasvars ();
  74
  75         void set_current_owner (ConfigVariableBase::Owner);
  76
  77         XMLNode* control_protocol_state () { return _control_protocol_state; }
  78
  79         sigc::signal<void,const char*> ParameterChanged;
  80
  81         /* define accessor methods */
  82
  83 #undef  CONFIG_VARIABLE
  84 #undef  CONFIG_VARIABLE_SPECIAL
  85 #define CONFIG_VARIABLE(Type,var,name,value) \
  86         Type get_##var () const { return var.get(); } \
  87         bool set_##var (Type val) { bool ret = var.set (val, current_owner); if (ret) { ParameterChanged (name); } return ret;  }
  88 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) \
  89         Type get_##var () const { return var.get(); } \
  90         bool set_##var (Type val) { bool ret = var.set (val, current_owner); if (ret) { ParameterChanged (name); } return ret; }
  91 #include "ardour/configuration_vars.h"
  92 #undef  CONFIG_VARIABLE
  93 #undef  CONFIG_VARIABLE_SPECIAL
  94
  95 #undef  CANVAS_VARIABLE
  96 #define CANVAS_VARIABLE(var,name) ConfigVariable<uint32_t> var;  // <-- is this really so bad?
  97 #include "ardour/canvas_vars.h"
  98 #undef  CANVAS_VARIABLE
  99
 100   private:
 101
 102         /* declare variables */
 103
 104 #undef  CONFIG_VARIABLE
 105 #undef  CONFIG_VARIABLE_SPECIAL
 106 #define CONFIG_VARIABLE(Type,var,name,value) ConfigVariable<Type> var;
 107 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) ConfigVariableWithMutation<Type> var;
 108 #include "ardour/configuration_vars.h"
 109 #undef  CONFIG_VARIABLE
 110 #undef  CONFIG_VARIABLE_SPECIAL
 111
 112         ConfigVariableBase::Owner current_owner;
 113         XMLNode* _control_protocol_state;
 114
 115         XMLNode& state (sigc::slot<bool,ConfigVariableBase::Owner>);
 116         bool     save_config_options_predicate (ConfigVariableBase::Owner owner);
 117 };
 118
 119 extern Configuration *Config;
 120 extern gain_t speed_quietning; /* see comment in configuration.cc */
 121
 122 } // namespace ARDOUR
 123
 124 #endif /* __ardour_configuration_h__ */