gmio/0.3/endian_8h_source.html

 /****************************************************************************

 ** Copyright (c) 2016, Fougue Ltd. <http://www.fougue.pro>

 ** All rights reserved.

 **

 ** Redistribution and use in source and binary forms, with or without

 ** modification, are permitted provided that the following conditions

 ** are met:

 **

 **     1. Redistributions of source code must retain the above copyright

 **        notice, this list of conditions and the following disclaimer.

 **

 **     2. Redistributions in binary form must reproduce the above

 **        copyright notice, this list of conditions and the following

 **        disclaimer in the documentation and/or other materials provided

 **        with the distribution.

 **

 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 ****************************************************************************/


 #ifndef GMIO_ENDIAN_H

 #define GMIO_ENDIAN_H


 #include "global.h"


 enum gmio_endianness

 {

     GMIO_ENDIANNESS_UNKNOWN = 0,


     GMIO_ENDIANNESS_LITTLE,


     GMIO_ENDIANNESS_BIG,


 #ifdef GMIO_HOST_IS_BIG_ENDIAN

     GMIO_ENDIANNESS_HOST = GMIO_ENDIANNESS_BIG

 #else


     GMIO_ENDIANNESS_HOST = GMIO_ENDIANNESS_LITTLE

 #endif

 };


 GMIO_C_LINKAGE_BEGIN


 GMIO_API enum gmio_endianness gmio_host_endianness();


 GMIO_C_LINKAGE_END


 #endif /* GMIO_ENDIAN_H */


GMIO_API
#define GMIO_API
Expands either to GMIO_DECL_EXPORT or GMIO_DECL_IMPORT when respectively compiling/using the DLL...
Definition: global.h:90

GMIO_ENDIANNESS_LITTLE
The least significant byte is stored at the lowest address.
Definition: endian.h:50

global.h
Fundamental global declarations, included by almost all other header/source files.

GMIO_C_LINKAGE_BEGIN
#define GMIO_C_LINKAGE_BEGIN
Expands to extern "C" { when building with a C++ compiler.
Definition: global.h:195

gmio_endianness
gmio_endianness
This enum identifies common endianness (byte order) of computer memory.
Definition: endian.h:43

GMIO_ENDIANNESS_UNKNOWN
Other (unknown) byte-order.
Definition: endian.h:46

GMIO_ENDIANNESS_HOST
Defines the endianness(byte order) used by the host computer for storing data in memory.
Definition: endian.h:65

GMIO_C_LINKAGE_END
#define GMIO_C_LINKAGE_END
Expands to } when building with a C++ compiler.
Definition: global.h:197

GMIO_ENDIANNESS_BIG
The most significant byte is stored at the lowest address.
Definition: endian.h:54

gmio_host_endianness
enum gmio_endianness gmio_host_endianness()
Returns endianness (byte order) of the host's CPU architecture.