build_version.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.TXT for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
/* Date for kicad build version */
 
#ifndef KICAD_BUILD_VERSION_H
#define KICAD_BUILD_VERSION_H
 
#include <kicommon.h>
#include <tuple>
 
class wxString;
 
KICOMMON_API wxString GetBuildVersion();
 
KICOMMON_API wxString GetBaseVersion();
 
KICOMMON_API wxString GetPlatformGetBitnessName();
 
KICOMMON_API wxString GetSemanticVersion();
 
KICOMMON_API wxString GetMajorMinorVersion();
 
KICOMMON_API wxString GetMajorMinorPatchVersion();
 
KICOMMON_API wxString GetBuildDate();
 
KICOMMON_API wxString GetCommitHash();
 
KICOMMON_API const std::tuple<int, int, int>& GetMajorMinorPatchTuple();
 
KICOMMON_API bool IsNightlyVersion();
 
KICOMMON_API wxString GetVersionInfoData( const wxString& aTitle, bool aHtml = false,
 bool aBrief = false );
 
#endif // KICAD_BUILD_VERSION_H