09f71cb40d
Adds a generic C++ based caching library to support material external modules. This is a template based library which means there is nothing to build or link. The only modification is to the CMakeLists.txt file to enable integration with FreeCAD, Original source: https://github.com/goldsborough/lru-cache
108 lines
3.6 KiB
C++
108 lines
3.6 KiB
C++
/// The MIT License (MIT)
|
|
/// Copyright (c) 2016 Peter Goldsborough
|
|
///
|
|
/// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
/// of this software and associated documentation files (the "Software"), to
|
|
/// deal in the Software without restriction, including without limitation the
|
|
/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
/// sell copies of the Software, and to permit persons to whom the Software is
|
|
/// furnished to do so, subject to the following conditions:
|
|
///
|
|
/// The above copyright notice and this permission notice shall be included in
|
|
/// all copies or substantial portions of the Software.
|
|
///
|
|
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
/// IN THE SOFTWARE.
|
|
|
|
#ifndef LRU_INTERNAL_ERRORS_HPP
|
|
#define LRU_INTERNAL_ERRORS_HPP
|
|
|
|
#include <stdexcept>
|
|
#include <string>
|
|
|
|
namespace LRU {
|
|
namespace Error {
|
|
|
|
/// Exception thrown when the value of an invalid key was requested.
|
|
struct KeyNotFound : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
|
|
KeyNotFound() : super("Failed to find key") {
|
|
}
|
|
|
|
explicit KeyNotFound(const std::string& key)
|
|
: super("Failed to find key: " + key) {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when the value of an expired key was requested.
|
|
struct KeyExpired : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
|
|
explicit KeyExpired(const std::string& key)
|
|
: super("Key found, but expired: " + key) {
|
|
}
|
|
|
|
KeyExpired() : super("Key found, but expired") {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when requesting the front or end key of an empty cache.
|
|
struct EmptyCache : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
explicit EmptyCache(const std::string& what_was_expected)
|
|
: super("Requested " + what_was_expected + " of empty cache") {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when attempting to convert an invalid unordered iterator to
|
|
/// an ordered iterator.
|
|
struct InvalidIteratorConversion : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
InvalidIteratorConversion()
|
|
: super("Cannot convert past-the-end unordered to ordered iterator") {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when attempting to erase the past-the-end iterator.
|
|
struct InvalidIterator : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
InvalidIterator() : super("Past-the-end iterator is invalid here") {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when requesting statistics about an unmonitored key.
|
|
struct UnmonitoredKey : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
UnmonitoredKey() : super("Requested statistics for unmonitored key") {
|
|
}
|
|
};
|
|
|
|
/// Exception thrown when requesting the statistics object of a cache when none
|
|
/// was registered.
|
|
struct NotMonitoring : public std::runtime_error {
|
|
using super = std::runtime_error;
|
|
NotMonitoring() : super("Statistics monitoring not enabled for this cache") {
|
|
}
|
|
};
|
|
|
|
namespace Lowercase {
|
|
using key_not_found = KeyNotFound;
|
|
using key_expired = KeyExpired;
|
|
using empty_cache = EmptyCache;
|
|
using invalid_iterator_conversion = InvalidIteratorConversion;
|
|
using invalid_iterator = InvalidIterator;
|
|
using unmonitored_key = UnmonitoredKey;
|
|
using not_monitoring = NotMonitoring;
|
|
} // namespace Lowercase
|
|
|
|
} // namespace Error
|
|
} // namespace LRU
|
|
|
|
#endif // LRU_INTERNAL_ERRORS_HPP
|