mirror of https://github.com/odrling/Aegisub
109 lines
3.6 KiB
C++
109 lines
3.6 KiB
C++
// Copyright (c) 2010, Amar Takhar <verm@aegisub.org>
|
|
//
|
|
// Permission to use, copy, modify, and distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice appear in all copies.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
#include <boost/filesystem/path.hpp>
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
#include <libaegisub/exception.h>
|
|
#include <libaegisub/fs_fwd.h>
|
|
|
|
namespace json {
|
|
class UnknownElement;
|
|
typedef std::vector<UnknownElement> Array;
|
|
}
|
|
|
|
namespace agi {
|
|
class Options;
|
|
|
|
DEFINE_EXCEPTION(MRUError, Exception);
|
|
DEFINE_EXCEPTION(MRUErrorInvalidKey, MRUError);
|
|
DEFINE_EXCEPTION(MRUErrorIndexOutOfRange, MRUError);
|
|
|
|
/// @class MRUManager
|
|
/// @brief Most Recently Used (MRU) list handling
|
|
///
|
|
/// Add() should be called anytime a file is opened, this will either add the
|
|
/// entry or update it if it already exists.
|
|
///
|
|
/// If a file fails to open, Remove() should be called.
|
|
class MRUManager {
|
|
public:
|
|
/// @brief Map for time->value pairs.
|
|
using MRUListMap = std::vector<agi::fs::path>;
|
|
|
|
/// @brief Constructor
|
|
/// @param config File to load MRU values from
|
|
MRUManager(agi::fs::path const& config, std::pair<const char *, size_t> default_config, agi::Options *options = nullptr);
|
|
|
|
template<size_t N>
|
|
MRUManager(agi::fs::path const& file, const char (&default_config)[N])
|
|
: MRUManager(file, {default_config, N - 1}) { }
|
|
|
|
/// @brief Add entry to the list.
|
|
/// @param key List name
|
|
/// @param entry Entry to add
|
|
/// @exception MRUErrorInvalidKey thrown when an invalid key is used.
|
|
void Add(std::string const& key, agi::fs::path const& entry);
|
|
|
|
/// @brief Remove entry from the list.
|
|
/// @param key List name
|
|
/// @param entry Entry to add
|
|
/// @exception MRUErrorInvalidKey thrown when an invalid key is used.
|
|
void Remove(std::string const& key, agi::fs::path const& entry);
|
|
|
|
/// @brief Return list
|
|
/// @param key List name
|
|
/// @exception MRUErrorInvalidKey thrown when an invalid key is used.
|
|
const MRUListMap* Get(std::string const& key);
|
|
|
|
/// @brief Return A single entry in a list.
|
|
/// @param key List name
|
|
/// @param entry 0-base position of entry
|
|
/// @exception MRUErrorInvalidKey thrown when an invalid key is used.
|
|
agi::fs::path const& GetEntry(std::string const& key, const size_t entry);
|
|
|
|
/// Write MRU lists to disk.
|
|
void Flush();
|
|
|
|
private:
|
|
/// Internal name of the config file, set during object construction.
|
|
const agi::fs::path config_name;
|
|
|
|
/// User preferences object for maximum number of items to list
|
|
agi::Options *const options;
|
|
|
|
/// @brief Map for MRUListMap values.
|
|
/// @param std::string Name
|
|
/// @param MRUListMap instance.
|
|
using MRUMap = std::map<std::string, MRUListMap>;
|
|
|
|
/// Internal MRUMap values.
|
|
MRUMap mru;
|
|
|
|
/// Map from MRU name to option name
|
|
const std::map<std::string, std::string> option_names;
|
|
|
|
/// @brief Load MRU Lists.
|
|
/// @param key List name.
|
|
/// @param array json::Array of values.
|
|
void Load(std::string const& key, ::json::Array const& array);
|
|
/// @brief Prune MRUListMap to the desired length.
|
|
/// This uses the user-set values for MRU list length.
|
|
void Prune(std::string const& key, MRUListMap& map) const;
|
|
MRUListMap &Find(std::string const& key);
|
|
};
|
|
|
|
} // namespace agi
|