6ee2f98349
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there. This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style. Some notes: * Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those. * Some multiline comments may have been munged into single line comments * Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them. * Enum comments can go after the enumeration itself '[value] /// comment' * include/aegisub/*.h haven't been converted yet, this will be done in a later commit * Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa. See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'. Originally committed to SVN as r3312.
839 lines
24 KiB
C++
839 lines
24 KiB
C++
// Copyright (c) 2005-2007, Rodrigo Braz Monteiro
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
// this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
// and/or other materials provided with the distribution.
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
// may be used to endorse or promote products derived from this software
|
|
// without specific prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// Aegisub Project http://www.aegisub.org/
|
|
//
|
|
// $Id$
|
|
|
|
/// @file options.cpp
|
|
/// @brief Initialise, load and store configuration settings, including all defaults
|
|
/// @ingroup main
|
|
///
|
|
|
|
|
|
////////////
|
|
// Includes
|
|
#include "config.h"
|
|
|
|
#include <string>
|
|
#include <wx/filename.h>
|
|
#include <fstream>
|
|
#include <wx/intl.h>
|
|
#include <wx/settings.h>
|
|
#include <wx/filefn.h>
|
|
#include <wx/utils.h>
|
|
#include "options.h"
|
|
#include "text_file_reader.h"
|
|
#include "text_file_writer.h"
|
|
#include "colorspace.h"
|
|
#include "utils.h"
|
|
|
|
|
|
|
|
/// @brief Constructor
|
|
///
|
|
OptionsManager::OptionsManager() {
|
|
modified = false;
|
|
overriding = false;
|
|
lastVersion = -1;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Destructor
|
|
///
|
|
OptionsManager::~OptionsManager() {
|
|
Clear();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Clear
|
|
///
|
|
void OptionsManager::Clear() {
|
|
opt.clear();
|
|
optType.clear();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Load default values
|
|
/// @param onlyDefaults
|
|
/// @param doOverride
|
|
///
|
|
void OptionsManager::LoadDefaults(bool onlyDefaults,bool doOverride) {
|
|
///// PUBLIC //////
|
|
// Here go the options that can be edited by the options menu
|
|
|
|
if (doOverride) overriding = true;
|
|
if (onlyDefaults) lastVersion = -1;
|
|
|
|
// General
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
|
|
// Broken on OS X during startup only.
|
|
SetBool(_T("Tips enabled"),false);
|
|
SetBool(_T("Show splash"),true);
|
|
SetBool(_T("Local config"),false);
|
|
SetInt(_T("Undo levels"),8);
|
|
SetInt(_T("Recent timecodes max"),16);
|
|
SetInt(_T("Recent keyframes max"),16);
|
|
SetInt(_T("Recent sub max"),16);
|
|
SetInt(_T("Recent vid max"),16);
|
|
SetInt(_T("Recent aud max"),16);
|
|
SetInt(_T("Recent find max"),16);
|
|
SetInt(_T("Recent replace max"),16);
|
|
SetInt(_T("Auto check for updates"),-1);
|
|
|
|
// File Save/Load
|
|
SetModificationType(MOD_RESTART);
|
|
SetInt(_T("Auto save every seconds"),60); // FIXME: this shouldn't need to require a restart
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
SetText(_T("Auto save path"),_T("?user/autosave"));
|
|
SetBool(_T("Auto backup"),true);
|
|
SetText(_T("Auto backup path"),_T("?user/autoback"));
|
|
SetText(_T("Auto recovery path"),_T("?user/recovered"));
|
|
SetInt(_T("Autoload linked files"),2);
|
|
SetText(_T("Text actor separator"),_T(":"));
|
|
SetText(_T("Text comment starter"),_T("#"));
|
|
SetText(_T("Save charset"),_T("UTF-8"));
|
|
SetBool(_T("Use nonstandard milisecond times"),false);
|
|
SetBool(_T("Auto save on every change"),false);
|
|
|
|
// Edit Box
|
|
SetModificationType(MOD_RESTART);
|
|
SetText(_T("Dictionaries path"),_T("?data/dictionaries"));
|
|
SetText(_T("Spell Checker"),_T("hunspell"));
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
SetBool(_T("Link time boxes commit"),true);
|
|
SetBool(_T("Insert mode on time boxes"),true);
|
|
SetModificationType(MOD_EDIT_BOX);
|
|
SetBool(_T("Call tips enabled"),false,1700);
|
|
SetBool(_T("Syntax highlight enabled"),true);
|
|
|
|
// Edit box cosmetic
|
|
SetColour(_T("Syntax Highlight Normal"),wxColour(0,0,0));
|
|
SetColour(_T("Syntax Highlight Brackets"),wxColour(20,50,255));
|
|
SetColour(_T("Syntax Highlight Slashes"),wxColour(255,0,200));
|
|
SetColour(_T("Syntax Highlight Tags"),wxColour(90,90,90));
|
|
SetColour(_T("Syntax Highlight Parameters"),wxColour(40,90,40));
|
|
SetColour(_T("Syntax Highlight Error"),wxColour(200,0,0));
|
|
SetColour(_T("Syntax Highlight Error Background"),wxColour(255,200,200));
|
|
SetColour(_T("Syntax Highlight Line Break"),wxColour(160,160,160));
|
|
SetColour(_T("Syntax Highlight Karaoke Template"), wxColour(128,0,192));
|
|
SetColour(_T("Edit Box Need Enter Background"),wxColour(192,192,255));
|
|
#if defined(__WINDOWS__)
|
|
SetInt(_T("Edit Font Size"),9);
|
|
#else
|
|
SetInt(_T("Edit Font Size"),11);
|
|
#endif
|
|
SetText(_T("Edit Font Face"),_T(""));
|
|
|
|
// Video Options
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
SetInt(_T("Video Check Script Res"), 0);
|
|
SetInt(_T("Video Default Zoom"), 7);
|
|
SetInt(_T("Video Fast Jump Step"), 10);
|
|
SetText(_T("Video Screenshot Path"),_T("?video"),1700);
|
|
SetModificationType(MOD_VIDEO);
|
|
SetBool(_T("Show keyframes on video slider"),true);
|
|
SetBool(_T("Show overscan mask"),false);
|
|
|
|
// Video Provider (Advanced)
|
|
SetModificationType(MOD_VIDEO_RELOAD);
|
|
SetInt(_T("Avisynth MemoryMax"),64,1700);
|
|
SetBool(_T("Threaded Video"),false,1700);
|
|
#ifdef __WINDOWS__
|
|
SetText(_T("Video Provider"),_T("ffmpegsource"),2416);
|
|
#else
|
|
SetText(_T("Video Provider"),_T(DEFAULT_PROVIDER_VIDEO),1945);
|
|
#endif
|
|
SetBool(_T("FFmpeg allow unsafe seeking"),false);
|
|
SetInt(_T("FFmpegSource decoding threads"),1);
|
|
SetBool(_T("Allow Ancient Avisynth"),false,1700);
|
|
#ifdef __WINDOWS__
|
|
SetText(_T("Subtitles Provider"),_T("csri/vsfilter_textsub"),1700);
|
|
#else
|
|
SetText(_T("Subtitles Provider"),_T(DEFAULT_PROVIDER_SUBTITLE));
|
|
#endif
|
|
SetInt(_T("FFmpegSource max cache size"),42);
|
|
SetInt(_T("FFmpegSource max cache files"),20);
|
|
SetInt(_T("FFmpegSource always index all tracks"), true);
|
|
SetText(_T("FFmpegSource log level"), _T("quiet"));
|
|
|
|
// Audio Options
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
SetBool(_T("Audio grab times on select"),true);
|
|
SetBool(_T("Audio Autofocus"),false);
|
|
SetBool(_T("Audio Wheel Default To Zoom"),false);
|
|
SetBool(_T("Audio lock scroll on cursor"),false);
|
|
SetBool(_T("Audio snap to keyframes"),false);
|
|
SetBool(_T("Audio snap to other lines"),false);
|
|
SetInt(_T("Timing Default Duration"), 2000);
|
|
SetInt(_T("Audio lead in"),200);
|
|
SetInt(_T("Audio lead out"),300);
|
|
SetModificationType(MOD_AUDIO);
|
|
SetInt(_T("Audio Inactive Lines Display Mode"),1);
|
|
SetBool(_T("Disable Dragging Times"), false);
|
|
SetInt(_T("Audio Start Drag Sensitivity"), 2);
|
|
|
|
// Audio Advanced
|
|
SetModificationType(MOD_AUDIO_RELOAD);
|
|
SetInt(_T("Audio Cache"),1,1700);
|
|
#if defined(__WINDOWS__)
|
|
SetText(_T("Audio Player"),_T("DirectSound"),1945);
|
|
SetText(_T("Audio Provider"),_T("ffmpegsource"),2416);
|
|
#else
|
|
SetText(_T("Audio Player"),_T(DEFAULT_PLAYER_AUDIO));
|
|
SetText(_T("Audio Provider"),_T(DEFAULT_PROVIDER_AUDIO),1945);
|
|
#endif
|
|
SetText(_T("Audio Downmixer"),_T("ConvertToMono"),1700);
|
|
SetText(_T("Audio Alsa Device"), _T("default"));
|
|
SetInt(_T("Audio PortAudio Device"), -1);
|
|
SetText(_T("Audio HD Cache Location"),_T("default"),1700);
|
|
SetText(_T("Audio HD Cache Name"),_T("audio%02i.tmp"),1700);
|
|
SetBool(_T("Audio Disable PCM Provider"), false);
|
|
// Technically these can do with just the spectrum object being re-created
|
|
SetInt(_T("Audio Spectrum Cutoff"),0);
|
|
SetInt(_T("Audio Spectrum Quality"),1);
|
|
SetInt(_T("Audio Spectrum Memory Max"),128); // megabytes
|
|
// and this one could do with just reiniting the audio player
|
|
SetInt(_T("Audio dsound buffer latency"), 100);
|
|
SetInt(_T("Audio dsound buffer length"), 5);
|
|
|
|
// Automation
|
|
// The path changes only take effect when a script is (re)loaded but Automatic should be good enough, it certainly doesn't warrart a restart
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
SetText(_T("Automation Base Path"), _T("?data/automation/"),1700);
|
|
SetText(_T("Automation Include Path"), _T("?user/automation/include/|?data/automation/include/"),1700);
|
|
SetText(_T("Automation Autoload Path"), _T("?user/automation/autoload/|?data/automation/autoload/"),1700);
|
|
SetInt(_T("Automation Trace Level"), 3);
|
|
SetInt(_T("Automation Thread Priority"), 1); // "below normal"
|
|
SetInt(_T("Automation Autoreload Mode"), 1); // local only
|
|
|
|
// Generate colors
|
|
// FIXME: Can't reliably store the system colour-based ones in the config file, the user might change colour scheme
|
|
wxColour tempCol = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
|
|
wxColour textCol = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
|
|
wxColour background = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
|
|
wxColour comment = wxColour(216,222,245);
|
|
wxColour selection = wxColour(206,255,231);
|
|
wxColour selComment = wxColour(211,238,238);
|
|
wxColour header = wxColour(165,207,231);
|
|
wxColour labels = wxColour(196,236,201);
|
|
wxColour inframe = wxColour(255,253,234);
|
|
wxColour active = wxColour(255,91,239);
|
|
wxColour grid = wxColour(128,128,128);
|
|
wxColour collision = wxColour(255,0,0);
|
|
|
|
// Grid
|
|
SetModificationType(MOD_GRID);
|
|
SetBool(_T("Grid allow focus"),true);
|
|
SetBool(_T("Highlight subs in frame"),true);
|
|
|
|
// Grid cosmetic
|
|
SetColour(_T("Grid standard foreground"),textCol);
|
|
SetColour(_T("Grid selection background"),selection);
|
|
SetColour(_T("Grid selection foreground"),textCol);
|
|
SetColour(_T("Grid comment background"),comment);
|
|
SetColour(_T("Grid collision foreground"),collision);
|
|
SetColour(_T("Grid selected comment background"),selComment);
|
|
SetColour(_T("Grid inframe background"),inframe);
|
|
SetColour(_T("Grid background"),background);
|
|
SetColour(_T("Grid header"),header);
|
|
SetColour(_T("Grid left column"),labels);
|
|
SetColour(_T("Grid active border"),active);
|
|
SetColour(_T("Grid lines"),grid);
|
|
#if defined(__WINDOWS__)
|
|
SetInt(_T("Grid font size"),8);
|
|
#else
|
|
SetInt(_T("Grid font size"),10);
|
|
#endif
|
|
SetText(_T("Grid Font Face"),_T(""));
|
|
wchar_t temp = 0x2600;
|
|
SetText(_T("Grid hide overrides char"),temp);
|
|
SetModificationType(MOD_AUTOMATIC);
|
|
|
|
// Audio Cosmetic
|
|
SetModificationType(MOD_AUDIO);
|
|
SetInt(_T("Audio Line boundaries Thickness"), 2);
|
|
SetBool(_T("Audio Draw Secondary Lines"), true);
|
|
SetBool(_T("Audio Draw Selection Background"), true);
|
|
SetBool(_T("Audio Draw Keyframes"), true);
|
|
SetBool(_T("Audio Draw Timeline"),true);
|
|
SetBool(_T("Audio Draw Cursor Time"),true);
|
|
SetBool(_T("Audio Draw Video Position"),false,1700);
|
|
SetColour(_T("Audio Selection Background Modified"),wxColour(92,0,0));
|
|
SetColour(_T("Audio Selection Background"),wxColour(64,64,64));
|
|
SetColour(_T("Audio Seconds Boundaries"),wxColour(0,100,255));
|
|
SetColour(_T("Audio Waveform Modified"),wxColour(255,230,230));
|
|
SetColour(_T("Audio Waveform Selected"),wxColour(255,255,255));
|
|
SetColour(_T("Audio Waveform Inactive"),wxColour(0,80,0));
|
|
SetColour(_T("Audio Waveform"),wxColour(0,200,0));
|
|
SetColour(_T("Audio Line boundary start"),wxColour(216,0,0),1700);
|
|
SetColour(_T("Audio Line boundary end"),wxColour(230,125,0),1700);
|
|
SetColour(_T("Audio Line boundary inactive line"),wxColour(128,128,128));
|
|
SetColour(_T("Audio Syllable boundaries"),wxColour(255,255,0));
|
|
SetColour(_T("Audio Syllable text"),wxColour(255,0,0));
|
|
SetColour(_T("Audio Play cursor"),wxColour(255,255,255));
|
|
SetColour(_T("Audio Background"),wxColour(0,0,0));
|
|
SetModificationType(MOD_OFF);
|
|
|
|
// RGB Adjust tool
|
|
SetBool(_T("RGBAdjust Tool"),false);
|
|
|
|
|
|
// Only defaults?
|
|
if (!onlyDefaults) {
|
|
|
|
///// INTERNAL //////
|
|
// Options that are set by the program itself
|
|
SetInt(_T("Video Dummy Last Width"), 640);
|
|
SetInt(_T("Video Dummy Last Height"), 480);
|
|
SetColour(_T("Video Dummy Last Colour"), wxColour(47, 163, 254));
|
|
SetFloat(_T("Video Dummy Last FPS"), 23.976);
|
|
SetInt(_T("Video Dummy Last Length"), 40000);
|
|
SetBool(_T("Video Dummy Pattern"), false);
|
|
|
|
// Broken on OS X during startup, so default to en_US
|
|
#ifdef __APPLE__
|
|
SetInt(_T("Locale Code"),56,1700);
|
|
#else
|
|
SetInt(_T("Locale Code"),-1,1700);
|
|
#endif
|
|
SetBool(_T("Sync video with subs"),true);
|
|
SetText(_T("Spell checker language"),_T("en_US"));
|
|
SetText(_T("Thesaurus language"),_T("en_US"));
|
|
SetInt(_T("Options Page"),0);
|
|
|
|
SetBool(_T("Audio Link"),true);
|
|
SetBool(_T("Audio Autocommit"),false);
|
|
SetBool(_T("Audio Autoscroll"),true);
|
|
SetBool(_T("Audio Medusa Timing Hotkeys"),false);
|
|
SetBool(_T("Audio Next Line on Commit"),true);
|
|
|
|
SetBool(_T("Shift Times ByTime"),true);
|
|
SetInt(_T("Shift Times Type"),0);
|
|
SetInt(_T("Shift Times Length"),0);
|
|
SetInt(_T("Shift Times Affect"),0);
|
|
SetBool(_T("Shift Times Direction"),true);
|
|
|
|
SetInt(_T("Tips current"),0);
|
|
SetBool(_T("Show associations"),true,1700);
|
|
SetBool(_T("Maximized"),false);
|
|
|
|
SetBool(_T("Find Match Case"),false);
|
|
SetBool(_T("Find RegExp"),false);
|
|
SetBool(_T("Find Update Video"),false);
|
|
SetInt(_T("Find Affect"),0);
|
|
SetInt(_T("Find Field"),0);
|
|
|
|
SetInt(_T("Grid hide overrides"),1);
|
|
for (int i=0;i<10;i++) SetBool(_T("Grid show column ") + AegiIntegerToString(i),true);
|
|
|
|
for (int i=0;i<9;i++) SetBool(wxString::Format(_T("Paste Over #%i"),i),false);
|
|
SetBool(_T("Paste Over #9"),true);
|
|
|
|
SetText(_T("Fonts Collector Destination"),_T("?script"));
|
|
SetInt(_T("Fonts Collector Action"),0);
|
|
|
|
SetInt(_T("Audio Display Height"),200,1784);
|
|
SetBool(_T("Audio Spectrum"),true);
|
|
SetInt(_T("Audio Sample Rate"),0);
|
|
|
|
SetBool(_T("Video Visual Realtime"),true);
|
|
SetBool(_T("Detached video"),false);
|
|
SetInt(_T("Detached video last x"),-1);
|
|
SetInt(_T("Detached video last y"),-1);
|
|
SetBool(_T("Detached video maximized"),false);
|
|
|
|
SetInt(_T("Timing processor key start before thres"),5);
|
|
SetInt(_T("Timing processor key start after thres"),4);
|
|
SetInt(_T("Timing processor key end before thres"),5);
|
|
SetInt(_T("Timing processor key end after thres"),6);
|
|
SetInt(_T("Timing processor adjacent thres"),300);
|
|
SetBool(_T("Timing processor Enable lead-in"),true);
|
|
SetBool(_T("Timing processor Enable lead-out"),true);
|
|
SetBool(_T("Timing processor Enable keyframe"),true);
|
|
SetBool(_T("Timing processor Enable adjacent"),true);
|
|
SetBool(_T("Timing processor Only Selection"),false);
|
|
SetFloat(_T("Timing processor adjacent bias"),1.0);
|
|
|
|
SetText(_T("Select Text"),_T(""));
|
|
SetInt(_T("Select Condition"),0);
|
|
SetInt(_T("Select Field"),0);
|
|
SetInt(_T("Select Action"),0);
|
|
SetInt(_T("Select Mode"),1);
|
|
SetBool(_T("Select Match case"),false);
|
|
SetBool(_T("Select Match dialogues"),true);
|
|
SetBool(_T("Select Match comments"),false);
|
|
|
|
SetText(_T("Color Picker Recent"), _T("&H000000& &H0000FF& &H00FFFF& &H00FF00& &HFFFF00& &HFF0000& &HFF00FF& &HFFFFFF&"));
|
|
SetInt(_T("Color Picker Mode"), 4, 1700);
|
|
|
|
SetText(_T("Last open subtitles path"),_T(""));
|
|
SetText(_T("Last open video path"),_T(""));
|
|
SetText(_T("Last open audio path"),_T(""));
|
|
SetText(_T("Last open timecodes path"),_T(""));
|
|
SetText(_T("Last open keyframes path"),_T(""));
|
|
SetText(_T("Last open automation path"),_T(""));
|
|
|
|
SetBool(_T("kanji timer interpolation"),true);
|
|
|
|
wxString previewText = _T("Aegisub\\N0123 ");
|
|
previewText += 0x6708; // kanji "moon"
|
|
previewText += 0x8a9e; // kanji "speak"
|
|
SetText(_T("Style editor preview text"),previewText);
|
|
SetColour(_T("Style editor preview background"),wxColour(125,153,176));
|
|
}
|
|
|
|
lastVersion = -1;
|
|
overriding = false;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Set filename
|
|
/// @param file
|
|
///
|
|
void OptionsManager::SetFile(wxString file) {
|
|
filename = file;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Get filename
|
|
/// @return
|
|
///
|
|
wxString OptionsManager::GetFile() const
|
|
{
|
|
return filename;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Save
|
|
/// @return
|
|
///
|
|
void OptionsManager::Save() {
|
|
// Check if it's actually modified
|
|
if (!modified) return;
|
|
|
|
// Open file
|
|
TextFileWriter file(filename,_T("UTF-8"));
|
|
file.WriteLineToFile(_T("[Config]"));
|
|
|
|
// Put variables in it
|
|
for (std::map<wxString,VariableData>::iterator cur=opt.begin();cur!=opt.end();cur++) {
|
|
file.WriteLineToFile((*cur).first + _T("=") + (*cur).second.AsText());
|
|
}
|
|
|
|
// Close
|
|
modified = false;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Load
|
|
/// @return
|
|
///
|
|
void OptionsManager::Load() {
|
|
// Check if file exists
|
|
wxFileName path(filename);
|
|
if (!path.FileExists()) {
|
|
modified = true;
|
|
return;
|
|
}
|
|
|
|
// Read header
|
|
TextFileReader file(filename);
|
|
wxString header;
|
|
try {
|
|
if (file.GetCurrentEncoding() != _T("binary"))
|
|
header = file.ReadLineFromFile();
|
|
}
|
|
catch (wxString e) {
|
|
header = _T("");
|
|
}
|
|
if (header != _T("[Config]")) {
|
|
wxMessageBox(_("Configuration file is either invalid or corrupt. The current file will be backed up and replaced with a default file."),_("Error"),wxCENTRE|wxICON_WARNING|wxOK);
|
|
wxRenameFile(filename,filename + wxString::Format(_T(".%i.backup"),wxGetUTCTime()));
|
|
modified = true;
|
|
return;
|
|
}
|
|
|
|
// Get variables
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
wxString curLine;
|
|
while (file.HasMoreLines()) {
|
|
// Parse line
|
|
try {
|
|
curLine = file.ReadLineFromFile();
|
|
}
|
|
catch (wxString e) {
|
|
wxMessageBox(_("Configuration file is either invalid or corrupt. The current file will be backed up and replaced with a default file."),_("Error"),wxCENTRE|wxICON_WARNING|wxOK);
|
|
wxRenameFile(filename,filename + wxString::Format(_T(".%i.backup"),wxGetUTCTime()));
|
|
modified = true;
|
|
return;
|
|
}
|
|
if (curLine.IsEmpty()) continue;
|
|
size_t pos = curLine.Find(_T("="));
|
|
if (pos == wxString::npos) continue;
|
|
wxString key = curLine.Left(pos);
|
|
wxString value = curLine.Mid(pos+1);
|
|
|
|
// Find it
|
|
cur = opt.find(key);
|
|
if (cur != opt.end()) {
|
|
(*cur).second.ResetWith(value);
|
|
}
|
|
else SetText(key,value);
|
|
}
|
|
|
|
// Get last version
|
|
if (IsDefined(_T("Last Version"))) {
|
|
long temp;
|
|
AsText(_T("Last Version")).ToLong(&temp);
|
|
lastVersion = temp;
|
|
}
|
|
else lastVersion = 1; // This was implemented in 1784, assume that anything before that is 1.
|
|
}
|
|
|
|
|
|
|
|
/// @brief Write int
|
|
/// @param key
|
|
/// @param param
|
|
/// @param ifLastVersion
|
|
/// @return
|
|
///
|
|
void OptionsManager::SetInt(wxString key,int param,int ifLastVersion) {
|
|
if (ifLastVersion == -1) {
|
|
if (overriding) ifLastVersion = 0;
|
|
else ifLastVersion = 0x7FFFFFFF;
|
|
}
|
|
if (lastVersion >= ifLastVersion) return;
|
|
opt[key.Lower()].SetInt(param);
|
|
if (curModType != MOD_OFF) optType[key.Lower()] = curModType;
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Write float
|
|
/// @param key
|
|
/// @param param
|
|
/// @param ifLastVersion
|
|
/// @return
|
|
///
|
|
void OptionsManager::SetFloat(wxString key,double param,int ifLastVersion) {
|
|
if (ifLastVersion == -1) {
|
|
if (overriding) ifLastVersion = 0;
|
|
else ifLastVersion = 0x7FFFFFFF;
|
|
}
|
|
if (lastVersion >= ifLastVersion) return;
|
|
opt[key.Lower()].SetFloat(param);
|
|
if (curModType != MOD_OFF) optType[key.Lower()] = curModType;
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Write string
|
|
/// @param key
|
|
/// @param param
|
|
/// @param ifLastVersion
|
|
/// @return
|
|
///
|
|
void OptionsManager::SetText(wxString key,wxString param,int ifLastVersion) {
|
|
if (ifLastVersion == -1) {
|
|
if (overriding) ifLastVersion = 0;
|
|
else ifLastVersion = 0x7FFFFFFF;
|
|
}
|
|
if (lastVersion >= ifLastVersion) return;
|
|
opt[key.Lower()].SetText(param);
|
|
if (curModType != MOD_OFF) optType[key.Lower()] = curModType;
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Write boolean
|
|
/// @param key
|
|
/// @param param
|
|
/// @param ifLastVersion
|
|
/// @return
|
|
///
|
|
void OptionsManager::SetBool(wxString key,bool param,int ifLastVersion) {
|
|
if (ifLastVersion == -1) {
|
|
if (overriding) ifLastVersion = 0;
|
|
else ifLastVersion = 0x7FFFFFFF;
|
|
}
|
|
if (lastVersion >= ifLastVersion) return;
|
|
opt[key.Lower()].SetBool(param);
|
|
if (curModType != MOD_OFF) optType[key.Lower()] = curModType;
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Write colour
|
|
/// @param key
|
|
/// @param param
|
|
/// @param ifLastVersion
|
|
/// @return
|
|
///
|
|
void OptionsManager::SetColour(wxString key,wxColour param,int ifLastVersion) {
|
|
if (ifLastVersion == -1) {
|
|
if (overriding) ifLastVersion = 0;
|
|
else ifLastVersion = 0x7FFFFFFF;
|
|
}
|
|
if (lastVersion >= ifLastVersion) return;
|
|
opt[key.Lower()].SetColour(param);
|
|
if (curModType != MOD_OFF) optType[key.Lower()] = curModType;
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Reset with
|
|
/// @param key
|
|
/// @param param
|
|
///
|
|
void OptionsManager::ResetWith(wxString key,wxString param) {
|
|
opt[key.Lower()].ResetWith(param);
|
|
modified = true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief As int
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
int OptionsManager::AsInt(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
if (cur != opt.end()) {
|
|
return (*cur).second.AsInt();
|
|
}
|
|
else throw key.c_str();//_T("Internal error: Attempted getting undefined configuration setting");
|
|
}
|
|
|
|
|
|
|
|
/// @brief As boolean
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
bool OptionsManager::AsBool(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
if (cur != opt.end()) {
|
|
return (*cur).second.AsBool();
|
|
}
|
|
else throw key.c_str();//_T("Internal error: Attempted getting undefined configuration setting");
|
|
}
|
|
|
|
|
|
|
|
/// @brief As float
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
double OptionsManager::AsFloat(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
if (cur != opt.end()) {
|
|
return (*cur).second.AsFloat();
|
|
}
|
|
else throw key.c_str();//_T("Internal error: Attempted getting undefined configuration setting");
|
|
}
|
|
|
|
|
|
|
|
/// @brief As string
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
wxString OptionsManager::AsText(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
if (cur != opt.end()) {
|
|
return (*cur).second.AsText();
|
|
}
|
|
else throw key.c_str();//_T("Internal error: Attempted getting undefined configuration setting");
|
|
}
|
|
|
|
|
|
|
|
/// @brief As colour
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
wxColour OptionsManager::AsColour(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
if (cur != opt.end()) {
|
|
return (*cur).second.AsColour();
|
|
}
|
|
else throw key.c_str();//_T("Internal error: Attempted getting undefined configuration setting");
|
|
}
|
|
|
|
|
|
|
|
/// @brief Modification type
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
ModType OptionsManager::GetModType(wxString key) {
|
|
std::map<wxString,ModType>::iterator cur;
|
|
cur = (optType.find(key.Lower()));
|
|
if (cur != optType.end()) {
|
|
return (*cur).second;
|
|
}
|
|
else return MOD_AUTOMATIC;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Is defined?
|
|
/// @param key
|
|
/// @return
|
|
///
|
|
bool OptionsManager::IsDefined(wxString key) {
|
|
std::map<wxString,VariableData>::iterator cur;
|
|
cur = (opt.find(key.Lower()));
|
|
return (cur != opt.end());
|
|
}
|
|
|
|
|
|
|
|
/// @brief Adds an item to a list of recents
|
|
/// @param entry
|
|
/// @param list
|
|
///
|
|
void OptionsManager::AddToRecentList (wxString entry,wxString list) {
|
|
// Find strings already in recent list
|
|
wxArrayString orig;
|
|
wxString cur;
|
|
int recentMax = AsInt(list + _T(" max"));
|
|
int n = 0;
|
|
for (int i=0;i<recentMax;i++) {
|
|
wxString key = wxString::Format(_T("%s #%i"), list.c_str(), i+1);
|
|
if (IsDefined(key)) {
|
|
cur = AsText(key);
|
|
if (cur != entry) {
|
|
orig.Add(cur);
|
|
n++;
|
|
}
|
|
}
|
|
else break;
|
|
}
|
|
|
|
// Write back to options
|
|
SetText(list + _T(" #1"),entry);
|
|
if (n > recentMax-1) n = recentMax-1;
|
|
for (int i=0;i<n;i++) {
|
|
wxString key = wxString::Format(_T("%s #%i"), list.c_str(), i+2);
|
|
SetText(key,orig[i]);
|
|
}
|
|
|
|
// Save options
|
|
Save();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Removes an item from a list of recents, if it's in the list
|
|
/// @param entry
|
|
/// @param list
|
|
///
|
|
void OptionsManager::RemoveFromRecentList (wxString entry,wxString list) {
|
|
// Find strings already in recent list
|
|
wxArrayString cleaned;
|
|
wxString cur;
|
|
int recentMax = AsInt(list + _T(" max"));
|
|
int n = 0;
|
|
for (int i=0;i<recentMax;i++) {
|
|
wxString key = wxString::Format(_T("%s #%i"), list.c_str(), i+1);
|
|
if (IsDefined(key)) {
|
|
cur = AsText(key);
|
|
if (cur != entry) {
|
|
cleaned.Add(cur);
|
|
n++;
|
|
}
|
|
}
|
|
else break;
|
|
}
|
|
|
|
// Write back to options
|
|
if (n > recentMax-1) n = recentMax-1;
|
|
for (int i=0;i<n;i++) {
|
|
wxString key = wxString::Format(_T("%s #%i"), list.c_str(), i+1);
|
|
SetText(key,cleaned[i]);
|
|
}
|
|
|
|
// Save options
|
|
Save();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Get recent list
|
|
/// @param list
|
|
/// @return
|
|
///
|
|
wxArrayString OptionsManager::GetRecentList (wxString list) {
|
|
wxArrayString work;
|
|
int recentMax = AsInt(list + _T(" max"));
|
|
for (int i=0;i<recentMax;i++) {
|
|
wxString key = wxString::Format(_T("%s #%i"), list.c_str(), i+1);
|
|
if (IsDefined(key)) {
|
|
work.Add(Options.AsText(key));
|
|
}
|
|
else break;
|
|
}
|
|
return work;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Set modification type
|
|
/// @param type
|
|
///
|
|
void OptionsManager::SetModificationType(ModType type) {
|
|
curModType = type;
|
|
}
|
|
|
|
|
|
|
|
/// DOCME
|
|
OptionsManager Options;
|
|
|
|
|