87 lines
2.4 KiB
C++
87 lines
2.4 KiB
C++
/**
|
|
* @file commands.hpp
|
|
* @brief Command handlers for the info module
|
|
*
|
|
* @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>
|
|
|
|
/**
|
|
* @enum Command
|
|
* @brief Commands supported by the info module
|
|
*/
|
|
enum Command {
|
|
CMD_UNKNOWN, /**< Unknown or unsupported command */
|
|
CMD_HELP, /**< Display help information */
|
|
CMD_VERSION, /**< Display core and module versions */
|
|
CMD_SYSTEM, /**< Display system information */
|
|
CMD_CONFIG, /**< Display configuration information */
|
|
};
|
|
|
|
/**
|
|
* @brief Parses a command string into a Command enum value
|
|
*
|
|
* @param cmd_str The command string to parse (NULL/empty means help)
|
|
* @return The corresponding Command enum value
|
|
*/
|
|
Command parse_command(const char* cmd_str);
|
|
|
|
/**
|
|
* @brief Displays the info module's help text
|
|
*
|
|
* @param ctx Host core context
|
|
* @return 0 on success
|
|
*/
|
|
int cmd_help(dpm_ctx* ctx);
|
|
|
|
/**
|
|
* @brief Reports the running core version and the info module version
|
|
*
|
|
* @param ctx Host core context
|
|
* @return 0 on success
|
|
*/
|
|
int cmd_version(dpm_ctx* ctx);
|
|
|
|
/**
|
|
* @brief Reports operating system and architecture information
|
|
*
|
|
* @param ctx Host core context
|
|
* @return 0 on success
|
|
*/
|
|
int cmd_system(dpm_ctx* ctx);
|
|
|
|
/**
|
|
* @brief Reports core configuration as resolved by the running context
|
|
*
|
|
* @param ctx Host core context
|
|
* @return 0 on success
|
|
*/
|
|
int cmd_config(dpm_ctx* ctx);
|
|
|
|
/**
|
|
* @brief Reports an unrecognized command
|
|
*
|
|
* @param ctx Host core context
|
|
* @param command The unrecognized command string
|
|
* @return 1 to indicate failure
|
|
*/
|
|
int cmd_unknown(dpm_ctx* ctx, const char* command);
|