build_version.h File Reference

#include <tuple>

Go to the source code of this file.

Functions
wxString	GetBuildVersion ()
	Get the full KiCad version string. More...
wxString	GetPlatformGetBitnessName ()
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	GetMajorMinorPatchVersion ()
	Get the major, minor and patch version in a string major.minor.patch This is extracted by CMake from the KICAD_SEMANTIC_VERSION variable. More...
wxString	GetBuildDate ()
	Get the build date as a string. More...
wxString	GetCommitHash ()
	Get the commit hash as a string. More...
const std::tuple< int, int, int > &	GetMajorMinorPatchTuple ()
	Get the build version numbers as a tuple. More...
bool	IsNightlyVersion ()
	Check if the build is meant to be nightly. More...
wxString	GetVersionInfoData (const wxString &aTitle, bool aHtml=false, bool aBrief=false)
	Create a version info string for bug reports and the about dialog. More...

Function Documentation

GetBuildDate()

wxString GetBuildDate

(

)

Get the build date as a string.

Returns

the build date string

Definition at line 84 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 77 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().

GetCommitHash()

wxString GetCommitHash

(

)

Get the commit hash as a string.

Returns

the commit hash string

Definition at line 105 of file build_version.cpp.

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

References Format().

Referenced by CLI::VERSION_COMMAND::doPerform().

GetMajorMinorPatchTuple()

const std::tuple< int, int, int > & GetMajorMinorPatchTuple

(

)

Get the build version numbers as a tuple.

Returns

A tuple with three ints for major/minor/patch revisions

Definition at line 118 of file build_version.cpp.

{
 static std::tuple<int, int, int> retval = KICAD_MAJOR_MINOR_PATCH_TUPLE;
 
 return retval;
}

GetMajorMinorPatchVersion()

wxString GetMajorMinorPatchVersion

(

)

Get the major, minor and patch version in a string major.minor.patch This is extracted by CMake from the KICAD_SEMANTIC_VERSION variable.

Returns

the major.minor.patch version as a string

Definition at line 112 of file build_version.cpp.

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

References Format().

Referenced by CLI::VERSION_COMMAND::doPerform().

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 98 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(), HTML_MESSAGE_BOX::OnHTMLLinkClicked(), PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER(), KICAD_MANAGER_FRAME::ProjectChanged(), and COMMON_CONTROL::ShowHelp().

GetPlatformGetBitnessName()

wxString GetPlatformGetBitnessName

(

)

Returns

the bitness name string (like "Little endian")

Definition at line 55 of file build_version.cpp.

{
 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
}

Referenced by buildKicadAboutBanner(), 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 91 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 126 of file build_version.cpp.

{
 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;
}

References KIFONT::OUTLINE_FONT::FontConfigVersion(), KIFONT::OUTLINE_FONT::FreeTypeVersion(), GetBuildDate(), GetBuildVersion(), GetCurlLibVersion(), GetKicadCurlVersion(), GetPlatformGetBitnessName(), KIFONT::OUTLINE_FONT::HarfBuzzVersion(), KIPLATFORM::APP::IsOperatingSystemUnsupported(), OFF, and ON.

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

IsNightlyVersion()

bool IsNightlyVersion

(

)

Check if the build is meant to be nightly.

Returns

true if running nightly build

Definition at line 71 of file build_version.cpp.

{
 return !!KICAD_IS_NIGHTLY;
}

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and EVT_MENU_RANGE().