libs/ardour/ardour/rc_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_rc_configuration_h__
  21 #define __ardour_rc_configuration_h__
  22
  23 #include <map>
  24 #include <string>
  25
  26 #include "ardour/libardour_visibility.h"
  27 #include "ardour/types.h"
  28 #include "ardour/utils.h"
  29 #include "ardour/types_convert.h"
  30
  31 #include "pbd/configuration.h"
  32
  33 class XMLNode;
  34
  35 namespace ARDOUR {
  36
  37 class LIBARDOUR_API RCConfiguration : public PBD::Configuration
  38 {
  39   public:
  40         RCConfiguration();
  41         ~RCConfiguration();
  42
  43         void map_parameters (boost::function<void (std::string)>&);
  44         int set_state (XMLNode const &, int version);
  45         XMLNode& get_state ();
  46         XMLNode& get_variables ();
  47         void set_variables (XMLNode const &);
  48
  49         int load_state ();
  50         int save_state ();
  51
  52         /// calls Stateful::*instant_xml methods using
  53         /// ARDOUR::user_config_directory for the directory argument
  54         void add_instant_xml (XMLNode&);
  55         XMLNode * instant_xml (const std::string& str);
  56
  57         XMLNode* control_protocol_state () { return _control_protocol_state; }
  58
  59         /* define accessor methods */
  60
  61 #undef  CONFIG_VARIABLE
  62 #undef  CONFIG_VARIABLE_SPECIAL
  63 #define CONFIG_VARIABLE(Type,var,name,value) \
  64         Type get_##var () const { return var.get(); } \
  65         bool set_##var (Type val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret;  }
  66 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) \
  67         Type get_##var () const { return var.get(); } \
  68         bool set_##var (Type val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret; }
  69 #include "ardour/rc_configuration_vars.h"
  70 #undef  CONFIG_VARIABLE
  71 #undef  CONFIG_VARIABLE_SPECIAL
  72
  73   private:
  74
  75         /* declare variables */
  76
  77 #undef  CONFIG_VARIABLE
  78 #undef  CONFIG_VARIABLE_SPECIAL
  79 #define CONFIG_VARIABLE(Type,var,name,value) PBD::ConfigVariable<Type> var;
  80 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) PBD::ConfigVariableWithMutation<Type> var;
  81 #include "ardour/rc_configuration_vars.h"
  82 #undef  CONFIG_VARIABLE
  83 #undef  CONFIG_VARIABLE_SPECIAL
  84
  85         XMLNode* _control_protocol_state;
  86 };
  87
  88 /* XXX: rename this */
  89 LIBARDOUR_API extern RCConfiguration *Config;
  90 LIBARDOUR_API extern gain_t speed_quietning; /* see comment in configuration.cc */
  91
  92 } // namespace ARDOUR
  93
  94 #endif /* __ardour_configuration_h__ */