Changeset 2702 for code/branches/buildsystem3/cmake/BuildConfig.cmake

Timestamp:

Feb 27, 2009, 2:13:29 PM (15 years ago)

Author:

rgrieder

Message:

Completed work on installation:

• The CMake switch INSTALL_COPYABLE tells whether you will be able to move the installed directory or not. If TRUE then all folders, including log and config directory, will be put into the CMAKE_INSTALL_PREFIX. Furthermore, relative paths are used, which get resolved at run time.
• If INSTALL_COPYABLE is set to FALSE, the standard operating system directories will be used. That also means on Windows files get written to the Application Data/.orxonox folder instead of Program Files/Orxonox
• Default configuration is INSTALL_COPYABLE=TRUE for Windows and FALSE for Unix

• Split OrxonoxConfig.h.in in two to avoid complete recompiles when changing only a path or INSTALL_COPYABLE
• Added a global constant character: CP_SLASH which stands for cross platform slash, meaning '/' on Unix and '
  ' on Windows
• Core class now has methods getFooPath(), getFooPathString() and getFooPathPOSIXString() where Foo can be Media, Log or Config
• getFooPathPOSIXString() will always return a directory formatted with slashes, even on Windows
• getFooPath() returns a reference to the boost::filesystem::path
• boost/filesystem.hpp does not get included to Core.h because it has a very large rat tail
• The platform specific directory stuff gets done in Core::postMainInitialisation()
• Adjusted all classes using the media path

File:

• code/branches/buildsystem3/cmake/BuildConfig.cmake (modified) (2 diffs)

code/branches/buildsystem3/cmake/BuildConfig.cmake

@@ -27 +27 @@
 ################# Misc Options ##################
 
-# Set binary output directories
-SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
-SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+# Standard path suffixes, might not hold everywhere though
+SET(DEFAULT_RUNTIME_PATH bin)
+SET(DEFAULT_LIBRARY_PATH lib)
+SET(DEFAULT_ARCHIVE_PATH lib/static)
+SET(DEFAULT_DOC_PATH     doc)
+SET(DEFAULT_MEDIA_PATH   media)
+SET(DEFAULT_CONFIG_PATH  config)
+SET(DEFAULT_LOG_PATH     log)
+
+# Set output directories
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${DEFAULT_RUNTIME_PATH})
+SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${DEFAULT_LIBRARY_PATH})
+SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${DEFAULT_ARCHIVE_PATH})
+# Do not set doc and media, rather check in the two subdirectories
+# whether they concur with the DEFAULT_..._PATH
+SET(CMAKE_CONFIG_OUTPUT_DIRECTORY  ${CMAKE_BINARY_DIR}/${DEFAULT_CONFIG_PATH})
+SET(CMAKE_LOG_OUTPUT_DIRECTORY     ${CMAKE_BINARY_DIR}/${DEFAULT_LOG_PATH})
 
 # Take care of some CMake 2.6.0 leftovers
@@ -117 +130 @@
 ############# Installation Settings #############
 
+SET(_info_text "Puts all installed files in subfolders of the install prefix path. That root folder can then be moved, copied and renamed as you wish. The executable will not write to folders like ~/.orxonox or \"Applictation Data\"")
 IF(UNIX)
+  OPTION(INSTALL_COPYABLE "${_info_text}" FALSE)
+ELSE()
+  OPTION(INSTALL_COPYABLE "${_info_text}" TRUE)
+ENDIF()
+
+IF(INSTALL_COPYABLE)
+  # Note the relative paths. They will be resolved at runtime.
+  # For CMake operations CMAKE_INSTALL_PREFIX is always appended.
+  SET(ORXONOX_RUNTIME_INSTALL_PATH ${DEFAULT_RUNTIME_PATH})
+  SET(ORXONOX_LIBRARY_INSTALL_PATH ${DEFAULT_LIBRARY_PATH})
+  SET(ORXONOX_ARCHIVE_INSTALL_PATH ${DEFAULT_ARCHIVE_PATH})
+  SET(ORXONOX_DOC_INSTALL_PATH     ${DEFAULT_DOC_PATH})
+  SET(ORXONOX_MEDIA_INSTALL_PATH   ${DEFAULT_MEDIA_PATH})
+  SET(ORXONOX_CONFIG_INSTALL_PATH  ${DEFAULT_CONFIG_PATH})
+  SET(ORXONOX_LOG_INSTALL_PATH     ${DEFAULT_LOG_PATH})
+
+ELSEIF(UNIX) # Apple too?
+  # Using absolute paths
   SET(ORXONOX_RUNTIME_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/bin)
   SET(ORXONOX_LIBRARY_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/lib/orxonox)
   SET(ORXONOX_ARCHIVE_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/lib/orxonox/static)
