diff options
| author | Bill Hoffman <bill.hoffman@kitware.com> | 2005-12-14 18:51:08 (GMT) |
|---|---|---|
| committer | Bill Hoffman <bill.hoffman@kitware.com> | 2005-12-14 18:51:08 (GMT) |
| commit | b7fa820118d6989ca4d77dbfcc972c2e903bfe2a (patch) | |
| tree | a5605c468a458597fff5f17485fad8cd85856e1b | |
| parent | 805d365d479a916acf2c5638809fb046fc28dc97 (diff) | |
| download | CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.zip CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.gz CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.bz2 | |
ENH: add documentation support for modules
116 files changed, 964 insertions, 762 deletions
diff --git a/Modules/CMake.cmake b/Modules/CMake.cmake index 411544f..7689bd9 100644 --- a/Modules/CMake.cmake +++ b/Modules/CMake.cmake @@ -1,3 +1,4 @@ + # This file is used by cmake.cxx to compute the CMAKE_ROOT location. # Do not remove this file from cvs without updating cmake.cxx to look # for a different file. diff --git a/Modules/CMakeBackwardCompatibilityC.cmake b/Modules/CMakeBackwardCompatibilityC.cmake index 90dfbfc..0333384 100644 --- a/Modules/CMakeBackwardCompatibilityC.cmake +++ b/Modules/CMakeBackwardCompatibilityC.cmake @@ -1,3 +1,4 @@ + # Nothing here yet IF(CMAKE_GENERATOR MATCHES "Visual Studio 7") INCLUDE(CMakeVS7BackwardCompatibility) diff --git a/Modules/CMakeBackwardCompatibilityCXX.cmake b/Modules/CMakeBackwardCompatibilityCXX.cmake index 79e6f03..9a2508c 100644 --- a/Modules/CMakeBackwardCompatibilityCXX.cmake +++ b/Modules/CMakeBackwardCompatibilityCXX.cmake @@ -1,4 +1,10 @@ -# +# - define a bunch of backwards compatibility varibles +# CMAKE_ANSI_CXXFLAGS - flag for ansi c++ +# CMAKE_HAS_ANSI_STRING_STREAM - has <strstream> +# INCLUDE(TestForANSIStreamHeaders) +# INCLUDE(CheckIncludeFileCXX) +# INCLUDE(TestForSTDNamespace) +# INCLUDE(TestForANSIForScope) IF(NOT CMAKE_SKIP_COMPATIBILITY_TESTS) # check for some ANSI flags in the CXX compiler if it is not gnu IF(NOT CMAKE_COMPILER_IS_GNUCXX) diff --git a/Modules/CMakeCInformation.cmake b/Modules/CMakeCInformation.cmake index a18fe4c..875e594 100644 --- a/Modules/CMakeCInformation.cmake +++ b/Modules/CMakeCInformation.cmake @@ -1,3 +1,4 @@ + # This file sets the basic flags for the C language in CMake. # It also loads the available platform file for the system-compiler # if it exists. diff --git a/Modules/CMakeCXXInformation.cmake b/Modules/CMakeCXXInformation.cmake index ea8c7d0..cbffdbf 100644 --- a/Modules/CMakeCXXInformation.cmake +++ b/Modules/CMakeCXXInformation.cmake @@ -1,3 +1,4 @@ + # This file sets the basic flags for the C++ language in CMake. # It also loads the available platform file for the system-compiler # if it exists. diff --git a/Modules/CMakeCommonLanguageInclude.cmake b/Modules/CMakeCommonLanguageInclude.cmake index 3f23c48..cb4aee6 100644 --- a/Modules/CMakeCommonLanguageInclude.cmake +++ b/Modules/CMakeCommonLanguageInclude.cmake @@ -1,3 +1,4 @@ + # this file has flags that are shared across languages and sets # cache values that can be initialized in the platform-compiler.cmake file # it may be included by more than one language. diff --git a/Modules/CMakeDetermineCCompiler.cmake b/Modules/CMakeDetermineCCompiler.cmake index bd7e9d2..27e8b60 100644 --- a/Modules/CMakeDetermineCCompiler.cmake +++ b/Modules/CMakeDetermineCCompiler.cmake @@ -1,3 +1,4 @@ + # determine the compiler to use for C programs # NOTE, a generator may set CMAKE_C_COMPILER before # loading this file to force a compiler. diff --git a/Modules/CMakeDetermineCXXCompiler.cmake b/Modules/CMakeDetermineCXXCompiler.cmake index 916640a..18aa4a3 100644 --- a/Modules/CMakeDetermineCXXCompiler.cmake +++ b/Modules/CMakeDetermineCXXCompiler.cmake @@ -1,3 +1,4 @@ + # determine the compiler to use for C++ programs # NOTE, a generator may set CMAKE_CXX_COMPILER before # loading this file to force a compiler. diff --git a/Modules/CMakeDetermineFortranCompiler.cmake b/Modules/CMakeDetermineFortranCompiler.cmake index 74d5cbd..d621135 100644 --- a/Modules/CMakeDetermineFortranCompiler.cmake +++ b/Modules/CMakeDetermineFortranCompiler.cmake @@ -1,3 +1,4 @@ + # determine the compiler to use for C programs # NOTE, a generator may set CMAKE_C_COMPILER before # loading this file to force a compiler. diff --git a/Modules/CMakeDetermineJavaCompiler.cmake b/Modules/CMakeDetermineJavaCompiler.cmake index da9d936..dcd47d8 100644 --- a/Modules/CMakeDetermineJavaCompiler.cmake +++ b/Modules/CMakeDetermineJavaCompiler.cmake @@ -1,3 +1,4 @@ + # determine the compiler to use for Java programs # NOTE, a generator may set CMAKE_Java_COMPILER before # loading this file to force a compiler. diff --git a/Modules/CMakeDetermineRCCompiler.cmake b/Modules/CMakeDetermineRCCompiler.cmake index e826b50..b2c1cad 100644 --- a/Modules/CMakeDetermineRCCompiler.cmake +++ b/Modules/CMakeDetermineRCCompiler.cmake @@ -1,3 +1,4 @@ + # determine the compiler to use for C programs # NOTE, a generator may set CMAKE_C_COMPILER before # loading this file to force a compiler. diff --git a/Modules/CMakeDetermineSystem.cmake b/Modules/CMakeDetermineSystem.cmake index 78b0474..fc13071 100644 --- a/Modules/CMakeDetermineSystem.cmake +++ b/Modules/CMakeDetermineSystem.cmake @@ -1,3 +1,4 @@ + # This module is used by the Makefile generator to determin the following variables: # CMAKE_SYSTEM_NAME - on unix this is uname -s, for windows it is Windows # CMAKE_SYSTEM_VERSION - on unix this is uname -r, for windows it is empty diff --git a/Modules/CMakeExportBuildSettings.cmake b/Modules/CMakeExportBuildSettings.cmake index 1ec8b8a..d24f28c 100644 --- a/Modules/CMakeExportBuildSettings.cmake +++ b/Modules/CMakeExportBuildSettings.cmake @@ -1,6 +1,7 @@ -# Macro to export the build settings for use by another project. -# Provide as an argument the file into which the settings are to be -# stored. +# - export build settings from a project. +# CMAKE_EXPORT_BUILD_SETTINGS(SETTINGS_FILE) - macro defined to export the build +# settings for use by another project. +# SETTINGS_FILE - the file into which the settings are to be stored. MACRO(CMAKE_EXPORT_BUILD_SETTINGS SETTINGS_FILE) IF(${SETTINGS_FILE} MATCHES ".+") CONFIGURE_FILE(${CMAKE_ROOT}/Modules/CMakeBuildSettings.cmake.in diff --git a/Modules/CMakeFindFrameworks.cmake b/Modules/CMakeFindFrameworks.cmake index c800869..3a47eb0 100644 --- a/Modules/CMakeFindFrameworks.cmake +++ b/Modules/CMakeFindFrameworks.cmake @@ -1,3 +1,5 @@ +# - helper module to find OSX frameworks + IF(NOT CMAKE_FIND_FRAMEWORKS_INCLUDED) SET(CMAKE_FIND_FRAMEWORKS_INCLUDED 1) MACRO(CMAKE_FIND_FRAMEWORKS fwk) diff --git a/Modules/CMakeFortranInformation.cmake b/Modules/CMakeFortranInformation.cmake index d711cf3..19aa5f7 100644 --- a/Modules/CMakeFortranInformation.cmake +++ b/Modules/CMakeFortranInformation.cmake @@ -1,3 +1,4 @@ + # This file sets the basic flags for the Fortran language in CMake. # It also loads the available platform file for the system-compiler # if it exists. diff --git a/Modules/CMakeImportBuildSettings.cmake b/Modules/CMakeImportBuildSettings.cmake index 9af301b..e3f0731 100644 --- a/Modules/CMakeImportBuildSettings.cmake +++ b/Modules/CMakeImportBuildSettings.cmake @@ -1,6 +1,8 @@ -# Macro to import the build settings from another project. Provide as -# an argument the file created by the other project's -# CMAKE_EXPORT_BUILD_SETTINGS command. +# - import build settings from another project +# CMAKE_IMPORT_BUILD_SETTINGS(SETTINGS_FILE) - macro defined to import the +# build settings from another project. +# SETTINGS_FILE - a file created by the other project's call to the +# CMAKE_EXPORT_BUILD_SETTINGS macro, see CMakeExportBuildSettings. MACRO(CMAKE_IMPORT_BUILD_SETTINGS SETTINGS_FILE) IF(${SETTINGS_FILE} MATCHES ".+") # Load the settings. diff --git a/Modules/CMakeJavaInformation.cmake b/Modules/CMakeJavaInformation.cmake index b890694..65c833e 100644 --- a/Modules/CMakeJavaInformation.cmake +++ b/Modules/CMakeJavaInformation.cmake @@ -1,3 +1,4 @@ + # this is a place holder if java needed flags for javac they would go here. IF(NOT CMAKE_Java_CREATE_STATIC_LIBRARY) SET(CMAKE_Java_CREATE_STATIC_LIBRARY diff --git a/Modules/CMakePrintSystemInformation.cmake b/Modules/CMakePrintSystemInformation.cmake index 14d5e1c..2b9ecda 100644 --- a/Modules/CMakePrintSystemInformation.cmake +++ b/Modules/CMakePrintSystemInformation.cmake @@ -1,6 +1,7 @@ -# this file can be used for diagnostic purposes -# just include it in a project to see various internal cmake -# variables +# - print system information +# This file can be used for diagnostic purposes +# just include it in a project to see various internal CMake +# variables. MESSAGE("CMAKE_SYSTEM is ${CMAKE_SYSTEM} ${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") MESSAGE("CMAKE_SYSTEM file is ${CMAKE_SYSTEM_INFO_FILE}") diff --git a/Modules/CMakeRCInformation.cmake b/Modules/CMakeRCInformation.cmake index 1dc1000..3c5e0e7 100644 --- a/Modules/CMakeRCInformation.cmake +++ b/Modules/CMakeRCInformation.cmake @@ -1,3 +1,4 @@ + # This file sets the basic flags for the Fortran language in CMake. # It also loads the available platform file for the system-compiler # if it exists. diff --git a/Modules/CMakeSystemSpecificInformation.cmake b/Modules/CMakeSystemSpecificInformation.cmake index 199232d..95f424c 100644 --- a/Modules/CMakeSystemSpecificInformation.cmake +++ b/Modules/CMakeSystemSpecificInformation.cmake @@ -1,3 +1,4 @@ + # This file is included by cmGlobalGenerator::EnableLanguage. # It is included after the compiler has been determined, so # we know things like the compiler name and if the compiler is gnu. diff --git a/Modules/CMakeTestCCompiler.cmake b/Modules/CMakeTestCCompiler.cmake index 096c790..a1c77a8 100644 --- a/Modules/CMakeTestCCompiler.cmake +++ b/Modules/CMakeTestCCompiler.cmake @@ -1,3 +1,4 @@ + # This file is used by EnableLanguage in cmGlobalGenerator to # determine that that selected C compiler can actually compile # and link the most basic of programs. If not, a fatal error diff --git a/Modules/CMakeTestCXXCompiler.cmake b/Modules/CMakeTestCXXCompiler.cmake index 6071a68..0571587 100644 --- a/Modules/CMakeTestCXXCompiler.cmake +++ b/Modules/CMakeTestCXXCompiler.cmake @@ -1,3 +1,4 @@ + # This file is used by EnableLanguage in cmGlobalGenerator to # determine that that selected C++ compiler can actually compile # and link the most basic of programs. If not, a fatal error diff --git a/Modules/CMakeTestFortranCompiler.cmake b/Modules/CMakeTestFortranCompiler.cmake index 9d5ec4b..1178ef4 100644 --- a/Modules/CMakeTestFortranCompiler.cmake +++ b/Modules/CMakeTestFortranCompiler.cmake @@ -1,3 +1,4 @@ + # This file is used by EnableLanguage in cmGlobalGenerator to # determine that that selected Fortran compiler can actually compile # and link the most basic of programs. If not, a fatal error diff --git a/Modules/CMakeTestJavaCompiler.cmake b/Modules/CMakeTestJavaCompiler.cmake index 72c47b5..a682307 100644 --- a/Modules/CMakeTestJavaCompiler.cmake +++ b/Modules/CMakeTestJavaCompiler.cmake @@ -1,3 +1,4 @@ + # This file is used by EnableLanguage in cmGlobalGenerator to # determine that that selected Fortran compiler can actually compile # and link the most basic of programs. If not, a fatal error diff --git a/Modules/CMakeTestRCCompiler.cmake b/Modules/CMakeTestRCCompiler.cmake index 4ce9353..a8eeaa3 100644 --- a/Modules/CMakeTestRCCompiler.cmake +++ b/Modules/CMakeTestRCCompiler.cmake @@ -1,3 +1,4 @@ + # This file is used by EnableLanguage in cmGlobalGenerator to # determine that that selected RC compiler can actually compile # and link the most basic of programs. If not, a fatal error diff --git a/Modules/CMakeVS6BackwardCompatibility.cmake b/Modules/CMakeVS6BackwardCompatibility.cmake index e180f5b..13665f7 100644 --- a/Modules/CMakeVS6BackwardCompatibility.cmake +++ b/Modules/CMakeVS6BackwardCompatibility.cmake @@ -1,3 +1,4 @@ + # hard code these for fast backwards compatibility tests SET (CMAKE_SIZEOF_INT 4 CACHE INTERNAL "Size of int data type") SET (CMAKE_SIZEOF_LONG 4 CACHE INTERNAL "Size of long data type") diff --git a/Modules/CMakeVS7BackwardCompatibility.cmake b/Modules/CMakeVS7BackwardCompatibility.cmake index 0789fae..49b5646 100644 --- a/Modules/CMakeVS7BackwardCompatibility.cmake +++ b/Modules/CMakeVS7BackwardCompatibility.cmake @@ -1,3 +1,4 @@ + # hard code these for fast backwards compatibility tests SET (CMAKE_SIZEOF_INT 4 CACHE INTERNAL "Size of int data type") SET (CMAKE_SIZEOF_LONG 4 CACHE INTERNAL "Size of long data type") diff --git a/Modules/CTest.cmake b/Modules/CTest.cmake index 7a6c1a9..6a8977c 100644 --- a/Modules/CTest.cmake +++ b/Modules/CTest.cmake @@ -1,5 +1,4 @@ -# CTest.cmake -# +# - setup CTest # This file configures a project to use the CTest/Dart testing/dashboard process. # OPTION(BUILD_TESTING "Build the testing tree." ON) diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake index f43ebf3..16dcada 100644 --- a/Modules/CheckCSourceCompiles.cmake +++ b/Modules/CheckCSourceCompiles.cmake @@ -1,13 +1,11 @@ -# -# Check if the source code provided in the SOURCE argument compiles. -# -# CHECK_C_SOURCE_COMPILES - macro which checks if the source code compiles\ -# SOURCE - source code to try to compile -# VARIABLE - variable to store size if the type exists. -# +# - Check if the source code provided in the SOURCE argument compiles. +# CHECK_C_SOURCE_COMPILES(SOURCE VAR) +# - macro which checks if the source code compiles +# SOURCE - source code to try to compile +# VAR - variable to store size if the type exists. # Checks the following optional VARIABLES (not arguments) -# CMAKE_REQUIRED_LIBRARIES - Link to extra libraries -# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler +# CMAKE_REQUIRED_LIBRARIES - Link to extra libraries +# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler # MACRO(CHECK_C_SOURCE_COMPILES SOURCE VAR) diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index 72fe1a9..bbbc98e 100644 --- a/Modules/CheckCXXSourceCompiles.cmake +++ b/Modules/CheckCXXSourceCompiles.cmake @@ -1,13 +1,11 @@ -# -# Check if the source code provided in the SOURCE argument compiles. -# -# CHECK_CXX_SOURCE_COMPILES - macro which checks if the source code compiles\ -# SOURCE - source code to try to compile -# VARIABLE - variable to store size if the type exists. -# +# - Check if the source code provided in the SOURCE argument compiles. +# CHECK_CXX_SOURCE_COMPILES(SOURCE VAR) +# - macro which checks if the source code compiles\ +# SOURCE - source code to try to compile +# VAR - variable to store size if the type exists. # Checks the following optional VARIABLES (not arguments) -# CMAKE_REQUIRED_LIBRARIES - Link to extra libraries -# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler +# CMAKE_REQUIRED_LIBRARIES - Link to extra libraries +# CMAKE_REQUIRED_FLAGS - Extra flags to C compiler # MACRO(CHECK_CXX_SOURCE_COMPILES SOURCE VAR) diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake index 7690ec3..6e43f9c 100644 --- a/Modules/CheckFunctionExists.cmake +++ b/Modules/CheckFunctionExists.cmake @@ -1,10 +1,8 @@ -# -# Check if the function exists. -# -# CHECK_FUNCTION_EXISTS - macro which checks if the function exists -# FUNCTION - the name of the function -# VARIABLE - variable to store the result -# +# - Check if the function exists. +# CHECK_FUNCTION_EXISTS(FUNCTION VARIABLE) +# - macro which checks if the function exists +# FUNCTION - the name of the function +# VARIABLE - variable to store the result # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then # those libraries will be linked against the test program diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake index 9429e70..206ff93 100644 --- a/Modules/CheckIncludeFile.cmake +++ b/Modules/CheckIncludeFile.cmake @@ -1,10 +1,9 @@ -# -# Check if the include file exists. -# -# CHECK_INCLUDE_FILE - macro which checks the include file exists. -# INCLUDE - name of include file -# VARIABLE - variable to return result -# +# - Check if the include file exists. +# CHECK_INCLUDE_FILE(INCLUDE VARIABLE) +# - macro which checks the include file exists. +# INCLUDE - name of include file +# VARIABLE - variable to return result +# # an optional third argument is the CFlags to add to the compile line # or you can use CMAKE_REQUIRED_FLAGS # diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake index 1abaaa7..8fd79c9 100644 --- a/Modules/CheckIncludeFileCXX.cmake +++ b/Modules/CheckIncludeFileCXX.cmake @@ -1,12 +1,10 @@ -# -# Check if the include file exists. -# -# CHECK_INCLUDE_FILE - macro which checks the include file exists. -# INCLUDE - name of include file -# VARIABLE - variable to return result -# -# an optional third argument is the CFlags to add to the compile line -# or you can use CMAKE_REQUIRED_FLAGS +# - Check if the include file exists. +# CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE) - macro which checks the include file exists. +# INCLUDE - name of include file +# VARIABLE - variable to return result +# +# An optional third argument is the CFlags to add to the compile line +# or you can use CMAKE_REQUIRED_FLAGS. # MACRO(CHECK_INCLUDE_FILE_CXX INCLUDE VARIABLE) IF("${VARIABLE}" MATCHES "^${VARIABLE}$") diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake index 4c57887..79ba337 100644 --- a/Modules/CheckIncludeFiles.cmake +++ b/Modules/CheckIncludeFiles.cmake @@ -1,10 +1,10 @@ +# - Check if the files can be included # -# Check if the files can be included -# -# CHECK_INCLUDE_FILES - macro which checks the include file exists. -# INCLUDE - list of files to include -# VARIABLE - variable to return result -# +# CHECK_INCLUDE_FILES(INCLUDE VARIABLE) +# - macro which checks the include file exists. +# INCLUDE - list of files to include +# VARIABLE - variable to return result +# # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake index b216c3b..fde1ca1 100644 --- a/Modules/CheckLibraryExists.cmake +++ b/Modules/CheckLibraryExists.cmake @@ -1,12 +1,11 @@ -# -# Check if the function exists. -# -# CHECK_LIBRARY_EXISTS - macro which checks if the function exists -# LIBRARY - the name of the library you are looking for -# FUNCTION - the name of the function -# LOCATION - location where the library should be found -# VARIABLE - variable to store the result -# +# - Check if the function exists. +# CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE) +# - macro which checks if the function exists +# LIBRARY - the name of the library you are looking for +# FUNCTION - the name of the function +# LOCATION - location where the library should be found +# VARIABLE - variable to store the result +# # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then # those libraries will be linked against the test program diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index cc1ca75..6d965fb 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -1,11 +1,10 @@ -# -# Check if the symbol exists in include files -# -# CHECK_SYMBOL_EXISTS - macro which checks the symbol exists in include files. -# SYMBOL - symbol -# FILES - include files to check -# VARIABLE - variable to return result -# +# - Check if the symbol exists in include files +# CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE) +# - macro which checks the symbol exists in include files. +# SYMBOL - symbol +# FILES - include files to check +# VARIABLE - variable to return result +# # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then # those libraries will be linked against the test program diff --git a/Modules/CheckTypeSize.cmake b/Modules/CheckTypeSize.cmake index 79df8b5..e19c260 100644 --- a/Modules/CheckTypeSize.cmake +++ b/Modules/CheckTypeSize.cmake @@ -1,11 +1,10 @@ -# +# - Check sizeof a type +# CHECK_TYPE_SIZE(TYPE VARIABLE) # Check if the type exists and determine size of type. if the type # exists, the size will be stored to the variable. # -# CHECK_TYPE_SIZE - macro which checks the size of type -# VARIABLE - variable to store size if the type exists. -# HAVE_${VARIABLE} - does the variable exists or not -# +# VARIABLE - variable to store size if the type exists. +# HAVE_${VARIABLE} - does the variable exists or not MACRO(CHECK_TYPE_SIZE TYPE VARIABLE) SET(CMAKE_ALLOW_UNKNOWN_VARIABLE_READ_ACCESS 1) diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake index ed1dfb3..1cebdee 100644 --- a/Modules/CheckVariableExists.cmake +++ b/Modules/CheckVariableExists.cmake @@ -1,14 +1,12 @@ -# -# Check if the variable exists. -# # CHECK_VARIABLE_EXISTS - macro which checks if the variable exists -# VAR - the name of the variable -# VARIABLE - variable to store the result -# +# - Check if the variable exists. +# CHECK_VARIABLE_EXISTS(VAR VARIABLE) +# - macro which checks if the variable exists +# VAR - the name of the variable +# VARIABLE - variable to store the result # If CMAKE_REQUIRED_FLAGS is set then those flags will be passed into the # compile of the program likewise if CMAKE_REQUIRED_LIBRARIES is set then -# those libraries will be linked against the test program -# -# only for C variables +# those libraries will be linked against the test program. +# This macro is only for C variables. # MACRO(CHECK_VARIABLE_EXISTS VAR VARIABLE) IF("${VARIABLE}" MATCHES "^${VARIABLE}$") diff --git a/Modules/Dart.cmake b/Modules/Dart.cmake index 3b73ea0..9536f43 100644 --- a/Modules/Dart.cmake +++ b/Modules/Dart.cmake @@ -1,11 +1,11 @@ -# Dart.cmake -# +# - setup for using Dart. # This file configures a project to use the Dart testing/dashboard process. # It is broken into 3 sections. + # -# Section #1: Locate programs on the client and determine site and build name -# Section #2: Configure or copy Tcl scripts from the source tree to build tree -# Section #3: Custom targets for performing dashboard builds. +# Section #1: Locate programs on the client and determine site and build name +# Section #2: Configure or copy Tcl scripts from the source tree to build tree +# Section #3: Custom targets for performing dashboard builds. # # OPTION(BUILD_TESTING "Build the testing tree." ON) diff --git a/Modules/Documentation.cmake b/Modules/Documentation.cmake index a098203..73998be 100644 --- a/Modules/Documentation.cmake +++ b/Modules/Documentation.cmake @@ -1,5 +1,4 @@ -# DocumentationVTK.cmake -# +# - DocumentationVTK.cmake # This file provides support for the VTK documentation framework. # It relies on several tools (Doxygen, Perl, etc). diff --git a/Modules/FindAVIFile.cmake b/Modules/FindAVIFile.cmake index f1de1a2..6c4be04 100644 --- a/Modules/FindAVIFile.cmake +++ b/Modules/FindAVIFile.cmake @@ -1,14 +1,12 @@ -# Locate AVIFILE library and include paths - -# AVIFILE (http://avifile.sourceforge.net/ )is a set of library for i386 machines +# - Locate AVIFILE library and include paths +# AVIFILE (http://avifile.sourceforge.net/)is a set of library for i386 machines # to use various AVI codecs. Support is limited beyond Linux. Windows # provides native AVI support, and so doesn't need this library. - # This module defines -# AVIFILE_INCLUDE_DIR, where to find avifile.h , etc. -# AVIFILE_LIBRARIES, the libraries to link against to use AVIFILE -# AVIFILE_DEFINITIONS, definitions to use when compiling code that uses AVIFILE. -# AVIFILE_FOUND, If false, don't try to use AVIFILE. +# AVIFILE_INCLUDE_DIR, where to find avifile.h , etc. +# AVIFILE_LIBRARIES, the libraries to link against to use AVIFILE +# AVIFILE_DEFINITIONS, definitions to use when compiling code that uses AVIFILE. +# AVIFILE_FOUND, If false, don't try to use AVIFILE. IF (UNIX) diff --git a/Modules/FindCABLE.cmake b/Modules/FindCABLE.cmake index 0d970e1..f7ceaaa 100644 --- a/Modules/FindCABLE.cmake +++ b/Modules/FindCABLE.cmake @@ -1,15 +1,12 @@ -# +# - Find CABLE # This module finds if CABLE is installed and determines where the # include files and libraries are. This code sets the following variables: -# # CABLE = the full path to the cable executable # CABLE_TCL_LIBRARY = the full path to the Tcl wrapper facility library # CABLE_INCLUDE_DIR = the full path to the cable include directory -# -# To build Tcl wrappers, you should add shared library and link it to -# ${CABLE_TCL_LIBRARY}. You should also add ${CABLE_INCLUDE_DIR} as -# an include directory. -# +# To build Tcl wrappers, you should add shared library and link it to +# ${CABLE_TCL_LIBRARY}. You should also add ${CABLE_INCLUDE_DIR} as +# an include directory. IF(NOT CABLE) FIND_PATH(CABLE_BUILD_DIR cableVersion.h) diff --git a/Modules/FindCurses.cmake b/Modules/FindCurses.cmake index 3e37986..9c72c49 100644 --- a/Modules/FindCurses.cmake +++ b/Modules/FindCurses.cmake @@ -1,5 +1,4 @@ -# -# Find the curses include file and library +# - Find the curses include file and library # FIND_PATH(CURSES_INCLUDE_PATH diff --git a/Modules/FindCygwin.cmake b/Modules/FindCygwin.cmake index 8fe326b..def439e 100644 --- a/Modules/FindCygwin.cmake +++ b/Modules/FindCygwin.cmake @@ -1,5 +1,4 @@ -# -# this module looks for Cygwin +# - this module looks for Cygwin # IF (WIN32) diff --git a/Modules/FindDCMTK.cmake b/Modules/FindDCMTK.cmake index b295bb0..2a26334 100644 --- a/Modules/FindDCMTK.cmake +++ b/Modules/FindDCMTK.cmake @@ -1,11 +1,10 @@ -# -# try to find DCMTK libraries +# - find DCMTK libraries # -# DCMTK_INCLUDE_DIR - Directories to include to use DCMTK -# DCMTK_LIBRARIES - Files to link against to use DCMTK -# DCMTK_FOUND - If false, don't try to use DCMTK -# DCMTK_DIR - (optional) Source directory for DCMTK +# DCMTK_INCLUDE_DIR - Directories to include to use DCMTK +# DCMTK_LIBRARIES - Files to link against to use DCMTK +# DCMTK_FOUND - If false, don't try to use DCMTK +# DCMTK_DIR - (optional) Source directory for DCMTK # # DCMTK_DIR can be used to make it simpler to find the various include # directories and compiled libraries if you've just compiled it in the diff --git a/Modules/FindDart.cmake b/Modules/FindDart.cmake index 92fdfad..30d8789 100644 --- a/Modules/FindDart.cmake +++ b/Modules/FindDart.cmake @@ -1,6 +1,6 @@ -# -# this module looks for the dart testing software and sets DART_ROOT -# to point to where it found it +# - Find DART +# This module looks for the dart testing software and sets DART_ROOT +# to point to where it found it. # FIND_PATH(DART_ROOT README.INSTALL diff --git a/Modules/FindDoxygen.cmake b/Modules/FindDoxygen.cmake index 45140c9..d3f705f 100644 --- a/Modules/FindDoxygen.cmake +++ b/Modules/FindDoxygen.cmake @@ -1,7 +1,4 @@ -# -# this module looks for Doxygen and the path to Graphiz's dot -# - +# - this module looks for Doxygen and the path to Graphiz's dot # With the OS X GUI version, it likes to be installed to /Applications and # it contains the doxygen executable in the bundle. In the versions I've # seen, it is located in Resources, but in general, more often binaries are diff --git a/Modules/FindFLTK.cmake b/Modules/FindFLTK.cmake index ac63018..df93e57 100644 --- a/Modules/FindFLTK.cmake +++ b/Modules/FindFLTK.cmake @@ -1,20 +1,17 @@ -# -# Find the native FLTK includes and library -# +# - Find the native FLTK includes and library # The following settings are defined -# FLTK_FLUID_EXECUTABLE, where to find the Fluid tool -# FLTK_WRAP_UI, This allows the FLTK_WRAP_UI command to work. -# FLTK_INCLUDE_DIR, where to find include files -# FLTK_LIBRARIES, list of fltk libraries -# FLTK_FOUND, Don't use FLTK if false. - +# FLTK_FLUID_EXECUTABLE, where to find the Fluid tool +# FLTK_WRAP_UI, This allows the FLTK_WRAP_UI command to work. +# FLTK_INCLUDE_DIR, where to find include files +# FLTK_LIBRARIES, list of fltk libraries +# FLTK_FOUND, Don't use FLTK if false. # The following settings should not be used in general. -# FLTK_BASE_LIBRARY = the full path to fltk.lib -# FLTK_GL_LIBRARY = the full path to fltk_gl.lib -# FLTK_FORMS_LIBRARY = the full path to fltk_forms.lib -# FLTK_IMAGES_LIBRARY = the full path to fltk_images.lib +# FLTK_BASE_LIBRARY = the full path to fltk.lib +# FLTK_GL_LIBRARY = the full path to fltk_gl.lib +# FLTK_FORMS_LIBRARY = the full path to fltk_forms.lib +# FLTK_IMAGES_LIBRARY = the full path to fltk_images.lib -# Platform dependent libraries required by FLTK +# Platform dependent libraries required by FLTK IF(WIN32) IF(NOT CYGWIN) IF(BORLAND) diff --git a/Modules/FindGCCXML.cmake b/Modules/FindGCCXML.cmake index 1600e9d..e0cb838 100644 --- a/Modules/FindGCCXML.cmake +++ b/Modules/FindGCCXML.cmake @@ -1,4 +1,4 @@ -# Find the GCC-XML front-end executable. +# - Find the GCC-XML front-end executable. FIND_PROGRAM(GCCXML NAMES gccxml ../GCC_XML/gccxml diff --git a/Modules/FindGLU.cmake b/Modules/FindGLU.cmake index b61828f..fa56a51 100644 --- a/Modules/FindGLU.cmake +++ b/Modules/FindGLU.cmake @@ -1,4 +1,5 @@ -# + + # Use of this file is deprecated, and is here for backwards compatibility with CMake 1.4 # GLU library is now found by FindOpenGL.cmake # diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake index 6448b7d..449d34e 100644 --- a/Modules/FindGLUT.cmake +++ b/Modules/FindGLUT.cmake @@ -1,14 +1,11 @@ -# -# try to find glut library and include files -# -# GLUT_INCLUDE_DIR, where to find GL/glut.h, etc. -# GLUT_LIBRARIES, the libraries to link against to use GLUT. -# GLUT_FOUND, If false, do not try to use GLUT. - -# also defined, but not for general use are -# GLUT_glut_LIBRARY = the full path to the glut library. -# GLUT_Xmu_LIBRARY = the full path to the Xmu library if available. -# GLUT_Xi_LIBRARY = the full path to the Xi Library if available. +# - try to find glut library and include files +# GLUT_INCLUDE_DIR, where to find GL/glut.h, etc. +# GLUT_LIBRARIES, the libraries to link against to use GLUT. +# GLUT_FOUND, If false, do not try to use GLUT. +# Also defined, but not for general use are: +# GLUT_glut_LIBRARY = the full path to the glut library. +# GLUT_Xmu_LIBRARY = the full path to the Xmu library. +# GLUT_Xi_LIBRARY = the full path to the Xi Library. IF (WIN32) diff --git a/Modules/FindGTK.cmake b/Modules/FindGTK.cmake index 81158a0..6d0c203 100644 --- a/Modules/FindGTK.cmake +++ b/Modules/FindGTK.cmake @@ -1,11 +1,8 @@ -# -# try to find GTK (and glib) and GTKGLArea -# - -# GTK_INCLUDE_DIR - Directories to include to use GTK -# GTK_LIBRARIES - Files to link against to use GTK -# GTK_FOUND - If false, don't try to use GTK -# GTK_GL_FOUND - If false, don't try to use GTK's GL features +# - try to find GTK (and glib) and GTKGLArea +# GTK_INCLUDE_DIR - Directories to include to use GTK +# GTK_LIBRARIES - Files to link against to use GTK +# GTK_FOUND - If false, don't try to use GTK +# GTK_GL_FOUND - If false, don't try to use GTK's GL features # don't even bother under WIN32 IF(UNIX) diff --git a/Modules/FindGnuplot.cmake b/Modules/FindGnuplot.cmake index 5a9bc28..5e3babc 100644 --- a/Modules/FindGnuplot.cmake +++ b/Modules/FindGnuplot.cmake @@ -1,5 +1,4 @@ -# -# this module looks for gnuplot +# - this module looks for gnuplot # INCLUDE(FindCygwin) diff --git a/Modules/FindHTMLHelp.cmake b/Modules/FindHTMLHelp.cmake index cf70330..9bb6ff5 100644 --- a/Modules/FindHTMLHelp.cmake +++ b/Modules/FindHTMLHelp.cmake @@ -1,9 +1,8 @@ -# -# This module looks for Microsoft HTML Help Compiler +# - This module looks for Microsoft HTML Help Compiler # It defines: -# HTML_HELP_COMPILER : full path to the HTML Help Compiler (hhc.exe) -# HTML_HELP_INCLUDE_PATH : include path to the HTML Help API (htmlhelp.h) -# HTML_HELP_LIBRARY : full path to the HTML Help library (htmlhelp.lib) +# HTML_HELP_COMPILER - path to the HTML Help Compiler (hhc.exe) +# HTML_HELP_INCLUDE_PATH - include path for HTML Help API (htmlhelp.h) +# HTML_HELP_LIBRARY - path to the HTML Help library (htmlhelp.lib) # IF (WIN32) diff --git a/Modules/FindITK.cmake b/Modules/FindITK.cmake index 40c321b..2612bd6 100644 --- a/Modules/FindITK.cmake +++ b/Modules/FindITK.cmake @@ -1,27 +1,25 @@ -# -# Find an ITK installation or build tree. -# +# - Find an ITK installation or build tree. # When ITK is found, the ITKConfig.cmake file is sourced to setup the # location and configuration of ITK. Please read this file, or # ITKConfig.cmake.in from the ITK source tree for the full list of # definitions. Of particular interest is -# -# ITK_USE_FILE - A CMake source file that can be included -# to set the include directories, library -# directories, and preprocessor macros. -# +# +# ITK_USE_FILE - A CMake source file that can be included +# to set the include directories, library +# directories, and preprocessor macros. # In addition to the variables read from ITKConfig.cmake, this find # module also defines +# ITK_DIR - The directory containing ITKConfig.cmake. This is +# either the root of the build tree, or the +# lib/InsightToolkit directory. This is the only +# cache entry. +# +# ITK_FOUND - Whether ITK was found. If this is true, ITK_DIR is okay. # -# ITK_DIR - The directory containing ITKConfig.cmake. This is either -# the root of the build tree, or the lib/InsightToolkit -# directory. This is the only cache entry. -# -# ITK_FOUND - Whether ITK was found. If this is true, ITK_DIR is okay. -# -# USE_ITK_FILE - The full path to the UseITK.cmake file. This is provided -# for backward compatability. Use ITK_USE_FILE instead. -# +# USE_ITK_FILE - The full path to the UseITK.cmake file. +# This is provided for backward compatability. +# Use ITK_USE_FILE instead. + SET(ITK_DIR_STRING "directory containing ITKConfig.cmake. This is either the root of the build tree, or PREFIX/lib/InsightToolkit for an installation.") diff --git a/Modules/FindImageMagick.cmake b/Modules/FindImageMagick.cmake index 0a3d89b..ab6f0b6 100644 --- a/Modules/FindImageMagick.cmake +++ b/Modules/FindImageMagick.cmake @@ -1,4 +1,4 @@ -# +# - Find Image Magick # This module finds if ImageMagick tools are installed and determines # where the executables are. This code sets the following variables: # diff --git a/Modules/FindJNI.cmake b/Modules/FindJNI.cmake index 70d786c..8d32ecd 100644 --- a/Modules/FindJNI.cmake +++ b/Modules/FindJNI.cmake @@ -1,8 +1,8 @@ -# +# - Find JNI java libraries. # This module finds if Java is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: -# +# # JAVA_AWT_LIB_PATH = the path to where the jawt library is # JAVA_INCLUDE_PATH = the path to where jni.h can be found # JAVA_AWT_INCLUDE_PATH = the path to where jawt.h can be found diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake index ef596ed..c5cd90f 100644 --- a/Modules/FindJPEG.cmake +++ b/Modules/FindJPEG.cmake @@ -1,13 +1,11 @@ -# +# - Find JPEG # Find the native JPEG includes and library -# # This module defines -# JPEG_INCLUDE_DIR, where to find jpeglib.h, etc. -# JPEG_LIBRARIES, the libraries to link against to use JPEG. -# JPEG_FOUND, If false, do not try to use JPEG. - +# JPEG_INCLUDE_DIR, where to find jpeglib.h, etc. +# JPEG_LIBRARIES, the libraries to link against to use JPEG. +# JPEG_FOUND, If false, do not try to use JPEG. # also defined, but not for general use are -# JPEG_LIBRARY, where to find the JPEG library. +# JPEG_LIBRARY, where to find the JPEG library. FIND_PATH(JPEG_INCLUDE_DIR jpeglib.h /usr/local/include diff --git a/Modules/FindJava.cmake b/Modules/FindJava.cmake index 466e8f6..3ec18da 100644 --- a/Modules/FindJava.cmake +++ b/Modules/FindJava.cmake @@ -1,4 +1,4 @@ -# +# - Find Java # This module finds if Java is installed and determines where the # include files and libraries are. This code sets the following # variables: diff --git a/Modules/FindKDE.cmake b/Modules/FindKDE.cmake index ba2ad25..3778090 100644 --- a/Modules/FindKDE.cmake +++ b/Modules/FindKDE.cmake @@ -1,20 +1,17 @@ -# Locate KDE include paths and libraries - -# KDE_INCLUDE_DIR -# KDE_LIB_DIR -# KDE_KDE_CONFIG -# KDE_DCOP_IDL -# KDE_VERSION - -#the macro ADD_DCOP_SOURCES(src_headers dest_srcs) +# - Locate KDE include paths and libraries +# KDE_INCLUDE_DIR +# KDE_LIB_DIR +# KDE_KDE_CONFIG +# KDE_DCOP_IDL +# KDE_VERSION + +# the macro ADD_DCOP_SOURCES(src_headers dest_srcs) # -#usage: -#SET(MY_APP_SOURCES main.cpp kfoo.cpp) -#SET(MY_DCOP_SOURCES kfooiface.h) -#ADD_DCOP_SOURCES(MY_DCOP_SOURCES MY_APP_SOURCES) -#and then it should work :-) - -#uses KDE_MIN_VERSION +# usage: +# SET(MY_APP_SOURCES main.cpp kfoo.cpp) +# SET(MY_DCOP_SOURCES kfooiface.h) +# ADD_DCOP_SOURCES(MY_DCOP_SOURCES MY_APP_SOURCES) +# uses KDE_MIN_VERSION CMAKE_MINIMUM_REQUIRED(VERSION 2.0.0) diff --git a/Modules/FindLATEX.cmake b/Modules/FindLATEX.cmake index b9e9692..d7e37e3 100644 --- a/Modules/FindLATEX.cmake +++ b/Modules/FindLATEX.cmake @@ -1,7 +1,7 @@ -# +# - Find Latex # This module finds if Latex is installed and determines where the # executables are. This code sets the following variables: -# +# # LATEX_COMPILER = the full path to the LaTeX compiler # PDFLATEX_COMPILER = the full path to the PdfLaTeX compiler # BIBTEX_COMPILER = the full path to the BibTeX compiler diff --git a/Modules/FindMFC.cmake b/Modules/FindMFC.cmake index b297411..f5fa606 100644 --- a/Modules/FindMFC.cmake +++ b/Modules/FindMFC.cmake @@ -1,7 +1,6 @@ -# +# - Find MFC on Windows # Find the native MFC - i.e. decide if this is an MS VC box. -# -# MFC_FOUND - Do not attempt to use MFC if "no" or undefined. +# MFC_FOUND - Do not attempt to use MFC if "no" or undefined. # You don't need to include anything or link anything to use it. # Assume no MFC support diff --git a/Modules/FindMPEG.cmake b/Modules/FindMPEG.cmake index 734c4f0..465e151 100644 --- a/Modules/FindMPEG.cmake +++ b/Modules/FindMPEG.cmake @@ -1,14 +1,11 @@ -# -# Find the native MPEG includes and library -# +# - Find the native MPEG includes and library # This module defines -# MPEG_INCLUDE_DIR, where to find MPEG.h, etc. -# MPEG_LIBRARIES, the libraries to link against to use MPEG. -# MPEG_FOUND, If false, do not try to use MPEG. - +# MPEG_INCLUDE_DIR, where to find MPEG.h, etc. +# MPEG_LIBRARIES, the libraries to link against to use MPEG. +# MPEG_FOUND, If false, do not try to use MPEG. # also defined, but not for general use are -# MPEG_mpeg2_LIBRARY, where to find the MPEG library. -# MPEG_vo_LIBRARY, where to find the vo library. +# MPEG_mpeg2_LIBRARY, where to find the MPEG library. +# MPEG_vo_LIBRARY, where to find the vo library. FIND_PATH(MPEG_INCLUDE_DIR mpeg2dec/include/video_out.h /usr/local/include diff --git a/Modules/FindMPEG2.cmake b/Modules/FindMPEG2.cmake index 21e0724..4c6e008 100644 --- a/Modules/FindMPEG2.cmake +++ b/Modules/FindMPEG2.cmake @@ -1,14 +1,11 @@ -# -# Find the native MPEG2 includes and library -# +# - Find the native MPEG2 includes and library # This module defines -# MPEG2_INCLUDE_DIR, where to find mpeg2dec/mpeg2.h, etc. -# MPEG2_LIBRARIES, the libraries to link against to use MPEG2. -# MPEG2_FOUND, If false, do not try to use MPEG2. - +# MPEG2_INCLUDE_DIR, where to find mpeg2dec/mpeg2.h, etc. +# MPEG2_LIBRARIES, the libraries to link against to use MPEG2. +# MPEG2_FOUND, If false, do not try to use MPEG2. # also defined, but not for general use are -# MPEG2_mpeg2_LIBRARY, where to find the MPEG2 library. -# MPEG2_vo_LIBRARY, where to find the vo library. +# MPEG2_mpeg2_LIBRARY, where to find the MPEG2 library. +# MPEG2_vo_LIBRARY, where to find the vo library. FIND_PATH(MPEG2_INCLUDE_DIR mpeg2.h /usr/local/include diff --git a/Modules/FindMPI.cmake b/Modules/FindMPI.cmake index 1f2013a..049f32d 100644 --- a/Modules/FindMPI.cmake +++ b/Modules/FindMPI.cmake @@ -1,10 +1,8 @@ -# -# this module look sfor MPI (Message Passing Interface) support +# - Find MPI +# This module looks for MPI (Message Passing Interface) support # it will define the following values -# -# MPI_INCLUDE_PATH = where mpi.h can be found -# MPI_LIBRARY = the library to link against (mpi mpich etc) -# +# MPI_INCLUDE_PATH = where mpi.h can be found +# MPI_LIBRARY = the library to link against (mpi mpich etc) FIND_PATH(MPI_INCLUDE_PATH mpi.h /usr/local/include @@ -24,6 +22,6 @@ FIND_LIBRARY(MPI_EXTRA_LIBRARY NAMES mpi++ PATHS /usr/lib /usr/local/lib /usr/local/mpi/lib "C:/Program Files/MPICH/SDK/Lib" - DOC "If a second mpi library is necessary, specify it here.") + DOC "If a second mpi library is necessary, specify it here.") MARK_AS_ADVANCED(MPI_INCLUDE_PATH MPI_LIBRARY MPI_EXTRA_LIBRARY) diff --git a/Modules/FindMatlab.cmake b/Modules/FindMatlab.cmake index 8a694c9..09fe88a 100644 --- a/Modules/FindMatlab.cmake +++ b/Modules/FindMatlab.cmake @@ -1,12 +1,10 @@ -# -# this module looks for Matlab -# -# Define -# MATLAB_INCLUDE_DIR points to the include path for mex.h, engine.h -# MATLAB_LIBRARIES list of libraries need: libmex.lib, libmx.lib and libeng.lib -# MATLAB_MEX_LIBRARY point to libmex.lib -# MATLAB_MX_LIBRARY point to libmx.lib -# MATLAB_ENG_LIBRARY point to libeng.lib +# - this module looks for Matlab +# Defines: +# MATLAB_INCLUDE_DIR points to the include path for mex.h, engine.h +# MATLAB_LIBRARIES list of libraries need: libmex.lib, libmx.lib and libeng.lib +# MATLAB_MEX_LIBRARY point to libmex.lib +# MATLAB_MX_LIBRARY point to libmx.lib +# MATLAB_ENG_LIBRARY point to libeng.lib SET(MATLAB_FOUND 0) diff --git a/Modules/FindMotif.cmake b/Modules/FindMotif.cmake index 6c437c3..6700e7e 100644 --- a/Modules/FindMotif.cmake +++ b/Modules/FindMotif.cmake @@ -1,9 +1,8 @@ -# Try to find Motif (or lesstif) -# Once done this will define -# -# MOTIF_FOUND - system has MOTIF -# MOTIF_INCLUDE_DIR - where the Motif include directory can be found -# MOTIF_LIBRARIES - Link these to use Motif +# - Try to find Motif (or lesstif) +# Once done this will define: +# MOTIF_FOUND - system has MOTIF +# MOTIF_INCLUDE_DIR - where the Motif include directory can be found +# MOTIF_LIBRARIES - Link these to use Motif SET(MOTIF_FOUND 0) IF(UNIX) diff --git a/Modules/FindOpenAL.cmake b/Modules/FindOpenAL.cmake index 5c6d957..2903b88 100644 --- a/Modules/FindOpenAL.cmake +++ b/Modules/FindOpenAL.cmake @@ -1,15 +1,14 @@ -# Locate OpenAL +# - Locate OpenAL # This module defines -# OPENAL_LIBRARY -# OPENAL_FOUND, if false, do not try to link to OpenAL -# OPENAL_INCLUDE_DIR, where to find the headers -# +# OPENAL_LIBRARY +# OPENAL_FOUND, if false, do not try to link to OpenAL +# OPENAL_INCLUDE_DIR, where to find the headers +# # $OPENALDIR is an environment variable that would # correspond to the ./configure --prefix=$OPENALDIR # used in building OpenAL. -# +# # Created by Eric Wing. This was influenced by the FindSDL.cmake module. - # On OSX, this will prefer the Framework version (if found) over others. # People will have to manually change the cache values of # OPENAL_LIBRARY to override this selection. diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index c20aaaf..d8d93b7 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -1,17 +1,16 @@ -# Try to find OpenGL +# - Try to find OpenGL # Once done this will define -# -# OPENGL_FOUND - system has OpenGL and it should be used -# OPENGL_XMESA_FOUND - system has XMESA, and it should be used. -# OPENGL_GLU_FOUND - system has GLU and it should be used. -# OPENGL_INCLUDE_DIR - where the GL include directory can be found -# OPENGL_LIBRARIES - Link these to use OpenGL and GLU -# +# +# OPENGL_FOUND - system has OpenGL and it should be used +# OPENGL_XMESA_FOUND - system has XMESA, and it should be used. +# OPENGL_GLU_FOUND - system has GLU and it should be used. +# OPENGL_INCLUDE_DIR - where the GL include directory can be found +# OPENGL_LIBRARIES - Link these to use OpenGL and GLU +# # If you want to use just GL you can use these values -# OPENGL_gl_LIBRARY - Path to OpenGL Library -# OPENGL_glu_LIBRARY - Path to GLU Library -# - +# OPENGL_gl_LIBRARY - Path to OpenGL Library +# OPENGL_glu_LIBRARY - Path to GLU Library +# # On OSX default to using the framework version of opengl # People will have to change the cache values of OPENGL_glu_LIBRARY # and OPENGL_gl_LIBRARY to use OpenGL with X11 on OSX diff --git a/Modules/FindPHP4.cmake b/Modules/FindPHP4.cmake index e38413f..a58bbab 100644 --- a/Modules/FindPHP4.cmake +++ b/Modules/FindPHP4.cmake @@ -1,4 +1,4 @@ -# +# - Find PHP4 # This module finds if PHP4 is installed and determines where the include files # and libraries are. It also determines what the name of the library is. This # code sets the following variables: diff --git a/Modules/FindPNG.cmake b/Modules/FindPNG.cmake index 3ddf05e..387be32 100644 --- a/Modules/FindPNG.cmake +++ b/Modules/FindPNG.cmake @@ -1,18 +1,14 @@ -# -# Find the native PNG includes and library +# - Find the native PNG includes and library # # This module defines -# PNG_INCLUDE_DIR, where to find png.h, etc. -# PNG_LIBRARIES, the libraries to link against to use PNG. -# PNG_DEFINITIONS - You should ADD_DEFINITONS(${PNG_DEFINITIONS}) before compiling code that includes png library files. -# PNG_FOUND, If false, do not try to use PNG. - +# PNG_INCLUDE_DIR, where to find png.h, etc. +# PNG_LIBRARIES, the libraries to link against to use PNG. +# PNG_DEFINITIONS - You should ADD_DEFINITONS(${PNG_DEFINITIONS}) before compiling code that includes png library files. +# PNG_FOUND, If false, do not try to use PNG. # also defined, but not for general use are -# PNG_LIBRARY, where to find the PNG library. - +# PNG_LIBRARY, where to find the PNG library. # None of the above will be defined unles zlib can be found. - # PNG depends on Zlib INCLUDE(FindZLIB) diff --git a/Modules/FindPerl.cmake b/Modules/FindPerl.cmake index 06fe6a3..71f49af 100644 --- a/Modules/FindPerl.cmake +++ b/Modules/FindPerl.cmake @@ -1,8 +1,8 @@ -# +# - Find perl # this module looks for Perl # -# PERL_EXECUTABLE - the full path to the Perl interpreter -# PERL_FOUND - If false, don't attempt to use perl. +# PERL_EXECUTABLE - the full path to the Perl interpreter +# PERL_FOUND - If false, don't attempt to use perl. INCLUDE(FindCygwin) diff --git a/Modules/FindPerlLibs.cmake b/Modules/FindPerlLibs.cmake index dfdc47f..3372d85 100644 --- a/Modules/FindPerlLibs.cmake +++ b/Modules/FindPerlLibs.cmake @@ -1,4 +1,4 @@ -# +# - Find Perl libraries # This module finds if PERL is installed and determines where the include files # and libraries are. It also determines what the name of the library is. This # code sets the following variables: diff --git a/Modules/FindPhysFS.cmake b/Modules/FindPhysFS.cmake index dda6577..c56a72b 100644 --- a/Modules/FindPhysFS.cmake +++ b/Modules/FindPhysFS.cmake @@ -1,8 +1,8 @@ -# Locate PhysFS library +# - Locate PhysFS library # This module defines -# PHYSFS_LIBRARY, the name of the library to link against -# PHYSFS_FOUND, if false, do not try to link to PHYSFS -# PHYSFS_INCLUDE_DIR, where to find PHYSFS/PHYSFS.h +# PHYSFS_LIBRARY, the name of the library to link against +# PHYSFS_FOUND, if false, do not try to link to PHYSFS +# PHYSFS_INCLUDE_DIR, where to find PHYSFS/PHYSFS.h # # $PHYSFSDIR is an environment variable that would # correspond to the ./configure --prefix=$PHYSFSDIR diff --git a/Modules/FindPike.cmake b/Modules/FindPike.cmake index 06f04b9..946df52 100644 --- a/Modules/FindPike.cmake +++ b/Modules/FindPike.cmake @@ -1,4 +1,4 @@ -# +# - Find Pike # This module finds if PIKE is installed and determines where the include files # and libraries are. It also determines what the name of the library is. This # code sets the following variables: diff --git a/Modules/FindPythonInterp.cmake b/Modules/FindPythonInterp.cmake index 1304aab..bf89a08 100644 --- a/Modules/FindPythonInterp.cmake +++ b/Modules/FindPythonInterp.cmake @@ -1,4 +1,4 @@ -# +# - Find python interpreter # This module finds if Python interpreter is installed and determines where the # executables are. This code sets the following variables: # diff --git a/Modules/FindPythonLibs.cmake b/Modules/FindPythonLibs.cmake index df9b0fd..acf3f84 100644 --- a/Modules/FindPythonLibs.cmake +++ b/Modules/FindPythonLibs.cmake @@ -1,4 +1,4 @@ -# +# - Find python libraries # This module finds if Python is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: diff --git a/Modules/FindQt.cmake b/Modules/FindQt.cmake index 4ee56f8..82af7cd 100644 --- a/Modules/FindQt.cmake +++ b/Modules/FindQt.cmake @@ -1,21 +1,22 @@ -# searches for all installed versions of QT. +# - Searches for all installed versions of QT. # This should only be used if your project can work with multiple # versions of QT. If not, you should just directly use FindQt4 or FindQt3. -# -# If multiple versions of QT are found on the machine, then -# The user must set the option DESIRED_QT_VERSION to the version -# they want to use. If only one version of qt is found on the machine, -# then the DESIRED_QT_VERSION is set to that version and the -# matching FindQt3 or FindQt4 module is included. -# Once the user sets DESIRED_QT_VERSION, then the FindQt3 or FindQt4 module -# is included. +# If multiple versions of QT are found on the machine, then +# The user must set the option DESIRED_QT_VERSION to the version +# they want to use. If only one version of qt is found on the machine, +# then the DESIRED_QT_VERSION is set to that version and the +# matching FindQt3 or FindQt4 module is included. +# Once the user sets DESIRED_QT_VERSION, then the FindQt3 or FindQt4 module +# is included. # -# QT_REQUIRED if this is set to TRUE then if cmake can not find QT4 or QT3 -# an error is raised and a message is sent to the user. +# QT_REQUIRED if this is set to TRUE then if CMake can not find +# QT4 or QT3 an error is raised and a message is sent +# to the user. # DESIRED_QT_VERSION OPTION is created # QT4_INSTALLED is set to TRUE if qt4 is found. # QT3_INSTALLED is set to TRUE if qt3 is found. + # look for signs of qt3 installations FILE(GLOB GLOB_TEMP_VAR /usr/lib/qt-3*/bin/qmake) IF(GLOB_TEMP_VAR) diff --git a/Modules/FindQt3.cmake b/Modules/FindQt3.cmake index b58519f..f1230e6 100644 --- a/Modules/FindQt3.cmake +++ b/Modules/FindQt3.cmake @@ -1,23 +1,23 @@ -# Locate Qt include paths and libraries +# - Locate Qt include paths and libraries # This module defines -# QT_INCLUDE_DIR, where to find qt.h, etc. -# QT_LIBRARIES, the libraries to link against to use Qt. -# QT_DEFINITIONS, definitions to use when compiling code that uses Qt. -# QT_FOUND, If false, don't try to use Qt. +# QT_INCLUDE_DIR, where to find qt.h, etc. +# QT_LIBRARIES, the libraries to link against to use Qt. +# QT_DEFINITIONS, definitions to use when compiling code that uses Qt. +# QT_FOUND, If false, don't try to use Qt. -#if you need the multithreaded version of Qt, set QT_MT_REQUIRED to TRUE +# if you need the multithreaded version of Qt, set QT_MT_REQUIRED to TRUE # also defined, but not for general use are -# QT_MOC_EXECUTABLE, where to find the moc tool. -# QT_UIC_EXECUTABLE, where to find the uic tool. -# QT_QT_LIBRARY, where to find the Qt library. -# QT_QTMAIN_LIBRARY, where to find the qtmain library. This is only required by Qt3 on Windows. +# QT_MOC_EXECUTABLE, where to find the moc tool. +# QT_UIC_EXECUTABLE, where to find the uic tool. +# QT_QT_LIBRARY, where to find the Qt library. +# QT_QTMAIN_LIBRARY, where to find the qtmain library. This is only required by Qt3 on Windows. # These are around for backwards compatibility # they will be set -# QT_WRAP_CPP, set true if QT_MOC_EXECUTABLE is found -# QT_WRAP_UI set true if QT_UIC_EXECUTABLE is found +# QT_WRAP_CPP, set true if QT_MOC_EXECUTABLE is found +# QT_WRAP_UI set true if QT_UIC_EXECUTABLE is found FILE(GLOB GLOB_PATHS_BIN /usr/lib/qt-3*/bin/) FIND_PATH(QT_INCLUDE_DIR qt.h diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake index 6dc84c1..ec50c88 100644 --- a/Modules/FindQt4.cmake +++ b/Modules/FindQt4.cmake @@ -1,115 +1,113 @@ -######################################################################## -# -# Locates Qt4 include paths and libraries -# -######################################################################## - -# This module defines -# QT_USE_FILE A CMake file that can be included to compile -# Qt 4 applications and libraries. By default, -# the QtCore and QtGui libraries are loaded. -# This behavior can be changed by setting one -# or more of the following variables to true: -# QT_DONT_USE_QTCORE -# QT_DONT_USE_QTGUI -# QT_USE_QT3SUPPORT -# QT_USE_QTASSISTANT -# QT_USE_QTDESIGNER -# QT_USE_QTMOTIF -# QT_USE_QTNETWORK -# QT_USE_QTNSPLUGIN -# QT_USE_QTOPENGL -# QT_USE_QTSQL -# QT_USE_QTXML -# All the libraries required are stored in a -# variable called QT_LIBRARIES. Add this variable -# to your TARGET_LINK_LIBRARIES. -# -# macro QT4_WRAP_CPP(outfiles inputfile ... ) -# macro QT4_WRAP_UI(outfiles inputfile ... ) -# macro QT4_ADD_RESOURCE(outfiles inputfile ... ) -# -# QT_FOUND If false, don't try to use Qt. -# QT4_FOUND If false, don't try to use Qt 4. -# -# QT_QTCORE_FOUND True if QtCore includes and library found. -# QT_QTGUI_FOUND True if QtGui includes and library found. -# QT_QT3SUPPORT_FOUND True if Qt3Support includes and library found. -# QT_QTASSISTANT_FOUND True if QtAssistant includes and library found. -# QT_QTDESIGNER_FOUND True if QtDesigner includes and library found. -# QT_QTMOTIF_FOUND True if QtMotif includes and library found. -# QT_QTNETWORK_FOUND True if QtNetwork includes and library found. -# QT_QTNSPLUGIN_FOUND True if QtNsPlugin includes and library found. -# QT_QTOPENGL_FOUND True if QtOpenGL includes and library found. -# QT_QTSQL_FOUND True if QtSql includes and library found. -# QT_QTXML_FOUND True if QtXml includes and library found. -# -# QT_DEFINITIONS Definitions to use when compiling code that -# uses Qt. -# -# QT_INCLUDES List of paths to all include directories of -# Qt4 QT_INCLUDE_DIR, QT_QT_INCLUDE_DIR, and QT_QTGUI_INCLUDE_DIR are -# always in this variable even if NOTFOUND, all other INCLUDE_DIRS are -# only added if they are found. -# -# QT_INCLUDE_DIR Path to "include" of Qt4 -# QT_QT_INCLUDE_DIR Path to "include/Qt" of Qt4 -# QT_QT3SUPPORT_INCLUDE_DIR Path to "include/Qt3Support" of Qt -# QT_QTASSISTANT_INCLUDE_DIR Path to "include/QtAssistant" of Qt4 -# QT_QTCORE_INCLUDE_DIR Path to "include/QtCore" of Qt4 -# QT_QTDESIGNER_INCLUDE_DIR Path to "include/QtDesigner" of Qt4 -# QT_QTGUI_INCLUDE_DIR Path to "include/QtGui" of Qt4 -# QT_QTMOTIF_INCLUDE_DIR Path to "include/QtMotif" of Qt4 -# QT_QTNETWORK_INCLUDE_DIR Path to "include/QtNetwork" of Qt4 -# QT_QTNSPLUGIN_INCLUDE_DIR Path to "include/QtNsPlugin" of Qt4 -# QT_QTOPENGL_INCLUDE_DIR Path to "include/QtOpenGL" of Qt4 -# QT_QTSQL_INCLUDE_DIR Path to "include/QtSql" of Qt4 -# QT_QTXML_INCLUDE_DIR Path to "include/QtXml" of Qt4 -# -# QT_LIBRARY_DIR Path to "lib" of Qt4 -# -# QT_QT3SUPPORT_LIBRARY Path+filename for Qt3Support library of Qt4 -# QT_QTASSISTANT_LIBRARY Path+filename for QtAssistant library of Qt4 -# QT_QTCORE_LIBRARY Path+filename for QtCore library of Qt4 -# QT_QTDESIGNER_LIBRARY Path+filename for QtDesigner library of Qt4 -# QT_QTGUI_LIBRARY Path+filename for QtGui library of Qt4 -# QT_QTMOTIF_LIBRARY Path+filename for QtMotif library of Qt4 -# QT_QTNETWORK_LIBRARY Path+filename for QtNetwork library of Qt4 -# QT_QTNSPLUGIN_LIBRARY Path+filename for QtNsPlugin library of Qt4 -# QT_QTOPENGL_LIBRARY Path+filename for QtOpenGL library of Qt4 -# QT_QTSQL_LIBRARY Path+filename for QtSql library of Qt4 -# QT_QTXML_LIBRARY Path+filename for QtXml library of Qt4 -# -# QT_QT3SUPPORT_LIBRARY_DEBUG Path+filename for Qt3Support_debug library of Qt -# QT_QTASSISTANT_LIBRARY_DEBUG Path+filename for QtAssistant_debug library -# of Qt4 -# QT_QTCORE_LIBRARY_DEBUG Path+filename for QtCore_debug library of Qt4 -# QT_QTDESIGNER_LIBRARY_DEBUG Path+filename for QtDesigner_debug library of Qt4 -# QT_QTGUI_LIBRARY_DEBUG Path+filename for QtGui_debug library of Qt4 -# QT_QTMOTIF_LIBRARY_DEBUG Path+filename for QtMotif_debug library of Qt4 -# QT_QTNETWORK_LIBRARY_DEBUG Path+filename for QtNetwork_debug library of Qt4 -# QT_QTNSPLUGIN_LIBRARY_DEBUG Path+filename for QtNsPlugin_debug library of Qt4 -# QT_QTOPENGL_LIBRARY_DEBUG Path+filename for QtOpenGL_debug library of Qt4 -# QT_QTSQL_LIBRARY_DEBUG Path+filename for QtSql_debug library of Qt4 -# QT_QTXML_LIBRARY_DEBUG Path+filename for QtXml_debug library of Qt4 -# +# - Find QT 4 +# This module can be used to find Qt4. +# This module defines: +# QT_USE_FILE A CMake file that can be included to compile +# Qt 4 applications and libraries. By default, +# the QtCore and QtGui libraries are loaded. +# This behavior can be changed by setting one +# or more of the following variables to true: +# QT_DONT_USE_QTCORE +# QT_DONT_USE_QTGUI +# QT_USE_QT3SUPPORT +# QT_USE_QTASSISTANT +# QT_USE_QTDESIGNER +# QT_USE_QTMOTIF +# QT_USE_QTNETWORK +# QT_USE_QTNSPLUGIN +# QT_USE_QTOPENGL +# QT_USE_QTSQL +# QT_USE_QTXML +# All the libraries required are stored in a +# variable called QT_LIBRARIES. Add this +# variable to your TARGET_LINK_LIBRARIES. +# +# macro QT4_WRAP_CPP(outfiles inputfile ... ) +# macro QT4_WRAP_UI(outfiles inputfile ... ) +# macro QT4_ADD_RESOURCE(outfiles inputfile ... ) +# +# QT_FOUND If false, don't try to use Qt. +# QT4_FOUND If false, don't try to use Qt 4. +# +# QT_QTCORE_FOUND True if QtCore was found. +# QT_QTGUI_FOUND True if QtGui was found. +# QT_QT3SUPPORT_FOUND True if Qt3Support was found. +# QT_QTASSISTANT_FOUND True if QtAssistant was found. +# QT_QTDESIGNER_FOUND True if QtDesigner was found. +# QT_QTMOTIF_FOUND True if QtMotif was found. +# QT_QTNETWORK_FOUND True if QtNetwork was found. +# QT_QTNSPLUGIN_FOUND True if QtNsPlugin was found. +# QT_QTOPENGL_FOUND True if QtOpenGL was found. +# QT_QTSQL_FOUND True if QtSql was found. +# QT_QTXML_FOUND True if QtXml was found. +# +# QT_DEFINITIONS Definitions to use when compiling code that +# uses Qt. +# +# QT_INCLUDES List of paths to all include directories of +# Qt4 QT_INCLUDE_DIR, QT_QT_INCLUDE_DIR, +# and QT_QTGUI_INCLUDE_DIR are +# always in this variable even if NOTFOUND, +# all other INCLUDE_DIRS are +# only added if they are found. +# +# QT_INCLUDE_DIR Path to "include" of Qt4 +# QT_QT_INCLUDE_DIR Path to "include/Qt" +# QT_QT3SUPPORT_INCLUDE_DIR Path to "include/Qt3Support" +# QT_QTASSISTANT_INCLUDE_DIR Path to "include/QtAssistant" +# QT_QTCORE_INCLUDE_DIR Path to "include/QtCore" +# QT_QTDESIGNER_INCLUDE_DIR Path to "include/QtDesigner" +# QT_QTGUI_INCLUDE_DIR Path to "include/QtGui" +# QT_QTMOTIF_INCLUDE_DIR Path to "include/QtMotif" +# QT_QTNETWORK_INCLUDE_DIR Path to "include/QtNetwork" +# QT_QTNSPLUGIN_INCLUDE_DIR Path to "include/QtNsPlugin" +# QT_QTOPENGL_INCLUDE_DIR Path to "include/QtOpenGL" +# QT_QTSQL_INCLUDE_DIR Path to "include/QtSql" +# QT_QTXML_INCLUDE_DIR Path to "include/QtXml" +# +# QT_LIBRARY_DIR Path to "lib" of Qt4 +# +# QT_QT3SUPPORT_LIBRARY Fullpath to Qt3Support library +# QT_QTASSISTANT_LIBRARY Fullpath to QtAssistant library +# QT_QTCORE_LIBRARY Fullpath to QtCore library +# QT_QTDESIGNER_LIBRARY Fullpath to QtDesigner library +# QT_QTGUI_LIBRARY Fullpath to QtGui library +# QT_QTMOTIF_LIBRARY Fullpath to QtMotif library +# QT_QTNETWORK_LIBRARY Fullpath to QtNetwork library +# QT_QTNSPLUGIN_LIBRARY Fullpath to QtNsPlugin library +# QT_QTOPENGL_LIBRARY Fullpath to QtOpenGL library +# QT_QTSQL_LIBRARY Fullpath to QtSql library +# QT_QTXML_LIBRARY Fullpath to QtXml library +# +# QT_QT3SUPPORT_LIBRARY_DEBUG Fullpath to Qt3Support_debug library +# QT_QTASSISTANT_LIBRARY_DEBUG Fullpath to QtAssistant_debug library +# +# QT_QTCORE_LIBRARY_DEBUG Fullpath to QtCore_debug +# QT_QTDESIGNER_LIBRARY_DEBUG Fullpath to QtDesigner_debug +# QT_QTGUI_LIBRARY_DEBUG Fullpath to QtGui_debug +# QT_QTMOTIF_LIBRARY_DEBUG Fullpath to QtMotif_debug +# QT_QTNETWORK_LIBRARY_DEBUG Fullpath to QtNetwork_debug +# QT_QTNSPLUGIN_LIBRARY_DEBUG Fullpath to QtNsPlugin_debug +# QT_QTOPENGL_LIBRARY_DEBUG Fullpath to QtOpenGL_debug +# QT_QTSQL_LIBRARY_DEBUG Fullpath to QtSql_debug +# QT_QTXML_LIBRARY_DEBUG Fullpath to QtXml_debug +# # also defined, but not for general use are -# QT_MOC_EXECUTABLE Where to find the moc tool. -# QT_UIC_EXECUTABLE Where to find the uic tool. -# QT_RCC_EXECUTABLE Where to find the rcc tool -# +# QT_MOC_EXECUTABLE Where to find the moc tool. +# QT_UIC_EXECUTABLE Where to find the uic tool. +# QT_RCC_EXECUTABLE Where to find the rcc tool +# # These are around for backwards compatibility # they will be set -# QT_WRAP_CPP Set true if QT_MOC_EXECUTABLE is found -# QT_WRAP_UI Set true if QT_UIC_EXECUTABLE is found -# -# +# QT_WRAP_CPP Set true if QT_MOC_EXECUTABLE is found +# QT_WRAP_UI Set true if QT_UIC_EXECUTABLE is found +# # These variables do _NOT_ have any effect anymore (compared to FindQt.cmake) -# QT_MT_REQUIRED Qt4 is now always multithreaded -# -# These variables are set to "" Because Qt structure changed (They make no sence in Qt4) -# QT_QT_LIBRARY Qt-Library is now splitt into different parts -# QT_QTMAIN_LIBRARY Qt-Library is now splitt into different parts +# QT_MT_REQUIRED Qt4 is now always multithreaded +# +# These variables are set to "" Because Qt structure changed +# (They make no sence in Qt4) +# QT_QT_LIBRARY Qt-Library is now splitt +# QT_QTMAIN_LIBRARY Qt-Library is now splitt SET(QT_USE_FILE ${CMAKE_ROOT}/Modules/UseQt4.cmake) diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index dfc811a..9c79a5f 100644 --- a/Modules/FindRuby.cmake +++ b/Modules/FindRuby.cmake @@ -1,4 +1,4 @@ -# +# - Find ruby # This module finds if RUBY is installed and determines where the include files # and libraries are. It also determines what the name of the library is. This # code sets the following variables: diff --git a/Modules/FindSDL.cmake b/Modules/FindSDL.cmake index 9ffcce3..b7a1c6d 100644 --- a/Modules/FindSDL.cmake +++ b/Modules/FindSDL.cmake @@ -1,14 +1,13 @@ -# Locate SDL library +# - Locate SDL library # This module defines -# SDL_LIBRARY, the name of the library to link against -# SDL_FOUND, if false, do not try to link to SDL -# SDL_INCLUDE_DIR, where to find SDL.h +# SDL_LIBRARY, the name of the library to link against +# SDL_FOUND, if false, do not try to link to SDL +# SDL_INCLUDE_DIR, where to find SDL.h # # Don't forget to include SDLmain.h and SDLmain.m your project for the # OS X framework based version. (Other versions link to -lSDLmain which # this module will try to find on your behalf.) Also for OS X, this # module will automatically add the -framework Cocoa on your behalf. -# # $SDLDIR is an environment variable that would # correspond to the ./configure --prefix=$SDLDIR # used in building SDL. diff --git a/Modules/FindSDL_image.cmake b/Modules/FindSDL_image.cmake index 604b6a9..b09d231 100644 --- a/Modules/FindSDL_image.cmake +++ b/Modules/FindSDL_image.cmake @@ -1,8 +1,8 @@ -# Locate SDL_image library +# - Locate SDL_image library # This module defines -# SDLIMAGE_LIBRARY, the name of the library to link against -# SDLIMAGE_FOUND, if false, do not try to link to SDL -# SDLIMAGE_INCLUDE_DIR, where to find SDL/SDL.h +# SDLIMAGE_LIBRARY, the name of the library to link against +# SDLIMAGE_FOUND, if false, do not try to link to SDL +# SDLIMAGE_INCLUDE_DIR, where to find SDL/SDL.h # # $SDLDIR is an environment variable that would # correspond to the ./configure --prefix=$SDLDIR diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake index 9b09b39..6c27f1c 100644 --- a/Modules/FindSDL_mixer.cmake +++ b/Modules/FindSDL_mixer.cmake @@ -1,8 +1,8 @@ -# Locate SDL_mixer library +# - Locate SDL_mixer library # This module defines -# SDLMIXER_LIBRARY, the name of the library to link against -# SDLMIXER_FOUND, if false, do not try to link to SDL -# SDLMIXER_INCLUDE_DIR, where to find SDL/SDL.h +# SDLMIXER_LIBRARY, the name of the library to link against +# SDLMIXER_FOUND, if false, do not try to link to SDL +# SDLMIXER_INCLUDE_DIR, where to find SDL/SDL.h # # $SDLDIR is an environment variable that would # correspond to the ./configure --prefix=$SDLDIR diff --git a/Modules/FindSDL_net.cmake b/Modules/FindSDL_net.cmake index b643f9a..f5296cd 100644 --- a/Modules/FindSDL_net.cmake +++ b/Modules/FindSDL_net.cmake @@ -1,17 +1,16 @@ -# Locate SDL_net library +# - Locate SDL_net library # This module defines -# SDLNET_LIBRARY, the name of the library to link against -# SDLNET_FOUND, if false, do not try to link against -# SDLNET_INCLUDE_DIR, where to find the headers -# +# SDLNET_LIBRARY, the name of the library to link against +# SDLNET_FOUND, if false, do not try to link against +# SDLNET_INCLUDE_DIR, where to find the headers +# # $SDLDIR is an environment variable that would # correspond to the ./configure --prefix=$SDLDIR # used in building SDL. -# +# # Created by Eric Wing. This was influenced by the FindSDL.cmake # module, but with modifications to recognize OS X frameworks and # additional Unix paths (FreeBSD, etc). - # On OSX, this will prefer the Framework version (if found) over others. # People will have to manually change the cache values of # SDLNET_LIBRARY to override this selection. diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake index 6309b6f..025d634 100644 --- a/Modules/FindSDL_sound.cmake +++ b/Modules/FindSDL_sound.cmake @@ -1,5 +1,4 @@ -# Locates the SDL_sound library - +# - Locates the SDL_sound library # This module depends on SDL being found and # must be called AFTER FindSDL.cmake is called. @@ -12,19 +11,18 @@ # flags to SDL_SOUND_LIBRARIES. This is prepended to SDL_SOUND_LIBRARIES. # This is available mostly for cases this module failed to anticipate for # and you must add additional flags. This is marked as ADVANCED. - # # This module also defines (but you shouldn't need to use directly) # SDL_SOUND_LIBRARY, the name of just the SDL_sound library you would link # against. Use SDL_SOUND_LIBRARIES for you link instructions and not this one. # And might define the following as needed -# MIKMOD_LIBRARY -# MODPLUG_LIBRARY -# OGG_LIBRARY -# VORBIS_LIBRARY -# SMPEG_LIBRARY -# FLAC_LIBRARY -# SPEEX_LIBRARY +# MIKMOD_LIBRARY +# MODPLUG_LIBRARY +# OGG_LIBRARY +# VORBIS_LIBRARY +# SMPEG_LIBRARY +# FLAC_LIBRARY +# SPEEX_LIBRARY # # Typically, you should not use these variables directly, and you should use # SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries diff --git a/Modules/FindSDL_ttf.cmake b/Modules/FindSDL_ttf.cmake index 5523cf9..6690f5c 100644 --- a/Modules/FindSDL_ttf.cmake +++ b/Modules/FindSDL_ttf.cmake @@ -1,17 +1,15 @@ -# Locate SDL_ttf library +# - Locate SDL_ttf library # This module defines -# SDLTTF_LIBRARY, the name of the library to link against -# SDLTTF_FOUND, if false, do not try to link to SDL -# SDLTTF_INCLUDE_DIR, where to find SDL/SDL.h -# +# SDLTTF_LIBRARY, the name of the library to link against +# SDLTTF_FOUND, if false, do not try to link to SDL +# SDLTTF_INCLUDE_DIR, where to find SDL/SDL.h +# # $SDLDIR is an environment variable that would # correspond to the ./configure --prefix=$SDLDIR # used in building SDL. -# # Created by Eric Wing. This was influenced by the FindSDL.cmake # module, but with modifications to recognize OS X frameworks and # additional Unix paths (FreeBSD, etc). - # On OSX, this will prefer the Framework version (if found) over others. # People will have to manually change the cache values of # SDLTTF_LIBRARY to override this selection. diff --git a/Modules/FindSWIG.cmake b/Modules/FindSWIG.cmake index 5d2ae9b..3694ae9 100644 --- a/Modules/FindSWIG.cmake +++ b/Modules/FindSWIG.cmake @@ -1,3 +1,9 @@ +# - Find SWIG +# This module finds an installed SWIG. It sets the following variables: +# SWIG_FOUND - set to true if SWIG is found +# SWIG_DIR - the directory where swig is installed +# SWIG_EXECUTABLE - the path to the swig executable + SET(SWIG_FOUND FOOBAR) FIND_PATH(SWIG_DIR SWIGConfig.cmake diff --git a/Modules/FindSelfPackers.cmake b/Modules/FindSelfPackers.cmake index e0e2cf3..78d6e19 100644 --- a/Modules/FindSelfPackers.cmake +++ b/Modules/FindSelfPackers.cmake @@ -1,10 +1,9 @@ -# -# this module looks for some executable packers (i.e. softwares that +# - Find upx +# This module looks for some executable packers (i.e. softwares that # compress executables or shared libs into on-the-fly self-extracting # executables or shared libs. -# # Examples: -# UPX: http://wildsau.idv.uni-linz.ac.at/mfx/upx.html +# UPX: http://wildsau.idv.uni-linz.ac.at/mfx/upx.html INCLUDE(FindCygwin) diff --git a/Modules/FindTCL.cmake b/Modules/FindTCL.cmake index 365ab11..166c740 100644 --- a/Modules/FindTCL.cmake +++ b/Modules/FindTCL.cmake @@ -1,22 +1,20 @@ -# +# - Find Tcl includes and libraries. # This module finds if TCL is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: -# -# TCL_LIBRARY = full path to the Tcl library (tcl tcl80 etc) -# TCL_LIBRARY_DEBUG = full path to the Tcl library (debug) -# TCL_STUB_LIBRARY = full path to the Tcl stub library -# TCL_STUB_LIBRARY_DEBUG = full path to the Tcl stub library (debug) +# TCL_LIBRARY = path to Tcl library (tcl tcl80) +# TCL_LIBRARY_DEBUG = path to Tcl library (debug) +# TCL_STUB_LIBRARY = path to Tcl stub library +# TCL_STUB_LIBRARY_DEBUG = path to Tcl stub library (debug) # TCL_INCLUDE_PATH = path to where tcl.h can be found -# TCL_TCLSH = full path to the tclsh binary (tcl tcl80 etc) -# TK_LIBRARY = full path to the Tk library (tk tk80 etc) -# TK_LIBRARY_DEBUG = full path to the Tk library (debug) -# TK_STUB_LIBRARY = full path to the Tk stub library -# TK_STUB_LIBRARY_DEBUG = full path to the Tk stub library (debug) +# TCL_TCLSH = path to tclsh binary (tcl tcl80) +# TK_LIBRARY = path to Tk library (tk tk80 etc) +# TK_LIBRARY_DEBUG = path to Tk library (debug) +# TK_STUB_LIBRARY = path to Tk stub library +# TK_STUB_LIBRARY_DEBUG = path to Tk stub library (debug) # TK_INCLUDE_PATH = path to where tk.h can be found # TK_INTERNAL_PATH = path to where tkWinInt.h can be found -# TK_WISH = full path to the wish binary (wish wish80 etc) -# +# TK_WISH = full path to the wish (wish wish80) INCLUDE(CMakeFindFrameworks) INCLUDE(FindTclsh) diff --git a/Modules/FindTIFF.cmake b/Modules/FindTIFF.cmake index 46b55eb..90d0b78 100644 --- a/Modules/FindTIFF.cmake +++ b/Modules/FindTIFF.cmake @@ -1,13 +1,12 @@ -# +# - Find TIFF library # Find the native TIFF includes and library # # This module defines -# TIFF_INCLUDE_DIR, where to find tiff.h, etc. -# TIFF_LIBRARIES, the libraries to link against to use TIFF. -# TIFF_FOUND, If false, do not try to use TIFF. - +# TIFF_INCLUDE_DIR, where to find tiff.h, etc. +# TIFF_LIBRARIES, the libraries to link against to use TIFF. +# TIFF_FOUND, If false, do not try to use TIFF. # also defined, but not for general use are -# TIFF_LIBRARY, where to find the TIFF library. +# TIFF_LIBRARY, where to find the TIFF library. FIND_PATH(TIFF_INCLUDE_DIR tiff.h /usr/local/include diff --git a/Modules/FindTclsh.cmake b/Modules/FindTclsh.cmake index dec264b..f75a6f2 100644 --- a/Modules/FindTclsh.cmake +++ b/Modules/FindTclsh.cmake @@ -1,11 +1,8 @@ -# +# - Find tclsh # This module finds if TCL is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: -# # TCL_TCLSH = the full path to the tclsh binary (tcl tcl80 etc) -# - # In cygwin, look for the cygwin version first. Don't look for it later to # avoid finding the cygwin version on a Win32 build. IF(WIN32) diff --git a/Modules/FindThreads.cmake b/Modules/FindThreads.cmake index ad6080e..95e5aa8 100644 --- a/Modules/FindThreads.cmake +++ b/Modules/FindThreads.cmake @@ -1,10 +1,10 @@ -# This module determines the thread library of the system. +# - This module determines the thread library of the system. # The following variables are set -# CMAKE_THREAD_LIBS_INIT - the thread library to link into an application (-lpthread ) -# CMAKE_USE_SPROC_INIT - are we using sproc? -# CMAKE_USE_WIN32_THREADS_INIT - are we using WIN32 threads -# CMAKE_USE_PTHREADS_INIT - are we using pthreads -# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads +# CMAKE_THREAD_LIBS_INIT - the thread library (-lpthread ) +# CMAKE_USE_SPROC_INIT - are we using sproc? +# CMAKE_USE_WIN32_THREADS_INIT - are we using WIN32 threads +# CMAKE_USE_PTHREADS_INIT - are we using pthreads +# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads INCLUDE (CheckIncludeFile) INCLUDE (CheckIncludeFiles) diff --git a/Modules/FindUnixCommands.cmake b/Modules/FindUnixCommands.cmake index 3f64348..10a0bd8 100644 --- a/Modules/FindUnixCommands.cmake +++ b/Modules/FindUnixCommands.cmake @@ -1,5 +1,5 @@ -# -# this module looks for some usual Unix commands +# - Find unix commands from cygwin +# This module looks for some usual Unix commands. # INCLUDE(FindCygwin) diff --git a/Modules/FindVTK.cmake b/Modules/FindVTK.cmake index e5f7d79..23789e4 100644 --- a/Modules/FindVTK.cmake +++ b/Modules/FindVTK.cmake @@ -1,30 +1,26 @@ -# -# Find a VTK installation or build tree. -# +# - Find a VTK installation or build tree. # The following variables are set if VTK is found. If VTK is not # found, VTK_FOUND is set to false. -# -# VTK_FOUND - Set to true when VTK is found. -# VTK_USE_FILE - CMake source file to setup a project to use VTK. -# VTK_MAJOR_VERSION - The VTK major version number. -# VTK_MINOR_VERSION - The VTK minor version number (odd for non-release). -# VTK_BUILD_VERSION - The VTK patch level (meaningless for odd minor). -# VTK_INCLUDE_DIRS - Include directories for VTK headers. -# VTK_LIBRARY_DIRS - Link directories for VTK libraries. -# VTK_KITS - List of VTK kits, in all CAPS (COMMON, IO, ...). -# VTK_LANGUAGES - List of wrapped languages, in all CAPS (TCL, ...). -# +# VTK_FOUND - Set to true when VTK is found. +# VTK_USE_FILE - CMake file to setup a project to use VTK. +# VTK_MAJOR_VERSION - The VTK major version number. +# VTK_MINOR_VERSION - The VTK minor version number +# (odd non-release). +# VTK_BUILD_VERSION - The VTK patch level +# (meaningless for odd minor). +# VTK_INCLUDE_DIRS - Include directories for VTK headers. +# VTK_LIBRARY_DIRS - Link directories for VTK libraries. +# VTK_KITS - List of VTK kits, in CAPS (COMMON,IO,). +# VTK_LANGUAGES - List of wrapped languages, in CAPS (TCL,) # The following cache entries must be set by the user to locate VTK: -# -# VTK_DIR - The directory containing VTKConfig.cmake. This is either -# the root of the build tree, or the lib/vtk -# directory. This is the only cache entry. -# -# The following variables are set for backward compatability and +# VTK_DIR - The directory containing VTKConfig.cmake. This +# is either the root of the build tree, or the +# lib/vtk directory. This is the only cache entry. +# The following variables are set for backward compatibility and # should not be used in new code: -# -# USE_VTK_FILE - The full path to the UseVTK.cmake file. This is provided -# for backward compatability. Use VTK_USE_FILE instead. +# USE_VTK_FILE - The full path to the UseVTK.cmake file. This +# is provided for backward compatability. Use +# VTK_USE_FILE instead. # # Construct consitent error messages for use below. diff --git a/Modules/FindWget.cmake b/Modules/FindWget.cmake index a94c491..f6804b9 100644 --- a/Modules/FindWget.cmake +++ b/Modules/FindWget.cmake @@ -1,9 +1,9 @@ -# -# this module looks for wget +# - Find wget +# This module looks for wget. # -# This module defines the following values -# WGET_EXECUTABLE: This variable defines the full path to the wget tool. -# WGET_FOUND: True if wget has been found. +# This module defines the following values: +# WGET_EXECUTABLE: This variable defines the full path to the wget tool. +# WGET_FOUND: True if wget has been found. INCLUDE(FindCygwin) diff --git a/Modules/FindWish.cmake b/Modules/FindWish.cmake index 16cbd8f..5f62c64 100644 --- a/Modules/FindWish.cmake +++ b/Modules/FindWish.cmake @@ -1,11 +1,10 @@ -# +# - Find wish installation # This module finds if TCL is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: # # TK_WISH = the full path to the wish binary (wish wish80 etc) # - # if UNIX is defined, then look for the cygwin version first IF(UNIX) FIND_PROGRAM(TK_WISH cygwish80 ) diff --git a/Modules/FindX11.cmake b/Modules/FindX11.cmake index a804b79..acf174f 100644 --- a/Modules/FindX11.cmake +++ b/Modules/FindX11.cmake @@ -1,10 +1,10 @@ -# -# try to find X11 on UNIX systems. +# - Find X11 installation +# Try to find X11 on UNIX systems. # # The following values are defined -# X11_FOUND - True if X11 is available -# X11_INCLUDE_DIR - include directories to use X11 -# X11_LIBRARIES - link against these to use X11 +# X11_FOUND - True if X11 is available +# X11_INCLUDE_DIR - include directories to use X11 +# X11_LIBRARIES - link against these to use X11 IF (UNIX) SET(X11_FOUND 0) diff --git a/Modules/FindZLIB.cmake b/Modules/FindZLIB.cmake index d5bca3f..b96f58d 100644 --- a/Modules/FindZLIB.cmake +++ b/Modules/FindZLIB.cmake @@ -1,9 +1,9 @@ -# +# - Find zlib # Find the native ZLIB includes and library # -# ZLIB_INCLUDE_DIR - where to find zlib.h, etc. -# ZLIB_LIBRARIES - List of fully qualified libraries to link against when using zlib. -# ZLIB_FOUND - Do not attempt to use zlib if "no" or undefined. +# ZLIB_INCLUDE_DIR - where to find zlib.h, etc. +# ZLIB_LIBRARIES - List of libraries when using zlib. +# ZLIB_FOUND - True if zlib found. FIND_PATH(ZLIB_INCLUDE_DIR zlib.h /usr/local/include diff --git a/Modules/FindwxWindows.cmake b/Modules/FindwxWindows.cmake index 2a1eea4..dd3657a 100644 --- a/Modules/FindwxWindows.cmake +++ b/Modules/FindwxWindows.cmake @@ -1,70 +1,64 @@ -## -## This module finds if wxWindows is installed and determines where the -## include files and libraries are. It also determines what the name of -## the library is. This code sets the following variables: -## -## ------------------------------------------------------------------ -## -## WXWINDOWS_FOUND = system has WxWindows (in desired config. build) -## -## WXWINDOWS_LIBRARIES = full path to the wxWindows libraries -## on Unix/Linux with additional linker flags from -## "wx-config --libs" -## -## CMAKE_WXWINDOWS_CXX_FLAGS = Unix compiler flags for wxWindows, essentially -## "`wx-config --cxxflags`" -## -## WXWINDOWS_INCLUDE_DIR = where to find headers "wx/wx.h" "wx/setup.h" -## -## WXWINDOWS_LINK_DIRECTORIES = link directories, useful for rpath on Unix -## -## WXWINDOWS_DEFINITIONS = extra defines -## -## deprecated: -## * CMAKE_WX_CAN_COMPILE -## * WXWINDOWS_LIBRARY -## * CMAKE_WX_CXX_FLAGS -## * WXWINDOWS_INCLUDE_PATH -## -## ------------------------------------------------------------------ -## -## USAGE: -## # for convenience include Use_wxWindows.cmake in your projects -## CMakeLists.txt: -## -## # if you need OpenGL support please -## SET(WXWINDOWS_USE_GL 1) -## # in your CMakeLists.txt *before* you include this file. -## -## # just include Use_wxWindows.cmake -## # in your projects CMakeLists.txt -## INCLUDE(Use_wxWindows) -## -## ------------------------------------------------------------------ -## Author Jan Woetzel <http://www.mip.informatik.uni-kiel.de/~jw> (07/2003) -## ------------------------------------------------------------------ -## -## -changed variable names to conventions from cmakes readme.txt (Jan Woetzel -## 07/07/2003) -## -added definition WINVER for WIN32 (Jan Woetzel 07/07//2003) -## -added IF(CMAKE_WXWINDOWS_CONFIG_EXECUTABLE) found and changed -## CMAKE_WX_CONFIG to CMAKE_WXWINDOWS_CONFIG_EXECUTABLE (Jan Woetzel -## 07/22/2003) -## -removed OPTION for CMAKE_WXWINDOWS_USE_GL. Force the developer to SET it. -## -## status: -## tested with: -## -cmake 1.6.7, Linux (Suse 7.3), wxWindows 2.4.0, gcc 2.95 -## -cmake 1.6.7, Linux (Suse 8.2), wxWindows 2.4.0, gcc 3.3 -## -cmake 1.6.7, Linux (Suse 8.2), wxWindows 2.4.1-patch1, gcc 3.3 -## -cmake 1.6.7, MS Windows XP home, wxWindows 2.4.1, MS Visual Studio .net 7 -## 2002 (static build) -## -## TODO: -## -OPTION for unicode builds -## -change WXWINDOWS_USE_GL to use FindOpenGL.cmake or let the user do it -## -testing of DLL linking under MS WIN32 -## +# - Find wxWindows installation +# This module finds if wxWindows is installed and determines where the +# include files and libraries are. It also determines what the name of +# the library is. This code sets the following variables: +# +# WXWINDOWS_FOUND = system has WxWindows +# WXWINDOWS_LIBRARIES = full path to the wxWindows libraries +# on Unix/Linux with additional linker +# flags from "wx-config --libs" +# CMAKE_WXWINDOWS_CXX_FLAGS = Compiler flags for wxWindows, +# essentially +# "`wx-config --cxxflags`" +# WXWINDOWS_INCLUDE_DIR = where to find "wx/wx.h" +# "wx/setup.h" +# WXWINDOWS_LINK_DIRECTORIES = link directories +# WXWINDOWS_DEFINITIONS = extra defines +# deprecated: +# * CMAKE_WX_CAN_COMPILE +# * WXWINDOWS_LIBRARY +# * CMAKE_WX_CXX_FLAGS +# * WXWINDOWS_INCLUDE_PATH +# +# USAGE: +# for convenience include Use_wxWindows.cmake in your projects +# CMakeLists.txt: +# +# if you need OpenGL support please +# SET(WXWINDOWS_USE_GL 1) +# # in your CMakeLists.txt *before* you include this file. +# +# # just include Use_wxWindows.cmake +# # in your projects CMakeLists.txt +# INCLUDE(Use_wxWindows) +# + + +# ------------------------------------------------------------------ +# Author Jan Woetzel <http://www.mip.informatik.uni-kiel.de/~jw> (07/2003) +# ------------------------------------------------------------------ +# +# -changed variable names to conventions from cmakes readme.txt (Jan Woetzel +# 07/07/2003) +# -added definition WINVER for WIN32 (Jan Woetzel 07/07//2003) +# -added IF(CMAKE_WXWINDOWS_CONFIG_EXECUTABLE) found and changed +# CMAKE_WX_CONFIG to CMAKE_WXWINDOWS_CONFIG_EXECUTABLE (Jan Woetzel +# 07/22/2003) +# -removed OPTION for CMAKE_WXWINDOWS_USE_GL. Force the developer to SET it. +# +# status: +# tested with: +# -cmake 1.6.7, Linux (Suse 7.3), wxWindows 2.4.0, gcc 2.95 +# -cmake 1.6.7, Linux (Suse 8.2), wxWindows 2.4.0, gcc 3.3 +# -cmake 1.6.7, Linux (Suse 8.2), wxWindows 2.4.1-patch1, gcc 3.3 +# -cmake 1.6.7, MS Windows XP home, wxWindows 2.4.1, MS Visual Studio .net 7 +# 2002 (static build) +# +# TODO: +# -OPTION for unicode builds +# -change WXWINDOWS_USE_GL to use FindOpenGL.cmake or let the user do it +# -testing of DLL linking under MS WIN32 +# IF(WIN32) SET(WIN32_STYLE_FIND 1) @@ -80,14 +74,14 @@ ENDIF(UNIX) IF(WIN32_STYLE_FIND) - ## ###################################################################### - ## - ## Windows specific: - ## - ## candidates for root/base directory of wxwindows - ## should have subdirs include and lib containing include/wx/wx.h - ## fix the root dir to avoid mixing of headers/libs from different - ## versions/builds: + # ################################### + # + # Windows specific: + # + # candidates for root/base directory of wxwindows + # should have subdirs include and lib containing include/wx/wx.h + # fix the root dir to avoid mixing of headers/libs from different + # versions/builds: SET (WXWINDOWS_POSSIBLE_ROOT_PATHS $ENV{WXWIN} @@ -96,9 +90,9 @@ IF(WIN32_STYLE_FIND) FIND_PATH(WXWINDOWS_ROOT_DIR include/wx/wx.h ${WXWINDOWS_POSSIBLE_ROOT_PATHS} ) - ## MESSAGE("DBG found WXWINDOWS_ROOT_DIR: ${WXWINDOWS_ROOT_DIR}") + # MESSAGE("DBG found WXWINDOWS_ROOT_DIR: ${WXWINDOWS_ROOT_DIR}") - ## find libs for combination of static/shared with release/debug + # find libs for combination of static/shared with release/debug SET (WXWINDOWS_POSSIBLE_LIB_PATHS "${WXWINDOWS_ROOT_DIR}/lib" ) @@ -123,22 +117,22 @@ IF(WIN32_STYLE_FIND) DOC "wxWindows shared debug build library " ) - ## if there is at least one shared lib available - ## let user choose wether to use shared or static wxwindows libs + # if there is at least one shared lib available + # let user choose wether to use shared or static wxwindows libs IF(WXWINDOWS_SHARED_LIBRARY OR WXWINDOWS_SHARED_DEBUG_LIBRARY) - ## default value OFF because wxWindows MSVS default build is static + # default value OFF because wxWindows MSVS default build is static OPTION(WXWINDOWS_USE_SHARED_LIBS "Use shared versions (dll) of wxWindows libraries?" OFF) MARK_AS_ADVANCED(WXWINDOWS_USE_SHARED_LIBS) ENDIF(WXWINDOWS_SHARED_LIBRARY OR WXWINDOWS_SHARED_DEBUG_LIBRARY) - ## add system libraries wxwindows depends on + # add system libraries wxwindows depends on SET(CMAKE_WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} comctl32 rpcrt4 wsock32 - ## presumably ctl3d32 is not neccesary (Jan Woetzel 07/2003) + # presumably ctl3d32 is not neccesary (Jan Woetzel 07/2003) # ctl3d32 # debug ${WXWINDOWS_ROOT_DIR}/lib/zlibd.lib optimized ${WXWINDOWS_ROOT_DIR}/lib/zlibd.lib # debug ${WXWINDOWS_ROOT_DIR}/lib/regexd.lib optimized ${WXWINDOWS_ROOT_DIR}/lib/regexd.lib @@ -151,7 +145,7 @@ IF(WIN32_STYLE_FIND) # OPTION(WXWINDOWS_USE_GL "use wxWindows with GL support (use additional # opengl, glu libs)?" OFF) - ## opengl/glu: (TODO/FIXME: better use FindOpenGL.cmake here + # opengl/glu: (TODO/FIXME: better use FindOpenGL.cmake here IF (WXWINDOWS_USE_GL) SET(CMAKE_WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} opengl32 @@ -160,21 +154,21 @@ IF(WIN32_STYLE_FIND) ENDIF (WXWINDOWS_USE_GL) - ## - ## select between use of shared or static wxWindows lib then set libs to use - ## for debug and optimized build. so the user can switch between debug and - ## release build e.g. within MS Visual Studio without running cmake with a - ## different build directory again. - ## - ## then add the build specific include dir for wx/setup.h - ## + # + # select between use of shared or static wxWindows lib then set libs to use + # for debug and optimized build. so the user can switch between debug and + # release build e.g. within MS Visual Studio without running cmake with a + # different build directory again. + # + # then add the build specific include dir for wx/setup.h + # IF(WXWINDOWS_USE_SHARED_LIBS) - ##MESSAGE("DBG wxWindows use shared lib selected.") + #MESSAGE("DBG wxWindows use shared lib selected.") - ## shared: both wx (debug and release) found? + # shared: both wx (debug and release) found? IF(WXWINDOWS_SHARED_DEBUG_LIBRARY AND WXWINDOWS_SHARED_LIBRARY) - ##MESSAGE("DBG wx shared: debug and optimized found.") + #MESSAGE("DBG wx shared: debug and optimized found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} debug ${WXWINDOWS_SHARED_DEBUG_LIBRARY} optimized ${WXWINDOWS_SHARED_LIBRARY} ) @@ -183,10 +177,10 @@ IF(WIN32_STYLE_FIND) ${WXWINDOWS_ROOT_DIR}/lib/mswdll ) ENDIF(WXWINDOWS_SHARED_DEBUG_LIBRARY AND WXWINDOWS_SHARED_LIBRARY) - ## shared: only debug wx lib found? + # shared: only debug wx lib found? IF(WXWINDOWS_SHARED_DEBUG_LIBRARY) IF(NOT WXWINDOWS_SHARED_LIBRARY) - ##MESSAGE("DBG wx shared: debug (but no optimized) found.") + #MESSAGE("DBG wx shared: debug (but no optimized) found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} ${WXWINDOWS_SHARED_DEBUG_LIBRARY} ) FIND_PATH(WXWINDOWS_INCLUDE_DIR_SETUPH wx/setup.h @@ -194,10 +188,10 @@ IF(WIN32_STYLE_FIND) ENDIF(NOT WXWINDOWS_SHARED_LIBRARY) ENDIF(WXWINDOWS_SHARED_DEBUG_LIBRARY) - ## shared: only release wx lib found? + # shared: only release wx lib found? IF(NOT WXWINDOWS_SHARED_DEBUG_LIBRARY) IF(WXWINDOWS_SHARED_LIBRARY) - ##MESSAGE("DBG wx shared: optimized (but no debug) found.") + #MESSAGE("DBG wx shared: optimized (but no debug) found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} ${WXWINDOWS_SHARED_DEBUG_LIBRARY} ) FIND_PATH(WXWINDOWS_INCLUDE_DIR_SETUPH wx/setup.h @@ -205,7 +199,7 @@ IF(WIN32_STYLE_FIND) ENDIF(WXWINDOWS_SHARED_LIBRARY) ENDIF(NOT WXWINDOWS_SHARED_DEBUG_LIBRARY) - ## shared: none found? + # shared: none found? IF(NOT WXWINDOWS_SHARED_DEBUG_LIBRARY) IF(NOT WXWINDOWS_SHARED_LIBRARY) MESSAGE(SEND_ERROR @@ -215,11 +209,11 @@ IF(WIN32_STYLE_FIND) ELSE(WXWINDOWS_USE_SHARED_LIBS) - ##MESSAGE("DBG wxWindows static lib selected.") + #MESSAGE("DBG wxWindows static lib selected.") - ## static: both wx (debug and release) found? + # static: both wx (debug and release) found? IF(WXWINDOWS_STATIC_DEBUG_LIBRARY AND WXWINDOWS_STATIC_LIBRARY) - ##MESSAGE("DBG wx static: debug and optimized found.") + #MESSAGE("DBG wx static: debug and optimized found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} debug ${WXWINDOWS_STATIC_DEBUG_LIBRARY} optimized ${WXWINDOWS_STATIC_LIBRARY} ) @@ -228,10 +222,10 @@ IF(WIN32_STYLE_FIND) ${WXWINDOWS_ROOT_DIR}/lib/msw ) ENDIF(WXWINDOWS_STATIC_DEBUG_LIBRARY AND WXWINDOWS_STATIC_LIBRARY) - ## static: only debug wx lib found? + # static: only debug wx lib found? IF(WXWINDOWS_STATIC_DEBUG_LIBRARY) IF(NOT WXWINDOWS_STATIC_LIBRARY) - ##MESSAGE("DBG wx static: debug (but no optimized) found.") + #MESSAGE("DBG wx static: debug (but no optimized) found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} ${WXWINDOWS_STATIC_DEBUG_LIBRARY} ) FIND_PATH(WXWINDOWS_INCLUDE_DIR_SETUPH wx/setup.h @@ -239,10 +233,10 @@ IF(WIN32_STYLE_FIND) ENDIF(NOT WXWINDOWS_STATIC_LIBRARY) ENDIF(WXWINDOWS_STATIC_DEBUG_LIBRARY) - ## static: only release wx lib found? + # static: only release wx lib found? IF(NOT WXWINDOWS_STATIC_DEBUG_LIBRARY) IF(WXWINDOWS_STATIC_LIBRARY) - ##MESSAGE("DBG wx static: optimized (but no debug) found.") + #MESSAGE("DBG wx static: optimized (but no debug) found.") SET(WXWINDOWS_LIBRARIES ${CMAKE_WXWINDOWS_LIBRARIES} ${WXWINDOWS_STATIC_DEBUG_LIBRARY} ) FIND_PATH(WXWINDOWS_INCLUDE_DIR_SETUPH wx/setup.h @@ -250,7 +244,7 @@ IF(WIN32_STYLE_FIND) ENDIF(WXWINDOWS_STATIC_LIBRARY) ENDIF(NOT WXWINDOWS_STATIC_DEBUG_LIBRARY) - ## static: none found? + # static: none found? IF(NOT WXWINDOWS_STATIC_DEBUG_LIBRARY) IF(NOT WXWINDOWS_STATIC_LIBRARY) MESSAGE(SEND_ERROR @@ -261,9 +255,9 @@ IF(WIN32_STYLE_FIND) ENDIF(WXWINDOWS_USE_SHARED_LIBS) - ## not neccessary in wxWindows 2.4.1 - ## but it may fix a previous bug, see - ## http://lists.wxwindows.org/cgi-bin/ezmlm-cgi?8:mss:37574:200305:mpdioeneabobmgjenoap + # not neccessary in wxWindows 2.4.1 + # but it may fix a previous bug, see + # http://lists.wxwindows.org/cgi-bin/ezmlm-cgi?8:mss:37574:200305:mpdioeneabobmgjenoap OPTION(WXWINDOWS_SET_DEFINITIONS "Set additional defines for wxWindows" OFF) MARK_AS_ADVANCED(WXWINDOWS_SET_DEFINITIONS) IF (WXWINDOWS_SET_DEFINITIONS) @@ -274,9 +268,9 @@ IF(WIN32_STYLE_FIND) ENDIF (WXWINDOWS_SET_DEFINITIONS) - ## Find the include directories for wxwindows - ## the first, build specific for wx/setup.h was determined before. - ## add inc dir for general for "wx/wx.h" + # Find the include directories for wxwindows + # the first, build specific for wx/setup.h was determined before. + # add inc dir for general for "wx/wx.h" SET (WXWINDOWS_POSSIBLE_INCLUDE_PATHS "${WXWINDOWS_ROOT_DIR}/include" ) @@ -301,13 +295,13 @@ IF(WIN32_STYLE_FIND) ELSE(WIN32_STYLE_FIND) IF (UNIX_STYLE_FIND) - ## ###################################################################### - ## - ## UNIX/Linux specific: - ## - ## use backquoted wx-config to query and set flags and libs: - ## 06/2003 Jan Woetzel - ## + # ################################### + # + # UNIX/Linux specific: + # + # use backquoted wx-config to query and set flags and libs: + # 06/2003 Jan Woetzel + # OPTION(WXWINDOWS_USE_SHARED_LIBS "Use shared versions (.so) of wxWindows libraries" ON) MARK_AS_ADVANCED(WXWINDOWS_USE_SHARED_LIBS) @@ -339,17 +333,17 @@ ELSE(WIN32_STYLE_FIND) IF(WXWINDOWS_USE_GL) SET(WX_CONFIG_ARGS_LIBS "${WX_CONFIG_ARGS_LIBS} --gl-libs" ) ENDIF(WXWINDOWS_USE_GL) - ##MESSAGE("DBG: WX_CONFIG_ARGS_LIBS=${WX_CONFIG_ARGS_LIBS}===") + #MESSAGE("DBG: WX_CONFIG_ARGS_LIBS=${WX_CONFIG_ARGS_LIBS}===") # set CXXFLAGS to be fed into CMAKE_CXX_FLAGS by the user: SET(CMAKE_WXWINDOWS_CXX_FLAGS "`${CMAKE_WXWINDOWS_WXCONFIG_EXECUTABLE} --cxxflags`") - ##MESSAGE("DBG: for compilation: - ##CMAKE_WXWINDOWS_CXX_FLAGS=${CMAKE_WXWINDOWS_CXX_FLAGS}===") + #MESSAGE("DBG: for compilation: + #CMAKE_WXWINDOWS_CXX_FLAGS=${CMAKE_WXWINDOWS_CXX_FLAGS}===") # keep the back-quoted string for clarity SET(WXWINDOWS_LIBRARIES "`${CMAKE_WXWINDOWS_WXCONFIG_EXECUTABLE} ${WX_CONFIG_ARGS_LIBS}`") - ##MESSAGE("DBG2: for linking: - ##WXWINDOWS_LIBRARIES=${WXWINDOWS_LIBRARIES}===") + #MESSAGE("DBG2: for linking: + #WXWINDOWS_LIBRARIES=${WXWINDOWS_LIBRARIES}===") # evaluate wx-config output to separate linker flags and linkdirs for # rpath: @@ -357,23 +351,23 @@ ELSE(WIN32_STYLE_FIND) ARGS ${WX_CONFIG_ARGS_LIBS} OUTPUT_VARIABLE WX_CONFIG_LIBS ) - ## extract linkdirs (-L) for rpath - ## use regular expression to match wildcard equivalent "-L*<endchar>" - ## with <endchar> is a space or a semicolon + # extract linkdirs (-L) for rpath + # use regular expression to match wildcard equivalent "-L*<endchar>" + # with <endchar> is a space or a semicolon STRING(REGEX MATCHALL "[-][L]([^ ;])+" WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX "${WX_CONFIG_LIBS}" ) #MESSAGE("DBG WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX=${WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX}") - ## remove prefix -L because we need the pure directory for LINK_DIRECTORIES - ## replace -L by ; because the separator seems to be lost otherwise (bug or - ## feature?) + # remove prefix -L because we need the pure directory for LINK_DIRECTORIES + # replace -L by ; because the separator seems to be lost otherwise (bug or + # feature?) IF(WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX) STRING(REGEX REPLACE "[-][L]" ";" WXWINDOWS_LINK_DIRECTORIES ${WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX} ) #MESSAGE("DBG WXWINDOWS_LINK_DIRECTORIES=${WXWINDOWS_LINK_DIRECTORIES}") ENDIF(WXWINDOWS_LINK_DIRECTORIES_WITH_PREFIX) - ## replace space separated string by semicolon separated vector to make it - ## work with LINK_DIRECTORIES + # replace space separated string by semicolon separated vector to make it + # work with LINK_DIRECTORIES SEPARATE_ARGUMENTS(WXWINDOWS_LINK_DIRECTORIES) MARK_AS_ADVANCED( @@ -401,10 +395,10 @@ ENDIF(WIN32_STYLE_FIND) IF(WXWINDOWS_LIBRARIES) IF(WXWINDOWS_INCLUDE_DIR OR CMAKE_WXWINDOWS_CXX_FLAGS) - ## found all we need. + # found all we need. SET(WXWINDOWS_FOUND 1) - ## set deprecated variables for backward compatibility: + # set deprecated variables for backward compatibility: SET(CMAKE_WX_CAN_COMPILE ${WXWINDOWS_FOUND}) SET(WXWINDOWS_LIBRARY ${WXWINDOWS_LIBRARIES}) SET(WXWINDOWS_INCLUDE_PATH ${WXWINDOWS_INCLUDE_DIR}) diff --git a/Modules/TestBigEndian.cmake b/Modules/TestBigEndian.cmake index bf95d53..3a38dfc 100644 --- a/Modules/TestBigEndian.cmake +++ b/Modules/TestBigEndian.cmake @@ -1,7 +1,7 @@ -# +# - Define macro to determine endian type # Check if the system is big endian or little endian -# -# VARIABLE - variable to store the result to +# TEST_BIG_ENDIAN(VARIABLE) +# VARIABLE - variable to store the result to # MACRO(TEST_BIG_ENDIAN VARIABLE) diff --git a/Modules/TestCXXAcceptsFlag.cmake b/Modules/TestCXXAcceptsFlag.cmake index 196d26b..8ead32a 100644 --- a/Modules/TestCXXAcceptsFlag.cmake +++ b/Modules/TestCXXAcceptsFlag.cmake @@ -1,9 +1,10 @@ -# +# - Test CXX compiler for a flag # Check if the CXX compiler accepts a flag # -# CHECK_FUNCTION_EXISTS - macro which checks if the function exists -# FLAG - the flags to try -# VARIABLE - variable to store the result +# Macro CHECK_CXX_ACCEPTS_FLAG(FLAGS VARIABLE) - +# checks if the function exists +# FLAGS - the flags to try +# VARIABLE - variable to store the result # MACRO(CHECK_CXX_ACCEPTS_FLAG FLAGS VARIABLE) diff --git a/Modules/TestForANSIForScope.cmake b/Modules/TestForANSIForScope.cmake index 2ca2634..ca41cca 100644 --- a/Modules/TestForANSIForScope.cmake +++ b/Modules/TestForANSIForScope.cmake @@ -1,7 +1,6 @@ -# -# check if the compiler supports std:: on stl classes -# -# CMAKE_NO_STD_NAMESPACE - defined accoreding to the results +# - Check for ANSI for scope support +# Check if the compiler supports std:: on stl classes. +# CMAKE_NO_STD_NAMESPACE - holds result # IF("CMAKE_ANSI_FOR_SCOPE" MATCHES "^CMAKE_ANSI_FOR_SCOPE$") diff --git a/Modules/TestForANSIStreamHeaders.cmake b/Modules/TestForANSIStreamHeaders.cmake index 9b7d964..b5e669d 100644 --- a/Modules/TestForANSIStreamHeaders.cmake +++ b/Modules/TestForANSIStreamHeaders.cmake @@ -1,7 +1,6 @@ -# +# - Test for compiler support of ANSI stream headers iostream, etc. # check if we they have the standard ansi stream files (without the .h) -# -# CMAKE_NO_ANSI_STREAM_HEADERS - defined accoreding to the results +# CMAKE_NO_ANSI_STREAM_HEADERS - defined according to the results # INCLUDE(CheckIncludeFileCXX) diff --git a/Modules/TestForSTDNamespace.cmake b/Modules/TestForSTDNamespace.cmake index e25850e..20bdaa1 100644 --- a/Modules/TestForSTDNamespace.cmake +++ b/Modules/TestForSTDNamespace.cmake @@ -1,7 +1,6 @@ -# +# - Test for std:: namespace support # check if the compiler supports std:: on stl classes -# -# CMAKE_NO_STD_NAMESPACE - defined accoreding to the results +# CMAKE_NO_STD_NAMESPACE - defined according to the results # IF("CMAKE_STD_NAMESPACE" MATCHES "^CMAKE_STD_NAMESPACE$") MESSAGE(STATUS "Check for STD namespace") diff --git a/Modules/UseQt4.cmake b/Modules/UseQt4.cmake index 2671bb7..d0d8638 100644 --- a/Modules/UseQt4.cmake +++ b/Modules/UseQt4.cmake @@ -1,10 +1,8 @@ -############################################################################# -# -# Sets up C and C++ to use Qt 4. It is assumed that FindQt.cmake -# has already been loaded. See FindQt.cmake for information on -# how to load Qt 4 into your CMake project. -# -############################################################################# +# - Use Module for QT4 +# Sets up C and C++ to use Qt 4. It is assumed that FindQt.cmake +# has already been loaded. See FindQt.cmake for information on +# how to load Qt 4 into your CMake project. + ADD_DEFINITIONS(${QT_DEFINITIONS}) diff --git a/Modules/UseSWIG.cmake b/Modules/UseSWIG.cmake index b199d4d..db313b5 100644 --- a/Modules/UseSWIG.cmake +++ b/Modules/UseSWIG.cmake @@ -1,17 +1,12 @@ -# -# SWIG module for CMake -# +# - SWIG module for CMake # Defines the following macros: -# # SWIG_ADD_MODULE(name language [ files ]) # - Define swig module with given name and specified language -# # SWIG_LINK_LIBRARIES(name [ libraries ]) # - Link libraries to swig module -# # All other macros are for internal use only. -# -# To get the actual name of the swig module, use: ${SWIG_MODULE_name_REAL_NAME}. +# To get the actual name of the swig module, +# use: ${SWIG_MODULE_name_REAL_NAME}. # Set Source files propertis such as CPLUSPLUS and SWIG_FLAGS to specify # special behavior of SWIG. Also global CMAKE_SWIG_FLAGS can be used to add # special flags to all swig calls. diff --git a/Modules/UseVTK40.cmake b/Modules/UseVTK40.cmake index e1d5273..750d44b 100644 --- a/Modules/UseVTK40.cmake +++ b/Modules/UseVTK40.cmake @@ -1,3 +1,5 @@ +# + # This is an implementation detail for using VTK 4.0 with the # FindVTK.cmake module. Do not include directly by name. This should # be included only when FindVTK.cmake sets the VTK_USE_FILE variable diff --git a/Modules/UseVTKBuildSettings40.cmake b/Modules/UseVTKBuildSettings40.cmake index c10ce01..a43bb0b 100644 --- a/Modules/UseVTKBuildSettings40.cmake +++ b/Modules/UseVTKBuildSettings40.cmake @@ -1,3 +1,5 @@ +# + # Implementation detail for FindVTK.cmake to let it provide a # VTK_BUILD_SETTINGS_FILE for VTK 4.0. diff --git a/Modules/UseVTKConfig40.cmake b/Modules/UseVTKConfig40.cmake index 8795f88..623c607 100644 --- a/Modules/UseVTKConfig40.cmake +++ b/Modules/UseVTKConfig40.cmake @@ -1,3 +1,5 @@ +# + # This is an implementation detail for using VTK 4.0 with the # FindVTK.cmake module. Do not include directly. diff --git a/Modules/Use_wxWindows.cmake b/Modules/Use_wxWindows.cmake index ba69dea..e41819c 100644 --- a/Modules/Use_wxWindows.cmake +++ b/Modules/Use_wxWindows.cmake @@ -1,49 +1,44 @@ -##
-## This convenience include finds if wxWindows is installed
-## and set the appropriate libs, incdirs, flags etc.
-
-## author Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> (07/2003)
-##
-## -----------------------------------------------------
-## USAGE:
-## just include Use_wxWindows.cmake
-## in your projects CMakeLists.txt
-## INCLUDE(Use_wxWindows)
-##
-## if you are sure you need GL then
-## SET(WXWINDOWS_USE_GL 1)
-## *before* you include this file.
-##
-## -----------------------------------------------------
-
-
-
-INCLUDE(FindwxWindows)
-
-IF(WXWINDOWS_FOUND)
-
- #MESSAGE("DBG Use_wxWindows.cmake: WXWINDOWS_INCLUDE_DIR=${WXWINDOWS_INCLUDE_DIR} WXWINDOWS_LINK_DIRECTORIES=${WXWINDOWS_LINK_DIRECTORIES} WXWINDOWS_LIBRARIES=${WXWINDOWS_LIBRARIES} CMAKE_WXWINDOWS_CXX_FLAGS=${CMAKE_WXWINDOWS_CXX_FLAGS} WXWINDOWS_DEFINITIONS=${WXWINDOWS_DEFINITIONS}")
-
- IF(WXWINDOWS_INCLUDE_DIR)
- INCLUDE_DIRECTORIES(${WXWINDOWS_INCLUDE_DIR})
- ENDIF(WXWINDOWS_INCLUDE_DIR)
-
- IF(WXWINDOWS_LINK_DIRECTORIES)
- LINK_DIRECTORIES(${WXWINDOWS_LINK_DIRECTORIES})
- ENDIF(WXWINDOWS_LINK_DIRECTORIES)
-
- IF(WXWINDOWS_LIBRARIES)
- LINK_LIBRARIES(${WXWINDOWS_LIBRARIES})
- ENDIF(WXWINDOWS_LIBRARIES)
-
- IF (CMAKE_WXWINDOWS_CXX_FLAGS)
- SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_WXWINDOWS_CXX_FLAGS}")
- ENDIF(CMAKE_WXWINDOWS_CXX_FLAGS)
-
- IF(WXWINDOWS_DEFINITIONS)
- ADD_DEFINITIONS(${WXWINDOWS_DEFINITIONS})
- ENDIF(WXWINDOWS_DEFINITIONS)
-
-ELSE(WXWINDOWS_FOUND)
- MESSAGE(SEND_ERROR "wxWindows not found by Use_wxWindows.cmake")
-ENDIF(WXWINDOWS_FOUND)
+# - Find wxWindows installation +# +# This convenience include finds if wxWindows is installed +# and set the appropriate libs, incdirs, flags etc. +# INCLUDE_DIRECTORIES, LINK_DIRECTORIES and ADD_DEFINITIONS +# are called. +# +# author Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> (07/2003) +# +# if you are sure you need GL then +# SET(WXWINDOWS_USE_GL 1) +# *before* you include this file. +# + + +INCLUDE(FindwxWindows) + +IF(WXWINDOWS_FOUND) + + #MESSAGE("DBG Use_wxWindows.cmake: WXWINDOWS_INCLUDE_DIR=${WXWINDOWS_INCLUDE_DIR} WXWINDOWS_LINK_DIRECTORIES=${WXWINDOWS_LINK_DIRECTORIES} WXWINDOWS_LIBRARIES=${WXWINDOWS_LIBRARIES} CMAKE_WXWINDOWS_CXX_FLAGS=${CMAKE_WXWINDOWS_CXX_FLAGS} WXWINDOWS_DEFINITIONS=${WXWINDOWS_DEFINITIONS}") + + IF(WXWINDOWS_INCLUDE_DIR) + INCLUDE_DIRECTORIES(${WXWINDOWS_INCLUDE_DIR}) + ENDIF(WXWINDOWS_INCLUDE_DIR) + + IF(WXWINDOWS_LINK_DIRECTORIES) + LINK_DIRECTORIES(${WXWINDOWS_LINK_DIRECTORIES}) + ENDIF(WXWINDOWS_LINK_DIRECTORIES) + + IF(WXWINDOWS_LIBRARIES) + LINK_LIBRARIES(${WXWINDOWS_LIBRARIES}) + ENDIF(WXWINDOWS_LIBRARIES) + + IF (CMAKE_WXWINDOWS_CXX_FLAGS) + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_WXWINDOWS_CXX_FLAGS}") + ENDIF(CMAKE_WXWINDOWS_CXX_FLAGS) + + IF(WXWINDOWS_DEFINITIONS) + ADD_DEFINITIONS(${WXWINDOWS_DEFINITIONS}) + ENDIF(WXWINDOWS_DEFINITIONS) + +ELSE(WXWINDOWS_FOUND) + MESSAGE(SEND_ERROR "wxWindows not found by Use_wxWindows.cmake") +ENDIF(WXWINDOWS_FOUND) diff --git a/Modules/UsewxWidgets.cmake b/Modules/UsewxWidgets.cmake index af6b0c7..8c219f1 100644 --- a/Modules/UsewxWidgets.cmake +++ b/Modules/UsewxWidgets.cmake @@ -1 +1,4 @@ +# - Same as Use_wxWindows +# + INCLUDE(Use_wxWindows) diff --git a/Modules/readme.txt b/Modules/readme.txt index 96cdfd2..1d336ac 100644 --- a/Modules/readme.txt +++ b/Modules/readme.txt @@ -26,4 +26,32 @@ For tidiness's sake, try to keep as many options as possible out of the cache, l If you need other commands to do special things then it should still begin with XXX_. This gives a sort of namespace effect and keeps things tidy for the user. You should put comments describing all the exported settings, plus descriptions of any the users can use to control stuff. -You really should also provide backwards compatibility any old settings that were actually in use. Make sure you comment them as deprecated, so that no-one starts using them.
\ No newline at end of file +You really should also provide backwards compatibility any old settings that were actually in use. Make sure you comment them as deprecated, so that no-one starts using them. + +To correctly docuement a module, create a comment block at the top with # comments. There are three types of comments that can be in the block: + +1. The brief description of the module, this is done by: +# - a small description + +2. A paragraph of text. This is done with all text that has a single +space between the # and the text. To create a new paragraph, just +put a # with no text on the line. + +3. A verbatim line. This is done with two spaces between the # and the text. + +For example: + +# - This is a cool module +# This module does really cool stuff. +# It can do even more than you think. +# +# It even needs to paragraphs to tell you about it. +# And it defines the following variables: +# VAR_COOL - this is greate isn't it? +# VAR_REALLY_COOL - cool right? +# + +To have a .cmake file in this directory NOT show up in the +modules documentation, you should start the file with a blank +line. + diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index c212ff3..74aadf5 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -18,6 +18,7 @@ #include "cmSystemTools.h" #include "cmVersion.h" +#include <cmsys/Directory.hxx> //---------------------------------------------------------------------------- static const cmDocumentationEntry cmDocumentationStandardOptions[] = @@ -51,6 +52,15 @@ static const cmDocumentationEntry cmDocumentationCommandsHeader[] = }; //---------------------------------------------------------------------------- +static const cmDocumentationEntry cmDocumentationModulesHeader[] = +{ + {0, + "The following modules are provided with CMake. " + "They can be used with INCLUDE(ModuleName).", 0}, + {0,0,0} +}; + +//---------------------------------------------------------------------------- static const cmDocumentationEntry cmDocumentationGeneratorsHeader[] = { {0, @@ -126,6 +136,16 @@ cmDocumentation::cmDocumentation() } //---------------------------------------------------------------------------- +cmDocumentation::~cmDocumentation() +{ + for(std::vector< char* >::iterator i = this->ModuleStrings.begin(); + i != this->ModuleStrings.end(); ++i) + { + delete [] *i; + } +} + +//---------------------------------------------------------------------------- bool cmDocumentation::PrintCopyright(std::ostream& os) { for(const cmDocumentationEntry* op = cmDocumentationCopyright; @@ -181,7 +201,9 @@ bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) { case cmDocumentation::Usage: return this->PrintDocumentationUsage(os); case cmDocumentation::Single: return this->PrintDocumentationSingle(os); + case cmDocumentation::SingleModule: return this->PrintDocumentationSingleModule(os); case cmDocumentation::List: return this->PrintDocumentationList(os); + case cmDocumentation::ModuleList: return this->PrintModuleList(os); case cmDocumentation::Full: return this->PrintDocumentationFull(os); case cmDocumentation::HTML: return this->PrintDocumentationHTML(os); case cmDocumentation::Man: return this->PrintDocumentationMan(os); @@ -192,6 +214,121 @@ bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) } //---------------------------------------------------------------------------- +bool cmDocumentation::CreateModulesSection() +{ + this->ModulesSection.push_back(cmDocumentationModulesHeader[0]); +#ifdef CMAKE_ROOT_DIR + std::string cmakeModules = CMAKE_ROOT_DIR; + cmakeModules += "/Modules"; + cmsys::Directory dir; + dir.Load(cmakeModules.c_str()); + for(unsigned int i = 0; i < dir.GetNumberOfFiles(); ++i) + { + std::string fname = dir.GetFile(i); + if(fname.length() > 6) + { + if(fname.substr(fname.length()-6, 6) == ".cmake") + { + std::string moduleName = fname.substr(0, fname.length()-6); + std::string path = cmakeModules; + path += "/"; + path += fname; + this->CreateSingleModule(path.c_str(), moduleName.c_str()); + } + } + } +#endif + cmDocumentationEntry e = { 0, 0, 0 }; + this->ModulesSection.push_back(e); + return true; +} + +//---------------------------------------------------------------------------- +bool cmDocumentation::CreateSingleModule(const char* fname, const char* moduleName) +{ + std::ifstream fin(fname); + if(!fin) + { + std::cerr << "Internal error: can not open module." << fname << std::endl; + return false; + } + std::string line; + std::string text; + std::string brief; + brief = " "; + bool newParagraph = true; + while ( fin && cmSystemTools::GetLineFromStream(fin, line) ) + { + if(line.size() && line[0] == '#') + { + // blank line + if(line.size() <= 2) + { + text += "\n"; + newParagraph = true; + } + else if(line[2] == '-') + { + brief = line.c_str()+4; + } + else + { + // two spaces + if(line[1] == ' ' && line[2] == ' ') + { + if(!newParagraph) + { + text += "\n"; + newParagraph = true; + } + // Skip #, and leave space for preformatted + text += line.c_str()+1; + text += "\n"; + } + else if(line[1] == ' ') + { + if(!newParagraph) + { + text += " "; + } + newParagraph = false; + // skip # and space + text += line.c_str()+2; + } + else + { + if(!newParagraph) + { + text += " "; + } + newParagraph = false; + // skip # + text += line.c_str()+1; + } + } + } + else + { + if(text.length() < 2) + { + return false; + } + char* pname = strcpy(new char[strlen(moduleName)+1], moduleName); + char* ptext = strcpy(new char[text.length()+1], text.c_str()); + this->ModuleStrings.push_back(pname); + this->ModuleStrings.push_back(ptext); + char* pbrief = strcpy(new char[brief.length()+1], brief.c_str()); + this->ModuleStrings.push_back(pbrief); + cmDocumentationEntry e = { pname, pbrief, ptext }; + this->ModulesSection.push_back(e); + return false; + } + } + return true; +} + + +//---------------------------------------------------------------------------- bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) { bool result = true; @@ -300,10 +437,23 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv) i = i+1; } } + else if(strcmp(argv[i], "--help-module") == 0) + { + type = cmDocumentation::SingleModule; + if((i+1 < argc) && !this->IsOption(argv[i+1])) + { + this->SingleModuleName = argv[i+1]; + i = i+1; + } + } else if(strcmp(argv[i], "--help-command-list") == 0) { type = cmDocumentation::List; } + else if(strcmp(argv[i], "--help-module-list") == 0) + { + type = cmDocumentation::ModuleList; + } else if(strcmp(argv[i], "--copyright") == 0) { type = cmDocumentation::Copyright; @@ -768,6 +918,10 @@ void cmDocumentation::PrintColumn(std::ostream& os, const char* text) column = static_cast<long>(r-l); newSentence = (*(r-1) == '.'); } + else + { + column = 0; + } } // Move to beginning of next word. Skip over whitespace. @@ -835,6 +989,32 @@ bool cmDocumentation::PrintDocumentationSingle(std::ostream& os) } //---------------------------------------------------------------------------- +bool cmDocumentation::PrintDocumentationSingleModule(std::ostream& os) +{ + if(this->SingleModuleName.length() == 0) + { + os << "Argument --help-module needs a module name.\n"; + return false; + } +#ifdef CMAKE_ROOT_DIR + std::string cmakeModules = CMAKE_ROOT_DIR; + cmakeModules += "/Modules/"; + cmakeModules += this->SingleModuleName; + cmakeModules += ".cmake"; + if(cmSystemTools::FileExists(cmakeModules.c_str())) + { + this->CreateSingleModule(cmakeModules.c_str(), this->SingleModuleName.c_str()); + this->PrintDocumentationCommand(os, &this->ModulesSection[0]); + return true; + } + // Argument was not a module. Complain. + os << "Argument \"" << this->SingleModuleName.c_str() + << "\" to --help-module is not a CMake module."; +#endif + return false; +} + +//---------------------------------------------------------------------------- bool cmDocumentation::PrintDocumentationList(std::ostream& os) { if(this->CommandsSection.empty()) @@ -854,6 +1034,26 @@ bool cmDocumentation::PrintDocumentationList(std::ostream& os) } //---------------------------------------------------------------------------- +bool cmDocumentation::PrintModuleList(std::ostream& os) +{ + this->CreateModulesSection(); + if(this->ModulesSection.empty()) + { + os << "Internal error: modules list is empty." << std::endl; + return false; + } + for(cmDocumentationEntry* entry = &this->ModulesSection[0]; + entry->brief; ++entry) + { + if(entry->name) + { + os << entry->name << std::endl; + } + } + return true; +} + +//---------------------------------------------------------------------------- bool cmDocumentation::PrintDocumentationUsage(std::ostream& os) { this->CreateUsageDocumentation(); @@ -951,6 +1151,11 @@ void cmDocumentation::CreateFullDocumentation() { this->AddSection("Listfile Commands", &this->CommandsSection[0]); } + this->CreateModulesSection(); + if(!this->ModulesSection.empty()) + { + this->AddSection("Standard CMake Modules", &this->ModulesSection[0]); + } this->AddSection("Copyright", cmDocumentationCopyright); this->AddSection("Mailing List", cmDocumentationMailingList); } @@ -983,6 +1188,12 @@ void cmDocumentation::CreateManDocumentation() { this->AddSection("COMMANDS", &this->CommandsSection[0]); } + this->CreateModulesSection(); + if(!this->ModulesSection.empty()) + { + this->AddSection("MODULES", &this->ModulesSection[0]); + } + this->AddSection("COPYRIGHT", cmDocumentationCopyright); this->AddSection("MAILING LIST", cmDocumentationMailingList); if(!this->SeeAlsoSection.empty()) diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index d0db3a1..735d09c 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -25,10 +25,12 @@ class cmDocumentation public: cmDocumentation(); + ~cmDocumentation(); // High-level interface for standard documents: /** Types of help provided. */ - enum Type { None, Usage, Single, List, Full, HTML, Man, Copyright, Version }; + enum Type { None, Usage, Single, SingleModule, List, ModuleList, + Full, HTML, Man, Copyright, Version }; /** * Check command line arguments for documentation options. Returns @@ -121,10 +123,14 @@ private: void PrintColumn(std::ostream& os, const char* text); void PrintHTMLEscapes(std::ostream& os, const char* text); + bool CreateSingleModule(const char* fname, const char* moduleName); + bool CreateModulesSection(); bool PrintCopyright(std::ostream& os); bool PrintVersion(std::ostream& os); bool PrintDocumentationList(std::ostream& os); + bool PrintModuleList(std::ostream& os); bool PrintDocumentationSingle(std::ostream& os); + bool PrintDocumentationSingleModule(std::ostream& os); bool PrintDocumentationUsage(std::ostream& os); bool PrintDocumentationFull(std::ostream& os); bool PrintDocumentationHTML(std::ostream& os); @@ -149,11 +155,14 @@ private: std::vector<cmDocumentationEntry> DescriptionSection; std::vector<cmDocumentationEntry> OptionsSection; std::vector<cmDocumentationEntry> CommandsSection; + std::vector<cmDocumentationEntry> ModulesSection; std::vector<cmDocumentationEntry> GeneratorsSection; std::vector<cmDocumentationEntry> SeeAlsoSection; std::string SeeAlsoString; std::string SingleCommand; + std::string SingleModuleName; + std::vector< char* > ModuleStrings; std::vector< const char* > Names; std::vector< const cmDocumentationEntry* > Sections; Form CurrentForm; diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx index 04804d5..e63c319 100644 --- a/Source/cmakemain.cxx +++ b/Source/cmakemain.cxx @@ -83,6 +83,12 @@ static const cmDocumentationEntry cmDocumentationOptions[] = "The list contains all commands for which help may be obtained by using " "the --help-command argument followed by a command name. If a file is " "specified, the help is written into it."}, + {"--help-module module [file]", "Print help for a single module and exit.", + "Full documentation specific to the given module is displayed."}, + {"--help-module-list [file]", "List available modules and exit.", + "The list contains all modules for which help may be obtained by using " + "the --help-module argument followed by a module name. If a file is " + "specified, the help is written into it."}, {0,0,0} }; |