settings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __SETTINGS_SETTINGS_H__
#define __SETTINGS_SETTINGS_H__
 
#include <stdbool.h>
 
#include <gtk/gtk.h>
 
typedef struct PluginSettings PluginSettings;
typedef struct UserShortcuts  UserShortcuts;
 
#define GSETTINGS_ZRYTHM_PREFIX "org.zrythm.Zrythm"
#define SETTINGS (ZRYTHM->settings)
 
/* ---- Standard settings ---- */
#define S_MONITOR SETTINGS->monitor
#define S_UI SETTINGS->ui
#define S_EXPORT_AUDIO SETTINGS->export_audio
#define S_EXPORT_MIDI SETTINGS->export_midi
#define S_GENERAL SETTINGS->general
#define S_UI_INSPECTOR SETTINGS->ui_inspector
#define S_UI_MIXER SETTINGS->ui_mixer
#define S_UI_PANELS SETTINGS->ui_panels
#define S_UI_PLUGIN_BROWSER SETTINGS->ui_plugin_browser
#define S_UI_FILE_BROWSER SETTINGS->ui_file_browser
#define S_TRANSPORT SETTINGS->transport
 
/* ---- end standard settings ---- */
 
/* ---- Preferences ---- */
#define S_P_DSP_PAN SETTINGS->preferences_dsp_pan
#define S_P_EDITING_AUDIO SETTINGS->preferences_editing_audio
#define S_P_EDITING_AUTOMATION \
  SETTINGS->preferences_editing_automation
#define S_P_EDITING_UNDO SETTINGS->preferences_editing_undo
#define S_P_GENERAL_ENGINE \
  SETTINGS->preferences_general_engine
#define S_P_GENERAL_PATHS SETTINGS->preferences_general_paths
#define S_P_GENERAL_UPDATES \
  SETTINGS->preferences_general_updates
#define S_P_PLUGINS_UIS SETTINGS->preferences_plugins_uis
#define S_P_PLUGINS_PATHS SETTINGS->preferences_plugins_paths
#define S_P_PROJECTS_GENERAL \
  SETTINGS->preferences_projects_general
#define S_P_UI_GENERAL SETTINGS->preferences_ui_general
#define S_P_SCRIPTING_GENERAL \
  SETTINGS->preferences_scripting_general
 
/* ---- end preferences ---- */
 
#define S_IS_DEBUG (g_settings_get_int (S_GENERAL, "debug"))
 
#define S_SET_ENUM(settings, key, val) \
  g_settings_set_enum (settings, key, val)
 
#define S_GET_ENUM(settings, key) \
  g_settings_get_enum (settings, key)
 
#define S_UI_SET_ENUM(key, val) S_SET_ENUM (S_UI, key, val)
 
#define S_UI_GET_ENUM(key) S_GET_ENUM (S_UI, key)
 
#define S_PLUGIN_SETTINGS SETTINGS->plugin_settings
 
#define S_USER_SHORTCUTS SETTINGS->user_shortcuts
 
typedef struct Settings
{
  GSettings * general;
 
  GSettings * preferences_dsp_pan;
  GSettings * preferences_editing_audio;
  GSettings * preferences_editing_automation;
  GSettings * preferences_editing_undo;
  GSettings * preferences_general_engine;
  GSettings * preferences_general_paths;
  GSettings * preferences_general_updates;
  GSettings * preferences_plugins_uis;
  GSettings * preferences_plugins_paths;
  GSettings * preferences_projects_general;
  GSettings * preferences_ui_general;
  GSettings * preferences_scripting_general;
 
  GSettings * monitor;
 
  GSettings * ui;
 
  GSettings * transport;
 
  GSettings * export_audio;
  GSettings * export_midi;
 
  GSettings * ui_mixer;
  GSettings * ui_inspector;
  GSettings * ui_panels;
  GSettings * ui_plugin_browser;
  GSettings * ui_file_browser;
 
  PluginSettings * plugin_settings;
 
  UserShortcuts * user_shortcuts;
} Settings;
 
Settings *
settings_new (void);
 
bool
settings_reset_to_factory (
  bool        confirm,
  GtkWindow * window,
  bool        exit_on_finish);
 
void
settings_print (int pretty_print);
 
NONNULL bool
settings_strv_contains_str (
  GSettings *  settings,
  const char * key,
  const char * val);
 
NONNULL void
settings_append_to_strv (
  GSettings *  settings,
  const char * key,
  const char * val,
  bool         ignore_if_duplicate);
 
GVariant *
settings_get_range (const char * schema, const char * key);
 
void
settings_get_range_double (
  const char * schema,
  const char * key,
  double *     lower,
  double *     upper);
 
GVariant *
settings_get_default_value (
  const char * schema,
  const char * key);
 
double
settings_get_default_value_double (
  const char * schema,
  const char * key);
 
char *
settings_get_summary (GSettings * settings, const char * key);
 
char *
settings_get_description (
  GSettings *  settings,
  const char * key);
 
void
settings_free (Settings * self);
 
#endif