mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Oliver Hamlet
bfb168907c
- CreateGameHandle() should return a unique_ptr because it transfers ownership. - GameInterface::GetDatabase() should return a reference because it returns an existing object that will always be valid at call time. - GameInterface::GetPlugin() and GameInterface::GetLoadedPlugins() return raw pointers because they do not transfer or share ownership. It's unfortunately that references can't be used instead (ignoring std::reference_wrapper), as std::optional<const Plugin&> and std::vector<const Plugin&> would be more meaningful return types. Internally, there were a few uses of shared_ptr that could be unique_ptr and a few that could be non-pointer types. A few uses of shared_ptr remain: - Game and ApiDatabase share a ConditionEvaluator, so it's kept inside a shared_ptr. Technically ApiDatabase is used such that the ConditionEvaluator it uses will always outlive it, but that's not guaranteed, so shared_ptr is used for safety. - Plugin objects are cached inside shared_ptr so that the map of them can be iterated over. Ideally they'd be stored in unique_ptr, but unique_ptr not being copyable means the map entries can't be iterated over.
115 lines
3.5 KiB
C++
115 lines
3.5 KiB
C++
/* LOOT
|
|
|
|
A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
|
|
Fallout: New Vegas.
|
|
|
|
Copyright (C) 2013-2016 WrinklyNinja
|
|
|
|
This file is part of LOOT.
|
|
|
|
LOOT 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 3 of
|
|
the License, or (at your option) any later version.
|
|
|
|
LOOT is distributed in the hope that it will
|
|
be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with LOOT. If not, see
|
|
<https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef LOOT_API_H
|
|
#define LOOT_API_H
|
|
|
|
#include <filesystem>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "loot/api_decorator.h"
|
|
#include "loot/enum/game_type.h"
|
|
#include "loot/enum/log_level.h"
|
|
#include "loot/exception/condition_syntax_error.h"
|
|
#include "loot/exception/cyclic_interaction_error.h"
|
|
#include "loot/exception/error_categories.h"
|
|
#include "loot/exception/file_access_error.h"
|
|
#include "loot/exception/undefined_group_error.h"
|
|
#include "loot/game_interface.h"
|
|
#include "loot/loot_version.h"
|
|
|
|
namespace loot {
|
|
/**
|
|
* @}
|
|
* @name Logging Functions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Set the callback function that is called when logging.
|
|
* @details If this function is not called, the default behaviour is to
|
|
* print messages to the console.
|
|
* @param callback
|
|
* The function called when logging. The first parameter is the
|
|
* level of the message being logged, and the second is the message.
|
|
*/
|
|
LOOT_API void SetLoggingCallback(
|
|
std::function<void(LogLevel, const char*)> callback);
|
|
|
|
/**
|
|
* @}
|
|
* @name Version Functions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Checks for API compatibility.
|
|
* @details Checks whether the loaded API is compatible with the given
|
|
* version of the API, abstracting API stability policy away from
|
|
* clients. The version numbering used is major.minor.patch.
|
|
* @param major
|
|
* The major version number to check.
|
|
* @param minor
|
|
* The minor version number to check.
|
|
* @param patch
|
|
* The patch version number to check.
|
|
* @returns True if the API versions are compatible, false otherwise.
|
|
*/
|
|
LOOT_API bool IsCompatible(const unsigned int major,
|
|
const unsigned int minor,
|
|
const unsigned int patch);
|
|
|
|
/**
|
|
* @}
|
|
* @name Lifecycle Management Functions
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Initialise a new game handle.
|
|
* @details Creates a handle for a game, which is then used by all
|
|
* game-specific functions.
|
|
* @param game
|
|
* A game code for which to create the handle.
|
|
* @param game_path
|
|
* The relative or absolute path to the directory containing the
|
|
* game's executable.
|
|
* @param game_local_path
|
|
* The relative or absolute path to the game's folder in
|
|
* `%%LOCALAPPDATA%` or an empty path. If an empty path, the API will
|
|
* attempt to look up the path that `%%LOCALAPPDATA%` corresponds to.
|
|
* This parameter is provided so that systems lacking that environmental
|
|
* variable (eg. Linux) can still use the API.
|
|
* @returns The new game handle.
|
|
*/
|
|
LOOT_API std::unique_ptr<GameInterface> CreateGameHandle(
|
|
const GameType game,
|
|
const std::filesystem::path& game_path,
|
|
const std::filesystem::path& game_local_path = "");
|
|
}
|
|
|
|
#endif
|