build_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) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2015-2020 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
 */
 
// Date for KiCad build version
#include <wx/wx.h>
#include <config.h>
#include <boost/version.hpp>
#include <kiplatform/app.h>
#include <font/outline_font.h>
 
#include <tuple>
 
// kicad_curl.h must be included before wx headers, to avoid
// conflicts for some defines, at least on Windows
// kicad_curl.h can create conflicts for some defines, at least on Windows
// so we are using here 2 proxy functions to know Curl version to avoid
// including kicad_curl.h to know Curl version
extern std::string GetKicadCurlVersion();
extern std::string GetCurlLibVersion();
 
#include <Standard_Version.hxx>
 
#if defined( KICAD_SPICE )
#include <ngspice/sharedspice.h>
#endif
 
// The include file version.h is always created even if the repo version cannot be
// determined. In this case KICAD_VERSION_FULL will default to the KICAD_VERSION
// that is set in KiCadVersion.cmake.
#define INCLUDE_KICAD_VERSION
#include <kicad_build_version.h>
#undef INCLUDE_KICAD_VERSION
 
wxString GetPlatformGetBitnessName()
{
 wxPlatformInfo platform;
// TODO (ISM): Read conditional once our wx fork and flatpaks are running released 3.1.5
// On Windows, use GetBitnessName if exists
// I (J-PC) hope 3.1.6 has no problem
#if defined( __WINDOWS__ ) && wxCHECK_VERSION( 3, 1, 5 )
 return platform.GetBitnessName();
#elif wxCHECK_VERSION( 3, 1, 6 )
 return platform.GetBitnessName();
#else
 return platform.GetArchName();
#endif
}
 
 
bool IsNightlyVersion()
{
 return !!KICAD_IS_NIGHTLY;
}
 
 
wxString GetBuildVersion()
{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_VERSION_FULL ) );
 return msg;
}
 
 
wxString GetBuildDate()
{
 wxString msg = wxString::Format( wxT( "%s %s" ), wxT( __DATE__ ), wxT( __TIME__ ) );
 return msg;
}
 
 
wxString GetSemanticVersion()
{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_SEMANTIC_VERSION ) );
 return msg;
}
 
 
wxString GetMajorMinorVersion()
{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_MAJOR_MINOR_VERSION ) );
 return msg;
}
 
 
wxString GetCommitHash()
{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_COMMIT_HASH ) );
 return msg;
}
 
 
wxString GetMajorMinorPatchVersion()
{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_MAJOR_MINOR_PATCH_VERSION ) );
 return msg;
}
 
