Add the GenerateExportMacro with unit tests.

Reviewed-by: Marcus D. Hanwell <marcus.hanwell@kitware.com>
This commit is contained in:
Stephen Kelly
2011-07-13 02:13:33 +02:00
parent 955d5133ab
commit 30880707c0
17 changed files with 1016 additions and 0 deletions
@@ -0,0 +1,122 @@
cmake_minimum_required(VERSION 2.8.5 FATAL_ERROR)
project(GenerateExportHeader)
set( CMAKE_INCLUDE_CURRENT_DIR ON )
macro(TEST_FAIL value msg)
if (${value})
message (SEND_ERROR "Test fail:" ${msg} ${Out} )
endif ()
endmacro()
macro(TEST_PASS value msg)
if (NOT ${value})
message (SEND_ERROR "Test fail:" ${msg} ${Out} )
endif ()
endmacro()
# We seem to get race conditions is writing this stuff to the same file at least on MinGW
# So to write to separate source and build directories, we use a count to differentiate.
set (COUNT 0)
macro(_do_build Include Library LibrarySource Source)
math(EXPR COUNT "${COUNT} + 1" )
file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/test${COUNT}/src.cpp" "#include \"${Include}\"\n"
"int main() { ${Source}; }\n"
)
file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/../${LibrarySource}" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/test${COUNT}")
if ("${Library}" STREQUAL "static_variant")
set(CONDITIONAL_STATIC_DEFINE "add_definitions(-DLIBSHARED_AND_STATIC_STATIC_DEFINE)\n")
endif()
file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/test${COUNT}/CMakeLists.txt"
"cmake_minimum_required(VERSION 2.8)\n"
"project(compiletest)\n"
"set(CMAKE_INCLUDE_CURRENT_DIR ON)\n"
"include(GenerateExportHeader)\n"
"add_compiler_export_flags()\n"
"if(CMAKE_COMPILER_IS_GNUCXX)\n"
" add_definitions(-Werror)\n"
"else()\n"
" if(MSVC)\n"
# Treat deprecation warnings as errors.
" add_definitions(/we4996)\n"
" endif()\n"
"endif()\n"
"if(MSVC)\n"
" add_definitions(-DCOMPILER_IS_MSVC)\n"
"endif()\n"
"add_subdirectory(${LibrarySource})\n"
"include_directories(${LibrarySource} \${CMAKE_CURRENT_BINARY_DIR}/${LibrarySource})\n"
"${CONDITIONAL_STATIC_DEFINE}"
"add_executable(compiletest src.cpp)\n"
"target_link_libraries(compiletest ${Library})\n"
)
try_compile(Result ${CMAKE_CURRENT_BINARY_DIR}/fail${COUNT}
${CMAKE_CURRENT_BINARY_DIR}/test${COUNT}
compilefail
OUTPUT_VARIABLE Out
)
endmacro()
macro(build_fail Include Library LibrarySource Source Message)
_do_build(${Include} ${Library} ${LibrarySource} "${Source}")
test_fail(Result ${Message})
endmacro()
macro(build_pass Include Library LibrarySource Source Message)
_do_build(${Include} ${Library} ${LibrarySource} "${Source}")
test_pass(Result ${Message})
endmacro()
include(GenerateExportHeader)
add_compiler_export_flags()
if (MSVC)
add_definitions(-DCOMPILER_IS_MSVC)
endif()
set(link_libraries)
macro(macro_add_test_library name)
add_subdirectory(${name})
include_directories(${name}
${${name}_BINARY_DIR} # For the export header.
)
list(APPEND link_libraries ${name})
add_subdirectory(${name}test)
endmacro()
macro_add_test_library(libshared)
macro_add_test_library(libstatic)
add_subdirectory(lib_shared_and_static)
add_subdirectory(lib_shared_and_statictest)
if (CMAKE_COMPILER_IS_GNUCXX)
# We deliberately call deprecated methods, and test for that elsewhere.
# No need to clutter the test output with warnings.
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-deprecated-declarations")
endif()
if(MSVC)
add_definitions(/wd4996)
endif()
add_executable(GenerateExportHeader exportheader_test.cpp)
target_link_libraries(GenerateExportHeader ${link_libraries})
@@ -0,0 +1,82 @@
#include "libshared.h"
#include "libstatic.h"
// #define BUILD_FAIL
#ifndef BUILD_FAIL
#define DOES_NOT_BUILD(function)
#else
#define DOES_NOT_BUILD(function) function
#endif
int main()
{
{
Libshared l;
l.libshared();
l.libshared_exported();
l.libshared_deprecated();
l.libshared_not_exported();
DOES_NOT_BUILD(l.libshared_excluded();)
}
{
LibsharedNotExported l;
DOES_NOT_BUILD(l.libshared();)
l.libshared_exported();
l.libshared_deprecated();
DOES_NOT_BUILD(l.libshared_not_exported();)
DOES_NOT_BUILD(l.libshared_excluded();)
}
{
LibsharedExcluded l;
DOES_NOT_BUILD(l.libshared();)
l.libshared_exported();
l.libshared_deprecated();
DOES_NOT_BUILD(l.libshared_not_exported();)
DOES_NOT_BUILD(l.libshared_excluded();)
}
libshared_exported();
libshared_deprecated();
DOES_NOT_BUILD(libshared_not_exported();)
DOES_NOT_BUILD(libshared_excluded();)
{
Libstatic l;
l.libstatic();
l.libstatic_exported();
l.libstatic_deprecated();
l.libstatic_not_exported();
l.libstatic_excluded();
}
{
LibstaticNotExported l;
l.libstatic();
l.libstatic_exported();
l.libstatic_deprecated();
l.libstatic_not_exported();
l.libstatic_excluded();
}
{
LibstaticExcluded l;
l.libstatic();
l.libstatic_exported();
l.libstatic_deprecated();
l.libstatic_not_exported();
l.libstatic_excluded();
}
libstatic_exported();
libstatic_deprecated();
libstatic_not_exported();
libstatic_excluded();
return 0;
}
@@ -0,0 +1,12 @@
project(shared_and_static)
set(lib_SRCS
libshared_and_static.cpp
)
add_library(shared_variant SHARED ${lib_SRCS})
add_library(static_variant ${lib_SRCS})
generate_export_header(shared_variant BASE_NAME libshared_and_static)
set_target_properties(static_variant PROPERTIES COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE)
@@ -0,0 +1,91 @@
#include "libshared_and_static.h"
int LibsharedAndStatic::libshared_and_static() const
{
return 0;
}
int LibsharedAndStatic::libshared_and_static_exported() const
{
return 0;
}
int LibsharedAndStatic::libshared_and_static_deprecated() const
{
return 0;
}
int LibsharedAndStatic::libshared_and_static_not_exported() const {
return 0;
}
int LibsharedAndStatic::libshared_and_static_excluded() const {
return 0;
}
int LibsharedAndStaticNotExported::libshared_and_static() const
{
return 0;
}
int LibsharedAndStaticNotExported::libshared_and_static_exported() const
{
return 0;
}
int LibsharedAndStaticNotExported::libshared_and_static_deprecated() const
{
return 0;
}
int LibsharedAndStaticNotExported::libshared_and_static_not_exported() const {
return 0;
}
int LibsharedAndStaticNotExported::libshared_and_static_excluded() const {
return 0;
}
int LibsharedAndStaticExcluded::libshared_and_static() const
{
return 0;
}
int LibsharedAndStaticExcluded::libshared_and_static_exported() const
{
return 0;
}
int LibsharedAndStaticExcluded::libshared_and_static_deprecated() const
{
return 0;
}
int LibsharedAndStaticExcluded::libshared_and_static_not_exported() const {
return 0;
}
int LibsharedAndStaticExcluded::libshared_and_static_excluded() const {
return 0;
}
int libshared_and_static() {
return 0;
}
int libshared_and_static_exported() {
return 0;
}
int libshared_and_static_deprecated() {
return 0;
}
int libshared_and_static_not_exported() {
return 0;
}
int libshared_and_static_excluded() {
return 0;
}
@@ -0,0 +1,58 @@
#ifndef SHARED_AND_STATIC_H
#define SHARED_AND_STATIC_H
#include "libshared_and_static_export.h"
class LIBSHARED_AND_STATIC_EXPORT LibsharedAndStatic {
public:
int libshared_and_static() const;
#ifdef COMPILER_IS_MSVC
int libshared_and_static_exported() const;
#else
int LIBSHARED_AND_STATIC_EXPORT libshared_and_static_exported() const;
#endif
int LIBSHARED_AND_STATIC_DEPRECATED libshared_and_static_deprecated() const;
int libshared_and_static_not_exported() const;
int LIBSHARED_AND_STATIC_NO_EXPORT libshared_and_static_excluded() const;
};
class LibsharedAndStaticNotExported {
public:
int libshared_and_static() const;
int LIBSHARED_AND_STATIC_EXPORT libshared_and_static_exported() const;
int LIBSHARED_AND_STATIC_DEPRECATED libshared_and_static_deprecated() const;
int libshared_and_static_not_exported() const;
int LIBSHARED_AND_STATIC_NO_EXPORT libshared_and_static_excluded() const;
};
class LIBSHARED_AND_STATIC_NO_EXPORT LibsharedAndStaticExcluded {
public:
int libshared_and_static() const;
int LIBSHARED_AND_STATIC_EXPORT libshared_and_static_exported() const;
int LIBSHARED_AND_STATIC_DEPRECATED libshared_and_static_deprecated() const;
int libshared_and_static_not_exported() const;
int LIBSHARED_AND_STATIC_NO_EXPORT libshared_and_static_excluded() const;
};
LIBSHARED_AND_STATIC_EXPORT int libshared_and_static_exported();
LIBSHARED_AND_STATIC_DEPRECATED int libshared_and_static_deprecated();
int libshared_and_static_not_exported();
int LIBSHARED_AND_STATIC_NO_EXPORT libshared_and_static_excluded();
#endif
@@ -0,0 +1,23 @@
macro(shared_variant_build_pass Source Message)
build_pass("libshared_and_static.h" "shared_variant" "lib_shared_and_static" "${Source}" ${Message})
endmacro()
macro(shared_variant_build_fail Source Message)
build_fail("libshared_and_static.h" "shared_variant" "lib_shared_and_static" "${Source}" ${Message})
endmacro()
macro(static_variant_build_pass Source Message)
build_pass("libshared_and_static.h" "static_variant" "lib_shared_and_static" "${Source}" ${Message})
endmacro()
macro(static_variant_build_fail Source Message)
build_fail("libshared_and_static.h" "static_variant" "lib_shared_and_static" "${Source}" ${Message})
endmacro()
static_variant_build_pass("return libshared_and_static_exported();" "Failed to build static variant")
shared_variant_build_pass("return libshared_and_static_exported();" "Failed to build shared variant")
shared_variant_build_fail("return libshared_and_static_deprecated();" "Built shared deprecated variant")
static_variant_build_fail("return libshared_and_static_deprecated();" "Built static deprecated variant")
static_variant_build_pass("return libshared_and_static_not_exported();" "Failed to build static not exported variant")
shared_variant_build_fail("return libshared_and_static_not_exported();" "Built shared not exported variant")
@@ -0,0 +1,6 @@
project(libshared)
add_library(libshared SHARED libshared.cpp)
generate_export_header(libshared)
@@ -0,0 +1,91 @@
#include "libshared.h"
int Libshared::libshared() const
{
return 0;
}
int Libshared::libshared_exported() const
{
return 0;
}
int Libshared::libshared_deprecated() const
{
return 0;
}
int Libshared::libshared_not_exported() const {
return 0;
}
int Libshared::libshared_excluded() const {
return 0;
}
int LibsharedNotExported::libshared() const
{
return 0;
}
int LibsharedNotExported::libshared_exported() const
{
return 0;
}
int LibsharedNotExported::libshared_deprecated() const
{
return 0;
}
int LibsharedNotExported::libshared_not_exported() const {
return 0;
}
int LibsharedNotExported::libshared_excluded() const {
return 0;
}
int LibsharedExcluded::libshared() const
{
return 0;
}
int LibsharedExcluded::libshared_exported() const
{
return 0;
}
int LibsharedExcluded::libshared_deprecated() const
{
return 0;
}
int LibsharedExcluded::libshared_not_exported() const {
return 0;
}
int LibsharedExcluded::libshared_excluded() const {
return 0;
}
int libshared() {
return 0;
}
int libshared_exported() {
return 0;
}
int libshared_deprecated() {
return 0;
}
int libshared_not_exported() {
return 0;
}
int libshared_excluded() {
return 0;
}
@@ -0,0 +1,59 @@
#ifndef LIBSHARED_H
#define LIBSHARED_H
#include "libshared_export.h"
class LIBSHARED_EXPORT Libshared {
public:
int libshared() const;
#ifdef COMPILER_IS_MSVC
// Double exporting not possible with MSVC
int libshared_exported() const;
#else
int LIBSHARED_EXPORT libshared_exported() const;
#endif
int LIBSHARED_DEPRECATED libshared_deprecated() const;
int libshared_not_exported() const;
int LIBSHARED_NO_EXPORT libshared_excluded() const;
};
class LibsharedNotExported {
public:
int libshared() const;
int LIBSHARED_EXPORT libshared_exported() const;
int LIBSHARED_DEPRECATED_EXPORT libshared_deprecated() const;
int libshared_not_exported() const;
int LIBSHARED_NO_EXPORT libshared_excluded() const;
};
class LIBSHARED_NO_EXPORT LibsharedExcluded {
public:
int libshared() const;
int LIBSHARED_EXPORT libshared_exported() const;
int LIBSHARED_DEPRECATED_EXPORT libshared_deprecated() const;
int libshared_not_exported() const;
int LIBSHARED_NO_EXPORT libshared_excluded() const;
};
LIBSHARED_EXPORT int libshared_exported();
LIBSHARED_DEPRECATED_EXPORT int libshared_deprecated();
int libshared_not_exported();
int LIBSHARED_NO_EXPORT libshared_excluded();
#endif
@@ -0,0 +1,27 @@
macro(shared_build_pass Source Message)
build_pass("libshared.h" "libshared" "libshared" "${Source}" ${Message})
endmacro()
macro(shared_build_fail Source Message)
build_fail("libshared.h" "libshared" "libshared" "${Source}" ${Message})
endmacro()
shared_build_pass("Libshared l; return l.libshared_exported();" "Failed to build exported")
shared_build_fail("Libshared l; return l.libshared_deprecated();" "Built use of deprecated class method. This should not be possible.")
if (COMPILER_HAS_HIDDEN_VISIBILITY)
shared_build_fail("Libshared l; return l.libshared_excluded();" "Built use of excluded class method. This should not be possible.")
else()
# There is no MSVC equivalent to hiding symbols.
shared_build_pass("Libshared l; return l.libshared_excluded();" "Built use of excluded class method. This is possible on MSVC.")
endif()
shared_build_fail("LibsharedNotExported l; return l.libshared();" "Built use of not-exported class method. This should not be possible.")
shared_build_fail("LibsharedNotExported l; return l.libshared_not_exported();" "Built use of not-exported class method. This should not be possible.")
shared_build_fail("LibsharedNotExported l; return l.libshared_excluded();" "Built use of not-exported class method. This should not be possible.")
shared_build_fail("LibsharedExcluded l; return l.libshared();" "Built use of excluded class method. This should not be possible.")
shared_build_fail("LibsharedExcluded l; return l.libshared_not_exported();" "Built use of excluded class method. This should not be possible.")
shared_build_fail("LibsharedExcluded l; return l.libshared_excluded();" "Built use of excluded class method. This should not be possible.")
shared_build_fail("return libshared_excluded();" "Built use of excluded function. This should not be possible.")
shared_build_fail("return libshared_not_exported();" "Built use of not-exported function. This should not be possible.")
@@ -0,0 +1,8 @@
project(libstatic)
# Show that the export header has no effect on a static library.
add_library(libstatic STATIC libstatic.cpp)
generate_export_header(libstatic)
@@ -0,0 +1,87 @@
#include "libstatic.h"
int Libstatic::libstatic() const
{
return 0;
}
int Libstatic::libstatic_exported() const
{
return 0;
}
int Libstatic::libstatic_deprecated() const
{
return 0;
}
int Libstatic::libstatic_not_exported() const {
return 0;
}
int Libstatic::libstatic_excluded() const {
return 0;
}
int LibstaticNotExported::libstatic() const
{
return 0;
}
int LibstaticNotExported::libstatic_exported() const
{
return 0;
}
int LibstaticNotExported::libstatic_deprecated() const
{
return 0;
}
int LibstaticNotExported::libstatic_not_exported() const {
return 0;
}
int LibstaticNotExported::libstatic_excluded() const {
return 0;
}
int LibstaticExcluded::libstatic() const
{
return 0;
}
int LibstaticExcluded::libstatic_exported() const
{
return 0;
}
int LibstaticExcluded::libstatic_deprecated() const
{
return 0;
}
int LibstaticExcluded::libstatic_not_exported() const {
return 0;
}
int LibstaticExcluded::libstatic_excluded() const {
return 0;
}
int libstatic_exported() {
return 0;
}
int libstatic_deprecated() {
return 0;
}
int libstatic_not_exported() {
return 0;
}
int libstatic_excluded() {
return 0;
}
@@ -0,0 +1,54 @@
#ifndef LIBSTATIC_H
#define LIBSTATIC_H
#include "libstatic_export.h"
class LIBSTATIC_EXPORT Libstatic {
public:
int libstatic() const;
int LIBSTATIC_EXPORT libstatic_exported() const;
int LIBSTATIC_DEPRECATED libstatic_deprecated() const;
int libstatic_not_exported() const;
int LIBSTATIC_NO_EXPORT libstatic_excluded() const;
};
class LibstaticNotExported {
public:
int libstatic() const;
int LIBSTATIC_EXPORT libstatic_exported() const;
int LIBSTATIC_DEPRECATED libstatic_deprecated() const;
int libstatic_not_exported() const;
int LIBSTATIC_NO_EXPORT libstatic_excluded() const;
};
class LIBSTATIC_NO_EXPORT LibstaticExcluded {
public:
int libstatic() const;
int LIBSTATIC_EXPORT libstatic_exported() const;
int LIBSTATIC_DEPRECATED libstatic_deprecated() const;
int libstatic_not_exported() const;
int LIBSTATIC_NO_EXPORT libstatic_excluded() const;
};
LIBSTATIC_EXPORT int libstatic_exported();
LIBSTATIC_DEPRECATED int libstatic_deprecated();
int libstatic_not_exported();
int LIBSTATIC_NO_EXPORT libstatic_excluded();
#endif
@@ -0,0 +1,13 @@
macro(static_build_pass Source Message)
build_pass("libstatic.h" "libstatic" "libstatic" "${Source}" ${Message})
endmacro()
macro(static_build_fail Source Message)
build_fail("libstatic.h" "libstatic" "libstatic" "${Source}" ${Message})
endmacro()
static_build_pass("Libstatic l; return l.libstatic_exported();" "Failed to build exported.")
static_build_fail("Libstatic l; return l.libstatic_deprecated();" "Built use of deprecated class method. This should not be possible.")
static_build_fail("libstatic_deprecated();" "Built use of deprecated function. This should not be possible.")