project (apitrace)
+
+##############################################################################
+# Options
+
+# On Mac OS X build fat binaries with i386 and x86_64 architectures by default.
+if (APPLE AND NOT CMAKE_OSX_ARCHITECTURES)
+ set (CMAKE_OSX_ARCHITECTURES "i386;x86_64" CACHE STRING "Build architectures for OSX" FORCE)
+endif ()
+
+# We use a cached string variable instead of the standard (boolean) OPTION
+# command so that we can default to auto-detecting optional depencies, while
+# still providing a mechanism to force/disable these optional dependencies, as
+# prescribed in http://www.gentoo.org/proj/en/qa/automagic.xml
+set (ENABLE_GUI "AUTO" CACHE STRING "Enable Qt GUI.")
+
+set (ENABLE_CLI true CACHE BOOL "Enable command Line interface.")
+
+set (ENABLE_EGL true CACHE BOOL "Enable EGL support.")
+
+
+##############################################################################
+# Find dependencies
+
set (CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
-# Set default built type
-if (NOT CMAKE_BUILD_TYPE)
- set (CMAKE_BUILD_TYPE Debug
- CACHE
- STRING "Choose the build type, options are: None, Debug, Release, RelWithDebInfo, or MinSizeRel."
- FORCE)
-endif (NOT CMAKE_BUILD_TYPE)
-
-set (CMAKE_USE_PYTHON_VERSION 2.6)
-
-find_package (PythonInterp REQUIRED)
-find_package (OpenGL REQUIRED)
-find_package (Qt4 COMPONENTS QtCore QtGui QtWebKit)
-find_package (QJSON)
-
-if (NOT WIN32)
- # Always use the bundled zlib and libpng sources on Windows to make it easy
- # to deploy the wrappers DLLs
- find_package (ZLIB)
- find_package (PNG)
- find_package (X11 REQUIRED)
-
- # We use GLX on MacOSX, which is in a separate library
- if (APPLE)
- find_library (X11_GL_LIB GL ${X11_LIB_SEARCH_PATH})
- set(X11_LIBRARIES ${X11_LIBRARIES} ${X11_GL_LIB})
- endif (APPLE)
-else (NOT WIN32)
+set (CMAKE_USE_PYTHON_VERSION 2.7 2.6)
+
+if (ANDROID)
+ set (ENABLE_GUI false)
+else ()
+ macro (find_host_package)
+ find_package (${ARGN})
+ endmacro()
+endif ()
+
+find_host_package (PythonInterp REQUIRED)
+find_package (Threads)
+
+if (ENABLE_GUI)
+ if (NOT (ENABLE_GUI STREQUAL "AUTO"))
+ set (REQUIRE_GUI REQUIRED)
+ endif ()
+ find_package (Qt4 4.7 COMPONENTS QtCore QtGui QtWebKit ${REQUIRE_GUI})
+ find_package (QJSON ${REQUIRE_GUI})
+endif ()
+
+if (WIN32)
find_package (DirectX)
-endif (NOT WIN32)
+ set (ENABLE_EGL false)
+elseif (APPLE)
+ set (ENABLE_EGL false)
+else ()
+ find_package (X11)
+
+ if (X11_FOUND)
+ include_directories (${X11_INCLUDE_DIR})
+ add_definitions (-DHAVE_X11)
+ endif ()
+endif ()
+
+
+##############################################################################
+# Set global build options
+
+include (CheckCXXCompilerFlag)
if (WIN32)
- # MSVC & MinGW only define & use APIENTRY
- add_definitions (-DGLAPIENTRY=__stdcall)
-endif (WIN32)
+ # http://msdn.microsoft.com/en-us/library/aa383745.aspx
+ add_definitions (-D_WIN32_WINNT=0x0501 -DWINVER=0x0501)
+else (WIN32)
+ CHECK_CXX_COMPILER_FLAG("-fvisibility=hidden" CXX_COMPILER_FLAG_VISIBILITY)
+ if (CXX_COMPILER_FLAG_VISIBILITY)
+ add_definitions ("-fvisibility=hidden")
+ endif ()
+endif ()
if (MSVC)
# C99 includes for msvc
- include_directories (msvc)
+ include_directories (${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/msvc)
# Enable math constants defines
add_definitions (-D_USE_MATH_DEFINES)
add_definitions (-D_CRT_SECURE_NO_DEPRECATE -D_CRT_SECURE_NO_WARNINGS -D_CRT_NONSTDC_NO_WARNINGS)
add_definitions (-D_SCL_SECURE_NO_DEPRECATE -D_SCL_SECURE_NO_WARNINGS)
add_definitions (-W4)
+ # XXX: it's safer to use ssize_t everywhere instead of disabling warning
+ add_definitions (-wd4018) # signed/unsigned mismatch
+ add_definitions (-wd4063) # not a valid value for switch of enum
+ add_definitions (-wd4100) # unreferenced formal parameter
+ add_definitions (-wd4127) # conditional expression is constant
add_definitions (-wd4244) # conversion from 'type1' to 'type2', possible loss of data
add_definitions (-wd4505) # unreferenced local function has been removed
+ add_definitions (-wd4512) # assignment operator could not be generated
add_definitions (-wd4800) # forcing value to bool 'true' or 'false' (performance warning)
- # XXX: it's safer to use ssize_t everywhere instead of disabling warning
- add_definitions (-wd4018) # signed/unsigned mismatch
# Use static runtime
# http://www.cmake.org/Wiki/CMake_FAQ#How_can_I_build_my_MSVC_application_with_a_static_runtime.3F
)
if (${flag_var} MATCHES "/MD")
string (REGEX REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
- endif (${flag_var} MATCHES "/MD")
+ endif ()
endforeach (flag_var)
else ()
# Adjust warnings
add_definitions (-Wno-sign-compare) # comparison between signed and unsigned integer expressions
endif ()
-# Use bundled ZLIB if system one can't be found
-if (ZLIB_FOUND)
- include_directories (${ZLIB_INCLUDE_DIRS})
- link_libraries (${ZLIB_LIBRARIES})
-else (ZLIB_FOUND)
- add_library (zlib STATIC
- zlib/adler32.c
- zlib/compress.c
- zlib/crc32.c
- zlib/gzio.c
- zlib/uncompr.c
- zlib/deflate.c
- zlib/trees.c
- zlib/zutil.c
- zlib/inflate.c
- zlib/infback.c
- zlib/inftrees.c
- zlib/inffast.c
- )
- include_directories (zlib)
- link_libraries (zlib)
-endif (ZLIB_FOUND)
-
-# Use bundled LIBPNG if system one can't be found
-if (PNG_FOUND)
- include_directories (${PNG_INCLUDE_DIR})
- add_definitions (${PNG_DEFINITIONS})
- link_libraries (${PNG_LIBRARIES})
-else (PNG_FOUND)
- add_library (png STATIC
- libpng/png.c
- libpng/pngerror.c
- libpng/pngget.c
- libpng/pngmem.c
- libpng/pngpread.c
- libpng/pngread.c
- libpng/pngrio.c
- libpng/pngrtran.c
- libpng/pngrutil.c
- libpng/pngset.c
- libpng/pngtrans.c
- libpng/pngwio.c
- libpng/pngwrite.c
- libpng/pngwtran.c
- libpng/pngwutil.c
- )
- include_directories (libpng)
- link_libraries (png)
-endif (PNG_FOUND)
+if (MINGW)
+ # Avoid depending on MinGW runtime DLLs
+ check_cxx_compiler_flag (-static-libgcc HAVE_STATIC_LIBGCC_FLAG)
+ if (HAVE_STATIC_LIBGCC_FLAG)
+ set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc")
+ set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -static-libgcc")
+ set (CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -static-libgcc")
+ endif ()
+ check_cxx_compiler_flag (-static-libstdc++ HAVE_STATIC_LIBSTDCXX_FLAG)
+ if (HAVE_STATIC_LIBSTDCXX_FLAG)
+ set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libstdc++")
+ set (CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -static-libstdc++")
+ set (CMAKE_MODULE_LINKER_FLAGS "${CMAKE_MODULE_LINKER_FLAGS} -static-libstdc++")
+ endif ()
+endif ()
-include_directories (${CMAKE_CURRENT_SOURCE_DIR})
-add_custom_command (
- OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/glproc.hpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/glproc.py > ${CMAKE_CURRENT_BINARY_DIR}/glproc.hpp
- DEPENDS glproc.py dispatch.py wglapi.py glxapi.py glapi.py glenum.py stdapi.py
-)
+# Put all executables into the same top level build directory, regardless of
+# which subdirectory they are declared
+set (CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
-if (WIN32)
- # Put wrappers in a separate directory
- set (LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/wrappers)
-
- # d3d8.dll
- #if (DirectX_D3D8_FOUND)
- # include_directories (${DirectX_D3D8_INCLUDE_DIR})
- # add_custom_command (
- # OUTPUT d3d8.cpp
- # COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/d3d8.py > ${CMAKE_CURRENT_BINARY_DIR}/d3d8.cpp
- # DEPENDS d3d8.py d3d8types.py d3d8caps.py winapi.py stdapi.py
- # )
- # add_library (d3d8 SHARED d3d8.def d3d8.cpp trace_write.cpp os_win32.cpp)
- # set_target_properties (d3d8 PROPERTIES PREFIX "")
- #endif (DirectX_D3D8_FOUND)
-
- # d3d9.dll
- if (DirectX_D3DX9_FOUND)
- include_directories (${DirectX_D3DX9_INCLUDE_DIR})
- add_custom_command (
- OUTPUT d3d9.cpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/d3d9.py > ${CMAKE_CURRENT_BINARY_DIR}/d3d9.cpp
- DEPENDS d3d9.py trace.py d3d9types.py d3d9caps.py d3dshader.py winapi.py stdapi.py
- )
- add_library (d3d9 SHARED d3d9.def d3d9.cpp trace_write.cpp os_win32.cpp)
- set_target_properties (d3d9 PROPERTIES PREFIX "")
- endif (DirectX_D3DX9_FOUND)
-
- # d3d10.dll
- #if (DirectX_D3D10_FOUND)
- # include_directories (${DirectX_D3D10_INCLUDE_DIR})
- # add_custom_command (
- # OUTPUT d3d10.cpp
- # COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/d3d10misc.py > ${CMAKE_CURRENT_BINARY_DIR}/d3d10.cpp
- # DEPENDS d3d10misc.py winapi.py stdapi.py
- # )
- # add_library (d3d10 SHARED d3d10.def d3d10.cpp trace_write.cpp os_win32.cpp)
- # set_target_properties (d3d10 PROPERTIES PREFIX "")
- #endif (DirectX_D3D10_FOUND)
-
- # opengl32.dll
- add_custom_command (
- OUTPUT wgltrace.cpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/wgltrace.py > ${CMAKE_CURRENT_BINARY_DIR}/wgltrace.cpp
- DEPENDS wgltrace.py gltrace.py trace.py wglapi.py wglenum.py glapi.py glenum.py winapi.py stdapi.py
- )
- add_library (opengl SHARED opengl32.def wgltrace.cpp trace_write.cpp os_win32.cpp ${CMAKE_CURRENT_BINARY_DIR}/glproc.hpp)
- set_target_properties (opengl PROPERTIES
- PREFIX ""
- OUTPUT_NAME opengl32)
- if (MINGW)
- set_target_properties(opengl PROPERTIES LINK_FLAGS "-Wl,--enable-stdcall-fixup ${CMAKE_CURRENT_SOURCE_DIR}/opengl32.def")
- endif (MINGW)
-else ()
- include_directories (${X11_INCLUDE_DIR})
+##############################################################################
+# Bundled dependencies
+#
+# We always use the bundled zlib, libpng, and snappy sources:
+# - on Windows to make it easy to deploy the wrappers DLLs
+# - on unices to prevent symbol collisions when tracing applications that link
+# against other versions of these libraries
- # libGL.so
- add_custom_command (
- OUTPUT glxtrace.cpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/glxtrace.py > ${CMAKE_CURRENT_BINARY_DIR}/glxtrace.cpp
- DEPENDS glxtrace.py gltrace.py trace.py glxapi.py glapi.py glenum.py stdapi.py
- )
+set (ZLIB_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/zlib)
+set (ZLIB_LIBRARIES z_bundled)
+add_subdirectory (thirdparty/zlib EXCLUDE_FROM_ALL)
- add_library (glxtrace SHARED glxtrace.cpp trace_write.cpp os_posix.cpp ${CMAKE_CURRENT_BINARY_DIR}/glproc.hpp)
+include_directories (${ZLIB_INCLUDE_DIRS})
- set_target_properties (glxtrace PROPERTIES
- PREFIX ""
- )
+set (SNAPPY_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/snappy)
+set (SNAPPY_LIBRARIES snappy_bundled)
+add_subdirectory (thirdparty/snappy EXCLUDE_FROM_ALL)
+
+include_directories (${SNAPPY_INCLUDE_DIRS})
+
+set (PNG_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/libpng)
+set (PNG_DEFINITIONS "")
+set (PNG_LIBRARIES png_bundled)
- target_link_libraries (glxtrace dl)
+add_subdirectory (thirdparty/libpng EXCLUDE_FROM_ALL)
+include_directories (${PNG_INCLUDE_DIR})
+add_definitions (${PNG_DEFINITIONS})
+
+if (MSVC)
+ add_subdirectory (thirdparty/getopt EXCLUDE_FROM_ALL)
+ include_directories (${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/getopt)
+ set (GETOPT_LIBRARIES getopt_bundled)
endif ()
if (WIN32)
- set (os os_win32.cpp)
- set (glws glws_wgl.cpp)
-else (WIN32)
- set (os os_posix.cpp)
- set (glws glws_glx.cpp)
-endif (WIN32)
+ add_subdirectory (thirdparty/less)
+endif ()
-add_library (trace trace_model.cpp trace_parser.cpp trace_write.cpp ${os})
+# The Qt website provides binaries for Windows and MacOSX, and they are
+# automatically found by cmake without any manual intervention. The situation
+# for QJSON is substantially different: there are no binaries for QJSON
+# available, and there is no standard installation directory that is detected
+# by cmake.
+#
+# By bundling the QJSON source, we make it much more easier to build the GUI on
+# Windows and MacOSX. But we only use the bundled sources when ENABLE_GUI is
+# AUTO.
+if (QT4_FOUND AND NOT QJSON_FOUND AND (ENABLE_GUI STREQUAL "AUTO"))
+ add_subdirectory (thirdparty/qjson EXCLUDE_FROM_ALL)
+ set (QJSON_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty)
+ set (QJSON_LIBRARY_DIRS)
+ set (QJSON_LIBRARIES qjson_bundled)
+ set (QJSON_FOUND TRUE)
+endif ()
-add_executable (tracedump tracedump.cpp)
-target_link_libraries (tracedump trace)
+# We use bundled headers for all Khronos APIs, to guarantee support for both
+# OpenGL and OpenGL ES at build time, because the OpenGL and OpenGL ES 1 APIs
+# are so intertwined that conditional compilation extremely difficult. This
+# also avoids missing/inconsistent declarations in system headers.
+include_directories (BEFORE ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/khronos)
-add_custom_command (
- OUTPUT glretrace_gl.cpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/glretrace.py > ${CMAKE_CURRENT_BINARY_DIR}/glretrace_gl.cpp
- DEPENDS glretrace.py retrace.py codegen.py glapi.py glenum.py stdapi.py
-)
+##############################################################################
+# Installation directories
-add_custom_command (
- OUTPUT glretrace_state.cpp
- COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/glstate.py > ${CMAKE_CURRENT_BINARY_DIR}/glretrace_state.cpp
- DEPENDS glstate.py glapi.py glenum.py stdapi.py
+if (WIN32 OR APPLE)
+ # On Windows/MacOSX, applications are usually installed on a directory of
+ # their own
+ set (DOC_INSTALL_DIR doc)
+ set (LIB_INSTALL_DIR lib)
+else ()
+ set (DOC_INSTALL_DIR share/doc/${CMAKE_PROJECT_NAME})
+ set (LIB_INSTALL_DIR lib/${CMAKE_PROJECT_NAME})
+endif ()
+
+set(SCRIPTS_INSTALL_DIR ${LIB_INSTALL_DIR}/scripts)
+set(WRAPPER_INSTALL_DIR ${LIB_INSTALL_DIR}/wrappers)
+
+# Expose the binary/install directories to source
+#
+# TODO: Use the same directory layout, for both build and install directories,
+# so that binaries can find each other using just relative paths.
+#
+add_definitions(
+ -DAPITRACE_BINARY_DIR="${CMAKE_BINARY_DIR}"
+ -DAPITRACE_INSTALL_PREFIX="${CMAKE_INSTALL_PREFIX}"
+ -DAPITRACE_WRAPPER_INSTALL_DIR="${CMAKE_INSTALL_PREFIX}/${WRAPPER_INSTALL_DIR}"
)
+
+##############################################################################
+# Common libraries / utilities
+
include_directories (
${CMAKE_CURRENT_BINARY_DIR}
- ${OPENGL_INCLUDE_PATH}
+ ${CMAKE_CURRENT_SOURCE_DIR}
+ ${CMAKE_CURRENT_SOURCE_DIR}/common
)
-add_executable (glretrace
- glretrace_gl.cpp
- glretrace_main.cpp
- glretrace_state.cpp
- retrace.cpp
- ${glws}
- image.cpp
- ${CMAKE_CURRENT_BINARY_DIR}/glproc.hpp
+if (WIN32)
+ set (os os_win32.cpp)
+ set (glws_os glws_wgl.cpp)
+else ()
+ set (os os_posix.cpp)
+ if (APPLE)
+ set (glws_os glws_cocoa.mm)
+ else ()
+ set (glws_os glws_glx.cpp)
+ endif ()
+endif ()
+
+add_library (common STATIC
+ common/trace_callset.cpp
+ common/trace_dump.cpp
+ common/trace_file.cpp
+ common/trace_file_read.cpp
+ common/trace_file_write.cpp
+ common/trace_file_zlib.cpp
+ common/trace_file_snappy.cpp
+ common/trace_model.cpp
+ common/trace_parser.cpp
+ common/trace_parser_flags.cpp
+ common/trace_writer.cpp
+ common/trace_writer_local.cpp
+ common/trace_writer_model.cpp
+ common/trace_loader.cpp
+ common/trace_resource.cpp
+ common/trace_tools_trace.cpp
+ common/image.cpp
+ common/image_bmp.cpp
+ common/image_pnm.cpp
+ common/image_png.cpp
+ common/${os}
)
-set_property (
- TARGET glretrace
- APPEND
- PROPERTY COMPILE_DEFINITIONS "RETRACE"
+set_target_properties (common PROPERTIES
+ COMPILE_DEFINITIONS APITRACE_SOURCE_DIR="${CMAKE_SOURCE_DIR}"
+ # Ensure it can be statically linked in shared libraries
+ COMPILE_FLAGS "${CMAKE_SHARED_LIBRARY_CXX_FLAGS}"
)
-target_link_libraries (glretrace
- trace
- ${OPENGL_gl_LIBRARY}
- ${OPENGL_glu_LIBRARY}
- ${X11_LIBRARIES}
+if (ANDROID)
+ target_link_libraries (common log)
+endif ()
+
+
+##############################################################################
+# Sub-directories
+
+add_subdirectory (dispatch)
+add_subdirectory (wrappers)
+add_subdirectory (retrace)
+
+
+##############################################################################
+# CLI
+
+if (ENABLE_CLI)
+ add_subdirectory(cli)
+endif ()
+
+##############################################################################
+# Scripts (to support the CLI)
+
+install (
+ PROGRAMS
+ ${CMAKE_CURRENT_SOURCE_DIR}/scripts/tracediff.py
+ ${CMAKE_CURRENT_SOURCE_DIR}/scripts/jsondiff.py
+ ${CMAKE_CURRENT_SOURCE_DIR}/scripts/snapdiff.py
+ DESTINATION ${SCRIPTS_INSTALL_DIR}
)
-if (NOT WIN32)
- target_link_libraries (glretrace ${X11_LIBRARIES})
-endif (NOT WIN32)
+##############################################################################
+# GUI
-if (QT4_FOUND AND QJSON_FOUND)
+if (ENABLE_GUI AND QT4_FOUND AND QJSON_FOUND)
add_subdirectory(gui)
-endif (QT4_FOUND AND QJSON_FOUND)
+endif ()
+
+
+##############################################################################
+# Packaging
+
+install (
+ FILES
+ BUGS.markdown
+ LICENSE
+ NEWS.markdown
+ README.markdown
+ DESTINATION ${DOC_INSTALL_DIR}
+)
+
+set (CPACK_PACKAGE_VERSION_MAJOR "3")
+set (CPACK_PACKAGE_VERSION_MINOR "0")
+
+# Use current date in YYYYMMDD format as patch number
+execute_process (
+ COMMAND ${PYTHON_EXECUTABLE} -c "import time, sys; sys.stdout.write(time.strftime('%Y%m%d'))"
+ OUTPUT_VARIABLE CPACK_PACKAGE_VERSION_PATCH
+)
+
+# cpack mistakenly detects Mingw-w64 as win32
+if (MINGW)
+ if (CMAKE_SIZEOF_VOID_P EQUAL 8)
+ set (CPACK_SYSTEM_NAME win64)
+ endif ()
+endif ()
+
+# See http://www.vtk.org/Wiki/CMake:CPackPackageGenerators
+if (WIN32)
+ set (CPACK_GENERATOR "ZIP")
+elseif (APPLE)
+ set (CPACK_GENERATOR "DragNDrop")
+else ()
+ set (CPACK_GENERATOR "TBZ2")
+endif ()
+
+include(CPack)