RTI Connext DDS Micro  Version 2.4.9
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
osapi_cc.h
Go to the documentation of this file.
1 /*
2  * FILE: osapi_cc.h - Common compiler related definitions
3  *
4  * (c) Copyright, Real-Time Innovations, 2012-2016
5  *
6  * All rights reserved.
7  *
8  * No duplications, whole or partial, manual or electronic, may be made
9  * without express written permission. Any such copies, or
10  * revisions thereof, must display this notice unaltered.
11  * This code contains trade secrets of Real-Time Innovations, Inc.
12  *
13  * Modification History
14  * --------------------
15  * 28jul2016,tk Refactored from osapi_config.h
16  */
17 /*ce \file
18  * \brief OS API Configuration
19  */
20 #ifndef osapi_cc_h
21 #define osapi_cc_h
22 
23 /*******************************************************************************
24  * Include compiler definitions
25  ******************************************************************************/
26 #ifndef OSAPI_CC_DEF_H
27 #if defined(__STDC__) || defined(_MSC_VER) || defined(RTI_WIN32)
28 #define OSAPI_CC_DEF_H "osapi_cc_stdc.h"
29 #else
30 #error "Unable to determine compiler, please define OSAPI_CC_DEF_H"
31 #endif
32 #endif
33 
34 #include OSAPI_CC_DEF_H
35 
36 /*ce
37  * \brief If the compiler does not support static override it here.
38  */
39 #ifndef OSAPI_CC_STATIC
40 #define RTI_PRIVATE static
41 #endif
42 
43 /* This is used to prevent the compiler from issuing warnings for variables
44  * not used on purpose (for example interface variables).
45  */
46 #if OSAPI_ENABLE_PRECONDITION
47 #define PRECOND_ARG(x_)
48 #else
49 #define PRECOND_ARG(x_) (void)(x_);
50 #endif
51 #define UNUSED_ARG(x) (void)(x)
52 #define IGNORE_RETVAL(x) (void)(x)
53 
54 #ifndef MUST_CHECK_RETURN
55 #define MUST_CHECK_RETURN
56 #endif
57 
58 #ifndef SHOULD_CHECK_RETURN
59 #define SHOULD_CHECK_RETURN
60 #endif
61 
62 #ifndef FUNCTION_SHOULD_TYPEDEF
63 #define FUNCTION_SHOULD_TYPEDEF(ftdef_) \
64 typedef SHOULD_CHECK_RETURN ftdef_;
65 #endif
66 
67 #ifndef FUNCTION_MUST_TYPEDEF
68 #define FUNCTION_MUST_TYPEDEF(ftdef_) \
69 typedef MUST_CHECK_RETURN ftdef_;
70 #endif
71 
72 /*i
73  */
74 typedef RTI_INT32 RTI_BOOL;
75 
76 /* Include this for convenient compatibility with RTI Connext Core
77  */
78 typedef RTI_BOOL RTIBool;
79 
80 #define RTI_FALSE ((RTI_BOOL) 0)
81 #define RTI_TRUE ((RTI_BOOL) 1)
82 
83 typedef RTI_UINT32 RTI_SIZE_T;
84 
85 #define RTI_SIZE_INVALID 0xffffffff
86 
87 #if !defined(RTI_ENDIAN_LITTLE) && !defined(RTI_ENDIAN_BIG)
88 #error "RTI_ENDIAN_LITTLE or RTI_ENDIAN_BIG not defined"
89 #endif
90 
91 #endif /* osapi_config_h */
RTI Connext DDS Micro Version 2.4.9 Copyright © Thu Dec 15 2016 Real-Time Innovations, Inc