CAENUtility.h

Go to the documentation of this file.

/******************************************************************************
*
*   CAEN SpA - Software Division
*   Via Vetraia, 11 - 55049 - Viareggio ITALY
*   +39 0594 388 398 - www.caen.it
*
*******************************************************************************
*
*   Copyright (C) 2019-2022 CAEN SpA
*
*   This file is part of the CAEN Utility.
*
*   The CAEN Utility is free software; you can redistribute it and/or
*   modify it under the terms of 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.
*
*   The CAEN Utility 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
*   Lesser General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public
*   License along with the CAEN Utility; if not, see
*   https://www.gnu.org/licenses/.
*
*   SPDX-License-Identifier: LGPL-3.0-or-later
*
***************************************************************************/
/******************************************************************************
* This library includes code from other open source projects.
*
* - "URL Parse"
*       Source:     https://github.com/Xsoda/url
*       License:    BSD 2-Clause "Simplified" License
*       Year:       2014
*       Author:     Xsoda
*
* - "Map"
*       Source:     https://github.com/rxi/map
*       License:    MIT license
*       Year:       2014
*       Author:     rxi
*
* - "POSIX Directory Browsing API for Windows"
*       Source:     https://github.com/octopusprime314/ReBoot/
*       License:    Copyright Kevlin Henney, 1997, 2003. All rights reserved.
*                   Permission to use, copy, modify, and distribute this software and its
*                   documentation for any purpose is hereby granted without fee, provided
*                   that this copyright and permissions notice appear in all copies and
*                   derivatives.
*                   This software is supplied "as is" without express or implied warranty.
*                   But that said, if there are any problems please get in touch.
*       Year:       1997, 2003
*       Author:     Kevlin Henney
*
* - "XGetopt - A Unix-compatible getopt() for MFC and Win32"
*       Source:     https://www.codeproject.com/Articles/1940/XGetopt-A-Unix-compatible-getopt-for-MFC-and-Win
*       License:    Public domain
*       Year:       2003
*       Author:     Hans Dietrich
*
******************************************************************************/

#ifndef CAEN_INCLUDE_CAENUTILITY_H_
#define CAEN_INCLUDE_CAENUTILITY_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>

// Define exports macros (only if the _CAEN_UTILITY_EXPORT macro
// is defined the functions are exported in the dll)
#ifdef _WIN32
/*
 * __stdcall would introduce name mangling if exporting functions
 * with __declspec(dllexport). This would make GetProcAddress harder
 * to use, so it is better to use __cdecl.
 * Curiously, if using __stdcall with .def files rather than
 * __declspec(dllexport), there is no name namgling (this is the
 * approach of CAENVMELib, for example).
 *
 * The x86_64 architecture has its own calling convention, that
 * never introduces name mangling, so it doesn't mattter.
 *
 * See https://stackoverflow.com/a/6635067/3287591.
 */
#define CAEN_UTILITY_API __cdecl
#ifdef _CAEN_UTILITY_EXPORT
#define CAEN_UTILITY_DLLAPI __declspec(dllexport)
#else
#define CAEN_UTILITY_DLLAPI __declspec(dllimport)
#endif
#else
#define CAEN_UTILITY_API
#define CAEN_UTILITY_DLLAPI __attribute__((visibility("default")))
#endif

#define _c_macro_str_helper(x)          #x
#define c_macro_str(x)                  _c_macro_str_helper(x)

#define c_unused_parameter(P)       ((void)(P))

// GCC
#if defined(__GNUC__) && !defined(__clang__)
#define c_gcc_version       (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
#define c_compiler_version  "GCC v" c_macro_str(__GNUC__) "." c_macro_str(__GNUC_MINOR__) "." c_macro_str(__GNUC_PATCHLEVEL__)
#else
#define c_gcc_version       (-1)
#endif

// Clang
#ifdef __clang__
#define c_clang_version     (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__)
#define c_compiler_version  "Clang v" __clang_version__
#else
#define c_clang_version     (-1)
#endif

// Microsoft Visual C++
#if defined(_MSC_VER) && !defined(__clang__)
#define c_msc_version       (_MSC_VER)
#define c_compiler_version  "Visual C++ v" c_macro_str(_MSC_FULL_VER)
#else
#define c_msc_version       (-1)
#endif

