utility_program.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef UTILITY_PROGRAM_H
#define UTILITY_PROGRAM_H
 
#include <functional>
#include <iostream>
#include <string>
#include <vector>
 
namespace KI_TEST
{

enum RET_CODES
{
    OK = 0,

    BAD_CMDLINE = 1,

    UNKNOWN_TOOL = 2,

    TOOL_SPECIFIC = 10,
};
 

struct UTILITY_PROGRAM
{
    using FUNC = std::function<int( int argc, char** argv )>;
 
    UTILITY_PROGRAM( const std::string& aName, const std::string& aDesc, FUNC aMainFunc )
            : m_name( aName ), m_desc( aDesc ), m_func( aMainFunc )
    {
    }
 
    UTILITY_PROGRAM() : m_func( nullptr )
    {
    }

    std::string m_name;

    std::string m_desc;

    FUNC m_func;
};
 

class COMBINED_UTILITY
{
public:

    int HandleCommandLine( int argc, char** argv ) const;
 
private:
    void showSubUtilityList( std::ostream& os ) const;

    UTILITY_PROGRAM::FUNC* findSubUtility( const std::string& aName ) const;

    void printUsage( char* name, std::ostream& os ) const;
};
 
} // namespace KI_TEST
 
#endif // UTILITY_PROGRAM_H