build_version.h File Reference

#include <kicommon.h>
#include <tuple>

Go to the source code of this file.

Functions
KICOMMON_API wxString	GetBuildVersion ()
	Get the full KiCad version string.
KICOMMON_API wxString	GetBaseVersion ()
	Get the KiCad version string without the information added by the packagers.
KICOMMON_API wxString	GetPlatformGetBitnessName ()
KICOMMON_API wxString	GetSemanticVersion ()
	Get the semantic version string for KiCad defined inside the KiCadVersion.cmake file in the variable KICAD_SEMANTIC_VERSION.
KICOMMON_API wxString	GetMajorMinorVersion ()
	Get only the major and minor version in a string major.minor.
KICOMMON_API 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.
KICOMMON_API wxString	GetBuildDate ()
	Get the build date as a string.
KICOMMON_API wxString	GetCommitHash ()
	Get the commit hash as a string.
KICOMMON_API const std::tuple< int, int, int > &	GetMajorMinorPatchTuple ()
	Get the build version numbers as a tuple.
KICOMMON_API bool	IsNightlyVersion ()
	Check if the build is meant to be nightly.
KICOMMON_API void	SetOpenGLInfo (const char *aRenderer, const char *aVendor, const char *aVersion)
	A setter for OpenGL info when it's initialized.
KICOMMON_API wxString	GetVersionInfoData (const wxString &aTitle, bool aHtml=false, bool aBrief=false)
	Create a version info string for bug reports and the about dialog.

Function Documentation

GetBaseVersion()

KICOMMON_API wxString GetBaseVersion

(

)

Get the KiCad version string without the information added by the packagers.

It is created by CMake in the KICAD_VERSION variable.

Returns

the base version string

Definition at line 87 of file build_version.cpp.

Referenced by DS_DRAW_ITEM_LIST::BuildFullText().

GetBuildDate()

KICOMMON_API wxString GetBuildDate

(

)

Get the build date as a string.

Returns

the build date string

Definition at line 94 of file build_version.cpp.

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

GetBuildVersion()

KICOMMON_API 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 80 of file build_version.cpp.

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONHeader(), buildKicadAboutBanner(), GENCAD_EXPORTER::CreateHeaderInfoData(), PCB_EDIT_FRAME::Export_IDF3(), PLACE_FILE_EXPORTER::GenPositionData(), PLACE_FILE_EXPORTER::GenReportData(), GetVersionInfoData(), API_HANDLER_COMMON::handleGetVersion(), 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()

KICOMMON_API wxString GetCommitHash

(

)

Get the commit hash as a string.

Returns

the commit hash string

Definition at line 115 of file build_version.cpp.

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

GetMajorMinorPatchTuple()

KICOMMON_API 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 128 of file build_version.cpp.

Referenced by ENV_VAR::GetVersionedEnvVarName(), and API_HANDLER_COMMON::handleGetVersion().

GetMajorMinorPatchVersion()

KICOMMON_API 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 122 of file build_version.cpp.

Referenced by DIALOG_UPDATE_NOTICE::DIALOG_UPDATE_NOTICE(), CLI::VERSION_COMMAND::doPerform(), PCB_IO_IPC2581::generateHistorySection(), ODB_MISC_ENTITY::ODB_MISC_ENTITY(), ERC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteJsonReport().

GetMajorMinorVersion()

KICOMMON_API 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 108 of file build_version.cpp.

Referenced by PATHS::CalculateUserSettingsPath(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_IO_KICAD_SEXPR::format(), DS_DATA_MODEL_IO::Format(), SCH_IO_KICAD_SEXPR::Format(), SETTINGS_MANAGER::GetSettingsVersion(), PATHS::GetUserCachePath(), PATHS::getUserDocumentPath(), PGM_BASE::InitPgm(), KICAD_MANAGER_FRAME::KICAD_MANAGER_FRAME(), HTML_MESSAGE_BOX::OnHTMLLinkClicked(), BITMAPCONV_INFO::outputDataHeader(), PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER(), KICAD_MANAGER_FRAME::ProjectChanged(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), CLIPBOARD_IO::SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), CLIPBOARD_IO::SaveSelection(), COMMON_CONTROL::ShowHelp(), and GBR_TO_PCB_EXPORTER::writePcbHeader().

GetPlatformGetBitnessName()

KICOMMON_API wxString GetPlatformGetBitnessName

(

)

Returns

the bitness name string (like "Little endian")

Definition at line 67 of file build_version.cpp.

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

GetSemanticVersion()

KICOMMON_API 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 101 of file build_version.cpp.

Referenced by UPDATE_MANAGER::CheckForUpdate(), STEP_PCB_MODEL::WriteGLTF(), and STEP_PCB_MODEL::WritePLY().

GetVersionInfoData()

KICOMMON_API 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 136 of file build_version.cpp.

References KIFONT::VERSION_INFO::FontConfig(), KIFONT::VERSION_INFO::FreeType(), GetBuildDate(), GetBuildVersion(), GetCurlLibVersion(), GetKicadCurlVersion(), GetPlatformGetBitnessName(), KIFONT::VERSION_INFO::HarfBuzz(), KIPLATFORM::APP::IsOperatingSystemUnsupported(), OFF, ON, s_glRenderer, s_glVendor, and s_glVersion.

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

IsNightlyVersion()

KICOMMON_API bool IsNightlyVersion

(

)

Check if the build is meant to be nightly.

Returns

true if running nightly build

Definition at line 74 of file build_version.cpp.

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

SetOpenGLInfo()

KICOMMON_API void SetOpenGLInfo	(	const char *	aRenderer,
		const char *	aVendor,
		const char *	aVersion
	)

A setter for OpenGL info when it's initialized.

Definition at line 59 of file build_version.cpp.

References s_glRenderer, s_glVendor, and s_glVersion.

Referenced by KIGFX::OPENGL_GAL::init(), EDA_3D_CANVAS::initializeOpenGL(), and EDA_3D_MODEL_VIEWER::ogl_initialize().