CAENMultiplatform.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
*
***************************************************************************/
#ifndef CAEN_INCLUDE_CAENMULTIPLATFORM_H_
#define CAEN_INCLUDE_CAENMULTIPLATFORM_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <types/CAENMultiplatformTypes.h>
#include <CAENUtility.h>

#ifdef _WIN32
#define c_arraysize(A)              _countof(A)
#else
#define c_arraysize(A)              (sizeof(A)/sizeof((A)[0])+sizeof(__typeof__(int[1-2*!!__builtin_types_compatible_p(__typeof__(A),__typeof__(&A[0]))]))*0)
#include <endian.h>
#endif

c_nodiscard c_declspec_allocator c_attribute_malloc c_attribute_alloc_size(1)
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_malloc(size_t size);

c_nodiscard c_declspec_allocator c_attribute_alloc_size(2)
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_realloc(void *ptr, size_t size);

c_nodiscard c_declspec_allocator c_attribute_malloc c_attribute_alloc_size(1, 2)
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_calloc(size_t nmemb, size_t size);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_free(void *ptr);

c_nodiscard
CAEN_UTILITY_DLLAPI size_t CAEN_UTILITY_API c_malloc_size(void *ptr);

c_nodiscard c_declspec_allocator c_attribute_malloc
CAEN_UTILITY_DLLAPI char* CAEN_UTILITY_API c_strdup(const char *str);

c_nodiscard c_declspec_allocator c_attribute_malloc
CAEN_UTILITY_DLLAPI char* CAEN_UTILITY_API c_strndup(const char *str, size_t size);
static inline void* c_zeromem(void* dest, size_t size) {
    return (dest == NULL) ? dest : memset(dest, 0, size);
}
static inline void* c_memset(void* dest, int val, size_t size) {
    return (dest == NULL) ? dest : memset(dest, val, size);
}
static inline void* c_memcpy(void* __restrict dest, const void* __restrict src, size_t size) {
    return (dest == NULL || src == NULL) ? dest : memcpy(dest, src, size);
}
static inline void* c_memmove(void* dest, const void* src, size_t size) {
    return (dest == NULL || src == NULL) ? dest : memmove(dest, src, size);
}
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_getCurrentEnvironment(c_environment_t *dest);

c_nodiscard
CAEN_UTILITY_DLLAPI c_Process_t* CAEN_UTILITY_API c_newProc(void);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_freeProc(c_Process_t *proc);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_setProcExec(const char *exec, c_Process_t *proc);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_addProcArg(const char *arg, c_Process_t *proc);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_addProcEnv(const char *varname, const char *varvalue, c_Process_t *proc);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_startProcess(c_Process_t *proc);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_endProcess(c_Process_t *proc);

c_nodiscard
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_getNCPU(void);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_pause(void);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_killProcess(const char *procName);

c_attribute_nonnull(1, 2)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_dlload(const char* libName, c_libhandle_t *libHandle);

c_attribute_nonnull(2, 3)
CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_dfload(c_libhandle_t hLib, const char* fcnName, c_fcnhandle_t *funcPtr);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_dlclose(c_libhandle_t hLib);
c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_ctz(uint32_t value);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_clz(uint32_t value);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_popcount(uint32_t value);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_ctz64(uint64_t value);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_clz64(uint64_t value);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI uint32_t CAEN_UTILITY_API c_popcount64(uint64_t value);
c_nodiscard
CAEN_UTILITY_DLLAPI DIR* c_opendir(const char* name);

CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_closedir(DIR* dir);

c_nodiscard
CAEN_UTILITY_DLLAPI struct dirent* c_readdir(DIR* dir);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_rewinddir(DIR* dir);

#ifdef _WIN32 // Windows (deprecated macros)
#define opendir(name)               c_opendir(name)
#define closedir(dir)               c_closedir(dir)
#define readdir(dir)                c_readdir(dir)
#define rewinddir(dir)              c_rewinddir(dir)
#endif

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_getch(void);

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_kbhit(void);

#ifndef _WIN32 // Linux (deprecated macros)
#define _getch()                    c_getch()
#define _kbhit()                    c_kbhit()
#endif

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_access(const char* pathname, int mode);

