Platform.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_CORE_PLATFORM_PLATFORM_H
#define IMT_BASE_CORE_PLATFORM_PLATFORM_H
 
// clang-format off
 
// Definition for platform specific settings.
// Include this file in every header.
 
// General Defines
// Define the following preprocessor defines for the given build configurations:
// Debug:       -
// Release:     NDEBUG
// Unittest:    _UNITTEST
//
// The following preprocessor defines can be defined in all configurations if needed:
// USE_STL                              if STL support is required.
// USE_RTTI                             if real time type identification support is required.
// OMIT_HARDWARE_EXCEPTION_HANDLERS     Omits the definition of exception handlers in the HAL so they can be defined in the application (or BSP)
//
// Note: The _DEBUG and DEBUG define wil be set automatically in this header based on the defines above.
 
// Overview of pre-defined Compiler Macros:
// https://sourceforge.net/p/predef/wiki/Compilers/
 
// Platform Defines
// Use ONE of the following platform defines:
//
// Desktop Windows => _WINDOWS
// The key identifier for a "Desktop" Windows OS is _WINDOWS.
// Define the following Preprocessor Defines on Visual Studio > Project Properties > Preprocessor Defines: _WINDOWS;WIN32
//
// IAR Systems Workbench => __IAR_SYSTEMS_ICC__ (auto)
// The IAR platform will automatically define __IAR_SYSTEMS_ICC__.
// IAR can have several target devices with different symbols defined by IAR IDE.
// Supported targets on IAR IDE:
// Target: __ICCARM__ IAR ARM C/C++ cross compiler
//
// QNX Momentics => __QNXNTO__ (auto)
// The QNX Momentix IDE will automatically define __QNXNTO__.
//
// Keil uVision IDE => __CC_ARM (auto)
// The Keil uVision IDE will automatically define __CC_ARM.
//
// Mingw32 Toolchain => __MINGW32__
// Uses the GNU Toolchain if you use GCC (__GNUC__)
// other toolchains are not supported.
//
// STM CubeIDE => __STMCUBE
// STM32 Eclipse based Toolchain.
//
// Espressif IDF => ESP_PLATFORM
// Espressif IDF is a __GNUC__ based Toolchain which uses cmake for build/link process.
// Add 'add_compile_definitions(ESP_PLATFORM)' in the main cmake file
//
// To provide a new platform extend the Platform.h file.
 
// Include the application defined configuration file.
// Create an Application specific PlatformConfigApp.h File and copy this to the "\Imt.Base.Core.Platform" folder where this file is located.
// All needed Application Platform specific defines should be located in that file.
#include <Imt.Base.Core.Platform/PlatformConfigApp.h>
 
// AXIVION FILE Style AutosarC++19_03-A2.7.3: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A2.8.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A2.8.2: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A7.1.6: File exempted from this rule, required construct
// AXIVION FILE Style AutosarC++19_03-A16.0.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A16.6.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A16.7.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A17.0.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-A18.0.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-M7.3.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-M16.0.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style AutosarC++19_03-M27.0.1: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style CodingStyle-SourceFileNaming: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style CodingStyle-Naming.Macro: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style CodingStyle-Naming.UserType: File exempted from this rule, as file includes platform specific constructs
// AXIVION FILE Style CodingStyle-Naming.Typedef: File exempted from this rule, as file includes platform specific constructs
 
#include <Imt.Base.Core.Platform/CppVersion.h>
 
// Imt.Base V4.0 requires C++11 or newer
// TODO enable check when VS2015 dependency is finally removed in V4.1
// static_assert(CppVersion::isCpp14OrNewer(), "Imt.Base only supports C++14 or newer");
 
//
// Debug macros
//
#ifdef NDEBUG
    #ifdef _DEBUG
        #undef _DEBUG
    #endif
    #ifdef DEBUG
        #undef DEBUG
    #endif
#else
    #ifndef _DEBUG
        #define _DEBUG
    #endif
    #ifndef DEBUG
        #define DEBUG
    #endif
#endif
 
//
// Use STL (only with C++ compiler)
//
#if defined(USE_STL) && defined(__cplusplus)
    // Include STL stuff
    #include <limits>
 
    // RTTI, runtime type information
    #ifdef USE_RTTI
        #include <typeinfo>
    #endif // USE_RTTI
 
    #include <string>
    #include <sstream>
 
#endif // USE_STL && __cplusplus
 
#if defined(USE_STL) && defined(_WINDOWS)
#include <float.h>
#endif // USE_STL && _WINDOWS
 
// Generic Dataflow runtime defines
#include <Imt.Base.Core.Platform/stdfloat.h>
#include <Imt.Base.Core.Platform/stdchar.h>
 
// Toolchain/Platform specific Dataflow runtime defines
 
#if defined(_WINDOWS)
    // Using WINDOWS (WIN32) and visual studio
    #include <Imt.Base.Core.Platform/PlatformWIN32/WIN32_Platform.h>
#elif defined(__IAR_SYSTEMS_ICC__)
    // Using IAR
    #include <Imt.Base.Core.Platform/PlatformIAR/IAR_Platform.h>
#elif defined(__CC_ARM)
    // Using uVision (Keil)
    #include "PlatformKeil/Keil_Platform.h"
#elif defined(__MINGW32__)
    #if defined(__GNUC__)
        // MinGW32
        #include <Imt.Base.Core.Platform/PlatformGCC/GCC_Platform.h>
    #else
        // This platform is currently not supported
        #error Check your preprocessor definitions!
    #endif
#elif defined(__WIN32_GNU__)
    // Win32 GNU
    #include "PlatformMinGW32/Win32GNU_Platform.h"
#elif defined(__STMCUBE)
    // STM32 Cube IDE
    #include <Imt.Base.Core.Platform/PlatformGCC/GCC_Platform.h>
#elif defined(__GNUC__)
    // Platforms using a GNU compiler
    #if defined(__gnu_linux__)
        // Linux SDK GCC for c/c++ compiler
        #include <Imt.Base.Core.Platform/PlatformGCC/GCC_Linux_Platform.h>
    #elif defined(ESP_PLATFORM)
        // Linux SDK GCC for c/c++ compiler
        #include <Imt.Base.Core.Platform/PlatformGCC/GCC_Platform.h>
    #else
        // Zepyhr SDK GCC for c/c++ compiler
        #include <Imt.Base.Core.Platform/PlatformGCC/GCC_Zephyr_Platform.h>
    #endif
#else
    // This platform is currently not supported
    #error Check your preprocessor definitions!
#endif
 
// clang-format on
 
#endif // IMT_BASE_CORE_PLATFORM_PLATFORM_H