#ifndef c_compiler_version
#define c_compiler_version  "Unknown"
#endif

#ifdef _WIN32
#define __attribute__(A)
#else
#define __declspec(A)
#endif

#ifdef _WIN32
#define c_nop               NOP_FUNCTION
#else
#define c_nop               ((void)0)
#endif

#define c_attribute_format(_FMT_,_ARGS_)    __attribute__((__format__(__printf__, _FMT_, _ARGS_)))

#if c_gcc_version >= 40300 || c_clang_version >= 40000
#define c_attribute_alloc_size(...)         __attribute__((__alloc_size__(__VA_ARGS__)))
#else
#define c_attribute_alloc_size(...)         __attribute__(())
#endif

#define c_declspec_allocator                __declspec(allocator)

#define c_attribute_malloc                  __attribute__((__malloc__))

#define c_attribute_pure                    __attribute__((__pure__))

#define c_attribute_nonnull(...)            __attribute__((__nonnull__(__VA_ARGS__)))

#if c_gcc_version >= 70000
#define c_attribute_fallthrough             __attribute__((__fallthrough__))
#else
#define c_attribute_fallthrough             c_nop
#endif

#if c_gcc_version >= 0 || c_clang_version >= 0
#define c_force_inline                      __attribute__((__always_inline__)) inline
#elif c_msc_version >= 0
#define c_force_inline                      __forceinline
#else
#define c_force_inline                      inline
#endif

#if c_gcc_version >= 30400 || c_clang_version >= 40000
#define c_nodiscard                         __attribute__((__warn_unused_result__))
#elif c_msc_version >= 1700
#define c_nodiscard                         _Check_return_
#else
#define c_nodiscard
#endif

#if c_gcc_version >= 20500 || c_clang_version >= 0
#define c_noreturn                          __attribute__((__noreturn__))
#elif c_msc_version >= 1700
#define c_noreturn                          __declspec(noreturn)
#else
#define c_noreturn
#endif

#if c_msc_version >= 0
#define c_acquires_lock_on_success(m)       _When_(return == CAENThread_RetCode_Success, _Acquires_lock_(m))
#define c_releases_lock_on_success(m)       _When_(return == CAENThread_RetCode_Success, _Releases_lock_(m))
#else
#define c_acquires_lock_on_success(m)
#define c_releases_lock_on_success(m)
#endif

#if c_msc_version >= 0
#define c_use_decl_annotations              _Use_decl_annotations_
#else
#define c_use_decl_annotations
#endif

#if c_gcc_version >= 0 || c_clang_version >= 0
#define c_likely(x)                         __builtin_expect((x),1)
#define c_unlikely(x)                       __builtin_expect((x),0)
#else
#define c_likely(x)                         (x)
#define c_unlikely(x)                       (x)
#endif

typedef enum {
    TYPE_INT8        = 0,
    TYPE_UINT8      = 1,
    TYPE_INT16      = 2,
    TYPE_UINT16     = 3,
    TYPE_INT32      = 4,
    TYPE_UINT32     = 5,
    TYPE_INT64      = 6,
    TYPE_UINT64     = 7,
    TYPE_STRING     = 8,
    TYPE_LONG       = 9,
    TYPE_DOUBLE     = 10,
    TYPE_CHAR       = 11,
    TYPE_RESCODE    = 12,
    TYPE_SHORT      = 13,
    TYPE_MEMORY     = 14,

    TYPE_NONE       = 255,
} c_type_t;

typedef enum {
    c_Utility_ErrorCode_Success = 0,
    c_Utility_ErrorCode_GenericError = -1,
    c_Utility_ErrorCode_Map = -2,
    c_Utility_ErrorCode_Memory = -3,
    c_Utility_ErrorCode_NULL= -4,
} c_Utility_ErrorCode_t;

typedef void(*c_funcptr_t)(void);

CAEN_UTILITY_DLLAPI size_t CAEN_UTILITY_API c_srtrim(char *str, const char *remove);
CAEN_UTILITY_DLLAPI size_t CAEN_UTILITY_API c_sltrim(char *str, const char *remove);
CAEN_UTILITY_DLLAPI size_t CAEN_UTILITY_API c_strim(char *str, const char *remove);
#ifdef __cplusplus
}
#endif

#endif // CAEN_INCLUDE_CAENUTILITY_H_