command_version.cpp

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 <[email protected]>
 * Copyright (C) 1992-2023 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/>.
 */
 
#include "command_version.h"
#include <cli/exit_codes.h>
#include <wx/crt.h>
#include <build_version.h>
 
#include <string_utils.h>
#include <build_version.h>
 
 
#define ARG_FORMAT "--format"
 
 
CLI::VERSION_COMMAND::VERSION_COMMAND() : COMMAND( "version" )
{
    m_argParser.add_description( UTF8STDSTR( _( "Reports the version info in various formats" ) ) );
 
    m_argParser.add_argument( ARG_FORMAT )
            .default_value( std::string( "plain" ) )
            .help( UTF8STDSTR( _( "version info format (plain, commit, about)" ) ) );
}
 
 
int CLI::VERSION_COMMAND::doPerform( KIWAY& aKiway )
{
    if( !m_argParser )
    {
        // were we redirected from the --version?
        // m_argParser override for bool() returns false if we didnt parse any args normally
        // we need to exit here early because it'll exception in the later arg handling code
        // if we don't no arg provided also ends up here on the version command
        wxPrintf( "%s\n", GetMajorMinorPatchVersion() );
        return EXIT_CODES::OK;
    }
 
    wxString format = From_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
    if( format == wxS( "plain" ) )
    {
        wxPrintf( "%s\n", GetMajorMinorPatchVersion() );
    }
    else if( format == wxS( "commit" ) )
    {
        wxPrintf( "%s\n", GetCommitHash() );
    }
    else if( format == wxS( "about" ) )
    {
        wxString msg_version = GetVersionInfoData( wxS( "kicad-cli" ) );
        wxPrintf( "%s\n", msg_version );
    }
    else
    {
        wxFprintf( stderr, _( "Invalid format\n" ) );
        return EXIT_CODES::ERR_ARGS;
    }
 
    return EXIT_CODES::OK;
}