CAEN_UTILITY_DLLAPI char* CAEN_UTILITY_API c_getcwd(char* buf, size_t size);

CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_chdir(const char* path);

CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_rmdir(const char* path);

c_nodiscard
CAEN_UTILITY_DLLAPI int64_t CAEN_UTILITY_API c_getpid(void);

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_strcasecmp(const char* s1, const char* s2);

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_strncasecmp(const char* s1, const char* s2, size_t n);
c_nodiscard c_declspec_allocator c_attribute_malloc
CAEN_UTILITY_DLLAPI char* CAEN_UTILITY_API c_getExpandedString(const char *filename); 

#define c_freeExpandedString(str)           c_free(str) 

c_nodiscard
CAEN_UTILITY_DLLAPI bool CAEN_UTILITY_API c_checkFileExists(const char *fname);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_getDirName(char *dest, const char *source);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_getBaseName(char *dest, const char *source);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_remAllFiles(const char *dir);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mkdir(const char *path);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_mkdirp(const char *dir);

c_nodiscard
CAEN_UTILITY_DLLAPI int64_t CAEN_UTILITY_API c_frexp(double value, int16_t *exponent, int8_t *classification);

c_nodiscard c_attribute_pure
CAEN_UTILITY_DLLAPI double CAEN_UTILITY_API c_ldexp(int64_t mantissa, int16_t exponent, int8_t classification);
c_nodiscard
CAEN_UTILITY_DLLAPI uint64_t CAEN_UTILITY_API c_get_time(void); 

c_attribute_nonnull(1)
CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_GetLocalTime(c_systemtime_t *t);

c_attribute_nonnull(1)
CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_GetSystemTime(c_systemtime_t *t);

c_nodiscard c_attribute_nonnull(1, 2)
CAEN_UTILITY_DLLAPI double CAEN_UTILITY_API c_DiffSystemTime_sec(const c_systemtime_t *t1, const c_systemtime_t *t2);

c_nodiscard
CAEN_UTILITY_DLLAPI uint64_t CAEN_UTILITY_API c_getCurrentTimeRepresentation(void);

#define c_CopySystemTime(src, dest)         (*(dest) = *(src)) 

c_nodiscard
static inline uint16_t c_hton16(uint16_t x) {
#ifdef _WIN32
    return htons(x);
#else
    return htobe16(x);
#endif
}
c_nodiscard
static inline uint16_t c_ntoh16(uint16_t x) {
#ifdef _WIN32
    return ntohs(x);
#else
    return be16toh(x);
#endif
}
c_nodiscard
static inline uint32_t c_hton32(uint32_t x) {
#ifdef _WIN32
    return htonl(x);
#else
    return htobe32(x);
#endif
}
c_nodiscard
static inline uint32_t c_ntoh32(uint32_t x) {
#ifdef _WIN32
    return ntohl(x);
#else
    return be32toh(x);
#endif
}
c_nodiscard
static inline uint64_t c_hton64(uint64_t x) {
#ifdef _WIN32
    return htonll(x);
#else
    return htobe64(x);
#endif
}
c_nodiscard
static inline uint64_t c_ntoh64(uint64_t x) {
#ifdef _WIN32
    return ntohll(x);
#else
    return be64toh(x);
#endif
}
#ifdef _WIN32 // Windows
CAEN_UTILITY_DLLAPI extern int c_mp_opterr;

CAEN_UTILITY_DLLAPI extern int c_mp_optopt;

CAEN_UTILITY_DLLAPI extern int c_mp_optind;

CAEN_UTILITY_DLLAPI extern char *c_mp_optarg;

c_nodiscard
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_mp_getopt(int argc, char *const *argv, const char *options);

#else // Linux
#define c_mp_opterr opterr
#define c_mp_optopt optopt
#define c_mp_optind optind
#define c_mp_optarg optarg
#define c_mp_getopt getopt
#endif

#define c_opterr c_mp_opterr
#define c_optopt c_mp_optopt
#define c_optind c_mp_optind
#define c_optarg c_mp_optarg
#define c_getopt c_mp_getopt

#ifdef __cplusplus
}
#endif

#endif // CAEN_INCLUDE_CAENMULTIPLATFORM_H_