src/gigedit/Settings.cpp

/*
    Copyright (c) 2014-2016 Christian Schoenebeck
    
    This file is part of "gigedit" and released under the terms of the
    GNU General Public License version 2.
*/

#include "Settings.h"
#include <glib.h>
#include "global.h"
#include <glibmm/keyfile.h>
#include <iostream>
#include <stdio.h>
#include <fstream>

#if (GTKMM_MAJOR_VERSION == 2 && GTKMM_MINOR_VERSION < 40) || GTKMM_MAJOR_VERSION < 2
# define HAS_GLIB_KEYFILE_SAVE_TO_FILE 0
#else
# define HAS_GLIB_KEYFILE_SAVE_TO_FILE 1
#endif

static std::string configDir() {
    //printf("configDir '%s'\n", g_get_user_config_dir());
    return g_get_user_config_dir();
}

static std::string dirSep() {
    //printf("sep '%s'\n", G_DIR_SEPARATOR_S);
    return G_DIR_SEPARATOR_S;
}

static std::string configFile() {
    return configDir() + dirSep() + "gigedit.conf";
}

static std::string groupName(Settings::Group_t group) {
    switch (group) {
        case Settings::GLOBAL: return "Global";
        case Settings::MAIN_WINDOW: return "MainWindow";
        case Settings::SCRIPT_EDITOR: return "ScriptEditor";
        case Settings::DIMENSION_MANAGER: return "DimensionManager";
        case Settings::SCRIPT_SLOTS: return "ScriptSlots";
        case Settings::COMBINE_INSTRUMENTS: return "CombineInstruments";
        case Settings::MIDI_RULES: return "MidiRules";
        case Settings::FILE_PROPS: return "FileProps";
        case Settings::INSTR_PROPS: return "InstrProps";
        case Settings::SAMPLE_REFS: return "SampleRefs";
    }
    return "Global";
}

#if !HAS_GLIB_KEYFILE_SAVE_TO_FILE

static bool saveToFile(Glib::KeyFile* keyfile, std::string filename) {
    Glib::ustring s = keyfile->to_data();
    std::ofstream out;
    out.open(filename.c_str(), std::ios_base::out | std::ios_base::trunc);
    out << s;
    out.close();
    return true;
}

#endif // ! HAS_GLIB_KEYFILE_SAVE_TO_FILE

static Settings* _instance = NULL;
    
Settings* Settings::singleton() {
    if (!_instance) {
        _instance = new Settings;
        _instance->load();
    }
    return _instance;
}

