ORE Studio 0.0.4
Loading...
Searching...
No Matches
parser_helpers.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_CLI_CONFIG_PARSER_HELPERS_HPP
21#define ORES_CLI_CONFIG_PARSER_HELPERS_HPP
22
23#include <string>
24#include <vector>
25#include <iosfwd>
26#include <boost/program_options.hpp>
27#include "ores.cli/config/entity.hpp"
28#include "ores.cli/config/format.hpp"
29#include "ores.cli/config/export_options.hpp"
30#include "ores.cli/config/delete_options.hpp"
31
32namespace ores::cli::config::parser_helpers {
33
37void print_help_header(std::ostream& s);
38
46void print_help_command(const std::string& command_name,
47 const boost::program_options::options_description& od, std::ostream& info);
48
52boost::program_options::options_description
53add_common_options(boost::program_options::options_description base);
54
58void validate_operation(const std::string& entity_name,
59 const std::string& operation,
60 const std::vector<std::string>& allowed_operations);
61
65void print_entity_help(const std::string& entity_name,
66 const std::string& description,
67 const std::vector<std::pair<std::string, std::string>>& operations,
68 std::ostream& info);
69
73boost::program_options::options_description make_export_options_description();
74
78boost::program_options::options_description make_delete_options_description();
79
83format read_format(const boost::program_options::variables_map& vm);
84
88export_options read_export_options(
89 const boost::program_options::variables_map& vm, entity e);
90
94delete_options read_delete_options(
95 const boost::program_options::variables_map& vm, entity e);
96
97}
98
99#endif