KiCad PCB EDA Suite
Loading...
Searching...
No Matches
build_version.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.TXT for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25/* Date for kicad build version */
26
27#ifndef KICAD_BUILD_VERSION_H
28#define KICAD_BUILD_VERSION_H
29
30#include <tuple>
31
32class wxString;
33
40wxString GetBuildVersion();
41
46
53wxString GetSemanticVersion();
54
61wxString GetMajorMinorVersion();
62
70
76wxString GetBuildDate();
77
83wxString GetCommitHash();
84
90const std::tuple<int,int,int>& GetMajorMinorPatchTuple();
91
96bool IsNightlyVersion();
97
105wxString GetVersionInfoData( const wxString& aTitle, bool aHtml = false, bool aBrief = false );
106
107#endif // KICAD_BUILD_VERSION_H
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
wxString GetCommitHash()
Get the commit hash as a string.
wxString GetMajorMinorPatchVersion()
Get the major, minor and patch version in a string major.minor.patch This is extracted by CMake from ...
const std::tuple< int, int, int > & GetMajorMinorPatchTuple()
Get the build version numbers as a tuple.
wxString GetBuildVersion()
Get the full KiCad version string.
wxString GetSemanticVersion()
Get the semantic version string for KiCad defined inside the KiCadVersion.cmake file in the variable ...
wxString GetPlatformGetBitnessName()
bool IsNightlyVersion()
Check if the build is meant to be nightly.
wxString GetVersionInfoData(const wxString &aTitle, bool aHtml=false, bool aBrief=false)
Create a version info string for bug reports and the about dialog.
wxString GetBuildDate()
Get the build date as a string.