command.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Mark Roszko <mark.roszko@gmail.com>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef CLI_COMMAND_H
#define CLI_COMMAND_H
 
#include <argparse/argparse.hpp>
#include <kiway.h>
 
#define UTF8STDSTR( s ) ( std::string( s.utf8_str() ) )
 
#define ARG_VERSION "--version"
#define ARG_HELP "--help"
#define ARG_HELP_SHORT "-h"
#define ARG_HELP_DESC _( "Shows help message and exits" )
#define ARG_OUTPUT "--output"
#define ARG_INPUT "input"
#define ARG_DRAWING_SHEET "--drawing-sheet"
#define ARG_DEFINE_VAR_SHORT "-D"
#define ARG_DEFINE_VAR_LONG "--define-var"
 
namespace CLI
{
 
class COMMAND
{
public:
    COMMAND( const std::string& aName );
 
    int Perform( KIWAY& aKiway );
 
    virtual ~COMMAND() = default;
 
    argparse::ArgumentParser& GetArgParser() { return m_argParser; }
    const std::string&        GetName() const { return m_name; }
 
    void PrintHelp();
 
protected:
    void addCommonArgs( bool aInput, bool aOutput, bool aInputCanBeDir, bool aOutputIsDir );
 
    void addDrawingSheetArg();
 
    void addDefineArg();
 
    virtual int              doPerform( KIWAY& aKiway );
 
    std::string              m_name;
 
    argparse::ArgumentParser m_argParser;
 
    bool                     m_hasInputArg;
 
    bool                     m_hasOutputArg;
 
    bool                     m_hasDrawingSheetArg;
 
    bool                     m_hasDefineArg;
 
    bool                     m_outputArgExpectsDir;
 
    wxString                 m_argInput;
 
    wxString                 m_argOutput;
 
    wxString                 m_argDrawingSheet;
 
    std::map<wxString, wxString>    m_argDefineVars;
};
 
}
 
#endif