const std::tuple<int,int,int>& GetMajorMinorPatchTuple()
{
 static std::tuple<int, int, int> retval = KICAD_MAJOR_MINOR_PATCH_TUPLE;
 
 return retval;
}
 
 
wxString GetVersionInfoData( const wxString& aTitle, bool aHtml, bool aBrief )
{
 wxString aMsg;
 // DO NOT translate information in the msg_version string
 
 wxString eol = aHtml ? "<br>" : "\n";
 
 // Tabs instead of spaces for the plaintext version for shorter string length
 wxString indent4 = aHtml ? "&nbsp;&nbsp;&nbsp;&nbsp;" : "\t";
 
#define ON "ON" << eol
#define OFF "OFF" << eol
 
 wxString version;
 version << ( KIPLATFORM::APP::IsOperatingSystemUnsupported() ? wxString( wxS( "(UNSUPPORTED)" ) )
 : GetBuildVersion() )
#ifdef DEBUG
 << ", debug"
#else
 << ", release"
#endif
 << " build";
 
 wxPlatformInfo platform;
 aMsg << "Application: " << aTitle;
 #if wxCHECK_VERSION( 3, 1, 6 )
 aMsg << " " << wxGetCpuArchitectureName() << " on " << wxGetNativeCpuArchitectureName();
 #elif defined( KICAD_BUILD_ARCH_X64 )
 aMsg << " (64-bit)";
 #elif defined( KICAD_BUILD_ARCH_X86 )
 aMsg << " (32-bit)";
 #elif defined( KICAD_BUILD_ARCH_ARM )
 aMsg << " (ARM 32-bit)";
 #elif defined( KICAD_BUILD_ARCH_ARM64 )
 aMsg << " (ARM 64-bit)";
 #endif
 
 aMsg << eol << eol;
 
 
 aMsg << "Version: " << version << eol << eol;
 aMsg << "Libraries:" << eol;
 
 aMsg << indent4 << wxGetLibraryVersionInfo().GetVersionString() << eol;
 
 aMsg << indent4 << "FreeType " << KIFONT::OUTLINE_FONT::FreeTypeVersion() << eol;
 aMsg << indent4 << "HarfBuzz " << KIFONT::OUTLINE_FONT::HarfBuzzVersion() << eol;
 aMsg << indent4 << "FontConfig " << KIFONT::OUTLINE_FONT::FontConfigVersion() << eol;
 
 if( !aBrief )
 aMsg << indent4 << GetKicadCurlVersion() << eol;
 
 aMsg << eol;
 
 aMsg << "Platform: "
#if __LINUX__
 << wxGetLinuxDistributionInfo().Description << ", "
#else
 << wxGetOsDescription() << ", "
#endif
 << GetPlatformGetBitnessName() << ", "
 << platform.GetEndiannessName() << ", "
 << platform.GetPortIdName();
 
#ifdef __WXGTK__
 aMsg << ", " << wxGetenv( "XDG_SESSION_DESKTOP" )
 << ", " << wxGetenv( "XDG_SESSION_TYPE" );
#endif
 
 aMsg << eol << eol;
 
 if( !aBrief )
 {
 aMsg << "Build Info:" << eol;
 aMsg << indent4 << "Date: " << GetBuildDate() << eol;
 }
 
 aMsg << indent4 << "wxWidgets: " << wxVERSION_NUM_DOT_STRING << " (";
 aMsg << __WX_BO_UNICODE __WX_BO_STL __WX_BO_WXWIN_COMPAT_2_8 ")";
 
 // Get the GTK+ version where possible.
#ifdef __WXGTK__
 int major, minor;
 
 major = wxPlatformInfo().Get().GetToolkitMajorVersion();
 minor = wxPlatformInfo().Get().GetToolkitMinorVersion();
 aMsg << " GTK+ " << major << "." << minor;
#endif
 
 aMsg << eol;
 
 aMsg << indent4 << "Boost: " << ( BOOST_VERSION / 100000 ) << wxT( "." )
 << ( BOOST_VERSION / 100 % 1000 ) << wxT( "." )
 << ( BOOST_VERSION % 100 ) << eol;
 
 aMsg << indent4 << "OCC: " << OCC_VERSION_COMPLETE << eol;
 aMsg << indent4 << "Curl: " << GetCurlLibVersion() << eol;
 
#if defined( KICAD_SPICE )
#if defined( NGSPICE_BUILD_VERSION )
 aMsg << indent4 << "ngspice: " << NGSPICE_BUILD_VERSION << eol;
#elif defined( NGSPICE_HAVE_CONFIG_H )
 #undef HAVE_STRNCASECMP /* is redefined in ngspice/config.h */
 #include <ngspice/config.h>
 aMsg << indent4 << "ngspice: " << PACKAGE_VERSION << eol;
#elif defined( NGSPICE_PACKAGE_VERSION )
 aMsg << indent4 << "ngspice: " << NGSPICE_PACKAGE_VERSION << eol;
#else
 aMsg << indent4 << "ngspice: " << "unknown" << eol;
#endif
#endif
 
 aMsg << indent4 << "Compiler: ";
#if defined(__clang__)
 aMsg << "Clang " << __clang_major__ << "." << __clang_minor__ << "." << __clang_patchlevel__;
#elif defined(__GNUG__)
 aMsg << "GCC " << __GNUC__ << "." << __GNUC_MINOR__ << "." << __GNUC_PATCHLEVEL__;
#elif defined(_MSC_VER)
 aMsg << "Visual C++ " << _MSC_VER;
#elif defined(__INTEL_COMPILER)
 aMsg << "Intel C++ " << __INTEL_COMPILER;
#else
 aMsg << "Other Compiler ";
#endif
 
#if defined(__GXX_ABI_VERSION)
 aMsg << " with C++ ABI " << __GXX_ABI_VERSION << eol;
#else
 aMsg << " without C++ ABI" << eol;
#endif
 
 aMsg << eol;
 
 // Add build settings config (build options):
 aMsg << "Build settings:" << eol;
 
#ifdef KICAD_USE_EGL
 aMsg << indent4 << "KICAD_USE_EGL=" << ON;
#endif
 
 aMsg << indent4 << "KICAD_SPICE=";
#ifdef KICAD_SPICE
 aMsg << ON;
#else
 aMsg << OFF;
#endif
 
#ifndef NDEBUG
 aMsg << indent4 << "KICAD_STDLIB_DEBUG=";
#ifdef KICAD_STDLIB_DEBUG
 aMsg << ON;
#else
 aMsg << OFF;
 aMsg << indent4 << "KICAD_STDLIB_LIGHT_DEBUG=";
#ifdef KICAD_STDLIB_LIGHT_DEBUG
 aMsg << ON;
#else
 aMsg << OFF;
#endif
#endif
 
 aMsg << indent4 << "KICAD_SANITIZE_ADDRESS=";
#ifdef KICAD_SANITIZE_ADDRESS
 aMsg << ON;
#else
 aMsg << OFF;
#endif
 
 aMsg << indent4 << "KICAD_SANITIZE_THREADS=";
#ifdef KICAD_SANITIZE_THREADS
 aMsg << ON;
#else
 aMsg << OFF;
#endif
#endif
 
 return aMsg;
}