platform.h

Go to the documentation of this file.

/*
 * Cppcheck - A tool for static C/C++ code analysis
 * Copyright (C) 2007-2024 Cppcheck team.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
//---------------------------------------------------------------------------
#ifndef platformH
#define platformH
//---------------------------------------------------------------------------
 
#include "config.h"
#include "standards.h"
 
#include <climits>
#include <cstddef>
#include <stdexcept>
#include <string>
#include <vector>
 
/// @addtogroup Core
/// @{
 
namespace tinyxml2 {
    class XMLDocument;
}
 
/**
 * @brief Platform settings
 */
class CPPCHECKLIB Platform {
private:
    static long long min_value(int bit) {
        if (bit >= 64)
            return LLONG_MIN;
        return -(1LL << (bit-1));
    }
 
    static long long max_value(int bit) {
        if (bit >= 64)
            return (~0ULL) >> 1;
        return (1LL << (bit-1)) - 1LL;
    }
 
    /** provides list of defines specified by the limit.h/climits includes */
    std::string getLimitsDefines(bool c99) const;
public:
    Platform();
 
    bool isIntValue(long long value) const {
        return value >= min_value(int_bit) && value <= max_value(int_bit);
    }
 
    bool isIntValue(unsigned long long value) const {
        const unsigned long long intMax = max_value(int_bit);
        return value <= intMax;
    }
 
    bool isLongValue(long long value) const {
        return value >= min_value(long_bit) && value <= max_value(long_bit);
    }
 
    bool isLongValue(unsigned long long value) const {
        const unsigned long long longMax = max_value(long_bit);
        return value <= longMax;
    }
 
    bool isLongLongValue(unsigned long long value) const {
        const unsigned long long longLongMax = max_value(long_long_bit);
        return value <= longLongMax;
    }
 
    nonneg int char_bit;       /// bits in char
    nonneg int short_bit;      /// bits in short
    nonneg int int_bit;        /// bits in int
    nonneg int long_bit;       /// bits in long
    nonneg int long_long_bit;  /// bits in long long
 
    /** size of standard types */
    std::size_t sizeof_bool;
    std::size_t sizeof_short;
    std::size_t sizeof_int;
    std::size_t sizeof_long;
    std::size_t sizeof_long_long;
    std::size_t sizeof_float;
    std::size_t sizeof_double;
    std::size_t sizeof_long_double;
    std::size_t sizeof_wchar_t;
    std::size_t sizeof_size_t;
    std::size_t sizeof_pointer;
 
    char defaultSign;  // unsigned:'u', signed:'s', unknown:'\0'
 
    enum Type {
        Unspecified, // No platform specified
        Native, // whatever system this code was compiled on
        Win32A,
        Win32W,
        Win64,
        Unix32,
        Unix64,
        File
    };
 
    /** platform type */
    Type type;
 
    /** set the platform type for predefined platforms - deprecated use set(const std::string&, std::string&) instead */
    bool set(Type t);
 
    /** set the platform type */
    bool set(const std::string& platformstr, std::string& errstr, const std::vector<std::string>& paths = {}, bool verbose = false);
 
    /**
     * load platform file
     * @param exename application path
     * @param filename platform filename
     * @param verbose log verbose information about the lookup
     * @return returns true if file was loaded successfully
     */
    bool loadFromFile(const char exename[], const std::string &filename, bool verbose = false);
 
    /** load platform from xml document, primarily for testing */
    bool loadFromXmlDocument(const tinyxml2::XMLDocument *doc);
 
    /**
     * @brief Returns true if platform type is Windows
     * @return true if Windows platform type.
     */
    bool isWindows() const {
        return type == Type::Win32A ||
               type == Type::Win32W ||
               type == Type::Win64;
    }
 
    const char *toString() const {
        return toString(type);
    }
 
    static const char *toString(Type pt) {
        switch (pt) {
        case Type::Unspecified:
            return "unspecified";
        case Type::Native:
            return "native";
        case Type::Win32A:
            return "win32A";
        case Type::Win32W:
            return "win32W";
        case Type::Win64:
            return "win64";
        case Type::Unix32:
            return "unix32";
        case Type::Unix64:
            return "unix64";
        case Type::File:
            return "platformFile";
        default:
            throw std::runtime_error("unknown platform");
        }
    }
 
    long long unsignedCharMax() const {
        return max_value(char_bit + 1);
    }
 
    long long signedCharMax() const {
        return max_value(char_bit);
    }
 
    long long signedCharMin() const {
        return min_value(char_bit);
    }
 
    /** provides list of defines specified by the limit.h/climits includes */
    std::string getLimitsDefines(Standards::cstd_t cstd) const;
    /** provides list of defines specified by the limit.h/climits includes */
    std::string getLimitsDefines(Standards::cppstd_t cppstd) const;
};
 
/// @}
//---------------------------------------------------------------------------
#endif // platformH