common.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal/common.h: Common definitions for EtcPal modules. */
 
#ifndef ETCPAL_COMMON_H_
#define ETCPAL_COMMON_H_
 
#include <stdint.h>
#include "etcpal/error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Suppress deprecated function warnings on Windows/MSVC. This is mostly used in situations where
 * Microsoft warns us that a function like strncpy() could be unsafe, but we want to be portable
 * and have made sure that we're using it in a safe way (e.g. by manually inserting null
 * terminators). */
#ifdef _MSC_VER
 
#define ETCPAL_MSVC_NO_DEP_WRN __pragma(warning(suppress : 4996))
 
#define ETCPAL_MSVC_BEGIN_NO_DEP_WARNINGS() __pragma(warning(push)) __pragma(warning(disable : 4996))
#define ETCPAL_MSVC_END_NO_DEP_WARNINGS()   __pragma(warning(pop))
 
#else /* _MSC_VER */
 
#define ETCPAL_MSVC_NO_DEP_WRN
#define ETCPAL_MSVC_BEGIN_NO_DEP_WARNINGS()
#define ETCPAL_MSVC_END_NO_DEP_WARNINGS()
 
#endif /* _MSC_VER */
 
/* Meaningful macro to suppress warnings on unused arguments */
#define ETCPAL_UNUSED_ARG(arg) ((void)arg)
 
#define ETCPAL_WAIT_FOREVER -1
 
typedef uint32_t etcpal_features_t;
 
#define ETCPAL_FEATURE_SOCKETS ((etcpal_features_t)(1u << 0)) 
#define ETCPAL_FEATURE_NETINTS ((etcpal_features_t)(1u << 1)) 
#define ETCPAL_FEATURE_TIMERS  ((etcpal_features_t)(1u << 2)) 
#define ETCPAL_FEATURE_LOGGING ((etcpal_features_t)(1u << 3)) 
#define ETCPAL_FEATURES_ALL    0xffffffffu                    
#define ETCPAL_FEATURES_ALL_BUT(mask) (((uint32_t)ETCPAL_FEATURES_ALL) & ((uint32_t)(~((uint32_t)(mask)))))
 
etcpal_error_t etcpal_init(etcpal_features_t features);
void           etcpal_deinit(etcpal_features_t features);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_COMMON_H_ */