Commit 831badec authored by Brad King's avatar Brad King

KWIML: The Kitware Information Macro Library

Provides header files that use preprocessor tests to detect and provide
information about the compiler and its target architecture.  The headers
contain no configuration-time test results and thus may be installed
into an architecture-independent include directory.  This makes them
suitable for use in the public interface of any package.
parents
This diff is collapsed.
#=============================================================================
# Kitware Information Macro Library
# Copyright 2010-2011 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# Import the KWIML directory tree into a subdirectory under a parent
# project and configure the library as follows:
#
# SET(KWIML myIML)
# SUBDIRS(KWIML)
#
# Optional settings are as follows:
#
# KWIML_HEADER_ROOT = build tree directory to hold KWIML headers.
# Headers will go in a directory called "${KWIML}" under this root.
# For example:
#
# SET(KWIML_HEADER_ROOT ${PROJECT_BINARY_DIR})
# INCLUDE_DIRECTORIES(${PROJECT_BINARY_DIR})
#
# KWIML_INSTALL_INCLUDE_DIR = install KWIML with "make install"
# Specify a value relative to the install prefix and do NOT start with '/'.
# KWIML_INSTALL_INCLUDE_OPTIONS = extra header installation options
# Specify options for the install(FILES) command.
#
# KWIML_LABELS_TEST = list of labels for KWIML tests
cmake_minimum_required(VERSION 2.6.3 FATAL_ERROR)
#-----------------------------------------------------------------------------
if(NOT DEFINED KWIML)
if(NOT "${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
message(FATAL_ERROR "Set KWIML namespace in parent directory!")
endif()
set(KWIML KWIML)
set(KWIML_STANDALONE 1)
project(KWIML)
include(CTest)
mark_as_advanced(BUILD_TESTING)
endif()
#-----------------------------------------------------------------------------
get_property(KWIML_LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
foreach(lang ${KWIML_LANGUAGES})
set(KWIML_LANGUAGE_${lang} 1)
endforeach()
if(NOT KWIML_LANGUAGE_C AND NOT KWIML_LANGUAGE_CXX)
set(BUILD_TESTING OFF)
endif()
#-----------------------------------------------------------------------------
if(NOT KWIML_HEADER_ROOT)
set(KWIML_HEADER_ROOT "${PROJECT_BINARY_DIR}")
endif()
set(KWIML_HEADER_DIR "${KWIML_HEADER_ROOT}/${KWIML}")
include_directories(${KWIML_HEADER_ROOT})
#-----------------------------------------------------------------------------
foreach(h ABI INT)
set(header ${KWIML_HEADER_DIR}/${h}.h)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${h}.h.in ${header} @ONLY)
if(KWIML_INSTALL_INCLUDE_DIR)
install(FILES ${header}
DESTINATION ${KWIML_INSTALL_INCLUDE_DIR}/${KWIML}
${KWIML_INSTALL_INCLUDE_OPTIONS})
endif()
endforeach()
#-----------------------------------------------------------------------------
if(BUILD_TESTING)
add_subdirectory(test)
endif()
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of Kitware, Inc. nor the names of its contributors
may be used to endorse or promote products derived from this
software without specific prior written permission.
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
HOLDER 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.
This diff is collapsed.
KWIML - The Kitware Information Macro Library
KWIML provides header files that use preprocessor tests to detect and
provide information about the compiler and its target architecture. The
headers contain no configuration-time test results and thus may be
installed into an architecture-independent include directory. This
makes them suitable for use in the public interface of any package.
This source tree is intended for distribution inside the source trees of
other packages. In order to avoid name collisions among multiple
packages the KWIML headers are configured with a per-package prefix on
both the header locations and the macros they define. See comments in
CMakeLists.txt for instructions to include KWIML inside another project.
The entire KWIML source tree is distributed under the OSI-approved
3-clause BSD License. Files used only for build and test purposes
contain a copyright notice and reference Copyright.txt for details.
Headers meant for installation and distribution outside the source tree
come with full inlined copies of the copyright notice and license text.
This makes them suitable for distribution with any package under
compatible license terms.
The following components are provided. See header comments for details:
ABI.h = Fundamental type size and representation
INT.h = Fixed-size integer types and format specifiers
The "test" subdirectory builds tests that verify correctness of the
information provided by each header.
#=============================================================================
# Kitware Information Macro Library
# Copyright 2010-2011 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
set(test_defs KWIML_NAMESPACE=${KWIML})
# Tell CMake how to follow dependencies of sources in this directory.
set_property(DIRECTORY
PROPERTY IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
"KWIML_HEADER(%)=<${KWIML}/%>"
)
if(KWIML_LANGUAGE_C)
set(test_srcs test.c)
else()
set(test_srcs test.cxx)
endif()
if(KWIML_LANGUAGE_C)
list(APPEND test_defs KWIML_LANGUAGE_C)
list(APPEND test_srcs
test_ABI_C.c
test_INT_C.c
)
endif()
if(KWIML_LANGUAGE_CXX)
list(APPEND test_defs KWIML_LANGUAGE_CXX)
list(APPEND test_srcs
test_ABI_CXX.cxx
test_INT_CXX.cxx
)
endif()
foreach(th test_ABI_endian test_INT_format)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${th}.h.in
${CMAKE_CURRENT_BINARY_DIR}/${th}.h @ONLY)
endforeach()
include_directories(BEFORE ${CMAKE_CURRENT_BINARY_DIR})
add_executable(${KWIML}_test ${test_srcs})
set_property(TARGET ${KWIML}_test PROPERTY COMPILE_DEFINITIONS ${test_defs})
set_property(TARGET ${KWIML}_test PROPERTY
RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
add_test(${KWIML}.test ${CMAKE_CURRENT_BINARY_DIR}/${KWIML}_test)
set_property(TEST ${KWIML}.test PROPERTY LABELS ${KWIML_LABELS_TEST})
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
extern int test_ABI_C(void);
extern int test_INT_C(void);
extern int test_ABI_CXX(void);
extern int test_INT_CXX(void);
#ifdef __cplusplus
} // extern "C"
#endif
int main(void)
{
int result = 1;
#ifdef KWIML_LANGUAGE_C
result = test_ABI_C() && result;
result = test_INT_C() && result;
#endif
#ifdef KWIML_LANGUAGE_CXX
result = test_ABI_CXX() && result;
result = test_INT_CXX() && result;
#endif
return result? 0 : 1;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "test.c"
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifndef KWIML_NAMESPACE
# error "Do not include test.h outside of KWIML test files."
#endif
#ifndef KWIML_TEST_H
#define KWIML_TEST_H
/*
Define KWIML_HEADER macro to help the test files include kwiml
headers from the configured namespace directory. The macro can be
used like this:
#include KWIML_HEADER(ABI.h)
*/
#define KWIML_HEADER(x) KWIML_HEADER0(KWIML_NAMESPACE/x)
#define KWIML_HEADER0(x) KWIML_HEADER1(x)
#define KWIML_HEADER1(x) <x>
/* Quiet MS standard library deprecation warnings. */
#define _CRT_SECURE_NO_DEPRECATE
#else
# error "test.h included multiple times."
#endif
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "test.h"
#include KWIML_HEADER(ABI.h)
#include "test_ABI_endian.h"
int test_ABI_C(void)
{
if(!test_ABI_endian())
{
return 0;
}
return 1;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "test.h"
#include KWIML_HEADER(ABI.h)
#include "test_ABI_endian.h"
extern "C" int test_ABI_CXX(void)
{
if(!test_ABI_endian())
{
return 0;
}
return 1;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include <stdio.h>
#ifdef __cplusplus
# define LANG "C++ "
#else
# define LANG "C "
#endif
static int test_ABI_endian(void)
{
int result = 1;
{
#if defined(@KWIML@_ABI_ENDIAN_ID)
int expect;
union { short s; unsigned char c[sizeof(short)]; } x;
x.s = 1;
expect = (x.c[0] == 1 ?
@KWIML@_ABI_ENDIAN_ID_LITTLE : @KWIML@_ABI_ENDIAN_ID_BIG);
printf(LANG "@KWIML@_ABI_ENDIAN_ID: expected [%d], got [%d]",
expect, @KWIML@_ABI_ENDIAN_ID);
if(@KWIML@_ABI_ENDIAN_ID == expect)
{
printf(", PASSED\n");
}
else
{
printf(", FAILED\n");
result = 0;
}
#else
printf(LANG "@KWIML@_ABI_ENDIAN_ID: unknown, FAILED\n");
result = 0;
#endif
}
return result;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "test.h"
#include KWIML_HEADER(INT.h)
#include "test_INT_format.h"
int test_INT_C(void)
{
if(!test_INT_format())
{
return 0;
}
return 1;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "test.h"
#include KWIML_HEADER(INT.h)
#include "test_INT_format.h"
extern "C" int test_INT_CXX(void)
{
if(!test_INT_format())
{
return 0;
}
return 1;
}
/*============================================================================
Kitware Information Macro Library
Copyright 2010-2011 Kitware, Inc.
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include <stdio.h>
#include <string.h>
#ifdef __cplusplus
# define LANG "C++ "
#else
# define LANG "C "
#endif
#define VALUE(T, U) \
(@KWIML@_INT_##T)((@KWIML@_INT_##U)0xab << \
((sizeof(@KWIML@_INT_##T)-1)<<3)) \
#define TEST_C(C, V, PRI, T, U) \
{ \
@KWIML@_INT_##T const x = VALUE(T, U); \
@KWIML@_INT_##T y = @KWIML@_INT_##C(V); \
printf(LANG "@KWIML@_INT_" #C ":" \
" expression [%"@KWIML@_INT_PRI##PRI"]," \
" literal [%"@KWIML@_INT_PRI##PRI"]", x, y); \
if(x == y) \
{ \
printf(", PASSED\n"); \
} \
else \
{ \
printf(", FAILED\n"); \
result = 0; \
} \
}
#define TEST_PRI(PRI, T, U, STR) \
{ \
@KWIML@_INT_##T const x = VALUE(T, U); \
char const* str = STR; \
sprintf(buf, "%"@KWIML@_INT_PRI##PRI, x); \
printf(LANG "@KWIML@_INT_PRI" #PRI ":" \
" expected [%s], got [%s]", str, buf); \
if(strcmp(str, buf) == 0) \
{ \
printf(", PASSED\n"); \
} \
else \
{ \
printf(", FAILED\n"); \
result = 0; \
} \
}
#define TEST_SCN(SCN, T, U, STR) TEST_SCN2(SCN, SCN, T, U, STR)
#define TEST_SCN2(PRI, SCN, T, U, STR) \
{ \
@KWIML@_INT_##T const x = VALUE(T, U); \
@KWIML@_INT_##T y; \
char const* str = STR; \
if(sscanf(str, "%"@KWIML@_INT_SCN##SCN, &y) != 1) \
{ \
y = 0; \
} \
printf(LANG "@KWIML@_INT_SCN" #SCN ":" \
" expected [%"@KWIML@_INT_PRI##PRI"]," \
" got [%"@KWIML@_INT_PRI##PRI"]", x, y); \
if(x == y) \
{ \
printf(", PASSED\n"); \
} \
else \
{ \
printf(", FAILED\n"); \
result = 0; \
} \
}
#define TEST(FMT, T, U, STR) TEST2(FMT, FMT, T, U, STR)
#define TEST2(PRI, SCN, T, U, STR) \
TEST_PRI(PRI, T, U, STR) \
TEST_SCN2(PRI, SCN, T, U, STR)
static int test_INT_format(void)
{
int result = 1;
char buf[256];
TEST_PRI(i8, int8_t, uint8_t, "-85")
#if defined(@KWIML@_INT_SCNi8)
TEST_SCN(i8, int8_t, uint8_t, "-85")
#endif
TEST_PRI(d8, int8_t, uint8_t, "-85")
#if defined(@KWIML@_INT_SCNd8)
TEST_SCN(d8, int8_t, uint8_t, "-85")
#endif
TEST_PRI(o8, uint8_t, uint8_t, "253")
#if defined(@KWIML@_INT_SCNo8)
TEST_SCN(o8, uint8_t, uint8_t, "253")
#endif
TEST_PRI(u8, uint8_t, uint8_t, "171")
#if defined(@KWIML@_INT_SCNu8)
TEST_SCN(u8, uint8_t, uint8_t, "171")
#endif
TEST_PRI(x8, uint8_t, uint8_t, "ab")
TEST_PRI(X8, uint8_t, uint8_t, "AB")
#if defined(@KWIML@_INT_SCNx8)
TEST_SCN(x8, uint8_t, uint8_t, "ab")
TEST_SCN2(X8, x8, uint8_t, uint8_t, "AB")
#endif
TEST(i16, int16_t, uint16_t, "-21760")
TEST(d16, int16_t, uint16_t, "-21760")
TEST(o16, uint16_t, uint16_t, "125400")
TEST(u16, uint16_t, uint16_t, "43776")
TEST(x16, uint16_t, uint16_t, "ab00")
TEST2(X16, x16, uint16_t, uint16_t, "AB00")
TEST(i32, int32_t, uint32_t, "-1426063360")
TEST(d32, int32_t, uint32_t, "-1426063360")
TEST(o32, uint32_t, uint32_t, "25300000000")
TEST(u32, uint32_t, uint32_t, "2868903936")
TEST(x32, uint32_t, uint32_t, "ab000000")
TEST2(X32, x32, uint32_t, uint32_t, "AB000000")
TEST_PRI(i64, int64_t, uint64_t, "-6124895493223874560")
#if defined(@KWIML@_INT_SCNi64)
TEST_SCN(i64, int64_t, uint64_t, "-6124895493223874560")
#endif
TEST_PRI(d64, int64_t, uint64_t, "-6124895493223874560")
#if defined(@KWIML@_INT_SCNd64)
TEST_SCN(d64, int64_t, uint64_t, "-6124895493223874560")
#endif
TEST_PRI(o64, uint64_t, uint64_t, "1254000000000000000000")
#if defined(@KWIML@_INT_SCNo64)
TEST_SCN(o64, uint64_t, uint64_t, "1254000000000000000000")
#endif
TEST_PRI(u64, uint64_t, uint64_t, "12321848580485677056")
#if defined(@KWIML@_INT_SCNu64)
TEST_SCN(u64, uint64_t, uint64_t, "12321848580485677056")
#endif
TEST_PRI(x64, uint64_t, uint64_t, "ab00000000000000")
TEST_PRI(X64, uint64_t, uint64_t, "AB00000000000000")
#if defined(@KWIML@_INT_SCNx64)
TEST_SCN(x64, uint64_t, uint64_t, "ab00000000000000")
TEST_SCN2(X64, x64, uint64_t, uint64_t, "AB00000000000000")
#endif
#if !defined(@KWIML@_INT_NO_INTPTR_T)
# if @KWIML@_ABI_SIZEOF_DATA_PTR == 4
TEST(iPTR, intptr_t, uint32_t, "-1426063360")
TEST(dPTR, intptr_t, uint32_t, "-1426063360")
# else
TEST(iPTR, intptr_t, uint64_t, "-6124895493223874560")
TEST(dPTR, intptr_t, uint64_t, "-6124895493223874560")
# endif
#endif
#if !defined(@KWIML@_INT_NO_UINTPTR_T)
# if @KWIML@_ABI_SIZEOF_DATA_PTR == 4
TEST(oPTR, uintptr_t, uintptr_t, "25300000000")
TEST(uPTR, uintptr_t, uintptr_t, "2868903936")
TEST(xPTR, uintptr_t, uintptr_t, "ab000000")
TEST2(XPTR, xPTR, uintptr_t, uintptr_t, "AB000000")
# else
TEST(oPTR, uintptr_t, uintptr_t, "1254000000000000000000")
TEST(uPTR, uintptr_t, uintptr_t, "12321848580485677056")
TEST(xPTR, uintptr_t, uintptr_t, "ab00000000000000")
TEST2(XPTR, xPTR, uintptr_t, uintptr_t, "AB00000000000000")
# endif
#endif
TEST_C(INT8_C, -0x55, i8, int8_t, uint8_t)
TEST_C(UINT8_C, 0xAB, u8, uint8_t, uint8_t)
TEST_C(INT16_C, -0x5500, i16, int16_t, uint16_t)
TEST_C(UINT16_C, 0xAB00, u16, uint16_t, uint16_t)
TEST_C(INT32_C, -0x55000000, i32, int32_t, uint32_t)
TEST_C(UINT32_C, 0xAB000000, u32, uint32_t, uint32_t)
TEST_C(INT64_C, -0x5500000000000000, i64, int64_t, uint64_t)
TEST_C(UINT64_C, 0xAB00000000000000, u64, uint64_t, uint64_t)
return result;
}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment