build_version.cpp File Reference

#include <wx/wx.h>
#include <config.h>
#include <boost/version.hpp>
#include <kiplatform/app.h>
#include <kicad_build_version.h>

Go to the source code of this file.

Macros
#define	ON   wxT( "ON" ) << eol
#define	OFF   wxT( "OFF" ) << eol

Functions
std::string	GetKicadCurlVersion ()
std::string	GetCurlLibVersion ()
wxString	GetPlatformGetBitnessName ()
wxString	GetBuildVersion ()
	Get the full KiCad version string. More...
wxString	GetBuildDate ()
	Get the build date as a string. More...
wxString	GetSemanticVersion ()
	Get the semantic version string for KiCad defined inside the KiCadVersion.cmake file in the variable KICAD_SEMANTIC_VERSION. More...
wxString	GetMajorMinorVersion ()
	Get only the major and minor version in a string major.minor. More...
wxString	GetVersionInfoData (const wxString &aTitle, bool aHtml, bool aBrief)
	Create a version info string for bug reports and the about dialog. More...

Macro Definition Documentation

OFF

#define OFF   wxT( "OFF" ) << eol

ON

#define ON   wxT( "ON" ) << eol

Function Documentation

GetBuildDate()

wxString GetBuildDate

(

)

Get the build date as a string.

Returns

the build date string

Definition at line 72 of file build_version.cpp.

{
 wxString msg = wxString::Format( wxT( "%s %s" ), wxT( __DATE__ ), wxT( __TIME__ ) );
 return msg;
}

References Format().

Referenced by buildKicadAboutBanner(), GetVersionInfoData(), and KICAD_CURL_EASY::KICAD_CURL_EASY().

GetBuildVersion()

wxString GetBuildVersion

(

)

Get the full KiCad version string.

This string contains platform-specific information added by the packagers. It is created by CMake in the KICAD_FULL_VERSION variable.

Returns

the full version string

Definition at line 65 of file build_version.cpp.

{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_VERSION_FULL ) );
 return msg;
}

References Format().

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONHeader(), DS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), CreateHeaderInfoData(), PCB_EDIT_FRAME::Export_IDF3(), PLACE_FILE_EXPORTER::GenPositionData(), PLACE_FILE_EXPORTER::GenReportData(), GetVersionInfoData(), KICAD_CURL_EASY::KICAD_CURL_EASY(), NETLIST_EXPORTER_XML::makeDesignHeader(), DSN::PARSER::PARSER(), GERBER_PLOTTER::StartPlot(), EXCELLON_WRITER::writeEXCELLONHeader(), PCB_CALCULATOR_DATAFILE::WriteHeader(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

GetCurlLibVersion()

std::string GetCurlLibVersion

(

)

Definition at line 142 of file kicad_curl.cpp.

{
 return LIBCURL_VERSION;
}

Referenced by GetVersionInfoData().

GetKicadCurlVersion()

std::string GetKicadCurlVersion

(

)

Definition at line 136 of file kicad_curl.cpp.

{
 return KICAD_CURL::GetVersion();
}

References KICAD_CURL::GetVersion().

Referenced by GetVersionInfoData().

GetMajorMinorVersion()

wxString GetMajorMinorVersion

(

)

Get only the major and minor version in a string major.minor.

This is extracted by CMake from the KICAD_SEMANTIC_VERSION variable.

Returns

the major and minor version as a string

Definition at line 86 of file build_version.cpp.

{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_MAJOR_MINOR_VERSION ) );
 return msg;
}

References Format().

Referenced by EVT_MENU_RANGE(), GetKicadLockFilePath(), SETTINGS_MANAGER::GetSettingsVersion(), KICAD_MANAGER_FRAME::ProjectChanged(), and COMMON_CONTROL::ShowHelp().

GetPlatformGetBitnessName()

wxString GetPlatformGetBitnessName

(

)

Returns

the bitness name string (like "Little endian")

Definition at line 53 of file build_version.cpp.

{
 wxPlatformInfo platform;
// TODO (ISM): Read conditional once our wx fork and flatpaks are running released 3.1.5
#if 0 && wxCHECK_VERSION( 3, 1, 5 )
 return platform.GetBitnessName();
#else
 return platform.GetArchName();
#endif
}

Referenced by GetVersionInfoData(), and KICAD_CURL_EASY::KICAD_CURL_EASY().

GetSemanticVersion()

wxString GetSemanticVersion

(

)

Get the semantic version string for KiCad defined inside the KiCadVersion.cmake file in the variable KICAD_SEMANTIC_VERSION.

Returns

the semantic version string

Definition at line 79 of file build_version.cpp.

{
 wxString msg = wxString::Format( wxT( "%s" ), wxT( KICAD_SEMANTIC_VERSION ) );
 return msg;
}

References Format().

GetVersionInfoData()

wxString GetVersionInfoData	(	const wxString &	aTitle,
		bool	aHtml = false,
		bool	aBrief = false
	)

Create a version info string for bug reports and the about dialog.

Parameters

aTitle	is the application title to include at the top of the report
aBrief	= true to condense information for the bug report URL
aHtml	= true to use a minimal HTML format, false for plan text

Returns

the version info string

Definition at line 93 of file build_version.cpp.

{
 wxString aMsg;
 // DO NOT translate information in the msg_version string

 wxString eol = aHtml ? wxT( "<br>" ) : wxT( "\n" );

 // Tabs instead of spaces for the plaintext version for shorter string length
 wxString indent4 = aHtml ? wxT( "&nbsp;&nbsp;&nbsp;&nbsp;" ) : wxT( "\t" );

#define ON wxT( "ON" ) << eol
#define OFF wxT( "OFF" ) << eol

 wxString version;
 version << ( KIPLATFORM::APP::IsOperatingSystemUnsupported() ? wxT( "(UNSUPPORTED)" )
 : GetBuildVersion() )
#ifdef DEBUG
 << wxT( ", debug" )
#else
 << wxT( ", release" )
#endif
 << wxT( " build" );

 wxPlatformInfo platform;
 aMsg << wxT( "Application: " ) << aTitle;

 #if defined( KICAD_BUILD_ARCH_X64 )
 aMsg << wxT( " (64-bit)" );
 #elif defined( KICAD_BUILD_ARCH_X86 )
 aMsg << wxT( " (32-bit)" );
 #elif defined( KICAD_BUILD_ARCH_ARM )
 aMsg << wxT( " (ARM 32-bit)" );
 #elif defined( KICAD_BUILD_ARCH_ARM64 )
 aMsg << wxT( " (ARM 64-bit)" );
 #endif

 aMsg << eol << eol;


 aMsg << wxT( "Version: " ) << version << eol << eol;
 aMsg << wxT( "Libraries:" ) << eol;

 aMsg << indent4 << wxGetLibraryVersionInfo().GetVersionString() << eol;

 if( !aBrief )
 aMsg << indent4 << GetKicadCurlVersion() << eol;

 aMsg << eol;

 aMsg << wxT( "Platform: " ) << wxGetOsDescription() << wxT( ", " )
 << GetPlatformGetBitnessName() << wxT( ", " )
 << platform.GetEndiannessName() << wxT( ", " )
 << platform.GetPortIdName();

#ifdef __WXGTK__
 aMsg << wxT( ", " ) << wxGetenv( wxT( "XDG_SESSION_DESKTOP" ) )
 << wxT( ", " ) << wxGetenv( wxT( "XDG_SESSION_TYPE" ) );
#endif

 aMsg << eol << eol;

 if( !aBrief )
 {
 aMsg << wxT( "Build Info:" ) << eol;
 aMsg << indent4 << wxT( "Date: " ) << GetBuildDate() << eol;
 }

 aMsg << indent4 << wxT( "wxWidgets: " ) << wxVERSION_NUM_DOT_STRING << wxT( " (" );
 aMsg << __WX_BO_UNICODE __WX_BO_STL __WX_BO_WXWIN_COMPAT_2_8 wxT( ")" );

 // Get the GTK+ version where possible.
#ifdef __WXGTK__
 int major, minor;

 major = wxPlatformInfo().Get().GetToolkitMajorVersion();
 minor = wxPlatformInfo().Get().GetToolkitMinorVersion();
 aMsg << wxT( " GTK+ " ) << major << wxT( "." ) << minor;
#endif

 aMsg << eol;

 aMsg << indent4 << wxT( "Boost: " ) << ( BOOST_VERSION / 100000 ) << wxT( "." )
 << ( BOOST_VERSION / 100 % 1000 ) << wxT( "." )
 << ( BOOST_VERSION % 100 ) << eol;

#ifdef KICAD_USE_OCC
 aMsg << indent4 << wxT( "OCC: " ) << OCC_VERSION_COMPLETE << eol;
#endif

 aMsg << indent4 << wxT( "Curl: " ) << GetCurlLibVersion() << eol;

#if defined( KICAD_SPICE )
#if defined( NGSPICE_BUILD_VERSION )
 aMsg << indent4 << wxT( "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 << wxT( "ngspice: " ) << PACKAGE_VERSION << eol;
#elif defined( NGSPICE_PACKAGE_VERSION )
 aMsg << indent4 << wxT( "ngspice: " ) << NGSPICE_PACKAGE_VERSION << eol;
#else
 aMsg << indent4 << wxT( "ngspice: " ) << wxT( "unknown" ) << eol;
#endif
#endif

 aMsg << indent4 << wxT( "Compiler: " );
#if defined(__clang__)
 aMsg << wxT( "Clang " ) << __clang_major__ << wxT( "." ) << __clang_minor__ << wxT( "." ) << __clang_patchlevel__;
#elif defined(__GNUG__)
 aMsg << wxT( "GCC " ) << __GNUC__ << wxT( "." ) << __GNUC_MINOR__ << wxT( "." ) << __GNUC_PATCHLEVEL__;
#elif defined(_MSC_VER)
 aMsg << wxT( "Visual C++ " ) << _MSC_VER;
#elif defined(__INTEL_COMPILER)
 aMsg << wxT( "Intel C++ " ) << __INTEL_COMPILER;
#else
 aMsg << wxT( "Other Compiler " );
#endif

#if defined(__GXX_ABI_VERSION)
 aMsg << wxT( " with C++ ABI " ) << __GXX_ABI_VERSION << eol;
#else
 aMsg << wxT( " without C++ ABI" ) << eol;
#endif

 aMsg << eol;

 // Add build settings config (build options):
 aMsg << wxT( "Build settings:" ) << eol;

#ifdef KICAD_USE_OCC
 aMsg << indent4 << wxT( "KICAD_USE_OCC=" ) << ON;
#endif

#ifdef KICAD_USE_EGL
 aMsg << indent4 << wxT( "KICAD_USE_EGL=" ) << ON;
#endif

 aMsg << indent4 << wxT( "KICAD_SPICE=" );
#ifdef KICAD_SPICE
 aMsg << ON;
#else
 aMsg << OFF;
#endif

#ifndef NDEBUG
 aMsg << indent4 << wxT( "KICAD_STDLIB_DEBUG=" );
#ifdef KICAD_STDLIB_DEBUG
 aMsg << ON;
#else
 aMsg << OFF;
 aMsg << indent4 << wxT( "KICAD_STDLIB_LIGHT_DEBUG=" );
#ifdef KICAD_STDLIB_LIGHT_DEBUG
 aMsg << ON;
#else
 aMsg << OFF;
#endif
#endif

 aMsg << indent4 << wxT( "KICAD_SANITIZE_ADDRESS=" );
#ifdef KICAD_SANITIZE_ADDRESS
 aMsg << ON;
#else
 aMsg << OFF;
#endif

 aMsg << indent4 << wxT( "KICAD_SANITIZE_THREADS=" );
#ifdef KICAD_SANITIZE_THREADS
 aMsg << ON;
#else
 aMsg << OFF;
#endif
#endif

 return aMsg;
}

References GetBuildDate(), GetBuildVersion(), GetCurlLibVersion(), GetKicadCurlVersion(), GetPlatformGetBitnessName(), KIPLATFORM::APP::IsOperatingSystemUnsupported(), OFF, and ON.

Referenced by DIALOG_ABOUT::createNotebooks(), DIALOG_ABOUT::onCopyVersionInfo(), and COMMON_CONTROL::ReportBug().