KiCad PCB EDA Suite
|
#include <wx/wx.h>
#include <config.h>
#include <boost/version.hpp>
#include <kiplatform/app.h>
#include <font/version_info.h>
#include <build_version.h>
#include <tuple>
#include <Standard_Version.hxx>
#include <ngspice/sharedspice.h>
#include <kicad_build_version.h>
Go to the source code of this file.
Macros | |
#define | INCLUDE_KICAD_VERSION |
#define | ON "ON" << eol |
#define | OFF "OFF" << eol |
Functions | |
std::string | GetKicadCurlVersion () |
std::string | GetCurlLibVersion () |
wxString | GetPlatformGetBitnessName () |
bool | IsNightlyVersion () |
Check if the build is meant to be nightly. More... | |
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 | GetCommitHash () |
Get the commit hash as a string. 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... | |
const std::tuple< int, int, int > & | GetMajorMinorPatchTuple () |
Get the build version numbers as a tuple. More... | |
wxString | GetVersionInfoData (const wxString &aTitle, bool aHtml, bool aBrief) |
Create a version info string for bug reports and the about dialog. More... | |
#define INCLUDE_KICAD_VERSION |
Definition at line 50 of file build_version.cpp.
#define OFF "OFF" << eol |
#define ON "ON" << eol |
wxString GetBuildDate | ( | ) |
Get the build date as a string.
Definition at line 74 of file build_version.cpp.
Referenced by buildKicadAboutBanner(), GetVersionInfoData(), and KICAD_CURL_EASY::KICAD_CURL_EASY().
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.
Definition at line 67 of file build_version.cpp.
Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONHeader(), DS_DRAW_ITEM_LIST::BuildFullText(), buildKicadAboutBanner(), GENCAD_EXPORTER::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().
wxString GetCommitHash | ( | ) |
Get the commit hash as a string.
Definition at line 95 of file build_version.cpp.
Referenced by CLI::VERSION_COMMAND::doPerform().
std::string GetCurlLibVersion | ( | ) |
Definition at line 54 of file kicad_curl.cpp.
Referenced by GetVersionInfoData().
std::string GetKicadCurlVersion | ( | ) |
Definition at line 48 of file kicad_curl.cpp.
References KICAD_CURL::GetVersion().
Referenced by GetVersionInfoData().
const std::tuple< int, int, int > & GetMajorMinorPatchTuple | ( | ) |
Get the build version numbers as a tuple.
Definition at line 108 of file build_version.cpp.
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.
Definition at line 102 of file build_version.cpp.
Referenced by CLI::VERSION_COMMAND::doPerform(), IPC2581_PLUGIN::generateHistorySection(), ERC_REPORT::WriteJsonReport(), and DRC_REPORT::WriteJsonReport().
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.
Definition at line 88 of file build_version.cpp.
Referenced by PATHS::CalculateUserSettingsPath(), EVT_MENU_RANGE(), SETTINGS_MANAGER::GetSettingsVersion(), PATHS::GetUserCachePath(), PATHS::getUserDocumentPath(), HTML_MESSAGE_BOX::OnHTMLLinkClicked(), PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER(), KICAD_MANAGER_FRAME::ProjectChanged(), and COMMON_CONTROL::ShowHelp().
wxString GetPlatformGetBitnessName | ( | ) |
Definition at line 54 of file build_version.cpp.
Referenced by buildKicadAboutBanner(), GetVersionInfoData(), and KICAD_CURL_EASY::KICAD_CURL_EASY().
wxString GetSemanticVersion | ( | ) |
Get the semantic version string for KiCad defined inside the KiCadVersion.cmake file in the variable KICAD_SEMANTIC_VERSION.
Definition at line 81 of file build_version.cpp.
Referenced by STEP_PCB_MODEL::WriteGLTF().
wxString GetVersionInfoData | ( | const wxString & | aTitle, |
bool | aHtml = false , |
||
bool | aBrief = false |
||
) |
Create a version info string for bug reports and the about dialog.
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 |
Definition at line 116 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, and ON.
Referenced by DIALOG_ABOUT::createNotebooks(), CLI::VERSION_COMMAND::doPerform(), DIALOG_ABOUT::onCopyVersionInfo(), and COMMON_CONTROL::ReportBug().
bool IsNightlyVersion | ( | ) |
Check if the build is meant to be nightly.
Definition at line 61 of file build_version.cpp.
Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and EVT_MENU_RANGE().