Types.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Oliver Kohlbacher $
// $Authors: Marc Sturm, Clemens Groepl $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
 
#include <ctime>
#include <cstddef> // for size_t & ptrdiff_t
#include <limits>
 
// If possible use the ISO C99-compliant header stdint.h
// to define the portable integer types.
#ifdef OPENMS_HAS_STDINT_H
#include <cstdint>
#endif
 
namespace OpenMS
{
  typedef OPENMS_INT32_TYPE Int32;
 
  typedef OPENMS_UINT32_TYPE UInt32;
 
  typedef OPENMS_INT64_TYPE Int64;
 
  typedef OPENMS_UINT64_TYPE UInt64;
 
  typedef time_t  Time;
 
  //typedef size_t UInt;
  typedef unsigned int UInt;
 
  //typedef OPENMS_SIZE_T_SIGNED Int;
  typedef int Int;
 
  typedef OPENMS_BYTE_TYPE Byte;
 
  typedef OPENMS_UINT64_TYPE UID;
 
  typedef size_t Size;
 
  typedef ptrdiff_t SignedSize;
 
  enum ASCII
  {
    ASCII__BACKSPACE        = '\b',
    ASCII__BELL             = '\a',
    ASCII__CARRIAGE_RETURN  = '\r',
    ASCII__HORIZONTAL_TAB   = '\t',
    ASCII__NEWLINE          = '\n',
    ASCII__RETURN           = ASCII__NEWLINE,
    ASCII__SPACE            = ' ',
    ASCII__TAB              = ASCII__HORIZONTAL_TAB,
    ASCII__VERTICAL_TAB     = '\v',
 
    ASCII__COLON            = ':',
    ASCII__COMMA            = ',',
    ASCII__EXCLAMATION_MARK = '!',
    ASCII__POINT            = '.',
    ASCII__QUESTION_MARK    = '?',
    ASCII__SEMICOLON        = ';'
  };
 
 
 
 
  template <typename FloatingPointType>
  inline constexpr Int writtenDigits(const FloatingPointType& /* unused */ = FloatingPointType());
 
  template <>
  inline constexpr Int writtenDigits<float>(const float&)
  {
    return std::numeric_limits<float>::digits10;
  }
 
  template <>
  inline constexpr Int writtenDigits<double>(const double&)
  {
    return std::numeric_limits<double>::digits10;
  }
 
  template <>
  inline constexpr Int writtenDigits<int>(const int&)
  {
    return std::numeric_limits<int>::digits10;
  }
 
  template <>
  inline constexpr Int writtenDigits<unsigned int>(const unsigned int&)
  {
    return std::numeric_limits<unsigned int>::digits10;
  }
 
  template <>
  inline constexpr Int writtenDigits<long int>(const long int&)
  {
    return std::numeric_limits<int>::digits10;
  }
 
  template <>
  inline constexpr Int writtenDigits<unsigned long int>(const unsigned long int&)
  {
    return std::numeric_limits<unsigned int>::digits10;
  }
 
  class DataValue;
  template <>
  inline constexpr Int writtenDigits<DataValue>(const DataValue&)
  {
    return std::numeric_limits<double>::digits10;
  }
 
  /*
    META-COMMENT:  DO NOT INTRODUCE ANY LINEBREAKS BELOW IN
    "<code>std::numeric_limits<long double>::digits10 == 18</code>".
    The doxygen parser (version 1.5.5) will get confused!  (Clemens)
  */
 
  template <>
  inline constexpr Int writtenDigits<long double>(const long double&)
  {
#ifndef OPENMS_WINDOWSPLATFORM
    return std::numeric_limits<long double>::digits10;
 
#else
    return std::numeric_limits<double>::digits10;
 
#endif
  }
 
  template <typename FloatingPointType>
  inline constexpr Int writtenDigits(const FloatingPointType& /* unused */)
  {
    return 6;
  }
 
  namespace Internal
  {
    extern OPENMS_DLLAPI const char* OpenMS_locale;
  }
 
} // namespace OpenMS