KiCad PCB EDA Suite
command.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2022 Mark Roszko <[email protected]>
5 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef CLI_COMMAND_H
22#define CLI_COMMAND_H
23
24#include <argparse/argparse.hpp>
25#include <kiway.h>
26
27#define UTF8STDSTR( s ) ( std::string( s.utf8_str() ) )
28
29#define ARG_VERSION "--version"
30#define ARG_HELP "--help"
31#define ARG_HELP_SHORT "-h"
32#define ARG_HELP_DESC _( "shows help message and exits" )
33
34namespace CLI
35{
36
38{
39public:
45 COMMAND( const std::string& aName );
46
50 int Perform( KIWAY& aKiway );
51
52 virtual ~COMMAND() = default;
53
54 argparse::ArgumentParser& GetArgParser() { return m_argParser; }
55 const std::string& GetName() const { return m_name; }
56
57 void PrintHelp();
58protected:
65 virtual int doPerform( KIWAY& aKiway );
66
67 std::string m_name;
68 argparse::ArgumentParser m_argParser;
69};
70
71}
72
73#endif
virtual ~COMMAND()=default
std::string m_name
Definition: command.h:67
virtual int doPerform(KIWAY &aKiway)
The internal handler that should be overloaded to implement command specific processing and work.
Definition: command.cpp:62
argparse::ArgumentParser & GetArgParser()
Definition: command.h:54
argparse::ArgumentParser m_argParser
Definition: command.h:68
COMMAND(const std::string &aName)
Define a new COMMAND instance.
Definition: command.cpp:29
const std::string & GetName() const
Definition: command.h:55
void PrintHelp()
Definition: command.cpp:41
int Perform(KIWAY &aKiway)
Entry point to processing commands from args and doing work.
Definition: command.cpp:49
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
Definition: exit_codes.h:25