Settings::Settings() : Glib::ObjectBase(typeid(Settings)),
    warnUserOnExtensions(*this, GLOBAL, "warnUserOnExtensions", true),
    syncSamplerInstrumentSelection(*this, GLOBAL, "syncSamplerInstrumentSelection", true),
    moveRootNoteWithRegionMoved(*this, GLOBAL, "moveRootNoteWithRegionMoved", true),
    autoRestoreWindowDimension(*this, GLOBAL, "autoRestoreWindowDimension", false),
    mainWindowX(*this, MAIN_WINDOW, "x", -1),
    mainWindowY(*this, MAIN_WINDOW, "y", -1),
    mainWindowW(*this, MAIN_WINDOW, "w", -1),
    mainWindowH(*this, MAIN_WINDOW, "h", -1),
    scriptEditorWindowX(*this, SCRIPT_EDITOR, "x", -1),
    scriptEditorWindowY(*this, SCRIPT_EDITOR, "y", -1),
    scriptEditorWindowW(*this, SCRIPT_EDITOR, "w", -1),
    scriptEditorWindowH(*this, SCRIPT_EDITOR, "h", -1),
    dimensionManagerWindowX(*this, DIMENSION_MANAGER, "x", -1),
    dimensionManagerWindowY(*this, DIMENSION_MANAGER, "y", -1),
    dimensionManagerWindowW(*this, DIMENSION_MANAGER, "w", -1),
    dimensionManagerWindowH(*this, DIMENSION_MANAGER, "h", -1),
    scriptSlotsWindowX(*this, SCRIPT_SLOTS, "x", -1),
    scriptSlotsWindowY(*this, SCRIPT_SLOTS, "y", -1),
    scriptSlotsWindowW(*this, SCRIPT_SLOTS, "w", -1),
    scriptSlotsWindowH(*this, SCRIPT_SLOTS, "h", -1),
    combineInstrumentsWindowX(*this, COMBINE_INSTRUMENTS, "x", -1),
    combineInstrumentsWindowY(*this, COMBINE_INSTRUMENTS, "y", -1),
    combineInstrumentsWindowW(*this, COMBINE_INSTRUMENTS, "w", -1),
    combineInstrumentsWindowH(*this, COMBINE_INSTRUMENTS, "h", -1),
    midiRulesWindowX(*this, MIDI_RULES, "x", -1),
    midiRulesWindowY(*this, MIDI_RULES, "y", -1),
    midiRulesWindowW(*this, MIDI_RULES, "w", -1),
    midiRulesWindowH(*this, MIDI_RULES, "h", -1),
    filePropsWindowX(*this, FILE_PROPS, "x", -1),
    filePropsWindowY(*this, FILE_PROPS, "y", -1),
    filePropsWindowW(*this, FILE_PROPS, "w", -1),
    filePropsWindowH(*this, FILE_PROPS, "h", -1),
    instrPropsWindowX(*this, INSTR_PROPS, "x", -1),
    instrPropsWindowY(*this, INSTR_PROPS, "y", -1),
    instrPropsWindowW(*this, INSTR_PROPS, "w", -1),
    instrPropsWindowH(*this, INSTR_PROPS, "h", -1),
    sampleRefsWindowX(*this, SAMPLE_REFS, "x", -1),
    sampleRefsWindowY(*this, SAMPLE_REFS, "y", -1),
    sampleRefsWindowW(*this, SAMPLE_REFS, "w", -1),
    sampleRefsWindowH(*this, SAMPLE_REFS, "h", -1),
    m_ignoreNotifies(false)
{
    m_boolProps.push_back(&warnUserOnExtensions);
    m_boolProps.push_back(&syncSamplerInstrumentSelection);
    m_boolProps.push_back(&moveRootNoteWithRegionMoved);
    m_boolProps.push_back(&autoRestoreWindowDimension);
    m_intProps.push_back(&mainWindowX);
    m_intProps.push_back(&mainWindowY);
    m_intProps.push_back(&mainWindowW);
    m_intProps.push_back(&mainWindowH);
    m_intProps.push_back(&scriptEditorWindowX);
    m_intProps.push_back(&scriptEditorWindowY);
    m_intProps.push_back(&scriptEditorWindowW);
    m_intProps.push_back(&scriptEditorWindowH);
    m_intProps.push_back(&dimensionManagerWindowX);
    m_intProps.push_back(&dimensionManagerWindowY);
    m_intProps.push_back(&dimensionManagerWindowW);
    m_intProps.push_back(&dimensionManagerWindowH);
    m_intProps.push_back(&scriptSlotsWindowX);
    m_intProps.push_back(&scriptSlotsWindowY);
    m_intProps.push_back(&scriptSlotsWindowW);
    m_intProps.push_back(&scriptSlotsWindowH);
    m_intProps.push_back(&combineInstrumentsWindowX);
    m_intProps.push_back(&combineInstrumentsWindowY);
    m_intProps.push_back(&combineInstrumentsWindowW);
    m_intProps.push_back(&combineInstrumentsWindowH);
    m_intProps.push_back(&midiRulesWindowX);
    m_intProps.push_back(&midiRulesWindowY);
    m_intProps.push_back(&midiRulesWindowW);
    m_intProps.push_back(&midiRulesWindowH);
    m_intProps.push_back(&filePropsWindowX);
    m_intProps.push_back(&filePropsWindowY);
    m_intProps.push_back(&filePropsWindowW);
    m_intProps.push_back(&filePropsWindowH);
    m_intProps.push_back(&instrPropsWindowX);
    m_intProps.push_back(&instrPropsWindowY);
    m_intProps.push_back(&instrPropsWindowW);
    m_intProps.push_back(&instrPropsWindowH);
    m_intProps.push_back(&sampleRefsWindowX);
    m_intProps.push_back(&sampleRefsWindowY);
    m_intProps.push_back(&sampleRefsWindowW);
    m_intProps.push_back(&sampleRefsWindowH);
}

