editor.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2024
    by Tomasz Sniatowski <kailoran@gmail.com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    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.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#include "preferences/editor.hpp"
#include "config.hpp"
#include "preferences/game.hpp"
#include "lexical_cast.hpp"
 
namespace preferences {
 
namespace editor {
 
    int auto_update_transitions() {
        return lexical_cast_default<int>(preferences::get("editor_auto_update_transitions"), TRANSITION_UPDATE_PARTIAL);
    }
 
    void set_auto_update_transitions(int value) {
        preferences::set("editor_auto_update_transitions", std::to_string(value));
    }
 
    std::string default_dir() {
        return preferences::get("editor_default_dir");
    }
 
    bool draw_terrain_codes() {
        return preferences::get("editor_draw_terrain_codes", false);
    }
 
    void set_draw_terrain_codes(bool value) {
        preferences::set("editor_draw_terrain_codes", value);
    }
 
    bool draw_hex_coordinates() {
        return preferences::get("editor_draw_hex_coordinates", false);
    }
 
    void set_draw_hex_coordinates(bool value) {
        preferences::set("editor_draw_hex_coordinates", value);
    }
 
    bool draw_num_of_bitmaps() {
        return preferences::get("editor_draw_num_of_bitmaps", false);
    }
 
    void set_draw_num_of_bitmaps(bool value) {
        preferences::set("editor_draw_num_of_bitmaps", value);
    }
 
    namespace {
        std::size_t editor_mru_limit()
        {
            return std::max(std::size_t(1), lexical_cast_default<std::size_t>(
                    preferences::get("editor_max_recent_files"), 10));
        }
 
        //
        // NOTE: The MRU read/save functions enforce the entry count limit in
        // order to ensure the list on disk doesn't grow forever. Otherwise,
        // normally this would be the UI's responsibility instead.
        //
 
        std::vector<std::string> do_read_editor_mru()
        {
            auto cfg = preferences::get_child("editor_recent_files");
 
            std::vector<std::string> mru;
            if(!cfg) {
                return mru;
            }
 
            for(const config& child : cfg->child_range("entry"))
            {
                const std::string& entry = child["path"].str();
                if(!entry.empty()) {
                    mru.push_back(entry);
                }
            }
 
            mru.resize(std::min(editor_mru_limit(), mru.size()));
 
            return mru;
        }
 
        void do_commit_editor_mru(const std::vector<std::string>& mru)
        {
            config cfg;
            unsigned n = 0;
 
            for(const std::string& entry : mru)
            {
                if(entry.empty()) {
                    continue;
                }
 
                config& child = cfg.add_child("entry");
                child["path"] = entry;
 
                if(++n >= editor_mru_limit()) {
                    break;
                }
            }
 
            preferences::set_child("editor_recent_files", cfg);
        }
    }
 
    std::vector<std::string> recent_files()
    {
        return do_read_editor_mru();
    }
 
    void add_recent_files_entry(const std::string& path)
    {
        if(path.empty()) {
            return;
        }
 
        std::vector<std::string> mru = do_read_editor_mru();
 
        // Enforce uniqueness. Normally shouldn't do a thing unless somebody
        // has been tampering with the preferences file.
        mru.erase(std::remove(mru.begin(), mru.end(), path), mru.end());
 
        mru.insert(mru.begin(), path);
        mru.resize(std::min(editor_mru_limit(), mru.size()));
 
        do_commit_editor_mru(mru);
    }
 
    void remove_recent_files_entry(const std::string& path)
    {
        if(path.empty()) {
            return;
        }
 
        std::vector<std::string> mru = do_read_editor_mru();
 
        mru.erase(std::remove(mru.begin(), mru.end(), path), mru.end());
 
        do_commit_editor_mru(mru);
    }
 
} //end namespace editor
 
} //end namespace preferences