version.hpp

/* Copyright 2017-2025 Fabian Koller, Axel Huebl, Franz Poeschel
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api 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 and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include <map>
#include <string>
#include <vector>

#define OPENPMDAPI_VERSION_MAJOR 0
#define OPENPMDAPI_VERSION_MINOR 17
#define OPENPMDAPI_VERSION_PATCH 0
#define OPENPMDAPI_VERSION_LABEL ""

#define OPENPMD_STANDARD_MAJOR 2
#define OPENPMD_STANDARD_MINOR 0
#define OPENPMD_STANDARD_PATCH 0

#define OPENPMD_STANDARD_DEFAULT_MAJOR 1
#define OPENPMD_STANDARD_DEFAULT_MINOR 1
#define OPENPMD_STANDARD_DEFAULT_PATCH 0

#define OPENPMD_STANDARD_MIN_MAJOR 1
#define OPENPMD_STANDARD_MIN_MINOR 0
#define OPENPMD_STANDARD_MIN_PATCH 0

#define OPENPMDAPI_VERSIONIFY(major, minor, patch)                             \
    (major * 1000000 + minor * 1000 + patch)

#define OPENPMDAPI_VERSION_GE(major, minor, patch)                             \
    (OPENPMDAPI_VERSIONIFY(                                                    \
         OPENPMDAPI_VERSION_MAJOR,                                             \
         OPENPMDAPI_VERSION_MINOR,                                             \
         OPENPMDAPI_VERSION_PATCH) >=                                          \
     OPENPMDAPI_VERSIONIFY(major, minor, patch))
 
namespace openPMD
{
std::string getVersion();

[[deprecated(
    "Deprecated due to unclear semantics. Use one of getStandardMinimum, "
    "getStandardMaximum() or getStandardDefault instead.")]] std::string
getStandard();

std::string getStandardDefault();

std::string getStandardMinimum();

std::string getStandardMaximum();

std::map<std::string, bool> getVariants();

std::vector<std::string> getFileExtensions();
 
} // namespace openPMD