Files
dpm-core-ng/include/internal/context.hpp
Christopher M. Punches 55c852586b Dispatch returns a result envelope
dpm_execute fills a dpm_result on every call: status and error_code
from the module's return value, and a payload the module hands back
through dpm_set_result. The payload's layout belongs to the module and
is documented per command; its release function is carried in the
envelope and invoked by dpm_result_release. The context keeps a stack
of the envelopes in progress, so a module calling a peer receives the
peer's payload in its own envelope and its caller sees only what the
module sets itself.

The good fixture returns a payload and counts its releases, and the
modules test covers the envelope fields, the payload round trip, single
release, discard on a NULL envelope, and a payload set outside any
dispatch. The prose documents describe the envelope and the payload
header a module ships.
2026-09-07 14:53:24 -04:00

102 lines
3.5 KiB
C++

/**
* @file context.hpp
* @brief The libdpm-core.so 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 <vector>
#include "internal/metadata.hpp"
#include "internal/modules.hpp"
/** @brief A libdpm-core.so 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;
/** Directory the .meta records and modules.aliases were read from. */
std::string metadata_dir;
/** 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;
/** Records of installed modules, keyed by module name. */
std::map<std::string, dpm_module_meta_records> meta_records;
/** Placeholder records a listing reports for modules carrying none. */
std::map<std::string, dpm_module_meta_records> uninstalled;
/** Alternate module names, keyed by alias. */
std::map<std::string, std::string> aliases;
/** Reason for the most recent failure. */
std::string last_error;
/** Envelopes of the dispatches in progress, innermost last. */
std::vector<dpm_result*> result_frames;
};
/**
* @namespace dpm_core
* @brief Internal implementation of libdpm-core.so
*
* Holds what the library's translation units share with each other and
* with nothing else: the loader, the configuration reader, the value
* sanitizers, and the version parser. It is declared in include/internal/,
* which is never installed, so a consumer or a module cannot name any of
* it.
*
* Nothing in here reaches the export table. The library is compiled with
* hidden default symbol visibility and linked against a version script
* whose `local: *` covers everything the public declarations do not
* claim, so these keep external linkage across the library's own files
* while staying invisible outside it.
*
* Helpers used by a single translation unit belong in that file's
* unnamed namespace instead, which gives them internal linkage and keeps
* them from colliding across files.
*/