The project version moves to 1.0.0, which the library soname, the reported version, the test expectations, and the generated document filename all derive from. SOVERSION now matches the major version. The generated reference is built from the source and its documentation comments alone. Prose from docs/ was briefly part of the input and is removed: development notes are written and read on their own, and a generator that reproduces them adds nothing. The reference opens on a front page declared in the public header, followed by the module contract. One target builds it. Both PDF and HTML are produced by default, the finished documents land in the build tree under docs/pdf and docs/html, and the generators work in docs/tmp. The internal namespace is dpm_core, matching the artifact name as closely as a C++ identifier permits.
86 lines
2.5 KiB
C++
86 lines
2.5 KiB
C++
/**
|
|
* @file context.hpp
|
|
* @brief The libdpm-core context: configuration, logging, module registry
|
|
*
|
|
* @copyright Copyright (c) 2026 SILO GROUP LLC
|
|
* @author Chris Punches <chris.punches@silogroup.org>
|
|
*
|
|
* Part of the Dark Horse Linux Package Manager (DPM)
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 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; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <dpm/core.h>
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "internal/modules.hpp"
|
|
|
|
/** @brief A libdpm-core context: configuration, logging, module registry */
|
|
struct dpm_ctx {
|
|
/** Directory the .conf files were read from. */
|
|
std::string config_dir;
|
|
|
|
/** Directory modules are loaded from. */
|
|
std::string module_path;
|
|
|
|
/** Target root for package operations. */
|
|
std::string root;
|
|
|
|
/** Messages above this level are dropped. */
|
|
int log_level = DPM_LOG_INFO;
|
|
|
|
/** Whether to append messages to log_file. */
|
|
bool write_to_log = false;
|
|
|
|
/** Path of the log file. */
|
|
std::string log_file;
|
|
|
|
/** Configuration store, addressed as config[module][section][key]. */
|
|
std::map<std::string,
|
|
std::map<std::string,
|
|
std::map<std::string, std::string>>> config;
|
|
|
|
/** Validated modules keyed by name; each is loaded at most once. */
|
|
std::map<std::string, std::unique_ptr<dpm_module>> modules;
|
|
|
|
/** Reason for the most recent failure. */
|
|
std::string last_error;
|
|
};
|
|
|
|
namespace dpm_core {
|
|
|
|
/**
|
|
* @brief Records a failure reason on the context
|
|
*
|
|
* @param ctx The libdpm-core context; NULL is a no-op
|
|
* @param msg The failure description
|
|
*/
|
|
void set_error(dpm_ctx* ctx, const std::string& msg);
|
|
|
|
/**
|
|
* @brief Loads all configuration files into the context
|
|
*
|
|
* Parses every .conf file in the context's configuration directory
|
|
* into the context's configuration store.
|
|
*
|
|
* @param ctx The libdpm-core context
|
|
*/
|
|
void load_config_dir(dpm_ctx* ctx);
|
|
|
|
} // namespace dpm_core
|