+  SET(ORXONOX_DOC_INSTALL_PATH     ${CMAKE_INSTALL_PREFIX}/share/doc/orxonox)
   SET(ORXONOX_MEDIA_INSTALL_PATH   ${CMAKE_INSTALL_PREFIX}/share/orxonox)
-  SET(ORXONOX_DOC_INSTALL_PATH     ${CMAKE_INSTALL_PREFIX}/share/doc/orxonox)
-  GET_FILENAME_COMPONENT(USER_DIR ~ ABSOLUTE)
-  SET(ORXONOX_LOG_INSTALL_PATH     ${USER_DIR}/.orxonox/log)
-  SET(ORXONOX_CONFIG_INSTALL_PATH  ${USER_DIR}/.orxonox/config)
-
-  # Execution paths, either relative to the binary dir or absolute
-  # For Windows copy&paste installs relative paths are much better
-  SET(ORXONOX_MEDIA_INSTALL_PATH_EXEC  ${ORXONOX_MEDIA_INSTALL_PATH})
-  SET(ORXONOX_CONFIG_INSTALL_PATH_EXEC ${ORXONOX_CONFIG_INSTALL_PATH})
-  SET(ORXONOX_LOG_INSTALL_PATH_EXEC    ${ORXONOX_LOG_INSTALL_PATH})
+  # These two paths are user and therefore runtime dependent --> only set relatively
+  SET(ORXONOX_CONFIG_INSTALL_PATH  ${DEFAULT_CONFIG_PATH})
+  SET(ORXONOX_LOG_INSTALL_PATH     ${DEFAULT_LOG_PATH})
+
 ELSEIF(WIN32)
-  SET(ORXONOX_RUNTIME_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/bin)
-  SET(ORXONOX_LIBRARY_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/lib)
-  SET(ORXONOX_ARCHIVE_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/lib/static)
-  SET(ORXONOX_MEDIA_INSTALL_PATH   ${CMAKE_INSTALL_PREFIX}/media)
-  SET(ORXONOX_DOC_INSTALL_PATH     ${CMAKE_INSTALL_PREFIX}/doc)
-  SET(ORXONOX_LOG_INSTALL_PATH     ${CMAKE_INSTALL_PREFIX}/log)
-  SET(ORXONOX_CONFIG_INSTALL_PATH  ${CMAKE_INSTALL_PREFIX}/config)
-
-  # Execution paths, either relative to the binary dir or absolute
-  # For Windows copy&paste installs relative paths are much better
-  SET(ORXONOX_MEDIA_INSTALL_PATH_EXEC  ../media)
-  SET(ORXONOX_CONFIG_INSTALL_PATH_EXEC ../config)
-  SET(ORXONOX_LOG_INSTALL_PATH_EXEC    ../log)
+  SET(ORXONOX_RUNTIME_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/${DEFAULT_RUNTIME_PATH})
+  SET(ORXONOX_LIBRARY_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/${DEFAULT_LIBRARY_PATH})
+  SET(ORXONOX_ARCHIVE_INSTALL_PATH ${CMAKE_INSTALL_PREFIX}/${DEFAULT_ARCHIVE_PATH})
+  SET(ORXONOX_DOC_INSTALL_PATH     ${CMAKE_INSTALL_PREFIX}/${DEFAULT_DOC_PATH})
+  SET(ORXONOX_MEDIA_INSTALL_PATH   ${CMAKE_INSTALL_PREFIX}/${DEFAULT_MEDIA_PATH})
+  # Leave empty because it is user and therefore runtime dependent
+  SET(ORXONOX_CONFIG_INSTALL_PATH  ${DEFAULT_CONFIG_PATH})
+  SET(ORXONOX_LOG_INSTALL_PATH     ${DEFAULT_LOG_PATH})
 ENDIF()