void Settings::onPropertyChanged(Glib::PropertyBase* pProperty, RawValueType_t type, Group_t group) {
    if (m_ignoreNotifies) return;

    //printf("Settings::onPropertyChanged(%s)\n", pProperty->get_name().c_str());

    Glib::KeyFile file;
    try {
        bool ok = file.load_from_file(configFile());
        if (!ok) {
            std::cerr << "Could not load '" << configFile() << "'\n" << std::flush;
        }
    } catch (...) {
        std::cerr << "Could not load '" << configFile() << "'\n" << std::flush;
    }

    switch (type) {
        case BOOLEAN: {
            Property<bool>* prop = static_cast<Property<bool>*>(pProperty);
            //std::cout << "Saving bool setting '" << prop->get_name() << "'\n" << std::flush;
            file.set_boolean(groupName(prop->group()), prop->get_name(), prop->get_value());
            break;
        }
        case INTEGER: {
            Property<int>* prop = static_cast<Property<int>*>(pProperty);
            //std::cout << "Saving int setting '" << prop->get_name() << "'\n" << std::flush;
            file.set_integer(groupName(prop->group()), prop->get_name(), prop->get_value());
            break;
        }
        case UNKNOWN:
            std::cerr << "BUG: Unknown setting raw type of property '" << pProperty->get_name() << "'\n" << std::flush;
            return;
    }

    try {
#if HAS_GLIB_KEYFILE_SAVE_TO_FILE
        bool ok = file.save_to_file(configFile());
#else
        bool ok = saveToFile(&file, configFile());
#endif
        if (!ok) {
            std::cerr << "Failed saving gigedit config to '" << configFile() << "'\n" << std::flush;
        } else {
            //std::cout <<"gigedit CONFIG SAVED\n";
        }
    } catch (...) {
        std::cerr << "Failed saving gigedit config to '" << configFile() << "'\n" << std::flush;
    }
}

void Settings::load() {
    Glib::KeyFile file;
    try {
        bool ok = file.load_from_file(configFile());
        if (!ok) return;
    } catch (...) {
        std::cerr << "Could not load gigedit config file '" << configFile() << "'\n" << std::flush;
        return;
    }

    // ignore onPropertyChanged() calls during updating the property values below
    m_ignoreNotifies = true;

    for (int i = 0; i < m_boolProps.size(); ++i) {
        Property<bool>* prop = static_cast<Property<bool>*>(m_boolProps[i]);
        try {
            const std::string group = groupName(prop->group());
            if (!file.has_key(group, prop->get_name())) continue;
            const bool value = file.get_boolean(group, prop->get_name());
            prop->set_value(value);
        } catch (...) {
            continue;
        }
    }

    for (int i = 0; i < m_intProps.size(); ++i) {
        Property<int>* prop = static_cast<Property<int>*>(m_intProps[i]);
        try {
            const std::string group = groupName(prop->group());
            if (!file.has_key(group, prop->get_name())) continue;
            const int value = file.get_integer(group, prop->get_name());
            prop->set_value(value);
        } catch (...) {
            continue;
        }
    }

    m_ignoreNotifies = false;
}

