1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2014 Eran Ifrah
// file name : cl_config.cpp
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#include "cl_config.h"
#include "FontUtils.hpp"
#include "cl_defs.h"
#include "cl_standard_paths.h"
#include "file_logger.h"
#include "fileutils.h"
#include "wx/filename.h"
#include <algorithm>
#include <wx/filefn.h>
#include <wx/log.h>
#include <wx/stdpaths.h>
#define ADD_OBJ_IF_NOT_EXISTS(parent, objName) \
if(!parent.hasNamedObject(objName)) { \
JSONItem obj = JSONItem::createObject(objName); \
parent.append(obj); \
}
#define ADD_ARR_IF_NOT_EXISTS(parent, arrName) \
if(!parent.hasNamedObject(arrName)) { \
JSONItem arr = JSONItem::createArray(arrName); \
parent.append(arr); \
}
namespace
{
void truncate_array(wxArrayString& arr, size_t maxSize)
{
while(arr.GetCount() > maxSize && arr.GetCount() > 0) {
arr.RemoveAt(arr.GetCount() - 1);
}
}
} // namespace
clConfig::clConfig(const wxString& filename)
{
if(wxFileName(filename).IsAbsolute()) {
m_filename = filename;
} else {
m_filename = clStandardPaths::Get().GetUserDataDir() + wxFileName::GetPathSeparator() + "config" +
wxFileName::GetPathSeparator() + filename;
}
if(m_filename.FileExists()) {
m_root = new JSON(m_filename);
} else {
if(!m_filename.DirExists()) {
m_filename.Mkdir(wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL);
}
m_root = new JSON(cJSON_Object);
}
// Load the "Recent Items" cache
{
wxArrayString recentFiles;
JSONItem e = m_root->toElement();
if(e.hasNamedObject("RecentWorkspaces")) {
recentFiles = e.namedObject("RecentWorkspaces").toArrayString();
m_cacheRecentItems.insert(std::make_pair("RecentWorkspaces", recentFiles));
}
}
{
wxArrayString recentFiles;
JSONItem e = m_root->toElement();
if(e.hasNamedObject("RecentFiles")) {
recentFiles = e.namedObject("RecentFiles").toArrayString();
m_cacheRecentItems.insert(std::make_pair("RecentFiles", recentFiles));
}
}
}
clConfig::~clConfig() { wxDELETE(m_root); }
clConfig& clConfig::Get()
{
static clConfig config;
return config;
}
bool clConfig::GetOutputTabOrder(wxArrayString& tabs, int& selected)
{
if(m_root->toElement().hasNamedObject("outputTabOrder")) {
JSONItem element = m_root->toElement().namedObject("outputTabOrder");
tabs = element.namedObject("tabs").toArrayString();
selected = element.namedObject("selected").toInt();
return true;
}
return false;
}
void clConfig::SetOutputTabOrder(const wxArrayString& tabs, int selected)
{
DoDeleteProperty("outputTabOrder");
// first time
JSONItem e = JSONItem::createObject("outputTabOrder");
e.addProperty("tabs", tabs);
e.addProperty("selected", selected);
m_root->toElement().append(e);
m_root->save(m_filename);
}
bool clConfig::GetWorkspaceTabOrder(wxArrayString& tabs, int& selected)
{
if(m_root->toElement().hasNamedObject("workspaceTabOrder")) {
JSONItem element = m_root->toElement().namedObject("workspaceTabOrder");
tabs = element.namedObject("tabs").toArrayString();
selected = element.namedObject("selected").toInt();
return true;
}
return false;
}
void clConfig::SetWorkspaceTabOrder(const wxArrayString& tabs, int selected)
{
DoDeleteProperty("workspaceTabOrder");
// first time
JSONItem e = JSONItem::createObject("workspaceTabOrder");
e.addProperty("tabs", tabs);
e.addProperty("selected", selected);
m_root->toElement().append(e);
m_root->save(m_filename);
}
void clConfig::DoDeleteProperty(const wxString& property)
{
if(m_root->toElement().hasNamedObject(property)) {
m_root->toElement().removeProperty(property);
}
}
bool clConfig::ReadItem(clConfigItem* item, const wxString& differentName)
{
wxString nameToUse = differentName.IsEmpty() ? item->GetName() : differentName;
if(m_root->toElement().hasNamedObject(nameToUse)) {
item->FromJSON(m_root->toElement().namedObject(nameToUse));
return true;
}
return false;
}
bool clConfig::Write(const wxString& name, std::function<JSONItem()> serialiser_func, const wxFileName& configFile)
{
auto item = serialiser_func();
if(configFile.IsOk()) {
// write to a separate file
configFile.Mkdir(wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL);
return FileUtils::WriteFileContent(configFile, item.format());
} else {
// add it to the global configuration file
DoDeleteProperty(name);
item.setName(name);
m_root->toElement().append(item);
return true;
}
}
void clConfig::Read(const wxString& name, std::function<void(const JSONItem& item)> deserialiser_func,
const wxFileName& configFile)
{
if(configFile.IsOk() && configFile.FileExists()) {
JSON root(configFile);
if(!root.isOk()) {
return;
}
deserialiser_func(root.toElement());
} else {
auto root = m_root->toElement();
if(root.hasNamedObject(name)) {
deserialiser_func(root[name]);
}
}
}
void clConfig::WriteItem(const clConfigItem* item, const wxString& differentName)
{
wxString nameToUse = differentName.IsEmpty() ? item->GetName() : differentName;
DoDeleteProperty(nameToUse);
m_root->toElement().append(item->ToJSON());
m_root->save(m_filename);
}
void clConfig::Reload()
{
if(m_filename.FileExists() == false)
return;
delete m_root;
m_root = new JSON(m_filename);
}
wxArrayString clConfig::MergeArrays(const wxArrayString& arr1, const wxArrayString& arr2) const
{
// we use set to keep the records sorted
std::set<wxString> visited;
for(const wxString& element : arr1) {
if(visited.count(element))
continue;
visited.insert(element);
}
wxArrayString merged_array;
merged_array.reserve(visited.size());
for(const wxString& element : visited) {
merged_array.Add(element);
}
return merged_array;
}
wxStringMap_t clConfig::MergeStringMaps(const wxStringMap_t& map1, const wxStringMap_t& map2) const
{
wxStringMap_t output;
output.reserve(map1.size() + map2.size());
output.insert(map1.begin(), map1.end());
output.insert(map2.begin(), map2.end());
return output;
}
void clConfig::Save()
{
if(m_root) {
LOG_IF_TRACE { clDEBUG1() << "Config file:" << m_filename << "saved!" << endl; }
m_root->save(m_filename);
}
}
void clConfig::Save(const wxFileName& fn)
{
if(m_root)
m_root->save(fn);
}
JSONItem clConfig::GetGeneralSetting()
{
if(!m_root->toElement().hasNamedObject("General")) {
JSONItem general = JSONItem::createObject("General");
m_root->toElement().append(general);
}
return m_root->toElement().namedObject("General");
}
void clConfig::Write(const wxString& name, bool value)
{
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
general.removeProperty(name);
}
general.addProperty(name, value);
Save();
}
bool clConfig::Read(const wxString& name, bool defaultValue)
{
#if CL_USE_NATIVEBOOK
if(name == "UseCustomBaseColour")
return false;
#endif
JSONItem general = GetGeneralSetting();
if(general.namedObject(name).isBool()) {
return general.namedObject(name).toBool();
}
return defaultValue;
}
void clConfig::Write(const wxString& name, int value)
{
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
general.removeProperty(name);
}
general.addProperty(name, value);
Save();
}
int clConfig::Read(const wxString& name, int defaultValue)
{
JSONItem general = GetGeneralSetting();
return general.namedObject(name).toInt(defaultValue);
}
void clConfig::Write(const wxString& name, const wxString& value)
{
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
general.removeProperty(name);
}
general.addProperty(name, value);
Save();
}
wxString clConfig::Read(const wxString& name, const wxString& defaultValue)
{
JSONItem general = GetGeneralSetting();
if(general.namedObject(name).isString()) {
return general.namedObject(name).toString();
}
return defaultValue;
}
int clConfig::GetAnnoyingDlgAnswer(const wxString& name, int defaultValue)
{
if(m_root->toElement().hasNamedObject("AnnoyingDialogsAnswers")) {
JSONItem element = m_root->toElement().namedObject("AnnoyingDialogsAnswers");
if(element.hasNamedObject(name)) {
return element.namedObject(name).toInt(defaultValue);
}
}
return defaultValue;
}
void clConfig::SetAnnoyingDlgAnswer(const wxString& name, int value)
{
if(!m_root->toElement().hasNamedObject("AnnoyingDialogsAnswers")) {
JSONItem element = JSONItem::createObject("AnnoyingDialogsAnswers");
m_root->toElement().append(element);
}
JSONItem element = m_root->toElement().namedObject("AnnoyingDialogsAnswers");
if(element.hasNamedObject(name)) {
element.removeProperty(name);
}
element.addProperty(name, value);
Save();
}
void clConfig::ClearAnnoyingDlgAnswers()
{
DoDeleteProperty("AnnoyingDialogsAnswers");
Save();
Reload();
}
void clConfig::SetQuickFindSearchItems(const wxArrayString& items)
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
if(quickFindBar.hasNamedObject("SearchHistory")) {
quickFindBar.removeProperty("SearchHistory");
}
wxArrayString items_to_save = items;
truncate_array(items_to_save, 20);
quickFindBar.addProperty("SearchHistory", items_to_save);
Save();
}
void clConfig::SetQuickFindReplaceItems(const wxArrayString& items)
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
if(quickFindBar.hasNamedObject("ReplaceHistory")) {
quickFindBar.removeProperty("ReplaceHistory");
}
wxArrayString items_to_save = items;
truncate_array(items_to_save, 20);
quickFindBar.addProperty("ReplaceHistory", items_to_save);
Save();
}
void clConfig::AddQuickFindReplaceItem(const wxString& str)
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
ADD_ARR_IF_NOT_EXISTS(quickFindBar, "ReplaceHistory");
JSONItem arr = quickFindBar.namedObject("ReplaceHistory");
wxArrayString items = arr.toArrayString();
// Update the array
int where = items.Index(str);
if(where != wxNOT_FOUND) {
items.RemoveAt(where);
items.Insert(str, 0);
} else {
// remove overflow items if needed
if(items.GetCount() > 20) {
// remove last item
items.RemoveAt(items.GetCount() - 1);
}
items.Insert(str, 0);
}
quickFindBar.removeProperty("ReplaceHistory");
quickFindBar.addProperty("ReplaceHistory", items);
Save();
}
void clConfig::AddQuickFindSearchItem(const wxString& str)
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
ADD_ARR_IF_NOT_EXISTS(quickFindBar, "SearchHistory");
JSONItem arr = quickFindBar.namedObject("SearchHistory");
wxArrayString items = arr.toArrayString();
// Update the array
int where = items.Index(str);
if(where != wxNOT_FOUND) {
items.RemoveAt(where);
}
items.Insert(str, 0);
// Reudce to size to max of 20
while(items.size() > 20) {
items.RemoveAt(items.size() - 1);
}
// Update the array
quickFindBar.removeProperty("SearchHistory");
quickFindBar.addProperty("SearchHistory", items);
Save();
}
wxArrayString clConfig::GetQuickFindReplaceItems() const
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
ADD_ARR_IF_NOT_EXISTS(quickFindBar, "ReplaceHistory");
return quickFindBar.namedObject("ReplaceHistory").toArrayString();
}
wxArrayString clConfig::GetQuickFindSearchItems() const
{
ADD_OBJ_IF_NOT_EXISTS(m_root->toElement(), "QuickFindBar");
JSONItem quickFindBar = m_root->toElement().namedObject("QuickFindBar");
ADD_ARR_IF_NOT_EXISTS(quickFindBar, "SearchHistory");
return quickFindBar.namedObject("SearchHistory").toArrayString();
}
wxArrayString clConfig::Read(const wxString& name, const wxArrayString& defaultValue)
{
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
return general.namedObject(name).toArrayString();
}
return defaultValue;
}
void clConfig::Write(const wxString& name, const wxArrayString& value)
{
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
general.removeProperty(name);
}
general.addProperty(name, value);
Save();
}
void clConfig::DoAddRecentItem(const wxString& propName, const wxString& filename)
{
wxArrayString recentItems = DoGetRecentItems(propName);
// Prepend the item
if(recentItems.Index(filename) != wxNOT_FOUND) {
recentItems.Remove(filename);
}
if(!wxFileName(filename).FileExists()) {
// Don't add non existing file
return;
}
recentItems.Insert(filename, 0);
// Make sure the list does not go over 15 items
while(recentItems.size() >= 15) {
recentItems.RemoveAt(recentItems.size() - 1);
}
// Remove non existing items
wxArrayString existingFiles;
for(size_t i = 0; i < recentItems.size(); ++i) {
if(wxFileName(recentItems.Item(i)).FileExists()) {
existingFiles.Add(recentItems.Item(i));
}
}
recentItems.swap(existingFiles);
// Remove old node if exists
JSONItem e = m_root->toElement();
if(e.hasNamedObject(propName)) {
e.removeProperty(propName);
}
// append new property
e.addProperty(propName, recentItems);
// update the cache
if(m_cacheRecentItems.count(propName)) {
m_cacheRecentItems.erase(propName);
}
m_cacheRecentItems.insert(std::make_pair(propName, recentItems));
m_root->save(m_filename);
}
void clConfig::DoClearRecentItems(const wxString& propName)
{
JSONItem e = m_root->toElement();
if(e.hasNamedObject(propName)) {
e.removeProperty(propName);
}
m_root->save(m_filename);
// update the cache
if(m_cacheRecentItems.count(propName)) {
m_cacheRecentItems.erase(propName);
}
}
wxArrayString clConfig::DoGetRecentItems(const wxString& propName) const
{
wxArrayString recentItems;
// Try the cache first
if(m_cacheRecentItems.count(propName)) {
recentItems = m_cacheRecentItems.find(propName)->second;
} else {
JSONItem e = m_root->toElement();
if(e.hasNamedObject(propName)) {
recentItems = e.namedObject(propName).toArrayString();
}
}
return recentItems;
}
#if wxUSE_GUI
wxFont clConfig::Read(const wxString& name, const wxFont& defaultValue)
{
JSONItem general = GetGeneralSetting();
if(!general.hasNamedObject(name))
return defaultValue;
// Unserialize the font
wxFont font;
JSONItem f = general.namedObject(name);
if(!f.hasNamedObject("fontDesc"))
return defaultValue;
font.SetNativeFontInfo(FontUtils::GetFontInfo(f.namedObject("fontDesc").toString()));
return font;
}
void clConfig::Write(const wxString& name, const wxFont& value)
{
JSONItem font = JSONItem::createObject(name);
font.addProperty("fontDesc", FontUtils::GetFontInfo(value));
JSONItem general = GetGeneralSetting();
if(general.hasNamedObject(name)) {
general.removeProperty(name);
}
general.append(font);
Save();
}
wxColour clConfig::Read(const wxString& name, const wxColour& defaultValue)
{
wxString strValue;
strValue = Read(name, wxString());
if(strValue.IsEmpty()) {
return defaultValue;
}
wxColour col(strValue);
return col;
}
void clConfig::Write(const wxString& name, const wxColour& value)
{
wxString strValue = value.GetAsString(wxC2S_HTML_SYNTAX);
Write(name, strValue);
Save();
}
#endif
|