1	schoenebeck	2541	/*
2	schoenebeck	2891	Copyright (c) 2014-2016 Christian Schoenebeck
3	schoenebeck	2541
4			This file is part of "gigedit" and released under the terms of the
5			GNU General Public License version 2.
6			*/
7
8			#include "Settings.h"
9	schoenebeck	2891	#include <glib.h>
10			#include "global.h"
11			#include <glibmm/keyfile.h>
12			#include <iostream>
13			#include <stdio.h>
14	schoenebeck	2892	#include <fstream>
15	schoenebeck	2541
16	schoenebeck	2892	#if (GTKMM_MAJOR_VERSION == 2 && GTKMM_MINOR_VERSION < 40) \|\| GTKMM_MAJOR_VERSION < 2
17			# define HAS_GLIB_KEYFILE_SAVE_TO_FILE 0
18			#else
19			# define HAS_GLIB_KEYFILE_SAVE_TO_FILE 1
20			#endif
21
22	schoenebeck	2891	static std::string configDir() {
23			//printf("configDir '%s'\n", g_get_user_config_dir());
24			return g_get_user_config_dir();
25			}
26
27			static std::string dirSep() {
28			//printf("sep '%s'\n", G_DIR_SEPARATOR_S);
29			return G_DIR_SEPARATOR_S;
30			}
31
32			static std::string configFile() {
33			return configDir() + dirSep() + "gigedit.conf";
34			}
35
36			static std::string groupName(Settings::Group_t group) {
37	schoenebeck	2893	switch (group) {
38			case Settings::GLOBAL: return "Global";
39			case Settings::MAIN_WINDOW: return "MainWindow";
40			case Settings::SCRIPT_EDITOR: return "ScriptEditor";
41	schoenebeck	2894	case Settings::DIMENSION_MANAGER: return "DimensionManager";
42			case Settings::SCRIPT_SLOTS: return "ScriptSlots";
43			case Settings::COMBINE_INSTRUMENTS: return "CombineInstruments";
44			case Settings::MIDI_RULES: return "MidiRules";
45			case Settings::FILE_PROPS: return "FileProps";
46			case Settings::INSTR_PROPS: return "InstrProps";
47			case Settings::SAMPLE_REFS: return "SampleRefs";
48	schoenebeck	2893	}
49	schoenebeck	2891	return "Global";
50			}
51
52	schoenebeck	2892	#if !HAS_GLIB_KEYFILE_SAVE_TO_FILE
53
54			static bool saveToFile(Glib::KeyFile* keyfile, std::string filename) {
55			Glib::ustring s = keyfile->to_data();
56			std::ofstream out;
57			out.open(filename.c_str(), std::ios_base::out \| std::ios_base::trunc);
58			out << s;
59			out.close();
60			return true;
61			}
62
63			#endif // ! HAS_GLIB_KEYFILE_SAVE_TO_FILE
64
65	schoenebeck	2891	static Settings* _instance = NULL;
66	schoenebeck	2541
67			Settings* Settings::singleton() {
68	schoenebeck	2891	if (!_instance) {
69			_instance = new Settings;
70			_instance->load();
71			}
72			return _instance;
73	schoenebeck	2541	}
74
75	schoenebeck	2891	Settings::Settings() : Glib::ObjectBase(typeid(Settings)),
76			warnUserOnExtensions(*this, GLOBAL, "warnUserOnExtensions", true),
77			syncSamplerInstrumentSelection(*this, GLOBAL, "syncSamplerInstrumentSelection", true),
78			moveRootNoteWithRegionMoved(*this, GLOBAL, "moveRootNoteWithRegionMoved", true),
79	schoenebeck	2918	autoRestoreWindowDimension(*this, GLOBAL, "autoRestoreWindowDimension", false),
80	schoenebeck	2893	mainWindowX(*this, MAIN_WINDOW, "x", -1),
81			mainWindowY(*this, MAIN_WINDOW, "y", -1),
82			mainWindowW(*this, MAIN_WINDOW, "w", -1),
83			mainWindowH(*this, MAIN_WINDOW, "h", -1),
84			scriptEditorWindowX(*this, SCRIPT_EDITOR, "x", -1),
85			scriptEditorWindowY(*this, SCRIPT_EDITOR, "y", -1),
86			scriptEditorWindowW(*this, SCRIPT_EDITOR, "w", -1),
87			scriptEditorWindowH(*this, SCRIPT_EDITOR, "h", -1),
88	schoenebeck	2894	dimensionManagerWindowX(*this, DIMENSION_MANAGER, "x", -1),
89			dimensionManagerWindowY(*this, DIMENSION_MANAGER, "y", -1),
90			dimensionManagerWindowW(*this, DIMENSION_MANAGER, "w", -1),
91			dimensionManagerWindowH(*this, DIMENSION_MANAGER, "h", -1),
92			scriptSlotsWindowX(*this, SCRIPT_SLOTS, "x", -1),
93			scriptSlotsWindowY(*this, SCRIPT_SLOTS, "y", -1),
94			scriptSlotsWindowW(*this, SCRIPT_SLOTS, "w", -1),
95			scriptSlotsWindowH(*this, SCRIPT_SLOTS, "h", -1),
96			combineInstrumentsWindowX(*this, COMBINE_INSTRUMENTS, "x", -1),
97			combineInstrumentsWindowY(*this, COMBINE_INSTRUMENTS, "y", -1),
98			combineInstrumentsWindowW(*this, COMBINE_INSTRUMENTS, "w", -1),
99			combineInstrumentsWindowH(*this, COMBINE_INSTRUMENTS, "h", -1),
100			midiRulesWindowX(*this, MIDI_RULES, "x", -1),
101			midiRulesWindowY(*this, MIDI_RULES, "y", -1),
102			midiRulesWindowW(*this, MIDI_RULES, "w", -1),
103			midiRulesWindowH(*this, MIDI_RULES, "h", -1),
104			filePropsWindowX(*this, FILE_PROPS, "x", -1),
105			filePropsWindowY(*this, FILE_PROPS, "y", -1),
106			filePropsWindowW(*this, FILE_PROPS, "w", -1),
107			filePropsWindowH(*this, FILE_PROPS, "h", -1),
108			instrPropsWindowX(*this, INSTR_PROPS, "x", -1),
109			instrPropsWindowY(*this, INSTR_PROPS, "y", -1),
110			instrPropsWindowW(*this, INSTR_PROPS, "w", -1),
111			instrPropsWindowH(*this, INSTR_PROPS, "h", -1),
112			sampleRefsWindowX(*this, SAMPLE_REFS, "x", -1),
113			sampleRefsWindowY(*this, SAMPLE_REFS, "y", -1),
114			sampleRefsWindowW(*this, SAMPLE_REFS, "w", -1),
115			sampleRefsWindowH(*this, SAMPLE_REFS, "h", -1),
116	schoenebeck	2891	m_ignoreNotifies(false)
117			{
118			m_boolProps.push_back(&warnUserOnExtensions);
119			m_boolProps.push_back(&syncSamplerInstrumentSelection);
120			m_boolProps.push_back(&moveRootNoteWithRegionMoved);
121	schoenebeck	2918	m_boolProps.push_back(&autoRestoreWindowDimension);
122	schoenebeck	2893	m_intProps.push_back(&mainWindowX);
123			m_intProps.push_back(&mainWindowY);
124			m_intProps.push_back(&mainWindowW);
125			m_intProps.push_back(&mainWindowH);
126			m_intProps.push_back(&scriptEditorWindowX);
127			m_intProps.push_back(&scriptEditorWindowY);
128			m_intProps.push_back(&scriptEditorWindowW);
129			m_intProps.push_back(&scriptEditorWindowH);
130	schoenebeck	2894	m_intProps.push_back(&dimensionManagerWindowX);
131			m_intProps.push_back(&dimensionManagerWindowY);
132			m_intProps.push_back(&dimensionManagerWindowW);
133			m_intProps.push_back(&dimensionManagerWindowH);
134			m_intProps.push_back(&scriptSlotsWindowX);
135			m_intProps.push_back(&scriptSlotsWindowY);
136			m_intProps.push_back(&scriptSlotsWindowW);
137			m_intProps.push_back(&scriptSlotsWindowH);
138			m_intProps.push_back(&combineInstrumentsWindowX);
139			m_intProps.push_back(&combineInstrumentsWindowY);
140			m_intProps.push_back(&combineInstrumentsWindowW);
141			m_intProps.push_back(&combineInstrumentsWindowH);
142			m_intProps.push_back(&midiRulesWindowX);
143			m_intProps.push_back(&midiRulesWindowY);
144			m_intProps.push_back(&midiRulesWindowW);
145			m_intProps.push_back(&midiRulesWindowH);
146			m_intProps.push_back(&filePropsWindowX);
147			m_intProps.push_back(&filePropsWindowY);
148			m_intProps.push_back(&filePropsWindowW);
149			m_intProps.push_back(&filePropsWindowH);
150			m_intProps.push_back(&instrPropsWindowX);
151			m_intProps.push_back(&instrPropsWindowY);
152			m_intProps.push_back(&instrPropsWindowW);
153			m_intProps.push_back(&instrPropsWindowH);
154			m_intProps.push_back(&sampleRefsWindowX);
155			m_intProps.push_back(&sampleRefsWindowY);
156			m_intProps.push_back(&sampleRefsWindowW);
157			m_intProps.push_back(&sampleRefsWindowH);
158	schoenebeck	2541	}
159	schoenebeck	2891
160			void Settings::onPropertyChanged(Glib::PropertyBase* pProperty, RawValueType_t type, Group_t group) {
161			if (m_ignoreNotifies) return;
162
163			//printf("Settings::onPropertyChanged(%s)\n", pProperty->get_name().c_str());
164
165			Glib::KeyFile file;
166			try {
167			bool ok = file.load_from_file(configFile());
168			if (!ok) {
169			std::cerr << "Could not load '" << configFile() << "'\n" << std::flush;
170			}
171			} catch (...) {
172			std::cerr << "Could not load '" << configFile() << "'\n" << std::flush;
173			}
174
175			switch (type) {
176			case BOOLEAN: {
177			Property<bool>* prop = static_cast<Property<bool>*>(pProperty);
178			//std::cout << "Saving bool setting '" << prop->get_name() << "'\n" << std::flush;
179			file.set_boolean(groupName(prop->group()), prop->get_name(), prop->get_value());
180			break;
181			}
182			case INTEGER: {
183			Property<int>* prop = static_cast<Property<int>*>(pProperty);
184			//std::cout << "Saving int setting '" << prop->get_name() << "'\n" << std::flush;
185			file.set_integer(groupName(prop->group()), prop->get_name(), prop->get_value());
186			break;
187			}
188			case UNKNOWN:
189			std::cerr << "BUG: Unknown setting raw type of property '" << pProperty->get_name() << "'\n" << std::flush;
190			return;
191			}
192
193			try {
194	schoenebeck	2892	#if HAS_GLIB_KEYFILE_SAVE_TO_FILE
195	schoenebeck	2891	bool ok = file.save_to_file(configFile());
196	schoenebeck	2892	#else
197			bool ok = saveToFile(&file, configFile());
198			#endif
199	schoenebeck	2891	if (!ok) {
200			std::cerr << "Failed saving gigedit config to '" << configFile() << "'\n" << std::flush;
201			} else {
202			//std::cout <<"gigedit CONFIG SAVED\n";
203			}
204			} catch (...) {
205			std::cerr << "Failed saving gigedit config to '" << configFile() << "'\n" << std::flush;
206			}
207			}
208
209			void Settings::load() {
210			Glib::KeyFile file;
211			try {
212			bool ok = file.load_from_file(configFile());
213			if (!ok) return;
214			} catch (...) {
215			std::cerr << "Could not load gigedit config file '" << configFile() << "'\n" << std::flush;
216			return;
217			}
218
219			// ignore onPropertyChanged() calls during updating the property values below
220			m_ignoreNotifies = true;
221
222			for (int i = 0; i < m_boolProps.size(); ++i) {
223			Property<bool>* prop = static_cast<Property<bool>*>(m_boolProps[i]);
224			try {
225			const std::string group = groupName(prop->group());
226			if (!file.has_key(group, prop->get_name())) continue;
227			const bool value = file.get_boolean(group, prop->get_name());
228			prop->set_value(value);
229			} catch (...) {
230			continue;
231			}
232			}
233
234			for (int i = 0; i < m_intProps.size(); ++i) {
235			Property<int>* prop = static_cast<Property<int>*>(m_intProps[i]);
236			try {
237			const std::string group = groupName(prop->group());
238			if (!file.has_key(group, prop->get_name())) continue;
239			const int value = file.get_integer(group, prop->get_name());
240			prop->set_value(value);
241			} catch (...) {
242			continue;
243			}
244			}
245
246			m_ignoreNotifies = false;
247			}
248