diff options
1603 files changed, 27707 insertions, 36611 deletions
diff --git a/Docs/CMakeLists.txt b/Auxiliary/CMakeLists.txt index 34090d2..c003b28 100644 --- a/Docs/CMakeLists.txt +++ b/Auxiliary/CMakeLists.txt @@ -1,3 +1,4 @@ install(FILES cmake-help.vim cmake-indent.vim cmake-syntax.vim DESTINATION ${CMAKE_DATA_DIR}/editors/vim) install(FILES cmake-mode.el DESTINATION ${CMAKE_DATA_DIR}/editors/emacs) +install(FILES cmake.m4 DESTINATION share/aclocal) add_subdirectory (bash-completion) diff --git a/Docs/bash-completion/CMakeLists.txt b/Auxiliary/bash-completion/CMakeLists.txt index c0a8899..c0a8899 100644 --- a/Docs/bash-completion/CMakeLists.txt +++ b/Auxiliary/bash-completion/CMakeLists.txt diff --git a/Docs/bash-completion/cmake b/Auxiliary/bash-completion/cmake index 59e0298..59e0298 100644 --- a/Docs/bash-completion/cmake +++ b/Auxiliary/bash-completion/cmake diff --git a/Docs/bash-completion/cpack b/Auxiliary/bash-completion/cpack index 9ab6048..9ab6048 100644 --- a/Docs/bash-completion/cpack +++ b/Auxiliary/bash-completion/cpack diff --git a/Docs/bash-completion/ctest b/Auxiliary/bash-completion/ctest index 25cb998..25cb998 100644 --- a/Docs/bash-completion/ctest +++ b/Auxiliary/bash-completion/ctest diff --git a/Docs/cmake-help.vim b/Auxiliary/cmake-help.vim index 17cfa83..17cfa83 100644 --- a/Docs/cmake-help.vim +++ b/Auxiliary/cmake-help.vim diff --git a/Docs/cmake-indent.vim b/Auxiliary/cmake-indent.vim index a26dd06..a26dd06 100644 --- a/Docs/cmake-indent.vim +++ b/Auxiliary/cmake-indent.vim diff --git a/Docs/cmake-mode.el b/Auxiliary/cmake-mode.el index 6feed94..6feed94 100644 --- a/Docs/cmake-mode.el +++ b/Auxiliary/cmake-mode.el diff --git a/Docs/cmake-syntax.vim b/Auxiliary/cmake-syntax.vim index 80395ab..80395ab 100644 --- a/Docs/cmake-syntax.vim +++ b/Auxiliary/cmake-syntax.vim diff --git a/Utilities/cmake.m4 b/Auxiliary/cmake.m4 index a374a3b..a374a3b 100644 --- a/Utilities/cmake.m4 +++ b/Auxiliary/cmake.m4 diff --git a/CMakeLists.txt b/CMakeLists.txt index 1fbbe08..25cd576 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -9,8 +9,10 @@ # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. # See the License for more information. #============================================================================= -cmake_minimum_required(VERSION 2.8.2 FATAL_ERROR) -set(CMAKE_LEGACY_CYGWIN_WIN32 0) # Remove when CMake >= 2.8.4 is required +cmake_minimum_required(VERSION 2.8.4 FATAL_ERROR) +if(POLICY CMP0025) + cmake_policy(SET CMP0025 NEW) +endif() project(CMake) if(CMAKE_BOOTSTRAP) @@ -193,15 +195,8 @@ mark_as_advanced(CMAKE_USE_FOLDERS) macro(CMAKE_SET_TARGET_FOLDER tgt folder) if(CMAKE_USE_FOLDERS) set_property(GLOBAL PROPERTY USE_FOLDERS ON) - - # Really, I just want this to be an "if(TARGET ${tgt})" ... - # but I'm not sure that our min req'd., CMake 2.4.5 can handle - # that... so I'm just activating this for now, with a version - # compare, and only for MSVC builds. - if(MSVC) - if(NOT ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION} LESS 2.8) - set_property(TARGET "${tgt}" PROPERTY FOLDER "${folder}") - endif() + if(MSVC AND TARGET ${tgt}) + set_property(TARGET "${tgt}" PROPERTY FOLDER "${folder}") endif() else() set_property(GLOBAL PROPERTY USE_FOLDERS OFF) @@ -323,11 +318,7 @@ macro (CMAKE_BUILD_UTILITIES) #--------------------------------------------------------------------- # Build or use system libarchive for CMake and CTest. if(CMAKE_USE_SYSTEM_LIBARCHIVE) - if(EXISTS ${CMAKE_ROOT}/Modules/FindLibArchive.cmake) # added in 2.8.3 - find_package(LibArchive) - else() - include(${CMake_SOURCE_DIR}/Modules/FindLibArchive.cmake) - endif() + find_package(LibArchive) if(NOT LibArchive_FOUND) message(FATAL_ERROR "CMAKE_USE_SYSTEM_LIBARCHIVE is ON but LibArchive is not found!") endif() @@ -420,27 +411,8 @@ endif() # The main section of the CMakeLists file # #----------------------------------------------------------------------- -include(Source/CMakeVersion.cmake) -# Releases define a small tweak level. -if("${CMake_VERSION_TWEAK}" VERSION_LESS 20000000) - set(CMake_VERSION_IS_RELEASE 1) - set(CMake_VERSION_SOURCE "") -else() - set(CMake_VERSION_IS_RELEASE 0) - include(${CMake_SOURCE_DIR}/Source/CMakeVersionSource.cmake) -endif() - -# Compute the full version string. -set(CMake_VERSION ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}) -if(${CMake_VERSION_TWEAK} GREATER 0) - set(CMake_VERSION ${CMake_VERSION}.${CMake_VERSION_TWEAK}) -endif() -if(CMake_VERSION_RC) - set(CMake_VERSION ${CMake_VERSION}-rc${CMake_VERSION_RC}) -endif() -if(CMake_VERSION_SOURCE) - set(CMake_VERSION ${CMake_VERSION}-${CMake_VERSION_SOURCE}) -endif() +# Compute CMake_VERSION, etc. +include(Source/CMakeVersionCompute.cmake) # Include the standard Dart testing module enable_testing() @@ -460,27 +432,8 @@ set(LIBRARY_OUTPUT_PATH "" CACHE INTERNAL # install tree. set(CMAKE_SKIP_RPATH ON CACHE INTERNAL "CMake does not need RPATHs.") -set(CMAKE_DATA_DIR "share/cmake-${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}" CACHE STRING - "Install location for data (relative to prefix).") -set(CMAKE_DOC_DIR "doc/cmake-${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}" CACHE STRING - "Install location for documentation (relative to prefix).") -set(CMAKE_MAN_DIR "man" CACHE STRING - "Install location for man pages (relative to prefix).") -mark_as_advanced(CMAKE_DATA_DIR CMAKE_DOC_DIR CMAKE_MAN_DIR) -if(CYGWIN AND EXISTS "${CMAKE_ROOT}/Modules/CPack.cmake") - # Force doc, data and man dirs to conform to cygwin layout. - set(CMAKE_DOC_DIR "share/doc/cmake-${CMake_VERSION}") - set(CMAKE_DATA_DIR "share/cmake-${CMake_VERSION}") - set(CMAKE_MAN_DIR "share/man") - # let the user know we just forced these values - message(STATUS "Setup for Cygwin packaging") - message(STATUS "Override cache CMAKE_DOC_DIR = ${CMAKE_DOC_DIR}") - message(STATUS "Override cache CMAKE_DATA_DIR = ${CMAKE_DATA_DIR}") - message(STATUS "Override cache CMAKE_MAN_DIR = ${CMAKE_MAN_DIR}") -endif() -string(REGEX REPLACE "^/" "" CMAKE_DATA_DIR "${CMAKE_DATA_DIR}") -string(REGEX REPLACE "^/" "" CMAKE_DOC_DIR "${CMAKE_DOC_DIR}") -string(REGEX REPLACE "^/" "" CMAKE_MAN_DIR "${CMAKE_MAN_DIR}") +# Load install destinations. +include(Source/CMakeInstallDestinations.cmake) if(BUILD_TESTING) include(${CMake_SOURCE_DIR}/Tests/CMakeInstall.cmake) @@ -529,8 +482,9 @@ endif() if(BUILD_QtDialog) if(APPLE) - set(CMAKE_BUNDLE_NAME - "CMake ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}-${CMake_VERSION_PATCH}") + set(CMAKE_BUNDLE_VERSION + "${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}") + set(CMAKE_BUNDLE_NAME "CMake ${CMAKE_BUNDLE_VERSION}") set(CMAKE_BUNDLE_LOCATION "${CMAKE_INSTALL_PREFIX}") # make sure CMAKE_INSTALL_PREFIX ends in / string(LENGTH "${CMAKE_INSTALL_PREFIX}" LEN) @@ -582,10 +536,6 @@ configure_file( "${CMAKE_CURRENT_BINARY_DIR}/DartLocal.conf" COPYONLY) -option(CMAKE_STRICT - "Perform strict testing to record property and variable access. Can be used to report any undefined properties or variables" OFF) -mark_as_advanced(CMAKE_STRICT) - if(NOT CMake_VERSION_IS_RELEASE) if("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU" AND NOT "${CMAKE_C_COMPILER_VERSION}" VERSION_LESS 4.2) @@ -619,7 +569,9 @@ if(BUILD_TESTING) CMAKE_SET_TARGET_FOLDER(CMakeLibTests "Tests") endif() CMAKE_SET_TARGET_FOLDER(cmw9xcom "Utilities/Win9xCompat") -CMAKE_SET_TARGET_FOLDER(documentation "Documentation") +if(TARGET documentation) + CMAKE_SET_TARGET_FOLDER(documentation "Documentation") +endif() # add a test add_test(SystemInformationNew "${CMAKE_CMAKE_COMMAND}" @@ -630,7 +582,7 @@ install(FILES Copyright.txt DESTINATION ${CMAKE_DOC_DIR}) # Install script directories. install( - DIRECTORY Modules Templates + DIRECTORY Help Modules Templates DESTINATION ${CMAKE_DATA_DIR} FILE_PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ DIRECTORY_PERMISSIONS OWNER_READ OWNER_EXECUTE OWNER_WRITE @@ -641,8 +593,8 @@ install( WORLD_READ WORLD_EXECUTE ) -# process docs related install -add_subdirectory(Docs) +# Install auxiliary files integrating with other tools. +add_subdirectory(Auxiliary) #----------------------------------------------------------------------- # End of the main section of the CMakeLists file diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt new file mode 100644 index 0000000..5889e90 --- /dev/null +++ b/Help/command/FIND_XXX.txt @@ -0,0 +1,101 @@ +A short-hand signature is: + +.. parsed-literal:: + + |FIND_XXX| (<VAR> name1 [path1 path2 ...]) + +The general signature is: + +.. parsed-literal:: + + |FIND_XXX| ( + <VAR> + name | |NAMES| + [HINTS path1 [path2 ... ENV var]] + [PATHS path1 [path2 ... ENV var]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [DOC "cache documentation string"] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_SYSTEM_PATH] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH] + ) + +This command is used to find a |SEARCH_XXX_DESC|. +A cache entry named by ``<VAR>`` is created to store the result +of this command. +If the |SEARCH_XXX| is found the result is stored in the variable +and the search will not be repeated unless the variable is cleared. +If nothing is found, the result will be +``<VAR>-NOTFOUND``, and the search will be attempted again the +next time |FIND_XXX| is invoked with the same variable. +The name of the |SEARCH_XXX| that +is searched for is specified by the names listed +after the NAMES argument. Additional search locations +can be specified after the PATHS argument. If ENV var is +found in the HINTS or PATHS section the environment variable var +will be read and converted from a system environment variable to +a cmake style list of paths. For example ENV PATH would be a way +to list the system path variable. The argument +after DOC will be used for the documentation string in +the cache. +PATH_SUFFIXES specifies additional subdirectories to check below +each search path. + +If NO_DEFAULT_PATH is specified, then no additional paths are +added to the search. +If NO_DEFAULT_PATH is not specified, the search process is as follows: + +.. |CMAKE_PREFIX_PATH_XXX_SUBDIR| replace:: + <prefix>/|XXX_SUBDIR| for each <prefix> in CMAKE_PREFIX_PATH + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| replace:: + <prefix>/|XXX_SUBDIR| for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH + +1. Search paths specified in cmake-specific cache variables. + These are intended to be used on the command line with a -DVAR=value. + This can be skipped if NO_CMAKE_PATH is passed. + + * |CMAKE_PREFIX_PATH_XXX| + * |CMAKE_XXX_PATH| + * |CMAKE_XXX_MAC_PATH| + +2. Search paths specified in cmake-specific environment variables. + These are intended to be set in the user's shell configuration. + This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + + * |CMAKE_PREFIX_PATH_XXX| + * |CMAKE_XXX_PATH| + * |CMAKE_XXX_MAC_PATH| + +3. Search the paths specified by the HINTS option. + These should be paths computed by system introspection, such as a + hint provided by the location of another item already found. + Hard-coded guesses should be specified with the PATHS option. + +4. Search the standard system environment variables. + This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument. + + * |SYSTEM_ENVIRONMENT_PATH_XXX| + +5. Search cmake variables defined in the Platform files + for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH + is passed. + + * |CMAKE_SYSTEM_PREFIX_PATH_XXX| + * |CMAKE_SYSTEM_XXX_PATH| + * |CMAKE_SYSTEM_XXX_MAC_PATH| + +6. Search the paths specified by the PATHS option + or in the short-hand version of the command. + These are typically hard-coded guesses. + +.. |FIND_ARGS_XXX| replace:: <VAR> NAMES name + +.. include:: FIND_XXX_MAC.txt +.. include:: FIND_XXX_ROOT.txt +.. include:: FIND_XXX_ORDER.txt diff --git a/Help/command/FIND_XXX_MAC.txt b/Help/command/FIND_XXX_MAC.txt new file mode 100644 index 0000000..eb3900c --- /dev/null +++ b/Help/command/FIND_XXX_MAC.txt @@ -0,0 +1,24 @@ +On Darwin or systems supporting OS X Frameworks, the cmake variable +CMAKE_FIND_FRAMEWORK can be set to empty or one of the following: + +* FIRST: Try to find frameworks before standard libraries or headers. + This is the default on Darwin. + +* LAST: Try to find frameworks after standard libraries or headers. + +* ONLY: Only try to find frameworks. + +* NEVER: Never try to find frameworks. + +On Darwin or systems supporting OS X Application Bundles, the cmake +variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the +following: + +* FIRST: Try to find application bundles before standard programs. + This is the default on Darwin. + +* LAST: Try to find application bundles after standard programs. + +* ONLY: Only try to find application bundles. + +* NEVER: Never try to find application bundles. diff --git a/Help/command/FIND_XXX_ORDER.txt b/Help/command/FIND_XXX_ORDER.txt new file mode 100644 index 0000000..bac2419 --- /dev/null +++ b/Help/command/FIND_XXX_ORDER.txt @@ -0,0 +1,12 @@ +The default search order is designed to be most-specific to +least-specific for common use cases. +Projects may override the order by simply calling the command +multiple times and using the ``NO_*`` options: + +.. parsed-literal:: + + |FIND_XXX| (|FIND_ARGS_XXX| PATHS paths... NO_DEFAULT_PATH) + |FIND_XXX| (|FIND_ARGS_XXX|) + +Once one of the calls succeeds the result variable will be set +and stored in the cache so that no call will search again. diff --git a/Help/command/FIND_XXX_ROOT.txt b/Help/command/FIND_XXX_ROOT.txt new file mode 100644 index 0000000..407375a --- /dev/null +++ b/Help/command/FIND_XXX_ROOT.txt @@ -0,0 +1,14 @@ +The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more +directories to be prepended to all other search directories. This +effectively "re-roots" the entire search under given locations. By +default it is empty. It is especially useful when cross-compiling to +point to the root directory of the target environment and CMake will +search there too. By default at first the directories listed in +CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be +searched. The default behavior can be adjusted by setting +|CMAKE_FIND_ROOT_PATH_MODE_XXX|. This behavior can be manually +overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH +the search order will be as described above. If +NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be +used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted +directories will be searched. diff --git a/Help/command/add_compile_options.rst b/Help/command/add_compile_options.rst new file mode 100644 index 0000000..a9329f4 --- /dev/null +++ b/Help/command/add_compile_options.rst @@ -0,0 +1,17 @@ +add_compile_options +------------------- + +Adds options to the compilation of source files. + +:: + + add_compile_options(<option> ...) + +Adds options to the compiler command line for sources in the current +directory and below. This command can be used to add any options, but +alternative commands exist to add preprocessor definitions or include +directories. See documentation of the directory and target +COMPILE_OPTIONS properties for details. Arguments to +add_compile_options may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/command/add_custom_command.rst b/Help/command/add_custom_command.rst new file mode 100644 index 0000000..4de708f --- /dev/null +++ b/Help/command/add_custom_command.rst @@ -0,0 +1,158 @@ +add_custom_command +------------------ + +Add a custom build rule to the generated build system. + +There are two main signatures for add_custom_command The first +signature is for adding a custom command to produce an output. + +:: + + add_custom_command(OUTPUT output1 [output2 ...] + COMMAND command1 [ARGS] [args1...] + [COMMAND command2 [ARGS] [args2...] ...] + [MAIN_DEPENDENCY depend] + [DEPENDS [depends...]] + [IMPLICIT_DEPENDS <lang1> depend1 + [<lang2> depend2] ...] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM] [APPEND]) + +This defines a command to generate specified OUTPUT file(s). A target +created in the same directory (CMakeLists.txt file) that specifies any +output of the custom command as a source file is given a rule to +generate the file using the command at build time. Do not list the +output in more than one independent target that may build in parallel +or the two instances of the rule may conflict (instead use +add_custom_target to drive the command and make the other targets +depend on that one). If an output name is a relative path it will be +interpreted relative to the build tree directory corresponding to the +current source directory. Note that MAIN_DEPENDENCY is completely +optional and is used as a suggestion to visual studio about where to +hang the custom command. In makefile terms this creates a new target +in the following form: + +:: + + OUTPUT: MAIN_DEPENDENCY DEPENDS + COMMAND + +If more than one command is specified they will be executed in order. +The optional ARGS argument is for backward compatibility and will be +ignored. + +The second signature adds a custom command to a target such as a +library or executable. This is useful for performing an operation +before or after building the target. The command becomes part of the +target and will only execute when the target itself is built. If the +target is already built, the command will not execute. + +:: + + add_custom_command(TARGET target + PRE_BUILD | PRE_LINK | POST_BUILD + COMMAND command1 [ARGS] [args1...] + [COMMAND command2 [ARGS] [args2...] ...] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM]) + +This defines a new command that will be associated with building the +specified target. When the command will happen is determined by which +of the following is specified: + +:: + + PRE_BUILD - run before all other dependencies + PRE_LINK - run after other dependencies + POST_BUILD - run after the target has been built + +Note that the PRE_BUILD option is only supported on Visual Studio 7 or +later. For all other generators PRE_BUILD will be treated as +PRE_LINK. + +If WORKING_DIRECTORY is specified the command will be executed in the +directory given. If it is a relative path it will be interpreted +relative to the build tree directory corresponding to the current +source directory. If COMMENT is set, the value will be displayed as a +message before the commands are executed at build time. If APPEND is +specified the COMMAND and DEPENDS option values are appended to the +custom command for the first output specified. There must have +already been a previous call to this command with the same output. +The COMMENT, WORKING_DIRECTORY, and MAIN_DEPENDENCY options are +currently ignored when APPEND is given, but may be used in the future. + +If VERBATIM is given then all arguments to the commands will be +escaped properly for the build tool so that the invoked command +receives each argument unchanged. Note that one level of escapes is +still used by the CMake language processor before add_custom_command +even sees the arguments. Use of VERBATIM is recommended as it enables +correct behavior. When VERBATIM is not given the behavior is platform +specific because there is no protection of tool-specific special +characters. + +If the output of the custom command is not actually created as a file +on disk it should be marked as SYMBOLIC with +SET_SOURCE_FILES_PROPERTIES. + +The IMPLICIT_DEPENDS option requests scanning of implicit dependencies +of an input file. The language given specifies the programming +language whose corresponding dependency scanner should be used. +Currently only C and CXX language scanners are supported. The +language has to be specified for every file in the IMPLICIT_DEPENDS +list. Dependencies discovered from the scanning are added to those of +the custom command at build time. Note that the IMPLICIT_DEPENDS +option is currently supported only for Makefile generators and will be +ignored by other generators. + +If COMMAND specifies an executable target (created by ADD_EXECUTABLE) +it will automatically be replaced by the location of the executable +created at build time. Additionally a target-level dependency will be +added so that the executable target will be built before any target +using this custom command. However this does NOT add a file-level +dependency that would cause the custom command to re-run whenever the +executable is recompiled. + +Arguments to COMMAND may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. + +References to target names in generator expressions imply target-level +dependencies, but NOT file-level dependencies. List target names with +the DEPENDS option to add file dependencies. + +The DEPENDS option specifies files on which the command depends. If +any dependency is an OUTPUT of another custom command in the same +directory (CMakeLists.txt file) CMake automatically brings the other +custom command into the target in which this command is built. If +DEPENDS is not specified the command will run whenever the OUTPUT is +missing; if the command does not actually create the OUTPUT then the +rule will always run. If DEPENDS specifies any target (created by an +ADD_* command) a target-level dependency is created to make sure the +target is built before any target using this custom command. +Additionally, if the target is an executable or library a file-level +dependency is created to cause the custom command to re-run whenever +the target is recompiled. diff --git a/Help/command/add_custom_target.rst b/Help/command/add_custom_target.rst new file mode 100644 index 0000000..1bf70bf --- /dev/null +++ b/Help/command/add_custom_target.rst @@ -0,0 +1,45 @@ +add_custom_target +----------------- + +Add a target with no output so it will always be built. + +:: + + add_custom_target(Name [ALL] [command1 [args1...]] + [COMMAND command2 [args2...] ...] + [DEPENDS depend depend depend ... ] + [WORKING_DIRECTORY dir] + [COMMENT comment] [VERBATIM] + [SOURCES src1 [src2...]]) + +Adds a target with the given name that executes the given commands. +The target has no output file and is ALWAYS CONSIDERED OUT OF DATE +even if the commands try to create a file with the name of the target. +Use ADD_CUSTOM_COMMAND to generate a file with dependencies. By +default nothing depends on the custom target. Use ADD_DEPENDENCIES to +add dependencies to or from other targets. If the ALL option is +specified it indicates that this target should be added to the default +build target so that it will be run every time (the command cannot be +called ALL). The command and arguments are optional and if not +specified an empty target will be created. If WORKING_DIRECTORY is +set, then the command will be run in that directory. If it is a +relative path it will be interpreted relative to the build tree +directory corresponding to the current source directory. If COMMENT +is set, the value will be displayed as a message before the commands +are executed at build time. Dependencies listed with the DEPENDS +argument may reference files and outputs of custom commands created +with add_custom_command() in the same directory (CMakeLists.txt file). + +If VERBATIM is given then all arguments to the commands will be +escaped properly for the build tool so that the invoked command +receives each argument unchanged. Note that one level of escapes is +still used by the CMake language processor before add_custom_target +even sees the arguments. Use of VERBATIM is recommended as it enables +correct behavior. When VERBATIM is not given the behavior is platform +specific because there is no protection of tool-specific special +characters. + +The SOURCES option specifies additional source files to be included in +the custom target. Specified source files will be added to IDE +project files for convenience in editing even if they have not build +rules. diff --git a/Help/command/add_definitions.rst b/Help/command/add_definitions.rst new file mode 100644 index 0000000..4c72752 --- /dev/null +++ b/Help/command/add_definitions.rst @@ -0,0 +1,19 @@ +add_definitions +--------------- + +Adds -D define flags to the compilation of source files. + +:: + + add_definitions(-DFOO -DBAR ...) + +Adds flags to the compiler command line for sources in the current +directory and below. This command can be used to add any flags, but +it was originally intended to add preprocessor definitions. Flags +beginning in -D or /D that look like preprocessor definitions are +automatically added to the COMPILE_DEFINITIONS property for the +current directory. Definitions with non-trivial values may be left in +the set of flags instead of being converted for reasons of backwards +compatibility. See documentation of the directory, target, and source +file COMPILE_DEFINITIONS properties for details on adding preprocessor +definitions to specific scopes and configurations. diff --git a/Help/command/add_dependencies.rst b/Help/command/add_dependencies.rst new file mode 100644 index 0000000..10997ec --- /dev/null +++ b/Help/command/add_dependencies.rst @@ -0,0 +1,19 @@ +add_dependencies +---------------- + +Add a dependency between top-level targets. + +:: + + add_dependencies(<target> [<target-dependency>]...) + +Make a top-level <target> depend on other top-level targets to ensure +that they build before <target> does. A top-level target is one +created by ADD_EXECUTABLE, ADD_LIBRARY, or ADD_CUSTOM_TARGET. +Dependencies added to an IMPORTED target are followed transitively in +its place since the target itself does not build. + +See the DEPENDS option of ADD_CUSTOM_TARGET and ADD_CUSTOM_COMMAND for +adding file-level dependencies in custom rules. See the +OBJECT_DEPENDS option in SET_SOURCE_FILES_PROPERTIES to add file-level +dependencies to object files. diff --git a/Help/command/add_executable.rst b/Help/command/add_executable.rst new file mode 100644 index 0000000..d6fd929 --- /dev/null +++ b/Help/command/add_executable.rst @@ -0,0 +1,73 @@ +add_executable +-------------- + +Add an executable to the project using the specified source files. + +:: + + add_executable(<name> [WIN32] [MACOSX_BUNDLE] + [EXCLUDE_FROM_ALL] + source1 source2 ... sourceN) + +Adds an executable target called <name> to be built from the source +files listed in the command invocation. The <name> corresponds to the +logical target name and must be globally unique within a project. The +actual file name of the executable built is constructed based on +conventions of the native platform (such as <name>.exe or just +<name>). + +By default the executable file will be created in the build tree +directory corresponding to the source tree directory in which the +command was invoked. See documentation of the +RUNTIME_OUTPUT_DIRECTORY target property to change this location. See +documentation of the OUTPUT_NAME target property to change the <name> +part of the final file name. + +If WIN32 is given the property WIN32_EXECUTABLE will be set on the +target created. See documentation of that target property for +details. + +If MACOSX_BUNDLE is given the corresponding property will be set on +the created target. See documentation of the MACOSX_BUNDLE target +property for details. + +If EXCLUDE_FROM_ALL is given the corresponding property will be set on +the created target. See documentation of the EXCLUDE_FROM_ALL target +property for details. + +The add_executable command can also create IMPORTED executable targets +using this signature: + +:: + + add_executable(<name> IMPORTED [GLOBAL]) + +An IMPORTED executable target references an executable file located +outside the project. No rules are generated to build it. The target +name has scope in the directory in which it is created and below, but +the GLOBAL option extends visibility. It may be referenced like any +target built within the project. IMPORTED executables are useful for +convenient reference from commands like add_custom_command. Details +about the imported executable are specified by setting properties +whose names begin in ``IMPORTED_``. The most important such property is +IMPORTED_LOCATION (and its per-configuration version +IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main +executable file on disk. See documentation of the IMPORTED_* +properties for more information. + +The signature + +:: + + add_executable(<name> ALIAS <target>) + +creates an alias, such that <name> can be used to refer to <target> in +subsequent commands. The <name> does not appear in the generated +buildsystem as a make target. The <target> may not be an IMPORTED +target or an ALIAS. Alias targets can be used as linkable targets, +targets to read properties from, executables for custom commands and +custom targets. They can also be tested for existance with the +regular if(TARGET) subcommand. The <name> may not be used to modify +properties of <target>, that is, it may not be used as the operand of +set_property, set_target_properties, target_link_libraries etc. An +ALIAS target may not be installed of exported. diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst new file mode 100644 index 0000000..45f1102 --- /dev/null +++ b/Help/command/add_library.rst @@ -0,0 +1,120 @@ +add_library +----------- + +Add a library to the project using the specified source files. + +:: + + add_library(<name> [STATIC | SHARED | MODULE] + [EXCLUDE_FROM_ALL] + source1 source2 ... sourceN) + +Adds a library target called <name> to be built from the source files +listed in the command invocation. The <name> corresponds to the +logical target name and must be globally unique within a project. The +actual file name of the library built is constructed based on +conventions of the native platform (such as lib<name>.a or +<name>.lib). + +STATIC, SHARED, or MODULE may be given to specify the type of library +to be created. STATIC libraries are archives of object files for use +when linking other targets. SHARED libraries are linked dynamically +and loaded at runtime. MODULE libraries are plugins that are not +linked into other targets but may be loaded dynamically at runtime +using dlopen-like functionality. If no type is given explicitly the +type is STATIC or SHARED based on whether the current value of the +variable BUILD_SHARED_LIBS is true. For SHARED and MODULE libraries +the POSITION_INDEPENDENT_CODE target property is set to TRUE +automatically. + +By default the library file will be created in the build tree +directory corresponding to the source tree directory in which the +command was invoked. See documentation of the +ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY, and +RUNTIME_OUTPUT_DIRECTORY target properties to change this location. +See documentation of the OUTPUT_NAME target property to change the +<name> part of the final file name. + +If EXCLUDE_FROM_ALL is given the corresponding property will be set on +the created target. See documentation of the EXCLUDE_FROM_ALL target +property for details. + +The add_library command can also create IMPORTED library targets using +this signature: + +:: + + add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED + [GLOBAL]) + +An IMPORTED library target references a library file located outside +the project. No rules are generated to build it. The target name has +scope in the directory in which it is created and below, but the +GLOBAL option extends visibility. It may be referenced like any +target built within the project. IMPORTED libraries are useful for +convenient reference from commands like target_link_libraries. +Details about the imported library are specified by setting properties +whose names begin in ``IMPORTED_``. The most important such property is +IMPORTED_LOCATION (and its per-configuration version +IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main +library file on disk. See documentation of the IMPORTED_* properties +for more information. + +The signature + +:: + + add_library(<name> OBJECT <src>...) + +creates a special "object library" target. An object library compiles +source files but does not archive or link their object files into a +library. Instead other targets created by add_library or +add_executable may reference the objects using an expression of the +form $<TARGET_OBJECTS:objlib> as a source, where "objlib" is the +object library name. For example: + +:: + + add_library(... $<TARGET_OBJECTS:objlib> ...) + add_executable(... $<TARGET_OBJECTS:objlib> ...) + +will include objlib's object files in a library and an executable +along with those compiled from their own sources. Object libraries +may contain only sources (and headers) that compile to object files. +They may contain custom commands generating such sources, but not +PRE_BUILD, PRE_LINK, or POST_BUILD commands. Object libraries cannot +be imported, exported, installed, or linked. Some native build +systems may not like targets that have only object files, so consider +adding at least one real source file to any target that references +$<TARGET_OBJECTS:objlib>. + +The signature + +:: + + add_library(<name> ALIAS <target>) + +creates an alias, such that <name> can be used to refer to <target> in +subsequent commands. The <name> does not appear in the generated +buildsystem as a make target. The <target> may not be an IMPORTED +target or an ALIAS. Alias targets can be used as linkable targets, +targets to read properties from. They can also be tested for +existance with the regular if(TARGET) subcommand. The <name> may not +be used to modify properties of <target>, that is, it may not be used +as the operand of set_property, set_target_properties, +target_link_libraries etc. An ALIAS target may not be installed of +exported. + +The signature + +:: + + add_library(<name> INTERFACE) + +creates an interface target. An interface target does not directly +create build output, though it may have properties set on it and it +may be installed, exported and imported. Typically the INTERFACE_* +properties are populated on the interface target using the +set_property(), target_link_libraries(), target_include_directories() +and target_compile_defintions() commands, and then it is used as an +argument to target_link_libraries() like any other target. diff --git a/Help/command/add_subdirectory.rst b/Help/command/add_subdirectory.rst new file mode 100644 index 0000000..29b5017 --- /dev/null +++ b/Help/command/add_subdirectory.rst @@ -0,0 +1,36 @@ +add_subdirectory +---------------- + +Add a subdirectory to the build. + +:: + + add_subdirectory(source_dir [binary_dir] + [EXCLUDE_FROM_ALL]) + +Add a subdirectory to the build. The source_dir specifies the +directory in which the source CMakeLists.txt and code files are +located. If it is a relative path it will be evaluated with respect +to the current directory (the typical usage), but it may also be an +absolute path. The binary_dir specifies the directory in which to +place the output files. If it is a relative path it will be evaluated +with respect to the current output directory, but it may also be an +absolute path. If binary_dir is not specified, the value of +source_dir, before expanding any relative path, will be used (the +typical usage). The CMakeLists.txt file in the specified source +directory will be processed immediately by CMake before processing in +the current input file continues beyond this command. + +If the EXCLUDE_FROM_ALL argument is provided then targets in the +subdirectory will not be included in the ALL target of the parent +directory by default, and will be excluded from IDE project files. +Users must explicitly build targets in the subdirectory. This is +meant for use when the subdirectory contains a separate part of the +project that is useful but not necessary, such as a set of examples. +Typically the subdirectory should contain its own project() command +invocation so that a full build system will be generated in the +subdirectory (such as a VS IDE solution file). Note that inter-target +dependencies supercede this exclusion. If a target built by the +parent project depends on a target in the subdirectory, the dependee +target will be included in the parent project build system to satisfy +the dependency. diff --git a/Help/command/add_test.rst b/Help/command/add_test.rst new file mode 100644 index 0000000..7363d5f --- /dev/null +++ b/Help/command/add_test.rst @@ -0,0 +1,69 @@ +add_test +-------- + +Add a test to the project with the specified arguments. + +:: + + add_test(testname Exename arg1 arg2 ... ) + +If the ENABLE_TESTING command has been run, this command adds a test +target to the current directory. If ENABLE_TESTING has not been run, +this command does nothing. The tests are run by the testing subsystem +by executing Exename with the specified arguments. Exename can be +either an executable built by this project or an arbitrary executable +on the system (like tclsh). The test will be run with the current +working directory set to the CMakeList.txt files corresponding +directory in the binary tree. Tests added using this signature do not +support generator expressions. + + + +:: + + add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]] + [WORKING_DIRECTORY dir] + COMMAND <command> [arg1 [arg2 ...]]) + +Add a test called <name>. The test name may not contain spaces, +quotes, or other characters special in CMake syntax. If COMMAND +specifies an executable target (created by add_executable) it will +automatically be replaced by the location of the executable created at +build time. If a CONFIGURATIONS option is given then the test will be +executed only when testing under one of the named configurations. If +a WORKING_DIRECTORY option is given then the test will be executed in +the given directory. + +Arguments after COMMAND may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Example usage: + +:: + + add_test(NAME mytest + COMMAND testDriver --config $<CONFIGURATION> + --exe $<TARGET_FILE:myexe>) + +This creates a test "mytest" whose command runs a testDriver tool +passing the configuration name and the full path to the executable +file produced by target "myexe". diff --git a/Help/command/aux_source_directory.rst b/Help/command/aux_source_directory.rst new file mode 100644 index 0000000..434d7a9 --- /dev/null +++ b/Help/command/aux_source_directory.rst @@ -0,0 +1,24 @@ +aux_source_directory +-------------------- + +Find all source files in a directory. + +:: + + aux_source_directory(<dir> <variable>) + +Collects the names of all the source files in the specified directory +and stores the list in the <variable> provided. This command is +intended to be used by projects that use explicit template +instantiation. Template instantiation files can be stored in a +"Templates" subdirectory and collected automatically using this +command to avoid manually listing all instantiations. + +It is tempting to use this command to avoid writing the list of source +files for a library or executable target. While this seems to work, +there is no way for CMake to generate a build system that knows when a +new source file has been added. Normally the generated build system +knows when it needs to rerun CMake because the CMakeLists.txt file is +modified to add a new source. When the source is just added to the +directory without modifying this file, one would have to manually +rerun CMake to generate a build system incorporating the new file. diff --git a/Help/command/break.rst b/Help/command/break.rst new file mode 100644 index 0000000..8f1067b --- /dev/null +++ b/Help/command/break.rst @@ -0,0 +1,10 @@ +break +----- + +Break from an enclosing foreach or while loop. + +:: + + break() + +Breaks from an enclosing foreach loop or while loop diff --git a/Help/command/build_command.rst b/Help/command/build_command.rst new file mode 100644 index 0000000..f4a56f0 --- /dev/null +++ b/Help/command/build_command.rst @@ -0,0 +1,37 @@ +build_command +------------- + +Get the command line to build this project. + +:: + + build_command(<variable> + [CONFIGURATION <config>] + [PROJECT_NAME <projname>] + [TARGET <target>]) + +Sets the given <variable> to a string containing the command line for +building one configuration of a target in a project using the build +tool appropriate for the current CMAKE_GENERATOR. + +If CONFIGURATION is omitted, CMake chooses a reasonable default value +for multi-configuration generators. CONFIGURATION is ignored for +single-configuration generators. + +If PROJECT_NAME is omitted, the resulting command line will build the +top level PROJECT in the current build tree. + +If TARGET is omitted, the resulting command line will build +everything, effectively using build target 'all' or 'ALL_BUILD'. + +:: + + build_command(<cachevariable> <makecommand>) + +This second signature is deprecated, but still available for backwards +compatibility. Use the first signature instead. + +Sets the given <cachevariable> to a string containing the command to +build this project from the root of the build tree using the build +tool given by <makecommand>. <makecommand> should be the full path to +msdev, devenv, nmake, make or one of the end user build tools. diff --git a/Help/command/build_name.rst b/Help/command/build_name.rst new file mode 100644 index 0000000..2148e49 --- /dev/null +++ b/Help/command/build_name.rst @@ -0,0 +1,12 @@ +build_name +---------- + +Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead. + +:: + + build_name(variable) + +Sets the specified variable to a string representing the platform and +compiler settings. These values are now available through the +CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables. diff --git a/Help/command/cmake_host_system_information.rst b/Help/command/cmake_host_system_information.rst new file mode 100644 index 0000000..ba545d5 --- /dev/null +++ b/Help/command/cmake_host_system_information.rst @@ -0,0 +1,25 @@ +cmake_host_system_information +----------------------------- + +Query host system specific information. + +:: + + cmake_host_system_information(RESULT <variable> QUERY <key> ...) + +Queries system information of the host system on which cmake runs. +One or more <key> can be provided to select the information to be +queried. The list of queried values is stored in <variable>. + +<key> can be one of the following values: + +:: + + NUMBER_OF_LOGICAL_CORES = Number of logical cores. + NUMBER_OF_PHYSICAL_CORES = Number of physical cores. + HOSTNAME = Hostname. + FQDN = Fully qualified domain name. + TOTAL_VIRTUAL_MEMORY = Total virtual memory in megabytes. + AVAILABLE_VIRTUAL_MEMORY = Available virtual memory in megabytes. + TOTAL_PHYSICAL_MEMORY = Total physical memory in megabytes. + AVAILABLE_PHYSICAL_MEMORY = Available physical memory in megabytes. diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst new file mode 100644 index 0000000..1bdffa4 --- /dev/null +++ b/Help/command/cmake_minimum_required.rst @@ -0,0 +1,30 @@ +cmake_minimum_required +---------------------- + +Set the minimum required version of cmake for a project. + +:: + + cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]] + [FATAL_ERROR]) + +If the current version of CMake is lower than that required it will +stop processing the project and report an error. When a version +higher than 2.4 is specified the command implicitly invokes + +:: + + cmake_policy(VERSION major[.minor[.patch[.tweak]]]) + +which sets the cmake policy version level to the version specified. +When version 2.4 or lower is given the command implicitly invokes + +:: + + cmake_policy(VERSION 2.4) + +which enables compatibility features for CMake 2.4 and lower. + +The FATAL_ERROR option is accepted but ignored by CMake 2.6 and +higher. It should be specified so CMake versions 2.4 and lower fail +with an error instead of just a warning. diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst new file mode 100644 index 0000000..46db8d3 --- /dev/null +++ b/Help/command/cmake_policy.rst @@ -0,0 +1,78 @@ +cmake_policy +------------ + +Manage CMake Policy settings. + +As CMake evolves it is sometimes necessary to change existing behavior +in order to fix bugs or improve implementations of existing features. +The CMake Policy mechanism is designed to help keep existing projects +building as new versions of CMake introduce changes in behavior. Each +new policy (behavioral change) is given an identifier of the form +"CMP<NNNN>" where "<NNNN>" is an integer index. Documentation +associated with each policy describes the OLD and NEW behavior and the +reason the policy was introduced. Projects may set each policy to +select the desired behavior. When CMake needs to know which behavior +to use it checks for a setting specified by the project. If no +setting is available the OLD behavior is assumed and a warning is +produced requesting that the policy be set. + +The cmake_policy command is used to set policies to OLD or NEW +behavior. While setting policies individually is supported, we +encourage projects to set policies based on CMake versions. + +:: + + cmake_policy(VERSION major.minor[.patch[.tweak]]) + +Specify that the current CMake list file is written for the given +version of CMake. All policies introduced in the specified version or +earlier will be set to use NEW behavior. All policies introduced +after the specified version will be unset (unless variable +CMAKE_POLICY_DEFAULT_CMP<NNNN> sets a default). This effectively +requests behavior preferred as of a given CMake version and tells +newer CMake versions to warn about their new policies. The policy +version specified must be at least 2.4 or the command will report an +error. In order to get compatibility features supporting versions +earlier than 2.4 see documentation of policy CMP0001. + +:: + + cmake_policy(SET CMP<NNNN> NEW) + cmake_policy(SET CMP<NNNN> OLD) + +Tell CMake to use the OLD or NEW behavior for a given policy. +Projects depending on the old behavior of a given policy may silence a +policy warning by setting the policy state to OLD. Alternatively one +may fix the project to work with the new behavior and set the policy +state to NEW. + +:: + + cmake_policy(GET CMP<NNNN> <variable>) + +Check whether a given policy is set to OLD or NEW behavior. The +output variable value will be "OLD" or "NEW" if the policy is set, and +empty otherwise. + +CMake keeps policy settings on a stack, so changes made by the +cmake_policy command affect only the top of the stack. A new entry on +the policy stack is managed automatically for each subdirectory to +protect its parents and siblings. CMake also manages a new entry for +scripts loaded by include() and find_package() commands except when +invoked with the NO_POLICY_SCOPE option (see also policy CMP0011). +The cmake_policy command provides an interface to manage custom +entries on the policy stack: + +:: + + cmake_policy(PUSH) + cmake_policy(POP) + +Each PUSH must have a matching POP to erase any changes. This is +useful to make temporary changes to policy settings. + +Functions and macros record policy settings when they are created and +use the pre-record policies when they are invoked. If the function or +macro implementation sets policies, the changes automatically +propagate up through callers until they reach the closest nested +policy stack entry. diff --git a/Help/command/configure_file.rst b/Help/command/configure_file.rst new file mode 100644 index 0000000..70357f2 --- /dev/null +++ b/Help/command/configure_file.rst @@ -0,0 +1,46 @@ +configure_file +-------------- + +Copy a file to another location and modify its contents. + +:: + + configure_file(<input> <output> + [COPYONLY] [ESCAPE_QUOTES] [@ONLY] + [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ]) + +Copies a file <input> to file <output> and substitutes variable values +referenced in the file content. If <input> is a relative path it is +evaluated with respect to the current source directory. The <input> +must be a file, not a directory. If <output> is a relative path it is +evaluated with respect to the current binary directory. If <output> +names an existing directory the input file is placed in that directory +with its original name. + +If the <input> file is modified the build system will re-run CMake to +re-configure the file and generate the build system again. + +This command replaces any variables in the input file referenced as +${VAR} or @VAR@ with their values as determined by CMake. If a +variable is not defined, it will be replaced with nothing. If +COPYONLY is specified, then no variable expansion will take place. If +ESCAPE_QUOTES is specified then any substituted quotes will be C-style +escaped. The file will be configured with the current values of CMake +variables. If @ONLY is specified, only variables of the form @VAR@ +will be replaced and ${VAR} will be ignored. This is useful for +configuring scripts that use ${VAR}. + +Input file lines of the form "#cmakedefine VAR ..." will be replaced +with either "#define VAR ..." or ``/* #undef VAR */`` depending on +whether VAR is set in CMake to any value not considered a false +constant by the if() command. (Content of "...", if any, is processed +as above.) Input file lines of the form "#cmakedefine01 VAR" will be +replaced with either "#define VAR 1" or "#define VAR 0" similarly. + +With NEWLINE_STYLE the line ending could be adjusted: + +:: + + 'UNIX' or 'LF' for \n, 'DOS', 'WIN32' or 'CRLF' for \r\n. + +COPYONLY must not be used with NEWLINE_STYLE. diff --git a/Help/command/create_test_sourcelist.rst b/Help/command/create_test_sourcelist.rst new file mode 100644 index 0000000..9addd67 --- /dev/null +++ b/Help/command/create_test_sourcelist.rst @@ -0,0 +1,30 @@ +create_test_sourcelist +---------------------- + +Create a test driver and source list for building test programs. + +:: + + create_test_sourcelist(sourceListName driverName + test1 test2 test3 + EXTRA_INCLUDE include.h + FUNCTION function) + +A test driver is a program that links together many small tests into a +single executable. This is useful when building static executables +with large libraries to shrink the total required size. The list of +source files needed to build the test driver will be in +sourceListName. DriverName is the name of the test driver program. +The rest of the arguments consist of a list of test source files, can +be semicolon separated. Each test source file should have a function +in it that is the same name as the file with no extension (foo.cxx +should have int foo(int, char*[]);) DriverName will be able to call +each of the tests by name on the command line. If EXTRA_INCLUDE is +specified, then the next argument is included into the generated file. +If FUNCTION is specified, then the next argument is taken as a +function name that is passed a pointer to ac and av. This can be used +to add extra command line processing to each test. The cmake variable +CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be +placed directly before calling the test main function. +CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be +placed directly after the call to the test main function. diff --git a/Help/command/ctest_build.rst b/Help/command/ctest_build.rst new file mode 100644 index 0000000..ac2a0c1 --- /dev/null +++ b/Help/command/ctest_build.rst @@ -0,0 +1,24 @@ +ctest_build +----------- + +Build the project. + +:: + + ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res] + [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val]) + +Builds the given build directory and stores results in Build.xml. If +no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. + +The TARGET variable can be used to specify a build target. If none is +specified, the "all" target will be built. + +The RETURN_VALUE option specifies a variable in which to store the +return value of the native build tool. The NUMBER_ERRORS and +NUMBER_WARNINGS options specify variables in which to store the number +of build errors and warnings detected. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_configure.rst b/Help/command/ctest_configure.rst new file mode 100644 index 0000000..2c4e305 --- /dev/null +++ b/Help/command/ctest_configure.rst @@ -0,0 +1,21 @@ +ctest_configure +--------------- + +Configure the project build tree. + +:: + + ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND] + [OPTIONS options] [RETURN_VALUE res]) + +Configures the given build directory and stores results in +Configure.xml. If no BUILD is given, the CTEST_BINARY_DIRECTORY +variable is used. If no SOURCE is given, the CTEST_SOURCE_DIRECTORY +variable is used. The OPTIONS argument specifies command line +arguments to pass to the configuration tool. The RETURN_VALUE option +specifies a variable in which to store the return value of the native +build tool. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst new file mode 100644 index 0000000..4c90f9c --- /dev/null +++ b/Help/command/ctest_coverage.rst @@ -0,0 +1,20 @@ +ctest_coverage +-------------- + +Collect coverage tool results. + +:: + + ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND] + [LABELS label1 [label2 [...]]]) + +Perform the coverage of the given build directory and stores results +in Coverage.xml. The second argument is a variable that will hold +value. + +The LABELS option filters the coverage report to include only source +files labeled with at least one of the labels specified. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_empty_binary_directory.rst b/Help/command/ctest_empty_binary_directory.rst new file mode 100644 index 0000000..7753667 --- /dev/null +++ b/Help/command/ctest_empty_binary_directory.rst @@ -0,0 +1,12 @@ +ctest_empty_binary_directory +---------------------------- + +empties the binary directory + +:: + + ctest_empty_binary_directory( directory ) + +Removes a binary directory. This command will perform some checks +prior to deleting the directory in an attempt to avoid malicious or +accidental directory deletion. diff --git a/Help/command/ctest_memcheck.rst b/Help/command/ctest_memcheck.rst new file mode 100644 index 0000000..ca47ed0 --- /dev/null +++ b/Help/command/ctest_memcheck.rst @@ -0,0 +1,28 @@ +ctest_memcheck +-------------- + +Run tests with a dynamic analysis tool. + +:: + + ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND] + [START start number] [END end number] + [STRIDE stride number] [EXCLUDE exclude regex ] + [INCLUDE include regex] + [EXCLUDE_LABEL exclude regex] + [INCLUDE_LABEL label regex] + [PARALLEL_LEVEL level] ) + +Tests the given build directory and stores results in MemCheck.xml. +The second argument is a variable that will hold value. Optionally, +you can specify the starting test number START, the ending test number +END, the number of tests to skip between each test STRIDE, a regular +expression for tests to run INCLUDE, or a regular expression for tests +not to run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular +expressions for tests to be included or excluded by the test property +LABEL. PARALLEL_LEVEL should be set to a positive number representing +the number of tests to be run in parallel. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_read_custom_files.rst b/Help/command/ctest_read_custom_files.rst new file mode 100644 index 0000000..0bc57cd --- /dev/null +++ b/Help/command/ctest_read_custom_files.rst @@ -0,0 +1,11 @@ +ctest_read_custom_files +----------------------- + +read CTestCustom files. + +:: + + ctest_read_custom_files( directory ... ) + +Read all the CTestCustom.ctest or CTestCustom.cmake files from the +given directory. diff --git a/Help/command/ctest_run_script.rst b/Help/command/ctest_run_script.rst new file mode 100644 index 0000000..0f35019 --- /dev/null +++ b/Help/command/ctest_run_script.rst @@ -0,0 +1,15 @@ +ctest_run_script +---------------- + +runs a ctest -S script + +:: + + ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 + script_file_name2 ... [RETURN_VALUE var]) + +Runs a script or scripts much like if it was run from ctest -S. If no +argument is provided then the current script is run using the current +settings of the variables. If NEW_PROCESS is specified then each +script will be run in a separate process.If RETURN_VALUE is specified +the return value of the last script run will be put into var. diff --git a/Help/command/ctest_sleep.rst b/Help/command/ctest_sleep.rst new file mode 100644 index 0000000..16a914c --- /dev/null +++ b/Help/command/ctest_sleep.rst @@ -0,0 +1,16 @@ +ctest_sleep +----------- + +sleeps for some amount of time + +:: + + ctest_sleep(<seconds>) + +Sleep for given number of seconds. + +:: + + ctest_sleep(<time1> <duration> <time2>) + +Sleep for t=(time1 + duration - time2) seconds if t > 0. diff --git a/Help/command/ctest_start.rst b/Help/command/ctest_start.rst new file mode 100644 index 0000000..f16142e --- /dev/null +++ b/Help/command/ctest_start.rst @@ -0,0 +1,16 @@ +ctest_start +----------- + +Starts the testing for a given model + +:: + + ctest_start(Model [TRACK <track>] [APPEND] [source [binary]]) + +Starts the testing for a given model. The command should be called +after the binary directory is initialized. If the 'source' and +'binary' directory are not specified, it reads the +CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is +specified, the submissions will go to the specified track. If APPEND +is used, the existing TAG is used rather than creating a new one based +on the current time stamp. diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst new file mode 100644 index 0000000..29d2f5d --- /dev/null +++ b/Help/command/ctest_submit.rst @@ -0,0 +1,34 @@ +ctest_submit +------------ + +Submit results to a dashboard server. + +:: + + ctest_submit([PARTS ...] [FILES ...] [RETRY_COUNT count] [RETRY_DELAY delay][RETURN_VALUE res]) + +By default all available parts are submitted if no PARTS or FILES are +specified. The PARTS option lists a subset of parts to be submitted. +Valid part names are: + +:: + + Start = nothing + Update = ctest_update results, in Update.xml + Configure = ctest_configure results, in Configure.xml + Build = ctest_build results, in Build.xml + Test = ctest_test results, in Test.xml + Coverage = ctest_coverage results, in Coverage.xml + MemCheck = ctest_memcheck results, in DynamicAnalysis.xml + Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml + ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES + Submit = nothing + +The FILES option explicitly lists specific files to be submitted. +Each individual file must exist at the time of the call. + +The RETRY_DELAY option specifies how long in seconds to wait after a +timed-out submission before attempting to re-submit. + +The RETRY_COUNT option specifies how many times to retry a timed-out +submission. diff --git a/Help/command/ctest_test.rst b/Help/command/ctest_test.rst new file mode 100644 index 0000000..5f28083 --- /dev/null +++ b/Help/command/ctest_test.rst @@ -0,0 +1,33 @@ +ctest_test +---------- + +Run tests in the project build tree. + +:: + + ctest_test([BUILD build_dir] [APPEND] + [START start number] [END end number] + [STRIDE stride number] [EXCLUDE exclude regex ] + [INCLUDE include regex] [RETURN_VALUE res] + [EXCLUDE_LABEL exclude regex] + [INCLUDE_LABEL label regex] + [PARALLEL_LEVEL level] + [SCHEDULE_RANDOM on] + [STOP_TIME time of day]) + +Tests the given build directory and stores results in Test.xml. The +second argument is a variable that will hold value. Optionally, you +can specify the starting test number START, the ending test number +END, the number of tests to skip between each test STRIDE, a regular +expression for tests to run INCLUDE, or a regular expression for tests +to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular +expression for test to be included or excluded by the test property +LABEL. PARALLEL_LEVEL should be set to a positive number representing +the number of tests to be run in parallel. SCHEDULE_RANDOM will +launch tests in a random order, and is typically used to detect +implicit test dependencies. STOP_TIME is the time of day at which the +tests should all stop running. + +The APPEND option marks results for append to those previously +submitted to a dashboard server since the last ctest_start. Append +semantics are defined by the dashboard server in use. diff --git a/Help/command/ctest_update.rst b/Help/command/ctest_update.rst new file mode 100644 index 0000000..d34e192 --- /dev/null +++ b/Help/command/ctest_update.rst @@ -0,0 +1,13 @@ +ctest_update +------------ + +Update the work tree from version control. + +:: + + ctest_update([SOURCE source] [RETURN_VALUE res]) + +Updates the given source directory and stores results in Update.xml. +If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. +The RETURN_VALUE option specifies a variable in which to store the +result, which is the number of files updated or -1 on error. diff --git a/Help/command/ctest_upload.rst b/Help/command/ctest_upload.rst new file mode 100644 index 0000000..9156af5 --- /dev/null +++ b/Help/command/ctest_upload.rst @@ -0,0 +1,11 @@ +ctest_upload +------------ + +Upload files to a dashboard server. + +:: + + ctest_upload(FILES ...) + +Pass a list of files to be sent along with the build results to the +dashboard server. diff --git a/Help/command/define_property.rst b/Help/command/define_property.rst new file mode 100644 index 0000000..62bcd1b --- /dev/null +++ b/Help/command/define_property.rst @@ -0,0 +1,45 @@ +define_property +--------------- + +Define and document custom properties. + +:: + + define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE | + TEST | VARIABLE | CACHED_VARIABLE> + PROPERTY <name> [INHERITED] + BRIEF_DOCS <brief-doc> [docs...] + FULL_DOCS <full-doc> [docs...]) + +Define one property in a scope for use with the set_property and +get_property commands. This is primarily useful to associate +documentation with property names that may be retrieved with the +get_property command. The first argument determines the kind of scope +in which the property should be used. It must be one of the +following: + +:: + + GLOBAL = associated with the global namespace + DIRECTORY = associated with one directory + TARGET = associated with one target + SOURCE = associated with one source file + TEST = associated with a test named with add_test + VARIABLE = documents a CMake language variable + CACHED_VARIABLE = documents a CMake cache variable + +Note that unlike set_property and get_property no actual scope needs +to be given; only the kind of scope is important. + +The required PROPERTY option is immediately followed by the name of +the property being defined. + +If the INHERITED option then the get_property command will chain up to +the next higher scope when the requested property is not set in the +scope given to the command. DIRECTORY scope chains to GLOBAL. +TARGET, SOURCE, and TEST chain to DIRECTORY. + +The BRIEF_DOCS and FULL_DOCS options are followed by strings to be +associated with the property as its brief and full documentation. +Corresponding options to the get_property command will retrieve the +documentation. diff --git a/Help/command/else.rst b/Help/command/else.rst new file mode 100644 index 0000000..5eece95 --- /dev/null +++ b/Help/command/else.rst @@ -0,0 +1,10 @@ +else +---- + +Starts the else portion of an if block. + +:: + + else(expression) + +See the if command. diff --git a/Help/command/elseif.rst b/Help/command/elseif.rst new file mode 100644 index 0000000..96ee0e9 --- /dev/null +++ b/Help/command/elseif.rst @@ -0,0 +1,10 @@ +elseif +------ + +Starts the elseif portion of an if block. + +:: + + elseif(expression) + +See the if command. diff --git a/Help/command/enable_language.rst b/Help/command/enable_language.rst new file mode 100644 index 0000000..d46ff7e --- /dev/null +++ b/Help/command/enable_language.rst @@ -0,0 +1,22 @@ +enable_language +--------------- + +Enable a language (CXX/C/Fortran/etc) + +:: + + enable_language(<lang> [OPTIONAL] ) + +This command enables support for the named language in CMake. This is +the same as the project command but does not create any of the extra +variables that are created by the project command. Example languages +are CXX, C, Fortran. + +This command must be called in file scope, not in a function call. +Furthermore, it must be called in the highest directory common to all +targets using the named language directly for compiling sources or +indirectly through link dependencies. It is simplest to enable all +needed languages in the top-level directory of a project. + +The OPTIONAL keyword is a placeholder for future implementation and +does not currently work. diff --git a/Help/command/enable_testing.rst b/Help/command/enable_testing.rst new file mode 100644 index 0000000..41ecd5b --- /dev/null +++ b/Help/command/enable_testing.rst @@ -0,0 +1,13 @@ +enable_testing +-------------- + +Enable testing for current directory and below. + +:: + + enable_testing() + +Enables testing for this directory and below. See also the add_test +command. Note that ctest expects to find a test file in the build +directory root. Therefore, this command should be in the source +directory root. diff --git a/Help/command/endforeach.rst b/Help/command/endforeach.rst new file mode 100644 index 0000000..f23552d --- /dev/null +++ b/Help/command/endforeach.rst @@ -0,0 +1,10 @@ +endforeach +---------- + +Ends a list of commands in a FOREACH block. + +:: + + endforeach(expression) + +See the FOREACH command. diff --git a/Help/command/endfunction.rst b/Help/command/endfunction.rst new file mode 100644 index 0000000..63e70ba --- /dev/null +++ b/Help/command/endfunction.rst @@ -0,0 +1,10 @@ +endfunction +----------- + +Ends a list of commands in a function block. + +:: + + endfunction(expression) + +See the function command. diff --git a/Help/command/endif.rst b/Help/command/endif.rst new file mode 100644 index 0000000..4c9955c --- /dev/null +++ b/Help/command/endif.rst @@ -0,0 +1,10 @@ +endif +----- + +Ends a list of commands in an if block. + +:: + + endif(expression) + +See the if command. diff --git a/Help/command/endmacro.rst b/Help/command/endmacro.rst new file mode 100644 index 0000000..524fc80 --- /dev/null +++ b/Help/command/endmacro.rst @@ -0,0 +1,10 @@ +endmacro +-------- + +Ends a list of commands in a macro block. + +:: + + endmacro(expression) + +See the macro command. diff --git a/Help/command/endwhile.rst b/Help/command/endwhile.rst new file mode 100644 index 0000000..11fdc1b --- /dev/null +++ b/Help/command/endwhile.rst @@ -0,0 +1,10 @@ +endwhile +-------- + +Ends a list of commands in a while block. + +:: + + endwhile(expression) + +See the while command. diff --git a/Help/command/exec_program.rst b/Help/command/exec_program.rst new file mode 100644 index 0000000..aaa0dac --- /dev/null +++ b/Help/command/exec_program.rst @@ -0,0 +1,24 @@ +exec_program +------------ + +Deprecated. Use the execute_process() command instead. + +Run an executable program during the processing of the CMakeList.txt +file. + +:: + + exec_program(Executable [directory in which to run] + [ARGS <arguments to executable>] + [OUTPUT_VARIABLE <var>] + [RETURN_VALUE <var>]) + +The executable is run in the optionally specified directory. The +executable can include arguments if it is double quoted, but it is +better to use the optional ARGS argument to specify arguments to the +program. This is because cmake will then be able to escape spaces in +the executable path. An optional argument OUTPUT_VARIABLE specifies a +variable in which to store the output. To capture the return value of +the execution, provide a RETURN_VALUE. If OUTPUT_VARIABLE is +specified, then no output will go to the stdout/stderr of the console +running cmake. diff --git a/Help/command/execute_process.rst b/Help/command/execute_process.rst new file mode 100644 index 0000000..3f0ccc2 --- /dev/null +++ b/Help/command/execute_process.rst @@ -0,0 +1,48 @@ +execute_process +--------------- + +Execute one or more child processes. + +:: + + execute_process(COMMAND <cmd1> [args1...]] + [COMMAND <cmd2> [args2...] [...]] + [WORKING_DIRECTORY <directory>] + [TIMEOUT <seconds>] + [RESULT_VARIABLE <variable>] + [OUTPUT_VARIABLE <variable>] + [ERROR_VARIABLE <variable>] + [INPUT_FILE <file>] + [OUTPUT_FILE <file>] + [ERROR_FILE <file>] + [OUTPUT_QUIET] + [ERROR_QUIET] + [OUTPUT_STRIP_TRAILING_WHITESPACE] + [ERROR_STRIP_TRAILING_WHITESPACE]) + +Runs the given sequence of one or more commands with the standard +output of each process piped to the standard input of the next. A +single standard error pipe is used for all processes. If +WORKING_DIRECTORY is given the named directory will be set as the +current working directory of the child processes. If TIMEOUT is given +the child processes will be terminated if they do not finish in the +specified number of seconds (fractions are allowed). If +RESULT_VARIABLE is given the variable will be set to contain the +result of running the processes. This will be an integer return code +from the last child or a string describing an error condition. If +OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named will be +set with the contents of the standard output and standard error pipes +respectively. If the same variable is named for both pipes their +output will be merged in the order produced. If INPUT_FILE, +OUTPUT_FILE, or ERROR_FILE is given the file named will be attached to +the standard input of the first process, standard output of the last +process, or standard error of all processes respectively. If +OUTPUT_QUIET or ERROR_QUIET is given then the standard output or +standard error results will be quietly ignored. If more than one +OUTPUT_* or ERROR_* option is given for the same pipe the precedence +is not specified. If no OUTPUT_* or ERROR_* options are given the +output will be shared with the corresponding pipes of the CMake +process itself. + +The execute_process command is a newer more powerful version of +exec_program, but the old command has been kept for compatibility. diff --git a/Help/command/export.rst b/Help/command/export.rst new file mode 100644 index 0000000..c293340 --- /dev/null +++ b/Help/command/export.rst @@ -0,0 +1,44 @@ +export +------ + +Export targets from the build tree for use by outside projects. + +:: + + export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>] + [APPEND] FILE <filename> [EXPORT_LINK_INTERFACE_LIBRARIES]) + +Create a file <filename> that may be included by outside projects to +import targets from the current project's build tree. This is useful +during cross-compiling to build utility executables that can run on +the host platform in one project and then import them into another +project being compiled for the target platform. If the NAMESPACE +option is given the <namespace> string will be prepended to all target +names written to the file. If the APPEND option is given the +generated code will be appended to the file instead of overwriting it. +The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the +contents of the properties matching +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?`` to be exported, when +policy CMP0022 is NEW. If a library target is included in the export +but a target to which it links is not included the behavior is +unspecified. + +The file created by this command is specific to the build tree and +should never be installed. See the install(EXPORT) command to export +targets from an installation tree. + +The properties set on the generated IMPORTED targets will have the +same values as the final values of the input TARGETS. + +:: + + export(PACKAGE <name>) + +Store the current build directory in the CMake user package registry +for package <name>. The find_package command may consider the +directory while searching for package <name>. This helps dependent +projects find and use a package from the current project's build tree +without help from the user. Note that the entry in the package +registry that this command creates works only in conjunction with a +package configuration file (<name>Config.cmake) that works with the +build tree. diff --git a/Help/command/export_library_dependencies.rst b/Help/command/export_library_dependencies.rst new file mode 100644 index 0000000..c09f3d5 --- /dev/null +++ b/Help/command/export_library_dependencies.rst @@ -0,0 +1,26 @@ +export_library_dependencies +--------------------------- + +Deprecated. Use INSTALL(EXPORT) or EXPORT command. + +This command generates an old-style library dependencies file. +Projects requiring CMake 2.6 or later should not use the command. Use +instead the install(EXPORT) command to help export targets from an +installation tree and the export() command to export targets from a +build tree. + +The old-style library dependencies file does not take into account +per-configuration names of libraries or the LINK_INTERFACE_LIBRARIES +target property. + +:: + + export_library_dependencies(<file> [APPEND]) + +Create a file named <file> that can be included into a CMake listfile +with the INCLUDE command. The file will contain a number of SET +commands that will set all the variables needed for library dependency +information. This should be the last command in the top level +CMakeLists.txt file of the project. If the APPEND option is +specified, the SET commands will be appended to the given file instead +of replacing it. diff --git a/Help/command/file.rst b/Help/command/file.rst new file mode 100644 index 0000000..83ade1d --- /dev/null +++ b/Help/command/file.rst @@ -0,0 +1,213 @@ +file +---- + +File manipulation command. + +:: + + file(WRITE filename "message to write"... ) + file(APPEND filename "message to write"... ) + file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX]) + file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> filename variable) + file(STRINGS filename variable [LIMIT_COUNT num] + [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes] + [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes] + [NEWLINE_CONSUME] [REGEX regex] + [NO_HEX_CONVERSION]) + file(GLOB variable [RELATIVE path] [globbing expressions]...) + file(GLOB_RECURSE variable [RELATIVE path] + [FOLLOW_SYMLINKS] [globbing expressions]...) + file(RENAME <oldname> <newname>) + file(REMOVE [file1 ...]) + file(REMOVE_RECURSE [file1 ...]) + file(MAKE_DIRECTORY [directory1 directory2 ...]) + file(RELATIVE_PATH variable directory file) + file(TO_CMAKE_PATH path result) + file(TO_NATIVE_PATH path result) + file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout] + [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS] + [EXPECTED_HASH ALGO=value] [EXPECTED_MD5 sum] + [TLS_VERIFY on|off] [TLS_CAINFO file]) + file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout] + [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]) + file(TIMESTAMP filename variable [<format string>] [UTC]) + file(GENERATE OUTPUT output_file + <INPUT input_file|CONTENT input_content> + [CONDITION expression]) + +WRITE will write a message into a file called 'filename'. It +overwrites the file if it already exists, and creates the file if it +does not exist. (If the file is a build input, use configure_file to +update the file only when its content changes.) + +APPEND will write a message into a file same as WRITE, except it will +append it to the end of the file + +READ will read the content of a file and store it into the variable. +It will start at the given offset and read up to numBytes. If the +argument HEX is given, the binary data will be converted to +hexadecimal representation and this will be stored in the variable. + +MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 will compute a +cryptographic hash of the content of a file. + +STRINGS will parse a list of ASCII strings from a file and store it in +a variable. Binary data in the file are ignored. Carriage return +(CR) characters are ignored. It works also for Intel Hex and Motorola +S-record files, which are automatically converted to binary format +when reading them. Disable this using NO_HEX_CONVERSION. + +LIMIT_COUNT sets the maximum number of strings to return. LIMIT_INPUT +sets the maximum number of bytes to read from the input file. +LIMIT_OUTPUT sets the maximum number of bytes to store in the output +variable. LENGTH_MINIMUM sets the minimum length of a string to +return. Shorter strings are ignored. LENGTH_MAXIMUM sets the maximum +length of a string to return. Longer strings are split into strings +no longer than the maximum length. NEWLINE_CONSUME allows newlines to +be included in strings instead of terminating them. + +REGEX specifies a regular expression that a string must match to be +returned. Typical usage + +:: + + file(STRINGS myfile.txt myfile) + +stores a list in the variable "myfile" in which each item is a line +from the input file. + +GLOB will generate a list of all files that match the globbing +expressions and store it into the variable. Globbing expressions are +similar to regular expressions, but much simpler. If RELATIVE flag is +specified for an expression, the results will be returned as a +relative path to the given path. (We do not recommend using GLOB to +collect a list of source files from your source tree. If no +CMakeLists.txt file changes when a source is added or removed then the +generated build system cannot know when to ask CMake to regenerate.) + +Examples of globbing expressions include: + +:: + + *.cxx - match all files with extension cxx + *.vt? - match all files with extension vta,...,vtz + f[3-5].txt - match files f3.txt, f4.txt, f5.txt + +GLOB_RECURSE will generate a list similar to the regular GLOB, except +it will traverse all the subdirectories of the matched directory and +match the files. Subdirectories that are symlinks are only traversed +if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. +See cmake --help-policy CMP0009 for more information. + +Examples of recursive globbing include: + +:: + + /dir/*.py - match all python files in /dir and subdirectories + +MAKE_DIRECTORY will create the given directories, also if their parent +directories don't exist yet + +RENAME moves a file or directory within a filesystem, replacing the +destination atomically. + +REMOVE will remove the given files, also in subdirectories + +REMOVE_RECURSE will remove the given files and directories, also +non-empty directories + +RELATIVE_PATH will determine relative path from directory to the given +file. + +TO_CMAKE_PATH will convert path into a cmake style path with unix /. +The input can be a single path or a system path like "$ENV{PATH}". +Note the double quotes around the ENV call TO_CMAKE_PATH only takes +one argument. This command will also convert the native list +delimiters for a list of paths like the PATH environment variable. + +TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from a +cmake style path into the native path style \ for windows and / for +UNIX. + +DOWNLOAD will download the given URL to the given file. If LOG var is +specified a log of the download will be put in var. If STATUS var is +specified the status of the operation will be put in var. The status +is returned in a list of length 2. The first element is the numeric +return value for the operation, and the second element is a string +value for the error. A 0 numeric error means no error in the +operation. If TIMEOUT time is specified, the operation will timeout +after time seconds, time should be specified as an integer. The +INACTIVITY_TIMEOUT specifies an integer number of seconds of +inactivity after which the operation should terminate. If +EXPECTED_HASH ALGO=value is specified, the operation will verify that +the downloaded file's actual hash matches the expected value, where +ALGO is one of MD5, SHA1, SHA224, SHA256, SHA384, or SHA512. If it +does not match, the operation fails with an error. ("EXPECTED_MD5 +sum" is short-hand for "EXPECTED_HASH MD5=sum".) If SHOW_PROGRESS is +specified, progress information will be printed as status messages +until the operation is complete. For https URLs CMake must be built +with OpenSSL. TLS/SSL certificates are not checked by default. Set +TLS_VERIFY to ON to check certificates and/or use EXPECTED_HASH to +verify downloaded content. Set TLS_CAINFO to specify a custom +Certificate Authority file. If either TLS option is not given CMake +will check variables CMAKE_TLS_VERIFY and CMAKE_TLS_CAINFO, +respectively. + +UPLOAD will upload the given file to the given URL. If LOG var is +specified a log of the upload will be put in var. If STATUS var is +specified the status of the operation will be put in var. The status +is returned in a list of length 2. The first element is the numeric +return value for the operation, and the second element is a string +value for the error. A 0 numeric error means no error in the +operation. If TIMEOUT time is specified, the operation will timeout +after time seconds, time should be specified as an integer. The +INACTIVITY_TIMEOUT specifies an integer number of seconds of +inactivity after which the operation should terminate. If +SHOW_PROGRESS is specified, progress information will be printed as +status messages until the operation is complete. + +TIMESTAMP will write a string representation of the modification time +of filename to variable. + +Should the command be unable to obtain a timestamp variable will be +set to the empty string "". + +See documentation of the string TIMESTAMP sub-command for more +details. + +The file() command also provides COPY and INSTALL signatures: + +:: + + file(<COPY|INSTALL> files... DESTINATION <dir> + [FILE_PERMISSIONS permissions...] + [DIRECTORY_PERMISSIONS permissions...] + [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS] + [FILES_MATCHING] + [[PATTERN <pattern> | REGEX <regex>] + [EXCLUDE] [PERMISSIONS permissions...]] [...]) + +The COPY signature copies files, directories, and symlinks to a +destination folder. Relative input paths are evaluated with respect +to the current source directory, and a relative destination is +evaluated with respect to the current build directory. Copying +preserves input file timestamps, and optimizes out a file if it exists +at the destination with the same timestamp. Copying preserves input +permissions unless explicit permissions or NO_SOURCE_PERMISSIONS are +given (default is USE_SOURCE_PERMISSIONS). See the install(DIRECTORY) +command for documentation of permissions, PATTERN, REGEX, and EXCLUDE +options. + +The INSTALL signature differs slightly from COPY: it prints status +messages, and NO_SOURCE_PERMISSIONS is default. Installation scripts +generated by the install() command use this signature (with some +undocumented options for internal use). + +GENERATE will write an <output_file> with content from an +<input_file>, or from <input_content>. The output is generated +conditionally based on the content of the <condition>. The file is +written at CMake generate-time and the input may contain generator +expressions. The <condition>, <output_file> and <input_file> may also +contain generator expressions. The <condition> must evaluate to +either '0' or '1'. The <output_file> must evaluate to a unique name +among all configurations and among all invocations of file(GENERATE). diff --git a/Help/command/find_file.rst b/Help/command/find_file.rst new file mode 100644 index 0000000..549b317 --- /dev/null +++ b/Help/command/find_file.rst @@ -0,0 +1,27 @@ +find_file +--------- + +.. |FIND_XXX| replace:: find_file +.. |NAMES| replace:: NAMES name1 [name2 ...] +.. |SEARCH_XXX| replace:: full path to a file +.. |SEARCH_XXX_DESC| replace:: full path to named file +.. |XXX_SUBDIR| replace:: include + +.. |CMAKE_PREFIX_PATH_XXX| replace:: + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_XXX_PATH| replace:: CMAKE_INCLUDE_PATH +.. |CMAKE_XXX_MAC_PATH| replace:: CMAKE_FRAMEWORK_PATH + +.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: PATH and INCLUDE + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace:: + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_SYSTEM_XXX_PATH| replace:: CMAKE_SYSTEM_INCLUDE_PATH +.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace:: CMAKE_SYSTEM_FRAMEWORK_PATH + +.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: + CMAKE_FIND_ROOT_PATH_MODE_INCLUDE + +.. include:: FIND_XXX.txt diff --git a/Help/command/find_library.rst b/Help/command/find_library.rst new file mode 100644 index 0000000..8598be7 --- /dev/null +++ b/Help/command/find_library.rst @@ -0,0 +1,44 @@ +find_library +------------ + +.. |FIND_XXX| replace:: find_library +.. |NAMES| replace:: NAMES name1 [name2 ...] [NAMES_PER_DIR] +.. |SEARCH_XXX| replace:: library +.. |SEARCH_XXX_DESC| replace:: library +.. |XXX_SUBDIR| replace:: lib + +.. |CMAKE_PREFIX_PATH_XXX| replace:: + <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_XXX_PATH| replace:: CMAKE_LIBRARY_PATH +.. |CMAKE_XXX_MAC_PATH| replace:: CMAKE_FRAMEWORK_PATH + +.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: PATH and LIB + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace:: + <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_SYSTEM_XXX_PATH| replace:: CMAKE_SYSTEM_LIBRARY_PATH +.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace:: CMAKE_SYSTEM_FRAMEWORK_PATH + +.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: + CMAKE_FIND_ROOT_PATH_MODE_LIBRARY + +.. include:: FIND_XXX.txt + +When more than one value is given to the NAMES option this command by +default will consider one name at a time and search every directory +for it. The NAMES_PER_DIR option tells this command to consider one +directory at a time and search for all names in it. + +If the library found is a framework, then VAR will be set to the full +path to the framework <fullPath>/A.framework. When a full path to a +framework is used as a library, CMake will use a -framework A, and a +-F<fullPath> to link the framework to the target. + +If the global property FIND_LIBRARY_USE_LIB64_PATHS is set all search +paths will be tested as normal, with "64/" appended, and with all +matches of "lib/" replaced with "lib64/". This property is +automatically set for the platforms that are known to need it if at +least one of the languages supported by the PROJECT command is +enabled. diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst new file mode 100644 index 0000000..c394a08 --- /dev/null +++ b/Help/command/find_package.rst @@ -0,0 +1,362 @@ +find_package +------------ + +Load settings for an external project. + +:: + + find_package(<package> [version] [EXACT] [QUIET] [MODULE] + [REQUIRED] [[COMPONENTS] [components...]] + [OPTIONAL_COMPONENTS components...] + [NO_POLICY_SCOPE]) + +Finds and loads settings from an external project. <package>_FOUND +will be set to indicate whether the package was found. When the +package is found package-specific information is provided through +variables and imported targets documented by the package itself. The +QUIET option disables messages if the package cannot be found. The +MODULE option disables the second signature documented below. The +REQUIRED option stops processing with an error message if the package +cannot be found. + +A package-specific list of required components may be listed after the +COMPONENTS option (or after the REQUIRED option if present). +Additional optional components may be listed after +OPTIONAL_COMPONENTS. Available components and their influence on +whether a package is considered to be found are defined by the target +package. + +The [version] argument requests a version with which the package found +should be compatible (format is major[.minor[.patch[.tweak]]]). The +EXACT option requests that the version be matched exactly. If no +[version] and/or component list is given to a recursive invocation +inside a find-module, the corresponding arguments are forwarded +automatically from the outer call (including the EXACT flag for +[version]). Version support is currently provided only on a +package-by-package basis (details below). + +User code should generally look for packages using the above simple +signature. The remainder of this command documentation specifies the +full command signature and details of the search process. Project +maintainers wishing to provide a package to be found by this command +are encouraged to read on. + +The command has two modes by which it searches for packages: "Module" +mode and "Config" mode. Module mode is available when the command is +invoked with the above reduced signature. CMake searches for a file +called "Find<package>.cmake" in the CMAKE_MODULE_PATH followed by the +CMake installation. If the file is found, it is read and processed by +CMake. It is responsible for finding the package, checking the +version, and producing any needed messages. Many find-modules provide +limited or no support for versioning; check the module documentation. +If no module is found and the MODULE option is not given the command +proceeds to Config mode. + +The complete Config mode command signature is: + +:: + + find_package(<package> [version] [EXACT] [QUIET] + [REQUIRED] [[COMPONENTS] [components...]] + [CONFIG|NO_MODULE] + [NO_POLICY_SCOPE] + [NAMES name1 [name2 ...]] + [CONFIGS config1 [config2 ...]] + [HINTS path1 [path2 ... ]] + [PATHS path1 [path2 ... ]] + [PATH_SUFFIXES suffix1 [suffix2 ...]] + [NO_DEFAULT_PATH] + [NO_CMAKE_ENVIRONMENT_PATH] + [NO_CMAKE_PATH] + [NO_SYSTEM_ENVIRONMENT_PATH] + [NO_CMAKE_PACKAGE_REGISTRY] + [NO_CMAKE_BUILDS_PATH] + [NO_CMAKE_SYSTEM_PATH] + [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY] + [CMAKE_FIND_ROOT_PATH_BOTH | + ONLY_CMAKE_FIND_ROOT_PATH | + NO_CMAKE_FIND_ROOT_PATH]) + +The CONFIG option may be used to skip Module mode explicitly and +switch to Config mode. It is synonymous to using NO_MODULE. Config +mode is also implied by use of options not specified in the reduced +signature. + +Config mode attempts to locate a configuration file provided by the +package to be found. A cache entry called <package>_DIR is created to +hold the directory containing the file. By default the command +searches for a package with the name <package>. If the NAMES option +is given the names following it are used instead of <package>. The +command searches for a file called "<name>Config.cmake" or +"<lower-case-name>-config.cmake" for each name specified. A +replacement set of possible configuration file names may be given +using the CONFIGS option. The search procedure is specified below. +Once found, the configuration file is read and processed by CMake. +Since the file is provided by the package it already knows the +location of package contents. The full path to the configuration file +is stored in the cmake variable <package>_CONFIG. + +All configuration files which have been considered by CMake while +searching for an installation of the package with an appropriate +version are stored in the cmake variable <package>_CONSIDERED_CONFIGS, +the associated versions in <package>_CONSIDERED_VERSIONS. + +If the package configuration file cannot be found CMake will generate +an error describing the problem unless the QUIET argument is +specified. If REQUIRED is specified and the package is not found a +fatal error is generated and the configure step stops executing. If +<package>_DIR has been set to a directory not containing a +configuration file CMake will ignore it and search from scratch. + +When the [version] argument is given Config mode will only find a +version of the package that claims compatibility with the requested +version (format is major[.minor[.patch[.tweak]]]). If the EXACT +option is given only a version of the package claiming an exact match +of the requested version may be found. CMake does not establish any +convention for the meaning of version numbers. Package version +numbers are checked by "version" files provided by the packages +themselves. For a candidate package configuration file +"<config-file>.cmake" the corresponding version file is located next +to it and named either "<config-file>-version.cmake" or +"<config-file>Version.cmake". If no such version file is available +then the configuration file is assumed to not be compatible with any +requested version. A basic version file containing generic version +matching code can be created using the macro +write_basic_package_version_file(), see its documentation for more +details. When a version file is found it is loaded to check the +requested version number. The version file is loaded in a nested +scope in which the following variables have been defined: + +:: + + PACKAGE_FIND_NAME = the <package> name + PACKAGE_FIND_VERSION = full requested version string + PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0 + PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0 + PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0 + PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0 + PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4 + +The version file checks whether it satisfies the requested version and +sets these variables: + +:: + + PACKAGE_VERSION = full provided version string + PACKAGE_VERSION_EXACT = true if version is exact match + PACKAGE_VERSION_COMPATIBLE = true if version is compatible + PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version + +These variables are checked by the find_package command to determine +whether the configuration file provides an acceptable version. They +are not available after the find_package call returns. If the version +is acceptable the following variables are set: + +:: + + <package>_VERSION = full provided version string + <package>_VERSION_MAJOR = major version if provided, else 0 + <package>_VERSION_MINOR = minor version if provided, else 0 + <package>_VERSION_PATCH = patch version if provided, else 0 + <package>_VERSION_TWEAK = tweak version if provided, else 0 + <package>_VERSION_COUNT = number of version components, 0 to 4 + +and the corresponding package configuration file is loaded. When +multiple package configuration files are available whose version files +claim compatibility with the version requested it is unspecified which +one is chosen. No attempt is made to choose a highest or closest +version number. + +Config mode provides an elaborate interface and search procedure. +Much of the interface is provided for completeness and for use +internally by find-modules loaded by Module mode. Most user code +should simply call + +:: + + find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET]) + +in order to find a package. Package maintainers providing CMake +package configuration files are encouraged to name and install them +such that the procedure outlined below will find them without +requiring use of additional options. + +CMake constructs a set of possible installation prefixes for the +package. Under each prefix several directories are searched for a +configuration file. The tables below show the directories searched. +Each entry is meant for installation trees following Windows (W), UNIX +(U), or Apple (A) conventions. + +:: + + <prefix>/ (W) + <prefix>/(cmake|CMake)/ (W) + <prefix>/<name>*/ (W) + <prefix>/<name>*/(cmake|CMake)/ (W) + <prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U) + <prefix>/(lib/<arch>|lib|share)/<name>*/ (U) + <prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U) + +On systems supporting OS X Frameworks and Application Bundles the +following directories are searched for frameworks or bundles +containing a configuration file: + +:: + + <prefix>/<name>.framework/Resources/ (A) + <prefix>/<name>.framework/Resources/CMake/ (A) + <prefix>/<name>.framework/Versions/*/Resources/ (A) + <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A) + <prefix>/<name>.app/Contents/Resources/ (A) + <prefix>/<name>.app/Contents/Resources/CMake/ (A) + +In all cases the <name> is treated as case-insensitive and corresponds +to any of the names specified (<package> or names given by NAMES). +Paths with lib/<arch> are enabled if CMAKE_LIBRARY_ARCHITECTURE is +set. If PATH_SUFFIXES is specified the suffixes are appended to each +(W) or (U) directory entry one-by-one. + +This set of directories is intended to work in cooperation with +projects that provide configuration files in their installation trees. +Directories above marked with (W) are intended for installations on +Windows where the prefix may point at the top of an application's +installation directory. Those marked with (U) are intended for +installations on UNIX platforms where the prefix is shared by multiple +packages. This is merely a convention, so all (W) and (U) directories +are still searched on all platforms. Directories marked with (A) are +intended for installations on Apple platforms. The cmake variables +CMAKE_FIND_FRAMEWORK and CMAKE_FIND_APPBUNDLE determine the order of +preference as specified below. + +The set of installation prefixes is constructed using the following +steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled. + +1. Search paths specified in cmake-specific cache variables. These +are intended to be used on the command line with a -DVAR=value. This +can be skipped if NO_CMAKE_PATH is passed. + +:: + + CMAKE_PREFIX_PATH + CMAKE_FRAMEWORK_PATH + CMAKE_APPBUNDLE_PATH + +2. Search paths specified in cmake-specific environment variables. +These are intended to be set in the user's shell configuration. This +can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed. + +:: + + <package>_DIR + CMAKE_PREFIX_PATH + CMAKE_FRAMEWORK_PATH + CMAKE_APPBUNDLE_PATH + +3. Search paths specified by the HINTS option. These should be paths +computed by system introspection, such as a hint provided by the +location of another item already found. Hard-coded guesses should be +specified with the PATHS option. + +4. Search the standard system environment variables. This can be +skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. Path entries ending +in "/bin" or "/sbin" are automatically converted to their parent +directories. + +:: + + PATH + +5. Search project build trees recently configured in a CMake GUI. +This can be skipped if NO_CMAKE_BUILDS_PATH is passed. It is intended +for the case when a user is building multiple dependent projects one +after another. + +6. Search paths stored in the CMake user package registry. This can +be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed. On Windows a +<package> may appear under registry key + +:: + + HKEY_CURRENT_USER\Software\Kitware\CMake\Packages\<package> + +as a REG_SZ value, with arbitrary name, that specifies the directory +containing the package configuration file. On UNIX platforms a +<package> may appear under the directory + +:: + + ~/.cmake/packages/<package> + +as a file, with arbitrary name, whose content specifies the directory +containing the package configuration file. See the export(PACKAGE) +command to create user package registry entries for project build +trees. + +7. Search cmake variables defined in the Platform files for the +current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is +passed. + +:: + + CMAKE_SYSTEM_PREFIX_PATH + CMAKE_SYSTEM_FRAMEWORK_PATH + CMAKE_SYSTEM_APPBUNDLE_PATH + +8. Search paths stored in the CMake system package registry. This +can be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed. On +Windows a <package> may appear under registry key + +:: + + HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package> + +as a REG_SZ value, with arbitrary name, that specifies the directory +containing the package configuration file. There is no system package +registry on non-Windows platforms. + +9. Search paths specified by the PATHS option. These are typically +hard-coded guesses. + +.. |FIND_XXX| replace:: find_package +.. |FIND_ARGS_XXX| replace:: <package> +.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: + CMAKE_FIND_ROOT_PATH_MODE_PACKAGE + +.. include:: FIND_XXX_MAC.txt +.. include:: FIND_XXX_ROOT.txt +.. include:: FIND_XXX_ORDER.txt + +Every non-REQUIRED find_package() call can be disabled by setting the +variable CMAKE_DISABLE_FIND_PACKAGE_<package> to TRUE. See the +documentation for the CMAKE_DISABLE_FIND_PACKAGE_<package> variable +for more information. + +When loading a find module or package configuration file find_package +defines variables to provide information about the call arguments (and +restores their original state before returning): + +:: + + <package>_FIND_REQUIRED = true if REQUIRED option was given + <package>_FIND_QUIETLY = true if QUIET option was given + <package>_FIND_VERSION = full requested version string + <package>_FIND_VERSION_MAJOR = major version if requested, else 0 + <package>_FIND_VERSION_MINOR = minor version if requested, else 0 + <package>_FIND_VERSION_PATCH = patch version if requested, else 0 + <package>_FIND_VERSION_TWEAK = tweak version if requested, else 0 + <package>_FIND_VERSION_COUNT = number of version components, 0 to 4 + <package>_FIND_VERSION_EXACT = true if EXACT option was given + <package>_FIND_COMPONENTS = list of requested components + <package>_FIND_REQUIRED_<c> = true if component <c> is required + false if component <c> is optional + +In Module mode the loaded find module is responsible to honor the +request detailed by these variables; see the find module for details. +In Config mode find_package handles REQUIRED, QUIET, and version +options automatically but leaves it to the package configuration file +to handle components in a way that makes sense for the package. The +package configuration file may set <package>_FOUND to false to tell +find_package that component requirements are not satisfied. + +See the cmake_policy() command documentation for discussion of the +NO_POLICY_SCOPE option. diff --git a/Help/command/find_path.rst b/Help/command/find_path.rst new file mode 100644 index 0000000..c85011a --- /dev/null +++ b/Help/command/find_path.rst @@ -0,0 +1,32 @@ +find_path +--------- + +.. |FIND_XXX| replace:: find_path +.. |NAMES| replace:: NAMES name1 [name2 ...] +.. |SEARCH_XXX| replace:: file in a directory +.. |SEARCH_XXX_DESC| replace:: directory containing the named file +.. |XXX_SUBDIR| replace:: include + +.. |CMAKE_PREFIX_PATH_XXX| replace:: + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_XXX_PATH| replace:: CMAKE_INCLUDE_PATH +.. |CMAKE_XXX_MAC_PATH| replace:: CMAKE_FRAMEWORK_PATH + +.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: PATH and INCLUDE + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace:: + <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and + |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_SYSTEM_XXX_PATH| replace:: CMAKE_SYSTEM_INCLUDE_PATH +.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace:: CMAKE_SYSTEM_FRAMEWORK_PATH + +.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: + CMAKE_FIND_ROOT_PATH_MODE_INCLUDE + +.. include:: FIND_XXX.txt + +When searching for frameworks, if the file is specified as A/b.h, then +the framework search will look for A.framework/Headers/b.h. If that +is found the path will be set to the path to the framework. CMake +will convert this to the correct -F option to include the file. diff --git a/Help/command/find_program.rst b/Help/command/find_program.rst new file mode 100644 index 0000000..da5a41d --- /dev/null +++ b/Help/command/find_program.rst @@ -0,0 +1,25 @@ +find_program +------------ + +.. |FIND_XXX| replace:: find_program +.. |NAMES| replace:: NAMES name1 [name2 ...] +.. |SEARCH_XXX| replace:: program +.. |SEARCH_XXX_DESC| replace:: program +.. |XXX_SUBDIR| replace:: [s]bin + +.. |CMAKE_PREFIX_PATH_XXX| replace:: + |CMAKE_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_XXX_PATH| replace:: CMAKE_PROGRAM_PATH +.. |CMAKE_XXX_MAC_PATH| replace:: CMAKE_APPBUNDLE_PATH + +.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: PATH + +.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace:: + |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR| +.. |CMAKE_SYSTEM_XXX_PATH| replace:: CMAKE_SYSTEM_PROGRAM_PATH +.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace:: CMAKE_SYSTEM_APPBUNDLE_PATH + +.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: + CMAKE_FIND_ROOT_PATH_MODE_PROGRAM + +.. include:: FIND_XXX.txt diff --git a/Help/command/fltk_wrap_ui.rst b/Help/command/fltk_wrap_ui.rst new file mode 100644 index 0000000..448ae64 --- /dev/null +++ b/Help/command/fltk_wrap_ui.rst @@ -0,0 +1,14 @@ +fltk_wrap_ui +------------ + +Create FLTK user interfaces Wrappers. + +:: + + fltk_wrap_ui(resultingLibraryName source1 + source2 ... sourceN ) + +Produce .h and .cxx files for all the .fl and .fld files listed. The +resulting .h and .cxx files will be added to a variable named +resultingLibraryName_FLTK_UI_SRCS which should be added to your +library. diff --git a/Help/command/foreach.rst b/Help/command/foreach.rst new file mode 100644 index 0000000..8f9710c --- /dev/null +++ b/Help/command/foreach.rst @@ -0,0 +1,46 @@ +foreach +------- + +Evaluate a group of commands for each value in a list. + +:: + + foreach(loop_var arg1 arg2 ...) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endforeach(loop_var) + +All commands between foreach and the matching endforeach are recorded +without being invoked. Once the endforeach is evaluated, the recorded +list of commands is invoked once for each argument listed in the +original foreach command. Before each iteration of the loop +"${loop_var}" will be set as a variable with the current value in the +list. + +:: + + foreach(loop_var RANGE total) + foreach(loop_var RANGE start stop [step]) + +Foreach can also iterate over a generated range of numbers. There are +three types of this iteration: + +* When specifying single number, the range will have elements 0 to + "total". + +* When specifying two numbers, the range will have elements from the + first number to the second number. + +* The third optional number is the increment used to iterate from the + first number to the second number. + +:: + + foreach(loop_var IN [LISTS [list1 [...]]] + [ITEMS [item1 [...]]]) + +Iterates over a precise list of items. The LISTS option names +list-valued variables to be traversed, including empty elements (an +empty string is a zero-length list). The ITEMS option ends argument +parsing and includes all arguments following it in the iteration. diff --git a/Help/command/function.rst b/Help/command/function.rst new file mode 100644 index 0000000..b18e03c --- /dev/null +++ b/Help/command/function.rst @@ -0,0 +1,31 @@ +function +-------- + +Start recording a function for later invocation as a command. + +:: + + function(<name> [arg1 [arg2 [arg3 ...]]]) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endfunction(<name>) + +Define a function named <name> that takes arguments named arg1 arg2 +arg3 (...). Commands listed after function, but before the matching +endfunction, are not invoked until the function is invoked. When it +is invoked, the commands recorded in the function are first modified +by replacing formal parameters (${arg1}) with the arguments passed, +and then invoked as normal commands. In addition to referencing the +formal parameters you can reference the variable ARGC which will be +set to the number of arguments passed into the function as well as +ARGV0 ARGV1 ARGV2 ... which will have the actual values of the +arguments passed in. This facilitates creating functions with +optional arguments. Additionally ARGV holds the list of all arguments +given to the function and ARGN holds the list of arguments past the +last expected argument. + +A function opens a new scope: see set(var PARENT_SCOPE) for details. + +See the cmake_policy() command documentation for the behavior of +policies inside functions. diff --git a/Help/command/get_cmake_property.rst b/Help/command/get_cmake_property.rst new file mode 100644 index 0000000..bcfc5e8 --- /dev/null +++ b/Help/command/get_cmake_property.rst @@ -0,0 +1,15 @@ +get_cmake_property +------------------ + +Get a property of the CMake instance. + +:: + + get_cmake_property(VAR property) + +Get a property from the CMake instance. The value of the property is +stored in the variable VAR. If the property is not found, VAR will be +set to "NOTFOUND". Some supported properties include: VARIABLES, +CACHE_VARIABLES, COMMANDS, MACROS, and COMPONENTS. + +See also the more general get_property() command. diff --git a/Help/command/get_directory_property.rst b/Help/command/get_directory_property.rst new file mode 100644 index 0000000..f2a0a80 --- /dev/null +++ b/Help/command/get_directory_property.rst @@ -0,0 +1,24 @@ +get_directory_property +---------------------- + +Get a property of DIRECTORY scope. + +:: + + get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>) + +Store a property of directory scope in the named variable. If the +property is not defined the empty-string is returned. The DIRECTORY +argument specifies another directory from which to retrieve the +property value. The specified directory must have already been +traversed by CMake. + +:: + + get_directory_property(<variable> [DIRECTORY <dir>] + DEFINITION <var-name>) + +Get a variable definition from a directory. This form is useful to +get a variable definition from another directory. + +See also the more general get_property() command. diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst new file mode 100644 index 0000000..5eec792 --- /dev/null +++ b/Help/command/get_filename_component.rst @@ -0,0 +1,37 @@ +get_filename_component +---------------------- + +Get a specific component of a full filename. + +:: + + get_filename_component(<VAR> <FileName> <COMP> [CACHE]) + +Set <VAR> to a component of <FileName>, where <COMP> is one of: + +:: + + DIRECTORY = Directory without file name + NAME = File name without directory + EXT = File name longest extension (.b.c from d/a.b.c) + NAME_WE = File name without directory or longest extension + ABSOLUTE = Full path to file + REALPATH = Full path to existing file with symlinks resolved + PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) + +Paths are returned with forward slashes and have no trailing slahes. +The longest file extension is always considered. If the optional +CACHE argument is specified, the result variable is added to the +cache. + +:: + + get_filename_component(<VAR> FileName + PROGRAM [PROGRAM_ARGS <ARG_VAR>] + [CACHE]) + +The program in FileName will be found in the system search path or +left as a full path. If PROGRAM_ARGS is present with PROGRAM, then +any command-line arguments present in the FileName string are split +from the program name and stored in <ARG_VAR>. This is used to +separate a program name from its arguments in a command line string. diff --git a/Help/command/get_property.rst b/Help/command/get_property.rst new file mode 100644 index 0000000..c2937be --- /dev/null +++ b/Help/command/get_property.rst @@ -0,0 +1,49 @@ +get_property +------------ + +Get a property. + +:: + + get_property(<variable> + <GLOBAL | + DIRECTORY [dir] | + TARGET <target> | + SOURCE <source> | + TEST <test> | + CACHE <entry> | + VARIABLE> + PROPERTY <name> + [SET | DEFINED | BRIEF_DOCS | FULL_DOCS]) + +Get one property from one object in a scope. The first argument +specifies the variable in which to store the result. The second +argument determines the scope from which to get the property. It must +be one of the following: + +GLOBAL scope is unique and does not accept a name. + +DIRECTORY scope defaults to the current directory but another +directory (already processed by CMake) may be named by full or +relative path. + +TARGET scope must name one existing target. + +SOURCE scope must name one source file. + +TEST scope must name one existing test. + +CACHE scope must name one cache entry. + +VARIABLE scope is unique and does not accept a name. + +The required PROPERTY option is immediately followed by the name of +the property to get. If the property is not set an empty value is +returned. If the SET option is given the variable is set to a boolean +value indicating whether the property has been set. If the DEFINED +option is given the variable is set to a boolean value indicating +whether the property has been defined such as with define_property. +If BRIEF_DOCS or FULL_DOCS is given then the variable is set to a +string containing documentation for the requested property. If +documentation is requested for a property that has not been defined +NOTFOUND is returned. diff --git a/Help/command/get_source_file_property.rst b/Help/command/get_source_file_property.rst new file mode 100644 index 0000000..80c512b --- /dev/null +++ b/Help/command/get_source_file_property.rst @@ -0,0 +1,16 @@ +get_source_file_property +------------------------ + +Get a property for a source file. + +:: + + get_source_file_property(VAR file property) + +Get a property from a source file. The value of the property is +stored in the variable VAR. If the property is not found, VAR will be +set to "NOTFOUND". Use set_source_files_properties to set property +values. Source file properties usually control how the file is built. +One property that is always there is LOCATION + +See also the more general get_property() command. diff --git a/Help/command/get_target_property.rst b/Help/command/get_target_property.rst new file mode 100644 index 0000000..4017d31 --- /dev/null +++ b/Help/command/get_target_property.rst @@ -0,0 +1,18 @@ +get_target_property +------------------- + +Get a property from a target. + +:: + + get_target_property(VAR target property) + +Get a property from a target. The value of the property is stored in +the variable VAR. If the property is not found, VAR will be set to +"NOTFOUND". Use set_target_properties to set property values. +Properties are usually used to control how a target is built, but some +query the target instead. This command can get properties for any +target so far created. The targets do not need to be in the current +CMakeLists.txt file. + +See also the more general get_property() command. diff --git a/Help/command/get_test_property.rst b/Help/command/get_test_property.rst new file mode 100644 index 0000000..2623755 --- /dev/null +++ b/Help/command/get_test_property.rst @@ -0,0 +1,15 @@ +get_test_property +----------------- + +Get a property of the test. + +:: + + get_test_property(test property VAR) + +Get a property from the Test. The value of the property is stored in +the variable VAR. If the property is not found, VAR will be set to +"NOTFOUND". For a list of standard properties you can type cmake +--help-property-list + +See also the more general get_property() command. diff --git a/Help/command/if.rst b/Help/command/if.rst new file mode 100644 index 0000000..b879ae1 --- /dev/null +++ b/Help/command/if.rst @@ -0,0 +1,238 @@ +if +-- + +Conditionally execute a group of commands. + +:: + + if(expression) + # then section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + elseif(expression2) + # elseif section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + else(expression) + # else section. + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endif(expression) + +Evaluates the given expression. If the result is true, the commands +in the THEN section are invoked. Otherwise, the commands in the else +section are invoked. The elseif and else sections are optional. You +may have multiple elseif clauses. Note that the expression in the +else and endif clause is optional. Long expressions can be used and +there is a traditional order of precedence. Parenthetical expressions +are evaluated first followed by unary operators such as EXISTS, +COMMAND, and DEFINED. Then any EQUAL, LESS, GREATER, STRLESS, +STRGREATER, STREQUAL, MATCHES will be evaluated. Then NOT operators +and finally AND, OR operators will be evaluated. Possible expressions +are: + +:: + + if(<constant>) + +True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. +False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, '', +or ends in the suffix '-NOTFOUND'. Named boolean constants are +case-insensitive. If the argument is not one of these constants, it +is treated as a variable: + +:: + + if(<variable>) + +True if the variable is defined to a value that is not a false +constant. False otherwise. (Note macro arguments are not variables.) + +:: + + if(NOT <expression>) + +True if the expression is not true. + +:: + + if(<expr1> AND <expr2>) + +True if both expressions would be considered true individually. + +:: + + if(<expr1> OR <expr2>) + +True if either expression would be considered true individually. + +:: + + if(COMMAND command-name) + +True if the given name is a command, macro or function that can be +invoked. + +:: + + if(POLICY policy-id) + +True if the given name is an existing policy (of the form CMP<NNNN>). + +:: + + if(TARGET target-name) + +True if the given name is an existing target, built or imported. + +:: + + if(EXISTS file-name) + if(EXISTS directory-name) + +True if the named file or directory exists. Behavior is well-defined +only for full paths. + +:: + + if(file1 IS_NEWER_THAN file2) + +True if file1 is newer than file2 or if one of the two files doesn't +exist. Behavior is well-defined only for full paths. If the file +time stamps are exactly the same, an IS_NEWER_THAN comparison returns +true, so that any dependent build operations will occur in the event +of a tie. This includes the case of passing the same file name for +both file1 and file2. + +:: + + if(IS_DIRECTORY directory-name) + +True if the given name is a directory. Behavior is well-defined only +for full paths. + +:: + + if(IS_SYMLINK file-name) + +True if the given name is a symbolic link. Behavior is well-defined +only for full paths. + +:: + + if(IS_ABSOLUTE path) + +True if the given path is an absolute path. + +:: + + if(<variable|string> MATCHES regex) + +True if the given string or variable's value matches the given regular +expression. + +:: + + if(<variable|string> LESS <variable|string>) + if(<variable|string> GREATER <variable|string>) + if(<variable|string> EQUAL <variable|string>) + +True if the given string or variable's value is a valid number and the +inequality or equality is true. + +:: + + if(<variable|string> STRLESS <variable|string>) + if(<variable|string> STRGREATER <variable|string>) + if(<variable|string> STREQUAL <variable|string>) + +True if the given string or variable's value is lexicographically less +(or greater, or equal) than the string or variable on the right. + +:: + + if(<variable|string> VERSION_LESS <variable|string>) + if(<variable|string> VERSION_EQUAL <variable|string>) + if(<variable|string> VERSION_GREATER <variable|string>) + +Component-wise integer version number comparison (version format is +major[.minor[.patch[.tweak]]]). + +:: + + if(DEFINED <variable>) + +True if the given variable is defined. It does not matter if the +variable is true or false just if it has been set. + +:: + + if((expression) AND (expression OR (expression))) + +The expressions inside the parenthesis are evaluated first and then +the remaining expression is evaluated as in the previous examples. +Where there are nested parenthesis the innermost are evaluated as part +of evaluating the expression that contains them. + +The if command was written very early in CMake's history, predating +the ${} variable evaluation syntax, and for convenience evaluates +variables named by its arguments as shown in the above signatures. +Note that normal variable evaluation with ${} applies before the if +command even receives the arguments. Therefore code like + +:: + + set(var1 OFF) + set(var2 "var1") + if(${var2}) + +appears to the if command as + +:: + + if(var1) + +and is evaluated according to the if(<variable>) case documented +above. The result is OFF which is false. However, if we remove the +${} from the example then the command sees + +:: + + if(var2) + +which is true because var2 is defined to "var1" which is not a false +constant. + +Automatic evaluation applies in the other cases whenever the +above-documented signature accepts <variable|string>: + +1) The left hand argument to MATCHES is first checked to see if it is +a defined variable, if so the variable's value is used, otherwise the +original value is used. + +2) If the left hand argument to MATCHES is missing it returns false +without error + +3) Both left and right hand arguments to LESS GREATER EQUAL are +independently tested to see if they are defined variables, if so their +defined values are used otherwise the original value is used. + +4) Both left and right hand arguments to STRLESS STREQUAL STRGREATER +are independently tested to see if they are defined variables, if so +their defined values are used otherwise the original value is used. + +5) Both left and right hand argumemnts to VERSION_LESS VERSION_EQUAL +VERSION_GREATER are independently tested to see if they are defined +variables, if so their defined values are used otherwise the original +value is used. + +6) The right hand argument to NOT is tested to see if it is a boolean +constant, if so the value is used, otherwise it is assumed to be a +variable and it is dereferenced. + +7) The left and right hand arguments to AND OR are independently +tested to see if they are boolean constants, if so they are used as +such, otherwise they are assumed to be variables and are dereferenced. diff --git a/Help/command/include.rst b/Help/command/include.rst new file mode 100644 index 0000000..a9074c1 --- /dev/null +++ b/Help/command/include.rst @@ -0,0 +1,25 @@ +include +------- + +Load and run CMake code from a file or module. + +:: + + include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>] + [NO_POLICY_SCOPE]) + +Load and run CMake code from the file given. Variable reads and +writes access the scope of the caller (dynamic scoping). If OPTIONAL +is present, then no error is raised if the file does not exist. If +RESULT_VARIABLE is given the variable will be set to the full filename +which has been included or NOTFOUND if it failed. + +If a module is specified instead of a file, the file with name +<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the +CMake module directory. There is one exception to this: if the file +which calls include() is located itself in the CMake module directory, +then first the CMake module directory is searched and +CMAKE_MODULE_PATH afterwards. See also policy CMP0017. + +See the cmake_policy() command documentation for discussion of the +NO_POLICY_SCOPE option. diff --git a/Help/command/include_directories.rst b/Help/command/include_directories.rst new file mode 100644 index 0000000..6744427 --- /dev/null +++ b/Help/command/include_directories.rst @@ -0,0 +1,30 @@ +include_directories +------------------- + +Add include directories to the build. + +:: + + include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...) + +Add the given directories to those the compiler uses to search for +include files. Relative paths are interpreted as relative to the +current source directory. + +The include directories are added to the directory property +INCLUDE_DIRECTORIES for the current CMakeLists file. They are also +added to the target property INCLUDE_DIRECTORIES for each target in +the current CMakeLists file. The target property values are the ones +used by the generators. + +By default the directories are appended onto the current list of +directories. This default behavior can be changed by setting +CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. By using AFTER or BEFORE +explicitly, you can select between appending and prepending, +independent of the default. + +If the SYSTEM option is given, the compiler will be told the +directories are meant as system include directories on some platforms +(signalling this setting might achieve effects such as the compiler +skipping warnings, or these fixed-install system files not being +considered in dependency calculations - see compiler docs). diff --git a/Help/command/include_external_msproject.rst b/Help/command/include_external_msproject.rst new file mode 100644 index 0000000..ba9a393 --- /dev/null +++ b/Help/command/include_external_msproject.rst @@ -0,0 +1,23 @@ +include_external_msproject +-------------------------- + +Include an external Microsoft project file in a workspace. + +:: + + include_external_msproject(projectname location + [TYPE projectTypeGUID] + [GUID projectGUID] + [PLATFORM platformName] + dep1 dep2 ...) + +Includes an external Microsoft project in the generated workspace +file. Currently does nothing on UNIX. This will create a target +named [projectname]. This can be used in the add_dependencies command +to make things depend on the external project. + +TYPE, GUID and PLATFORM are optional parameters that allow one to +specify the type of project, id (GUID) of the project and the name of +the target platform. This is useful for projects requiring values +other than the default (e.g. WIX projects). These options are not +supported by the Visual Studio 6 generator. diff --git a/Help/command/include_regular_expression.rst b/Help/command/include_regular_expression.rst new file mode 100644 index 0000000..dd887df --- /dev/null +++ b/Help/command/include_regular_expression.rst @@ -0,0 +1,18 @@ +include_regular_expression +-------------------------- + +Set the regular expression used for dependency checking. + +:: + + include_regular_expression(regex_match [regex_complain]) + +Set the regular expressions used in dependency checking. Only files +matching regex_match will be traced as dependencies. Only files +matching regex_complain will generate warnings if they cannot be found +(standard header paths are not searched). The defaults are: + +:: + + regex_match = "^.*$" (match everything) + regex_complain = "^$" (match empty string only) diff --git a/Help/command/install.rst b/Help/command/install.rst new file mode 100644 index 0000000..a463a60 --- /dev/null +++ b/Help/command/install.rst @@ -0,0 +1,316 @@ +install +------- + +Specify rules to run at install time. + +This command generates installation rules for a project. Rules +specified by calls to this command within a source directory are +executed in order during installation. The order across directories +is not defined. + +There are multiple signatures for this command. Some of them define +installation properties for files and targets. Properties common to +multiple signatures are covered here but they are valid only for +signatures that specify them. + +DESTINATION arguments specify the directory on disk to which a file +will be installed. If a full path (with a leading slash or drive +letter) is given it is used directly. If a relative path is given it +is interpreted relative to the value of CMAKE_INSTALL_PREFIX. The +prefix can be relocated at install time using DESTDIR mechanism +explained in the CMAKE_INSTALL_PREFIX variable documentation. + +PERMISSIONS arguments specify permissions for installed files. Valid +permissions are OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, GROUP_READ, +GROUP_WRITE, GROUP_EXECUTE, WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, +SETUID, and SETGID. Permissions that do not make sense on certain +platforms are ignored on those platforms. + +The CONFIGURATIONS argument specifies a list of build configurations +for which the install rule applies (Debug, Release, etc.). + +The COMPONENT argument specifies an installation component name with +which the install rule is associated, such as "runtime" or +"development". During component-specific installation only install +rules associated with the given component name will be executed. +During a full installation all components are installed. If COMPONENT +is not provided a default component "Unspecified" is created. The +default component name may be controlled with the +CMAKE_INSTALL_DEFAULT_COMPONENT_NAME variable. + +The RENAME argument specifies a name for an installed file that may be +different from the original file. Renaming is allowed only when a +single file is installed by the command. + +The OPTIONAL argument specifies that it is not an error if the file to +be installed does not exist. + +The TARGETS signature: + +:: + + install(TARGETS targets... [EXPORT <export-name>] + [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE| + PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE] + [DESTINATION <dir>] + [INCLUDES DESTINATION [<dir> ...]] + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP] + ] [...]) + +The TARGETS form specifies rules for installing targets from a +project. There are five kinds of target files that may be installed: +ARCHIVE, LIBRARY, RUNTIME, FRAMEWORK, and BUNDLE. Executables are +treated as RUNTIME targets, except that those marked with the +MACOSX_BUNDLE property are treated as BUNDLE targets on OS X. Static +libraries are always treated as ARCHIVE targets. Module libraries are +always treated as LIBRARY targets. For non-DLL platforms shared +libraries are treated as LIBRARY targets, except that those marked +with the FRAMEWORK property are treated as FRAMEWORK targets on OS X. +For DLL platforms the DLL part of a shared library is treated as a +RUNTIME target and the corresponding import library is treated as an +ARCHIVE target. All Windows-based systems including Cygwin are DLL +platforms. The ARCHIVE, LIBRARY, RUNTIME, and FRAMEWORK arguments +change the type of target to which the subsequent properties apply. +If none is given the installation properties apply to all target +types. If only one is given then only targets of that type will be +installed (which can be used to install just a DLL or just an import +library).The INCLUDES DESTINATION specifies a list of directories +which will be added to the INTERFACE_INCLUDE_DIRECTORIES of the +<targets> when exported by install(EXPORT). If a relative path is +specified, it is treated as relative to the $<INSTALL_PREFIX>. + +The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE arguments cause +subsequent properties to be applied to installing a FRAMEWORK shared +library target's associated files on non-Apple platforms. Rules +defined by these arguments are ignored on Apple platforms because the +associated files are installed into the appropriate locations inside +the framework folder. See documentation of the PRIVATE_HEADER, +PUBLIC_HEADER, and RESOURCE target properties for details. + +Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY +option. On some platforms a versioned shared library has a symbolic +link such as + +:: + + lib<name>.so -> lib<name>.so.1 + +where "lib<name>.so.1" is the soname of the library and "lib<name>.so" +is a "namelink" allowing linkers to find the library when given +"-l<name>". The NAMELINK_ONLY option causes installation of only the +namelink when a library target is installed. The NAMELINK_SKIP option +causes installation of library files other than the namelink when a +library target is installed. When neither option is given both +portions are installed. On platforms where versioned shared libraries +do not have namelinks or when a library is not versioned the +NAMELINK_SKIP option installs the library and the NAMELINK_ONLY option +installs nothing. See the VERSION and SOVERSION target properties for +details on creating versioned shared libraries. + +One or more groups of properties may be specified in a single call to +the TARGETS form of this command. A target may be installed more than +once to different locations. Consider hypothetical targets "myExe", +"mySharedLib", and "myStaticLib". The code + +:: + + install(TARGETS myExe mySharedLib myStaticLib + RUNTIME DESTINATION bin + LIBRARY DESTINATION lib + ARCHIVE DESTINATION lib/static) + install(TARGETS mySharedLib DESTINATION /some/full/path) + +will install myExe to <prefix>/bin and myStaticLib to +<prefix>/lib/static. On non-DLL platforms mySharedLib will be +installed to <prefix>/lib and /some/full/path. On DLL platforms the +mySharedLib DLL will be installed to <prefix>/bin and /some/full/path +and its import library will be installed to <prefix>/lib/static and +/some/full/path. + +The EXPORT option associates the installed target files with an export +called <export-name>. It must appear before any RUNTIME, LIBRARY, or +ARCHIVE options. To actually install the export file itself, call +install(EXPORT). See documentation of the install(EXPORT ...) +signature below for details. + +Installing a target with EXCLUDE_FROM_ALL set to true has undefined +behavior. + +The FILES signature: + +:: + + install(FILES files... DESTINATION <dir> + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [RENAME <name>] [OPTIONAL]) + +The FILES form specifies rules for installing files for a project. +File names given as relative paths are interpreted with respect to the +current source directory. Files installed by this form are by default +given permissions OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ +if no PERMISSIONS argument is given. + +The PROGRAMS signature: + +:: + + install(PROGRAMS files... DESTINATION <dir> + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] + [RENAME <name>] [OPTIONAL]) + +The PROGRAMS form is identical to the FILES form except that the +default permissions for the installed file also include OWNER_EXECUTE, +GROUP_EXECUTE, and WORLD_EXECUTE. This form is intended to install +programs that are not targets, such as shell scripts. Use the TARGETS +form to install targets built within the project. + +The DIRECTORY signature: + +:: + + install(DIRECTORY dirs... DESTINATION <dir> + [FILE_PERMISSIONS permissions...] + [DIRECTORY_PERMISSIONS permissions...] + [USE_SOURCE_PERMISSIONS] [OPTIONAL] + [CONFIGURATIONS [Debug|Release|...]] + [COMPONENT <component>] [FILES_MATCHING] + [[PATTERN <pattern> | REGEX <regex>] + [EXCLUDE] [PERMISSIONS permissions...]] [...]) + +The DIRECTORY form installs contents of one or more directories to a +given destination. The directory structure is copied verbatim to the +destination. The last component of each directory name is appended to +the destination directory but a trailing slash may be used to avoid +this because it leaves the last component empty. Directory names +given as relative paths are interpreted with respect to the current +source directory. If no input directory names are given the +destination directory will be created but nothing will be installed +into it. The FILE_PERMISSIONS and DIRECTORY_PERMISSIONS options +specify permissions given to files and directories in the destination. +If USE_SOURCE_PERMISSIONS is specified and FILE_PERMISSIONS is not, +file permissions will be copied from the source directory structure. +If no permissions are specified files will be given the default +permissions specified in the FILES form of the command, and the +directories will be given the default permissions specified in the +PROGRAMS form of the command. + +Installation of directories may be controlled with fine granularity +using the PATTERN or REGEX options. These "match" options specify a +globbing pattern or regular expression to match directories or files +encountered within input directories. They may be used to apply +certain options (see below) to a subset of the files and directories +encountered. The full path to each input file or directory (with +forward slashes) is matched against the expression. A PATTERN will +match only complete file names: the portion of the full path matching +the pattern must occur at the end of the file name and be preceded by +a slash. A REGEX will match any portion of the full path but it may +use '/' and '$' to simulate the PATTERN behavior. By default all +files and directories are installed whether or not they are matched. +The FILES_MATCHING option may be given before the first match option +to disable installation of files (but not directories) not matched by +any expression. For example, the code + +:: + + install(DIRECTORY src/ DESTINATION include/myproj + FILES_MATCHING PATTERN "*.h") + +will extract and install header files from a source tree. + +Some options may follow a PATTERN or REGEX expression and are applied +only to files or directories matching them. The EXCLUDE option will +skip the matched file or directory. The PERMISSIONS option overrides +the permissions setting for the matched file or directory. For +example the code + +:: + + install(DIRECTORY icons scripts/ DESTINATION share/myproj + PATTERN "CVS" EXCLUDE + PATTERN "scripts/*" + PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ + GROUP_EXECUTE GROUP_READ) + +will install the icons directory to share/myproj/icons and the scripts +directory to share/myproj. The icons will get default file +permissions, the scripts will be given specific permissions, and any +CVS directories will be excluded. + +The SCRIPT and CODE signature: + +:: + + install([[SCRIPT <file>] [CODE <code>]] [...]) + +The SCRIPT form will invoke the given CMake script files during +installation. If the script file name is a relative path it will be +interpreted with respect to the current source directory. The CODE +form will invoke the given CMake code during installation. Code is +specified as a single argument inside a double-quoted string. For +example, the code + +:: + + install(CODE "MESSAGE(\"Sample install message.\")") + +will print a message during installation. + +The EXPORT signature: + +:: + + install(EXPORT <export-name> DESTINATION <dir> + [NAMESPACE <namespace>] [FILE <name>.cmake] + [PERMISSIONS permissions...] + [CONFIGURATIONS [Debug|Release|...]] + [EXPORT_LINK_INTERFACE_LIBRARIES] + [COMPONENT <component>]) + +The EXPORT form generates and installs a CMake file containing code to +import targets from the installation tree into another project. +Target installations are associated with the export <export-name> +using the EXPORT option of the install(TARGETS ...) signature +documented above. The NAMESPACE option will prepend <namespace> to +the target names as they are written to the import file. By default +the generated file will be called <export-name>.cmake but the FILE +option may be used to specify a different name. The value given to +the FILE option must be a file name with the ".cmake" extension. If a +CONFIGURATIONS option is given then the file will only be installed +when one of the named configurations is installed. Additionally, the +generated import file will reference only the matching target +configurations. The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if +present, causes the contents of the properties matching +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?`` to be exported, when +policy CMP0022 is NEW. If a COMPONENT option is specified that does +not match that given to the targets associated with <export-name> the +behavior is undefined. If a library target is included in the export +but a target to which it links is not included the behavior is +unspecified. + +The EXPORT form is useful to help outside projects use targets built +and installed by the current project. For example, the code + +:: + + install(TARGETS myexe EXPORT myproj DESTINATION bin) + install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj) + +will install the executable myexe to <prefix>/bin and code to import +it in the file "<prefix>/lib/myproj/myproj.cmake". An outside project +may load this file with the include command and reference the myexe +executable from the installation tree using the imported target name +mp_myexe as if the target were built in its own tree. + +NOTE: This command supercedes the INSTALL_TARGETS command and the +target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. It also +replaces the FILES forms of the INSTALL_FILES and INSTALL_PROGRAMS +commands. The processing order of these install rules relative to +those generated by INSTALL_TARGETS, INSTALL_FILES, and +INSTALL_PROGRAMS commands is not defined. diff --git a/Help/command/install_files.rst b/Help/command/install_files.rst new file mode 100644 index 0000000..7b6bd81 --- /dev/null +++ b/Help/command/install_files.rst @@ -0,0 +1,39 @@ +install_files +------------- + +Deprecated. Use the install(FILES ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. The FILES form is +directly replaced by the FILES form of the install command. The +regexp form can be expressed more clearly using the GLOB form of the +file command. + +:: + + install_files(<dir> extension file file ...) + +Create rules to install the listed files with the given extension into +the given directory. Only files existing in the current source tree +or its corresponding location in the binary tree may be listed. If a +file specified already has an extension, that extension will be +removed first. This is useful for providing lists of source files +such as foo.cxx when you want the corresponding foo.h to be installed. +A typical extension is '.h'. + +:: + + install_files(<dir> regexp) + +Any files in the current source directory that match the regular +expression will be installed. + +:: + + install_files(<dir> FILES file file ...) + +Any files listed after the FILES keyword will be installed explicitly +from the names given. Full paths are allowed in this form. + +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. diff --git a/Help/command/install_programs.rst b/Help/command/install_programs.rst new file mode 100644 index 0000000..26789d8 --- /dev/null +++ b/Help/command/install_programs.rst @@ -0,0 +1,33 @@ +install_programs +---------------- + +Deprecated. Use the install(PROGRAMS ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. The FILES form is +directly replaced by the PROGRAMS form of the INSTALL command. The +regexp form can be expressed more clearly using the GLOB form of the +FILE command. + +:: + + install_programs(<dir> file1 file2 [file3 ...]) + install_programs(<dir> FILES file1 [file2 ...]) + +Create rules to install the listed programs into the given directory. +Use the FILES argument to guarantee that the file list version of the +command will be used even when there is only one argument. + +:: + + install_programs(<dir> regexp) + +In the second form any program in the current source directory that +matches the regular expression will be installed. + +This command is intended to install programs that are not built by +cmake, such as shell scripts. See the TARGETS form of the INSTALL +command to create installation rules for targets built by cmake. + +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. diff --git a/Help/command/install_targets.rst b/Help/command/install_targets.rst new file mode 100644 index 0000000..caa933f --- /dev/null +++ b/Help/command/install_targets.rst @@ -0,0 +1,17 @@ +install_targets +--------------- + +Deprecated. Use the install(TARGETS ) command instead. + +This command has been superceded by the install command. It is +provided for compatibility with older CMake code. + +:: + + install_targets(<dir> [RUNTIME_DIRECTORY dir] target target) + +Create rules to install the listed targets into the given directory. +The directory <dir> is relative to the installation prefix, which is +stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY is +specified, then on systems with special runtime files (Windows DLL), +the files will be copied to that directory. diff --git a/Help/command/link_directories.rst b/Help/command/link_directories.rst new file mode 100644 index 0000000..bdc94cd --- /dev/null +++ b/Help/command/link_directories.rst @@ -0,0 +1,19 @@ +link_directories +---------------- + +Specify directories in which the linker will look for libraries. + +:: + + link_directories(directory1 directory2 ...) + +Specify the paths in which the linker should search for libraries. +The command will apply only to targets created after it is called. +Relative paths given to this command are interpreted as relative to +the current source directory, see CMP0015. + +Note that this command is rarely necessary. Library locations +returned by find_package() and find_library() are absolute paths. +Pass these absolute library file paths directly to the +target_link_libraries() command. CMake will ensure the linker finds +them. diff --git a/Help/command/link_libraries.rst b/Help/command/link_libraries.rst new file mode 100644 index 0000000..d690c9b --- /dev/null +++ b/Help/command/link_libraries.rst @@ -0,0 +1,16 @@ +link_libraries +-------------- + +Deprecated. Use the target_link_libraries() command instead. + +Link libraries to all targets added later. + +:: + + link_libraries(library1 <debug | optimized> library2 ...) + +Specify a list of libraries to be linked into any following targets +(typically added with the add_executable or add_library calls). This +command is passed down to all subdirectories. The debug and optimized +strings may be used to indicate that the next library listed is to be +used only for that specific type of build. diff --git a/Help/command/list.rst b/Help/command/list.rst new file mode 100644 index 0000000..f044dba --- /dev/null +++ b/Help/command/list.rst @@ -0,0 +1,60 @@ +list +---- + +List operations. + +:: + + list(LENGTH <list> <output variable>) + list(GET <list> <element index> [<element index> ...] + <output variable>) + list(APPEND <list> [<element> ...]) + list(FIND <list> <value> <output variable>) + list(INSERT <list> <element_index> <element> [<element> ...]) + list(REMOVE_ITEM <list> <value> [<value> ...]) + list(REMOVE_AT <list> <index> [<index> ...]) + list(REMOVE_DUPLICATES <list>) + list(REVERSE <list>) + list(SORT <list>) + +LENGTH will return a given list's length. + +GET will return list of elements specified by indices from the list. + +APPEND will append elements to the list. + +FIND will return the index of the element specified in the list or -1 +if it wasn't found. + +INSERT will insert elements to the list to the specified location. + +REMOVE_AT and REMOVE_ITEM will remove items from the list. The +difference is that REMOVE_ITEM will remove the given items, while +REMOVE_AT will remove the items at the given indices. + +REMOVE_DUPLICATES will remove duplicated items in the list. + +REVERSE reverses the contents of the list in-place. + +SORT sorts the list in-place alphabetically. + +The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM, +REMOVE_DUPLICATES, REVERSE and SORT may create new values for the list +within the current CMake variable scope. Similar to the SET command, +the LIST command creates new variable values in the current scope, +even if the list itself is actually defined in a parent scope. To +propagate the results of these operations upwards, use SET with +PARENT_SCOPE, SET with CACHE INTERNAL, or some other means of value +propagation. + +NOTES: A list in cmake is a ; separated group of strings. To create a +list the set command can be used. For example, set(var a b c d e) +creates a list with a;b;c;d;e, and set(var "a b c d e") creates a +string or a list with one item in it. + +When specifying index values, if <element index> is 0 or greater, it +is indexed from the beginning of the list, with 0 representing the +first list element. If <element index> is -1 or lesser, it is indexed +from the end of the list, with -1 representing the last list element. +Be careful when counting with negative indices: they do not start from +0. -0 is equivalent to 0, the first list element. diff --git a/Help/command/load_cache.rst b/Help/command/load_cache.rst new file mode 100644 index 0000000..b7484cb --- /dev/null +++ b/Help/command/load_cache.rst @@ -0,0 +1,27 @@ +load_cache +---------- + +Load in the values from another project's CMake cache. + +:: + + load_cache(pathToCacheFile READ_WITH_PREFIX + prefix entry1...) + +Read the cache and store the requested entries in variables with their +name prefixed with the given prefix. This only reads the values, and +does not create entries in the local project's cache. + +:: + + load_cache(pathToCacheFile [EXCLUDE entry1...] + [INCLUDE_INTERNALS entry1...]) + +Load in the values from another cache and store them in the local +project's cache as internal entries. This is useful for a project +that depends on another project built in a different tree. EXCLUDE +option can be used to provide a list of entries to be excluded. +INCLUDE_INTERNALS can be used to provide a list of internal entries to +be included. Normally, no internal entries are brought in. Use of +this form of the command is strongly discouraged, but it is provided +for backward compatibility. diff --git a/Help/command/load_command.rst b/Help/command/load_command.rst new file mode 100644 index 0000000..63f23be --- /dev/null +++ b/Help/command/load_command.rst @@ -0,0 +1,21 @@ +load_command +------------ + +Load a command into a running CMake. + +:: + + load_command(COMMAND_NAME <loc1> [loc2 ...]) + +The given locations are searched for a library whose name is +cmCOMMAND_NAME. If found, it is loaded as a module and the command is +added to the set of available CMake commands. Usually, TRY_COMPILE is +used before this command to compile the module. If the command is +successfully loaded a variable named + +:: + + CMAKE_LOADED_COMMAND_<COMMAND_NAME> + +will be set to the full path of the module that was loaded. Otherwise +the variable will not be set. diff --git a/Help/command/macro.rst b/Help/command/macro.rst new file mode 100644 index 0000000..aa16352 --- /dev/null +++ b/Help/command/macro.rst @@ -0,0 +1,33 @@ +macro +----- + +Start recording a macro for later invocation as a command. + +:: + + macro(<name> [arg1 [arg2 [arg3 ...]]]) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endmacro(<name>) + +Define a macro named <name> that takes arguments named arg1 arg2 arg3 +(...). Commands listed after macro, but before the matching endmacro, +are not invoked until the macro is invoked. When it is invoked, the +commands recorded in the macro are first modified by replacing formal +parameters (${arg1}) with the arguments passed, and then invoked as +normal commands. In addition to referencing the formal parameters you +can reference the values ${ARGC} which will be set to the number of +arguments passed into the function as well as ${ARGV0} ${ARGV1} +${ARGV2} ... which will have the actual values of the arguments +passed in. This facilitates creating macros with optional arguments. +Additionally ${ARGV} holds the list of all arguments given to the +macro and ${ARGN} holds the list of arguments past the last expected +argument. Note that the parameters to a macro and values such as ARGN +are not variables in the usual CMake sense. They are string +replacements much like the C preprocessor would do with a macro. If +you want true CMake variables and/or better CMake scope control you +should look at the function command. + +See the cmake_policy() command documentation for the behavior of +policies inside macros. diff --git a/Help/command/make_directory.rst b/Help/command/make_directory.rst new file mode 100644 index 0000000..44dbe97 --- /dev/null +++ b/Help/command/make_directory.rst @@ -0,0 +1,12 @@ +make_directory +-------------- + +Deprecated. Use the file(MAKE_DIRECTORY ) command instead. + +:: + + make_directory(directory) + +Creates the specified directory. Full paths should be given. Any +parent directories that do not exist will also be created. Use with +care. diff --git a/Help/command/mark_as_advanced.rst b/Help/command/mark_as_advanced.rst new file mode 100644 index 0000000..30b1289 --- /dev/null +++ b/Help/command/mark_as_advanced.rst @@ -0,0 +1,19 @@ +mark_as_advanced +---------------- + +Mark cmake cached variables as advanced. + +:: + + mark_as_advanced([CLEAR|FORCE] VAR [VAR2 ...]) + +Mark the named cached variables as advanced. An advanced variable +will not be displayed in any of the cmake GUIs unless the show +advanced option is on. If CLEAR is the first argument advanced +variables are changed back to unadvanced. If FORCE is the first +argument, then the variable is made advanced. If neither FORCE nor +CLEAR is specified, new values will be marked as advanced, but if the +variable already has an advanced/non-advanced state, it will not be +changed. + +It does nothing in script mode. diff --git a/Help/command/math.rst b/Help/command/math.rst new file mode 100644 index 0000000..38fde1d --- /dev/null +++ b/Help/command/math.rst @@ -0,0 +1,13 @@ +math +---- + +Mathematical expressions. + +:: + + math(EXPR <output variable> <math expression>) + +EXPR evaluates mathematical expression and returns result in the +output variable. Example mathematical expression is '5 * ( 10 + 13 +)'. Supported operators are + - * / % | & ^ ~ << >> * / %. They have +the same meaning as they do in C code. diff --git a/Help/command/message.rst b/Help/command/message.rst new file mode 100644 index 0000000..a20325a --- /dev/null +++ b/Help/command/message.rst @@ -0,0 +1,33 @@ +message +------- + +Display a message to the user. + +:: + + message([<mode>] "message to display" ...) + +The optional <mode> keyword determines the type of message: + +:: + + (none) = Important information + STATUS = Incidental information + WARNING = CMake Warning, continue processing + AUTHOR_WARNING = CMake Warning (dev), continue processing + SEND_ERROR = CMake Error, continue processing, + but skip generation + FATAL_ERROR = CMake Error, stop processing and generation + DEPRECATION = CMake Deprecation Error or Warning if variable + CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED + is enabled, respectively, else no message. + +The CMake command-line tool displays STATUS messages on stdout and all +other message types on stderr. The CMake GUI displays all messages in +its log area. The interactive dialogs (ccmake and CMakeSetup) show +STATUS messages one at a time on a status line and other messages in +interactive pop-up boxes. + +CMake Warning and Error message text displays using a simple markup +language. Non-indented text is formatted in line-wrapped paragraphs +delimited by newlines. Indented text is considered pre-formatted. diff --git a/Help/command/option.rst b/Help/command/option.rst new file mode 100644 index 0000000..244ed07 --- /dev/null +++ b/Help/command/option.rst @@ -0,0 +1,15 @@ +option +------ + +Provides an option that the user can optionally select. + +:: + + option(<option_variable> "help string describing option" + [initial value]) + +Provide an option for the user to select as ON or OFF. If no initial +value is provided, OFF is used. + +If you have options that depend on the values of other options, see +the module help for CMakeDependentOption. diff --git a/Help/command/output_required_files.rst b/Help/command/output_required_files.rst new file mode 100644 index 0000000..d6bce13 --- /dev/null +++ b/Help/command/output_required_files.rst @@ -0,0 +1,17 @@ +output_required_files +--------------------- + +Deprecated. Approximate C preprocessor dependency scanning. + +This command exists only because ancient CMake versions provided it. +CMake handles preprocessor dependency scanning automatically using a +more advanced scanner. + +:: + + output_required_files(srcfile outputfile) + +Outputs a list of all the source files that are required by the +specified srcfile. This list is written into outputfile. This is +similar to writing out the dependencies for srcfile except that it +jumps from .h files into .cxx, .c and .cpp files if possible. diff --git a/Help/command/project.rst b/Help/command/project.rst new file mode 100644 index 0000000..9b9f93f --- /dev/null +++ b/Help/command/project.rst @@ -0,0 +1,27 @@ +project +------- + +Set a name for the entire project. + +:: + + project(<projectname> [languageName1 languageName2 ... ] ) + +Sets the name of the project. Additionally this sets the variables +<projectName>_BINARY_DIR and <projectName>_SOURCE_DIR to the +respective values. + +Optionally you can specify which languages your project supports. +Example languages are CXX (i.e. C++), C, Fortran, etc. By default C +and CXX are enabled. E.g. if you do not have a C++ compiler, you can +disable the check for it by explicitly listing the languages you want +to support, e.g. C. By using the special language "NONE" all checks +for any language can be disabled. If a variable exists called +CMAKE_PROJECT_<projectName>_INCLUDE, the file pointed to by that +variable will be included as the last step of the project command. + +The top-level CMakeLists.txt file for a project must contain a +literal, direct call to the project() command; loading one through the +include() command is not sufficient. If no such call exists CMake +will implicitly add one to the top that enables the default languages +(C and CXX). diff --git a/Help/command/qt_wrap_cpp.rst b/Help/command/qt_wrap_cpp.rst new file mode 100644 index 0000000..81bbc06 --- /dev/null +++ b/Help/command/qt_wrap_cpp.rst @@ -0,0 +1,12 @@ +qt_wrap_cpp +----------- + +Create Qt Wrappers. + +:: + + qt_wrap_cpp(resultingLibraryName DestName + SourceLists ...) + +Produce moc files for all the .h files listed in the SourceLists. The +moc files will be added to the library using the DestName source list. diff --git a/Help/command/qt_wrap_ui.rst b/Help/command/qt_wrap_ui.rst new file mode 100644 index 0000000..4e033a8 --- /dev/null +++ b/Help/command/qt_wrap_ui.rst @@ -0,0 +1,14 @@ +qt_wrap_ui +---------- + +Create Qt user interfaces Wrappers. + +:: + + qt_wrap_ui(resultingLibraryName HeadersDestName + SourcesDestName SourceLists ...) + +Produce .h and .cxx files for all the .ui files listed in the +SourceLists. The .h files will be added to the library using the +HeadersDestNamesource list. The .cxx files will be added to the +library using the SourcesDestNamesource list. diff --git a/Help/command/remove.rst b/Help/command/remove.rst new file mode 100644 index 0000000..ddf0e9a --- /dev/null +++ b/Help/command/remove.rst @@ -0,0 +1,12 @@ +remove +------ + +Deprecated. Use the list(REMOVE_ITEM ) command instead. + +:: + + remove(VAR VALUE VALUE ...) + +Removes VALUE from the variable VAR. This is typically used to remove +entries from a vector (e.g. semicolon separated list). VALUE is +expanded. diff --git a/Help/command/remove_definitions.rst b/Help/command/remove_definitions.rst new file mode 100644 index 0000000..566da6e --- /dev/null +++ b/Help/command/remove_definitions.rst @@ -0,0 +1,11 @@ +remove_definitions +------------------ + +Removes -D define flags added by add_definitions. + +:: + + remove_definitions(-DFOO -DBAR ...) + +Removes flags (added by add_definitions) from the compiler command +line for sources in the current directory and below. diff --git a/Help/command/return.rst b/Help/command/return.rst new file mode 100644 index 0000000..899470c --- /dev/null +++ b/Help/command/return.rst @@ -0,0 +1,18 @@ +return +------ + +Return from a file, directory or function. + +:: + + return() + +Returns from a file, directory or function. When this command is +encountered in an included file (via include() or find_package()), it +causes processing of the current file to stop and control is returned +to the including file. If it is encountered in a file which is not +included by another file, e.g. a CMakeLists.txt, control is returned +to the parent directory if there is one. If return is called in a +function, control is returned to the caller of the function. Note +that a macro is not a function and does not handle return like a +function does. diff --git a/Help/command/separate_arguments.rst b/Help/command/separate_arguments.rst new file mode 100644 index 0000000..a876595 --- /dev/null +++ b/Help/command/separate_arguments.rst @@ -0,0 +1,31 @@ +separate_arguments +------------------ + +Parse space-separated arguments into a semicolon-separated list. + +:: + + separate_arguments(<var> <UNIX|WINDOWS>_COMMAND "<args>") + +Parses a unix- or windows-style command-line string "<args>" and +stores a semicolon-separated list of the arguments in <var>. The +entire command line must be given in one "<args>" argument. + +The UNIX_COMMAND mode separates arguments by unquoted whitespace. It +recognizes both single-quote and double-quote pairs. A backslash +escapes the next literal character (\" is "); there are no special +escapes (\n is just n). + +The WINDOWS_COMMAND mode parses a windows command-line using the same +syntax the runtime library uses to construct argv at startup. It +separates arguments by whitespace that is not double-quoted. +Backslashes are literal unless they precede double-quotes. See the +MSDN article "Parsing C Command-Line Arguments" for details. + +:: + + separate_arguments(VARIABLE) + +Convert the value of VARIABLE to a semi-colon separated list. All +spaces are replaced with ';'. This helps with generating command +lines. diff --git a/Help/command/set.rst b/Help/command/set.rst new file mode 100644 index 0000000..7a59550 --- /dev/null +++ b/Help/command/set.rst @@ -0,0 +1,116 @@ +set +--- + +Set a CMake, cache or environment variable to a given value. + +:: + + set(<variable> <value> + [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE]) + +Within CMake sets <variable> to the value <value>. <value> is +expanded before <variable> is set to it. Normally, set will set a +regular CMake variable. If CACHE is present, then the <variable> is +put in the cache instead, unless it is already in the cache. See +section 'Variable types in CMake' below for details of regular and +cache variables and their interactions. If CACHE is used, <type> and +<docstring> are required. <type> is used by the CMake GUI to choose a +widget with which the user sets a value. The value for <type> may be +one of + +:: + + FILEPATH = File chooser dialog. + PATH = Directory chooser dialog. + STRING = Arbitrary string. + BOOL = Boolean ON/OFF checkbox. + INTERNAL = No GUI entry (used for persistent variables). + +If <type> is INTERNAL, the cache variable is marked as internal, and +will not be shown to the user in tools like cmake-gui. This is +intended for values that should be persisted in the cache, but which +users should not normally change. INTERNAL implies FORCE. + +Normally, set(...CACHE...) creates cache variables, but does not +modify them. If FORCE is specified, the value of the cache variable +is set, even if the variable is already in the cache. This should +normally be avoided, as it will remove any changes to the cache +variable's value by the user. + +If PARENT_SCOPE is present, the variable will be set in the scope +above the current scope. Each new directory or function creates a new +scope. This command will set the value of a variable into the parent +directory or calling function (whichever is applicable to the case at +hand). PARENT_SCOPE cannot be combined with CACHE. + +If <value> is not specified then the variable is removed instead of +set. See also: the unset() command. + +:: + + set(<variable> <value1> ... <valueN>) + +In this case <variable> is set to a semicolon separated list of +values. + +<variable> can be an environment variable such as: + +:: + + set( ENV{PATH} /home/martink ) + +in which case the environment variable will be set. + +*** Variable types in CMake *** + +In CMake there are two types of variables: normal variables and cache +variables. Normal variables are meant for the internal use of the +script (just like variables in most programming languages); they are +not persisted across CMake runs. Cache variables (unless set with +INTERNAL) are mostly intended for configuration settings where the +first CMake run determines a suitable default value, which the user +can then override, by editing the cache with tools such as ccmake or +cmake-gui. Cache variables are stored in the CMake cache file, and +are persisted across CMake runs. + +Both types can exist at the same time with the same name but different +values. When ${FOO} is evaluated, CMake first looks for a normal +variable 'FOO' in scope and uses it if set. If and only if no normal +variable exists then it falls back to the cache variable 'FOO'. + +Some examples: + +The code 'set(FOO "x")' sets the normal variable 'FOO'. It does not +touch the cache, but it will hide any existing cache value 'FOO'. + +The code 'set(FOO "x" CACHE ...)' checks for 'FOO' in the cache, +ignoring any normal variable of the same name. If 'FOO' is in the +cache then nothing happens to either the normal variable or the cache +variable. If 'FOO' is not in the cache, then it is added to the +cache. + +Finally, whenever a cache variable is added or modified by a command, +CMake also *removes* the normal variable of the same name from the +current scope so that an immediately following evaluation of it will +expose the newly cached value. + +Normally projects should avoid using normal and cache variables of the +same name, as this interaction can be hard to follow. However, in +some situations it can be useful. One example (used by some +projects): + +A project has a subproject in its source tree. The child project has +its own CMakeLists.txt, which is included from the parent +CMakeLists.txt using add_subdirectory(). Now, if the parent and the +child project provide the same option (for example a compiler option), +the parent gets the first chance to add a user-editable option to the +cache. Normally, the child would then use the same value that the +parent uses. However, it may be necessary to hard-code the value for +the child project's option while still allowing the user to edit the +value used by the parent project. The parent project can achieve this +simply by setting a normal variable with the same name as the option +in a scope sufficient to hide the option's cache variable from the +child completely. The parent has already set the cache variable, so +the child's set(...CACHE...) will do nothing, and evaluating the +option variable will use the value from the normal variable, which +hides the cache variable. diff --git a/Help/command/set_directory_properties.rst b/Help/command/set_directory_properties.rst new file mode 100644 index 0000000..834013a --- /dev/null +++ b/Help/command/set_directory_properties.rst @@ -0,0 +1,15 @@ +set_directory_properties +------------------------ + +Set a property of the directory. + +:: + + set_directory_properties(PROPERTIES prop1 value1 prop2 value2) + +Set a property for the current directory and subdirectories. If the +property is not found, CMake will report an error. The properties +include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, +INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. +ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as +a part of "make clean" stage. diff --git a/Help/command/set_property.rst b/Help/command/set_property.rst new file mode 100644 index 0000000..8cb963e --- /dev/null +++ b/Help/command/set_property.rst @@ -0,0 +1,43 @@ +set_property +------------ + +Set a named property in a given scope. + +:: + + set_property(<GLOBAL | + DIRECTORY [dir] | + TARGET [target1 [target2 ...]] | + SOURCE [src1 [src2 ...]] | + TEST [test1 [test2 ...]] | + CACHE [entry1 [entry2 ...]]> + [APPEND] [APPEND_STRING] + PROPERTY <name> [value1 [value2 ...]]) + +Set one property on zero or more objects of a scope. The first +argument determines the scope in which the property is set. It must +be one of the following: + +GLOBAL scope is unique and does not accept a name. + +DIRECTORY scope defaults to the current directory but another +directory (already processed by CMake) may be named by full or +relative path. + +TARGET scope may name zero or more existing targets. + +SOURCE scope may name zero or more source files. Note that source +file properties are visible only to targets added in the same +directory (CMakeLists.txt). + +TEST scope may name zero or more existing tests. + +CACHE scope must name zero or more cache existing entries. + +The required PROPERTY option is immediately followed by the name of +the property to set. Remaining arguments are used to compose the +property value in the form of a semicolon-separated list. If the +APPEND option is given the list is appended to any existing property +value.If the APPEND_STRING option is given the string is append to any +existing property value as string, i.e. it results in a longer string +and not a list of strings. diff --git a/Help/command/set_source_files_properties.rst b/Help/command/set_source_files_properties.rst new file mode 100644 index 0000000..8ea02a3 --- /dev/null +++ b/Help/command/set_source_files_properties.rst @@ -0,0 +1,15 @@ +set_source_files_properties +--------------------------- + +Source files can have properties that affect how they are built. + +:: + + set_source_files_properties([file1 [file2 [...]]] + PROPERTIES prop1 value1 + [prop2 value2 [...]]) + +Set properties associated with source files using a key/value paired +list. See properties documentation for those known to CMake. +Unrecognized properties are ignored. Source file properties are +visible only to targets added in the same directory (CMakeLists.txt). diff --git a/Help/command/set_target_properties.rst b/Help/command/set_target_properties.rst new file mode 100644 index 0000000..f65ee24 --- /dev/null +++ b/Help/command/set_target_properties.rst @@ -0,0 +1,104 @@ +set_target_properties +--------------------- + +Targets can have properties that affect how they are built. + +:: + + set_target_properties(target1 target2 ... + PROPERTIES prop1 value1 + prop2 value2 ...) + +Set properties on a target. The syntax for the command is to list all +the files you want to change, and then provide the values you want to +set next. You can use any prop value pair you want and extract it +later with the GET_TARGET_PROPERTY command. + +Properties that affect the name of a target's output file are as +follows. The PREFIX and SUFFIX properties override the default target +name prefix (such as "lib") and suffix (such as ".so"). IMPORT_PREFIX +and IMPORT_SUFFIX are the equivalent properties for the import library +corresponding to a DLL (for SHARED library targets). OUTPUT_NAME sets +the real name of a target when it is built and can be used to help +create two targets of the same name even though CMake requires unique +logical target names. There is also a <CONFIG>_OUTPUT_NAME that can +set the output name on a per-configuration basis. <CONFIG>_POSTFIX +sets a postfix for the real name of the target when it is built under +the configuration named by <CONFIG> (in upper-case, such as +"DEBUG_POSTFIX"). The value of this property is initialized when the +target is created to the value of the variable CMAKE_<CONFIG>_POSTFIX +(except for executable targets because earlier CMake versions which +did not use this variable for executables). + +The LINK_FLAGS property can be used to add extra flags to the link +step of a target. LINK_FLAGS_<CONFIG> will add to the configuration +<CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. +DEFINE_SYMBOL sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to target_EXPORTS by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations. The COMPILE_FLAGS +property sets additional compiler flags used to build sources within +the target. It may also be used to pass additional preprocessor +definitions. + +The LINKER_LANGUAGE property is used to change the tool used to link +an executable or shared library. The default is set the language to +match the files in the library. CXX and C are common values for this +property. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables VERSION can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. For shared libraries and executables on +Windows the VERSION attribute is parsed to extract a "major.minor" +version number. These numbers are used as the image version of the +binary. + +There are a few properties used to specify RPATH rules. INSTALL_RPATH +is a semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). INSTALL_RPATH_USE_LINK_PATH +is a boolean that if set to true will append directories in the linker +search path and outside the project to the INSTALL_RPATH. +SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree. +BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the +target in the build tree with the INSTALL_RPATH. This takes +precedence over SKIP_BUILD_RPATH and avoids the need for relinking +before installation. INSTALL_NAME_DIR is a string specifying the +directory portion of the "install_name" field of shared libraries on +Mac OSX to use in the installed targets. When the target is created +the values of the variables CMAKE_INSTALL_RPATH, +CMAKE_INSTALL_RPATH_USE_LINK_PATH, CMAKE_SKIP_BUILD_RPATH, +CMAKE_BUILD_WITH_INSTALL_RPATH, and CMAKE_INSTALL_NAME_DIR are used to +initialize these properties. + +PROJECT_LABEL can be used to change the name of the target in an IDE +like visual studio. VS_KEYWORD can be set to change the visual studio +keyword, for example Qt integration works better if this is set to +Qt4VSv1.0. + +VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER and +VS_SCC_AUXPATH can be set to add support for source control bindings +in a Visual Studio project file. + +VS_GLOBAL_<variable> can be set to add a Visual Studio +project-specific global variable. Qt integration works better if +VS_GLOBAL_QtVersion is set to the Qt version FindQt4.cmake found. For +example, "4.7.3" + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. + +The EXCLUDE_FROM_DEFAULT_BUILD property is used by the visual studio +generators. If it is set to 1 the target will not be part of the +default build when you select "Build Solution". This can also be set +on a per-configuration basis using +EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>. diff --git a/Help/command/set_tests_properties.rst b/Help/command/set_tests_properties.rst new file mode 100644 index 0000000..82cd5d8 --- /dev/null +++ b/Help/command/set_tests_properties.rst @@ -0,0 +1,36 @@ +set_tests_properties +-------------------- + +Set a property of the tests. + +:: + + set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2) + +Set a property for the tests. If the property is not found, CMake +will report an error. Generator expressions will be expanded the same +as supported by the test's add_test call. The properties include: + +WILL_FAIL: If set to true, this will invert the pass/fail flag of the +test. + +PASS_REGULAR_EXPRESSION: If set, the test output will be checked +against the specified regular expressions and at least one of the +regular expressions has to match, otherwise the test will fail. + +:: + + Example: PASS_REGULAR_EXPRESSION "TestPassed;All ok" + +FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of +specified regular expressions, the test will fail. + +:: + + Example: PASS_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed" + +Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a list +of regular expressions. + +TIMEOUT: Setting this will limit the test runtime to the number of +seconds specified. diff --git a/Help/command/site_name.rst b/Help/command/site_name.rst new file mode 100644 index 0000000..e17c1ee --- /dev/null +++ b/Help/command/site_name.rst @@ -0,0 +1,8 @@ +site_name +--------- + +Set the given variable to the name of the computer. + +:: + + site_name(variable) diff --git a/Help/command/source_group.rst b/Help/command/source_group.rst new file mode 100644 index 0000000..77bb9ad --- /dev/null +++ b/Help/command/source_group.rst @@ -0,0 +1,28 @@ +source_group +------------ + +Define a grouping for sources in the makefile. + +:: + + source_group(name [REGULAR_EXPRESSION regex] [FILES src1 src2 ...]) + +Defines a group into which sources will be placed in project files. +This is mainly used to setup file tabs in Visual Studio. Any file +whose name is listed or matches the regular expression will be placed +in this group. If a file matches multiple groups, the LAST group that +explicitly lists the file will be favored, if any. If no group +explicitly lists the file, the LAST group whose regular expression +matches the file will be favored. + +The name of the group may contain backslashes to specify subgroups: + +:: + + source_group(outer\\inner ...) + +For backwards compatibility, this command also supports the format: + +:: + + source_group(name regex) diff --git a/Help/command/string.rst b/Help/command/string.rst new file mode 100644 index 0000000..1e18ca6 --- /dev/null +++ b/Help/command/string.rst @@ -0,0 +1,152 @@ +string +------ + +String operations. + +:: + + string(REGEX MATCH <regular_expression> + <output variable> <input> [<input>...]) + string(REGEX MATCHALL <regular_expression> + <output variable> <input> [<input>...]) + string(REGEX REPLACE <regular_expression> + <replace_expression> <output variable> + <input> [<input>...]) + string(REPLACE <match_string> + <replace_string> <output variable> + <input> [<input>...]) + string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> + <output variable> <input>) + string(COMPARE EQUAL <string1> <string2> <output variable>) + string(COMPARE NOTEQUAL <string1> <string2> <output variable>) + string(COMPARE LESS <string1> <string2> <output variable>) + string(COMPARE GREATER <string1> <string2> <output variable>) + string(ASCII <number> [<number> ...] <output variable>) + string(CONFIGURE <string1> <output variable> + [@ONLY] [ESCAPE_QUOTES]) + string(TOUPPER <string1> <output variable>) + string(TOLOWER <string1> <output variable>) + string(LENGTH <string> <output variable>) + string(SUBSTRING <string> <begin> <length> <output variable>) + string(STRIP <string> <output variable>) + string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>] + [RANDOM_SEED <seed>] <output variable>) + string(FIND <string> <substring> <output variable> [REVERSE]) + string(TIMESTAMP <output variable> [<format string>] [UTC]) + string(MAKE_C_IDENTIFIER <input string> <output variable>) + +REGEX MATCH will match the regular expression once and store the match +in the output variable. + +REGEX MATCHALL will match the regular expression as many times as +possible and store the matches in the output variable as a list. + +REGEX REPLACE will match the regular expression as many times as +possible and substitute the replacement expression for the match in +the output. The replace expression may refer to paren-delimited +subexpressions of the match using \1, \2, ..., \9. Note that two +backslashes (\\1) are required in CMake code to get a backslash +through argument parsing. + +REPLACE will replace all occurrences of match_string in the input with +replace_string and store the result in the output. + +MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 will compute a +cryptographic hash of the input string. + +COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store +true or false in the output variable. + +ASCII will convert all numbers into corresponding ASCII characters. + +CONFIGURE will transform a string like CONFIGURE_FILE transforms a +file. + +TOUPPER/TOLOWER will convert string to upper/lower characters. + +LENGTH will return a given string's length. + +SUBSTRING will return a substring of a given string. If length is -1 +the remainder of the string starting at begin will be returned. + +STRIP will return a substring of a given string with leading and +trailing spaces removed. + +RANDOM will return a random string of given length consisting of +characters from the given alphabet. Default length is 5 characters +and default alphabet is all numbers and upper and lower case letters. +If an integer RANDOM_SEED is given, its value will be used to seed the +random number generator. + +FIND will return the position where the given substring was found in +the supplied string. If the REVERSE flag was used, the command will +search for the position of the last occurrence of the specified +substring. + +The following characters have special meaning in regular expressions: + +:: + + ^ Matches at beginning of input + $ Matches at end of input + . Matches any single character + [ ] Matches any character(s) inside the brackets + [^ ] Matches any character(s) not inside the brackets + - Inside brackets, specifies an inclusive range between + characters on either side e.g. [a-f] is [abcdef] + To match a literal - using brackets, make it the first + or the last character e.g. [+*/-] matches basic + mathematical operators. + * Matches preceding pattern zero or more times + + Matches preceding pattern one or more times + ? Matches preceding pattern zero or once only + | Matches a pattern on either side of the | + () Saves a matched subexpression, which can be referenced + in the REGEX REPLACE operation. Additionally it is saved + by all regular expression-related commands, including + e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9). + +``*``, ``+`` and ``?`` have higher precedence than concatenation. | has lower +precedence than concatenation. This means that the regular expression +"^ab+d$" matches "abbd" but not "ababd", and the regular expression +"^(ab|cd)$" matches "ab" but not "abd". + +TIMESTAMP will write a string representation of the current date +and/or time to the output variable. + +Should the command be unable to obtain a timestamp the output variable +will be set to the empty string "". + +The optional UTC flag requests the current date/time representation to +be in Coordinated Universal Time (UTC) rather than local time. + +The optional <format string> may contain the following format +specifiers: + +:: + + %d The day of the current month (01-31). + %H The hour on a 24-hour clock (00-23). + %I The hour on a 12-hour clock (01-12). + %j The day of the current year (001-366). + %m The month of the current year (01-12). + %M The minute of the current hour (00-59). + %S The second of the current minute. + 60 represents a leap second. (00-60) + %U The week number of the current year (00-53). + %w The day of the current week. 0 is Sunday. (0-6) + %y The last two digits of the current year (00-99) + %Y The current year. + +Unknown format specifiers will be ignored and copied to the output +as-is. + +If no explicit <format string> is given it will default to: + +:: + + %Y-%m-%dT%H:%M:%S for local time. + %Y-%m-%dT%H:%M:%SZ for UTC. + +MAKE_C_IDENTIFIER will write a string which can be used as an +identifier in C. diff --git a/Help/command/subdir_depends.rst b/Help/command/subdir_depends.rst new file mode 100644 index 0000000..c72a4af --- /dev/null +++ b/Help/command/subdir_depends.rst @@ -0,0 +1,11 @@ +subdir_depends +-------------- + +Deprecated. Does nothing. + +:: + + subdir_depends(subdir dep1 dep2 ...) + +Does not do anything. This command used to help projects order +parallel builds correctly. This functionality is now automatic. diff --git a/Help/command/subdirs.rst b/Help/command/subdirs.rst new file mode 100644 index 0000000..dee49f8 --- /dev/null +++ b/Help/command/subdirs.rst @@ -0,0 +1,24 @@ +subdirs +------- + +Deprecated. Use the add_subdirectory() command instead. + +Add a list of subdirectories to the build. + +:: + + subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] + [PREORDER] ) + +Add a list of subdirectories to the build. The add_subdirectory +command should be used instead of subdirs although subdirs will still +work. This will cause any CMakeLists.txt files in the sub directories +to be processed by CMake. Any directories after the PREORDER flag are +traversed first by makefile builds, the PREORDER flag has no effect on +IDE projects. Any directories after the EXCLUDE_FROM_ALL marker will +not be included in the top level makefile or project file. This is +useful for having CMake create makefiles or projects for a set of +examples in a project. You would want CMake to generate makefiles or +project files for all the examples at the same time, but you would not +want them to show up in the top level project or be built each time +make is run from the top. diff --git a/Help/command/target_compile_definitions.rst b/Help/command/target_compile_definitions.rst new file mode 100644 index 0000000..5c223a2 --- /dev/null +++ b/Help/command/target_compile_definitions.rst @@ -0,0 +1,24 @@ +target_compile_definitions +-------------------------- + +Add compile definitions to a target. + +:: + + target_compile_definitions(<target> <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify compile definitions to use when compiling a given target. The +named <target> must have been created by a command such as +add_executable or add_library and must not be an IMPORTED target. The +INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the COMPILE_DEFINITIONS property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_COMPILE_DEFINITIONS +property of <target>. The following arguments specify compile +definitions. Repeated calls for the same <target> append items in the +order called. + +Arguments to target_compile_definitions may use "generator expressions" with +the syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst new file mode 100644 index 0000000..88a4ea3 --- /dev/null +++ b/Help/command/target_compile_options.rst @@ -0,0 +1,27 @@ +target_compile_options +---------------------- + +Add compile options to a target. + +:: + + target_compile_options(<target> [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify compile options to use when compiling a given target. The +named <target> must have been created by a command such as +add_executable or add_library and must not be an IMPORTED target. If +BEFORE is specified, the content will be prepended to the property +instead of being appended. + +The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the COMPILE_OPTIONS property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_COMPILE_OPTIONS property +of <target>. The following arguments specify compile opitions. +Repeated calls for the same <target> append items in the order called. + +Arguments to target_compile_options may use "generator expressions" +with the syntax "$<...>". +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst new file mode 100644 index 0000000..4835b96 --- /dev/null +++ b/Help/command/target_include_directories.rst @@ -0,0 +1,37 @@ +target_include_directories +-------------------------- + +Add include directories to a target. + +:: + + target_include_directories(<target> [SYSTEM] [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] + [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) + +Specify include directories or targets to use when compiling a given +target. The named <target> must have been created by a command such +as add_executable or add_library and must not be an IMPORTED target. + +If BEFORE is specified, the content will be prepended to the property +instead of being appended. + +The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the +scope of the following arguments. PRIVATE and PUBLIC items will +populate the INCLUDE_DIRECTORIES property of <target>. PUBLIC and +INTERFACE items will populate the INTERFACE_INCLUDE_DIRECTORIES +property of <target>. The following arguments specify include +directories. Specified include directories may be absolute paths or +relative paths. Repeated calls for the same <target> append items in +the order called.If SYSTEM is specified, the compiler will be told the +directories are meant as system include directories on some platforms +(signalling this setting might achieve effects such as the compiler +skipping warnings, or these fixed-install system files not being +considered in dependency calculations - see compiler docs). If SYSTEM +is used together with PUBLIC or INTERFACE, the +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be populated +with the specified directories. + +Arguments to target_include_directories may use "generator +expressions" with the syntax "$<...>". +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/command/target_link_libraries.rst b/Help/command/target_link_libraries.rst new file mode 100644 index 0000000..a1e3e22 --- /dev/null +++ b/Help/command/target_link_libraries.rst @@ -0,0 +1,142 @@ +target_link_libraries +--------------------- + +Link a target to given libraries. + +:: + + target_link_libraries(<target> [item1 [item2 [...]]] + [[debug|optimized|general] <item>] ...) + +Specify libraries or flags to use when linking a given target. The +named <target> must have been created in the current directory by a +command such as add_executable or add_library. The remaining +arguments specify library names or flags. Repeated calls for the same +<target> append items in the order called. + +If a library name matches that of another target in the project a +dependency will automatically be added in the build system to make +sure the library being linked is up-to-date before the target links. +Item names starting with '-', but not '-l' or '-framework', are +treated as linker flags. + +A "debug", "optimized", or "general" keyword indicates that the +library immediately following it is to be used only for the +corresponding build configuration. The "debug" keyword corresponds to +the Debug configuration (or to configurations named in the +DEBUG_CONFIGURATIONS global property if it is set). The "optimized" +keyword corresponds to all other configurations. The "general" +keyword corresponds to all configurations, and is purely optional +(assumed if omitted). Higher granularity may be achieved for +per-configuration rules by creating and linking to IMPORTED library +targets. See the IMPORTED mode of the add_library command for more +information. + +Library dependencies are transitive by default. When this target is +linked into another target then the libraries linked to this target +will appear on the link line for the other target too. See the +INTERFACE_LINK_LIBRARIES target property to override the set of +transitive link dependencies for a target. Calls to other signatures +of this command may set the property making any libraries linked +exclusively by this signature private. + +CMake will also propagate "usage requirements" from linked library +targets. Usage requirements affect compilation of sources in the +<target>. They are specified by properties defined on linked targets. +During generation of the build system, CMake integrates usage +requirement property values with the corresponding build properties +for <target>: + +:: + + INTERFACE_COMPILE_DEFINITONS: Appends to COMPILE_DEFINITONS + INTERFACE_INCLUDE_DIRECTORIES: Appends to INCLUDE_DIRECTORIES + INTERFACE_POSITION_INDEPENDENT_CODE: Sets POSITION_INDEPENDENT_CODE + or checked for consistency with existing value + + + +If an <item> is a library in a Mac OX framework, the Headers directory +of the framework will also be processed as a "usage requirement". +This has the same effect as passing the framework directory as an +include directory. target_link_libraries(<target> + +:: + + <PRIVATE|PUBLIC|INTERFACE> <lib> ... + [<PRIVATE|PUBLIC|INTERFACE> <lib> ... ] ...]) + +The PUBLIC, PRIVATE and INTERFACE keywords can be used to specify both +the link dependencies and the link interface in one command. +Libraries and targets following PUBLIC are linked to, and are made +part of the link interface. Libraries and targets following PRIVATE +are linked to, but are not made part of the link interface. Libraries +following INTERFACE are appended to the link interface and are not +used for linking <target>. + +:: + + target_link_libraries(<target> LINK_INTERFACE_LIBRARIES + [[debug|optimized|general] <lib>] ...) + +The LINK_INTERFACE_LIBRARIES mode appends the libraries to the +INTERFACE_LINK_LIBRARIES target property instead of using them for +linking. If policy CMP0022 is not NEW, then this mode also appends +libraries to the LINK_INTERFACE_LIBRARIES and its per-configuration +equivalent. This signature is for compatibility only. Prefer the +INTERFACE mode instead. Libraries specified as "debug" are wrapped in +a generator expression to correspond to debug builds. If policy +CMP0022 is not NEW, the libraries are also appended to the +LINK_INTERFACE_LIBRARIES_DEBUG property (or to the properties +corresponding to configurations listed in the DEBUG_CONFIGURATIONS +global property if it is set). Libraries specified as "optimized" are +appended to the INTERFACE_LINK_LIBRARIES property. If policy CMP0022 +is not NEW, they are also appended to the LINK_INTERFACE_LIBRARIES +property. Libraries specified as "general" (or without any keyword) +are treated as if specified for both "debug" and "optimized". + +:: + + target_link_libraries(<target> + <LINK_PRIVATE|LINK_PUBLIC> + [[debug|optimized|general] <lib>] ... + [<LINK_PRIVATE|LINK_PUBLIC> + [[debug|optimized|general] <lib>] ...]) + +The LINK_PUBLIC and LINK_PRIVATE modes can be used to specify both the +link dependencies and the link interface in one command. This +signature is for compatibility only. Prefer the PUBLIC or PRIVATE +keywords instead. Libraries and targets following LINK_PUBLIC are +linked to, and are made part of the INTERFACE_LINK_LIBRARIES. If +policy CMP0022 is not NEW, they are also made part of the +LINK_INTERFACE_LIBRARIES. Libraries and targets following +LINK_PRIVATE are linked to, but are not made part of the +INTERFACE_LINK_LIBRARIES (or LINK_INTERFACE_LIBRARIES). + +The library dependency graph is normally acyclic (a DAG), but in the +case of mutually-dependent STATIC libraries CMake allows the graph to +contain cycles (strongly connected components). When another target +links to one of the libraries CMake repeats the entire connected +component. For example, the code + +:: + + add_library(A STATIC a.c) + add_library(B STATIC b.c) + target_link_libraries(A B) + target_link_libraries(B A) + add_executable(main main.c) + target_link_libraries(main A) + +links 'main' to 'A B A B'. (While one repetition is usually +sufficient, pathological object file and symbol arrangements can +require more. One may handle such cases by manually repeating the +component in the last target_link_libraries call. However, if two +archives are really so interdependent they should probably be combined +into a single archive.) + +Arguments to target_link_libraries may use "generator expressions" +with the syntax "$<...>". Note however, that generator expressions +will not be used in OLD handling of CMP0003 or CMP0004. +See the :manual:`cmake-generator-expressions(7)` manual for available +expressions. diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst new file mode 100644 index 0000000..8ed3cf4 --- /dev/null +++ b/Help/command/try_compile.rst @@ -0,0 +1,71 @@ +try_compile +----------- + +Try building some code. + +:: + + try_compile(RESULT_VAR <bindir> <srcdir> + <projectName> [targetName] [CMAKE_FLAGS flags...] + [OUTPUT_VARIABLE <var>]) + +Try building a project. In this form, srcdir should contain a +complete CMake project with a CMakeLists.txt file and all sources. +The bindir and srcdir will not be deleted after this command is run. +Specify targetName to build a specific target instead of the 'all' or +'ALL_BUILD' target. + +:: + + try_compile(RESULT_VAR <bindir> <srcfile|SOURCES srcfile...> + [CMAKE_FLAGS flags...] + [COMPILE_DEFINITIONS flags...] + [LINK_LIBRARIES libs...] + [OUTPUT_VARIABLE <var>] + [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]]) + +Try building an executable from one or more source files. In this +form the user need only supply one or more source files that include a +definition for 'main'. CMake will create a CMakeLists.txt file to +build the source(s) as an executable. Specify COPY_FILE to get a copy +of the linked executable at the given fileName and optionally +COPY_FILE_ERROR to capture any error. + +In this version all files in bindir/CMakeFiles/CMakeTmp will be +cleaned automatically. For debugging, --debug-trycompile can be +passed to cmake to avoid this clean. However, multiple sequential +try_compile operations reuse this single output directory. If you use +--debug-trycompile, you can only debug one try_compile call at a time. +The recommended procedure is to configure with cmake all the way +through once, then delete the cache entry associated with the +try_compile call of interest, and then re-run cmake again with +--debug-trycompile. + +Some extra flags that can be included are, INCLUDE_DIRECTORIES, +LINK_DIRECTORIES, and LINK_LIBRARIES. COMPILE_DEFINITIONS are +-Ddefinition that will be passed to the compile line. + +The srcfile signature also accepts a LINK_LIBRARIES argument which may +contain a list of libraries or IMPORTED targets which will be linked +to in the generated project. If LINK_LIBRARIES is specified as a +parameter to try_compile, then any LINK_LIBRARIES passed as +CMAKE_FLAGS will be ignored. + +try_compile creates a CMakeList.txt file on the fly that looks like +this: + +:: + + add_definitions( <expanded COMPILE_DEFINITIONS from calling cmake>) + include_directories(${INCLUDE_DIRECTORIES}) + link_directories(${LINK_DIRECTORIES}) + add_executable(cmTryCompileExec sources) + target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES}) + +In both versions of the command, if OUTPUT_VARIABLE is specified, then +the output from the build process is stored in the given variable. +The success or failure of the try_compile, i.e. TRUE or FALSE +respectively, is returned in RESULT_VAR. CMAKE_FLAGS can be used to +pass -DVAR:TYPE=VALUE flags to the cmake that is run during the build. +Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build +configuration. diff --git a/Help/command/try_run.rst b/Help/command/try_run.rst new file mode 100644 index 0000000..9a17ad9 --- /dev/null +++ b/Help/command/try_run.rst @@ -0,0 +1,52 @@ +try_run +------- + +Try compiling and then running some code. + +:: + + try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR + bindir srcfile [CMAKE_FLAGS <Flags>] + [COMPILE_DEFINITIONS <flags>] + [COMPILE_OUTPUT_VARIABLE comp] + [RUN_OUTPUT_VARIABLE run] + [OUTPUT_VARIABLE var] + [ARGS <arg1> <arg2>...]) + +Try compiling a srcfile. Return TRUE or FALSE for success or failure +in COMPILE_RESULT_VAR. Then if the compile succeeded, run the +executable and return its exit code in RUN_RESULT_VAR. If the +executable was built, but failed to run, then RUN_RESULT_VAR will be +set to FAILED_TO_RUN. COMPILE_OUTPUT_VARIABLE specifies the variable +where the output from the compile step goes. RUN_OUTPUT_VARIABLE +specifies the variable where the output from the running executable +goes. + +For compatibility reasons OUTPUT_VARIABLE is still supported, which +gives you the output from the compile and run step combined. + +Cross compiling issues + +When cross compiling, the executable compiled in the first step +usually cannot be run on the build host. try_run() checks the +CMAKE_CROSSCOMPILING variable to detect whether CMake is in +crosscompiling mode. If that's the case, it will still try to compile +the executable, but it will not try to run the executable. Instead it +will create cache variables which must be filled by the user or by +presetting them in some CMake script file to the values the executable +would have produced if it had been run on its actual target platform. +These variables are RUN_RESULT_VAR (explanation see above) and if +RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an additional cache +variable RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT.This is +intended to hold stdout and stderr from the executable. + +In order to make cross compiling your project easier, use try_run only +if really required. If you use try_run, use RUN_OUTPUT_VARIABLE (or +OUTPUT_VARIABLE) only if really required. Using them will require +that when crosscompiling, the cache variables will have to be set +manually to the output of the executable. You can also "guard" the +calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an +easy-to-preset alternative for this case. + +Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build +configuration. diff --git a/Help/command/unset.rst b/Help/command/unset.rst new file mode 100644 index 0000000..d8f0dcd --- /dev/null +++ b/Help/command/unset.rst @@ -0,0 +1,25 @@ +unset +----- + +Unset a variable, cache variable, or environment variable. + +:: + + unset(<variable> [CACHE | PARENT_SCOPE]) + +Removes the specified variable causing it to become undefined. If +CACHE is present then the variable is removed from the cache instead +of the current scope. + +If PARENT_SCOPE is present then the variable is removed from the scope +above the current scope. See the same option in the set() command for +further details. + +<variable> can be an environment variable such as: + +:: + + unset(ENV{LD_LIBRARY_PATH}) + +in which case the variable will be removed from the current +environment. diff --git a/Help/command/use_mangled_mesa.rst b/Help/command/use_mangled_mesa.rst new file mode 100644 index 0000000..a4d77e9 --- /dev/null +++ b/Help/command/use_mangled_mesa.rst @@ -0,0 +1,13 @@ +use_mangled_mesa +---------------- + +Copy mesa headers for use in combination with system GL. + +:: + + use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY) + +The path to mesa includes, should contain gl_mangle.h. The mesa +headers are copied to the specified output directory. This allows +mangled mesa headers to override other GL headers by being added to +the include directory path earlier. diff --git a/Help/command/utility_source.rst b/Help/command/utility_source.rst new file mode 100644 index 0000000..e513627 --- /dev/null +++ b/Help/command/utility_source.rst @@ -0,0 +1,22 @@ +utility_source +-------------- + +Specify the source tree of a third-party utility. + +:: + + utility_source(cache_entry executable_name + path_to_source [file1 file2 ...]) + +When a third-party utility's source is included in the distribution, +this command specifies its location and name. The cache entry will +not be set unless the path_to_source and all listed files exist. It +is assumed that the source tree of the utility will have been built +before it is needed. + +When cross compiling CMake will print a warning if a utility_source() +command is executed, because in many cases it is used to build an +executable which is executed later on. This doesn't work when cross +compiling, since the executable can run only on their target platform. +So in this case the cache entry has to be adjusted manually so it +points to an executable which is runnable on the build host. diff --git a/Help/command/variable_requires.rst b/Help/command/variable_requires.rst new file mode 100644 index 0000000..7535e40 --- /dev/null +++ b/Help/command/variable_requires.rst @@ -0,0 +1,20 @@ +variable_requires +----------------- + +Deprecated. Use the if() command instead. + +Assert satisfaction of an option's required variables. + +:: + + variable_requires(TEST_VARIABLE RESULT_VARIABLE + REQUIRED_VARIABLE1 + REQUIRED_VARIABLE2 ...) + +The first argument (TEST_VARIABLE) is the name of the variable to be +tested, if that variable is false nothing else is done. If +TEST_VARIABLE is true, then the next argument (RESULT_VARIABLE) is a +variable that is set to true if all the required variables are set. +The rest of the arguments are variables that must be true or not set +to NOTFOUND to avoid an error. If any are not true, an error is +reported. diff --git a/Help/command/variable_watch.rst b/Help/command/variable_watch.rst new file mode 100644 index 0000000..a2df058 --- /dev/null +++ b/Help/command/variable_watch.rst @@ -0,0 +1,13 @@ +variable_watch +-------------- + +Watch the CMake variable for change. + +:: + + variable_watch(<variable name> [<command to execute>]) + +If the specified variable changes, the message will be printed about +the variable being changed. If the command is specified, the command +will be executed. The command will receive the following arguments: +COMMAND(<variable> <access> <value> <current list file> <stack>) diff --git a/Help/command/while.rst b/Help/command/while.rst new file mode 100644 index 0000000..72c055d --- /dev/null +++ b/Help/command/while.rst @@ -0,0 +1,17 @@ +while +----- + +Evaluate a group of commands while a condition is true + +:: + + while(condition) + COMMAND1(ARGS ...) + COMMAND2(ARGS ...) + ... + endwhile(condition) + +All commands between while and the matching endwhile are recorded +without being invoked. Once the endwhile is evaluated, the recorded +list of commands is invoked as long as the condition is true. The +condition is evaluated using the same logic as the if command. diff --git a/Help/command/write_file.rst b/Help/command/write_file.rst new file mode 100644 index 0000000..015514b --- /dev/null +++ b/Help/command/write_file.rst @@ -0,0 +1,20 @@ +write_file +---------- + +Deprecated. Use the file(WRITE ) command instead. + +:: + + write_file(filename "message to write"... [APPEND]) + +The first argument is the file name, the rest of the arguments are +messages to write. If the argument APPEND is specified, then the +message will be appended. + +NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as +this one but add some more functionality. + +NOTE 2: When using write_file the produced file cannot be used as an +input to CMake (CONFIGURE_FILE, source file ...) because it will lead +to an infinite loop. Use configure_file if you want to generate input +files to CMake. diff --git a/Help/generator/Borland Makefiles.rst b/Help/generator/Borland Makefiles.rst new file mode 100644 index 0000000..c00d00a --- /dev/null +++ b/Help/generator/Borland Makefiles.rst @@ -0,0 +1,4 @@ +Borland Makefiles +----------------- + +Generates Borland makefiles. diff --git a/Help/generator/CodeBlocks - MinGW Makefiles.rst b/Help/generator/CodeBlocks - MinGW Makefiles.rst new file mode 100644 index 0000000..f54eb11 --- /dev/null +++ b/Help/generator/CodeBlocks - MinGW Makefiles.rst @@ -0,0 +1,11 @@ +CodeBlocks - MinGW Makefiles +---------------------------- + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/CodeBlocks - NMake Makefiles.rst b/Help/generator/CodeBlocks - NMake Makefiles.rst new file mode 100644 index 0000000..c7f944a --- /dev/null +++ b/Help/generator/CodeBlocks - NMake Makefiles.rst @@ -0,0 +1,11 @@ +CodeBlocks - NMake Makefiles +---------------------------- + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/CodeBlocks - Ninja.rst b/Help/generator/CodeBlocks - Ninja.rst new file mode 100644 index 0000000..0253af6 --- /dev/null +++ b/Help/generator/CodeBlocks - Ninja.rst @@ -0,0 +1,11 @@ +CodeBlocks - Ninja +------------------ + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/CodeBlocks - Unix Makefiles.rst b/Help/generator/CodeBlocks - Unix Makefiles.rst new file mode 100644 index 0000000..0a29835 --- /dev/null +++ b/Help/generator/CodeBlocks - Unix Makefiles.rst @@ -0,0 +1,11 @@ +CodeBlocks - Unix Makefiles +--------------------------- + +Generates CodeBlocks project files. + +Project files for CodeBlocks will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. Additionally a hierarchy of makefiles is generated +into the build tree. The appropriate make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/Eclipse CDT4 - MinGW Makefiles.rst b/Help/generator/Eclipse CDT4 - MinGW Makefiles.rst new file mode 100644 index 0000000..9e7a26e --- /dev/null +++ b/Help/generator/Eclipse CDT4 - MinGW Makefiles.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - MinGW Makefiles +------------------------------ + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/Eclipse CDT4 - NMake Makefiles.rst b/Help/generator/Eclipse CDT4 - NMake Makefiles.rst new file mode 100644 index 0000000..b5133ad --- /dev/null +++ b/Help/generator/Eclipse CDT4 - NMake Makefiles.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - NMake Makefiles +------------------------------ + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/Eclipse CDT4 - Ninja.rst b/Help/generator/Eclipse CDT4 - Ninja.rst new file mode 100644 index 0000000..270011f --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Ninja.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Ninja +-------------------- + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/Eclipse CDT4 - Unix Makefiles.rst b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst new file mode 100644 index 0000000..c3449a7 --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Unix Makefiles +----------------------------- + +Generates Eclipse CDT 4.0 project files. + +Project files for Eclipse will be created in the top directory. In +out of source builds, a linked resource to the top level source +directory will be created. Additionally a hierarchy of makefiles is +generated into the build tree. The appropriate make program can build +the project through the default make target. A "make install" target +is also provided. diff --git a/Help/generator/KDevelop3 - Unix Makefiles.rst b/Help/generator/KDevelop3 - Unix Makefiles.rst new file mode 100644 index 0000000..2a29a2e --- /dev/null +++ b/Help/generator/KDevelop3 - Unix Makefiles.rst @@ -0,0 +1,13 @@ +KDevelop3 - Unix Makefiles +-------------------------- + +Generates KDevelop 3 project files. + +Project files for KDevelop 3 will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. If you change the settings using KDevelop cmake +will try its best to keep your changes when regenerating the project +files. Additionally a hierarchy of UNIX makefiles is generated into +the build tree. Any standard UNIX-style make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/KDevelop3.rst b/Help/generator/KDevelop3.rst new file mode 100644 index 0000000..788d557 --- /dev/null +++ b/Help/generator/KDevelop3.rst @@ -0,0 +1,13 @@ +KDevelop3 +--------- + +Generates KDevelop 3 project files. + +Project files for KDevelop 3 will be created in the top directory and +in every subdirectory which features a CMakeLists.txt file containing +a PROJECT() call. If you change the settings using KDevelop cmake +will try its best to keep your changes when regenerating the project +files. Additionally a hierarchy of UNIX makefiles is generated into +the build tree. Any standard UNIX-style make program can build the +project through the default make target. A "make install" target is +also provided. diff --git a/Help/generator/MSYS Makefiles.rst b/Help/generator/MSYS Makefiles.rst new file mode 100644 index 0000000..0b89126 --- /dev/null +++ b/Help/generator/MSYS Makefiles.rst @@ -0,0 +1,7 @@ +MSYS Makefiles +-------------- + +Generates MSYS makefiles. + +The makefiles use /bin/sh as the shell. They require msys to be +installed on the machine. diff --git a/Help/generator/MinGW Makefiles.rst b/Help/generator/MinGW Makefiles.rst new file mode 100644 index 0000000..ed4ccdd --- /dev/null +++ b/Help/generator/MinGW Makefiles.rst @@ -0,0 +1,7 @@ +MinGW Makefiles +--------------- + +Generates a make file for use with mingw32-make. + +The makefiles generated use cmd.exe as the shell. They do not require +msys or a unix shell. diff --git a/Help/generator/NMake Makefiles JOM.rst b/Help/generator/NMake Makefiles JOM.rst new file mode 100644 index 0000000..3a8744c --- /dev/null +++ b/Help/generator/NMake Makefiles JOM.rst @@ -0,0 +1,4 @@ +NMake Makefiles JOM +------------------- + +Generates JOM makefiles. diff --git a/Help/generator/NMake Makefiles.rst b/Help/generator/NMake Makefiles.rst new file mode 100644 index 0000000..89f2479 --- /dev/null +++ b/Help/generator/NMake Makefiles.rst @@ -0,0 +1,4 @@ +NMake Makefiles +--------------- + +Generates NMake makefiles. diff --git a/Help/generator/Ninja.rst b/Help/generator/Ninja.rst new file mode 100644 index 0000000..08f74fb --- /dev/null +++ b/Help/generator/Ninja.rst @@ -0,0 +1,8 @@ +Ninja +----- + +Generates build.ninja files (experimental). + +A build.ninja file is generated into the build tree. Recent versions +of the ninja program can build the project through the "all" target. +An "install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - MinGW Makefiles.rst b/Help/generator/Sublime Text 2 - MinGW Makefiles.rst new file mode 100644 index 0000000..6e2ed02 --- /dev/null +++ b/Help/generator/Sublime Text 2 - MinGW Makefiles.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - MinGW Makefiles +-------------------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - NMake Makefiles.rst b/Help/generator/Sublime Text 2 - NMake Makefiles.rst new file mode 100644 index 0000000..5e02fd4 --- /dev/null +++ b/Help/generator/Sublime Text 2 - NMake Makefiles.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - NMake Makefiles +-------------------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - Ninja.rst b/Help/generator/Sublime Text 2 - Ninja.rst new file mode 100644 index 0000000..b7a2b88 --- /dev/null +++ b/Help/generator/Sublime Text 2 - Ninja.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Ninja +---------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Sublime Text 2 - Unix Makefiles.rst b/Help/generator/Sublime Text 2 - Unix Makefiles.rst new file mode 100644 index 0000000..67d329e --- /dev/null +++ b/Help/generator/Sublime Text 2 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Unix Makefiles +------------------------------- + +Generates Sublime Text 2 project files. + +Project files for Sublime Text 2 will be created in the top directory +and in every subdirectory which features a CMakeLists.txt file +containing a PROJECT() call. Additionally Makefiles (or build.ninja +files) are generated into the build tree. The appropriate make +program can build the project through the default make target. A +"make install" target is also provided. diff --git a/Help/generator/Unix Makefiles.rst b/Help/generator/Unix Makefiles.rst new file mode 100644 index 0000000..97d74a8 --- /dev/null +++ b/Help/generator/Unix Makefiles.rst @@ -0,0 +1,8 @@ +Unix Makefiles +-------------- + +Generates standard UNIX makefiles. + +A hierarchy of UNIX makefiles is generated into the build tree. Any +standard UNIX-style make program can build the project through the +default make target. A "make install" target is also provided. diff --git a/Help/generator/Visual Studio 10.rst b/Help/generator/Visual Studio 10.rst new file mode 100644 index 0000000..9ea7970 --- /dev/null +++ b/Help/generator/Visual Studio 10.rst @@ -0,0 +1,9 @@ +Visual Studio 10 +---------------- + +Generates Visual Studio 10 (2010) project files. + +It is possible to append a space followed by the platform name to +create project files for a specific target platform. E.g. "Visual +Studio 10 Win64" will create project files for the x64 processor; +"Visual Studio 10 IA64" for Itanium. diff --git a/Help/generator/Visual Studio 11.rst b/Help/generator/Visual Studio 11.rst new file mode 100644 index 0000000..4115c8d --- /dev/null +++ b/Help/generator/Visual Studio 11.rst @@ -0,0 +1,9 @@ +Visual Studio 11 +---------------- + +Generates Visual Studio 11 (2012) project files. + +It is possible to append a space followed by the platform name to +create project files for a specific target platform. E.g. "Visual +Studio 11 Win64" will create project files for the x64 processor; +"Visual Studio 11 ARM" for ARM. diff --git a/Help/generator/Visual Studio 12.rst b/Help/generator/Visual Studio 12.rst new file mode 100644 index 0000000..51bcab7 --- /dev/null +++ b/Help/generator/Visual Studio 12.rst @@ -0,0 +1,9 @@ +Visual Studio 12 +---------------- + +Generates Visual Studio 12 (2013) project files. + +It is possible to append a space followed by the platform name to +create project files for a specific target platform. E.g. "Visual +Studio 12 Win64" will create project files for the x64 processor; +"Visual Studio 12 ARM" for ARM. diff --git a/Help/generator/Visual Studio 6.rst b/Help/generator/Visual Studio 6.rst new file mode 100644 index 0000000..d619354 --- /dev/null +++ b/Help/generator/Visual Studio 6.rst @@ -0,0 +1,4 @@ +Visual Studio 6 +--------------- + +Generates Visual Studio 6 project files. diff --git a/Help/generator/Visual Studio 7 .NET 2003.rst b/Help/generator/Visual Studio 7 .NET 2003.rst new file mode 100644 index 0000000..2034140 --- /dev/null +++ b/Help/generator/Visual Studio 7 .NET 2003.rst @@ -0,0 +1,4 @@ +Visual Studio 7 .NET 2003 +------------------------- + +Generates Visual Studio .NET 2003 project files. diff --git a/Help/generator/Visual Studio 7.rst b/Help/generator/Visual Studio 7.rst new file mode 100644 index 0000000..d0eb719 --- /dev/null +++ b/Help/generator/Visual Studio 7.rst @@ -0,0 +1,4 @@ +Visual Studio 7 +--------------- + +Generates Visual Studio .NET 2002 project files. diff --git a/Help/generator/Visual Studio 8 2005.rst b/Help/generator/Visual Studio 8 2005.rst new file mode 100644 index 0000000..d7b6de2 --- /dev/null +++ b/Help/generator/Visual Studio 8 2005.rst @@ -0,0 +1,8 @@ +Visual Studio 8 2005 +-------------------- + +Generates Visual Studio 8 2005 project files. + +It is possible to append a space followed by the platform name to +create project files for a specific target platform. E.g. "Visual +Studio 8 2005 Win64" will create project files for the x64 processor. diff --git a/Help/generator/Visual Studio 9 2008.rst b/Help/generator/Visual Studio 9 2008.rst new file mode 100644 index 0000000..ade9fd5 --- /dev/null +++ b/Help/generator/Visual Studio 9 2008.rst @@ -0,0 +1,9 @@ +Visual Studio 9 2008 +-------------------- + +Generates Visual Studio 9 2008 project files. + +It is possible to append a space followed by the platform name to +create project files for a specific target platform. E.g. "Visual +Studio 9 2008 Win64" will create project files for the x64 processor; +"Visual Studio 9 2008 IA64" for Itanium. diff --git a/Help/generator/Watcom WMake.rst b/Help/generator/Watcom WMake.rst new file mode 100644 index 0000000..09bdc3d --- /dev/null +++ b/Help/generator/Watcom WMake.rst @@ -0,0 +1,4 @@ +Watcom WMake +------------ + +Generates Watcom WMake makefiles. diff --git a/Help/generator/Xcode.rst b/Help/generator/Xcode.rst new file mode 100644 index 0000000..d8a6790 --- /dev/null +++ b/Help/generator/Xcode.rst @@ -0,0 +1,4 @@ +Xcode +----- + +Generate Xcode project files. diff --git a/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt new file mode 100644 index 0000000..6797d0e --- /dev/null +++ b/Help/include/COMPILE_DEFINITIONS_DISCLAIMER.txt @@ -0,0 +1,18 @@ +Disclaimer: Most native build tools have poor support for escaping +certain values. CMake has work-arounds for many cases but some values +may just not be possible to pass correctly. If a value does not seem +to be escaped correctly, do not attempt to work-around the problem by +adding escape sequences to the value. Your work-around may break in a +future version of CMake that has improved escape support. Instead +consider defining the macro in a (configured) header file. Then +report the limitation. Known limitations include:: + + # - broken almost everywhere + ; - broken in VS IDE 7.0 and Borland Makefiles + , - broken in VS IDE + % - broken in some cases in NMake + & | - broken in some cases on MinGW + ^ < > \" - broken in most Make tools on Windows + +CMake does not reject these values outright because they do work in +some cases. Use with caution. diff --git a/Help/index.rst b/Help/index.rst new file mode 100644 index 0000000..7db0be6 --- /dev/null +++ b/Help/index.rst @@ -0,0 +1,29 @@ +CMake Reference Documentation +############################# + +.. only:: html + + Reference Manuals: + +.. toctree:: + :maxdepth: 1 + + /manual/ccmake.1 + /manual/cmake.1 + /manual/cmake-gui.1 + /manual/cpack.1 + /manual/ctest.1 + /manual/cmake-commands.7 + /manual/cmake-generators.7 + /manual/cmake-modules.7 + /manual/cmake-policies.7 + /manual/cmake-properties.7 + /manual/cmake-variables.7 + /manual/cmake-generator-expressions.7 + +.. only:: html + + Index and Search: + + * :ref:`genindex` + * :ref:`search` diff --git a/Help/manual/LINKS.txt b/Help/manual/LINKS.txt new file mode 100644 index 0000000..fcd8533 --- /dev/null +++ b/Help/manual/LINKS.txt @@ -0,0 +1,21 @@ +The following resources are available to get help using CMake: + +* ``Home Page``: http://www.cmake.org + + The primary starting point for learning about CMake. + +* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ + + A Wiki is provided containing answers to frequently asked questions. + +* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html + + Links to available documentation may be found on this web page. + +* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html + + For help and discussion about using cmake, a mailing list is + provided at cmake@cmake.org. The list is member-post-only but one + may sign up on the CMake web page. Please first read the full + documentation at http://www.cmake.org before posting questions to + the list. diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt new file mode 100644 index 0000000..3aded5c --- /dev/null +++ b/Help/manual/OPTIONS_BUILD.txt @@ -0,0 +1,57 @@ +* ``-C <initial-cache>``: Pre-load a script to populate the cache. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a file from which + to load cache entries before the first pass through the project's + cmake listfiles. The loaded entries take priority over the + project's default values. The given file should be a CMake script + containing SET commands that use the CACHE option, not a + cache-format file. + +* ``-D <var>:<type>=<value>``: Create a cmake cache entry. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a setting that + takes priority over the project's default value. The option may be + repeated for as many cache entries as desired. + +* ``-U <globbing_expr>``: Remove matching entries from CMake cache. + + This option may be used to remove one or more variables from the + CMakeCache.txt file, globbing expressions using * and ? are + supported. The option may be repeated for as many cache entries as + desired. + + Use with care, you can make your CMakeCache.txt non-working. + +* ``-G <generator-name>``: Specify a build system generator. + + CMake may support multiple native build systems on certain + platforms. A generator is responsible for generating a particular + build system. Possible generator names are specified in the + Generators section. + +* ``-T <toolset-name>``: Specify toolset name if supported by generator. + + Some CMake generators support a toolset name to be given to the + native build system to choose a compiler. This is supported only on + specific generators: + + :: + + Visual Studio >= 10 + Xcode >= 3.0 + + See native build system documentation for allowed toolset names. + +* ``-Wno-dev``: Suppress developer warnings. + + Suppress warnings that are meant for the author of the + CMakeLists.txt files. + +* ``-Wdev``: Enable developer warnings. + + Enable warnings that are meant for the author of the CMakeLists.txt + files. diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt new file mode 100644 index 0000000..baaab0f --- /dev/null +++ b/Help/manual/OPTIONS_HELP.txt @@ -0,0 +1,111 @@ +.. |file| replace:: The help is printed to a named <f>ile if given. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--version,-version,/V [<f>]``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. + |file| + +* ``--help-manual <man> [<f>]``: Print one help manual and exit. + + The specified manual is printed in a human-readable text format. + |file| + +* ``--help-manual-list [<f>]``: List help manuals available and exit. + + The list contains all manuals for which help may be obtained by + using the ``--help-manual`` option followed by a manual name. + |file| + +* ``--help-command <cmd> [<f>]``: Print help for one command and exit. + + The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is + printed in a human-readable text format. + |file| + +* ``--help-command-list [<f>]``: List commands with help available and exit. + + The list contains all commands for which help may be obtained by + using the ``--help-command`` option followed by a command name. + |file| + +* ``--help-commands [<f>]``: Print cmake-commands manual and exit. + + The :manual:`cmake-commands(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-module <mod> [<f>]``: Print help for one module and exit. + + The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed + in a human-readable text format. + |file| + +* ``--help-module-list [<f>]``: List modules with help available and exit. + + The list contains all modules for which help may be obtained by + using the ``--help-module`` option followed by a module name. + |file| + +* ``--help-modules [<f>]``: Print cmake-modules manual and exit. + + The :manual:`cmake-modules(7)` manual is printed in a human-readable + text format. + |file| + +* ``--help-policy <cmp> [<f>]``: Print help for one policy and exit. + + The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is + printed in a human-readable text format. + |file| + +* ``--help-policy-list [<f>]``: List policies with help available and exit. + + The list contains all policies for which help may be obtained by + using the ``--help-policy`` option followed by a policy name. + |file| + +* ``--help-policies [<f>]``: Print cmake-policies manual and exit. + + The :manual:`cmake-policies(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-property <prop> [<f>]``: Print help for one property and exit. + + The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are + printed in a human-readable text format. + |file| + +* ``--help-property-list [<f>]``: List properties with help available and exit. + + The list contains all properties for which help may be obtained by + using the ``--help-property`` option followed by a property name. + |file| + +* ``--help-properties [<f>]``: Print cmake-properties manual and exit. + + The :manual:`cmake-properties(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-variable <var> [<f>]``: Print help for one variable and exit. + + The :manual:`cmake-variables(7)` manual entry for ``<var>`` is + printed in a human-readable text format. + |file| + +* ``--help-variable-list [<f>]``: List variables with help available and exit. + + The list contains all variables for which help may be obtained by + using the ``--help-variable`` option followed by a variable name. + |file| + +* ``--help-variables [<f>]``: Print cmake-variables manual and exit. + + The :manual:`cmake-variables(7)` manual is printed in a + human-readable text format. + |file| diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst new file mode 100644 index 0000000..62a7dcf --- /dev/null +++ b/Help/manual/ccmake.1.rst @@ -0,0 +1,33 @@ +ccmake(1) +********* + +Synopsis +======== + +:: + + ccmake <path-to-source> + ccmake <path-to-existing-build> + +Description +=========== + +The "ccmake" executable is the CMake curses interface. Project +configuration settings may be specified interactively through this +GUI. Brief instructions are provided at the bottom of the terminal +when the program is running. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + +.. include:: OPTIONS_BUILD.txt + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt diff --git a/Help/manual/cmake-commands.7.rst b/Help/manual/cmake-commands.7.rst new file mode 100644 index 0000000..71d7375 --- /dev/null +++ b/Help/manual/cmake-commands.7.rst @@ -0,0 +1,141 @@ +cmake-commands(7) +***************** + +.. only:: html or latex + + .. contents:: + +Normal Commands +=============== + +These commands may be used freely in CMake projects. + +.. toctree:: + /command/add_compile_options + /command/add_custom_command + /command/add_custom_target + /command/add_definitions + /command/add_dependencies + /command/add_executable + /command/add_library + /command/add_subdirectory + /command/add_test + /command/aux_source_directory + /command/break + /command/build_command + /command/cmake_host_system_information + /command/cmake_minimum_required + /command/cmake_policy + /command/configure_file + /command/create_test_sourcelist + /command/define_property + /command/elseif + /command/else + /command/enable_language + /command/enable_testing + /command/endforeach + /command/endfunction + /command/endif + /command/endmacro + /command/endwhile + /command/execute_process + /command/export + /command/file + /command/find_file + /command/find_library + /command/find_package + /command/find_path + /command/find_program + /command/fltk_wrap_ui + /command/foreach + /command/function + /command/get_cmake_property + /command/get_directory_property + /command/get_filename_component + /command/get_property + /command/get_source_file_property + /command/get_target_property + /command/get_test_property + /command/if + /command/include_directories + /command/include_external_msproject + /command/include_regular_expression + /command/include + /command/install + /command/link_directories + /command/list + /command/load_cache + /command/load_command + /command/macro + /command/mark_as_advanced + /command/math + /command/message + /command/option + /command/project + /command/qt_wrap_cpp + /command/qt_wrap_ui + /command/remove_definitions + /command/return + /command/separate_arguments + /command/set_directory_properties + /command/set_property + /command/set + /command/set_source_files_properties + /command/set_target_properties + /command/set_tests_properties + /command/site_name + /command/source_group + /command/string + /command/target_compile_definitions + /command/target_compile_options + /command/target_include_directories + /command/target_link_libraries + /command/try_compile + /command/try_run + /command/unset + /command/variable_watch + /command/while + +Deprecated Commands +=================== + +These commands are available only for compatibility with older +versions of CMake. Do not use them in new code. + +.. toctree:: + /command/build_name + /command/exec_program + /command/export_library_dependencies + /command/install_files + /command/install_programs + /command/install_targets + /command/link_libraries + /command/make_directory + /command/output_required_files + /command/remove + /command/subdir_depends + /command/subdirs + /command/use_mangled_mesa + /command/utility_source + /command/variable_requires + /command/write_file + +CTest Commands +============== + +These commands are available only in ctest scripts. + +.. toctree:: + /command/ctest_build + /command/ctest_configure + /command/ctest_coverage + /command/ctest_empty_binary_directory + /command/ctest_memcheck + /command/ctest_read_custom_files + /command/ctest_run_script + /command/ctest_sleep + /command/ctest_start + /command/ctest_submit + /command/ctest_test + /command/ctest_update + /command/ctest_upload diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst new file mode 100644 index 0000000..849ee36 --- /dev/null +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -0,0 +1,84 @@ +cmake-generator-expressions(7) +****************************** + +.. only:: html or latex + + .. contents:: + +Generator Expressions +===================== + +Generator expressions are evaluated during build +system generation to produce information specific to each build +configuration. Valid expressions are: + +:: + + $<0:...> = empty string (ignores "...") + $<1:...> = content of "..." + $<CONFIG:cfg> = '1' if config is "cfg", else '0' + $<CONFIGURATION> = configuration name + $<BOOL:...> = '1' if the '...' is true, else '0' + $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0' + $<ANGLE-R> = A literal '>'. Used to compare strings which contain a '>' for example. + $<COMMA> = A literal ','. Used to compare strings which contain a ',' for example. + $<SEMICOLON> = A literal ';'. Used to prevent list expansion on an argument with ';'. + $<JOIN:list,...> = joins the list with the content of "..." + $<TARGET_NAME:...> = Marks ... as being the name of a target. This is required if exporting targets to multiple dependent export sets. The '...' must be a literal name of a target- it may not contain generator expressions. + $<INSTALL_INTERFACE:...> = content of "..." when the property is exported using install(EXPORT), and empty otherwise. + $<BUILD_INTERFACE:...> = content of "..." when the property is exported using export(), or when the target is used by another target in the same buildsystem. Expands to the empty string otherwise. + $<PLATFORM_ID> = The CMake-id of the platform $<PLATFORM_ID:comp> = '1' if the The CMake-id of the platform matches comp, otherwise '0'. + $<C_COMPILER_ID> = The CMake-id of the C compiler used. + $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C compiler matches comp, otherwise '0'. + $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler used. + $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX compiler matches comp, otherwise '0'. + $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than v2, else '0'. + $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, else '0'. + $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, else '0'. + $<C_COMPILER_VERSION> = The version of the C compiler used. + $<C_COMPILER_VERSION:ver> = '1' if the version of the C compiler matches ver, otherwise '0'. + $<CXX_COMPILER_VERSION> = The version of the CXX compiler used. + $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX compiler matches ver, otherwise '0'. + $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a) + $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so) + $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3) + +where "tgt" is the name of a target. Target file expressions produce +a full path, but _DIR and _NAME versions can produce the directory and +file name components: + +:: + + $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt> + $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt> + $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt> + + + +:: + + $<TARGET_PROPERTY:tgt,prop> = The value of the property prop on the target tgt. + +Note that tgt is not added as a dependency of the target this +expression is evaluated on. + +:: + + $<TARGET_POLICY:pol> = '1' if the policy was NEW when the 'head' target was created, else '0'. If the policy was not set, the warning message for the policy will be emitted. This generator expression only works for a subset of policies. + $<INSTALL_PREFIX> = Content of the install prefix when the target is exported via INSTALL(EXPORT) and empty otherwise. + +Boolean expressions: + +:: + + $<AND:?[,?]...> = '1' if all '?' are '1', else '0' + $<OR:?[,?]...> = '0' if all '?' are '0', else '1' + $<NOT:?> = '0' if '?' is '1', else '1' + +where '?' is always either '0' or '1'. + +Expressions with an implicit 'this' target: + +:: + + $<TARGET_PROPERTY:prop> = The value of the property prop on the target on which the generator expression is evaluated. diff --git a/Help/manual/cmake-generators.7.rst b/Help/manual/cmake-generators.7.rst new file mode 100644 index 0000000..c73d587 --- /dev/null +++ b/Help/manual/cmake-generators.7.rst @@ -0,0 +1,42 @@ +cmake-generators(7) +******************* + +.. only:: html or latex + + .. contents:: + +All Generators +============== + +.. toctree:: + /generator/Borland Makefiles + /generator/CodeBlocks - MinGW Makefiles + /generator/CodeBlocks - Ninja + /generator/CodeBlocks - NMake Makefiles + /generator/CodeBlocks - Unix Makefiles + /generator/Eclipse CDT4 - MinGW Makefiles + /generator/Eclipse CDT4 - Ninja + /generator/Eclipse CDT4 - NMake Makefiles + /generator/Eclipse CDT4 - Unix Makefiles + /generator/KDevelop3 + /generator/KDevelop3 - Unix Makefiles + /generator/MinGW Makefiles + /generator/MSYS Makefiles + /generator/Ninja + /generator/NMake Makefiles JOM + /generator/NMake Makefiles + /generator/Sublime Text 2 - MinGW Makefiles + /generator/Sublime Text 2 - Ninja + /generator/Sublime Text 2 - NMake Makefiles + /generator/Sublime Text 2 - Unix Makefiles + /generator/Unix Makefiles + /generator/Visual Studio 10 + /generator/Visual Studio 11 + /generator/Visual Studio 12 + /generator/Visual Studio 6 + /generator/Visual Studio 7 .NET 2003 + /generator/Visual Studio 7 + /generator/Visual Studio 8 2005 + /generator/Visual Studio 9 2008 + /generator/Watcom WMake + /generator/Xcode diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst new file mode 100644 index 0000000..e773ee1 --- /dev/null +++ b/Help/manual/cmake-gui.1.rst @@ -0,0 +1,31 @@ +cmake-gui(1) +************ + +Synopsis +======== + +:: + + cmake-gui [options] + cmake-gui [options] <path-to-source> + cmake-gui [options] <path-to-existing-build> + +Description +=========== + +The "cmake-gui" executable is the CMake GUI. Project configuration +settings may be specified interactively. Brief instructions are +provided at the bottom of the window when the program is running. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt diff --git a/Help/manual/cmake-modules.7.rst b/Help/manual/cmake-modules.7.rst new file mode 100644 index 0000000..da518d3 --- /dev/null +++ b/Help/manual/cmake-modules.7.rst @@ -0,0 +1,230 @@ +cmake-modules(7) +**************** + +.. only:: html or latex + + .. contents:: + +All Modules +=========== + +.. toctree:: + /module/AddFileDependencies + /module/BundleUtilities + /module/CheckCCompilerFlag + /module/CheckCSourceCompiles + /module/CheckCSourceRuns + /module/CheckCXXCompilerFlag + /module/CheckCXXSourceCompiles + /module/CheckCXXSourceRuns + /module/CheckCXXSymbolExists + /module/CheckFortranFunctionExists + /module/CheckFunctionExists + /module/CheckIncludeFileCXX + /module/CheckIncludeFile + /module/CheckIncludeFiles + /module/CheckLanguage + /module/CheckLibraryExists + /module/CheckPrototypeDefinition + /module/CheckStructHasMember + /module/CheckSymbolExists + /module/CheckTypeSize + /module/CheckVariableExists + /module/CMakeAddFortranSubdirectory + /module/CMakeBackwardCompatibilityCXX + /module/CMakeDependentOption + /module/CMakeDetermineVSServicePack + /module/CMakeExpandImportedTargets + /module/CMakeFindFrameworks + /module/CMakeFindPackageMode + /module/CMakeForceCompiler + /module/CMakeGraphVizOptions + /module/CMakePackageConfigHelpers + /module/CMakeParseArguments + /module/CMakePrintHelpers + /module/CMakePrintSystemInformation + /module/CMakePushCheckState + /module/CMakeVerifyManifest + /module/CPackBundle + /module/CPackComponent + /module/CPackCygwin + /module/CPackDeb + /module/CPackDMG + /module/CPackNSIS + /module/CPackPackageMaker + /module/CPackRPM + /module/CPack + /module/CPackWIX + /module/CTest + /module/CTestScriptMode + /module/CTestUseLaunchers + /module/Dart + /module/DeployQt4 + /module/Documentation + /module/ExternalData + /module/ExternalProject + /module/FeatureSummary + /module/FindALSA + /module/FindArmadillo + /module/FindASPELL + /module/FindAVIFile + /module/FindBISON + /module/FindBLAS + /module/FindBoost + /module/FindBullet + /module/FindBZip2 + /module/FindCABLE + /module/FindCoin3D + /module/FindCUDA + /module/FindCups + /module/FindCURL + /module/FindCurses + /module/FindCVS + /module/FindCxxTest + /module/FindCygwin + /module/FindDart + /module/FindDCMTK + /module/FindDevIL + /module/FindDoxygen + /module/FindEXPAT + /module/FindFLEX + /module/FindFLTK2 + /module/FindFLTK + /module/FindFreetype + /module/FindGCCXML + /module/FindGDAL + /module/FindGettext + /module/FindGIF + /module/FindGit + /module/FindGLEW + /module/FindGLUT + /module/FindGnuplot + /module/FindGnuTLS + /module/FindGTest + /module/FindGTK2 + /module/FindGTK + /module/FindHDF5 + /module/FindHg + /module/FindHSPELL + /module/FindHTMLHelp + /module/FindIcotool + /module/FindImageMagick + /module/FindITK + /module/FindJasper + /module/FindJava + /module/FindJNI + /module/FindJPEG + /module/FindKDE3 + /module/FindKDE4 + /module/FindLAPACK + /module/FindLATEX + /module/FindLibArchive + /module/FindLibLZMA + /module/FindLibXml2 + /module/FindLibXslt + /module/FindLua50 + /module/FindLua51 + /module/FindLua + /module/FindMatlab + /module/FindMFC + /module/FindMotif + /module/FindMPEG2 + /module/FindMPEG + /module/FindMPI + /module/FindOpenAL + /module/FindOpenGL + /module/FindOpenMP + /module/FindOpenSceneGraph + /module/FindOpenSSL + /module/FindOpenThreads + /module/FindosgAnimation + /module/FindosgDB + /module/Findosg_functions + /module/FindosgFX + /module/FindosgGA + /module/FindosgIntrospection + /module/FindosgManipulator + /module/FindosgParticle + /module/FindosgPresentation + /module/FindosgProducer + /module/FindosgQt + /module/Findosg + /module/FindosgShadow + /module/FindosgSim + /module/FindosgTerrain + /module/FindosgText + /module/FindosgUtil + /module/FindosgViewer + /module/FindosgVolume + /module/FindosgWidget + /module/FindPackageHandleStandardArgs + /module/FindPackageMessage + /module/FindPerlLibs + /module/FindPerl + /module/FindPHP4 + /module/FindPhysFS + /module/FindPike + /module/FindPkgConfig + /module/FindPNG + /module/FindPostgreSQL + /module/FindProducer + /module/FindProtobuf + /module/FindPythonInterp + /module/FindPythonLibs + /module/FindQt3 + /module/FindQt4 + /module/FindQt + /module/FindQuickTime + /module/FindRTI + /module/FindRuby + /module/FindSDL_image + /module/FindSDL_mixer + /module/FindSDL_net + /module/FindSDL + /module/FindSDL_sound + /module/FindSDL_ttf + /module/FindSelfPackers + /module/FindSquish + /module/FindSubversion + /module/FindSWIG + /module/FindTCL + /module/FindTclsh + /module/FindTclStub + /module/FindThreads + /module/FindTIFF + /module/FindUnixCommands + /module/FindVTK + /module/FindWget + /module/FindWish + /module/FindwxWidgets + /module/FindwxWindows + /module/FindX11 + /module/FindXMLRPC + /module/FindZLIB + /module/FortranCInterface + /module/GenerateExportHeader + /module/GetPrerequisites + /module/GNUInstallDirs + /module/InstallRequiredSystemLibraries + /module/MacroAddFileDependencies + /module/ProcessorCount + /module/Qt4ConfigDependentSettings + /module/Qt4Macros + /module/SelectLibraryConfigurations + /module/SquishTestScript + /module/TestBigEndian + /module/TestCXXAcceptsFlag + /module/TestForANSIForScope + /module/TestForANSIStreamHeaders + /module/TestForSSTREAM + /module/TestForSTDNamespace + /module/UseEcos + /module/UseJavaClassFilelist + /module/UseJava + /module/UseJavaSymlinks + /module/UsePkgConfig + /module/UseQt4 + /module/UseSWIG + /module/UsewxWidgets + /module/Use_wxWindows + /module/WriteBasicConfigVersionFile diff --git a/Help/manual/cmake-policies.7.rst b/Help/manual/cmake-policies.7.rst new file mode 100644 index 0000000..cd91c91 --- /dev/null +++ b/Help/manual/cmake-policies.7.rst @@ -0,0 +1,38 @@ +cmake-policies(7) +***************** + +.. only:: html or latex + + .. contents:: + +All Policies +============ + +.. toctree:: + /policy/CMP0000 + /policy/CMP0001 + /policy/CMP0002 + /policy/CMP0003 + /policy/CMP0004 + /policy/CMP0005 + /policy/CMP0006 + /policy/CMP0007 + /policy/CMP0008 + /policy/CMP0009 + /policy/CMP0010 + /policy/CMP0011 + /policy/CMP0012 + /policy/CMP0013 + /policy/CMP0014 + /policy/CMP0015 + /policy/CMP0016 + /policy/CMP0017 + /policy/CMP0018 + /policy/CMP0019 + /policy/CMP0020 + /policy/CMP0021 + /policy/CMP0022 + /policy/CMP0023 + /policy/CMP0024 + /policy/CMP0025 + /policy/CMP0026 diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst new file mode 100644 index 0000000..bb3acff --- /dev/null +++ b/Help/manual/cmake-properties.7.rst @@ -0,0 +1,262 @@ +cmake-properties(7) +******************* + +.. only:: html or latex + + .. contents:: + +Properties of Global Scope +========================== + +.. toctree:: + /prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS + /prop_gbl/AUTOMOC_TARGETS_FOLDER + /prop_gbl/DEBUG_CONFIGURATIONS + /prop_gbl/DISABLED_FEATURES + /prop_gbl/ENABLED_FEATURES + /prop_gbl/ENABLED_LANGUAGES + /prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS + /prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING + /prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE + /prop_gbl/GLOBAL_DEPENDS_NO_CYCLES + /prop_gbl/IN_TRY_COMPILE + /prop_gbl/PACKAGES_FOUND + /prop_gbl/PACKAGES_NOT_FOUND + /prop_gbl/PREDEFINED_TARGETS_FOLDER + /prop_gbl/REPORT_UNDEFINED_PROPERTIES + /prop_gbl/RULE_LAUNCH_COMPILE + /prop_gbl/RULE_LAUNCH_CUSTOM + /prop_gbl/RULE_LAUNCH_LINK + /prop_gbl/RULE_MESSAGES + /prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS + /prop_gbl/TARGET_SUPPORTS_SHARED_LIBS + /prop_gbl/USE_FOLDERS + +Properties on Directories +========================= + +.. toctree:: + /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES + /prop_dir/CACHE_VARIABLES + /prop_dir/CLEAN_NO_CUSTOM + /prop_dir/COMPILE_DEFINITIONS_CONFIG + /prop_dir/COMPILE_DEFINITIONS + /prop_dir/COMPILE_OPTIONS + /prop_dir/DEFINITIONS + /prop_dir/EXCLUDE_FROM_ALL + /prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM + /prop_dir/INCLUDE_DIRECTORIES + /prop_dir/INCLUDE_REGULAR_EXPRESSION + /prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG + /prop_dir/INTERPROCEDURAL_OPTIMIZATION + /prop_dir/LINK_DIRECTORIES + /prop_dir/LISTFILE_STACK + /prop_dir/MACROS + /prop_dir/PARENT_DIRECTORY + /prop_dir/RULE_LAUNCH_COMPILE + /prop_dir/RULE_LAUNCH_CUSTOM + /prop_dir/RULE_LAUNCH_LINK + /prop_dir/TEST_INCLUDE_FILE + /prop_dir/VARIABLES + /prop_dir/VS_GLOBAL_SECTION_POST_section + /prop_dir/VS_GLOBAL_SECTION_PRE_section + +Properties on Targets +===================== + +.. toctree:: + /prop_tgt/ALIASED_TARGET + /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY + /prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG + /prop_tgt/ARCHIVE_OUTPUT_NAME + /prop_tgt/AUTOMOC_MOC_OPTIONS + /prop_tgt/AUTOMOC + /prop_tgt/BUILD_WITH_INSTALL_RPATH + /prop_tgt/BUNDLE_EXTENSION + /prop_tgt/BUNDLE + /prop_tgt/COMPATIBLE_INTERFACE_BOOL + /prop_tgt/COMPATIBLE_INTERFACE_STRING + /prop_tgt/COMPILE_DEFINITIONS_CONFIG + /prop_tgt/COMPILE_DEFINITIONS + /prop_tgt/COMPILE_FLAGS + /prop_tgt/COMPILE_OPTIONS + /prop_tgt/CONFIG_OUTPUT_NAME + /prop_tgt/CONFIG_POSTFIX + /prop_tgt/DEBUG_POSTFIX + /prop_tgt/DEFINE_SYMBOL + /prop_tgt/EchoString + /prop_tgt/ENABLE_EXPORTS + /prop_tgt/EXCLUDE_FROM_ALL + /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG + /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD + /prop_tgt/EXPORT_NAME + /prop_tgt/FOLDER + /prop_tgt/Fortran_FORMAT + /prop_tgt/Fortran_MODULE_DIRECTORY + /prop_tgt/FRAMEWORK + /prop_tgt/GENERATOR_FILE_NAME + /prop_tgt/GNUtoMS + /prop_tgt/HAS_CXX + /prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM + /prop_tgt/IMPORTED_CONFIGURATIONS + /prop_tgt/IMPORTED_IMPLIB_CONFIG + /prop_tgt/IMPORTED_IMPLIB + /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG + /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES + /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES + /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES + /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG + /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY + /prop_tgt/IMPORTED_LOCATION_CONFIG + /prop_tgt/IMPORTED_LOCATION + /prop_tgt/IMPORTED_NO_SONAME_CONFIG + /prop_tgt/IMPORTED_NO_SONAME + /prop_tgt/IMPORTED + /prop_tgt/IMPORTED_SONAME_CONFIG + /prop_tgt/IMPORTED_SONAME + /prop_tgt/IMPORT_PREFIX + /prop_tgt/IMPORT_SUFFIX + /prop_tgt/INCLUDE_DIRECTORIES + /prop_tgt/INSTALL_NAME_DIR + /prop_tgt/INSTALL_RPATH + /prop_tgt/INSTALL_RPATH_USE_LINK_PATH + /prop_tgt/INTERFACE_COMPILE_DEFINITIONS + /prop_tgt/INTERFACE_COMPILE_OPTIONS + /prop_tgt/INTERFACE_INCLUDE_DIRECTORIES + /prop_tgt/INTERFACE_LINK_LIBRARIES + /prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE + /prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES + /prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG + /prop_tgt/INTERPROCEDURAL_OPTIMIZATION + /prop_tgt/LABELS + /prop_tgt/LANG_VISIBILITY_PRESET + /prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/LIBRARY_OUTPUT_DIRECTORY + /prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG + /prop_tgt/LIBRARY_OUTPUT_NAME + /prop_tgt/LINK_DEPENDS_NO_SHARED + /prop_tgt/LINK_DEPENDS + /prop_tgt/LINKER_LANGUAGE + /prop_tgt/LINK_FLAGS_CONFIG + /prop_tgt/LINK_FLAGS + /prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG + /prop_tgt/LINK_INTERFACE_LIBRARIES + /prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG + /prop_tgt/LINK_INTERFACE_MULTIPLICITY + /prop_tgt/LINK_LIBRARIES + /prop_tgt/LINK_SEARCH_END_STATIC + /prop_tgt/LINK_SEARCH_START_STATIC + /prop_tgt/LOCATION_CONFIG + /prop_tgt/LOCATION + /prop_tgt/MACOSX_BUNDLE_INFO_PLIST + /prop_tgt/MACOSX_BUNDLE + /prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST + /prop_tgt/MACOSX_RPATH + /prop_tgt/MAP_IMPORTED_CONFIG_CONFIG + /prop_tgt/NAME + /prop_tgt/NO_SONAME + /prop_tgt/NO_SYSTEM_FROM_IMPORTED + /prop_tgt/OSX_ARCHITECTURES_CONFIG + /prop_tgt/OSX_ARCHITECTURES + /prop_tgt/OUTPUT_NAME_CONFIG + /prop_tgt/OUTPUT_NAME + /prop_tgt/PDB_NAME_CONFIG + /prop_tgt/PDB_NAME + /prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/PDB_OUTPUT_DIRECTORY + /prop_tgt/POSITION_INDEPENDENT_CODE + /prop_tgt/POST_INSTALL_SCRIPT + /prop_tgt/PREFIX + /prop_tgt/PRE_INSTALL_SCRIPT + /prop_tgt/PRIVATE_HEADER + /prop_tgt/PROJECT_LABEL + /prop_tgt/PUBLIC_HEADER + /prop_tgt/RESOURCE + /prop_tgt/RULE_LAUNCH_COMPILE + /prop_tgt/RULE_LAUNCH_CUSTOM + /prop_tgt/RULE_LAUNCH_LINK + /prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG + /prop_tgt/RUNTIME_OUTPUT_DIRECTORY + /prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG + /prop_tgt/RUNTIME_OUTPUT_NAME + /prop_tgt/SKIP_BUILD_RPATH + /prop_tgt/SOURCES + /prop_tgt/SOVERSION + /prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG + /prop_tgt/STATIC_LIBRARY_FLAGS + /prop_tgt/SUFFIX + /prop_tgt/TYPE + /prop_tgt/VERSION + /prop_tgt/VISIBILITY_INLINES_HIDDEN + /prop_tgt/VS_DOTNET_REFERENCES + /prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION + /prop_tgt/VS_GLOBAL_KEYWORD + /prop_tgt/VS_GLOBAL_PROJECT_TYPES + /prop_tgt/VS_GLOBAL_ROOTNAMESPACE + /prop_tgt/VS_GLOBAL_variable + /prop_tgt/VS_KEYWORD + /prop_tgt/VS_SCC_AUXPATH + /prop_tgt/VS_SCC_LOCALPATH + /prop_tgt/VS_SCC_PROJECTNAME + /prop_tgt/VS_SCC_PROVIDER + /prop_tgt/VS_WINRT_EXTENSIONS + /prop_tgt/VS_WINRT_REFERENCES + /prop_tgt/WIN32_EXECUTABLE + /prop_tgt/XCODE_ATTRIBUTE_an-attribute + +Properties on Tests +=================== + +.. toctree:: + /prop_test/ATTACHED_FILES_ON_FAIL + /prop_test/ATTACHED_FILES + /prop_test/COST + /prop_test/DEPENDS + /prop_test/ENVIRONMENT + /prop_test/FAIL_REGULAR_EXPRESSION + /prop_test/LABELS + /prop_test/MEASUREMENT + /prop_test/PASS_REGULAR_EXPRESSION + /prop_test/PROCESSORS + /prop_test/REQUIRED_FILES + /prop_test/RESOURCE_LOCK + /prop_test/RUN_SERIAL + /prop_test/TIMEOUT + /prop_test/WILL_FAIL + /prop_test/WORKING_DIRECTORY + +Properties on Source Files +========================== + +.. toctree:: + /prop_sf/ABSTRACT + /prop_sf/COMPILE_DEFINITIONS_CONFIG + /prop_sf/COMPILE_DEFINITIONS + /prop_sf/COMPILE_FLAGS + /prop_sf/EXTERNAL_OBJECT + /prop_sf/Fortran_FORMAT + /prop_sf/GENERATED + /prop_sf/HEADER_FILE_ONLY + /prop_sf/KEEP_EXTENSION + /prop_sf/LABELS + /prop_sf/LANGUAGE + /prop_sf/LOCATION + /prop_sf/MACOSX_PACKAGE_LOCATION + /prop_sf/OBJECT_DEPENDS + /prop_sf/OBJECT_OUTPUTS + /prop_sf/SYMBOLIC + /prop_sf/WRAP_EXCLUDE + +Properties on Cache Entries +=========================== + +.. toctree:: + /prop_cache/ADVANCED + /prop_cache/HELPSTRING + /prop_cache/MODIFIED + /prop_cache/STRINGS + /prop_cache/TYPE + /prop_cache/VALUE diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst new file mode 100644 index 0000000..99c782d --- /dev/null +++ b/Help/manual/cmake-variables.7.rst @@ -0,0 +1,254 @@ +cmake-variables(7) +****************** + +.. only:: html or latex + + .. contents:: + +Variables that Provide Information +================================== + +.. toctree:: + /variable/CMAKE_ARGC + /variable/CMAKE_ARGV0 + /variable/CMAKE_AR + /variable/CMAKE_BINARY_DIR + /variable/CMAKE_BUILD_TOOL + /variable/CMAKE_CACHEFILE_DIR + /variable/CMAKE_CACHE_MAJOR_VERSION + /variable/CMAKE_CACHE_MINOR_VERSION + /variable/CMAKE_CACHE_PATCH_VERSION + /variable/CMAKE_CFG_INTDIR + /variable/CMAKE_COMMAND + /variable/CMAKE_CROSSCOMPILING + /variable/CMAKE_CTEST_COMMAND + /variable/CMAKE_CURRENT_BINARY_DIR + /variable/CMAKE_CURRENT_LIST_DIR + /variable/CMAKE_CURRENT_LIST_FILE + /variable/CMAKE_CURRENT_LIST_LINE + /variable/CMAKE_CURRENT_SOURCE_DIR + /variable/CMAKE_DL_LIBS + /variable/CMAKE_EDIT_COMMAND + /variable/CMAKE_EXECUTABLE_SUFFIX + /variable/CMAKE_EXTRA_GENERATOR + /variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES + /variable/CMAKE_GENERATOR + /variable/CMAKE_GENERATOR_TOOLSET + /variable/CMAKE_HOME_DIRECTORY + /variable/CMAKE_IMPORT_LIBRARY_PREFIX + /variable/CMAKE_IMPORT_LIBRARY_SUFFIX + /variable/CMAKE_LINK_LIBRARY_SUFFIX + /variable/CMAKE_MAJOR_VERSION + /variable/CMAKE_MAKE_PROGRAM + /variable/CMAKE_MINIMUM_REQUIRED_VERSION + /variable/CMAKE_MINOR_VERSION + /variable/CMAKE_PARENT_LIST_FILE + /variable/CMAKE_PATCH_VERSION + /variable/CMAKE_PROJECT_NAME + /variable/CMAKE_RANLIB + /variable/CMAKE_ROOT + /variable/CMAKE_SCRIPT_MODE_FILE + /variable/CMAKE_SHARED_LIBRARY_PREFIX + /variable/CMAKE_SHARED_LIBRARY_SUFFIX + /variable/CMAKE_SHARED_MODULE_PREFIX + /variable/CMAKE_SHARED_MODULE_SUFFIX + /variable/CMAKE_SIZEOF_VOID_P + /variable/CMAKE_SKIP_RPATH + /variable/CMAKE_SOURCE_DIR + /variable/CMAKE_STANDARD_LIBRARIES + /variable/CMAKE_STATIC_LIBRARY_PREFIX + /variable/CMAKE_STATIC_LIBRARY_SUFFIX + /variable/CMAKE_TWEAK_VERSION + /variable/CMAKE_VERBOSE_MAKEFILE + /variable/CMAKE_VERSION + /variable/CMAKE_VS_PLATFORM_TOOLSET + /variable/CMAKE_XCODE_PLATFORM_TOOLSET + /variable/PROJECT_BINARY_DIR + /variable/PROJECT-NAME_BINARY_DIR + /variable/PROJECT_NAME + /variable/PROJECT-NAME_SOURCE_DIR + /variable/PROJECT_SOURCE_DIR + +Variables that Change Behavior +============================== + +.. toctree:: + /variable/BUILD_SHARED_LIBS + /variable/CMAKE_ABSOLUTE_DESTINATION_FILES + /variable/CMAKE_AUTOMOC_RELAXED_MODE + /variable/CMAKE_BACKWARDS_COMPATIBILITY + /variable/CMAKE_BUILD_TYPE + /variable/CMAKE_COLOR_MAKEFILE + /variable/CMAKE_CONFIGURATION_TYPES + /variable/CMAKE_DEBUG_TARGET_PROPERTIES + /variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName + /variable/CMAKE_ERROR_DEPRECATED + /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION + /variable/CMAKE_FIND_LIBRARY_PREFIXES + /variable/CMAKE_FIND_LIBRARY_SUFFIXES + /variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE + /variable/CMAKE_IGNORE_PATH + /variable/CMAKE_INCLUDE_PATH + /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME + /variable/CMAKE_INSTALL_PREFIX + /variable/CMAKE_LIBRARY_PATH + /variable/CMAKE_MFC_FLAG + /variable/CMAKE_MODULE_PATH + /variable/CMAKE_NOT_USING_CONFIG_FLAGS + /variable/CMAKE_POLICY_DEFAULT_CMPNNNN + /variable/CMAKE_PREFIX_PATH + /variable/CMAKE_PROGRAM_PATH + /variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY + /variable/CMAKE_SYSTEM_IGNORE_PATH + /variable/CMAKE_SYSTEM_INCLUDE_PATH + /variable/CMAKE_SYSTEM_LIBRARY_PATH + /variable/CMAKE_SYSTEM_PREFIX_PATH + /variable/CMAKE_SYSTEM_PROGRAM_PATH + /variable/CMAKE_USER_MAKE_RULES_OVERRIDE + /variable/CMAKE_WARN_DEPRECATED + /variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION + +Variables that Describe the System +================================== + +.. toctree:: + /variable/APPLE + /variable/BORLAND + /variable/CMAKE_CL_64 + /variable/CMAKE_COMPILER_2005 + /variable/CMAKE_HOST_APPLE + /variable/CMAKE_HOST_SYSTEM_NAME + /variable/CMAKE_HOST_SYSTEM_PROCESSOR + /variable/CMAKE_HOST_SYSTEM + /variable/CMAKE_HOST_SYSTEM_VERSION + /variable/CMAKE_HOST_UNIX + /variable/CMAKE_HOST_WIN32 + /variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX + /variable/CMAKE_LIBRARY_ARCHITECTURE + /variable/CMAKE_OBJECT_PATH_MAX + /variable/CMAKE_SYSTEM_NAME + /variable/CMAKE_SYSTEM_PROCESSOR + /variable/CMAKE_SYSTEM + /variable/CMAKE_SYSTEM_VERSION + /variable/CYGWIN + /variable/ENV + /variable/MSVC10 + /variable/MSVC11 + /variable/MSVC12 + /variable/MSVC60 + /variable/MSVC70 + /variable/MSVC71 + /variable/MSVC80 + /variable/MSVC90 + /variable/MSVC_IDE + /variable/MSVC + /variable/MSVC_VERSION + /variable/UNIX + /variable/WIN32 + /variable/XCODE_VERSION + +Variables that Control the Build +================================ + +.. toctree:: + /variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY + /variable/CMAKE_AUTOMOC_MOC_OPTIONS + /variable/CMAKE_AUTOMOC + /variable/CMAKE_BUILD_WITH_INSTALL_RPATH + /variable/CMAKE_CONFIG_POSTFIX + /variable/CMAKE_DEBUG_POSTFIX + /variable/CMAKE_EXE_LINKER_FLAGS_CONFIG + /variable/CMAKE_EXE_LINKER_FLAGS + /variable/CMAKE_Fortran_FORMAT + /variable/CMAKE_Fortran_MODULE_DIRECTORY + /variable/CMAKE_GNUtoMS + /variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE + /variable/CMAKE_INCLUDE_CURRENT_DIR + /variable/CMAKE_INSTALL_NAME_DIR + /variable/CMAKE_INSTALL_RPATH + /variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH + /variable/CMAKE_LANG_VISIBILITY_PRESET + /variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY + /variable/CMAKE_LIBRARY_PATH_FLAG + /variable/CMAKE_LINK_DEF_FILE_FLAG + /variable/CMAKE_LINK_DEPENDS_NO_SHARED + /variable/CMAKE_LINK_INTERFACE_LIBRARIES + /variable/CMAKE_LINK_LIBRARY_FILE_FLAG + /variable/CMAKE_LINK_LIBRARY_FLAG + /variable/CMAKE_MACOSX_BUNDLE + /variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG + /variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG + /variable/CMAKE_MODULE_LINKER_FLAGS + /variable/CMAKE_NO_BUILTIN_CHRPATH + /variable/CMAKE_NO_SYSTEM_FROM_IMPORTED + /variable/CMAKE_PDB_OUTPUT_DIRECTORY + /variable/CMAKE_POSITION_INDEPENDENT_CODE + /variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY + /variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG + /variable/CMAKE_SHARED_LINKER_FLAGS + /variable/CMAKE_SKIP_BUILD_RPATH + /variable/CMAKE_SKIP_INSTALL_RPATH + /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG + /variable/CMAKE_STATIC_LINKER_FLAGS + /variable/CMAKE_TRY_COMPILE_CONFIGURATION + /variable/CMAKE_USE_RELATIVE_PATHS + /variable/CMAKE_VISIBILITY_INLINES_HIDDEN + /variable/CMAKE_WIN32_EXECUTABLE + /variable/EXECUTABLE_OUTPUT_PATH + /variable/LIBRARY_OUTPUT_PATH + +Variables for Languages +======================= + +.. toctree:: + /variable/CMAKE_COMPILER_IS_GNULANG + /variable/CMAKE_Fortran_MODDIR_DEFAULT + /variable/CMAKE_Fortran_MODDIR_FLAG + /variable/CMAKE_Fortran_MODOUT_FLAG + /variable/CMAKE_INTERNAL_PLATFORM_ABI + /variable/CMAKE_LANG_ARCHIVE_APPEND + /variable/CMAKE_LANG_ARCHIVE_CREATE + /variable/CMAKE_LANG_ARCHIVE_FINISH + /variable/CMAKE_LANG_COMPILE_OBJECT + /variable/CMAKE_LANG_COMPILER_ABI + /variable/CMAKE_LANG_COMPILER_ID + /variable/CMAKE_LANG_COMPILER_LOADED + /variable/CMAKE_LANG_COMPILER + /variable/CMAKE_LANG_COMPILER_VERSION + /variable/CMAKE_LANG_CREATE_SHARED_LIBRARY + /variable/CMAKE_LANG_CREATE_SHARED_MODULE + /variable/CMAKE_LANG_CREATE_STATIC_LIBRARY + /variable/CMAKE_LANG_FLAGS_DEBUG + /variable/CMAKE_LANG_FLAGS_MINSIZEREL + /variable/CMAKE_LANG_FLAGS_RELEASE + /variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO + /variable/CMAKE_LANG_FLAGS + /variable/CMAKE_LANG_IGNORE_EXTENSIONS + /variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES + /variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES + /variable/CMAKE_LANG_LIBRARY_ARCHITECTURE + /variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES + /variable/CMAKE_LANG_LINKER_PREFERENCE + /variable/CMAKE_LANG_LINK_EXECUTABLE + /variable/CMAKE_LANG_OUTPUT_EXTENSION + /variable/CMAKE_LANG_PLATFORM_ID + /variable/CMAKE_LANG_SIMULATE_ID + /variable/CMAKE_LANG_SIMULATE_VERSION + /variable/CMAKE_LANG_SIZEOF_DATA_PTR + /variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS + /variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG + +Variables for CPack +=================== + +.. toctree:: + /variable/CPACK_ABSOLUTE_DESTINATION_FILES + /variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY + /variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION + /variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY + /variable/CPACK_INSTALL_SCRIPT + /variable/CPACK_PACKAGING_INSTALL_PREFIX + /variable/CPACK_SET_DESTDIR + /variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst new file mode 100644 index 0000000..64d0fb3 --- /dev/null +++ b/Help/manual/cmake.1.rst @@ -0,0 +1,149 @@ +cmake(1) +******** + +Synopsis +======== + +:: + + cmake [options] <path-to-source> + cmake [options] <path-to-existing-build> + +Description +=========== + +The "cmake" executable is the CMake command-line interface. It may be +used to configure projects in scripts. Project configuration settings +may be specified on the command line with the -D option. The -i +option will cause cmake to interactively prompt for such settings. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + +.. include:: OPTIONS_BUILD.txt + +* ``-E``: CMake command mode. + + For true platform independence, CMake provides a list of commands + that can be used on all systems. Run with -E help for the usage + information. Commands available are: chdir, compare_files, copy, + copy_directory, copy_if_different, echo, echo_append, environment, + make_directory, md5sum, remove, remove_directory, rename, tar, time, + touch, touch_nocreate. In addition, some platform specific commands + are available. On Windows: comspec, delete_regv, write_regv. On + UNIX: create_symlink. + +* ``-i``: Run in wizard mode. + + Wizard mode runs cmake interactively without a GUI. The user is + prompted to answer questions about the project configuration. The + answers are used to set cmake cache values. + +* ``-L[A][H]``: List non-advanced cached variables. + + List cache variables will run CMake and list all the variables from + the CMake cache that are not marked as INTERNAL or ADVANCED. This + will effectively display current CMake settings, which can then be + changed with -D option. Changing some of the variables may result + in more variables being created. If A is specified, then it will + display also advanced variables. If H is specified, it will also + display help for each variable. + +* ``--build <dir>``: Build a CMake-generated project binary tree. + + This abstracts a native build tool's command-line interface with the + following options: + + :: + + <dir> = Project binary directory to be built. + --target <tgt> = Build <tgt> instead of default targets. + --config <cfg> = For multi-configuration tools, choose <cfg>. + --clean-first = Build target 'clean' first, then build. + (To clean only, use --target 'clean'.) + --use-stderr = Don't merge stdout/stderr output and pass the + original stdout/stderr handles to the native + tool so it can use the capabilities of the + calling terminal (e.g. colored output). + -- = Pass remaining options to the native tool. + + Run cmake --build with no options for quick help. + +* ``-N``: View mode only. + + Only load the cache. Do not actually run configure and generate + steps. + +* ``-P <file>``: Process script mode. + + Process the given cmake file as a script written in the CMake + language. No configure or generate step is performed and the cache + is not modified. If variables are defined using -D, this must be + done before the -P argument. + +* ``--find-package``: Run in pkg-config like mode. + + Search a package using find_package() and print the resulting flags + to stdout. This can be used to use cmake instead of pkg-config to + find installed libraries in plain Makefile-based projects or in + autoconf-based projects (via share/aclocal/cmake.m4). + +* ``--graphviz=[file]``: Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more. + + Generate a graphviz input file that will contain all the library and + executable dependencies in the project. See the documentation for + CMakeGraphVizOptions.cmake for more details. + +* ``--system-information [file]``: Dump information about this system. + + Dump a wide range of information about the current system. If run + from the top of a binary tree for a CMake project it will dump + additional information such as the cache, log files etc. + +* ``--debug-trycompile``: Do not delete the try_compile build tree. Only useful on one try_compile at a time. + + Do not delete the files and directories created for try_compile + calls. This is useful in debugging failed try_compiles. It may + however change the results of the try-compiles as old junk from a + previous try-compile may cause a different test to either pass or + fail incorrectly. This option is best used for one try-compile at a + time, and only when debugging. + +* ``--debug-output``: Put cmake in a debug mode. + + Print extra stuff during the cmake run like stack traces with + message(send_error ) calls. + +* ``--trace``: Put cmake in trace mode. + + Print a trace of all calls made and from where with + message(send_error ) calls. + +* ``--warn-uninitialized``: Warn about uninitialized values. + + Print a warning when an uninitialized variable is used. + +* ``--warn-unused-vars``: Warn about unused variables. + + Find variables that are declared or set, but not used. + +* ``--no-warn-unused-cli``: Don't warn about command line options. + + Don't find variables that are declared on the command line, but not + used. + +* ``--check-system-vars``: Find problems with variable usage in system files. + + Normally, unused and uninitialized variables are searched for only + in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to + warn about other files as well. + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst new file mode 100644 index 0000000..5c6567c --- /dev/null +++ b/Help/manual/cpack.1.rst @@ -0,0 +1,83 @@ +cpack(1) +******** + +Synopsis +======== + +:: + + cpack -G <generator> [options] + +Description +=========== + +The "cpack" executable is the CMake packaging program. +CMake-generated build trees created for projects that use the +INSTALL_* commands have packaging support. This program will generate +the package. + +CMake is a cross-platform build system generator. Projects specify +their build process with platform-independent CMake listfiles included +in each directory of a source tree with the name CMakeLists.txt. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + + +* ``-G <generator>``: Use the specified generator to generate package. + + CPack may support multiple native packaging systems on certain + platforms. A generator is responsible for generating input files + for particular system and invoking that systems. Possible generator + names are specified in the Generators section. + +* ``-C <Configuration>``: Specify the project configuration + + This option specifies the configuration that the project was build + with, for example 'Debug', 'Release'. + +* ``-D <var>=<value>``: Set a CPack variable. + + Set a variable that can be used by the generator. + +* ``--config <config file>``: Specify the config file. + + Specify the config file to use to create the package. By default + CPackConfig.cmake in the current directory will be used. + +* ``--verbose,-V``: enable verbose output + + Run cpack with verbose output. + +* ``--debug``: enable debug output (for CPack developers) + + Run cpack with debug output (for CPack developers). + +* ``-P <package name>``: override/define CPACK_PACKAGE_NAME + + If the package name is not specified on cpack commmand line + thenCPack.cmake defines it as CMAKE_PROJECT_NAME + +* ``-R <package version>``: override/define CPACK_PACKAGE_VERSION + + If version is not specified on cpack command line thenCPack.cmake + defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into + CPack.cmake for detail + +* ``-B <package directory>``: override/define CPACK_PACKAGE_DIRECTORY + + The directory where CPack will be doing its packaging work.The + resulting package will be found there. Inside this directoryCPack + creates '_CPack_Packages' sub-directory which is theCPack temporary + directory. + +* ``--vendor <vendor name>``: override/define CPACK_PACKAGE_VENDOR + + If vendor is not specified on cpack command line (or inside + CMakeLists.txt) thenCPack.cmake defines it with a default value + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst new file mode 100644 index 0000000..43fb961 --- /dev/null +++ b/Help/manual/ctest.1.rst @@ -0,0 +1,312 @@ +ctest(1) +******** + +Synopsis +======== + +:: + + ctest [options] + +Description +=========== + +The "ctest" executable is the CMake test driver program. +CMake-generated build trees created for projects that use the +ENABLE_TESTING and ADD_TEST commands have testing support. This +program will run the tests and report results. + + +* ``-C <cfg>, --build-config <cfg>``: Choose configuration to test. + + Some CMake-generated build trees can have multiple build + configurations in the same tree. This option can be used to specify + which one should be tested. Example configurations are "Debug" and + "Release". + +* ``-V,--verbose``: Enable verbose output from tests. + + Test output is normally suppressed and only summary information is + displayed. This option will show all test output. + +* ``-VV,--extra-verbose``: Enable more verbose output from tests. + + Test output is normally suppressed and only summary information is + displayed. This option will show even more test output. + +* ``--debug``: Displaying more verbose internals of CTest. + + This feature will result in a large number of output that is mostly + useful for debugging dashboard problems. + +* ``--output-on-failure``: Output anything outputted by the test program if the test should fail. This option can also be enabled by setting the environment variable CTEST_OUTPUT_ON_FAILURE + +* ``-F``: Enable failover. + + This option allows ctest to resume a test set execution that was + previously interrupted. If no interruption occurred, the -F option + will have no effect. + +* ``-j <jobs>, --parallel <jobs>``: Run the tests in parallel using thegiven number of jobs. + + This option tells ctest to run the tests in parallel using given + number of jobs. This option can also be set by setting the + environment variable CTEST_PARALLEL_LEVEL. + +* ``-Q,--quiet``: Make ctest quiet. + + This option will suppress all the output. The output log file will + still be generated if the --output-log is specified. Options such + as --verbose, --extra-verbose, and --debug are ignored if --quiet is + specified. + +* ``-O <file>, --output-log <file>``: Output to log file + + This option tells ctest to write all its output to a log file. + +* ``-N,--show-only``: Disable actual execution of tests. + + This option tells ctest to list the tests that would be run but not + actually run them. Useful in conjunction with the -R and -E + options. + +* ``-L <regex>, --label-regex <regex>``: Run tests with labels matching regular expression. + + This option tells ctest to run only the tests whose labels match the + given regular expression. + +* ``-R <regex>, --tests-regex <regex>``: Run tests matching regular expression. + + This option tells ctest to run only the tests whose names match the + given regular expression. + +* ``-E <regex>, --exclude-regex <regex>``: Exclude tests matching regular expression. + + This option tells ctest to NOT run the tests whose names match the + given regular expression. + +* ``-LE <regex>, --label-exclude <regex>``: Exclude tests with labels matching regular expression. + + This option tells ctest to NOT run the tests whose labels match the + given regular expression. + +* ``-D <dashboard>, --dashboard <dashboard>``: Execute dashboard test + + This option tells ctest to act as a Dart client and perform a + dashboard test. All tests are <Mode><Test>, where Mode can be + Experimental, Nightly, and Continuous, and Test can be Start, + Update, Configure, Build, Test, Coverage, and Submit. + +* ``-D <var>:<type>=<value>``: Define a variable for script mode + + Pass in variable values on the command line. Use in conjunction + with -S to pass variable values to a dashboard script. Parsing -D + arguments as variable values is only attempted if the value + following -D does not match any of the known dashboard types. + +* ``-M <model>, --test-model <model>``: Sets the model for a dashboard + + This option tells ctest to act as a Dart client where the TestModel + can be Experimental, Nightly, and Continuous. Combining -M and -T + is similar to -D + +* ``-T <action>, --test-action <action>``: Sets the dashboard action to perform + + This option tells ctest to act as a Dart client and perform some + action such as start, build, test etc. Combining -M and -T is + similar to -D + +* ``--track <track>``: Specify the track to submit dashboard to + + Submit dashboard to specified track instead of default one. By + default, the dashboard is submitted to Nightly, Experimental, or + Continuous track, but by specifying this option, the track can be + arbitrary. + +* ``-S <script>, --script <script>``: Execute a dashboard for a configuration + + This option tells ctest to load in a configuration script which sets + a number of parameters such as the binary and source directories. + Then ctest will do what is required to create and run a dashboard. + This option basically sets up a dashboard and then runs ctest -D + with the appropriate options. + +* ``-SP <script>, --script-new-process <script>``: Execute a dashboard for a configuration + + This option does the same operations as -S but it will do them in a + separate process. This is primarily useful in cases where the + script may modify the environment and you do not want the modified + environment to impact other -S scripts. + +* ``-A <file>, --add-notes <file>``: Add a notes file with submission + + This option tells ctest to include a notes file when submitting + dashboard. + +* ``-I [Start,End,Stride,test#,test#|Test file], --tests-information``: Run a specific number of tests by number. + + This option causes ctest to run tests starting at number Start, + ending at number End, and incrementing by Stride. Any additional + numbers after Stride are considered individual test numbers. Start, + End,or stride can be empty. Optionally a file can be given that + contains the same syntax as the command line. + +* ``-U, --union``: Take the Union of -I and -R + + When both -R and -I are specified by default the intersection of + tests are run. By specifying -U the union of tests is run instead. + +* ``--rerun-failed``: Run only the tests that failed previously + + This option tells ctest to perform only the tests that failed during + its previous run. When this option is specified, ctest ignores all + other options intended to modify the list of tests to run (-L, -R, + -E, -LE, -I, etc). In the event that CTest runs and no tests fail, + subsequent calls to ctest with the --rerun-failed option will run + the set of tests that most recently failed (if any). + +* ``--max-width <width>``: Set the max width for a test name to output + + Set the maximum width for each test name to show in the output. + This allows the user to widen the output to avoid clipping the test + name which can be very annoying. + +* ``--interactive-debug-mode [0|1]``: Set the interactive mode to 0 or 1. + + This option causes ctest to run tests in either an interactive mode + or a non-interactive mode. On Windows this means that in + non-interactive mode, all system debug pop up windows are blocked. + In dashboard mode (Experimental, Nightly, Continuous), the default + is non-interactive. When just running tests not for a dashboard the + default is to allow popups and interactive debugging. + +* ``--no-label-summary``: Disable timing summary information for labels. + + This option tells ctest not to print summary information for each + label associated with the tests run. If there are no labels on the + tests, nothing extra is printed. + +* ``--build-and-test``: Configure, build and run a test. + + This option tells ctest to configure (i.e. run cmake on), build, + and or execute a test. The configure and test steps are optional. + The arguments to this command line are the source and binary + directories. By default this will run CMake on the Source/Bin + directories specified unless --build-nocmake is specified. Both + --build-makeprogram and --build-generator MUST be provided to use + --build-and-test. If --test-command is specified then that will be + run after the build is complete. Other options that affect this + mode are --build-target --build-nocmake, --build-run-dir, + --build-two-config, --build-exe-dir, + --build-project,--build-noclean, --build-options + +* ``--build-target``: Specify a specific target to build. + + This option goes with the --build-and-test option, if left out the + all target is built. + +* ``--build-nocmake``: Run the build without running cmake first. + + Skip the cmake step. + +* ``--build-run-dir``: Specify directory to run programs from. + + Directory where programs will be after it has been compiled. + +* ``--build-two-config``: Run CMake twice + +* ``--build-exe-dir``: Specify the directory for the executable. + +* ``--build-generator``: Specify the generator to use. + +* ``--build-generator-toolset``: Specify the generator-specific toolset. + +* ``--build-project``: Specify the name of the project to build. + +* ``--build-makeprogram``: Specify the make program to use. + +* ``--build-noclean``: Skip the make clean step. + +* ``--build-config-sample``: A sample executable to use to determine the configuration + + A sample executable to use to determine the configuration that + should be used. e.g. Debug/Release/etc + +* ``--build-options``: Add extra options to the build step. + + This option must be the last option with the exception of + --test-command + +* ``--test-command``: The test to run with the --build-and-test option. + +* ``--test-timeout``: The time limit in seconds, internal use only. + +* ``--tomorrow-tag``: Nightly or experimental starts with next day tag. + + This is useful if the build will not finish in one day. + +* ``--ctest-config``: The configuration file used to initialize CTest state when submitting dashboards. + + This option tells CTest to use different initialization file instead + of CTestConfiguration.tcl. This way multiple initialization files + can be used for example to submit to multiple dashboards. + +* ``--overwrite``: Overwrite CTest configuration option. + + By default ctest uses configuration options from configuration file. + This option will overwrite the configuration option. + +* ``--extra-submit <file>[;<file>]``: Submit extra files to the dashboard. + + This option will submit extra files to the dashboard. + +* ``--force-new-ctest-process``: Run child CTest instances as new processes + + By default CTest will run child CTest instances within the same + process. If this behavior is not desired, this argument will + enforce new processes for child CTest processes. + +* ``--schedule-random``: Use a random order for scheduling tests + + This option will run the tests in a random order. It is commonly + used to detect implicit dependencies in a test suite. + +* ``--submit-index``: Submit individual dashboard tests with specific index + + This option allows performing the same CTest action (such as test) + multiple times and submit all stages to the same dashboard (Dart2 + required). Each execution requires different index. + +* ``--timeout <seconds>``: Set a global timeout on all tests. + + This option will set a global timeout on all tests that do not + already have a timeout set on them. + +* ``--stop-time <time>``: Set a time at which all tests should stop running. + + Set a real time of day at which all tests should timeout. Example: + 7:00:00 -0400. Any time format understood by the curl date parser + is accepted. Local time is assumed if no timezone is specified. + +* ``--http1.0``: Submit using HTTP 1.0. + + This option will force CTest to use HTTP 1.0 to submit files to the + dashboard, instead of HTTP 1.1. + +* ``--no-compress-output``: Do not compress test output when submitting. + + This flag will turn off automatic compression of test output. Use + this to maintain compatibility with an older version of CDash which + doesn't support compressed test output. + +* ``--print-labels``: Print all available test labels. + + This option will not run any tests, it will simply print the list of + all labels associated with the test set. + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt diff --git a/Help/module/AddFileDependencies.rst b/Help/module/AddFileDependencies.rst new file mode 100644 index 0000000..3cbce33 --- /dev/null +++ b/Help/module/AddFileDependencies.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/AddFileDependencies.cmake diff --git a/Help/module/BundleUtilities.rst b/Help/module/BundleUtilities.rst new file mode 100644 index 0000000..5d9c840 --- /dev/null +++ b/Help/module/BundleUtilities.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/BundleUtilities.cmake diff --git a/Help/module/CMakeAddFortranSubdirectory.rst b/Help/module/CMakeAddFortranSubdirectory.rst new file mode 100644 index 0000000..9abf571 --- /dev/null +++ b/Help/module/CMakeAddFortranSubdirectory.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeAddFortranSubdirectory.cmake diff --git a/Help/module/CMakeBackwardCompatibilityCXX.rst b/Help/module/CMakeBackwardCompatibilityCXX.rst new file mode 100644 index 0000000..05e5f4a --- /dev/null +++ b/Help/module/CMakeBackwardCompatibilityCXX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeBackwardCompatibilityCXX.cmake diff --git a/Help/module/CMakeDependentOption.rst b/Help/module/CMakeDependentOption.rst new file mode 100644 index 0000000..fd071b5 --- /dev/null +++ b/Help/module/CMakeDependentOption.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeDependentOption.cmake diff --git a/Help/module/CMakeDetermineVSServicePack.rst b/Help/module/CMakeDetermineVSServicePack.rst new file mode 100644 index 0000000..1768533 --- /dev/null +++ b/Help/module/CMakeDetermineVSServicePack.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeDetermineVSServicePack.cmake diff --git a/Help/module/CMakeExpandImportedTargets.rst b/Help/module/CMakeExpandImportedTargets.rst new file mode 100644 index 0000000..1084280 --- /dev/null +++ b/Help/module/CMakeExpandImportedTargets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeExpandImportedTargets.cmake diff --git a/Help/module/CMakeFindFrameworks.rst b/Help/module/CMakeFindFrameworks.rst new file mode 100644 index 0000000..c2c219b --- /dev/null +++ b/Help/module/CMakeFindFrameworks.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeFindFrameworks.cmake diff --git a/Help/module/CMakeFindPackageMode.rst b/Help/module/CMakeFindPackageMode.rst new file mode 100644 index 0000000..d099d19 --- /dev/null +++ b/Help/module/CMakeFindPackageMode.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeFindPackageMode.cmake diff --git a/Help/module/CMakeForceCompiler.rst b/Help/module/CMakeForceCompiler.rst new file mode 100644 index 0000000..3277426 --- /dev/null +++ b/Help/module/CMakeForceCompiler.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeForceCompiler.cmake diff --git a/Help/module/CMakeGraphVizOptions.rst b/Help/module/CMakeGraphVizOptions.rst new file mode 100644 index 0000000..2cd97b3 --- /dev/null +++ b/Help/module/CMakeGraphVizOptions.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeGraphVizOptions.cmake diff --git a/Help/module/CMakePackageConfigHelpers.rst b/Help/module/CMakePackageConfigHelpers.rst new file mode 100644 index 0000000..a291aff --- /dev/null +++ b/Help/module/CMakePackageConfigHelpers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePackageConfigHelpers.cmake diff --git a/Help/module/CMakeParseArguments.rst b/Help/module/CMakeParseArguments.rst new file mode 100644 index 0000000..810a9dd --- /dev/null +++ b/Help/module/CMakeParseArguments.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeParseArguments.cmake diff --git a/Help/module/CMakePrintHelpers.rst b/Help/module/CMakePrintHelpers.rst new file mode 100644 index 0000000..a75a34f --- /dev/null +++ b/Help/module/CMakePrintHelpers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePrintHelpers.cmake diff --git a/Help/module/CMakePrintSystemInformation.rst b/Help/module/CMakePrintSystemInformation.rst new file mode 100644 index 0000000..0b5d848 --- /dev/null +++ b/Help/module/CMakePrintSystemInformation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePrintSystemInformation.cmake diff --git a/Help/module/CMakePushCheckState.rst b/Help/module/CMakePushCheckState.rst new file mode 100644 index 0000000..e897929 --- /dev/null +++ b/Help/module/CMakePushCheckState.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakePushCheckState.cmake diff --git a/Help/module/CMakeVerifyManifest.rst b/Help/module/CMakeVerifyManifest.rst new file mode 100644 index 0000000..eeff1bf --- /dev/null +++ b/Help/module/CMakeVerifyManifest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CMakeVerifyManifest.cmake diff --git a/Help/module/CPack.rst b/Help/module/CPack.rst new file mode 100644 index 0000000..bfbda1f --- /dev/null +++ b/Help/module/CPack.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPack.cmake diff --git a/Help/module/CPackBundle.rst b/Help/module/CPackBundle.rst new file mode 100644 index 0000000..651e874 --- /dev/null +++ b/Help/module/CPackBundle.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackBundle.cmake diff --git a/Help/module/CPackComponent.rst b/Help/module/CPackComponent.rst new file mode 100644 index 0000000..df82836 --- /dev/null +++ b/Help/module/CPackComponent.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackComponent.cmake diff --git a/Help/module/CPackCygwin.rst b/Help/module/CPackCygwin.rst new file mode 100644 index 0000000..21f4473 --- /dev/null +++ b/Help/module/CPackCygwin.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackCygwin.cmake diff --git a/Help/module/CPackDMG.rst b/Help/module/CPackDMG.rst new file mode 100644 index 0000000..784262c --- /dev/null +++ b/Help/module/CPackDMG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackDMG.cmake diff --git a/Help/module/CPackDeb.rst b/Help/module/CPackDeb.rst new file mode 100644 index 0000000..d1526ee --- /dev/null +++ b/Help/module/CPackDeb.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackDeb.cmake diff --git a/Help/module/CPackNSIS.rst b/Help/module/CPackNSIS.rst new file mode 100644 index 0000000..bb35ed6 --- /dev/null +++ b/Help/module/CPackNSIS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackNSIS.cmake diff --git a/Help/module/CPackPackageMaker.rst b/Help/module/CPackPackageMaker.rst new file mode 100644 index 0000000..de55448 --- /dev/null +++ b/Help/module/CPackPackageMaker.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackPackageMaker.cmake diff --git a/Help/module/CPackRPM.rst b/Help/module/CPackRPM.rst new file mode 100644 index 0000000..28d0e69 --- /dev/null +++ b/Help/module/CPackRPM.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackRPM.cmake diff --git a/Help/module/CPackWIX.rst b/Help/module/CPackWIX.rst new file mode 100644 index 0000000..1f5e451 --- /dev/null +++ b/Help/module/CPackWIX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CPackWIX.cmake diff --git a/Help/module/CTest.rst b/Help/module/CTest.rst new file mode 100644 index 0000000..11a6af7 --- /dev/null +++ b/Help/module/CTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTest.cmake diff --git a/Help/module/CTestScriptMode.rst b/Help/module/CTestScriptMode.rst new file mode 100644 index 0000000..be1b044 --- /dev/null +++ b/Help/module/CTestScriptMode.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTestScriptMode.cmake diff --git a/Help/module/CTestUseLaunchers.rst b/Help/module/CTestUseLaunchers.rst new file mode 100644 index 0000000..688da08 --- /dev/null +++ b/Help/module/CTestUseLaunchers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CTestUseLaunchers.cmake diff --git a/Help/module/CheckCCompilerFlag.rst b/Help/module/CheckCCompilerFlag.rst new file mode 100644 index 0000000..1be1491 --- /dev/null +++ b/Help/module/CheckCCompilerFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCCompilerFlag.cmake diff --git a/Help/module/CheckCSourceCompiles.rst b/Help/module/CheckCSourceCompiles.rst new file mode 100644 index 0000000..1fa02f9 --- /dev/null +++ b/Help/module/CheckCSourceCompiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCSourceCompiles.cmake diff --git a/Help/module/CheckCSourceRuns.rst b/Help/module/CheckCSourceRuns.rst new file mode 100644 index 0000000..16b47e6 --- /dev/null +++ b/Help/module/CheckCSourceRuns.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCSourceRuns.cmake diff --git a/Help/module/CheckCXXCompilerFlag.rst b/Help/module/CheckCXXCompilerFlag.rst new file mode 100644 index 0000000..cfd1f45 --- /dev/null +++ b/Help/module/CheckCXXCompilerFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXCompilerFlag.cmake diff --git a/Help/module/CheckCXXSourceCompiles.rst b/Help/module/CheckCXXSourceCompiles.rst new file mode 100644 index 0000000..d701c4e --- /dev/null +++ b/Help/module/CheckCXXSourceCompiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSourceCompiles.cmake diff --git a/Help/module/CheckCXXSourceRuns.rst b/Help/module/CheckCXXSourceRuns.rst new file mode 100644 index 0000000..caab975 --- /dev/null +++ b/Help/module/CheckCXXSourceRuns.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSourceRuns.cmake diff --git a/Help/module/CheckCXXSymbolExists.rst b/Help/module/CheckCXXSymbolExists.rst new file mode 100644 index 0000000..fc192e8 --- /dev/null +++ b/Help/module/CheckCXXSymbolExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckCXXSymbolExists.cmake diff --git a/Help/module/CheckFortranFunctionExists.rst b/Help/module/CheckFortranFunctionExists.rst new file mode 100644 index 0000000..3395d05 --- /dev/null +++ b/Help/module/CheckFortranFunctionExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckFortranFunctionExists.cmake diff --git a/Help/module/CheckFunctionExists.rst b/Help/module/CheckFunctionExists.rst new file mode 100644 index 0000000..ed89dc4 --- /dev/null +++ b/Help/module/CheckFunctionExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckFunctionExists.cmake diff --git a/Help/module/CheckIncludeFile.rst b/Help/module/CheckIncludeFile.rst new file mode 100644 index 0000000..6b83108 --- /dev/null +++ b/Help/module/CheckIncludeFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFile.cmake diff --git a/Help/module/CheckIncludeFileCXX.rst b/Help/module/CheckIncludeFileCXX.rst new file mode 100644 index 0000000..fdbf39f --- /dev/null +++ b/Help/module/CheckIncludeFileCXX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFileCXX.cmake diff --git a/Help/module/CheckIncludeFiles.rst b/Help/module/CheckIncludeFiles.rst new file mode 100644 index 0000000..b56f145 --- /dev/null +++ b/Help/module/CheckIncludeFiles.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckIncludeFiles.cmake diff --git a/Help/module/CheckLanguage.rst b/Help/module/CheckLanguage.rst new file mode 100644 index 0000000..16f1a3f --- /dev/null +++ b/Help/module/CheckLanguage.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckLanguage.cmake diff --git a/Help/module/CheckLibraryExists.rst b/Help/module/CheckLibraryExists.rst new file mode 100644 index 0000000..7512f46 --- /dev/null +++ b/Help/module/CheckLibraryExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckLibraryExists.cmake diff --git a/Help/module/CheckPrototypeDefinition.rst b/Help/module/CheckPrototypeDefinition.rst new file mode 100644 index 0000000..073fcb5 --- /dev/null +++ b/Help/module/CheckPrototypeDefinition.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckPrototypeDefinition.cmake diff --git a/Help/module/CheckStructHasMember.rst b/Help/module/CheckStructHasMember.rst new file mode 100644 index 0000000..5277ad2 --- /dev/null +++ b/Help/module/CheckStructHasMember.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckStructHasMember.cmake diff --git a/Help/module/CheckSymbolExists.rst b/Help/module/CheckSymbolExists.rst new file mode 100644 index 0000000..68ae700 --- /dev/null +++ b/Help/module/CheckSymbolExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckSymbolExists.cmake diff --git a/Help/module/CheckTypeSize.rst b/Help/module/CheckTypeSize.rst new file mode 100644 index 0000000..6ad0345 --- /dev/null +++ b/Help/module/CheckTypeSize.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckTypeSize.cmake diff --git a/Help/module/CheckVariableExists.rst b/Help/module/CheckVariableExists.rst new file mode 100644 index 0000000..07f0777 --- /dev/null +++ b/Help/module/CheckVariableExists.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/CheckVariableExists.cmake diff --git a/Help/module/Dart.rst b/Help/module/Dart.rst new file mode 100644 index 0000000..524ac33 --- /dev/null +++ b/Help/module/Dart.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Dart.cmake diff --git a/Help/module/DeployQt4.rst b/Help/module/DeployQt4.rst new file mode 100644 index 0000000..3c0ef44 --- /dev/null +++ b/Help/module/DeployQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/DeployQt4.cmake diff --git a/Help/module/Documentation.rst b/Help/module/Documentation.rst new file mode 100644 index 0000000..08e2ffb --- /dev/null +++ b/Help/module/Documentation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Documentation.cmake diff --git a/Help/module/ExternalData.rst b/Help/module/ExternalData.rst new file mode 100644 index 0000000..f0f8f1d --- /dev/null +++ b/Help/module/ExternalData.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ExternalData.cmake diff --git a/Help/module/ExternalProject.rst b/Help/module/ExternalProject.rst new file mode 100644 index 0000000..fce7056 --- /dev/null +++ b/Help/module/ExternalProject.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ExternalProject.cmake diff --git a/Help/module/FeatureSummary.rst b/Help/module/FeatureSummary.rst new file mode 100644 index 0000000..6fd8f38 --- /dev/null +++ b/Help/module/FeatureSummary.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FeatureSummary.cmake diff --git a/Help/module/FindALSA.rst b/Help/module/FindALSA.rst new file mode 100644 index 0000000..2a73786 --- /dev/null +++ b/Help/module/FindALSA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindALSA.cmake diff --git a/Help/module/FindASPELL.rst b/Help/module/FindASPELL.rst new file mode 100644 index 0000000..56dedc4 --- /dev/null +++ b/Help/module/FindASPELL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindASPELL.cmake diff --git a/Help/module/FindAVIFile.rst b/Help/module/FindAVIFile.rst new file mode 100644 index 0000000..71282a6 --- /dev/null +++ b/Help/module/FindAVIFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindAVIFile.cmake diff --git a/Help/module/FindArmadillo.rst b/Help/module/FindArmadillo.rst new file mode 100644 index 0000000..f0ac933 --- /dev/null +++ b/Help/module/FindArmadillo.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindArmadillo.cmake diff --git a/Help/module/FindBISON.rst b/Help/module/FindBISON.rst new file mode 100644 index 0000000..c6e5791 --- /dev/null +++ b/Help/module/FindBISON.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBISON.cmake diff --git a/Help/module/FindBLAS.rst b/Help/module/FindBLAS.rst new file mode 100644 index 0000000..41f6771 --- /dev/null +++ b/Help/module/FindBLAS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBLAS.cmake diff --git a/Help/module/FindBZip2.rst b/Help/module/FindBZip2.rst new file mode 100644 index 0000000..281b1d1 --- /dev/null +++ b/Help/module/FindBZip2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBZip2.cmake diff --git a/Help/module/FindBoost.rst b/Help/module/FindBoost.rst new file mode 100644 index 0000000..1392540 --- /dev/null +++ b/Help/module/FindBoost.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBoost.cmake diff --git a/Help/module/FindBullet.rst b/Help/module/FindBullet.rst new file mode 100644 index 0000000..4ed2b85 --- /dev/null +++ b/Help/module/FindBullet.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindBullet.cmake diff --git a/Help/module/FindCABLE.rst b/Help/module/FindCABLE.rst new file mode 100644 index 0000000..716d5ab --- /dev/null +++ b/Help/module/FindCABLE.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCABLE.cmake diff --git a/Help/module/FindCUDA.rst b/Help/module/FindCUDA.rst new file mode 100644 index 0000000..46ffa9f --- /dev/null +++ b/Help/module/FindCUDA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCUDA.cmake diff --git a/Help/module/FindCURL.rst b/Help/module/FindCURL.rst new file mode 100644 index 0000000..e2acc49 --- /dev/null +++ b/Help/module/FindCURL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCURL.cmake diff --git a/Help/module/FindCVS.rst b/Help/module/FindCVS.rst new file mode 100644 index 0000000..c891c07 --- /dev/null +++ b/Help/module/FindCVS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCVS.cmake diff --git a/Help/module/FindCoin3D.rst b/Help/module/FindCoin3D.rst new file mode 100644 index 0000000..fc70a74 --- /dev/null +++ b/Help/module/FindCoin3D.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCoin3D.cmake diff --git a/Help/module/FindCups.rst b/Help/module/FindCups.rst new file mode 100644 index 0000000..10d0646 --- /dev/null +++ b/Help/module/FindCups.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCups.cmake diff --git a/Help/module/FindCurses.rst b/Help/module/FindCurses.rst new file mode 100644 index 0000000..73dd011 --- /dev/null +++ b/Help/module/FindCurses.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCurses.cmake diff --git a/Help/module/FindCxxTest.rst b/Help/module/FindCxxTest.rst new file mode 100644 index 0000000..4f17c39 --- /dev/null +++ b/Help/module/FindCxxTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCxxTest.cmake diff --git a/Help/module/FindCygwin.rst b/Help/module/FindCygwin.rst new file mode 100644 index 0000000..2e529dd --- /dev/null +++ b/Help/module/FindCygwin.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindCygwin.cmake diff --git a/Help/module/FindDCMTK.rst b/Help/module/FindDCMTK.rst new file mode 100644 index 0000000..8437d55 --- /dev/null +++ b/Help/module/FindDCMTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDCMTK.cmake diff --git a/Help/module/FindDart.rst b/Help/module/FindDart.rst new file mode 100644 index 0000000..6f21ad4 --- /dev/null +++ b/Help/module/FindDart.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDart.cmake diff --git a/Help/module/FindDevIL.rst b/Help/module/FindDevIL.rst new file mode 100644 index 0000000..91a28dd --- /dev/null +++ b/Help/module/FindDevIL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDevIL.cmake diff --git a/Help/module/FindDoxygen.rst b/Help/module/FindDoxygen.rst new file mode 100644 index 0000000..cffe734 --- /dev/null +++ b/Help/module/FindDoxygen.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindDoxygen.cmake diff --git a/Help/module/FindEXPAT.rst b/Help/module/FindEXPAT.rst new file mode 100644 index 0000000..5063680 --- /dev/null +++ b/Help/module/FindEXPAT.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindEXPAT.cmake diff --git a/Help/module/FindFLEX.rst b/Help/module/FindFLEX.rst new file mode 100644 index 0000000..cc90791 --- /dev/null +++ b/Help/module/FindFLEX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLEX.cmake diff --git a/Help/module/FindFLTK.rst b/Help/module/FindFLTK.rst new file mode 100644 index 0000000..cc1964c --- /dev/null +++ b/Help/module/FindFLTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLTK.cmake diff --git a/Help/module/FindFLTK2.rst b/Help/module/FindFLTK2.rst new file mode 100644 index 0000000..5c2acc4 --- /dev/null +++ b/Help/module/FindFLTK2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFLTK2.cmake diff --git a/Help/module/FindFreetype.rst b/Help/module/FindFreetype.rst new file mode 100644 index 0000000..424c3fc --- /dev/null +++ b/Help/module/FindFreetype.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindFreetype.cmake diff --git a/Help/module/FindGCCXML.rst b/Help/module/FindGCCXML.rst new file mode 100644 index 0000000..15fd4d0 --- /dev/null +++ b/Help/module/FindGCCXML.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGCCXML.cmake diff --git a/Help/module/FindGDAL.rst b/Help/module/FindGDAL.rst new file mode 100644 index 0000000..81fcb3a --- /dev/null +++ b/Help/module/FindGDAL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGDAL.cmake diff --git a/Help/module/FindGIF.rst b/Help/module/FindGIF.rst new file mode 100644 index 0000000..03d3a75 --- /dev/null +++ b/Help/module/FindGIF.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGIF.cmake diff --git a/Help/module/FindGLEW.rst b/Help/module/FindGLEW.rst new file mode 100644 index 0000000..77755da --- /dev/null +++ b/Help/module/FindGLEW.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGLEW.cmake diff --git a/Help/module/FindGLUT.rst b/Help/module/FindGLUT.rst new file mode 100644 index 0000000..40263ee --- /dev/null +++ b/Help/module/FindGLUT.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGLUT.cmake diff --git a/Help/module/FindGTK.rst b/Help/module/FindGTK.rst new file mode 100644 index 0000000..1ce6a86 --- /dev/null +++ b/Help/module/FindGTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTK.cmake diff --git a/Help/module/FindGTK2.rst b/Help/module/FindGTK2.rst new file mode 100644 index 0000000..67c1ba9 --- /dev/null +++ b/Help/module/FindGTK2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTK2.cmake diff --git a/Help/module/FindGTest.rst b/Help/module/FindGTest.rst new file mode 100644 index 0000000..0e3b4d7 --- /dev/null +++ b/Help/module/FindGTest.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGTest.cmake diff --git a/Help/module/FindGettext.rst b/Help/module/FindGettext.rst new file mode 100644 index 0000000..e880dc0 --- /dev/null +++ b/Help/module/FindGettext.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGettext.cmake diff --git a/Help/module/FindGit.rst b/Help/module/FindGit.rst new file mode 100644 index 0000000..dd540ef --- /dev/null +++ b/Help/module/FindGit.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGit.cmake diff --git a/Help/module/FindGnuTLS.rst b/Help/module/FindGnuTLS.rst new file mode 100644 index 0000000..de0c1d4 --- /dev/null +++ b/Help/module/FindGnuTLS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGnuTLS.cmake diff --git a/Help/module/FindGnuplot.rst b/Help/module/FindGnuplot.rst new file mode 100644 index 0000000..93a18b6 --- /dev/null +++ b/Help/module/FindGnuplot.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindGnuplot.cmake diff --git a/Help/module/FindHDF5.rst b/Help/module/FindHDF5.rst new file mode 100644 index 0000000..8ac1b8b --- /dev/null +++ b/Help/module/FindHDF5.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHDF5.cmake diff --git a/Help/module/FindHSPELL.rst b/Help/module/FindHSPELL.rst new file mode 100644 index 0000000..c1905a2 --- /dev/null +++ b/Help/module/FindHSPELL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHSPELL.cmake diff --git a/Help/module/FindHTMLHelp.rst b/Help/module/FindHTMLHelp.rst new file mode 100644 index 0000000..47d9c8c --- /dev/null +++ b/Help/module/FindHTMLHelp.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHTMLHelp.cmake diff --git a/Help/module/FindHg.rst b/Help/module/FindHg.rst new file mode 100644 index 0000000..94aba6f --- /dev/null +++ b/Help/module/FindHg.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindHg.cmake diff --git a/Help/module/FindITK.rst b/Help/module/FindITK.rst new file mode 100644 index 0000000..dbfabbd --- /dev/null +++ b/Help/module/FindITK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindITK.cmake diff --git a/Help/module/FindIcotool.rst b/Help/module/FindIcotool.rst new file mode 100644 index 0000000..c139f58 --- /dev/null +++ b/Help/module/FindIcotool.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindIcotool.cmake diff --git a/Help/module/FindImageMagick.rst b/Help/module/FindImageMagick.rst new file mode 100644 index 0000000..3a3596e --- /dev/null +++ b/Help/module/FindImageMagick.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindImageMagick.cmake diff --git a/Help/module/FindJNI.rst b/Help/module/FindJNI.rst new file mode 100644 index 0000000..b753cf8 --- /dev/null +++ b/Help/module/FindJNI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJNI.cmake diff --git a/Help/module/FindJPEG.rst b/Help/module/FindJPEG.rst new file mode 100644 index 0000000..8036352 --- /dev/null +++ b/Help/module/FindJPEG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJPEG.cmake diff --git a/Help/module/FindJasper.rst b/Help/module/FindJasper.rst new file mode 100644 index 0000000..725a87f --- /dev/null +++ b/Help/module/FindJasper.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJasper.cmake diff --git a/Help/module/FindJava.rst b/Help/module/FindJava.rst new file mode 100644 index 0000000..39e6b6b --- /dev/null +++ b/Help/module/FindJava.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindJava.cmake diff --git a/Help/module/FindKDE3.rst b/Help/module/FindKDE3.rst new file mode 100644 index 0000000..13ac15c --- /dev/null +++ b/Help/module/FindKDE3.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindKDE3.cmake diff --git a/Help/module/FindKDE4.rst b/Help/module/FindKDE4.rst new file mode 100644 index 0000000..8b22f7f --- /dev/null +++ b/Help/module/FindKDE4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindKDE4.cmake diff --git a/Help/module/FindLAPACK.rst b/Help/module/FindLAPACK.rst new file mode 100644 index 0000000..6e99090 --- /dev/null +++ b/Help/module/FindLAPACK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLAPACK.cmake diff --git a/Help/module/FindLATEX.rst b/Help/module/FindLATEX.rst new file mode 100644 index 0000000..4b14c71 --- /dev/null +++ b/Help/module/FindLATEX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLATEX.cmake diff --git a/Help/module/FindLibArchive.rst b/Help/module/FindLibArchive.rst new file mode 100644 index 0000000..c46b1d0 --- /dev/null +++ b/Help/module/FindLibArchive.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibArchive.cmake diff --git a/Help/module/FindLibLZMA.rst b/Help/module/FindLibLZMA.rst new file mode 100644 index 0000000..8880158 --- /dev/null +++ b/Help/module/FindLibLZMA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibLZMA.cmake diff --git a/Help/module/FindLibXml2.rst b/Help/module/FindLibXml2.rst new file mode 100644 index 0000000..bbb3225 --- /dev/null +++ b/Help/module/FindLibXml2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibXml2.cmake diff --git a/Help/module/FindLibXslt.rst b/Help/module/FindLibXslt.rst new file mode 100644 index 0000000..4107170 --- /dev/null +++ b/Help/module/FindLibXslt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLibXslt.cmake diff --git a/Help/module/FindLua.rst b/Help/module/FindLua.rst new file mode 100644 index 0000000..977e5bf --- /dev/null +++ b/Help/module/FindLua.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua.cmake diff --git a/Help/module/FindLua50.rst b/Help/module/FindLua50.rst new file mode 100644 index 0000000..0353fc3 --- /dev/null +++ b/Help/module/FindLua50.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua50.cmake diff --git a/Help/module/FindLua51.rst b/Help/module/FindLua51.rst new file mode 100644 index 0000000..672ff35 --- /dev/null +++ b/Help/module/FindLua51.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindLua51.cmake diff --git a/Help/module/FindMFC.rst b/Help/module/FindMFC.rst new file mode 100644 index 0000000..a3226a6 --- /dev/null +++ b/Help/module/FindMFC.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMFC.cmake diff --git a/Help/module/FindMPEG.rst b/Help/module/FindMPEG.rst new file mode 100644 index 0000000..c9ce481 --- /dev/null +++ b/Help/module/FindMPEG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPEG.cmake diff --git a/Help/module/FindMPEG2.rst b/Help/module/FindMPEG2.rst new file mode 100644 index 0000000..f843c89 --- /dev/null +++ b/Help/module/FindMPEG2.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPEG2.cmake diff --git a/Help/module/FindMPI.rst b/Help/module/FindMPI.rst new file mode 100644 index 0000000..fad10c7 --- /dev/null +++ b/Help/module/FindMPI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMPI.cmake diff --git a/Help/module/FindMatlab.rst b/Help/module/FindMatlab.rst new file mode 100644 index 0000000..43f861a --- /dev/null +++ b/Help/module/FindMatlab.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMatlab.cmake diff --git a/Help/module/FindMotif.rst b/Help/module/FindMotif.rst new file mode 100644 index 0000000..e602a50 --- /dev/null +++ b/Help/module/FindMotif.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindMotif.cmake diff --git a/Help/module/FindOpenAL.rst b/Help/module/FindOpenAL.rst new file mode 100644 index 0000000..f086556 --- /dev/null +++ b/Help/module/FindOpenAL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenAL.cmake diff --git a/Help/module/FindOpenGL.rst b/Help/module/FindOpenGL.rst new file mode 100644 index 0000000..85e89bc --- /dev/null +++ b/Help/module/FindOpenGL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenGL.cmake diff --git a/Help/module/FindOpenMP.rst b/Help/module/FindOpenMP.rst new file mode 100644 index 0000000..01362ab --- /dev/null +++ b/Help/module/FindOpenMP.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenMP.cmake diff --git a/Help/module/FindOpenSSL.rst b/Help/module/FindOpenSSL.rst new file mode 100644 index 0000000..f622bb1 --- /dev/null +++ b/Help/module/FindOpenSSL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenSSL.cmake diff --git a/Help/module/FindOpenSceneGraph.rst b/Help/module/FindOpenSceneGraph.rst new file mode 100644 index 0000000..4346492 --- /dev/null +++ b/Help/module/FindOpenSceneGraph.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenSceneGraph.cmake diff --git a/Help/module/FindOpenThreads.rst b/Help/module/FindOpenThreads.rst new file mode 100644 index 0000000..bb3f0f9 --- /dev/null +++ b/Help/module/FindOpenThreads.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindOpenThreads.cmake diff --git a/Help/module/FindPHP4.rst b/Help/module/FindPHP4.rst new file mode 100644 index 0000000..1de62e8 --- /dev/null +++ b/Help/module/FindPHP4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPHP4.cmake diff --git a/Help/module/FindPNG.rst b/Help/module/FindPNG.rst new file mode 100644 index 0000000..e6d1618 --- /dev/null +++ b/Help/module/FindPNG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPNG.cmake diff --git a/Help/module/FindPackageHandleStandardArgs.rst b/Help/module/FindPackageHandleStandardArgs.rst new file mode 100644 index 0000000..feda7ef --- /dev/null +++ b/Help/module/FindPackageHandleStandardArgs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPackageHandleStandardArgs.cmake diff --git a/Help/module/FindPackageMessage.rst b/Help/module/FindPackageMessage.rst new file mode 100644 index 0000000..b682d8c --- /dev/null +++ b/Help/module/FindPackageMessage.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPackageMessage.cmake diff --git a/Help/module/FindPerl.rst b/Help/module/FindPerl.rst new file mode 100644 index 0000000..098f4b5 --- /dev/null +++ b/Help/module/FindPerl.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPerl.cmake diff --git a/Help/module/FindPerlLibs.rst b/Help/module/FindPerlLibs.rst new file mode 100644 index 0000000..8d8bbab --- /dev/null +++ b/Help/module/FindPerlLibs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPerlLibs.cmake diff --git a/Help/module/FindPhysFS.rst b/Help/module/FindPhysFS.rst new file mode 100644 index 0000000..21d928b --- /dev/null +++ b/Help/module/FindPhysFS.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPhysFS.cmake diff --git a/Help/module/FindPike.rst b/Help/module/FindPike.rst new file mode 100644 index 0000000..b096ca4 --- /dev/null +++ b/Help/module/FindPike.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPike.cmake diff --git a/Help/module/FindPkgConfig.rst b/Help/module/FindPkgConfig.rst new file mode 100644 index 0000000..b8caf74 --- /dev/null +++ b/Help/module/FindPkgConfig.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPkgConfig.cmake diff --git a/Help/module/FindPostgreSQL.rst b/Help/module/FindPostgreSQL.rst new file mode 100644 index 0000000..b45c07e --- /dev/null +++ b/Help/module/FindPostgreSQL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPostgreSQL.cmake diff --git a/Help/module/FindProducer.rst b/Help/module/FindProducer.rst new file mode 100644 index 0000000..1c0c575 --- /dev/null +++ b/Help/module/FindProducer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindProducer.cmake diff --git a/Help/module/FindProtobuf.rst b/Help/module/FindProtobuf.rst new file mode 100644 index 0000000..b978e01 --- /dev/null +++ b/Help/module/FindProtobuf.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindProtobuf.cmake diff --git a/Help/module/FindPythonInterp.rst b/Help/module/FindPythonInterp.rst new file mode 100644 index 0000000..3be2306 --- /dev/null +++ b/Help/module/FindPythonInterp.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPythonInterp.cmake diff --git a/Help/module/FindPythonLibs.rst b/Help/module/FindPythonLibs.rst new file mode 100644 index 0000000..8f0015d --- /dev/null +++ b/Help/module/FindPythonLibs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindPythonLibs.cmake diff --git a/Help/module/FindQt.rst b/Help/module/FindQt.rst new file mode 100644 index 0000000..3aa8a26 --- /dev/null +++ b/Help/module/FindQt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt.cmake diff --git a/Help/module/FindQt3.rst b/Help/module/FindQt3.rst new file mode 100644 index 0000000..b933059 --- /dev/null +++ b/Help/module/FindQt3.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt3.cmake diff --git a/Help/module/FindQt4.rst b/Help/module/FindQt4.rst new file mode 100644 index 0000000..28036b2 --- /dev/null +++ b/Help/module/FindQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQt4.cmake diff --git a/Help/module/FindQuickTime.rst b/Help/module/FindQuickTime.rst new file mode 100644 index 0000000..735f7d2 --- /dev/null +++ b/Help/module/FindQuickTime.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindQuickTime.cmake diff --git a/Help/module/FindRTI.rst b/Help/module/FindRTI.rst new file mode 100644 index 0000000..a93ad16 --- /dev/null +++ b/Help/module/FindRTI.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindRTI.cmake diff --git a/Help/module/FindRuby.rst b/Help/module/FindRuby.rst new file mode 100644 index 0000000..a1e7922 --- /dev/null +++ b/Help/module/FindRuby.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindRuby.cmake diff --git a/Help/module/FindSDL.rst b/Help/module/FindSDL.rst new file mode 100644 index 0000000..79893c0 --- /dev/null +++ b/Help/module/FindSDL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL.cmake diff --git a/Help/module/FindSDL_image.rst b/Help/module/FindSDL_image.rst new file mode 100644 index 0000000..dc69d70 --- /dev/null +++ b/Help/module/FindSDL_image.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_image.cmake diff --git a/Help/module/FindSDL_mixer.rst b/Help/module/FindSDL_mixer.rst new file mode 100644 index 0000000..1c9c446 --- /dev/null +++ b/Help/module/FindSDL_mixer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_mixer.cmake diff --git a/Help/module/FindSDL_net.rst b/Help/module/FindSDL_net.rst new file mode 100644 index 0000000..079d0bb --- /dev/null +++ b/Help/module/FindSDL_net.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_net.cmake diff --git a/Help/module/FindSDL_sound.rst b/Help/module/FindSDL_sound.rst new file mode 100644 index 0000000..077edf7 --- /dev/null +++ b/Help/module/FindSDL_sound.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_sound.cmake diff --git a/Help/module/FindSDL_ttf.rst b/Help/module/FindSDL_ttf.rst new file mode 100644 index 0000000..40c5ec4 --- /dev/null +++ b/Help/module/FindSDL_ttf.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSDL_ttf.cmake diff --git a/Help/module/FindSWIG.rst b/Help/module/FindSWIG.rst new file mode 100644 index 0000000..9b25b94 --- /dev/null +++ b/Help/module/FindSWIG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSWIG.cmake diff --git a/Help/module/FindSelfPackers.rst b/Help/module/FindSelfPackers.rst new file mode 100644 index 0000000..5f2c689 --- /dev/null +++ b/Help/module/FindSelfPackers.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSelfPackers.cmake diff --git a/Help/module/FindSquish.rst b/Help/module/FindSquish.rst new file mode 100644 index 0000000..dc2c86d --- /dev/null +++ b/Help/module/FindSquish.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSquish.cmake diff --git a/Help/module/FindSubversion.rst b/Help/module/FindSubversion.rst new file mode 100644 index 0000000..aa15857 --- /dev/null +++ b/Help/module/FindSubversion.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindSubversion.cmake diff --git a/Help/module/FindTCL.rst b/Help/module/FindTCL.rst new file mode 100644 index 0000000..cbd2035 --- /dev/null +++ b/Help/module/FindTCL.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTCL.cmake diff --git a/Help/module/FindTIFF.rst b/Help/module/FindTIFF.rst new file mode 100644 index 0000000..69f8ca5 --- /dev/null +++ b/Help/module/FindTIFF.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTIFF.cmake diff --git a/Help/module/FindTclStub.rst b/Help/module/FindTclStub.rst new file mode 100644 index 0000000..6cc5b2d --- /dev/null +++ b/Help/module/FindTclStub.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTclStub.cmake diff --git a/Help/module/FindTclsh.rst b/Help/module/FindTclsh.rst new file mode 100644 index 0000000..23e7d6b --- /dev/null +++ b/Help/module/FindTclsh.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindTclsh.cmake diff --git a/Help/module/FindThreads.rst b/Help/module/FindThreads.rst new file mode 100644 index 0000000..91967a7 --- /dev/null +++ b/Help/module/FindThreads.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindThreads.cmake diff --git a/Help/module/FindUnixCommands.rst b/Help/module/FindUnixCommands.rst new file mode 100644 index 0000000..9ad05ad --- /dev/null +++ b/Help/module/FindUnixCommands.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindUnixCommands.cmake diff --git a/Help/module/FindVTK.rst b/Help/module/FindVTK.rst new file mode 100644 index 0000000..f9c1efe --- /dev/null +++ b/Help/module/FindVTK.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindVTK.cmake diff --git a/Help/module/FindWget.rst b/Help/module/FindWget.rst new file mode 100644 index 0000000..06affd4 --- /dev/null +++ b/Help/module/FindWget.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindWget.cmake diff --git a/Help/module/FindWish.rst b/Help/module/FindWish.rst new file mode 100644 index 0000000..76be4cf --- /dev/null +++ b/Help/module/FindWish.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindWish.cmake diff --git a/Help/module/FindX11.rst b/Help/module/FindX11.rst new file mode 100644 index 0000000..906efd7 --- /dev/null +++ b/Help/module/FindX11.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindX11.cmake diff --git a/Help/module/FindXMLRPC.rst b/Help/module/FindXMLRPC.rst new file mode 100644 index 0000000..5d11a0c --- /dev/null +++ b/Help/module/FindXMLRPC.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindXMLRPC.cmake diff --git a/Help/module/FindZLIB.rst b/Help/module/FindZLIB.rst new file mode 100644 index 0000000..ded8634 --- /dev/null +++ b/Help/module/FindZLIB.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindZLIB.cmake diff --git a/Help/module/Findosg.rst b/Help/module/Findosg.rst new file mode 100644 index 0000000..6b407ac --- /dev/null +++ b/Help/module/Findosg.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Findosg.cmake diff --git a/Help/module/FindosgAnimation.rst b/Help/module/FindosgAnimation.rst new file mode 100644 index 0000000..f14a1e7 --- /dev/null +++ b/Help/module/FindosgAnimation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgAnimation.cmake diff --git a/Help/module/FindosgDB.rst b/Help/module/FindosgDB.rst new file mode 100644 index 0000000..9f72bc7 --- /dev/null +++ b/Help/module/FindosgDB.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgDB.cmake diff --git a/Help/module/FindosgFX.rst b/Help/module/FindosgFX.rst new file mode 100644 index 0000000..0e1edfb --- /dev/null +++ b/Help/module/FindosgFX.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgFX.cmake diff --git a/Help/module/FindosgGA.rst b/Help/module/FindosgGA.rst new file mode 100644 index 0000000..562d73f --- /dev/null +++ b/Help/module/FindosgGA.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgGA.cmake diff --git a/Help/module/FindosgIntrospection.rst b/Help/module/FindosgIntrospection.rst new file mode 100644 index 0000000..53621a7 --- /dev/null +++ b/Help/module/FindosgIntrospection.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgIntrospection.cmake diff --git a/Help/module/FindosgManipulator.rst b/Help/module/FindosgManipulator.rst new file mode 100644 index 0000000..b9d615d --- /dev/null +++ b/Help/module/FindosgManipulator.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgManipulator.cmake diff --git a/Help/module/FindosgParticle.rst b/Help/module/FindosgParticle.rst new file mode 100644 index 0000000..9cf191c --- /dev/null +++ b/Help/module/FindosgParticle.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgParticle.cmake diff --git a/Help/module/FindosgPresentation.rst b/Help/module/FindosgPresentation.rst new file mode 100644 index 0000000..cb47841 --- /dev/null +++ b/Help/module/FindosgPresentation.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgPresentation.cmake diff --git a/Help/module/FindosgProducer.rst b/Help/module/FindosgProducer.rst new file mode 100644 index 0000000..c502851 --- /dev/null +++ b/Help/module/FindosgProducer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgProducer.cmake diff --git a/Help/module/FindosgQt.rst b/Help/module/FindosgQt.rst new file mode 100644 index 0000000..08c8704 --- /dev/null +++ b/Help/module/FindosgQt.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgQt.cmake diff --git a/Help/module/FindosgShadow.rst b/Help/module/FindosgShadow.rst new file mode 100644 index 0000000..fbb22e1 --- /dev/null +++ b/Help/module/FindosgShadow.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgShadow.cmake diff --git a/Help/module/FindosgSim.rst b/Help/module/FindosgSim.rst new file mode 100644 index 0000000..9e47b65 --- /dev/null +++ b/Help/module/FindosgSim.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgSim.cmake diff --git a/Help/module/FindosgTerrain.rst b/Help/module/FindosgTerrain.rst new file mode 100644 index 0000000..dd401d8 --- /dev/null +++ b/Help/module/FindosgTerrain.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgTerrain.cmake diff --git a/Help/module/FindosgText.rst b/Help/module/FindosgText.rst new file mode 100644 index 0000000..bb028fb --- /dev/null +++ b/Help/module/FindosgText.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgText.cmake diff --git a/Help/module/FindosgUtil.rst b/Help/module/FindosgUtil.rst new file mode 100644 index 0000000..bb11bdf --- /dev/null +++ b/Help/module/FindosgUtil.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgUtil.cmake diff --git a/Help/module/FindosgViewer.rst b/Help/module/FindosgViewer.rst new file mode 100644 index 0000000..5def375 --- /dev/null +++ b/Help/module/FindosgViewer.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgViewer.cmake diff --git a/Help/module/FindosgVolume.rst b/Help/module/FindosgVolume.rst new file mode 100644 index 0000000..d836906 --- /dev/null +++ b/Help/module/FindosgVolume.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgVolume.cmake diff --git a/Help/module/FindosgWidget.rst b/Help/module/FindosgWidget.rst new file mode 100644 index 0000000..bdd1135 --- /dev/null +++ b/Help/module/FindosgWidget.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindosgWidget.cmake diff --git a/Help/module/Findosg_functions.rst b/Help/module/Findosg_functions.rst new file mode 100644 index 0000000..522e1ac --- /dev/null +++ b/Help/module/Findosg_functions.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Findosg_functions.cmake diff --git a/Help/module/FindwxWidgets.rst b/Help/module/FindwxWidgets.rst new file mode 100644 index 0000000..519beb7 --- /dev/null +++ b/Help/module/FindwxWidgets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindwxWidgets.cmake diff --git a/Help/module/FindwxWindows.rst b/Help/module/FindwxWindows.rst new file mode 100644 index 0000000..35c9728 --- /dev/null +++ b/Help/module/FindwxWindows.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FindwxWindows.cmake diff --git a/Help/module/FortranCInterface.rst b/Help/module/FortranCInterface.rst new file mode 100644 index 0000000..7afcf15 --- /dev/null +++ b/Help/module/FortranCInterface.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/FortranCInterface.cmake diff --git a/Help/module/GNUInstallDirs.rst b/Help/module/GNUInstallDirs.rst new file mode 100644 index 0000000..79d3570 --- /dev/null +++ b/Help/module/GNUInstallDirs.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GNUInstallDirs.cmake diff --git a/Help/module/GenerateExportHeader.rst b/Help/module/GenerateExportHeader.rst new file mode 100644 index 0000000..115713e --- /dev/null +++ b/Help/module/GenerateExportHeader.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GenerateExportHeader.cmake diff --git a/Help/module/GetPrerequisites.rst b/Help/module/GetPrerequisites.rst new file mode 100644 index 0000000..84b20c8 --- /dev/null +++ b/Help/module/GetPrerequisites.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/GetPrerequisites.cmake diff --git a/Help/module/InstallRequiredSystemLibraries.rst b/Help/module/InstallRequiredSystemLibraries.rst new file mode 100644 index 0000000..5ea9af3 --- /dev/null +++ b/Help/module/InstallRequiredSystemLibraries.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/InstallRequiredSystemLibraries.cmake diff --git a/Help/module/MacroAddFileDependencies.rst b/Help/module/MacroAddFileDependencies.rst new file mode 100644 index 0000000..5f0bf6b --- /dev/null +++ b/Help/module/MacroAddFileDependencies.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/MacroAddFileDependencies.cmake diff --git a/Help/module/ProcessorCount.rst b/Help/module/ProcessorCount.rst new file mode 100644 index 0000000..0149d09 --- /dev/null +++ b/Help/module/ProcessorCount.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/ProcessorCount.cmake diff --git a/Help/module/Qt4ConfigDependentSettings.rst b/Help/module/Qt4ConfigDependentSettings.rst new file mode 100644 index 0000000..7002f53 --- /dev/null +++ b/Help/module/Qt4ConfigDependentSettings.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Qt4ConfigDependentSettings.cmake diff --git a/Help/module/Qt4Macros.rst b/Help/module/Qt4Macros.rst new file mode 100644 index 0000000..6448d53 --- /dev/null +++ b/Help/module/Qt4Macros.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Qt4Macros.cmake diff --git a/Help/module/SelectLibraryConfigurations.rst b/Help/module/SelectLibraryConfigurations.rst new file mode 100644 index 0000000..14fd6f8 --- /dev/null +++ b/Help/module/SelectLibraryConfigurations.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/SelectLibraryConfigurations.cmake diff --git a/Help/module/SquishTestScript.rst b/Help/module/SquishTestScript.rst new file mode 100644 index 0000000..47da404 --- /dev/null +++ b/Help/module/SquishTestScript.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/SquishTestScript.cmake diff --git a/Help/module/TestBigEndian.rst b/Help/module/TestBigEndian.rst new file mode 100644 index 0000000..f9e4d2f --- /dev/null +++ b/Help/module/TestBigEndian.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestBigEndian.cmake diff --git a/Help/module/TestCXXAcceptsFlag.rst b/Help/module/TestCXXAcceptsFlag.rst new file mode 100644 index 0000000..ee3d70a --- /dev/null +++ b/Help/module/TestCXXAcceptsFlag.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestCXXAcceptsFlag.cmake diff --git a/Help/module/TestForANSIForScope.rst b/Help/module/TestForANSIForScope.rst new file mode 100644 index 0000000..00d9238 --- /dev/null +++ b/Help/module/TestForANSIForScope.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForANSIForScope.cmake diff --git a/Help/module/TestForANSIStreamHeaders.rst b/Help/module/TestForANSIStreamHeaders.rst new file mode 100644 index 0000000..212a30b --- /dev/null +++ b/Help/module/TestForANSIStreamHeaders.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForANSIStreamHeaders.cmake diff --git a/Help/module/TestForSSTREAM.rst b/Help/module/TestForSSTREAM.rst new file mode 100644 index 0000000..d154751 --- /dev/null +++ b/Help/module/TestForSSTREAM.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForSSTREAM.cmake diff --git a/Help/module/TestForSTDNamespace.rst b/Help/module/TestForSTDNamespace.rst new file mode 100644 index 0000000..ad989e3 --- /dev/null +++ b/Help/module/TestForSTDNamespace.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/TestForSTDNamespace.cmake diff --git a/Help/module/UseEcos.rst b/Help/module/UseEcos.rst new file mode 100644 index 0000000..0e57868 --- /dev/null +++ b/Help/module/UseEcos.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseEcos.cmake diff --git a/Help/module/UseJava.rst b/Help/module/UseJava.rst new file mode 100644 index 0000000..fa2f1bd --- /dev/null +++ b/Help/module/UseJava.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJava.cmake diff --git a/Help/module/UseJavaClassFilelist.rst b/Help/module/UseJavaClassFilelist.rst new file mode 100644 index 0000000..b9cd476 --- /dev/null +++ b/Help/module/UseJavaClassFilelist.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJavaClassFilelist.cmake diff --git a/Help/module/UseJavaSymlinks.rst b/Help/module/UseJavaSymlinks.rst new file mode 100644 index 0000000..2fab8e8 --- /dev/null +++ b/Help/module/UseJavaSymlinks.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseJavaSymlinks.cmake diff --git a/Help/module/UsePkgConfig.rst b/Help/module/UsePkgConfig.rst new file mode 100644 index 0000000..668f766 --- /dev/null +++ b/Help/module/UsePkgConfig.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UsePkgConfig.cmake diff --git a/Help/module/UseQt4.rst b/Help/module/UseQt4.rst new file mode 100644 index 0000000..c2f2ea8 --- /dev/null +++ b/Help/module/UseQt4.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseQt4.cmake diff --git a/Help/module/UseSWIG.rst b/Help/module/UseSWIG.rst new file mode 100644 index 0000000..0007c35 --- /dev/null +++ b/Help/module/UseSWIG.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UseSWIG.cmake diff --git a/Help/module/Use_wxWindows.rst b/Help/module/Use_wxWindows.rst new file mode 100644 index 0000000..a489e98 --- /dev/null +++ b/Help/module/Use_wxWindows.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/Use_wxWindows.cmake diff --git a/Help/module/UsewxWidgets.rst b/Help/module/UsewxWidgets.rst new file mode 100644 index 0000000..6829c2d --- /dev/null +++ b/Help/module/UsewxWidgets.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/UsewxWidgets.cmake diff --git a/Help/module/WriteBasicConfigVersionFile.rst b/Help/module/WriteBasicConfigVersionFile.rst new file mode 100644 index 0000000..c637d5d --- /dev/null +++ b/Help/module/WriteBasicConfigVersionFile.rst @@ -0,0 +1 @@ +.. cmake-module:: ../../Modules/WriteBasicConfigVersionFile.cmake diff --git a/Help/policy/CMP0000.rst b/Help/policy/CMP0000.rst new file mode 100644 index 0000000..9fbf842 --- /dev/null +++ b/Help/policy/CMP0000.rst @@ -0,0 +1,30 @@ +CMP0000 +------- + +A minimum required CMake version must be specified. + +CMake requires that projects specify the version of CMake to which +they have been written. This policy has been put in place so users +trying to build the project may be told when they need to update their +CMake. Specifying a version also helps the project build with CMake +versions newer than that specified. Use the cmake_minimum_required +command at the top of your main CMakeLists.txt file: + +:: + + cmake_minimum_required(VERSION <major>.<minor>) + +where "<major>.<minor>" is the version of CMake you want to support +(such as "2.6"). The command will ensure that at least the given +version of CMake is running and help newer versions be compatible with +the project. See documentation of cmake_minimum_required for details. + +Note that the command invocation must appear in the CMakeLists.txt +file itself; a call in an included file is not sufficient. However, +the cmake_policy command may be called to set policy CMP0000 to OLD or +NEW behavior explicitly. The OLD behavior is to silently ignore the +missing invocation. The NEW behavior is to issue an error instead of +a warning. An included file may set CMP0000 explicitly to affect how +this policy is enforced for the main CMakeLists.txt file. + +This policy was introduced in CMake version 2.6.0. diff --git a/Help/policy/CMP0001.rst b/Help/policy/CMP0001.rst new file mode 100644 index 0000000..344f1e2 --- /dev/null +++ b/Help/policy/CMP0001.rst @@ -0,0 +1,19 @@ +CMP0001 +------- + +CMAKE_BACKWARDS_COMPATIBILITY should no longer be used. + +The OLD behavior is to check CMAKE_BACKWARDS_COMPATIBILITY and present +it to the user. The NEW behavior is to ignore +CMAKE_BACKWARDS_COMPATIBILITY completely. + +In CMake 2.4 and below the variable CMAKE_BACKWARDS_COMPATIBILITY was +used to request compatibility with earlier versions of CMake. In +CMake 2.6 and above all compatibility issues are handled by policies +and the cmake_policy command. However, CMake must still check +CMAKE_BACKWARDS_COMPATIBILITY for projects written for CMake 2.4 and +below. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0002.rst b/Help/policy/CMP0002.rst new file mode 100644 index 0000000..2c15bd4 --- /dev/null +++ b/Help/policy/CMP0002.rst @@ -0,0 +1,26 @@ +CMP0002 +------- + +Logical target names must be globally unique. + +Targets names created with add_executable, add_library, or +add_custom_target are logical build target names. Logical target +names must be globally unique because: + +:: + + - Unique names may be referenced unambiguously both in CMake + code and on make tool command lines. + - Logical names are used by Xcode and VS IDE generators + to produce meaningful project names for the targets. + +The logical name of executable and library targets does not have to +correspond to the physical file names built. Consider using the +OUTPUT_NAME target property to create two targets with the same +physical name while keeping logical names distinct. Custom targets +must simply have globally unique names (unless one uses the global +property ALLOW_DUPLICATE_CUSTOM_TARGETS with a Makefiles generator). + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0003.rst b/Help/policy/CMP0003.rst new file mode 100644 index 0000000..27b83f8 --- /dev/null +++ b/Help/policy/CMP0003.rst @@ -0,0 +1,102 @@ +CMP0003 +------- + +Libraries linked via full path no longer produce linker search paths. + +This policy affects how libraries whose full paths are NOT known are +found at link time, but was created due to a change in how CMake deals +with libraries whose full paths are known. Consider the code + +:: + + target_link_libraries(myexe /path/to/libA.so) + +CMake 2.4 and below implemented linking to libraries whose full paths +are known by splitting them on the link line into separate components +consisting of the linker search path and the library name. The +example code might have produced something like + +:: + + ... -L/path/to -lA ... + +in order to link to library A. An analysis was performed to order +multiple link directories such that the linker would find library A in +the desired location, but there are cases in which this does not work. +CMake versions 2.6 and above use the more reliable approach of passing +the full path to libraries directly to the linker in most cases. The +example code now produces something like + +:: + + ... /path/to/libA.so .... + +Unfortunately this change can break code like + +:: + + target_link_libraries(myexe /path/to/libA.so B) + +where "B" is meant to find "/path/to/libB.so". This code is wrong +because the user is asking the linker to find library B but has not +provided a linker search path (which may be added with the +link_directories command). However, with the old linking +implementation the code would work accidentally because the linker +search path added for library A allowed library B to be found. + +In order to support projects depending on linker search paths added by +linking to libraries with known full paths, the OLD behavior for this +policy will add the linker search paths even though they are not +needed for their own libraries. When this policy is set to OLD, CMake +will produce a link line such as + +:: + + ... -L/path/to /path/to/libA.so -lB ... + +which will allow library B to be found as it was previously. When +this policy is set to NEW, CMake will produce a link line such as + +:: + + ... /path/to/libA.so -lB ... + +which more accurately matches what the project specified. + +The setting for this policy used when generating the link line is that +in effect when the target is created by an add_executable or +add_library command. For the example described above, the code + +:: + + cmake_policy(SET CMP0003 OLD) # or cmake_policy(VERSION 2.4) + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so B) + +will work and suppress the warning for this policy. It may also be +updated to work with the corrected linking approach: + +:: + + cmake_policy(SET CMP0003 NEW) # or cmake_policy(VERSION 2.6) + link_directories(/path/to) # needed to find library B + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so B) + +Even better, library B may be specified with a full path: + +:: + + add_executable(myexe myexe.c) + target_link_libraries(myexe /path/to/libA.so /path/to/libB.so) + +When all items on the link line have known paths CMake does not check +this policy so it has no effect. + +Note that the warning for this policy will be issued for at most one +target. This avoids flooding users with messages for every target +when setting the policy once will probably fix all targets. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0004.rst b/Help/policy/CMP0004.rst new file mode 100644 index 0000000..80045f5 --- /dev/null +++ b/Help/policy/CMP0004.rst @@ -0,0 +1,23 @@ +CMP0004 +------- + +Libraries linked may not have leading or trailing whitespace. + +CMake versions 2.4 and below silently removed leading and trailing +whitespace from libraries linked with code like + +:: + + target_link_libraries(myexe " A ") + +This could lead to subtle errors in user projects. + +The OLD behavior for this policy is to silently remove leading and +trailing whitespace. The NEW behavior for this policy is to diagnose +the existence of such whitespace as an error. The setting for this +policy used when checking the library names is that in effect when the +target is created by an add_executable or add_library command. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0005.rst b/Help/policy/CMP0005.rst new file mode 100644 index 0000000..c11a9e6 --- /dev/null +++ b/Help/policy/CMP0005.rst @@ -0,0 +1,24 @@ +CMP0005 +------- + +Preprocessor definition values are now escaped automatically. + +This policy determines whether or not CMake should generate escaped +preprocessor definition values added via add_definitions. CMake +versions 2.4 and below assumed that only trivial values would be given +for macros in add_definitions calls. It did not attempt to escape +non-trivial values such as string literals in generated build rules. +CMake versions 2.6 and above support escaping of most values, but +cannot assume the user has not added escapes already in an attempt to +work around limitations in earlier versions. + +The OLD behavior for this policy is to place definition values given +to add_definitions directly in the generated build rules without +attempting to escape anything. The NEW behavior for this policy is to +generate correct escapes for all native build tools automatically. +See documentation of the COMPILE_DEFINITIONS target property for +limitations of the escaping implementation. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0006.rst b/Help/policy/CMP0006.rst new file mode 100644 index 0000000..8d1e5bd --- /dev/null +++ b/Help/policy/CMP0006.rst @@ -0,0 +1,22 @@ +CMP0006 +------- + +Installing MACOSX_BUNDLE targets requires a BUNDLE DESTINATION. + +This policy determines whether the install(TARGETS) command must be +given a BUNDLE DESTINATION when asked to install a target with the +MACOSX_BUNDLE property set. CMake 2.4 and below did not distinguish +application bundles from normal executables when installing targets. +CMake 2.6 provides a BUNDLE option to the install(TARGETS) command +that specifies rules specific to application bundles on the Mac. +Projects should use this option when installing a target with the +MACOSX_BUNDLE property set. + +The OLD behavior for this policy is to fall back to the RUNTIME +DESTINATION if a BUNDLE DESTINATION is not given. The NEW behavior +for this policy is to produce an error if a bundle target is installed +without a BUNDLE DESTINATION. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0007.rst b/Help/policy/CMP0007.rst new file mode 100644 index 0000000..f0d8c16 --- /dev/null +++ b/Help/policy/CMP0007.rst @@ -0,0 +1,15 @@ +CMP0007 +------- + +list command no longer ignores empty elements. + +This policy determines whether the list command will ignore empty +elements in the list. CMake 2.4 and below list commands ignored all +empty elements in the list. For example, a;b;;c would have length 3 +and not 4. The OLD behavior for this policy is to ignore empty list +elements. The NEW behavior for this policy is to correctly count +empty elements in a list. + +This policy was introduced in CMake version 2.6.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0008.rst b/Help/policy/CMP0008.rst new file mode 100644 index 0000000..b118ece --- /dev/null +++ b/Help/policy/CMP0008.rst @@ -0,0 +1,32 @@ +CMP0008 +------- + +Libraries linked by full-path must have a valid library file name. + +In CMake 2.4 and below it is possible to write code like + +:: + + target_link_libraries(myexe /full/path/to/somelib) + +where "somelib" is supposed to be a valid library file name such as +"libsomelib.a" or "somelib.lib". For Makefile generators this +produces an error at build time because the dependency on the full +path cannot be found. For VS IDE and Xcode generators this used to +work by accident because CMake would always split off the library +directory and ask the linker to search for the library by name +(-lsomelib or somelib.lib). Despite the failure with Makefiles, some +projects have code like this and build only with VS and/or Xcode. +This version of CMake prefers to pass the full path directly to the +native build tool, which will fail in this case because it does not +name a valid library file. + +This policy determines what to do with full paths that do not appear +to name a valid library file. The OLD behavior for this policy is to +split the library name from the path and ask the linker to search for +it. The NEW behavior for this policy is to trust the given path and +pass it directly to the native build tool unchanged. + +This policy was introduced in CMake version 2.6.1. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0009.rst b/Help/policy/CMP0009.rst new file mode 100644 index 0000000..481af1a --- /dev/null +++ b/Help/policy/CMP0009.rst @@ -0,0 +1,19 @@ +CMP0009 +------- + +FILE GLOB_RECURSE calls should not follow symlinks by default. + +In CMake 2.6.1 and below, FILE GLOB_RECURSE calls would follow through +symlinks, sometimes coming up with unexpectedly large result sets +because of symlinks to top level directories that contain hundreds of +thousands of files. + +This policy determines whether or not to follow symlinks encountered +during a FILE GLOB_RECURSE call. The OLD behavior for this policy is +to follow the symlinks. The NEW behavior for this policy is not to +follow the symlinks by default, but only if FOLLOW_SYMLINKS is given +as an additional argument to the FILE command. + +This policy was introduced in CMake version 2.6.2. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0010.rst b/Help/policy/CMP0010.rst new file mode 100644 index 0000000..01699e1 --- /dev/null +++ b/Help/policy/CMP0010.rst @@ -0,0 +1,15 @@ +CMP0010 +------- + +Bad variable reference syntax is an error. + +In CMake 2.6.2 and below, incorrect variable reference syntax such as +a missing close-brace ("${FOO") was reported but did not stop +processing of CMake code. This policy determines whether a bad +variable reference is an error. The OLD behavior for this policy is +to warn about the error, leave the string untouched, and continue. +The NEW behavior for this policy is to report an error. + +This policy was introduced in CMake version 2.6.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0011.rst b/Help/policy/CMP0011.rst new file mode 100644 index 0000000..0f41fff --- /dev/null +++ b/Help/policy/CMP0011.rst @@ -0,0 +1,22 @@ +CMP0011 +------- + +Included scripts do automatic cmake_policy PUSH and POP. + +In CMake 2.6.2 and below, CMake Policy settings in scripts loaded by +the include() and find_package() commands would affect the includer. +Explicit invocations of cmake_policy(PUSH) and cmake_policy(POP) were +required to isolate policy changes and protect the includer. While +some scripts intend to affect the policies of their includer, most do +not. In CMake 2.6.3 and above, include() and find_package() by +default PUSH and POP an entry on the policy stack around an included +script, but provide a NO_POLICY_SCOPE option to disable it. This +policy determines whether or not to imply NO_POLICY_SCOPE for +compatibility. The OLD behavior for this policy is to imply +NO_POLICY_SCOPE for include() and find_package() commands. The NEW +behavior for this policy is to allow the commands to do their default +cmake_policy PUSH and POP. + +This policy was introduced in CMake version 2.6.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0012.rst b/Help/policy/CMP0012.rst new file mode 100644 index 0000000..7a749bf --- /dev/null +++ b/Help/policy/CMP0012.rst @@ -0,0 +1,25 @@ +CMP0012 +------- + +if() recognizes numbers and boolean constants. + +In CMake versions 2.6.4 and lower the if() command implicitly +dereferenced arguments corresponding to variables, even those named +like numbers or boolean constants, except for 0 and 1. Numbers and +boolean constants such as true, false, yes, no, on, off, y, n, +notfound, ignore (all case insensitive) were recognized in some cases +but not all. For example, the code "if(TRUE)" might have evaluated as +false. Numbers such as 2 were recognized only in boolean expressions +like "if(NOT 2)" (leading to false) but not as a single-argument like +"if(2)" (also leading to false). Later versions of CMake prefer to +treat numbers and boolean constants literally, so they should not be +used as variable names. + +The OLD behavior for this policy is to implicitly dereference +variables named like numbers and boolean constants. The NEW behavior +for this policy is to recognize numbers and boolean constants without +dereferencing variables with such names. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0013.rst b/Help/policy/CMP0013.rst new file mode 100644 index 0000000..e99997b --- /dev/null +++ b/Help/policy/CMP0013.rst @@ -0,0 +1,19 @@ +CMP0013 +------- + +Duplicate binary directories are not allowed. + +CMake 2.6.3 and below silently permitted add_subdirectory() calls to +create the same binary directory multiple times. During build system +generation files would be written and then overwritten in the build +tree and could lead to strange behavior. CMake 2.6.4 and above +explicitly detect duplicate binary directories. CMake 2.6.4 always +considers this case an error. In CMake 2.8.0 and above this policy +determines whether or not the case is an error. The OLD behavior for +this policy is to allow duplicate binary directories. The NEW +behavior for this policy is to disallow duplicate binary directories +with an error. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0014.rst b/Help/policy/CMP0014.rst new file mode 100644 index 0000000..37178d1 --- /dev/null +++ b/Help/policy/CMP0014.rst @@ -0,0 +1,15 @@ +CMP0014 +------- + +Input directories must have CMakeLists.txt. + +CMake versions before 2.8 silently ignored missing CMakeLists.txt +files in directories referenced by add_subdirectory() or subdirs(), +treating them as if present but empty. In CMake 2.8.0 and above this +policy determines whether or not the case is an error. The OLD +behavior for this policy is to silently ignore the problem. The NEW +behavior for this policy is to report an error. + +This policy was introduced in CMake version 2.8.0. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0015.rst b/Help/policy/CMP0015.rst new file mode 100644 index 0000000..1b54979 --- /dev/null +++ b/Help/policy/CMP0015.rst @@ -0,0 +1,17 @@ +CMP0015 +------- + +link_directories() treats paths relative to the source dir. + +In CMake 2.8.0 and lower the link_directories() command passed +relative paths unchanged to the linker. In CMake 2.8.1 and above the +link_directories() command prefers to interpret relative paths with +respect to CMAKE_CURRENT_SOURCE_DIR, which is consistent with +include_directories() and other commands. The OLD behavior for this +policy is to use relative paths verbatim in the linker command. The +NEW behavior for this policy is to convert relative paths to absolute +paths by appending the relative path to CMAKE_CURRENT_SOURCE_DIR. + +This policy was introduced in CMake version 2.8.1. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0016.rst b/Help/policy/CMP0016.rst new file mode 100644 index 0000000..743b1a9 --- /dev/null +++ b/Help/policy/CMP0016.rst @@ -0,0 +1,13 @@ +CMP0016 +------- + +target_link_libraries() reports error if its only argument is not a target. + +In CMake 2.8.2 and lower the target_link_libraries() command silently +ignored if it was called with only one argument, and this argument +wasn't a valid target. In CMake 2.8.3 and above it reports an error +in this case. + +This policy was introduced in CMake version 2.8.3. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0017.rst b/Help/policy/CMP0017.rst new file mode 100644 index 0000000..c93e8b2 --- /dev/null +++ b/Help/policy/CMP0017.rst @@ -0,0 +1,19 @@ +CMP0017 +------- + +Prefer files from the CMake module directory when including from there. + +Starting with CMake 2.8.4, if a cmake-module shipped with CMake (i.e. +located in the CMake module directory) calls include() or +find_package(), the files located in the CMake module directory are +preferred over the files in CMAKE_MODULE_PATH. This makes sure that +the modules belonging to CMake always get those files included which +they expect, and against which they were developed and tested. In all +other cases, the files found in CMAKE_MODULE_PATH still take +precedence over the ones in the CMake module directory. The OLD +behaviour is to always prefer files from CMAKE_MODULE_PATH over files +from the CMake modules directory. + +This policy was introduced in CMake version 2.8.4. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0018.rst b/Help/policy/CMP0018.rst new file mode 100644 index 0000000..0f68267 --- /dev/null +++ b/Help/policy/CMP0018.rst @@ -0,0 +1,32 @@ +CMP0018 +------- + +Ignore CMAKE_SHARED_LIBRARY_<Lang>_FLAGS variable. + +CMake 2.8.8 and lower compiled sources in SHARED and MODULE libraries +using the value of the undocumented CMAKE_SHARED_LIBRARY_<Lang>_FLAGS +platform variable. The variable contained platform-specific flags +needed to compile objects for shared libraries. Typically it included +a flag such as -fPIC for position independent code but also included +other flags needed on certain platforms. CMake 2.8.9 and higher +prefer instead to use the POSITION_INDEPENDENT_CODE target property to +determine what targets should be position independent, and new +undocumented platform variables to select flags while ignoring +CMAKE_SHARED_LIBRARY_<Lang>_FLAGS completely. + +The default for either approach produces identical compilation flags, +but if a project modifies CMAKE_SHARED_LIBRARY_<Lang>_FLAGS from its +original value this policy determines which approach to use. + +The OLD behavior for this policy is to ignore the +POSITION_INDEPENDENT_CODE property for all targets and use the +modified value of CMAKE_SHARED_LIBRARY_<Lang>_FLAGS for SHARED and +MODULE libraries. + +The NEW behavior for this policy is to ignore +CMAKE_SHARED_LIBRARY_<Lang>_FLAGS whether it is modified or not and +honor the POSITION_INDEPENDENT_CODE target property. + +This policy was introduced in CMake version 2.8.9. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0019.rst b/Help/policy/CMP0019.rst new file mode 100644 index 0000000..2b37fa1 --- /dev/null +++ b/Help/policy/CMP0019.rst @@ -0,0 +1,20 @@ +CMP0019 +------- + +Do not re-expand variables in include and link information. + +CMake 2.8.10 and lower re-evaluated values given to the +include_directories, link_directories, and link_libraries commands to +expand any leftover variable references at the end of the +configuration step. This was for strict compatibility with VERY early +CMake versions because all variable references are now normally +evaluated during CMake language processing. CMake 2.8.11 and higher +prefer to skip the extra evaluation. + +The OLD behavior for this policy is to re-evaluate the values for +strict compatibility. The NEW behavior for this policy is to leave +the values untouched. + +This policy was introduced in CMake version 2.8.11. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0020.rst b/Help/policy/CMP0020.rst new file mode 100644 index 0000000..ad664b0 --- /dev/null +++ b/Help/policy/CMP0020.rst @@ -0,0 +1,25 @@ +CMP0020 +------- + +Automatically link Qt executables to qtmain target on Windows. + +CMake 2.8.10 and lower required users of Qt to always specify a link +dependency to the qtmain.lib static library manually on Windows. +CMake 2.8.11 gained the ability to evaluate generator expressions +while determining the link dependencies from IMPORTED targets. This +allows CMake itself to automatically link executables which link to Qt +to the qtmain.lib library when using IMPORTED Qt targets. For +applications already linking to qtmain.lib, this should have little +impact. For applications which supply their own alternative WinMain +implementation and for applications which use the QAxServer library, +this automatic linking will need to be disabled as per the +documentation. + +The OLD behavior for this policy is not to link executables to +qtmain.lib automatically when they link to the QtCore IMPORTEDtarget. +The NEW behavior for this policy is to link executables to qtmain.lib +automatically when they link to QtCore IMPORTED target. + +This policy was introduced in CMake version 2.8.11. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0021.rst b/Help/policy/CMP0021.rst new file mode 100644 index 0000000..3f5bd03 --- /dev/null +++ b/Help/policy/CMP0021.rst @@ -0,0 +1,18 @@ +CMP0021 +------- + +Fatal error on relative paths in INCLUDE_DIRECTORIES target property. + +CMake 2.8.10.2 and lower allowed the INCLUDE_DIRECTORIES target +property to contain relative paths. The base path for such relative +entries is not well defined. CMake 2.8.12 issues a FATAL_ERROR if the +INCLUDE_DIRECTORIES property contains a relative path. + +The OLD behavior for this policy is not to warn about relative paths +in the INCLUDE_DIRECTORIES target property. The NEW behavior for this +policy is to issue a FATAL_ERROR if INCLUDE_DIRECTORIES contains a +relative path. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0022.rst b/Help/policy/CMP0022.rst new file mode 100644 index 0000000..d068c55 --- /dev/null +++ b/Help/policy/CMP0022.rst @@ -0,0 +1,33 @@ +CMP0022 +------- + +INTERFACE_LINK_LIBRARIES defines the link interface. + +CMake 2.8.11 constructed the 'link interface' of a target from +properties matching ``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?``. +The modern way to specify config-sensitive content is to use generator +expressions and the ``IMPORTED_`` prefix makes uniform processing of the +link interface with generator expressions impossible. The +INTERFACE_LINK_LIBRARIES target property was introduced as a +replacement in CMake 2.8.12. This new property is named consistently +with the INTERFACE_COMPILE_DEFINITIONS, INTERFACE_INCLUDE_DIRECTORIES +and INTERFACE_COMPILE_OPTIONS properties. For in-build targets, CMake +will use the INTERFACE_LINK_LIBRARIES property as the source of the +link interface only if policy CMP0022 is NEW. When exporting a target +which has this policy set to NEW, only the INTERFACE_LINK_LIBRARIES +property will be processed and generated for the IMPORTED target by +default. A new option to the install(EXPORT) and export commands +allows export of the old-style properties for compatibility with +downstream users of CMake versions older than 2.8.12. The +target_link_libraries command will no longer populate the properties +matching LINK_INTERFACE_LIBRARIES(_<CONFIG>)? if this policy is NEW. + +The OLD behavior for this policy is to ignore the +INTERFACE_LINK_LIBRARIES property for in-build targets. The NEW +behavior for this policy is to use the INTERFACE_LINK_LIBRARIES +property for in-build targets, and ignore the old properties matching +``(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)?``. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0023.rst b/Help/policy/CMP0023.rst new file mode 100644 index 0000000..962b624 --- /dev/null +++ b/Help/policy/CMP0023.rst @@ -0,0 +1,33 @@ +CMP0023 +------- + +Plain and keyword target_link_libraries signatures cannot be mixed. + +CMake 2.8.12 introduced the target_link_libraries signature using the +PUBLIC, PRIVATE, and INTERFACE keywords to generalize the LINK_PUBLIC +and LINK_PRIVATE keywords introduced in CMake 2.8.7. Use of +signatures with any of these keywords sets the link interface of a +target explicitly, even if empty. This produces confusing behavior +when used in combination with the historical behavior of the plain +target_link_libraries signature. For example, consider the code: + +:: + + target_link_libraries(mylib A) + target_link_libraries(mylib PRIVATE B) + +After the first line the link interface has not been set explicitly so +CMake would use the link implementation, A, as the link interface. +However, the second line sets the link interface to empty. In order +to avoid this subtle behavior CMake now prefers to disallow mixing the +plain and keyword signatures of target_link_libraries for a single +target. + +The OLD behavior for this policy is to allow keyword and plain +target_link_libraries signatures to be mixed. The NEW behavior for +this policy is to not to allow mixing of the keyword and plain +signatures. + +This policy was introduced in CMake version 2.8.12. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0024.rst b/Help/policy/CMP0024.rst new file mode 100644 index 0000000..ce0b2e6 --- /dev/null +++ b/Help/policy/CMP0024.rst @@ -0,0 +1,22 @@ +CMP0024 +------- + +Disallow include export result. + +CMake 2.8.12 and lower allowed use of the include() command with the +result of the export() command. This relies on the assumption that +the export() command has an immediate effect at configure-time during +a cmake run. Certain properties of targets are not fully determined +until later at generate-time, such as the link language and complete +list of link libraries. Future refactoring will change the effect of +the export() command to be executed at generate-time. Use ALIAS +targets instead in cases where the goal is to refer to targets by +another name + +The OLD behavior for this policy is to allow including the result of +an export() command. The NEW behavior for this policy is to not to +allow including the result of an export() command. + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0025.rst b/Help/policy/CMP0025.rst new file mode 100644 index 0000000..25957e9 --- /dev/null +++ b/Help/policy/CMP0025.rst @@ -0,0 +1,21 @@ +CMP0025 +------- + +Compiler id for Apple Clang is now AppleClang. + +CMake >= 2.8.13 recognize that Apple Clang is a different compiler +than upstream Clang and that they have different version numbers. +CMake now prefers to present this to projects by setting +CMAKE_<LANG>_COMPILER_ID to "AppleClang" instead of "Clang". However, +existing projects may assume the compiler id for Apple Clang is just +"Clang" as it was in CMake < 2.8.13. Therefore this policy determines +for Apple Clang which compiler id to report in +CMAKE_<LANG>_COMPILER_ID after <LANG> is enabled by the project() or +enable_language() command. + +The OLD behavior for this policy is to use compiler id "Clang". The +NEW behavior for this policy is to use compiler id "AppleClang". + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/policy/CMP0026.rst b/Help/policy/CMP0026.rst new file mode 100644 index 0000000..585da56 --- /dev/null +++ b/Help/policy/CMP0026.rst @@ -0,0 +1,25 @@ +CMP0026 +------- + +Disallow use of the LOCATION target property. + +CMake 2.8.12 and lower allowed reading the LOCATION target property to +determine the eventual location of build targets. This relies on the +assumption that all necessary information is available at +configure-time to determine the final location and filename of the +target. However, this property is not fully determined until later at +generate-time. At generate time, the $<TARGET_FILE> generator +expression can be used to determine the eventual LOCATION of a target +output. + +Code which reads the LOCATION target property can be ported to use the +$<TARGET_FILE> generator expression together with the file(GENERATE) +subcommand to generate a file containing the target location. + +The OLD behavior for this policy is to allow reading the LOCATION +property from build-targets. The NEW behavior for this policy is to +not to allow reading the LOCATION property from build-targets. + +This policy was introduced in CMake version 2.8.13. CMake version +|release| warns when the policy is not set and uses OLD behavior. Use +the cmake_policy command to set it to OLD or NEW explicitly. diff --git a/Help/prop_cache/ADVANCED.rst b/Help/prop_cache/ADVANCED.rst new file mode 100644 index 0000000..a0a4f73 --- /dev/null +++ b/Help/prop_cache/ADVANCED.rst @@ -0,0 +1,8 @@ +ADVANCED +-------- + +True if entry should be hidden by default in GUIs. + +This is a boolean value indicating whether the entry is considered +interesting only for advanced configuration. The mark_as_advanced() +command modifies this property. diff --git a/Help/prop_cache/HELPSTRING.rst b/Help/prop_cache/HELPSTRING.rst new file mode 100644 index 0000000..71a86d0 --- /dev/null +++ b/Help/prop_cache/HELPSTRING.rst @@ -0,0 +1,7 @@ +HELPSTRING +---------- + +Help associated with entry in GUIs. + +This string summarizes the purpose of an entry to help users set it +through a CMake GUI. diff --git a/Help/prop_cache/MODIFIED.rst b/Help/prop_cache/MODIFIED.rst new file mode 100644 index 0000000..3ad7035 --- /dev/null +++ b/Help/prop_cache/MODIFIED.rst @@ -0,0 +1,7 @@ +MODIFIED +-------- + +Internal management property. Do not set or get. + +This is an internal cache entry property managed by CMake to track +interactive user modification of entries. Ignore it. diff --git a/Help/prop_cache/STRINGS.rst b/Help/prop_cache/STRINGS.rst new file mode 100644 index 0000000..2f8e32e --- /dev/null +++ b/Help/prop_cache/STRINGS.rst @@ -0,0 +1,9 @@ +STRINGS +------- + +Enumerate possible STRING entry values for GUI selection. + +For cache entries with type STRING, this enumerates a set of values. +CMake GUIs may use this to provide a selection widget instead of a +generic string entry field. This is for convenience only. CMake does +not enforce that the value matches one of those listed. diff --git a/Help/prop_cache/TYPE.rst b/Help/prop_cache/TYPE.rst new file mode 100644 index 0000000..eb75c2a --- /dev/null +++ b/Help/prop_cache/TYPE.rst @@ -0,0 +1,21 @@ +TYPE +---- + +Widget type for entry in GUIs. + +Cache entry values are always strings, but CMake GUIs present widgets +to help users set values. The GUIs use this property as a hint to +determine the widget type. Valid TYPE values are: + +:: + + BOOL = Boolean ON/OFF value. + PATH = Path to a directory. + FILEPATH = Path to a file. + STRING = Generic string value. + INTERNAL = Do not present in GUI at all. + STATIC = Value managed by CMake, do not change. + UNINITIALIZED = Type not yet specified. + +Generally the TYPE of a cache entry should be set by the command which +creates it (set, option, find_library, etc.). diff --git a/Help/prop_cache/VALUE.rst b/Help/prop_cache/VALUE.rst new file mode 100644 index 0000000..59aabd4 --- /dev/null +++ b/Help/prop_cache/VALUE.rst @@ -0,0 +1,7 @@ +VALUE +----- + +Value of a cache entry. + +This property maps to the actual value of a cache entry. Setting this +property always sets the value without checking, so use with care. diff --git a/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst new file mode 100644 index 0000000..e32eed3 --- /dev/null +++ b/Help/prop_dir/ADDITIONAL_MAKE_CLEAN_FILES.rst @@ -0,0 +1,7 @@ +ADDITIONAL_MAKE_CLEAN_FILES +--------------------------- + +Additional files to clean during the make clean stage. + +A list of files that will be cleaned as a part of the "make clean" +stage. diff --git a/Help/prop_dir/CACHE_VARIABLES.rst b/Help/prop_dir/CACHE_VARIABLES.rst new file mode 100644 index 0000000..2c66f93 --- /dev/null +++ b/Help/prop_dir/CACHE_VARIABLES.rst @@ -0,0 +1,7 @@ +CACHE_VARIABLES +--------------- + +List of cache variables available in the current directory. + +This read-only property specifies the list of CMake cache variables +currently defined. It is intended for debugging purposes. diff --git a/Help/prop_dir/CLEAN_NO_CUSTOM.rst b/Help/prop_dir/CLEAN_NO_CUSTOM.rst new file mode 100644 index 0000000..9a4173e --- /dev/null +++ b/Help/prop_dir/CLEAN_NO_CUSTOM.rst @@ -0,0 +1,7 @@ +CLEAN_NO_CUSTOM +--------------- + +Should the output of custom commands be left. + +If this is true then the outputs of custom commands for this directory +will not be removed during the "make clean" stage. diff --git a/Help/prop_dir/COMPILE_DEFINITIONS.rst b/Help/prop_dir/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..290d612 --- /dev/null +++ b/Help/prop_dir/COMPILE_DEFINITIONS.rst @@ -0,0 +1,20 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a directory's sources. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). This property will be +initialized in each directory by its value in the directory's parent. + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt diff --git a/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..0876ddf --- /dev/null +++ b/Help/prop_dir/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,8 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions in a directory. + +This is the configuration-specific version of COMPILE_DEFINITIONS. +This property will be initialized in each directory by its value in +the directory's parent. diff --git a/Help/prop_dir/COMPILE_OPTIONS.rst b/Help/prop_dir/COMPILE_OPTIONS.rst new file mode 100644 index 0000000..e8d1b8a --- /dev/null +++ b/Help/prop_dir/COMPILE_OPTIONS.rst @@ -0,0 +1,14 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property specifies the list of directories given so far for this +property. This property exists on directories and targets. + +The target property values are used by the generators to set the +options for the compiler. + +Contents of COMPILE_OPTIONS may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_dir/DEFINITIONS.rst b/Help/prop_dir/DEFINITIONS.rst new file mode 100644 index 0000000..22f7c15 --- /dev/null +++ b/Help/prop_dir/DEFINITIONS.rst @@ -0,0 +1,8 @@ +DEFINITIONS +----------- + +For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead. + +This read-only property specifies the list of flags given so far to +the add_definitions command. It is intended for debugging purposes. +Use the COMPILE_DEFINITIONS instead. diff --git a/Help/prop_dir/EXCLUDE_FROM_ALL.rst b/Help/prop_dir/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000..1aa24e4 --- /dev/null +++ b/Help/prop_dir/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,9 @@ +EXCLUDE_FROM_ALL +---------------- + +Exclude the directory from the all target of its parent. + +A property on a directory that indicates if its targets are excluded +from the default build target. If it is not, then with a Makefile for +example typing make will cause the targets to be built. The same +concept applies to the default build of other generators. diff --git a/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000..993f620 --- /dev/null +++ b/Help/prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,34 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify #include line transforms for dependencies in a directory. + +This property specifies rules to transform macro-like #include lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +"A_MACRO(%)=value-with-%" (the % must be literal). During dependency +scanning occurrences of A_MACRO(...) on #include lines will be +replaced by the value given with the macro argument substituted for +'%'. For example, the entry + +:: + + MYDIR(%)=<mydir/%> + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include <mydir/myheader.h> + +allowing the dependency to be followed. + +This property applies to sources in all targets within a directory. +The property value is initialized in each directory by its value in +the directory's parent. diff --git a/Help/prop_dir/INCLUDE_DIRECTORIES.rst b/Help/prop_dir/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..6c5782f --- /dev/null +++ b/Help/prop_dir/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,18 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +include_directories command. This property exists on directories and +targets. In addition to accepting values from the include_directories +command, values may be set directly on any directory or any target +using the set_property command. A target gets its initial value for +this property from the value of the directory property. A directory +gets its initial value from its parent directory if it has one. Both +directory and target property values are adjusted by calls to the +include_directories command. + +The target property values are used by the generators to set the +include paths for the compiler. See also the include_directories +command. diff --git a/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst b/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..befafa5 --- /dev/null +++ b/Help/prop_dir/INCLUDE_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +INCLUDE_REGULAR_EXPRESSION +-------------------------- + +Include file scanning regular expression. + +This read-only property specifies the regular expression used during +dependency scanning to match include files that should be followed. +See the include_regular_expression command. diff --git a/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000..0c78dfb --- /dev/null +++ b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,7 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for targets in a directory. + +If set to true, enables interprocedural optimizations if they are +known to be supported by the compiler. diff --git a/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000..32520865 --- /dev/null +++ b/Help/prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,8 @@ +INTERPROCEDURAL_OPTIMIZATION_<CONFIG> +------------------------------------- + +Per-configuration interprocedural optimization for a directory. + +This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. +If set, this property overrides the generic property for the named +configuration. diff --git a/Help/prop_dir/LINK_DIRECTORIES.rst b/Help/prop_dir/LINK_DIRECTORIES.rst new file mode 100644 index 0000000..fa37576 --- /dev/null +++ b/Help/prop_dir/LINK_DIRECTORIES.rst @@ -0,0 +1,8 @@ +LINK_DIRECTORIES +---------------- + +List of linker search directories. + +This read-only property specifies the list of directories given so far +to the link_directories command. It is intended for debugging +purposes. diff --git a/Help/prop_dir/LISTFILE_STACK.rst b/Help/prop_dir/LISTFILE_STACK.rst new file mode 100644 index 0000000..f729c1e --- /dev/null +++ b/Help/prop_dir/LISTFILE_STACK.rst @@ -0,0 +1,9 @@ +LISTFILE_STACK +-------------- + +The current stack of listfiles being processed. + +This property is mainly useful when trying to debug errors in your +CMake scripts. It returns a list of what list files are currently +being processed, in order. So if one listfile does an INCLUDE command +then that is effectively pushing the included listfile onto the stack. diff --git a/Help/prop_dir/MACROS.rst b/Help/prop_dir/MACROS.rst new file mode 100644 index 0000000..e4feada --- /dev/null +++ b/Help/prop_dir/MACROS.rst @@ -0,0 +1,8 @@ +MACROS +------ + +List of macro commands available in the current directory. + +This read-only property specifies the list of CMake macros currently +defined. It is intended for debugging purposes. See the macro +command. diff --git a/Help/prop_dir/PARENT_DIRECTORY.rst b/Help/prop_dir/PARENT_DIRECTORY.rst new file mode 100644 index 0000000..3bc5824 --- /dev/null +++ b/Help/prop_dir/PARENT_DIRECTORY.rst @@ -0,0 +1,8 @@ +PARENT_DIRECTORY +---------------- + +Source directory that added current subdirectory. + +This read-only property specifies the source directory that added the +current source directory as a subdirectory of the build. In the +top-level directory the value is the empty-string. diff --git a/Help/prop_dir/RULE_LAUNCH_COMPILE.rst b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..342d0ae --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst b/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..93d1e01 --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/RULE_LAUNCH_LINK.rst b/Help/prop_dir/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..3cfb236 --- /dev/null +++ b/Help/prop_dir/RULE_LAUNCH_LINK.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +See the global property of the same name for details. This overrides +the global property for a directory. diff --git a/Help/prop_dir/TEST_INCLUDE_FILE.rst b/Help/prop_dir/TEST_INCLUDE_FILE.rst new file mode 100644 index 0000000..e477951 --- /dev/null +++ b/Help/prop_dir/TEST_INCLUDE_FILE.rst @@ -0,0 +1,7 @@ +TEST_INCLUDE_FILE +----------------- + +A cmake file that will be included when ctest is run. + +If you specify TEST_INCLUDE_FILE, that file will be included and +processed when ctest is run on the directory. diff --git a/Help/prop_dir/VARIABLES.rst b/Help/prop_dir/VARIABLES.rst new file mode 100644 index 0000000..0328295 --- /dev/null +++ b/Help/prop_dir/VARIABLES.rst @@ -0,0 +1,7 @@ +VARIABLES +--------- + +List of variables defined in the current directory. + +This read-only property specifies the list of CMake variables +currently defined. It is intended for debugging purposes. diff --git a/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst b/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst new file mode 100644 index 0000000..eb91832 --- /dev/null +++ b/Help/prop_dir/VS_GLOBAL_SECTION_POST_section.rst @@ -0,0 +1,29 @@ +VS_GLOBAL_SECTION_POST_<section> +-------------------------------- + +Specify a postSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(<section>) = postSolution + <contents based on property value> + EndGlobalSection + +The property must be set to a semicolon-separated list of key=value +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for Visual Studio 7 and above; it is ignored +on other generators. The property only applies when set on a +directory whose CMakeLists.txt contains a project() command. + +Note that CMake generates postSolution sections ExtensibilityGlobals +and ExtensibilityAddIns by default. If you set the corresponding +property, it will override the default section. For example, setting +VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default +contents of the ExtensibilityGlobals section, while keeping +ExtensibilityAddIns on its default. diff --git a/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst b/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst new file mode 100644 index 0000000..fbcd9e6 --- /dev/null +++ b/Help/prop_dir/VS_GLOBAL_SECTION_PRE_section.rst @@ -0,0 +1,22 @@ +VS_GLOBAL_SECTION_PRE_<section> +------------------------------- + +Specify a preSolution global section in Visual Studio. + +Setting a property like this generates an entry of the following form +in the solution file: + +:: + + GlobalSection(<section>) = preSolution + <contents based on property value> + EndGlobalSection + +The property must be set to a semicolon-separated list of key=value +pairs. Each such pair will be transformed into an entry in the +solution global section. Whitespace around key and value is ignored. +List elements which do not contain an equal sign are skipped. + +This property only works for Visual Studio 7 and above; it is ignored +on other generators. The property only applies when set on a +directory whose CMakeLists.txt contains a project() command. diff --git a/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst b/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst new file mode 100644 index 0000000..8fab503 --- /dev/null +++ b/Help/prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS.rst @@ -0,0 +1,19 @@ +ALLOW_DUPLICATE_CUSTOM_TARGETS +------------------------------ + +Allow duplicate custom targets to be created. + +Normally CMake requires that all targets built in a project have +globally unique logical names (see policy CMP0002). This is necessary +to generate meaningful project file names in Xcode and VS IDE +generators. It also allows the target names to be referenced +unambiguously. + +Makefile generators are capable of supporting duplicate custom target +names. For projects that care only about Makefile generators and do +not wish to support Xcode or VS IDE generators, one may set this +property to true to allow duplicate custom targets. The property +allows multiple add_custom_target command calls in different +directories to specify the same target name. However, setting this +property will cause non-Makefile generators to produce an error and +refuse to generate the project. diff --git a/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst new file mode 100644 index 0000000..c83fb8b --- /dev/null +++ b/Help/prop_gbl/AUTOMOC_TARGETS_FOLDER.rst @@ -0,0 +1,8 @@ +AUTOMOC_TARGETS_FOLDER +---------------------- + +Name of FOLDER for ``*_automoc`` targets that are added automatically by CMake for targets for which AUTOMOC is enabled. + +If not set, CMake uses the FOLDER property of the parent target as a +default value for this property. See also the documentation for the +FOLDER target property and the AUTOMOC target property. diff --git a/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst b/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst new file mode 100644 index 0000000..690143f --- /dev/null +++ b/Help/prop_gbl/DEBUG_CONFIGURATIONS.rst @@ -0,0 +1,14 @@ +DEBUG_CONFIGURATIONS +-------------------- + +Specify which configurations are for debugging. + +The value must be a semi-colon separated list of configuration names. +Currently this property is used only by the target_link_libraries +command (see its documentation for details). Additional uses may be +defined in the future. + +This property must be set at the top level of the project and before +the first target_link_libraries command invocation. If any entry in +the list does not match a valid configuration for the project the +behavior is undefined. diff --git a/Help/prop_gbl/DISABLED_FEATURES.rst b/Help/prop_gbl/DISABLED_FEATURES.rst new file mode 100644 index 0000000..111cdf6 --- /dev/null +++ b/Help/prop_gbl/DISABLED_FEATURES.rst @@ -0,0 +1,11 @@ +DISABLED_FEATURES +----------------- + +List of features which are disabled during the CMake run. + +List of features which are disabled during the CMake run. By default +it contains the names of all packages which were not found. This is +determined using the <NAME>_FOUND variables. Packages which are +searched QUIET are not listed. A project can add its own features to +this list. This property is used by the macros in +FeatureSummary.cmake. diff --git a/Help/prop_gbl/ENABLED_FEATURES.rst b/Help/prop_gbl/ENABLED_FEATURES.rst new file mode 100644 index 0000000..b03da5a --- /dev/null +++ b/Help/prop_gbl/ENABLED_FEATURES.rst @@ -0,0 +1,11 @@ +ENABLED_FEATURES +---------------- + +List of features which are enabled during the CMake run. + +List of features which are enabled during the CMake run. By default +it contains the names of all packages which were found. This is +determined using the <NAME>_FOUND variables. Packages which are +searched QUIET are not listed. A project can add its own features to +this list. This property is used by the macros in +FeatureSummary.cmake. diff --git a/Help/prop_gbl/ENABLED_LANGUAGES.rst b/Help/prop_gbl/ENABLED_LANGUAGES.rst new file mode 100644 index 0000000..43e3c09 --- /dev/null +++ b/Help/prop_gbl/ENABLED_LANGUAGES.rst @@ -0,0 +1,6 @@ +ENABLED_LANGUAGES +----------------- + +Read-only property that contains the list of currently enabled languages + +Set to list of currently enabled languages. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst new file mode 100644 index 0000000..185246c --- /dev/null +++ b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst @@ -0,0 +1,9 @@ +FIND_LIBRARY_USE_LIB64_PATHS +---------------------------- + +Whether FIND_LIBRARY should automatically search lib64 directories. + +FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the +FIND_LIBRARY command should automatically search the lib64 variant of +directories called lib in the search path when building 64-bit +binaries. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst new file mode 100644 index 0000000..9a3edd8 --- /dev/null +++ b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst @@ -0,0 +1,9 @@ +FIND_LIBRARY_USE_OPENBSD_VERSIONING +----------------------------------- + +Whether FIND_LIBRARY should find OpenBSD-style shared libraries. + +This property is a boolean specifying whether the FIND_LIBRARY command +should find shared libraries with OpenBSD-style versioned extension: +".so.<major>.<minor>". The property is set to true on OpenBSD and +false on other platforms. diff --git a/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst b/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst new file mode 100644 index 0000000..832503b --- /dev/null +++ b/Help/prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE.rst @@ -0,0 +1,8 @@ +GLOBAL_DEPENDS_DEBUG_MODE +------------------------- + +Enable global target dependency graph debug mode. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. This property +causes it to display details of its analysis to stderr. diff --git a/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst b/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst new file mode 100644 index 0000000..d10661e --- /dev/null +++ b/Help/prop_gbl/GLOBAL_DEPENDS_NO_CYCLES.rst @@ -0,0 +1,10 @@ +GLOBAL_DEPENDS_NO_CYCLES +------------------------ + +Disallow global target dependency graph cycles. + +CMake automatically analyzes the global inter-target dependency graph +at the beginning of native build system generation. It reports an +error if the dependency graph contains a cycle that does not consist +of all STATIC library targets. This property tells CMake to disallow +all cycles completely, even among static libraries. diff --git a/Help/prop_gbl/IN_TRY_COMPILE.rst b/Help/prop_gbl/IN_TRY_COMPILE.rst new file mode 100644 index 0000000..3a2ef5b --- /dev/null +++ b/Help/prop_gbl/IN_TRY_COMPILE.rst @@ -0,0 +1,6 @@ +IN_TRY_COMPILE +-------------- + +Read-only property that is true during a try-compile configuration. + +True when building a project inside a TRY_COMPILE or TRY_RUN command. diff --git a/Help/prop_gbl/PACKAGES_FOUND.rst b/Help/prop_gbl/PACKAGES_FOUND.rst new file mode 100644 index 0000000..61cce1f --- /dev/null +++ b/Help/prop_gbl/PACKAGES_FOUND.rst @@ -0,0 +1,7 @@ +PACKAGES_FOUND +-------------- + +List of packages which were found during the CMake run. + +List of packages which were found during the CMake run. Whether a +package has been found is determined using the <NAME>_FOUND variables. diff --git a/Help/prop_gbl/PACKAGES_NOT_FOUND.rst b/Help/prop_gbl/PACKAGES_NOT_FOUND.rst new file mode 100644 index 0000000..ca3c5ba --- /dev/null +++ b/Help/prop_gbl/PACKAGES_NOT_FOUND.rst @@ -0,0 +1,7 @@ +PACKAGES_NOT_FOUND +------------------ + +List of packages which were not found during the CMake run. + +List of packages which were not found during the CMake run. Whether a +package has been found is determined using the <NAME>_FOUND variables. diff --git a/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst new file mode 100644 index 0000000..e85b823 --- /dev/null +++ b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst @@ -0,0 +1,9 @@ +PREDEFINED_TARGETS_FOLDER +------------------------- + +Name of FOLDER for targets that are added automatically by CMake. + +If not set, CMake uses "CMakePredefinedTargets" as a default value for +this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be +organized into this FOLDER. See also the documentation for the FOLDER +target property. diff --git a/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst b/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst new file mode 100644 index 0000000..29ba365 --- /dev/null +++ b/Help/prop_gbl/REPORT_UNDEFINED_PROPERTIES.rst @@ -0,0 +1,8 @@ +REPORT_UNDEFINED_PROPERTIES +--------------------------- + +If set, report any undefined properties to this file. + +If this property is set to a filename then when CMake runs it will +report any properties or variables that were accessed but not defined +into the filename specified in this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..980843b --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +Makefile generators prefix compiler commands with the given launcher +command line. This is intended to allow launchers to intercept build +problems with high granularity. Non-Makefile generators currently +ignore this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst b/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..9d4a25c --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +Makefile generators prefix custom commands with the given launcher +command line. This is intended to allow launchers to intercept build +problems with high granularity. Non-Makefile generators currently +ignore this property. diff --git a/Help/prop_gbl/RULE_LAUNCH_LINK.rst b/Help/prop_gbl/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..191f1d5 --- /dev/null +++ b/Help/prop_gbl/RULE_LAUNCH_LINK.rst @@ -0,0 +1,9 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +Makefile generators prefix link and archive commands with the given +launcher command line. This is intended to allow launchers to +intercept build problems with high granularity. Non-Makefile +generators currently ignore this property. diff --git a/Help/prop_gbl/RULE_MESSAGES.rst b/Help/prop_gbl/RULE_MESSAGES.rst new file mode 100644 index 0000000..38d83a3 --- /dev/null +++ b/Help/prop_gbl/RULE_MESSAGES.rst @@ -0,0 +1,13 @@ +RULE_MESSAGES +------------- + +Specify whether to report a message for each make rule. + +This property specifies whether Makefile generators should add a +progress message describing what each build rule does. If the +property is not set the default is ON. Set the property to OFF to +disable granular messages and report only as each target completes. +This is intended to allow scripted builds to avoid the build time cost +of detailed reports. If a CMAKE_RULE_MESSAGES cache entry exists its +value initializes the value of this property. Non-Makefile generators +currently ignore this property. diff --git a/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst b/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst new file mode 100644 index 0000000..930feba --- /dev/null +++ b/Help/prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS.rst @@ -0,0 +1,7 @@ +TARGET_ARCHIVES_MAY_BE_SHARED_LIBS +---------------------------------- + +Set if shared libraries may be named like archives. + +On AIX shared libraries may be named "lib<name>.a". This property is +set to true on such platforms. diff --git a/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst b/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst new file mode 100644 index 0000000..f6e89fb --- /dev/null +++ b/Help/prop_gbl/TARGET_SUPPORTS_SHARED_LIBS.rst @@ -0,0 +1,9 @@ +TARGET_SUPPORTS_SHARED_LIBS +--------------------------- + +Does the target platform support shared libraries. + +TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target +platform supports shared libraries. Basically all current general +general purpose OS do so, the exception are usually embedded systems +with no or special OSs. diff --git a/Help/prop_gbl/USE_FOLDERS.rst b/Help/prop_gbl/USE_FOLDERS.rst new file mode 100644 index 0000000..fdbca9f --- /dev/null +++ b/Help/prop_gbl/USE_FOLDERS.rst @@ -0,0 +1,9 @@ +USE_FOLDERS +----------- + +Use the FOLDER target property to organize targets into folders. + +If not set, CMake treats this property as OFF by default. CMake +generators that are capable of organizing into a hierarchy of folders +use the values of the FOLDER target property to name those folders. +See also the documentation for the FOLDER target property. diff --git a/Help/prop_sf/ABSTRACT.rst b/Help/prop_sf/ABSTRACT.rst new file mode 100644 index 0000000..339d115 --- /dev/null +++ b/Help/prop_sf/ABSTRACT.rst @@ -0,0 +1,9 @@ +ABSTRACT +-------- + +Is this source file an abstract class. + +A property on a source file that indicates if the source file +represents a class that is abstract. This only makes sense for +languages that have a notion of an abstract class and it is only used +by some tools that wrap classes into other languages. diff --git a/Help/prop_sf/COMPILE_DEFINITIONS.rst b/Help/prop_sf/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..7f7e7c7 --- /dev/null +++ b/Help/prop_sf/COMPILE_DEFINITIONS.rst @@ -0,0 +1,20 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a source file. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). Xcode does not support +per-configuration definitions on source files. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt diff --git a/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..e695f38 --- /dev/null +++ b/Help/prop_sf/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,8 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions on a source file. + +This is the configuration-specific version of COMPILE_DEFINITIONS. +Note that Xcode does not support per-configuration source file flags +so this property will be ignored by the Xcode generator. diff --git a/Help/prop_sf/COMPILE_FLAGS.rst b/Help/prop_sf/COMPILE_FLAGS.rst new file mode 100644 index 0000000..daba502 --- /dev/null +++ b/Help/prop_sf/COMPILE_FLAGS.rst @@ -0,0 +1,8 @@ +COMPILE_FLAGS +------------- + +Additional flags to be added when compiling this source file. + +These flags will be added to the list of compile flags when this +source file builds. Use COMPILE_DEFINITIONS to pass additional +preprocessor definitions. diff --git a/Help/prop_sf/EXTERNAL_OBJECT.rst b/Help/prop_sf/EXTERNAL_OBJECT.rst new file mode 100644 index 0000000..efa0e9b --- /dev/null +++ b/Help/prop_sf/EXTERNAL_OBJECT.rst @@ -0,0 +1,8 @@ +EXTERNAL_OBJECT +--------------- + +If set to true then this is an object file. + +If this property is set to true then the source file is really an +object file and should not be compiled. It will still be linked into +the target though. diff --git a/Help/prop_sf/Fortran_FORMAT.rst b/Help/prop_sf/Fortran_FORMAT.rst new file mode 100644 index 0000000..69e34aa --- /dev/null +++ b/Help/prop_sf/Fortran_FORMAT.rst @@ -0,0 +1,9 @@ +Fortran_FORMAT +-------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This property tells CMake whether a given Fortran source file uses +fixed-format or free-format. CMake will pass the corresponding format +flag to the compiler. Consider using the target-wide Fortran_FORMAT +property if all source files in a target share the same format. diff --git a/Help/prop_sf/GENERATED.rst b/Help/prop_sf/GENERATED.rst new file mode 100644 index 0000000..a3aa127 --- /dev/null +++ b/Help/prop_sf/GENERATED.rst @@ -0,0 +1,8 @@ +GENERATED +--------- + +Is this source file generated as part of the build process. + +If a source file is generated by the build process CMake will handle +it differently in terms of dependency checking etc. Otherwise having +a non-existent source file could create problems. diff --git a/Help/prop_sf/HEADER_FILE_ONLY.rst b/Help/prop_sf/HEADER_FILE_ONLY.rst new file mode 100644 index 0000000..b4fb2db --- /dev/null +++ b/Help/prop_sf/HEADER_FILE_ONLY.rst @@ -0,0 +1,9 @@ +HEADER_FILE_ONLY +---------------- + +Is this source file only a header file. + +A property on a source file that indicates if the source file is a +header file with no associated implementation. This is set +automatically based on the file extension and is used by CMake to +determine if certain dependency information should be computed. diff --git a/Help/prop_sf/KEEP_EXTENSION.rst b/Help/prop_sf/KEEP_EXTENSION.rst new file mode 100644 index 0000000..d6167e5 --- /dev/null +++ b/Help/prop_sf/KEEP_EXTENSION.rst @@ -0,0 +1,9 @@ +KEEP_EXTENSION +-------------- + +Make the output file have the same extension as the source file. + +If this property is set then the file extension of the output file +will be the same as that of the source file. Normally the output file +extension is computed based on the language of the source file, for +example .cxx will go to a .o extension. diff --git a/Help/prop_sf/LABELS.rst b/Help/prop_sf/LABELS.rst new file mode 100644 index 0000000..e1c1069 --- /dev/null +++ b/Help/prop_sf/LABELS.rst @@ -0,0 +1,8 @@ +LABELS +------ + +Specify a list of text labels associated with a source file. + +This property has meaning only when the source file is listed in a +target whose LABELS property is also set. No other semantics are +currently specified. diff --git a/Help/prop_sf/LANGUAGE.rst b/Help/prop_sf/LANGUAGE.rst new file mode 100644 index 0000000..97bfa20 --- /dev/null +++ b/Help/prop_sf/LANGUAGE.rst @@ -0,0 +1,10 @@ +LANGUAGE +-------- + +What programming language is the file. + +A property that can be set to indicate what programming language the +source file is. If it is not set the language is determined based on +the file extension. Typical values are CXX C etc. Setting this +property for a file means this file will be compiled. Do not set this +for headers or files that should not be compiled. diff --git a/Help/prop_sf/LOCATION.rst b/Help/prop_sf/LOCATION.rst new file mode 100644 index 0000000..252d680 --- /dev/null +++ b/Help/prop_sf/LOCATION.rst @@ -0,0 +1,7 @@ +LOCATION +-------- + +The full path to a source file. + +A read only property on a SOURCE FILE that contains the full path to +the source file. diff --git a/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst b/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst new file mode 100644 index 0000000..27f2929 --- /dev/null +++ b/Help/prop_sf/MACOSX_PACKAGE_LOCATION.rst @@ -0,0 +1,19 @@ +MACOSX_PACKAGE_LOCATION +----------------------- + +Place a source file inside a Mac OS X bundle, CFBundle, or framework. + +Executable targets with the MACOSX_BUNDLE property set are built as +Mac OS X application bundles on Apple platforms. Shared library +targets with the FRAMEWORK property set are built as Mac OS X +frameworks on Apple platforms. Module library targets with the BUNDLE +property set are built as Mac OS X CFBundle bundles on Apple +platforms. Source files listed in the target with this property set +will be copied to a directory inside the bundle or framework content +folder specified by the property value. For bundles the content +folder is "<name>.app/Contents". For frameworks the content folder is +"<name>.framework/Versions/<version>". For cfbundles the content +folder is "<name>.bundle/Contents" (unless the extension is changed). +See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target properties +for specifying files meant for Headers, PrivateHeaders, or Resources +directories. diff --git a/Help/prop_sf/OBJECT_DEPENDS.rst b/Help/prop_sf/OBJECT_DEPENDS.rst new file mode 100644 index 0000000..18022de --- /dev/null +++ b/Help/prop_sf/OBJECT_DEPENDS.rst @@ -0,0 +1,18 @@ +OBJECT_DEPENDS +-------------- + +Additional files on which a compiled object file depends. + +Specifies a semicolon-separated list of full-paths to files on which +any object files compiled from this source file depend. An object +file will be recompiled if any of the named files is newer than it. + +This property need not be used to specify the dependency of a source +file on a generated header file that it includes. Although the +property was originally introduced for this purpose, it is no longer +necessary. If the generated header file is created by a custom +command in the same target as the source file, the automatic +dependency scanning process will recognize the dependency. If the +generated header file is created by another target, an inter-target +dependency should be created with the add_dependencies command (if one +does not already exist due to linking relationships). diff --git a/Help/prop_sf/OBJECT_OUTPUTS.rst b/Help/prop_sf/OBJECT_OUTPUTS.rst new file mode 100644 index 0000000..6a28553 --- /dev/null +++ b/Help/prop_sf/OBJECT_OUTPUTS.rst @@ -0,0 +1,9 @@ +OBJECT_OUTPUTS +-------------- + +Additional outputs for a Makefile rule. + +Additional outputs created by compilation of this source file. If any +of these outputs is missing the object will be recompiled. This is +supported only on Makefile generators and will be ignored on other +generators. diff --git a/Help/prop_sf/SYMBOLIC.rst b/Help/prop_sf/SYMBOLIC.rst new file mode 100644 index 0000000..c7d0b26 --- /dev/null +++ b/Help/prop_sf/SYMBOLIC.rst @@ -0,0 +1,8 @@ +SYMBOLIC +-------- + +Is this just a name for a rule. + +If SYMBOLIC (boolean) is set to true the build system will be informed +that the source file is not actually created on disk but instead used +as a symbolic name for a build rule. diff --git a/Help/prop_sf/WRAP_EXCLUDE.rst b/Help/prop_sf/WRAP_EXCLUDE.rst new file mode 100644 index 0000000..2c79f72 --- /dev/null +++ b/Help/prop_sf/WRAP_EXCLUDE.rst @@ -0,0 +1,10 @@ +WRAP_EXCLUDE +------------ + +Exclude this source file from any code wrapping techniques. + +Some packages can wrap source files into alternate languages to +provide additional functionality. For example, C++ code can be +wrapped into Java or Python etc using SWIG etc. If WRAP_EXCLUDE is +set to true (1 etc) that indicates that this source file should not be +wrapped. diff --git a/Help/prop_test/ATTACHED_FILES.rst b/Help/prop_test/ATTACHED_FILES.rst new file mode 100644 index 0000000..496d800 --- /dev/null +++ b/Help/prop_test/ATTACHED_FILES.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES +-------------- + +Attach a list of files to a dashboard submission. + +Set this property to a list of files that will be encoded and +submitted to the dashboard as an addition to the test result. diff --git a/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst new file mode 100644 index 0000000..6819143 --- /dev/null +++ b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES_ON_FAIL +---------------------- + +Attach a list of files to a dashboard submission if the test fails. + +Same as ATTACHED_FILES, but these files will only be included if the +test does not pass. diff --git a/Help/prop_test/COST.rst b/Help/prop_test/COST.rst new file mode 100644 index 0000000..3236a02 --- /dev/null +++ b/Help/prop_test/COST.rst @@ -0,0 +1,7 @@ +COST +---- + +Set this to a floating point value. Tests in a test set will be run in descending order of cost. + +This property describes the cost of a test. You can explicitly set +this value; tests with higher COST values will run first. diff --git a/Help/prop_test/DEPENDS.rst b/Help/prop_test/DEPENDS.rst new file mode 100644 index 0000000..ee946d9 --- /dev/null +++ b/Help/prop_test/DEPENDS.rst @@ -0,0 +1,6 @@ +DEPENDS +------- + +Specifies that this test should only be run after the specified list of tests. + +Set this to a list of tests that must finish before this test is run. diff --git a/Help/prop_test/ENVIRONMENT.rst b/Help/prop_test/ENVIRONMENT.rst new file mode 100644 index 0000000..df9bc9e --- /dev/null +++ b/Help/prop_test/ENVIRONMENT.rst @@ -0,0 +1,9 @@ +ENVIRONMENT +----------- + +Specify environment variables that should be defined for running a test. + +If set to a list of environment variables and values of the form +MYVAR=value those environment variables will be defined while running +the test. The environment is restored to its previous state after the +test is done. diff --git a/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..b02d17d --- /dev/null +++ b/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +FAIL_REGULAR_EXPRESSION +----------------------- + +If the output matches this regular expression the test will fail. + +If set, if the output matches one of specified regular expressions, +the test will fail.For example: FAIL_REGULAR_EXPRESSION +"[^a-z]Error;ERROR;Failed" diff --git a/Help/prop_test/LABELS.rst b/Help/prop_test/LABELS.rst new file mode 100644 index 0000000..8d75570 --- /dev/null +++ b/Help/prop_test/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a test. + +The list is reported in dashboard submissions. diff --git a/Help/prop_test/MEASUREMENT.rst b/Help/prop_test/MEASUREMENT.rst new file mode 100644 index 0000000..bc4936e --- /dev/null +++ b/Help/prop_test/MEASUREMENT.rst @@ -0,0 +1,8 @@ +MEASUREMENT +----------- + +Specify a CDASH measurement and value to be reported for a test. + +If set to a name then that name will be reported to CDASH as a named +measurement with a value of 1. You may also specify a value by +setting MEASUREMENT to "measurement=value". diff --git a/Help/prop_test/PASS_REGULAR_EXPRESSION.rst b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..bb35f77 --- /dev/null +++ b/Help/prop_test/PASS_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +PASS_REGULAR_EXPRESSION +----------------------- + +The output must match this regular expression for the test to pass. + +If set, the test output will be checked against the specified regular +expressions and at least one of the regular expressions has to match, +otherwise the test will fail. diff --git a/Help/prop_test/PROCESSORS.rst b/Help/prop_test/PROCESSORS.rst new file mode 100644 index 0000000..763b6d0 --- /dev/null +++ b/Help/prop_test/PROCESSORS.rst @@ -0,0 +1,8 @@ +PROCESSORS +---------- + +How many process slots this test requires + +Denotes the number of processors that this test will require. This is +typically used for MPI tests, and should be used in conjunction with +the ctest_test PARALLEL_LEVEL option. diff --git a/Help/prop_test/REQUIRED_FILES.rst b/Help/prop_test/REQUIRED_FILES.rst new file mode 100644 index 0000000..fac357c --- /dev/null +++ b/Help/prop_test/REQUIRED_FILES.rst @@ -0,0 +1,7 @@ +REQUIRED_FILES +-------------- + +List of files required to run the test. + +If set to a list of files, the test will not be run unless all of the +files exist. diff --git a/Help/prop_test/RESOURCE_LOCK.rst b/Help/prop_test/RESOURCE_LOCK.rst new file mode 100644 index 0000000..8c30f01 --- /dev/null +++ b/Help/prop_test/RESOURCE_LOCK.rst @@ -0,0 +1,7 @@ +RESOURCE_LOCK +------------- + +Specify a list of resources that are locked by this test. + +If multiple tests specify the same resource lock, they are guaranteed +not to run concurrently. diff --git a/Help/prop_test/RUN_SERIAL.rst b/Help/prop_test/RUN_SERIAL.rst new file mode 100644 index 0000000..8f65ae1 --- /dev/null +++ b/Help/prop_test/RUN_SERIAL.rst @@ -0,0 +1,8 @@ +RUN_SERIAL +---------- + +Do not run this test in parallel with any other test. + +Use this option in conjunction with the ctest_test PARALLEL_LEVEL +option to specify that this test should not be run in parallel with +any other tests. diff --git a/Help/prop_test/TIMEOUT.rst b/Help/prop_test/TIMEOUT.rst new file mode 100644 index 0000000..0b247b8 --- /dev/null +++ b/Help/prop_test/TIMEOUT.rst @@ -0,0 +1,9 @@ +TIMEOUT +------- + +How many seconds to allow for this test. + +This property if set will limit a test to not take more than the +specified number of seconds to run. If it exceeds that the test +process will be killed and ctest will move to the next test. This +setting takes precedence over CTEST_TESTING_TIMEOUT. diff --git a/Help/prop_test/WILL_FAIL.rst b/Help/prop_test/WILL_FAIL.rst new file mode 100644 index 0000000..f1f94a4 --- /dev/null +++ b/Help/prop_test/WILL_FAIL.rst @@ -0,0 +1,7 @@ +WILL_FAIL +--------- + +If set to true, this will invert the pass/fail flag of the test. + +This property can be used for tests that are expected to fail and +return a non zero return code. diff --git a/Help/prop_test/WORKING_DIRECTORY.rst b/Help/prop_test/WORKING_DIRECTORY.rst new file mode 100644 index 0000000..5222a19 --- /dev/null +++ b/Help/prop_test/WORKING_DIRECTORY.rst @@ -0,0 +1,7 @@ +WORKING_DIRECTORY +----------------- + +The directory from which the test executable will be called. + +If this is not set it is called from the directory the test executable +is located in. diff --git a/Help/prop_tgt/ALIASED_TARGET.rst b/Help/prop_tgt/ALIASED_TARGET.rst new file mode 100644 index 0000000..0af4365 --- /dev/null +++ b/Help/prop_tgt/ALIASED_TARGET.rst @@ -0,0 +1,7 @@ +ALIASED_TARGET +-------------- + +Name of target aliased by this target. + +If this is an ALIAS target, this property contains the name of the +target aliased. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..df57dba --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,7 @@ +ARCHIVE_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: ARCHIVE +.. |xxx| replace:: archive +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_ARCHIVE_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..3c0c4fd --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for ARCHIVE target files. + +This is a per-configuration version of ARCHIVE_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst new file mode 100644 index 0000000..a137bb8 --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -0,0 +1,6 @@ +ARCHIVE_OUTPUT_NAME +------------------- + +.. |XXX| replace:: ARCHIVE +.. |xxx| replace:: archive +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..314fa58 --- /dev/null +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +ARCHIVE_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for ARCHIVE target files. + +This is the configuration-specific version of ARCHIVE_OUTPUT_NAME. diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst new file mode 100644 index 0000000..8af1116 --- /dev/null +++ b/Help/prop_tgt/AUTOMOC.rst @@ -0,0 +1,31 @@ +AUTOMOC +------- + +Should the target be processed with automoc (for Qt projects). + +AUTOMOC is a boolean specifying whether CMake will handle the Qt moc +preprocessor automatically, i.e. without having to use the +QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are +supported. When this property is set to TRUE, CMake will scan the +source files at build time and invoke moc accordingly. If an #include +statement like #include "moc_foo.cpp" is found, the Q_OBJECT class +declaration is expected in the header, and moc is run on the header +file. If an #include statement like #include "foo.moc" is found, then +a Q_OBJECT is expected in the current source file and moc is run on +the file itself. Additionally, all header files are parsed for +Q_OBJECT macros, and if found, moc is also executed on those files. +The resulting moc files, which are not included as shown above in any +of the source files are included in a generated +<targetname>_automoc.cpp file, which is compiled as part of the +target.This property is initialized by the value of the variable +CMAKE_AUTOMOC if it is set when a target is created. + +Additional command line options for moc can be set via the +AUTOMOC_MOC_OPTIONS property. + +By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules +for searching the files which will be processed by moc can be relaxed. +See the documentation for this variable for more details. + +The global property AUTOMOC_TARGETS_FOLDER can be used to group the +automoc targets together in an IDE, e.g. in MSVS. diff --git a/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000..6ab5c85 --- /dev/null +++ b/Help/prop_tgt/AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,12 @@ +AUTOMOC_MOC_OPTIONS +------------------- + +Additional options for moc when using automoc (see the AUTOMOC property) + +This property is only used if the AUTOMOC property is set to TRUE for +this target. In this case, it holds additional command line options +which will be used when moc is executed during the build, i.e. it is +equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() +macro. + +By default it is empty. diff --git a/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000..abcf28f --- /dev/null +++ b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,11 @@ +BUILD_WITH_INSTALL_RPATH +------------------------ + +Should build tree targets have install tree rpaths. + +BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the +target in the build tree with the INSTALL_RPATH. This takes +precedence over SKIP_BUILD_RPATH and avoids the need for relinking +before installation. This property is initialized by the value of the +variable CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is +created. diff --git a/Help/prop_tgt/BUNDLE.rst b/Help/prop_tgt/BUNDLE.rst new file mode 100644 index 0000000..166659f --- /dev/null +++ b/Help/prop_tgt/BUNDLE.rst @@ -0,0 +1,9 @@ +BUNDLE +------ + +This target is a CFBundle on the Mac. + +If a module library target has this property set to true it will be +built as a CFBundle when built on the mac. It will have the directory +structure required for a CFBundle and will be suitable to be used for +creating Browser Plugins or other application resources. diff --git a/Help/prop_tgt/BUNDLE_EXTENSION.rst b/Help/prop_tgt/BUNDLE_EXTENSION.rst new file mode 100644 index 0000000..94ac935 --- /dev/null +++ b/Help/prop_tgt/BUNDLE_EXTENSION.rst @@ -0,0 +1,7 @@ +BUNDLE_EXTENSION +---------------- + +The file extension used to name a BUNDLE target on the Mac. + +The default value is "bundle" - you can also use "plugin" or whatever +file extension is required by the host app for your bundle. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst new file mode 100644 index 0000000..7f95ef0 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_BOOL.rst @@ -0,0 +1,17 @@ +COMPATIBLE_INTERFACE_BOOL +------------------------- + +Properties which must be compatible with their link interface + +The COMPATIBLE_INTERFACE_BOOL property may contain a list of +propertiesfor this target which must be consistent when evaluated as a +boolean in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +consistent with each other, and with the "FOO" property in the +dependee. Consistency in this sense has the meaning that if the +property is set, then it must have the same boolean value as all +others, and if the property is not set, then it is ignored. Note that +for each dependee, the set of properties from this property must not +intersect with the set of properties from the +COMPATIBLE_INTERFACE_STRING property. diff --git a/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst new file mode 100644 index 0000000..a461f76 --- /dev/null +++ b/Help/prop_tgt/COMPATIBLE_INTERFACE_STRING.rst @@ -0,0 +1,15 @@ +COMPATIBLE_INTERFACE_STRING +--------------------------- + +Properties which must be string-compatible with their link interface + +The COMPATIBLE_INTERFACE_STRING property may contain a list of +properties for this target which must be the same when evaluated as a +string in the INTERFACE of all linked dependees. For example, if a +property "FOO" appears in the list, then for each dependee, the +"INTERFACE_FOO" property content in all of its dependencies must be +equal with each other, and with the "FOO" property in the dependee. +If the property is not set, then it is ignored. Note that for each +dependee, the set of properties from this property must not intersect +with the set of properties from the COMPATIBLE_INTERFACE_BOOL +property. diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..51bdb92 --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst @@ -0,0 +1,23 @@ +COMPILE_DEFINITIONS +------------------- + +Preprocessor definitions for compiling a target's sources. + +The COMPILE_DEFINITIONS property may be set to a semicolon-separated +list of preprocessor definitions using the syntax VAR or VAR=value. +Function-style definitions are not supported. CMake will +automatically escape the value correctly for the native build system +(note that CMake language syntax may require escapes to specify some +values). This property may be set on a per-configuration basis using +the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case +name (ex. "COMPILE_DEFINITIONS_DEBUG"). + +CMake will automatically drop some definitions that are not supported +by the native build tool. The VS6 IDE does not support definition +values with spaces (but NMake does). + +Contents of COMPILE_DEFINITIONS may use "generator expressions" with the +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual +for available expressions. + +.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst new file mode 100644 index 0000000..0adb7dd --- /dev/null +++ b/Help/prop_tgt/COMPILE_DEFINITIONS_CONFIG.rst @@ -0,0 +1,6 @@ +COMPILE_DEFINITIONS_<CONFIG> +---------------------------- + +Per-configuration preprocessor definitions on a target. + +This is the configuration-specific version of COMPILE_DEFINITIONS. diff --git a/Help/prop_tgt/COMPILE_FLAGS.rst b/Help/prop_tgt/COMPILE_FLAGS.rst new file mode 100644 index 0000000..6ee6c51 --- /dev/null +++ b/Help/prop_tgt/COMPILE_FLAGS.rst @@ -0,0 +1,11 @@ +COMPILE_FLAGS +------------- + +Additional flags to use when compiling this target's sources. + +The COMPILE_FLAGS property sets additional compiler flags used to +build sources within the target. Use COMPILE_DEFINITIONS to pass +additional preprocessor definitions. + +This property is deprecated. Use the COMPILE_OPTIONS property or the +target_compile_options command instead. diff --git a/Help/prop_tgt/COMPILE_OPTIONS.rst b/Help/prop_tgt/COMPILE_OPTIONS.rst new file mode 100644 index 0000000..80e0ccb --- /dev/null +++ b/Help/prop_tgt/COMPILE_OPTIONS.rst @@ -0,0 +1,14 @@ +COMPILE_OPTIONS +--------------- + +List of options to pass to the compiler. + +This property specifies the list of options specified so far for this +property. This property exists on directories and targets. + +The target property values are used by the generators to set the +options for the compiler. + +Contents of COMPILE_OPTIONS may use "generator expressions" with the +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst new file mode 100644 index 0000000..f2c875e --- /dev/null +++ b/Help/prop_tgt/CONFIG_OUTPUT_NAME.rst @@ -0,0 +1,7 @@ +<CONFIG>_OUTPUT_NAME +-------------------- + +Old per-configuration target file base name. + +This is a configuration-specific version of OUTPUT_NAME. Use +OUTPUT_NAME_<CONFIG> instead. diff --git a/Help/prop_tgt/CONFIG_POSTFIX.rst b/Help/prop_tgt/CONFIG_POSTFIX.rst new file mode 100644 index 0000000..11b50b9 --- /dev/null +++ b/Help/prop_tgt/CONFIG_POSTFIX.rst @@ -0,0 +1,10 @@ +<CONFIG>_POSTFIX +---------------- + +Postfix to append to the target file name for configuration <CONFIG>. + +When building with configuration <CONFIG> the value of this property +is appended to the target file name built on disk. For non-executable +targets, this property is initialized by the value of the variable +CMAKE_<CONFIG>_POSTFIX if it is set when a target is created. This +property is ignored on the Mac for Frameworks and App Bundles. diff --git a/Help/prop_tgt/DEBUG_POSTFIX.rst b/Help/prop_tgt/DEBUG_POSTFIX.rst new file mode 100644 index 0000000..1487656 --- /dev/null +++ b/Help/prop_tgt/DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +DEBUG_POSTFIX +------------- + +See target property <CONFIG>_POSTFIX. + +This property is a special case of the more-general <CONFIG>_POSTFIX +property for the DEBUG configuration. diff --git a/Help/prop_tgt/DEFINE_SYMBOL.rst b/Help/prop_tgt/DEFINE_SYMBOL.rst new file mode 100644 index 0000000..f47f135 --- /dev/null +++ b/Help/prop_tgt/DEFINE_SYMBOL.rst @@ -0,0 +1,11 @@ +DEFINE_SYMBOL +------------- + +Define a symbol when compiling this target's sources. + +DEFINE_SYMBOL sets the name of the preprocessor symbol defined when +compiling sources in a shared library. If not set here then it is set +to target_EXPORTS by default (with some substitutions if the target is +not a valid C identifier). This is useful for headers to know whether +they are being included from inside their library or outside to +properly setup dllexport/dllimport decorations. diff --git a/Help/prop_tgt/ENABLE_EXPORTS.rst b/Help/prop_tgt/ENABLE_EXPORTS.rst new file mode 100644 index 0000000..283f5a8 --- /dev/null +++ b/Help/prop_tgt/ENABLE_EXPORTS.rst @@ -0,0 +1,19 @@ +ENABLE_EXPORTS +-------------- + +Specify whether an executable exports symbols for loadable modules. + +Normally an executable does not export any symbols because it is the +final program. It is possible for an executable to export symbols to +be used by loadable modules. When this property is set to true CMake +will allow other targets to "link" to the executable with the +TARGET_LINK_LIBRARIES command. On all platforms a target-level +dependency on the executable is created for targets that link to it. +For DLL platforms an import library will be created for the exported +symbols and then used for linking. All Windows-based systems +including Cygwin are DLL platforms. For non-DLL platforms that +require all symbols to be resolved at link time, such as Mac OS X, the +module will "link" to the executable using a flag like +"-bundle_loader". For other non-DLL platforms the link rule is simply +ignored since the dynamic loader will automatically bind symbols when +the module is loaded. diff --git a/Help/prop_tgt/EXCLUDE_FROM_ALL.rst b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst new file mode 100644 index 0000000..caa5741 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_ALL.rst @@ -0,0 +1,10 @@ +EXCLUDE_FROM_ALL +---------------- + +Exclude the target from the all target. + +A property on a target that indicates if the target is excluded from +the default build target. If it is not, then with a Makefile for +example typing make will cause this target to be built. The same +concept applies to the default build of other generators. Installing +a target with EXCLUDE_FROM_ALL set to true has undefined behavior. diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst new file mode 100644 index 0000000..19270a5 --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD.rst @@ -0,0 +1,8 @@ +EXCLUDE_FROM_DEFAULT_BUILD +-------------------------- + +Exclude target from "Build Solution". + +This property is only used by Visual Studio generators 7 and above. +When set to TRUE, the target will not be built when you press "Build +Solution". diff --git a/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst new file mode 100644 index 0000000..655a9de --- /dev/null +++ b/Help/prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG.rst @@ -0,0 +1,9 @@ +EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> +----------------------------------- + +Per-configuration version of target exclusion from "Build Solution". + +This is the configuration-specific version of +EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD +is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes +precedence in configurations for which it has a value. diff --git a/Help/prop_tgt/EXPORT_NAME.rst b/Help/prop_tgt/EXPORT_NAME.rst new file mode 100644 index 0000000..1b4247c --- /dev/null +++ b/Help/prop_tgt/EXPORT_NAME.rst @@ -0,0 +1,8 @@ +EXPORT_NAME +----------- + +Exported name for target files. + +This sets the name for the IMPORTED target generated when it this +target is is exported. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/EchoString.rst b/Help/prop_tgt/EchoString.rst new file mode 100644 index 0000000..32ae2aa --- /dev/null +++ b/Help/prop_tgt/EchoString.rst @@ -0,0 +1,7 @@ +EchoString +---------- + +A message to be displayed when the target is built. + +A message to display on some generators (such as makefiles) when the +target is built. diff --git a/Help/prop_tgt/FOLDER.rst b/Help/prop_tgt/FOLDER.rst new file mode 100644 index 0000000..bfe4e8e --- /dev/null +++ b/Help/prop_tgt/FOLDER.rst @@ -0,0 +1,10 @@ +FOLDER +------ + +Set the folder name. Use to organize targets in an IDE. + +Targets with no FOLDER property will appear as top level entities in +IDEs like Visual Studio. Targets with the same FOLDER property value +will appear next to each other in a folder of that name. To nest +folders, use FOLDER values such as 'GUI/Dialogs' with '/' characters +separating folder levels. diff --git a/Help/prop_tgt/FRAMEWORK.rst b/Help/prop_tgt/FRAMEWORK.rst new file mode 100644 index 0000000..9f472c0 --- /dev/null +++ b/Help/prop_tgt/FRAMEWORK.rst @@ -0,0 +1,9 @@ +FRAMEWORK +--------- + +This target is a framework on the Mac. + +If a shared library target has this property set to true it will be +built as a framework when built on the mac. It will have the +directory structure required for a framework and will be suitable to +be used with the -framework option diff --git a/Help/prop_tgt/Fortran_FORMAT.rst b/Help/prop_tgt/Fortran_FORMAT.rst new file mode 100644 index 0000000..0a11d91 --- /dev/null +++ b/Help/prop_tgt/Fortran_FORMAT.rst @@ -0,0 +1,11 @@ +Fortran_FORMAT +-------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This property tells CMake whether the Fortran source files in a target +use fixed-format or free-format. CMake will pass the corresponding +format flag to the compiler. Use the source-specific Fortran_FORMAT +property to change the format of a specific source file. If the +variable CMAKE_Fortran_FORMAT is set when a target is created its +value is used to initialize this property. diff --git a/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000..9c86437 --- /dev/null +++ b/Help/prop_tgt/Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,17 @@ +Fortran_MODULE_DIRECTORY +------------------------ + +Specify output directory for Fortran modules provided by the target. + +If the target contains Fortran source files that provide modules and +the compiler supports a module output directory this specifies the +directory in which the modules will be placed. When this property is +not set the modules will be placed in the build directory +corresponding to the target's source directory. If the variable +CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its +value is used to initialize this property. + +Note that some compilers will automatically search the module output +directory for modules USEd during compilation but others will not. If +your sources USE modules their location must be specified by +INCLUDE_DIRECTORIES regardless of this property. diff --git a/Help/prop_tgt/GENERATOR_FILE_NAME.rst b/Help/prop_tgt/GENERATOR_FILE_NAME.rst new file mode 100644 index 0000000..032b22a --- /dev/null +++ b/Help/prop_tgt/GENERATOR_FILE_NAME.rst @@ -0,0 +1,9 @@ +GENERATOR_FILE_NAME +------------------- + +Generator's file for this target. + +An internal property used by some generators to record the name of the +project or dsp file associated with this target. Note that at +configure time, this property is only set for targets created by +include_external_msproject(). diff --git a/Help/prop_tgt/GNUtoMS.rst b/Help/prop_tgt/GNUtoMS.rst new file mode 100644 index 0000000..cf34da9 --- /dev/null +++ b/Help/prop_tgt/GNUtoMS.rst @@ -0,0 +1,17 @@ +GNUtoMS +------- + +Convert GNU import library (.dll.a) to MS format (.lib). + +When linking a shared library or executable that exports symbols using +GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert +the import library (.dll.a) from GNU to MS format (.lib). Both import +libraries will be installed by install(TARGETS) and exported by +install(EXPORT) and export() to be linked by applications with either +GNU- or MS-compatible tools. + +If the variable CMAKE_GNUtoMS is set when a target is created its +value is used to initialize this property. The variable must be set +prior to the first command that enables a language such as project() +or enable_language(). CMake provides the variable as an option to the +user automatically when configuring on Windows with GNU tools. diff --git a/Help/prop_tgt/HAS_CXX.rst b/Help/prop_tgt/HAS_CXX.rst new file mode 100644 index 0000000..7790932 --- /dev/null +++ b/Help/prop_tgt/HAS_CXX.rst @@ -0,0 +1,7 @@ +HAS_CXX +------- + +Link the target using the C++ linker tool (obsolete). + +This is equivalent to setting the LINKER_LANGUAGE property to CXX. +See that property's documentation for details. diff --git a/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst new file mode 100644 index 0000000..dc73807 --- /dev/null +++ b/Help/prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM.rst @@ -0,0 +1,32 @@ +IMPLICIT_DEPENDS_INCLUDE_TRANSFORM +---------------------------------- + +Specify #include line transforms for dependencies in a target. + +This property specifies rules to transform macro-like #include lines +during implicit dependency scanning of C and C++ source files. The +list of rules must be semicolon-separated with each entry of the form +"A_MACRO(%)=value-with-%" (the % must be literal). During dependency +scanning occurrences of A_MACRO(...) on #include lines will be +replaced by the value given with the macro argument substituted for +'%'. For example, the entry + +:: + + MYDIR(%)=<mydir/%> + +will convert lines of the form + +:: + + #include MYDIR(myheader.h) + +to + +:: + + #include <mydir/myheader.h> + +allowing the dependency to be followed. + +This property applies to sources in the target on which it is set. diff --git a/Help/prop_tgt/IMPORTED.rst b/Help/prop_tgt/IMPORTED.rst new file mode 100644 index 0000000..bf9835e --- /dev/null +++ b/Help/prop_tgt/IMPORTED.rst @@ -0,0 +1,8 @@ +IMPORTED +-------- + +Read-only indication of whether a target is IMPORTED. + +The boolean value of this property is true for targets created with +the IMPORTED option to add_executable or add_library. It is false for +targets built within the project. diff --git a/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst new file mode 100644 index 0000000..6de1baa --- /dev/null +++ b/Help/prop_tgt/IMPORTED_CONFIGURATIONS.rst @@ -0,0 +1,11 @@ +IMPORTED_CONFIGURATIONS +----------------------- + +Configurations provided for an IMPORTED target. + +Set this to the list of configuration names available for an IMPORTED +target. The names correspond to configurations defined in the project +from which the target is imported. If the importing project uses a +different set of configurations the names may be mapped using the +MAP_IMPORTED_CONFIG_<CONFIG> property. Ignored for non-imported +targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB.rst b/Help/prop_tgt/IMPORTED_IMPLIB.rst new file mode 100644 index 0000000..acf4b32 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB +--------------- + +Full path to the import library for an IMPORTED target. + +Set this to the location of the ".lib" part of a windows DLL. Ignored +for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst new file mode 100644 index 0000000..b4b3f02 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_IMPLIB_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_IMPLIB_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_IMPLIB property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst new file mode 100644 index 0000000..2db2b0e --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES +--------------------------------- + +Dependent shared libraries of an imported shared library. + +Shared libraries may be linked to other shared libraries as part of +their implementation. On some platforms the linker searches for the +dependent libraries of shared libraries they are including in the +link. Set this property to the list of dependent shared libraries of +an imported library. The list should be disjoint from the list of +interface libraries in the INTERFACE_LINK_LIBRARIES property. On +platforms requiring dependent shared libraries to be found at link +time CMake uses this list to add appropriate files or paths to the +link command line. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..ee243c7 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst new file mode 100644 index 0000000..5ca9c8b --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES.rst @@ -0,0 +1,14 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES +--------------------------------- + +Languages compiled into an IMPORTED static library. + +Set this to the list of languages of source files compiled to produce +a STATIC IMPORTED library (such as "C" or "CXX"). CMake accounts for +these languages when computing how to link a target to the imported +library. For example, when a C executable links to an imported C++ +static library CMake chooses the C++ linker to satisfy language +runtime dependencies of the static library. + +This property is ignored for targets that are not STATIC libraries. +This property is ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst new file mode 100644 index 0000000..d4a10fb --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG.rst @@ -0,0 +1,8 @@ +IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..61134a4 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,16 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES +--------------------------------- + +Transitive link interface of an IMPORTED target. + +Set this to the list of libraries whose interface is included when an +IMPORTED library target is linked to another target. The libraries +will be included on the link line for the target. Unlike the +LINK_INTERFACE_LIBRARIES property, this property applies to all +imported target types, including STATIC libraries. This property is +ignored for non-imported targets. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..13b93ba --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG> +------------------------------------------ + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES. + +Configuration names correspond to those provided by the project from +which the target is imported. If set, this property completely +overrides the generic property for the named configuration. + +This property is ignored if the target also has a non-empty +INTERFACE_LINK_LIBRARIES property. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000..3a86b99 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,6 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY +------------------------------------ + +Repetition count for cycles of IMPORTED static libraries. + +This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets. diff --git a/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000..33b9b84 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG> +--------------------------------------------- + +<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY. + +If set, this property completely overrides the generic property for +the named configuration. diff --git a/Help/prop_tgt/IMPORTED_LOCATION.rst b/Help/prop_tgt/IMPORTED_LOCATION.rst new file mode 100644 index 0000000..8cfef73 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION.rst @@ -0,0 +1,21 @@ +IMPORTED_LOCATION +----------------- + +Full path to the main file on disk for an IMPORTED target. + +Set this to the location of an IMPORTED target file on disk. For +executables this is the location of the executable file. For bundles +on OS X this is the location of the executable file inside +Contents/MacOS under the application bundle folder. For static +libraries and modules this is the location of the library or module. +For shared libraries on non-DLL platforms this is the location of the +shared library. For frameworks on OS X this is the location of the +library file symlink just inside the framework folder. For DLLs this +is the location of the ".dll" part of the library. For UNKNOWN +libraries this is the location of the file to be linked. Ignored for +non-imported targets. + +Projects may skip IMPORTED_LOCATION if the configuration-specific +property IMPORTED_LOCATION_<CONFIG> is set. To get the location of an +imported target read one of the LOCATION or LOCATION_<CONFIG> +properties. diff --git a/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst new file mode 100644 index 0000000..f85bb19 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_LOCATION_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_LOCATION_<CONFIG> +-------------------------- + +<CONFIG>-specific version of IMPORTED_LOCATION property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME.rst b/Help/prop_tgt/IMPORTED_NO_SONAME.rst new file mode 100644 index 0000000..4a1bb44 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME.rst @@ -0,0 +1,9 @@ +IMPORTED_NO_SONAME +------------------ + +Specifies that an IMPORTED shared library target has no "soname". + +Set this property to true for an imported shared library file that has +no "soname" field. CMake may adjust generated link commands for some +platforms to prevent the linker from using the path to the library in +place of its missing soname. Ignored for non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst new file mode 100644 index 0000000..22d6822 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_NO_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_NO_SONAME_<CONFIG> +--------------------------- + +<CONFIG>-specific version of IMPORTED_NO_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORTED_SONAME.rst b/Help/prop_tgt/IMPORTED_SONAME.rst new file mode 100644 index 0000000..d80907e --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME.rst @@ -0,0 +1,8 @@ +IMPORTED_SONAME +--------------- + +The "soname" of an IMPORTED target of shared library type. + +Set this to the "soname" embedded in an imported shared library. This +is meaningful only on platforms supporting the feature. Ignored for +non-imported targets. diff --git a/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst new file mode 100644 index 0000000..6ec9af3 --- /dev/null +++ b/Help/prop_tgt/IMPORTED_SONAME_CONFIG.rst @@ -0,0 +1,7 @@ +IMPORTED_SONAME_<CONFIG> +------------------------ + +<CONFIG>-specific version of IMPORTED_SONAME property. + +Configuration names correspond to those provided by the project from +which the target is imported. diff --git a/Help/prop_tgt/IMPORT_PREFIX.rst b/Help/prop_tgt/IMPORT_PREFIX.rst new file mode 100644 index 0000000..deede97 --- /dev/null +++ b/Help/prop_tgt/IMPORT_PREFIX.rst @@ -0,0 +1,9 @@ +IMPORT_PREFIX +------------- + +What comes before the import library name. + +Similar to the target property PREFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the prefix (such as "lib") +on an import library name. diff --git a/Help/prop_tgt/IMPORT_SUFFIX.rst b/Help/prop_tgt/IMPORT_SUFFIX.rst new file mode 100644 index 0000000..bd01250 --- /dev/null +++ b/Help/prop_tgt/IMPORT_SUFFIX.rst @@ -0,0 +1,9 @@ +IMPORT_SUFFIX +------------- + +What comes after the import library name. + +Similar to the target property SUFFIX, but used for import libraries +(typically corresponding to a DLL) instead of regular libraries. A +target property that can be set to override the suffix (such as +".lib") on an import library name. diff --git a/Help/prop_tgt/INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..40709a4 --- /dev/null +++ b/Help/prop_tgt/INCLUDE_DIRECTORIES.rst @@ -0,0 +1,22 @@ +INCLUDE_DIRECTORIES +------------------- + +List of preprocessor include file search directories. + +This property specifies the list of directories given so far to the +include_directories command. This property exists on directories and +targets. In addition to accepting values from the include_directories +command, values may be set directly on any directory or any target +using the set_property command. A target gets its initial value for +this property from the value of the directory property. A directory +gets its initial value from its parent directory if it has one. Both +directory and target property values are adjusted by calls to the +include_directories command. + +The target property values are used by the generators to set the +include paths for the compiler. See also the include_directories +command. + +Contents of INCLUDE_DIRECTORIES may use "generator expressions" with the +syntax "$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/INSTALL_NAME_DIR.rst b/Help/prop_tgt/INSTALL_NAME_DIR.rst new file mode 100644 index 0000000..a67ec15 --- /dev/null +++ b/Help/prop_tgt/INSTALL_NAME_DIR.rst @@ -0,0 +1,8 @@ +INSTALL_NAME_DIR +---------------- + +Mac OSX directory name for installed targets. + +INSTALL_NAME_DIR is a string specifying the directory portion of the +"install_name" field of shared libraries on Mac OSX to use in the +installed targets. diff --git a/Help/prop_tgt/INSTALL_RPATH.rst b/Help/prop_tgt/INSTALL_RPATH.rst new file mode 100644 index 0000000..6206b68 --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH.rst @@ -0,0 +1,9 @@ +INSTALL_RPATH +------------- + +The rpath to use for installed targets. + +A semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This property is initialized +by the value of the variable CMAKE_INSTALL_RPATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000..f0006f8 --- /dev/null +++ b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,10 @@ +INSTALL_RPATH_USE_LINK_PATH +--------------------------- + +Add paths to linker search and installed rpath. + +INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will +append directories in the linker search path and outside the project +to the INSTALL_RPATH. This property is initialized by the value of +the variable CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a +target is created. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst new file mode 100644 index 0000000..eb001dd --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_DEFINITIONS.rst @@ -0,0 +1,13 @@ +INTERFACE_COMPILE_DEFINITIONS +----------------------------- + +List of public compile definitions for a library. + +Targets may populate this property to publish the compile definitions +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_DEFINITIONS property such +as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the +compile definitions specified in the interface of 'foo'. + +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst new file mode 100644 index 0000000..51b1f6e --- /dev/null +++ b/Help/prop_tgt/INTERFACE_COMPILE_OPTIONS.rst @@ -0,0 +1,13 @@ +INTERFACE_COMPILE_OPTIONS +------------------------- + +List of interface options to pass to the compiler. + +Targets may populate this property to publish the compile options +required to compile against the headers for the target. Consuming +targets can add entries to their own COMPILE_OPTIONS property such as +$<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the compile +options specified in the interface of 'foo'. + +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..33892da --- /dev/null +++ b/Help/prop_tgt/INTERFACE_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,13 @@ +INTERFACE_INCLUDE_DIRECTORIES +----------------------------- + +List of public include directories for a library. + +Targets may populate this property to publish the include directories +required to compile against the headers for the target. Consuming +targets can add entries to their own INCLUDE_DIRECTORIES property such +as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the +include directories specified in the interface of 'foo'. + +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst new file mode 100644 index 0000000..24c2441 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_LINK_LIBRARIES.rst @@ -0,0 +1,14 @@ +INTERFACE_LINK_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +This property contains the list of transitive link dependencies. When +the target is linked into another target the libraries listed (and +recursively their link interface libraries) will be provided to the +other target also. This property is overriden by the +LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property +if policy CMP0022 is OLD or unset. + +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..76c1e06 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,15 @@ +INTERFACE_POSITION_INDEPENDENT_CODE +----------------------------------- + +Whether consumers need to create a position-independent target + +The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of +this target whether they must set their POSITION_INDEPENDENT_CODE +property to ON. If this property is set to ON, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to ON. +Similarly, if this property is set to OFF, then the +POSITION_INDEPENDENT_CODE property on all consumers will be set to +OFF. If this property is undefined, then consumers will determine +their POSITION_INDEPENDENT_CODE property by other means. Consumers +must ensure that the targets that they link to have a consistent +requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property. diff --git a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..9a6e3a9 --- /dev/null +++ b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,12 @@ +INTERFACE_SYSTEM_INCLUDE_DIRECTORIES +------------------------------------ + +List of public system include directories for a library. + +Targets may populate this property to publish the include directories +which contain system headers, and therefore should not result in +compiler warnings. Consuming targets will then mark the same include +directories as system headers. + +This property also supports generator expressions. See the +:manual:`cmake-generator-expressions(7)` manual for available expressions. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst new file mode 100644 index 0000000..effa3b0 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION.rst @@ -0,0 +1,7 @@ +INTERPROCEDURAL_OPTIMIZATION +---------------------------- + +Enable interprocedural optimization for a target. + +If set to true, enables interprocedural optimizations if they are +known to be supported by the compiler. diff --git a/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst new file mode 100644 index 0000000..492fee0 --- /dev/null +++ b/Help/prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG.rst @@ -0,0 +1,8 @@ +INTERPROCEDURAL_OPTIMIZATION_<CONFIG> +------------------------------------- + +Per-configuration interprocedural optimization for a target. + +This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. +If set, this property overrides the generic property for the named +configuration. diff --git a/Help/prop_tgt/LABELS.rst b/Help/prop_tgt/LABELS.rst new file mode 100644 index 0000000..5e46469 --- /dev/null +++ b/Help/prop_tgt/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a target. + +Target label semantics are currently unspecified. diff --git a/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000..d4bde17 --- /dev/null +++ b/Help/prop_tgt/LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,10 @@ +<LANG>_VISIBILITY_PRESET +------------------------ + +Value for symbol visibility compile flags + +The <LANG>_VISIBILITY_PRESET property determines the value passed in a +visibility related compile option, such as -fvisibility= for <LANG>. +This property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..e1d3a82 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,7 @@ +LIBRARY_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: LIBRARY +.. |xxx| replace:: library +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_LIBRARY_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..2a38373 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +LIBRARY_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for LIBRARY target files. + +This is a per-configuration version of LIBRARY_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst new file mode 100644 index 0000000..9e9d401 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -0,0 +1,6 @@ +LIBRARY_OUTPUT_NAME +------------------- + +.. |XXX| replace:: LIBRARY +.. |xxx| replace:: library +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..785d1b2 --- /dev/null +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +LIBRARY_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for LIBRARY target files. + +This is the configuration-specific version of LIBRARY_OUTPUT_NAME. diff --git a/Help/prop_tgt/LINKER_LANGUAGE.rst b/Help/prop_tgt/LINKER_LANGUAGE.rst new file mode 100644 index 0000000..b1ca867 --- /dev/null +++ b/Help/prop_tgt/LINKER_LANGUAGE.rst @@ -0,0 +1,14 @@ +LINKER_LANGUAGE +--------------- + +Specifies language whose compiler will invoke the linker. + +For executables, shared libraries, and modules, this sets the language +whose compiler is used to link the target (such as "C" or "CXX"). A +typical value for an executable is the language of the source file +providing the program entry point (main). If not set, the language +with the highest linker preference value is the default. See +documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables. + +If this property is not set by the user, it will be calculated at +generate-time by CMake. diff --git a/Help/prop_tgt/LINK_DEPENDS.rst b/Help/prop_tgt/LINK_DEPENDS.rst new file mode 100644 index 0000000..5576b85 --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS.rst @@ -0,0 +1,12 @@ +LINK_DEPENDS +------------ + +Additional files on which a target binary depends for linking. + +Specifies a semicolon-separated list of full-paths to files on which +the link rule for this target depends. The target binary will be +linked if any of the named files is newer than it. + +This property is ignored by non-Makefile generators. It is intended +to specify dependencies on "linker scripts" for custom Makefile link +rules. diff --git a/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000..5c6778d --- /dev/null +++ b/Help/prop_tgt/LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,14 @@ +LINK_DEPENDS_NO_SHARED +---------------------- + +Do not depend on linked shared library files. + +Set this property to true to tell CMake generators not to add +file-level dependencies on the shared library files linked by this +target. Modification to the shared libraries will not be sufficient +to re-link this target. Logical target-level dependencies will not be +affected so the linked shared libraries will still be brought up to +date before this target is built. + +This property is initialized by the value of the variable +CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is created. diff --git a/Help/prop_tgt/LINK_FLAGS.rst b/Help/prop_tgt/LINK_FLAGS.rst new file mode 100644 index 0000000..409d00a --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS.rst @@ -0,0 +1,8 @@ +LINK_FLAGS +---------- + +Additional flags to use when linking this target. + +The LINK_FLAGS property can be used to add extra flags to the link +step of a target. LINK_FLAGS_<CONFIG> will add to the configuration +<CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. diff --git a/Help/prop_tgt/LINK_FLAGS_CONFIG.rst b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst new file mode 100644 index 0000000..ba7adc8 --- /dev/null +++ b/Help/prop_tgt/LINK_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +LINK_FLAGS_<CONFIG> +------------------- + +Per-configuration linker flags for a target. + +This is the configuration-specific version of LINK_FLAGS. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..75c2a31 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,22 @@ +LINK_INTERFACE_LIBRARIES +------------------------ + +List public interface libraries for a shared library or executable. + +By default linking to a shared library target transitively links to +targets with which the library itself was linked. For an executable +with exports (see the ENABLE_EXPORTS property) no default transitive +link dependencies are used. This property replaces the default +transitive link dependencies with an explicit list. When the target +is linked into another target the libraries listed (and recursively +their link interface libraries) will be provided to the other target +also. If the list is empty then no transitive link dependencies will +be incorporated when this target is linked into another target even if +the default set is non-empty. This property is initialized by the +value of the variable CMAKE_LINK_INTERFACE_LIBRARIES if it is set when +a target is created. This property is ignored for STATIC libraries. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst new file mode 100644 index 0000000..1a7a941 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG.rst @@ -0,0 +1,13 @@ +LINK_INTERFACE_LIBRARIES_<CONFIG> +--------------------------------- + +Per-configuration list of public interface libraries for a target. + +This is the configuration-specific version of +LINK_INTERFACE_LIBRARIES. If set, this property completely overrides +the generic property for the named configuration. + +This property is overriden by the INTERFACE_LINK_LIBRARIES property if +policy CMP0022 is NEW. + +This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst new file mode 100644 index 0000000..4e26388 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY.rst @@ -0,0 +1,12 @@ +LINK_INTERFACE_MULTIPLICITY +--------------------------- + +Repetition count for STATIC libraries with cyclic dependencies. + +When linking to a STATIC library target with cyclic dependencies the +linker may need to scan more than once through the archives in the +strongly connected component of the dependency graph. CMake by +default constructs the link line so that the linker will scan through +the component at least twice. This property specifies the minimum +number of scans if it is larger than the default. CMake uses the +largest value specified by any target in a component. diff --git a/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst new file mode 100644 index 0000000..5ea4a45 --- /dev/null +++ b/Help/prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG.rst @@ -0,0 +1,8 @@ +LINK_INTERFACE_MULTIPLICITY_<CONFIG> +------------------------------------ + +Per-configuration repetition count for cycles of STATIC libraries. + +This is the configuration-specific version of +LINK_INTERFACE_MULTIPLICITY. If set, this property completely +overrides the generic property for the named configuration. diff --git a/Help/prop_tgt/LINK_LIBRARIES.rst b/Help/prop_tgt/LINK_LIBRARIES.rst new file mode 100644 index 0000000..b18fe30 --- /dev/null +++ b/Help/prop_tgt/LINK_LIBRARIES.rst @@ -0,0 +1,17 @@ +LINK_LIBRARIES +-------------- + +List of direct link dependencies. + +This property specifies the list of libraries or targets which will be +used for linking. In addition to accepting values from the +target_link_libraries command, values may be set directly on any +target using the set_property command. + +The target property values are used by the generators to set the link +libraries for the compiler. See also the target_link_libraries +command. + +Contents of LINK_LIBRARIES may use "generator expressions" with the syntax +"$<...>". See the :manual:`cmake-generator-expressions(7)` manual for +available expressions. diff --git a/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst new file mode 100644 index 0000000..fe105bd --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_END_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_END_STATIC +---------------------- + +End a link line such that static system libraries are used. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default CMake adds an option at the +end of the library list (if necessary) to set the linker search type +back to its starting type. This property switches the final linker +search type to -Bstatic regardless of how it started. See also +LINK_SEARCH_START_STATIC. diff --git a/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst new file mode 100644 index 0000000..ca899fe --- /dev/null +++ b/Help/prop_tgt/LINK_SEARCH_START_STATIC.rst @@ -0,0 +1,14 @@ +LINK_SEARCH_START_STATIC +------------------------ + +Assume the linker looks for static libraries by default. + +Some linkers support switches such as -Bstatic and -Bdynamic to +determine whether to use static or shared libraries for -lXXX options. +CMake uses these options to set the link type for libraries whose full +paths are not known or (in some cases) are in implicit link +directories for the platform. By default the linker search type is +assumed to be -Bdynamic at the beginning of the library list. This +property switches the assumption to -Bstatic. It is intended for use +when linking an executable statically (e.g. with the GNU -static +option). See also LINK_SEARCH_END_STATIC. diff --git a/Help/prop_tgt/LOCATION.rst b/Help/prop_tgt/LOCATION.rst new file mode 100644 index 0000000..16d5696 --- /dev/null +++ b/Help/prop_tgt/LOCATION.rst @@ -0,0 +1,27 @@ +LOCATION +-------- + +Read-only location of a target on disk. + +For an imported target, this read-only property returns the value of +the LOCATION_<CONFIG> property for an unspecified configuration +<CONFIG> provided by the target. + +For a non-imported target, this property is provided for compatibility +with CMake 2.4 and below. It was meant to get the location of an +executable target's output file for use in add_custom_command. The +path may contain a build-system-specific portion that is replaced at +build time with the configuration getting built (such as +"$(ConfigurationName)" in VS). In CMake 2.6 and above +add_custom_command automatically recognizes a target name in its +COMMAND and DEPENDS options and computes the target location. In +CMake 2.8.4 and above add_custom_command recognizes generator +expressions to refer to target locations anywhere in the command. +Therefore this property is not needed for creating custom commands. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/LOCATION_CONFIG.rst b/Help/prop_tgt/LOCATION_CONFIG.rst new file mode 100644 index 0000000..ac6bdb7 --- /dev/null +++ b/Help/prop_tgt/LOCATION_CONFIG.rst @@ -0,0 +1,20 @@ +LOCATION_<CONFIG> +----------------- + +Read-only property providing a target location on disk. + +A read-only property that indicates where a target's main file is +located on disk for the configuration <CONFIG>. The property is +defined only for library and executable targets. An imported target +may provide a set of configurations different from that of the +importing project. By default CMake looks for an exact-match but +otherwise uses an arbitrary available configuration. Use the +MAP_IMPORTED_CONFIG_<CONFIG> property to map imported configurations +explicitly. + +Do not set properties that affect the location of a target after +reading this property. These include properties whose names match +"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", +``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow +this rule is not diagnosed and leaves the location of the target +undefined. diff --git a/Help/prop_tgt/MACOSX_BUNDLE.rst b/Help/prop_tgt/MACOSX_BUNDLE.rst new file mode 100644 index 0000000..ff21e61 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE.rst @@ -0,0 +1,12 @@ +MACOSX_BUNDLE +------------- + +Build an executable as an application bundle on Mac OS X. + +When this property is set to true the executable when built on Mac OS +X will be created as an application bundle. This makes it a GUI +executable that can be launched from the Finder. See the +MACOSX_BUNDLE_INFO_PLIST target property for information about +creation of the Info.plist file for the application bundle. This +property is initialized by the value of the variable +CMAKE_MACOSX_BUNDLE if it is set when a target is created. diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst new file mode 100644 index 0000000..097cce1 --- /dev/null +++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -0,0 +1,29 @@ +MACOSX_BUNDLE_INFO_PLIST +------------------------ + +Specify a custom Info.plist template for a Mac OS X App Bundle. + +An executable target with MACOSX_BUNDLE enabled will be built as an +application bundle on Mac OS X. By default its Info.plist file is +created by configuring a template called MacOSXBundleInfo.plist.in +located in the CMAKE_MODULE_PATH. This property specifies an +alternative template file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_BUNDLE_INFO_STRING + MACOSX_BUNDLE_ICON_FILE + MACOSX_BUNDLE_GUI_IDENTIFIER + MACOSX_BUNDLE_LONG_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_NAME + MACOSX_BUNDLE_SHORT_VERSION_STRING + MACOSX_BUNDLE_BUNDLE_VERSION + MACOSX_BUNDLE_COPYRIGHT + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst new file mode 100644 index 0000000..729d929 --- /dev/null +++ b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst @@ -0,0 +1,25 @@ +MACOSX_FRAMEWORK_INFO_PLIST +--------------------------- + +Specify a custom Info.plist template for a Mac OS X Framework. + +A library target with FRAMEWORK enabled will be built as a framework +on Mac OS X. By default its Info.plist file is created by configuring +a template called MacOSXFrameworkInfo.plist.in located in the +CMAKE_MODULE_PATH. This property specifies an alternative template +file name which may be a full path. + +The following target properties may be set to specify content to be +configured into the file: + +:: + + MACOSX_FRAMEWORK_ICON_FILE + MACOSX_FRAMEWORK_IDENTIFIER + MACOSX_FRAMEWORK_SHORT_VERSION_STRING + MACOSX_FRAMEWORK_BUNDLE_VERSION + +CMake variables of the same name may be set to affect all targets in a +directory that do not have each specific property set. If a custom +Info.plist is specified by this property it may of course hard-code +all the settings instead of using the target properties. diff --git a/Help/prop_tgt/MACOSX_RPATH.rst b/Help/prop_tgt/MACOSX_RPATH.rst new file mode 100644 index 0000000..f2d8078 --- /dev/null +++ b/Help/prop_tgt/MACOSX_RPATH.rst @@ -0,0 +1,10 @@ +MACOSX_RPATH +------------ + +Whether to use rpaths on Mac OS X. + +When this property is set to true, the directory portion of +the"install_name" field of shared libraries will default to +"@rpath".Runtime paths will also be embedded in binaries using this +target.This property is initialized by the value of the variable +CMAKE_MACOSX_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000..09ff0ce --- /dev/null +++ b/Help/prop_tgt/MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,19 @@ +MAP_IMPORTED_CONFIG_<CONFIG> +---------------------------- + +Map from project configuration to IMPORTED target's configuration. + +Set this to the list of configurations of an imported target that may +be used for the current project's <CONFIG> configuration. Targets +imported from another project may not provide the same set of +configuration names available in the current project. Setting this +property tells CMake what imported configurations are suitable for use +when building the <CONFIG> configuration. The first configuration in +the list found to be provided by the imported target is selected. If +this property is set and no matching configurations are available, +then the imported target is considered to be not found. This property +is ignored for non-imported targets. + +This property is initialized by the value of the variable +CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/NAME.rst b/Help/prop_tgt/NAME.rst new file mode 100644 index 0000000..ddd84f2 --- /dev/null +++ b/Help/prop_tgt/NAME.rst @@ -0,0 +1,6 @@ +NAME +---- + +Logical name for the target. + +Read-only logical name for the target as used by CMake. diff --git a/Help/prop_tgt/NO_SONAME.rst b/Help/prop_tgt/NO_SONAME.rst new file mode 100644 index 0000000..fc668b5 --- /dev/null +++ b/Help/prop_tgt/NO_SONAME.rst @@ -0,0 +1,14 @@ +NO_SONAME +--------- + +Whether to set "soname" when linking a shared library or module. + +Enable this boolean property if a generated shared library or module +should not have "soname" set. Default is to set "soname" on all +shared libraries and modules as long as the platform supports it. +Generally, use this property only for leaf private libraries or +plugins. If you use it on normal shared libraries which other targets +link against, on some platforms a linker will insert a full path to +the library (as specified at link time) into the dynamic section of +the dependent binary. Therefore, once installed, dynamic loader may +eventually fail to locate the library for the binary. diff --git a/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000..070dd30 --- /dev/null +++ b/Help/prop_tgt/NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,11 @@ +NO_SYSTEM_FROM_IMPORTED +----------------------- + +Do not treat includes from IMPORTED target interfaces as SYSTEM. + +The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets +are treated as SYSTEM includes by default. If this property is +enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED +targets are not treated as system includes. This property is +initialized by the value of the variable CMAKE_NO_SYSTEM_FROM_IMPORTED +if it is set when a target is created. diff --git a/Help/prop_tgt/OSX_ARCHITECTURES.rst b/Help/prop_tgt/OSX_ARCHITECTURES.rst new file mode 100644 index 0000000..68ff970 --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES.rst @@ -0,0 +1,11 @@ +OSX_ARCHITECTURES +----------------- + +Target specific architectures for OS X. + +The OSX_ARCHITECTURES property sets the target binary architecture for +targets on OS X. This property is initialized by the value of the +variable CMAKE_OSX_ARCHITECTURES if it is set when a target is +created. Use OSX_ARCHITECTURES_<CONFIG> to set the binary +architectures on a per-configuration basis. <CONFIG> is an upper-case +name (ex: "OSX_ARCHITECTURES_DEBUG"). diff --git a/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst new file mode 100644 index 0000000..ea05bea --- /dev/null +++ b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst @@ -0,0 +1,7 @@ +OSX_ARCHITECTURES_<CONFIG> +-------------------------- + +Per-configuration OS X binary architectures for a target. + +This property is the configuration-specific version of +OSX_ARCHITECTURES. diff --git a/Help/prop_tgt/OUTPUT_NAME.rst b/Help/prop_tgt/OUTPUT_NAME.rst new file mode 100644 index 0000000..97bf010 --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME.rst @@ -0,0 +1,8 @@ +OUTPUT_NAME +----------- + +Output name for target files. + +This sets the base name for output files created for an executable or +library target. If not set, the logical target name is used by +default. diff --git a/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..7bfbcbc --- /dev/null +++ b/Help/prop_tgt/OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +OUTPUT_NAME_<CONFIG> +-------------------- + +Per-configuration target file base name. + +This is the configuration-specific version of OUTPUT_NAME. diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst new file mode 100644 index 0000000..fe059e0 --- /dev/null +++ b/Help/prop_tgt/PDB_NAME.rst @@ -0,0 +1,10 @@ +PDB_NAME +-------- + +Output name for MS debug symbols .pdb file from linker. + +Set the base name for debug symbols file created for an executable or +shared library target. If not set, the logical target name is used by +default. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst new file mode 100644 index 0000000..50c3aa2 --- /dev/null +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -0,0 +1,8 @@ +PDB_NAME_<CONFIG> +----------------- + +Per-configuration name for MS debug symbols .pdb file. + +This is the configuration-specific version of PDB_NAME. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..d973e90d --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,11 @@ +PDB_OUTPUT_DIRECTORY +-------------------- + +Output directory for MS debug symbols .pdb file from linker. + +This property specifies the directory into which the MS debug symbols +will be placed by the linker. This property is initialized by the +value of the variable CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a +target is created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..25ab944 --- /dev/null +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,13 @@ +PDB_OUTPUT_DIRECTORY_<CONFIG> +----------------------------- + +Per-configuration output directory for MS debug symbols .pdb files. + +This is a per-configuration version of PDB_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. + +This property is not implemented by the Visual Studio 6 generator. diff --git a/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..1202447 --- /dev/null +++ b/Help/prop_tgt/POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,11 @@ +POSITION_INDEPENDENT_CODE +------------------------- + +Whether to create a position-independent target + +The POSITION_INDEPENDENT_CODE property determines whether position +independent executables or shared libraries will be created. This +property is true by default for SHARED and MODULE library targets and +false otherwise. This property is initialized by the value of the +variable CMAKE_POSITION_INDEPENDENT_CODE if it is set when a target is +created. diff --git a/Help/prop_tgt/POST_INSTALL_SCRIPT.rst b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..f1adb40 --- /dev/null +++ b/Help/prop_tgt/POST_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +POST_INSTALL_SCRIPT +------------------- + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PREFIX.rst b/Help/prop_tgt/PREFIX.rst new file mode 100644 index 0000000..a165104 --- /dev/null +++ b/Help/prop_tgt/PREFIX.rst @@ -0,0 +1,7 @@ +PREFIX +------ + +What comes before the library name. + +A target property that can be set to override the prefix (such as +"lib") on a library name. diff --git a/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..113d7c5 --- /dev/null +++ b/Help/prop_tgt/PRE_INSTALL_SCRIPT.rst @@ -0,0 +1,9 @@ +PRE_INSTALL_SCRIPT +------------------ + +Deprecated install support. + +The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old +way to specify CMake scripts to run before and after installing a +target. They are used only when the old INSTALL_TARGETS command is +used to install the target. Use the INSTALL command instead. diff --git a/Help/prop_tgt/PRIVATE_HEADER.rst b/Help/prop_tgt/PRIVATE_HEADER.rst new file mode 100644 index 0000000..da2127b --- /dev/null +++ b/Help/prop_tgt/PRIVATE_HEADER.rst @@ -0,0 +1,11 @@ +PRIVATE_HEADER +-------------- + +Specify private header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +PrivateHeaders directory inside the framework folder. On non-Apple +platforms these headers may be installed using the PRIVATE_HEADER +option to the install(TARGETS) command. diff --git a/Help/prop_tgt/PROJECT_LABEL.rst b/Help/prop_tgt/PROJECT_LABEL.rst new file mode 100644 index 0000000..a1491ee --- /dev/null +++ b/Help/prop_tgt/PROJECT_LABEL.rst @@ -0,0 +1,7 @@ +PROJECT_LABEL +------------- + +Change the name of a target in an IDE. + +Can be used to change the name of the target in an IDE like Visual +Studio. diff --git a/Help/prop_tgt/PUBLIC_HEADER.rst b/Help/prop_tgt/PUBLIC_HEADER.rst new file mode 100644 index 0000000..6e25d94 --- /dev/null +++ b/Help/prop_tgt/PUBLIC_HEADER.rst @@ -0,0 +1,11 @@ +PUBLIC_HEADER +------------- + +Specify public header files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of header files to be placed in the +Headers directory inside the framework folder. On non-Apple platforms +these headers may be installed using the PUBLIC_HEADER option to the +install(TARGETS) command. diff --git a/Help/prop_tgt/RESOURCE.rst b/Help/prop_tgt/RESOURCE.rst new file mode 100644 index 0000000..1e9921d --- /dev/null +++ b/Help/prop_tgt/RESOURCE.rst @@ -0,0 +1,11 @@ +RESOURCE +-------- + +Specify resource files in a FRAMEWORK shared library target. + +Shared library targets marked with the FRAMEWORK property generate +frameworks on OS X and normal shared libraries on other platforms. +This property may be set to a list of files to be placed in the +Resources directory inside the framework folder. On non-Apple +platforms these files may be installed using the RESOURCE option to +the install(TARGETS) command. diff --git a/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst new file mode 100644 index 0000000..e92ab86 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_COMPILE.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_COMPILE +------------------- + +Specify a launcher for compile rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst new file mode 100644 index 0000000..2db0317 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_CUSTOM.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_CUSTOM +------------------ + +Specify a launcher for custom rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RULE_LAUNCH_LINK.rst b/Help/prop_tgt/RULE_LAUNCH_LINK.rst new file mode 100644 index 0000000..f330033 --- /dev/null +++ b/Help/prop_tgt/RULE_LAUNCH_LINK.rst @@ -0,0 +1,7 @@ +RULE_LAUNCH_LINK +---------------- + +Specify a launcher for link rules. + +See the global property of the same name for details. This overrides +the global and directory property for a target. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..af5ef44 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,7 @@ +RUNTIME_OUTPUT_DIRECTORY +------------------------ + +.. |XXX| replace:: RUNTIME +.. |xxx| replace:: runtime +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_RUNTIME_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..10be6cf --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,11 @@ +RUNTIME_OUTPUT_DIRECTORY_<CONFIG> +--------------------------------- + +Per-configuration output directory for RUNTIME target files. + +This is a per-configuration version of RUNTIME_OUTPUT_DIRECTORY, but +multi-configuration generators (VS, Xcode) do NOT append a +per-configuration subdirectory to the specified directory. This +property is initialized by the value of the variable +CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is +created. diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst new file mode 100644 index 0000000..dc7dba4 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -0,0 +1,6 @@ +RUNTIME_OUTPUT_NAME +------------------- + +.. |XXX| replace:: RUNTIME +.. |xxx| replace:: runtime +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst new file mode 100644 index 0000000..f9029e5 --- /dev/null +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG.rst @@ -0,0 +1,6 @@ +RUNTIME_OUTPUT_NAME_<CONFIG> +---------------------------- + +Per-configuration output name for RUNTIME target files. + +This is the configuration-specific version of RUNTIME_OUTPUT_NAME. diff --git a/Help/prop_tgt/SKIP_BUILD_RPATH.rst b/Help/prop_tgt/SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000..a91fa9c --- /dev/null +++ b/Help/prop_tgt/SKIP_BUILD_RPATH.rst @@ -0,0 +1,9 @@ +SKIP_BUILD_RPATH +---------------- + +Should rpaths be used for the build tree. + +SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic +generation of an rpath allowing the target to run from the build tree. +This property is initialized by the value of the variable +CMAKE_SKIP_BUILD_RPATH if it is set when a target is created. diff --git a/Help/prop_tgt/SOURCES.rst b/Help/prop_tgt/SOURCES.rst new file mode 100644 index 0000000..833b65a --- /dev/null +++ b/Help/prop_tgt/SOURCES.rst @@ -0,0 +1,7 @@ +SOURCES +------- + +Source names specified for a target. + +Read-only list of sources specified for a target. The names returned +are suitable for passing to the set_source_files_properties command. diff --git a/Help/prop_tgt/SOVERSION.rst b/Help/prop_tgt/SOVERSION.rst new file mode 100644 index 0000000..672ff23 --- /dev/null +++ b/Help/prop_tgt/SOVERSION.rst @@ -0,0 +1,14 @@ +SOVERSION +--------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. +SOVERSION is ignored if NO_SONAME property is set. For shared +libraries and executables on Windows the VERSION attribute is parsed +to extract a "major.minor" version number. These numbers are used as +the image version of the binary. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst new file mode 100644 index 0000000..d3b2cd4 --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS +-------------------- + +Extra flags to use when linking static libraries. + +Extra flags to use when linking a static library. diff --git a/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst new file mode 100644 index 0000000..cca353d --- /dev/null +++ b/Help/prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +STATIC_LIBRARY_FLAGS_<CONFIG> +----------------------------- + +Per-configuration flags for creating a static library. + +This is the configuration-specific version of STATIC_LIBRARY_FLAGS. diff --git a/Help/prop_tgt/SUFFIX.rst b/Help/prop_tgt/SUFFIX.rst new file mode 100644 index 0000000..70844be --- /dev/null +++ b/Help/prop_tgt/SUFFIX.rst @@ -0,0 +1,7 @@ +SUFFIX +------ + +What comes after the target name. + +A target property that can be set to override the suffix (such as +".so" or ".exe") on the name of a library, module or executable. diff --git a/Help/prop_tgt/TARGET_FILE_TYPES.txt b/Help/prop_tgt/TARGET_FILE_TYPES.txt new file mode 100644 index 0000000..18489c7 --- /dev/null +++ b/Help/prop_tgt/TARGET_FILE_TYPES.txt @@ -0,0 +1,9 @@ +There are three kinds of target files that may be built: archive, +library, and runtime. Executables are always treated as runtime +targets. Static libraries are always treated as archive targets. +Module libraries are always treated as library targets. For +non-DLL platforms shared libraries are treated as library +targets. For DLL platforms the DLL part of a shared library is +treated as a runtime target and the corresponding import library +is treated as an archive target. All Windows-based systems +including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/TYPE.rst b/Help/prop_tgt/TYPE.rst new file mode 100644 index 0000000..1951d46 --- /dev/null +++ b/Help/prop_tgt/TYPE.rst @@ -0,0 +1,8 @@ +TYPE +---- + +The type of the target. + +This read-only property can be used to test the type of the given +target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, +SHARED_LIBRARY, EXECUTABLE or one of the internal target types. diff --git a/Help/prop_tgt/VERSION.rst b/Help/prop_tgt/VERSION.rst new file mode 100644 index 0000000..87f6c49 --- /dev/null +++ b/Help/prop_tgt/VERSION.rst @@ -0,0 +1,16 @@ +VERSION +------- + +What version number is this target. + +For shared libraries VERSION and SOVERSION can be used to specify the +build version and API version respectively. When building or +installing appropriate symlinks are created if the platform supports +symlinks and the linker supports so-names. If only one of both is +specified the missing is assumed to have the same version number. For +executables VERSION can be used to specify the build version. When +building or installing appropriate symlinks are created if the +platform supports symlinks. For shared libraries and executables on +Windows the VERSION attribute is parsed to extract a "major.minor" +version number. These numbers are used as the image version of the +binary. diff --git a/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000..3754410 --- /dev/null +++ b/Help/prop_tgt/VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,11 @@ +VISIBILITY_INLINES_HIDDEN +------------------------- + +Whether to add a compile flag to hide symbols of inline functions + +The VISIBILITY_INLINES_HIDDEN property determines whether a flag for +hiding symbols for inline functions. the value passed used in a +visibility related compile option, such as -fvisibility=. This +property only has an affect for libraries and executables with +exports. This property is initialized by the value of the variable +CMAKE_VISIBILITY_INLINES_HIDDEN if it is set when a target is created. diff --git a/Help/prop_tgt/VS_DOTNET_REFERENCES.rst b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst new file mode 100644 index 0000000..a661ad9 --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_DOTNET_REFERENCES +-------------------- + +Visual Studio managed project .NET references + +Adds one or more semicolon-delimited .NET references to a generated +Visual Studio project. For example, "System;System.Windows.Forms". diff --git a/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst new file mode 100644 index 0000000..829d696 --- /dev/null +++ b/Help/prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION.rst @@ -0,0 +1,7 @@ +VS_DOTNET_TARGET_FRAMEWORK_VERSION +---------------------------------- + +Specify the .NET target framework version. + +Used to specify the .NET target framework version for C++/CLI. For +example, "v4.5". diff --git a/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst new file mode 100644 index 0000000..072475f --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_KEYWORD.rst @@ -0,0 +1,9 @@ +VS_GLOBAL_KEYWORD +----------------- + +Visual Studio project keyword. + +Sets the "keyword" attribute for a generated Visual Studio project. +Defaults to "Win32Proj". You may wish to override this value with +"ManagedCProj", for example, in a Visual Studio managed C++ unit test +project. diff --git a/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst new file mode 100644 index 0000000..f4d9efc --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_PROJECT_TYPES.rst @@ -0,0 +1,15 @@ +VS_GLOBAL_PROJECT_TYPES +----------------------- + +Visual Studio project type(s). + +Can be set to one or more UUIDs recognized by Visual Studio to +indicate the type of project. This value is copied verbatim into the +generated project file. Example for a managed C++ unit testing +project: + +:: + + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942} + +UUIDs are semicolon-delimited. diff --git a/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst new file mode 100644 index 0000000..a23c540 --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_ROOTNAMESPACE.rst @@ -0,0 +1,7 @@ +VS_GLOBAL_ROOTNAMESPACE +----------------------- + +Visual Studio project root namespace. + +Sets the "RootNamespace" attribute for a generated Visual Studio +project. The attribute will be generated only if this is set. diff --git a/Help/prop_tgt/VS_GLOBAL_variable.rst b/Help/prop_tgt/VS_GLOBAL_variable.rst new file mode 100644 index 0000000..56b8021 --- /dev/null +++ b/Help/prop_tgt/VS_GLOBAL_variable.rst @@ -0,0 +1,10 @@ +VS_GLOBAL_<variable> +-------------------- + +Visual Studio project-specific global variable. + +Tell the Visual Studio generator to set the global variable +'<variable>' to a given value in the generated Visual Studio project. +Ignored on other generators. Qt integration works better if +VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For +example, "4.7.3" diff --git a/Help/prop_tgt/VS_KEYWORD.rst b/Help/prop_tgt/VS_KEYWORD.rst new file mode 100644 index 0000000..aa8e206 --- /dev/null +++ b/Help/prop_tgt/VS_KEYWORD.rst @@ -0,0 +1,7 @@ +VS_KEYWORD +---------- + +Visual Studio project keyword. + +Can be set to change the visual studio keyword, for example Qt +integration works better if this is set to Qt4VSv1.0. diff --git a/Help/prop_tgt/VS_SCC_AUXPATH.rst b/Help/prop_tgt/VS_SCC_AUXPATH.rst new file mode 100644 index 0000000..054f59e --- /dev/null +++ b/Help/prop_tgt/VS_SCC_AUXPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_AUXPATH +-------------- + +Visual Studio Source Code Control Aux Path. + +Can be set to change the visual studio source code control auxpath +property. diff --git a/Help/prop_tgt/VS_SCC_LOCALPATH.rst b/Help/prop_tgt/VS_SCC_LOCALPATH.rst new file mode 100644 index 0000000..b5b7721 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_LOCALPATH.rst @@ -0,0 +1,7 @@ +VS_SCC_LOCALPATH +---------------- + +Visual Studio Source Code Control Local Path. + +Can be set to change the visual studio source code control local path +property. diff --git a/Help/prop_tgt/VS_SCC_PROJECTNAME.rst b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst new file mode 100644 index 0000000..6d7f628 --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROJECTNAME.rst @@ -0,0 +1,7 @@ +VS_SCC_PROJECTNAME +------------------ + +Visual Studio Source Code Control Project. + +Can be set to change the visual studio source code control project +name property. diff --git a/Help/prop_tgt/VS_SCC_PROVIDER.rst b/Help/prop_tgt/VS_SCC_PROVIDER.rst new file mode 100644 index 0000000..80475af --- /dev/null +++ b/Help/prop_tgt/VS_SCC_PROVIDER.rst @@ -0,0 +1,7 @@ +VS_SCC_PROVIDER +--------------- + +Visual Studio Source Code Control Provider. + +Can be set to change the visual studio source code control provider +property. diff --git a/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst new file mode 100644 index 0000000..cc6fb16 --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_EXTENSIONS.rst @@ -0,0 +1,6 @@ +VS_WINRT_EXTENSIONS +------------------- + +Visual Studio project C++/CX language extensions for Windows Runtime + +Can be set to enable C++/CX language extensions. diff --git a/Help/prop_tgt/VS_WINRT_REFERENCES.rst b/Help/prop_tgt/VS_WINRT_REFERENCES.rst new file mode 100644 index 0000000..af98b2f --- /dev/null +++ b/Help/prop_tgt/VS_WINRT_REFERENCES.rst @@ -0,0 +1,7 @@ +VS_WINRT_REFERENCES +------------------- + +Visual Studio project Windows Runtime Metadata references + +Adds one or more semicolon-delimited WinRT references to a generated +Visual Studio project. For example, "Windows;Windows.UI.Core". diff --git a/Help/prop_tgt/WIN32_EXECUTABLE.rst b/Help/prop_tgt/WIN32_EXECUTABLE.rst new file mode 100644 index 0000000..336d5f7 --- /dev/null +++ b/Help/prop_tgt/WIN32_EXECUTABLE.rst @@ -0,0 +1,12 @@ +WIN32_EXECUTABLE +---------------- + +Build an executable with a WinMain entry point on windows. + +When this property is set to true the executable when linked on +Windows will be created with a WinMain() entry point instead of just +main(). This makes it a GUI executable instead of a console +application. See the CMAKE_MFC_FLAG variable documentation to +configure use of MFC for WinMain executables. This property is +initialized by the value of the variable CMAKE_WIN32_EXECUTABLE if it +is set when a target is created. diff --git a/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst new file mode 100644 index 0000000..0be313c --- /dev/null +++ b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst @@ -0,0 +1,7 @@ +XCODE_ATTRIBUTE_<an-attribute> +------------------------------ + +Set Xcode target attributes directly. + +Tell the Xcode generator to set '<an-attribute>' to a given value in +the generated Xcode project. Ignored on other generators. diff --git a/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt new file mode 100644 index 0000000..65abbce --- /dev/null +++ b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt @@ -0,0 +1,10 @@ +Output directory in which to build |XXX| target files. + +This property specifies the directory into which |xxx| target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. + +.. include:: TARGET_FILE_TYPES.txt + +This property is initialized by the value of the variable +|CMAKE_XXX_OUTPUT_DIRECTORY| if it is set when a target is created. diff --git a/Help/prop_tgt/XXX_OUTPUT_NAME.txt b/Help/prop_tgt/XXX_OUTPUT_NAME.txt new file mode 100644 index 0000000..9c4fc7c --- /dev/null +++ b/Help/prop_tgt/XXX_OUTPUT_NAME.txt @@ -0,0 +1,6 @@ +Output name for |XXX| target files. + +This property specifies the base name for |xxx| target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. + +.. include:: TARGET_FILE_TYPES.txt diff --git a/Help/variable/APPLE.rst b/Help/variable/APPLE.rst new file mode 100644 index 0000000..3afdee8 --- /dev/null +++ b/Help/variable/APPLE.rst @@ -0,0 +1,6 @@ +APPLE +----- + +True if running on Mac OS X. + +Set to true on Mac OS X. diff --git a/Help/variable/BORLAND.rst b/Help/variable/BORLAND.rst new file mode 100644 index 0000000..4af6085 --- /dev/null +++ b/Help/variable/BORLAND.rst @@ -0,0 +1,6 @@ +BORLAND +------- + +True if the Borland compiler is being used. + +This is set to true if the Borland compiler is being used. diff --git a/Help/variable/BUILD_SHARED_LIBS.rst b/Help/variable/BUILD_SHARED_LIBS.rst new file mode 100644 index 0000000..6f30efb --- /dev/null +++ b/Help/variable/BUILD_SHARED_LIBS.rst @@ -0,0 +1,10 @@ +BUILD_SHARED_LIBS +----------------- + +Global flag to cause add_library to create shared libraries if on. + +If present and true, this will cause all libraries to be built shared +unless the library was explicitly added as a static library. This +variable is often added to projects as an OPTION so that each user of +a project can decide if they want to build the project using shared or +static libraries. diff --git a/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst b/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst new file mode 100644 index 0000000..3691453 --- /dev/null +++ b/Help/variable/CMAKE_ABSOLUTE_DESTINATION_FILES.rst @@ -0,0 +1,9 @@ +CMAKE_ABSOLUTE_DESTINATION_FILES +-------------------------------- + +List of files which have been installed using an ABSOLUTE DESTINATION path. + +This variable is defined by CMake-generated cmake_install.cmake +scripts. It can be used (read-only) by programs or scripts that +source those install scripts. This is used by some CPack generators +(e.g. RPM). diff --git a/Help/variable/CMAKE_AR.rst b/Help/variable/CMAKE_AR.rst new file mode 100644 index 0000000..5893677 --- /dev/null +++ b/Help/variable/CMAKE_AR.rst @@ -0,0 +1,7 @@ +CMAKE_AR +-------- + +Name of archiving tool for static libraries. + +This specifies the name of the program that creates archive or static +libraries. diff --git a/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..6a22f73 --- /dev/null +++ b/Help/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_ARCHIVE_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the ARCHIVE targets when built. + +This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_ARGC.rst b/Help/variable/CMAKE_ARGC.rst new file mode 100644 index 0000000..be120b8 --- /dev/null +++ b/Help/variable/CMAKE_ARGC.rst @@ -0,0 +1,7 @@ +CMAKE_ARGC +---------- + +Number of command line arguments passed to CMake in script mode. + +When run in -P script mode, CMake sets this variable to the number of +command line arguments. See also CMAKE_ARGV0, 1, 2 ... diff --git a/Help/variable/CMAKE_ARGV0.rst b/Help/variable/CMAKE_ARGV0.rst new file mode 100644 index 0000000..e5ed419 --- /dev/null +++ b/Help/variable/CMAKE_ARGV0.rst @@ -0,0 +1,9 @@ +CMAKE_ARGV0 +----------- + +Command line argument passed to CMake in script mode. + +When run in -P script mode, CMake sets this variable to the first +command line argument. It then also sets CMAKE_ARGV1, CMAKE_ARGV2, +... and so on, up to the number of command line arguments given. See +also CMAKE_ARGC. diff --git a/Help/variable/CMAKE_AUTOMOC.rst b/Help/variable/CMAKE_AUTOMOC.rst new file mode 100644 index 0000000..87e8a9b --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC.rst @@ -0,0 +1,7 @@ +CMAKE_AUTOMOC +------------- + +Whether to handle moc automatically for Qt targets. + +This variable is used to initialize the AUTOMOC property on all the +targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst b/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst new file mode 100644 index 0000000..bdbed85 --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC_MOC_OPTIONS.rst @@ -0,0 +1,8 @@ +CMAKE_AUTOMOC_MOC_OPTIONS +------------------------- + +Additional options for moc when using automoc (see CMAKE_AUTOMOC). + +This variable is used to initialize the AUTOMOC_MOC_OPTIONS property +on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst b/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst new file mode 100644 index 0000000..8858410 --- /dev/null +++ b/Help/variable/CMAKE_AUTOMOC_RELAXED_MODE.rst @@ -0,0 +1,13 @@ +CMAKE_AUTOMOC_RELAXED_MODE +-------------------------- + +Switch between strict and relaxed automoc mode. + +By default, automoc behaves exactly as described in the documentation +of the AUTOMOC target property. When set to TRUE, it accepts more +input and tries to find the correct input file for moc even if it +differs from the documented behaviour. In this mode it e.g. also +checks whether a header file is intended to be processed by moc when a +"foo.moc" file has been included. + +Relaxed mode has to be enabled for KDE4 compatibility. diff --git a/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst b/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst new file mode 100644 index 0000000..4015739 --- /dev/null +++ b/Help/variable/CMAKE_BACKWARDS_COMPATIBILITY.rst @@ -0,0 +1,11 @@ +CMAKE_BACKWARDS_COMPATIBILITY +----------------------------- + +Version of cmake required to build project + +From the point of view of backwards compatibility, this specifies what +version of CMake should be supported. By default this value is the +version number of CMake that you are running. You can set this to an +older version of CMake to support deprecated commands of CMake in +projects that were written to use older versions of CMake. This can +be set by the user or set at the beginning of a CMakeLists file. diff --git a/Help/variable/CMAKE_BINARY_DIR.rst b/Help/variable/CMAKE_BINARY_DIR.rst new file mode 100644 index 0000000..703bb58 --- /dev/null +++ b/Help/variable/CMAKE_BINARY_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_BINARY_DIR +---------------- + +The path to the top level of the build tree. + +This is the full path to the top level of the current CMake build +tree. For an in-source build, this would be the same as +CMAKE_SOURCE_DIR. diff --git a/Help/variable/CMAKE_BUILD_TOOL.rst b/Help/variable/CMAKE_BUILD_TOOL.rst new file mode 100644 index 0000000..f0bc938 --- /dev/null +++ b/Help/variable/CMAKE_BUILD_TOOL.rst @@ -0,0 +1,11 @@ +CMAKE_BUILD_TOOL +---------------- + +Tool used for the actual build process. + +This variable is set to the program that will be needed to build the +output of CMake. If the generator selected was Visual Studio 6, the +CMAKE_BUILD_TOOL will be set to msdev, for Unix Makefiles it will be +set to make or gmake, and for Visual Studio 7 it set to devenv. For +NMake Makefiles the value is nmake. This can be useful for adding +special flags and commands based on the final build environment. diff --git a/Help/variable/CMAKE_BUILD_TYPE.rst b/Help/variable/CMAKE_BUILD_TYPE.rst new file mode 100644 index 0000000..68f08ba --- /dev/null +++ b/Help/variable/CMAKE_BUILD_TYPE.rst @@ -0,0 +1,19 @@ +CMAKE_BUILD_TYPE +---------------- + +Specifies the build type on single-configuration generators. + +This statically specifies what build type (configuration) will be +built in this build tree. Possible values are empty, Debug, Release, +RelWithDebInfo and MinSizeRel. This variable is only meaningful to +single-configuration generators (such as make and Ninja) i.e. those +which choose a single configuration when CMake runs to generate a +build tree as opposed to multi-configuration generators which offer +selection of the build configuration within the generated build +environment. There are many per-config properties and variables +(usually following clean SOME_VAR_<CONFIG> order conventions), such as +CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: +CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. For example, +in a build tree configured to build type Debug, CMake will see to +having CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS +settings. See also CMAKE_CONFIGURATION_TYPES. diff --git a/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst new file mode 100644 index 0000000..6875da6 --- /dev/null +++ b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst @@ -0,0 +1,11 @@ +CMAKE_BUILD_WITH_INSTALL_RPATH +------------------------------ + +Use the install path for the RPATH + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always built with the install path for the RPATH and does not need to +be relinked when installed. diff --git a/Help/variable/CMAKE_CACHEFILE_DIR.rst b/Help/variable/CMAKE_CACHEFILE_DIR.rst new file mode 100644 index 0000000..78c7d93 --- /dev/null +++ b/Help/variable/CMAKE_CACHEFILE_DIR.rst @@ -0,0 +1,7 @@ +CMAKE_CACHEFILE_DIR +------------------- + +The directory with the CMakeCache.txt file. + +This is the full path to the directory that has the CMakeCache.txt +file in it. This is the same as CMAKE_BINARY_DIR. diff --git a/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst b/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst new file mode 100644 index 0000000..e6887d9 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_MAJOR_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_MAJOR_VERSION +------------------------- + +Major version of CMake used to create the CMakeCache.txt file + +This stores the major version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst b/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst new file mode 100644 index 0000000..799f0a9 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_MINOR_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_MINOR_VERSION +------------------------- + +Minor version of CMake used to create the CMakeCache.txt file + +This stores the minor version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst b/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst new file mode 100644 index 0000000..e67d544 --- /dev/null +++ b/Help/variable/CMAKE_CACHE_PATCH_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_CACHE_PATCH_VERSION +------------------------- + +Patch version of CMake used to create the CMakeCache.txt file + +This stores the patch version of CMake used to write a CMake cache +file. It is only different when a different version of CMake is run +on a previously created cache file. diff --git a/Help/variable/CMAKE_CFG_INTDIR.rst b/Help/variable/CMAKE_CFG_INTDIR.rst new file mode 100644 index 0000000..20435e5 --- /dev/null +++ b/Help/variable/CMAKE_CFG_INTDIR.rst @@ -0,0 +1,45 @@ +CMAKE_CFG_INTDIR +---------------- + +Build-time reference to per-configuration output subdirectory. + +For native build systems supporting multiple configurations in the +build tree (such as Visual Studio and Xcode), the value is a reference +to a build-time variable specifying the name of the per-configuration +output subdirectory. On Makefile generators this evaluates to "." +because there is only one configuration in a build tree. Example +values: + +:: + + $(IntDir) = Visual Studio 6 + $(OutDir) = Visual Studio 7, 8, 9 + $(Configuration) = Visual Studio 10 + $(CONFIGURATION) = Xcode + . = Make-based tools + +Since these values are evaluated by the native build system, this +variable is suitable only for use in command lines that will be +evaluated at build time. Example of intended usage: + +:: + + add_executable(mytool mytool.c) + add_custom_command( + OUTPUT out.txt + COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool + ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt + DEPENDS mytool in.txt + ) + add_custom_target(drive ALL DEPENDS out.txt) + +Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but +has been left for compatibility with existing projects. Instead +add_custom_command() recognizes executable target names in its COMMAND +option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool" +can be replaced by just "mytool". + +This variable is read-only. Setting it is undefined behavior. In +multi-configuration build systems the value of this variable is passed +as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation +of all source files. diff --git a/Help/variable/CMAKE_CL_64.rst b/Help/variable/CMAKE_CL_64.rst new file mode 100644 index 0000000..5096829 --- /dev/null +++ b/Help/variable/CMAKE_CL_64.rst @@ -0,0 +1,6 @@ +CMAKE_CL_64 +----------- + +Using the 64 bit compiler from Microsoft + +Set to true when using the 64 bit cl compiler from Microsoft. diff --git a/Help/variable/CMAKE_COLOR_MAKEFILE.rst b/Help/variable/CMAKE_COLOR_MAKEFILE.rst new file mode 100644 index 0000000..170baf3 --- /dev/null +++ b/Help/variable/CMAKE_COLOR_MAKEFILE.rst @@ -0,0 +1,7 @@ +CMAKE_COLOR_MAKEFILE +-------------------- + +Enables color output when using the Makefile generator. + +When enabled, the generated Makefiles will produce colored output. +Default is ON. diff --git a/Help/variable/CMAKE_COMMAND.rst b/Help/variable/CMAKE_COMMAND.rst new file mode 100644 index 0000000..f4e5f1e --- /dev/null +++ b/Help/variable/CMAKE_COMMAND.rst @@ -0,0 +1,8 @@ +CMAKE_COMMAND +------------- + +The full path to the cmake executable. + +This is the full path to the CMake executable cmake which is useful +from custom commands that want to use the cmake -E option for portable +system commands. (e.g. /usr/local/bin/cmake diff --git a/Help/variable/CMAKE_COMPILER_2005.rst b/Help/variable/CMAKE_COMPILER_2005.rst new file mode 100644 index 0000000..134559b --- /dev/null +++ b/Help/variable/CMAKE_COMPILER_2005.rst @@ -0,0 +1,6 @@ +CMAKE_COMPILER_2005 +------------------- + +Using the Visual Studio 2005 compiler from Microsoft + +Set to true when using the Visual Studio 2005 compiler from Microsoft. diff --git a/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst b/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst new file mode 100644 index 0000000..bc5652f --- /dev/null +++ b/Help/variable/CMAKE_COMPILER_IS_GNULANG.rst @@ -0,0 +1,15 @@ +CMAKE_COMPILER_IS_GNU<LANG> +--------------------------- + +True if the compiler is GNU. + +If the selected <LANG> compiler is the GNU compiler then this is TRUE, +if not it is FALSE. Unlike the other per-language variables, this +uses the GNU syntax for identifying languages instead of the CMake +syntax. Recognized values of the <LANG> suffix are: + +:: + + CC = C compiler + CXX = C++ compiler + G77 = Fortran compiler diff --git a/Help/variable/CMAKE_CONFIGURATION_TYPES.rst b/Help/variable/CMAKE_CONFIGURATION_TYPES.rst new file mode 100644 index 0000000..986b969 --- /dev/null +++ b/Help/variable/CMAKE_CONFIGURATION_TYPES.rst @@ -0,0 +1,10 @@ +CMAKE_CONFIGURATION_TYPES +------------------------- + +Specifies the available build types on multi-config generators. + +This specifies what build types (configurations) will be available +such as Debug, Release, RelWithDebInfo etc. This has reasonable +defaults on most platforms, but can be extended to provide other build +types. See also CMAKE_BUILD_TYPE for details of managing +configuration data, and CMAKE_CFG_INTDIR. diff --git a/Help/variable/CMAKE_CONFIG_POSTFIX.rst b/Help/variable/CMAKE_CONFIG_POSTFIX.rst new file mode 100644 index 0000000..af38bed --- /dev/null +++ b/Help/variable/CMAKE_CONFIG_POSTFIX.rst @@ -0,0 +1,7 @@ +CMAKE_<CONFIG>_POSTFIX +---------------------- + +Default filename postfix for libraries under configuration <CONFIG>. + +When a non-executable target is created its <CONFIG>_POSTFIX target +property is initialized with the value of this variable if it is set. diff --git a/Help/variable/CMAKE_CROSSCOMPILING.rst b/Help/variable/CMAKE_CROSSCOMPILING.rst new file mode 100644 index 0000000..cf9865b --- /dev/null +++ b/Help/variable/CMAKE_CROSSCOMPILING.rst @@ -0,0 +1,8 @@ +CMAKE_CROSSCOMPILING +-------------------- + +Is CMake currently cross compiling. + +This variable will be set to true by CMake if CMake is cross +compiling. Specifically if the build platform is different from the +target platform. diff --git a/Help/variable/CMAKE_CTEST_COMMAND.rst b/Help/variable/CMAKE_CTEST_COMMAND.rst new file mode 100644 index 0000000..d5dd2c3 --- /dev/null +++ b/Help/variable/CMAKE_CTEST_COMMAND.rst @@ -0,0 +1,8 @@ +CMAKE_CTEST_COMMAND +------------------- + +Full path to ctest command installed with cmake. + +This is the full path to the CTest executable ctest which is useful +from custom commands that want to use the cmake -E option for portable +system commands. diff --git a/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst new file mode 100644 index 0000000..fb55a11 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_BINARY_DIR.rst @@ -0,0 +1,10 @@ +CMAKE_CURRENT_BINARY_DIR +------------------------ + +The path to the binary directory currently being processed. + +This the full path to the build directory that is currently being +processed by cmake. Each directory added by add_subdirectory will +create a binary directory in the build tree, and as it is being +processed this variable will be set. For in-source builds this is the +current source directory being processed. diff --git a/Help/variable/CMAKE_CURRENT_LIST_DIR.rst b/Help/variable/CMAKE_CURRENT_LIST_DIR.rst new file mode 100644 index 0000000..b816821 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_DIR.rst @@ -0,0 +1,17 @@ +CMAKE_CURRENT_LIST_DIR +---------------------- + +Full directory of the listfile currently being processed. + +As CMake processes the listfiles in your project this variable will +always be set to the directory where the listfile which is currently +being processed (CMAKE_CURRENT_LIST_FILE) is located. The value has +dynamic scope. When CMake starts processing commands in a source file +it sets this variable to the directory where this file is located. +When CMake finishes processing commands from the file it restores the +previous value. Therefore the value of the variable inside a macro or +function is the directory of the file invoking the bottom-most entry +on the call stack, not the directory of the file containing the macro +or function definition. + +See also CMAKE_CURRENT_LIST_FILE. diff --git a/Help/variable/CMAKE_CURRENT_LIST_FILE.rst b/Help/variable/CMAKE_CURRENT_LIST_FILE.rst new file mode 100644 index 0000000..910d7b4 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_FILE.rst @@ -0,0 +1,15 @@ +CMAKE_CURRENT_LIST_FILE +----------------------- + +Full path to the listfile currently being processed. + +As CMake processes the listfiles in your project this variable will +always be set to the one currently being processed. The value has +dynamic scope. When CMake starts processing commands in a source file +it sets this variable to the location of the file. When CMake +finishes processing commands from the file it restores the previous +value. Therefore the value of the variable inside a macro or function +is the file invoking the bottom-most entry on the call stack, not the +file containing the macro or function definition. + +See also CMAKE_PARENT_LIST_FILE. diff --git a/Help/variable/CMAKE_CURRENT_LIST_LINE.rst b/Help/variable/CMAKE_CURRENT_LIST_LINE.rst new file mode 100644 index 0000000..60e8e26 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_LIST_LINE.rst @@ -0,0 +1,7 @@ +CMAKE_CURRENT_LIST_LINE +----------------------- + +The line number of the current file being processed. + +This is the line number of the file currently being processed by +cmake. diff --git a/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst new file mode 100644 index 0000000..db063a4 --- /dev/null +++ b/Help/variable/CMAKE_CURRENT_SOURCE_DIR.rst @@ -0,0 +1,7 @@ +CMAKE_CURRENT_SOURCE_DIR +------------------------ + +The path to the source directory currently being processed. + +This the full path to the source directory that is currently being +processed by cmake. diff --git a/Help/variable/CMAKE_DEBUG_POSTFIX.rst b/Help/variable/CMAKE_DEBUG_POSTFIX.rst new file mode 100644 index 0000000..fde24b2 --- /dev/null +++ b/Help/variable/CMAKE_DEBUG_POSTFIX.rst @@ -0,0 +1,7 @@ +CMAKE_DEBUG_POSTFIX +------------------- + +See variable CMAKE_<CONFIG>_POSTFIX. + +This variable is a special case of the more-general +CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration. diff --git a/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst b/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst new file mode 100644 index 0000000..2ded823 --- /dev/null +++ b/Help/variable/CMAKE_DEBUG_TARGET_PROPERTIES.rst @@ -0,0 +1,11 @@ +CMAKE_DEBUG_TARGET_PROPERTIES +----------------------------- + +Enables tracing output for target properties. + +This variable can be populated with a list of properties to generate +debug output for when evaluating target properties. Currently it can +only be used when evaluating the INCLUDE_DIRECTORIES, +COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties. In that +case, it outputs a backtrace for each entry in the target property. +Default is unset. diff --git a/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst b/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst new file mode 100644 index 0000000..bcb277c --- /dev/null +++ b/Help/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.rst @@ -0,0 +1,15 @@ +CMAKE_DISABLE_FIND_PACKAGE_<PackageName> +---------------------------------------- + +Variable for disabling find_package() calls. + +Every non-REQUIRED find_package() call in a project can be disabled by +setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. +This can be used to build a project without an optional package, +although that package is installed. + +This switch should be used during the initial CMake run. Otherwise if +the package has already been found in a previous CMake run, the +variables which have been stored in the cache will still be there. In +that case it is recommended to remove the cache variables for this +package from the cache using the cache editor or cmake -U diff --git a/Help/variable/CMAKE_DL_LIBS.rst b/Help/variable/CMAKE_DL_LIBS.rst new file mode 100644 index 0000000..cae4565 --- /dev/null +++ b/Help/variable/CMAKE_DL_LIBS.rst @@ -0,0 +1,7 @@ +CMAKE_DL_LIBS +------------- + +Name of library containing dlopen and dlcose. + +The name of the library that has dlopen and dlclose in it, usually +-ldl on most UNIX machines. diff --git a/Help/variable/CMAKE_EDIT_COMMAND.rst b/Help/variable/CMAKE_EDIT_COMMAND.rst new file mode 100644 index 0000000..24d26b5 --- /dev/null +++ b/Help/variable/CMAKE_EDIT_COMMAND.rst @@ -0,0 +1,7 @@ +CMAKE_EDIT_COMMAND +------------------ + +Full path to cmake-gui or ccmake. + +This is the full path to the CMake executable that can graphically +edit the cache. For example, cmake-gui, ccmake, or cmake -i. diff --git a/Help/variable/CMAKE_ERROR_DEPRECATED.rst b/Help/variable/CMAKE_ERROR_DEPRECATED.rst new file mode 100644 index 0000000..43ab282 --- /dev/null +++ b/Help/variable/CMAKE_ERROR_DEPRECATED.rst @@ -0,0 +1,8 @@ +CMAKE_ERROR_DEPRECATED +---------------------- + +Whether to issue deprecation errors for macros and functions. + +If TRUE, this can be used by macros and functions to issue fatal +errors when deprecated macros or functions are used. This variable is +FALSE by default. diff --git a/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..651d68d --- /dev/null +++ b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,9 @@ +CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------- + +Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL DESTINATION is encountered. + +The fatal error is emitted before the installation of the offending +file takes place. This variable is used by CMake-generated +cmake_install.cmake scripts. If one sets this variable to ON while +running the script, it may get fatal error messages from the script. diff --git a/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst b/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst new file mode 100644 index 0000000..45c313c --- /dev/null +++ b/Help/variable/CMAKE_EXECUTABLE_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_EXECUTABLE_SUFFIX +----------------------- + +The suffix for executables on this platform. + +The suffix to use for the end of an executable filename if any, .exe +on Windows. + +CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst new file mode 100644 index 0000000..9e108f8 --- /dev/null +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_EXE_LINKER_FLAGS +---------------------- + +Linker flags to be used to create executables. + +These flags will be used by the linker when creating an executable. diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..dcaf300 --- /dev/null +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_EXE_LINKER_FLAGS_<CONFIG> +------------------------------- + +Flags to be used when linking an executable. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating +executables. diff --git a/Help/variable/CMAKE_EXTRA_GENERATOR.rst b/Help/variable/CMAKE_EXTRA_GENERATOR.rst new file mode 100644 index 0000000..71aec92 --- /dev/null +++ b/Help/variable/CMAKE_EXTRA_GENERATOR.rst @@ -0,0 +1,9 @@ +CMAKE_EXTRA_GENERATOR +--------------------- + +The extra generator used to build the project. + +When using the Eclipse, CodeBlocks or KDevelop generators, CMake +generates Makefiles (CMAKE_GENERATOR) and additionally project files +for the respective IDE. This IDE project file generator is stored in +CMAKE_EXTRA_GENERATOR (e.g. "Eclipse CDT4"). diff --git a/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst b/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst new file mode 100644 index 0000000..6187a7a --- /dev/null +++ b/Help/variable/CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES +----------------------------------- + +Additional suffixes for shared libraries. + +Extensions for shared libraries other than that specified by +CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake uses this to recognize +external shared library files during analysis of libraries linked by a +target. diff --git a/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst b/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst new file mode 100644 index 0000000..1a9e7ce --- /dev/null +++ b/Help/variable/CMAKE_FIND_LIBRARY_PREFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_FIND_LIBRARY_PREFIXES +--------------------------- + +Prefixes to prepend when looking for libraries. + +This specifies what prefixes to add to library names when the +find_library command looks for libraries. On UNIX systems this is +typically lib, meaning that when trying to find the foo library it +will look for libfoo. diff --git a/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst b/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst new file mode 100644 index 0000000..c533909 --- /dev/null +++ b/Help/variable/CMAKE_FIND_LIBRARY_SUFFIXES.rst @@ -0,0 +1,9 @@ +CMAKE_FIND_LIBRARY_SUFFIXES +--------------------------- + +Suffixes to append when looking for libraries. + +This specifies what suffixes to add to library names when the +find_library command looks for libraries. On Windows systems this is +typically .lib and .dll, meaning that when trying to find the foo +library it will look for foo.dll etc. diff --git a/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst new file mode 100644 index 0000000..5d7599c --- /dev/null +++ b/Help/variable/CMAKE_FIND_PACKAGE_WARN_NO_MODULE.rst @@ -0,0 +1,19 @@ +CMAKE_FIND_PACKAGE_WARN_NO_MODULE +--------------------------------- + +Tell find_package to warn if called without an explicit mode. + +If find_package is called without an explicit mode option (MODULE, +CONFIG or NO_MODULE) and no Find<pkg>.cmake module is in +CMAKE_MODULE_PATH then CMake implicitly assumes that the caller +intends to search for a package configuration file. If no package +configuration file is found then the wording of the failure message +must account for both the case that the package is really missing and +the case that the project has a bug and failed to provide the intended +Find module. If instead the caller specifies an explicit mode option +then the failure message can be more specific. + +Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package to +warn when it implicitly assumes Config mode. This helps developers +enforce use of an explicit mode in all calls to find_package within a +project. diff --git a/Help/variable/CMAKE_Fortran_FORMAT.rst b/Help/variable/CMAKE_Fortran_FORMAT.rst new file mode 100644 index 0000000..c0e971c --- /dev/null +++ b/Help/variable/CMAKE_Fortran_FORMAT.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_FORMAT +-------------------- + +Set to FIXED or FREE to indicate the Fortran source layout. + +This variable is used to initialize the Fortran_FORMAT property on all +the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst b/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst new file mode 100644 index 0000000..a8dfcdf --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODDIR_DEFAULT.rst @@ -0,0 +1,8 @@ +CMAKE_Fortran_MODDIR_DEFAULT +---------------------------- + +Fortran default module output directory. + +Most Fortran compilers write .mod files to the current working +directory. For those that do not, this is set to "." and used when +the Fortran_MODULE_DIRECTORY target property is not set. diff --git a/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst b/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst new file mode 100644 index 0000000..4b32df3 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODDIR_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_MODDIR_FLAG +------------------------- + +Fortran flag for module output directory. + +This stores the flag needed to pass the value of the +Fortran_MODULE_DIRECTORY target property to the compiler. diff --git a/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst b/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst new file mode 100644 index 0000000..a232213 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODOUT_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_Fortran_MODOUT_FLAG +------------------------- + +Fortran flag to enable module output. + +Most Fortran compilers write .mod files out by default. For others, +this stores the flag needed to enable module output. diff --git a/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst b/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst new file mode 100644 index 0000000..b1d49d8 --- /dev/null +++ b/Help/variable/CMAKE_Fortran_MODULE_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_Fortran_MODULE_DIRECTORY +------------------------------ + +Fortran module output directory. + +This variable is used to initialize the Fortran_MODULE_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_GENERATOR.rst b/Help/variable/CMAKE_GENERATOR.rst new file mode 100644 index 0000000..a4e70a5 --- /dev/null +++ b/Help/variable/CMAKE_GENERATOR.rst @@ -0,0 +1,7 @@ +CMAKE_GENERATOR +--------------- + +The generator used to build the project. + +The name of the generator that is being used to generate the build +files. (e.g. "Unix Makefiles", "Visual Studio 6", etc.) diff --git a/Help/variable/CMAKE_GENERATOR_TOOLSET.rst b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst new file mode 100644 index 0000000..4540eaa --- /dev/null +++ b/Help/variable/CMAKE_GENERATOR_TOOLSET.rst @@ -0,0 +1,9 @@ +CMAKE_GENERATOR_TOOLSET +----------------------- + +Native build system toolset name specified by user. + +Some CMake generators support a toolset name to be given to the native +build system to choose a compiler. If the user specifies a toolset +name (e.g. via the cmake -T option) the value will be available in +this variable. diff --git a/Help/variable/CMAKE_GNUtoMS.rst b/Help/variable/CMAKE_GNUtoMS.rst new file mode 100644 index 0000000..e253f59 --- /dev/null +++ b/Help/variable/CMAKE_GNUtoMS.rst @@ -0,0 +1,8 @@ +CMAKE_GNUtoMS +------------- + +Convert GNU import libraries (.dll.a) to MS format (.lib). + +This variable is used to initialize the GNUtoMS property on targets +when they are created. See that target property for additional +information. diff --git a/Help/variable/CMAKE_HOME_DIRECTORY.rst b/Help/variable/CMAKE_HOME_DIRECTORY.rst new file mode 100644 index 0000000..fdc5d81 --- /dev/null +++ b/Help/variable/CMAKE_HOME_DIRECTORY.rst @@ -0,0 +1,6 @@ +CMAKE_HOME_DIRECTORY +-------------------- + +Path to top of source tree. + +This is the path to the top level of the source tree. diff --git a/Help/variable/CMAKE_HOST_APPLE.rst b/Help/variable/CMAKE_HOST_APPLE.rst new file mode 100644 index 0000000..d4b8483 --- /dev/null +++ b/Help/variable/CMAKE_HOST_APPLE.rst @@ -0,0 +1,6 @@ +CMAKE_HOST_APPLE +---------------- + +True for Apple OS X operating systems. + +Set to true when the host system is Apple OS X. diff --git a/Help/variable/CMAKE_HOST_SYSTEM.rst b/Help/variable/CMAKE_HOST_SYSTEM.rst new file mode 100644 index 0000000..4366ee3 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM +----------------- + +Name of system cmake is being run on. + +The same as CMAKE_SYSTEM but for the host system instead of the target +system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst b/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst new file mode 100644 index 0000000..718208a --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_NAME.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_NAME +---------------------- + +Name of the OS CMake is running on. + +The same as CMAKE_SYSTEM_NAME but for the host system instead of the +target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst b/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst new file mode 100644 index 0000000..2700b66 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_PROCESSOR.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_PROCESSOR +--------------------------- + +The name of the CPU CMake is running on. + +The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead of +the target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst b/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst new file mode 100644 index 0000000..a8451e8 --- /dev/null +++ b/Help/variable/CMAKE_HOST_SYSTEM_VERSION.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_SYSTEM_VERSION +------------------------- + +OS version CMake is running on. + +The same as CMAKE_SYSTEM_VERSION but for the host system instead of +the target system when cross compiling. diff --git a/Help/variable/CMAKE_HOST_UNIX.rst b/Help/variable/CMAKE_HOST_UNIX.rst new file mode 100644 index 0000000..bbefba7 --- /dev/null +++ b/Help/variable/CMAKE_HOST_UNIX.rst @@ -0,0 +1,7 @@ +CMAKE_HOST_UNIX +--------------- + +True for UNIX and UNIX like operating systems. + +Set to true when the host system is UNIX or UNIX like (i.e. APPLE and +CYGWIN). diff --git a/Help/variable/CMAKE_HOST_WIN32.rst b/Help/variable/CMAKE_HOST_WIN32.rst new file mode 100644 index 0000000..92ee456 --- /dev/null +++ b/Help/variable/CMAKE_HOST_WIN32.rst @@ -0,0 +1,6 @@ +CMAKE_HOST_WIN32 +---------------- + +True on windows systems, including win64. + +Set to true when the host system is Windows and on Cygwin. diff --git a/Help/variable/CMAKE_IGNORE_PATH.rst b/Help/variable/CMAKE_IGNORE_PATH.rst new file mode 100644 index 0000000..a818f74 --- /dev/null +++ b/Help/variable/CMAKE_IGNORE_PATH.rst @@ -0,0 +1,17 @@ +CMAKE_IGNORE_PATH +----------------- + +Path to be ignored by FIND_XXX() commands. + +Specifies directories to be ignored by searches in FIND_XXX() +commands. This is useful in cross-compiled environments where some +system directories contain incompatible but possibly linkable +libraries. For example, on cross-compiled cluster environments, this +allows a user to ignore directories containing libraries meant for the +front-end machine that modules like FindX11 (and others) would +normally search. By default this is empty; it is intended to be set +by the project. Note that CMAKE_IGNORE_PATH takes a list of directory +names, NOT a list of prefixes. If you want to ignore paths under +prefixes (bin, include, lib, etc.), you'll need to specify them +explicitly. See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, +CMAKE_INCLUDE_PATH, CMAKE_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..1d16a37 --- /dev/null +++ b/Help/variable/CMAKE_IMPORT_LIBRARY_PREFIX.rst @@ -0,0 +1,9 @@ +CMAKE_IMPORT_LIBRARY_PREFIX +--------------------------- + +The prefix for import libraries that you link to. + +The prefix to use for the name of an import library if used on this +platform. + +CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..c16825e --- /dev/null +++ b/Help/variable/CMAKE_IMPORT_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_IMPORT_LIBRARY_SUFFIX +--------------------------- + +The suffix for import libraries that you link to. + +The suffix to use for the end of an import library filename if used on +this platform. + +CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst new file mode 100644 index 0000000..79f3952 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR.rst @@ -0,0 +1,13 @@ +CMAKE_INCLUDE_CURRENT_DIR +------------------------- + +Automatically add the current source- and build directories to the include path. + +If this variable is enabled, CMake automatically adds in each +directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} +to the include path for this directory. These additional include +directories do not propagate down to subdirectories. This is useful +mainly for out-of-source builds, where files generated into the build +tree are included by files located in the source tree. + +By default CMAKE_INCLUDE_CURRENT_DIR is OFF. diff --git a/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst new file mode 100644 index 0000000..948db50 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE.rst @@ -0,0 +1,10 @@ +CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE +-------------------------------------- + +Automatically add the current source- and build directories to the INTERFACE_INCLUDE_DIRECTORIES. + +If this variable is enabled, CMake automatically adds for each shared +library target, static library target, module target and executable +target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to +the INTERFACE_INCLUDE_DIRECTORIES.By default +CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF. diff --git a/Help/variable/CMAKE_INCLUDE_PATH.rst b/Help/variable/CMAKE_INCLUDE_PATH.rst new file mode 100644 index 0000000..360b403 --- /dev/null +++ b/Help/variable/CMAKE_INCLUDE_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_INCLUDE_PATH +------------------ + +Path used for searching by FIND_FILE() and FIND_PATH(). + +Specifies a path which will be used both by FIND_FILE() and +FIND_PATH(). Both commands will check each of the contained +directories for the existence of the file which is currently searched. +By default it is empty, it is intended to be set by the project. See +also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst b/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst new file mode 100644 index 0000000..2ad0689 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME.rst @@ -0,0 +1,9 @@ +CMAKE_INSTALL_DEFAULT_COMPONENT_NAME +------------------------------------ + +Default component used in install() commands. + +If an install() command is used without the COMPONENT argument, these +files will be grouped into a default component. The name of this +default install component will be taken from this variable. It +defaults to "Unspecified". diff --git a/Help/variable/CMAKE_INSTALL_NAME_DIR.rst b/Help/variable/CMAKE_INSTALL_NAME_DIR.rst new file mode 100644 index 0000000..540df6b --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_NAME_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_INSTALL_NAME_DIR +---------------------- + +Mac OS X directory name for installed targets. + +CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR +property on all targets. See that target property for more +information. diff --git a/Help/variable/CMAKE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_INSTALL_PREFIX.rst new file mode 100644 index 0000000..72c8d41 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_PREFIX.rst @@ -0,0 +1,29 @@ +CMAKE_INSTALL_PREFIX +-------------------- + +Install directory used by install. + +If "make install" is invoked or INSTALL is built, this directory is +prepended onto all install directories. This variable defaults to +/usr/local on UNIX and c:/Program Files on Windows. + +On UNIX one can use the DESTDIR mechanism in order to relocate the +whole installation. DESTDIR means DESTination DIRectory. It is +commonly used by makefile users in order to install software at +non-default location. It is usually invoked like this: + +:: + + make DESTDIR=/home/john install + +which will install the concerned software using the installation +prefix, e.g. "/usr/local" prepended with the DESTDIR value which +finally gives "/home/john/usr/local". + +WARNING: DESTDIR may not be used on Windows because installation +prefix usually contains a drive letter like in "C:/Program Files" +which cannot be prepended with some other prefix. + +The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so +that find_package, find_program, find_library, find_path, and +find_file will search the prefix for other software. diff --git a/Help/variable/CMAKE_INSTALL_RPATH.rst b/Help/variable/CMAKE_INSTALL_RPATH.rst new file mode 100644 index 0000000..0992d57 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_RPATH.rst @@ -0,0 +1,8 @@ +CMAKE_INSTALL_RPATH +------------------- + +The rpath to use for installed targets. + +A semicolon-separated list specifying the rpath to use in installed +targets (for platforms that support it). This is used to initialize +the target property INSTALL_RPATH for all targets. diff --git a/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst b/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst new file mode 100644 index 0000000..9277a3b --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_RPATH_USE_LINK_PATH.rst @@ -0,0 +1,9 @@ +CMAKE_INSTALL_RPATH_USE_LINK_PATH +--------------------------------- + +Add paths to linker search and installed rpath. + +CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true +will append directories in the linker search path and outside the +project to the INSTALL_RPATH. This is used to initialize the target +property INSTALL_RPATH_USE_LINK_PATH for all targets. diff --git a/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst b/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst new file mode 100644 index 0000000..9693bf6 --- /dev/null +++ b/Help/variable/CMAKE_INTERNAL_PLATFORM_ABI.rst @@ -0,0 +1,6 @@ +CMAKE_INTERNAL_PLATFORM_ABI +--------------------------- + +An internal variable subject to change. + +This is used in determining the compiler ABI and is subject to change. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst b/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst new file mode 100644 index 0000000..2c3abae --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_APPEND.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_APPEND +--------------------------- + +Rule variable to append to a static archive. + +This is a rule variable that tells CMake how to append to a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst b/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst new file mode 100644 index 0000000..f93dd11 --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_CREATE.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_CREATE +--------------------------- + +Rule variable to create a new static archive. + +This is a rule variable that tells CMake how to create a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH. diff --git a/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst b/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst new file mode 100644 index 0000000..fff4128 --- /dev/null +++ b/Help/variable/CMAKE_LANG_ARCHIVE_FINISH.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_ARCHIVE_FINISH +--------------------------- + +Rule variable to finish an existing static archive. + +This is a rule variable that tells CMake how to finish a static +archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on +some platforms in order to support large object counts. See also +CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND. diff --git a/Help/variable/CMAKE_LANG_COMPILER.rst b/Help/variable/CMAKE_LANG_COMPILER.rst new file mode 100644 index 0000000..fffc347 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILER +--------------------- + +The full path to the compiler for LANG. + +This is the command that will be used as the <LANG> compiler. Once +set, you can not change this variable. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ABI.rst b/Help/variable/CMAKE_LANG_COMPILER_ABI.rst new file mode 100644 index 0000000..be946c0 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_ABI.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_COMPILER_ABI +------------------------- + +An internal variable subject to change. + +This is used in determining the compiler ABI and is subject to change. diff --git a/Help/variable/CMAKE_LANG_COMPILER_ID.rst b/Help/variable/CMAKE_LANG_COMPILER_ID.rst new file mode 100644 index 0000000..cf9c386 --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_ID.rst @@ -0,0 +1,33 @@ +CMAKE_<LANG>_COMPILER_ID +------------------------ + +Compiler identification string. + +A short string unique to the compiler vendor. Possible values +include: + +:: + + Absoft = Absoft Fortran (absoft.com) + ADSP = Analog VisualDSP++ (analog.com) + AppleClang = Apple Clang (apple.com) + Clang = LLVM Clang (clang.llvm.org) + Cray = Cray Compiler (cray.com) + Embarcadero, Borland = Embarcadero (embarcadero.com) + G95 = G95 Fortran (g95.org) + GNU = GNU Compiler Collection (gcc.gnu.org) + HP = Hewlett-Packard Compiler (hp.com) + Intel = Intel Compiler (intel.com) + MIPSpro = SGI MIPSpro (sgi.com) + MSVC = Microsoft Visual Studio (microsoft.com) + PGI = The Portland Group (pgroup.com) + PathScale = PathScale (pathscale.com) + SDCC = Small Device C Compiler (sdcc.sourceforge.net) + SunPro = Oracle Solaris Studio (oracle.com) + TI = Texas Instruments (ti.com) + TinyCC = Tiny C Compiler (tinycc.org) + Watcom = Open Watcom (openwatcom.org) + XL, VisualAge, zOS = IBM XL (ibm.com) + +This variable is not guaranteed to be defined for all compilers or +languages. diff --git a/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst b/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst new file mode 100644 index 0000000..3b8e9aa --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_LOADED.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILER_LOADED +---------------------------- + +Defined to true if the language is enabled. + +When language <LANG> is enabled by project() or enable_language() this +variable is defined to 1. diff --git a/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst b/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst new file mode 100644 index 0000000..50e77eb --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILER_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_COMPILER_VERSION +----------------------------- + +Compiler version string. + +Compiler version in major[.minor[.patch[.tweak]]] format. This +variable is not guaranteed to be defined for all compilers or +languages. diff --git a/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst b/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst new file mode 100644 index 0000000..f43ed6d --- /dev/null +++ b/Help/variable/CMAKE_LANG_COMPILE_OBJECT.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_COMPILE_OBJECT +--------------------------- + +Rule variable to compile a single object file. + +This is a rule variable that tells CMake how to compile a single +object file for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst b/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst new file mode 100644 index 0000000..adf1624 --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_SHARED_LIBRARY.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_SHARED_LIBRARY +---------------------------------- + +Rule variable to create a shared library. + +This is a rule variable that tells CMake how to create a shared +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst b/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst new file mode 100644 index 0000000..406b4da --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_SHARED_MODULE.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_SHARED_MODULE +--------------------------------- + +Rule variable to create a shared module. + +This is a rule variable that tells CMake how to create a shared +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst b/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst new file mode 100644 index 0000000..8114432 --- /dev/null +++ b/Help/variable/CMAKE_LANG_CREATE_STATIC_LIBRARY.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_CREATE_STATIC_LIBRARY +---------------------------------- + +Rule variable to create a static library. + +This is a rule variable that tells CMake how to create a static +library for the language <LANG>. diff --git a/Help/variable/CMAKE_LANG_FLAGS.rst b/Help/variable/CMAKE_LANG_FLAGS.rst new file mode 100644 index 0000000..6aa0a3e --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS +------------------ + +Flags for all build types. + +<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE. diff --git a/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst b/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst new file mode 100644 index 0000000..a727641 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_DEBUG.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS_DEBUG +------------------------ + +Flags for Debug build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is Debug. diff --git a/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst new file mode 100644 index 0000000..fbb8516 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_MINSIZEREL.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_FLAGS_MINSIZEREL +----------------------------- + +Flags for MinSizeRel build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for +minimum size release. diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst b/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst new file mode 100644 index 0000000..4b2c926 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_RELEASE.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_FLAGS_RELEASE +-------------------------- + +Flags for Release build type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is Release diff --git a/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst new file mode 100644 index 0000000..16bd4e9 --- /dev/null +++ b/Help/variable/CMAKE_LANG_FLAGS_RELWITHDEBINFO.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_FLAGS_RELWITHDEBINFO +--------------------------------- + +Flags for RelWithDebInfo type or configuration. + +<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. Short for +Release With Debug Information. diff --git a/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst b/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst new file mode 100644 index 0000000..3d07e91 --- /dev/null +++ b/Help/variable/CMAKE_LANG_IGNORE_EXTENSIONS.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_IGNORE_EXTENSIONS +------------------------------ + +File extensions that should be ignored by the build. + +This is a list of file extensions that may be part of a project for a +given language but are not compiled. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst new file mode 100644 index 0000000..c60e18c --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_INCLUDE_DIRECTORIES.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES +----------------------------------------- + +Directories implicitly searched by the compiler for header files. + +CMake does not explicitly specify these directories on compiler +command lines for language <LANG>. This prevents system include +directories from being treated as user include directories on some +compilers. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst new file mode 100644 index 0000000..568950c --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_DIRECTORIES.rst @@ -0,0 +1,17 @@ +CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES +-------------------------------------- + +Implicit linker search path detected for language <LANG>. + +Compilers typically pass directories containing language runtime +libraries and default library search paths when they invoke a linker. +These paths are implicit linker search directories for the compiler's +language. CMake automatically detects these directories for each +language and reports the results in this variable. + +When a library in one of these directories is given by full path to +target_link_libraries() CMake will generate the -l<name> form on link +lines to ensure the linker searches its implicit directories for the +library. Note that some toolchains read implicit directories from an +environment variable such as LIBRARY_PATH so keep its value consistent +when operating in a given build tree. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst new file mode 100644 index 0000000..05e6ddb --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES +------------------------------------------------ + +Implicit linker framework search path detected for language <LANG>. + +These paths are implicit linker framework search directories for the +compiler's language. CMake automatically detects these directories +for each language and reports the results in this variable. diff --git a/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst new file mode 100644 index 0000000..fddfed8 --- /dev/null +++ b/Help/variable/CMAKE_LANG_IMPLICIT_LINK_LIBRARIES.rst @@ -0,0 +1,10 @@ +CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES +------------------------------------ + +Implicit link libraries and flags detected for language <LANG>. + +Compilers typically pass language runtime library names and other +flags when they invoke a linker. These flags are implicit link +options for the compiler's language. CMake automatically detects +these libraries and flags for each language and reports the results in +this variable. diff --git a/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst b/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst new file mode 100644 index 0000000..4f31494 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LIBRARY_ARCHITECTURE.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_LIBRARY_ARCHITECTURE +--------------------------------- + +Target architecture library directory name detected for <lang>. + +If the <lang> compiler passes to the linker an architecture-specific +system library search directory such as <prefix>/lib/<arch> this +variable contains the <arch> name if/as detected by CMake. diff --git a/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst new file mode 100644 index 0000000..af7ee60 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE.rst @@ -0,0 +1,11 @@ +CMAKE_<LANG>_LINKER_PREFERENCE +------------------------------ + +Preference value for linker language selection. + +The "linker language" for executable, shared library, and module +targets is the language whose compiler will invoke the linker. The +LINKER_LANGUAGE target property sets the language explicitly. +Otherwise, the linker language is that whose linker preference value +is highest among languages compiled and linked into the target. See +also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable. diff --git a/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst new file mode 100644 index 0000000..d513767 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINKER_PREFERENCE_PROPAGATES.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES +----------------------------------------- + +True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets. + +This is used when CMake selects a linker language for a target. +Languages compiled directly into the target are always considered. A +language compiled into static libraries linked by the target is +considered if this variable is true. diff --git a/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst b/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst new file mode 100644 index 0000000..abd5891 --- /dev/null +++ b/Help/variable/CMAKE_LANG_LINK_EXECUTABLE.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_LINK_EXECUTABLE +---------------------------- + +Rule variable to link an executable. + +Rule variable to link an executable for the given language. diff --git a/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst b/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst new file mode 100644 index 0000000..22fac29 --- /dev/null +++ b/Help/variable/CMAKE_LANG_OUTPUT_EXTENSION.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_OUTPUT_EXTENSION +----------------------------- + +Extension for the output of a compile for a single file. + +This is the extension for an object file for the given <LANG>. For +example .obj for C on Windows. diff --git a/Help/variable/CMAKE_LANG_PLATFORM_ID.rst b/Help/variable/CMAKE_LANG_PLATFORM_ID.rst new file mode 100644 index 0000000..1b243e3 --- /dev/null +++ b/Help/variable/CMAKE_LANG_PLATFORM_ID.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_PLATFORM_ID +------------------------ + +An internal variable subject to change. + +This is used in determining the platform and is subject to change. diff --git a/Help/variable/CMAKE_LANG_SIMULATE_ID.rst b/Help/variable/CMAKE_LANG_SIMULATE_ID.rst new file mode 100644 index 0000000..646c0db --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIMULATE_ID.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_SIMULATE_ID +------------------------ + +Identification string of "simulated" compiler. + +Some compilers simulate other compilers to serve as drop-in +replacements. When CMake detects such a compiler it sets this +variable to what would have been the CMAKE_<LANG>_COMPILER_ID for the +simulated compiler. diff --git a/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst b/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst new file mode 100644 index 0000000..982053d --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIMULATE_VERSION.rst @@ -0,0 +1,9 @@ +CMAKE_<LANG>_SIMULATE_VERSION +----------------------------- + +Version string of "simulated" compiler. + +Some compilers simulate other compilers to serve as drop-in +replacements. When CMake detects such a compiler it sets this +variable to what would have been the CMAKE_<LANG>_COMPILER_VERSION for +the simulated compiler. diff --git a/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst b/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst new file mode 100644 index 0000000..c85b5e0 --- /dev/null +++ b/Help/variable/CMAKE_LANG_SIZEOF_DATA_PTR.rst @@ -0,0 +1,7 @@ +CMAKE_<LANG>_SIZEOF_DATA_PTR +---------------------------- + +Size of pointer-to-data types for language <LANG>. + +This holds the size (in bytes) of pointer-to-data types in the target +platform ABI. It is defined for languages C and CXX (C++). diff --git a/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst b/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst new file mode 100644 index 0000000..e085fee --- /dev/null +++ b/Help/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS.rst @@ -0,0 +1,6 @@ +CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS +----------------------------------- + +Extensions of source files for the given language. + +This is the list of extensions for a given language's source files. diff --git a/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst b/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst new file mode 100644 index 0000000..bef670f --- /dev/null +++ b/Help/variable/CMAKE_LANG_VISIBILITY_PRESET.rst @@ -0,0 +1,8 @@ +CMAKE_<LANG>_VISIBILITY_PRESET +------------------------------ + +Default value for <LANG>_VISIBILITY_PRESET of targets. + +This variable is used to initialize the <LANG>_VISIBILITY_PRESET +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst new file mode 100644 index 0000000..c9a15f3 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_ARCHITECTURE +-------------------------- + +Target architecture library directory name, if detected. + +This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE as detected for +one of the enabled languages. diff --git a/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst new file mode 100644 index 0000000..6c41269 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_ARCHITECTURE_REGEX.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_ARCHITECTURE_REGEX +-------------------------------- + +Regex matching possible target architecture library directory names. + +This is used to detect CMAKE_<lang>_LIBRARY_ARCHITECTURE from the +implicit linker search path by matching the <arch> name. diff --git a/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..3bdd348 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_LIBRARY_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the LIBRARY targets when built. + +This variable is used to initialize the LIBRARY_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LIBRARY_PATH.rst b/Help/variable/CMAKE_LIBRARY_PATH.rst new file mode 100644 index 0000000..e77dd34 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_LIBRARY_PATH +------------------ + +Path used for searching by FIND_LIBRARY(). + +Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() +will check each of the contained directories for the existence of the +library which is currently searched. By default it is empty, it is +intended to be set by the project. See also +CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst b/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst new file mode 100644 index 0000000..ede39e9 --- /dev/null +++ b/Help/variable/CMAKE_LIBRARY_PATH_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LIBRARY_PATH_FLAG +----------------------- + +The flag to be used to add a library search path to a compiler. + +The flag will be used to specify a library directory to the compiler. +On most compilers this is "-L". diff --git a/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst b/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst new file mode 100644 index 0000000..382447c --- /dev/null +++ b/Help/variable/CMAKE_LINK_DEF_FILE_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_DEF_FILE_FLAG +------------------------ + +Linker flag to be used to specify a .def file for dll creation. + +The flag will be used to add a .def file when creating a dll on +Windows; this is only defined on Windows. diff --git a/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst b/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst new file mode 100644 index 0000000..6ae7df6 --- /dev/null +++ b/Help/variable/CMAKE_LINK_DEPENDS_NO_SHARED.rst @@ -0,0 +1,8 @@ +CMAKE_LINK_DEPENDS_NO_SHARED +---------------------------- + +Whether to skip link dependencies on shared library files. + +This variable initializes the LINK_DEPENDS_NO_SHARED property on +targets when they are created. See that target property for +additional information. diff --git a/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst b/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst new file mode 100644 index 0000000..efe6fd7 --- /dev/null +++ b/Help/variable/CMAKE_LINK_INTERFACE_LIBRARIES.rst @@ -0,0 +1,8 @@ +CMAKE_LINK_INTERFACE_LIBRARIES +------------------------------ + +Default value for LINK_INTERFACE_LIBRARIES of targets. + +This variable is used to initialize the LINK_INTERFACE_LIBRARIES +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst b/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst new file mode 100644 index 0000000..6858e2c --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_FILE_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_LIBRARY_FILE_FLAG +---------------------------- + +Flag to be used to link a library specified by a path to its file. + +The flag will be used before a library file path is given to the +linker. This is needed only on very few platforms. diff --git a/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst b/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst new file mode 100644 index 0000000..c3e02d7 --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_FLAG.rst @@ -0,0 +1,7 @@ +CMAKE_LINK_LIBRARY_FLAG +----------------------- + +Flag to be used to link a library into an executable. + +The flag will be used to specify a library to link to an executable. +On most compilers this is "-l". diff --git a/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..390298d --- /dev/null +++ b/Help/variable/CMAKE_LINK_LIBRARY_SUFFIX.rst @@ -0,0 +1,6 @@ +CMAKE_LINK_LIBRARY_SUFFIX +------------------------- + +The suffix for libraries that you link to. + +The suffix to use for the end of a library filename, .lib on Windows. diff --git a/Help/variable/CMAKE_MACOSX_BUNDLE.rst b/Help/variable/CMAKE_MACOSX_BUNDLE.rst new file mode 100644 index 0000000..e4768f3 --- /dev/null +++ b/Help/variable/CMAKE_MACOSX_BUNDLE.rst @@ -0,0 +1,7 @@ +CMAKE_MACOSX_BUNDLE +------------------- + +Default value for MACOSX_BUNDLE of targets. + +This variable is used to initialize the MACOSX_BUNDLE property on all +the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_MAJOR_VERSION.rst b/Help/variable/CMAKE_MAJOR_VERSION.rst new file mode 100644 index 0000000..7dd24e5 --- /dev/null +++ b/Help/variable/CMAKE_MAJOR_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_MAJOR_VERSION +------------------- + +The Major version of cmake (i.e. the 2 in 2.X.X) + +This specifies the major version of the CMake executable being run. diff --git a/Help/variable/CMAKE_MAKE_PROGRAM.rst b/Help/variable/CMAKE_MAKE_PROGRAM.rst new file mode 100644 index 0000000..8307bc6 --- /dev/null +++ b/Help/variable/CMAKE_MAKE_PROGRAM.rst @@ -0,0 +1,7 @@ +CMAKE_MAKE_PROGRAM +------------------ + +See CMAKE_BUILD_TOOL. + +This variable is around for backwards compatibility, see +CMAKE_BUILD_TOOL. diff --git a/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst b/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst new file mode 100644 index 0000000..41ccde1 --- /dev/null +++ b/Help/variable/CMAKE_MAP_IMPORTED_CONFIG_CONFIG.rst @@ -0,0 +1,8 @@ +CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> +---------------------------------- + +Default value for MAP_IMPORTED_CONFIG_<CONFIG> of targets. + +This variable is used to initialize the MAP_IMPORTED_CONFIG_<CONFIG> +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_MFC_FLAG.rst b/Help/variable/CMAKE_MFC_FLAG.rst new file mode 100644 index 0000000..221d26e --- /dev/null +++ b/Help/variable/CMAKE_MFC_FLAG.rst @@ -0,0 +1,16 @@ +CMAKE_MFC_FLAG +-------------- + +Tell cmake to use MFC for an executable or dll. + +This can be set in a CMakeLists.txt file and will enable MFC in the +application. It should be set to 1 for the static MFC library, and 2 +for the shared MFC library. This is used in Visual Studio 6 and 7 +project files. The CMakeSetup dialog used MFC and the CMakeLists.txt +looks like this: + +:: + + add_definitions(-D_AFXDLL) + set(CMAKE_MFC_FLAG 2) + add_executable(CMakeSetup WIN32 ${SRCS}) diff --git a/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst b/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst new file mode 100644 index 0000000..351de44 --- /dev/null +++ b/Help/variable/CMAKE_MINIMUM_REQUIRED_VERSION.rst @@ -0,0 +1,7 @@ +CMAKE_MINIMUM_REQUIRED_VERSION +------------------------------ + +Version specified to cmake_minimum_required command + +Variable containing the VERSION component specified in the +cmake_minimum_required command. diff --git a/Help/variable/CMAKE_MINOR_VERSION.rst b/Help/variable/CMAKE_MINOR_VERSION.rst new file mode 100644 index 0000000..bbc1073 --- /dev/null +++ b/Help/variable/CMAKE_MINOR_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_MINOR_VERSION +------------------- + +The Minor version of cmake (i.e. the 4 in X.4.X). + +This specifies the minor version of the CMake executable being run. diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst new file mode 100644 index 0000000..6372bbd --- /dev/null +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_MODULE_LINKER_FLAGS +------------------------- + +Linker flags to be used to create modules. + +These flags will be used by the linker when creating a module. diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..87a1901 --- /dev/null +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,6 @@ +CMAKE_MODULE_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a module. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating modules. diff --git a/Help/variable/CMAKE_MODULE_PATH.rst b/Help/variable/CMAKE_MODULE_PATH.rst new file mode 100644 index 0000000..a2dde45 --- /dev/null +++ b/Help/variable/CMAKE_MODULE_PATH.rst @@ -0,0 +1,8 @@ +CMAKE_MODULE_PATH +----------------- + +List of directories to search for CMake modules. + +Commands like include() and find_package() search for files in +directories listed by this variable before checking the default +modules that come with CMake. diff --git a/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst b/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst new file mode 100644 index 0000000..cbe0350 --- /dev/null +++ b/Help/variable/CMAKE_NOT_USING_CONFIG_FLAGS.rst @@ -0,0 +1,7 @@ +CMAKE_NOT_USING_CONFIG_FLAGS +---------------------------- + +Skip _BUILD_TYPE flags if true. + +This is an internal flag used by the generators in CMake to tell CMake +to skip the _BUILD_TYPE flags. diff --git a/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst new file mode 100644 index 0000000..189f59f --- /dev/null +++ b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst @@ -0,0 +1,10 @@ +CMAKE_NO_BUILTIN_CHRPATH +------------------------ + +Do not use the builtin ELF editor to fix RPATHs on installation. + +When an ELF binary needs to have a different RPATH after installation +than it does in the build tree, CMake uses a builtin editor to change +the RPATH in the installed copy. If this variable is set to true then +CMake will relink the binary before installation instead of using its +builtin editor. diff --git a/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst b/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst new file mode 100644 index 0000000..c1919af --- /dev/null +++ b/Help/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED.rst @@ -0,0 +1,8 @@ +CMAKE_NO_SYSTEM_FROM_IMPORTED +----------------------------- + +Default value for NO_SYSTEM_FROM_IMPORTED of targets. + +This variable is used to initialize the NO_SYSTEM_FROM_IMPORTED +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_OBJECT_PATH_MAX.rst b/Help/variable/CMAKE_OBJECT_PATH_MAX.rst new file mode 100644 index 0000000..9e30cbb --- /dev/null +++ b/Help/variable/CMAKE_OBJECT_PATH_MAX.rst @@ -0,0 +1,16 @@ +CMAKE_OBJECT_PATH_MAX +--------------------- + +Maximum object file full-path length allowed by native build tools. + +CMake computes for every source file an object file name that is +unique to the source file and deterministic with respect to the full +path to the source file. This allows multiple source files in a +target to share the same name if they lie in different directories +without rebuilding when one is added or removed. However, it can +produce long full paths in a few cases, so CMake shortens the path +using a hashing scheme when the full path to an object file exceeds a +limit. CMake has a built-in limit for each platform that is +sufficient for common tools, but some native tools may have a lower +limit. This variable may be set to specify the limit explicitly. The +value must be an integer no less than 128. diff --git a/Help/variable/CMAKE_PARENT_LIST_FILE.rst b/Help/variable/CMAKE_PARENT_LIST_FILE.rst new file mode 100644 index 0000000..5566a72 --- /dev/null +++ b/Help/variable/CMAKE_PARENT_LIST_FILE.rst @@ -0,0 +1,9 @@ +CMAKE_PARENT_LIST_FILE +---------------------- + +Full path to the CMake file that included the current one. + +While processing a CMake file loaded by include() or find_package() +this variable contains the full path to the file including it. The +top of the include stack is always the CMakeLists.txt for the current +directory. See also CMAKE_CURRENT_LIST_FILE. diff --git a/Help/variable/CMAKE_PATCH_VERSION.rst b/Help/variable/CMAKE_PATCH_VERSION.rst new file mode 100644 index 0000000..fe68bf2 --- /dev/null +++ b/Help/variable/CMAKE_PATCH_VERSION.rst @@ -0,0 +1,6 @@ +CMAKE_PATCH_VERSION +------------------- + +The patch version of cmake (i.e. the 3 in X.X.3). + +This specifies the patch version of the CMake executable being run. diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..938d159 --- /dev/null +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_PDB_OUTPUT_DIRECTORY +-------------------------- + +Where to put all the MS debug symbol files from linker. + +This variable is used to initialize the PDB_OUTPUT_DIRECTORY property +on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst new file mode 100644 index 0000000..e401aa5 --- /dev/null +++ b/Help/variable/CMAKE_POLICY_DEFAULT_CMPNNNN.rst @@ -0,0 +1,16 @@ +CMAKE_POLICY_DEFAULT_CMP<NNNN> +------------------------------ + +Default for CMake Policy CMP<NNNN> when it is otherwise left unset. + +Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) by +default leave policies introduced after the given version unset. Set +CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the default +for policy CMP<NNNN>, where <NNNN> is the policy number. + +This variable should not be set by a project in CMake code; use +cmake_policy(SET) instead. Users running CMake may set this variable +in the cache (e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) to set +a policy not otherwise set by the project. Set to OLD to quiet a +policy warning while using old behavior or to NEW to try building the +project with new behavior. diff --git a/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst b/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst new file mode 100644 index 0000000..5e71665 --- /dev/null +++ b/Help/variable/CMAKE_POSITION_INDEPENDENT_CODE.rst @@ -0,0 +1,8 @@ +CMAKE_POSITION_INDEPENDENT_CODE +------------------------------- + +Default value for POSITION_INDEPENDENT_CODE of targets. + +This variable is used to initialize the POSITION_INDEPENDENT_CODE +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_PREFIX_PATH.rst b/Help/variable/CMAKE_PREFIX_PATH.rst new file mode 100644 index 0000000..4c21d5e --- /dev/null +++ b/Help/variable/CMAKE_PREFIX_PATH.rst @@ -0,0 +1,13 @@ +CMAKE_PREFIX_PATH +----------------- + +Path used for searching by FIND_XXX(), with appropriate suffixes added. + +Specifies a path which will be used by the FIND_XXX() commands. It +contains the "base" directories, the FIND_XXX() commands append +appropriate subdirectories to the base directories. So FIND_PROGRAM() +adds /bin to each of the directories in the path, FIND_LIBRARY() +appends /lib to each of the directories, and FIND_PATH() and +FIND_FILE() append /include . By default it is empty, it is intended +to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, +CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_PROGRAM_PATH.rst b/Help/variable/CMAKE_PROGRAM_PATH.rst new file mode 100644 index 0000000..02c5e02 --- /dev/null +++ b/Help/variable/CMAKE_PROGRAM_PATH.rst @@ -0,0 +1,10 @@ +CMAKE_PROGRAM_PATH +------------------ + +Path used for searching by FIND_PROGRAM(). + +Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() +will check each of the contained directories for the existence of the +program which is currently searched. By default it is empty, it is +intended to be set by the project. See also +CMAKE_SYSTEM_PROGRAM_PATH, CMAKE_PREFIX_PATH. diff --git a/Help/variable/CMAKE_PROJECT_NAME.rst b/Help/variable/CMAKE_PROJECT_NAME.rst new file mode 100644 index 0000000..4734705 --- /dev/null +++ b/Help/variable/CMAKE_PROJECT_NAME.rst @@ -0,0 +1,7 @@ +CMAKE_PROJECT_NAME +------------------ + +The name of the current project. + +This specifies name of the current project from the closest inherited +PROJECT command. diff --git a/Help/variable/CMAKE_RANLIB.rst b/Help/variable/CMAKE_RANLIB.rst new file mode 100644 index 0000000..82672e9 --- /dev/null +++ b/Help/variable/CMAKE_RANLIB.rst @@ -0,0 +1,7 @@ +CMAKE_RANLIB +------------ + +Name of randomizing tool for static libraries. + +This specifies name of the program that randomizes libraries on UNIX, +not used on Windows, but may be present. diff --git a/Help/variable/CMAKE_ROOT.rst b/Help/variable/CMAKE_ROOT.rst new file mode 100644 index 0000000..f963a7f --- /dev/null +++ b/Help/variable/CMAKE_ROOT.rst @@ -0,0 +1,8 @@ +CMAKE_ROOT +---------- + +Install directory for running cmake. + +This is the install root for the running CMake and the Modules +directory can be found here. This is commonly used in this format: +${CMAKE_ROOT}/Modules diff --git a/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst new file mode 100644 index 0000000..366ca66 --- /dev/null +++ b/Help/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY.rst @@ -0,0 +1,8 @@ +CMAKE_RUNTIME_OUTPUT_DIRECTORY +------------------------------ + +Where to put all the RUNTIME targets when built. + +This variable is used to initialize the RUNTIME_OUTPUT_DIRECTORY +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst new file mode 100644 index 0000000..ad73cc0 --- /dev/null +++ b/Help/variable/CMAKE_SCRIPT_MODE_FILE.rst @@ -0,0 +1,8 @@ +CMAKE_SCRIPT_MODE_FILE +---------------------- + +Full path to the -P script file currently being processed. + +When run in -P script mode, CMake sets this variable to the full path +of the script file. When run to configure a CMakeLists.txt file, this +variable is not set. diff --git a/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..a863e2a --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LIBRARY_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_SHARED_LIBRARY_PREFIX +--------------------------- + +The prefix for shared libraries that you link to. + +The prefix to use for the name of a shared library, lib on UNIX. + +CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..c296ecd --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_SHARED_LIBRARY_SUFFIX +--------------------------- + +The suffix for shared libraries that you link to. + +The suffix to use for the end of a shared library filename, .dll on +Windows. + +CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst new file mode 100644 index 0000000..fce950c --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_SHARED_LINKER_FLAGS +------------------------- + +Linker flags to be used to create shared libraries. + +These flags will be used by the linker when creating a shared library. diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..fedc626 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_SHARED_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a shared library. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating shared +libraries. diff --git a/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst b/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst new file mode 100644 index 0000000..a5a2428 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_MODULE_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_SHARED_MODULE_PREFIX +-------------------------- + +The prefix for loadable modules that you link to. + +The prefix to use for the name of a loadable module on this platform. + +CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst b/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst new file mode 100644 index 0000000..32a3c34 --- /dev/null +++ b/Help/variable/CMAKE_SHARED_MODULE_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_SHARED_MODULE_SUFFIX +-------------------------- + +The suffix for shared libraries that you link to. + +The suffix to use for the end of a loadable module filename on this +platform + +CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_SIZEOF_VOID_P.rst b/Help/variable/CMAKE_SIZEOF_VOID_P.rst new file mode 100644 index 0000000..2697fad --- /dev/null +++ b/Help/variable/CMAKE_SIZEOF_VOID_P.rst @@ -0,0 +1,8 @@ +CMAKE_SIZEOF_VOID_P +------------------- + +Size of a void pointer. + +This is set to the size of a pointer on the machine, and is determined +by a try compile. If a 64 bit size is found, then the library search +path is modified to look for 64 bit libraries first. diff --git a/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst new file mode 100644 index 0000000..8da6100 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst @@ -0,0 +1,10 @@ +CMAKE_SKIP_BUILD_RPATH +---------------------- + +Do not include RPATHs in the build tree. + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always built with no RPATH. diff --git a/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst new file mode 100644 index 0000000..33ee8a8 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_INSTALL_ALL_DEPENDENCY.rst @@ -0,0 +1,11 @@ +CMAKE_SKIP_INSTALL_ALL_DEPENDENCY +--------------------------------- + +Don't make the install target depend on the all target. + +By default, the "install" target depends on the "all" target. This +has the effect, that when "make install" is invoked or INSTALL is +built, first the "all" target is built, then the installation starts. +If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency +is not created, so the installation process will start immediately, +independent from whether the project has been completely built or not. diff --git a/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst new file mode 100644 index 0000000..f16b212 --- /dev/null +++ b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst @@ -0,0 +1,14 @@ +CMAKE_SKIP_INSTALL_RPATH +------------------------ + +Do not include RPATHs in the install tree. + +Normally CMake uses the build tree for the RPATH when building +executables etc on systems that use RPATH. When the software is +installed the executables etc are relinked by CMake to have the +install RPATH. If this variable is set to true then the software is +always installed without RPATH, even if RPATH is enabled when +building. This can be useful for example to allow running tests from +the build directory with RPATH enabled before the installation step. +To omit RPATH in both the build and install steps, use +CMAKE_SKIP_RPATH instead. diff --git a/Help/variable/CMAKE_SKIP_RPATH.rst b/Help/variable/CMAKE_SKIP_RPATH.rst new file mode 100644 index 0000000..c93f67f --- /dev/null +++ b/Help/variable/CMAKE_SKIP_RPATH.rst @@ -0,0 +1,10 @@ +CMAKE_SKIP_RPATH +---------------- + +If true, do not add run time path information. + +If this is set to TRUE, then the rpath information is not added to +compiled executables. The default is to add rpath information if the +platform supports it. This allows for easy running from the build +tree. To omit RPATH in the install step, but not the build step, use +CMAKE_SKIP_INSTALL_RPATH instead. diff --git a/Help/variable/CMAKE_SOURCE_DIR.rst b/Help/variable/CMAKE_SOURCE_DIR.rst new file mode 100644 index 0000000..088fa83 --- /dev/null +++ b/Help/variable/CMAKE_SOURCE_DIR.rst @@ -0,0 +1,8 @@ +CMAKE_SOURCE_DIR +---------------- + +The path to the top level of the source tree. + +This is the full path to the top level of the current CMake source +tree. For an in-source build, this would be the same as +CMAKE_BINARY_DIR. diff --git a/Help/variable/CMAKE_STANDARD_LIBRARIES.rst b/Help/variable/CMAKE_STANDARD_LIBRARIES.rst new file mode 100644 index 0000000..9c728cd --- /dev/null +++ b/Help/variable/CMAKE_STANDARD_LIBRARIES.rst @@ -0,0 +1,7 @@ +CMAKE_STANDARD_LIBRARIES +------------------------ + +Libraries linked into every executable and shared library. + +This is the list of libraries that are linked into all executables and +libraries. diff --git a/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst b/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst new file mode 100644 index 0000000..0a3095d --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LIBRARY_PREFIX.rst @@ -0,0 +1,8 @@ +CMAKE_STATIC_LIBRARY_PREFIX +--------------------------- + +The prefix for static libraries that you link to. + +The prefix to use for the name of a static library, lib on UNIX. + +CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst b/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst new file mode 100644 index 0000000..4d07671 --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LIBRARY_SUFFIX.rst @@ -0,0 +1,9 @@ +CMAKE_STATIC_LIBRARY_SUFFIX +--------------------------- + +The suffix for static libraries that you link to. + +The suffix to use for the end of a static library filename, .lib on +Windows. + +CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>. diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst new file mode 100644 index 0000000..9c38673 --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst @@ -0,0 +1,6 @@ +CMAKE_STATIC_LINKER_FLAGS +------------------------- + +Linker flags to be used to create static libraries. + +These flags will be used by the linker when creating a static library. diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst new file mode 100644 index 0000000..6cde24d --- /dev/null +++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst @@ -0,0 +1,7 @@ +CMAKE_STATIC_LINKER_FLAGS_<CONFIG> +---------------------------------- + +Flags to be used when linking a static library. + +Same as CMAKE_C_FLAGS_* but used by the linker when creating static +libraries. diff --git a/Help/variable/CMAKE_SYSTEM.rst b/Help/variable/CMAKE_SYSTEM.rst new file mode 100644 index 0000000..283d0be --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM.rst @@ -0,0 +1,9 @@ +CMAKE_SYSTEM +------------ + +Name of system cmake is compiling for. + +This variable is the composite of CMAKE_SYSTEM_NAME and +CMAKE_SYSTEM_VERSION, like this +${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VERSION +is not set, then CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME. diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst new file mode 100644 index 0000000..9e6b195 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst @@ -0,0 +1,15 @@ +CMAKE_SYSTEM_IGNORE_PATH +------------------------ + +Path to be ignored by FIND_XXX() commands. + +Specifies directories to be ignored by searches in FIND_XXX() +commands. This is useful in cross-compiled environments where some +system directories contain incompatible but possibly linkable +libraries. For example, on cross-compiled cluster environments, this +allows a user to ignore directories containing libraries meant for the +front-end machine that modules like FindX11 (and others) would +normally search. By default this contains a list of directories +containing incompatible binaries for the host system. See also +CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, +CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst new file mode 100644 index 0000000..1734185 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_INCLUDE_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_INCLUDE_PATH +------------------------- + +Path used for searching by FIND_FILE() and FIND_PATH(). + +Specifies a path which will be used both by FIND_FILE() and +FIND_PATH(). Both commands will check each of the contained +directories for the existence of the file which is currently searched. +By default it contains the standard directories for the current +system. It is NOT intended to be modified by the project, use +CMAKE_INCLUDE_PATH for this. See also CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst b/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst new file mode 100644 index 0000000..4778646 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_LIBRARY_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_LIBRARY_PATH +------------------------- + +Path used for searching by FIND_LIBRARY(). + +Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() +will check each of the contained directories for the existence of the +library which is currently searched. By default it contains the +standard directories for the current system. It is NOT intended to be +modified by the project, use CMAKE_LIBRARY_PATH for this. See also +CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_NAME.rst b/Help/variable/CMAKE_SYSTEM_NAME.rst new file mode 100644 index 0000000..9871dd9 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_NAME.rst @@ -0,0 +1,9 @@ +CMAKE_SYSTEM_NAME +----------------- + +Name of the OS CMake is building for. + +This is the name of the operating system on which CMake is targeting. +On systems that have the uname command, this variable is set to the +output of uname -s. Linux, Windows, and Darwin for Mac OS X are the +values found on the big three operating systems. diff --git a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst new file mode 100644 index 0000000..2dbae1f --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst @@ -0,0 +1,16 @@ +CMAKE_SYSTEM_PREFIX_PATH +------------------------ + +Path used for searching by FIND_XXX(), with appropriate suffixes added. + +Specifies a path which will be used by the FIND_XXX() commands. It +contains the "base" directories, the FIND_XXX() commands append +appropriate subdirectories to the base directories. So FIND_PROGRAM() +adds /bin to each of the directories in the path, FIND_LIBRARY() +appends /lib to each of the directories, and FIND_PATH() and +FIND_FILE() append /include . By default this contains the standard +directories for the current system and the CMAKE_INSTALL_PREFIX. It +is NOT intended to be modified by the project, use CMAKE_PREFIX_PATH +for this. See also CMAKE_SYSTEM_INCLUDE_PATH, +CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_SYSTEM_PROGRAM_PATH, and +CMAKE_SYSTEM_IGNORE_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst new file mode 100644 index 0000000..1655ada --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst @@ -0,0 +1,8 @@ +CMAKE_SYSTEM_PROCESSOR +---------------------- + +The name of the CPU CMake is building for. + +On systems that support uname, this variable is set to the output of +uname -p, on windows it is set to the value of the environment +variable PROCESSOR_ARCHITECTURE diff --git a/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst b/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst new file mode 100644 index 0000000..e1fad63 --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_PROGRAM_PATH.rst @@ -0,0 +1,11 @@ +CMAKE_SYSTEM_PROGRAM_PATH +------------------------- + +Path used for searching by FIND_PROGRAM(). + +Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() +will check each of the contained directories for the existence of the +program which is currently searched. By default it contains the +standard directories for the current system. It is NOT intended to be +modified by the project, use CMAKE_PROGRAM_PATH for this. See also +CMAKE_SYSTEM_PREFIX_PATH. diff --git a/Help/variable/CMAKE_SYSTEM_VERSION.rst b/Help/variable/CMAKE_SYSTEM_VERSION.rst new file mode 100644 index 0000000..61bb40e --- /dev/null +++ b/Help/variable/CMAKE_SYSTEM_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_SYSTEM_VERSION +-------------------- + +OS version CMake is building for. + +A numeric version string for the system, on systems that support +uname, this variable is set to the output of uname -r. On other +systems this is set to major-minor version numbers. diff --git a/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst b/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst new file mode 100644 index 0000000..a92feab --- /dev/null +++ b/Help/variable/CMAKE_TRY_COMPILE_CONFIGURATION.rst @@ -0,0 +1,9 @@ +CMAKE_TRY_COMPILE_CONFIGURATION +------------------------------- + +Build configuration used for try_compile and try_run projects. + +Projects built by try_compile and try_run are built synchronously +during the CMake configuration step. Therefore a specific build +configuration must be chosen even if the generated build system +supports multiple configurations. diff --git a/Help/variable/CMAKE_TWEAK_VERSION.rst b/Help/variable/CMAKE_TWEAK_VERSION.rst new file mode 100644 index 0000000..56270aa --- /dev/null +++ b/Help/variable/CMAKE_TWEAK_VERSION.rst @@ -0,0 +1,8 @@ +CMAKE_TWEAK_VERSION +------------------- + +The tweak version of cmake (i.e. the 1 in X.X.X.1). + +This specifies the tweak version of the CMake executable being run. +Releases use tweak < 20000000 and development versions use the date +format CCYYMMDD for the tweak level. diff --git a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst new file mode 100644 index 0000000..5a4c86b --- /dev/null +++ b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE.rst @@ -0,0 +1,23 @@ +CMAKE_USER_MAKE_RULES_OVERRIDE +------------------------------ + +Specify a CMake file that overrides platform information. + +CMake loads the specified file while enabling support for each +language from either the project() or enable_language() commands. It +is loaded after CMake's builtin compiler and platform information +modules have been loaded but before the information is used. The file +may set platform information variables to override CMake's defaults. + +This feature is intended for use only in overriding information +variables that must be set before CMake builds its first test project +to check that the compiler for a language works. It should not be +used to load a file in cases that a normal include() will work. Use +it only as a last resort for behavior that cannot be achieved any +other way. For example, one may set CMAKE_C_FLAGS_INIT to change the +default value used to initialize CMAKE_C_FLAGS before it is cached. +The override file should NOT be used to set anything that could be set +after languages are enabled, such as variables like +CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. +Information set in the file will be used for try_compile and try_run +builds too. diff --git a/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst new file mode 100644 index 0000000..e6d2c68 --- /dev/null +++ b/Help/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG.rst @@ -0,0 +1,7 @@ +CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG> +------------------------------------- + +Specify a CMake file that overrides platform information for <LANG>. + +This is a language-specific version of CMAKE_USER_MAKE_RULES_OVERRIDE +loaded only when enabling language <LANG>. diff --git a/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst b/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst new file mode 100644 index 0000000..af6f08c --- /dev/null +++ b/Help/variable/CMAKE_USE_RELATIVE_PATHS.rst @@ -0,0 +1,10 @@ +CMAKE_USE_RELATIVE_PATHS +------------------------ + +Use relative paths (May not work!). + +If this is set to TRUE, then CMake will use relative paths between the +source and binary tree. This option does not work for more +complicated projects, and relative paths are used when possible. In +general, it is not possible to move CMake generated makefiles to a +different location regardless of the value of this variable. diff --git a/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst b/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst new file mode 100644 index 0000000..451ce8c --- /dev/null +++ b/Help/variable/CMAKE_VERBOSE_MAKEFILE.rst @@ -0,0 +1,8 @@ +CMAKE_VERBOSE_MAKEFILE +---------------------- + +Create verbose makefiles if on. + +This variable defaults to false. You can set this variable to true to +make CMake produce verbose makefiles that show each command line as it +is used. diff --git a/Help/variable/CMAKE_VERSION.rst b/Help/variable/CMAKE_VERSION.rst new file mode 100644 index 0000000..4ccc491 --- /dev/null +++ b/Help/variable/CMAKE_VERSION.rst @@ -0,0 +1,10 @@ +CMAKE_VERSION +------------- + +The full version of cmake in major.minor.patch[.tweak[-id]] format. + +This specifies the full version of the CMake executable being run. +This variable is defined by versions 2.6.3 and higher. See variables +CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, CMAKE_PATCH_VERSION, and +CMAKE_TWEAK_VERSION for individual version components. The [-id] +component appears in non-release versions and may be arbitrary text. diff --git a/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst b/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst new file mode 100644 index 0000000..f55c7b1 --- /dev/null +++ b/Help/variable/CMAKE_VISIBILITY_INLINES_HIDDEN.rst @@ -0,0 +1,8 @@ +CMAKE_VISIBILITY_INLINES_HIDDEN +------------------------------- + +Default value for VISIBILITY_INLINES_HIDDEN of targets. + +This variable is used to initialize the VISIBILITY_INLINES_HIDDEN +property on all the targets. See that target property for additional +information. diff --git a/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst new file mode 100644 index 0000000..08c6061 --- /dev/null +++ b/Help/variable/CMAKE_VS_PLATFORM_TOOLSET.rst @@ -0,0 +1,10 @@ +CMAKE_VS_PLATFORM_TOOLSET +------------------------- + +Visual Studio Platform Toolset name. + +VS 10 and above use MSBuild under the hood and support multiple +compiler toolchains. CMake may specify a toolset explicitly, such as +"v110" for VS 11 or "Windows7.1SDK" for 64-bit support in VS 10 +Express. CMake provides the name of the chosen toolset in this +variable. diff --git a/Help/variable/CMAKE_WARN_DEPRECATED.rst b/Help/variable/CMAKE_WARN_DEPRECATED.rst new file mode 100644 index 0000000..7b2510b --- /dev/null +++ b/Help/variable/CMAKE_WARN_DEPRECATED.rst @@ -0,0 +1,7 @@ +CMAKE_WARN_DEPRECATED +--------------------- + +Whether to issue deprecation warnings for macros and functions. + +If TRUE, this can be used by macros and functions to issue deprecation +warnings. This variable is FALSE by default. diff --git a/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..f6a188d --- /dev/null +++ b/Help/variable/CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,8 @@ +CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------ + +Ask cmake_install.cmake script to warn each time a file with absolute INSTALL DESTINATION is encountered. + +This variable is used by CMake-generated cmake_install.cmake scripts. +If one sets this variable to ON while running the script, it may get +warning messages from the script. diff --git a/Help/variable/CMAKE_WIN32_EXECUTABLE.rst b/Help/variable/CMAKE_WIN32_EXECUTABLE.rst new file mode 100644 index 0000000..3e1e0dd --- /dev/null +++ b/Help/variable/CMAKE_WIN32_EXECUTABLE.rst @@ -0,0 +1,7 @@ +CMAKE_WIN32_EXECUTABLE +---------------------- + +Default value for WIN32_EXECUTABLE of targets. + +This variable is used to initialize the WIN32_EXECUTABLE property on +all the targets. See that target property for additional information. diff --git a/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst b/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst new file mode 100644 index 0000000..f0a4841 --- /dev/null +++ b/Help/variable/CMAKE_XCODE_PLATFORM_TOOLSET.rst @@ -0,0 +1,9 @@ +CMAKE_XCODE_PLATFORM_TOOLSET +---------------------------- + +Xcode compiler selection. + +Xcode supports selection of a compiler from one of the installed +toolsets. CMake provides the name of the chosen toolset in this +variable, if any is explicitly selected (e.g. via the cmake -T +option). diff --git a/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst b/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst new file mode 100644 index 0000000..d836629 --- /dev/null +++ b/Help/variable/CPACK_ABSOLUTE_DESTINATION_FILES.rst @@ -0,0 +1,10 @@ +CPACK_ABSOLUTE_DESTINATION_FILES +-------------------------------- + +List of files which have been installed using an ABSOLUTE DESTINATION path. + +This variable is a Read-Only variable which is set internally by CPack +during installation and before packaging using +CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake +scripts. The value can be used within CPack project configuration +file and/or CPack<GEN>.cmake file of <GEN> generator. diff --git a/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst new file mode 100644 index 0000000..e938978 --- /dev/null +++ b/Help/variable/CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -0,0 +1,8 @@ +CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY +------------------------------------------ + +Boolean toggle to include/exclude top level directory (component case). + +Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY but for the +component case. See CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation +for the detail. diff --git a/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..4d96385 --- /dev/null +++ b/Help/variable/CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,10 @@ +CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------- + +Ask CPack to error out as soon as a file with absolute INSTALL DESTINATION is encountered. + +The fatal error is emitted before the installation of the offending +file takes place. Some CPack generators, like NSIS,enforce this +internally. This variable triggers the definition +ofCMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runsVariables +common to all CPack generators diff --git a/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst new file mode 100644 index 0000000..4f96bff --- /dev/null +++ b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -0,0 +1,19 @@ +CPACK_INCLUDE_TOPLEVEL_DIRECTORY +-------------------------------- + +Boolean toggle to include/exclude top level directory. + +When preparing a package CPack installs the item under the so-called +top level directory. The purpose of is to include (set to 1 or ON or +TRUE) the top level directory in the package or not (set to 0 or OFF +or FALSE). + +Each CPack generator has a built-in default value for this variable. +E.g. Archive generators (ZIP, TGZ, ...) includes the top level +whereas RPM or DEB don't. The user may override the default value by +setting this variable. + +There is a similar variable CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY +which may be used to override the behavior for the component packaging +case which may have different default value for historical (now +backward compatibility) reason. diff --git a/Help/variable/CPACK_INSTALL_SCRIPT.rst b/Help/variable/CPACK_INSTALL_SCRIPT.rst new file mode 100644 index 0000000..59b8cd7 --- /dev/null +++ b/Help/variable/CPACK_INSTALL_SCRIPT.rst @@ -0,0 +1,8 @@ +CPACK_INSTALL_SCRIPT +-------------------- + +Extra CMake script provided by the user. + +If set this CMake script will be executed by CPack during its local +[CPack-private] installation which is done right before packaging the +files. The script is not called by e.g.: make install. diff --git a/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst b/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst new file mode 100644 index 0000000..f9cfa1b --- /dev/null +++ b/Help/variable/CPACK_PACKAGING_INSTALL_PREFIX.rst @@ -0,0 +1,13 @@ +CPACK_PACKAGING_INSTALL_PREFIX +------------------------------ + +The prefix used in the built package. + +Each CPack generator has a default value (like /usr). This default +value may be overwritten from the CMakeLists.txt or the cpack command +line by setting an alternative value. + +e.g. set(CPACK_PACKAGING_INSTALL_PREFIX "/opt") + +This is not the same purpose as CMAKE_INSTALL_PREFIX which is used +when installing from the build tree without building a package. diff --git a/Help/variable/CPACK_SET_DESTDIR.rst b/Help/variable/CPACK_SET_DESTDIR.rst new file mode 100644 index 0000000..69d82e6 --- /dev/null +++ b/Help/variable/CPACK_SET_DESTDIR.rst @@ -0,0 +1,30 @@ +CPACK_SET_DESTDIR +----------------- + +Boolean toggle to make CPack use DESTDIR mechanism when packaging. + +DESTDIR means DESTination DIRectory. It is commonly used by makefile +users in order to install software at non-default location. It is a +basic relocation mechanism that should not be used on Windows (see +CMAKE_INSTALL_PREFIX documentation). It is usually invoked like this: + +:: + + make DESTDIR=/home/john install + +which will install the concerned software using the installation +prefix, e.g. "/usr/local" prepended with the DESTDIR value which +finally gives "/home/john/usr/local". When preparing a package, CPack +first installs the items to be packaged in a local (to the build tree) +directory by using the same DESTDIR mechanism. Nevertheless, if +CPACK_SET_DESTDIR is set then CPack will set DESTDIR before doing the +local install. The most noticeable difference is that without +CPACK_SET_DESTDIR, CPack uses CPACK_PACKAGING_INSTALL_PREFIX as a +prefix whereas with CPACK_SET_DESTDIR set, CPack will use +CMAKE_INSTALL_PREFIX as a prefix. + +Manually setting CPACK_SET_DESTDIR may help (or simply be necessary) +if some install rules uses absolute DESTINATION (see CMake INSTALL +command). However, starting with CPack/CMake 2.8.3 RPM and DEB +installers tries to handle DESTDIR automatically so that it is seldom +necessary for the user to set it. diff --git a/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst new file mode 100644 index 0000000..8d6f54f --- /dev/null +++ b/Help/variable/CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -0,0 +1,8 @@ +CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION +------------------------------------------ + +Ask CPack to warn each time a file with absolute INSTALL DESTINATION is encountered. + +This variable triggers the definition of +CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs +cmake_install.cmake scripts. diff --git a/Help/variable/CYGWIN.rst b/Help/variable/CYGWIN.rst new file mode 100644 index 0000000..c168878 --- /dev/null +++ b/Help/variable/CYGWIN.rst @@ -0,0 +1,6 @@ +CYGWIN +------ + +True for Cygwin. + +Set to true when using Cygwin. diff --git a/Help/variable/ENV.rst b/Help/variable/ENV.rst new file mode 100644 index 0000000..977afc3 --- /dev/null +++ b/Help/variable/ENV.rst @@ -0,0 +1,7 @@ +ENV +--- + +Access environment variables. + +Use the syntax $ENV{VAR} to read environment variable VAR. See also +the set() command to set ENV{VAR}. diff --git a/Help/variable/EXECUTABLE_OUTPUT_PATH.rst b/Help/variable/EXECUTABLE_OUTPUT_PATH.rst new file mode 100644 index 0000000..7079230 --- /dev/null +++ b/Help/variable/EXECUTABLE_OUTPUT_PATH.rst @@ -0,0 +1,8 @@ +EXECUTABLE_OUTPUT_PATH +---------------------- + +Old executable location variable. + +The target property RUNTIME_OUTPUT_DIRECTORY supercedes this variable +for a target if it is set. Executable targets are otherwise placed in +this directory. diff --git a/Help/variable/LIBRARY_OUTPUT_PATH.rst b/Help/variable/LIBRARY_OUTPUT_PATH.rst new file mode 100644 index 0000000..1c1f8ae --- /dev/null +++ b/Help/variable/LIBRARY_OUTPUT_PATH.rst @@ -0,0 +1,9 @@ +LIBRARY_OUTPUT_PATH +------------------- + +Old library location variable. + +The target properties ARCHIVE_OUTPUT_DIRECTORY, +LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede this +variable for a target if they are set. Library targets are otherwise +placed in this directory. diff --git a/Help/variable/MSVC.rst b/Help/variable/MSVC.rst new file mode 100644 index 0000000..e9f931b --- /dev/null +++ b/Help/variable/MSVC.rst @@ -0,0 +1,6 @@ +MSVC +---- + +True when using Microsoft Visual C + +Set to true when the compiler is some version of Microsoft Visual C. diff --git a/Help/variable/MSVC10.rst b/Help/variable/MSVC10.rst new file mode 100644 index 0000000..894c5aa --- /dev/null +++ b/Help/variable/MSVC10.rst @@ -0,0 +1,6 @@ +MSVC10 +------ + +True when using Microsoft Visual C 10.0 + +Set to true when the compiler is version 10.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC11.rst b/Help/variable/MSVC11.rst new file mode 100644 index 0000000..fe25297 --- /dev/null +++ b/Help/variable/MSVC11.rst @@ -0,0 +1,6 @@ +MSVC11 +------ + +True when using Microsoft Visual C 11.0 + +Set to true when the compiler is version 11.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC12.rst b/Help/variable/MSVC12.rst new file mode 100644 index 0000000..216d3d3 --- /dev/null +++ b/Help/variable/MSVC12.rst @@ -0,0 +1,6 @@ +MSVC12 +------ + +True when using Microsoft Visual C 12.0 + +Set to true when the compiler is version 12.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC60.rst b/Help/variable/MSVC60.rst new file mode 100644 index 0000000..572e9f4 --- /dev/null +++ b/Help/variable/MSVC60.rst @@ -0,0 +1,6 @@ +MSVC60 +------ + +True when using Microsoft Visual C 6.0 + +Set to true when the compiler is version 6.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC70.rst b/Help/variable/MSVC70.rst new file mode 100644 index 0000000..b1b7a881 --- /dev/null +++ b/Help/variable/MSVC70.rst @@ -0,0 +1,6 @@ +MSVC70 +------ + +True when using Microsoft Visual C 7.0 + +Set to true when the compiler is version 7.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC71.rst b/Help/variable/MSVC71.rst new file mode 100644 index 0000000..af309a6 --- /dev/null +++ b/Help/variable/MSVC71.rst @@ -0,0 +1,6 @@ +MSVC71 +------ + +True when using Microsoft Visual C 7.1 + +Set to true when the compiler is version 7.1 of Microsoft Visual C. diff --git a/Help/variable/MSVC80.rst b/Help/variable/MSVC80.rst new file mode 100644 index 0000000..306c67f --- /dev/null +++ b/Help/variable/MSVC80.rst @@ -0,0 +1,6 @@ +MSVC80 +------ + +True when using Microsoft Visual C 8.0 + +Set to true when the compiler is version 8.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC90.rst b/Help/variable/MSVC90.rst new file mode 100644 index 0000000..3cfcc67 --- /dev/null +++ b/Help/variable/MSVC90.rst @@ -0,0 +1,6 @@ +MSVC90 +------ + +True when using Microsoft Visual C 9.0 + +Set to true when the compiler is version 9.0 of Microsoft Visual C. diff --git a/Help/variable/MSVC_IDE.rst b/Help/variable/MSVC_IDE.rst new file mode 100644 index 0000000..055f876 --- /dev/null +++ b/Help/variable/MSVC_IDE.rst @@ -0,0 +1,7 @@ +MSVC_IDE +-------- + +True when using the Microsoft Visual C IDE + +Set to true when the target platform is the Microsoft Visual C IDE, as +opposed to the command line compiler. diff --git a/Help/variable/MSVC_VERSION.rst b/Help/variable/MSVC_VERSION.rst new file mode 100644 index 0000000..d74114e --- /dev/null +++ b/Help/variable/MSVC_VERSION.rst @@ -0,0 +1,17 @@ +MSVC_VERSION +------------ + +The version of Microsoft Visual C/C++ being used if any. + +Known version numbers are: + +:: + + 1200 = VS 6.0 + 1300 = VS 7.0 + 1310 = VS 7.1 + 1400 = VS 8.0 + 1500 = VS 9.0 + 1600 = VS 10.0 + 1700 = VS 11.0 + 1800 = VS 12.0 diff --git a/Help/variable/PROJECT-NAME_BINARY_DIR.rst b/Help/variable/PROJECT-NAME_BINARY_DIR.rst new file mode 100644 index 0000000..a19940f --- /dev/null +++ b/Help/variable/PROJECT-NAME_BINARY_DIR.rst @@ -0,0 +1,8 @@ +<PROJECT-NAME>_BINARY_DIR +------------------------- + +Top level binary directory for the named project. + +A variable is created with the name used in the PROJECT command, and +is the binary directory for the project. This can be useful when +SUBDIR is used to connect several projects. diff --git a/Help/variable/PROJECT-NAME_SOURCE_DIR.rst b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst new file mode 100644 index 0000000..f2f5caf --- /dev/null +++ b/Help/variable/PROJECT-NAME_SOURCE_DIR.rst @@ -0,0 +1,8 @@ +<PROJECT-NAME>_SOURCE_DIR +------------------------- + +Top level source directory for the named project. + +A variable is created with the name used in the PROJECT command, and +is the source directory for the project. This can be useful when +add_subdirectory is used to connect several projects. diff --git a/Help/variable/PROJECT_BINARY_DIR.rst b/Help/variable/PROJECT_BINARY_DIR.rst new file mode 100644 index 0000000..e506bdd --- /dev/null +++ b/Help/variable/PROJECT_BINARY_DIR.rst @@ -0,0 +1,6 @@ +PROJECT_BINARY_DIR +------------------ + +Full path to build directory for project. + +This is the binary directory of the most recent PROJECT command. diff --git a/Help/variable/PROJECT_NAME.rst b/Help/variable/PROJECT_NAME.rst new file mode 100644 index 0000000..7559af6 --- /dev/null +++ b/Help/variable/PROJECT_NAME.rst @@ -0,0 +1,6 @@ +PROJECT_NAME +------------ + +Name of the project given to the project command. + +This is the name given to the most recent PROJECT command. diff --git a/Help/variable/PROJECT_SOURCE_DIR.rst b/Help/variable/PROJECT_SOURCE_DIR.rst new file mode 100644 index 0000000..c9ba132 --- /dev/null +++ b/Help/variable/PROJECT_SOURCE_DIR.rst @@ -0,0 +1,6 @@ +PROJECT_SOURCE_DIR +------------------ + +Top level source directory for the current project. + +This is the source directory of the most recent PROJECT command. diff --git a/Help/variable/UNIX.rst b/Help/variable/UNIX.rst new file mode 100644 index 0000000..82e3454 --- /dev/null +++ b/Help/variable/UNIX.rst @@ -0,0 +1,7 @@ +UNIX +---- + +True for UNIX and UNIX like operating systems. + +Set to true when the target system is UNIX or UNIX like (i.e. APPLE +and CYGWIN). diff --git a/Help/variable/WIN32.rst b/Help/variable/WIN32.rst new file mode 100644 index 0000000..8cf7bf3 --- /dev/null +++ b/Help/variable/WIN32.rst @@ -0,0 +1,6 @@ +WIN32 +----- + +True on windows systems, including win64. + +Set to true when the target system is Windows. diff --git a/Help/variable/XCODE_VERSION.rst b/Help/variable/XCODE_VERSION.rst new file mode 100644 index 0000000..b6f0403 --- /dev/null +++ b/Help/variable/XCODE_VERSION.rst @@ -0,0 +1,7 @@ +XCODE_VERSION +------------- + +Version of Xcode (Xcode generator only). + +Under the Xcode generator, this is the version of Xcode as specified +in "Xcode.app/Contents/version.plist" (such as "3.1.2"). diff --git a/Modules/AddFileDependencies.cmake b/Modules/AddFileDependencies.cmake index e88025c..4d01a52 100644 --- a/Modules/AddFileDependencies.cmake +++ b/Modules/AddFileDependencies.cmake @@ -1,6 +1,10 @@ -# - ADD_FILE_DEPENDENCIES(source_file depend_files...) -# Adds the given files as dependencies to source_file +#.rst: +# AddFileDependencies +# ------------------- +# +# ADD_FILE_DEPENDENCIES(source_file depend_files...) # +# Adds the given files as dependencies to source_file #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/BundleUtilities.cmake b/Modules/BundleUtilities.cmake index 0f6cd05..b896de2 100644 --- a/Modules/BundleUtilities.cmake +++ b/Modules/BundleUtilities.cmake @@ -1,146 +1,207 @@ -# - Functions to help assemble a standalone bundle application. +#.rst: +# BundleUtilities +# --------------- +# +# Functions to help assemble a standalone bundle application. +# # A collection of CMake utility functions useful for dealing with .app # bundles on the Mac and bundle-like directories on any OS. # # The following functions are provided by this module: -# fixup_bundle -# copy_and_fixup_bundle -# verify_app -# get_bundle_main_executable -# get_dotapp_dir -# get_bundle_and_executable -# get_bundle_all_executables -# get_item_key -# clear_bundle_keys -# set_bundle_key_values -# get_bundle_keys -# copy_resolved_item_into_bundle -# copy_resolved_framework_into_bundle -# fixup_bundle_item -# verify_bundle_prerequisites -# verify_bundle_symlinks +# +# :: +# +# fixup_bundle +# copy_and_fixup_bundle +# verify_app +# get_bundle_main_executable +# get_dotapp_dir +# get_bundle_and_executable +# get_bundle_all_executables +# get_item_key +# clear_bundle_keys +# set_bundle_key_values +# get_bundle_keys +# copy_resolved_item_into_bundle +# copy_resolved_framework_into_bundle +# fixup_bundle_item +# verify_bundle_prerequisites +# verify_bundle_symlinks +# # Requires CMake 2.6 or greater because it uses function, break and -# PARENT_SCOPE. Also depends on GetPrerequisites.cmake. +# PARENT_SCOPE. Also depends on GetPrerequisites.cmake. +# +# :: +# +# FIXUP_BUNDLE(<app> <libs> <dirs>) # -# FIXUP_BUNDLE(<app> <libs> <dirs>) # Fix up a bundle in-place and make it standalone, such that it can be -# drag-n-drop copied to another machine and run on that machine as long as all -# of the system libraries are compatible. +# drag-n-drop copied to another machine and run on that machine as long +# as all of the system libraries are compatible. +# +# If you pass plugins to fixup_bundle as the libs parameter, you should +# install them or copy them into the bundle before calling fixup_bundle. +# The "libs" parameter is a list of libraries that must be fixed up, but +# that cannot be determined by otool output analysis. (i.e., plugins) +# +# Gather all the keys for all the executables and libraries in a bundle, +# and then, for each key, copy each prerequisite into the bundle. Then +# fix each one up according to its own list of prerequisites. +# +# Then clear all the keys and call verify_app on the final bundle to +# ensure that it is truly standalone. +# +# :: # -# If you pass plugins to fixup_bundle as the libs parameter, you should install -# them or copy them into the bundle before calling fixup_bundle. The "libs" -# parameter is a list of libraries that must be fixed up, but that cannot be -# determined by otool output analysis. (i.e., plugins) +# COPY_AND_FIXUP_BUNDLE(<src> <dst> <libs> <dirs>) # -# Gather all the keys for all the executables and libraries in a bundle, and -# then, for each key, copy each prerequisite into the bundle. Then fix each one -# up according to its own list of prerequisites. +# Makes a copy of the bundle <src> at location <dst> and then fixes up +# the new copied bundle in-place at <dst>... # -# Then clear all the keys and call verify_app on the final bundle to ensure -# that it is truly standalone. +# :: # -# COPY_AND_FIXUP_BUNDLE(<src> <dst> <libs> <dirs>) -# Makes a copy of the bundle <src> at location <dst> and then fixes up the -# new copied bundle in-place at <dst>... +# VERIFY_APP(<app>) # -# VERIFY_APP(<app>) -# Verifies that an application <app> appears valid based on running analysis -# tools on it. Calls "message(FATAL_ERROR" if the application is not verified. +# Verifies that an application <app> appears valid based on running +# analysis tools on it. Calls "message(FATAL_ERROR" if the application +# is not verified. # -# GET_BUNDLE_MAIN_EXECUTABLE(<bundle> <result_var>) -# The result will be the full path name of the bundle's main executable file -# or an "error:" prefixed string if it could not be determined. +# :: # -# GET_DOTAPP_DIR(<exe> <dotapp_dir_var>) -# Returns the nearest parent dir whose name ends with ".app" given the full -# path to an executable. If there is no such parent dir, then simply return -# the dir containing the executable. +# GET_BUNDLE_MAIN_EXECUTABLE(<bundle> <result_var>) +# +# The result will be the full path name of the bundle's main executable +# file or an "error:" prefixed string if it could not be determined. +# +# :: +# +# GET_DOTAPP_DIR(<exe> <dotapp_dir_var>) +# +# Returns the nearest parent dir whose name ends with ".app" given the +# full path to an executable. If there is no such parent dir, then +# simply return the dir containing the executable. # # The returned directory may or may not exist. # -# GET_BUNDLE_AND_EXECUTABLE(<app> <bundle_var> <executable_var> <valid_var>) +# :: +# +# GET_BUNDLE_AND_EXECUTABLE(<app> <bundle_var> <executable_var> <valid_var>) +# # Takes either a ".app" directory name or the name of an executable # nested inside a ".app" directory and returns the path to the ".app" # directory in <bundle_var> and the path to its main executable in # <executable_var> # -# GET_BUNDLE_ALL_EXECUTABLES(<bundle> <exes_var>) -# Scans the given bundle recursively for all executable files and accumulates -# them into a variable. +# :: +# +# GET_BUNDLE_ALL_EXECUTABLES(<bundle> <exes_var>) +# +# Scans the given bundle recursively for all executable files and +# accumulates them into a variable. +# +# :: +# +# GET_ITEM_KEY(<item> <key_var>) +# +# Given a file (item) name, generate a key that should be unique +# considering the set of libraries that need copying or fixing up to +# make a bundle standalone. This is essentially the file name including +# extension with "." replaced by "_" # -# GET_ITEM_KEY(<item> <key_var>) -# Given a file (item) name, generate a key that should be unique considering -# the set of libraries that need copying or fixing up to make a bundle -# standalone. This is essentially the file name including extension with "." -# replaced by "_" +# This key is used as a prefix for CMake variables so that we can +# associate a set of variables with a given item based on its key. # -# This key is used as a prefix for CMake variables so that we can associate a -# set of variables with a given item based on its key. +# :: # -# CLEAR_BUNDLE_KEYS(<keys_var>) -# Loop over the list of keys, clearing all the variables associated with each -# key. After the loop, clear the list of keys itself. +# CLEAR_BUNDLE_KEYS(<keys_var>) # -# Caller of get_bundle_keys should call clear_bundle_keys when done with list -# of keys. +# Loop over the list of keys, clearing all the variables associated with +# each key. After the loop, clear the list of keys itself. # -# SET_BUNDLE_KEY_VALUES(<keys_var> <context> <item> <exepath> <dirs> -# <copyflag>) -# Add a key to the list (if necessary) for the given item. If added, +# Caller of get_bundle_keys should call clear_bundle_keys when done with +# list of keys. +# +# :: +# +# SET_BUNDLE_KEY_VALUES(<keys_var> <context> <item> <exepath> <dirs> +# <copyflag>) +# +# Add a key to the list (if necessary) for the given item. If added, # also set all the variables associated with that key. # -# GET_BUNDLE_KEYS(<app> <libs> <dirs> <keys_var>) -# Loop over all the executable and library files within the bundle (and given -# as extra <libs>) and accumulate a list of keys representing them. Set -# values associated with each key such that we can loop over all of them and -# copy prerequisite libs into the bundle and then do appropriate -# install_name_tool fixups. -# -# COPY_RESOLVED_ITEM_INTO_BUNDLE(<resolved_item> <resolved_embedded_item>) -# Copy a resolved item into the bundle if necessary. Copy is not necessary if -# the resolved_item is "the same as" the resolved_embedded_item. -# -# COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE(<resolved_item> <resolved_embedded_item>) -# Copy a resolved framework into the bundle if necessary. Copy is not necessary -# if the resolved_item is "the same as" the resolved_embedded_item. -# -# By default, BU_COPY_FULL_FRAMEWORK_CONTENTS is not set. If you want full -# frameworks embedded in your bundles, set BU_COPY_FULL_FRAMEWORK_CONTENTS to -# ON before calling fixup_bundle. By default, -# COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE copies the framework dylib itself plus -# the framework Resources directory. -# -# FIXUP_BUNDLE_ITEM(<resolved_embedded_item> <exepath> <dirs>) -# Get the direct/non-system prerequisites of the resolved embedded item. For -# each prerequisite, change the way it is referenced to the value of the -# _EMBEDDED_ITEM keyed variable for that prerequisite. (Most likely changing to -# an "@executable_path" style reference.) -# -# This function requires that the resolved_embedded_item be "inside" the bundle -# already. In other words, if you pass plugins to fixup_bundle as the libs -# parameter, you should install them or copy them into the bundle before -# calling fixup_bundle. The "libs" parameter is a list of libraries that must -# be fixed up, but that cannot be determined by otool output analysis. (i.e., -# plugins) -# -# Also, change the id of the item being fixed up to its own _EMBEDDED_ITEM -# value. +# :: +# +# GET_BUNDLE_KEYS(<app> <libs> <dirs> <keys_var>) +# +# Loop over all the executable and library files within the bundle (and +# given as extra <libs>) and accumulate a list of keys representing +# them. Set values associated with each key such that we can loop over +# all of them and copy prerequisite libs into the bundle and then do +# appropriate install_name_tool fixups. +# +# :: +# +# COPY_RESOLVED_ITEM_INTO_BUNDLE(<resolved_item> <resolved_embedded_item>) +# +# Copy a resolved item into the bundle if necessary. Copy is not +# necessary if the resolved_item is "the same as" the +# resolved_embedded_item. +# +# :: +# +# COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE(<resolved_item> <resolved_embedded_item>) +# +# Copy a resolved framework into the bundle if necessary. Copy is not +# necessary if the resolved_item is "the same as" the +# resolved_embedded_item. +# +# By default, BU_COPY_FULL_FRAMEWORK_CONTENTS is not set. If you want +# full frameworks embedded in your bundles, set +# BU_COPY_FULL_FRAMEWORK_CONTENTS to ON before calling fixup_bundle. By +# default, COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE copies the framework +# dylib itself plus the framework Resources directory. +# +# :: +# +# FIXUP_BUNDLE_ITEM(<resolved_embedded_item> <exepath> <dirs>) +# +# Get the direct/non-system prerequisites of the resolved embedded item. +# For each prerequisite, change the way it is referenced to the value of +# the _EMBEDDED_ITEM keyed variable for that prerequisite. (Most likely +# changing to an "@executable_path" style reference.) +# +# This function requires that the resolved_embedded_item be "inside" the +# bundle already. In other words, if you pass plugins to fixup_bundle +# as the libs parameter, you should install them or copy them into the +# bundle before calling fixup_bundle. The "libs" parameter is a list of +# libraries that must be fixed up, but that cannot be determined by +# otool output analysis. (i.e., plugins) +# +# Also, change the id of the item being fixed up to its own +# _EMBEDDED_ITEM value. # # Accumulate changes in a local variable and make *one* call to -# install_name_tool at the end of the function with all the changes at once. +# install_name_tool at the end of the function with all the changes at +# once. # # If the BU_CHMOD_BUNDLE_ITEMS variable is set then bundle items will be # marked writable before install_name_tool tries to change them. # -# VERIFY_BUNDLE_PREREQUISITES(<bundle> <result_var> <info_var>) -# Verifies that the sum of all prerequisites of all files inside the bundle -# are contained within the bundle or are "system" libraries, presumed to exist -# everywhere. +# :: +# +# VERIFY_BUNDLE_PREREQUISITES(<bundle> <result_var> <info_var>) +# +# Verifies that the sum of all prerequisites of all files inside the +# bundle are contained within the bundle or are "system" libraries, +# presumed to exist everywhere. +# +# :: +# +# VERIFY_BUNDLE_SYMLINKS(<bundle> <result_var> <info_var>) # -# VERIFY_BUNDLE_SYMLINKS(<bundle> <result_var> <info_var>) -# Verifies that any symlinks found in the bundle point to other files that are -# already also in the bundle... Anything that points to an external file causes -# this function to fail the verification. +# Verifies that any symlinks found in the bundle point to other files +# that are already also in the bundle... Anything that points to an +# external file causes this function to fail the verification. #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/CMakeAddFortranSubdirectory.cmake b/Modules/CMakeAddFortranSubdirectory.cmake index abd9100..2e5a76f 100644 --- a/Modules/CMakeAddFortranSubdirectory.cmake +++ b/Modules/CMakeAddFortranSubdirectory.cmake @@ -1,29 +1,37 @@ -# - Use MinGW gfortran from VS if a fortran compiler is not found. -# The 'add_fortran_subdirectory' function adds a subdirectory -# to a project that contains a fortran only sub-project. The module -# will check the current compiler and see if it can support fortran. -# If no fortran compiler is found and the compiler is MSVC, then -# this module will find the MinGW gfortran. It will then use -# an external project to build with the MinGW tools. It will also -# create imported targets for the libraries created. This will only -# work if the fortran code is built into a dll, so BUILD_SHARED_LIBS -# is turned on in the project. In addition the CMAKE_GNUtoMS option -# is set to on, so that the MS .lib files are created. -# Usage is as follows: -# cmake_add_fortran_subdirectory( -# <subdir> # name of subdirectory -# PROJECT <project_name> # project name in subdir top CMakeLists.txt -# ARCHIVE_DIR <dir> # dir where project places .lib files -# RUNTIME_DIR <dir> # dir where project places .dll files -# LIBRARIES <lib>... # names of library targets to import -# LINK_LIBRARIES # link interface libraries for LIBRARIES -# [LINK_LIBS <lib> <dep>...]... -# CMAKE_COMMAND_LINE ... # extra command line flags to pass to cmake -# NO_EXTERNAL_INSTALL # skip installation of external project -# ) -# Relative paths in ARCHIVE_DIR and RUNTIME_DIR are interpreted with respect -# to the build directory corresponding to the source directory in which the -# function is invoked. +#.rst: +# CMakeAddFortranSubdirectory +# --------------------------- +# +# Use MinGW gfortran from VS if a fortran compiler is not found. +# +# The 'add_fortran_subdirectory' function adds a subdirectory to a +# project that contains a fortran only sub-project. The module will +# check the current compiler and see if it can support fortran. If no +# fortran compiler is found and the compiler is MSVC, then this module +# will find the MinGW gfortran. It will then use an external project to +# build with the MinGW tools. It will also create imported targets for +# the libraries created. This will only work if the fortran code is +# built into a dll, so BUILD_SHARED_LIBS is turned on in the project. +# In addition the CMAKE_GNUtoMS option is set to on, so that the MS .lib +# files are created. Usage is as follows: +# +# :: +# +# cmake_add_fortran_subdirectory( +# <subdir> # name of subdirectory +# PROJECT <project_name> # project name in subdir top CMakeLists.txt +# ARCHIVE_DIR <dir> # dir where project places .lib files +# RUNTIME_DIR <dir> # dir where project places .dll files +# LIBRARIES <lib>... # names of library targets to import +# LINK_LIBRARIES # link interface libraries for LIBRARIES +# [LINK_LIBS <lib> <dep>...]... +# CMAKE_COMMAND_LINE ... # extra command line flags to pass to cmake +# NO_EXTERNAL_INSTALL # skip installation of external project +# ) +# +# Relative paths in ARCHIVE_DIR and RUNTIME_DIR are interpreted with +# respect to the build directory corresponding to the source directory +# in which the function is invoked. # # Limitations: # diff --git a/Modules/CMakeBackwardCompatibilityCXX.cmake b/Modules/CMakeBackwardCompatibilityCXX.cmake index cfc1d91..343fdb2 100644 --- a/Modules/CMakeBackwardCompatibilityCXX.cmake +++ b/Modules/CMakeBackwardCompatibilityCXX.cmake @@ -1,10 +1,17 @@ -# - define a bunch of backwards compatibility variables -# CMAKE_ANSI_CXXFLAGS - flag for ansi c++ -# CMAKE_HAS_ANSI_STRING_STREAM - has <strstream> -# include(TestForANSIStreamHeaders) -# include(CheckIncludeFileCXX) -# include(TestForSTDNamespace) -# include(TestForANSIForScope) +#.rst: +# CMakeBackwardCompatibilityCXX +# ----------------------------- +# +# define a bunch of backwards compatibility variables +# +# :: +# +# CMAKE_ANSI_CXXFLAGS - flag for ansi c++ +# CMAKE_HAS_ANSI_STRING_STREAM - has <strstream> +# include(TestForANSIStreamHeaders) +# include(CheckIncludeFileCXX) +# include(TestForSTDNamespace) +# include(TestForANSIForScope) #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CMakeCCompiler.cmake.in b/Modules/CMakeCCompiler.cmake.in index c41adc9..3e8d4ff 100644 --- a/Modules/CMakeCCompiler.cmake.in +++ b/Modules/CMakeCCompiler.cmake.in @@ -3,6 +3,8 @@ set(CMAKE_C_COMPILER_ARG1 "@CMAKE_C_COMPILER_ARG1@") set(CMAKE_C_COMPILER_ID "@CMAKE_C_COMPILER_ID@") set(CMAKE_C_COMPILER_VERSION "@CMAKE_C_COMPILER_VERSION@") set(CMAKE_C_PLATFORM_ID "@CMAKE_C_PLATFORM_ID@") +set(CMAKE_C_SIMULATE_ID "@CMAKE_C_SIMULATE_ID@") +set(CMAKE_C_SIMULATE_VERSION "@CMAKE_C_SIMULATE_VERSION@") @SET_MSVC_C_ARCHITECTURE_ID@ set(CMAKE_AR "@CMAKE_AR@") set(CMAKE_RANLIB "@CMAKE_RANLIB@") diff --git a/Modules/CMakeCCompilerId.c.in b/Modules/CMakeCCompilerId.c.in index 66a5582..6dde1c3 100644 --- a/Modules/CMakeCCompilerId.c.in +++ b/Modules/CMakeCCompilerId.c.in @@ -29,10 +29,21 @@ # endif #elif defined(__clang__) -# define COMPILER_ID "Clang" +# if defined(__apple_build_version__) +# define COMPILER_ID "AppleClang" +# define COMPILER_VERSION_TWEAK DEC(__apple_build_version__) +# else +# define COMPILER_ID "Clang" +# endif # define COMPILER_VERSION_MAJOR DEC(__clang_major__) # define COMPILER_VERSION_MINOR DEC(__clang_minor__) # define COMPILER_VERSION_PATCH DEC(__clang_patchlevel__) +# if defined(_MSC_VER) +# define SIMULATE_ID "MSVC" + /* _MSC_VER = VVRR */ +# define SIMULATE_VERSION_MAJOR DEC(_MSC_VER / 100) +# define SIMULATE_VERSION_MINOR DEC(_MSC_VER % 100) +# endif #elif defined(__BORLANDC__) && defined(__CODEGEARC_VERSION__) # define COMPILER_ID "Embarcadero" @@ -206,6 +217,9 @@ because some compilers will just produce instructions to fill the array rather than assigning a pointer to a static array. */ char const* info_compiler = "INFO" ":" "compiler[" COMPILER_ID "]"; +#ifdef SIMULATE_ID +char const* info_simulate = "INFO" ":" "simulate[" SIMULATE_ID "]"; +#endif @CMAKE_C_COMPILER_ID_PLATFORM_CONTENT@ @@ -223,6 +237,12 @@ int main(int argc, char* argv[]) #ifdef COMPILER_VERSION_MAJOR require += info_version[argc]; #endif +#ifdef SIMULATE_ID + require += info_simulate[argc]; +#endif +#ifdef SIMULATE_VERSION_MAJOR + require += info_simulate_version[argc]; +#endif (void)argv; return require; } diff --git a/Modules/CMakeCXXCompiler.cmake.in b/Modules/CMakeCXXCompiler.cmake.in index 9287b81..777f007 100644 --- a/Modules/CMakeCXXCompiler.cmake.in +++ b/Modules/CMakeCXXCompiler.cmake.in @@ -3,6 +3,8 @@ set(CMAKE_CXX_COMPILER_ARG1 "@CMAKE_CXX_COMPILER_ARG1@") set(CMAKE_CXX_COMPILER_ID "@CMAKE_CXX_COMPILER_ID@") set(CMAKE_CXX_COMPILER_VERSION "@CMAKE_CXX_COMPILER_VERSION@") set(CMAKE_CXX_PLATFORM_ID "@CMAKE_CXX_PLATFORM_ID@") +set(CMAKE_CXX_SIMULATE_ID "@CMAKE_CXX_SIMULATE_ID@") +set(CMAKE_CXX_SIMULATE_VERSION "@CMAKE_CXX_SIMULATE_VERSION@") @SET_MSVC_CXX_ARCHITECTURE_ID@ set(CMAKE_AR "@CMAKE_AR@") set(CMAKE_RANLIB "@CMAKE_RANLIB@") diff --git a/Modules/CMakeCXXCompilerId.cpp.in b/Modules/CMakeCXXCompilerId.cpp.in index 5e87715..3a60922 100644 --- a/Modules/CMakeCXXCompilerId.cpp.in +++ b/Modules/CMakeCXXCompilerId.cpp.in @@ -34,10 +34,21 @@ # endif #elif defined(__clang__) -# define COMPILER_ID "Clang" +# if defined(__apple_build_version__) +# define COMPILER_ID "AppleClang" +# define COMPILER_VERSION_TWEAK DEC(__apple_build_version__) +# else +# define COMPILER_ID "Clang" +# endif # define COMPILER_VERSION_MAJOR DEC(__clang_major__) # define COMPILER_VERSION_MINOR DEC(__clang_minor__) # define COMPILER_VERSION_PATCH DEC(__clang_patchlevel__) +# if defined(_MSC_VER) +# define SIMULATE_ID "MSVC" + /* _MSC_VER = VVRR */ +# define SIMULATE_VERSION_MAJOR DEC(_MSC_VER / 100) +# define SIMULATE_VERSION_MINOR DEC(_MSC_VER % 100) +# endif #elif defined(__BORLANDC__) && defined(__CODEGEARC_VERSION__) # define COMPILER_ID "Embarcadero" @@ -199,6 +210,9 @@ because some compilers will just produce instructions to fill the array rather than assigning a pointer to a static array. */ char const* info_compiler = "INFO" ":" "compiler[" COMPILER_ID "]"; +#ifdef SIMULATE_ID +char const* info_simulate = "INFO" ":" "simulate[" SIMULATE_ID "]"; +#endif @CMAKE_CXX_COMPILER_ID_PLATFORM_CONTENT@ @@ -212,6 +226,12 @@ int main(int argc, char* argv[]) #ifdef COMPILER_VERSION_MAJOR require += info_version[argc]; #endif +#ifdef SIMULATE_ID + require += info_simulate[argc]; +#endif +#ifdef SIMULATE_VERSION_MAJOR + require += info_simulate_version[argc]; +#endif (void)argv; return require; } diff --git a/Modules/CMakeCheckCompilerFlagCommonPatterns.cmake b/Modules/CMakeCheckCompilerFlagCommonPatterns.cmake new file mode 100644 index 0000000..9d8ba9e --- /dev/null +++ b/Modules/CMakeCheckCompilerFlagCommonPatterns.cmake @@ -0,0 +1,41 @@ + +#============================================================================= +# Copyright 2006-2011 Kitware, Inc. +# Copyright 2006 Alexander Neundorf <neundorf@kde.org> +# Copyright 2011 Matthias Kretz <kretz@kde.org> +# Copyright 2013 Rolf Eike Beer <eike@sf-mail.de> +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +# (To distribute this file outside of CMake, substitute the full +# License text for the above reference.) + +# Do NOT include this module directly into any of your code. It is meant as +# a library for Check*CompilerFlag.cmake modules. It's content may change in +# any way between releases. + +macro (CHECK_COMPILER_FLAG_COMMON_PATTERNS _VAR) + set(${_VAR} + FAIL_REGEX "unrecognized .*option" # GNU + FAIL_REGEX "unknown .*option" # Clang + FAIL_REGEX "ignoring unknown option" # MSVC + FAIL_REGEX "warning D9002" # MSVC, any lang + FAIL_REGEX "option.*not supported" # Intel + FAIL_REGEX "invalid argument .*option" # Intel + FAIL_REGEX "ignoring option .*argument required" # Intel + FAIL_REGEX "[Uu]nknown option" # HP + FAIL_REGEX "[Ww]arning: [Oo]ption" # SunPro + FAIL_REGEX "command option .* is not recognized" # XL + FAIL_REGEX "command option .* contains an incorrect subargument" # XL + FAIL_REGEX "not supported in this configuration; ignored" # AIX + FAIL_REGEX "File with unknown suffix passed to linker" # PGI + FAIL_REGEX "WARNING: unknown flag:" # Open64 + FAIL_REGEX "Incorrect command line option:" # Borland + FAIL_REGEX "Warning: illegal option" # SunStudio 12 + ) +endmacro () diff --git a/Modules/CMakeDependentOption.cmake b/Modules/CMakeDependentOption.cmake index 990728f..7e9f183 100644 --- a/Modules/CMakeDependentOption.cmake +++ b/Modules/CMakeDependentOption.cmake @@ -1,15 +1,23 @@ -# - Macro to provide an option dependent on other options. +#.rst: +# CMakeDependentOption +# -------------------- +# +# Macro to provide an option dependent on other options. +# # This macro presents an option to the user only if a set of other -# conditions are true. When the option is not presented a default -# value is used, but any value set by the user is preserved for when -# the option is presented again. -# Example invocation: -# CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON -# "USE_BAR;NOT USE_ZOT" OFF) -# If USE_BAR is true and USE_ZOT is false, this provides an option called -# USE_FOO that defaults to ON. Otherwise, it sets USE_FOO to OFF. If -# the status of USE_BAR or USE_ZOT ever changes, any value for the -# USE_FOO option is saved so that when the option is re-enabled it +# conditions are true. When the option is not presented a default value +# is used, but any value set by the user is preserved for when the +# option is presented again. Example invocation: +# +# :: +# +# CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON +# "USE_BAR;NOT USE_ZOT" OFF) +# +# If USE_BAR is true and USE_ZOT is false, this provides an option +# called USE_FOO that defaults to ON. Otherwise, it sets USE_FOO to +# OFF. If the status of USE_BAR or USE_ZOT ever changes, any value for +# the USE_FOO option is saved so that when the option is re-enabled it # retains its old value. #============================================================================= diff --git a/Modules/CMakeDetermineCompilerId.cmake b/Modules/CMakeDetermineCompilerId.cmake index da955cb..de4a882 100644 --- a/Modules/CMakeDetermineCompilerId.cmake +++ b/Modules/CMakeDetermineCompilerId.cmake @@ -80,6 +80,8 @@ function(CMAKE_DETERMINE_COMPILER_ID lang flagvar src) set(MSVC_${lang}_ARCHITECTURE_ID "${MSVC_${lang}_ARCHITECTURE_ID}" PARENT_SCOPE) set(CMAKE_${lang}_COMPILER_VERSION "${CMAKE_${lang}_COMPILER_VERSION}" PARENT_SCOPE) + set(CMAKE_${lang}_SIMULATE_ID "${CMAKE_${lang}_SIMULATE_ID}" PARENT_SCOPE) + set(CMAKE_${lang}_SIMULATE_VERSION "${CMAKE_${lang}_SIMULATE_VERSION}" PARENT_SCOPE) endfunction() #----------------------------------------------------------------------------- @@ -309,9 +311,12 @@ function(CMAKE_DETERMINE_COMPILER_ID_CHECK lang file) set(COMPILER_ID) set(COMPILER_VERSION) set(PLATFORM_ID) + set(ARCHITECTURE_ID) + set(SIMULATE_ID) + set(SIMULATE_VERSION) file(STRINGS ${file} - CMAKE_${lang}_COMPILER_ID_STRINGS LIMIT_COUNT 4 REGEX "INFO:") - set(HAVE_COMPILER_TWICE 0) + CMAKE_${lang}_COMPILER_ID_STRINGS LIMIT_COUNT 6 REGEX "INFO:") + set(COMPILER_ID_TWICE) foreach(info ${CMAKE_${lang}_COMPILER_ID_STRINGS}) if("${info}" MATCHES ".*INFO:compiler\\[([^]\"]*)\\].*") if(COMPILER_ID) @@ -333,6 +338,14 @@ function(CMAKE_DETERMINE_COMPILER_ID_CHECK lang file) string(REGEX REPLACE "^0+([0-9])" "\\1" COMPILER_VERSION "${COMPILER_VERSION}") string(REGEX REPLACE "\\.0+([0-9])" ".\\1" COMPILER_VERSION "${COMPILER_VERSION}") endif() + if("${info}" MATCHES ".*INFO:simulate\\[([^]\"]*)\\].*") + set(SIMULATE_ID "${CMAKE_MATCH_1}") + endif() + if("${info}" MATCHES ".*INFO:simulate_version\\[([^]\"]*)\\].*") + set(SIMULATE_VERSION "${CMAKE_MATCH_1}") + string(REGEX REPLACE "^0+([0-9])" "\\1" SIMULATE_VERSION "${SIMULATE_VERSION}") + string(REGEX REPLACE "\\.0+([0-9])" ".\\1" SIMULATE_VERSION "${SIMULATE_VERSION}") + endif() endforeach() # Detect the exact architecture from the PE header. @@ -370,6 +383,8 @@ function(CMAKE_DETERMINE_COMPILER_ID_CHECK lang file) set(CMAKE_${lang}_PLATFORM_ID "${PLATFORM_ID}") set(MSVC_${lang}_ARCHITECTURE_ID "${ARCHITECTURE_ID}") set(CMAKE_${lang}_COMPILER_VERSION "${COMPILER_VERSION}") + set(CMAKE_${lang}_SIMULATE_ID "${SIMULATE_ID}") + set(CMAKE_${lang}_SIMULATE_VERSION "${SIMULATE_VERSION}") endif() # Check the compiler identification string. @@ -418,6 +433,8 @@ function(CMAKE_DETERMINE_COMPILER_ID_CHECK lang file) set(MSVC_${lang}_ARCHITECTURE_ID "${MSVC_${lang}_ARCHITECTURE_ID}" PARENT_SCOPE) set(CMAKE_${lang}_COMPILER_VERSION "${CMAKE_${lang}_COMPILER_VERSION}" PARENT_SCOPE) + set(CMAKE_${lang}_SIMULATE_ID "${CMAKE_${lang}_SIMULATE_ID}" PARENT_SCOPE) + set(CMAKE_${lang}_SIMULATE_VERSION "${CMAKE_${lang}_SIMULATE_VERSION}" PARENT_SCOPE) set(CMAKE_EXECUTABLE_FORMAT "${CMAKE_EXECUTABLE_FORMAT}" PARENT_SCOPE) endfunction() diff --git a/Modules/CMakeDetermineVSServicePack.cmake b/Modules/CMakeDetermineVSServicePack.cmake index f49482e..353aed6 100644 --- a/Modules/CMakeDetermineVSServicePack.cmake +++ b/Modules/CMakeDetermineVSServicePack.cmake @@ -1,22 +1,34 @@ -# - Determine the Visual Studio service pack of the 'cl' in use. +#.rst: +# CMakeDetermineVSServicePack +# --------------------------- +# +# Determine the Visual Studio service pack of the 'cl' in use. +# # The functionality of this module has been superseded by the platform -# variable CMAKE_<LANG>_COMPILER_VERSION that contains the compiler version -# number. +# variable CMAKE_<LANG>_COMPILER_VERSION that contains the compiler +# version number. # # Usage: -# if(MSVC) -# include(CMakeDetermineVSServicePack) -# DetermineVSServicePack( my_service_pack ) -# if( my_service_pack ) -# message(STATUS "Detected: ${my_service_pack}") -# endif() -# endif() +# +# :: +# +# if(MSVC) +# include(CMakeDetermineVSServicePack) +# DetermineVSServicePack( my_service_pack ) +# if( my_service_pack ) +# message(STATUS "Detected: ${my_service_pack}") +# endif() +# endif() +# # Function DetermineVSServicePack sets the given variable to one of the # following values or an empty string if unknown: -# vc80, vc80sp1 -# vc90, vc90sp1 -# vc100, vc100sp1 -# vc110, vc110sp1, vc110sp2 +# +# :: +# +# vc80, vc80sp1 +# vc90, vc90sp1 +# vc100, vc100sp1 +# vc110, vc110sp1, vc110sp2 #============================================================================= # Copyright 2009-2013 Kitware, Inc. diff --git a/Modules/CMakeExpandImportedTargets.cmake b/Modules/CMakeExpandImportedTargets.cmake index f5c009c..47ac316 100644 --- a/Modules/CMakeExpandImportedTargets.cmake +++ b/Modules/CMakeExpandImportedTargets.cmake @@ -1,19 +1,32 @@ +#.rst: +# CMakeExpandImportedTargets +# -------------------------- +# +# +# # CMAKE_EXPAND_IMPORTED_TARGETS(<var> LIBRARIES lib1 lib2...libN -# [CONFIGURATION <config>] ) +# +# :: +# +# [CONFIGURATION <config>] ) +# +# # # CMAKE_EXPAND_IMPORTED_TARGETS() takes a list of libraries and replaces -# all imported targets contained in this list with their actual file paths -# of the referenced libraries on disk, including the libraries from their -# link interfaces. -# If a CONFIGURATION is given, it uses the respective configuration of the -# imported targets if it exists. If no CONFIGURATION is given, it uses -# the first configuration from ${CMAKE_CONFIGURATION_TYPES} if set, otherwise -# ${CMAKE_BUILD_TYPE}. -# This macro is used by all Check*.cmake files which use -# try_compile() or try_run() and support CMAKE_REQUIRED_LIBRARIES , so that -# these checks support imported targets in CMAKE_REQUIRED_LIBRARIES: -# cmake_expand_imported_targets(expandedLibs LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} -# CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" ) +# all imported targets contained in this list with their actual file +# paths of the referenced libraries on disk, including the libraries +# from their link interfaces. If a CONFIGURATION is given, it uses the +# respective configuration of the imported targets if it exists. If no +# CONFIGURATION is given, it uses the first configuration from +# ${CMAKE_CONFIGURATION_TYPES} if set, otherwise ${CMAKE_BUILD_TYPE}. +# This macro is used by all Check*.cmake files which use try_compile() +# or try_run() and support CMAKE_REQUIRED_LIBRARIES , so that these +# checks support imported targets in CMAKE_REQUIRED_LIBRARIES: +# +# :: +# +# cmake_expand_imported_targets(expandedLibs LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} +# CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" ) #============================================================================= diff --git a/Modules/CMakeFindBinUtils.cmake b/Modules/CMakeFindBinUtils.cmake index e70c013..b4e2ae5 100644 --- a/Modules/CMakeFindBinUtils.cmake +++ b/Modules/CMakeFindBinUtils.cmake @@ -30,8 +30,10 @@ # License text for the above reference.) # if it's the MS C/CXX compiler, search for link -if("${CMAKE_CXX_COMPILER_ID}" MATCHES "MSVC" - OR "${CMAKE_C_COMPILER_ID}" MATCHES "MSVC" +if("${CMAKE_C_SIMULATE_ID}" STREQUAL "MSVC" + OR "${CMAKE_CXX_SIMULATE_ID}" STREQUAL "MSVC" + OR "${CMAKE_C_COMPILER_ID}" STREQUAL "MSVC" + OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "MSVC" OR "${CMAKE_GENERATOR}" MATCHES "Visual Studio") find_program(CMAKE_LINKER NAMES link HINTS ${_CMAKE_TOOLCHAIN_LOCATION}) diff --git a/Modules/CMakeFindFrameworks.cmake b/Modules/CMakeFindFrameworks.cmake index 7fdeb84..6a8bcd4 100644 --- a/Modules/CMakeFindFrameworks.cmake +++ b/Modules/CMakeFindFrameworks.cmake @@ -1,4 +1,8 @@ -# - helper module to find OSX frameworks +#.rst: +# CMakeFindFrameworks +# ------------------- +# +# helper module to find OSX frameworks #============================================================================= # Copyright 2003-2009 Kitware, Inc. diff --git a/Modules/CMakeFindPackageMode.cmake b/Modules/CMakeFindPackageMode.cmake index e5216f4..9f97ee5 100644 --- a/Modules/CMakeFindPackageMode.cmake +++ b/Modules/CMakeFindPackageMode.cmake @@ -1,12 +1,21 @@ -# This file is executed by cmake when invoked with --find-package. -# It expects that the following variables are set using -D: -# NAME = name of the package -# COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc. -# LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM -# MODE = EXIST : only check for existence of the given package -# COMPILE : print the flags needed for compiling an object file which uses the given package -# LINK : print the flags needed for linking when using the given package -# QUIET = if TRUE, don't print anything +#.rst: +# CMakeFindPackageMode +# -------------------- +# +# +# +# This file is executed by cmake when invoked with --find-package. It +# expects that the following variables are set using -D: +# +# :: +# +# NAME = name of the package +# COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc. +# LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM +# MODE = EXIST : only check for existence of the given package +# COMPILE : print the flags needed for compiling an object file which uses the given package +# LINK : print the flags needed for linking when using the given package +# QUIET = if TRUE, don't print anything #============================================================================= # Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org> diff --git a/Modules/CMakeForceCompiler.cmake b/Modules/CMakeForceCompiler.cmake index 207c8ad..0e6b5af 100644 --- a/Modules/CMakeForceCompiler.cmake +++ b/Modules/CMakeForceCompiler.cmake @@ -1,33 +1,54 @@ +#.rst: +# CMakeForceCompiler +# ------------------ +# +# +# # This module defines macros intended for use by cross-compiling # toolchain files when CMake is not able to automatically detect the # compiler identification. # # Macro CMAKE_FORCE_C_COMPILER has the following signature: -# CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>) -# It sets CMAKE_C_COMPILER to the given compiler and the cmake -# internal variable CMAKE_C_COMPILER_ID to the given compiler-id. -# It also bypasses the check for working compiler and basic compiler -# information tests. +# +# :: +# +# CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>) +# +# It sets CMAKE_C_COMPILER to the given compiler and the cmake internal +# variable CMAKE_C_COMPILER_ID to the given compiler-id. It also +# bypasses the check for working compiler and basic compiler information +# tests. # # Macro CMAKE_FORCE_CXX_COMPILER has the following signature: -# CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>) +# +# :: +# +# CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>) +# # It sets CMAKE_CXX_COMPILER to the given compiler and the cmake -# internal variable CMAKE_CXX_COMPILER_ID to the given compiler-id. -# It also bypasses the check for working compiler and basic compiler +# internal variable CMAKE_CXX_COMPILER_ID to the given compiler-id. It +# also bypasses the check for working compiler and basic compiler # information tests. # # Macro CMAKE_FORCE_Fortran_COMPILER has the following signature: -# CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>) +# +# :: +# +# CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>) +# # It sets CMAKE_Fortran_COMPILER to the given compiler and the cmake # internal variable CMAKE_Fortran_COMPILER_ID to the given compiler-id. # It also bypasses the check for working compiler and basic compiler # information tests. # # So a simple toolchain file could look like this: -# include (CMakeForceCompiler) -# set(CMAKE_SYSTEM_NAME Generic) -# CMAKE_FORCE_C_COMPILER (chc12 MetrowerksHicross) -# CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross) +# +# :: +# +# include (CMakeForceCompiler) +# set(CMAKE_SYSTEM_NAME Generic) +# CMAKE_FORCE_C_COMPILER (chc12 MetrowerksHicross) +# CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross) #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake index 2f04abb..f2b8e59 100644 --- a/Modules/CMakeGraphVizOptions.cmake +++ b/Modules/CMakeGraphVizOptions.cmake @@ -1,72 +1,98 @@ -##section Variables specific to the graphviz support -##end -##module -# - The builtin graphviz support of CMake. -# CMake can generate graphviz files, showing the dependencies between -# the targets in a project and also external libraries which are linked -# against. -# When CMake is run with the --graphiz=foo option, it will produce -# * a foo.dot file showing all dependencies in the project -# * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends -# * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target -# -# This can result in huge graphs. Using the file CMakeGraphVizOptions.cmake -# the look and content of the generated graphs can be influenced. -# This file is searched first in ${CMAKE_BINARY_DIR} and then in -# ${CMAKE_SOURCE_DIR}. If found, it is read and the variables set in it -# are used to adjust options for the generated graphviz files. -##end -# -##variable -# GRAPHVIZ_GRAPH_TYPE - The graph type -# Mandatory : NO -# Default : "digraph" -##end -##variable -# GRAPHVIZ_GRAPH_NAME - The graph name. -# Mandatory : NO -# Default : "GG" -##end -##variable -# GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file. -# Mandatory : NO -# Default : "node [n fontsize = "12"];" -##end -##variable -# GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file. -# Mandatory : NO -# Default : "node" -##end -##variable -# GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude module libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs. -# Mandatory : NO -# Default : TRUE -##end -##variable -# GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets. -# Mandatory : NO -# Default : empty -##end +#.rst: +# CMakeGraphVizOptions +# -------------------- +# +# The builtin graphviz support of CMake. +# +# Variables specific to the graphviz support +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# CMake +# can generate graphviz files, showing the dependencies between the +# targets in a project and also external libraries which are linked +# against. When CMake is run with the --graphiz=foo option, it will +# produce +# +# * a foo.dot file showing all dependencies in the project +# * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends +# * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target +# +# This can result in huge graphs. Using the file +# CMakeGraphVizOptions.cmake the look and content of the generated +# graphs can be influenced. This file is searched first in +# ${CMAKE_BINARY_DIR} and then in ${CMAKE_SOURCE_DIR}. If found, it is +# read and the variables set in it are used to adjust options for the +# generated graphviz files. +# +# .. variable:: GRAPHVIZ_GRAPH_TYPE +# +# The graph type +# +# * Mandatory : NO +# * Default : "digraph" +# +# .. variable:: GRAPHVIZ_GRAPH_NAME +# +# The graph name. +# +# * Mandatory : NO +# * Default : "GG" +# +# .. variable:: GRAPHVIZ_GRAPH_HEADER +# +# The header written at the top of the graphviz file. +# +# * Mandatory : NO +# * Default : "node [n fontsize = "12"];" +# +# .. variable:: GRAPHVIZ_NODE_PREFIX +# +# The prefix for each node in the graphviz file. +# +# * Mandatory : NO +# * Default : "node" +# +# .. variable:: GRAPHVIZ_EXECUTABLES +# +# Set this to FALSE to exclude executables from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_STATIC_LIBS +# +# Set this to FALSE to exclude static libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_SHARED_LIBS +# +# Set this to FALSE to exclude shared libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_MODULE_LIBS +# +# Set this to FALSE to exclude module libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_EXTERNAL_LIBS +# +# Set this to FALSE to exclude external libraries from the generated graphs. +# +# * Mandatory : NO +# * Default : TRUE +# +# .. variable:: GRAPHVIZ_IGNORE_TARGETS +# +# A list of regular expressions for ignoring targets. +# +# * Mandatory : NO +# * Default : empty #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake index 3c56b7f..855af9c 100644 --- a/Modules/CMakePackageConfigHelpers.cmake +++ b/Modules/CMakePackageConfigHelpers.cmake @@ -1,135 +1,183 @@ -# - CONFIGURE_PACKAGE_CONFIG_FILE(), WRITE_BASIC_PACKAGE_VERSION_FILE() +#.rst: +# CMakePackageConfigHelpers +# ------------------------- +# +# CONFIGURE_PACKAGE_CONFIG_FILE(), WRITE_BASIC_PACKAGE_VERSION_FILE() +# +# +# +# :: +# +# CONFIGURE_PACKAGE_CONFIG_FILE(<input> <output> INSTALL_DESTINATION <path> +# [PATH_VARS <var1> <var2> ... <varN>] +# [NO_SET_AND_CHECK_MACRO] +# [NO_CHECK_REQUIRED_COMPONENTS_MACRO] +# [NO_FIND_DEPENDENCY_MACRO]) +# # -# CONFIGURE_PACKAGE_CONFIG_FILE(<input> <output> INSTALL_DESTINATION <path> -# [PATH_VARS <var1> <var2> ... <varN>] -# [NO_SET_AND_CHECK_MACRO] -# [NO_CHECK_REQUIRED_COMPONENTS_MACRO] -# [NO_FIND_DEPENDENCY_MACRO]) # # CONFIGURE_PACKAGE_CONFIG_FILE() should be used instead of the plain -# configure_file() command when creating the <Name>Config.cmake or <Name>-config.cmake -# file for installing a project or library. It helps making the resulting package -# relocatable by avoiding hardcoded paths in the installed Config.cmake file. +# configure_file() command when creating the <Name>Config.cmake or +# <Name>-config.cmake file for installing a project or library. It +# helps making the resulting package relocatable by avoiding hardcoded +# paths in the installed Config.cmake file. # # In a FooConfig.cmake file there may be code like this to make the # install destinations know to the using project: -# set(FOO_INCLUDE_DIR "@CMAKE_INSTALL_FULL_INCLUDEDIR@" ) -# set(FOO_DATA_DIR "@CMAKE_INSTALL_PREFIX@/@RELATIVE_DATA_INSTALL_DIR@" ) -# set(FOO_ICONS_DIR "@CMAKE_INSTALL_PREFIX@/share/icons" ) -# ...logic to determine installedPrefix from the own location... -# set(FOO_CONFIG_DIR "${installedPrefix}/@CONFIG_INSTALL_DIR@" ) -# All 4 options shown above are not sufficient, since the first 3 hardcode -# the absolute directory locations, and the 4th case works only if the logic -# to determine the installedPrefix is correct, and if CONFIG_INSTALL_DIR contains -# a relative path, which in general cannot be guaranteed. -# This has the effect that the resulting FooConfig.cmake file would work poorly -# under Windows and OSX, where users are used to choose the install location -# of a binary package at install time, independent from how CMAKE_INSTALL_PREFIX -# was set at build/cmake time. -# -# Using CONFIGURE_PACKAGE_CONFIG_FILE() helps. If used correctly, it makes the -# resulting FooConfig.cmake file relocatable. -# Usage: -# 1. write a FooConfig.cmake.in file as you are used to -# 2. insert a line containing only the string "@PACKAGE_INIT@" -# 3. instead of set(FOO_DIR "@SOME_INSTALL_DIR@"), use set(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@") -# (this must be after the @PACKAGE_INIT@ line) -# 4. instead of using the normal configure_file(), use CONFIGURE_PACKAGE_CONFIG_FILE() -# -# The <input> and <output> arguments are the input and output file, the same way -# as in configure_file(). -# -# The <path> given to INSTALL_DESTINATION must be the destination where the FooConfig.cmake -# file will be installed to. This can either be a relative or absolute path, both work. -# -# The variables <var1> to <varN> given as PATH_VARS are the variables which contain -# install destinations. For each of them the macro will create a helper variable -# PACKAGE_<var...>. These helper variables must be used -# in the FooConfig.cmake.in file for setting the installed location. They are calculated -# by CONFIGURE_PACKAGE_CONFIG_FILE() so that they are always relative to the -# installed location of the package. This works both for relative and also for absolute locations. -# For absolute locations it works only if the absolute location is a subdirectory -# of CMAKE_INSTALL_PREFIX. -# -# By default configure_package_config_file() also generates two helper macros, -# set_and_check() and check_required_components() into the FooConfig.cmake file. -# -# set_and_check() should be used instead of the normal set() -# command for setting directories and file locations. Additionally to setting the -# variable it also checks that the referenced file or directory actually exists -# and fails with a FATAL_ERROR otherwise. This makes sure that the created -# FooConfig.cmake file does not contain wrong references. -# When using the NO_SET_AND_CHECK_MACRO, this macro is not generated into the +# +# :: +# +# set(FOO_INCLUDE_DIR "@CMAKE_INSTALL_FULL_INCLUDEDIR@" ) +# set(FOO_DATA_DIR "@CMAKE_INSTALL_PREFIX@/@RELATIVE_DATA_INSTALL_DIR@" ) +# set(FOO_ICONS_DIR "@CMAKE_INSTALL_PREFIX@/share/icons" ) +# ...logic to determine installedPrefix from the own location... +# set(FOO_CONFIG_DIR "${installedPrefix}/@CONFIG_INSTALL_DIR@" ) +# +# All 4 options shown above are not sufficient, since the first 3 +# hardcode the absolute directory locations, and the 4th case works only +# if the logic to determine the installedPrefix is correct, and if +# CONFIG_INSTALL_DIR contains a relative path, which in general cannot +# be guaranteed. This has the effect that the resulting FooConfig.cmake +# file would work poorly under Windows and OSX, where users are used to +# choose the install location of a binary package at install time, +# independent from how CMAKE_INSTALL_PREFIX was set at build/cmake time. +# +# Using CONFIGURE_PACKAGE_CONFIG_FILE() helps. If used correctly, it +# makes the resulting FooConfig.cmake file relocatable. Usage: +# +# :: +# +# 1. write a FooConfig.cmake.in file as you are used to +# 2. insert a line containing only the string "@PACKAGE_INIT@" +# 3. instead of set(FOO_DIR "@SOME_INSTALL_DIR@"), use set(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@") +# (this must be after the @PACKAGE_INIT@ line) +# 4. instead of using the normal configure_file(), use CONFIGURE_PACKAGE_CONFIG_FILE() +# +# +# +# The <input> and <output> arguments are the input and output file, the +# same way as in configure_file(). +# +# The <path> given to INSTALL_DESTINATION must be the destination where +# the FooConfig.cmake file will be installed to. This can either be a +# relative or absolute path, both work. +# +# The variables <var1> to <varN> given as PATH_VARS are the variables +# which contain install destinations. For each of them the macro will +# create a helper variable PACKAGE_<var...>. These helper variables +# must be used in the FooConfig.cmake.in file for setting the installed +# location. They are calculated by CONFIGURE_PACKAGE_CONFIG_FILE() so +# that they are always relative to the installed location of the +# package. This works both for relative and also for absolute +# locations. For absolute locations it works only if the absolute +# location is a subdirectory of CMAKE_INSTALL_PREFIX. +# +# By default configure_package_config_file() also generates two helper +# macros, set_and_check() and check_required_components() into the # FooConfig.cmake file. # -# check_required_components(<package_name>) should be called at the end of the -# FooConfig.cmake file if the package supports components. -# This macro checks whether all requested, non-optional components have been found, -# and if this is not the case, sets the Foo_FOUND variable to FALSE, so that the package -# is considered to be not found. -# It does that by testing the Foo_<Component>_FOUND variables for all requested -# required components. -# When using the NO_CHECK_REQUIRED_COMPONENTS option, this macro is not generated +# set_and_check() should be used instead of the normal set() command for +# setting directories and file locations. Additionally to setting the +# variable it also checks that the referenced file or directory actually +# exists and fails with a FATAL_ERROR otherwise. This makes sure that +# the created FooConfig.cmake file does not contain wrong references. +# When using the NO_SET_AND_CHECK_MACRO, this macro is not generated # into the FooConfig.cmake file. # -# For an example see below the documentation for WRITE_BASIC_PACKAGE_VERSION_FILE(). -# -# -# WRITE_BASIC_PACKAGE_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion|ExactVersion) ) -# -# Writes a file for use as <package>ConfigVersion.cmake file to <filename>. -# See the documentation of find_package() for details on this. -# filename is the output filename, it should be in the build tree. -# major.minor.patch is the version number of the project to be installed -# The COMPATIBILITY mode AnyNewerVersion means that the installed package version -# will be considered compatible if it is newer or exactly the same as the requested version. -# This mode should be used for packages which are fully backward compatible, -# also across major versions. -# If SameMajorVersion is used instead, then the behaviour differs from AnyNewerVersion -# in that the major version number must be the same as requested, e.g. version 2.0 will -# not be considered compatible if 1.0 is requested. -# This mode should be used for packages which guarantee backward compatibility within the -# same major version. -# If ExactVersion is used, then the package is only considered compatible if the requested -# version matches exactly its own version number (not considering the tweak version). -# For example, version 1.2.3 of a package is only considered compatible to requested version 1.2.3. -# This mode is for packages without compatibility guarantees. -# If your project has more elaborated version matching rules, you will need to write your -# own custom ConfigVersion.cmake file instead of using this macro. -# -# Internally, this macro executes configure_file() to create the resulting -# version file. Depending on the COMPATIBLITY, either the file -# BasicConfigVersion-SameMajorVersion.cmake.in or BasicConfigVersion-AnyNewerVersion.cmake.in -# is used. Please note that these two files are internal to CMake and you should -# not call configure_file() on them yourself, but they can be used as starting +# check_required_components(<package_name>) should be called at the end +# of the FooConfig.cmake file if the package supports components. This +# macro checks whether all requested, non-optional components have been +# found, and if this is not the case, sets the Foo_FOUND variable to +# FALSE, so that the package is considered to be not found. It does +# that by testing the Foo_<Component>_FOUND variables for all requested +# required components. When using the NO_CHECK_REQUIRED_COMPONENTS +# option, this macro is not generated into the FooConfig.cmake file. +# +# For an example see below the documentation for +# WRITE_BASIC_PACKAGE_VERSION_FILE(). +# +# +# +# :: +# +# WRITE_BASIC_PACKAGE_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion|ExactVersion) ) +# +# +# +# Writes a file for use as <package>ConfigVersion.cmake file to +# <filename>. See the documentation of find_package() for details on +# this. +# +# :: +# +# filename is the output filename, it should be in the build tree. +# major.minor.patch is the version number of the project to be installed +# +# The COMPATIBILITY mode AnyNewerVersion means that the installed +# package version will be considered compatible if it is newer or +# exactly the same as the requested version. This mode should be used +# for packages which are fully backward compatible, also across major +# versions. If SameMajorVersion is used instead, then the behaviour +# differs from AnyNewerVersion in that the major version number must be +# the same as requested, e.g. version 2.0 will not be considered +# compatible if 1.0 is requested. This mode should be used for packages +# which guarantee backward compatibility within the same major version. +# If ExactVersion is used, then the package is only considered +# compatible if the requested version matches exactly its own version +# number (not considering the tweak version). For example, version +# 1.2.3 of a package is only considered compatible to requested version +# 1.2.3. This mode is for packages without compatibility guarantees. +# If your project has more elaborated version matching rules, you will +# need to write your own custom ConfigVersion.cmake file instead of +# using this macro. +# +# Internally, this macro executes configure_file() to create the +# resulting version file. Depending on the COMPATIBLITY, either the +# file BasicConfigVersion-SameMajorVersion.cmake.in or +# BasicConfigVersion-AnyNewerVersion.cmake.in is used. Please note that +# these two files are internal to CMake and you should not call +# configure_file() on them yourself, but they can be used as starting # point to create more sophisticted custom ConfigVersion.cmake files. # # -# Example using both configure_package_config_file() and write_basic_package_version_file(): -# CMakeLists.txt: -# set(INCLUDE_INSTALL_DIR include/ ... CACHE ) -# set(LIB_INSTALL_DIR lib/ ... CACHE ) -# set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) -# ... -# include(CMakePackageConfigHelpers) -# configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake -# INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake -# PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR) -# write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake -# VERSION 1.2.3 -# COMPATIBILITY SameMajorVersion ) -# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake -# DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake ) +# +# Example using both configure_package_config_file() and +# write_basic_package_version_file(): CMakeLists.txt: +# +# :: +# +# set(INCLUDE_INSTALL_DIR include/ ... CACHE ) +# set(LIB_INSTALL_DIR lib/ ... CACHE ) +# set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) +# ... +# include(CMakePackageConfigHelpers) +# configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake +# INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake +# PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR) +# write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake +# VERSION 1.2.3 +# COMPATIBILITY SameMajorVersion ) +# install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake +# DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake ) +# +# # # With a FooConfig.cmake.in: -# set(FOO_VERSION x.y.z) -# ... -# @PACKAGE_INIT@ -# ... -# set_and_check(FOO_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@") -# set_and_check(FOO_SYSCONFIG_DIR "@PACKAGE_SYSCONFIG_INSTALL_DIR@") -# -# check_required_components(Foo) +# +# :: +# +# set(FOO_VERSION x.y.z) +# ... +# @PACKAGE_INIT@ +# ... +# set_and_check(FOO_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@") +# set_and_check(FOO_SYSCONFIG_DIR "@PACKAGE_SYSCONFIG_INSTALL_DIR@") +# +# +# +# :: +# +# check_required_components(Foo) #============================================================================= diff --git a/Modules/CMakeParseArguments.cmake b/Modules/CMakeParseArguments.cmake index 016da0c..4248176 100644 --- a/Modules/CMakeParseArguments.cmake +++ b/Modules/CMakeParseArguments.cmake @@ -1,64 +1,86 @@ -# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...) +#.rst: +# CMakeParseArguments +# ------------------- # -# CMAKE_PARSE_ARGUMENTS() is intended to be used in macros or functions for -# parsing the arguments given to that macro or function. -# It processes the arguments and defines a set of variables which hold the +# +# +# CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> +# <multi_value_keywords> args...) +# +# CMAKE_PARSE_ARGUMENTS() is intended to be used in macros or functions +# for parsing the arguments given to that macro or function. It +# processes the arguments and defines a set of variables which hold the # values of the respective options. # # The <options> argument contains all options for the respective macro, -# i.e. keywords which can be used when calling the macro without any value -# following, like e.g. the OPTIONAL keyword of the install() command. +# i.e. keywords which can be used when calling the macro without any +# value following, like e.g. the OPTIONAL keyword of the install() +# command. # # The <one_value_keywords> argument contains all keywords for this macro -# which are followed by one value, like e.g. DESTINATION keyword of the +# which are followed by one value, like e.g. DESTINATION keyword of the # install() command. # -# The <multi_value_keywords> argument contains all keywords for this macro -# which can be followed by more than one value, like e.g. the TARGETS or -# FILES keywords of the install() command. +# The <multi_value_keywords> argument contains all keywords for this +# macro which can be followed by more than one value, like e.g. the +# TARGETS or FILES keywords of the install() command. # # When done, CMAKE_PARSE_ARGUMENTS() will have defined for each of the # keywords listed in <options>, <one_value_keywords> and # <multi_value_keywords> a variable composed of the given <prefix> -# followed by "_" and the name of the respective keyword. -# These variables will then hold the respective value from the argument list. +# followed by "_" and the name of the respective keyword. These +# variables will then hold the respective value from the argument list. # For the <options> keywords this will be TRUE or FALSE. # # All remaining arguments are collected in a variable -# <prefix>_UNPARSED_ARGUMENTS, this can be checked afterwards to see whether -# your macro was called with unrecognized parameters. +# <prefix>_UNPARSED_ARGUMENTS, this can be checked afterwards to see +# whether your macro was called with unrecognized parameters. +# +# As an example here a my_install() macro, which takes similar arguments +# as the real install() command: +# +# :: +# +# function(MY_INSTALL) +# set(options OPTIONAL FAST) +# set(oneValueArgs DESTINATION RENAME) +# set(multiValueArgs TARGETS CONFIGURATIONS) +# cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) +# ... # -# As an example here a my_install() macro, which takes similar arguments as the -# real install() command: # -# function(MY_INSTALL) -# set(options OPTIONAL FAST) -# set(oneValueArgs DESTINATION RENAME) -# set(multiValueArgs TARGETS CONFIGURATIONS) -# cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) -# ... # # Assume my_install() has been called like this: -# my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub) -# -# After the cmake_parse_arguments() call the macro will have set the following -# variables: -# MY_INSTALL_OPTIONAL = TRUE -# MY_INSTALL_FAST = FALSE (this option was not used when calling my_install() -# MY_INSTALL_DESTINATION = "bin" -# MY_INSTALL_RENAME = "" (was not used) -# MY_INSTALL_TARGETS = "foo;bar" -# MY_INSTALL_CONFIGURATIONS = "" (was not used) -# MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL" +# +# :: +# +# my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub) +# +# +# +# After the cmake_parse_arguments() call the macro will have set the +# following variables: +# +# :: +# +# MY_INSTALL_OPTIONAL = TRUE +# MY_INSTALL_FAST = FALSE (this option was not used when calling my_install() +# MY_INSTALL_DESTINATION = "bin" +# MY_INSTALL_RENAME = "" (was not used) +# MY_INSTALL_TARGETS = "foo;bar" +# MY_INSTALL_CONFIGURATIONS = "" (was not used) +# MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL" +# +# # # You can then continue and process these variables. # -# Keywords terminate lists of values, e.g. if directly after a one_value_keyword -# another recognized keyword follows, this is interpreted as the beginning of -# the new option. -# E.g. my_install(TARGETS foo DESTINATION OPTIONAL) would result in -# MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION would -# be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefor. +# Keywords terminate lists of values, e.g. if directly after a +# one_value_keyword another recognized keyword follows, this is +# interpreted as the beginning of the new option. E.g. +# my_install(TARGETS foo DESTINATION OPTIONAL) would result in +# MY_INSTALL_DESTINATION set to "OPTIONAL", but MY_INSTALL_DESTINATION +# would be empty and MY_INSTALL_OPTIONAL would be set to TRUE therefor. #============================================================================= # Copyright 2010 Alexander Neundorf <neundorf@kde.org> diff --git a/Modules/CMakePlatformId.h.in b/Modules/CMakePlatformId.h.in index 69171c2..1e41fec 100644 --- a/Modules/CMakePlatformId.h.in +++ b/Modules/CMakePlatformId.h.in @@ -151,6 +151,24 @@ char const info_version[] = { ']','\0'}; #endif +/* Construct a string literal encoding the version number components. */ +#ifdef SIMULATE_VERSION_MAJOR +char const info_simulate_version[] = { + 'I', 'N', 'F', 'O', ':', + 's','i','m','u','l','a','t','e','_','v','e','r','s','i','o','n','[', + SIMULATE_VERSION_MAJOR, +# ifdef SIMULATE_VERSION_MINOR + '.', SIMULATE_VERSION_MINOR, +# ifdef SIMULATE_VERSION_PATCH + '.', SIMULATE_VERSION_PATCH, +# ifdef SIMULATE_VERSION_TWEAK + '.', SIMULATE_VERSION_TWEAK, +# endif +# endif +# endif + ']','\0'}; +#endif + /* Construct the string literal in pieces to prevent the source from getting matched. Store it in a pointer rather than an array because some compilers will just produce instructions to fill the diff --git a/Modules/CMakePrintHelpers.cmake b/Modules/CMakePrintHelpers.cmake index ef5d857..72832ad 100644 --- a/Modules/CMakePrintHelpers.cmake +++ b/Modules/CMakePrintHelpers.cmake @@ -1,29 +1,52 @@ -# - Convenience macros for printing properties and variables, useful e.g. for debugging. +#.rst: +# CMakePrintHelpers +# ----------------- +# +# Convenience macros for printing properties and variables, useful e.g. for debugging. +# +# +# +# +# +# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN] +# +# :: +# +# [SOURCES source1 .. sourceN] +# [DIRECTORIES dir1 .. dirN] +# [TESTS test1 .. testN] +# [CACHE_ENTRIES entry1 .. entryN] +# PROPERTIES prop1 .. propN ) # # -# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN] -# [SOURCES source1 .. sourceN] -# [DIRECTORIES dir1 .. dirN] -# [TESTS test1 .. testN] -# [CACHE_ENTRIES entry1 .. entryN] -# PROPERTIES prop1 .. propN ) # # This macro prints the values of the properties of the given targets, -# source files, directories, tests or cache entries. Exactly one of the -# scope keywords must be used. -# Example: -# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS) -# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for both -# targets foo and bar. +# source files, directories, tests or cache entries. Exactly one of the +# scope keywords must be used. Example: # +# :: # -# CMAKE_PRINT_VARIABLES(var1 var2 .. varN) +# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS) +# +# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for +# both targets foo and bar. +# +# +# +# CMAKE_PRINT_VARIABLES(var1 var2 .. varN) # # This macro will print the name of each variable followed by its value. # Example: -# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST) +# +# :: +# +# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST) +# # Gives: -# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" +# +# :: +# +# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" #============================================================================= # Copyright 2013 Alexander Neundorf, <neundorf@kde.org> diff --git a/Modules/CMakePrintSystemInformation.cmake b/Modules/CMakePrintSystemInformation.cmake index e0c7334..355c47d 100644 --- a/Modules/CMakePrintSystemInformation.cmake +++ b/Modules/CMakePrintSystemInformation.cmake @@ -1,7 +1,11 @@ -# - print system information -# This file can be used for diagnostic purposes -# just include it in a project to see various internal CMake -# variables. +#.rst: +# CMakePrintSystemInformation +# --------------------------- +# +# print system information +# +# This file can be used for diagnostic purposes just include it in a +# project to see various internal CMake variables. #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CMakePushCheckState.cmake b/Modules/CMakePushCheckState.cmake index b37b706..39f0023 100644 --- a/Modules/CMakePushCheckState.cmake +++ b/Modules/CMakePushCheckState.cmake @@ -1,30 +1,37 @@ -# This module defines three macros: -# CMAKE_PUSH_CHECK_STATE() -# CMAKE_POP_CHECK_STATE() -# and -# CMAKE_RESET_CHECK_STATE() -# These macros can be used to save, restore and reset (i.e., clear contents) -# the state of the variables -# CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_DEFINITIONS, CMAKE_REQUIRED_LIBRARIES -# and CMAKE_REQUIRED_INCLUDES used by the various Check-files coming with CMake, -# like e.g. check_function_exists() etc. -# The variable contents are pushed on a stack, pushing multiple times is supported. -# This is useful e.g. when executing such tests in a Find-module, where they have to be set, -# but after the Find-module has been executed they should have the same value -# as they had before. +#.rst: +# CMakePushCheckState +# ------------------- # -# CMAKE_PUSH_CHECK_STATE() macro receives optional argument RESET. Whether it's specified, -# CMAKE_PUSH_CHECK_STATE() will set all CMAKE_REQUIRED_* variables to empty values, same -# as CMAKE_RESET_CHECK_STATE() call will do. +# +# +# This module defines three macros: CMAKE_PUSH_CHECK_STATE() +# CMAKE_POP_CHECK_STATE() and CMAKE_RESET_CHECK_STATE() These macros can +# be used to save, restore and reset (i.e., clear contents) the state of +# the variables CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_DEFINITIONS, +# CMAKE_REQUIRED_LIBRARIES and CMAKE_REQUIRED_INCLUDES used by the +# various Check-files coming with CMake, like e.g. +# check_function_exists() etc. The variable contents are pushed on a +# stack, pushing multiple times is supported. This is useful e.g. when +# executing such tests in a Find-module, where they have to be set, but +# after the Find-module has been executed they should have the same +# value as they had before. +# +# CMAKE_PUSH_CHECK_STATE() macro receives optional argument RESET. +# Whether it's specified, CMAKE_PUSH_CHECK_STATE() will set all +# CMAKE_REQUIRED_* variables to empty values, same as +# CMAKE_RESET_CHECK_STATE() call will do. # # Usage: -# cmake_push_check_state(RESET) -# set(CMAKE_REQUIRED_DEFINITIONS -DSOME_MORE_DEF) -# check_function_exists(...) -# cmake_reset_check_state() -# set(CMAKE_REQUIRED_DEFINITIONS -DANOTHER_DEF) -# check_function_exists(...) -# cmake_pop_check_state() +# +# :: +# +# cmake_push_check_state(RESET) +# set(CMAKE_REQUIRED_DEFINITIONS -DSOME_MORE_DEF) +# check_function_exists(...) +# cmake_reset_check_state() +# set(CMAKE_REQUIRED_DEFINITIONS -DANOTHER_DEF) +# check_function_exists(...) +# cmake_pop_check_state() #============================================================================= # Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org> diff --git a/Modules/CMakeVerifyManifest.cmake b/Modules/CMakeVerifyManifest.cmake index aebe77e..bff4e1e 100644 --- a/Modules/CMakeVerifyManifest.cmake +++ b/Modules/CMakeVerifyManifest.cmake @@ -1,14 +1,19 @@ +#.rst: +# CMakeVerifyManifest +# ------------------- +# +# +# # CMakeVerifyManifest.cmake # -# This script is used to verify that embeded manifests and -# side by side manifests for a project match. To run this -# script, cd to a directory and run the script with cmake -P. -# On the command line you can pass in versions that are OK even -# if not found in the .manifest files. For example, -# cmake -Dallow_versions=8.0.50608.0 -PCmakeVerifyManifest.cmake -# could be used to allow an embeded manifest of 8.0.50608.0 -# to be used in a project even if that version was not found -# in the .manifest file. +# This script is used to verify that embeded manifests and side by side +# manifests for a project match. To run this script, cd to a directory +# and run the script with cmake -P. On the command line you can pass in +# versions that are OK even if not found in the .manifest files. For +# example, cmake -Dallow_versions=8.0.50608.0 +# -PCmakeVerifyManifest.cmake could be used to allow an embeded manifest +# of 8.0.50608.0 to be used in a project even if that version was not +# found in the .manifest file. # This script first recursively globs *.manifest files from # the current directory. Then globs *.exe and *.dll. Each diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index b0260ab..da6b2e0 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -1,275 +1,266 @@ -##section Variables common to all CPack generators -##end -##module -# - Build binary and source package installers. -# The CPack module generates binary and source installers in a variety -# of formats using the cpack program. Inclusion of the CPack module -# adds two new targets to the resulting makefiles, package and +#.rst: +# CPack +# ----- +# +# Build binary and source package installers. +# +# Variables common to all CPack generators +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The +# CPack module generates binary and source installers in a variety of +# formats using the cpack program. Inclusion of the CPack module adds +# two new targets to the resulting makefiles, package and # package_source, which build the binary and source installers, -# respectively. The generated binary installers contain everything +# respectively. The generated binary installers contain everything # installed via CMake's INSTALL command (and the deprecated # INSTALL_FILES, INSTALL_PROGRAMS, and INSTALL_TARGETS commands). # # For certain kinds of binary installers (including the graphical # installers on Mac OS X and Windows), CPack generates installers that -# allow users to select individual application components to -# install. See CPackComponent module for that. +# allow users to select individual application components to install. +# See CPackComponent module for that. # # The CPACK_GENERATOR variable has different meanings in different -# contexts. In your CMakeLists.txt file, CPACK_GENERATOR is a -# *list of generators*: when run with no other arguments, CPack -# will iterate over that list and produce one package for each -# generator. In a CPACK_PROJECT_CONFIG_FILE, though, CPACK_GENERATOR -# is a *string naming a single generator*. If you need per-cpack- -# generator logic to control *other* cpack settings, then you need -# a CPACK_PROJECT_CONFIG_FILE. +# contexts. In your CMakeLists.txt file, CPACK_GENERATOR is a *list of +# generators*: when run with no other arguments, CPack will iterate over +# that list and produce one package for each generator. In a +# CPACK_PROJECT_CONFIG_FILE, though, CPACK_GENERATOR is a *string naming +# a single generator*. If you need per-cpack- generator logic to +# control *other* cpack settings, then you need a +# CPACK_PROJECT_CONFIG_FILE. # # The CMake source tree itself contains a CPACK_PROJECT_CONFIG_FILE. # See the top level file CMakeCPackOptions.cmake.in for an example. # -# If set, the CPACK_PROJECT_CONFIG_FILE is included automatically -# on a per-generator basis. It only need contain overrides. +# If set, the CPACK_PROJECT_CONFIG_FILE is included automatically on a +# per-generator basis. It only need contain overrides. # # Here's how it works: -# - cpack runs -# - it includes CPackConfig.cmake -# - it iterates over the generators listed in that file's -# CPACK_GENERATOR list variable (unless told to use just a -# specific one via -G on the command line...) -# -# - foreach generator, it then -# - sets CPACK_GENERATOR to the one currently being iterated -# - includes the CPACK_PROJECT_CONFIG_FILE -# - produces the package for that generator -# -# This is the key: For each generator listed in CPACK_GENERATOR -# in CPackConfig.cmake, cpack will *reset* CPACK_GENERATOR -# internally to *the one currently being used* and then include -# the CPACK_PROJECT_CONFIG_FILE. -# -# Before including this CPack module in your CMakeLists.txt file, -# there are a variety of variables that can be set to customize -# the resulting installers. The most commonly-used variables are: -##end -# -##variable -# CPACK_PACKAGE_NAME - The name of the package (or application). If -# not specified, defaults to the project name. -##end -# -##variable -# CPACK_PACKAGE_VENDOR - The name of the package vendor. (e.g., -# "Kitware"). -##end -# -##variable -# CPACK_PACKAGE_DIRECTORY - The directory in which CPack is doing its -# packaging. If it is not set then this will default (internally) to the -# build dir. This variable may be defined in CPack config file or from -# the cpack command line option "-B". If set the command line option -# override the value found in the config file. -##end -# -##variable -# CPACK_PACKAGE_VERSION_MAJOR - Package major Version -##end -# -##variable -# CPACK_PACKAGE_VERSION_MINOR - Package minor Version -##end -# -##variable -# CPACK_PACKAGE_VERSION_PATCH - Package patch Version -##end -# -##variable -# CPACK_PACKAGE_DESCRIPTION_FILE - A text file used to describe the -# project. Used, for example, the introduction screen of a -# CPack-generated Windows installer to describe the project. -##end -# -##variable -# CPACK_PACKAGE_DESCRIPTION_SUMMARY - Short description of the -# project (only a few words). -##end -# -##variable -# CPACK_PACKAGE_FILE_NAME - The name of the package file to generate, -# not including the extension. For example, cmake-2.6.1-Linux-i686. -# The default value is -# -# ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_SYSTEM_NAME}. -##end -# -##variable -# CPACK_PACKAGE_INSTALL_DIRECTORY - Installation directory on the -# target system. This may be used by some CPack generators -# like NSIS to create an installation directory e.g., "CMake 2.5" -# below the installation prefix. All installed element will be +# +# * cpack runs +# * it includes CPackConfig.cmake +# * it iterates over the generators listed in that file's +# CPACK_GENERATOR list variable (unless told to use just a +# specific one via -G on the command line...) +# * foreach generator, it then +# +# - sets CPACK_GENERATOR to the one currently being iterated +# - includes the CPACK_PROJECT_CONFIG_FILE +# - produces the package for that generator +# +# This is the key: For each generator listed in CPACK_GENERATOR in +# CPackConfig.cmake, cpack will *reset* CPACK_GENERATOR internally to +# *the one currently being used* and then include the +# CPACK_PROJECT_CONFIG_FILE. +# +# Before including this CPack module in your CMakeLists.txt file, there +# are a variety of variables that can be set to customize the resulting +# installers. The most commonly-used variables are: +# +# .. variable:: CPACK_PACKAGE_NAME +# +# The name of the package (or application). If not specified, defaults to +# the project name. +# +# .. variable:: CPACK_PACKAGE_VENDOR +# +# The name of the package vendor. (e.g., "Kitware"). +# +# .. variable:: CPACK_PACKAGE_DIRECTORY +# +# The directory in which CPack is doing its packaging. If it is not set +# then this will default (internally) to the build dir. This variable may +# be defined in CPack config file or from the cpack command line option +# "-B". If set the command line option override the value found in the +# config file. +# +# .. variable:: CPACK_PACKAGE_VERSION_MAJOR +# +# Package major Version +# +# .. variable:: CPACK_PACKAGE_VERSION_MINOR +# +# Package minor Version +# +# .. variable:: CPACK_PACKAGE_VERSION_PATCH +# +# Package patch Version +# +# .. variable:: CPACK_PACKAGE_DESCRIPTION_FILE +# +# A text file used to describe the project. Used, for example, the +# introduction screen of a CPack-generated Windows installer to describe +# the project. +# +# .. variable:: CPACK_PACKAGE_DESCRIPTION_SUMMARY +# +# Short description of the project (only a few words). +# +# .. variable:: CPACK_PACKAGE_FILE_NAME +# +# The name of the package file to generate, not including the +# extension. For example, cmake-2.6.1-Linux-i686. The default value is:: +# +# ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_SYSTEM_NAME}. +# +# .. variable:: CPACK_PACKAGE_INSTALL_DIRECTORY +# +# Installation directory on the target system. This may be used by some +# CPack generators like NSIS to create an installation directory e.g., +# "CMake 2.5" below the installation prefix. All installed element will be # put inside this directory. -##end -# -##variable -# CPACK_PACKAGE_ICON - A branding image that will be displayed inside -# the installer (used by GUI installers). -##end -# -##variable -# CPACK_PROJECT_CONFIG_FILE - CPack-time project CPack configuration -# file. This file included at cpack time, once per -# generator after CPack has set CPACK_GENERATOR to the actual generator -# being used. It allows per-generator setting of CPACK_* variables at -# cpack time. -##end -# -##variable -# CPACK_RESOURCE_FILE_LICENSE - License to be embedded in the installer. It -# will typically be displayed to the user by the produced installer -# (often with an explicit "Accept" button, for graphical installers) -# prior to installation. This license file is NOT added to installed -# file but is used by some CPack generators like NSIS. If you want -# to install a license file (may be the same as this one) -# along with your project you must add an appropriate CMake INSTALL +# +# .. variable:: CPACK_PACKAGE_ICON +# +# A branding image that will be displayed inside the installer (used by GUI +# installers). +# +# .. variable:: CPACK_PROJECT_CONFIG_FILE +# +# CPack-time project CPack configuration file. This file included at cpack +# time, once per generator after CPack has set CPACK_GENERATOR to the +# actual generator being used. It allows per-generator setting of CPACK_* +# variables at cpack time. +# +# .. variable:: CPACK_RESOURCE_FILE_LICENSE +# +# License to be embedded in the installer. It will typically be displayed +# to the user by the produced installer (often with an explicit "Accept" +# button, for graphical installers) prior to installation. This license +# file is NOT added to installed file but is used by some CPack generators +# like NSIS. If you want to install a license file (may be the same as this +# one) along with your project you must add an appropriate CMake INSTALL # command in your CMakeLists.txt. -##end -# -##variable -# CPACK_RESOURCE_FILE_README - ReadMe file to be embedded in the installer. It -# typically describes in some detail the purpose of the project -# during the installation. Not all CPack generators uses -# this file. -##end -# -##variable -# CPACK_RESOURCE_FILE_WELCOME - Welcome file to be embedded in the -# installer. It welcomes users to this installer. -# Typically used in the graphical installers on Windows and Mac OS X. -##end -# -##variable -# CPACK_MONOLITHIC_INSTALL - Disables the component-based -# installation mechanism. When set the component specification is ignored -# and all installed items are put in a single "MONOLITHIC" package. -# Some CPack generators do monolithic packaging by default and -# may be asked to do component packaging by setting -# CPACK_<GENNAME>_COMPONENT_INSTALL to 1/TRUE. -##end -# -##variable -# CPACK_GENERATOR - List of CPack generators to use. If not -# specified, CPack will create a set of options CPACK_BINARY_<GENNAME> (e.g., -# CPACK_BINARY_NSIS) allowing the user to enable/disable individual -# generators. This variable may be used on the command line -# as well as in: -# -# cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree -##end -# -##variable -# CPACK_OUTPUT_CONFIG_FILE - The name of the CPack binary configuration -# file. This file is the CPack configuration generated by the CPack module -# for binary installers. Defaults to CPackConfig.cmake. -##end -# -##variable -# CPACK_PACKAGE_EXECUTABLES - Lists each of the executables and associated -# text label to be used to create Start Menu shortcuts. For example, -# setting this to the list ccmake;CMake will -# create a shortcut named "CMake" that will execute the installed -# executable ccmake. Not all CPack generators use it (at least NSIS and -# OSXX11 do). -##end -# -##variable -# CPACK_STRIP_FILES - List of files to be stripped. Starting with -# CMake 2.6.0 CPACK_STRIP_FILES will be a boolean variable which -# enables stripping of all files (a list of files evaluates to TRUE -# in CMake, so this change is compatible). -##end +# +# .. variable:: CPACK_RESOURCE_FILE_README +# +# ReadMe file to be embedded in the installer. It typically describes in +# some detail the purpose of the project during the installation. Not all +# CPack generators uses this file. +# +# .. variable:: CPACK_RESOURCE_FILE_WELCOME +# +# Welcome file to be embedded in the installer. It welcomes users to this +# installer. Typically used in the graphical installers on Windows and Mac +# OS X. +# +# .. variable:: CPACK_MONOLITHIC_INSTALL +# +# Disables the component-based installation mechanism. When set the +# component specification is ignored and all installed items are put in a +# single "MONOLITHIC" package. Some CPack generators do monolithic +# packaging by default and may be asked to do component packaging by +# setting CPACK_<GENNAME>_COMPONENT_INSTALL to 1/TRUE. +# +# .. variable:: CPACK_GENERATOR +# +# List of CPack generators to use. If not specified, CPack will create a +# set of options CPACK_BINARY_<GENNAME> (e.g., CPACK_BINARY_NSIS) allowing +# the user to enable/disable individual generators. This variable may be +# used on the command line as well as in:: +# +# cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree +# +# .. variable:: CPACK_OUTPUT_CONFIG_FILE +# +# The name of the CPack binary configuration file. This file is the CPack +# configuration generated by the CPack module for binary +# installers. Defaults to CPackConfig.cmake. +# +# .. variable:: CPACK_PACKAGE_EXECUTABLES +# +# Lists each of the executables and associated text label to be used to +# create Start Menu shortcuts. For example, setting this to the list +# ccmake;CMake will create a shortcut named "CMake" that will execute the +# installed executable ccmake. Not all CPack generators use it (at least +# NSIS and OSXX11 do). +# +# .. variable:: CPACK_STRIP_FILES +# +# List of files to be stripped. Starting with CMake 2.6.0 CPACK_STRIP_FILES +# will be a boolean variable which enables stripping of all files (a list +# of files evaluates to TRUE in CMake, so this change is compatible). # # The following CPack variables are specific to source packages, and # will not affect binary packages: # -##variable -# CPACK_SOURCE_PACKAGE_FILE_NAME - The name of the source package. For -# example cmake-2.6.1. -##end -# -##variable -# CPACK_SOURCE_STRIP_FILES - List of files in the source tree that -# will be stripped. Starting with CMake 2.6.0 -# CPACK_SOURCE_STRIP_FILES will be a boolean variable which enables -# stripping of all files (a list of files evaluates to TRUE in CMake, -# so this change is compatible). -##end -# -##variable -# CPACK_SOURCE_GENERATOR - List of generators used for the source -# packages. As with CPACK_GENERATOR, if this is not specified then -# CPack will create a set of options (e.g., CPACK_SOURCE_ZIP) -# allowing users to select which packages will be generated. -##end -# -##variable -# CPACK_SOURCE_OUTPUT_CONFIG_FILE - The name of the CPack source -# configuration file. This file is the CPack configuration generated by the -# CPack module for source installers. Defaults to CPackSourceConfig.cmake. -##end -# -##variable -# CPACK_SOURCE_IGNORE_FILES - Pattern of files in the source tree -# that won't be packaged when building a source package. This is a -# list of regular expression patterns (that must be properly escaped), -# e.g., /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.* -##end +# .. variable:: CPACK_SOURCE_PACKAGE_FILE_NAME +# +# The name of the source package. For example cmake-2.6.1. +# +# .. variable:: CPACK_SOURCE_STRIP_FILES +# +# List of files in the source tree that will be stripped. Starting with +# CMake 2.6.0 CPACK_SOURCE_STRIP_FILES will be a boolean variable which +# enables stripping of all files (a list of files evaluates to TRUE in +# CMake, so this change is compatible). +# +# .. variable:: CPACK_SOURCE_GENERATOR +# +# List of generators used for the source packages. As with CPACK_GENERATOR, +# if this is not specified then CPack will create a set of options (e.g., +# CPACK_SOURCE_ZIP) allowing users to select which packages will be +# generated. +# +# .. variable:: CPACK_SOURCE_OUTPUT_CONFIG_FILE +# +# The name of the CPack source configuration file. This file is the CPack +# configuration generated by the CPack module for source +# installers. Defaults to CPackSourceConfig.cmake. +# +# .. variable:: CPACK_SOURCE_IGNORE_FILES +# +# Pattern of files in the source tree that won't be packaged when building +# a source package. This is a list of regular expression patterns (that +# must be properly escaped), e.g., +# /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.* # # The following variables are for advanced uses of CPack: # -##variable -# CPACK_CMAKE_GENERATOR - What CMake generator should be used if the -# project is CMake project. Defaults to the value of CMAKE_GENERATOR -# few users will want to change this setting. -##end -# -##variable -# CPACK_INSTALL_CMAKE_PROJECTS - List of four values that specify -# what project to install. The four values are: Build directory, -# Project Name, Project Component, Directory. If omitted, CPack will -# build an installer that installers everything. -##end -# -##variable -# CPACK_SYSTEM_NAME - System name, defaults to the value of -# ${CMAKE_SYSTEM_NAME}. -##end -# -##variable -# CPACK_PACKAGE_VERSION - Package full version, used internally. By -# default, this is built from CPACK_PACKAGE_VERSION_MAJOR, -# CPACK_PACKAGE_VERSION_MINOR, and CPACK_PACKAGE_VERSION_PATCH. -##end -# -##variable -# CPACK_TOPLEVEL_TAG - Directory for the installed files. -##end -# -##variable -# CPACK_INSTALL_COMMANDS - Extra commands to install components. -##end -# -##variable -# CPACK_INSTALLED_DIRECTORIES - Extra directories to install. -##end -# -##variable -# CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when -# installing this project. This is only used by installer for Windows. -# The default value is based on the installation directory. -##end -##variable -# CPACK_CREATE_DESKTOP_LINKS - List of desktop links to create. -##end +# .. variable:: CPACK_CMAKE_GENERATOR +# +# What CMake generator should be used if the project is CMake +# project. Defaults to the value of CMAKE_GENERATOR few users will want to +# change this setting. +# +# .. variable:: CPACK_INSTALL_CMAKE_PROJECTS +# +# List of four values that specify what project to install. The four values +# are: Build directory, Project Name, Project Component, Directory. If +# omitted, CPack will build an installer that installers everything. +# +# .. variable:: CPACK_SYSTEM_NAME +# +# System name, defaults to the value of ${CMAKE_SYSTEM_NAME}. +# +# .. variable:: CPACK_PACKAGE_VERSION +# +# Package full version, used internally. By default, this is built from +# CPACK_PACKAGE_VERSION_MAJOR, CPACK_PACKAGE_VERSION_MINOR, and +# CPACK_PACKAGE_VERSION_PATCH. +# +# .. variable:: CPACK_TOPLEVEL_TAG +# +# Directory for the installed files. # +# .. variable:: CPACK_INSTALL_COMMANDS +# +# Extra commands to install components. +# +# .. variable:: CPACK_INSTALLED_DIRECTORIES +# +# Extra directories to install. +# +# .. variable:: CPACK_PACKAGE_INSTALL_REGISTRY_KEY +# +# Registry key used when installing this project. This is only used by +# installer for Windows. The default value is based on the installation +# directory. +# +# .. variable:: CPACK_CREATE_DESKTOP_LINKS +# +# List of desktop links to create. #============================================================================= # Copyright 2006-2009 Kitware, Inc. @@ -407,15 +398,16 @@ macro(cpack_optional_append _list _cond _item) endif() endmacro() -##variable -# CPACK_BINARY_<GENNAME> - CPack generated options for binary generators. The -# CPack.cmake module generates (when CPACK_GENERATOR is not set) -# a set of CMake options (see CMake option command) which may then be used to -# select the CPack generator(s) to be used when launching the package target. -##end -# Provide options to choose generators -# we might check here if the required tools for the generates exist -# and set the defaults according to the results +#.rst: +# .. variable:: CPACK_BINARY_<GENNAME> +# +# CPack generated options for binary generators. The CPack.cmake module +# generates (when CPACK_GENERATOR is not set) a set of CMake options (see +# CMake option command) which may then be used to select the CPack +# generator(s) to be used when launching the package target. +# +# Provide options to choose generators we might check here if the required +# tools for the generates exist and set the defaults according to the results if(NOT CPACK_GENERATOR) if(UNIX) if(CYGWIN) diff --git a/Modules/CPackBundle.cmake b/Modules/CPackBundle.cmake index 0da51e3..d8293c0 100644 --- a/Modules/CPackBundle.cmake +++ b/Modules/CPackBundle.cmake @@ -1,36 +1,38 @@ -##section Variables specific to CPack Bundle generator -##end -##module -# - CPack Bundle generator (Mac OS X) specific options +#.rst: +# CPackBundle +# ----------- +# +# CPack Bundle generator (Mac OS X) specific options +# +# Variables specific to CPack Bundle generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # # Installers built on Mac OS X using the Bundle generator use the -# aforementioned DragNDrop (CPACK_DMG_xxx) variables, plus -# the following Bundle-specific parameters (CPACK_BUNDLE_xxx). -##end -# -##variable -# CPACK_BUNDLE_NAME - The name of the generated bundle. This -# appears in the OSX finder as the bundle name. Required. -##end -# -##variable -# CPACK_BUNDLE_PLIST - Path to an OSX plist file that will be used -# for the generated bundle. This assumes that the caller has generated -# or specified their own Info.plist file. Required. -##end -# -##variable -# CPACK_BUNDLE_ICON - Path to an OSX icon file that will be used as -# the icon for the generated bundle. This is the icon that appears in the -# OSX finder for the bundle, and in the OSX dock when the bundle is opened. -# Required. -##end -# -##variable -# CPACK_BUNDLE_STARTUP_COMMAND - Path to a startup script. This is a path to -# an executable or script that will be run whenever an end-user double-clicks -# the generated bundle in the OSX Finder. Optional. -##end +# aforementioned DragNDrop (CPACK_DMG_xxx) variables, plus the following +# Bundle-specific parameters (CPACK_BUNDLE_xxx). +# +# .. variable:: CPACK_BUNDLE_NAME +# +# The name of the generated bundle. This appears in the OSX finder as the +# bundle name. Required. +# +# .. variable:: CPACK_BUNDLE_PLIST +# +# Path to an OSX plist file that will be used for the generated bundle. This +# assumes that the caller has generated or specified their own Info.plist +# file. Required. +# +# .. variable:: CPACK_BUNDLE_ICON +# +# Path to an OSX icon file that will be used as the icon for the generated +# bundle. This is the icon that appears in the OSX finder for the bundle, and +# in the OSX dock when the bundle is opened. Required. +# +# .. variable:: CPACK_BUNDLE_STARTUP_COMMAND +# +# Path to a startup script. This is a path to an executable or script that +# will be run whenever an end-user double-clicks the generated bundle in the +# OSX Finder. Optional. #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake index c85cfb4..a55a01e 100644 --- a/Modules/CPackComponent.cmake +++ b/Modules/CPackComponent.cmake @@ -1,265 +1,288 @@ -##section Variables concerning CPack Components -##end -##module -# - Build binary and source package installers +#.rst: +# CPackComponent +# -------------- # -# The CPackComponent module is the module which handles -# the component part of CPack. See CPack module for -# general information about CPack. +# Build binary and source package installers +# +# Variables concerning CPack Components +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The CPackComponent module is the module which handles the component +# part of CPack. See CPack module for general information about CPack. # # For certain kinds of binary installers (including the graphical # installers on Mac OS X and Windows), CPack generates installers that -# allow users to select individual application components to -# install. The contents of each of the components are identified by -# the COMPONENT argument of CMake's INSTALL command. These components -# can be annotated with user-friendly names and descriptions, -# inter-component dependencies, etc., and grouped in various ways to -# customize the resulting installer. See the cpack_add_* commands, -# described below, for more information about component-specific -# installations. +# allow users to select individual application components to install. +# The contents of each of the components are identified by the COMPONENT +# argument of CMake's INSTALL command. These components can be +# annotated with user-friendly names and descriptions, inter-component +# dependencies, etc., and grouped in various ways to customize the +# resulting installer. See the cpack_add_* commands, described below, +# for more information about component-specific installations. # # Component-specific installation allows users to select specific sets -# of components to install during the install process. Installation -# components are identified by the COMPONENT argument of CMake's -# INSTALL commands, and should be further described by the following -# CPack commands: -##end -# -##variable -# CPACK_COMPONENTS_ALL - The list of component to install. -# -#The default value of this variable is computed by CPack -#and contains all components defined by the project. The -#user may set it to only include the specified components. -##end -# -##variable -# CPACK_<GENNAME>_COMPONENT_INSTALL - Enable/Disable component install for -# CPack generator <GENNAME>. -# -#Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy -#default behavior. e.g. RPM builds monolithic whereas NSIS builds component. -#One can change the default behavior by setting this variable to 0/1 or OFF/ON. -##end -##variable -# CPACK_COMPONENTS_GROUPING - Specify how components are grouped for multi-package -# component-aware CPack generators. -# -#Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates several -#packages files when asked for component packaging. They group the component -#differently depending on the value of this variable: -# - ONE_PER_GROUP (default): creates one package file per component group -# - ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component -# - IGNORE : creates one package per component, i.e. IGNORE component group -#One can specify different grouping for different CPack generator by using -#a CPACK_PROJECT_CONFIG_FILE. -##end -##variable -# CPACK_COMPONENT_<compName>_DISPLAY_NAME - The name to be displayed for a component. -##end -##variable -# CPACK_COMPONENT_<compName>_DESCRIPTION - The description of a component. -##end -##variable -# CPACK_COMPONENT_<compName>_GROUP - The group of a component. -##end -##variable -# CPACK_COMPONENT_<compName>_DEPENDS - The dependencies (list of components) -# on which this component depends. -##end -##variable -# CPACK_COMPONENT_<compName>_REQUIRED - True is this component is required. -##end -##macro -#cpack_add_component - Describes a CPack installation component -#named by the COMPONENT argument to a CMake INSTALL command. -# -# cpack_add_component(compname -# [DISPLAY_NAME name] -# [DESCRIPTION description] -# [HIDDEN | REQUIRED | DISABLED ] -# [GROUP group] -# [DEPENDS comp1 comp2 ... ] -# [INSTALL_TYPES type1 type2 ... ] -# [DOWNLOADED] -# [ARCHIVE_FILE filename]) -# -#The cmake_add_component command describes an installation -#component, which the user can opt to install or remove as part of -#the graphical installation process. compname is the name of the -#component, as provided to the COMPONENT argument of one or more -#CMake INSTALL commands. -# -#DISPLAY_NAME is the displayed name of the component, used in -#graphical installers to display the component name. This value can -#be any string. -# -#DESCRIPTION is an extended description of the component, used in -#graphical installers to give the user additional information about -#the component. Descriptions can span multiple lines using "\n" as -#the line separator. Typically, these descriptions should be no -#more than a few lines long. -# -#HIDDEN indicates that this component will be hidden in the -#graphical installer, so that the user cannot directly change -#whether it is installed or not. -# -#REQUIRED indicates that this component is required, and therefore -#will always be installed. It will be visible in the graphical -#installer, but it cannot be unselected. (Typically, required -#components are shown greyed out). -# -#DISABLED indicates that this component should be disabled -#(unselected) by default. The user is free to select this component -#for installation, unless it is also HIDDEN. -# -#DEPENDS lists the components on which this component depends. If -#this component is selected, then each of the components listed -#must also be selected. The dependency information is encoded -#within the installer itself, so that users cannot install -#inconsistent sets of components. -# -#GROUP names the component group of which this component is a -#part. If not provided, the component will be a standalone -#component, not part of any component group. Component groups are -#described with the cpack_add_component_group command, detailed -#below. -# -#INSTALL_TYPES lists the installation types of which this component -#is a part. When one of these installations types is selected, this -#component will automatically be selected. Installation types are -#described with the cpack_add_install_type command, detailed below. -# -#DOWNLOADED indicates that this component should be downloaded -#on-the-fly by the installer, rather than packaged in with the -#installer itself. For more information, see the cpack_configure_downloads -# command. -# -#ARCHIVE_FILE provides a name for the archive file created by CPack -#to be used for downloaded components. If not supplied, CPack will -#create a file with some name based on CPACK_PACKAGE_FILE_NAME and -#the name of the component. See cpack_configure_downloads for more -#information. -##end -# -##macro -#cpack_add_component_group - Describes a group of related CPack -#installation components. -# -# cpack_add_component_group(groupname -# [DISPLAY_NAME name] -# [DESCRIPTION description] -# [PARENT_GROUP parent] -# [EXPANDED] -# [BOLD_TITLE]) -# -#The cpack_add_component_group describes a group of installation -#components, which will be placed together within the listing of -#options. Typically, component groups allow the user to -#select/deselect all of the components within a single group via a -#single group-level option. Use component groups to reduce the -#complexity of installers with many options. groupname is an -#arbitrary name used to identify the group in the GROUP argument of -#the cpack_add_component command, which is used to place a -#component in a group. The name of the group must not conflict with -#the name of any component. -# -#DISPLAY_NAME is the displayed name of the component group, used in -#graphical installers to display the component group name. This -#value can be any string. -# -#DESCRIPTION is an extended description of the component group, -#used in graphical installers to give the user additional -#information about the components within that group. Descriptions -#can span multiple lines using "\n" as the line -#separator. Typically, these descriptions should be no more than a -#few lines long. -# -#PARENT_GROUP, if supplied, names the parent group of this group. -#Parent groups are used to establish a hierarchy of groups, -#providing an arbitrary hierarchy of groups. -# -#EXPANDED indicates that, by default, the group should show up as -#"expanded", so that the user immediately sees all of the -#components within the group. Otherwise, the group will initially -#show up as a single entry. -# -#BOLD_TITLE indicates that the group title should appear in bold, -#to call the user's attention to the group. -##end -# -##macro -#cpack_add_install_type - Add a new installation type containing a -#set of predefined component selections to the graphical installer. -# -# cpack_add_install_type(typename -# [DISPLAY_NAME name]) -# -#The cpack_add_install_type command identifies a set of preselected -#components that represents a common use case for an -#application. For example, a "Developer" install type might include -#an application along with its header and library files, while an -#"End user" install type might just include the application's -#executable. Each component identifies itself with one or more -#install types via the INSTALL_TYPES argument to -#cpack_add_component. -# -#DISPLAY_NAME is the displayed name of the install type, which will -#typically show up in a drop-down box within a graphical -#installer. This value can be any string. -##end -# -##macro -#cpack_configure_downloads - Configure CPack to download selected -#components on-the-fly as part of the installation process. -# -# cpack_configure_downloads(site -# [UPLOAD_DIRECTORY dirname] -# [ALL] -# [ADD_REMOVE|NO_ADD_REMOVE]) -# -#The cpack_configure_downloads command configures installation-time -#downloads of selected components. For each downloadable component, -#CPack will create an archive containing the contents of that -#component, which should be uploaded to the given site. When the -#user selects that component for installation, the installer will -#download and extract the component in place. This feature is -#useful for creating small installers that only download the -#requested components, saving bandwidth. Additionally, the -#installers are small enough that they will be installed as part of -#the normal installation process, and the "Change" button in -#Windows Add/Remove Programs control panel will allow one to add or -#remove parts of the application after the original -#installation. On Windows, the downloaded-components functionality -#requires the ZipDLL plug-in for NSIS, available at: -# -# http://nsis.sourceforge.net/ZipDLL_plug-in -# -#On Mac OS X, installers that download components on-the-fly can -#only be built and installed on system using Mac OS X 10.5 or -#later. -# -#The site argument is a URL where the archives for downloadable -#components will reside, e.g., http://www.cmake.org/files/2.6.1/installer/ -#All of the archives produced by CPack should be uploaded to that location. -# -#UPLOAD_DIRECTORY is the local directory where CPack will create the -#various archives for each of the components. The contents of this -#directory should be uploaded to a location accessible by the URL given -#in the site argument. If omitted, CPack will use the directory -#CPackUploads inside the CMake binary directory to store the generated -#archives. -# -#The ALL flag indicates that all components be downloaded. Otherwise, only -#those components explicitly marked as DOWNLOADED or that have a specified -#ARCHIVE_FILE will be downloaded. Additionally, the ALL option implies -#ADD_REMOVE (unless NO_ADD_REMOVE is specified). -# -#ADD_REMOVE indicates that CPack should install a copy of the installer -#that can be called from Windows' Add/Remove Programs dialog (via the -#"Modify" button) to change the set of installed components. NO_ADD_REMOVE -#turns off this behavior. This option is ignored on Mac OS X. -##endmacro +# of components to install during the install process. Installation +# components are identified by the COMPONENT argument of CMake's INSTALL +# commands, and should be further described by the following CPack +# commands: +# +# .. variable:: CPACK_COMPONENTS_ALL +# +# The list of component to install. +# +# The default value of this variable is computed by CPack and contains all +# components defined by the project. The user may set it to only include the +# specified components. +# +# .. variable:: CPACK_<GENNAME>_COMPONENT_INSTALL +# +# Enable/Disable component install for CPack generator <GENNAME>. +# +# Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy +# default behavior. e.g. RPM builds monolithic whereas NSIS builds +# component. One can change the default behavior by setting this variable to +# 0/1 or OFF/ON. +# +# .. variable:: CPACK_COMPONENTS_GROUPING +# +# Specify how components are grouped for multi-package component-aware CPack +# generators. +# +# Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates +# several packages files when asked for component packaging. They group +# the component differently depending on the value of this variable: +# +# * ONE_PER_GROUP (default): creates one package file per component group +# * ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component +# * IGNORE : creates one package per component, i.e. IGNORE component group +# +# One can specify different grouping for different CPack generator by +# using a CPACK_PROJECT_CONFIG_FILE. +# +# .. variable:: CPACK_COMPONENT_<compName>_DISPLAY_NAME +# +# The name to be displayed for a component. +# +# .. variable:: CPACK_COMPONENT_<compName>_DESCRIPTION +# +# The description of a component. +# +# .. variable:: CPACK_COMPONENT_<compName>_GROUP +# +# The group of a component. +# +# .. variable:: CPACK_COMPONENT_<compName>_DEPENDS +# +# The dependencies (list of components) on which this component depends. +# +# .. variable:: CPACK_COMPONENT_<compName>_REQUIRED +# +# True is this component is required. +# +# .. command:: cpack_add_component +# +# Describes a CPack installation +# component named by the COMPONENT argument to a CMake INSTALL command. +# +# :: +# +# cpack_add_component(compname +# [DISPLAY_NAME name] +# [DESCRIPTION description] +# [HIDDEN | REQUIRED | DISABLED ] +# [GROUP group] +# [DEPENDS comp1 comp2 ... ] +# [INSTALL_TYPES type1 type2 ... ] +# [DOWNLOADED] +# [ARCHIVE_FILE filename]) +# +# +# +# The cmake_add_component command describes an installation component, +# which the user can opt to install or remove as part of the graphical +# installation process. compname is the name of the component, as +# provided to the COMPONENT argument of one or more CMake INSTALL +# commands. +# +# DISPLAY_NAME is the displayed name of the component, used in graphical +# installers to display the component name. This value can be any +# string. +# +# DESCRIPTION is an extended description of the component, used in +# graphical installers to give the user additional information about the +# component. Descriptions can span multiple lines using "\n" as the +# line separator. Typically, these descriptions should be no more than +# a few lines long. +# +# HIDDEN indicates that this component will be hidden in the graphical +# installer, so that the user cannot directly change whether it is +# installed or not. +# +# REQUIRED indicates that this component is required, and therefore will +# always be installed. It will be visible in the graphical installer, +# but it cannot be unselected. (Typically, required components are +# shown greyed out). +# +# DISABLED indicates that this component should be disabled (unselected) +# by default. The user is free to select this component for +# installation, unless it is also HIDDEN. +# +# DEPENDS lists the components on which this component depends. If this +# component is selected, then each of the components listed must also be +# selected. The dependency information is encoded within the installer +# itself, so that users cannot install inconsistent sets of components. +# +# GROUP names the component group of which this component is a part. If +# not provided, the component will be a standalone component, not part +# of any component group. Component groups are described with the +# cpack_add_component_group command, detailed below. +# +# INSTALL_TYPES lists the installation types of which this component is +# a part. When one of these installations types is selected, this +# component will automatically be selected. Installation types are +# described with the cpack_add_install_type command, detailed below. +# +# DOWNLOADED indicates that this component should be downloaded +# on-the-fly by the installer, rather than packaged in with the +# installer itself. For more information, see the +# cpack_configure_downloads command. +# +# ARCHIVE_FILE provides a name for the archive file created by CPack to +# be used for downloaded components. If not supplied, CPack will create +# a file with some name based on CPACK_PACKAGE_FILE_NAME and the name of +# the component. See cpack_configure_downloads for more information. +# +# .. command:: cpack_add_component_group +# +# Describes a group of related CPack installation components. +# +# :: +# +# cpack_add_component_group(groupname +# [DISPLAY_NAME name] +# [DESCRIPTION description] +# [PARENT_GROUP parent] +# [EXPANDED] +# [BOLD_TITLE]) +# +# +# +# The cpack_add_component_group describes a group of installation +# components, which will be placed together within the listing of +# options. Typically, component groups allow the user to +# select/deselect all of the components within a single group via a +# single group-level option. Use component groups to reduce the +# complexity of installers with many options. groupname is an arbitrary +# name used to identify the group in the GROUP argument of the +# cpack_add_component command, which is used to place a component in a +# group. The name of the group must not conflict with the name of any +# component. +# +# DISPLAY_NAME is the displayed name of the component group, used in +# graphical installers to display the component group name. This value +# can be any string. +# +# DESCRIPTION is an extended description of the component group, used in +# graphical installers to give the user additional information about the +# components within that group. Descriptions can span multiple lines +# using "\n" as the line separator. Typically, these descriptions +# should be no more than a few lines long. +# +# PARENT_GROUP, if supplied, names the parent group of this group. +# Parent groups are used to establish a hierarchy of groups, providing +# an arbitrary hierarchy of groups. +# +# EXPANDED indicates that, by default, the group should show up as +# "expanded", so that the user immediately sees all of the components +# within the group. Otherwise, the group will initially show up as a +# single entry. +# +# BOLD_TITLE indicates that the group title should appear in bold, to +# call the user's attention to the group. +# +# .. command:: cpack_add_install_type +# +# Add a new installation type containing +# a set of predefined component selections to the graphical installer. +# +# :: +# +# cpack_add_install_type(typename +# [DISPLAY_NAME name]) +# +# +# +# The cpack_add_install_type command identifies a set of preselected +# components that represents a common use case for an application. For +# example, a "Developer" install type might include an application along +# with its header and library files, while an "End user" install type +# might just include the application's executable. Each component +# identifies itself with one or more install types via the INSTALL_TYPES +# argument to cpack_add_component. +# +# DISPLAY_NAME is the displayed name of the install type, which will +# typically show up in a drop-down box within a graphical installer. +# This value can be any string. +# +# .. command:: cpack_configure_downloads +# +# Configure CPack to download +# selected components on-the-fly as part of the installation process. +# +# :: +# +# cpack_configure_downloads(site +# [UPLOAD_DIRECTORY dirname] +# [ALL] +# [ADD_REMOVE|NO_ADD_REMOVE]) +# +# +# +# The cpack_configure_downloads command configures installation-time +# downloads of selected components. For each downloadable component, +# CPack will create an archive containing the contents of that +# component, which should be uploaded to the given site. When the user +# selects that component for installation, the installer will download +# and extract the component in place. This feature is useful for +# creating small installers that only download the requested components, +# saving bandwidth. Additionally, the installers are small enough that +# they will be installed as part of the normal installation process, and +# the "Change" button in Windows Add/Remove Programs control panel will +# allow one to add or remove parts of the application after the original +# installation. On Windows, the downloaded-components functionality +# requires the ZipDLL plug-in for NSIS, available at: +# +# :: +# +# http://nsis.sourceforge.net/ZipDLL_plug-in +# +# +# +# On Mac OS X, installers that download components on-the-fly can only +# be built and installed on system using Mac OS X 10.5 or later. +# +# The site argument is a URL where the archives for downloadable +# components will reside, e.g., +# http://www.cmake.org/files/2.6.1/installer/ All of the archives +# produced by CPack should be uploaded to that location. +# +# UPLOAD_DIRECTORY is the local directory where CPack will create the +# various archives for each of the components. The contents of this +# directory should be uploaded to a location accessible by the URL given +# in the site argument. If omitted, CPack will use the directory +# CPackUploads inside the CMake binary directory to store the generated +# archives. +# +# The ALL flag indicates that all components be downloaded. Otherwise, +# only those components explicitly marked as DOWNLOADED or that have a +# specified ARCHIVE_FILE will be downloaded. Additionally, the ALL +# option implies ADD_REMOVE (unless NO_ADD_REMOVE is specified). +# +# ADD_REMOVE indicates that CPack should install a copy of the installer +# that can be called from Windows' Add/Remove Programs dialog (via the +# "Modify" button) to change the set of installed components. +# NO_ADD_REMOVE turns off this behavior. This option is ignored on Mac +# OS X. #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/CPackCygwin.cmake b/Modules/CPackCygwin.cmake index 7ed7f67..abfc1f6 100644 --- a/Modules/CPackCygwin.cmake +++ b/Modules/CPackCygwin.cmake @@ -1,23 +1,27 @@ -##section Variables specific to CPack Cygwin generator -##end -##module -# - Cygwin CPack generator (Cygwin). -# The following variable is specific to installers build on -# and/or for Cygwin: -##end -# -##variable -# CPACK_CYGWIN_PATCH_NUMBER - The Cygwin patch number. -# FIXME: This documentation is incomplete. -##end -##variable -# CPACK_CYGWIN_PATCH_FILE - The Cygwin patch file. -# FIXME: This documentation is incomplete. -##end -##variable -# CPACK_CYGWIN_BUILD_SCRIPT - The Cygwin build script. -# FIXME: This documentation is incomplete. -##end +#.rst: +# CPackCygwin +# ----------- +# +# Cygwin CPack generator (Cygwin). +# +# Variables specific to CPack Cygwin generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The +# following variable is specific to installers build on and/or for +# Cygwin: +# +# .. variable:: CPACK_CYGWIN_PATCH_NUMBER +# +# The Cygwin patch number. FIXME: This documentation is incomplete. +# +# .. variable:: CPACK_CYGWIN_PATCH_FILE +# +# The Cygwin patch file. FIXME: This documentation is incomplete. +# +# .. variable:: CPACK_CYGWIN_BUILD_SCRIPT +# +# The Cygwin build script. FIXME: This documentation is incomplete. #============================================================================= # Copyright 2006-2012 Kitware, Inc. diff --git a/Modules/CPackDMG.cmake b/Modules/CPackDMG.cmake index e866bab..b7a6ba5 100644 --- a/Modules/CPackDMG.cmake +++ b/Modules/CPackDMG.cmake @@ -1,60 +1,59 @@ -##section Variables specific to CPack DragNDrop generator -##end -##module -# - DragNDrop CPack generator (Mac OS X). -# The following variables are specific to the DragNDrop installers -# built on Mac OS X: -##end -# -##variable -# CPACK_DMG_VOLUME_NAME - The volume name of the generated disk -# image. Defaults to CPACK_PACKAGE_FILE_NAME. -##end -# -##variable -# CPACK_DMG_FORMAT - The disk image format. Common values are UDRO -# (UDIF read-only), UDZO (UDIF zlib-compressed) or UDBZ (UDIF -# bzip2-compressed). Refer to hdiutil(1) for more information on -# other available formats. -##end -# -##variable -# CPACK_DMG_DS_STORE - Path to a custom DS_Store file. This .DS_Store -# file e.g. can be used to specify the Finder window -# position/geometry and layout (such as hidden toolbars, placement of the -# icons etc.). This file has to be generated by the Finder (either manually or -# through OSA-script) using a normal folder from which the .DS_Store -# file can then be extracted. -##end -# -##variable -# CPACK_DMG_BACKGROUND_IMAGE - Path to a background image file. This -# file will be used as the background for the Finder Window when the disk -# image is opened. By default no background image is set. The background -# image is applied after applying the custom .DS_Store file. -##end -# -##variable -# CPACK_COMMAND_HDIUTIL - Path to the hdiutil(1) command used to -# operate on disk image files on Mac OS X. This variable can be used -# to override the automatically detected command (or specify its -# location if the auto-detection fails to find it.) -##end -# -##variable -# CPACK_COMMAND_SETFILE - Path to the SetFile(1) command used to set -# extended attributes on files and directories on Mac OS X. This -# variable can be used to override the automatically detected -# command (or specify its location if the auto-detection fails to -# find it.) -##end -# -##variable -# CPACK_COMMAND_REZ - Path to the Rez(1) command used to compile -# resources on Mac OS X. This variable can be used to override the +#.rst: +# CPackDMG +# -------- +# +# DragNDrop CPack generator (Mac OS X). +# +# Variables specific to CPack DragNDrop generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The following variables are specific to the DragNDrop installers built +# on Mac OS X: +# +# .. variable:: CPACK_DMG_VOLUME_NAME +# +# The volume name of the generated disk image. Defaults to +# CPACK_PACKAGE_FILE_NAME. +# +# .. variable:: CPACK_DMG_FORMAT +# +# The disk image format. Common values are UDRO (UDIF read-only), UDZO (UDIF +# zlib-compressed) or UDBZ (UDIF bzip2-compressed). Refer to hdiutil(1) for +# more information on other available formats. +# +# .. variable:: CPACK_DMG_DS_STORE +# +# Path to a custom DS_Store file. This .DS_Store file e.g. can be used to +# specify the Finder window position/geometry and layout (such as hidden +# toolbars, placement of the icons etc.). This file has to be generated by +# the Finder (either manually or through OSA-script) using a normal folder +# from which the .DS_Store file can then be extracted. +# +# .. variable:: CPACK_DMG_BACKGROUND_IMAGE +# +# Path to a background image file. This file will be used as the background +# for the Finder Window when the disk image is opened. By default no +# background image is set. The background image is applied after applying the +# custom .DS_Store file. +# +# .. variable:: CPACK_COMMAND_HDIUTIL +# +# Path to the hdiutil(1) command used to operate on disk image files on Mac +# OS X. This variable can be used to override the automatically detected +# command (or specify its location if the auto-detection fails to find it.) +# +# .. variable:: CPACK_COMMAND_SETFILE +# +# Path to the SetFile(1) command used to set extended attributes on files and +# directories on Mac OS X. This variable can be used to override the # automatically detected command (or specify its location if the # auto-detection fails to find it.) -##end +# +# .. variable:: CPACK_COMMAND_REZ +# +# Path to the Rez(1) command used to compile resources on Mac OS X. This +# variable can be used to override the automatically detected command (or +# specify its location if the auto-detection fails to find it.) #============================================================================= # Copyright 2006-2012 Kitware, Inc. diff --git a/Modules/CPackDeb.cmake b/Modules/CPackDeb.cmake index 75ff3be..c79ef06 100644 --- a/Modules/CPackDeb.cmake +++ b/Modules/CPackDeb.cmake @@ -1,169 +1,194 @@ -##section Variables specific to CPack Debian (DEB) generator -##end -##module -# - The builtin (binary) CPack Deb generator (Unix only) +#.rst: +# CPackDeb +# -------- +# +# The builtin (binary) CPack Deb generator (Unix only) +# +# Variables specific to CPack Debian (DEB) generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# # CPackDeb may be used to create Deb package using CPack. # CPackDeb is a CPack generator thus it uses the CPACK_XXX variables # used by CPack : http://www.cmake.org/Wiki/CMake:CPackConfiguration. -# CPackDeb generator should work on any linux host but it will -# produce better deb package when Debian specific tools 'dpkg-xxx' -# are usable on the build system. -# -# CPackDeb has specific features which are controlled by -# the specifics CPACK_DEBIAN_XXX variables.You'll find a detailed usage on -# the wiki: -# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#DEB_.28UNIX_only.29 +# CPackDeb generator should work on any linux host but it will produce +# better deb package when Debian specific tools 'dpkg-xxx' are usable on +# the build system. +# +# CPackDeb has specific features which are controlled by the specifics +# CPACK_DEBIAN_XXX variables.You'll find a detailed usage on the wiki: +# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#DEB_.28UNIX_only.29 +# # However as a handy reminder here comes the list of specific variables: -##end -# -##variable -# CPACK_DEBIAN_PACKAGE_NAME -# Mandatory : YES -# Default : CPACK_PACKAGE_NAME (lower case) -# The debian package summary -##end -##variable -# CPACK_DEBIAN_PACKAGE_VERSION -# Mandatory : YES -# Default : CPACK_PACKAGE_VERSION -# The debian package version -##end -##variable -# CPACK_DEBIAN_PACKAGE_ARCHITECTURE -# Mandatory : YES -# Default : Output of dpkg --print-architecture (or i386 if dpkg is not found) -# The debian package architecture -##end -##variable -# CPACK_DEBIAN_PACKAGE_DEPENDS -# Mandatory : NO -# Default : - -# May be used to set deb dependencies. -##end -##variable -# CPACK_DEBIAN_PACKAGE_MAINTAINER -# Mandatory : YES -# Default : CPACK_PACKAGE_CONTACT -# The debian package maintainer -##end -##variable -# CPACK_DEBIAN_PACKAGE_DESCRIPTION -# Mandatory : YES -# Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY -# The debian package description -##end -##variable -# CPACK_DEBIAN_PACKAGE_SECTION -# Mandatory : YES -# Default : 'devel' -# The debian package section -##end -##variable -# CPACK_DEBIAN_PACKAGE_PRIORITY -# Mandatory : YES -# Default : 'optional' -# The debian package priority -##end -##variable -# CPACK_DEBIAN_PACKAGE_HOMEPAGE -# Mandatory : NO -# Default : - -# The URL of the web site for this package, preferably (when applicable) the -# site from which the original source can be obtained and any additional -# upstream documentation or information may be found. -# The content of this field is a simple URL without any surrounding -# characters such as <>. -##end -##variable -# CPACK_DEBIAN_PACKAGE_SHLIBDEPS -# Mandatory : NO -# Default : OFF -# May be set to ON in order to use dpkg-shlibdeps to generate -# better package dependency list. -# You may need set CMAKE_INSTALL_RPATH toi appropriate value -# if you use this feature, because if you don't dpkg-shlibdeps -# may fail to find your own shared libs. -# See http://www.cmake.org/Wiki/CMake_RPATH_handling. -##end -##variable -# CPACK_DEBIAN_PACKAGE_DEBUG -# Mandatory : NO -# Default : - -# May be set when invoking cpack in order to trace debug information -# during CPackDeb run. -##end -##variable -# CPACK_DEBIAN_PACKAGE_PREDEPENDS -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# This field is like Depends, except that it also forces dpkg to complete installation of -# the packages named before even starting the installation of the package which declares -# the pre-dependency. -##end -##variable -# CPACK_DEBIAN_PACKAGE_ENHANCES -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# This field is similar to Suggests but works in the opposite direction. -# It is used to declare that a package can enhance the functionality of another package. -##end -##variable -# CPACK_DEBIAN_PACKAGE_BREAKS -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# When one binary package declares that it breaks another, dpkg will refuse to allow the -# package which declares Breaks be installed unless the broken package is deconfigured first, -# and it will refuse to allow the broken package to be reconfigured. -##end -##variable -# CPACK_DEBIAN_PACKAGE_CONFLICTS -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# When one binary package declares a conflict with another using a Conflicts field, -# dpkg will refuse to allow them to be installed on the system at the same time. -##end -##variable -# CPACK_DEBIAN_PACKAGE_PROVIDES -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# A virtual package is one which appears in the Provides control field of another package. -##end -##variable -# CPACK_DEBIAN_PACKAGE_REPLACES -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# Packages can declare in their control file that they should overwrite -# files in certain other packages, or completely replace other packages. -##end -##variable -# CPACK_DEBIAN_PACKAGE_RECOMMENDS -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# Allows packages to declare a strong, but not absolute, dependency on other packages. -##end -##variable -# CPACK_DEBIAN_PACKAGE_SUGGESTS -# Mandatory : NO -# Default : - -# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps -# Allows packages to declare a suggested package install grouping. -##end -##variable -# CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA -# Mandatory : NO -# Default : - -# This variable allow advanced user to add custom script to the control.tar.gz -# Typical usage is for conffiles, postinst, postrm, prerm. -# Usage: set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA -# "${CMAKE_CURRENT_SOURCE_DIR/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm") -##end +# +# .. variable:: CPACK_DEBIAN_PACKAGE_NAME +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_NAME (lower case) +# +# The debian package summary +# +# .. variable:: CPACK_DEBIAN_PACKAGE_VERSION +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_VERSION +# +# The debian package version +# +# .. variable:: CPACK_DEBIAN_PACKAGE_ARCHITECTURE +# +# * Mandatory : YES +# * Default : Output of dpkg --print-architecture (or i386 if dpkg is not found) +# +# The debian package architecture +# +# .. variable:: CPACK_DEBIAN_PACKAGE_DEPENDS +# +# * Mandatory : NO +# * Default : - +# +# May be used to set deb dependencies. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_MAINTAINER +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_CONTACT +# +# The debian package maintainer +# +# .. variable:: CPACK_DEBIAN_PACKAGE_DESCRIPTION +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY +# +# The debian package description +# +# .. variable:: CPACK_DEBIAN_PACKAGE_SECTION +# +# * Mandatory : YES +# * Default : 'devel' +# +# The debian package section +# +# .. variable:: CPACK_DEBIAN_PACKAGE_PRIORITY +# +# * Mandatory : YES +# * Default : 'optional' +# +# The debian package priority +# +# .. variable:: CPACK_DEBIAN_PACKAGE_HOMEPAGE +# +# * Mandatory : NO +# * Default : - +# +# The URL of the web site for this package, preferably (when applicable) the +# site from which the original source can be obtained and any additional +# upstream documentation or information may be found. +# The content of this field is a simple URL without any surrounding +# characters such as <>. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_SHLIBDEPS +# +# * Mandatory : NO +# * Default : OFF +# +# May be set to ON in order to use dpkg-shlibdeps to generate +# better package dependency list. +# You may need set CMAKE_INSTALL_RPATH toi appropriate value +# if you use this feature, because if you don't dpkg-shlibdeps +# may fail to find your own shared libs. +# See http://www.cmake.org/Wiki/CMake_RPATH_handling. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_DEBUG +# +# * Mandatory : NO +# * Default : - +# +# May be set when invoking cpack in order to trace debug information +# during CPackDeb run. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_PREDEPENDS +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# This field is like Depends, except that it also forces dpkg to complete installation of +# the packages named before even starting the installation of the package which declares +# the pre-dependency. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_ENHANCES +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# This field is similar to Suggests but works in the opposite direction. +# It is used to declare that a package can enhance the functionality of another package. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_BREAKS +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# When one binary package declares that it breaks another, dpkg will refuse to allow the +# package which declares Breaks be installed unless the broken package is deconfigured first, +# and it will refuse to allow the broken package to be reconfigured. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_CONFLICTS +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# When one binary package declares a conflict with another using a Conflicts field, +# dpkg will refuse to allow them to be installed on the system at the same time. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_PROVIDES +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# A virtual package is one which appears in the Provides control field of another package. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_REPLACES +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# Packages can declare in their control file that they should overwrite +# files in certain other packages, or completely replace other packages. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_RECOMMENDS +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# Allows packages to declare a strong, but not absolute, dependency on other packages. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_SUGGESTS +# +# * Mandatory : NO +# * Default : - +# +# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps +# Allows packages to declare a suggested package install grouping. +# +# .. variable:: CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA +# +# * Mandatory : NO +# * Default : - +# +# This variable allow advanced user to add custom script to the +# control.tar.gz Typical usage is for conffiles, postinst, postrm, prerm. +# Usage:: +# +# set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA +# "${CMAKE_CURRENT_SOURCE_DIR/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm") #============================================================================= diff --git a/Modules/CPackNSIS.cmake b/Modules/CPackNSIS.cmake index d140053..9d23ec0 100644 --- a/Modules/CPackNSIS.cmake +++ b/Modules/CPackNSIS.cmake @@ -1,134 +1,122 @@ -##section Variables specific to CPack NSIS generator -##end -##module -# - CPack NSIS generator specific options +#.rst: +# CPackNSIS +# --------- +# +# CPack NSIS generator specific options +# +# Variables specific to CPack NSIS generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # # The following variables are specific to the graphical installers built # on Windows using the Nullsoft Installation System. -##end -# -##variable -# CPACK_NSIS_INSTALL_ROOT - The default installation directory presented -# to the end user by the NSIS installer is under this root dir. The full -# directory presented to the end user is: -# ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY} -##end -# -##variable -# CPACK_NSIS_MUI_ICON - An icon filename. -# The name of a *.ico file used as the main icon for the generated -# install program. -##end -# -##variable -# CPACK_NSIS_MUI_UNIICON - An icon filename. -# The name of a *.ico file used as the main icon for the generated -# uninstall program. -##end -# -##variable -# CPACK_NSIS_INSTALLER_MUI_ICON_CODE - undocumented. -##end -# -##variable -# CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS - Extra NSIS commands that -# will be added to the beginning of the install Section, before your -# install tree is available on the target system. -##end -# -##variable -# CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that -# will be added to the end of the install Section, after your -# install tree is available on the target system. -##end -# -##variable -# CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will -# be added to the uninstall Section, before your install tree is -# removed from the target system. -##end -# -##variable -# CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the -# NSIS SetCompressor command. -##end -# -##variable -# CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL - Ask about uninstalling -# previous versions first. -# If this is set to "ON", then an installer will look for previous -# installed versions and if one is found, ask the user whether to -# uninstall it before proceeding with the install. -##end -# -##variable -# CPACK_NSIS_MODIFY_PATH - Modify PATH toggle. -# If this is set to "ON", then an extra page -# will appear in the installer that will allow the user to choose -# whether the program directory should be added to the system PATH -# variable. -##end -# -##variable -# CPACK_NSIS_DISPLAY_NAME - The display name string that appears in -# the Windows Add/Remove Program control panel -##end -# -##variable -# CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the -# installer. -##end -# -##variable -# CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that -# contains the installer icon. -##end -# -##variable -# CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in -# installing your application. -##end -# -##variable -# CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more -# information about your application. -##end -# -##variable -# CPACK_NSIS_CONTACT - Contact information for questions and comments -# about the installation process. -##end -# -##variable -# CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for -# creating start menu shortcuts. -##end -# -##variable -# CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to -# uninstall start menu shortcuts. -##end -# -##variable -# CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links -# assumes that they are in 'bin' unless this variable is set. -# For example, you would set this to 'exec' if your executables are -# in an exec directory. -##end -# -##variable -# CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option -# to run on the finish page of the NSIS installer. -##end -##variable -# CPACK_NSIS_MENU_LINKS - Specify links in [application] menu. -# This should contain a list of pair "link" "link name". The link -# may be an URL or a path relative to installation prefix. -# Like: -# set(CPACK_NSIS_MENU_LINKS -# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help" -# "http://www.cmake.org" "CMake Web Site") -##end +# +# .. variable:: CPACK_NSIS_INSTALL_ROOT +# +# The default installation directory presented to the end user by the NSIS +# installer is under this root dir. The full directory presented to the end +# user is: ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY} +# +# .. variable:: CPACK_NSIS_MUI_ICON +# +# An icon filename. The name of a ``*.ico`` file used as the main icon for the +# generated install program. +# +# .. variable:: CPACK_NSIS_MUI_UNIICON +# +# An icon filename. The name of a ``*.ico`` file used as the main icon for the +# generated uninstall program. +# +# .. variable:: CPACK_NSIS_INSTALLER_MUI_ICON_CODE +# +# undocumented. +# +# .. variable:: CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS +# +# Extra NSIS commands that will be added to the beginning of the install +# Section, before your install tree is available on the target system. +# +# .. variable:: CPACK_NSIS_EXTRA_INSTALL_COMMANDS +# +# Extra NSIS commands that will be added to the end of the install Section, +# after your install tree is available on the target system. +# +# .. variable:: CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS +# +# Extra NSIS commands that will be added to the uninstall Section, before +# your install tree is removed from the target system. +# +# .. variable:: CPACK_NSIS_COMPRESSOR +# +# The arguments that will be passed to the NSIS SetCompressor command. +# +# .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL +# +# Ask about uninstalling previous versions first. If this is set to "ON", +# then an installer will look for previous installed versions and if one is +# found, ask the user whether to uninstall it before proceeding with the +# install. +# +# .. variable:: CPACK_NSIS_MODIFY_PATH +# +# Modify PATH toggle. If this is set to "ON", then an extra page will appear +# in the installer that will allow the user to choose whether the program +# directory should be added to the system PATH variable. +# +# .. variable:: CPACK_NSIS_DISPLAY_NAME +# +# The display name string that appears in the Windows Add/Remove Program +# control panel +# +# .. variable:: CPACK_NSIS_PACKAGE_NAME +# +# The title displayed at the top of the installer. +# +# .. variable:: CPACK_NSIS_INSTALLED_ICON_NAME +# +# A path to the executable that contains the installer icon. +# +# .. variable:: CPACK_NSIS_HELP_LINK +# +# URL to a web site providing assistance in installing your application. +# +# .. variable:: CPACK_NSIS_URL_INFO_ABOUT +# +# URL to a web site providing more information about your application. +# +# .. variable:: CPACK_NSIS_CONTACT +# +# Contact information for questions and comments about the installation +# process. +# +# .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA +# +# Additional NSIS commands for creating start menu shortcuts. +# +# .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA +# +# Additional NSIS commands to uninstall start menu shortcuts. +# +# .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY +# +# Creating NSIS start menu links assumes that they are in 'bin' unless this +# variable is set. For example, you would set this to 'exec' if your +# executables are in an exec directory. +# +# .. variable:: CPACK_NSIS_MUI_FINISHPAGE_RUN +# +# Specify an executable to add an option to run on the finish page of the +# NSIS installer. +# +# .. variable:: CPACK_NSIS_MENU_LINKS +# +# Specify links in [application] menu. This should contain a list of pair +# "link" "link name". The link may be an URL or a path relative to +# installation prefix. Like:: +# +# set(CPACK_NSIS_MENU_LINKS +# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help" +# "http://www.cmake.org" "CMake Web Site") +# #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/CPackPackageMaker.cmake b/Modules/CPackPackageMaker.cmake index 98ca9e2..4160425 100644 --- a/Modules/CPackPackageMaker.cmake +++ b/Modules/CPackPackageMaker.cmake @@ -1,25 +1,27 @@ -##section Variables specific to CPack PackageMaker generator -##end -##module -# - PackageMaker CPack generator (Mac OS X). -# The following variable is specific to installers built on Mac OS X -# using PackageMaker: -##end +#.rst: +# CPackPackageMaker +# ----------------- # -##variable -# CPACK_OSX_PACKAGE_VERSION - The version of Mac OS X that the -# resulting PackageMaker archive should be compatible with. Different -# versions of Mac OS X support different -# features. For example, CPack can only build component-based -# installers for Mac OS X 10.4 or newer, and can only build -# installers that download component son-the-fly for Mac OS X 10.5 -# or newer. If left blank, this value will be set to the minimum -# version of Mac OS X that supports the requested features. Set this -# variable to some value (e.g., 10.4) only if you want to guarantee -# that your installer will work on that version of Mac OS X, and -# don't mind missing extra features available in the installer -# shipping with later versions of Mac OS X. -##end +# PackageMaker CPack generator (Mac OS X). +# +# Variables specific to CPack PackageMaker generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The following variable is specific to installers built on Mac +# OS X using PackageMaker: +# +# .. variable:: CPACK_OSX_PACKAGE_VERSION +# +# The version of Mac OS X that the resulting PackageMaker archive should be +# compatible with. Different versions of Mac OS X support different +# features. For example, CPack can only build component-based installers for +# Mac OS X 10.4 or newer, and can only build installers that download +# component son-the-fly for Mac OS X 10.5 or newer. If left blank, this value +# will be set to the minimum version of Mac OS X that supports the requested +# features. Set this variable to some value (e.g., 10.4) only if you want to +# guarantee that your installer will work on that version of Mac OS X, and +# don't mind missing extra features available in the installer shipping with +# later versions of Mac OS X. #============================================================================= # Copyright 2006-2012 Kitware, Inc. diff --git a/Modules/CPackRPM.cmake b/Modules/CPackRPM.cmake index bf5b5bc..a13a46f 100644 --- a/Modules/CPackRPM.cmake +++ b/Modules/CPackRPM.cmake @@ -1,248 +1,331 @@ -##section Variables specific to CPack RPM generator -##end -##module -# - The builtin (binary) CPack RPM generator (Unix only) -# CPackRPM may be used to create RPM package using CPack. -# CPackRPM is a CPack generator thus it uses the CPACK_XXX variables -# used by CPack : http://www.cmake.org/Wiki/CMake:CPackConfiguration -# -# However CPackRPM has specific features which are controlled by -# the specifics CPACK_RPM_XXX variables. CPackRPM is a component aware +#.rst: +# CPackRPM +# -------- +# +# The builtin (binary) CPack RPM generator (Unix only) +# +# Variables specific to CPack RPM generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# CPackRPM may be used to create RPM package using CPack. CPackRPM is a +# CPack generator thus it uses the CPACK_XXX variables used by CPack : +# http://www.cmake.org/Wiki/CMake:CPackConfiguration +# +# However CPackRPM has specific features which are controlled by the +# specifics CPACK_RPM_XXX variables. CPackRPM is a component aware # generator so when CPACK_RPM_COMPONENT_INSTALL is ON some more -# CPACK_RPM_<ComponentName>_XXXX variables may be used in order -# to have component specific values. Note however that <componentName> -# refers to the **grouping name**. This may be either a component name -# or a component GROUP name. -# Usually those vars correspond to RPM spec file entities, one may find -# information about spec files here http://www.rpm.org/wiki/Docs. -# You'll find a detailed usage of CPackRPM on the wiki: -# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#RPM_.28Unix_Only.29 +# CPACK_RPM_<ComponentName>_XXXX variables may be used in order to have +# component specific values. Note however that <componentName> refers +# to the **grouping name**. This may be either a component name or a +# component GROUP name. Usually those vars correspond to RPM spec file +# entities, one may find information about spec files here +# http://www.rpm.org/wiki/Docs. You'll find a detailed usage of +# CPackRPM on the wiki: +# +# :: +# +# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#RPM_.28Unix_Only.29 +# # However as a handy reminder here comes the list of specific variables: -##end -# -##variable -# CPACK_RPM_PACKAGE_SUMMARY - The RPM package summary. -# Mandatory : YES -# Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY -##end -##variable -# CPACK_RPM_PACKAGE_NAME - The RPM package name. -# Mandatory : YES -# Default : CPACK_PACKAGE_NAME -##end -##variable -# CPACK_RPM_PACKAGE_VERSION - The RPM package version. -# Mandatory : YES -# Default : CPACK_PACKAGE_VERSION -##end -##variable -# CPACK_RPM_PACKAGE_ARCHITECTURE - The RPM package architecture. -# Mandatory : NO -# Default : - -# This may be set to "noarch" if you -# know you are building a noarch package. -##end -##variable -# CPACK_RPM_PACKAGE_RELEASE - The RPM package release. -# Mandatory : YES -# Default : 1 -# This is the numbering of the RPM package -# itself, i.e. the version of the packaging and not the version of the -# content (see CPACK_RPM_PACKAGE_VERSION). One may change the default -# value if the previous packaging was buggy and/or you want to put here -# a fancy Linux distro specific numbering. -##end -##variable -# CPACK_RPM_PACKAGE_LICENSE - The RPM package license policy. -# Mandatory : YES -# Default : "unknown" -##end -##variable -# CPACK_RPM_PACKAGE_GROUP - The RPM package group. -# Mandatory : YES -# Default : "unknown" -##end -##variable -# CPACK_RPM_PACKAGE_VENDOR - The RPM package vendor. -# Mandatory : YES -# Default : CPACK_PACKAGE_VENDOR if set or "unknown" -##end -##variable -# CPACK_RPM_PACKAGE_URL - The projects URL. -# Mandatory : NO -# Default : - -##end -##variable -# CPACK_RPM_PACKAGE_DESCRIPTION - RPM package description. -# Mandatory : YES -# Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available" -##end -##variable -# CPACK_RPM_COMPRESSION_TYPE - RPM compression type. -# Mandatory : NO -# Default : - -# May be used to override RPM compression type to be used -# to build the RPM. For example some Linux distribution now default -# to lzma or xz compression whereas older cannot use such RPM. -# Using this one can enforce compression type to be used. -# Possible value are: lzma, xz, bzip2 and gzip. -##end -##variable -# CPACK_RPM_PACKAGE_REQUIRES - RPM spec requires field. -# Mandatory : NO -# Default : - -# May be used to set RPM dependencies (requires). -# Note that you must enclose the complete requires string between quotes, -# for example: -# set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8") -# The required package list of an RPM file could be printed with -# rpm -qp --requires file.rpm -##end -##variable -# CPACK_RPM_PACKAGE_SUGGESTS - RPM spec suggest field. -# Mandatory : NO -# Default : - -# May be used to set weak RPM dependencies (suggests). -# Note that you must enclose the complete requires string between quotes. -##end -##variable -# CPACK_RPM_PACKAGE_PROVIDES - RPM spec provides field. -# Mandatory : NO -# Default : - -# May be used to set RPM dependencies (provides). -# The provided package list of an RPM file could be printed with -# rpm -qp --provides file.rpm -##end -##variable -# CPACK_RPM_PACKAGE_OBSOLETES - RPM spec obsoletes field. -# Mandatory : NO -# Default : - -# May be used to set RPM packages that are obsoleted by this one. -##end -##variable -# CPACK_RPM_PACKAGE_RELOCATABLE - build a relocatable RPM. -# Mandatory : NO -# Default : CPACK_PACKAGE_RELOCATABLE -# If this variable is set to TRUE or ON CPackRPM will try -# to build a relocatable RPM package. A relocatable RPM may -# be installed using rpm --prefix or --relocate in order to -# install it at an alternate place see rpm(8). -# Note that currently this may fail if CPACK_SET_DESTDIR is set to ON. -# If CPACK_SET_DESTDIR is set then you will get a warning message -# but if there is file installed with absolute path you'll get -# unexpected behavior. -##end -##variable -# CPACK_RPM_SPEC_INSTALL_POST - [deprecated]. -# Mandatory : NO -# Default : - -# This way of specifying post-install script is deprecated use -# CPACK_RPM_POST_INSTALL_SCRIPT_FILE -# May be used to set an RPM post-install command inside the spec file. -# For example setting it to "/bin/true" may be used to prevent -# rpmbuild to strip binaries. -##end -##variable -# CPACK_RPM_SPEC_MORE_DEFINE - RPM extended spec definitions lines. -# Mandatory : NO -# Default : - -# May be used to add any %define lines to the generated spec file. -##end -##variable -# CPACK_RPM_PACKAGE_DEBUG - Toggle CPackRPM debug output. -# Mandatory : NO -# Default : - -# May be set when invoking cpack in order to trace debug information -# during CPack RPM run. For example you may launch CPack like this -# cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM -##end -##variable -# CPACK_RPM_USER_BINARY_SPECFILE - A user provided spec file. -# Mandatory : NO -# Default : - -# May be set by the user in order to specify a USER binary spec file -# to be used by CPackRPM instead of generating the file. -# The specified file will be processed by configure_file( @ONLY). -# One can provide a component specific file by setting -# CPACK_RPM_<componentName>_USER_BINARY_SPECFILE. -##end -##variable -# CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE - Spec file template. -# Mandatory : NO -# Default : - -# If set CPack will generate a template for USER specified binary -# spec file and stop with an error. For example launch CPack like this -# cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM -# The user may then use this file in order to hand-craft is own -# binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE. -##end -##variable -# CPACK_RPM_PRE_INSTALL_SCRIPT_FILE -# CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE -# Mandatory : NO -# Default : - -# May be used to embed a pre (un)installation script in the spec file. -# The refered script file(s) will be read and directly -# put after the %pre or %preun section -# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for -# each component can be overridden with -# CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE and -# CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE -# One may verify which scriptlet has been included with -# rpm -qp --scripts package.rpm -##end -##variable -# CPACK_RPM_POST_INSTALL_SCRIPT_FILE -# CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE -# Mandatory : NO -# Default : - -# May be used to embed a post (un)installation script in the spec file. -# The refered script file(s) will be read and directly -# put after the %post or %postun section -# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for -# each component can be overridden with -# CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE and -# CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE -# One may verify which scriptlet has been included with -# rpm -qp --scripts package.rpm -##end -##variable -# CPACK_RPM_USER_FILELIST -# CPACK_RPM_<COMPONENT>_USER_FILELIST -# Mandatory : NO -# Default : - -# May be used to explicitly specify %(<directive>) file line -# in the spec file. Like %config(noreplace) or any other directive -# that be found in the %files section. Since CPackRPM is generating -# the list of files (and directories) the user specified files of -# the CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from the generated list. -##end -##variable -# CPACK_RPM_CHANGELOG_FILE - RPM changelog file. -# Mandatory : NO -# Default : - -# May be used to embed a changelog in the spec file. -# The refered file will be read and directly put after the %changelog -# section. -##end -##variable -# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST - list of path to be excluded. -# Mandatory : NO -# Default : /etc /etc/init.d /usr /usr/share /usr/share/doc /usr/bin /usr/lib /usr/lib64 /usr/include -# May be used to exclude path (directories or files) from the auto-generated -# list of paths discovered by CPack RPM. The defaut value contains a reasonable -# set of values if the variable is not defined by the user. If the variable -# is defined by the user then CPackRPM will NOT any of the default path. -# If you want to add some path to the default list then you can use -# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION variable. -##end -##variable -# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION - additional list of path to be excluded. -# Mandatory : NO -# Default : - -# May be used to add more exclude path (directories or files) from the initial -# default list of excluded paths. See CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST. -##end +# +# .. variable:: CPACK_RPM_PACKAGE_SUMMARY +# +# The RPM package summary. +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY +# +# .. variable:: CPACK_RPM_PACKAGE_NAME +# +# The RPM package name. +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_NAME +# +# .. variable:: CPACK_RPM_PACKAGE_VERSION +# +# The RPM package version. +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_VERSION +# +# .. variable:: CPACK_RPM_PACKAGE_ARCHITECTURE +# +# The RPM package architecture. +# +# * Mandatory : NO +# * Default : - +# +# This may be set to "noarch" if you know you are building a noarch package. +# +# .. variable:: CPACK_RPM_PACKAGE_RELEASE +# +# The RPM package release. +# +# * Mandatory : YES +# * Default : 1 +# +# This is the numbering of the RPM package itself, i.e. the version of the +# packaging and not the version of the content (see +# CPACK_RPM_PACKAGE_VERSION). One may change the default value if the +# previous packaging was buggy and/or you want to put here a fancy Linux +# distro specific numbering. +# +# .. variable:: CPACK_RPM_PACKAGE_LICENSE +# +# The RPM package license policy. +# +# * Mandatory : YES +# * Default : "unknown" +# +# .. variable:: CPACK_RPM_PACKAGE_GROUP +# +# The RPM package group. +# +# * Mandatory : YES +# * Default : "unknown" +# +# .. variable:: CPACK_RPM_PACKAGE_VENDOR +# +# The RPM package vendor. +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_VENDOR if set or "unknown" +# +# .. variable:: CPACK_RPM_PACKAGE_URL +# +# The projects URL. +# +# * Mandatory : NO +# * Default : - +# +# .. variable:: CPACK_RPM_PACKAGE_DESCRIPTION +# +# RPM package description. +# +# * Mandatory : YES +# * Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package +# description available" +# +# .. variable:: CPACK_RPM_COMPRESSION_TYPE +# +# RPM compression type. +# +# * Mandatory : NO +# * Default : - +# +# May be used to override RPM compression type to be used to build the +# RPM. For example some Linux distribution now default to lzma or xz +# compression whereas older cannot use such RPM. Using this one can enforce +# compression type to be used. Possible value are: lzma, xz, bzip2 and gzip. +# +# .. variable:: CPACK_RPM_PACKAGE_REQUIRES +# +# RPM spec requires field. +# +# * Mandatory : NO +# * Default : - +# +# May be used to set RPM dependencies (requires). Note that you must enclose +# the complete requires string between quotes, for example:: +# +# set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8") +# +# The required package list of an RPM file could be printed with:: +# +# rpm -qp --requires file.rpm +# +# .. variable:: CPACK_RPM_PACKAGE_SUGGESTS +# +# RPM spec suggest field. +# +# * Mandatory : NO +# * Default : - +# +# May be used to set weak RPM dependencies (suggests). Note that you must +# enclose the complete requires string between quotes. +# +# .. variable:: CPACK_RPM_PACKAGE_PROVIDES +# +# RPM spec provides field. +# +# * Mandatory : NO +# * Default : - +# +# May be used to set RPM dependencies (provides). The provided package list +# of an RPM file could be printed with:: +# +# rpm -qp --provides file.rpm +# +# .. variable:: CPACK_RPM_PACKAGE_OBSOLETES +# +# RPM spec obsoletes field. +# +# * Mandatory : NO +# * Default : - +# +# May be used to set RPM packages that are obsoleted by this one. +# +# .. variable:: CPACK_RPM_PACKAGE_RELOCATABLE +# +# build a relocatable RPM. +# +# * Mandatory : NO +# * Default : CPACK_PACKAGE_RELOCATABLE +# +# If this variable is set to TRUE or ON CPackRPM will try +# to build a relocatable RPM package. A relocatable RPM may +# be installed using:: +# +# rpm --prefix or --relocate +# +# in order to install it at an alternate place see rpm(8). Note that +# currently this may fail if CPACK_SET_DESTDIR is set to ON. If +# CPACK_SET_DESTDIR is set then you will get a warning message but if there +# is file installed with absolute path you'll get unexpected behavior. +# +# .. variable:: CPACK_RPM_SPEC_INSTALL_POST +# +# * Mandatory : NO +# * Default : - +# * Deprecated: YES +# +# This way of specifying post-install script is deprecated, use +# CPACK_RPM_POST_INSTALL_SCRIPT_FILE. +# May be used to set an RPM post-install command inside the spec file. +# For example setting it to "/bin/true" may be used to prevent +# rpmbuild to strip binaries. +# +# .. variable:: CPACK_RPM_SPEC_MORE_DEFINE +# +# RPM extended spec definitions lines. +# +# * Mandatory : NO +# * Default : - +# +# May be used to add any %define lines to the generated spec file. +# +# .. variable:: CPACK_RPM_PACKAGE_DEBUG +# +# Toggle CPackRPM debug output. +# +# * Mandatory : NO +# * Default : - +# +# May be set when invoking cpack in order to trace debug information +# during CPack RPM run. For example you may launch CPack like this:: +# +# cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM +# +# .. variable:: CPACK_RPM_USER_BINARY_SPECFILE +# +# A user provided spec file. +# +# * Mandatory : NO +# * Default : - +# +# May be set by the user in order to specify a USER binary spec file +# to be used by CPackRPM instead of generating the file. +# The specified file will be processed by configure_file( @ONLY). +# One can provide a component specific file by setting +# CPACK_RPM_<componentName>_USER_BINARY_SPECFILE. +# +# .. variable:: CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE +# +# Spec file template. +# +# * Mandatory : NO +# * Default : - +# +# If set CPack will generate a template for USER specified binary +# spec file and stop with an error. For example launch CPack like this:: +# +# cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM +# +# The user may then use this file in order to hand-craft is own +# binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE. +# +# .. variable:: CPACK_RPM_PRE_INSTALL_SCRIPT_FILE +# CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE +# +# * Mandatory : NO +# * Default : - +# +# May be used to embed a pre (un)installation script in the spec file. +# The refered script file(s) will be read and directly +# put after the %pre or %preun section +# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for +# each component can be overridden with +# CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE and +# CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE. +# One may verify which scriptlet has been included with:: +# +# rpm -qp --scripts package.rpm +# +# .. variable:: CPACK_RPM_POST_INSTALL_SCRIPT_FILE +# CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE +# +# * Mandatory : NO +# * Default : - +# +# May be used to embed a post (un)installation script in the spec file. +# The refered script file(s) will be read and directly +# put after the %post or %postun section. +# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for +# each component can be overridden with +# CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE and +# CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE. +# One may verify which scriptlet has been included with:: +# +# rpm -qp --scripts package.rpm +# +# .. variable:: CPACK_RPM_USER_FILELIST +# CPACK_RPM_<COMPONENT>_USER_FILELIST +# +# * Mandatory : NO +# * Default : - +# +# May be used to explicitly specify %(<directive>) file line +# in the spec file. Like %config(noreplace) or any other directive +# that be found in the %files section. Since CPackRPM is generating +# the list of files (and directories) the user specified files of +# the CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from +# the generated list. +# +# .. variable:: CPACK_RPM_CHANGELOG_FILE +# +# RPM changelog file. +# +# * Mandatory : NO +# * Default : - +# +# May be used to embed a changelog in the spec file. +# The refered file will be read and directly put after the %changelog +# section. +# +# .. variable:: CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST +# +# list of path to be excluded. +# +# * Mandatory : NO +# * Default : /etc /etc/init.d /usr /usr/share /usr/share/doc /usr/bin /usr/lib /usr/lib64 /usr/include +# +# May be used to exclude path (directories or files) from the auto-generated +# list of paths discovered by CPack RPM. The defaut value contains a +# reasonable set of values if the variable is not defined by the user. If the +# variable is defined by the user then CPackRPM will NOT any of the default +# path. If you want to add some path to the default list then you can use +# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION variable. +# +# .. variable:: CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION +# +# additional list of path to be excluded. +# +# * Mandatory : NO +# * Default : - +# +# May be used to add more exclude path (directories or files) from the initial +# default list of excluded paths. See CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST. #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/CPackWIX.cmake b/Modules/CPackWIX.cmake index fce25f0..f4fcf6a 100644 --- a/Modules/CPackWIX.cmake +++ b/Modules/CPackWIX.cmake @@ -1,107 +1,128 @@ -##section Variables specific to CPack WiX generator -##end -##module -# - CPack WiX generator specific options -# -# The following variables are specific to the installers built -# on Windows using WiX. -##end -##variable -# CPACK_WIX_UPGRADE_GUID - Upgrade GUID (Product/@UpgradeCode) -# -# Will be automatically generated unless explicitly provided. -# -# It should be explicitly set to a constant generated -# gloabally unique identifier (GUID) to allow your installers -# to replace existing installations that use the same GUID. -# -# You may for example explicitly set this variable in -# your CMakeLists.txt to the value that has been generated per default. -# You should not use GUIDs that you did not generate yourself or which may -# belong to other projects. -# -# A GUID shall have the following fixed length syntax: -# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +#.rst: +# CPackWIX +# -------- +# +# CPack WiX generator specific options +# +# Variables specific to CPack WiX generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The following variables are specific to the installers built on +# Windows using WiX. +# +# .. variable:: CPACK_WIX_UPGRADE_GUID +# +# Upgrade GUID (``Product/@UpgradeCode``) +# +# Will be automatically generated unless explicitly provided. +# +# It should be explicitly set to a constant generated gloabally unique +# identifier (GUID) to allow your installers to replace existing +# installations that use the same GUID. +# +# You may for example explicitly set this variable in your +# CMakeLists.txt to the value that has been generated per default. You +# should not use GUIDs that you did not generate yourself or which may +# belong to other projects. +# +# A GUID shall have the following fixed length syntax:: +# +# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +# # (each X represents an uppercase hexadecimal digit) -##end -##variable -# CPACK_WIX_PRODUCT_GUID - Product GUID (Product/@Id) # -# Will be automatically generated unless explicitly provided. +# .. variable:: CPACK_WIX_PRODUCT_GUID +# +# Product GUID (``Product/@Id``) +# +# Will be automatically generated unless explicitly provided. +# +# If explicitly provided this will set the Product Id of your installer. +# +# The installer will abort if it detects a pre-existing installation that +# uses the same GUID. +# +# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. +# +# .. variable:: CPACK_WIX_LICENSE_RTF +# +# RTF License File +# +# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. +# +# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly +# converted to RTF by the WiX Generator. +# +# With CPACK_WIX_LICENSE_RTF you can override the license file used by the +# WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported +# format or the .txt -> .rtf conversion does not work as expected. +# +# .. variable:: CPACK_WIX_PRODUCT_ICON # -# If explicitly provided this will set the Product Id of your installer. +# The Icon shown next to the program name in Add/Remove programs. # -# The installer will abort if it detects a pre-existing installation that uses -# the same GUID. +# If set, this icon is used in place of the default icon. # -# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. -##end -##variable -# CPACK_WIX_LICENSE_RTF - RTF License File +# .. variable:: CPACK_WIX_UI_BANNER # -# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension -# it is used as-is. +# The bitmap will appear at the top of all installer pages other than the +# welcome and completion dialogs. # -# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension -# it is implicitly converted to RTF by the WiX Generator. +# If set, this image will replace the default banner image. # -# With CPACK_WIX_LICENSE_RTF you can override the license file used -# by the WiX Generator in case CPACK_RESOURCE_FILE_LICENSE -# is in an unsupported format or the .txt -> .rtf -# conversion does not work as expected. +# This image must be 493 by 58 pixels. # -##end +# .. variable:: CPACK_WIX_UI_DIALOG # -##variable -# CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program name in Add/Remove programs. +# Background bitmap used on the welcome and completion dialogs. # -# If set, this icon is used in place of the default icon. +# If this variable is set, the installer will replace the default dialog +# image. # -##end +# This image must be 493 by 312 pixels. # -##variable -# CPACK_WIX_UI_BANNER - The bitmap will appear at the top of all installer pages other than the welcome and completion dialogs. +# .. variable:: CPACK_WIX_PROGRAM_MENU_FOLDER # -# If set, this image will replace the default banner image. +# Start menu folder name for launcher. # -# This image must be 493 by 58 pixels. +# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME # -##end +# .. variable:: CPACK_WIX_CULTURES # -##variable -# CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome and completion dialogs. +# Language(s) of the installer # -# If this variable is set, the installer will replace the default dialog image. +# Languages are compiled into the WixUI extension library. To use them, +# simply provide the name of the culture. If you specify more than one +# culture identifier in a comma or semicolon delimited list, the first one +# that is found will be used. You can find a list of supported languages at: +# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm # -# This image must be 493 by 312 pixels. +# .. variable:: CPACK_WIX_TEMPLATE # -##end +# Template file for WiX generation # -##variable -# CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for launcher. +# If this variable is set, the specified template will be used to generate +# the WiX wxs file. This should be used if further customization of the +# output is required. # -# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME +# If this variable is not set, the default MSI template included with CMake +# will be used. # -##end -##variable -# CPACK_WIX_CULTURES - Language(s) of the installer +# .. variable:: CPACK_WIX_EXTRA_SOURCES # -# Languages are compiled into the WixUI extension library. To use them, -# simply provide the name of the culture. If you specify more than one -# culture identifier in a comma or semicolon delimited list, the first one -# that is found will be used. You can find a list of supported languages at: -# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm +# Extra WiX source files # -##end -##variable -# CPACK_WIX_TEMPLATE - Template file for WiX generation +# This variable provides an optional list of extra WiX source files (.wxs) +# that should be compiled and linked. The full path to source files is +# required. # -# If this variable is set, the specified template will be used to generate the WiX wxs file. -# This should be used if further customization of the output is required. +# .. variable:: CPACK_WIX_EXTRA_OBJECTS # -# If this variable is not set, the default MSI template included with CMake will be used. +# Extra WiX object files or libraries # -##end +# This variable provides an optional list of extra WiX object (.wixobj) +# and/or WiX library (.wixlib) files. The full path to objects and libraries +# is required. #============================================================================= # Copyright 2012 Kitware, Inc. diff --git a/Modules/CTest.cmake b/Modules/CTest.cmake index 5cd62f6..643cd29 100644 --- a/Modules/CTest.cmake +++ b/Modules/CTest.cmake @@ -1,49 +1,68 @@ -# - Configure a project for testing with CTest/CDash +#.rst: +# CTest +# ----- +# +# Configure a project for testing with CTest/CDash +# # Include this module in the top CMakeLists.txt file of a project to # enable testing with CTest and dashboard submissions to CDash: -# project(MyProject) -# ... -# include(CTest) +# +# :: +# +# project(MyProject) +# ... +# include(CTest) +# # The module automatically creates a BUILD_TESTING option that selects # whether to enable testing support (ON by default). After including # the module, use code like -# if(BUILD_TESTING) -# # ... CMake code to create tests ... -# endif() +# +# :: +# +# if(BUILD_TESTING) +# # ... CMake code to create tests ... +# endif() +# # to creating tests when testing is enabled. # # To enable submissions to a CDash server, create a CTestConfig.cmake # file at the top of the project with content such as -# set(CTEST_PROJECT_NAME "MyProject") -# set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") -# set(CTEST_DROP_METHOD "http") -# set(CTEST_DROP_SITE "my.cdash.org") -# set(CTEST_DROP_LOCATION "/submit.php?project=MyProject") -# set(CTEST_DROP_SITE_CDASH TRUE) -# (the CDash server can provide the file to a project administrator -# who configures 'MyProject'). -# Settings in the config file are shared by both this CTest module and -# the CTest command-line tool's dashboard script mode (ctest -S). +# +# :: +# +# set(CTEST_PROJECT_NAME "MyProject") +# set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") +# set(CTEST_DROP_METHOD "http") +# set(CTEST_DROP_SITE "my.cdash.org") +# set(CTEST_DROP_LOCATION "/submit.php?project=MyProject") +# set(CTEST_DROP_SITE_CDASH TRUE) +# +# (the CDash server can provide the file to a project administrator who +# configures 'MyProject'). Settings in the config file are shared by +# both this CTest module and the CTest command-line tool's dashboard +# script mode (ctest -S). # # While building a project for submission to CDash, CTest scans the -# build output for errors and warnings and reports them with -# surrounding context from the build log. This generic approach works -# for all build tools, but does not give details about the command -# invocation that produced a given problem. One may get more detailed -# reports by adding -# set(CTEST_USE_LAUNCHERS 1) -# to the CTestConfig.cmake file. When this option is enabled, the -# CTest module tells CMake's Makefile generators to invoke every -# command in the generated build system through a CTest launcher -# program. (Currently the CTEST_USE_LAUNCHERS option is ignored on -# non-Makefile generators.) During a manual build each launcher -# transparently runs the command it wraps. During a CTest-driven -# build for submission to CDash each launcher reports detailed -# information when its command fails or warns. -# (Setting CTEST_USE_LAUNCHERS in CTestConfig.cmake is convenient, but -# also adds the launcher overhead even for manual builds. One may -# instead set it in a CTest dashboard script and add it to the CMake -# cache for the build tree.) +# build output for errors and warnings and reports them with surrounding +# context from the build log. This generic approach works for all build +# tools, but does not give details about the command invocation that +# produced a given problem. One may get more detailed reports by adding +# +# :: +# +# set(CTEST_USE_LAUNCHERS 1) +# +# to the CTestConfig.cmake file. When this option is enabled, the CTest +# module tells CMake's Makefile generators to invoke every command in +# the generated build system through a CTest launcher program. +# (Currently the CTEST_USE_LAUNCHERS option is ignored on non-Makefile +# generators.) During a manual build each launcher transparently runs +# the command it wraps. During a CTest-driven build for submission to +# CDash each launcher reports detailed information when its command +# fails or warns. (Setting CTEST_USE_LAUNCHERS in CTestConfig.cmake is +# convenient, but also adds the launcher overhead even for manual +# builds. One may instead set it in a CTest dashboard script and add it +# to the CMake cache for the build tree.) #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/CTestScriptMode.cmake b/Modules/CTestScriptMode.cmake index 42d3764..b434724 100644 --- a/Modules/CTestScriptMode.cmake +++ b/Modules/CTestScriptMode.cmake @@ -1,3 +1,9 @@ +#.rst: +# CTestScriptMode +# --------------- +# +# +# # This file is read by ctest in script mode (-S) #============================================================================= diff --git a/Modules/CTestUseLaunchers.cmake b/Modules/CTestUseLaunchers.cmake index 24f5f2e..2fab247 100644 --- a/Modules/CTestUseLaunchers.cmake +++ b/Modules/CTestUseLaunchers.cmake @@ -1,21 +1,27 @@ -# - Set the RULE_LAUNCH_* global properties when CTEST_USE_LAUNCHERS is on. +#.rst: +# CTestUseLaunchers +# ----------------- +# +# Set the RULE_LAUNCH_* global properties when CTEST_USE_LAUNCHERS is on. +# # CTestUseLaunchers is automatically included when you include(CTest). -# However, it is split out into its own module file so projects -# can use the CTEST_USE_LAUNCHERS functionality independently. +# However, it is split out into its own module file so projects can use +# the CTEST_USE_LAUNCHERS functionality independently. # # To use launchers, set CTEST_USE_LAUNCHERS to ON in a ctest -S # dashboard script, and then also set it in the cache of the configured -# project. Both cmake and ctest need to know the value of it for the launchers -# to work properly. CMake needs to know in order to generate proper build -# rules, and ctest, in order to produce the proper error and warning -# analysis. +# project. Both cmake and ctest need to know the value of it for the +# launchers to work properly. CMake needs to know in order to generate +# proper build rules, and ctest, in order to produce the proper error +# and warning analysis. # -# For convenience, you may set the ENV variable CTEST_USE_LAUNCHERS_DEFAULT -# in your ctest -S script, too. Then, as long as your CMakeLists uses -# include(CTest) or include(CTestUseLaunchers), it will use the value of the -# ENV variable to initialize a CTEST_USE_LAUNCHERS cache variable. This cache -# variable initialization only occurs if CTEST_USE_LAUNCHERS is not already -# defined. +# For convenience, you may set the ENV variable +# CTEST_USE_LAUNCHERS_DEFAULT in your ctest -S script, too. Then, as +# long as your CMakeLists uses include(CTest) or +# include(CTestUseLaunchers), it will use the value of the ENV variable +# to initialize a CTEST_USE_LAUNCHERS cache variable. This cache +# variable initialization only occurs if CTEST_USE_LAUNCHERS is not +# already defined. #============================================================================= # Copyright 2008-2012 Kitware, Inc. diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake index bc15e9a..efdac20 100644 --- a/Modules/CheckCCompilerFlag.cmake +++ b/Modules/CheckCCompilerFlag.cmake @@ -1,14 +1,22 @@ -# - Check whether the C compiler supports a given flag. +#.rst: +# CheckCCompilerFlag +# ------------------ +# +# Check whether the C compiler supports a given flag. +# # CHECK_C_COMPILER_FLAG(<flag> <var>) -# <flag> - the compiler flag -# <var> - variable to store the result -# This internally calls the check_c_source_compiles macro and -# sets CMAKE_REQUIRED_DEFINITIONS to <flag>. -# See help for CheckCSourceCompiles for a listing of variables -# that can otherwise modify the build. -# The result only tells that the compiler does not give an error message when -# it encounters the flag. If the flag has any effect or even a specific one is -# beyond the scope of this module. +# +# :: +# +# <flag> - the compiler flag +# <var> - variable to store the result +# +# This internally calls the check_c_source_compiles macro and sets +# CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for +# CheckCSourceCompiles for a listing of variables that can otherwise +# modify the build. The result only tells that the compiler does not +# give an error message when it encounters the flag. If the flag has +# any effect or even a specific one is beyond the scope of this module. #============================================================================= # Copyright 2006-2011 Kitware, Inc. @@ -26,36 +34,30 @@ # License text for the above reference.) include(CheckCSourceCompiles) +include(CMakeCheckCompilerFlagCommonPatterns) macro (CHECK_C_COMPILER_FLAG _FLAG _RESULT) set(SAFE_CMAKE_REQUIRED_DEFINITIONS "${CMAKE_REQUIRED_DEFINITIONS}") set(CMAKE_REQUIRED_DEFINITIONS "${_FLAG}") + # Normalize locale during test compilation. set(_CheckCCompilerFlag_LOCALE_VARS LC_ALL LC_MESSAGES LANG) foreach(v ${_CheckCCompilerFlag_LOCALE_VARS}) set(_CheckCCompilerFlag_SAVED_${v} "$ENV{${v}}") set(ENV{${v}} C) endforeach() + CHECK_COMPILER_FLAG_COMMON_PATTERNS(_CheckCCompilerFlag_COMMON_PATTERNS) CHECK_C_SOURCE_COMPILES("int main(void) { return 0; }" ${_RESULT} # Some compilers do not fail with a bad flag FAIL_REGEX "command line option .* is valid for .* but not for C" # GNU - FAIL_REGEX "unrecognized .*option" # GNU - FAIL_REGEX "unknown .*option" # Clang - FAIL_REGEX "ignoring unknown option" # MSVC - FAIL_REGEX "warning D9002" # MSVC, any lang - FAIL_REGEX "option.*not supported" # Intel - FAIL_REGEX "invalid argument .*option" # Intel - FAIL_REGEX "ignoring option .*argument required" # Intel - FAIL_REGEX "[Uu]nknown option" # HP - FAIL_REGEX "[Ww]arning: [Oo]ption" # SunPro - FAIL_REGEX "command option .* is not recognized" # XL - FAIL_REGEX "WARNING: unknown flag:" # Open64 + ${_CheckCCompilerFlag_COMMON_PATTERNS} ) foreach(v ${_CheckCCompilerFlag_LOCALE_VARS}) set(ENV{${v}} ${_CheckCCompilerFlag_SAVED_${v}}) unset(_CheckCCompilerFlag_SAVED_${v}) endforeach() unset(_CheckCCompilerFlag_LOCALE_VARS) + unset(_CheckCCompilerFlag_COMMON_PATTERNS) set (CMAKE_REQUIRED_DEFINITIONS "${SAFE_CMAKE_REQUIRED_DEFINITIONS}") endmacro () diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake index 86a4565..c2f6915 100644 --- a/Modules/CheckCSourceCompiles.cmake +++ b/Modules/CheckCSourceCompiles.cmake @@ -1,15 +1,26 @@ -# - Check if given C source compiles and links into an executable +#.rst: +# CheckCSourceCompiles +# -------------------- +# +# Check if given C source compiles and links into an executable +# # CHECK_C_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>]) -# <code> - source code to try to compile, must define 'main' -# <var> - variable to store whether the source code compiled -# <fail-regex> - fail if test output matches this regex -# The following variables may be set before calling this macro to -# modify the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# :: +# +# <code> - source code to try to compile, must define 'main' +# <var> - variable to store whether the source code compiled +# <fail-regex> - fail if test output matches this regex +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/CheckCSourceRuns.cmake b/Modules/CheckCSourceRuns.cmake index e3a091f..2e68454 100644 --- a/Modules/CheckCSourceRuns.cmake +++ b/Modules/CheckCSourceRuns.cmake @@ -1,15 +1,26 @@ -# - Check if the given C source code compiles and runs. +#.rst: +# CheckCSourceRuns +# ---------------- +# +# Check if the given C source code compiles and runs. +# # CHECK_C_SOURCE_RUNS(<code> <var>) -# <code> - source code to try to compile -# <var> - variable to store the result -# (1 for success, empty for failure) -# The following variables may be set before calling this macro to -# modify the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# :: +# +# <code> - source code to try to compile +# <var> - variable to store the result +# (1 for success, empty for failure) +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/CheckCXXCompilerFlag.cmake b/Modules/CheckCXXCompilerFlag.cmake index eee3a70..fab3a05 100644 --- a/Modules/CheckCXXCompilerFlag.cmake +++ b/Modules/CheckCXXCompilerFlag.cmake @@ -1,14 +1,22 @@ -# - Check whether the CXX compiler supports a given flag. +#.rst: +# CheckCXXCompilerFlag +# -------------------- +# +# Check whether the CXX compiler supports a given flag. +# # CHECK_CXX_COMPILER_FLAG(<flag> <var>) -# <flag> - the compiler flag -# <var> - variable to store the result -# This internally calls the check_cxx_source_compiles macro and -# sets CMAKE_REQUIRED_DEFINITIONS to <flag>. -# See help for CheckCXXSourceCompiles for a listing of variables -# that can otherwise modify the build. -# The result only tells that the compiler does not give an error message when -# it encounters the flag. If the flag has any effect or even a specific one is -# beyond the scope of this module. +# +# :: +# +# <flag> - the compiler flag +# <var> - variable to store the result +# +# This internally calls the check_cxx_source_compiles macro and sets +# CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for +# CheckCXXSourceCompiles for a listing of variables that can otherwise +# modify the build. The result only tells that the compiler does not +# give an error message when it encounters the flag. If the flag has +# any effect or even a specific one is beyond the scope of this module. #============================================================================= # Copyright 2006-2010 Kitware, Inc. @@ -26,6 +34,7 @@ # License text for the above reference.) include(CheckCXXSourceCompiles) +include(CMakeCheckCompilerFlagCommonPatterns) macro (CHECK_CXX_COMPILER_FLAG _FLAG _RESULT) set(SAFE_CMAKE_REQUIRED_DEFINITIONS "${CMAKE_REQUIRED_DEFINITIONS}") @@ -37,28 +46,18 @@ macro (CHECK_CXX_COMPILER_FLAG _FLAG _RESULT) set(_CheckCXXCompilerFlag_SAVED_${v} "$ENV{${v}}") set(ENV{${v}} C) endforeach() - CHECK_CXX_SOURCE_COMPILES("int main() { return 0;}" ${_RESULT} + CHECK_COMPILER_FLAG_COMMON_PATTERNS(_CheckCXXCompilerFlag_COMMON_PATTERNS) + CHECK_CXX_SOURCE_COMPILES("int main() { return 0; }" ${_RESULT} # Some compilers do not fail with a bad flag FAIL_REGEX "command line option .* is valid for .* but not for C\\\\+\\\\+" # GNU - FAIL_REGEX "unrecognized .*option" # GNU - FAIL_REGEX "unknown .*option" # Clang - FAIL_REGEX "ignoring unknown option" # MSVC - FAIL_REGEX "warning D9002" # MSVC, any lang - FAIL_REGEX "option.*not supported" # Intel - FAIL_REGEX "invalid argument .*option" # Intel - FAIL_REGEX "ignoring option .*argument required" # Intel - FAIL_REGEX "[Uu]nknown option" # HP - FAIL_REGEX "[Ww]arning: [Oo]ption" # SunPro - FAIL_REGEX "command option .* is not recognized" # XL - FAIL_REGEX "not supported in this configuration; ignored" # AIX - FAIL_REGEX "File with unknown suffix passed to linker" # PGI - FAIL_REGEX "WARNING: unknown flag:" # Open64 + ${_CheckCXXCompilerFlag_COMMON_PATTERNS} ) foreach(v ${_CheckCXXCompilerFlag_LOCALE_VARS}) set(ENV{${v}} ${_CheckCXXCompilerFlag_SAVED_${v}}) unset(_CheckCXXCompilerFlag_SAVED_${v}) endforeach() unset(_CheckCXXCompilerFlag_LOCALE_VARS) + unset(_CheckCXXCompilerFlag_COMMON_PATTERNS) set (CMAKE_REQUIRED_DEFINITIONS "${SAFE_CMAKE_REQUIRED_DEFINITIONS}") endmacro () diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake index 734c083..c7ef5ec 100644 --- a/Modules/CheckCXXSourceCompiles.cmake +++ b/Modules/CheckCXXSourceCompiles.cmake @@ -1,15 +1,26 @@ -# - Check if given C++ source compiles and links into an executable +#.rst: +# CheckCXXSourceCompiles +# ---------------------- +# +# Check if given C++ source compiles and links into an executable +# # CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>]) -# <code> - source code to try to compile, must define 'main' -# <var> - variable to store whether the source code compiled -# <fail-regex> - fail if test output matches this regex -# The following variables may be set before calling this macro to -# modify the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# :: +# +# <code> - source code to try to compile, must define 'main' +# <var> - variable to store whether the source code compiled +# <fail-regex> - fail if test output matches this regex +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/CheckCXXSourceRuns.cmake b/Modules/CheckCXXSourceRuns.cmake index 9e401f1..4e3ff6c 100644 --- a/Modules/CheckCXXSourceRuns.cmake +++ b/Modules/CheckCXXSourceRuns.cmake @@ -1,15 +1,26 @@ -# - Check if the given C++ source code compiles and runs. +#.rst: +# CheckCXXSourceRuns +# ------------------ +# +# Check if the given C++ source code compiles and runs. +# # CHECK_CXX_SOURCE_RUNS(<code> <var>) -# <code> - source code to try to compile -# <var> - variable to store the result -# (1 for success, empty for failure) -# The following variables may be set before calling this macro to -# modify the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# :: +# +# <code> - source code to try to compile +# <var> - variable to store the result +# (1 for success, empty for failure) +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/CheckCXXSymbolExists.cmake b/Modules/CheckCXXSymbolExists.cmake index 2100973..aa62fbf 100644 --- a/Modules/CheckCXXSymbolExists.cmake +++ b/Modules/CheckCXXSymbolExists.cmake @@ -1,26 +1,32 @@ -# - Check if a symbol exists as a function, variable, or macro in C++ +#.rst: +# CheckCXXSymbolExists +# -------------------- +# +# Check if a symbol exists as a function, variable, or macro in C++ +# # CHECK_CXX_SYMBOL_EXISTS(<symbol> <files> <variable>) # # Check that the <symbol> is available after including given header -# <files> and store the result in a <variable>. Specify the list -# of files in one argument as a semicolon-separated list. -# CHECK_CXX_SYMBOL_EXISTS() can be used to check in C++ files, as opposed -# to CHECK_SYMBOL_EXISTS(), which works only for C. +# <files> and store the result in a <variable>. Specify the list of +# files in one argument as a semicolon-separated list. +# CHECK_CXX_SYMBOL_EXISTS() can be used to check in C++ files, as +# opposed to CHECK_SYMBOL_EXISTS(), which works only for C. # # If the header files define the symbol as a macro it is considered -# available and assumed to work. If the header files declare the -# symbol as a function or variable then the symbol must also be -# available for linking. If the symbol is a type or enum value -# it will not be recognized (consider using CheckTypeSize or -# CheckCSourceCompiles). -# -# The following variables may be set before calling this macro to -# modify the way the check is run: -# -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# available and assumed to work. If the header files declare the symbol +# as a function or variable then the symbol must also be available for +# linking. If the symbol is a type or enum value it will not be +# recognized (consider using CheckTypeSize or CheckCSourceCompiles). +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2003-2011 Kitware, Inc. diff --git a/Modules/CheckFortranFunctionExists.cmake b/Modules/CheckFortranFunctionExists.cmake index 45dd7be..0b12289 100644 --- a/Modules/CheckFortranFunctionExists.cmake +++ b/Modules/CheckFortranFunctionExists.cmake @@ -1,13 +1,24 @@ -# - Check if the Fortran function exists. +#.rst: +# CheckFortranFunctionExists +# -------------------------- +# +# macro which checks if the Fortran function exists +# # CHECK_FORTRAN_FUNCTION_EXISTS(FUNCTION VARIABLE) -# - macro which checks if the Fortran function exists -# FUNCTION - the name of the Fortran function -# VARIABLE - variable to store the result # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: +# +# FUNCTION - the name of the Fortran function +# VARIABLE - variable to store the result +# +# +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: # -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake index ead1354..e232bd7 100644 --- a/Modules/CheckFunctionExists.cmake +++ b/Modules/CheckFunctionExists.cmake @@ -1,18 +1,25 @@ -# - Check if a C function can be linked +#.rst: +# CheckFunctionExists +# ------------------- +# +# Check if a C function can be linked +# # CHECK_FUNCTION_EXISTS(<function> <variable>) # # Check that the <function> is provided by libraries on the system and # store the result in a <variable>. This does not verify that any -# system header file declares the function, only that it can be found -# at link time (consider using CheckSymbolExists). +# system header file declares the function, only that it can be found at +# link time (consider using CheckSymbolExists). +# +# The following variables may be set before calling this macro to modify +# the way the check is run: # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2002-2011 Kitware, Inc. diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake index 8067e65..2d0edf9 100644 --- a/Modules/CheckIncludeFile.cmake +++ b/Modules/CheckIncludeFile.cmake @@ -1,19 +1,29 @@ -# - Check if the include file exists. +#.rst: +# CheckIncludeFile +# ---------------- +# +# macro which checks 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 +# :: +# +# 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 # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# The following variables may be set before calling this macro to modify +# the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories +# :: # +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake index 22c2d1a..7a86be5 100644 --- a/Modules/CheckIncludeFileCXX.cmake +++ b/Modules/CheckIncludeFileCXX.cmake @@ -1,19 +1,33 @@ -# - Check if the include file exists. -# CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE) +#.rst: +# CheckIncludeFileCXX +# ------------------- # -# INCLUDE - name of include file -# VARIABLE - variable to return result +# Check if the include file exists. # -# An optional third argument is the CFlags to add to the compile line -# or you can use CMAKE_REQUIRED_FLAGS. +# :: # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE) # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories # +# +# :: +# +# 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. +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake index daf2dd0..75bf27c 100644 --- a/Modules/CheckIncludeFiles.cmake +++ b/Modules/CheckIncludeFiles.cmake @@ -1,16 +1,28 @@ -# - Check if the files can be included +#.rst: +# CheckIncludeFiles +# ----------------- +# +# Check if the files can be included +# +# # # CHECK_INCLUDE_FILES(INCLUDE VARIABLE) # -# INCLUDE - list of files to include -# VARIABLE - variable to return result +# :: +# +# INCLUDE - list of files to include +# VARIABLE - variable to return result +# +# +# +# The following variables may be set before calling this macro to modify +# the way the check is run: # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories #============================================================================= # Copyright 2003-2012 Kitware, Inc. diff --git a/Modules/CheckLanguage.cmake b/Modules/CheckLanguage.cmake index 87a4018..3bd126a 100644 --- a/Modules/CheckLanguage.cmake +++ b/Modules/CheckLanguage.cmake @@ -1,19 +1,32 @@ -# - Check if a language can be enabled +#.rst: +# CheckLanguage +# ------------- +# +# Check if a language can be enabled +# # Usage: -# check_language(<lang>) +# +# :: +# +# check_language(<lang>) +# # where <lang> is a language that may be passed to enable_language() # such as "Fortran". If CMAKE_<lang>_COMPILER is already defined the # check does nothing. Otherwise it tries enabling the language in a # test project. The result is cached in CMAKE_<lang>_COMPILER as the -# compiler that was found, or NOTFOUND if the language cannot be enabled. +# compiler that was found, or NOTFOUND if the language cannot be +# enabled. # # Example: -# check_language(Fortran) -# if(CMAKE_Fortran_COMPILER) -# enable_language(Fortran) -# else() -# message(STATUS "No Fortran support") -# endif() +# +# :: +# +# check_language(Fortran) +# if(CMAKE_Fortran_COMPILER) +# enable_language(Fortran) +# else() +# message(STATUS "No Fortran support") +# endif() #============================================================================= # Copyright 2009-2012 Kitware, Inc. diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake index fb7d0ec..f5c563c 100644 --- a/Modules/CheckLibraryExists.cmake +++ b/Modules/CheckLibraryExists.cmake @@ -1,17 +1,28 @@ -# - Check if the function exists. +#.rst: +# CheckLibraryExists +# ------------------ +# +# Check if the function exists. +# # CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE) # -# 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 +# :: +# +# 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 +# +# +# +# The following variables may be set before calling this macro to modify +# the way the check is run: # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CheckPrototypeDefinition.cmake b/Modules/CheckPrototypeDefinition.cmake index 2342b3c..25ea7f4 100644 --- a/Modules/CheckPrototypeDefinition.cmake +++ b/Modules/CheckPrototypeDefinition.cmake @@ -1,23 +1,38 @@ -# - Check if the protoype we expect is correct. +#.rst: +# CheckPrototypeDefinition +# ------------------------ +# +# Check if the protoype we expect is correct. +# # check_prototype_definition(FUNCTION PROTOTYPE RETURN HEADER VARIABLE) -# FUNCTION - The name of the function (used to check if prototype exists) -# PROTOTYPE- The prototype to check. -# RETURN - The return value of the function. -# HEADER - The header files required. -# VARIABLE - The variable to store the result. +# +# :: +# +# FUNCTION - The name of the function (used to check if prototype exists) +# PROTOTYPE- The prototype to check. +# RETURN - The return value of the function. +# HEADER - The header files required. +# VARIABLE - The variable to store the result. +# # Example: -# check_prototype_definition(getpwent_r -# "struct passwd *getpwent_r(struct passwd *src, char *buf, int buflen)" -# "NULL" -# "unistd.h;pwd.h" -# SOLARIS_GETPWENT_R) -# The following variables may be set before calling this macro to -# modify the way the check is run: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# :: +# +# check_prototype_definition(getpwent_r +# "struct passwd *getpwent_r(struct passwd *src, char *buf, int buflen)" +# "NULL" +# "unistd.h;pwd.h" +# SOLARIS_GETPWENT_R) +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/CheckStructHasMember.cmake b/Modules/CheckStructHasMember.cmake index ea2891c..a4ed8d5 100644 --- a/Modules/CheckStructHasMember.cmake +++ b/Modules/CheckStructHasMember.cmake @@ -1,19 +1,41 @@ -# - Check if the given struct or class has the specified member variable -# CHECK_STRUCT_HAS_MEMBER (STRUCT MEMBER HEADER VARIABLE) +#.rst: +# CheckStructHasMember +# -------------------- # -# STRUCT - the name of the struct or class you are interested in -# MEMBER - the member which existence you want to check -# HEADER - the header(s) where the prototype should be declared -# VARIABLE - variable to store the result +# Check if the given struct or class has the specified member variable # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# CHECK_STRUCT_HAS_MEMBER (<struct> <member> <header> <variable> # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories +# :: # -# Example: CHECK_STRUCT_HAS_MEMBER("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC) +# [LANGUAGE <language>]) +# +# +# +# :: +# +# <struct> - the name of the struct or class you are interested in +# <member> - the member which existence you want to check +# <header> - the header(s) where the prototype should be declared +# <variable> - variable to store the result +# <language> - the compiler to use (C or CXX) +# +# +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: +# +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# +# +# +# Example: CHECK_STRUCT_HAS_MEMBER("struct timeval" tv_sec sys/select.h +# HAVE_TIMEVAL_TV_SEC LANGUAGE C) #============================================================================= # Copyright 2007-2009 Kitware, Inc. @@ -29,6 +51,7 @@ # License text for the above reference.) include(CheckCSourceCompiles) +include(CheckCXXSourceCompiles) macro (CHECK_STRUCT_HAS_MEMBER _STRUCT _MEMBER _HEADER _RESULT) set(_INCLUDE_FILES) @@ -36,16 +59,29 @@ macro (CHECK_STRUCT_HAS_MEMBER _STRUCT _MEMBER _HEADER _RESULT) set(_INCLUDE_FILES "${_INCLUDE_FILES}#include <${it}>\n") endforeach () + if("x${ARGN}" STREQUAL "x") + set(_lang C) + elseif("x${ARGN}" MATCHES "^xLANGUAGE;([a-zA-Z]+)$") + set(_lang "${CMAKE_MATCH_1}") + else() + message(FATAL_ERROR "Unknown arguments:\n ${ARGN}\n") + endif() + set(_CHECK_STRUCT_MEMBER_SOURCE_CODE " ${_INCLUDE_FILES} int main() { ${_STRUCT}* tmp; tmp->${_MEMBER}; - return 0; + return 0; } ") - CHECK_C_SOURCE_COMPILES("${_CHECK_STRUCT_MEMBER_SOURCE_CODE}" ${_RESULT}) + if("${_lang}" STREQUAL "C") + CHECK_C_SOURCE_COMPILES("${_CHECK_STRUCT_MEMBER_SOURCE_CODE}" ${_RESULT}) + elseif("${_lang}" STREQUAL "CXX") + CHECK_CXX_SOURCE_COMPILES("${_CHECK_STRUCT_MEMBER_SOURCE_CODE}" ${_RESULT}) + else() + message(FATAL_ERROR "Unknown language:\n ${_lang}\nSupported languages: C, CXX.\n") + endif() endmacro () - diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake index 0969bc5..eeac4c9 100644 --- a/Modules/CheckSymbolExists.cmake +++ b/Modules/CheckSymbolExists.cmake @@ -1,26 +1,33 @@ -# - Check if a symbol exists as a function, variable, or macro +#.rst: +# CheckSymbolExists +# ----------------- +# +# Check if a symbol exists as a function, variable, or macro +# # CHECK_SYMBOL_EXISTS(<symbol> <files> <variable>) # # Check that the <symbol> is available after including given header -# <files> and store the result in a <variable>. Specify the list -# of files in one argument as a semicolon-separated list. +# <files> and store the result in a <variable>. Specify the list of +# files in one argument as a semicolon-separated list. # # If the header files define the symbol as a macro it is considered -# available and assumed to work. If the header files declare the -# symbol as a function or variable then the symbol must also be -# available for linking. If the symbol is a type or enum value -# it will not be recognized (consider using CheckTypeSize or -# CheckCSourceCompiles). -# If the check needs to be done in C++, consider using CHECK_CXX_SYMBOL_EXISTS(), -# which does the same as CHECK_SYMBOL_EXISTS(), but in C++. +# available and assumed to work. If the header files declare the symbol +# as a function or variable then the symbol must also be available for +# linking. If the symbol is a type or enum value it will not be +# recognized (consider using CheckTypeSize or CheckCSourceCompiles). If +# the check needs to be done in C++, consider using +# CHECK_CXX_SYMBOL_EXISTS(), which does the same as +# CHECK_SYMBOL_EXISTS(), but in C++. +# +# The following variables may be set before calling this macro to modify +# the way the check is run: # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2003-2011 Kitware, Inc. diff --git a/Modules/CheckTypeSize.cmake b/Modules/CheckTypeSize.cmake index 2d0eab5..0798176 100644 --- a/Modules/CheckTypeSize.cmake +++ b/Modules/CheckTypeSize.cmake @@ -1,42 +1,61 @@ -# - Check sizeof a type -# CHECK_TYPE_SIZE(TYPE VARIABLE [BUILTIN_TYPES_ONLY]) -# Check if the type exists and determine its size. -# On return, "HAVE_${VARIABLE}" holds the existence of the type, -# and "${VARIABLE}" holds one of the following: -# <size> = type has non-zero size <size> -# "0" = type has arch-dependent size (see below) -# "" = type does not exist -# Furthermore, the variable "${VARIABLE}_CODE" holds C preprocessor -# code to define the macro "${VARIABLE}" to the size of the type, or -# leave the macro undefined if the type does not exist. -# -# The variable "${VARIABLE}" may be "0" when CMAKE_OSX_ARCHITECTURES -# has multiple architectures for building OS X universal binaries. -# This indicates that the type size varies across architectures. -# In this case "${VARIABLE}_CODE" contains C preprocessor tests -# mapping from each architecture macro to the corresponding type size. -# The list of architecture macros is stored in "${VARIABLE}_KEYS", and -# the value for each key is stored in "${VARIABLE}-${KEY}". +#.rst: +# CheckTypeSize +# ------------- +# +# Check sizeof a type +# +# :: +# +# CHECK_TYPE_SIZE(TYPE VARIABLE [BUILTIN_TYPES_ONLY]) +# +# Check if the type exists and determine its size. On return, +# "HAVE_${VARIABLE}" holds the existence of the type, and "${VARIABLE}" +# holds one of the following: +# +# :: +# +# <size> = type has non-zero size <size> +# "0" = type has arch-dependent size (see below) +# "" = type does not exist +# +# Furthermore, the variable "${VARIABLE}_CODE" holds C preprocessor code +# to define the macro "${VARIABLE}" to the size of the type, or leave +# the macro undefined if the type does not exist. +# +# The variable "${VARIABLE}" may be "0" when CMAKE_OSX_ARCHITECTURES has +# multiple architectures for building OS X universal binaries. This +# indicates that the type size varies across architectures. In this +# case "${VARIABLE}_CODE" contains C preprocessor tests mapping from +# each architecture macro to the corresponding type size. The list of +# architecture macros is stored in "${VARIABLE}_KEYS", and the value for +# each key is stored in "${VARIABLE}-${KEY}". # # If the BUILTIN_TYPES_ONLY option is not given, the macro checks for # headers <sys/types.h>, <stdint.h>, and <stddef.h>, and saves results -# in HAVE_SYS_TYPES_H, HAVE_STDINT_H, and HAVE_STDDEF_H. The type -# size check automatically includes the available headers, thus -# supporting checks of types defined in the headers. +# in HAVE_SYS_TYPES_H, HAVE_STDINT_H, and HAVE_STDDEF_H. The type size +# check automatically includes the available headers, thus supporting +# checks of types defined in the headers. # -# Despite the name of the macro you may use it to check the size of -# more complex expressions, too. To check e.g. for the size of a struct +# Despite the name of the macro you may use it to check the size of more +# complex expressions, too. To check e.g. for the size of a struct # member you can do something like this: -# check_type_size("((struct something*)0)->member" SIZEOF_MEMBER) # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# :: +# +# check_type_size("((struct something*)0)->member" SIZEOF_MEMBER) +# +# +# +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_INCLUDES = list of include directories -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link -# CMAKE_EXTRA_INCLUDE_FILES = list of extra headers to include +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_INCLUDES = list of include directories +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_EXTRA_INCLUDE_FILES = list of extra headers to include #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake index a21e65f..4861ff0 100644 --- a/Modules/CheckVariableExists.cmake +++ b/Modules/CheckVariableExists.cmake @@ -1,17 +1,32 @@ -# - Check if the variable exists. -# CHECK_VARIABLE_EXISTS(VAR VARIABLE) +#.rst: +# CheckVariableExists +# ------------------- +# +# Check if the variable exists. +# +# :: +# +# CHECK_VARIABLE_EXISTS(VAR VARIABLE) +# +# +# +# :: +# +# VAR - the name of the variable +# VARIABLE - variable to store the result +# # -# VAR - the name of the variable -# VARIABLE - variable to store the result # # This macro is only for C variables. # -# The following variables may be set before calling this macro to -# modify the way the check is run: +# The following variables may be set before calling this macro to modify +# the way the check is run: +# +# :: # -# CMAKE_REQUIRED_FLAGS = string of compile command line flags -# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) -# CMAKE_REQUIRED_LIBRARIES = list of libraries to link +# CMAKE_REQUIRED_FLAGS = string of compile command line flags +# CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar) +# CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/Compiler/AppleClang-ASM.cmake b/Modules/Compiler/AppleClang-ASM.cmake new file mode 100644 index 0000000..f52bde0 --- /dev/null +++ b/Modules/Compiler/AppleClang-ASM.cmake @@ -0,0 +1 @@ +include(Compiler/Clang-ASM) diff --git a/Modules/Compiler/AppleClang-C.cmake b/Modules/Compiler/AppleClang-C.cmake new file mode 100644 index 0000000..44070b8 --- /dev/null +++ b/Modules/Compiler/AppleClang-C.cmake @@ -0,0 +1 @@ +include(Compiler/Clang-C) diff --git a/Modules/Compiler/AppleClang-CXX.cmake b/Modules/Compiler/AppleClang-CXX.cmake new file mode 100644 index 0000000..680f720 --- /dev/null +++ b/Modules/Compiler/AppleClang-CXX.cmake @@ -0,0 +1 @@ +include(Compiler/Clang-CXX) diff --git a/Modules/Compiler/Clang-CXX.cmake b/Modules/Compiler/Clang-CXX.cmake index 972d889..0372e18 100644 --- a/Modules/Compiler/Clang-CXX.cmake +++ b/Modules/Compiler/Clang-CXX.cmake @@ -1,4 +1,6 @@ include(Compiler/Clang) __compiler_clang(CXX) -set(CMAKE_CXX_COMPILE_OPTIONS_VISIBILITY_INLINES_HIDDEN "-fvisibility-inlines-hidden") +if(NOT CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC") + set(CMAKE_CXX_COMPILE_OPTIONS_VISIBILITY_INLINES_HIDDEN "-fvisibility-inlines-hidden") +endif() diff --git a/Modules/Compiler/Clang.cmake b/Modules/Compiler/Clang.cmake index ec4562a..7d7be5c 100644 --- a/Modules/Compiler/Clang.cmake +++ b/Modules/Compiler/Clang.cmake @@ -18,11 +18,17 @@ if(__COMPILER_CLANG) endif() set(__COMPILER_CLANG 1) -include(Compiler/GNU) +if(CMAKE_C_SIMULATE_ID STREQUAL "MSVC" + OR CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC") + macro(__compiler_clang lang) + endmacro() +else() + include(Compiler/GNU) -macro(__compiler_clang lang) - __compiler_gnu(${lang}) - set(CMAKE_${lang}_COMPILE_OPTIONS_PIE "-fPIE") - set(CMAKE_INCLUDE_SYSTEM_FLAG_${lang} "-isystem ") - set(CMAKE_${lang}_COMPILE_OPTIONS_VISIBILITY "-fvisibility=") -endmacro() + macro(__compiler_clang lang) + __compiler_gnu(${lang}) + set(CMAKE_${lang}_COMPILE_OPTIONS_PIE "-fPIE") + set(CMAKE_INCLUDE_SYSTEM_FLAG_${lang} "-isystem ") + set(CMAKE_${lang}_COMPILE_OPTIONS_VISIBILITY "-fvisibility=") + endmacro() +endif() diff --git a/Modules/Dart.cmake b/Modules/Dart.cmake index bd744b0..db487d8 100644 --- a/Modules/Dart.cmake +++ b/Modules/Dart.cmake @@ -1,12 +1,22 @@ -# - Configure a project for testing with CTest or old Dart Tcl Client +#.rst: +# Dart +# ---- +# +# Configure a project for testing with CTest or old Dart Tcl Client +# # This file is the backwards-compatibility version of the CTest module. # It supports using the old Dart 1 Tcl client for driving dashboard -# submissions as well as testing with CTest. This module should be included -# in the CMakeLists.txt file at the top of a project. Typical usage: -# include(Dart) -# if(BUILD_TESTING) -# # ... testing related CMake code ... -# endif() +# submissions as well as testing with CTest. This module should be +# included in the CMakeLists.txt file at the top of a project. Typical +# usage: +# +# :: +# +# include(Dart) +# if(BUILD_TESTING) +# # ... testing related CMake code ... +# endif() +# # The BUILD_TESTING option is created by the Dart module to determine # whether testing support should be enabled. The default is ON. diff --git a/Modules/DeployQt4.cmake b/Modules/DeployQt4.cmake index 5f8a9fb..9b31567 100644 --- a/Modules/DeployQt4.cmake +++ b/Modules/DeployQt4.cmake @@ -1,68 +1,99 @@ -# - Functions to help assemble a standalone Qt4 executable. -# A collection of CMake utility functions useful for deploying -# Qt4 executables. +#.rst: +# DeployQt4 +# --------- +# +# Functions to help assemble a standalone Qt4 executable. +# +# A collection of CMake utility functions useful for deploying Qt4 +# executables. # # The following functions are provided by this module: -# write_qt4_conf -# resolve_qt4_paths -# fixup_qt4_executable -# install_qt4_plugin_path -# install_qt4_plugin -# install_qt4_executable +# +# :: +# +# write_qt4_conf +# resolve_qt4_paths +# fixup_qt4_executable +# install_qt4_plugin_path +# install_qt4_plugin +# install_qt4_executable +# # Requires CMake 2.6 or greater because it uses function and -# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# +# :: +# +# WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>) # -# WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>) # Writes a qt.conf file with the <qt_conf_contents> into <qt_conf_dir>. # -# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>]) +# :: +# +# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>]) +# # Loop through <paths_var> list and if any don't exist resolve them -# relative to the <executable_path> (if supplied) or the CMAKE_INSTALL_PREFIX. +# relative to the <executable_path> (if supplied) or the +# CMAKE_INSTALL_PREFIX. +# +# :: # -# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) -# Copies Qt plugins, writes a Qt configuration file (if needed) and fixes up a -# Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. +# FIXUP_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) +# +# Copies Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. # # <executable> should point to the executable to be fixed-up. # -# <qtplugins> should contain a list of the names or paths of any Qt plugins -# to be installed. +# <qtplugins> should contain a list of the names or paths of any Qt +# plugins to be installed. # -# <libs> will be passed to BundleUtilities and should be a list of any already -# installed plugins, libraries or executables to also be fixed-up. +# <libs> will be passed to BundleUtilities and should be a list of any +# already installed plugins, libraries or executables to also be +# fixed-up. # -# <dirs> will be passed to BundleUtilities and should contain and directories -# to be searched to find library dependencies. +# <dirs> will be passed to BundleUtilities and should contain and +# directories to be searched to find library dependencies. # # <plugins_dir> allows an custom plugins directory to be used. # -# <request_qt_conf> will force a qt.conf file to be written even if not needed. +# <request_qt_conf> will force a qt.conf file to be written even if not +# needed. +# +# :: +# +# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>) # -# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var <plugins_dir> <component> <configurations>) # Install (or copy) a resolved <plugin> to the default plugins directory # (or <plugins_dir>) relative to <executable> and store the result in # <installed_plugin_path_var>. # # If <copy> is set to TRUE then the plugins will be copied rather than -# installed. This is to allow this module to be used at CMake time rather than -# install time. +# installed. This is to allow this module to be used at CMake time +# rather than install time. # # If <component> is set then anything installed will use this COMPONENT. # -# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>) -# Install (or copy) an unresolved <plugin> to the default plugins directory -# (or <plugins_dir>) relative to <executable> and store the result in -# <installed_plugin_path_var>. See documentation of INSTALL_QT4_PLUGIN_PATH. -# -# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) -# Installs Qt plugins, writes a Qt configuration file (if needed) and fixes up -# a Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. The executable will be fixed-up at install time. -# <component> is the COMPONENT used for bundle fixup and plugin installation. -# See documentation of FIXUP_QT4_BUNDLE. +# :: +# +# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var <plugins_dir> <component>) +# +# Install (or copy) an unresolved <plugin> to the default plugins +# directory (or <plugins_dir>) relative to <executable> and store the +# result in <installed_plugin_path_var>. See documentation of +# INSTALL_QT4_PLUGIN_PATH. +# +# :: +# +# INSTALL_QT4_EXECUTABLE(<executable> [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) +# +# Installs Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. The executable will be fixed-up +# at install time. <component> is the COMPONENT used for bundle fixup +# and plugin installation. See documentation of FIXUP_QT4_BUNDLE. #============================================================================= # Copyright 2011 Mike McQuaid <mike@mikemcquaid.com> diff --git a/Modules/Documentation.cmake b/Modules/Documentation.cmake index d1c3afe..be6aaea 100644 --- a/Modules/Documentation.cmake +++ b/Modules/Documentation.cmake @@ -1,6 +1,11 @@ -# - DocumentationVTK.cmake -# This file provides support for the VTK documentation framework. -# It relies on several tools (Doxygen, Perl, etc). +#.rst: +# Documentation +# ------------- +# +# DocumentationVTK.cmake +# +# This file provides support for the VTK documentation framework. It +# relies on several tools (Doxygen, Perl, etc). #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/ExternalData.cmake b/Modules/ExternalData.cmake index 50669bd..86a42ae 100644 --- a/Modules/ExternalData.cmake +++ b/Modules/ExternalData.cmake @@ -1,146 +1,194 @@ -# - Manage data files stored outside source tree -# Use this module to unambiguously reference data files stored outside the -# source tree and fetch them at build time from arbitrary local and remote -# content-addressed locations. Functions provided by this module recognize -# arguments with the syntax "DATA{<name>}" as references to external data, -# replace them with full paths to local copies of those data, and create build -# rules to fetch and update the local copies. +#.rst: +# ExternalData +# ------------ +# +# Manage data files stored outside source tree +# +# Use this module to unambiguously reference data files stored outside +# the source tree and fetch them at build time from arbitrary local and +# remote content-addressed locations. Functions provided by this module +# recognize arguments with the syntax "DATA{<name>}" as references to +# external data, replace them with full paths to local copies of those +# data, and create build rules to fetch and update the local copies. # # The DATA{} syntax is literal and the <name> is a full or relative path -# within the source tree. The source tree must contain either a real data -# file at <name> or a "content link" at <name><ext> containing a hash of the -# real file using a hash algorithm corresponding to <ext>. For example, the -# argument "DATA{img.png}" may be satisfied by either a real "img.png" file in -# the current source directory or a "img.png.md5" file containing its MD5 sum. -# -# The 'ExternalData_Expand_Arguments' function evaluates DATA{} references -# in its arguments and constructs a new list of arguments: -# ExternalData_Expand_Arguments( -# <target> # Name of data management target -# <outVar> # Output variable -# [args...] # Input arguments, DATA{} allowed -# ) -# It replaces each DATA{} reference in an argument with the full path of a -# real data file on disk that will exist after the <target> builds. +# within the source tree. The source tree must contain either a real +# data file at <name> or a "content link" at <name><ext> containing a +# hash of the real file using a hash algorithm corresponding to <ext>. +# For example, the argument "DATA{img.png}" may be satisfied by either a +# real "img.png" file in the current source directory or a "img.png.md5" +# file containing its MD5 sum. +# +# The 'ExternalData_Expand_Arguments' function evaluates DATA{} +# references in its arguments and constructs a new list of arguments: +# +# :: +# +# ExternalData_Expand_Arguments( +# <target> # Name of data management target +# <outVar> # Output variable +# [args...] # Input arguments, DATA{} allowed +# ) +# +# It replaces each DATA{} reference in an argument with the full path of +# a real data file on disk that will exist after the <target> builds. # # The 'ExternalData_Add_Test' function wraps around the CMake add_test() # command but supports DATA{} references in its arguments: -# ExternalData_Add_Test( -# <target> # Name of data management target -# ... # Arguments of add_test(), DATA{} allowed -# ) +# +# :: +# +# ExternalData_Add_Test( +# <target> # Name of data management target +# ... # Arguments of add_test(), DATA{} allowed +# ) +# # It passes its arguments through ExternalData_Expand_Arguments and then # invokes add_test() using the results. # -# The 'ExternalData_Add_Target' function creates a custom target to manage -# local instances of data files stored externally: -# ExternalData_Add_Target( -# <target> # Name of data management target -# ) -# It creates custom commands in the target as necessary to make data files -# available for each DATA{} reference previously evaluated by other functions -# provided by this module. A list of URL templates must be provided in the -# variable ExternalData_URL_TEMPLATES using the placeholders "%(algo)" and -# "%(hash)" in each template. Data fetch rules try each URL template in order -# by substituting the hash algorithm name for "%(algo)" and the hash value for -# "%(hash)". +# The 'ExternalData_Add_Target' function creates a custom target to +# manage local instances of data files stored externally: +# +# :: +# +# ExternalData_Add_Target( +# <target> # Name of data management target +# ) +# +# It creates custom commands in the target as necessary to make data +# files available for each DATA{} reference previously evaluated by +# other functions provided by this module. A list of URL templates must +# be provided in the variable ExternalData_URL_TEMPLATES using the +# placeholders "%(algo)" and "%(hash)" in each template. Data fetch +# rules try each URL template in order by substituting the hash +# algorithm name for "%(algo)" and the hash value for "%(hash)". # # The following hash algorithms are supported: -# %(algo) <ext> Description -# ------- ----- ----------- -# MD5 .md5 Message-Digest Algorithm 5, RFC 1321 -# SHA1 .sha1 US Secure Hash Algorithm 1, RFC 3174 -# SHA224 .sha224 US Secure Hash Algorithms, RFC 4634 -# SHA256 .sha256 US Secure Hash Algorithms, RFC 4634 -# SHA384 .sha384 US Secure Hash Algorithms, RFC 4634 -# SHA512 .sha512 US Secure Hash Algorithms, RFC 4634 +# +# :: +# +# %(algo) <ext> Description +# ------- ----- ----------- +# MD5 .md5 Message-Digest Algorithm 5, RFC 1321 +# SHA1 .sha1 US Secure Hash Algorithm 1, RFC 3174 +# SHA224 .sha224 US Secure Hash Algorithms, RFC 4634 +# SHA256 .sha256 US Secure Hash Algorithms, RFC 4634 +# SHA384 .sha384 US Secure Hash Algorithms, RFC 4634 +# SHA512 .sha512 US Secure Hash Algorithms, RFC 4634 +# # Note that the hashes are used only for unique data identification and # download verification. This is not security software. # # Example usage: -# include(ExternalData) -# set(ExternalData_URL_TEMPLATES "file:///local/%(algo)/%(hash)" -# "http://data.org/%(algo)/%(hash)") -# ExternalData_Add_Test(MyData -# NAME MyTest -# COMMAND MyExe DATA{MyInput.png} -# ) -# ExternalData_Add_Target(MyData) -# When test "MyTest" runs the "DATA{MyInput.png}" argument will be replaced by -# the full path to a real instance of the data file "MyInput.png" on disk. If -# the source tree contains a content link such as "MyInput.png.md5" then the -# "MyData" target creates a real "MyInput.png" in the build tree. +# +# :: +# +# include(ExternalData) +# set(ExternalData_URL_TEMPLATES "file:///local/%(algo)/%(hash)" +# "http://data.org/%(algo)/%(hash)") +# ExternalData_Add_Test(MyData +# NAME MyTest +# COMMAND MyExe DATA{MyInput.png} +# ) +# ExternalData_Add_Target(MyData) +# +# When test "MyTest" runs the "DATA{MyInput.png}" argument will be +# replaced by the full path to a real instance of the data file +# "MyInput.png" on disk. If the source tree contains a content link +# such as "MyInput.png.md5" then the "MyData" target creates a real +# "MyInput.png" in the build tree. # # The DATA{} syntax can be told to fetch a file series using the form -# "DATA{<name>,:}", where the ":" is literal. If the source tree contains a -# group of files or content links named like a series then a reference to one -# member adds rules to fetch all of them. Although all members of a series -# are fetched, only the file originally named by the DATA{} argument is -# substituted for it. The default configuration recognizes file series names -# ending with "#.ext", "_#.ext", ".#.ext", or "-#.ext" where "#" is a sequence -# of decimal digits and ".ext" is any single extension. Configure it with a -# regex that parses <number> and <suffix> parts from the end of <name>: -# ExternalData_SERIES_PARSE = regex of the form (<number>)(<suffix>)$ +# "DATA{<name>,:}", where the ":" is literal. If the source tree +# contains a group of files or content links named like a series then a +# reference to one member adds rules to fetch all of them. Although all +# members of a series are fetched, only the file originally named by the +# DATA{} argument is substituted for it. The default configuration +# recognizes file series names ending with "#.ext", "_#.ext", ".#.ext", +# or "-#.ext" where "#" is a sequence of decimal digits and ".ext" is +# any single extension. Configure it with a regex that parses <number> +# and <suffix> parts from the end of <name>: +# +# :: +# +# ExternalData_SERIES_PARSE = regex of the form (<number>)(<suffix>)$ +# # For more complicated cases set: -# ExternalData_SERIES_PARSE = regex with at least two () groups -# ExternalData_SERIES_PARSE_PREFIX = <prefix> regex group number, if any -# ExternalData_SERIES_PARSE_NUMBER = <number> regex group number -# ExternalData_SERIES_PARSE_SUFFIX = <suffix> regex group number +# +# :: +# +# ExternalData_SERIES_PARSE = regex with at least two () groups +# ExternalData_SERIES_PARSE_PREFIX = <prefix> regex group number, if any +# ExternalData_SERIES_PARSE_NUMBER = <number> regex group number +# ExternalData_SERIES_PARSE_SUFFIX = <suffix> regex group number +# # Configure series number matching with a regex that matches the # <number> part of series members named <prefix><number><suffix>: -# ExternalData_SERIES_MATCH = regex matching <number> in all series members +# +# :: +# +# ExternalData_SERIES_MATCH = regex matching <number> in all series members +# # Note that the <suffix> of a series does not include a hash-algorithm # extension. # -# The DATA{} syntax can alternatively match files associated with the named -# file and contained in the same directory. Associated files may be specified -# by options using the syntax DATA{<name>,<opt1>,<opt2>,...}. Each option may -# specify one file by name or specify a regular expression to match file names -# using the syntax REGEX:<regex>. For example, the arguments -# DATA{MyData/MyInput.mhd,MyInput.img} # File pair -# DATA{MyData/MyFrames00.png,REGEX:MyFrames[0-9]+\\.png} # Series -# will pass MyInput.mha and MyFrames00.png on the command line but ensure -# that the associated files are present next to them. -# -# The DATA{} syntax may reference a directory using a trailing slash and a -# list of associated files. The form DATA{<name>/,<opt1>,<opt2>,...} adds -# rules to fetch any files in the directory that match one of the associated -# file options. For example, the argument DATA{MyDataDir/,REGEX:.*} will pass -# the full path to a MyDataDir directory on the command line and ensure that -# the directory contains files corresponding to every file or content link in -# the MyDataDir source directory. -# -# The variable ExternalData_LINK_CONTENT may be set to the name of a supported -# hash algorithm to enable automatic conversion of real data files referenced -# by the DATA{} syntax into content links. For each such <file> a content -# link named "<file><ext>" is created. The original file is renamed to the -# form ".ExternalData_<algo>_<hash>" to stage it for future transmission to -# one of the locations in the list of URL templates (by means outside the -# scope of this module). The data fetch rule created for the content link -# will use the staged object if it cannot be found using any URL template. +# The DATA{} syntax can alternatively match files associated with the +# named file and contained in the same directory. Associated files may +# be specified by options using the syntax +# DATA{<name>,<opt1>,<opt2>,...}. Each option may specify one file by +# name or specify a regular expression to match file names using the +# syntax REGEX:<regex>. For example, the arguments +# +# :: +# +# DATA{MyData/MyInput.mhd,MyInput.img} # File pair +# DATA{MyData/MyFrames00.png,REGEX:MyFrames[0-9]+\\.png} # Series +# +# will pass MyInput.mha and MyFrames00.png on the command line but +# ensure that the associated files are present next to them. +# +# The DATA{} syntax may reference a directory using a trailing slash and +# a list of associated files. The form DATA{<name>/,<opt1>,<opt2>,...} +# adds rules to fetch any files in the directory that match one of the +# associated file options. For example, the argument +# DATA{MyDataDir/,REGEX:.*} will pass the full path to a MyDataDir +# directory on the command line and ensure that the directory contains +# files corresponding to every file or content link in the MyDataDir +# source directory. +# +# The variable ExternalData_LINK_CONTENT may be set to the name of a +# supported hash algorithm to enable automatic conversion of real data +# files referenced by the DATA{} syntax into content links. For each +# such <file> a content link named "<file><ext>" is created. The +# original file is renamed to the form ".ExternalData_<algo>_<hash>" to +# stage it for future transmission to one of the locations in the list +# of URL templates (by means outside the scope of this module). The +# data fetch rule created for the content link will use the staged +# object if it cannot be found using any URL template. # # The variable ExternalData_OBJECT_STORES may be set to a list of local # directories that store objects using the layout <dir>/%(algo)/%(hash). -# These directories will be searched first for a needed object. If the object -# is not available in any store then it will be fetched remotely using the URL -# templates and added to the first local store listed. If no stores are -# specified the default is a location inside the build tree. +# These directories will be searched first for a needed object. If the +# object is not available in any store then it will be fetched remotely +# using the URL templates and added to the first local store listed. If +# no stores are specified the default is a location inside the build +# tree. # # The variable ExternalData_SOURCE_ROOT may be set to the highest source -# directory containing any path named by a DATA{} reference. The default is -# CMAKE_SOURCE_DIR. ExternalData_SOURCE_ROOT and CMAKE_SOURCE_DIR must refer -# to directories within a single source distribution (e.g. they come together -# in one tarball). -# -# The variable ExternalData_BINARY_ROOT may be set to the directory to hold -# the real data files named by expanded DATA{} references. The default is -# CMAKE_BINARY_DIR. The directory layout will mirror that of content links -# under ExternalData_SOURCE_ROOT. -# -# Variables ExternalData_TIMEOUT_INACTIVITY and ExternalData_TIMEOUT_ABSOLUTE -# set the download inactivity and absolute timeouts, in seconds. The defaults -# are 60 seconds and 300 seconds, respectively. Set either timeout to 0 -# seconds to disable enforcement. +# directory containing any path named by a DATA{} reference. The +# default is CMAKE_SOURCE_DIR. ExternalData_SOURCE_ROOT and +# CMAKE_SOURCE_DIR must refer to directories within a single source +# distribution (e.g. they come together in one tarball). +# +# The variable ExternalData_BINARY_ROOT may be set to the directory to +# hold the real data files named by expanded DATA{} references. The +# default is CMAKE_BINARY_DIR. The directory layout will mirror that of +# content links under ExternalData_SOURCE_ROOT. +# +# Variables ExternalData_TIMEOUT_INACTIVITY and +# ExternalData_TIMEOUT_ABSOLUTE set the download inactivity and absolute +# timeouts, in seconds. The defaults are 60 seconds and 300 seconds, +# respectively. Set either timeout to 0 seconds to disable enforcement. #============================================================================= # Copyright 2010-2013 Kitware, Inc. diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 0781ea1..84fa613 100644 --- a/Modules/ExternalProject.cmake +++ b/Modules/ExternalProject.cmake @@ -1,7 +1,15 @@ -# - Create custom targets to build projects in external trees +#.rst: +# ExternalProject +# --------------- +# +# Create custom targets to build projects in external trees +# # The 'ExternalProject_Add' function creates a custom target to drive # download, update/patch, configure, build, install and test steps of an # external project: +# +# :: +# # ExternalProject_Add(<name> # Name for custom target # [DEPENDS projects...] # Targets on which the project depends # [PREFIX dir] # Root dir for entire project @@ -62,40 +70,49 @@ # #--Custom targets------------- # [STEP_TARGETS st1 st2 ...] # Generate custom targets for these steps # ) -# The *_DIR options specify directories for the project, with default -# directories computed as follows. -# If the PREFIX option is given to ExternalProject_Add() or the EP_PREFIX -# directory property is set, then an external project is built and installed -# under the specified prefix: -# TMP_DIR = <prefix>/tmp -# STAMP_DIR = <prefix>/src/<name>-stamp -# DOWNLOAD_DIR = <prefix>/src -# SOURCE_DIR = <prefix>/src/<name> -# BINARY_DIR = <prefix>/src/<name>-build -# INSTALL_DIR = <prefix> -# Otherwise, if the EP_BASE directory property is set then components -# of an external project are stored under the specified base: -# TMP_DIR = <base>/tmp/<name> -# STAMP_DIR = <base>/Stamp/<name> -# DOWNLOAD_DIR = <base>/Download/<name> -# SOURCE_DIR = <base>/Source/<name> -# BINARY_DIR = <base>/Build/<name> -# INSTALL_DIR = <base>/Install/<name> -# If no PREFIX, EP_PREFIX, or EP_BASE is specified then the default -# is to set PREFIX to "<name>-prefix". -# Relative paths are interpreted with respect to the build directory -# corresponding to the source directory in which ExternalProject_Add is -# invoked. +# +# The ``*_DIR`` options specify directories for the project, with default +# directories computed as follows. If the PREFIX option is given to +# ExternalProject_Add() or the EP_PREFIX directory property is set, then +# an external project is built and installed under the specified prefix: +# +# :: +# +# TMP_DIR = <prefix>/tmp +# STAMP_DIR = <prefix>/src/<name>-stamp +# DOWNLOAD_DIR = <prefix>/src +# SOURCE_DIR = <prefix>/src/<name> +# BINARY_DIR = <prefix>/src/<name>-build +# INSTALL_DIR = <prefix> +# +# Otherwise, if the EP_BASE directory property is set then components of +# an external project are stored under the specified base: +# +# :: +# +# TMP_DIR = <base>/tmp/<name> +# STAMP_DIR = <base>/Stamp/<name> +# DOWNLOAD_DIR = <base>/Download/<name> +# SOURCE_DIR = <base>/Source/<name> +# BINARY_DIR = <base>/Build/<name> +# INSTALL_DIR = <base>/Install/<name> +# +# If no PREFIX, EP_PREFIX, or EP_BASE is specified then the default is +# to set PREFIX to "<name>-prefix". Relative paths are interpreted with +# respect to the build directory corresponding to the source directory +# in which ExternalProject_Add is invoked. # # If SOURCE_DIR is explicitly set to an existing directory the project -# will be built from it. -# Otherwise a download step must be specified using one of the -# DOWNLOAD_COMMAND, CVS_*, SVN_*, or URL options. -# The URL option may refer locally to a directory or source tarball, -# or refer to a remote tarball (e.g. http://.../src.tgz). +# will be built from it. Otherwise a download step must be specified +# using one of the DOWNLOAD_COMMAND, CVS_*, SVN_*, or URL options. The +# URL option may refer locally to a directory or source tarball, or +# refer to a remote tarball (e.g. http://.../src.tgz). +# +# The 'ExternalProject_Add_Step' function adds a custom step to an +# external project: +# +# :: # -# The 'ExternalProject_Add_Step' function adds a custom step to an external -# project: # ExternalProject_Add_Step(<name> <step> # Names of project and custom step # [COMMAND cmd...] # Command line invoked by this step # [COMMENT "text..."] # Text printed when step executes @@ -106,58 +123,70 @@ # [WORKING_DIRECTORY dir] # Working directory for command # [LOG 1] # Wrap step in script to log output # ) -# The command line, comment, and working directory of every standard -# and custom step is processed to replace tokens -# <SOURCE_DIR>, -# <BINARY_DIR>, -# <INSTALL_DIR>, -# and <TMP_DIR> -# with corresponding property values. +# +# The command line, comment, and working directory of every standard and +# custom step is processed to replace tokens <SOURCE_DIR>, <BINARY_DIR>, +# <INSTALL_DIR>, and <TMP_DIR> with corresponding property values. # # Any builtin step that specifies a "<step>_COMMAND cmd..." or custom # step that specifies a "COMMAND cmd..." may specify additional command -# lines using the form "COMMAND cmd...". At build time the commands will -# be executed in order and aborted if any one fails. For example: -# ... BUILD_COMMAND make COMMAND echo done ... +# lines using the form "COMMAND cmd...". At build time the commands +# will be executed in order and aborted if any one fails. For example: +# +# :: +# +# ... BUILD_COMMAND make COMMAND echo done ... +# # specifies to run "make" and then "echo done" during the build step. -# Whether the current working directory is preserved between commands -# is not defined. Behavior of shell operators like "&&" is not defined. +# Whether the current working directory is preserved between commands is +# not defined. Behavior of shell operators like "&&" is not defined. # # The 'ExternalProject_Get_Property' function retrieves external project # target properties: -# ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]]) -# It stores property values in variables of the same name. -# Property names correspond to the keyword argument names of +# +# :: +# +# ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]]) +# +# It stores property values in variables of the same name. Property +# names correspond to the keyword argument names of # 'ExternalProject_Add'. # -# The 'ExternalProject_Add_StepTargets' function generates custom targets for -# the steps listed: -# ExternalProject_Add_StepTargets(<name> [step1 [step2 [...]]]) +# The 'ExternalProject_Add_StepTargets' function generates custom +# targets for the steps listed: +# +# :: +# +# ExternalProject_Add_StepTargets(<name> [step1 [step2 [...]]]) # -# If STEP_TARGETS is set then ExternalProject_Add_StepTargets is automatically -# called at the end of matching calls to ExternalProject_Add_Step. Pass -# STEP_TARGETS explicitly to individual ExternalProject_Add calls, or -# implicitly to all ExternalProject_Add calls by setting the directory property -# EP_STEP_TARGETS. +# +# +# If STEP_TARGETS is set then ExternalProject_Add_StepTargets is +# automatically called at the end of matching calls to +# ExternalProject_Add_Step. Pass STEP_TARGETS explicitly to individual +# ExternalProject_Add calls, or implicitly to all ExternalProject_Add +# calls by setting the directory property EP_STEP_TARGETS. # # If STEP_TARGETS is not set, clients may still manually call # ExternalProject_Add_StepTargets after calling ExternalProject_Add or # ExternalProject_Add_Step. # # This functionality is provided to make it easy to drive the steps -# independently of each other by specifying targets on build command lines. -# For example, you may be submitting to a sub-project based dashboard, where -# you want to drive the configure portion of the build, then submit to the -# dashboard, followed by the build portion, followed by tests. If you invoke -# a custom target that depends on a step halfway through the step dependency -# chain, then all the previous steps will also run to ensure everything is -# up to date. +# independently of each other by specifying targets on build command +# lines. For example, you may be submitting to a sub-project based +# dashboard, where you want to drive the configure portion of the build, +# then submit to the dashboard, followed by the build portion, followed +# by tests. If you invoke a custom target that depends on a step +# halfway through the step dependency chain, then all the previous steps +# will also run to ensure everything is up to date. +# +# For example, to drive configure, build and test steps independently +# for each ExternalProject_Add call in your project, write the following +# line prior to any ExternalProject_Add calls in your CMakeLists file: # -# For example, to drive configure, build and test steps independently for each -# ExternalProject_Add call in your project, write the following line prior to -# any ExternalProject_Add calls in your CMakeLists file: +# :: # -# set_property(DIRECTORY PROPERTY EP_STEP_TARGETS configure build test) +# set_property(DIRECTORY PROPERTY EP_STEP_TARGETS configure build test) #============================================================================= # Copyright 2008-2012 Kitware, Inc. diff --git a/Modules/FeatureSummary.cmake b/Modules/FeatureSummary.cmake index 5d98ac3..b0f8e16 100644 --- a/Modules/FeatureSummary.cmake +++ b/Modules/FeatureSummary.cmake @@ -1,167 +1,244 @@ -# - Macros for generating a summary of enabled/disabled features +#.rst: +# FeatureSummary +# -------------- # -# This module provides the macros feature_summary(), set_package_properties() and -# add_feature_info(). -# For compatibility it also still provides set_package_info(), set_feature_info(), +# Macros for generating a summary of enabled/disabled features +# +# +# +# This module provides the macros feature_summary(), +# set_package_properties() and add_feature_info(). For compatibility it +# also still provides set_package_info(), set_feature_info(), # print_enabled_features() and print_disabled_features(). # # These macros can be used to generate a summary of enabled and disabled # packages and/or feature for a build tree: # -# -- The following OPTIONAL packages have been found: -# LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org> -# * Enables HTML-import in MyWordProcessor -# * Enables odt-export in MyWordProcessor -# PNG , A PNG image library. , <http://www.libpng.org/pub/png/> -# * Enables saving screenshots -# -- The following OPTIONAL packages have not been found: -# Lua51 , The Lua scripting language. , <http://www.lua.org> -# * Enables macros in MyWordProcessor -# Foo , Foo provides cool stuff. -# -# -# FEATURE_SUMMARY( [FILENAME <file>] -# [APPEND] -# [VAR <variable_name>] -# [INCLUDE_QUIET_PACKAGES] -# [FATAL_ON_MISSING_REQUIRED_PACKAGES] -# [DESCRIPTION "Found packages:"] -# WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND -# | ENABLED_FEATURES | DISABLED_FEATURES] -# ) -# -# The FEATURE_SUMMARY() macro can be used to print information about enabled -# or disabled packages or features of a project. -# By default, only the names of the features/packages will be printed and their -# required version when one was specified. Use SET_PACKAGE_PROPERTIES() to add more -# useful information, like e.g. a download URL for the respective package or their -# purpose in the project. -# -# The WHAT option is the only mandatory option. Here you specify what information -# will be printed: -# ALL: print everything -# ENABLED_FEATURES: the list of all features which are enabled -# DISABLED_FEATURES: the list of all features which are disabled -# PACKAGES_FOUND: the list of all packages which have been found -# PACKAGES_NOT_FOUND: the list of all packages which have not been found -# OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL -# OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL -# RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED -# RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED -# REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED -# REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED -# RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME -# RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME -# -# If a FILENAME is given, the information is printed into this file. If APPEND -# is used, it is appended to this file, otherwise the file is overwritten if -# it already existed. -# If the VAR option is used, the information is "printed" into the specified -# variable. -# If FILENAME is not used, the information is printed to the terminal. -# Using the DESCRIPTION option a description or headline can be set which will -# be printed above the actual content. -# If INCLUDE_QUIET_PACKAGES is given, packages which have been searched with find_package(... QUIET) will -# also be listed. By default they are skipped. -# If FATAL_ON_MISSING_REQUIRED_PACKAGES is given, CMake will abort if a package which is marked as REQUIRED -# has not been found. +# :: +# +# -- The following OPTIONAL packages have been found: +# LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org> +# * Enables HTML-import in MyWordProcessor +# * Enables odt-export in MyWordProcessor +# PNG , A PNG image library. , <http://www.libpng.org/pub/png/> +# * Enables saving screenshots +# -- The following OPTIONAL packages have not been found: +# Lua51 , The Lua scripting language. , <http://www.lua.org> +# * Enables macros in MyWordProcessor +# Foo , Foo provides cool stuff. +# +# +# +# +# +# :: +# +# FEATURE_SUMMARY( [FILENAME <file>] +# [APPEND] +# [VAR <variable_name>] +# [INCLUDE_QUIET_PACKAGES] +# [FATAL_ON_MISSING_REQUIRED_PACKAGES] +# [DESCRIPTION "Found packages:"] +# WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND +# | ENABLED_FEATURES | DISABLED_FEATURES] +# ) +# +# +# +# The FEATURE_SUMMARY() macro can be used to print information about +# enabled or disabled packages or features of a project. By default, +# only the names of the features/packages will be printed and their +# required version when one was specified. Use SET_PACKAGE_PROPERTIES() +# to add more useful information, like e.g. a download URL for the +# respective package or their purpose in the project. +# +# The WHAT option is the only mandatory option. Here you specify what +# information will be printed: +# +# :: +# +# ALL: print everything +# ENABLED_FEATURES: the list of all features which are enabled +# DISABLED_FEATURES: the list of all features which are disabled +# PACKAGES_FOUND: the list of all packages which have been found +# PACKAGES_NOT_FOUND: the list of all packages which have not been found +# OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL +# OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL +# RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED +# RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED +# REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED +# REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED +# RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME +# RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME +# +# +# +# If a FILENAME is given, the information is printed into this file. If +# APPEND is used, it is appended to this file, otherwise the file is +# overwritten if it already existed. If the VAR option is used, the +# information is "printed" into the specified variable. If FILENAME is +# not used, the information is printed to the terminal. Using the +# DESCRIPTION option a description or headline can be set which will be +# printed above the actual content. If INCLUDE_QUIET_PACKAGES is given, +# packages which have been searched with find_package(... QUIET) will +# also be listed. By default they are skipped. If +# FATAL_ON_MISSING_REQUIRED_PACKAGES is given, CMake will abort if a +# package which is marked as REQUIRED has not been found. # # Example 1, append everything to a file: -# feature_summary(WHAT ALL -# FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND) -# -# Example 2, print the enabled features into the variable enabledFeaturesText, including QUIET packages: -# feature_summary(WHAT ENABLED_FEATURES -# INCLUDE_QUIET_PACKAGES -# DESCRIPTION "Enabled Features:" -# VAR enabledFeaturesText) -# message(STATUS "${enabledFeaturesText}") -# -# -# SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ] -# [ DESCRIPTION <description> ] -# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ] -# [ PURPOSE <purpose> ] -# ) -# -# Use this macro to set up information about the named package, which can -# then be displayed via FEATURE_SUMMARY(). -# This can be done either directly in the Find-module or in the project -# which uses the module after the find_package() call. -# The features for which information can be set are added automatically by the -# find_package() command. -# -# URL: this should be the homepage of the package, or something similar. Ideally this is set -# already directly in the Find-module. -# -# DESCRIPTION: A short description what that package is, at most one sentence. +# +# :: +# +# feature_summary(WHAT ALL +# FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND) +# +# +# +# Example 2, print the enabled features into the variable +# enabledFeaturesText, including QUIET packages: +# +# :: +# +# feature_summary(WHAT ENABLED_FEATURES +# INCLUDE_QUIET_PACKAGES +# DESCRIPTION "Enabled Features:" +# VAR enabledFeaturesText) +# message(STATUS "${enabledFeaturesText}") +# +# +# +# +# +# :: +# +# SET_PACKAGE_PROPERTIES(<name> PROPERTIES [ URL <url> ] +# [ DESCRIPTION <description> ] +# [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ] +# [ PURPOSE <purpose> ] +# ) +# +# +# +# Use this macro to set up information about the named package, which +# can then be displayed via FEATURE_SUMMARY(). This can be done either +# directly in the Find-module or in the project which uses the module +# after the find_package() call. The features for which information can +# be set are added automatically by the find_package() command. +# +# URL: this should be the homepage of the package, or something similar. # Ideally this is set already directly in the Find-module. # -# TYPE: What type of dependency has the using project on that package. Default is OPTIONAL. -# In this case it is a package which can be used by the project when available at buildtime, -# but it also work without. RECOMMENDED is similar to OPTIONAL, i.e. the project will build -# if the package is not present, but the functionality of the resulting binaries will be severly -# limited. If a REQUIRED package is not available at buildtime, the project may not even build. This -# can be combined with the FATAL_ON_MISSING_REQUIRED_PACKAGES argument for feature_summary(). -# Last, a RUNTIME package is a package which is actually not used at all during the build, but -# which is required for actually running the resulting binaries. So if such a package is missing, -# the project can still be built, but it may not work later on. If set_package_properties() is called -# multiple times for the same package with different TYPEs, the TYPE is only changed to higher -# TYPEs ( RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED ), lower TYPEs are ignored. -# The TYPE property is project-specific, so it cannot be set by the Find-module, but must be set in the project. -# -# PURPOSE: This describes which features this package enables in the project, i.e. it tells the user -# what functionality he gets in the resulting binaries. -# If set_package_properties() is called multiple times for a package, all PURPOSE properties are appended -# to a list of purposes of the package in the project. -# As the TYPE property, also the PURPOSE property -# is project-specific, so it cannot be set by the Find-module, but must be set in the project. +# DESCRIPTION: A short description what that package is, at most one +# sentence. Ideally this is set already directly in the Find-module. +# +# TYPE: What type of dependency has the using project on that package. +# Default is OPTIONAL. In this case it is a package which can be used +# by the project when available at buildtime, but it also work without. +# RECOMMENDED is similar to OPTIONAL, i.e. the project will build if +# the package is not present, but the functionality of the resulting +# binaries will be severly limited. If a REQUIRED package is not +# available at buildtime, the project may not even build. This can be +# combined with the FATAL_ON_MISSING_REQUIRED_PACKAGES argument for +# feature_summary(). Last, a RUNTIME package is a package which is +# actually not used at all during the build, but which is required for +# actually running the resulting binaries. So if such a package is +# missing, the project can still be built, but it may not work later on. +# If set_package_properties() is called multiple times for the same +# package with different TYPEs, the TYPE is only changed to higher TYPEs +# ( RUNTIME < OPTIONAL < RECOMMENDED < REQUIRED ), lower TYPEs are +# ignored. The TYPE property is project-specific, so it cannot be set +# by the Find-module, but must be set in the project. +# +# PURPOSE: This describes which features this package enables in the +# project, i.e. it tells the user what functionality he gets in the +# resulting binaries. If set_package_properties() is called multiple +# times for a package, all PURPOSE properties are appended to a list of +# purposes of the package in the project. As the TYPE property, also +# the PURPOSE property is project-specific, so it cannot be set by the +# Find-module, but must be set in the project. +# # # # Example for setting the info for a package: -# find_package(LibXml2) -# set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library." -# URL "http://xmlsoft.org/") -# -# set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED -# PURPOSE "Enables HTML-import in MyWordProcessor") -# ... -# set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL -# PURPOSE "Enables odt-export in MyWordProcessor") -# -# find_package(DBUS) -# set_package_properties(DBUS PROPERTIES TYPE RUNTIME -# PURPOSE "Necessary to disable the screensaver during a presentation" ) -# -# ADD_FEATURE_INFO(<name> <enabled> <description>) -# Use this macro to add information about a feature with the given <name>. -# <enabled> contains whether this feature is enabled or not, <description> -# is a text describing the feature. -# The information can be displayed using feature_summary() for ENABLED_FEATURES -# and DISABLED_FEATURES respectively. +# +# :: +# +# find_package(LibXml2) +# set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library." +# URL "http://xmlsoft.org/") +# +# +# +# :: +# +# set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED +# PURPOSE "Enables HTML-import in MyWordProcessor") +# ... +# set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL +# PURPOSE "Enables odt-export in MyWordProcessor") +# +# +# +# :: +# +# find_package(DBUS) +# set_package_properties(DBUS PROPERTIES TYPE RUNTIME +# PURPOSE "Necessary to disable the screensaver during a presentation" ) +# +# +# +# :: +# +# ADD_FEATURE_INFO(<name> <enabled> <description>) +# +# Use this macro to add information about a feature with the given +# <name>. <enabled> contains whether this feature is enabled or not, +# <description> is a text describing the feature. The information can +# be displayed using feature_summary() for ENABLED_FEATURES and +# DISABLED_FEATURES respectively. # # Example for setting the info for a feature: -# option(WITH_FOO "Help for foo" ON) -# add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.") # +# :: +# +# option(WITH_FOO "Help for foo" ON) +# add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.") +# +# +# +# +# +# The following macros are provided for compatibility with previous +# CMake versions: +# +# :: +# +# SET_PACKAGE_INFO(<name> <description> [<url> [<purpose>] ] ) +# +# Use this macro to set up information about the named package, which +# can then be displayed via FEATURE_SUMMARY(). This can be done either +# directly in the Find-module or in the project which uses the module +# after the find_package() call. The features for which information can +# be set are added automatically by the find_package() command. +# +# :: +# +# PRINT_ENABLED_FEATURES() +# +# Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION +# "Enabled features:") +# +# :: # -# The following macros are provided for compatibility with previous CMake versions: +# PRINT_DISABLED_FEATURES() # -# SET_PACKAGE_INFO(<name> <description> [<url> [<purpose>] ] ) -# Use this macro to set up information about the named package, which can -# then be displayed via FEATURE_SUMMARY(). -# This can be done either directly in the Find-module or in the project -# which uses the module after the find_package() call. -# The features for which information can be set are added automatically by the -# find_package() command. +# Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION +# "Disabled features:") # -# PRINT_ENABLED_FEATURES() -# Does the same as FEATURE_SUMMARY(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:") +# :: # -# PRINT_DISABLED_FEATURES() -# Does the same as FEATURE_SUMMARY(WHAT DISABLED_FEATURES DESCRIPTION "Disabled features:") +# SET_FEATURE_INFO(<name> <description> [<url>] ) # -# SET_FEATURE_INFO(<name> <description> [<url>] ) # Does the same as SET_PACKAGE_INFO(<name> <description> <url> ) #============================================================================= diff --git a/Modules/FindALSA.cmake b/Modules/FindALSA.cmake index 60b0f56..5c30eb9 100644 --- a/Modules/FindALSA.cmake +++ b/Modules/FindALSA.cmake @@ -1,15 +1,25 @@ -# - Find alsa +#.rst: +# FindALSA +# -------- +# +# Find alsa +# # Find the alsa libraries (asound) # -# This module defines the following variables: -# ALSA_FOUND - True if ALSA_INCLUDE_DIR & ALSA_LIBRARY are found -# ALSA_LIBRARIES - Set when ALSA_LIBRARY is found -# ALSA_INCLUDE_DIRS - Set when ALSA_INCLUDE_DIR is found +# :: +# +# This module defines the following variables: +# ALSA_FOUND - True if ALSA_INCLUDE_DIR & ALSA_LIBRARY are found +# ALSA_LIBRARIES - Set when ALSA_LIBRARY is found +# ALSA_INCLUDE_DIRS - Set when ALSA_INCLUDE_DIR is found +# +# # -# ALSA_INCLUDE_DIR - where to find asoundlib.h, etc. -# ALSA_LIBRARY - the asound library -# ALSA_VERSION_STRING - the version of alsa found (since CMake 2.8.8) +# :: # +# ALSA_INCLUDE_DIR - where to find asoundlib.h, etc. +# ALSA_LIBRARY - the asound library +# ALSA_VERSION_STRING - the version of alsa found (since CMake 2.8.8) #============================================================================= # Copyright 2009-2011 Kitware, Inc. diff --git a/Modules/FindASPELL.cmake b/Modules/FindASPELL.cmake index 5b383c4..2a3f228 100644 --- a/Modules/FindASPELL.cmake +++ b/Modules/FindASPELL.cmake @@ -1,11 +1,18 @@ -# - Try to find ASPELL +#.rst: +# FindASPELL +# ---------- +# +# Try to find ASPELL +# # Once done this will define # -# ASPELL_FOUND - system has ASPELL -# ASPELL_EXECUTABLE - the ASPELL executable -# ASPELL_INCLUDE_DIR - the ASPELL include directory -# ASPELL_LIBRARIES - The libraries needed to use ASPELL -# ASPELL_DEFINITIONS - Compiler switches required for using ASPELL +# :: +# +# ASPELL_FOUND - system has ASPELL +# ASPELL_EXECUTABLE - the ASPELL executable +# ASPELL_INCLUDE_DIR - the ASPELL include directory +# ASPELL_LIBRARIES - The libraries needed to use ASPELL +# ASPELL_DEFINITIONS - Compiler switches required for using ASPELL #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindAVIFile.cmake b/Modules/FindAVIFile.cmake index 93fa400..5661075 100644 --- a/Modules/FindAVIFile.cmake +++ b/Modules/FindAVIFile.cmake @@ -1,13 +1,20 @@ -# - Locate AVIFILE library and include paths +#.rst: +# FindAVIFile +# ----------- +# +# Locate AVIFILE library and include paths +# # AVIFILE (http://avifile.sourceforge.net/)is a set of libraries 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 -# AVIFILE_DEFINITIONS, definitions to use when compiling -# AVIFILE_FOUND, If false, don't try to use AVIFILE +# 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 +# AVIFILE_DEFINITIONS, definitions to use when compiling +# AVIFILE_FOUND, If false, don't try to use AVIFILE #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindArmadillo.cmake b/Modules/FindArmadillo.cmake index 4758534..4549771 100644 --- a/Modules/FindArmadillo.cmake +++ b/Modules/FindArmadillo.cmake @@ -1,20 +1,32 @@ -# - Find Armadillo +#.rst: +# FindArmadillo +# ------------- +# +# Find Armadillo +# # Find the Armadillo C++ library # # Using Armadillo: -# find_package(Armadillo REQUIRED) -# include_directories(${ARMADILLO_INCLUDE_DIRS}) -# add_executable(foo foo.cc) -# target_link_libraries(foo ${ARMADILLO_LIBRARIES}) +# +# :: +# +# find_package(Armadillo REQUIRED) +# include_directories(${ARMADILLO_INCLUDE_DIRS}) +# add_executable(foo foo.cc) +# target_link_libraries(foo ${ARMADILLO_LIBRARIES}) +# # This module sets the following variables: -# ARMADILLO_FOUND - set to true if the library is found -# ARMADILLO_INCLUDE_DIRS - list of required include directories -# ARMADILLO_LIBRARIES - list of libraries to be linked -# ARMADILLO_VERSION_MAJOR - major version number -# ARMADILLO_VERSION_MINOR - minor version number -# ARMADILLO_VERSION_PATCH - patch version number -# ARMADILLO_VERSION_STRING - version number as a string (ex: "1.0.4") -# ARMADILLO_VERSION_NAME - name of the version (ex: "Antipodean Antileech") +# +# :: +# +# ARMADILLO_FOUND - set to true if the library is found +# ARMADILLO_INCLUDE_DIRS - list of required include directories +# ARMADILLO_LIBRARIES - list of libraries to be linked +# ARMADILLO_VERSION_MAJOR - major version number +# ARMADILLO_VERSION_MINOR - minor version number +# ARMADILLO_VERSION_PATCH - patch version number +# ARMADILLO_VERSION_STRING - version number as a string (ex: "1.0.4") +# ARMADILLO_VERSION_NAME - name of the version (ex: "Antipodean Antileech") #============================================================================= # Copyright 2011 Clement Creusot <creusot@cs.york.ac.uk> diff --git a/Modules/FindBISON.cmake b/Modules/FindBISON.cmake index 4a3e68c..9ca428e 100644 --- a/Modules/FindBISON.cmake +++ b/Modules/FindBISON.cmake @@ -1,37 +1,61 @@ -# - Find bison executable and provides macros to generate custom build rules +#.rst: +# FindBISON +# --------- +# +# Find bison executable and provides macros to generate custom build rules +# # The module defines the following variables: # -# BISON_EXECUTABLE - path to the bison program -# BISON_VERSION - version of bison -# BISON_FOUND - true if the program was found +# :: +# +# BISON_EXECUTABLE - path to the bison program +# BISON_VERSION - version of bison +# BISON_FOUND - true if the program was found +# +# # # The minimum required version of bison can be specified using the -# standard CMake syntax, e.g. find_package(BISON 2.1.3) +# standard CMake syntax, e.g. find_package(BISON 2.1.3) # # If bison is found, the module defines the macros: -# BISON_TARGET(<Name> <YaccInput> <CodeOutput> [VERBOSE <file>] -# [COMPILE_FLAGS <string>]) -# which will create a custom rule to generate a parser. <YaccInput> is -# the path to a yacc file. <CodeOutput> is the name of the source file -# generated by bison. A header file is also be generated, and contains -# the token list. If COMPILE_FLAGS option is specified, the next -# parameter is added in the bison command line. if VERBOSE option is -# specified, <file> is created and contains verbose descriptions of the -# grammar and parser. The macro defines a set of variables: -# BISON_${Name}_DEFINED - true is the macro ran successfully -# BISON_${Name}_INPUT - The input source file, an alias for <YaccInput> -# BISON_${Name}_OUTPUT_SOURCE - The source file generated by bison -# BISON_${Name}_OUTPUT_HEADER - The header file generated by bison -# BISON_${Name}_OUTPUTS - The sources files generated by bison -# BISON_${Name}_COMPILE_FLAGS - Options used in the bison command line -# -# ==================================================================== -# Example: -# -# find_package(BISON) -# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) -# add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS}) -# ==================================================================== +# +# :: +# +# BISON_TARGET(<Name> <YaccInput> <CodeOutput> [VERBOSE <file>] +# [COMPILE_FLAGS <string>]) +# +# which will create a custom rule to generate a parser. <YaccInput> is +# the path to a yacc file. <CodeOutput> is the name of the source file +# generated by bison. A header file is also be generated, and contains +# the token list. If COMPILE_FLAGS option is specified, the next +# parameter is added in the bison command line. if VERBOSE option is +# specified, <file> is created and contains verbose descriptions of the +# grammar and parser. The macro defines a set of variables: +# +# :: +# +# BISON_${Name}_DEFINED - true is the macro ran successfully +# BISON_${Name}_INPUT - The input source file, an alias for <YaccInput> +# BISON_${Name}_OUTPUT_SOURCE - The source file generated by bison +# BISON_${Name}_OUTPUT_HEADER - The header file generated by bison +# BISON_${Name}_OUTPUTS - The sources files generated by bison +# BISON_${Name}_COMPILE_FLAGS - Options used in the bison command line +# +# +# +# :: +# +# ==================================================================== +# Example: +# +# +# +# :: +# +# find_package(BISON) +# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) +# add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS}) +# ==================================================================== #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindBLAS.cmake b/Modules/FindBLAS.cmake index f8a284d..3b658ef 100644 --- a/Modules/FindBLAS.cmake +++ b/Modules/FindBLAS.cmake @@ -1,31 +1,41 @@ -# - Find BLAS library -# This module finds an installed fortran library that implements the BLAS -# linear-algebra interface (see http://www.netlib.org/blas/). -# The list of libraries searched for is taken -# from the autoconf macro file, acx_blas.m4 (distributed at +#.rst: +# FindBLAS +# -------- +# +# Find BLAS library +# +# This module finds an installed fortran library that implements the +# BLAS linear-algebra interface (see http://www.netlib.org/blas/). The +# list of libraries searched for is taken from the autoconf macro file, +# acx_blas.m4 (distributed at # http://ac-archive.sourceforge.net/ac-archive/acx_blas.html). # # This module sets the following variables: -# BLAS_FOUND - set to true if a library implementing the BLAS interface -# is found -# BLAS_LINKER_FLAGS - uncached list of required linker flags (excluding -l -# and -L). -# BLAS_LIBRARIES - uncached list of libraries (using full path name) to -# link against to use BLAS -# BLAS95_LIBRARIES - uncached list of libraries (using full path name) -# to link against to use BLAS95 interface -# BLAS95_FOUND - set to true if a library implementing the BLAS f95 interface -# is found -# BLA_STATIC if set on this determines what kind of linkage we do (static) -# BLA_VENDOR if set checks only the specified vendor, if not set checks -# all the possibilities -# BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK -########## -### List of vendors (BLA_VENDOR) valid in this module -## Goto,ATLAS PhiPACK,CXML,DXML,SunPerf,SCSL,SGIMATH,IBMESSL,Intel10_32 (intel mkl v10 32 bit),Intel10_64lp (intel mkl v10 64 bit,lp thread model, lp64 model), -## Intel10_64lp_seq (intel mkl v10 64 bit,sequential code, lp64 model), -## Intel( older versions of mkl 32 and 64 bit), ACML,ACML_MP,ACML_GPU,Apple, NAS, Generic -# C/CXX should be enabled to use Intel mkl +# +# :: +# +# BLAS_FOUND - set to true if a library implementing the BLAS interface +# is found +# BLAS_LINKER_FLAGS - uncached list of required linker flags (excluding -l +# and -L). +# BLAS_LIBRARIES - uncached list of libraries (using full path name) to +# link against to use BLAS +# BLAS95_LIBRARIES - uncached list of libraries (using full path name) +# to link against to use BLAS95 interface +# BLAS95_FOUND - set to true if a library implementing the BLAS f95 interface +# is found +# BLA_STATIC if set on this determines what kind of linkage we do (static) +# BLA_VENDOR if set checks only the specified vendor, if not set checks +# all the possibilities +# BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK +# +# ######### ## List of vendors (BLA_VENDOR) valid in this module # +# Goto,ATLAS PhiPACK,CXML,DXML,SunPerf,SCSL,SGIMATH,IBMESSL,Intel10_32 +# (intel mkl v10 32 bit),Intel10_64lp (intel mkl v10 64 bit,lp thread +# model, lp64 model), # Intel10_64lp_seq (intel mkl v10 64 +# bit,sequential code, lp64 model), # Intel( older versions of mkl 32 +# and 64 bit), ACML,ACML_MP,ACML_GPU,Apple, NAS, Generic C/CXX should be +# enabled to use Intel mkl #============================================================================= # Copyright 2007-2009 Kitware, Inc. @@ -469,8 +479,45 @@ if (BLA_VENDOR MATCHES "Intel*" OR BLA_VENDOR STREQUAL "All") set(BLAS_mkl_SEARCH_SYMBOL SGEMM) set(_LIBRARIES BLAS95_LIBRARIES) if (WIN32) - list(APPEND BLAS_SEARCH_LIBS - "mkl_blas95 mkl_intel_c mkl_intel_thread mkl_core libguide40") + if (BLA_STATIC) + set(BLAS_mkl_DLL_SUFFIX "") + else() + set(BLAS_mkl_DLL_SUFFIX "_dll") + endif() + + # Find the main file (32-bit or 64-bit) + set(BLAS_SEARCH_LIBS_WIN_MAIN "") + if (BLA_VENDOR STREQUAL "Intel10_32" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_MAIN + "mkl_blas95${BLAS_mkl_DLL_SUFFIX} mkl_intel_c${BLAS_mkl_DLL_SUFFIX}") + endif() + if (BLA_VENDOR STREQUAL "Intel10_64lp*" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_MAIN + "mkl_blas95_lp64${BLAS_mkl_DLL_SUFFIX} mkl_intel_lp64${BLAS_mkl_DLL_SUFFIX}") + endif () + + # Add threading/sequential libs + set(BLAS_SEARCH_LIBS_WIN_THREAD "") + if (BLA_VENDOR STREQUAL "*_seq" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "mkl_sequential${BLAS_mkl_DLL_SUFFIX}") + endif() + if (NOT BLA_VENDOR STREQUAL "*_seq" OR BLA_VENDOR STREQUAL "All") + # old version + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "libguide40 mkl_intel_thread${BLAS_mkl_DLL_SUFFIX}") + # mkl >= 10.3 + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "libiomp5md mkl_intel_thread${BLAS_mkl_DLL_SUFFIX}") + endif() + + # Cartesian product of the above + foreach (MAIN ${BLAS_SEARCH_LIBS_WIN_MAIN}) + foreach (THREAD ${BLAS_SEARCH_LIBS_WIN_THREAD}) + list(APPEND BLAS_SEARCH_LIBS + "${MAIN} ${THREAD} mkl_core${BLAS_mkl_DLL_SUFFIX}") + endforeach() + endforeach() else () if (BLA_VENDOR STREQUAL "Intel10_32" OR BLA_VENDOR STREQUAL "All") list(APPEND BLAS_SEARCH_LIBS @@ -490,17 +537,54 @@ if (BLA_VENDOR MATCHES "Intel*" OR BLA_VENDOR STREQUAL "All") "mkl_blas95_lp64 mkl_intel_lp64 mkl_intel_thread mkl_core iomp5") endif () endif () - endif () - if (BLA_VENDOR STREQUAL "Intel10_64lp_seq" OR BLA_VENDOR STREQUAL "All") - list(APPEND BLAS_SEARCH_LIBS - "mkl_blas95_lp64 mkl_intel_lp64 mkl_sequential mkl_core") + if (BLA_VENDOR STREQUAL "Intel10_64lp_seq" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS + "mkl_intel_lp64 mkl_sequential mkl_core") + endif () endif () else () set(BLAS_mkl_SEARCH_SYMBOL sgemm) set(_LIBRARIES BLAS_LIBRARIES) if (WIN32) - list(APPEND BLAS_SEARCH_LIBS - "mkl_c_dll mkl_intel_thread_dll mkl_core_dll libguide40") + if (BLA_STATIC) + set(BLAS_mkl_DLL_SUFFIX "") + else() + set(BLAS_mkl_DLL_SUFFIX "_dll") + endif() + + # Find the main file (32-bit or 64-bit) + set(BLAS_SEARCH_LIBS_WIN_MAIN "") + if (BLA_VENDOR STREQUAL "Intel10_32" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_MAIN + "mkl_intel_c${BLAS_mkl_DLL_SUFFIX}") + endif() + if (BLA_VENDOR STREQUAL "Intel10_64lp*" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_MAIN + "mkl_intel_lp64${BLAS_mkl_DLL_SUFFIX}") + endif () + + # Add threading/sequential libs + set(BLAS_SEARCH_LIBS_WIN_THREAD "") + if (NOT BLA_VENDOR STREQUAL "*_seq" OR BLA_VENDOR STREQUAL "All") + # old version + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "libguide40 mkl_intel_thread${BLAS_mkl_DLL_SUFFIX}") + # mkl >= 10.3 + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "libiomp5md mkl_intel_thread${BLAS_mkl_DLL_SUFFIX}") + endif() + if (BLA_VENDOR STREQUAL "*_seq" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS_WIN_THREAD + "mkl_sequential${BLAS_mkl_DLL_SUFFIX}") + endif() + + # Cartesian product of the above + foreach (MAIN ${BLAS_SEARCH_LIBS_WIN_MAIN}) + foreach (THREAD ${BLAS_SEARCH_LIBS_WIN_THREAD}) + list(APPEND BLAS_SEARCH_LIBS + "${MAIN} ${THREAD} mkl_core${BLAS_mkl_DLL_SUFFIX}") + endforeach() + endforeach() else () if (BLA_VENDOR STREQUAL "Intel10_32" OR BLA_VENDOR STREQUAL "All") list(APPEND BLAS_SEARCH_LIBS @@ -521,6 +605,10 @@ if (BLA_VENDOR MATCHES "Intel*" OR BLA_VENDOR STREQUAL "All") "mkl_intel_lp64 mkl_intel_thread mkl_core iomp5") endif () endif () + if (BLA_VENDOR STREQUAL "Intel10_64lp_seq" OR BLA_VENDOR STREQUAL "All") + list(APPEND BLAS_SEARCH_LIBS + "mkl_intel_lp64 mkl_sequential mkl_core") + endif () #older vesions of intel mkl libs if (BLA_VENDOR STREQUAL "Intel" OR BLA_VENDOR STREQUAL "All") @@ -532,10 +620,6 @@ if (BLA_VENDOR MATCHES "Intel*" OR BLA_VENDOR STREQUAL "All") "mkl_em64t") endif () endif () - if (BLA_VENDOR STREQUAL "Intel10_64lp_seq" OR BLA_VENDOR STREQUAL "All") - list(APPEND BLAS_SEARCH_LIBS - "mkl_intel_lp64 mkl_sequential mkl_core") - endif () endif () foreach (IT ${BLAS_SEARCH_LIBS}) diff --git a/Modules/FindBZip2.cmake b/Modules/FindBZip2.cmake index 9fb29d0..3883877 100644 --- a/Modules/FindBZip2.cmake +++ b/Modules/FindBZip2.cmake @@ -1,11 +1,18 @@ -# - Try to find BZip2 +#.rst: +# FindBZip2 +# --------- +# +# Try to find BZip2 +# # Once done this will define # -# BZIP2_FOUND - system has BZip2 -# BZIP2_INCLUDE_DIR - the BZip2 include directory -# BZIP2_LIBRARIES - Link these to use BZip2 -# BZIP2_NEED_PREFIX - this is set if the functions are prefixed with BZ2_ -# BZIP2_VERSION_STRING - the version of BZip2 found (since CMake 2.8.8) +# :: +# +# BZIP2_FOUND - system has BZip2 +# BZIP2_INCLUDE_DIR - the BZip2 include directory +# BZIP2_LIBRARIES - Link these to use BZip2 +# BZIP2_NEED_PREFIX - this is set if the functions are prefixed with BZ2_ +# BZIP2_VERSION_STRING - the version of BZip2 found (since CMake 2.8.8) #============================================================================= # Copyright 2006-2012 Kitware, Inc. diff --git a/Modules/FindBoost.cmake b/Modules/FindBoost.cmake index 914a0a5..6e1c926 100644 --- a/Modules/FindBoost.cmake +++ b/Modules/FindBoost.cmake @@ -1,136 +1,180 @@ -# - Find Boost include dirs and libraries +#.rst: +# FindBoost +# --------- +# +# Find Boost include dirs and libraries +# # Use this module by invoking find_package with the form: -# find_package(Boost -# [version] [EXACT] # Minimum or EXACT version e.g. 1.36.0 -# [REQUIRED] # Fail with error if Boost is not found -# [COMPONENTS <libs>...] # Boost libraries by their canonical name -# ) # e.g. "date_time" for "libboost_date_time" +# +# :: +# +# find_package(Boost +# [version] [EXACT] # Minimum or EXACT version e.g. 1.36.0 +# [REQUIRED] # Fail with error if Boost is not found +# [COMPONENTS <libs>...] # Boost libraries by their canonical name +# ) # e.g. "date_time" for "libboost_date_time" +# # This module finds headers and requested component libraries OR a CMake # package configuration file provided by a "Boost CMake" build. For the # latter case skip to the "Boost CMake" section below. For the former # case results are reported in variables: -# Boost_FOUND - True if headers and requested libraries were found -# Boost_INCLUDE_DIRS - Boost include directories -# Boost_LIBRARY_DIRS - Link directories for Boost libraries -# Boost_LIBRARIES - Boost component libraries to be linked -# Boost_<C>_FOUND - True if component <C> was found (<C> is upper-case) -# Boost_<C>_LIBRARY - Libraries to link for component <C> (may include -# target_link_libraries debug/optimized keywords) -# Boost_VERSION - BOOST_VERSION value from boost/version.hpp -# Boost_LIB_VERSION - Version string appended to library filenames -# Boost_MAJOR_VERSION - Boost major version number (X in X.y.z) -# Boost_MINOR_VERSION - Boost minor version number (Y in x.Y.z) -# Boost_SUBMINOR_VERSION - Boost subminor version number (Z in x.y.Z) -# Boost_LIB_DIAGNOSTIC_DEFINITIONS (Windows) -# - Pass to add_definitions() to have diagnostic -# information about Boost's automatic linking -# displayed during compilation +# +# :: +# +# Boost_FOUND - True if headers and requested libraries were found +# Boost_INCLUDE_DIRS - Boost include directories +# Boost_LIBRARY_DIRS - Link directories for Boost libraries +# Boost_LIBRARIES - Boost component libraries to be linked +# Boost_<C>_FOUND - True if component <C> was found (<C> is upper-case) +# Boost_<C>_LIBRARY - Libraries to link for component <C> (may include +# target_link_libraries debug/optimized keywords) +# Boost_VERSION - BOOST_VERSION value from boost/version.hpp +# Boost_LIB_VERSION - Version string appended to library filenames +# Boost_MAJOR_VERSION - Boost major version number (X in X.y.z) +# Boost_MINOR_VERSION - Boost minor version number (Y in x.Y.z) +# Boost_SUBMINOR_VERSION - Boost subminor version number (Z in x.y.Z) +# Boost_LIB_DIAGNOSTIC_DEFINITIONS (Windows) +# - Pass to add_definitions() to have diagnostic +# information about Boost's automatic linking +# displayed during compilation +# +# # # This module reads hints about search locations from variables: -# BOOST_ROOT - Preferred installation prefix -# (or BOOSTROOT) -# BOOST_INCLUDEDIR - Preferred include directory e.g. <prefix>/include -# BOOST_LIBRARYDIR - Preferred library directory e.g. <prefix>/lib -# Boost_NO_SYSTEM_PATHS - Set to ON to disable searching in locations not -# specified by these hint variables. Default is OFF. -# Boost_ADDITIONAL_VERSIONS -# - List of Boost versions not known to this module -# (Boost install locations may contain the version) +# +# :: +# +# BOOST_ROOT - Preferred installation prefix +# (or BOOSTROOT) +# BOOST_INCLUDEDIR - Preferred include directory e.g. <prefix>/include +# BOOST_LIBRARYDIR - Preferred library directory e.g. <prefix>/lib +# Boost_NO_SYSTEM_PATHS - Set to ON to disable searching in locations not +# specified by these hint variables. Default is OFF. +# Boost_ADDITIONAL_VERSIONS +# - List of Boost versions not known to this module +# (Boost install locations may contain the version) +# # and saves search results persistently in CMake cache entries: -# Boost_INCLUDE_DIR - Directory containing Boost headers -# Boost_LIBRARY_DIR - Directory containing Boost libraries -# Boost_<C>_LIBRARY_DEBUG - Component <C> library debug variant -# Boost_<C>_LIBRARY_RELEASE - Component <C> library release variant -# Users may set these hints or results as cache entries. Projects should -# not read these entries directly but instead use the above result variables. -# Note that some hint names start in upper-case "BOOST". One may specify -# these as environment variables if they are not specified as CMake variables -# or cache entries. # -# This module first searches for the Boost header files using the above hint -# variables (excluding BOOST_LIBRARYDIR) and saves the result in -# Boost_INCLUDE_DIR. Then it searches for requested component libraries using -# the above hints (excluding BOOST_INCLUDEDIR and Boost_ADDITIONAL_VERSIONS), -# "lib" directories near Boost_INCLUDE_DIR, and the library name configuration -# settings below. It saves the library directory in Boost_LIBRARY_DIR and -# individual library locations in Boost_<C>_LIBRARY_DEBUG and -# Boost_<C>_LIBRARY_RELEASE. When one changes settings used by previous -# searches in the same build tree (excluding environment variables) this -# module discards previous search results affected by the changes and searches -# again. +# :: +# +# Boost_INCLUDE_DIR - Directory containing Boost headers +# Boost_LIBRARY_DIR - Directory containing Boost libraries +# Boost_<C>_LIBRARY_DEBUG - Component <C> library debug variant +# Boost_<C>_LIBRARY_RELEASE - Component <C> library release variant +# +# Users may set these hints or results as cache entries. Projects +# should not read these entries directly but instead use the above +# result variables. Note that some hint names start in upper-case +# "BOOST". One may specify these as environment variables if they are +# not specified as CMake variables or cache entries. +# +# This module first searches for the Boost header files using the above +# hint variables (excluding BOOST_LIBRARYDIR) and saves the result in +# Boost_INCLUDE_DIR. Then it searches for requested component libraries +# using the above hints (excluding BOOST_INCLUDEDIR and +# Boost_ADDITIONAL_VERSIONS), "lib" directories near Boost_INCLUDE_DIR, +# and the library name configuration settings below. It saves the +# library directory in Boost_LIBRARY_DIR and individual library +# locations in Boost_<C>_LIBRARY_DEBUG and Boost_<C>_LIBRARY_RELEASE. +# When one changes settings used by previous searches in the same build +# tree (excluding environment variables) this module discards previous +# search results affected by the changes and searches again. +# +# Boost libraries come in many variants encoded in their file name. +# Users or projects may tell this module which variant to find by +# setting variables: +# +# :: +# +# Boost_USE_MULTITHREADED - Set to OFF to use the non-multithreaded +# libraries ('mt' tag). Default is ON. +# Boost_USE_STATIC_LIBS - Set to ON to force the use of the static +# libraries. Default is OFF. +# Boost_USE_STATIC_RUNTIME - Set to ON or OFF to specify whether to use +# libraries linked statically to the C++ runtime +# ('s' tag). Default is platform dependent. +# Boost_USE_DEBUG_PYTHON - Set to ON to use libraries compiled with a +# debug Python build ('y' tag). Default is OFF. +# Boost_USE_STLPORT - Set to ON to use libraries compiled with +# STLPort ('p' tag). Default is OFF. +# Boost_USE_STLPORT_DEPRECATED_NATIVE_IOSTREAMS +# - Set to ON to use libraries compiled with +# STLPort deprecated "native iostreams" +# ('n' tag). Default is OFF. +# Boost_COMPILER - Set to the compiler-specific library suffix +# (e.g. "-gcc43"). Default is auto-computed +# for the C++ compiler in use. +# Boost_THREADAPI - Suffix for "thread" component library name, +# such as "pthread" or "win32". Names with +# and without this suffix will both be tried. # -# Boost libraries come in many variants encoded in their file name. Users or -# projects may tell this module which variant to find by setting variables: -# Boost_USE_MULTITHREADED - Set to OFF to use the non-multithreaded -# libraries ('mt' tag). Default is ON. -# Boost_USE_STATIC_LIBS - Set to ON to force the use of the static -# libraries. Default is OFF. -# Boost_USE_STATIC_RUNTIME - Set to ON or OFF to specify whether to use -# libraries linked statically to the C++ runtime -# ('s' tag). Default is platform dependent. -# Boost_USE_DEBUG_PYTHON - Set to ON to use libraries compiled with a -# debug Python build ('y' tag). Default is OFF. -# Boost_USE_STLPORT - Set to ON to use libraries compiled with -# STLPort ('p' tag). Default is OFF. -# Boost_USE_STLPORT_DEPRECATED_NATIVE_IOSTREAMS -# - Set to ON to use libraries compiled with -# STLPort deprecated "native iostreams" -# ('n' tag). Default is OFF. -# Boost_COMPILER - Set to the compiler-specific library suffix -# (e.g. "-gcc43"). Default is auto-computed -# for the C++ compiler in use. -# Boost_THREADAPI - Suffix for "thread" component library name, -# such as "pthread" or "win32". Names with -# and without this suffix will both be tried. # Other variables one may set to control this module are: -# Boost_DEBUG - Set to ON to enable debug output from FindBoost. -# Please enable this before filing any bug report. -# Boost_DETAILED_FAILURE_MSG -# - Set to ON to add detailed information to the -# failure message even when the REQUIRED option -# is not given to the find_package call. -# Boost_REALPATH - Set to ON to resolve symlinks for discovered -# libraries to assist with packaging. For example, -# the "system" component library may be resolved to -# "/usr/lib/libboost_system.so.1.42.0" instead of -# "/usr/lib/libboost_system.so". This does not -# affect linking and should not be enabled unless -# the user needs this information. +# +# :: +# +# Boost_DEBUG - Set to ON to enable debug output from FindBoost. +# Please enable this before filing any bug report. +# Boost_DETAILED_FAILURE_MSG +# - Set to ON to add detailed information to the +# failure message even when the REQUIRED option +# is not given to the find_package call. +# Boost_REALPATH - Set to ON to resolve symlinks for discovered +# libraries to assist with packaging. For example, +# the "system" component library may be resolved to +# "/usr/lib/libboost_system.so.1.42.0" instead of +# "/usr/lib/libboost_system.so". This does not +# affect linking and should not be enabled unless +# the user needs this information. +# # On Visual Studio and Borland compilers Boost headers request automatic -# linking to corresponding libraries. This requires matching libraries to be -# linked explicitly or available in the link library search path. In this -# case setting Boost_USE_STATIC_LIBS to OFF may not achieve dynamic linking. -# Boost automatic linking typically requests static libraries with a few -# exceptions (such as Boost.Python). Use -# add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS}) +# linking to corresponding libraries. This requires matching libraries +# to be linked explicitly or available in the link library search path. +# In this case setting Boost_USE_STATIC_LIBS to OFF may not achieve +# dynamic linking. Boost automatic linking typically requests static +# libraries with a few exceptions (such as Boost.Python). Use +# +# :: +# +# add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS}) +# # to ask Boost to report information about automatic linking requests. # # Example to find Boost headers only: -# find_package(Boost 1.36.0) -# if(Boost_FOUND) -# include_directories(${Boost_INCLUDE_DIRS}) -# add_executable(foo foo.cc) -# endif() +# +# :: +# +# find_package(Boost 1.36.0) +# if(Boost_FOUND) +# include_directories(${Boost_INCLUDE_DIRS}) +# add_executable(foo foo.cc) +# endif() +# # Example to find Boost headers and some libraries: -# set(Boost_USE_STATIC_LIBS ON) -# set(Boost_USE_MULTITHREADED ON) -# set(Boost_USE_STATIC_RUNTIME OFF) -# find_package(Boost 1.36.0 COMPONENTS date_time filesystem system ...) -# if(Boost_FOUND) -# include_directories(${Boost_INCLUDE_DIRS}) -# add_executable(foo foo.cc) -# target_link_libraries(foo ${Boost_LIBRARIES}) -# endif() +# +# :: +# +# set(Boost_USE_STATIC_LIBS ON) +# set(Boost_USE_MULTITHREADED ON) +# set(Boost_USE_STATIC_RUNTIME OFF) +# find_package(Boost 1.36.0 COMPONENTS date_time filesystem system ...) +# if(Boost_FOUND) +# include_directories(${Boost_INCLUDE_DIRS}) +# add_executable(foo foo.cc) +# target_link_libraries(foo ${Boost_LIBRARIES}) +# endif() +# +# # # Boost CMake ---------------------------------------------------------- # # If Boost was built using the boost-cmake project it provides a package -# configuration file for use with find_package's Config mode. This module -# looks for the package configuration file called BoostConfig.cmake or -# boost-config.cmake and stores the result in cache entry "Boost_DIR". If -# found, the package configuration file is loaded and this module returns with -# no further action. See documentation of the Boost CMake package -# configuration for details on what it provides. +# configuration file for use with find_package's Config mode. This +# module looks for the package configuration file called +# BoostConfig.cmake or boost-config.cmake and stores the result in cache +# entry "Boost_DIR". If found, the package configuration file is loaded +# and this module returns with no further action. See documentation of +# the Boost CMake package configuration for details on what it provides. # # Set Boost_NO_BOOST_CMAKE to ON to disable the search for boost-cmake. diff --git a/Modules/FindBullet.cmake b/Modules/FindBullet.cmake index 1a27fc3..fc848fa 100644 --- a/Modules/FindBullet.cmake +++ b/Modules/FindBullet.cmake @@ -1,17 +1,36 @@ -# - Try to find the Bullet physics engine +#.rst: +# FindBullet +# ---------- # -# This module defines the following variables +# Try to find the Bullet physics engine # -# BULLET_FOUND - Was bullet found -# BULLET_INCLUDE_DIRS - the Bullet include directories -# BULLET_LIBRARIES - Link to this, by default it includes -# all bullet components (Dynamics, -# Collision, LinearMath, & SoftBody) # -# This module accepts the following variables # -# BULLET_ROOT - Can be set to bullet install path or Windows build path +# :: # +# This module defines the following variables +# +# +# +# :: +# +# BULLET_FOUND - Was bullet found +# BULLET_INCLUDE_DIRS - the Bullet include directories +# BULLET_LIBRARIES - Link to this, by default it includes +# all bullet components (Dynamics, +# Collision, LinearMath, & SoftBody) +# +# +# +# :: +# +# This module accepts the following variables +# +# +# +# :: +# +# BULLET_ROOT - Can be set to bullet install path or Windows build path #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindCABLE.cmake b/Modules/FindCABLE.cmake index 3e2d5d3..5cea109 100644 --- a/Modules/FindCABLE.cmake +++ b/Modules/FindCABLE.cmake @@ -1,14 +1,24 @@ -# - Find CABLE +#.rst: +# FindCABLE +# --------- +# +# Find CABLE +# # This module finds if CABLE is installed and determines where the -# include files and libraries are. This code sets the following variables: +# include files and libraries are. This code sets the following +# variables: +# +# :: +# +# CABLE the path to the cable executable +# CABLE_TCL_LIBRARY the path to the Tcl wrapper library +# CABLE_INCLUDE_DIR the path to the include directory +# # -# CABLE the path to the cable executable -# CABLE_TCL_LIBRARY the path to the Tcl wrapper library -# CABLE_INCLUDE_DIR the path to the 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. +# ${CABLE_TCL_LIBRARY}. You should also add ${CABLE_INCLUDE_DIR} as an +# include directory. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindCUDA.cmake b/Modules/FindCUDA.cmake index 8270ad4..5dca820 100644 --- a/Modules/FindCUDA.cmake +++ b/Modules/FindCUDA.cmake @@ -1,286 +1,460 @@ -# - Tools for building CUDA C files: libraries and build dependencies. -# This script locates the NVIDIA CUDA C tools. It should work on linux, windows, -# and mac and should be reasonably up to date with CUDA C releases. -# -# This script makes use of the standard find_package arguments of <VERSION>, -# REQUIRED and QUIET. CUDA_FOUND will report if an acceptable version of CUDA -# was found. -# -# The script will prompt the user to specify CUDA_TOOLKIT_ROOT_DIR if the prefix -# cannot be determined by the location of nvcc in the system path and REQUIRED -# is specified to find_package(). To use a different installed version of the -# toolkit set the environment variable CUDA_BIN_PATH before running cmake -# (e.g. CUDA_BIN_PATH=/usr/local/cuda1.0 instead of the default /usr/local/cuda) -# or set CUDA_TOOLKIT_ROOT_DIR after configuring. If you change the value of -# CUDA_TOOLKIT_ROOT_DIR, various components that depend on the path will be -# relocated. +#.rst: +# FindCUDA +# -------- +# +# Tools for building CUDA C files: libraries and build dependencies. +# +# This script locates the NVIDIA CUDA C tools. It should work on linux, +# windows, and mac and should be reasonably up to date with CUDA C +# releases. +# +# This script makes use of the standard find_package arguments of +# <VERSION>, REQUIRED and QUIET. CUDA_FOUND will report if an +# acceptable version of CUDA was found. +# +# The script will prompt the user to specify CUDA_TOOLKIT_ROOT_DIR if +# the prefix cannot be determined by the location of nvcc in the system +# path and REQUIRED is specified to find_package(). To use a different +# installed version of the toolkit set the environment variable +# CUDA_BIN_PATH before running cmake (e.g. +# CUDA_BIN_PATH=/usr/local/cuda1.0 instead of the default +# /usr/local/cuda) or set CUDA_TOOLKIT_ROOT_DIR after configuring. If +# you change the value of CUDA_TOOLKIT_ROOT_DIR, various components that +# depend on the path will be relocated. # # It might be necessary to set CUDA_TOOLKIT_ROOT_DIR manually on certain -# platforms, or to use a cuda runtime not installed in the default location. In -# newer versions of the toolkit the cuda library is included with the graphics -# driver- be sure that the driver version matches what is needed by the cuda -# runtime version. -# -# The following variables affect the behavior of the macros in the script (in -# alphebetical order). Note that any of these flags can be changed multiple -# times in the same directory before calling CUDA_ADD_EXECUTABLE, -# CUDA_ADD_LIBRARY, CUDA_COMPILE, CUDA_COMPILE_PTX or CUDA_WRAP_SRCS. -# -# CUDA_64_BIT_DEVICE_CODE (Default matches host bit size) -# -- Set to ON to compile for 64 bit device code, OFF for 32 bit device code. -# Note that making this different from the host code when generating object -# or C files from CUDA code just won't work, because size_t gets defined by -# nvcc in the generated source. If you compile to PTX and then load the -# file yourself, you can mix bit sizes between device and host. -# -# CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE (Default ON) -# -- Set to ON if you want the custom build rule to be attached to the source -# file in Visual Studio. Turn OFF if you add the same cuda file to multiple -# targets. -# -# This allows the user to build the target from the CUDA file; however, bad -# things can happen if the CUDA source file is added to multiple targets. -# When performing parallel builds it is possible for the custom build -# command to be run more than once and in parallel causing cryptic build -# errors. VS runs the rules for every source file in the target, and a -# source can have only one rule no matter how many projects it is added to. -# When the rule is run from multiple targets race conditions can occur on -# the generated file. Eventually everything will get built, but if the user -# is unaware of this behavior, there may be confusion. It would be nice if -# this script could detect the reuse of source files across multiple targets -# and turn the option off for the user, but no good solution could be found. -# -# CUDA_BUILD_CUBIN (Default OFF) -# -- Set to ON to enable and extra compilation pass with the -cubin option in -# Device mode. The output is parsed and register, shared memory usage is -# printed during build. -# -# CUDA_BUILD_EMULATION (Default OFF for device mode) -# -- Set to ON for Emulation mode. -D_DEVICEEMU is defined for CUDA C files -# when CUDA_BUILD_EMULATION is TRUE. -# -# CUDA_GENERATED_OUTPUT_DIR (Default CMAKE_CURRENT_BINARY_DIR) -# -- Set to the path you wish to have the generated files placed. If it is -# blank output files will be placed in CMAKE_CURRENT_BINARY_DIR. -# Intermediate files will always be placed in -# CMAKE_CURRENT_BINARY_DIR/CMakeFiles. -# -# CUDA_HOST_COMPILATION_CPP (Default ON) -# -- Set to OFF for C compilation of host code. -# -# CUDA_HOST_COMPILER (Default CMAKE_C_COMPILER, $(VCInstallDir)/bin for VS) -# -- Set the host compiler to be used by nvcc. Ignored if -ccbin or -# --compiler-bindir is already present in the CUDA_NVCC_FLAGS or -# CUDA_NVCC_FLAGS_<CONFIG> variables. For Visual Studio targets -# $(VCInstallDir)/bin is a special value that expands out to the path when -# the command is run from withing VS. -# -# CUDA_NVCC_FLAGS -# CUDA_NVCC_FLAGS_<CONFIG> -# -- Additional NVCC command line arguments. NOTE: multiple arguments must be -# semi-colon delimited (e.g. --compiler-options;-Wall) -# -# CUDA_PROPAGATE_HOST_FLAGS (Default ON) -# -- Set to ON to propagate CMAKE_{C,CXX}_FLAGS and their configuration -# dependent counterparts (e.g. CMAKE_C_FLAGS_DEBUG) automatically to the -# host compiler through nvcc's -Xcompiler flag. This helps make the -# generated host code match the rest of the system better. Sometimes -# certain flags give nvcc problems, and this will help you turn the flag -# propagation off. This does not affect the flags supplied directly to nvcc -# via CUDA_NVCC_FLAGS or through the OPTION flags specified through -# CUDA_ADD_LIBRARY, CUDA_ADD_EXECUTABLE, or CUDA_WRAP_SRCS. Flags used for -# shared library compilation are not affected by this flag. -# -# CUDA_SEPARABLE_COMPILATION (Default OFF) -# -- If set this will enable separable compilation for all CUDA runtime object -# files. If used outside of CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY -# (e.g. calling CUDA_WRAP_SRCS directly), -# CUDA_COMPUTE_SEPARABLE_COMPILATION_OBJECT_FILE_NAME and -# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS should be called. -# -# CUDA_VERBOSE_BUILD (Default OFF) -# -- Set to ON to see all the commands used when building the CUDA file. When -# using a Makefile generator the value defaults to VERBOSE (run make -# VERBOSE=1 to see output), although setting CUDA_VERBOSE_BUILD to ON will -# always print the output. +# platforms, or to use a cuda runtime not installed in the default +# location. In newer versions of the toolkit the cuda library is +# included with the graphics driver- be sure that the driver version +# matches what is needed by the cuda runtime version. +# +# The following variables affect the behavior of the macros in the +# script (in alphebetical order). Note that any of these flags can be +# changed multiple times in the same directory before calling +# CUDA_ADD_EXECUTABLE, CUDA_ADD_LIBRARY, CUDA_COMPILE, CUDA_COMPILE_PTX +# or CUDA_WRAP_SRCS. +# +# :: +# +# CUDA_64_BIT_DEVICE_CODE (Default matches host bit size) +# -- Set to ON to compile for 64 bit device code, OFF for 32 bit device code. +# Note that making this different from the host code when generating object +# or C files from CUDA code just won't work, because size_t gets defined by +# nvcc in the generated source. If you compile to PTX and then load the +# file yourself, you can mix bit sizes between device and host. +# +# +# +# :: +# +# CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE (Default ON) +# -- Set to ON if you want the custom build rule to be attached to the source +# file in Visual Studio. Turn OFF if you add the same cuda file to multiple +# targets. +# +# +# +# :: +# +# This allows the user to build the target from the CUDA file; however, bad +# things can happen if the CUDA source file is added to multiple targets. +# When performing parallel builds it is possible for the custom build +# command to be run more than once and in parallel causing cryptic build +# errors. VS runs the rules for every source file in the target, and a +# source can have only one rule no matter how many projects it is added to. +# When the rule is run from multiple targets race conditions can occur on +# the generated file. Eventually everything will get built, but if the user +# is unaware of this behavior, there may be confusion. It would be nice if +# this script could detect the reuse of source files across multiple targets +# and turn the option off for the user, but no good solution could be found. +# +# +# +# :: +# +# CUDA_BUILD_CUBIN (Default OFF) +# -- Set to ON to enable and extra compilation pass with the -cubin option in +# Device mode. The output is parsed and register, shared memory usage is +# printed during build. +# +# +# +# :: +# +# CUDA_BUILD_EMULATION (Default OFF for device mode) +# -- Set to ON for Emulation mode. -D_DEVICEEMU is defined for CUDA C files +# when CUDA_BUILD_EMULATION is TRUE. +# +# +# +# :: +# +# CUDA_GENERATED_OUTPUT_DIR (Default CMAKE_CURRENT_BINARY_DIR) +# -- Set to the path you wish to have the generated files placed. If it is +# blank output files will be placed in CMAKE_CURRENT_BINARY_DIR. +# Intermediate files will always be placed in +# CMAKE_CURRENT_BINARY_DIR/CMakeFiles. +# +# +# +# :: +# +# CUDA_HOST_COMPILATION_CPP (Default ON) +# -- Set to OFF for C compilation of host code. +# +# +# +# :: +# +# CUDA_HOST_COMPILER (Default CMAKE_C_COMPILER, $(VCInstallDir)/bin for VS) +# -- Set the host compiler to be used by nvcc. Ignored if -ccbin or +# --compiler-bindir is already present in the CUDA_NVCC_FLAGS or +# CUDA_NVCC_FLAGS_<CONFIG> variables. For Visual Studio targets +# $(VCInstallDir)/bin is a special value that expands out to the path when +# the command is run from withing VS. +# +# +# +# :: +# +# CUDA_NVCC_FLAGS +# CUDA_NVCC_FLAGS_<CONFIG> +# -- Additional NVCC command line arguments. NOTE: multiple arguments must be +# semi-colon delimited (e.g. --compiler-options;-Wall) +# +# +# +# :: +# +# CUDA_PROPAGATE_HOST_FLAGS (Default ON) +# -- Set to ON to propagate CMAKE_{C,CXX}_FLAGS and their configuration +# dependent counterparts (e.g. CMAKE_C_FLAGS_DEBUG) automatically to the +# host compiler through nvcc's -Xcompiler flag. This helps make the +# generated host code match the rest of the system better. Sometimes +# certain flags give nvcc problems, and this will help you turn the flag +# propagation off. This does not affect the flags supplied directly to nvcc +# via CUDA_NVCC_FLAGS or through the OPTION flags specified through +# CUDA_ADD_LIBRARY, CUDA_ADD_EXECUTABLE, or CUDA_WRAP_SRCS. Flags used for +# shared library compilation are not affected by this flag. +# +# +# +# :: +# +# CUDA_SEPARABLE_COMPILATION (Default OFF) +# -- If set this will enable separable compilation for all CUDA runtime object +# files. If used outside of CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY +# (e.g. calling CUDA_WRAP_SRCS directly), +# CUDA_COMPUTE_SEPARABLE_COMPILATION_OBJECT_FILE_NAME and +# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS should be called. +# +# +# +# :: +# +# CUDA_VERBOSE_BUILD (Default OFF) +# -- Set to ON to see all the commands used when building the CUDA file. When +# using a Makefile generator the value defaults to VERBOSE (run make +# VERBOSE=1 to see output), although setting CUDA_VERBOSE_BUILD to ON will +# always print the output. +# +# # # The script creates the following macros (in alphebetical order): # -# CUDA_ADD_CUFFT_TO_TARGET( cuda_target ) -# -- Adds the cufft library to the target (can be any target). Handles whether -# you are in emulation mode or not. -# -# CUDA_ADD_CUBLAS_TO_TARGET( cuda_target ) -# -- Adds the cublas library to the target (can be any target). Handles -# whether you are in emulation mode or not. -# -# CUDA_ADD_EXECUTABLE( cuda_target file0 file1 ... -# [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] [OPTIONS ...] ) -# -- Creates an executable "cuda_target" which is made up of the files -# specified. All of the non CUDA C files are compiled using the standard -# build rules specified by CMAKE and the cuda files are compiled to object -# files using nvcc and the host compiler. In addition CUDA_INCLUDE_DIRS is -# added automatically to include_directories(). Some standard CMake target -# calls can be used on the target after calling this macro -# (e.g. set_target_properties and target_link_libraries), but setting -# properties that adjust compilation flags will not affect code compiled by -# nvcc. Such flags should be modified before calling CUDA_ADD_EXECUTABLE, -# CUDA_ADD_LIBRARY or CUDA_WRAP_SRCS. -# -# CUDA_ADD_LIBRARY( cuda_target file0 file1 ... -# [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] [OPTIONS ...] ) -# -- Same as CUDA_ADD_EXECUTABLE except that a library is created. -# -# CUDA_BUILD_CLEAN_TARGET() -# -- Creates a convience target that deletes all the dependency files -# generated. You should make clean after running this target to ensure the -# dependency files get regenerated. -# -# CUDA_COMPILE( generated_files file0 file1 ... [STATIC | SHARED | MODULE] -# [OPTIONS ...] ) -# -- Returns a list of generated files from the input source files to be used -# with ADD_LIBRARY or ADD_EXECUTABLE. -# -# CUDA_COMPILE_PTX( generated_files file0 file1 ... [OPTIONS ...] ) -# -- Returns a list of PTX files generated from the input source files. -# -# CUDA_COMPUTE_SEPARABLE_COMPILATION_OBJECT_FILE_NAME( output_file_var -# cuda_target -# object_files ) -# -- Compute the name of the intermediate link file used for separable -# compilation. This file name is typically passed into -# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS. output_file_var is produced -# based on cuda_target the list of objects files that need separable -# compilation as specified by object_files. If the object_files list is -# empty, then output_file_var will be empty. This function is called -# automatically for CUDA_ADD_LIBRARY and CUDA_ADD_EXECUTABLE. Note that -# this is a function and not a macro. -# -# CUDA_INCLUDE_DIRECTORIES( path0 path1 ... ) -# -- Sets the directories that should be passed to nvcc -# (e.g. nvcc -Ipath0 -Ipath1 ... ). These paths usually contain other .cu -# files. -# -# -# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS( output_file_var cuda_target -# nvcc_flags object_files) -# -# -- Generates the link object required by separable compilation from the given -# object files. This is called automatically for CUDA_ADD_EXECUTABLE and -# CUDA_ADD_LIBRARY, but can be called manually when using CUDA_WRAP_SRCS -# directly. When called from CUDA_ADD_LIBRARY or CUDA_ADD_EXECUTABLE the -# nvcc_flags passed in are the same as the flags passed in via the OPTIONS -# argument. The only nvcc flag added automatically is the bitness flag as -# specified by CUDA_64_BIT_DEVICE_CODE. Note that this is a function -# instead of a macro. -# -# CUDA_WRAP_SRCS ( cuda_target format generated_files file0 file1 ... -# [STATIC | SHARED | MODULE] [OPTIONS ...] ) -# -- This is where all the magic happens. CUDA_ADD_EXECUTABLE, -# CUDA_ADD_LIBRARY, CUDA_COMPILE, and CUDA_COMPILE_PTX all call this -# function under the hood. -# -# Given the list of files (file0 file1 ... fileN) this macro generates -# custom commands that generate either PTX or linkable objects (use "PTX" or -# "OBJ" for the format argument to switch). Files that don't end with .cu -# or have the HEADER_FILE_ONLY property are ignored. -# -# The arguments passed in after OPTIONS are extra command line options to -# give to nvcc. You can also specify per configuration options by -# specifying the name of the configuration followed by the options. General -# options must preceed configuration specific options. Not all -# configurations need to be specified, only the ones provided will be used. -# -# OPTIONS -DFLAG=2 "-DFLAG_OTHER=space in flag" -# DEBUG -g -# RELEASE --use_fast_math -# RELWITHDEBINFO --use_fast_math;-g -# MINSIZEREL --use_fast_math -# -# For certain configurations (namely VS generating object files with -# CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE set to ON), no generated file will -# be produced for the given cuda file. This is because when you add the -# cuda file to Visual Studio it knows that this file produces an object file -# and will link in the resulting object file automatically. -# -# This script will also generate a separate cmake script that is used at -# build time to invoke nvcc. This is for several reasons. -# -# 1. nvcc can return negative numbers as return values which confuses -# Visual Studio into thinking that the command succeeded. The script now -# checks the error codes and produces errors when there was a problem. -# -# 2. nvcc has been known to not delete incomplete results when it -# encounters problems. This confuses build systems into thinking the -# target was generated when in fact an unusable file exists. The script -# now deletes the output files if there was an error. -# -# 3. By putting all the options that affect the build into a file and then -# make the build rule dependent on the file, the output files will be -# regenerated when the options change. -# -# This script also looks at optional arguments STATIC, SHARED, or MODULE to -# determine when to target the object compilation for a shared library. -# BUILD_SHARED_LIBS is ignored in CUDA_WRAP_SRCS, but it is respected in -# CUDA_ADD_LIBRARY. On some systems special flags are added for building -# objects intended for shared libraries. A preprocessor macro, -# <target_name>_EXPORTS is defined when a shared library compilation is -# detected. -# -# Flags passed into add_definitions with -D or /D are passed along to nvcc. +# :: +# +# CUDA_ADD_CUFFT_TO_TARGET( cuda_target ) +# -- Adds the cufft library to the target (can be any target). Handles whether +# you are in emulation mode or not. +# +# +# +# :: +# +# CUDA_ADD_CUBLAS_TO_TARGET( cuda_target ) +# -- Adds the cublas library to the target (can be any target). Handles +# whether you are in emulation mode or not. +# +# +# +# :: +# +# CUDA_ADD_EXECUTABLE( cuda_target file0 file1 ... +# [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] [OPTIONS ...] ) +# -- Creates an executable "cuda_target" which is made up of the files +# specified. All of the non CUDA C files are compiled using the standard +# build rules specified by CMAKE and the cuda files are compiled to object +# files using nvcc and the host compiler. In addition CUDA_INCLUDE_DIRS is +# added automatically to include_directories(). Some standard CMake target +# calls can be used on the target after calling this macro +# (e.g. set_target_properties and target_link_libraries), but setting +# properties that adjust compilation flags will not affect code compiled by +# nvcc. Such flags should be modified before calling CUDA_ADD_EXECUTABLE, +# CUDA_ADD_LIBRARY or CUDA_WRAP_SRCS. +# +# +# +# :: +# +# CUDA_ADD_LIBRARY( cuda_target file0 file1 ... +# [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] [OPTIONS ...] ) +# -- Same as CUDA_ADD_EXECUTABLE except that a library is created. +# +# +# +# :: +# +# CUDA_BUILD_CLEAN_TARGET() +# -- Creates a convience target that deletes all the dependency files +# generated. You should make clean after running this target to ensure the +# dependency files get regenerated. +# +# +# +# :: +# +# CUDA_COMPILE( generated_files file0 file1 ... [STATIC | SHARED | MODULE] +# [OPTIONS ...] ) +# -- Returns a list of generated files from the input source files to be used +# with ADD_LIBRARY or ADD_EXECUTABLE. +# +# +# +# :: +# +# CUDA_COMPILE_PTX( generated_files file0 file1 ... [OPTIONS ...] ) +# -- Returns a list of PTX files generated from the input source files. +# +# +# +# :: +# +# CUDA_COMPUTE_SEPARABLE_COMPILATION_OBJECT_FILE_NAME( output_file_var +# cuda_target +# object_files ) +# -- Compute the name of the intermediate link file used for separable +# compilation. This file name is typically passed into +# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS. output_file_var is produced +# based on cuda_target the list of objects files that need separable +# compilation as specified by object_files. If the object_files list is +# empty, then output_file_var will be empty. This function is called +# automatically for CUDA_ADD_LIBRARY and CUDA_ADD_EXECUTABLE. Note that +# this is a function and not a macro. +# +# +# +# :: +# +# CUDA_INCLUDE_DIRECTORIES( path0 path1 ... ) +# -- Sets the directories that should be passed to nvcc +# (e.g. nvcc -Ipath0 -Ipath1 ... ). These paths usually contain other .cu +# files. +# +# +# +# +# +# :: +# +# CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS( output_file_var cuda_target +# nvcc_flags object_files) +# +# +# +# :: +# +# -- Generates the link object required by separable compilation from the given +# object files. This is called automatically for CUDA_ADD_EXECUTABLE and +# CUDA_ADD_LIBRARY, but can be called manually when using CUDA_WRAP_SRCS +# directly. When called from CUDA_ADD_LIBRARY or CUDA_ADD_EXECUTABLE the +# nvcc_flags passed in are the same as the flags passed in via the OPTIONS +# argument. The only nvcc flag added automatically is the bitness flag as +# specified by CUDA_64_BIT_DEVICE_CODE. Note that this is a function +# instead of a macro. +# +# +# +# :: +# +# CUDA_WRAP_SRCS ( cuda_target format generated_files file0 file1 ... +# [STATIC | SHARED | MODULE] [OPTIONS ...] ) +# -- This is where all the magic happens. CUDA_ADD_EXECUTABLE, +# CUDA_ADD_LIBRARY, CUDA_COMPILE, and CUDA_COMPILE_PTX all call this +# function under the hood. +# +# +# +# :: +# +# Given the list of files (file0 file1 ... fileN) this macro generates +# custom commands that generate either PTX or linkable objects (use "PTX" or +# "OBJ" for the format argument to switch). Files that don't end with .cu +# or have the HEADER_FILE_ONLY property are ignored. +# +# +# +# :: +# +# The arguments passed in after OPTIONS are extra command line options to +# give to nvcc. You can also specify per configuration options by +# specifying the name of the configuration followed by the options. General +# options must preceed configuration specific options. Not all +# configurations need to be specified, only the ones provided will be used. +# +# +# +# :: +# +# OPTIONS -DFLAG=2 "-DFLAG_OTHER=space in flag" +# DEBUG -g +# RELEASE --use_fast_math +# RELWITHDEBINFO --use_fast_math;-g +# MINSIZEREL --use_fast_math +# +# +# +# :: +# +# For certain configurations (namely VS generating object files with +# CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE set to ON), no generated file will +# be produced for the given cuda file. This is because when you add the +# cuda file to Visual Studio it knows that this file produces an object file +# and will link in the resulting object file automatically. +# +# +# +# :: +# +# This script will also generate a separate cmake script that is used at +# build time to invoke nvcc. This is for several reasons. +# +# +# +# :: +# +# 1. nvcc can return negative numbers as return values which confuses +# Visual Studio into thinking that the command succeeded. The script now +# checks the error codes and produces errors when there was a problem. +# +# +# +# :: +# +# 2. nvcc has been known to not delete incomplete results when it +# encounters problems. This confuses build systems into thinking the +# target was generated when in fact an unusable file exists. The script +# now deletes the output files if there was an error. +# +# +# +# :: +# +# 3. By putting all the options that affect the build into a file and then +# make the build rule dependent on the file, the output files will be +# regenerated when the options change. +# +# +# +# :: +# +# This script also looks at optional arguments STATIC, SHARED, or MODULE to +# determine when to target the object compilation for a shared library. +# BUILD_SHARED_LIBS is ignored in CUDA_WRAP_SRCS, but it is respected in +# CUDA_ADD_LIBRARY. On some systems special flags are added for building +# objects intended for shared libraries. A preprocessor macro, +# <target_name>_EXPORTS is defined when a shared library compilation is +# detected. +# +# +# +# :: +# +# Flags passed into add_definitions with -D or /D are passed along to nvcc. +# +# # # The script defines the following variables: # -# CUDA_VERSION_MAJOR -- The major version of cuda as reported by nvcc. -# CUDA_VERSION_MINOR -- The minor version. -# CUDA_VERSION -# CUDA_VERSION_STRING -- CUDA_VERSION_MAJOR.CUDA_VERSION_MINOR -# -# CUDA_TOOLKIT_ROOT_DIR -- Path to the CUDA Toolkit (defined if not set). -# CUDA_SDK_ROOT_DIR -- Path to the CUDA SDK. Use this to find files in the -# SDK. This script will not directly support finding -# specific libraries or headers, as that isn't -# supported by NVIDIA. If you want to change -# libraries when the path changes see the -# FindCUDA.cmake script for an example of how to clear -# these variables. There are also examples of how to -# use the CUDA_SDK_ROOT_DIR to locate headers or -# libraries, if you so choose (at your own risk). -# CUDA_INCLUDE_DIRS -- Include directory for cuda headers. Added automatically -# for CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY. -# CUDA_LIBRARIES -- Cuda RT library. -# CUDA_CUFFT_LIBRARIES -- Device or emulation library for the Cuda FFT -# implementation (alternative to: -# CUDA_ADD_CUFFT_TO_TARGET macro) -# CUDA_CUBLAS_LIBRARIES -- Device or emulation library for the Cuda BLAS -# implementation (alterative to: -# CUDA_ADD_CUBLAS_TO_TARGET macro). -# CUDA_cupti_LIBRARY -- CUDA Profiling Tools Interface library. -# Only available for CUDA version 4.0+. -# CUDA_curand_LIBRARY -- CUDA Random Number Generation library. -# Only available for CUDA version 3.2+. -# CUDA_cusparse_LIBRARY -- CUDA Sparse Matrix library. -# Only available for CUDA version 3.2+. -# CUDA_npp_LIBRARY -- NVIDIA Performance Primitives library. -# Only available for CUDA version 4.0+. -# CUDA_nvcuvenc_LIBRARY -- CUDA Video Encoder library. -# Only available for CUDA version 3.2+. -# Windows only. -# CUDA_nvcuvid_LIBRARY -- CUDA Video Decoder library. -# Only available for CUDA version 3.2+. -# Windows only. -# -# -# James Bigler, NVIDIA Corp (nvidia.com - jbigler) -# Abe Stephens, SCI Institute -- http://www.sci.utah.edu/~abe/FindCuda.html -# -# Copyright (c) 2008 - 2009 NVIDIA Corporation. All rights reserved. -# -# Copyright (c) 2007-2009 -# Scientific Computing and Imaging Institute, University of Utah -# -# This code is licensed under the MIT License. See the FindCUDA.cmake script -# for the text of the license. +# :: +# +# CUDA_VERSION_MAJOR -- The major version of cuda as reported by nvcc. +# CUDA_VERSION_MINOR -- The minor version. +# CUDA_VERSION +# CUDA_VERSION_STRING -- CUDA_VERSION_MAJOR.CUDA_VERSION_MINOR +# +# +# +# :: +# +# CUDA_TOOLKIT_ROOT_DIR -- Path to the CUDA Toolkit (defined if not set). +# CUDA_SDK_ROOT_DIR -- Path to the CUDA SDK. Use this to find files in the +# SDK. This script will not directly support finding +# specific libraries or headers, as that isn't +# supported by NVIDIA. If you want to change +# libraries when the path changes see the +# FindCUDA.cmake script for an example of how to clear +# these variables. There are also examples of how to +# use the CUDA_SDK_ROOT_DIR to locate headers or +# libraries, if you so choose (at your own risk). +# CUDA_INCLUDE_DIRS -- Include directory for cuda headers. Added automatically +# for CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY. +# CUDA_LIBRARIES -- Cuda RT library. +# CUDA_CUFFT_LIBRARIES -- Device or emulation library for the Cuda FFT +# implementation (alternative to: +# CUDA_ADD_CUFFT_TO_TARGET macro) +# CUDA_CUBLAS_LIBRARIES -- Device or emulation library for the Cuda BLAS +# implementation (alterative to: +# CUDA_ADD_CUBLAS_TO_TARGET macro). +# CUDA_cupti_LIBRARY -- CUDA Profiling Tools Interface library. +# Only available for CUDA version 4.0+. +# CUDA_curand_LIBRARY -- CUDA Random Number Generation library. +# Only available for CUDA version 3.2+. +# CUDA_cusparse_LIBRARY -- CUDA Sparse Matrix library. +# Only available for CUDA version 3.2+. +# CUDA_npp_LIBRARY -- NVIDIA Performance Primitives library. +# Only available for CUDA version 4.0+. +# CUDA_nppc_LIBRARY -- NVIDIA Performance Primitives library (core). +# Only available for CUDA version 5.5+. +# CUDA_nppi_LIBRARY -- NVIDIA Performance Primitives library (image processing). +# Only available for CUDA version 5.5+. +# CUDA_npps_LIBRARY -- NVIDIA Performance Primitives library (signal processing). +# Only available for CUDA version 5.5+. +# CUDA_nvcuvenc_LIBRARY -- CUDA Video Encoder library. +# Only available for CUDA version 3.2+. +# Windows only. +# CUDA_nvcuvid_LIBRARY -- CUDA Video Decoder library. +# Only available for CUDA version 3.2+. +# Windows only. +# +# +# +# +# +# :: +# +# James Bigler, NVIDIA Corp (nvidia.com - jbigler) +# Abe Stephens, SCI Institute -- http://www.sci.utah.edu/~abe/FindCuda.html +# +# +# +# :: +# +# Copyright (c) 2008 - 2009 NVIDIA Corporation. All rights reserved. +# +# +# +# :: +# +# Copyright (c) 2007-2009 +# Scientific Computing and Imaging Institute, University of Utah +# +# +# +# :: +# +# This code is licensed under the MIT License. See the FindCUDA.cmake script +# for the text of the license. # The MIT License # @@ -496,6 +670,9 @@ if(NOT "${CUDA_TOOLKIT_ROOT_DIR}" STREQUAL "${CUDA_TOOLKIT_ROOT_DIR_INTERNAL}") unset(CUDA_curand_LIBRARY CACHE) unset(CUDA_cusparse_LIBRARY CACHE) unset(CUDA_npp_LIBRARY CACHE) + unset(CUDA_nppc_LIBRARY CACHE) + unset(CUDA_nppi_LIBRARY CACHE) + unset(CUDA_npps_LIBRARY CACHE) unset(CUDA_nvcuvenc_LIBRARY CACHE) unset(CUDA_nvcuvid_LIBRARY CACHE) endif() @@ -700,7 +877,13 @@ if(NOT CUDA_VERSION VERSION_LESS "3.2") find_cuda_helper_libs(nvcuvid) endif() endif() -if(NOT CUDA_VERSION VERSION_LESS "4.0") +if(CUDA_VERSION VERSION_GREATER "5.0") + # In CUDA 5.5 NPP was splitted onto 3 separate libraries. + find_cuda_helper_libs(nppc) + find_cuda_helper_libs(nppi) + find_cuda_helper_libs(npps) + set(CUDA_npp_LIBRARY "${CUDA_nppc_LIBRARY};${CUDA_nppi_LIBRARY};${CUDA_npps_LIBRARY}") +elseif(NOT CUDA_VERSION VERSION_LESS "4.0") find_cuda_helper_libs(npp) endif() diff --git a/Modules/FindCURL.cmake b/Modules/FindCURL.cmake index 0fb8f45..209fd87 100644 --- a/Modules/FindCURL.cmake +++ b/Modules/FindCURL.cmake @@ -1,10 +1,17 @@ -# - Find curl +#.rst: +# FindCURL +# -------- +# +# Find curl +# # Find the native CURL headers and libraries. # -# CURL_INCLUDE_DIRS - where to find curl/curl.h, etc. -# CURL_LIBRARIES - List of libraries when using curl. -# CURL_FOUND - True if curl found. -# CURL_VERSION_STRING - the version of curl found (since CMake 2.8.8) +# :: +# +# CURL_INCLUDE_DIRS - where to find curl/curl.h, etc. +# CURL_LIBRARIES - List of libraries when using curl. +# CURL_FOUND - True if curl found. +# CURL_VERSION_STRING - the version of curl found (since CMake 2.8.8) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindCVS.cmake b/Modules/FindCVS.cmake index 07079bb..6f545df 100644 --- a/Modules/FindCVS.cmake +++ b/Modules/FindCVS.cmake @@ -1,11 +1,24 @@ +#.rst: +# FindCVS +# ------- +# +# +# # The module defines the following variables: -# CVS_EXECUTABLE - path to cvs command line client -# CVS_FOUND - true if the command line client was found +# +# :: +# +# CVS_EXECUTABLE - path to cvs command line client +# CVS_FOUND - true if the command line client was found +# # Example usage: -# find_package(CVS) -# if(CVS_FOUND) -# message("CVS found: ${CVS_EXECUTABLE}") -# endif() +# +# :: +# +# find_package(CVS) +# if(CVS_FOUND) +# message("CVS found: ${CVS_EXECUTABLE}") +# endif() #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/FindCoin3D.cmake b/Modules/FindCoin3D.cmake index bbda87b..b5c3a96 100644 --- a/Modules/FindCoin3D.cmake +++ b/Modules/FindCoin3D.cmake @@ -1,13 +1,20 @@ -# - Find Coin3D (Open Inventor) -# Coin3D is an implementation of the Open Inventor API. -# It provides data structures and algorithms for 3D visualization +#.rst: +# FindCoin3D +# ---------- +# +# Find Coin3D (Open Inventor) +# +# Coin3D is an implementation of the Open Inventor API. It provides +# data structures and algorithms for 3D visualization # http://www.coin3d.org/ # # This module defines the following variables -# COIN3D_FOUND - system has Coin3D - Open Inventor -# COIN3D_INCLUDE_DIRS - where the Inventor include directory can be found -# COIN3D_LIBRARIES - Link to this to use Coin3D # +# :: +# +# COIN3D_FOUND - system has Coin3D - Open Inventor +# COIN3D_INCLUDE_DIRS - where the Inventor include directory can be found +# COIN3D_LIBRARIES - Link to this to use Coin3D #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/FindCups.cmake b/Modules/FindCups.cmake index 53ab031..4b55d6a 100644 --- a/Modules/FindCups.cmake +++ b/Modules/FindCups.cmake @@ -1,12 +1,19 @@ -# - Try to find the Cups printing system +#.rst: +# FindCups +# -------- +# +# Try to find the Cups printing system +# # Once done this will define # -# CUPS_FOUND - system has Cups -# CUPS_INCLUDE_DIR - the Cups include directory -# CUPS_LIBRARIES - Libraries needed to use Cups -# CUPS_VERSION_STRING - version of Cups found (since CMake 2.8.8) -# Set CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE to TRUE if you need a version which -# features this function (i.e. at least 1.1.19) +# :: +# +# CUPS_FOUND - system has Cups +# CUPS_INCLUDE_DIR - the Cups include directory +# CUPS_LIBRARIES - Libraries needed to use Cups +# CUPS_VERSION_STRING - version of Cups found (since CMake 2.8.8) +# Set CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE to TRUE if you need a version which +# features this function (i.e. at least 1.1.19) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindCurses.cmake b/Modules/FindCurses.cmake index 09d1ba4..971edb7 100644 --- a/Modules/FindCurses.cmake +++ b/Modules/FindCurses.cmake @@ -1,16 +1,26 @@ -# - Find the curses include file and library +#.rst: +# FindCurses +# ---------- # -# CURSES_FOUND - system has Curses -# CURSES_INCLUDE_DIR - the Curses include directory -# CURSES_LIBRARIES - The libraries needed to use Curses -# CURSES_HAVE_CURSES_H - true if curses.h is available -# CURSES_HAVE_NCURSES_H - true if ncurses.h is available -# CURSES_HAVE_NCURSES_NCURSES_H - true if ncurses/ncurses.h is available -# CURSES_HAVE_NCURSES_CURSES_H - true if ncurses/curses.h is available -# CURSES_LIBRARY - set for backwards compatibility with 2.4 CMake +# Find the curses include file and library # -# Set CURSES_NEED_NCURSES to TRUE before the find_package() command if NCurses -# functionality is required. +# +# +# :: +# +# CURSES_FOUND - system has Curses +# CURSES_INCLUDE_DIR - the Curses include directory +# CURSES_LIBRARIES - The libraries needed to use Curses +# CURSES_HAVE_CURSES_H - true if curses.h is available +# CURSES_HAVE_NCURSES_H - true if ncurses.h is available +# CURSES_HAVE_NCURSES_NCURSES_H - true if ncurses/ncurses.h is available +# CURSES_HAVE_NCURSES_CURSES_H - true if ncurses/curses.h is available +# CURSES_LIBRARY - set for backwards compatibility with 2.4 CMake +# +# +# +# Set CURSES_NEED_NCURSES to TRUE before the find_package() command if +# NCurses functionality is required. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindCxxTest.cmake b/Modules/FindCxxTest.cmake index 48de64a..bc0dfbc 100644 --- a/Modules/FindCxxTest.cmake +++ b/Modules/FindCxxTest.cmake @@ -1,88 +1,138 @@ -# - Find CxxTest -# Find the CxxTest suite and declare a helper macro for creating unit tests -# and integrating them with CTest. -# For more details on CxxTest see http://cxxtest.tigris.org +#.rst: +# FindCxxTest +# ----------- +# +# Find CxxTest +# +# Find the CxxTest suite and declare a helper macro for creating unit +# tests and integrating them with CTest. For more details on CxxTest +# see http://cxxtest.tigris.org # # INPUT Variables # -# CXXTEST_USE_PYTHON [deprecated since 1.3] -# Only used in the case both Python & Perl -# are detected on the system to control -# which CxxTest code generator is used. -# Valid only for CxxTest version 3. +# :: +# +# CXXTEST_USE_PYTHON [deprecated since 1.3] +# Only used in the case both Python & Perl +# are detected on the system to control +# which CxxTest code generator is used. +# Valid only for CxxTest version 3. +# +# +# +# :: +# +# NOTE: In older versions of this Find Module, +# this variable controlled if the Python test +# generator was used instead of the Perl one, +# regardless of which scripting language the +# user had installed. +# +# +# +# :: +# +# CXXTEST_TESTGEN_ARGS (since CMake 2.8.3) +# Specify a list of options to pass to the CxxTest code +# generator. If not defined, --error-printer is +# passed. # -# NOTE: In older versions of this Find Module, -# this variable controlled if the Python test -# generator was used instead of the Perl one, -# regardless of which scripting language the -# user had installed. # -# CXXTEST_TESTGEN_ARGS (since CMake 2.8.3) -# Specify a list of options to pass to the CxxTest code -# generator. If not defined, --error-printer is -# passed. # # OUTPUT Variables # -# CXXTEST_FOUND -# True if the CxxTest framework was found -# CXXTEST_INCLUDE_DIRS -# Where to find the CxxTest include directory -# CXXTEST_PERL_TESTGEN_EXECUTABLE -# The perl-based test generator -# CXXTEST_PYTHON_TESTGEN_EXECUTABLE -# The python-based test generator -# CXXTEST_TESTGEN_EXECUTABLE (since CMake 2.8.3) -# The test generator that is actually used (chosen using user preferences -# and interpreters found in the system) -# CXXTEST_TESTGEN_INTERPRETER (since CMake 2.8.3) -# The full path to the Perl or Python executable on the system +# :: +# +# CXXTEST_FOUND +# True if the CxxTest framework was found +# CXXTEST_INCLUDE_DIRS +# Where to find the CxxTest include directory +# CXXTEST_PERL_TESTGEN_EXECUTABLE +# The perl-based test generator +# CXXTEST_PYTHON_TESTGEN_EXECUTABLE +# The python-based test generator +# CXXTEST_TESTGEN_EXECUTABLE (since CMake 2.8.3) +# The test generator that is actually used (chosen using user preferences +# and interpreters found in the system) +# CXXTEST_TESTGEN_INTERPRETER (since CMake 2.8.3) +# The full path to the Perl or Python executable on the system +# +# # # MACROS for optional use by CMake users: # -# CXXTEST_ADD_TEST(<test_name> <gen_source_file> <input_files_to_testgen...>) -# Creates a CxxTest runner and adds it to the CTest testing suite -# Parameters: -# test_name The name of the test -# gen_source_file The generated source filename to be -# generated by CxxTest -# input_files_to_testgen The list of header files containing the -# CxxTest::TestSuite's to be included in -# this runner -# -# #============== -# Example Usage: -# -# find_package(CxxTest) -# if(CXXTEST_FOUND) -# include_directories(${CXXTEST_INCLUDE_DIR}) -# enable_testing() -# -# CXXTEST_ADD_TEST(unittest_foo foo_test.cc -# ${CMAKE_CURRENT_SOURCE_DIR}/foo_test.h) -# target_link_libraries(unittest_foo foo) # as needed -# endif() -# -# This will (if CxxTest is found): -# 1. Invoke the testgen executable to autogenerate foo_test.cc in the -# binary tree from "foo_test.h" in the current source directory. -# 2. Create an executable and test called unittest_foo. -# -# #============= -# Example foo_test.h: -# -# #include <cxxtest/TestSuite.h> -# -# class MyTestSuite : public CxxTest::TestSuite -# { -# public: -# void testAddition( void ) -# { -# TS_ASSERT( 1 + 1 > 1 ); -# TS_ASSERT_EQUALS( 1 + 1, 2 ); -# } -# }; +# :: +# +# CXXTEST_ADD_TEST(<test_name> <gen_source_file> <input_files_to_testgen...>) +# Creates a CxxTest runner and adds it to the CTest testing suite +# Parameters: +# test_name The name of the test +# gen_source_file The generated source filename to be +# generated by CxxTest +# input_files_to_testgen The list of header files containing the +# CxxTest::TestSuite's to be included in +# this runner +# +# +# +# :: +# +# #============== +# Example Usage: +# +# +# +# :: +# +# find_package(CxxTest) +# if(CXXTEST_FOUND) +# include_directories(${CXXTEST_INCLUDE_DIR}) +# enable_testing() +# +# +# +# :: +# +# CXXTEST_ADD_TEST(unittest_foo foo_test.cc +# ${CMAKE_CURRENT_SOURCE_DIR}/foo_test.h) +# target_link_libraries(unittest_foo foo) # as needed +# endif() +# +# +# +# :: +# +# This will (if CxxTest is found): +# 1. Invoke the testgen executable to autogenerate foo_test.cc in the +# binary tree from "foo_test.h" in the current source directory. +# 2. Create an executable and test called unittest_foo. +# +# +# +# :: +# +# #============= +# Example foo_test.h: +# +# +# +# :: +# +# #include <cxxtest/TestSuite.h> +# +# +# +# :: # +# class MyTestSuite : public CxxTest::TestSuite +# { +# public: +# void testAddition( void ) +# { +# TS_ASSERT( 1 + 1 > 1 ); +# TS_ASSERT_EQUALS( 1 + 1, 2 ); +# } +# }; #============================================================================= # Copyright 2008-2010 Kitware, Inc. diff --git a/Modules/FindCygwin.cmake b/Modules/FindCygwin.cmake index d7ab7cc..5cb533b 100644 --- a/Modules/FindCygwin.cmake +++ b/Modules/FindCygwin.cmake @@ -1,5 +1,8 @@ -# - this module looks for Cygwin +#.rst: +# FindCygwin +# ---------- # +# this module looks for Cygwin #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindDCMTK.cmake b/Modules/FindDCMTK.cmake index 361d09e..91aafbb 100644 --- a/Modules/FindDCMTK.cmake +++ b/Modules/FindDCMTK.cmake @@ -1,5 +1,8 @@ -# - find DCMTK libraries and applications +#.rst: +# FindDCMTK +# --------- # +# find DCMTK libraries and applications # DCMTK_INCLUDE_DIRS - Directories to include to use DCMTK # DCMTK_LIBRARIES - Files to link against to use DCMTK diff --git a/Modules/FindDart.cmake b/Modules/FindDart.cmake index a2b2926..ea01fc2 100644 --- a/Modules/FindDart.cmake +++ b/Modules/FindDart.cmake @@ -1,7 +1,11 @@ -# - Find DART -# This module looks for the dart testing software and sets DART_ROOT -# to point to where it found it. +#.rst: +# FindDart +# -------- # +# Find DART +# +# This module looks for the dart testing software and sets DART_ROOT to +# point to where it found it. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindDevIL.cmake b/Modules/FindDevIL.cmake index dacc604..22a82b5 100644 --- a/Modules/FindDevIL.cmake +++ b/Modules/FindDevIL.cmake @@ -1,23 +1,32 @@ +#.rst: +# FindDevIL +# --------- +# +# +# # This module locates the developer's image library. # http://openil.sourceforge.net/ # # This module sets: -# IL_LIBRARIES - the name of the IL library. These include the full path to -# the core DevIL library. This one has to be linked into the -# application. -# ILU_LIBRARIES - the name of the ILU library. Again, the full path. This -# library is for filters and effects, not actual loading. It -# doesn't have to be linked if the functionality it provides -# is not used. -# ILUT_LIBRARIES - the name of the ILUT library. Full path. This part of the -# library interfaces with OpenGL. It is not strictly needed -# in applications. -# IL_INCLUDE_DIR - where to find the il.h, ilu.h and ilut.h files. -# IL_FOUND - this is set to TRUE if all the above variables were set. -# This will be set to false if ILU or ILUT are not found, -# even if they are not needed. In most systems, if one -# library is found all the others are as well. That's the -# way the DevIL developers release it. +# +# :: +# +# IL_LIBRARIES - the name of the IL library. These include the full path to +# the core DevIL library. This one has to be linked into the +# application. +# ILU_LIBRARIES - the name of the ILU library. Again, the full path. This +# library is for filters and effects, not actual loading. It +# doesn't have to be linked if the functionality it provides +# is not used. +# ILUT_LIBRARIES - the name of the ILUT library. Full path. This part of the +# library interfaces with OpenGL. It is not strictly needed +# in applications. +# IL_INCLUDE_DIR - where to find the il.h, ilu.h and ilut.h files. +# IL_FOUND - this is set to TRUE if all the above variables were set. +# This will be set to false if ILU or ILUT are not found, +# even if they are not needed. In most systems, if one +# library is found all the others are as well. That's the +# way the DevIL developers release it. #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/FindDoxygen.cmake b/Modules/FindDoxygen.cmake index d2ede6a..a456d9c 100644 --- a/Modules/FindDoxygen.cmake +++ b/Modules/FindDoxygen.cmake @@ -1,23 +1,36 @@ -# - This module looks for Doxygen and the path to Graphviz's dot +#.rst: +# FindDoxygen +# ----------- +# +# This module looks for Doxygen and the path to Graphviz's dot +# # Doxygen is a documentation generation tool. Please see # http://www.doxygen.org # # This module accepts the following optional variables: # -# DOXYGEN_SKIP_DOT = If true this module will skip trying to find Dot -# (an optional component often used by Doxygen) +# :: +# +# DOXYGEN_SKIP_DOT = If true this module will skip trying to find Dot +# (an optional component often used by Doxygen) +# +# # # This modules defines the following variables: # -# DOXYGEN_EXECUTABLE = The path to the doxygen command. -# DOXYGEN_FOUND = Was Doxygen found or not? -# DOXYGEN_VERSION = The version reported by doxygen --version +# :: +# +# DOXYGEN_EXECUTABLE = The path to the doxygen command. +# DOXYGEN_FOUND = Was Doxygen found or not? +# DOXYGEN_VERSION = The version reported by doxygen --version +# # -# DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen. -# DOXYGEN_DOT_FOUND = Was Dot found or not? -# DOXYGEN_DOT_PATH = The path to dot not including the executable # +# :: # +# DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen. +# DOXYGEN_DOT_FOUND = Was Dot found or not? +# DOXYGEN_DOT_PATH = The path to dot not including the executable #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindEXPAT.cmake b/Modules/FindEXPAT.cmake index c681a0d..6183af8 100644 --- a/Modules/FindEXPAT.cmake +++ b/Modules/FindEXPAT.cmake @@ -1,9 +1,16 @@ -# - Find expat +#.rst: +# FindEXPAT +# --------- +# +# Find expat +# # Find the native EXPAT headers and libraries. # -# EXPAT_INCLUDE_DIRS - where to find expat.h, etc. -# EXPAT_LIBRARIES - List of libraries when using expat. -# EXPAT_FOUND - True if expat found. +# :: +# +# EXPAT_INCLUDE_DIRS - where to find expat.h, etc. +# EXPAT_LIBRARIES - List of libraries when using expat. +# EXPAT_FOUND - True if expat found. #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindFLEX.cmake b/Modules/FindFLEX.cmake index 79a3a1e..c837c52 100644 --- a/Modules/FindFLEX.cmake +++ b/Modules/FindFLEX.cmake @@ -1,53 +1,92 @@ -# - Find flex executable and provides a macro to generate custom build rules +#.rst: +# FindFLEX +# -------- +# +# Find flex executable and provides a macro to generate custom build rules +# +# # # The module defines the following variables: -# FLEX_FOUND - true is flex executable is found -# FLEX_EXECUTABLE - the path to the flex executable -# FLEX_VERSION - the version of flex -# FLEX_LIBRARIES - The flex libraries -# FLEX_INCLUDE_DIRS - The path to the flex headers +# +# :: +# +# FLEX_FOUND - true is flex executable is found +# FLEX_EXECUTABLE - the path to the flex executable +# FLEX_VERSION - the version of flex +# FLEX_LIBRARIES - The flex libraries +# FLEX_INCLUDE_DIRS - The path to the flex headers +# +# # # The minimum required version of flex can be specified using the -# standard syntax, e.g. find_package(FLEX 2.5.13) +# standard syntax, e.g. find_package(FLEX 2.5.13) +# # # # If flex is found on the system, the module provides the macro: -# FLEX_TARGET(Name FlexInput FlexOutput [COMPILE_FLAGS <string>]) -# which creates a custom command to generate the <FlexOutput> file from -# the <FlexInput> file. If COMPILE_FLAGS option is specified, the next -# parameter is added to the flex command line. Name is an alias used to -# get details of this custom command. Indeed the macro defines the +# +# :: +# +# FLEX_TARGET(Name FlexInput FlexOutput [COMPILE_FLAGS <string>]) +# +# which creates a custom command to generate the <FlexOutput> file from +# the <FlexInput> file. If COMPILE_FLAGS option is specified, the next +# parameter is added to the flex command line. Name is an alias used to +# get details of this custom command. Indeed the macro defines the # following variables: -# FLEX_${Name}_DEFINED - true is the macro ran successfully -# FLEX_${Name}_OUTPUTS - the source file generated by the custom rule, an -# alias for FlexOutput -# FLEX_${Name}_INPUT - the flex source file, an alias for ${FlexInput} # -# Flex scanners oftenly use tokens defined by Bison: the code generated -# by Flex depends of the header generated by Bison. This module also +# :: +# +# FLEX_${Name}_DEFINED - true is the macro ran successfully +# FLEX_${Name}_OUTPUTS - the source file generated by the custom rule, an +# alias for FlexOutput +# FLEX_${Name}_INPUT - the flex source file, an alias for ${FlexInput} +# +# +# +# Flex scanners oftenly use tokens defined by Bison: the code generated +# by Flex depends of the header generated by Bison. This module also # defines a macro: -# ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget) -# which adds the required dependency between a scanner and a parser -# where <FlexTarget> and <BisonTarget> are the first parameters of +# +# :: +# +# ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget) +# +# which adds the required dependency between a scanner and a parser +# where <FlexTarget> and <BisonTarget> are the first parameters of # respectively FLEX_TARGET and BISON_TARGET macros. # -# ==================================================================== -# Example: +# :: +# +# ==================================================================== +# Example: +# +# +# +# :: +# +# find_package(BISON) +# find_package(FLEX) +# +# +# +# :: +# +# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) +# FLEX_TARGET(MyScanner lexer.l ${CMAKE_CURRENT_BINARY_DIR}/lexer.cpp) +# ADD_FLEX_BISON_DEPENDENCY(MyScanner MyParser) +# # -# find_package(BISON) -# find_package(FLEX) # -# BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp) -# FLEX_TARGET(MyScanner lexer.l ${CMAKE_CURRENT_BINARY_DIR}/lexer.cpp) -# ADD_FLEX_BISON_DEPENDENCY(MyScanner MyParser) +# :: # -# include_directories(${CMAKE_CURRENT_BINARY_DIR}) -# add_executable(Foo -# Foo.cc -# ${BISON_MyParser_OUTPUTS} -# ${FLEX_MyScanner_OUTPUTS} -# ) -# ==================================================================== +# include_directories(${CMAKE_CURRENT_BINARY_DIR}) +# add_executable(Foo +# Foo.cc +# ${BISON_MyParser_OUTPUTS} +# ${FLEX_MyScanner_OUTPUTS} +# ) +# ==================================================================== #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindFLTK.cmake b/Modules/FindFLTK.cmake index 92c14da..b87bc7f 100644 --- a/Modules/FindFLTK.cmake +++ b/Modules/FindFLTK.cmake @@ -1,33 +1,58 @@ -# - Find the native FLTK includes and library +#.rst: +# FindFLTK +# -------- # -# By default FindFLTK.cmake will search for all of the FLTK components and -# add them to the FLTK_LIBRARIES variable. +# Find the native FLTK includes and library # -# You can limit the components which get placed in FLTK_LIBRARIES by -# defining one or more of the following three options: # -# FLTK_SKIP_OPENGL, set to true to disable searching for opengl and -# the FLTK GL library -# FLTK_SKIP_FORMS, set to true to disable searching for fltk_forms -# FLTK_SKIP_IMAGES, set to true to disable searching for fltk_images # -# FLTK_SKIP_FLUID, set to true if the fluid binary need not be present -# at build time +# By default FindFLTK.cmake will search for all of the FLTK components +# and add them to the FLTK_LIBRARIES variable. +# +# :: +# +# You can limit the components which get placed in FLTK_LIBRARIES by +# defining one or more of the following three options: +# +# +# +# :: +# +# FLTK_SKIP_OPENGL, set to true to disable searching for opengl and +# the FLTK GL library +# FLTK_SKIP_FORMS, set to true to disable searching for fltk_forms +# FLTK_SKIP_IMAGES, set to true to disable searching for fltk_images +# +# +# +# :: +# +# FLTK_SKIP_FLUID, set to true if the fluid binary need not be present +# at build time +# +# # # The following variables will be defined: -# FLTK_FOUND, True if all components not skipped were found -# FLTK_INCLUDE_DIR, where to find include files -# FLTK_LIBRARIES, list of fltk libraries you should link against -# FLTK_FLUID_EXECUTABLE, where to find the Fluid tool -# FLTK_WRAP_UI, This enables the FLTK_WRAP_UI command +# +# :: +# +# FLTK_FOUND, True if all components not skipped were found +# FLTK_INCLUDE_DIR, where to find include files +# FLTK_LIBRARIES, list of fltk libraries you should link against +# FLTK_FLUID_EXECUTABLE, where to find the Fluid tool +# FLTK_WRAP_UI, This enables the FLTK_WRAP_UI command +# +# # # The following cache variables are assigned but should not be used. # See the FLTK_LIBRARIES variable instead. # -# 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 #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindFLTK2.cmake b/Modules/FindFLTK2.cmake index 09f6925..4deffda 100644 --- a/Modules/FindFLTK2.cmake +++ b/Modules/FindFLTK2.cmake @@ -1,14 +1,26 @@ -# - Find the native FLTK2 includes and library +#.rst: +# FindFLTK2 +# --------- +# +# Find the native FLTK2 includes and library +# # The following settings are defined -# FLTK2_FLUID_EXECUTABLE, where to find the Fluid tool -# FLTK2_WRAP_UI, This enables the FLTK2_WRAP_UI command -# FLTK2_INCLUDE_DIR, where to find include files -# FLTK2_LIBRARIES, list of fltk2 libraries -# FLTK2_FOUND, Don't use FLTK2 if false. +# +# :: +# +# FLTK2_FLUID_EXECUTABLE, where to find the Fluid tool +# FLTK2_WRAP_UI, This enables the FLTK2_WRAP_UI command +# FLTK2_INCLUDE_DIR, where to find include files +# FLTK2_LIBRARIES, list of fltk2 libraries +# FLTK2_FOUND, Don't use FLTK2 if false. +# # The following settings should not be used in general. -# FLTK2_BASE_LIBRARY = the full path to fltk2.lib -# FLTK2_GL_LIBRARY = the full path to fltk2_gl.lib -# FLTK2_IMAGES_LIBRARY = the full path to fltk2_images.lib +# +# :: +# +# FLTK2_BASE_LIBRARY = the full path to fltk2.lib +# FLTK2_GL_LIBRARY = the full path to fltk2_gl.lib +# FLTK2_IMAGES_LIBRARY = the full path to fltk2_images.lib #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindFreetype.cmake b/Modules/FindFreetype.cmake index ccea991..179dc00 100644 --- a/Modules/FindFreetype.cmake +++ b/Modules/FindFreetype.cmake @@ -1,16 +1,25 @@ -# - Locate FreeType library +#.rst: +# FindFreetype +# ------------ +# +# Locate FreeType library +# # This module defines -# FREETYPE_LIBRARIES, the library to link against -# FREETYPE_FOUND, if false, do not try to link to FREETYPE -# FREETYPE_INCLUDE_DIRS, where to find headers. -# FREETYPE_VERSION_STRING, the version of freetype found (since CMake 2.8.8) -# This is the concatenation of the paths: -# FREETYPE_INCLUDE_DIR_ft2build -# FREETYPE_INCLUDE_DIR_freetype2 # -# $FREETYPE_DIR is an environment variable that would -# correspond to the ./configure --prefix=$FREETYPE_DIR -# used in building FREETYPE. +# :: +# +# FREETYPE_LIBRARIES, the library to link against +# FREETYPE_FOUND, if false, do not try to link to FREETYPE +# FREETYPE_INCLUDE_DIRS, where to find headers. +# FREETYPE_VERSION_STRING, the version of freetype found (since CMake 2.8.8) +# This is the concatenation of the paths: +# FREETYPE_INCLUDE_DIR_ft2build +# FREETYPE_INCLUDE_DIR_freetype2 +# +# +# +# $FREETYPE_DIR is an environment variable that would correspond to the +# ./configure --prefix=$FREETYPE_DIR used in building FREETYPE. #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindGCCXML.cmake b/Modules/FindGCCXML.cmake index 05f08a6..48618e2 100644 --- a/Modules/FindGCCXML.cmake +++ b/Modules/FindGCCXML.cmake @@ -1,7 +1,16 @@ -# - Find the GCC-XML front-end executable. +#.rst: +# FindGCCXML +# ---------- +# +# Find the GCC-XML front-end executable. +# +# # # This module will define the following variables: -# GCCXML - the GCC-XML front-end executable. +# +# :: +# +# GCCXML - the GCC-XML front-end executable. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindGDAL.cmake b/Modules/FindGDAL.cmake index 6e89847..4e04c31 100644 --- a/Modules/FindGDAL.cmake +++ b/Modules/FindGDAL.cmake @@ -1,14 +1,26 @@ +#.rst: +# FindGDAL +# -------- +# +# +# # Locate gdal # # This module accepts the following environment variables: # -# GDAL_DIR or GDAL_ROOT - Specify the location of GDAL +# :: +# +# GDAL_DIR or GDAL_ROOT - Specify the location of GDAL +# +# # # This module defines the following CMake variables: # -# GDAL_FOUND - True if libgdal is found -# GDAL_LIBRARY - A variable pointing to the GDAL library -# GDAL_INCLUDE_DIR - Where to find the headers +# :: +# +# GDAL_FOUND - True if libgdal is found +# GDAL_LIBRARY - A variable pointing to the GDAL library +# GDAL_INCLUDE_DIR - Where to find the headers #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindGIF.cmake b/Modules/FindGIF.cmake index 90ff737..117ded7 100644 --- a/Modules/FindGIF.cmake +++ b/Modules/FindGIF.cmake @@ -1,14 +1,19 @@ -# This module searches giflib and defines -# GIF_LIBRARIES - libraries to link to in order to use GIF -# GIF_FOUND, if false, do not try to link -# GIF_INCLUDE_DIR, where to find the headers -# GIF_VERSION, reports either version 4 or 3 (for everything before version 4) +#.rst: +# FindGIF +# ------- +# +# +# +# This module searches giflib and defines GIF_LIBRARIES - libraries to +# link to in order to use GIF GIF_FOUND, if false, do not try to link +# GIF_INCLUDE_DIR, where to find the headers GIF_VERSION, reports either +# version 4 or 3 (for everything before version 4) # # The minimum required version of giflib can be specified using the -# standard syntax, e.g. find_package(GIF 4) +# standard syntax, e.g. find_package(GIF 4) # -# $GIF_DIR is an environment variable that would -# correspond to the ./configure --prefix=$GIF_DIR +# $GIF_DIR is an environment variable that would correspond to the +# ./configure --prefix=$GIF_DIR #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindGLEW.cmake b/Modules/FindGLEW.cmake index 37dff03..497a80c 100644 --- a/Modules/FindGLEW.cmake +++ b/Modules/FindGLEW.cmake @@ -1,8 +1,16 @@ -# - Find the OpenGL Extension Wrangler Library (GLEW) +#.rst: +# FindGLEW +# -------- +# +# Find the OpenGL Extension Wrangler Library (GLEW) +# # This module defines the following variables: -# GLEW_INCLUDE_DIRS - include directories for GLEW -# GLEW_LIBRARIES - libraries to link against GLEW -# GLEW_FOUND - true if GLEW has been found and can be used +# +# :: +# +# GLEW_INCLUDE_DIRS - include directories for GLEW +# GLEW_LIBRARIES - libraries to link against GLEW +# GLEW_FOUND - true if GLEW has been found and can be used #============================================================================= # Copyright 2012 Benjamin Eikel diff --git a/Modules/FindGLUT.cmake b/Modules/FindGLUT.cmake index 843d138..be7c0cd 100644 --- a/Modules/FindGLUT.cmake +++ b/Modules/FindGLUT.cmake @@ -1,11 +1,22 @@ -# - 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 -# GLUT_FOUND, If false, do not try to use GLUT. +#.rst: +# FindGLUT +# -------- +# +# 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 +# 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. +# +# :: +# +# 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. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindGTK.cmake b/Modules/FindGTK.cmake index 8a44ade..01bca76 100644 --- a/Modules/FindGTK.cmake +++ b/Modules/FindGTK.cmake @@ -1,8 +1,15 @@ -# - 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 - GTK was found -# GTK_GL_FOUND - GTK's GL features were found +#.rst: +# FindGTK +# ------- +# +# 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 - GTK was found +# GTK_GL_FOUND - GTK's GL features were found #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindGTK2.cmake b/Modules/FindGTK2.cmake index 77aac6d..25c482e 100644 --- a/Modules/FindGTK2.cmake +++ b/Modules/FindGTK2.cmake @@ -1,56 +1,98 @@ -# - FindGTK2.cmake -# This module can find the GTK2 widget libraries and several of its other -# optional components like gtkmm, glade, and glademm. +#.rst: +# FindGTK2 +# -------- +# +# FindGTK2.cmake +# +# This module can find the GTK2 widget libraries and several of its +# other optional components like gtkmm, glade, and glademm. # # NOTE: If you intend to use version checking, CMake 2.6.2 or later is -# required. # -# Specify one or more of the following components -# as you call this find module. See example below. +# :: +# +# required. +# +# +# +# Specify one or more of the following components as you call this find +# module. See example below. +# +# :: +# +# gtk +# gtkmm +# glade +# glademm +# # -# gtk -# gtkmm -# glade -# glademm # # The following variables will be defined for your use # -# GTK2_FOUND - Were all of your specified components found? -# GTK2_INCLUDE_DIRS - All include directories -# GTK2_LIBRARIES - All libraries -# GTK2_DEFINITIONS - Additional compiler flags +# :: +# +# GTK2_FOUND - Were all of your specified components found? +# GTK2_INCLUDE_DIRS - All include directories +# GTK2_LIBRARIES - All libraries +# GTK2_DEFINITIONS - Additional compiler flags +# +# +# +# :: +# +# GTK2_VERSION - The version of GTK2 found (x.y.z) +# GTK2_MAJOR_VERSION - The major version of GTK2 +# GTK2_MINOR_VERSION - The minor version of GTK2 +# GTK2_PATCH_VERSION - The patch version of GTK2 +# # -# GTK2_VERSION - The version of GTK2 found (x.y.z) -# GTK2_MAJOR_VERSION - The major version of GTK2 -# GTK2_MINOR_VERSION - The minor version of GTK2 -# GTK2_PATCH_VERSION - The patch version of GTK2 # # Optional variables you can define prior to calling this module: # -# GTK2_DEBUG - Enables verbose debugging of the module -# GTK2_ADDITIONAL_SUFFIXES - Allows defining additional directories to -# search for include files +# :: +# +# GTK2_DEBUG - Enables verbose debugging of the module +# GTK2_ADDITIONAL_SUFFIXES - Allows defining additional directories to +# search for include files +# +# # -#================= -# Example Usage: +# ================= Example Usage: # -# Call find_package() once, here are some examples to pick from: +# :: # -# Require GTK 2.6 or later -# find_package(GTK2 2.6 REQUIRED gtk) +# Call find_package() once, here are some examples to pick from: # -# Require GTK 2.10 or later and Glade -# find_package(GTK2 2.10 REQUIRED gtk glade) # -# Search for GTK/GTKMM 2.8 or later -# find_package(GTK2 2.8 COMPONENTS gtk gtkmm) # -# if(GTK2_FOUND) -# include_directories(${GTK2_INCLUDE_DIRS}) -# add_executable(mygui mygui.cc) -# target_link_libraries(mygui ${GTK2_LIBRARIES}) -# endif() +# :: # +# Require GTK 2.6 or later +# find_package(GTK2 2.6 REQUIRED gtk) +# +# +# +# :: +# +# Require GTK 2.10 or later and Glade +# find_package(GTK2 2.10 REQUIRED gtk glade) +# +# +# +# :: +# +# Search for GTK/GTKMM 2.8 or later +# find_package(GTK2 2.8 COMPONENTS gtk gtkmm) +# +# +# +# :: +# +# if(GTK2_FOUND) +# include_directories(${GTK2_INCLUDE_DIRS}) +# add_executable(mygui mygui.cc) +# target_link_libraries(mygui ${GTK2_LIBRARIES}) +# endif() #============================================================================= # Copyright 2009 Kitware, Inc. @@ -66,7 +108,10 @@ # (To distribute this file outside of CMake, substitute the full # License text for the above reference.) -# Version 1.5 (UNRELEASED) (CMake 2.8.12) +# Version 1.6 (CMake 2.8.13) +# * Create targets for each library +# * Do not link libfreetype +# Version 1.5 (CMake 2.8.12) # * 14236: Detect gthread library # Detect pangocairo on windows # Detect pangocairo with gtk module instead of with gtkmm @@ -130,6 +175,7 @@ #============================================================= include(${CMAKE_CURRENT_LIST_DIR}/SelectLibraryConfigurations.cmake) +include(${CMAKE_CURRENT_LIST_DIR}/CMakeParseArguments.cmake) function(_GTK2_GET_VERSION _OUT_major _OUT_minor _OUT_micro _gtkversion_hdr) file(STRINGS ${_gtkversion_hdr} _contents REGEX "#define GTK_M[A-Z]+_VERSION[ \t]+") @@ -214,7 +260,7 @@ function(_GTK2_FIND_INCLUDE_DIR _var _hdr) message(STATUS "Adding ${_gtk2_arch_dir} to search path for multiarch support") endif() endif() - find_path(${_var}_INCLUDE_DIR ${_hdr} + find_path(GTK2_${_var}_INCLUDE_DIR ${_hdr} PATHS ${_gtk2_arch_dir} /usr/local/lib64 @@ -240,9 +286,10 @@ function(_GTK2_FIND_INCLUDE_DIR _var _hdr) PATH_SUFFIXES ${_suffixes} ) + mark_as_advanced(GTK2_${_var}_INCLUDE_DIR) - if(${_var}_INCLUDE_DIR) - set(GTK2_INCLUDE_DIRS ${GTK2_INCLUDE_DIRS} ${${_var}_INCLUDE_DIR} PARENT_SCOPE) + if(GTK2_${_var}_INCLUDE_DIR) + set(GTK2_INCLUDE_DIRS ${GTK2_INCLUDE_DIRS} ${GTK2_${_var}_INCLUDE_DIR} PARENT_SCOPE) endif() endfunction() @@ -332,10 +379,10 @@ function(_GTK2_FIND_LIBRARY _var _lib _expand_vc _append_version) if(GTK2_DEBUG) message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " - "While searching for ${_var}_LIBRARY, our proposed library list is ${_lib_list}") + "While searching for GTK2_${_var}_LIBRARY, our proposed library list is ${_lib_list}") endif() - find_library(${_var}_LIBRARY_RELEASE + find_library(GTK2_${_var}_LIBRARY_RELEASE NAMES ${_lib_list} PATHS /opt/gnome/lib @@ -349,10 +396,10 @@ function(_GTK2_FIND_LIBRARY _var _lib _expand_vc _append_version) if(_expand_vc AND MSVC) if(GTK2_DEBUG) message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " - "While searching for ${_var}_LIBRARY_DEBUG our proposed library list is ${_libd_list}") + "While searching for GTK2_${_var}_LIBRARY_DEBUG our proposed library list is ${_libd_list}") endif() - find_library(${_var}_LIBRARY_DEBUG + find_library(GTK2_${_var}_LIBRARY_DEBUG NAMES ${_libd_list} PATHS $ENV{GTKMM_BASEPATH}/lib @@ -361,24 +408,148 @@ function(_GTK2_FIND_LIBRARY _var _lib _expand_vc _append_version) ) endif() - select_library_configurations(${_var}) + select_library_configurations(GTK2_${_var}) - set(${_var}_LIBRARY ${${_var}_LIBRARY} PARENT_SCOPE) + set(GTK2_${_var}_LIBRARY ${GTK2_${_var}_LIBRARY} PARENT_SCOPE) + set(GTK2_${_var}_FOUND ${GTK2_${_var}_FOUND} PARENT_SCOPE) - set(GTK2_LIBRARIES ${GTK2_LIBRARIES} ${${_var}_LIBRARY}) - set(GTK2_LIBRARIES ${GTK2_LIBRARIES} PARENT_SCOPE) + if(GTK2_${_var}_FOUND) + set(GTK2_LIBRARIES ${GTK2_LIBRARIES} ${GTK2_${_var}_LIBRARY}) + set(GTK2_LIBRARIES ${GTK2_LIBRARIES} PARENT_SCOPE) + endif() if(GTK2_DEBUG) message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " - "${_var}_LIBRARY_RELEASE = \"${${_var}_LIBRARY_RELEASE}\"") + "GTK2_${_var}_LIBRARY_RELEASE = \"${GTK2_${_var}_LIBRARY_RELEASE}\"") + message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " + "GTK2_${_var}_LIBRARY_DEBUG = \"${GTK2_${_var}_LIBRARY_DEBUG}\"") message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " - "${_var}_LIBRARY_DEBUG = \"${${_var}_LIBRARY_DEBUG}\"") + "GTK2_${_var}_LIBRARY = \"${GTK2_${_var}_LIBRARY}\"") message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " - "${_var}_LIBRARY = \"${${_var}_LIBRARY}\"") + "GTK2_${_var}_FOUND = \"${GTK2_${_var}_FOUND}\"") endif() endfunction() + +function(_GTK2_ADD_TARGET_DEPENDS_INTERNAL _var _property) + if(GTK2_DEBUG) + message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " + "_GTK2_ADD_TARGET_DEPENDS_INTERNAL( ${_var} ${_property} )") + endif() + + string(TOLOWER "${_var}" _basename) + + if (TARGET GTK2::${_basename}) + foreach(_depend ${ARGN}) + set(_valid_depends) + if (TARGET GTK2::${_depend}) + list(APPEND _valid_depends GTK2::${_depend}) + endif() + if (_valid_depends) + set_property(TARGET GTK2::${_basename} APPEND PROPERTY ${_property} "${_valid_depends}") + endif() + set(_valid_depends) + endforeach() + endif() +endfunction() + +function(_GTK2_ADD_TARGET_DEPENDS _var) + if(GTK2_DEBUG) + message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " + "_GTK2_ADD_TARGET_DEPENDS( ${_var} )") + endif() + + string(TOLOWER "${_var}" _basename) + + if(TARGET GTK2::${_basename}) + get_target_property(_configs GTK2::${_basename} IMPORTED_CONFIGURATIONS) + _GTK2_ADD_TARGET_DEPENDS_INTERNAL(${_var} INTERFACE_LINK_LIBRARIES ${ARGN}) + foreach(_config ${_configs}) + _GTK2_ADD_TARGET_DEPENDS_INTERNAL(${_var} IMPORTED_LINK_INTERFACE_LIBRARIES_${_config} ${ARGN}) + endforeach() + endif() +endfunction() + +function(_GTK2_ADD_TARGET_INCLUDE_DIRS _var) + if(GTK2_DEBUG) + message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " + "_GTK2_ADD_TARGET_INCLUDE_DIRS( ${_var} )") + endif() + + string(TOLOWER "${_var}" _basename) + + if(TARGET GTK2::${_basename}) + foreach(_include ${ARGN}) + set_property(TARGET GTK2::${_basename} APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${_include}") + endforeach() + endif() +endfunction() + +#============================================================= +# _GTK2_ADD_TARGET +# Internal function to create targets for GTK2 +# _var = target to create +#============================================================= +function(_GTK2_ADD_TARGET _var) + if(GTK2_DEBUG) + message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " + "_GTK2_ADD_TARGET( ${_var} )") + endif() + + string(TOLOWER "${_var}" _basename) + + cmake_parse_arguments(_${_var} "" "" "GTK2_DEPENDS;GTK2_OPTIONAL_DEPENDS;OPTIONAL_INCLUDES" ${ARGN}) + + if(GTK2_${_var}_FOUND AND NOT TARGET GTK2::${_basename}) + # Do not create the target if dependencies are missing + foreach(_dep ${_${_var}_GTK2_DEPENDS}) + if(NOT TARGET GTK2::${_dep}) + return() + endif() + endforeach() + + add_library(GTK2::${_basename} UNKNOWN IMPORTED) + + if(GTK2_${_var}_LIBRARY_RELEASE) + set_property(TARGET GTK2::${_basename} APPEND PROPERTY IMPORTED_CONFIGURATIONS RELEASE) + set_property(TARGET GTK2::${_basename} PROPERTY IMPORTED_LOCATION_RELEASE "${GTK2_${_var}_LIBRARY_RELEASE}" ) + endif() + + if(GTK2_${_var}_LIBRARY_DEBUG) + set_property(TARGET GTK2::${_basename} APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG) + set_property(TARGET GTK2::${_basename} PROPERTY IMPORTED_LOCATION_DEBUG "${GTK2_${_var}_LIBRARY_DEBUG}" ) + endif() + + if(GTK2_${_var}_INCLUDE_DIR) + set_property(TARGET GTK2::${_basename} APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${GTK2_${_var}_INCLUDE_DIR}") + endif() + + if(GTK2_${_var}CONFIG_INCLUDE_DIR AND NOT "${GTK2_${_var}CONFIG_INCLUDE_DIR}" STREQUAL "GTK2_${_var}_INCLUDE_DIR") + set_property(TARGET GTK2::${_basename} APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${GTK2_${_var}CONFIG_INCLUDE_DIR}") + endif() + + if(GTK2_DEFINITIONS) + set_property(TARGET GTK2::${_basename} PROPERTY INTERFACE_COMPILE_DEFINITIONS "${GTK2_DEFINITIONS}") + endif() + + if(_${_var}_GTK2_DEPENDS) + _GTK2_ADD_TARGET_DEPENDS(${_var} ${_${_var}_GTK2_DEPENDS} ${_${_var}_GTK2_OPTIONAL_DEPENDS}) + endif() + + if(_${_var}_OPTIONAL_INCLUDES) + _GTK2_ADD_TARGET_INCLUDE_DIRS(${_var} ${_${_var}_OPTIONAL_INCLUDES}) + endif() + + if(GTK2_USE_IMPORTED_TARGETS) + set(GTK2_${_var}_LIBRARY GTK2::${_basename} PARENT_SCOPE) + endif() + + endif() +endfunction() + + + #============================================================= # @@ -405,7 +576,7 @@ if(GTK2_FIND_VERSION) message(STATUS "[FindGTK2.cmake:${CMAKE_CURRENT_LIST_LINE}] " "Searching for version ${GTK2_FIND_VERSION}") endif() - _GTK2_FIND_INCLUDE_DIR(GTK2_GTK gtk/gtk.h) + _GTK2_FIND_INCLUDE_DIR(GTK gtk/gtk.h) if(GTK2_GTK_INCLUDE_DIR) _GTK2_GET_VERSION(GTK2_MAJOR_VERSION GTK2_MINOR_VERSION @@ -446,104 +617,162 @@ if(GTK2_FIND_VERSION) endif() # +# On MSVC, according to https://wiki.gnome.org/gtkmm/MSWindows, the /vd2 flag needs to be +# passed to the compiler in order to use gtkmm +# +if(MSVC) + foreach(_GTK2_component ${GTK2_FIND_COMPONENTS}) + if(_GTK2_component STREQUAL "gtkmm") + set(GTK2_DEFINITIONS "/vd2") + elseif(_GTK2_component STREQUAL "glademm") + set(GTK2_DEFINITIONS "/vd2") + endif() + endforeach() +endif() + +# # Find all components # -find_package(Freetype) -list(APPEND GTK2_INCLUDE_DIRS ${FREETYPE_INCLUDE_DIRS}) -list(APPEND GTK2_LIBRARIES ${FREETYPE_LIBRARIES}) +find_package(Freetype QUIET) +if(FREETYPE_INCLUDE_DIR_ft2build AND FREETYPE_INCLUDE_DIR_freetype2) + list(APPEND GTK2_INCLUDE_DIRS ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) +endif() foreach(_GTK2_component ${GTK2_FIND_COMPONENTS}) if(_GTK2_component STREQUAL "gtk") - _GTK2_FIND_INCLUDE_DIR(GTK2_GTK gtk/gtk.h) + _GTK2_FIND_INCLUDE_DIR(GLIB glib.h) + _GTK2_FIND_INCLUDE_DIR(GLIBCONFIG glibconfig.h) + _GTK2_FIND_LIBRARY (GLIB glib false true) + _GTK2_ADD_TARGET (GLIB) - if(UNIX) - _GTK2_FIND_LIBRARY (GTK2_GTK gtk-x11 false true) - _GTK2_FIND_LIBRARY (GTK2_GDK gdk-x11 false true) - else() - _GTK2_FIND_LIBRARY (GTK2_GTK gtk-win32 false true) - _GTK2_FIND_LIBRARY (GTK2_GDK gdk-win32 false true) - endif() - - _GTK2_FIND_INCLUDE_DIR(GTK2_GDK gdk/gdk.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GDKCONFIG gdkconfig.h) + _GTK2_FIND_INCLUDE_DIR(GOBJECT glib-object.h) + _GTK2_FIND_LIBRARY (GOBJECT gobject false true) + _GTK2_ADD_TARGET (GOBJECT GTK2_DEPENDS glib) - _GTK2_FIND_INCLUDE_DIR(GTK2_CAIRO cairo.h) - _GTK2_FIND_LIBRARY (GTK2_CAIRO cairo false false) + _GTK2_FIND_INCLUDE_DIR(ATK atk/atk.h) + _GTK2_FIND_LIBRARY (ATK atk false true) + _GTK2_ADD_TARGET (ATK GTK2_DEPENDS gobject glib) - _GTK2_FIND_INCLUDE_DIR(GTK2_FONTCONFIG fontconfig/fontconfig.h) + _GTK2_FIND_LIBRARY (GIO gio false true) + _GTK2_ADD_TARGET (GIO GTK2_DEPENDS gobject glib) - _GTK2_FIND_INCLUDE_DIR(GTK2_PANGO pango/pango.h) - _GTK2_FIND_LIBRARY (GTK2_PANGO pango false true) + _GTK2_FIND_LIBRARY (GTHREAD gthread false true) + _GTK2_ADD_TARGET (GTHREAD GTK2_DEPENDS glib) - _GTK2_FIND_LIBRARY (GTK2_PANGOCAIRO pangocairo false true) + _GTK2_FIND_LIBRARY (GMODULE gmodule false true) + _GTK2_ADD_TARGET (GMODULE GTK2_DEPENDS glib) - _GTK2_FIND_LIBRARY (GTK2_PANGOFT2 pangoft2 false true) + _GTK2_FIND_INCLUDE_DIR(GDK_PIXBUF gdk-pixbuf/gdk-pixbuf.h) + _GTK2_FIND_LIBRARY (GDK_PIXBUF gdk_pixbuf false true) + _GTK2_ADD_TARGET (GDK_PIXBUF GTK2_DEPENDS gobject glib) - _GTK2_FIND_LIBRARY (GTK2_PANGOXFT pangoxft false true) + _GTK2_FIND_INCLUDE_DIR(CAIRO cairo.h) + _GTK2_FIND_LIBRARY (CAIRO cairo false false) + _GTK2_ADD_TARGET (CAIRO) - _GTK2_FIND_INCLUDE_DIR(GTK2_GDK_PIXBUF gdk-pixbuf/gdk-pixbuf.h) - _GTK2_FIND_LIBRARY (GTK2_GDK_PIXBUF gdk_pixbuf false true) + _GTK2_FIND_INCLUDE_DIR(PANGO pango/pango.h) + _GTK2_FIND_LIBRARY (PANGO pango false true) + _GTK2_ADD_TARGET (PANGO GTK2_DEPENDS gobject glib) - _GTK2_FIND_LIBRARY (GTK2_GTHREAD gthread false true) + _GTK2_FIND_LIBRARY (PANGOCAIRO pangocairo false true) + _GTK2_ADD_TARGET (PANGOCAIRO GTK2_DEPENDS pango cairo gobject glib) - _GTK2_FIND_LIBRARY (GTK2_GMODULE gmodule false true) + _GTK2_FIND_LIBRARY (PANGOFT2 pangoft2 false true) + _GTK2_ADD_TARGET (PANGOFT2 GTK2_DEPENDS pango gobject glib + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) - _GTK2_FIND_LIBRARY (GTK2_GIO gio false true) + _GTK2_FIND_LIBRARY (PANGOXFT pangoxft false true) + _GTK2_ADD_TARGET (PANGOXFT GTK2_DEPENDS pangoft2 pango gobject glib + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) - _GTK2_FIND_INCLUDE_DIR(GTK2_ATK atk/atk.h) - _GTK2_FIND_LIBRARY (GTK2_ATK atk false true) + _GTK2_FIND_INCLUDE_DIR(GDK gdk/gdk.h) + _GTK2_FIND_INCLUDE_DIR(GDKCONFIG gdkconfig.h) + if(UNIX) + _GTK2_FIND_LIBRARY (GDK gdk-x11 false true) + else() + _GTK2_FIND_LIBRARY (GDK gdk-win32 false true) + endif() + _GTK2_ADD_TARGET (GDK GTK2_DEPENDS pango gdk_pixbuf gobject glib + GTK2_OPTIONAL_DEPENDS pangocairo cairo) - _GTK2_FIND_INCLUDE_DIR(GTK2_GOBJECT gobject/gobject.h) - _GTK2_FIND_LIBRARY (GTK2_GOBJECT gobject false true) + _GTK2_FIND_INCLUDE_DIR(GTK gtk/gtk.h) + if(UNIX) + _GTK2_FIND_LIBRARY (GTK gtk-x11 false true) + else() + _GTK2_FIND_LIBRARY (GTK gtk-win32 false true) + endif() + _GTK2_ADD_TARGET (GTK GTK2_DEPENDS gdk atk pangoft2 pango gdk_pixbuf gthread gobject glib + GTK2_OPTIONAL_DEPENDS gio pangocairo cairo) - _GTK2_FIND_INCLUDE_DIR(GTK2_GLIB glib.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GLIBCONFIG glibconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GLIB glib false true) + # Left for compatibility with previous versions. It doesn't seem to be required + _GTK2_FIND_INCLUDE_DIR(FONTCONFIG fontconfig/fontconfig.h) elseif(_GTK2_component STREQUAL "gtkmm") - _GTK2_FIND_INCLUDE_DIR(GTK2_GTKMM gtkmm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GTKMMCONFIG gtkmmconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GTKMM gtkmm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_GDKMM gdkmm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GDKMMCONFIG gdkmmconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GDKMM gdkmm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_PANGOMM pangomm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_PANGOMMCONFIG pangommconfig.h) - _GTK2_FIND_LIBRARY (GTK2_PANGOMM pangomm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_CAIROMM cairomm/cairomm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_CAIROMMCONFIG cairommconfig.h) - _GTK2_FIND_LIBRARY (GTK2_CAIROMM cairomm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_GIOMM giomm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GIOMMCONFIG giommconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GIOMM giomm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_ATKMM atkmm.h) - _GTK2_FIND_LIBRARY (GTK2_ATKMM atkmm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_GLIBMM glibmm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GLIBMMCONFIG glibmmconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GLIBMM glibmm true true) - - _GTK2_FIND_INCLUDE_DIR(GTK2_SIGC++ sigc++/sigc++.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_SIGC++CONFIG sigc++config.h) - _GTK2_FIND_LIBRARY (GTK2_SIGC++ sigc true true) + _GTK2_FIND_INCLUDE_DIR(SIGC++ sigc++/sigc++.h) + _GTK2_FIND_INCLUDE_DIR(SIGC++CONFIG sigc++config.h) + _GTK2_FIND_LIBRARY (SIGC++ sigc true true) + _GTK2_ADD_TARGET (SIGC++) + + _GTK2_FIND_INCLUDE_DIR(GLIBMM glibmm.h) + _GTK2_FIND_INCLUDE_DIR(GLIBMMCONFIG glibmmconfig.h) + _GTK2_FIND_LIBRARY (GLIBMM glibmm true true) + _GTK2_ADD_TARGET (GLIBMM GTK2_DEPENDS gobject sigc++ glib) + + _GTK2_FIND_INCLUDE_DIR(GIOMM giomm.h) + _GTK2_FIND_INCLUDE_DIR(GIOMMCONFIG giommconfig.h) + _GTK2_FIND_LIBRARY (GIOMM giomm true true) + _GTK2_ADD_TARGET (GIOMM GTK2_DEPENDS gio glibmm gobject sigc++ glib) + + _GTK2_FIND_INCLUDE_DIR(ATKMM atkmm.h) + _GTK2_FIND_LIBRARY (ATKMM atkmm true true) + _GTK2_ADD_TARGET (ATKMM GTK2_DEPENDS atk glibmm gobject sigc++ glib) + + _GTK2_FIND_INCLUDE_DIR(CAIROMM cairomm/cairomm.h) + _GTK2_FIND_INCLUDE_DIR(CAIROMMCONFIG cairommconfig.h) + _GTK2_FIND_LIBRARY (CAIROMM cairomm true true) + _GTK2_ADD_TARGET (CAIROMM GTK2_DEPENDS cairo sigc++ + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) + + _GTK2_FIND_INCLUDE_DIR(PANGOMM pangomm.h) + _GTK2_FIND_INCLUDE_DIR(PANGOMMCONFIG pangommconfig.h) + _GTK2_FIND_LIBRARY (PANGOMM pangomm true true) + _GTK2_ADD_TARGET (PANGOMM GTK2_DEPENDS glibmm sigc++ pango gobject glib + GTK2_OPTIONAL_DEPENDS cairomm pangocairo cairo + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) + + + _GTK2_FIND_INCLUDE_DIR(GDKMM gdkmm.h) + _GTK2_FIND_INCLUDE_DIR(GDKMMCONFIG gdkmmconfig.h) + _GTK2_FIND_LIBRARY (GDKMM gdkmm true true) + _GTK2_ADD_TARGET (GDKMM GTK2_DEPENDS pangomm gtk glibmm sigc++ gdk atk pangoft2 gdk_pixbuf pango gobject glib + GTK2_OPTIONAL_DEPENDS giomm cairomm gio pangocairo cairo + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) + + _GTK2_FIND_INCLUDE_DIR(GTKMM gtkmm.h) + _GTK2_FIND_INCLUDE_DIR(GTKMMCONFIG gtkmmconfig.h) + _GTK2_FIND_LIBRARY (GTKMM gtkmm true true) + _GTK2_ADD_TARGET (GTKMM GTK2_DEPENDS atkmm gdkmm pangomm gtk glibmm sigc++ gdk atk pangoft2 gdk_pixbuf pango gthread gobject glib + GTK2_OPTIONAL_DEPENDS giomm cairomm gio pangocairo cairo + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) elseif(_GTK2_component STREQUAL "glade") - _GTK2_FIND_INCLUDE_DIR(GTK2_GLADE glade/glade.h) - _GTK2_FIND_LIBRARY (GTK2_GLADE glade false true) + _GTK2_FIND_INCLUDE_DIR(GLADE glade/glade.h) + _GTK2_FIND_LIBRARY (GLADE glade false true) + _GTK2_ADD_TARGET (GLADE GTK2_DEPENDS gtk gdk atk gio pangoft2 gdk_pixbuf pango gobject glib + GTK2_OPTIONAL_DEPENDS pangocairo cairo + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) elseif(_GTK2_component STREQUAL "glademm") - _GTK2_FIND_INCLUDE_DIR(GTK2_GLADEMM libglademm.h) - _GTK2_FIND_INCLUDE_DIR(GTK2_GLADEMMCONFIG libglademmconfig.h) - _GTK2_FIND_LIBRARY (GTK2_GLADEMM glademm true true) + _GTK2_FIND_INCLUDE_DIR(GLADEMM libglademm.h) + _GTK2_FIND_INCLUDE_DIR(GLADEMMCONFIG libglademmconfig.h) + _GTK2_FIND_LIBRARY (GLADEMM glademm true true) + _GTK2_ADD_TARGET (GLADEMM GTK2_DEPENDS gtkmm glade atkmm gdkmm giomm pangomm glibmm sigc++ gtk gdk atk pangoft2 gdk_pixbuf pango gthread gobject glib + GTK2_OPTIONAL_DEPENDS giomm cairomm gio pangocairo cairo + OPTIONAL_INCLUDES ${FREETYPE_INCLUDE_DIR_ft2build} ${FREETYPE_INCLUDE_DIR_freetype2}) else() message(FATAL_ERROR "Unknown GTK2 component ${_component}") @@ -562,20 +791,6 @@ if(NOT GTK2_FIND_VERSION AND GTK2_GTK_INCLUDE_DIR) endif() # -# On MSVC, according to https://wiki.gnome.org/gtkmm/MSWindows, the /vd2 flag needs to be -# passed to the compiler in order to use gtkmm -# -if(MSVC) - foreach(_GTK2_component ${GTK2_FIND_COMPONENTS}) - if(_GTK2_component STREQUAL "gtkmm") - set(GTK2_DEFINITIONS "/vd2") - elseif(_GTK2_component STREQUAL "glademm") - set(GTK2_DEFINITIONS "/vd2") - endif() - endforeach() -endif() - -# # Try to enforce components # @@ -586,6 +801,8 @@ include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake) foreach(_GTK2_component ${GTK2_FIND_COMPONENTS}) string(TOUPPER ${_GTK2_component} _COMPONENT_UPPER) + set(GTK2_${_COMPONENT_UPPER}_FIND_QUIETLY ${GTK2_FIND_QUIETLY}) + if(_GTK2_component STREQUAL "gtk") FIND_PACKAGE_HANDLE_STANDARD_ARGS(GTK2_${_COMPONENT_UPPER} "Some or all of the gtk libraries were not found." GTK2_GTK_LIBRARY @@ -613,6 +830,8 @@ foreach(_GTK2_component ${GTK2_FIND_COMPONENTS}) GTK2_GLIBMMCONFIG_INCLUDE_DIR GTK2_GLIBMM_LIBRARY + FREETYPE_INCLUDE_DIR_ft2build + FREETYPE_INCLUDE_DIR_freetype2 ) elseif(_GTK2_component STREQUAL "glade") FIND_PACKAGE_HANDLE_STANDARD_ARGS(GTK2_${_COMPONENT_UPPER} "The glade library was not found." diff --git a/Modules/FindGTest.cmake b/Modules/FindGTest.cmake index d531dd1..c00a750 100644 --- a/Modules/FindGTest.cmake +++ b/Modules/FindGTest.cmake @@ -1,58 +1,94 @@ +#.rst: +# FindGTest +# --------- +# # Locate the Google C++ Testing Framework. # # Defines the following variables: # -# GTEST_FOUND - Found the Google Testing framework -# GTEST_INCLUDE_DIRS - Include directories +# :: +# +# GTEST_FOUND - Found the Google Testing framework +# GTEST_INCLUDE_DIRS - Include directories +# +# +# +# Also defines the library variables below as normal variables. These +# contain debug/optimized keywords when a debugging library is found. +# +# :: +# +# GTEST_BOTH_LIBRARIES - Both libgtest & libgtest-main +# GTEST_LIBRARIES - libgtest +# GTEST_MAIN_LIBRARIES - libgtest-main # -# Also defines the library variables below as normal -# variables. These contain debug/optimized keywords when -# a debugging library is found. # -# GTEST_BOTH_LIBRARIES - Both libgtest & libgtest-main -# GTEST_LIBRARIES - libgtest -# GTEST_MAIN_LIBRARIES - libgtest-main # # Accepts the following variables as input: # -# GTEST_ROOT - (as a CMake or environment variable) -# The root directory of the gtest install prefix +# :: +# +# GTEST_ROOT - (as a CMake or environment variable) +# The root directory of the gtest install prefix +# +# +# +# :: +# +# GTEST_MSVC_SEARCH - If compiling with MSVC, this variable can be set to +# "MD" or "MT" to enable searching a GTest build tree +# (defaults: "MD") +# # -# GTEST_MSVC_SEARCH - If compiling with MSVC, this variable can be set to -# "MD" or "MT" to enable searching a GTest build tree -# (defaults: "MD") # -#----------------------- # Example Usage: # -# enable_testing() -# find_package(GTest REQUIRED) -# include_directories(${GTEST_INCLUDE_DIRS}) +# :: +# +# enable_testing() +# find_package(GTest REQUIRED) +# include_directories(${GTEST_INCLUDE_DIRS}) +# # -# add_executable(foo foo.cc) -# target_link_libraries(foo ${GTEST_BOTH_LIBRARIES}) # -# add_test(AllTestsInFoo foo) +# :: # -#----------------------- +# add_executable(foo foo.cc) +# target_link_libraries(foo ${GTEST_BOTH_LIBRARIES}) # -# If you would like each Google test to show up in CTest as -# a test you may use the following macro. -# NOTE: It will slow down your tests by running an executable -# for each test and test fixture. You will also have to rerun -# CMake after adding or removing tests or test fixtures. +# +# +# :: +# +# add_test(AllTestsInFoo foo) +# +# +# +# +# +# If you would like each Google test to show up in CTest as a test you +# may use the following macro. NOTE: It will slow down your tests by +# running an executable for each test and test fixture. You will also +# have to rerun CMake after adding or removing tests or test fixtures. # # GTEST_ADD_TESTS(executable extra_args ARGN) -# executable = The path to the test executable -# extra_args = Pass a list of extra arguments to be passed to -# executable enclosed in quotes (or "" for none) -# ARGN = A list of source files to search for tests & test -# fixtures. -# -# Example: -# set(FooTestArgs --foo 1 --bar 2) -# add_executable(FooTest FooUnitTest.cc) -# GTEST_ADD_TESTS(FooTest "${FooTestArgs}" FooUnitTest.cc) +# +# :: +# +# executable = The path to the test executable +# extra_args = Pass a list of extra arguments to be passed to +# executable enclosed in quotes (or "" for none) +# ARGN = A list of source files to search for tests & test +# fixtures. +# +# +# +# :: +# +# Example: +# set(FooTestArgs --foo 1 --bar 2) +# add_executable(FooTest FooUnitTest.cc) +# GTEST_ADD_TESTS(FooTest "${FooTestArgs}" FooUnitTest.cc) #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindGettext.cmake b/Modules/FindGettext.cmake index 1a6bd39..6a1e36e 100644 --- a/Modules/FindGettext.cmake +++ b/Modules/FindGettext.cmake @@ -1,29 +1,52 @@ -# - Find GNU gettext tools -# This module looks for the GNU gettext tools. This module defines the +#.rst: +# FindGettext +# ----------- +# +# Find GNU gettext tools +# +# This module looks for the GNU gettext tools. This module defines the # following values: -# GETTEXT_MSGMERGE_EXECUTABLE: the full path to the msgmerge tool. -# GETTEXT_MSGFMT_EXECUTABLE: the full path to the msgfmt tool. -# GETTEXT_FOUND: True if gettext has been found. -# GETTEXT_VERSION_STRING: the version of gettext found (since CMake 2.8.8) +# +# :: +# +# GETTEXT_MSGMERGE_EXECUTABLE: the full path to the msgmerge tool. +# GETTEXT_MSGFMT_EXECUTABLE: the full path to the msgfmt tool. +# GETTEXT_FOUND: True if gettext has been found. +# GETTEXT_VERSION_STRING: the version of gettext found (since CMake 2.8.8) +# +# # # Additionally it provides the following macros: -# GETTEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ... fileN ) -# This will create a target "translations" which will convert the -# given input po files into the binary output mo file. If the -# ALL option is used, the translations will also be created when -# building the default target. -# GETTEXT_PROCESS_POT( <potfile> [ALL] [INSTALL_DESTINATION <destdir>] LANGUAGES <lang1> <lang2> ... ) -# Process the given pot file to mo files. -# If INSTALL_DESTINATION is given then automatically install rules will be created, -# the language subdirectory will be taken into account (by default use share/locale/). -# If ALL is specified, the pot file is processed when building the all traget. -# It creates a custom target "potfile". -# GETTEXT_PROCESS_PO_FILES( <lang> [ALL] [INSTALL_DESTINATION <dir>] PO_FILES <po1> <po2> ... ) -# Process the given po files to mo files for the given language. -# If INSTALL_DESTINATION is given then automatically install rules will be created, -# the language subdirectory will be taken into account (by default use share/locale/). -# If ALL is specified, the po files are processed when building the all traget. -# It creates a custom target "pofiles". +# GETTEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ... fileN ) +# +# :: +# +# This will create a target "translations" which will convert the +# given input po files into the binary output mo file. If the +# ALL option is used, the translations will also be created when +# building the default target. +# +# GETTEXT_PROCESS_POT( <potfile> [ALL] [INSTALL_DESTINATION <destdir>] +# LANGUAGES <lang1> <lang2> ... ) +# +# :: +# +# Process the given pot file to mo files. +# If INSTALL_DESTINATION is given then automatically install rules will be created, +# the language subdirectory will be taken into account (by default use share/locale/). +# If ALL is specified, the pot file is processed when building the all traget. +# It creates a custom target "potfile". +# +# GETTEXT_PROCESS_PO_FILES( <lang> [ALL] [INSTALL_DESTINATION <dir>] +# PO_FILES <po1> <po2> ... ) +# +# :: +# +# Process the given po files to mo files for the given language. +# If INSTALL_DESTINATION is given then automatically install rules will be created, +# the language subdirectory will be taken into account (by default use share/locale/). +# If ALL is specified, the po files are processed when building the all traget. +# It creates a custom target "pofiles". #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindGit.cmake b/Modules/FindGit.cmake index 41d2a7a..570538d 100644 --- a/Modules/FindGit.cmake +++ b/Modules/FindGit.cmake @@ -1,12 +1,25 @@ +#.rst: +# FindGit +# ------- +# +# +# # The module defines the following variables: -# GIT_EXECUTABLE - path to git command line client -# GIT_FOUND - true if the command line client was found -# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8) +# +# :: +# +# GIT_EXECUTABLE - path to git command line client +# GIT_FOUND - true if the command line client was found +# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8) +# # Example usage: -# find_package(Git) -# if(GIT_FOUND) -# message("git found: ${GIT_EXECUTABLE}") -# endif() +# +# :: +# +# find_package(Git) +# if(GIT_FOUND) +# message("git found: ${GIT_EXECUTABLE}") +# endif() #============================================================================= # Copyright 2010 Kitware, Inc. diff --git a/Modules/FindGnuTLS.cmake b/Modules/FindGnuTLS.cmake index 7315f1d..4d94ffc 100644 --- a/Modules/FindGnuTLS.cmake +++ b/Modules/FindGnuTLS.cmake @@ -1,11 +1,19 @@ -# - Try to find the GNU Transport Layer Security library (gnutls) +#.rst: +# FindGnuTLS +# ---------- +# +# Try to find the GNU Transport Layer Security library (gnutls) +# +# # # Once done this will define # -# GNUTLS_FOUND - System has gnutls -# GNUTLS_INCLUDE_DIR - The gnutls include directory -# GNUTLS_LIBRARIES - The libraries needed to use gnutls -# GNUTLS_DEFINITIONS - Compiler switches required for using gnutls +# :: +# +# GNUTLS_FOUND - System has gnutls +# GNUTLS_INCLUDE_DIR - The gnutls include directory +# GNUTLS_LIBRARIES - The libraries needed to use gnutls +# GNUTLS_DEFINITIONS - Compiler switches required for using gnutls #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindGnuplot.cmake b/Modules/FindGnuplot.cmake index f2f9dd0..067604f 100644 --- a/Modules/FindGnuplot.cmake +++ b/Modules/FindGnuplot.cmake @@ -1,10 +1,20 @@ -# - this module looks for gnuplot +#.rst: +# FindGnuplot +# ----------- +# +# this module looks for gnuplot +# +# # # Once done this will define # -# GNUPLOT_FOUND - system has Gnuplot -# GNUPLOT_EXECUTABLE - the Gnuplot executable -# GNUPLOT_VERSION_STRING - the version of Gnuplot found (since CMake 2.8.8) +# :: +# +# GNUPLOT_FOUND - system has Gnuplot +# GNUPLOT_EXECUTABLE - the Gnuplot executable +# GNUPLOT_VERSION_STRING - the version of Gnuplot found (since CMake 2.8.8) +# +# # # GNUPLOT_VERSION_STRING will not work for old versions like 3.7.1. diff --git a/Modules/FindHDF5.cmake b/Modules/FindHDF5.cmake index 0c246a1..2903bf8 100644 --- a/Modules/FindHDF5.cmake +++ b/Modules/FindHDF5.cmake @@ -1,49 +1,62 @@ -# - Find HDF5, a library for reading and writing self describing array data. +#.rst: +# FindHDF5 +# -------- +# +# Find HDF5, a library for reading and writing self describing array data. +# +# # # This module invokes the HDF5 wrapper compiler that should be installed -# alongside HDF5. Depending upon the HDF5 Configuration, the wrapper compiler -# is called either h5cc or h5pcc. If this succeeds, the module will then call -# the compiler with the -show argument to see what flags are used when compiling -# an HDF5 client application. +# alongside HDF5. Depending upon the HDF5 Configuration, the wrapper +# compiler is called either h5cc or h5pcc. If this succeeds, the module +# will then call the compiler with the -show argument to see what flags +# are used when compiling an HDF5 client application. # -# The module will optionally accept the COMPONENTS argument. If no COMPONENTS -# are specified, then the find module will default to finding only the HDF5 C -# library. If one or more COMPONENTS are specified, the module will attempt to -# find the language bindings for the specified components. The only valid -# components are C, CXX, Fortran, HL, and Fortran_HL. If the COMPONENTS -# argument is not given, the module will attempt to find only the C bindings. +# The module will optionally accept the COMPONENTS argument. If no +# COMPONENTS are specified, then the find module will default to finding +# only the HDF5 C library. If one or more COMPONENTS are specified, the +# module will attempt to find the language bindings for the specified +# components. The only valid components are C, CXX, Fortran, HL, and +# Fortran_HL. If the COMPONENTS argument is not given, the module will +# attempt to find only the C bindings. # -# On UNIX systems, this module will read the variable HDF5_USE_STATIC_LIBRARIES -# to determine whether or not to prefer a static link to a dynamic link for HDF5 -# and all of it's dependencies. To use this feature, make sure that the -# HDF5_USE_STATIC_LIBRARIES variable is set before the call to find_package. +# On UNIX systems, this module will read the variable +# HDF5_USE_STATIC_LIBRARIES to determine whether or not to prefer a +# static link to a dynamic link for HDF5 and all of it's dependencies. +# To use this feature, make sure that the HDF5_USE_STATIC_LIBRARIES +# variable is set before the call to find_package. # -# To provide the module with a hint about where to find your HDF5 installation, -# you can set the environment variable HDF5_ROOT. The Find module will then -# look in this path when searching for HDF5 executables, paths, and libraries. +# To provide the module with a hint about where to find your HDF5 +# installation, you can set the environment variable HDF5_ROOT. The +# Find module will then look in this path when searching for HDF5 +# executables, paths, and libraries. # -# In addition to finding the includes and libraries required to compile an HDF5 -# client application, this module also makes an effort to find tools that come -# with the HDF5 distribution that may be useful for regression testing. +# In addition to finding the includes and libraries required to compile +# an HDF5 client application, this module also makes an effort to find +# tools that come with the HDF5 distribution that may be useful for +# regression testing. # # This module will define the following variables: -# HDF5_INCLUDE_DIRS - Location of the hdf5 includes -# HDF5_INCLUDE_DIR - Location of the hdf5 includes (deprecated) -# HDF5_DEFINITIONS - Required compiler definitions for HDF5 -# HDF5_C_LIBRARIES - Required libraries for the HDF5 C bindings. -# HDF5_CXX_LIBRARIES - Required libraries for the HDF5 C++ bindings -# HDF5_Fortran_LIBRARIES - Required libraries for the HDF5 Fortran bindings -# HDF5_HL_LIBRARIES - Required libraries for the HDF5 high level API -# HDF5_Fortran_HL_LIBRARIES - Required libraries for the high level Fortran -# bindings. -# HDF5_LIBRARIES - Required libraries for all requested bindings -# HDF5_FOUND - true if HDF5 was found on the system -# HDF5_LIBRARY_DIRS - the full set of library directories -# HDF5_IS_PARALLEL - Whether or not HDF5 was found with parallel IO support -# HDF5_C_COMPILER_EXECUTABLE - the path to the HDF5 C wrapper compiler -# HDF5_CXX_COMPILER_EXECUTABLE - the path to the HDF5 C++ wrapper compiler -# HDF5_Fortran_COMPILER_EXECUTABLE - the path to the HDF5 Fortran wrapper compiler -# HDF5_DIFF_EXECUTABLE - the path to the HDF5 dataset comparison tool +# +# :: +# +# HDF5_INCLUDE_DIRS - Location of the hdf5 includes +# HDF5_INCLUDE_DIR - Location of the hdf5 includes (deprecated) +# HDF5_DEFINITIONS - Required compiler definitions for HDF5 +# HDF5_C_LIBRARIES - Required libraries for the HDF5 C bindings. +# HDF5_CXX_LIBRARIES - Required libraries for the HDF5 C++ bindings +# HDF5_Fortran_LIBRARIES - Required libraries for the HDF5 Fortran bindings +# HDF5_HL_LIBRARIES - Required libraries for the HDF5 high level API +# HDF5_Fortran_HL_LIBRARIES - Required libraries for the high level Fortran +# bindings. +# HDF5_LIBRARIES - Required libraries for all requested bindings +# HDF5_FOUND - true if HDF5 was found on the system +# HDF5_LIBRARY_DIRS - the full set of library directories +# HDF5_IS_PARALLEL - Whether or not HDF5 was found with parallel IO support +# HDF5_C_COMPILER_EXECUTABLE - the path to the HDF5 C wrapper compiler +# HDF5_CXX_COMPILER_EXECUTABLE - the path to the HDF5 C++ wrapper compiler +# HDF5_Fortran_COMPILER_EXECUTABLE - the path to the HDF5 Fortran wrapper compiler +# HDF5_DIFF_EXECUTABLE - the path to the HDF5 dataset comparison tool #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindHSPELL.cmake b/Modules/FindHSPELL.cmake index 71e55da..2316533 100644 --- a/Modules/FindHSPELL.cmake +++ b/Modules/FindHSPELL.cmake @@ -1,14 +1,25 @@ -# - Try to find Hspell +#.rst: +# FindHSPELL +# ---------- +# +# Try to find Hspell +# # Once done this will define # -# HSPELL_FOUND - system has Hspell -# HSPELL_INCLUDE_DIR - the Hspell include directory -# HSPELL_LIBRARIES - The libraries needed to use Hspell -# HSPELL_DEFINITIONS - Compiler switches required for using Hspell +# :: +# +# HSPELL_FOUND - system has Hspell +# HSPELL_INCLUDE_DIR - the Hspell include directory +# HSPELL_LIBRARIES - The libraries needed to use Hspell +# HSPELL_DEFINITIONS - Compiler switches required for using Hspell +# +# +# +# :: # -# HSPELL_VERSION_STRING - The version of Hspell found (x.y) -# HSPELL_MAJOR_VERSION - the major version of Hspell -# HSPELL_MINOR_VERSION - The minor version of Hspell +# HSPELL_VERSION_STRING - The version of Hspell found (x.y) +# HSPELL_MAJOR_VERSION - the major version of Hspell +# HSPELL_MINOR_VERSION - The minor version of Hspell #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindHTMLHelp.cmake b/Modules/FindHTMLHelp.cmake index c69e9e9..4e39a34 100644 --- a/Modules/FindHTMLHelp.cmake +++ b/Modules/FindHTMLHelp.cmake @@ -1,9 +1,16 @@ -# - This module looks for Microsoft HTML Help Compiler +#.rst: +# FindHTMLHelp +# ------------ +# +# This module looks for Microsoft HTML Help Compiler +# # It defines: -# HTML_HELP_COMPILER : full path to the Compiler (hhc.exe) -# HTML_HELP_INCLUDE_PATH : include path to the API (htmlhelp.h) -# HTML_HELP_LIBRARY : full path to the library (htmlhelp.lib) # +# :: +# +# HTML_HELP_COMPILER : full path to the Compiler (hhc.exe) +# HTML_HELP_INCLUDE_PATH : include path to the API (htmlhelp.h) +# HTML_HELP_LIBRARY : full path to the library (htmlhelp.lib) #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindHg.cmake b/Modules/FindHg.cmake index a6a4aef..a1fb33f 100644 --- a/Modules/FindHg.cmake +++ b/Modules/FindHg.cmake @@ -1,12 +1,25 @@ +#.rst: +# FindHg +# ------ +# +# +# # The module defines the following variables: -# HG_EXECUTABLE - path to mercurial command line client (hg) -# HG_FOUND - true if the command line client was found -# HG_VERSION_STRING - the version of mercurial found +# +# :: +# +# HG_EXECUTABLE - path to mercurial command line client (hg) +# HG_FOUND - true if the command line client was found +# HG_VERSION_STRING - the version of mercurial found +# # Example usage: -# find_package(Hg) -# if(HG_FOUND) -# message("hg found: ${HG_EXECUTABLE}") -# endif() +# +# :: +# +# find_package(Hg) +# if(HG_FOUND) +# message("hg found: ${HG_EXECUTABLE}") +# endif() #============================================================================= # Copyright 2010-2012 Kitware, Inc. diff --git a/Modules/FindITK.cmake b/Modules/FindITK.cmake index 2929a76..c9d39eb 100644 --- a/Modules/FindITK.cmake +++ b/Modules/FindITK.cmake @@ -1,4 +1,8 @@ -# - Find an ITK installation or build tree. +#.rst: +# FindITK +# ------- +# +# 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 diff --git a/Modules/FindIcotool.cmake b/Modules/FindIcotool.cmake index 8c10177..e29fe2e 100644 --- a/Modules/FindIcotool.cmake +++ b/Modules/FindIcotool.cmake @@ -1,10 +1,17 @@ -# - Find icotool -# This module looks for icotool. This module defines the -# following values: -# ICOTOOL_EXECUTABLE: the full path to the icotool tool. -# ICOTOOL_FOUND: True if icotool has been found. -# ICOTOOL_VERSION_STRING: the version of icotool found. +#.rst: +# FindIcotool +# ----------- # +# Find icotool +# +# This module looks for icotool. This module defines the following +# values: +# +# :: +# +# ICOTOOL_EXECUTABLE: the full path to the icotool tool. +# ICOTOOL_FOUND: True if icotool has been found. +# ICOTOOL_VERSION_STRING: the version of icotool found. #============================================================================= # Copyright 2012 Aleksey Avdeev <solo@altlinux.ru> diff --git a/Modules/FindImageMagick.cmake b/Modules/FindImageMagick.cmake index 7c6cce7..1e7bda5 100644 --- a/Modules/FindImageMagick.cmake +++ b/Modules/FindImageMagick.cmake @@ -1,58 +1,84 @@ -# - Find the ImageMagick binary suite. -# This module will search for a set of ImageMagick tools specified -# as components in the FIND_PACKAGE call. Typical components include, -# but are not limited to (future versions of ImageMagick might have +#.rst: +# FindImageMagick +# --------------- +# +# Find the ImageMagick binary suite. +# +# This module will search for a set of ImageMagick tools specified as +# components in the FIND_PACKAGE call. Typical components include, but +# are not limited to (future versions of ImageMagick might have # additional components not listed here): # -# animate -# compare -# composite -# conjure -# convert -# display -# identify -# import -# mogrify -# montage -# stream +# :: +# +# animate +# compare +# composite +# conjure +# convert +# display +# identify +# import +# mogrify +# montage +# stream +# +# # # If no component is specified in the FIND_PACKAGE call, then it only -# searches for the ImageMagick executable directory. This code defines +# searches for the ImageMagick executable directory. This code defines # the following variables: # -# ImageMagick_FOUND - TRUE if all components are found. -# ImageMagick_EXECUTABLE_DIR - Full path to executables directory. -# ImageMagick_<component>_FOUND - TRUE if <component> is found. -# ImageMagick_<component>_EXECUTABLE - Full path to <component> executable. -# ImageMagick_VERSION_STRING - the version of ImageMagick found -# (since CMake 2.8.8) +# :: +# +# ImageMagick_FOUND - TRUE if all components are found. +# ImageMagick_EXECUTABLE_DIR - Full path to executables directory. +# ImageMagick_<component>_FOUND - TRUE if <component> is found. +# ImageMagick_<component>_EXECUTABLE - Full path to <component> executable. +# ImageMagick_VERSION_STRING - the version of ImageMagick found +# (since CMake 2.8.8) +# +# # # ImageMagick_VERSION_STRING will not work for old versions like 5.2.3. # # There are also components for the following ImageMagick APIs: # -# Magick++ -# MagickWand -# MagickCore +# :: +# +# Magick++ +# MagickWand +# MagickCore +# +# # # For these components the following variables are set: # -# ImageMagick_FOUND - TRUE if all components are found. -# ImageMagick_INCLUDE_DIRS - Full paths to all include dirs. -# ImageMagick_LIBRARIES - Full paths to all libraries. -# ImageMagick_<component>_FOUND - TRUE if <component> is found. -# ImageMagick_<component>_INCLUDE_DIRS - Full path to <component> include dirs. -# ImageMagick_<component>_LIBRARIES - Full path to <component> libraries. +# :: +# +# ImageMagick_FOUND - TRUE if all components are found. +# ImageMagick_INCLUDE_DIRS - Full paths to all include dirs. +# ImageMagick_LIBRARIES - Full paths to all libraries. +# ImageMagick_<component>_FOUND - TRUE if <component> is found. +# ImageMagick_<component>_INCLUDE_DIRS - Full path to <component> include dirs. +# ImageMagick_<component>_LIBRARIES - Full path to <component> libraries. +# +# # # Example Usages: -# find_package(ImageMagick) -# find_package(ImageMagick COMPONENTS convert) -# find_package(ImageMagick COMPONENTS convert mogrify display) -# find_package(ImageMagick COMPONENTS Magick++) -# find_package(ImageMagick COMPONENTS Magick++ convert) -# -# Note that the standard FIND_PACKAGE features are supported -# (i.e., QUIET, REQUIRED, etc.). +# +# :: +# +# find_package(ImageMagick) +# find_package(ImageMagick COMPONENTS convert) +# find_package(ImageMagick COMPONENTS convert mogrify display) +# find_package(ImageMagick COMPONENTS Magick++) +# find_package(ImageMagick COMPONENTS Magick++ convert) +# +# +# +# Note that the standard FIND_PACKAGE features are supported (i.e., +# QUIET, REQUIRED, etc.). #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindJNI.cmake b/Modules/FindJNI.cmake index 9d708ca..1780a8e 100644 --- a/Modules/FindJNI.cmake +++ b/Modules/FindJNI.cmake @@ -1,17 +1,23 @@ -# - Find JNI java libraries. +#.rst: +# FindJNI +# ------- +# +# 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: +# include files and libraries are. It also determines what the name of +# the library is. This code sets the following variables: # -# JNI_INCLUDE_DIRS = the include dirs to use -# JNI_LIBRARIES = the libraries to use -# JNI_FOUND = TRUE if JNI headers and libraries were found. -# JAVA_AWT_LIBRARY = the path to the jawt library -# JAVA_JVM_LIBRARY = the path to the jvm library -# JAVA_INCLUDE_PATH = the include path to jni.h -# JAVA_INCLUDE_PATH2 = the include path to jni_md.h -# JAVA_AWT_INCLUDE_PATH = the include path to jawt.h +# :: # +# JNI_INCLUDE_DIRS = the include dirs to use +# JNI_LIBRARIES = the libraries to use +# JNI_FOUND = TRUE if JNI headers and libraries were found. +# JAVA_AWT_LIBRARY = the path to the jawt library +# JAVA_JVM_LIBRARY = the path to the jvm library +# JAVA_INCLUDE_PATH = the include path to jni.h +# JAVA_INCLUDE_PATH2 = the include path to jni_md.h +# JAVA_AWT_INCLUDE_PATH = the include path to jawt.h #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindJPEG.cmake b/Modules/FindJPEG.cmake index 7c1f0fd..90e4485 100644 --- a/Modules/FindJPEG.cmake +++ b/Modules/FindJPEG.cmake @@ -1,11 +1,22 @@ -# - 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 needed to use JPEG. -# JPEG_FOUND, If false, do not try to use JPEG. +#.rst: +# FindJPEG +# -------- +# +# 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 needed 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. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindJasper.cmake b/Modules/FindJasper.cmake index 136056b..0f325f0 100644 --- a/Modules/FindJasper.cmake +++ b/Modules/FindJasper.cmake @@ -1,10 +1,17 @@ -# - Try to find the Jasper JPEG2000 library +#.rst: +# FindJasper +# ---------- +# +# Try to find the Jasper JPEG2000 library +# # Once done this will define # -# JASPER_FOUND - system has Jasper -# JASPER_INCLUDE_DIR - the Jasper include directory -# JASPER_LIBRARIES - the libraries needed to use Jasper -# JASPER_VERSION_STRING - the version of Jasper found (since CMake 2.8.8) +# :: +# +# JASPER_FOUND - system has Jasper +# JASPER_INCLUDE_DIR - the Jasper include directory +# JASPER_LIBRARIES - the libraries needed to use Jasper +# JASPER_VERSION_STRING - the version of Jasper found (since CMake 2.8.8) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindJava.cmake b/Modules/FindJava.cmake index 2f02b7a..2d1a976 100644 --- a/Modules/FindJava.cmake +++ b/Modules/FindJava.cmake @@ -1,46 +1,57 @@ -# - Find Java +#.rst: +# FindJava +# -------- +# +# Find Java +# # This module finds if Java is installed and determines where the -# include files and libraries are. This code sets the following +# include files and libraries are. This code sets the following # variables: # -# Java_JAVA_EXECUTABLE = the full path to the Java runtime -# Java_JAVAC_EXECUTABLE = the full path to the Java compiler -# Java_JAVAH_EXECUTABLE = the full path to the Java header generator -# Java_JAVADOC_EXECUTABLE = the full path to the Java documention generator -# Java_JAR_EXECUTABLE = the full path to the Java archiver -# Java_VERSION_STRING = Version of the package found (java version), eg. 1.6.0_12 -# Java_VERSION_MAJOR = The major version of the package found. -# Java_VERSION_MINOR = The minor version of the package found. -# Java_VERSION_PATCH = The patch version of the package found. -# Java_VERSION_TWEAK = The tweak version of the package found (after '_') -# Java_VERSION = This is set to: $major.$minor.$patch(.$tweak) +# :: +# +# Java_JAVA_EXECUTABLE = the full path to the Java runtime +# Java_JAVAC_EXECUTABLE = the full path to the Java compiler +# Java_JAVAH_EXECUTABLE = the full path to the Java header generator +# Java_JAVADOC_EXECUTABLE = the full path to the Java documention generator +# Java_JAR_EXECUTABLE = the full path to the Java archiver +# Java_VERSION_STRING = Version of the package found (java version), eg. 1.6.0_12 +# Java_VERSION_MAJOR = The major version of the package found. +# Java_VERSION_MINOR = The minor version of the package found. +# Java_VERSION_PATCH = The patch version of the package found. +# Java_VERSION_TWEAK = The tweak version of the package found (after '_') +# Java_VERSION = This is set to: $major.$minor.$patch(.$tweak) +# +# # # The minimum required version of Java can be specified using the -# standard CMake syntax, e.g. find_package(Java 1.5) +# standard CMake syntax, e.g. find_package(Java 1.5) # -# NOTE: ${Java_VERSION} and ${Java_VERSION_STRING} are not guaranteed to be -# identical. For example some java version may return: -# Java_VERSION_STRING = 1.5.0_17 -# and -# Java_VERSION = 1.5.0.17 +# NOTE: ${Java_VERSION} and ${Java_VERSION_STRING} are not guaranteed to +# be identical. For example some java version may return: +# Java_VERSION_STRING = 1.5.0_17 and Java_VERSION = 1.5.0.17 # -# another example is the Java OEM, with: -# Java_VERSION_STRING = 1.6.0-oem -# and -# Java_VERSION = 1.6.0 +# another example is the Java OEM, with: Java_VERSION_STRING = 1.6.0-oem +# and Java_VERSION = 1.6.0 # # For these components the following variables are set: # -# Java_FOUND - TRUE if all components are found. -# Java_INCLUDE_DIRS - Full paths to all include dirs. -# Java_LIBRARIES - Full paths to all libraries. -# Java_<component>_FOUND - TRUE if <component> is found. +# :: +# +# Java_FOUND - TRUE if all components are found. +# Java_INCLUDE_DIRS - Full paths to all include dirs. +# Java_LIBRARIES - Full paths to all libraries. +# Java_<component>_FOUND - TRUE if <component> is found. +# +# # # Example Usages: -# find_package(Java) -# find_package(Java COMPONENTS Runtime) -# find_package(Java COMPONENTS Development) # +# :: +# +# find_package(Java) +# find_package(Java COMPONENTS Runtime) +# find_package(Java COMPONENTS Development) #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindKDE3.cmake b/Modules/FindKDE3.cmake index 70eccef..159e29c 100644 --- a/Modules/FindKDE3.cmake +++ b/Modules/FindKDE3.cmake @@ -1,64 +1,132 @@ -# - Find the KDE3 include and library dirs, KDE preprocessors and define a some macros +#.rst: +# FindKDE3 +# -------- +# +# Find the KDE3 include and library dirs, KDE preprocessors and define a some macros +# +# # # This module defines the following variables: -# KDE3_DEFINITIONS - compiler definitions required for compiling KDE software -# KDE3_INCLUDE_DIR - the KDE include directory -# KDE3_INCLUDE_DIRS - the KDE and the Qt include directory, for use with include_directories() -# KDE3_LIB_DIR - the directory where the KDE libraries are installed, for use with link_directories() -# QT_AND_KDECORE_LIBS - this contains both the Qt and the kdecore library -# KDE3_DCOPIDL_EXECUTABLE - the dcopidl executable -# KDE3_DCOPIDL2CPP_EXECUTABLE - the dcopidl2cpp executable -# KDE3_KCFGC_EXECUTABLE - the kconfig_compiler executable -# KDE3_FOUND - set to TRUE if all of the above has been found +# +# :: +# +# KDE3_DEFINITIONS - compiler definitions required for compiling KDE software +# KDE3_INCLUDE_DIR - the KDE include directory +# KDE3_INCLUDE_DIRS - the KDE and the Qt include directory, for use with include_directories() +# KDE3_LIB_DIR - the directory where the KDE libraries are installed, for use with link_directories() +# QT_AND_KDECORE_LIBS - this contains both the Qt and the kdecore library +# KDE3_DCOPIDL_EXECUTABLE - the dcopidl executable +# KDE3_DCOPIDL2CPP_EXECUTABLE - the dcopidl2cpp executable +# KDE3_KCFGC_EXECUTABLE - the kconfig_compiler executable +# KDE3_FOUND - set to TRUE if all of the above has been found +# +# # # The following user adjustable options are provided: # -# KDE3_BUILD_TESTS - enable this to build KDE testcases +# :: +# +# KDE3_BUILD_TESTS - enable this to build KDE testcases +# +# +# +# +# +# It also adds the following macros (from KDE3Macros.cmake) SRCS_VAR is +# always the variable which contains the list of source files for your +# application or library. +# +# KDE3_AUTOMOC(file1 ... fileN) +# +# :: +# +# Call this if you want to have automatic moc file handling. +# This means if you include "foo.moc" in the source file foo.cpp +# a moc file for the header foo.h will be created automatically. +# You can set the property SKIP_AUTOMAKE using set_source_files_properties() +# to exclude some files in the list from being processed. +# +# +# +# KDE3_ADD_MOC_FILES(SRCS_VAR file1 ... fileN ) +# +# :: +# +# If you don't use the KDE3_AUTOMOC() macro, for the files +# listed here moc files will be created (named "foo.moc.cpp") +# +# +# +# KDE3_ADD_DCOP_SKELS(SRCS_VAR header1.h ... headerN.h ) +# +# :: +# +# Use this to generate DCOP skeletions from the listed headers. # # -# It also adds the following macros (from KDE3Macros.cmake) -# SRCS_VAR is always the variable which contains the list of source files for your application or library. # -# KDE3_AUTOMOC(file1 ... fileN) -# Call this if you want to have automatic moc file handling. -# This means if you include "foo.moc" in the source file foo.cpp -# a moc file for the header foo.h will be created automatically. -# You can set the property SKIP_AUTOMAKE using set_source_files_properties() -# to exclude some files in the list from being processed. +# KDE3_ADD_DCOP_STUBS(SRCS_VAR header1.h ... headerN.h ) # -# KDE3_ADD_MOC_FILES(SRCS_VAR file1 ... fileN ) -# If you don't use the KDE3_AUTOMOC() macro, for the files -# listed here moc files will be created (named "foo.moc.cpp") +# :: # -# KDE3_ADD_DCOP_SKELS(SRCS_VAR header1.h ... headerN.h ) -# Use this to generate DCOP skeletions from the listed headers. +# Use this to generate DCOP stubs from the listed headers. # -# KDE3_ADD_DCOP_STUBS(SRCS_VAR header1.h ... headerN.h ) -# Use this to generate DCOP stubs from the listed headers. # -# KDE3_ADD_UI_FILES(SRCS_VAR file1.ui ... fileN.ui ) -# Use this to add the Qt designer ui files to your application/library. # -# KDE3_ADD_KCFG_FILES(SRCS_VAR file1.kcfgc ... fileN.kcfgc ) -# Use this to add KDE kconfig compiler files to your application/library. +# KDE3_ADD_UI_FILES(SRCS_VAR file1.ui ... fileN.ui ) +# +# :: +# +# Use this to add the Qt designer ui files to your application/library. +# +# +# +# KDE3_ADD_KCFG_FILES(SRCS_VAR file1.kcfgc ... fileN.kcfgc ) +# +# :: +# +# Use this to add KDE kconfig compiler files to your application/library. +# +# # # KDE3_INSTALL_LIBTOOL_FILE(target) -# This will create and install a simple libtool file for the given target. # -# KDE3_ADD_EXECUTABLE(name file1 ... fileN ) -# Currently identical to add_executable(), may provide some advanced features in the future. +# :: +# +# This will create and install a simple libtool file for the given target. +# +# +# +# KDE3_ADD_EXECUTABLE(name file1 ... fileN ) +# +# :: +# +# Currently identical to add_executable(), may provide some advanced features in the future. +# +# +# +# KDE3_ADD_KPART(name [WITH_PREFIX] file1 ... fileN ) +# +# :: +# +# Create a KDE plugin (KPart, kioslave, etc.) from the given source files. +# If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't. +# It creates and installs an appropriate libtool la-file. +# +# +# +# KDE3_ADD_KDEINIT_EXECUTABLE(name file1 ... fileN ) +# +# :: +# +# Create a KDE application in the form of a module loadable via kdeinit. +# A library named kdeinit_<name> will be created and a small executable which links to it. +# # -# KDE3_ADD_KPART(name [WITH_PREFIX] file1 ... fileN ) -# Create a KDE plugin (KPart, kioslave, etc.) from the given source files. -# If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't. -# It creates and installs an appropriate libtool la-file. # -# KDE3_ADD_KDEINIT_EXECUTABLE(name file1 ... fileN ) -# Create a KDE application in the form of a module loadable via kdeinit. -# A library named kdeinit_<name> will be created and a small executable which links to it. +# The option KDE3_ENABLE_FINAL to enable all-in-one compilation is no +# longer supported. # -# The option KDE3_ENABLE_FINAL to enable all-in-one compilation is -# no longer supported. # # # Author: Alexander Neundorf <neundorf@kde.org> diff --git a/Modules/FindKDE4.cmake b/Modules/FindKDE4.cmake index c653a04..3c2c309 100644 --- a/Modules/FindKDE4.cmake +++ b/Modules/FindKDE4.cmake @@ -1,11 +1,24 @@ -# Find KDE4 and provide all necessary variables and macros to compile software for it. -# It looks for KDE 4 in the following directories in the given order: -# CMAKE_INSTALL_PREFIX -# KDEDIRS -# /opt/kde4 +#.rst: +# FindKDE4 +# -------- # -# Please look in FindKDE4Internal.cmake and KDE4Macros.cmake for more information. -# They are installed with the KDE 4 libraries in $KDEDIRS/share/apps/cmake/modules/. +# +# +# Find KDE4 and provide all necessary variables and macros to compile +# software for it. It looks for KDE 4 in the following directories in +# the given order: +# +# :: +# +# CMAKE_INSTALL_PREFIX +# KDEDIRS +# /opt/kde4 +# +# +# +# Please look in FindKDE4Internal.cmake and KDE4Macros.cmake for more +# information. They are installed with the KDE 4 libraries in +# $KDEDIRS/share/apps/cmake/modules/. # # Author: Alexander Neundorf <neundorf@kde.org> diff --git a/Modules/FindLAPACK.cmake b/Modules/FindLAPACK.cmake index 3167850..69da4cd 100644 --- a/Modules/FindLAPACK.cmake +++ b/Modules/FindLAPACK.cmake @@ -1,27 +1,37 @@ -# - Find LAPACK library -# This module finds an installed fortran library that implements the LAPACK -# linear-algebra interface (see http://www.netlib.org/lapack/). +#.rst: +# FindLAPACK +# ---------- # -# The approach follows that taken for the autoconf macro file, acx_lapack.m4 -# (distributed at http://ac-archive.sourceforge.net/ac-archive/acx_lapack.html). +# Find LAPACK library +# +# This module finds an installed fortran library that implements the +# LAPACK linear-algebra interface (see http://www.netlib.org/lapack/). +# +# The approach follows that taken for the autoconf macro file, +# acx_lapack.m4 (distributed at +# http://ac-archive.sourceforge.net/ac-archive/acx_lapack.html). # # This module sets the following variables: -# LAPACK_FOUND - set to true if a library implementing the LAPACK interface -# is found -# LAPACK_LINKER_FLAGS - uncached list of required linker flags (excluding -l -# and -L). -# LAPACK_LIBRARIES - uncached list of libraries (using full path name) to -# link against to use LAPACK -# LAPACK95_LIBRARIES - uncached list of libraries (using full path name) to -# link against to use LAPACK95 -# LAPACK95_FOUND - set to true if a library implementing the LAPACK f95 -# interface is found -# BLA_STATIC if set on this determines what kind of linkage we do (static) -# BLA_VENDOR if set checks only the specified vendor, if not set checks -# all the possibilities -# BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK -### List of vendors (BLA_VENDOR) valid in this module -## Intel(mkl), ACML,Apple, NAS, Generic +# +# :: +# +# LAPACK_FOUND - set to true if a library implementing the LAPACK interface +# is found +# LAPACK_LINKER_FLAGS - uncached list of required linker flags (excluding -l +# and -L). +# LAPACK_LIBRARIES - uncached list of libraries (using full path name) to +# link against to use LAPACK +# LAPACK95_LIBRARIES - uncached list of libraries (using full path name) to +# link against to use LAPACK95 +# LAPACK95_FOUND - set to true if a library implementing the LAPACK f95 +# interface is found +# BLA_STATIC if set on this determines what kind of linkage we do (static) +# BLA_VENDOR if set checks only the specified vendor, if not set checks +# all the possibilities +# BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK +# +# ## List of vendors (BLA_VENDOR) valid in this module # Intel(mkl), +# ACML,Apple, NAS, Generic #============================================================================= # Copyright 2007-2009 Kitware, Inc. @@ -229,57 +239,61 @@ if (BLA_VENDOR MATCHES "Intel*" OR BLA_VENDOR STREQUAL "All") else() find_package(Threads REQUIRED) endif() + + set(LAPACK_SEARCH_LIBS "") + if (BLA_F95) - if(NOT LAPACK95_LIBRARIES) - # old - check_lapack_libraries( - LAPACK95_LIBRARIES - LAPACK - cheev - "" - "mkl_lapack95" - "${BLAS95_LIBRARIES}" - "${CMAKE_THREAD_LIBS_INIT};${LM}" - ) - endif() - if(NOT LAPACK95_LIBRARIES) - # new >= 10.3 - check_lapack_libraries( - LAPACK95_LIBRARIES - LAPACK - CHEEV - "" - "mkl_intel_lp64" - "${BLAS95_LIBRARIES}" - "${CMAKE_THREAD_LIBS_INIT};${LM}" - ) - endif() + set(LAPACK_mkl_SEARCH_SYMBOL "CHEEV") + set(_LIBRARIES LAPACK95_LIBRARIES) + set(_BLAS_LIBRARIES ${BLAS95_LIBRARIES}) + + # old + list(APPEND LAPACK_SEARCH_LIBS + "mkl_lapack95") + # new >= 10.3 + list(APPEND LAPACK_SEARCH_LIBS + "mkl_intel_c") + list(APPEND LAPACK_SEARCH_LIBS + "mkl_intel_lp64") else() - if(NOT LAPACK_LIBRARIES) - # old - check_lapack_libraries( - LAPACK_LIBRARIES - LAPACK - cheev - "" - "mkl_lapack" - "${BLAS_LIBRARIES}" - "${CMAKE_THREAD_LIBS_INIT};${LM}" - ) - endif() - if(NOT LAPACK_LIBRARIES) - # new >= 10.3 + set(LAPACK_mkl_SEARCH_SYMBOL "cheev") + set(_LIBRARIES LAPACK_LIBRARIES) + set(_BLAS_LIBRARIES ${BLAS_LIBRARIES}) + + # old + list(APPEND LAPACK_SEARCH_LIBS + "mkl_lapack") + # new >= 10.3 + list(APPEND LAPACK_SEARCH_LIBS + "mkl_gf_lp64") + endif() + + # First try empty lapack libs + if (NOT ${_LIBRARIES}) + check_lapack_libraries( + ${_LIBRARIES} + BLAS + ${LAPACK_mkl_SEARCH_SYMBOL} + "" + "" + "${_BLAS_LIBRARIES}" + "${CMAKE_THREAD_LIBS_INIT};${LM}" + ) + endif () + # Then try the search libs + foreach (IT ${LAPACK_SEARCH_LIBS}) + if (NOT ${_LIBRARIES}) check_lapack_libraries( - LAPACK_LIBRARIES - LAPACK - cheev + ${_LIBRARIES} + BLAS + ${LAPACK_mkl_SEARCH_SYMBOL} "" - "mkl_gf_lp64" - "${BLAS_LIBRARIES}" + "${IT}" + "${_BLAS_LIBRARIES}" "${CMAKE_THREAD_LIBS_INIT};${LM}" ) - endif() - endif() + endif () + endforeach () endif () endif() else() diff --git a/Modules/FindLATEX.cmake b/Modules/FindLATEX.cmake index bc752a9..e78d5bf 100644 --- a/Modules/FindLATEX.cmake +++ b/Modules/FindLATEX.cmake @@ -1,15 +1,21 @@ -# - Find Latex +#.rst: +# FindLATEX +# --------- +# +# Find Latex +# # This module finds if Latex is installed and determines where the -# executables are. This code sets the following variables: +# executables are. This code sets the following variables: # -# LATEX_COMPILER: path to the LaTeX compiler -# PDFLATEX_COMPILER: path to the PdfLaTeX compiler -# BIBTEX_COMPILER: path to the BibTeX compiler -# MAKEINDEX_COMPILER: path to the MakeIndex compiler -# DVIPS_CONVERTER: path to the DVIPS converter -# PS2PDF_CONVERTER: path to the PS2PDF converter -# LATEX2HTML_CONVERTER: path to the LaTeX2Html converter +# :: # +# LATEX_COMPILER: path to the LaTeX compiler +# PDFLATEX_COMPILER: path to the PdfLaTeX compiler +# BIBTEX_COMPILER: path to the BibTeX compiler +# MAKEINDEX_COMPILER: path to the MakeIndex compiler +# DVIPS_CONVERTER: path to the DVIPS converter +# PS2PDF_CONVERTER: path to the PS2PDF converter +# LATEX2HTML_CONVERTER: path to the LaTeX2Html converter #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindLibArchive.cmake b/Modules/FindLibArchive.cmake index be931c5..471a4f1 100644 --- a/Modules/FindLibArchive.cmake +++ b/Modules/FindLibArchive.cmake @@ -1,10 +1,17 @@ -# - Find libarchive library and headers +#.rst: +# FindLibArchive +# -------------- +# +# Find libarchive library and headers +# # The module defines the following variables: # -# LibArchive_FOUND - true if libarchive was found -# LibArchive_INCLUDE_DIRS - include search path -# LibArchive_LIBRARIES - libraries to link -# LibArchive_VERSION - libarchive 3-component version number +# :: +# +# LibArchive_FOUND - true if libarchive was found +# LibArchive_INCLUDE_DIRS - include search path +# LibArchive_LIBRARIES - libraries to link +# LibArchive_VERSION - libarchive 3-component version number #============================================================================= # Copyright 2010 Kitware, Inc. diff --git a/Modules/FindLibLZMA.cmake b/Modules/FindLibLZMA.cmake index 837e633..be01594 100644 --- a/Modules/FindLibLZMA.cmake +++ b/Modules/FindLibLZMA.cmake @@ -1,16 +1,23 @@ -# - Find LibLZMA +#.rst: +# FindLibLZMA +# ----------- +# +# Find LibLZMA +# # Find LibLZMA headers and library # -# LIBLZMA_FOUND - True if liblzma is found. -# LIBLZMA_INCLUDE_DIRS - Directory where liblzma headers are located. -# LIBLZMA_LIBRARIES - Lzma libraries to link against. -# LIBLZMA_HAS_AUTO_DECODER - True if lzma_auto_decoder() is found (required). -# LIBLZMA_HAS_EASY_ENCODER - True if lzma_easy_encoder() is found (required). -# LIBLZMA_HAS_LZMA_PRESET - True if lzma_lzma_preset() is found (required). -# LIBLZMA_VERSION_MAJOR - The major version of lzma -# LIBLZMA_VERSION_MINOR - The minor version of lzma -# LIBLZMA_VERSION_PATCH - The patch version of lzma -# LIBLZMA_VERSION_STRING - version number as a string (ex: "5.0.3") +# :: +# +# LIBLZMA_FOUND - True if liblzma is found. +# LIBLZMA_INCLUDE_DIRS - Directory where liblzma headers are located. +# LIBLZMA_LIBRARIES - Lzma libraries to link against. +# LIBLZMA_HAS_AUTO_DECODER - True if lzma_auto_decoder() is found (required). +# LIBLZMA_HAS_EASY_ENCODER - True if lzma_easy_encoder() is found (required). +# LIBLZMA_HAS_LZMA_PRESET - True if lzma_lzma_preset() is found (required). +# LIBLZMA_VERSION_MAJOR - The major version of lzma +# LIBLZMA_VERSION_MINOR - The minor version of lzma +# LIBLZMA_VERSION_PATCH - The patch version of lzma +# LIBLZMA_VERSION_STRING - version number as a string (ex: "5.0.3") #============================================================================= # Copyright 2008 Per Øyvind Karlsen <peroyvind@mandriva.org> diff --git a/Modules/FindLibXml2.cmake b/Modules/FindLibXml2.cmake index 858496e..7322428 100644 --- a/Modules/FindLibXml2.cmake +++ b/Modules/FindLibXml2.cmake @@ -1,12 +1,19 @@ -# - Try to find the LibXml2 xml processing library +#.rst: +# FindLibXml2 +# ----------- +# +# Try to find the LibXml2 xml processing library +# # Once done this will define # -# LIBXML2_FOUND - System has LibXml2 -# LIBXML2_INCLUDE_DIR - The LibXml2 include directory -# LIBXML2_LIBRARIES - The libraries needed to use LibXml2 -# LIBXML2_DEFINITIONS - Compiler switches required for using LibXml2 -# LIBXML2_XMLLINT_EXECUTABLE - The XML checking tool xmllint coming with LibXml2 -# LIBXML2_VERSION_STRING - the version of LibXml2 found (since CMake 2.8.8) +# :: +# +# LIBXML2_FOUND - System has LibXml2 +# LIBXML2_INCLUDE_DIR - The LibXml2 include directory +# LIBXML2_LIBRARIES - The libraries needed to use LibXml2 +# LIBXML2_DEFINITIONS - Compiler switches required for using LibXml2 +# LIBXML2_XMLLINT_EXECUTABLE - The XML checking tool xmllint coming with LibXml2 +# LIBXML2_VERSION_STRING - the version of LibXml2 found (since CMake 2.8.8) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindLibXslt.cmake b/Modules/FindLibXslt.cmake index 7d142f4..bf2f821 100644 --- a/Modules/FindLibXslt.cmake +++ b/Modules/FindLibXslt.cmake @@ -1,14 +1,26 @@ -# - Try to find the LibXslt library +#.rst: +# FindLibXslt +# ----------- +# +# Try to find the LibXslt library +# # Once done this will define # -# LIBXSLT_FOUND - system has LibXslt -# LIBXSLT_INCLUDE_DIR - the LibXslt include directory -# LIBXSLT_LIBRARIES - Link these to LibXslt -# LIBXSLT_DEFINITIONS - Compiler switches required for using LibXslt -# LIBXSLT_VERSION_STRING - version of LibXslt found (since CMake 2.8.8) -# Additionally, the following two variables are set (but not required for using xslt): -# LIBXSLT_EXSLT_LIBRARIES - Link to these if you need to link against the exslt library -# LIBXSLT_XSLTPROC_EXECUTABLE - Contains the full path to the xsltproc executable if found +# :: +# +# LIBXSLT_FOUND - system has LibXslt +# LIBXSLT_INCLUDE_DIR - the LibXslt include directory +# LIBXSLT_LIBRARIES - Link these to LibXslt +# LIBXSLT_DEFINITIONS - Compiler switches required for using LibXslt +# LIBXSLT_VERSION_STRING - version of LibXslt found (since CMake 2.8.8) +# +# Additionally, the following two variables are set (but not required +# for using xslt): +# +# :: +# +# LIBXSLT_EXSLT_LIBRARIES - Link to these if you need to link against the exslt library +# LIBXSLT_XSLTPROC_EXECUTABLE - Contains the full path to the xsltproc executable if found #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindLua.cmake b/Modules/FindLua.cmake index 31fe54c..cc35e54 100644 --- a/Modules/FindLua.cmake +++ b/Modules/FindLua.cmake @@ -1,19 +1,37 @@ -# Locate Lua library -# This module defines -# LUA_FOUND - if false, do not try to link to Lua -# LUA_LIBRARIES - both lua and lualib -# LUA_INCLUDE_DIR - where to find lua.h -# LUA_VERSION_STRING - the version of Lua found -# LUA_VERSION_MAJOR - the major version of Lua -# LUA_VERSION_MINOR - the minor version of Lua -# LUA_VERSION_PATCH - the patch version of Lua +#.rst: +# FindLua +# ------- +# +# +# +# Locate Lua library This module defines +# +# :: +# +# LUA_FOUND - if false, do not try to link to Lua +# LUA_LIBRARIES - both lua and lualib +# LUA_INCLUDE_DIR - where to find lua.h +# LUA_VERSION_STRING - the version of Lua found +# LUA_VERSION_MAJOR - the major version of Lua +# LUA_VERSION_MINOR - the minor version of Lua +# LUA_VERSION_PATCH - the patch version of Lua +# +# # # Note that the expected include convention is -# #include "lua.h" +# +# :: +# +# #include "lua.h" +# # and not -# #include <lua/lua.h> -# This is because, the lua location is not standardized and may exist -# in locations other than lua/ +# +# :: +# +# #include <lua/lua.h> +# +# This is because, the lua location is not standardized and may exist in +# locations other than lua/ #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindLua50.cmake b/Modules/FindLua50.cmake index 0276a98..666d909 100644 --- a/Modules/FindLua50.cmake +++ b/Modules/FindLua50.cmake @@ -1,15 +1,33 @@ -# Locate Lua library -# This module defines -# LUA50_FOUND, if false, do not try to link to Lua -# LUA_LIBRARIES, both lua and lualib -# LUA_INCLUDE_DIR, where to find lua.h and lualib.h (and probably lauxlib.h) +#.rst: +# FindLua50 +# --------- +# +# +# +# Locate Lua library This module defines +# +# :: +# +# LUA50_FOUND, if false, do not try to link to Lua +# LUA_LIBRARIES, both lua and lualib +# LUA_INCLUDE_DIR, where to find lua.h and lualib.h (and probably lauxlib.h) +# +# # # Note that the expected include convention is -# #include "lua.h" +# +# :: +# +# #include "lua.h" +# # and not -# #include <lua/lua.h> -# This is because, the lua location is not standardized and may exist -# in locations other than lua/ +# +# :: +# +# #include <lua/lua.h> +# +# This is because, the lua location is not standardized and may exist in +# locations other than lua/ #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindLua51.cmake b/Modules/FindLua51.cmake index a2bf0c0..5b9ff91 100644 --- a/Modules/FindLua51.cmake +++ b/Modules/FindLua51.cmake @@ -1,16 +1,34 @@ -# Locate Lua library -# This module defines -# LUA51_FOUND, if false, do not try to link to Lua -# LUA_LIBRARIES -# LUA_INCLUDE_DIR, where to find lua.h -# LUA_VERSION_STRING, the version of Lua found (since CMake 2.8.8) +#.rst: +# FindLua51 +# --------- +# +# +# +# Locate Lua library This module defines +# +# :: +# +# LUA51_FOUND, if false, do not try to link to Lua +# LUA_LIBRARIES +# LUA_INCLUDE_DIR, where to find lua.h +# LUA_VERSION_STRING, the version of Lua found (since CMake 2.8.8) +# +# # # Note that the expected include convention is -# #include "lua.h" +# +# :: +# +# #include "lua.h" +# # and not -# #include <lua/lua.h> -# This is because, the lua location is not standardized and may exist -# in locations other than lua/ +# +# :: +# +# #include <lua/lua.h> +# +# This is because, the lua location is not standardized and may exist in +# locations other than lua/ #============================================================================= # Copyright 2007-2009 Kitware, Inc. @@ -54,7 +72,7 @@ find_library(LUA_LIBRARY if(LUA_LIBRARY) # include the math library for Unix - if(UNIX AND NOT APPLE AND NOT BEOS) + if(UNIX AND NOT APPLE AND NOT BEOS AND NOT HAIKU) find_library(LUA_MATH_LIBRARY m) set( LUA_LIBRARIES "${LUA_LIBRARY};${LUA_MATH_LIBRARY}" CACHE STRING "Lua Libraries") # For Windows and Mac, don't need to explicitly include the math library diff --git a/Modules/FindMFC.cmake b/Modules/FindMFC.cmake index 4ff7586..261ebdb 100644 --- a/Modules/FindMFC.cmake +++ b/Modules/FindMFC.cmake @@ -1,7 +1,16 @@ -# - Find MFC on Windows -# Find the native MFC - i.e. decide if an application can link to the MFC -# libraries. -# MFC_FOUND - Was MFC support found +#.rst: +# FindMFC +# ------- +# +# Find MFC on Windows +# +# Find the native MFC - i.e. decide if an application can link to the +# MFC libraries. +# +# :: +# +# MFC_FOUND - Was MFC support found +# # You don't need to include anything or link anything to use it. #============================================================================= diff --git a/Modules/FindMPEG.cmake b/Modules/FindMPEG.cmake index f99f87b..26ee8dd 100644 --- a/Modules/FindMPEG.cmake +++ b/Modules/FindMPEG.cmake @@ -1,11 +1,23 @@ -# - Find the native MPEG includes and library +#.rst: +# FindMPEG +# -------- +# +# Find the native MPEG includes and library +# # This module defines -# MPEG_INCLUDE_DIR, where to find MPEG.h, etc. -# MPEG_LIBRARIES, the libraries required 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 required 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. #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindMPEG2.cmake b/Modules/FindMPEG2.cmake index fc01c4c..f2f2076 100644 --- a/Modules/FindMPEG2.cmake +++ b/Modules/FindMPEG2.cmake @@ -1,11 +1,23 @@ -# - Find the native MPEG2 includes and library +#.rst: +# FindMPEG2 +# --------- +# +# Find the native MPEG2 includes and library +# # This module defines -# MPEG2_INCLUDE_DIR, path to mpeg2dec/mpeg2.h, etc. -# MPEG2_LIBRARIES, the libraries required to use MPEG2. -# MPEG2_FOUND, If false, do not try to use MPEG2. +# +# :: +# +# MPEG2_INCLUDE_DIR, path to mpeg2dec/mpeg2.h, etc. +# MPEG2_LIBRARIES, the libraries required 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. #============================================================================= # Copyright 2003-2009 Kitware, Inc. diff --git a/Modules/FindMPI.cmake b/Modules/FindMPI.cmake index 0eb86a8..c8d46ba 100644 --- a/Modules/FindMPI.cmake +++ b/Modules/FindMPI.cmake @@ -1,64 +1,88 @@ -# - Find a Message Passing Interface (MPI) implementation +#.rst: +# FindMPI +# ------- +# +# Find a Message Passing Interface (MPI) implementation +# # The Message Passing Interface (MPI) is a library used to write -# high-performance distributed-memory parallel applications, and -# is typically deployed on a cluster. MPI is a standard interface -# (defined by the MPI forum) for which many implementations are -# available. All of them have somewhat different include paths, -# libraries to link against, etc., and this module tries to smooth -# out those differences. +# high-performance distributed-memory parallel applications, and is +# typically deployed on a cluster. MPI is a standard interface (defined +# by the MPI forum) for which many implementations are available. All +# of them have somewhat different include paths, libraries to link +# against, etc., and this module tries to smooth out those differences. # # === Variables === # -# This module will set the following variables per language in your project, -# where <lang> is one of C, CXX, or Fortran: -# MPI_<lang>_FOUND TRUE if FindMPI found MPI flags for <lang> -# MPI_<lang>_COMPILER MPI Compiler wrapper for <lang> -# MPI_<lang>_COMPILE_FLAGS Compilation flags for MPI programs -# MPI_<lang>_INCLUDE_PATH Include path(s) for MPI header -# MPI_<lang>_LINK_FLAGS Linking flags for MPI programs -# MPI_<lang>_LIBRARIES All libraries to link MPI programs against +# This module will set the following variables per language in your +# project, where <lang> is one of C, CXX, or Fortran: +# +# :: +# +# MPI_<lang>_FOUND TRUE if FindMPI found MPI flags for <lang> +# MPI_<lang>_COMPILER MPI Compiler wrapper for <lang> +# MPI_<lang>_COMPILE_FLAGS Compilation flags for MPI programs +# MPI_<lang>_INCLUDE_PATH Include path(s) for MPI header +# MPI_<lang>_LINK_FLAGS Linking flags for MPI programs +# MPI_<lang>_LIBRARIES All libraries to link MPI programs against +# # Additionally, FindMPI sets the following variables for running MPI # programs from the command line: -# MPIEXEC Executable for running MPI programs -# MPIEXEC_NUMPROC_FLAG Flag to pass to MPIEXEC before giving -# it the number of processors to run on -# MPIEXEC_PREFLAGS Flags to pass to MPIEXEC directly -# before the executable to run. -# MPIEXEC_POSTFLAGS Flags to pass to MPIEXEC after other flags +# +# :: +# +# MPIEXEC Executable for running MPI programs +# MPIEXEC_NUMPROC_FLAG Flag to pass to MPIEXEC before giving +# it the number of processors to run on +# MPIEXEC_PREFLAGS Flags to pass to MPIEXEC directly +# before the executable to run. +# MPIEXEC_POSTFLAGS Flags to pass to MPIEXEC after other flags +# # === Usage === # # To use this module, simply call FindMPI from a CMakeLists.txt file, or -# run find_package(MPI), then run CMake. If you are happy with the auto- -# detected configuration for your language, then you're done. If not, you -# have two options: -# 1. Set MPI_<lang>_COMPILER to the MPI wrapper (mpicc, etc.) of your -# choice and reconfigure. FindMPI will attempt to determine all the -# necessary variables using THAT compiler's compile and link flags. -# 2. If this fails, or if your MPI implementation does not come with -# a compiler wrapper, then set both MPI_<lang>_LIBRARIES and -# MPI_<lang>_INCLUDE_PATH. You may also set any other variables -# listed above, but these two are required. This will circumvent -# autodetection entirely. -# When configuration is successful, MPI_<lang>_COMPILER will be set to the -# compiler wrapper for <lang>, if it was found. MPI_<lang>_FOUND and other -# variables above will be set if any MPI implementation was found for <lang>, -# regardless of whether a compiler was found. -# -# When using MPIEXEC to execute MPI applications, you should typically use -# all of the MPIEXEC flags as follows: -# ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} PROCS -# ${MPIEXEC_PREFLAGS} EXECUTABLE ${MPIEXEC_POSTFLAGS} ARGS -# where PROCS is the number of processors on which to execute the program, -# EXECUTABLE is the MPI program, and ARGS are the arguments to pass to the -# MPI program. +# run find_package(MPI), then run CMake. If you are happy with the +# auto- detected configuration for your language, then you're done. If +# not, you have two options: +# +# :: +# +# 1. Set MPI_<lang>_COMPILER to the MPI wrapper (mpicc, etc.) of your +# choice and reconfigure. FindMPI will attempt to determine all the +# necessary variables using THAT compiler's compile and link flags. +# 2. If this fails, or if your MPI implementation does not come with +# a compiler wrapper, then set both MPI_<lang>_LIBRARIES and +# MPI_<lang>_INCLUDE_PATH. You may also set any other variables +# listed above, but these two are required. This will circumvent +# autodetection entirely. +# +# When configuration is successful, MPI_<lang>_COMPILER will be set to +# the compiler wrapper for <lang>, if it was found. MPI_<lang>_FOUND +# and other variables above will be set if any MPI implementation was +# found for <lang>, regardless of whether a compiler was found. +# +# When using MPIEXEC to execute MPI applications, you should typically +# use all of the MPIEXEC flags as follows: +# +# :: +# +# ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} PROCS +# ${MPIEXEC_PREFLAGS} EXECUTABLE ${MPIEXEC_POSTFLAGS} ARGS +# +# where PROCS is the number of processors on which to execute the +# program, EXECUTABLE is the MPI program, and ARGS are the arguments to +# pass to the MPI program. # # === Backward Compatibility === # # For backward compatibility with older versions of FindMPI, these # variables are set, but deprecated: -# MPI_FOUND MPI_COMPILER MPI_LIBRARY -# MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_EXTRA_LIBRARY -# MPI_LINK_FLAGS MPI_LIBRARIES +# +# :: +# +# MPI_FOUND MPI_COMPILER MPI_LIBRARY +# MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_EXTRA_LIBRARY +# MPI_LINK_FLAGS MPI_LIBRARIES +# # In new projects, please use the MPI_<lang>_XXX equivalents. #============================================================================= diff --git a/Modules/FindMatlab.cmake b/Modules/FindMatlab.cmake index 8038488..474556e 100644 --- a/Modules/FindMatlab.cmake +++ b/Modules/FindMatlab.cmake @@ -1,10 +1,18 @@ -# - this module looks for Matlab +#.rst: +# FindMatlab +# ---------- +# +# this module looks for Matlab +# # Defines: -# MATLAB_INCLUDE_DIR: include path for mex.h, engine.h -# MATLAB_LIBRARIES: required libraries: libmex, etc -# MATLAB_MEX_LIBRARY: path to libmex.lib -# MATLAB_MX_LIBRARY: path to libmx.lib -# MATLAB_ENG_LIBRARY: path to libeng.lib +# +# :: +# +# MATLAB_INCLUDE_DIR: include path for mex.h, engine.h +# MATLAB_LIBRARIES: required libraries: libmex, etc +# MATLAB_MEX_LIBRARY: path to libmex.lib +# MATLAB_MX_LIBRARY: path to libmx.lib +# MATLAB_ENG_LIBRARY: path to libeng.lib #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/FindMotif.cmake b/Modules/FindMotif.cmake index 5065e3a..a08ece4 100644 --- a/Modules/FindMotif.cmake +++ b/Modules/FindMotif.cmake @@ -1,8 +1,16 @@ -# - Try to find Motif (or lesstif) +#.rst: +# FindMotif +# --------- +# +# Try to find Motif (or lesstif) +# # Once done this will define: -# MOTIF_FOUND - system has MOTIF -# MOTIF_INCLUDE_DIR - include paths to use Motif -# MOTIF_LIBRARIES - Link these to use Motif +# +# :: +# +# MOTIF_FOUND - system has MOTIF +# MOTIF_INCLUDE_DIR - include paths to use Motif +# MOTIF_LIBRARIES - Link these to use Motif #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/FindOpenAL.cmake b/Modules/FindOpenAL.cmake index 78fd632..8150ff2 100644 --- a/Modules/FindOpenAL.cmake +++ b/Modules/FindOpenAL.cmake @@ -1,14 +1,18 @@ -# 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 +#.rst: +# FindOpenAL +# ---------- # -# $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. +# +# 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 +# +# $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. #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index 83fcc3d..21c2198 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -1,19 +1,33 @@ -# - Try to find OpenGL +#.rst: +# FindOpenGL +# ---------- +# +# Try to find OpenGL +# # Once done this will define # -# OPENGL_FOUND - system has OpenGL -# OPENGL_XMESA_FOUND - system has XMESA -# OPENGL_GLU_FOUND - system has GLU -# OPENGL_INCLUDE_DIR - the GL include directory -# OPENGL_LIBRARIES - Link these to use OpenGL and GLU +# :: +# +# OPENGL_FOUND - system has OpenGL +# OPENGL_XMESA_FOUND - system has XMESA +# OPENGL_GLU_FOUND - system has GLU +# OPENGL_INCLUDE_DIR - the GL include directory +# 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 # -# 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 +# :: +# +# 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 #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindOpenMP.cmake b/Modules/FindOpenMP.cmake index f4a9f44..ba03f25 100644 --- a/Modules/FindOpenMP.cmake +++ b/Modules/FindOpenMP.cmake @@ -1,16 +1,27 @@ -# - Finds OpenMP support -# This module can be used to detect OpenMP support in a compiler. -# If the compiler supports OpenMP, the flags required to compile with +#.rst: +# FindOpenMP +# ---------- +# +# Finds OpenMP support +# +# This module can be used to detect OpenMP support in a compiler. If +# the compiler supports OpenMP, the flags required to compile with # OpenMP support are returned in variables for the different languages. # The variables may be empty if the compiler does not need a special # flag to support OpenMP. # # The following variables are set: -# OpenMP_C_FLAGS - flags to add to the C compiler for OpenMP support -# OpenMP_CXX_FLAGS - flags to add to the CXX compiler for OpenMP support -# OPENMP_FOUND - true if openmp is detected # -# Supported compilers can be found at http://openmp.org/wp/openmp-compilers/ +# :: +# +# OpenMP_C_FLAGS - flags to add to the C compiler for OpenMP support +# OpenMP_CXX_FLAGS - flags to add to the CXX compiler for OpenMP support +# OPENMP_FOUND - true if openmp is detected +# +# +# +# Supported compilers can be found at +# http://openmp.org/wp/openmp-compilers/ #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindOpenSSL.cmake b/Modules/FindOpenSSL.cmake index b610438..6bf2aad 100644 --- a/Modules/FindOpenSSL.cmake +++ b/Modules/FindOpenSSL.cmake @@ -1,13 +1,25 @@ -# - Try to find the OpenSSL encryption library +#.rst: +# FindOpenSSL +# ----------- +# +# Try to find the OpenSSL encryption library +# # Once done this will define # -# OPENSSL_ROOT_DIR - Set this variable to the root installation of OpenSSL +# :: +# +# OPENSSL_ROOT_DIR - Set this variable to the root installation of OpenSSL +# +# # # Read-Only variables: -# OPENSSL_FOUND - system has the OpenSSL library -# OPENSSL_INCLUDE_DIR - the OpenSSL include directory -# OPENSSL_LIBRARIES - The libraries needed to use OpenSSL -# OPENSSL_VERSION - This is set to $major.$minor.$revision$path (eg. 0.9.8s) +# +# :: +# +# OPENSSL_FOUND - system has the OpenSSL library +# OPENSSL_INCLUDE_DIR - the OpenSSL include directory +# OPENSSL_LIBRARIES - The libraries needed to use OpenSSL +# OPENSSL_VERSION - This is set to $major.$minor.$revision$path (eg. 0.9.8s) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindOpenSceneGraph.cmake b/Modules/FindOpenSceneGraph.cmake index 7affca8..7bbd753 100644 --- a/Modules/FindOpenSceneGraph.cmake +++ b/Modules/FindOpenSceneGraph.cmake @@ -1,55 +1,98 @@ -# - Find OpenSceneGraph -# This module searches for the OpenSceneGraph core "osg" library as well as -# OpenThreads, and whatever additional COMPONENTS (nodekits) that you specify. -# See http://www.openscenegraph.org +#.rst: +# FindOpenSceneGraph +# ------------------ # -# NOTE: To use this module effectively you must either require CMake >= 2.6.3 -# with cmake_minimum_required(VERSION 2.6.3) or download and place -# FindOpenThreads.cmake, Findosg_functions.cmake, Findosg.cmake, -# and Find<etc>.cmake files into your CMAKE_MODULE_PATH. +# Find OpenSceneGraph # -#================================== +# This module searches for the OpenSceneGraph core "osg" library as well +# as OpenThreads, and whatever additional COMPONENTS (nodekits) that you +# specify. +# +# :: +# +# See http://www.openscenegraph.org +# +# +# +# NOTE: To use this module effectively you must either require CMake >= +# 2.6.3 with cmake_minimum_required(VERSION 2.6.3) or download and place +# FindOpenThreads.cmake, Findosg_functions.cmake, Findosg.cmake, and +# Find<etc>.cmake files into your CMAKE_MODULE_PATH. +# +# ================================== # # This module accepts the following variables (note mixed case) # -# OpenSceneGraph_DEBUG - Enable debugging output +# :: +# +# OpenSceneGraph_DEBUG - Enable debugging output +# +# +# +# :: +# +# OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced +# automatically +# +# +# +# The following environment variables are also respected for finding the +# OSG and it's various components. CMAKE_PREFIX_PATH can also be used +# for this (see find_library() CMake documentation). +# +# :: # -# OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced -# automatically +# <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file) +# OSG_DIR +# OSGDIR +# OSG_ROOT # -# The following environment variables are also respected for finding the OSG -# and it's various components. CMAKE_PREFIX_PATH can also be used for this -# (see find_library() CMake documentation). # -# <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file) -# OSG_DIR -# OSGDIR -# OSG_ROOT # -# [CMake 2.8.10]: -# The CMake variable OSG_DIR can now be used as well to influence detection, instead of needing -# to specify an environment variable. +# [CMake 2.8.10]: The CMake variable OSG_DIR can now be used as well to +# influence detection, instead of needing to specify an environment +# variable. # # This module defines the following output variables: # -# OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found? +# :: +# +# OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found? +# +# +# +# :: +# +# OPENSCENEGRAPH_VERSION - The version of the OSG which was found +# +# +# +# :: +# +# OPENSCENEGRAPH_INCLUDE_DIRS - Where to find the headers +# +# +# +# :: +# +# OPENSCENEGRAPH_LIBRARIES - The OSG libraries +# +# # -# OPENSCENEGRAPH_VERSION - The version of the OSG which was found +# ================================== Example Usage: # -# OPENSCENEGRAPH_INCLUDE_DIRS - Where to find the headers +# :: # -# OPENSCENEGRAPH_LIBRARIES - The OSG libraries +# find_package(OpenSceneGraph 2.0.0 REQUIRED osgDB osgUtil) +# # libOpenThreads & libosg automatically searched +# include_directories(${OPENSCENEGRAPH_INCLUDE_DIRS}) # -#================================== -# Example Usage: # -# find_package(OpenSceneGraph 2.0.0 REQUIRED osgDB osgUtil) -# # libOpenThreads & libosg automatically searched -# include_directories(${OPENSCENEGRAPH_INCLUDE_DIRS}) # -# add_executable(foo foo.cc) -# target_link_libraries(foo ${OPENSCENEGRAPH_LIBRARIES}) +# :: # +# add_executable(foo foo.cc) +# target_link_libraries(foo ${OPENSCENEGRAPH_LIBRARIES}) #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindOpenThreads.cmake b/Modules/FindOpenThreads.cmake index e059960..69bab3d 100644 --- a/Modules/FindOpenThreads.cmake +++ b/Modules/FindOpenThreads.cmake @@ -1,23 +1,25 @@ -# OpenThreads is a C++ based threading library. Its largest userbase +#.rst: +# FindOpenThreads +# --------------- +# +# +# +# OpenThreads is a C++ based threading library. Its largest userbase # seems to OpenSceneGraph so you might notice I accept OSGDIR as an -# environment path. -# I consider this part of the Findosg* suite used to find OpenSceneGraph -# components. -# Each component is separate and you must opt in to each module. +# environment path. I consider this part of the Findosg* suite used to +# find OpenSceneGraph components. Each component is separate and you +# must opt in to each module. # -# Locate OpenThreads -# This module defines -# OPENTHREADS_LIBRARY +# Locate OpenThreads This module defines OPENTHREADS_LIBRARY # OPENTHREADS_FOUND, if false, do not try to link to OpenThreads # OPENTHREADS_INCLUDE_DIR, where to find the headers # -# $OPENTHREADS_DIR is an environment variable that would -# correspond to the ./configure --prefix=$OPENTHREADS_DIR -# used in building osg. +# $OPENTHREADS_DIR is an environment variable that would correspond to +# the ./configure --prefix=$OPENTHREADS_DIR used in building osg. # -# [CMake 2.8.10]: -# The CMake variables OPENTHREADS_DIR or OSG_DIR can now be used as well to influence -# detection, instead of needing to specify an environment variable. +# [CMake 2.8.10]: The CMake variables OPENTHREADS_DIR or OSG_DIR can now +# be used as well to influence detection, instead of needing to specify +# an environment variable. # # Created by Eric Wing. diff --git a/Modules/FindPHP4.cmake b/Modules/FindPHP4.cmake index 4267ac1..51a89f3 100644 --- a/Modules/FindPHP4.cmake +++ b/Modules/FindPHP4.cmake @@ -1,11 +1,17 @@ -# - 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: +#.rst: +# FindPHP4 +# -------- # -# PHP4_INCLUDE_PATH = path to where php.h can be found -# PHP4_EXECUTABLE = full path to the php4 binary +# 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: +# +# :: +# +# PHP4_INCLUDE_PATH = path to where php.h can be found +# PHP4_EXECUTABLE = full path to the php4 binary #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindPNG.cmake b/Modules/FindPNG.cmake index a2577d2..873c3de 100644 --- a/Modules/FindPNG.cmake +++ b/Modules/FindPNG.cmake @@ -1,19 +1,34 @@ -# - Find the native PNG includes and library +#.rst: +# FindPNG +# ------- +# +# Find the native PNG includes and library +# +# # # This module searches libpng, the library for working with PNG images. # # It defines the following variables -# PNG_INCLUDE_DIRS, 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_VERSION_STRING - the version of the PNG library found (since CMake 2.8.8) +# +# :: +# +# PNG_INCLUDE_DIRS, 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_VERSION_STRING - the version of the PNG library found (since CMake 2.8.8) +# # Also defined, but not for general use are -# PNG_LIBRARY, where to find the PNG library. -# For backward compatiblity the variable PNG_INCLUDE_DIR is also set. It has the same value as PNG_INCLUDE_DIRS. # -# Since PNG depends on the ZLib compression library, none of the above will be -# defined unless ZLib can be found. +# :: +# +# PNG_LIBRARY, where to find the PNG library. +# +# For backward compatiblity the variable PNG_INCLUDE_DIR is also set. +# It has the same value as PNG_INCLUDE_DIRS. +# +# Since PNG depends on the ZLib compression library, none of the above +# will be defined unless ZLib can be found. #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake index 70423a7..d030418 100644 --- a/Modules/FindPackageHandleStandardArgs.cmake +++ b/Modules/FindPackageHandleStandardArgs.cmake @@ -1,89 +1,117 @@ -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> ... ) +#.rst: +# FindPackageHandleStandardArgs +# ----------------------------- +# +# +# +# FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> ... ) # # This function is intended to be used in FindXXX.cmake modules files. -# It handles the REQUIRED, QUIET and version-related arguments to find_package(). -# It also sets the <packagename>_FOUND variable. -# The package is considered found if all variables <var1>... listed contain -# valid results, e.g. valid filepaths. +# It handles the REQUIRED, QUIET and version-related arguments to +# find_package(). It also sets the <packagename>_FOUND variable. The +# package is considered found if all variables <var1>... listed contain +# valid results, e.g. valid filepaths. # -# There are two modes of this function. The first argument in both modes is -# the name of the Find-module where it is called (in original casing). +# There are two modes of this function. The first argument in both +# modes is the name of the Find-module where it is called (in original +# casing). # # The first simple mode looks like this: -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> (DEFAULT_MSG|"Custom failure message") <var1>...<varN> ) -# If the variables <var1> to <varN> are all valid, then <UPPERCASED_NAME>_FOUND -# will be set to TRUE. -# If DEFAULT_MSG is given as second argument, then the function will generate -# itself useful success and error messages. You can also supply a custom error message -# for the failure case. This is not recommended. +# +# :: +# +# FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> (DEFAULT_MSG|"Custom failure message") <var1>...<varN> ) +# +# If the variables <var1> to <varN> are all valid, then +# <UPPERCASED_NAME>_FOUND will be set to TRUE. If DEFAULT_MSG is given +# as second argument, then the function will generate itself useful +# success and error messages. You can also supply a custom error +# message for the failure case. This is not recommended. # # The second mode is more powerful and also supports version checking: -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [FOUND_VAR <resultVar>] -# [REQUIRED_VARS <var1>...<varN>] -# [VERSION_VAR <versionvar>] -# [HANDLE_COMPONENTS] -# [CONFIG_MODE] -# [FAIL_MESSAGE "Custom failure message"] ) -# -# In this mode, the name of the result-variable can be set either to either -# <UPPERCASED_NAME>_FOUND or <OriginalCase_Name>_FOUND using the FOUND_VAR option. -# Other names for the result-variable are not allowed. -# So for a Find-module named FindFooBar.cmake, the two possible names are -# FooBar_FOUND and FOOBAR_FOUND. It is recommended to use the original case version. -# If the FOUND_VAR option is not used, the default is <UPPERCASED_NAME>_FOUND. +# +# :: +# +# FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [FOUND_VAR <resultVar>] +# [REQUIRED_VARS <var1>...<varN>] +# [VERSION_VAR <versionvar>] +# [HANDLE_COMPONENTS] +# [CONFIG_MODE] +# [FAIL_MESSAGE "Custom failure message"] ) +# +# +# +# In this mode, the name of the result-variable can be set either to +# either <UPPERCASED_NAME>_FOUND or <OriginalCase_Name>_FOUND using the +# FOUND_VAR option. Other names for the result-variable are not +# allowed. So for a Find-module named FindFooBar.cmake, the two +# possible names are FooBar_FOUND and FOOBAR_FOUND. It is recommended +# to use the original case version. If the FOUND_VAR option is not +# used, the default is <UPPERCASED_NAME>_FOUND. # # As in the simple mode, if <var1> through <varN> are all valid, -# <packagename>_FOUND will be set to TRUE. -# After REQUIRED_VARS the variables which are required for this package are listed. -# Following VERSION_VAR the name of the variable can be specified which holds -# the version of the package which has been found. If this is done, this version -# will be checked against the (potentially) specified required version used -# in the find_package() call. The EXACT keyword is also handled. The default -# messages include information about the required version and the version -# which has been actually found, both if the version is ok or not. -# If the package supports components, use the HANDLE_COMPONENTS option to enable -# handling them. In this case, find_package_handle_standard_args() will report -# which components have been found and which are missing, and the <packagename>_FOUND -# variable will be set to FALSE if any of the required components (i.e. not the -# ones listed after OPTIONAL_COMPONENTS) are missing. -# Use the option CONFIG_MODE if your FindXXX.cmake module is a wrapper for -# a find_package(... NO_MODULE) call. In this case VERSION_VAR will be set -# to <NAME>_VERSION and the macro will automatically check whether the -# Config module was found. -# Via FAIL_MESSAGE a custom failure message can be specified, if this is not -# used, the default message will be displayed. +# <packagename>_FOUND will be set to TRUE. After REQUIRED_VARS the +# variables which are required for this package are listed. Following +# VERSION_VAR the name of the variable can be specified which holds the +# version of the package which has been found. If this is done, this +# version will be checked against the (potentially) specified required +# version used in the find_package() call. The EXACT keyword is also +# handled. The default messages include information about the required +# version and the version which has been actually found, both if the +# version is ok or not. If the package supports components, use the +# HANDLE_COMPONENTS option to enable handling them. In this case, +# find_package_handle_standard_args() will report which components have +# been found and which are missing, and the <packagename>_FOUND variable +# will be set to FALSE if any of the required components (i.e. not the +# ones listed after OPTIONAL_COMPONENTS) are missing. Use the option +# CONFIG_MODE if your FindXXX.cmake module is a wrapper for a +# find_package(... NO_MODULE) call. In this case VERSION_VAR will be +# set to <NAME>_VERSION and the macro will automatically check whether +# the Config module was found. Via FAIL_MESSAGE a custom failure +# message can be specified, if this is not used, the default message +# will be displayed. # # Example for mode 1: # -# find_package_handle_standard_args(LibXml2 DEFAULT_MSG LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) +# :: +# +# find_package_handle_standard_args(LibXml2 DEFAULT_MSG LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) +# +# # # LibXml2 is considered to be found, if both LIBXML2_LIBRARY and -# LIBXML2_INCLUDE_DIR are valid. Then also LIBXML2_FOUND is set to TRUE. -# If it is not found and REQUIRED was used, it fails with FATAL_ERROR, -# independent whether QUIET was used or not. -# If it is found, success will be reported, including the content of <var1>. -# On repeated Cmake runs, the same message won't be printed again. +# LIBXML2_INCLUDE_DIR are valid. Then also LIBXML2_FOUND is set to +# TRUE. If it is not found and REQUIRED was used, it fails with +# FATAL_ERROR, independent whether QUIET was used or not. If it is +# found, success will be reported, including the content of <var1>. On +# repeated Cmake runs, the same message won't be printed again. # # Example for mode 2: # -# find_package_handle_standard_args(LibXslt FOUND_VAR LibXslt_FOUND -# REQUIRED_VARS LibXslt_LIBRARIES LibXslt_INCLUDE_DIRS -# VERSION_VAR LibXslt_VERSION_STRING) -# In this case, LibXslt is considered to be found if the variable(s) listed -# after REQUIRED_VAR are all valid, i.e. LibXslt_LIBRARIES and LibXslt_INCLUDE_DIRS -# in this case. The result will then be stored in LibXslt_FOUND . -# Also the version of LibXslt will be checked by using the version contained -# in LibXslt_VERSION_STRING. -# Since no FAIL_MESSAGE is given, the default messages will be printed. +# :: +# +# find_package_handle_standard_args(LibXslt FOUND_VAR LibXslt_FOUND +# REQUIRED_VARS LibXslt_LIBRARIES LibXslt_INCLUDE_DIRS +# VERSION_VAR LibXslt_VERSION_STRING) +# +# In this case, LibXslt is considered to be found if the variable(s) +# listed after REQUIRED_VAR are all valid, i.e. LibXslt_LIBRARIES and +# LibXslt_INCLUDE_DIRS in this case. The result will then be stored in +# LibXslt_FOUND . Also the version of LibXslt will be checked by using +# the version contained in LibXslt_VERSION_STRING. Since no +# FAIL_MESSAGE is given, the default messages will be printed. # # Another example for mode 2: # -# find_package(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4) -# find_package_handle_standard_args(Automoc4 CONFIG_MODE) -# In this case, FindAutmoc4.cmake wraps a call to find_package(Automoc4 NO_MODULE) -# and adds an additional search directory for automoc4. -# Here the result will be stored in AUTOMOC4_FOUND. -# The following FIND_PACKAGE_HANDLE_STANDARD_ARGS() call produces a proper +# :: +# +# find_package(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4) +# find_package_handle_standard_args(Automoc4 CONFIG_MODE) +# +# In this case, FindAutmoc4.cmake wraps a call to find_package(Automoc4 +# NO_MODULE) and adds an additional search directory for automoc4. Here +# the result will be stored in AUTOMOC4_FOUND. The following +# FIND_PACKAGE_HANDLE_STANDARD_ARGS() call produces a proper # success/error message. #============================================================================= diff --git a/Modules/FindPackageMessage.cmake b/Modules/FindPackageMessage.cmake index 5cea43e..b6a58e4 100644 --- a/Modules/FindPackageMessage.cmake +++ b/Modules/FindPackageMessage.cmake @@ -1,22 +1,30 @@ +#.rst: +# FindPackageMessage +# ------------------ +# +# +# # FIND_PACKAGE_MESSAGE(<name> "message for user" "find result details") # -# This macro is intended to be used in FindXXX.cmake modules files. -# It will print a message once for each unique find result. -# This is useful for telling the user where a package was found. -# The first argument specifies the name (XXX) of the package. -# The second argument specifies the message to display. -# The third argument lists details about the find result so that -# if they change the message will be displayed again. -# The macro also obeys the QUIET argument to the find_package command. +# This macro is intended to be used in FindXXX.cmake modules files. It +# will print a message once for each unique find result. This is useful +# for telling the user where a package was found. The first argument +# specifies the name (XXX) of the package. The second argument +# specifies the message to display. The third argument lists details +# about the find result so that if they change the message will be +# displayed again. The macro also obeys the QUIET argument to the +# find_package command. # # Example: # -# if(X11_FOUND) -# FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}" -# "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]") -# else() -# ... -# endif() +# :: +# +# if(X11_FOUND) +# FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}" +# "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]") +# else() +# ... +# endif() #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/FindPerl.cmake b/Modules/FindPerl.cmake index 5eaf207..3fd5d8e 100644 --- a/Modules/FindPerl.cmake +++ b/Modules/FindPerl.cmake @@ -1,9 +1,16 @@ -# - Find perl +#.rst: +# FindPerl +# -------- +# +# Find perl +# # this module looks for Perl # -# PERL_EXECUTABLE - the full path to perl -# PERL_FOUND - If false, don't attempt to use perl. -# PERL_VERSION_STRING - version of perl found (since CMake 2.8.8) +# :: +# +# PERL_EXECUTABLE - the full path to perl +# PERL_FOUND - If false, don't attempt to use perl. +# PERL_VERSION_STRING - version of perl found (since CMake 2.8.8) #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindPerlLibs.cmake b/Modules/FindPerlLibs.cmake index 492f047..54ccd24 100644 --- a/Modules/FindPerlLibs.cmake +++ b/Modules/FindPerlLibs.cmake @@ -1,27 +1,41 @@ -# - 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: +#.rst: +# FindPerlLibs +# ------------ +# +# 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: +# +# :: +# +# PERLLIBS_FOUND = True if perl.h & libperl were found +# PERL_INCLUDE_PATH = path to where perl.h is found +# PERL_LIBRARY = path to libperl +# PERL_EXECUTABLE = full path to the perl binary +# # -# PERLLIBS_FOUND = True if perl.h & libperl were found -# PERL_INCLUDE_PATH = path to where perl.h is found -# PERL_LIBRARY = path to libperl -# PERL_EXECUTABLE = full path to the perl binary # # The minimum required version of Perl can be specified using the -# standard syntax, e.g. find_package(PerlLibs 6.0) +# standard syntax, e.g. find_package(PerlLibs 6.0) +# +# :: +# +# The following variables are also available if needed +# (introduced after CMake 2.6.4) +# # -# The following variables are also available if needed -# (introduced after CMake 2.6.4) # -# PERL_SITESEARCH = path to the sitesearch install dir -# PERL_SITELIB = path to the sitelib install directory -# PERL_VENDORARCH = path to the vendor arch install directory -# PERL_VENDORLIB = path to the vendor lib install directory -# PERL_ARCHLIB = path to the arch lib install directory -# PERL_PRIVLIB = path to the priv lib install directory -# PERL_EXTRA_C_FLAGS = Compilation flags used to build perl +# :: # +# PERL_SITESEARCH = path to the sitesearch install dir +# PERL_SITELIB = path to the sitelib install directory +# PERL_VENDORARCH = path to the vendor arch install directory +# PERL_VENDORLIB = path to the vendor lib install directory +# PERL_ARCHLIB = path to the arch lib install directory +# PERL_PRIVLIB = path to the priv lib install directory +# PERL_EXTRA_C_FLAGS = Compilation flags used to build perl #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindPhysFS.cmake b/Modules/FindPhysFS.cmake index a2d6abf..ff584c7 100644 --- a/Modules/FindPhysFS.cmake +++ b/Modules/FindPhysFS.cmake @@ -1,12 +1,15 @@ -# 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.h +#.rst: +# FindPhysFS +# ---------- # -# $PHYSFSDIR is an environment variable that would -# correspond to the ./configure --prefix=$PHYSFSDIR -# used in building PHYSFS. +# +# +# 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.h +# +# $PHYSFSDIR is an environment variable that would correspond to the +# ./configure --prefix=$PHYSFSDIR used in building PHYSFS. # # Created by Eric Wing. diff --git a/Modules/FindPike.cmake b/Modules/FindPike.cmake index 5b48ab4..2d6a03d 100644 --- a/Modules/FindPike.cmake +++ b/Modules/FindPike.cmake @@ -1,11 +1,17 @@ -# - 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: +#.rst: +# FindPike +# -------- # -# PIKE_INCLUDE_PATH = path to where program.h is found -# PIKE_EXECUTABLE = full path to the pike binary +# 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: +# +# :: +# +# PIKE_INCLUDE_PATH = path to where program.h is found +# PIKE_EXECUTABLE = full path to the pike binary #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindPkgConfig.cmake b/Modules/FindPkgConfig.cmake index 2766f97..e6fdefe 100644 --- a/Modules/FindPkgConfig.cmake +++ b/Modules/FindPkgConfig.cmake @@ -1,11 +1,26 @@ -# - a pkg-config module for CMake +#.rst: +# FindPkgConfig +# ------------- +# +# a pkg-config module for CMake +# +# # # Usage: -# pkg_check_modules(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*) -# checks for all the given modules # -# pkg_search_module(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*) -# checks for given modules and uses the first working one +# :: +# +# pkg_check_modules(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*) +# checks for all the given modules +# +# +# +# :: +# +# pkg_search_module(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*) +# checks for given modules and uses the first working one +# +# # # When the 'REQUIRED' argument was set, macros will fail with an error # when module(s) could not be found @@ -13,63 +28,110 @@ # When the 'QUIET' argument is set, no status messages will be printed. # # It sets the following variables: -# PKG_CONFIG_FOUND ... if pkg-config executable was found -# PKG_CONFIG_EXECUTABLE ... pathname of the pkg-config program -# PKG_CONFIG_VERSION_STRING ... the version of the pkg-config program found -# (since CMake 2.8.8) +# +# :: +# +# PKG_CONFIG_FOUND ... if pkg-config executable was found +# PKG_CONFIG_EXECUTABLE ... pathname of the pkg-config program +# PKG_CONFIG_VERSION_STRING ... the version of the pkg-config program found +# (since CMake 2.8.8) +# +# # # For the following variables two sets of values exist; first one is the -# common one and has the given PREFIX. The second set contains flags +# common one and has the given PREFIX. The second set contains flags # which are given out when pkgconfig was called with the '--static' # option. -# <XPREFIX>_FOUND ... set to 1 if module(s) exist -# <XPREFIX>_LIBRARIES ... only the libraries (w/o the '-l') -# <XPREFIX>_LIBRARY_DIRS ... the paths of the libraries (w/o the '-L') -# <XPREFIX>_LDFLAGS ... all required linker flags -# <XPREFIX>_LDFLAGS_OTHER ... all other linker flags -# <XPREFIX>_INCLUDE_DIRS ... the '-I' preprocessor flags (w/o the '-I') -# <XPREFIX>_CFLAGS ... all required cflags -# <XPREFIX>_CFLAGS_OTHER ... the other compiler flags -# -# <XPREFIX> = <PREFIX> for common case -# <XPREFIX> = <PREFIX>_STATIC for static linking -# -# There are some special variables whose prefix depends on the count -# of given modules. When there is only one module, <PREFIX> stays -# unchanged. When there are multiple modules, the prefix will be +# +# :: +# +# <XPREFIX>_FOUND ... set to 1 if module(s) exist +# <XPREFIX>_LIBRARIES ... only the libraries (w/o the '-l') +# <XPREFIX>_LIBRARY_DIRS ... the paths of the libraries (w/o the '-L') +# <XPREFIX>_LDFLAGS ... all required linker flags +# <XPREFIX>_LDFLAGS_OTHER ... all other linker flags +# <XPREFIX>_INCLUDE_DIRS ... the '-I' preprocessor flags (w/o the '-I') +# <XPREFIX>_CFLAGS ... all required cflags +# <XPREFIX>_CFLAGS_OTHER ... the other compiler flags +# +# +# +# :: +# +# <XPREFIX> = <PREFIX> for common case +# <XPREFIX> = <PREFIX>_STATIC for static linking +# +# +# +# There are some special variables whose prefix depends on the count of +# given modules. When there is only one module, <PREFIX> stays +# unchanged. When there are multiple modules, the prefix will be # changed to <PREFIX>_<MODNAME>: -# <XPREFIX>_VERSION ... version of the module -# <XPREFIX>_PREFIX ... prefix-directory of the module -# <XPREFIX>_INCLUDEDIR ... include-dir of the module -# <XPREFIX>_LIBDIR ... lib-dir of the module # -# <XPREFIX> = <PREFIX> when |MODULES| == 1, else -# <XPREFIX> = <PREFIX>_<MODNAME> +# :: +# +# <XPREFIX>_VERSION ... version of the module +# <XPREFIX>_PREFIX ... prefix-directory of the module +# <XPREFIX>_INCLUDEDIR ... include-dir of the module +# <XPREFIX>_LIBDIR ... lib-dir of the module +# +# +# +# :: +# +# <XPREFIX> = <PREFIX> when |MODULES| == 1, else +# <XPREFIX> = <PREFIX>_<MODNAME> +# +# # # A <MODULE> parameter can have the following formats: -# {MODNAME} ... matches any version -# {MODNAME}>={VERSION} ... at least version <VERSION> is required -# {MODNAME}={VERSION} ... exactly version <VERSION> is required -# {MODNAME}<={VERSION} ... modules must not be newer than <VERSION> +# +# :: +# +# {MODNAME} ... matches any version +# {MODNAME}>={VERSION} ... at least version <VERSION> is required +# {MODNAME}={VERSION} ... exactly version <VERSION> is required +# {MODNAME}<={VERSION} ... modules must not be newer than <VERSION> +# +# # # Examples -# pkg_check_modules (GLIB2 glib-2.0) # -# pkg_check_modules (GLIB2 glib-2.0>=2.10) -# requires at least version 2.10 of glib2 and defines e.g. -# GLIB2_VERSION=2.10.3 +# :: +# +# pkg_check_modules (GLIB2 glib-2.0) +# +# +# +# :: +# +# pkg_check_modules (GLIB2 glib-2.0>=2.10) +# requires at least version 2.10 of glib2 and defines e.g. +# GLIB2_VERSION=2.10.3 +# +# +# +# :: +# +# pkg_check_modules (FOO glib-2.0>=2.10 gtk+-2.0) +# requires both glib2 and gtk2, and defines e.g. +# FOO_glib-2.0_VERSION=2.10.3 +# FOO_gtk+-2.0_VERSION=2.8.20 +# +# +# +# :: +# +# pkg_check_modules (XRENDER REQUIRED xrender) +# defines e.g.: +# XRENDER_LIBRARIES=Xrender;X11 +# XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp +# # -# pkg_check_modules (FOO glib-2.0>=2.10 gtk+-2.0) -# requires both glib2 and gtk2, and defines e.g. -# FOO_glib-2.0_VERSION=2.10.3 -# FOO_gtk+-2.0_VERSION=2.8.20 # -# pkg_check_modules (XRENDER REQUIRED xrender) -# defines e.g.: -# XRENDER_LIBRARIES=Xrender;X11 -# XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp +# :: # -# pkg_search_module (BAR libxml-2.0 libxml2 libxml>=2) +# pkg_search_module (BAR libxml-2.0 libxml2 libxml>=2) #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindPostgreSQL.cmake b/Modules/FindPostgreSQL.cmake index e3c898b..f13dea8 100644 --- a/Modules/FindPostgreSQL.cmake +++ b/Modules/FindPostgreSQL.cmake @@ -1,11 +1,19 @@ -# - Find the PostgreSQL installation. -# In Windows, we make the assumption that, if the PostgreSQL files are installed, the default directory -# will be C:\Program Files\PostgreSQL. +#.rst: +# FindPostgreSQL +# -------------- +# +# Find the PostgreSQL installation. +# +# In Windows, we make the assumption that, if the PostgreSQL files are +# installed, the default directory will be C:\Program Files\PostgreSQL. # # This module defines -# PostgreSQL_LIBRARIES - the PostgreSQL libraries needed for linking -# PostgreSQL_INCLUDE_DIRS - the directories of the PostgreSQL headers -# PostgreSQL_VERSION_STRING - the version of PostgreSQL found (since CMake 2.8.8) +# +# :: +# +# PostgreSQL_LIBRARIES - the PostgreSQL libraries needed for linking +# PostgreSQL_INCLUDE_DIRS - the directories of the PostgreSQL headers +# PostgreSQL_VERSION_STRING - the version of PostgreSQL found (since CMake 2.8.8) #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindProducer.cmake b/Modules/FindProducer.cmake index 3099062..aef84ea 100644 --- a/Modules/FindProducer.cmake +++ b/Modules/FindProducer.cmake @@ -1,27 +1,30 @@ -# Though Producer isn't directly part of OpenSceneGraph, its primary user -# is OSG so I consider this part of the Findosg* suite used to find -# OpenSceneGraph components. You'll notice that I accept OSGDIR as an +#.rst: +# FindProducer +# ------------ +# +# +# +# Though Producer isn't directly part of OpenSceneGraph, its primary +# user is OSG so I consider this part of the Findosg* suite used to find +# OpenSceneGraph components. You'll notice that I accept OSGDIR as an # environment path. # -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL (and OpenThreads?) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). +# Each component is separate and you must opt in to each module. You +# must also opt into OpenGL (and OpenThreads?) as these modules won't do +# it for you. This is to allow you control over your own system piece +# by piece in case you need to opt out of certain components or change +# the Find behavior for a particular module (perhaps because the default +# FindOpenGL.cmake module doesn't work with your system as an example). # If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake +# modules. # -# Locate Producer -# This module defines -# PRODUCER_LIBRARY -# PRODUCER_FOUND, if false, do not try to link to Producer -# PRODUCER_INCLUDE_DIR, where to find the headers +# Locate Producer This module defines PRODUCER_LIBRARY PRODUCER_FOUND, +# if false, do not try to link to Producer PRODUCER_INCLUDE_DIR, where +# to find the headers # -# $PRODUCER_DIR is an environment variable that would -# correspond to the ./configure --prefix=$PRODUCER_DIR -# used in building osg. +# $PRODUCER_DIR is an environment variable that would correspond to the +# ./configure --prefix=$PRODUCER_DIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindProtobuf.cmake b/Modules/FindProtobuf.cmake index 2972198..9b120a6 100644 --- a/Modules/FindProtobuf.cmake +++ b/Modules/FindProtobuf.cmake @@ -1,62 +1,127 @@ +#.rst: +# FindProtobuf +# ------------ +# +# +# # Locate and configure the Google Protocol Buffers library. # # The following variables can be set and are optional: # -# PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set -# the protobuf-default VS project build locations -# (vsprojects/Debug & vsprojects/Release) will be searched -# for libraries and binaries. +# :: +# +# PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set +# the protobuf-default VS project build locations +# (vsprojects/Debug & vsprojects/Release) will be searched +# for libraries and binaries. +# +# +# +# :: +# +# PROTOBUF_IMPORT_DIRS - List of additional directories to be searched for +# imported .proto files. (New in CMake 2.8.8) +# # -# PROTOBUF_IMPORT_DIRS - List of additional directories to be searched for -# imported .proto files. (New in CMake 2.8.8) # # Defines the following variables: # -# PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files) -# PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers -# PROTOBUF_LIBRARIES - The protobuf libraries +# :: +# +# PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files) +# PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers +# PROTOBUF_LIBRARIES - The protobuf libraries +# # [New in CMake 2.8.5] -# PROTOBUF_PROTOC_LIBRARIES - The protoc libraries -# PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries +# +# :: +# +# PROTOBUF_PROTOC_LIBRARIES - The protoc libraries +# PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries +# +# # # The following cache variables are also available to set or use: -# PROTOBUF_LIBRARY - The protobuf library -# PROTOBUF_PROTOC_LIBRARY - The protoc library -# PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers -# PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler +# +# :: +# +# PROTOBUF_LIBRARY - The protobuf library +# PROTOBUF_PROTOC_LIBRARY - The protoc library +# PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers +# PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler +# # [New in CMake 2.8.5] -# PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug) -# PROTOBUF_PROTOC_LIBRARY_DEBUG - The protoc library (debug) -# PROTOBUF_LITE_LIBRARY - The protobuf lite library -# PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug) # -# ==================================================================== -# Example: +# :: +# +# PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug) +# PROTOBUF_PROTOC_LIBRARY_DEBUG - The protoc library (debug) +# PROTOBUF_LITE_LIBRARY - The protobuf lite library +# PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug) +# +# +# +# :: +# +# ==================================================================== +# Example: +# +# +# +# :: +# +# find_package(Protobuf REQUIRED) +# include_directories(${PROTOBUF_INCLUDE_DIRS}) +# +# +# +# :: +# +# include_directories(${CMAKE_CURRENT_BINARY_DIR}) +# PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto) +# add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS}) +# target_link_libraries(bar ${PROTOBUF_LIBRARIES}) # -# find_package(Protobuf REQUIRED) -# include_directories(${PROTOBUF_INCLUDE_DIRS}) # -# include_directories(${CMAKE_CURRENT_BINARY_DIR}) -# PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto) -# add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS}) -# target_link_libraries(bar ${PROTOBUF_LIBRARIES}) # # NOTE: You may need to link against pthreads, depending -# on the platform. # -# NOTE: The PROTOBUF_GENERATE_CPP macro & add_executable() or add_library() -# calls only work properly within the same directory. +# :: +# +# on the platform. +# +# +# +# NOTE: The PROTOBUF_GENERATE_CPP macro & add_executable() or +# add_library() +# +# :: +# +# calls only work properly within the same directory. +# +# +# +# :: +# +# ==================================================================== +# # -# ==================================================================== # # PROTOBUF_GENERATE_CPP (public function) -# SRCS = Variable to define with autogenerated -# source files -# HDRS = Variable to define with autogenerated -# header files -# ARGN = proto files # -# ==================================================================== +# :: +# +# SRCS = Variable to define with autogenerated +# source files +# HDRS = Variable to define with autogenerated +# header files +# ARGN = proto files +# +# +# +# :: +# +# ==================================================================== #============================================================================= diff --git a/Modules/FindPythonInterp.cmake b/Modules/FindPythonInterp.cmake index b6b7897..6126a48 100644 --- a/Modules/FindPythonInterp.cmake +++ b/Modules/FindPythonInterp.cmake @@ -1,18 +1,32 @@ -# - Find python interpreter -# This module finds if Python interpreter is installed and determines where the -# executables are. This code sets the following variables: +#.rst: +# FindPythonInterp +# ---------------- # -# PYTHONINTERP_FOUND - Was the Python executable found -# PYTHON_EXECUTABLE - path to the Python interpreter +# Find python interpreter # -# PYTHON_VERSION_STRING - Python version found e.g. 2.5.2 -# PYTHON_VERSION_MAJOR - Python major version found e.g. 2 -# PYTHON_VERSION_MINOR - Python minor version found e.g. 5 -# PYTHON_VERSION_PATCH - Python patch version found e.g. 2 +# This module finds if Python interpreter is installed and determines +# where the executables are. This code sets the following variables: # -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list of -# version numbers that should be taken into account when searching for Python. -# You need to set this variable before calling find_package(PythonInterp). +# :: +# +# PYTHONINTERP_FOUND - Was the Python executable found +# PYTHON_EXECUTABLE - path to the Python interpreter +# +# +# +# :: +# +# PYTHON_VERSION_STRING - Python version found e.g. 2.5.2 +# PYTHON_VERSION_MAJOR - Python major version found e.g. 2 +# PYTHON_VERSION_MINOR - Python minor version found e.g. 5 +# PYTHON_VERSION_PATCH - Python patch version found e.g. 2 +# +# +# +# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list +# of version numbers that should be taken into account when searching +# for Python. You need to set this variable before calling +# find_package(PythonInterp). #============================================================================= # Copyright 2005-2010 Kitware, Inc. diff --git a/Modules/FindPythonLibs.cmake b/Modules/FindPythonLibs.cmake index 8356ed9..0749efc 100644 --- a/Modules/FindPythonLibs.cmake +++ b/Modules/FindPythonLibs.cmake @@ -1,23 +1,36 @@ -# - Find python libraries +#.rst: +# FindPythonLibs +# -------------- +# +# 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: +# include files and libraries are. It also determines what the name of +# the library is. This code sets the following variables: +# +# :: +# +# PYTHONLIBS_FOUND - have the Python libs been found +# PYTHON_LIBRARIES - path to the python library +# PYTHON_INCLUDE_PATH - path to where Python.h is found (deprecated) +# PYTHON_INCLUDE_DIRS - path to where Python.h is found +# PYTHON_DEBUG_LIBRARIES - path to the debug library (deprecated) +# PYTHONLIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8) +# +# +# +# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list +# of version numbers that should be taken into account when searching +# for Python. You need to set this variable before calling +# find_package(PythonLibs). # -# PYTHONLIBS_FOUND - have the Python libs been found -# PYTHON_LIBRARIES - path to the python library -# PYTHON_INCLUDE_PATH - path to where Python.h is found (deprecated) -# PYTHON_INCLUDE_DIRS - path to where Python.h is found -# PYTHON_DEBUG_LIBRARIES - path to the debug library (deprecated) -# PYTHONLIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8) +# If you'd like to specify the installation of Python to use, you should +# modify the following cache variables: # -# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list of -# version numbers that should be taken into account when searching for Python. -# You need to set this variable before calling find_package(PythonLibs). +# :: # -# If you'd like to specify the installation of Python to use, you should modify -# the following cache variables: -# PYTHON_LIBRARY - path to the python library -# PYTHON_INCLUDE_DIR - path to where Python.h is found +# PYTHON_LIBRARY - path to the python library +# PYTHON_INCLUDE_DIR - path to where Python.h is found #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindQt.cmake b/Modules/FindQt.cmake index 54b7c6f..e893c7a 100644 --- a/Modules/FindQt.cmake +++ b/Modules/FindQt.cmake @@ -1,21 +1,31 @@ -# - Searches for all installed versions of Qt. +#.rst: +# FindQt +# ------ +# +# 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. +# 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. +# +# :: +# +# 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. +# 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. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindQt3.cmake b/Modules/FindQt3.cmake index 4fc8e40..6cd12c6 100644 --- a/Modules/FindQt3.cmake +++ b/Modules/FindQt3.cmake @@ -1,20 +1,34 @@ -# - Locate Qt include paths and libraries +#.rst: +# FindQt3 +# ------- +# +# 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_VERSION_STRING - the version of Qt found # -# If you need the multithreaded version of Qt, set QT_MT_REQUIRED to TRUE +# :: +# +# 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_VERSION_STRING - the version of Qt found +# +# +# +# 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 diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake index 1d17ba3..46a0355 100644 --- a/Modules/FindQt4.cmake +++ b/Modules/FindQt4.cmake @@ -1,349 +1,511 @@ -# - Find Qt 4 -# This module can be used to find Qt4. -# The most important issue is that the Qt4 qmake is available via the system path. -# This qmake is then used to detect basically everything else. -# This module defines a number of key variables and macros. -# The variable QT_USE_FILE is set which is the path to a CMake file that can be included -# to compile Qt 4 applications and libraries. It sets up the compilation -# environment for include directories, preprocessor defines and populates a +#.rst: +# FindQt4 +# ------- +# +# Find Qt 4 +# +# This module can be used to find Qt4. The most important issue is that +# the Qt4 qmake is available via the system path. This qmake is then +# used to detect basically everything else. This module defines a +# number of key variables and macros. The variable QT_USE_FILE is set +# which is the path to a CMake file that can be included to compile Qt 4 +# applications and libraries. It sets up the compilation environment +# for include directories, preprocessor defines and populates a # QT_LIBRARIES variable. # # Typical usage could be something like: -# find_package(Qt4 4.4.3 REQUIRED QtCore QtGui QtXml) -# include(${QT_USE_FILE}) -# add_executable(myexe main.cpp) -# target_link_libraries(myexe ${QT_LIBRARIES}) -# -# The minimum required version can be specified using the standard find_package()-syntax -# (see example above). -# For compatibility with older versions of FindQt4.cmake it is also possible to -# set the variable QT_MIN_VERSION to the minimum required version of Qt4 before the -# find_package(Qt4) command. -# If both are used, the version used in the find_package() command overrides the -# one from QT_MIN_VERSION. -# -# When using the components argument, QT_USE_QT* variables are automatically set -# for the QT_USE_FILE to pick up. If one wishes to manually set them, the -# available ones to set include: -# QT_DONT_USE_QTCORE -# QT_DONT_USE_QTGUI -# QT_USE_QT3SUPPORT -# QT_USE_QTASSISTANT -# QT_USE_QAXCONTAINER -# QT_USE_QAXSERVER -# QT_USE_QTDESIGNER -# QT_USE_QTMOTIF -# QT_USE_QTMAIN -# QT_USE_QTMULTIMEDIA -# QT_USE_QTNETWORK -# QT_USE_QTNSPLUGIN -# QT_USE_QTOPENGL -# QT_USE_QTSQL -# QT_USE_QTXML -# QT_USE_QTSVG -# QT_USE_QTTEST -# QT_USE_QTUITOOLS -# QT_USE_QTDBUS -# QT_USE_QTSCRIPT -# QT_USE_QTASSISTANTCLIENT -# QT_USE_QTHELP -# QT_USE_QTWEBKIT -# QT_USE_QTXMLPATTERNS -# QT_USE_PHONON -# QT_USE_QTSCRIPTTOOLS -# QT_USE_QTDECLARATIVE -# -# QT_USE_IMPORTED_TARGETS -# If this variable is set to TRUE, FindQt4.cmake will create imported -# library targets for the various Qt libraries and set the -# library variables like QT_QTCORE_LIBRARY to point at these imported -# targets instead of the library file on disk. This provides much better -# handling of the release and debug versions of the Qt libraries and is -# also always backwards compatible, except for the case that dependencies -# of libraries are exported, these will then also list the names of the -# imported targets as dependency and not the file location on disk. This -# is much more flexible, but requires that FindQt4.cmake is executed before -# such an exported dependency file is processed. -# -# Note that if using IMPORTED targets, the qtmain.lib static library is -# automatically linked on Windows. To disable that globally, set the -# QT4_NO_LINK_QTMAIN variable before finding Qt4. To disable that for a -# particular executable, set the QT4_NO_LINK_QTMAIN target property to -# True on the executable. -# -# QT_INCLUDE_DIRS_NO_SYSTEM -# If this variable is set to TRUE, the Qt include directories -# in the QT_USE_FILE will NOT have the SYSTEM keyword set. -# -# There are also some files that need processing by some Qt tools such as moc -# and uic. Listed below are macros that may be used to process those files. -# -# macro QT4_WRAP_CPP(outfiles inputfile ... OPTIONS ...) -# create moc code from a list of files containing Qt class with -# the Q_OBJECT declaration. Per-directory preprocessor definitions -# are also added. Options may be given to moc, such as those found -# when executing "moc -help". -# -# macro QT4_WRAP_UI(outfiles inputfile ... OPTIONS ...) -# create code from a list of Qt designer ui files. -# Options may be given to uic, such as those found -# when executing "uic -help" -# -# macro QT4_ADD_RESOURCES(outfiles inputfile ... OPTIONS ...) -# create code from a list of Qt resource files. -# Options may be given to rcc, such as those found -# when executing "rcc -help" -# -# macro QT4_GENERATE_MOC(inputfile outputfile ) -# creates a rule to run moc on infile and create outfile. -# Use this if for some reason QT4_WRAP_CPP() isn't appropriate, e.g. -# because you need a custom filename for the moc file or something similar. -# -# macro QT4_AUTOMOC(sourcefile1 sourcefile2 ... ) -# The qt4_automoc macro is obsolete. Use the CMAKE_AUTOMOC feature instead. -# This macro is still experimental. -# It can be used to have moc automatically handled. -# So if you have the files foo.h and foo.cpp, and in foo.h a -# a class uses the Q_OBJECT macro, moc has to run on it. If you don't -# want to use QT4_WRAP_CPP() (which is reliable and mature), you can insert -# #include "foo.moc" -# in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will the -# scan all listed files at cmake-time for such included moc files and if it finds -# them cause a rule to be generated to run moc at build time on the -# accompanying header file foo.h. -# If a source file has the SKIP_AUTOMOC property set it will be ignored by this macro. -# -# You should have a look on the AUTOMOC property for targets to achieve the same results. -# -# macro QT4_ADD_DBUS_INTERFACE(outfiles interface basename) -# Create the interface header and implementation files with the -# given basename from the given interface xml file and add it to -# the list of sources. -# -# You can pass additional parameters to the qdbusxml2cpp call by setting -# properties on the input file: -# -# INCLUDE the given file will be included in the generate interface header -# -# CLASSNAME the generated class is named accordingly -# -# NO_NAMESPACE the generated class is not wrapped in a namespace -# -# macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... ) -# Create the interface header and implementation files -# for all listed interface xml files. -# The basename will be automatically determined from the name of the xml file. -# -# The source file properties described for QT4_ADD_DBUS_INTERFACE also apply here. -# -# macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname [basename] [classname]) -# create a dbus adaptor (header and implementation file) from the xml file -# describing the interface, and add it to the list of sources. The adaptor -# forwards the calls to a parent class, defined in parentheader and named -# parentclassname. The name of the generated files will be -# <basename>adaptor.{cpp,h} where basename defaults to the basename of the xml file. -# If <classname> is provided, then it will be used as the classname of the -# adaptor itself. -# -# macro QT4_GENERATE_DBUS_INTERFACE( header [interfacename] OPTIONS ...) -# generate the xml interface file from the given header. -# If the optional argument interfacename is omitted, the name of the -# interface file is constructed from the basename of the header with -# the suffix .xml appended. -# Options may be given to qdbuscpp2xml, such as those found when executing "qdbuscpp2xml --help" -# -# macro QT4_CREATE_TRANSLATION( qm_files directories ... sources ... -# ts_files ... OPTIONS ...) -# out: qm_files -# in: directories sources ts_files -# options: flags to pass to lupdate, such as -extensions to specify -# extensions for a directory scan. -# generates commands to create .ts (vie lupdate) and .qm -# (via lrelease) - files from directories and/or sources. The ts files are -# created and/or updated in the source tree (unless given with full paths). -# The qm files are generated in the build tree. -# Updating the translations can be done by adding the qm_files -# to the source list of your library/executable, so they are -# always updated, or by adding a custom target to control when -# they get updated/generated. -# -# macro QT4_ADD_TRANSLATION( qm_files ts_files ... ) -# out: qm_files -# in: ts_files -# generates commands to create .qm from .ts - files. The generated -# filenames can be found in qm_files. The ts_files -# must exist and are not updated in any way. +# +# :: +# +# find_package(Qt4 4.4.3 REQUIRED QtCore QtGui QtXml) +# include(${QT_USE_FILE}) +# add_executable(myexe main.cpp) +# target_link_libraries(myexe ${QT_LIBRARIES}) +# +# +# +# The minimum required version can be specified using the standard +# find_package()-syntax (see example above). For compatibility with +# older versions of FindQt4.cmake it is also possible to set the +# variable QT_MIN_VERSION to the minimum required version of Qt4 before +# the find_package(Qt4) command. If both are used, the version used in +# the find_package() command overrides the one from QT_MIN_VERSION. +# +# When using the components argument, QT_USE_QT* variables are +# automatically set for the QT_USE_FILE to pick up. If one wishes to +# manually set them, the available ones to set include: +# +# :: +# +# QT_DONT_USE_QTCORE +# QT_DONT_USE_QTGUI +# QT_USE_QT3SUPPORT +# QT_USE_QTASSISTANT +# QT_USE_QAXCONTAINER +# QT_USE_QAXSERVER +# QT_USE_QTDESIGNER +# QT_USE_QTMOTIF +# QT_USE_QTMAIN +# QT_USE_QTMULTIMEDIA +# QT_USE_QTNETWORK +# QT_USE_QTNSPLUGIN +# QT_USE_QTOPENGL +# QT_USE_QTSQL +# QT_USE_QTXML +# QT_USE_QTSVG +# QT_USE_QTTEST +# QT_USE_QTUITOOLS +# QT_USE_QTDBUS +# QT_USE_QTSCRIPT +# QT_USE_QTASSISTANTCLIENT +# QT_USE_QTHELP +# QT_USE_QTWEBKIT +# QT_USE_QTXMLPATTERNS +# QT_USE_PHONON +# QT_USE_QTSCRIPTTOOLS +# QT_USE_QTDECLARATIVE +# +# +# +# :: +# +# QT_USE_IMPORTED_TARGETS +# If this variable is set to TRUE, FindQt4.cmake will create imported +# library targets for the various Qt libraries and set the +# library variables like QT_QTCORE_LIBRARY to point at these imported +# targets instead of the library file on disk. This provides much better +# handling of the release and debug versions of the Qt libraries and is +# also always backwards compatible, except for the case that dependencies +# of libraries are exported, these will then also list the names of the +# imported targets as dependency and not the file location on disk. This +# is much more flexible, but requires that FindQt4.cmake is executed before +# such an exported dependency file is processed. +# +# +# +# :: +# +# Note that if using IMPORTED targets, the qtmain.lib static library is +# automatically linked on Windows. To disable that globally, set the +# QT4_NO_LINK_QTMAIN variable before finding Qt4. To disable that for a +# particular executable, set the QT4_NO_LINK_QTMAIN target property to +# True on the executable. +# +# +# +# :: +# +# QT_INCLUDE_DIRS_NO_SYSTEM +# If this variable is set to TRUE, the Qt include directories +# in the QT_USE_FILE will NOT have the SYSTEM keyword set. +# +# +# +# There are also some files that need processing by some Qt tools such +# as moc and uic. Listed below are macros that may be used to process +# those files. +# +# :: +# +# macro QT4_WRAP_CPP(outfiles inputfile ... OPTIONS ...) +# create moc code from a list of files containing Qt class with +# the Q_OBJECT declaration. Per-directory preprocessor definitions +# are also added. Options may be given to moc, such as those found +# when executing "moc -help". +# +# +# +# :: +# +# macro QT4_WRAP_UI(outfiles inputfile ... OPTIONS ...) +# create code from a list of Qt designer ui files. +# Options may be given to uic, such as those found +# when executing "uic -help" +# +# +# +# :: +# +# macro QT4_ADD_RESOURCES(outfiles inputfile ... OPTIONS ...) +# create code from a list of Qt resource files. +# Options may be given to rcc, such as those found +# when executing "rcc -help" +# +# +# +# :: +# +# macro QT4_GENERATE_MOC(inputfile outputfile ) +# creates a rule to run moc on infile and create outfile. +# Use this if for some reason QT4_WRAP_CPP() isn't appropriate, e.g. +# because you need a custom filename for the moc file or something similar. +# +# +# +# :: +# +# macro QT4_AUTOMOC(sourcefile1 sourcefile2 ... ) +# The qt4_automoc macro is obsolete. Use the CMAKE_AUTOMOC feature instead. +# This macro is still experimental. +# It can be used to have moc automatically handled. +# So if you have the files foo.h and foo.cpp, and in foo.h a +# a class uses the Q_OBJECT macro, moc has to run on it. If you don't +# want to use QT4_WRAP_CPP() (which is reliable and mature), you can insert +# #include "foo.moc" +# in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will the +# scan all listed files at cmake-time for such included moc files and if it finds +# them cause a rule to be generated to run moc at build time on the +# accompanying header file foo.h. +# If a source file has the SKIP_AUTOMOC property set it will be ignored by this macro. +# +# +# +# :: +# +# You should have a look on the AUTOMOC property for targets to achieve the same results. +# +# +# +# :: +# +# macro QT4_ADD_DBUS_INTERFACE(outfiles interface basename) +# Create the interface header and implementation files with the +# given basename from the given interface xml file and add it to +# the list of sources. +# +# +# +# :: +# +# You can pass additional parameters to the qdbusxml2cpp call by setting +# properties on the input file: +# +# +# +# :: +# +# INCLUDE the given file will be included in the generate interface header +# +# +# +# :: +# +# CLASSNAME the generated class is named accordingly +# +# +# +# :: +# +# NO_NAMESPACE the generated class is not wrapped in a namespace +# +# +# +# :: +# +# macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... ) +# Create the interface header and implementation files +# for all listed interface xml files. +# The basename will be automatically determined from the name of the xml file. +# +# +# +# :: +# +# The source file properties described for QT4_ADD_DBUS_INTERFACE also apply here. +# +# +# +# :: +# +# macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname [basename] [classname]) +# create a dbus adaptor (header and implementation file) from the xml file +# describing the interface, and add it to the list of sources. The adaptor +# forwards the calls to a parent class, defined in parentheader and named +# parentclassname. The name of the generated files will be +# <basename>adaptor.{cpp,h} where basename defaults to the basename of the xml file. +# If <classname> is provided, then it will be used as the classname of the +# adaptor itself. +# +# +# +# :: +# +# macro QT4_GENERATE_DBUS_INTERFACE( header [interfacename] OPTIONS ...) +# generate the xml interface file from the given header. +# If the optional argument interfacename is omitted, the name of the +# interface file is constructed from the basename of the header with +# the suffix .xml appended. +# Options may be given to qdbuscpp2xml, such as those found when executing "qdbuscpp2xml --help" +# +# +# +# :: +# +# macro QT4_CREATE_TRANSLATION( qm_files directories ... sources ... +# ts_files ... OPTIONS ...) +# out: qm_files +# in: directories sources ts_files +# options: flags to pass to lupdate, such as -extensions to specify +# extensions for a directory scan. +# generates commands to create .ts (vie lupdate) and .qm +# (via lrelease) - files from directories and/or sources. The ts files are +# created and/or updated in the source tree (unless given with full paths). +# The qm files are generated in the build tree. +# Updating the translations can be done by adding the qm_files +# to the source list of your library/executable, so they are +# always updated, or by adding a custom target to control when +# they get updated/generated. +# +# +# +# :: +# +# macro QT4_ADD_TRANSLATION( qm_files ts_files ... ) +# out: qm_files +# in: ts_files +# generates commands to create .qm from .ts - files. The generated +# filenames can be found in qm_files. The ts_files +# must exist and are not updated in any way. +# +# # # function QT4_USE_MODULES( target [link_type] modules...) -# This function is obsolete. Use target_link_libraries with IMPORTED targets instead. -# Make <target> use the <modules> from Qt. Using a Qt module means -# to link to the library, add the relevant include directories for the module, -# and add the relevant compiler defines for using the module. -# Modules are roughly equivalent to components of Qt4, so usage would be -# something like: -# qt4_use_modules(myexe Core Gui Declarative) -# to use QtCore, QtGui and QtDeclarative. The optional <link_type> argument can -# be specified as either LINK_PUBLIC or LINK_PRIVATE to specify the same argument -# to the target_link_libraries call. -# -# -# Below is a detailed list of variables that FindQt4.cmake sets. -# QT_FOUND If false, don't try to use Qt. -# Qt4_FOUND If false, don't try to use Qt 4. -# QT4_FOUND If false, don't try to use Qt 4. This variable is for compatibility only. -# -# QT_VERSION_MAJOR The major version of Qt found. -# QT_VERSION_MINOR The minor version of Qt found. -# QT_VERSION_PATCH The patch version of Qt found. -# -# QT_EDITION Set to the edition of Qt (i.e. DesktopLight) -# QT_EDITION_DESKTOPLIGHT True if QT_EDITION == DesktopLight -# 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_QTASSISTANTCLIENT_FOUND True if QtAssistantClient was found. -# QT_QAXCONTAINER_FOUND True if QAxContainer was found (Windows only). -# QT_QAXSERVER_FOUND True if QAxServer was found (Windows only). -# QT_QTDBUS_FOUND True if QtDBus was found. -# QT_QTDESIGNER_FOUND True if QtDesigner was found. -# QT_QTDESIGNERCOMPONENTS True if QtDesignerComponents was found. -# QT_QTHELP_FOUND True if QtHelp was found. -# QT_QTMOTIF_FOUND True if QtMotif was found. -# QT_QTMULTIMEDIA_FOUND True if QtMultimedia was found (since Qt 4.6.0). -# 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_QTSVG_FOUND True if QtSvg was found. -# QT_QTSCRIPT_FOUND True if QtScript was found. -# QT_QTSCRIPTTOOLS_FOUND True if QtScriptTools was found. -# QT_QTTEST_FOUND True if QtTest was found. -# QT_QTUITOOLS_FOUND True if QtUiTools was found. -# QT_QTWEBKIT_FOUND True if QtWebKit was found. -# QT_QTXML_FOUND True if QtXml was found. -# QT_QTXMLPATTERNS_FOUND True if QtXmlPatterns was found. -# QT_PHONON_FOUND True if phonon was found. -# QT_QTDECLARATIVE_FOUND True if QtDeclarative was found. -# -# QT_MAC_USE_COCOA For Mac OS X, its whether Cocoa or Carbon is used. -# In general, this should not be used, but its useful -# when having platform specific code. -# -# QT_DEFINITIONS Definitions to use when compiling code that uses Qt. -# You do not need to use this if you include QT_USE_FILE. -# The QT_USE_FILE will also define QT_DEBUG and QT_NO_DEBUG -# to fit your current build type. Those are not contained -# in QT_DEFINITIONS. -# -# QT_INCLUDES List of paths to all include directories of -# Qt4 QT_INCLUDE_DIR and QT_QTCORE_INCLUDE_DIR are -# always in this variable even if NOTFOUND, -# all other INCLUDE_DIRS are -# only added if they are found. -# You do not need to use this if you include QT_USE_FILE. -# -# -# Include directories for the Qt modules are listed here. -# You do not need to use these variables if you include QT_USE_FILE. -# -# QT_INCLUDE_DIR Path to "include" of Qt4 -# QT_QT3SUPPORT_INCLUDE_DIR Path to "include/Qt3Support" -# QT_QTASSISTANT_INCLUDE_DIR Path to "include/QtAssistant" -# QT_QTASSISTANTCLIENT_INCLUDE_DIR Path to "include/QtAssistant" -# QT_QAXCONTAINER_INCLUDE_DIR Path to "include/ActiveQt" (Windows only) -# QT_QAXSERVER_INCLUDE_DIR Path to "include/ActiveQt" (Windows only) -# QT_QTCORE_INCLUDE_DIR Path to "include/QtCore" -# QT_QTDBUS_INCLUDE_DIR Path to "include/QtDBus" -# QT_QTDESIGNER_INCLUDE_DIR Path to "include/QtDesigner" -# QT_QTDESIGNERCOMPONENTS_INCLUDE_DIR Path to "include/QtDesigner" -# QT_QTGUI_INCLUDE_DIR Path to "include/QtGui" -# QT_QTHELP_INCLUDE_DIR Path to "include/QtHelp" -# QT_QTMOTIF_INCLUDE_DIR Path to "include/QtMotif" -# QT_QTMULTIMEDIA_INCLUDE_DIR Path to "include/QtMultimedia" -# 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_QTSCRIPT_INCLUDE_DIR Path to "include/QtScript" -# QT_QTSQL_INCLUDE_DIR Path to "include/QtSql" -# QT_QTSVG_INCLUDE_DIR Path to "include/QtSvg" -# QT_QTTEST_INCLUDE_DIR Path to "include/QtTest" -# QT_QTWEBKIT_INCLUDE_DIR Path to "include/QtWebKit" -# QT_QTXML_INCLUDE_DIR Path to "include/QtXml" -# QT_QTXMLPATTERNS_INCLUDE_DIR Path to "include/QtXmlPatterns" -# QT_PHONON_INCLUDE_DIR Path to "include/phonon" -# QT_QTSCRIPTTOOLS_INCLUDE_DIR Path to "include/QtScriptTools" -# QT_QTDECLARATIVE_INCLUDE_DIR Path to "include/QtDeclarative" -# -# QT_BINARY_DIR Path to "bin" of Qt4 -# QT_LIBRARY_DIR Path to "lib" of Qt4 -# QT_PLUGINS_DIR Path to "plugins" for Qt4 -# QT_TRANSLATIONS_DIR Path to "translations" of Qt4 -# QT_IMPORTS_DIR Path to "imports" of Qt4 -# QT_DOC_DIR Path to "doc" of Qt4 -# QT_MKSPECS_DIR Path to "mkspecs" of Qt4 -# -# -# The Qt toolkit may contain both debug and release libraries. -# In that case, the following library variables will contain both. -# You do not need to use these variables if you include QT_USE_FILE, -# and use QT_LIBRARIES. -# -# QT_QT3SUPPORT_LIBRARY The Qt3Support library -# QT_QTASSISTANT_LIBRARY The QtAssistant library -# QT_QTASSISTANTCLIENT_LIBRARY The QtAssistantClient library -# QT_QAXCONTAINER_LIBRARY The QAxContainer library (Windows only) -# QT_QAXSERVER_LIBRARY The QAxServer library (Windows only) -# QT_QTCORE_LIBRARY The QtCore library -# QT_QTDBUS_LIBRARY The QtDBus library -# QT_QTDESIGNER_LIBRARY The QtDesigner library -# QT_QTDESIGNERCOMPONENTS_LIBRARY The QtDesignerComponents library -# QT_QTGUI_LIBRARY The QtGui library -# QT_QTHELP_LIBRARY The QtHelp library -# QT_QTMOTIF_LIBRARY The QtMotif library -# QT_QTMULTIMEDIA_LIBRARY The QtMultimedia library -# QT_QTNETWORK_LIBRARY The QtNetwork library -# QT_QTNSPLUGIN_LIBRARY The QtNsPLugin library -# QT_QTOPENGL_LIBRARY The QtOpenGL library -# QT_QTSCRIPT_LIBRARY The QtScript library -# QT_QTSQL_LIBRARY The QtSql library -# QT_QTSVG_LIBRARY The QtSvg library -# QT_QTTEST_LIBRARY The QtTest library -# QT_QTUITOOLS_LIBRARY The QtUiTools library -# QT_QTWEBKIT_LIBRARY The QtWebKit library -# QT_QTXML_LIBRARY The QtXml library -# QT_QTXMLPATTERNS_LIBRARY The QtXmlPatterns library -# QT_QTMAIN_LIBRARY The qtmain library for Windows -# QT_PHONON_LIBRARY The phonon library -# QT_QTSCRIPTTOOLS_LIBRARY The QtScriptTools library -# -# The QtDeclarative library: QT_QTDECLARATIVE_LIBRARY +# +# :: +# +# This function is obsolete. Use target_link_libraries with IMPORTED targets instead. +# Make <target> use the <modules> from Qt. Using a Qt module means +# to link to the library, add the relevant include directories for the module, +# and add the relevant compiler defines for using the module. +# Modules are roughly equivalent to components of Qt4, so usage would be +# something like: +# qt4_use_modules(myexe Core Gui Declarative) +# to use QtCore, QtGui and QtDeclarative. The optional <link_type> argument can +# be specified as either LINK_PUBLIC or LINK_PRIVATE to specify the same argument +# to the target_link_libraries call. +# +# +# +# +# +# :: +# +# Below is a detailed list of variables that FindQt4.cmake sets. +# QT_FOUND If false, don't try to use Qt. +# Qt4_FOUND If false, don't try to use Qt 4. +# QT4_FOUND If false, don't try to use Qt 4. This variable is for compatibility only. +# +# +# +# :: +# +# QT_VERSION_MAJOR The major version of Qt found. +# QT_VERSION_MINOR The minor version of Qt found. +# QT_VERSION_PATCH The patch version of Qt found. +# +# +# +# :: +# +# QT_EDITION Set to the edition of Qt (i.e. DesktopLight) +# QT_EDITION_DESKTOPLIGHT True if QT_EDITION == DesktopLight +# 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_QTASSISTANTCLIENT_FOUND True if QtAssistantClient was found. +# QT_QAXCONTAINER_FOUND True if QAxContainer was found (Windows only). +# QT_QAXSERVER_FOUND True if QAxServer was found (Windows only). +# QT_QTDBUS_FOUND True if QtDBus was found. +# QT_QTDESIGNER_FOUND True if QtDesigner was found. +# QT_QTDESIGNERCOMPONENTS True if QtDesignerComponents was found. +# QT_QTHELP_FOUND True if QtHelp was found. +# QT_QTMOTIF_FOUND True if QtMotif was found. +# QT_QTMULTIMEDIA_FOUND True if QtMultimedia was found (since Qt 4.6.0). +# 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_QTSVG_FOUND True if QtSvg was found. +# QT_QTSCRIPT_FOUND True if QtScript was found. +# QT_QTSCRIPTTOOLS_FOUND True if QtScriptTools was found. +# QT_QTTEST_FOUND True if QtTest was found. +# QT_QTUITOOLS_FOUND True if QtUiTools was found. +# QT_QTWEBKIT_FOUND True if QtWebKit was found. +# QT_QTXML_FOUND True if QtXml was found. +# QT_QTXMLPATTERNS_FOUND True if QtXmlPatterns was found. +# QT_PHONON_FOUND True if phonon was found. +# QT_QTDECLARATIVE_FOUND True if QtDeclarative was found. +# +# +# +# :: +# +# QT_MAC_USE_COCOA For Mac OS X, its whether Cocoa or Carbon is used. +# In general, this should not be used, but its useful +# when having platform specific code. +# +# +# +# :: +# +# QT_DEFINITIONS Definitions to use when compiling code that uses Qt. +# You do not need to use this if you include QT_USE_FILE. +# The QT_USE_FILE will also define QT_DEBUG and QT_NO_DEBUG +# to fit your current build type. Those are not contained +# in QT_DEFINITIONS. +# +# +# +# :: +# +# QT_INCLUDES List of paths to all include directories of +# Qt4 QT_INCLUDE_DIR and QT_QTCORE_INCLUDE_DIR are +# always in this variable even if NOTFOUND, +# all other INCLUDE_DIRS are +# only added if they are found. +# You do not need to use this if you include QT_USE_FILE. +# +# +# +# +# +# :: +# +# Include directories for the Qt modules are listed here. +# You do not need to use these variables if you include QT_USE_FILE. +# +# +# +# :: +# +# QT_INCLUDE_DIR Path to "include" of Qt4 +# QT_QT3SUPPORT_INCLUDE_DIR Path to "include/Qt3Support" +# QT_QTASSISTANT_INCLUDE_DIR Path to "include/QtAssistant" +# QT_QTASSISTANTCLIENT_INCLUDE_DIR Path to "include/QtAssistant" +# QT_QAXCONTAINER_INCLUDE_DIR Path to "include/ActiveQt" (Windows only) +# QT_QAXSERVER_INCLUDE_DIR Path to "include/ActiveQt" (Windows only) +# QT_QTCORE_INCLUDE_DIR Path to "include/QtCore" +# QT_QTDBUS_INCLUDE_DIR Path to "include/QtDBus" +# QT_QTDESIGNER_INCLUDE_DIR Path to "include/QtDesigner" +# QT_QTDESIGNERCOMPONENTS_INCLUDE_DIR Path to "include/QtDesigner" +# QT_QTGUI_INCLUDE_DIR Path to "include/QtGui" +# QT_QTHELP_INCLUDE_DIR Path to "include/QtHelp" +# QT_QTMOTIF_INCLUDE_DIR Path to "include/QtMotif" +# QT_QTMULTIMEDIA_INCLUDE_DIR Path to "include/QtMultimedia" +# 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_QTSCRIPT_INCLUDE_DIR Path to "include/QtScript" +# QT_QTSQL_INCLUDE_DIR Path to "include/QtSql" +# QT_QTSVG_INCLUDE_DIR Path to "include/QtSvg" +# QT_QTTEST_INCLUDE_DIR Path to "include/QtTest" +# QT_QTWEBKIT_INCLUDE_DIR Path to "include/QtWebKit" +# QT_QTXML_INCLUDE_DIR Path to "include/QtXml" +# QT_QTXMLPATTERNS_INCLUDE_DIR Path to "include/QtXmlPatterns" +# QT_PHONON_INCLUDE_DIR Path to "include/phonon" +# QT_QTSCRIPTTOOLS_INCLUDE_DIR Path to "include/QtScriptTools" +# QT_QTDECLARATIVE_INCLUDE_DIR Path to "include/QtDeclarative" +# +# +# +# :: +# +# QT_BINARY_DIR Path to "bin" of Qt4 +# QT_LIBRARY_DIR Path to "lib" of Qt4 +# QT_PLUGINS_DIR Path to "plugins" for Qt4 +# QT_TRANSLATIONS_DIR Path to "translations" of Qt4 +# QT_IMPORTS_DIR Path to "imports" of Qt4 +# QT_DOC_DIR Path to "doc" of Qt4 +# QT_MKSPECS_DIR Path to "mkspecs" of Qt4 +# +# +# +# +# +# The Qt toolkit may contain both debug and release libraries. In that +# case, the following library variables will contain both. You do not +# need to use these variables if you include QT_USE_FILE, and use +# QT_LIBRARIES. +# +# :: +# +# QT_QT3SUPPORT_LIBRARY The Qt3Support library +# QT_QTASSISTANT_LIBRARY The QtAssistant library +# QT_QTASSISTANTCLIENT_LIBRARY The QtAssistantClient library +# QT_QAXCONTAINER_LIBRARY The QAxContainer library (Windows only) +# QT_QAXSERVER_LIBRARY The QAxServer library (Windows only) +# QT_QTCORE_LIBRARY The QtCore library +# QT_QTDBUS_LIBRARY The QtDBus library +# QT_QTDESIGNER_LIBRARY The QtDesigner library +# QT_QTDESIGNERCOMPONENTS_LIBRARY The QtDesignerComponents library +# QT_QTGUI_LIBRARY The QtGui library +# QT_QTHELP_LIBRARY The QtHelp library +# QT_QTMOTIF_LIBRARY The QtMotif library +# QT_QTMULTIMEDIA_LIBRARY The QtMultimedia library +# QT_QTNETWORK_LIBRARY The QtNetwork library +# QT_QTNSPLUGIN_LIBRARY The QtNsPLugin library +# QT_QTOPENGL_LIBRARY The QtOpenGL library +# QT_QTSCRIPT_LIBRARY The QtScript library +# QT_QTSQL_LIBRARY The QtSql library +# QT_QTSVG_LIBRARY The QtSvg library +# QT_QTTEST_LIBRARY The QtTest library +# QT_QTUITOOLS_LIBRARY The QtUiTools library +# QT_QTWEBKIT_LIBRARY The QtWebKit library +# QT_QTXML_LIBRARY The QtXml library +# QT_QTXMLPATTERNS_LIBRARY The QtXmlPatterns library +# QT_QTMAIN_LIBRARY The qtmain library for Windows +# QT_PHONON_LIBRARY The phonon library +# QT_QTSCRIPTTOOLS_LIBRARY The QtScriptTools library +# +# +# +# The QtDeclarative library: QT_QTDECLARATIVE_LIBRARY # # 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_UIC3_EXECUTABLE Where to find the uic3 tool. -# QT_RCC_EXECUTABLE Where to find the rcc tool -# QT_DBUSCPP2XML_EXECUTABLE Where to find the qdbuscpp2xml tool. -# QT_DBUSXML2CPP_EXECUTABLE Where to find the qdbusxml2cpp tool. -# QT_LUPDATE_EXECUTABLE Where to find the lupdate tool. -# QT_LRELEASE_EXECUTABLE Where to find the lrelease tool. -# QT_QCOLLECTIONGENERATOR_EXECUTABLE Where to find the qcollectiongenerator tool. -# QT_DESIGNER_EXECUTABLE Where to find the Qt designer tool. -# QT_LINGUIST_EXECUTABLE Where to find the Qt linguist 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 -# -# 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 sense in Qt4) -# QT_QT_LIBRARY Qt-Library is now split +# +# :: +# +# QT_MOC_EXECUTABLE Where to find the moc tool. +# QT_UIC_EXECUTABLE Where to find the uic tool. +# QT_UIC3_EXECUTABLE Where to find the uic3 tool. +# QT_RCC_EXECUTABLE Where to find the rcc tool +# QT_DBUSCPP2XML_EXECUTABLE Where to find the qdbuscpp2xml tool. +# QT_DBUSXML2CPP_EXECUTABLE Where to find the qdbusxml2cpp tool. +# QT_LUPDATE_EXECUTABLE Where to find the lupdate tool. +# QT_LRELEASE_EXECUTABLE Where to find the lrelease tool. +# QT_QCOLLECTIONGENERATOR_EXECUTABLE Where to find the qcollectiongenerator tool. +# QT_DESIGNER_EXECUTABLE Where to find the Qt designer tool. +# QT_LINGUIST_EXECUTABLE Where to find the Qt linguist 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 +# +# +# +# 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 sense in Qt4) +# +# :: +# +# QT_QT_LIBRARY Qt-Library is now split #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/FindQuickTime.cmake b/Modules/FindQuickTime.cmake index 42a0dce..2779269 100644 --- a/Modules/FindQuickTime.cmake +++ b/Modules/FindQuickTime.cmake @@ -1,11 +1,15 @@ -# Locate QuickTime -# This module defines -# QUICKTIME_LIBRARY +#.rst: +# FindQuickTime +# ------------- +# +# +# +# Locate QuickTime This module defines QUICKTIME_LIBRARY # QUICKTIME_FOUND, if false, do not try to link to gdal # QUICKTIME_INCLUDE_DIR, where to find the headers # -# $QUICKTIME_DIR is an environment variable that would -# correspond to the ./configure --prefix=$QUICKTIME_DIR +# $QUICKTIME_DIR is an environment variable that would correspond to the +# ./configure --prefix=$QUICKTIME_DIR # # Created by Eric Wing. diff --git a/Modules/FindRTI.cmake b/Modules/FindRTI.cmake index 60990b7..1aad0a8 100644 --- a/Modules/FindRTI.cmake +++ b/Modules/FindRTI.cmake @@ -1,17 +1,32 @@ -# - Try to find M&S HLA RTI libraries -# This module finds if any HLA RTI is installed and locates the standard RTI -# include files and libraries. +#.rst: +# FindRTI +# ------- +# +# Try to find M&S HLA RTI libraries +# +# This module finds if any HLA RTI is installed and locates the standard +# RTI include files and libraries. +# +# RTI is a simulation infrastructure standardized by IEEE and SISO. It +# has a well defined C++ API that assures that simulation applications +# are independent on a particular RTI implementation. +# +# :: +# +# http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation) +# # -# RTI is a simulation infrastructure standardized by IEEE and SISO. It has a -# well defined C++ API that assures that simulation applications are -# independent on a particular RTI implementation. -# http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation) # # This code sets the following variables: -# RTI_INCLUDE_DIR = the directory where RTI includes file are found -# RTI_LIBRARIES = The libraries to link against to use RTI -# RTI_DEFINITIONS = -DRTI_USES_STD_FSTREAM -# RTI_FOUND = Set to FALSE if any HLA RTI was not found +# +# :: +# +# RTI_INCLUDE_DIR = the directory where RTI includes file are found +# RTI_LIBRARIES = The libraries to link against to use RTI +# RTI_DEFINITIONS = -DRTI_USES_STD_FSTREAM +# RTI_FOUND = Set to FALSE if any HLA RTI was not found +# +# # # Report problems to <certi-devel@nongnu.org> diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index c02158f..9d9383d 100644 --- a/Modules/FindRuby.cmake +++ b/Modules/FindRuby.cmake @@ -1,20 +1,31 @@ -# - Find Ruby -# This module finds if Ruby is installed and determines where the include files -# and libraries are. Ruby 1.8 and 1.9 are supported. +#.rst: +# FindRuby +# -------- +# +# Find Ruby +# +# This module finds if Ruby is installed and determines where the +# include files and libraries are. Ruby 1.8 and 1.9 are supported. # # The minimum required version of Ruby can be specified using the -# standard syntax, e.g. find_package(Ruby 1.8) +# standard syntax, e.g. find_package(Ruby 1.8) +# +# It also determines what the name of the library is. This code sets +# the following variables: +# +# :: +# +# RUBY_EXECUTABLE = full path to the ruby binary +# RUBY_INCLUDE_DIRS = include dirs to be used when using the ruby library +# RUBY_LIBRARY = full path to the ruby library +# RUBY_VERSION = the version of ruby which was found, e.g. "1.8.7" +# RUBY_FOUND = set to true if ruby ws found successfully +# # -# It also determines what the name of the library is. This -# code sets the following variables: # -# RUBY_EXECUTABLE = full path to the ruby binary -# RUBY_INCLUDE_DIRS = include dirs to be used when using the ruby library -# RUBY_LIBRARY = full path to the ruby library -# RUBY_VERSION = the version of ruby which was found, e.g. "1.8.7" -# RUBY_FOUND = set to true if ruby ws found successfully +# :: # -# RUBY_INCLUDE_PATH = same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it +# RUBY_INCLUDE_PATH = same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindSDL.cmake b/Modules/FindSDL.cmake index fec142e..6d418fd 100644 --- a/Modules/FindSDL.cmake +++ b/Modules/FindSDL.cmake @@ -1,57 +1,72 @@ -# - Locate SDL library +#.rst: +# FindSDL +# ------- +# +# 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_VERSION_STRING, human-readable string containing the version of SDL +# +# :: +# +# 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_VERSION_STRING, human-readable string containing the version of SDL +# +# # # This module responds to the the flag: -# SDL_BUILDING_LIBRARY -# If this is defined, then no SDL_main will be linked in because -# only applications need main(). -# Otherwise, it is assumed you are building an application and this -# module will attempt to locate and set the the proper link flags -# as part of the returned SDL_LIBRARY variable. +# +# :: +# +# SDL_BUILDING_LIBRARY +# If this is defined, then no SDL_main will be linked in because +# only applications need main(). +# Otherwise, it is assumed you are building an application and this +# module will attempt to locate and set the the proper link flags +# as part of the returned SDL_LIBRARY variable. +# +# # # 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 +# 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. # # -# Additional Note: If you see an empty SDL_LIBRARY_TEMP in your configuration -# and no SDL_LIBRARY, it means CMake did not find your SDL library -# (SDL.dll, libsdl.so, SDL.framework, etc). -# Set SDL_LIBRARY_TEMP to point to your SDL library, and configure again. -# Similarly, if you see an empty SDLMAIN_LIBRARY, you should set this value -# as appropriate. These values are used to generate the final SDL_LIBRARY -# variable, but when these values are unset, SDL_LIBRARY does not get created. +# +# Additional Note: If you see an empty SDL_LIBRARY_TEMP in your +# configuration and no SDL_LIBRARY, it means CMake did not find your SDL +# library (SDL.dll, libsdl.so, SDL.framework, etc). Set +# SDL_LIBRARY_TEMP to point to your SDL library, and configure again. +# Similarly, if you see an empty SDLMAIN_LIBRARY, you should set this +# value as appropriate. These values are used to generate the final +# SDL_LIBRARY variable, but when these values are unset, SDL_LIBRARY +# does not get created. +# # # -# $SDLDIR is an environment variable that would -# correspond to the ./configure --prefix=$SDLDIR -# used in building SDL. -# l.e.galup 9-20-02 +# $SDLDIR is an environment variable that would correspond to the +# ./configure --prefix=$SDLDIR used in building SDL. l.e.galup 9-20-02 # -# Modified by Eric Wing. -# Added code to assist with automated building by using environmental variables -# and providing a more controlled/consistent search behavior. -# Added new modifications to recognize OS X frameworks and -# additional Unix paths (FreeBSD, etc). -# Also corrected the header search path to follow "proper" SDL guidelines. -# Added a search for SDLmain which is needed by some platforms. -# Added a search for threads which is needed by some platforms. -# Added needed compile switches for MinGW. +# Modified by Eric Wing. Added code to assist with automated building +# by using environmental variables and providing a more +# controlled/consistent search behavior. Added new modifications to +# recognize OS X frameworks and additional Unix paths (FreeBSD, etc). +# Also corrected the header search path to follow "proper" SDL +# guidelines. Added a search for SDLmain which is needed by some +# platforms. Added a search for threads which is needed by some +# platforms. Added needed compile switches for MinGW. # # On OSX, this will prefer the Framework version (if found) over others. -# People will have to manually change the cache values of -# SDL_LIBRARY to override this selection or set the CMake environment +# People will have to manually change the cache values of SDL_LIBRARY to +# override this selection or set the CMake environment # CMAKE_INCLUDE_PATH to modify the search paths. # # Note that the header path has changed from SDL/SDL.h to just SDL.h -# This needed to change because "proper" SDL convention -# is #include "SDL.h", not <SDL/SDL.h>. This is done for portability -# reasons because not all systems place things in SDL/ (see FreeBSD). +# This needed to change because "proper" SDL convention is #include +# "SDL.h", not <SDL/SDL.h>. This is done for portability reasons +# because not all systems place things in SDL/ (see FreeBSD). #============================================================================= # Copyright 2003-2009 Kitware, Inc. @@ -70,7 +85,9 @@ find_path(SDL_INCLUDE_DIR SDL.h HINTS ENV SDLDIR - PATH_SUFFIXES include/SDL include/SDL12 include/SDL11 include + PATH_SUFFIXES SDL SDL12 SDL11 + # path suffixes to search inside ENV{SDLDIR} + include/SDL include/SDL12 include/SDL11 include ) # SDL-1.1 is the name used by FreeBSD ports... diff --git a/Modules/FindSDL_image.cmake b/Modules/FindSDL_image.cmake index 30d74ac..2ec6e50 100644 --- a/Modules/FindSDL_image.cmake +++ b/Modules/FindSDL_image.cmake @@ -1,20 +1,34 @@ -# - Locate SDL_image library +#.rst: +# FindSDL_image +# ------------- +# +# Locate SDL_image library +# # This module defines: -# SDL_IMAGE_LIBRARIES, the name of the library to link against -# SDL_IMAGE_INCLUDE_DIRS, where to find the headers -# SDL_IMAGE_FOUND, if false, do not try to link against -# SDL_IMAGE_VERSION_STRING - human-readable string containing the version of SDL_image +# +# :: +# +# SDL_IMAGE_LIBRARIES, the name of the library to link against +# SDL_IMAGE_INCLUDE_DIRS, where to find the headers +# SDL_IMAGE_FOUND, if false, do not try to link against +# SDL_IMAGE_VERSION_STRING - human-readable string containing the version of SDL_image +# +# # # For backward compatiblity the following variables are also set: -# SDLIMAGE_LIBRARY (same value as SDL_IMAGE_LIBRARIES) -# SDLIMAGE_INCLUDE_DIR (same value as SDL_IMAGE_INCLUDE_DIRS) -# SDLIMAGE_FOUND (same value as SDL_IMAGE_FOUND) # -# $SDLDIR is an environment variable that would -# correspond to the ./configure --prefix=$SDLDIR -# used in building SDL. +# :: +# +# SDLIMAGE_LIBRARY (same value as SDL_IMAGE_LIBRARIES) +# SDLIMAGE_INCLUDE_DIR (same value as SDL_IMAGE_INCLUDE_DIRS) +# SDLIMAGE_FOUND (same value as SDL_IMAGE_FOUND) +# +# +# +# $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 +# 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). diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake index 8ca7cc3..d17c907 100644 --- a/Modules/FindSDL_mixer.cmake +++ b/Modules/FindSDL_mixer.cmake @@ -1,20 +1,34 @@ -# - Locate SDL_mixer library +#.rst: +# FindSDL_mixer +# ------------- +# +# Locate SDL_mixer library +# # This module defines: -# SDL_MIXER_LIBRARIES, the name of the library to link against -# SDL_MIXER_INCLUDE_DIRS, where to find the headers -# SDL_MIXER_FOUND, if false, do not try to link against -# SDL_MIXER_VERSION_STRING - human-readable string containing the version of SDL_mixer +# +# :: +# +# SDL_MIXER_LIBRARIES, the name of the library to link against +# SDL_MIXER_INCLUDE_DIRS, where to find the headers +# SDL_MIXER_FOUND, if false, do not try to link against +# SDL_MIXER_VERSION_STRING - human-readable string containing the version of SDL_mixer +# +# # # For backward compatiblity the following variables are also set: -# SDLMIXER_LIBRARY (same value as SDL_MIXER_LIBRARIES) -# SDLMIXER_INCLUDE_DIR (same value as SDL_MIXER_INCLUDE_DIRS) -# SDLMIXER_FOUND (same value as SDL_MIXER_FOUND) # -# $SDLDIR is an environment variable that would -# correspond to the ./configure --prefix=$SDLDIR -# used in building SDL. +# :: +# +# SDLMIXER_LIBRARY (same value as SDL_MIXER_LIBRARIES) +# SDLMIXER_INCLUDE_DIR (same value as SDL_MIXER_INCLUDE_DIRS) +# SDLMIXER_FOUND (same value as SDL_MIXER_FOUND) +# +# +# +# $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 +# 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). diff --git a/Modules/FindSDL_net.cmake b/Modules/FindSDL_net.cmake index ca707af..c545189 100644 --- a/Modules/FindSDL_net.cmake +++ b/Modules/FindSDL_net.cmake @@ -1,20 +1,34 @@ -# - Locate SDL_net library +#.rst: +# FindSDL_net +# ----------- +# +# Locate SDL_net library +# # This module defines: -# SDL_NET_LIBRARIES, the name of the library to link against -# SDL_NET_INCLUDE_DIRS, where to find the headers -# SDL_NET_FOUND, if false, do not try to link against -# SDL_NET_VERSION_STRING - human-readable string containing the version of SDL_net +# +# :: +# +# SDL_NET_LIBRARIES, the name of the library to link against +# SDL_NET_INCLUDE_DIRS, where to find the headers +# SDL_NET_FOUND, if false, do not try to link against +# SDL_NET_VERSION_STRING - human-readable string containing the version of SDL_net +# +# # # For backward compatiblity the following variables are also set: -# SDLNET_LIBRARY (same value as SDL_NET_LIBRARIES) -# SDLNET_INCLUDE_DIR (same value as SDL_NET_INCLUDE_DIRS) -# SDLNET_FOUND (same value as SDL_NET_FOUND) # -# $SDLDIR is an environment variable that would -# correspond to the ./configure --prefix=$SDLDIR -# used in building SDL. +# :: +# +# SDLNET_LIBRARY (same value as SDL_NET_LIBRARIES) +# SDLNET_INCLUDE_DIR (same value as SDL_NET_INCLUDE_DIRS) +# SDLNET_FOUND (same value as SDL_NET_FOUND) +# +# +# +# $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 +# 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). diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake index efd2658..863699a 100644 --- a/Modules/FindSDL_sound.cmake +++ b/Modules/FindSDL_sound.cmake @@ -1,59 +1,80 @@ -# - Locates the SDL_sound library +#.rst: +# FindSDL_sound +# ------------- # -# This module depends on SDL being found and -# must be called AFTER FindSDL.cmake is called. +# Locates the SDL_sound library +# +# +# +# This module depends on SDL being found and must be called AFTER +# FindSDL.cmake is called. # # This module defines -# SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h -# SDL_SOUND_FOUND, if false, do not try to link to SDL_sound -# SDL_SOUND_LIBRARIES, this contains the list of libraries that you need -# to link against. This is a read-only variable and is marked INTERNAL. -# SDL_SOUND_EXTRAS, this is an optional variable for you to add your own -# 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. -# SDL_SOUND_VERSION_STRING, human-readable string containing the version of SDL_sound +# +# :: +# +# SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h +# SDL_SOUND_FOUND, if false, do not try to link to SDL_sound +# SDL_SOUND_LIBRARIES, this contains the list of libraries that you need +# to link against. This is a read-only variable and is marked INTERNAL. +# SDL_SOUND_EXTRAS, this is an optional variable for you to add your own +# 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. +# SDL_SOUND_VERSION_STRING, human-readable string containing the version of SDL_sound +# +# # # 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. +# +# :: +# +# 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 # -# 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 -# (if needed) to successfully compile on your system. +# :: +# +# 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 (if needed) to successfully compile on your system. # -# Created by Eric Wing. -# This module is a bit more complicated than the other FindSDL* family modules. -# The reason is that SDL_sound can be compiled in a large variety of different ways -# which are independent of platform. SDL_sound may dynamically link against other 3rd -# party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug, -# MikMod, FLAC, Speex, and potentially others. -# Under some circumstances which I don't fully understand, -# there seems to be a requirement -# that dependent libraries of libraries you use must also be explicitly -# linked against in order to successfully compile. SDL_sound does not currently -# have any system in place to know how it was compiled. -# So this CMake module does the hard work in trying to discover which 3rd party -# libraries are required for building (if any). -# This module uses a brute force approach to create a test program that uses SDL_sound, -# and then tries to build it. If the build fails, it parses the error output for -# known symbol names to figure out which libraries are needed. +# Created by Eric Wing. This module is a bit more complicated than the +# other FindSDL* family modules. The reason is that SDL_sound can be +# compiled in a large variety of different ways which are independent of +# platform. SDL_sound may dynamically link against other 3rd party +# libraries to get additional codec support, such as Ogg Vorbis, SMPEG, +# ModPlug, MikMod, FLAC, Speex, and potentially others. Under some +# circumstances which I don't fully understand, there seems to be a +# requirement that dependent libraries of libraries you use must also be +# explicitly linked against in order to successfully compile. SDL_sound +# does not currently have any system in place to know how it was +# compiled. So this CMake module does the hard work in trying to +# discover which 3rd party libraries are required for building (if any). +# This module uses a brute force approach to create a test program that +# uses SDL_sound, and then tries to build it. If the build fails, it +# parses the error output for known symbol names to figure out which +# libraries are needed. # -# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would -# correspond to the ./configure --prefix=$SDLDIR used in building SDL. +# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that +# would correspond to the ./configure --prefix=$SDLDIR used in building +# SDL. # # On OSX, this will prefer the Framework version (if found) over others. -# People will have to manually change the cache values of -# SDL_LIBRARY to override this selectionor set the CMake environment -# CMAKE_INCLUDE_PATH to modify the search paths. +# People will have to manually change the cache values of SDL_LIBRARY to +# override this selectionor set the CMake environment CMAKE_INCLUDE_PATH +# to modify the search paths. #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/FindSDL_ttf.cmake b/Modules/FindSDL_ttf.cmake index bb0ca91..8f72b1a 100644 --- a/Modules/FindSDL_ttf.cmake +++ b/Modules/FindSDL_ttf.cmake @@ -1,20 +1,34 @@ -# - Locate SDL_ttf library +#.rst: +# FindSDL_ttf +# ----------- +# +# Locate SDL_ttf library +# # This module defines: -# SDL_TTF_LIBRARIES, the name of the library to link against -# SDL_TTF_INCLUDE_DIRS, where to find the headers -# SDL_TTF_FOUND, if false, do not try to link against -# SDL_TTF_VERSION_STRING - human-readable string containing the version of SDL_ttf +# +# :: +# +# SDL_TTF_LIBRARIES, the name of the library to link against +# SDL_TTF_INCLUDE_DIRS, where to find the headers +# SDL_TTF_FOUND, if false, do not try to link against +# SDL_TTF_VERSION_STRING - human-readable string containing the version of SDL_ttf +# +# # # For backward compatiblity the following variables are also set: -# SDLTTF_LIBRARY (same value as SDL_TTF_LIBRARIES) -# SDLTTF_INCLUDE_DIR (same value as SDL_TTF_INCLUDE_DIRS) -# SDLTTF_FOUND (same value as SDL_TTF_FOUND) # -# $SDLDIR is an environment variable that would -# correspond to the ./configure --prefix=$SDLDIR -# used in building SDL. +# :: +# +# SDLTTF_LIBRARY (same value as SDL_TTF_LIBRARIES) +# SDLTTF_INCLUDE_DIR (same value as SDL_TTF_INCLUDE_DIRS) +# SDLTTF_FOUND (same value as SDL_TTF_FOUND) +# +# +# +# $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 +# 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). diff --git a/Modules/FindSWIG.cmake b/Modules/FindSWIG.cmake index db60b88..bb78bc2 100644 --- a/Modules/FindSWIG.cmake +++ b/Modules/FindSWIG.cmake @@ -1,17 +1,26 @@ -# - Find SWIG +#.rst: +# FindSWIG +# -------- +# +# 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 -# SWIG_VERSION - the version number of the swig executable # -# The minimum required version of SWIG can be specified using the -# standard syntax, e.g. find_package(SWIG 1.1) +# :: +# +# 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 +# SWIG_VERSION - the version number of the swig executable # -# All information is collected from the SWIG_EXECUTABLE so the -# version to be found can be changed from the command line by -# means of setting SWIG_EXECUTABLE # +# +# The minimum required version of SWIG can be specified using the +# standard syntax, e.g. find_package(SWIG 1.1) +# +# All information is collected from the SWIG_EXECUTABLE so the version +# to be found can be changed from the command line by means of setting +# SWIG_EXECUTABLE #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindSelfPackers.cmake b/Modules/FindSelfPackers.cmake index fd28642..238be89 100644 --- a/Modules/FindSelfPackers.cmake +++ b/Modules/FindSelfPackers.cmake @@ -1,9 +1,16 @@ -# - Find upx -# This module looks for some executable packers (i.e. software that +#.rst: +# FindSelfPackers +# --------------- +# +# Find upx +# +# This module looks for some executable packers (i.e. software 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 +# executables or shared libs. Examples: +# +# :: +# +# UPX: http://wildsau.idv.uni-linz.ac.at/mfx/upx.html #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindSquish.cmake b/Modules/FindSquish.cmake index b797805..5cff122 100644 --- a/Modules/FindSquish.cmake +++ b/Modules/FindSquish.cmake @@ -1,63 +1,108 @@ +#.rst: +# FindSquish +# ---------- # -# ---- Find Squish -# This module can be used to find Squish. Currently Squish versions 3 and 4 are supported. +# -- Typical Use # -# ---- Variables and Macros -# SQUISH_FOUND If false, don't try to use Squish -# SQUISH_VERSION The full version of Squish found -# SQUISH_VERSION_MAJOR The major version of Squish found -# SQUISH_VERSION_MINOR The minor version of Squish found -# SQUISH_VERSION_PATCH The patch version of Squish found # -# SQUISH_INSTALL_DIR The Squish installation directory (containing bin, lib, etc) -# SQUISH_SERVER_EXECUTABLE The squishserver executable -# SQUISH_CLIENT_EXECUTABLE The squishrunner executable # -# SQUISH_INSTALL_DIR_FOUND Was the install directory found? -# SQUISH_SERVER_EXECUTABLE_FOUND Was the server executable found? -# SQUISH_CLIENT_EXECUTABLE_FOUND Was the client executable found? +# This module can be used to find Squish. Currently Squish versions 3 +# and 4 are supported. +# +# :: +# +# SQUISH_FOUND If false, don't try to use Squish +# SQUISH_VERSION The full version of Squish found +# SQUISH_VERSION_MAJOR The major version of Squish found +# SQUISH_VERSION_MINOR The minor version of Squish found +# SQUISH_VERSION_PATCH The patch version of Squish found +# +# +# +# :: +# +# SQUISH_INSTALL_DIR The Squish installation directory (containing bin, lib, etc) +# SQUISH_SERVER_EXECUTABLE The squishserver executable +# SQUISH_CLIENT_EXECUTABLE The squishrunner executable +# +# +# +# :: +# +# SQUISH_INSTALL_DIR_FOUND Was the install directory found? +# SQUISH_SERVER_EXECUTABLE_FOUND Was the server executable found? +# SQUISH_CLIENT_EXECUTABLE_FOUND Was the client executable found? +# +# +# +# It provides the function squish_v4_add_test() for adding a squish test +# to cmake using Squish 4.x: +# +# :: +# +# squish_v4_add_test(cmakeTestName AUT targetName SUITE suiteName TEST squishTestName +# [SETTINGSGROUP group] [PRE_COMMAND command] [POST_COMMAND command] ) # -# It provides the function squish_v4_add_test() for adding a squish test to cmake using Squish 4.x: # -# squish_v4_add_test(cmakeTestName AUT targetName SUITE suiteName TEST squishTestName -# [SETTINGSGROUP group] [PRE_COMMAND command] [POST_COMMAND command] ) # # The arguments have the following meaning: -# cmakeTestName: this will be used as the first argument for add_test() -# AUT targetName: the name of the cmake target which will be used as AUT, i.e. the -# executable which will be tested. -# SUITE suiteName: this is either the full path to the squish suite, or just the -# last directory of the suite, i.e. the suite name. In this case -# the CMakeLists.txt which calls squish_add_test() must be located -# in the parent directory of the suite directory. -# TEST squishTestName: the name of the squish test, i.e. the name of the subdirectory -# of the test inside the suite directory. -# SETTINGSGROUP group: if specified, the given settings group will be used for executing the test. -# If not specified, the groupname will be "CTest_<username>" -# PRE_COMMAND command: if specified, the given command will be executed before starting the squish test. -# POST_COMMAND command: same as PRE_COMMAND, but after the squish test has been executed. -# -# ---- Typical Use +# +# :: +# +# cmakeTestName: this will be used as the first argument for add_test() +# AUT targetName: the name of the cmake target which will be used as AUT, i.e. the +# executable which will be tested. +# SUITE suiteName: this is either the full path to the squish suite, or just the +# last directory of the suite, i.e. the suite name. In this case +# the CMakeLists.txt which calls squish_add_test() must be located +# in the parent directory of the suite directory. +# TEST squishTestName: the name of the squish test, i.e. the name of the subdirectory +# of the test inside the suite directory. +# SETTINGSGROUP group: if specified, the given settings group will be used for executing the test. +# If not specified, the groupname will be "CTest_<username>" +# PRE_COMMAND command: if specified, the given command will be executed before starting the squish test. +# POST_COMMAND command: same as PRE_COMMAND, but after the squish test has been executed. +# +# +# +# :: +# +# enable_testing() +# find_package(Squish 4.0) +# if (SQUISH_FOUND) +# squish_v4_add_test(myTestName AUT myApp SUITE ${CMAKE_SOURCE_DIR}/tests/mySuite TEST someSquishTest SETTINGSGROUP myGroup ) +# endif () +# +# +# +# +# +# For users of Squish version 3.x the macro squish_v3_add_test() is +# provided: +# +# :: +# +# squish_v3_add_test(testName applicationUnderTest testCase envVars testWrapper) +# Use this macro to add a test using Squish 3.x. +# +# +# +# :: +# # enable_testing() -# find_package(Squish 4.0) +# find_package(Squish) # if (SQUISH_FOUND) -# squish_v4_add_test(myTestName AUT myApp SUITE ${CMAKE_SOURCE_DIR}/tests/mySuite TEST someSquishTest SETTINGSGROUP myGroup ) +# squish_v3_add_test(myTestName myApplication testCase envVars testWrapper) # endif () # # -# For users of Squish version 3.x the macro squish_v3_add_test() is provided: -# squish_v3_add_test(testName applicationUnderTest testCase envVars testWrapper) -# Use this macro to add a test using Squish 3.x. # -# ---- Typical Use -# enable_testing() -# find_package(Squish) -# if (SQUISH_FOUND) -# squish_v3_add_test(myTestName myApplication testCase envVars testWrapper) -# endif () +# macro SQUISH_ADD_TEST(testName applicationUnderTest testCase envVars +# testWrapper) +# +# :: # -# macro SQUISH_ADD_TEST(testName applicationUnderTest testCase envVars testWrapper) -# This is deprecated. Use SQUISH_V3_ADD_TEST() if you are using Squish 3.x instead. +# This is deprecated. Use SQUISH_V3_ADD_TEST() if you are using Squish 3.x instead. #============================================================================= diff --git a/Modules/FindSubversion.cmake b/Modules/FindSubversion.cmake index f1bfc75..2338721 100644 --- a/Modules/FindSubversion.cmake +++ b/Modules/FindSubversion.cmake @@ -1,37 +1,62 @@ -# - Extract information from a subversion working copy +#.rst: +# FindSubversion +# -------------- +# +# Extract information from a subversion working copy +# # The module defines the following variables: -# Subversion_SVN_EXECUTABLE - path to svn command line client -# Subversion_VERSION_SVN - version of svn command line client -# Subversion_FOUND - true if the command line client was found -# SUBVERSION_FOUND - same as Subversion_FOUND, set for compatiblity reasons +# +# :: +# +# Subversion_SVN_EXECUTABLE - path to svn command line client +# Subversion_VERSION_SVN - version of svn command line client +# Subversion_FOUND - true if the command line client was found +# SUBVERSION_FOUND - same as Subversion_FOUND, set for compatiblity reasons +# +# # # The minimum required version of Subversion can be specified using the -# standard syntax, e.g. find_package(Subversion 1.4) +# standard syntax, e.g. find_package(Subversion 1.4) # # If the command line client executable is found two macros are defined: -# Subversion_WC_INFO(<dir> <var-prefix>) -# Subversion_WC_LOG(<dir> <var-prefix>) -# Subversion_WC_INFO extracts information of a subversion working copy at -# a given location. This macro defines the following variables: -# <var-prefix>_WC_URL - url of the repository (at <dir>) -# <var-prefix>_WC_ROOT - root url of the repository -# <var-prefix>_WC_REVISION - current revision -# <var-prefix>_WC_LAST_CHANGED_AUTHOR - author of last commit -# <var-prefix>_WC_LAST_CHANGED_DATE - date of last commit -# <var-prefix>_WC_LAST_CHANGED_REV - revision of last commit -# <var-prefix>_WC_INFO - output of command `svn info <dir>' +# +# :: +# +# Subversion_WC_INFO(<dir> <var-prefix>) +# Subversion_WC_LOG(<dir> <var-prefix>) +# +# Subversion_WC_INFO extracts information of a subversion working copy +# at a given location. This macro defines the following variables: +# +# :: +# +# <var-prefix>_WC_URL - url of the repository (at <dir>) +# <var-prefix>_WC_ROOT - root url of the repository +# <var-prefix>_WC_REVISION - current revision +# <var-prefix>_WC_LAST_CHANGED_AUTHOR - author of last commit +# <var-prefix>_WC_LAST_CHANGED_DATE - date of last commit +# <var-prefix>_WC_LAST_CHANGED_REV - revision of last commit +# <var-prefix>_WC_INFO - output of command `svn info <dir>' +# # Subversion_WC_LOG retrieves the log message of the base revision of a -# subversion working copy at a given location. This macro defines the +# subversion working copy at a given location. This macro defines the # variable: -# <var-prefix>_LAST_CHANGED_LOG - last log of base revision +# +# :: +# +# <var-prefix>_LAST_CHANGED_LOG - last log of base revision +# # Example usage: -# find_package(Subversion) -# if(SUBVERSION_FOUND) -# Subversion_WC_INFO(${PROJECT_SOURCE_DIR} Project) -# message("Current revision is ${Project_WC_REVISION}") -# Subversion_WC_LOG(${PROJECT_SOURCE_DIR} Project) -# message("Last changed log is ${Project_LAST_CHANGED_LOG}") -# endif() +# +# :: +# +# find_package(Subversion) +# if(SUBVERSION_FOUND) +# Subversion_WC_INFO(${PROJECT_SOURCE_DIR} Project) +# message("Current revision is ${Project_WC_REVISION}") +# Subversion_WC_LOG(${PROJECT_SOURCE_DIR} Project) +# message("Last changed log is ${Project_LAST_CHANGED_LOG}") +# endif() #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/FindTCL.cmake b/Modules/FindTCL.cmake index 37e43d0..a83e277 100644 --- a/Modules/FindTCL.cmake +++ b/Modules/FindTCL.cmake @@ -1,35 +1,45 @@ -# - 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_FOUND = Tcl was found -# TK_FOUND = Tk was found -# TCLTK_FOUND = Tcl and Tk were found -# TCL_LIBRARY = path to Tcl library (tcl tcl80) -# TCL_INCLUDE_PATH = path to where tcl.h can be found -# TCL_TCLSH = path to tclsh binary (tcl tcl80) -# TK_LIBRARY = path to Tk library (tk tk80 etc) -# TK_INCLUDE_PATH = path to where tk.h can be found -# TK_WISH = full path to the wish executable +#.rst: +# FindTCL +# ------- # -# In an effort to remove some clutter and clear up some issues for people -# who are not necessarily Tcl/Tk gurus/developpers, some variables were -# moved or removed. Changes compared to CMake 2.4 are: -# - The stub libraries are now found in FindTclStub.cmake -# => they were only useful for people writing Tcl/Tk extensions. -# - TCL_LIBRARY_DEBUG and TK_LIBRARY_DEBUG were removed. -# => these libs are not packaged by default with Tcl/Tk distributions. -# Even when Tcl/Tk is built from source, several flavors of debug libs -# are created and there is no real reason to pick a single one -# specifically (say, amongst tcl84g, tcl84gs, or tcl84sgx). -# Let's leave that choice to the user by allowing him to assign -# TCL_LIBRARY to any Tcl library, debug or not. -# - TK_INTERNAL_PATH was removed. -# => this ended up being only a Win32 variable, and there is a lot of -# confusion regarding the location of this file in an installed Tcl/Tk -# tree anyway (see 8.5 for example). If you need the internal path at -# this point it is safer you ask directly where the *source* tree is -# and dig from there. +# TK_INTERNAL_PATH was removed. +# +# 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_FOUND = Tcl was found +# TK_FOUND = Tk was found +# TCLTK_FOUND = Tcl and Tk were found +# TCL_LIBRARY = path to Tcl library (tcl tcl80) +# TCL_INCLUDE_PATH = path to where tcl.h can be found +# TCL_TCLSH = path to tclsh binary (tcl tcl80) +# TK_LIBRARY = path to Tk library (tk tk80 etc) +# TK_INCLUDE_PATH = path to where tk.h can be found +# TK_WISH = full path to the wish executable +# +# +# +# In an effort to remove some clutter and clear up some issues for +# people who are not necessarily Tcl/Tk gurus/developpers, some +# variables were moved or removed. Changes compared to CMake 2.4 are: +# +# :: +# +# => they were only useful for people writing Tcl/Tk extensions. +# => these libs are not packaged by default with Tcl/Tk distributions. +# Even when Tcl/Tk is built from source, several flavors of debug libs +# are created and there is no real reason to pick a single one +# specifically (say, amongst tcl84g, tcl84gs, or tcl84sgx). +# Let's leave that choice to the user by allowing him to assign +# TCL_LIBRARY to any Tcl library, debug or not. +# => this ended up being only a Win32 variable, and there is a lot of +# confusion regarding the location of this file in an installed Tcl/Tk +# tree anyway (see 8.5 for example). If you need the internal path at +# this point it is safer you ask directly where the *source* tree is +# and dig from there. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindTIFF.cmake b/Modules/FindTIFF.cmake index b48fb0e..a67d24d 100644 --- a/Modules/FindTIFF.cmake +++ b/Modules/FindTIFF.cmake @@ -1,11 +1,22 @@ -# - Find TIFF library -# Find the native TIFF includes and library -# This module defines -# TIFF_INCLUDE_DIR, where to find tiff.h, etc. -# TIFF_LIBRARIES, libraries to link against to use TIFF. -# TIFF_FOUND, If false, do not try to use TIFF. +#.rst: +# FindTIFF +# -------- +# +# Find TIFF library +# +# Find the native TIFF includes and library This module defines +# +# :: +# +# TIFF_INCLUDE_DIR, where to find tiff.h, etc. +# TIFF_LIBRARIES, 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. #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindTclStub.cmake b/Modules/FindTclStub.cmake index 8dda94a..3c24f97 100644 --- a/Modules/FindTclStub.cmake +++ b/Modules/FindTclStub.cmake @@ -1,25 +1,45 @@ -# - Find Tcl stub libraries. -# This module finds Tcl stub libraries. It first finds Tcl include files and -# libraries by calling FindTCL.cmake. -# How to Use the Tcl Stubs Library: -# http://tcl.activestate.com/doc/howto/stubs.html +#.rst: +# FindTclStub +# ----------- +# +# TCL_STUB_LIBRARY_DEBUG and TK_STUB_LIBRARY_DEBUG were removed. +# +# This module finds Tcl stub libraries. It first finds Tcl include +# files and libraries by calling FindTCL.cmake. How to Use the Tcl +# Stubs Library: +# +# :: +# +# http://tcl.activestate.com/doc/howto/stubs.html +# # Using Stub Libraries: -# http://safari.oreilly.com/0130385603/ch48lev1sec3 +# +# :: +# +# http://safari.oreilly.com/0130385603/ch48lev1sec3 +# # This code sets the following variables: -# TCL_STUB_LIBRARY = path to Tcl stub library -# TK_STUB_LIBRARY = path to Tk stub library -# TTK_STUB_LIBRARY = path to ttk stub library -# -# In an effort to remove some clutter and clear up some issues for people -# who are not necessarily Tcl/Tk gurus/developpers, some variables were -# moved or removed. Changes compared to CMake 2.4 are: -# - TCL_STUB_LIBRARY_DEBUG and TK_STUB_LIBRARY_DEBUG were removed. -# => these libs are not packaged by default with Tcl/Tk distributions. -# Even when Tcl/Tk is built from source, several flavors of debug libs -# are created and there is no real reason to pick a single one -# specifically (say, amongst tclstub84g, tclstub84gs, or tclstub84sgx). -# Let's leave that choice to the user by allowing him to assign -# TCL_STUB_LIBRARY to any Tcl library, debug or not. +# +# :: +# +# TCL_STUB_LIBRARY = path to Tcl stub library +# TK_STUB_LIBRARY = path to Tk stub library +# TTK_STUB_LIBRARY = path to ttk stub library +# +# +# +# In an effort to remove some clutter and clear up some issues for +# people who are not necessarily Tcl/Tk gurus/developpers, some +# variables were moved or removed. Changes compared to CMake 2.4 are: +# +# :: +# +# => these libs are not packaged by default with Tcl/Tk distributions. +# Even when Tcl/Tk is built from source, several flavors of debug libs +# are created and there is no real reason to pick a single one +# specifically (say, amongst tclstub84g, tclstub84gs, or tclstub84sgx). +# Let's leave that choice to the user by allowing him to assign +# TCL_STUB_LIBRARY to any Tcl library, debug or not. #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/FindTclsh.cmake b/Modules/FindTclsh.cmake index 0f091e6..2fd5332 100644 --- a/Modules/FindTclsh.cmake +++ b/Modules/FindTclsh.cmake @@ -1,11 +1,20 @@ -# - 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: -# TCLSH_FOUND = TRUE if tclsh has been found -# TCL_TCLSH = the path to the tclsh executable -# In cygwin, look for the cygwin version first. Don't look for it later to -# avoid finding the cygwin version on a Win32 build. +#.rst: +# FindTclsh +# --------- +# +# 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: +# +# :: +# +# TCLSH_FOUND = TRUE if tclsh has been found +# TCL_TCLSH = the path to the tclsh executable +# +# In cygwin, look for the cygwin version first. Don't look for it later +# to avoid finding the cygwin version on a Win32 build. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindThreads.cmake b/Modules/FindThreads.cmake index f03908e..ec671bf 100644 --- a/Modules/FindThreads.cmake +++ b/Modules/FindThreads.cmake @@ -1,12 +1,24 @@ -# - This module determines the thread library of the system. +#.rst: +# FindThreads +# ----------- +# +# This module determines the thread library of the system. +# # The following variables are set -# CMAKE_THREAD_LIBS_INIT - the thread library -# CMAKE_USE_SPROC_INIT - are we using sproc? -# CMAKE_USE_WIN32_THREADS_INIT - 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 +# CMAKE_USE_SPROC_INIT - are we using sproc? +# CMAKE_USE_WIN32_THREADS_INIT - using WIN32 threads? +# CMAKE_USE_PTHREADS_INIT - are we using pthreads +# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads +# # For systems with multiple thread libraries, caller can set -# CMAKE_THREAD_PREFER_PTHREAD +# +# :: +# +# CMAKE_THREAD_PREFER_PTHREAD #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/FindUnixCommands.cmake b/Modules/FindUnixCommands.cmake index 87caadc..d4e5dcd 100644 --- a/Modules/FindUnixCommands.cmake +++ b/Modules/FindUnixCommands.cmake @@ -1,6 +1,10 @@ -# - Find unix commands from cygwin -# This module looks for some usual Unix commands. +#.rst: +# FindUnixCommands +# ---------------- +# +# Find unix commands from cygwin # +# This module looks for some usual Unix commands. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindVTK.cmake b/Modules/FindVTK.cmake index 085d60d..bcc7f87 100644 --- a/Modules/FindVTK.cmake +++ b/Modules/FindVTK.cmake @@ -1,31 +1,46 @@ -# - 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 file 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 -# VTK_LIBRARY_DIRS - Link directories for VTK libraries -# VTK_KITS - List of VTK kits, in CAPS -# (COMMON,IO,) etc. -# VTK_LANGUAGES - List of wrapped languages, in CAPS -# (TCL, PYHTON,) etc. +#.rst: +# FindVTK +# ------- +# +# 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 file 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 +# VTK_LIBRARY_DIRS - Link directories for VTK libraries +# VTK_KITS - List of VTK kits, in CAPS +# (COMMON,IO,) etc. +# VTK_LANGUAGES - List of wrapped languages, in CAPS +# (TCL, PYHTON,) etc. +# # 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 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 -# compatibility. Use VTK_USE_FILE -# instead. # +# :: +# +# 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 +# compatibility. Use VTK_USE_FILE +# instead. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindWget.cmake b/Modules/FindWget.cmake index 4da98b1..b303b40 100644 --- a/Modules/FindWget.cmake +++ b/Modules/FindWget.cmake @@ -1,8 +1,15 @@ -# - Find wget -# This module looks for wget. This module defines the -# following values: -# WGET_EXECUTABLE: the full path to the wget tool. -# WGET_FOUND: True if wget has been found. +#.rst: +# FindWget +# -------- +# +# Find wget +# +# This module looks for wget. This module defines the following values: +# +# :: +# +# WGET_EXECUTABLE: the full path to the wget tool. +# WGET_FOUND: True if wget has been found. #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindWish.cmake b/Modules/FindWish.cmake index 11b29f2..df301b4 100644 --- a/Modules/FindWish.cmake +++ b/Modules/FindWish.cmake @@ -1,9 +1,18 @@ -# - 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: +#.rst: +# FindWish +# -------- +# +# 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 path to the wish executable +# # -# TK_WISH = the path to the wish executable # # if UNIX is defined, then it will look for the cygwin version first diff --git a/Modules/FindX11.cmake b/Modules/FindX11.cmake index 131d979..67cecc2 100644 --- a/Modules/FindX11.cmake +++ b/Modules/FindX11.cmake @@ -1,44 +1,57 @@ -# - 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 +#.rst: +# FindX11 +# ------- # -# and also the following more fine grained variables: -# Include paths: X11_ICE_INCLUDE_PATH, X11_ICE_LIB, X11_ICE_FOUND -# X11_SM_INCLUDE_PATH, X11_SM_LIB, X11_SM_FOUND -# X11_X11_INCLUDE_PATH, X11_X11_LIB -# X11_Xaccessrules_INCLUDE_PATH, X11_Xaccess_FOUND -# X11_Xaccessstr_INCLUDE_PATH, X11_Xaccess_FOUND -# X11_Xau_INCLUDE_PATH, X11_Xau_LIB, X11_Xau_FOUND -# X11_Xcomposite_INCLUDE_PATH, X11_Xcomposite_LIB, X11_Xcomposite_FOUND -# X11_Xcursor_INCLUDE_PATH, X11_Xcursor_LIB, X11_Xcursor_FOUND -# X11_Xdamage_INCLUDE_PATH, X11_Xdamage_LIB, X11_Xdamage_FOUND -# X11_Xdmcp_INCLUDE_PATH, X11_Xdmcp_LIB, X11_Xdmcp_FOUND -# X11_Xext_LIB, X11_Xext_FOUND -# X11_dpms_INCLUDE_PATH, (in X11_Xext_LIB), X11_dpms_FOUND -# X11_XShm_INCLUDE_PATH, (in X11_Xext_LIB), X11_XShm_FOUND -# X11_Xshape_INCLUDE_PATH, (in X11_Xext_LIB), X11_Xshape_FOUND -# X11_xf86misc_INCLUDE_PATH, X11_Xxf86misc_LIB, X11_xf86misc_FOUND -# X11_xf86vmode_INCLUDE_PATH, X11_Xxf86vm_LIB X11_xf86vmode_FOUND -# X11_Xfixes_INCLUDE_PATH, X11_Xfixes_LIB, X11_Xfixes_FOUND -# X11_Xft_INCLUDE_PATH, X11_Xft_LIB, X11_Xft_FOUND -# X11_Xi_INCLUDE_PATH, X11_Xi_LIB, X11_Xi_FOUND -# X11_Xinerama_INCLUDE_PATH, X11_Xinerama_LIB, X11_Xinerama_FOUND -# X11_Xinput_INCLUDE_PATH, X11_Xinput_LIB, X11_Xinput_FOUND -# X11_Xkb_INCLUDE_PATH, X11_Xkb_FOUND -# X11_Xkblib_INCLUDE_PATH, X11_Xkb_FOUND -# X11_Xkbfile_INCLUDE_PATH, X11_Xkbfile_LIB, X11_Xkbfile_FOUND -# X11_Xmu_INCLUDE_PATH, X11_Xmu_LIB, X11_Xmu_FOUND -# X11_Xpm_INCLUDE_PATH, X11_Xpm_LIB, X11_Xpm_FOUND -# X11_XTest_INCLUDE_PATH, X11_XTest_LIB, X11_XTest_FOUND -# X11_Xrandr_INCLUDE_PATH, X11_Xrandr_LIB, X11_Xrandr_FOUND -# X11_Xrender_INCLUDE_PATH, X11_Xrender_LIB, X11_Xrender_FOUND -# X11_Xscreensaver_INCLUDE_PATH, X11_Xscreensaver_LIB, X11_Xscreensaver_FOUND -# X11_Xt_INCLUDE_PATH, X11_Xt_LIB, X11_Xt_FOUND -# X11_Xutil_INCLUDE_PATH, X11_Xutil_FOUND -# X11_Xv_INCLUDE_PATH, X11_Xv_LIB, X11_Xv_FOUND -# X11_XSync_INCLUDE_PATH, (in X11_Xext_LIB), X11_XSync_FOUND +# 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 +# +# +# +# and also the following more fine grained variables: Include paths: +# X11_ICE_INCLUDE_PATH, X11_ICE_LIB, X11_ICE_FOUND +# +# :: +# +# X11_SM_INCLUDE_PATH, X11_SM_LIB, X11_SM_FOUND +# X11_X11_INCLUDE_PATH, X11_X11_LIB +# X11_Xaccessrules_INCLUDE_PATH, X11_Xaccess_FOUND +# X11_Xaccessstr_INCLUDE_PATH, X11_Xaccess_FOUND +# X11_Xau_INCLUDE_PATH, X11_Xau_LIB, X11_Xau_FOUND +# X11_Xcomposite_INCLUDE_PATH, X11_Xcomposite_LIB, X11_Xcomposite_FOUND +# X11_Xcursor_INCLUDE_PATH, X11_Xcursor_LIB, X11_Xcursor_FOUND +# X11_Xdamage_INCLUDE_PATH, X11_Xdamage_LIB, X11_Xdamage_FOUND +# X11_Xdmcp_INCLUDE_PATH, X11_Xdmcp_LIB, X11_Xdmcp_FOUND +# X11_Xext_LIB, X11_Xext_FOUND +# X11_dpms_INCLUDE_PATH, (in X11_Xext_LIB), X11_dpms_FOUND +# X11_XShm_INCLUDE_PATH, (in X11_Xext_LIB), X11_XShm_FOUND +# X11_Xshape_INCLUDE_PATH, (in X11_Xext_LIB), X11_Xshape_FOUND +# X11_xf86misc_INCLUDE_PATH, X11_Xxf86misc_LIB, X11_xf86misc_FOUND +# X11_xf86vmode_INCLUDE_PATH, X11_Xxf86vm_LIB X11_xf86vmode_FOUND +# X11_Xfixes_INCLUDE_PATH, X11_Xfixes_LIB, X11_Xfixes_FOUND +# X11_Xft_INCLUDE_PATH, X11_Xft_LIB, X11_Xft_FOUND +# X11_Xi_INCLUDE_PATH, X11_Xi_LIB, X11_Xi_FOUND +# X11_Xinerama_INCLUDE_PATH, X11_Xinerama_LIB, X11_Xinerama_FOUND +# X11_Xinput_INCLUDE_PATH, X11_Xinput_LIB, X11_Xinput_FOUND +# X11_Xkb_INCLUDE_PATH, X11_Xkb_FOUND +# X11_Xkblib_INCLUDE_PATH, X11_Xkb_FOUND +# X11_Xkbfile_INCLUDE_PATH, X11_Xkbfile_LIB, X11_Xkbfile_FOUND +# X11_Xmu_INCLUDE_PATH, X11_Xmu_LIB, X11_Xmu_FOUND +# X11_Xpm_INCLUDE_PATH, X11_Xpm_LIB, X11_Xpm_FOUND +# X11_XTest_INCLUDE_PATH, X11_XTest_LIB, X11_XTest_FOUND +# X11_Xrandr_INCLUDE_PATH, X11_Xrandr_LIB, X11_Xrandr_FOUND +# X11_Xrender_INCLUDE_PATH, X11_Xrender_LIB, X11_Xrender_FOUND +# X11_Xscreensaver_INCLUDE_PATH, X11_Xscreensaver_LIB, X11_Xscreensaver_FOUND +# X11_Xt_INCLUDE_PATH, X11_Xt_LIB, X11_Xt_FOUND +# X11_Xutil_INCLUDE_PATH, X11_Xutil_FOUND +# X11_Xv_INCLUDE_PATH, X11_Xv_LIB, X11_Xv_FOUND +# X11_XSync_INCLUDE_PATH, (in X11_Xext_LIB), X11_XSync_FOUND #============================================================================= diff --git a/Modules/FindXMLRPC.cmake b/Modules/FindXMLRPC.cmake index c80249b..e855050 100644 --- a/Modules/FindXMLRPC.cmake +++ b/Modules/FindXMLRPC.cmake @@ -1,16 +1,32 @@ -# - Find xmlrpc +#.rst: +# FindXMLRPC +# ---------- +# +# Find xmlrpc +# # Find the native XMLRPC headers and libraries. -# XMLRPC_INCLUDE_DIRS - where to find xmlrpc.h, etc. -# XMLRPC_LIBRARIES - List of libraries when using xmlrpc. -# XMLRPC_FOUND - True if xmlrpc found. +# +# :: +# +# XMLRPC_INCLUDE_DIRS - where to find xmlrpc.h, etc. +# XMLRPC_LIBRARIES - List of libraries when using xmlrpc. +# XMLRPC_FOUND - True if xmlrpc found. +# # XMLRPC modules may be specified as components for this find module. # Modules may be listed by running "xmlrpc-c-config". Modules include: -# c++ C++ wrapper code -# libwww-client libwww-based client -# cgi-server CGI-based server -# abyss-server ABYSS-based server +# +# :: +# +# c++ C++ wrapper code +# libwww-client libwww-based client +# cgi-server CGI-based server +# abyss-server ABYSS-based server +# # Typical usage: -# find_package(XMLRPC REQUIRED libwww-client) +# +# :: +# +# find_package(XMLRPC REQUIRED libwww-client) #============================================================================= # Copyright 2001-2009 Kitware, Inc. diff --git a/Modules/FindZLIB.cmake b/Modules/FindZLIB.cmake index 00b9c64..75b0076 100644 --- a/Modules/FindZLIB.cmake +++ b/Modules/FindZLIB.cmake @@ -1,25 +1,41 @@ -# - Find zlib -# Find the native ZLIB includes and library. -# Once done this will define +#.rst: +# FindZLIB +# -------- +# +# Find zlib +# +# Find the native ZLIB includes and library. Once done this will define +# +# :: +# +# ZLIB_INCLUDE_DIRS - where to find zlib.h, etc. +# ZLIB_LIBRARIES - List of libraries when using zlib. +# ZLIB_FOUND - True if zlib found. +# +# +# +# :: +# +# ZLIB_VERSION_STRING - The version of zlib found (x.y.z) +# ZLIB_VERSION_MAJOR - The major version of zlib +# ZLIB_VERSION_MINOR - The minor version of zlib +# ZLIB_VERSION_PATCH - The patch version of zlib +# ZLIB_VERSION_TWEAK - The tweak version of zlib # -# ZLIB_INCLUDE_DIRS - where to find zlib.h, etc. -# ZLIB_LIBRARIES - List of libraries when using zlib. -# ZLIB_FOUND - True if zlib found. # -# ZLIB_VERSION_STRING - The version of zlib found (x.y.z) -# ZLIB_VERSION_MAJOR - The major version of zlib -# ZLIB_VERSION_MINOR - The minor version of zlib -# ZLIB_VERSION_PATCH - The patch version of zlib -# ZLIB_VERSION_TWEAK - The tweak version of zlib # # The following variable are provided for backward compatibility # -# ZLIB_MAJOR_VERSION - The major version of zlib -# ZLIB_MINOR_VERSION - The minor version of zlib -# ZLIB_PATCH_VERSION - The patch version of zlib +# :: +# +# ZLIB_MAJOR_VERSION - The major version of zlib +# ZLIB_MINOR_VERSION - The minor version of zlib +# ZLIB_PATCH_VERSION - The patch version of zlib +# +# # -# An includer may set ZLIB_ROOT to a zlib installation root to tell -# this module where to look. +# An includer may set ZLIB_ROOT to a zlib installation root to tell this +# module where to look. #============================================================================= # Copyright 2001-2011 Kitware, Inc. diff --git a/Modules/Findosg.cmake b/Modules/Findosg.cmake index bc1e48a..5ab2846 100644 --- a/Modules/Findosg.cmake +++ b/Modules/Findosg.cmake @@ -1,31 +1,37 @@ +#.rst: +# Findosg +# ------- # -# NOTE: It is highly recommended that you use the new FindOpenSceneGraph.cmake -# introduced in CMake 2.6.3 and not use this Find module directly. -# -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osg -# This module defines -# -# OSG_FOUND - Was the Osg found? -# OSG_INCLUDE_DIR - Where to find the headers -# OSG_LIBRARIES - The libraries to link against for the OSG (use this) -# -# OSG_LIBRARY - The OSG library -# OSG_LIBRARY_DEBUG - The OSG debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# +# +# +# +# NOTE: It is highly recommended that you use the new +# FindOpenSceneGraph.cmake introduced in CMake 2.6.3 and not use this +# Find module directly. +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osg This module defines +# +# OSG_FOUND - Was the Osg found? OSG_INCLUDE_DIR - Where to find the +# headers OSG_LIBRARIES - The libraries to link against for the OSG (use +# this) +# +# OSG_LIBRARY - The OSG library OSG_LIBRARY_DEBUG - The OSG debug +# library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgAnimation.cmake b/Modules/FindosgAnimation.cmake index 121aefc..403e68e 100644 --- a/Modules/FindosgAnimation.cmake +++ b/Modules/FindosgAnimation.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgAnimation -# This module defines -# -# OSGANIMATION_FOUND - Was osgAnimation found? -# OSGANIMATION_INCLUDE_DIR - Where to find the headers -# OSGANIMATION_LIBRARIES - The libraries to link against for the OSG (use this) -# -# OSGANIMATION_LIBRARY - The OSG library -# OSGANIMATION_LIBRARY_DEBUG - The OSG debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgAnimation +# ---------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgAnimation This module defines +# +# OSGANIMATION_FOUND - Was osgAnimation found? OSGANIMATION_INCLUDE_DIR +# - Where to find the headers OSGANIMATION_LIBRARIES - The libraries to +# link against for the OSG (use this) +# +# OSGANIMATION_LIBRARY - The OSG library OSGANIMATION_LIBRARY_DEBUG - +# The OSG debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgDB.cmake b/Modules/FindosgDB.cmake index 1ed94a1..0e5bdef 100644 --- a/Modules/FindosgDB.cmake +++ b/Modules/FindosgDB.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgDB -# This module defines -# -# OSGDB_FOUND - Was osgDB found? -# OSGDB_INCLUDE_DIR - Where to find the headers -# OSGDB_LIBRARIES - The libraries to link against for the osgDB (use this) -# -# OSGDB_LIBRARY - The osgDB library -# OSGDB_LIBRARY_DEBUG - The osgDB debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgDB +# --------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgDB This module defines +# +# OSGDB_FOUND - Was osgDB found? OSGDB_INCLUDE_DIR - Where to find the +# headers OSGDB_LIBRARIES - The libraries to link against for the osgDB +# (use this) +# +# OSGDB_LIBRARY - The osgDB library OSGDB_LIBRARY_DEBUG - The osgDB +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgFX.cmake b/Modules/FindosgFX.cmake index 1f1d59f..7b2cb76 100644 --- a/Modules/FindosgFX.cmake +++ b/Modules/FindosgFX.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgFX -# This module defines -# -# OSGFX_FOUND - Was osgFX found? -# OSGFX_INCLUDE_DIR - Where to find the headers -# OSGFX_LIBRARIES - The libraries to link against for the osgFX (use this) -# -# OSGFX_LIBRARY - The osgFX library -# OSGFX_LIBRARY_DEBUG - The osgFX debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgFX +# --------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgFX This module defines +# +# OSGFX_FOUND - Was osgFX found? OSGFX_INCLUDE_DIR - Where to find the +# headers OSGFX_LIBRARIES - The libraries to link against for the osgFX +# (use this) +# +# OSGFX_LIBRARY - The osgFX library OSGFX_LIBRARY_DEBUG - The osgFX +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgGA.cmake b/Modules/FindosgGA.cmake index e60f7f5..2e80ff2 100644 --- a/Modules/FindosgGA.cmake +++ b/Modules/FindosgGA.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgGA -# This module defines -# -# OSGGA_FOUND - Was osgGA found? -# OSGGA_INCLUDE_DIR - Where to find the headers -# OSGGA_LIBRARIES - The libraries to link against for the osgGA (use this) -# -# OSGGA_LIBRARY - The osgGA library -# OSGGA_LIBRARY_DEBUG - The osgGA debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgGA +# --------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgGA This module defines +# +# OSGGA_FOUND - Was osgGA found? OSGGA_INCLUDE_DIR - Where to find the +# headers OSGGA_LIBRARIES - The libraries to link against for the osgGA +# (use this) +# +# OSGGA_LIBRARY - The osgGA library OSGGA_LIBRARY_DEBUG - The osgGA +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgIntrospection.cmake b/Modules/FindosgIntrospection.cmake index a430ad6..1b52a6a 100644 --- a/Modules/FindosgIntrospection.cmake +++ b/Modules/FindosgIntrospection.cmake @@ -1,27 +1,32 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgINTROSPECTION -# This module defines +#.rst: +# FindosgIntrospection +# -------------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgINTROSPECTION This module defines # # OSGINTROSPECTION_FOUND - Was osgIntrospection found? # OSGINTROSPECTION_INCLUDE_DIR - Where to find the headers -# OSGINTROSPECTION_LIBRARIES - The libraries to link for osgIntrospection (use this) +# OSGINTROSPECTION_LIBRARIES - The libraries to link for +# osgIntrospection (use this) # # OSGINTROSPECTION_LIBRARY - The osgIntrospection library # OSGINTROSPECTION_LIBRARY_DEBUG - The osgIntrospection debug library # -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgManipulator.cmake b/Modules/FindosgManipulator.cmake index 32d6def..6f54082 100644 --- a/Modules/FindosgManipulator.cmake +++ b/Modules/FindosgManipulator.cmake @@ -1,27 +1,32 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgManipulator -# This module defines +#.rst: +# FindosgManipulator +# ------------------ +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgManipulator This module defines # # OSGMANIPULATOR_FOUND - Was osgManipulator found? # OSGMANIPULATOR_INCLUDE_DIR - Where to find the headers -# OSGMANIPULATOR_LIBRARIES - The libraries to link for osgManipulator (use this) +# OSGMANIPULATOR_LIBRARIES - The libraries to link for osgManipulator +# (use this) # # OSGMANIPULATOR_LIBRARY - The osgManipulator library # OSGMANIPULATOR_LIBRARY_DEBUG - The osgManipulator debug library # -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgParticle.cmake b/Modules/FindosgParticle.cmake index 1a6ae0b..82e9a13 100644 --- a/Modules/FindosgParticle.cmake +++ b/Modules/FindosgParticle.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgParticle -# This module defines -# -# OSGPARTICLE_FOUND - Was osgParticle found? -# OSGPARTICLE_INCLUDE_DIR - Where to find the headers -# OSGPARTICLE_LIBRARIES - The libraries to link for osgParticle (use this) +#.rst: +# FindosgParticle +# --------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgParticle This module defines +# +# OSGPARTICLE_FOUND - Was osgParticle found? OSGPARTICLE_INCLUDE_DIR - +# Where to find the headers OSGPARTICLE_LIBRARIES - The libraries to +# link for osgParticle (use this) # # OSGPARTICLE_LIBRARY - The osgParticle library # OSGPARTICLE_LIBRARY_DEBUG - The osgParticle debug library # -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgPresentation.cmake b/Modules/FindosgPresentation.cmake index 412502a..1cd57b3 100644 --- a/Modules/FindosgPresentation.cmake +++ b/Modules/FindosgPresentation.cmake @@ -1,30 +1,35 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgPresentation -# This module defines +#.rst: +# FindosgPresentation +# ------------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgPresentation This module defines # # OSGPRESENTATION_FOUND - Was osgPresentation found? # OSGPRESENTATION_INCLUDE_DIR - Where to find the headers -# OSGPRESENTATION_LIBRARIES - The libraries to link for osgPresentation (use this) +# OSGPRESENTATION_LIBRARIES - The libraries to link for osgPresentation +# (use this) # # OSGPRESENTATION_LIBRARY - The osgPresentation library # OSGPRESENTATION_LIBRARY_DEBUG - The osgPresentation debug library # -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # -# Created by Eric Wing. -# Modified to work with osgPresentation by Robert Osfield, January 2012. +# Created by Eric Wing. Modified to work with osgPresentation by Robert +# Osfield, January 2012. #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindosgProducer.cmake b/Modules/FindosgProducer.cmake index ea561a0..ad4902b 100644 --- a/Modules/FindosgProducer.cmake +++ b/Modules/FindosgProducer.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgProducer -# This module defines -# -# OSGPRODUCER_FOUND - Was osgProducer found? -# OSGPRODUCER_INCLUDE_DIR - Where to find the headers -# OSGPRODUCER_LIBRARIES - The libraries to link for osgProducer (use this) +#.rst: +# FindosgProducer +# --------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgProducer This module defines +# +# OSGPRODUCER_FOUND - Was osgProducer found? OSGPRODUCER_INCLUDE_DIR - +# Where to find the headers OSGPRODUCER_LIBRARIES - The libraries to +# link for osgProducer (use this) # # OSGPRODUCER_LIBRARY - The osgProducer library # OSGPRODUCER_LIBRARY_DEBUG - The osgProducer debug library # -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgQt.cmake b/Modules/FindosgQt.cmake index c7e8fee..b5c1718 100644 --- a/Modules/FindosgQt.cmake +++ b/Modules/FindosgQt.cmake @@ -1,30 +1,33 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgQt -# This module defines -# -# OSGQT_FOUND - Was osgQt found? -# OSGQT_INCLUDE_DIR - Where to find the headers -# OSGQT_LIBRARIES - The libraries to link for osgQt (use this) -# -# OSGQT_LIBRARY - The osgQt library -# OSGQT_LIBRARY_DEBUG - The osgQt debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. -# -# Created by Eric Wing. -# Modified to work with osgQt by Robert Osfield, January 2012. +#.rst: +# FindosgQt +# --------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgQt This module defines +# +# OSGQT_FOUND - Was osgQt found? OSGQT_INCLUDE_DIR - Where to find the +# headers OSGQT_LIBRARIES - The libraries to link for osgQt (use this) +# +# OSGQT_LIBRARY - The osgQt library OSGQT_LIBRARY_DEBUG - The osgQt +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. +# +# Created by Eric Wing. Modified to work with osgQt by Robert Osfield, +# January 2012. #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/FindosgShadow.cmake b/Modules/FindosgShadow.cmake index f3be0bf..b0d22e7 100644 --- a/Modules/FindosgShadow.cmake +++ b/Modules/FindosgShadow.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgShadow -# This module defines -# -# OSGSHADOW_FOUND - Was osgShadow found? -# OSGSHADOW_INCLUDE_DIR - Where to find the headers -# OSGSHADOW_LIBRARIES - The libraries to link for osgShadow (use this) -# -# OSGSHADOW_LIBRARY - The osgShadow library -# OSGSHADOW_LIBRARY_DEBUG - The osgShadow debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgShadow +# ------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgShadow This module defines +# +# OSGSHADOW_FOUND - Was osgShadow found? OSGSHADOW_INCLUDE_DIR - Where +# to find the headers OSGSHADOW_LIBRARIES - The libraries to link for +# osgShadow (use this) +# +# OSGSHADOW_LIBRARY - The osgShadow library OSGSHADOW_LIBRARY_DEBUG - +# The osgShadow debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgSim.cmake b/Modules/FindosgSim.cmake index 19cd175..ce088dc 100644 --- a/Modules/FindosgSim.cmake +++ b/Modules/FindosgSim.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgSim -# This module defines -# -# OSGSIM_FOUND - Was osgSim found? -# OSGSIM_INCLUDE_DIR - Where to find the headers -# OSGSIM_LIBRARIES - The libraries to link for osgSim (use this) -# -# OSGSIM_LIBRARY - The osgSim library -# OSGSIM_LIBRARY_DEBUG - The osgSim debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgSim +# ---------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgSim This module defines +# +# OSGSIM_FOUND - Was osgSim found? OSGSIM_INCLUDE_DIR - Where to find +# the headers OSGSIM_LIBRARIES - The libraries to link for osgSim (use +# this) +# +# OSGSIM_LIBRARY - The osgSim library OSGSIM_LIBRARY_DEBUG - The osgSim +# debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgTerrain.cmake b/Modules/FindosgTerrain.cmake index 4b7249e..bfde773 100644 --- a/Modules/FindosgTerrain.cmake +++ b/Modules/FindosgTerrain.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgTerrain -# This module defines -# -# OSGTERRAIN_FOUND - Was osgTerrain found? -# OSGTERRAIN_INCLUDE_DIR - Where to find the headers -# OSGTERRAIN_LIBRARIES - The libraries to link for osgTerrain (use this) -# -# OSGTERRAIN_LIBRARY - The osgTerrain library -# OSGTERRAIN_LIBRARY_DEBUG - The osgTerrain debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgTerrain +# -------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgTerrain This module defines +# +# OSGTERRAIN_FOUND - Was osgTerrain found? OSGTERRAIN_INCLUDE_DIR - +# Where to find the headers OSGTERRAIN_LIBRARIES - The libraries to link +# for osgTerrain (use this) +# +# OSGTERRAIN_LIBRARY - The osgTerrain library OSGTERRAIN_LIBRARY_DEBUG - +# The osgTerrain debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgText.cmake b/Modules/FindosgText.cmake index 41683c7..32cd115 100644 --- a/Modules/FindosgText.cmake +++ b/Modules/FindosgText.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgText -# This module defines -# -# OSGTEXT_FOUND - Was osgText found? -# OSGTEXT_INCLUDE_DIR - Where to find the headers -# OSGTEXT_LIBRARIES - The libraries to link for osgText (use this) -# -# OSGTEXT_LIBRARY - The osgText library -# OSGTEXT_LIBRARY_DEBUG - The osgText debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgText +# ----------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgText This module defines +# +# OSGTEXT_FOUND - Was osgText found? OSGTEXT_INCLUDE_DIR - Where to find +# the headers OSGTEXT_LIBRARIES - The libraries to link for osgText (use +# this) +# +# OSGTEXT_LIBRARY - The osgText library OSGTEXT_LIBRARY_DEBUG - The +# osgText debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgUtil.cmake b/Modules/FindosgUtil.cmake index 85c1177..9797425 100644 --- a/Modules/FindosgUtil.cmake +++ b/Modules/FindosgUtil.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgUtil -# This module defines -# -# OSGUTIL_FOUND - Was osgUtil found? -# OSGUTIL_INCLUDE_DIR - Where to find the headers -# OSGUTIL_LIBRARIES - The libraries to link for osgUtil (use this) -# -# OSGUTIL_LIBRARY - The osgUtil library -# OSGUTIL_LIBRARY_DEBUG - The osgUtil debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgUtil +# ----------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgUtil This module defines +# +# OSGUTIL_FOUND - Was osgUtil found? OSGUTIL_INCLUDE_DIR - Where to find +# the headers OSGUTIL_LIBRARIES - The libraries to link for osgUtil (use +# this) +# +# OSGUTIL_LIBRARY - The osgUtil library OSGUTIL_LIBRARY_DEBUG - The +# osgUtil debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgViewer.cmake b/Modules/FindosgViewer.cmake index d2252f4..b355530 100644 --- a/Modules/FindosgViewer.cmake +++ b/Modules/FindosgViewer.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgViewer -# This module defines -# -# OSGVIEWER_FOUND - Was osgViewer found? -# OSGVIEWER_INCLUDE_DIR - Where to find the headers -# OSGVIEWER_LIBRARIES - The libraries to link for osgViewer (use this) -# -# OSGVIEWER_LIBRARY - The osgViewer library -# OSGVIEWER_LIBRARY_DEBUG - The osgViewer debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgViewer +# ------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgViewer This module defines +# +# OSGVIEWER_FOUND - Was osgViewer found? OSGVIEWER_INCLUDE_DIR - Where +# to find the headers OSGVIEWER_LIBRARIES - The libraries to link for +# osgViewer (use this) +# +# OSGVIEWER_LIBRARY - The osgViewer library OSGVIEWER_LIBRARY_DEBUG - +# The osgViewer debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgVolume.cmake b/Modules/FindosgVolume.cmake index ae2d95c..8d3ad6c 100644 --- a/Modules/FindosgVolume.cmake +++ b/Modules/FindosgVolume.cmake @@ -1,27 +1,31 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgVolume -# This module defines -# -# OSGVOLUME_FOUND - Was osgVolume found? -# OSGVOLUME_INCLUDE_DIR - Where to find the headers -# OSGVOLUME_LIBRARIES - The libraries to link for osgVolume (use this) -# -# OSGVOLUME_LIBRARY - The osgVolume library -# OSGVOLUME_LIBRARY_DEBUG - The osgVolume debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. +#.rst: +# FindosgVolume +# ------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgVolume This module defines +# +# OSGVOLUME_FOUND - Was osgVolume found? OSGVOLUME_INCLUDE_DIR - Where +# to find the headers OSGVOLUME_LIBRARIES - The libraries to link for +# osgVolume (use this) +# +# OSGVOLUME_LIBRARY - The osgVolume library OSGVOLUME_LIBRARY_DEBUG - +# The osgVolume debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. # # Created by Eric Wing. diff --git a/Modules/FindosgWidget.cmake b/Modules/FindosgWidget.cmake index cb2e12f..ec3c3bc 100644 --- a/Modules/FindosgWidget.cmake +++ b/Modules/FindosgWidget.cmake @@ -1,29 +1,34 @@ -# This is part of the Findosg* suite used to find OpenSceneGraph components. -# Each component is separate and you must opt in to each module. You must -# also opt into OpenGL and OpenThreads (and Producer if needed) as these -# modules won't do it for you. This is to allow you control over your own -# system piece by piece in case you need to opt out of certain components -# or change the Find behavior for a particular module (perhaps because the -# default FindOpenGL.cmake module doesn't work with your system as an -# example). -# If you want to use a more convenient module that includes everything, -# use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. -# -# Locate osgWidget -# This module defines -# -# OSGWIDGET_FOUND - Was osgWidget found? -# OSGWIDGET_INCLUDE_DIR - Where to find the headers -# OSGWIDGET_LIBRARIES - The libraries to link for osgWidget (use this) -# -# OSGWIDGET_LIBRARY - The osgWidget library -# OSGWIDGET_LIBRARY_DEBUG - The osgWidget debug library -# -# $OSGDIR is an environment variable that would -# correspond to the ./configure --prefix=$OSGDIR -# used in building osg. -# -# FindosgWidget.cmake tweaked from Findosg* suite as created by Eric Wing. +#.rst: +# FindosgWidget +# ------------- +# +# +# +# This is part of the Findosg* suite used to find OpenSceneGraph +# components. Each component is separate and you must opt in to each +# module. You must also opt into OpenGL and OpenThreads (and Producer +# if needed) as these modules won't do it for you. This is to allow you +# control over your own system piece by piece in case you need to opt +# out of certain components or change the Find behavior for a particular +# module (perhaps because the default FindOpenGL.cmake module doesn't +# work with your system as an example). If you want to use a more +# convenient module that includes everything, use the +# FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +# +# Locate osgWidget This module defines +# +# OSGWIDGET_FOUND - Was osgWidget found? OSGWIDGET_INCLUDE_DIR - Where +# to find the headers OSGWIDGET_LIBRARIES - The libraries to link for +# osgWidget (use this) +# +# OSGWIDGET_LIBRARY - The osgWidget library OSGWIDGET_LIBRARY_DEBUG - +# The osgWidget debug library +# +# $OSGDIR is an environment variable that would correspond to the +# ./configure --prefix=$OSGDIR used in building osg. +# +# FindosgWidget.cmake tweaked from Findosg* suite as created by Eric +# Wing. #============================================================================= # Copyright 2007-2009 Kitware, Inc. diff --git a/Modules/Findosg_functions.cmake b/Modules/Findosg_functions.cmake index 2e90837..d10fae9 100644 --- a/Modules/Findosg_functions.cmake +++ b/Modules/Findosg_functions.cmake @@ -1,8 +1,14 @@ +#.rst: +# Findosg_functions +# ----------------- +# +# +# +# # # This CMake file contains two macros to assist with searching for OSG # libraries and nodekits. Please see FindOpenSceneGraph.cmake for full # documentation. -# #============================================================================= # Copyright 2009 Kitware, Inc. diff --git a/Modules/FindwxWidgets.cmake b/Modules/FindwxWidgets.cmake index 28c1b64..4ecab62 100644 --- a/Modules/FindwxWidgets.cmake +++ b/Modules/FindwxWidgets.cmake @@ -1,79 +1,108 @@ -# - Find a wxWidgets (a.k.a., wxWindows) installation. +#.rst: +# FindwxWidgets +# ------------- +# +# Find a wxWidgets (a.k.a., wxWindows) installation. +# # This module finds if wxWidgets is installed and selects a default -# configuration to use. wxWidgets is a modular library. To specify the -# modules that you will use, you need to name them as components to -# the package: +# configuration to use. wxWidgets is a modular library. To specify the +# modules that you will use, you need to name them as components to the +# package: # # find_package(wxWidgets COMPONENTS core base ...) # -# There are two search branches: a windows style and a unix style. For -# windows, the following variables are searched for and set to -# defaults in case of multiple choices. Change them if the defaults -# are not desired (i.e., these are the only variables you should -# change to select a configuration): +# There are two search branches: a windows style and a unix style. For +# windows, the following variables are searched for and set to defaults +# in case of multiple choices. Change them if the defaults are not +# desired (i.e., these are the only variables you should change to +# select a configuration): +# +# :: +# +# wxWidgets_ROOT_DIR - Base wxWidgets directory +# (e.g., C:/wxWidgets-2.6.3). +# wxWidgets_LIB_DIR - Path to wxWidgets libraries +# (e.g., C:/wxWidgets-2.6.3/lib/vc_lib). +# wxWidgets_CONFIGURATION - Configuration to use +# (e.g., msw, mswd, mswu, mswunivud, etc.) +# wxWidgets_EXCLUDE_COMMON_LIBRARIES +# - Set to TRUE to exclude linking of +# commonly required libs (e.g., png tiff +# jpeg zlib regex expat). +# # -# wxWidgets_ROOT_DIR - Base wxWidgets directory -# (e.g., C:/wxWidgets-2.6.3). -# wxWidgets_LIB_DIR - Path to wxWidgets libraries -# (e.g., C:/wxWidgets-2.6.3/lib/vc_lib). -# wxWidgets_CONFIGURATION - Configuration to use -# (e.g., msw, mswd, mswu, mswunivud, etc.) -# wxWidgets_EXCLUDE_COMMON_LIBRARIES -# - Set to TRUE to exclude linking of -# commonly required libs (e.g., png tiff -# jpeg zlib regex expat). # -# For unix style it uses the wx-config utility. You can select between +# For unix style it uses the wx-config utility. You can select between # debug/release, unicode/ansi, universal/non-universal, and # static/shared in the QtDialog or ccmake interfaces by turning ON/OFF # the following variables: # -# wxWidgets_USE_DEBUG -# wxWidgets_USE_UNICODE -# wxWidgets_USE_UNIVERSAL -# wxWidgets_USE_STATIC +# :: +# +# wxWidgets_USE_DEBUG +# wxWidgets_USE_UNICODE +# wxWidgets_USE_UNIVERSAL +# wxWidgets_USE_STATIC +# +# # # There is also a wxWidgets_CONFIG_OPTIONS variable for all other -# options that need to be passed to the wx-config utility. For -# example, to use the base toolkit found in the /usr/local path, set -# the variable (before calling the FIND_PACKAGE command) as such: +# options that need to be passed to the wx-config utility. For example, +# to use the base toolkit found in the /usr/local path, set the variable +# (before calling the FIND_PACKAGE command) as such: +# +# :: +# +# set(wxWidgets_CONFIG_OPTIONS --toolkit=base --prefix=/usr) # -# set(wxWidgets_CONFIG_OPTIONS --toolkit=base --prefix=/usr) # -# The following are set after the configuration is done for both -# windows and unix style: # -# wxWidgets_FOUND - Set to TRUE if wxWidgets was found. -# wxWidgets_INCLUDE_DIRS - Include directories for WIN32 -# i.e., where to find "wx/wx.h" and -# "wx/setup.h"; possibly empty for unices. -# wxWidgets_LIBRARIES - Path to the wxWidgets libraries. -# wxWidgets_LIBRARY_DIRS - compile time link dirs, useful for -# rpath on UNIX. Typically an empty string -# in WIN32 environment. -# wxWidgets_DEFINITIONS - Contains defines required to compile/link -# against WX, e.g. WXUSINGDLL -# wxWidgets_DEFINITIONS_DEBUG- Contains defines required to compile/link -# against WX debug builds, e.g. __WXDEBUG__ -# wxWidgets_CXX_FLAGS - Include dirs and compiler flags for -# unices, empty on WIN32. Essentially -# "`wx-config --cxxflags`". -# wxWidgets_USE_FILE - Convenience include file. +# The following are set after the configuration is done for both windows +# and unix style: +# +# :: +# +# wxWidgets_FOUND - Set to TRUE if wxWidgets was found. +# wxWidgets_INCLUDE_DIRS - Include directories for WIN32 +# i.e., where to find "wx/wx.h" and +# "wx/setup.h"; possibly empty for unices. +# wxWidgets_LIBRARIES - Path to the wxWidgets libraries. +# wxWidgets_LIBRARY_DIRS - compile time link dirs, useful for +# rpath on UNIX. Typically an empty string +# in WIN32 environment. +# wxWidgets_DEFINITIONS - Contains defines required to compile/link +# against WX, e.g. WXUSINGDLL +# wxWidgets_DEFINITIONS_DEBUG- Contains defines required to compile/link +# against WX debug builds, e.g. __WXDEBUG__ +# wxWidgets_CXX_FLAGS - Include dirs and compiler flags for +# unices, empty on WIN32. Essentially +# "`wx-config --cxxflags`". +# wxWidgets_USE_FILE - Convenience include file. +# +# # # Sample usage: -# # Note that for MinGW users the order of libs is important! -# find_package(wxWidgets COMPONENTS net gl core base) -# if(wxWidgets_FOUND) -# include(${wxWidgets_USE_FILE}) -# # and for each of your dependent executable/library targets: -# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) -# endif() +# +# :: +# +# # Note that for MinGW users the order of libs is important! +# find_package(wxWidgets COMPONENTS net gl core base) +# if(wxWidgets_FOUND) +# include(${wxWidgets_USE_FILE}) +# # and for each of your dependent executable/library targets: +# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) +# endif() +# +# # # If wxWidgets is required (i.e., not an optional part): -# find_package(wxWidgets REQUIRED net gl core base) -# include(${wxWidgets_USE_FILE}) -# # and for each of your dependent executable/library targets: -# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) +# +# :: +# +# find_package(wxWidgets REQUIRED net gl core base) +# include(${wxWidgets_USE_FILE}) +# # and for each of your dependent executable/library targets: +# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/FindwxWindows.cmake b/Modules/FindwxWindows.cmake index 868d20c..6e441c3 100644 --- a/Modules/FindwxWindows.cmake +++ b/Modules/FindwxWindows.cmake @@ -1,51 +1,81 @@ -# - Find wxWindows (wxWidgets) installation -# This module finds if wxWindows/wxWidgets is installed and determines where -# the include files and libraries are. It also determines what the name of -# the library is. -# Please note this file is DEPRECATED and replaced by FindwxWidgets.cmake. -# This code sets the following variables: -# -# WXWINDOWS_FOUND = system has WxWindows -# WXWINDOWS_LIBRARIES = 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`" -# on Linux -# WXWINDOWS_INCLUDE_DIR = where to find "wx/wx.h" and "wx/setup.h" -# WXWINDOWS_LINK_DIRECTORIES = link directories, useful for rpath on -# Unix -# WXWINDOWS_DEFINITIONS = extra defines -# -# OPTIONS -# If you need OpenGL support please -# set(WXWINDOWS_USE_GL 1) +#.rst: +# FindwxWindows +# ------------- +# +# Find wxWindows (wxWidgets) installation +# +# This module finds if wxWindows/wxWidgets is installed and determines +# where the include files and libraries are. It also determines what +# the name of the library is. Please note this file is DEPRECATED and +# replaced by FindwxWidgets.cmake. This code sets the following +# variables: +# +# :: +# +# WXWINDOWS_FOUND = system has WxWindows +# WXWINDOWS_LIBRARIES = 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`" +# on Linux +# WXWINDOWS_INCLUDE_DIR = where to find "wx/wx.h" and "wx/setup.h" +# WXWINDOWS_LINK_DIRECTORIES = link directories, useful for rpath on +# Unix +# WXWINDOWS_DEFINITIONS = extra defines +# +# +# +# OPTIONS If you need OpenGL support please +# +# :: +# +# set(WXWINDOWS_USE_GL 1) +# # in your CMakeLists.txt *before* you include this file. # -# HAVE_ISYSTEM - true required to replace -I by -isystem on g++ +# :: +# +# HAVE_ISYSTEM - true required to replace -I by -isystem on g++ +# +# # # For convenience include Use_wxWindows.cmake in your project's -# CMakeLists.txt using include(${CMAKE_CURRENT_LIST_DIR}/Use_wxWindows.cmake). +# CMakeLists.txt using +# include(${CMAKE_CURRENT_LIST_DIR}/Use_wxWindows.cmake). # # USAGE -# set(WXWINDOWS_USE_GL 1) -# find_package(wxWindows) # -# NOTES -# wxWidgets 2.6.x is supported for monolithic builds -# e.g. compiled in wx/build/msw dir as: -# nmake -f makefile.vc BUILD=debug SHARED=0 USE_OPENGL=1 MONOLITHIC=1 +# :: +# +# set(WXWINDOWS_USE_GL 1) +# find_package(wxWindows) +# +# +# +# NOTES wxWidgets 2.6.x is supported for monolithic builds e.g. +# compiled in wx/build/msw dir as: +# +# :: +# +# nmake -f makefile.vc BUILD=debug SHARED=0 USE_OPENGL=1 MONOLITHIC=1 +# +# # # DEPRECATED # -# CMAKE_WX_CAN_COMPILE -# WXWINDOWS_LIBRARY -# CMAKE_WX_CXX_FLAGS -# WXWINDOWS_INCLUDE_PATH +# :: +# +# CMAKE_WX_CAN_COMPILE +# WXWINDOWS_LIBRARY +# CMAKE_WX_CXX_FLAGS +# WXWINDOWS_INCLUDE_PATH +# +# # -# AUTHOR -# Jan Woetzel <http://www.mip.informatik.uni-kiel.de/~jw> (07/2003-01/2006) +# AUTHOR Jan Woetzel <http://www.mip.informatik.uni-kiel.de/~jw> +# (07/2003-01/2006) #============================================================================= # Copyright 2000-2009 Kitware, Inc. diff --git a/Modules/FortranCInterface.cmake b/Modules/FortranCInterface.cmake index c59e1f8..dccb26f 100644 --- a/Modules/FortranCInterface.cmake +++ b/Modules/FortranCInterface.cmake @@ -1,85 +1,129 @@ -# - Fortran/C Interface Detection +#.rst: +# FortranCInterface +# ----------------- +# +# Fortran/C Interface Detection +# # This module automatically detects the API by which C and Fortran # languages interact. Variables indicate if the mangling is found: -# FortranCInterface_GLOBAL_FOUND = Global subroutines and functions -# FortranCInterface_MODULE_FOUND = Module subroutines and functions -# (declared by "MODULE PROCEDURE") +# +# :: +# +# FortranCInterface_GLOBAL_FOUND = Global subroutines and functions +# FortranCInterface_MODULE_FOUND = Module subroutines and functions +# (declared by "MODULE PROCEDURE") +# # A function is provided to generate a C header file containing macros # to mangle symbol names: -# FortranCInterface_HEADER(<file> -# [MACRO_NAMESPACE <macro-ns>] -# [SYMBOL_NAMESPACE <ns>] -# [SYMBOLS [<module>:]<function> ...]) +# +# :: +# +# FortranCInterface_HEADER(<file> +# [MACRO_NAMESPACE <macro-ns>] +# [SYMBOL_NAMESPACE <ns>] +# [SYMBOLS [<module>:]<function> ...]) +# # It generates in <file> definitions of the following macros: -# #define FortranCInterface_GLOBAL (name,NAME) ... -# #define FortranCInterface_GLOBAL_(name,NAME) ... -# #define FortranCInterface_MODULE (mod,name, MOD,NAME) ... -# #define FortranCInterface_MODULE_(mod,name, MOD,NAME) ... -# These macros mangle four categories of Fortran symbols, -# respectively: -# - Global symbols without '_': call mysub() -# - Global symbols with '_' : call my_sub() -# - Module symbols without '_': use mymod; call mysub() -# - Module symbols with '_' : use mymod; call my_sub() +# +# :: +# +# #define FortranCInterface_GLOBAL (name,NAME) ... +# #define FortranCInterface_GLOBAL_(name,NAME) ... +# #define FortranCInterface_MODULE (mod,name, MOD,NAME) ... +# #define FortranCInterface_MODULE_(mod,name, MOD,NAME) ... +# +# These macros mangle four categories of Fortran symbols, respectively: +# +# :: +# +# - Global symbols without '_': call mysub() +# - Global symbols with '_' : call my_sub() +# - Module symbols without '_': use mymod; call mysub() +# - Module symbols with '_' : use mymod; call my_sub() +# # If mangling for a category is not known, its macro is left undefined. -# All macros require raw names in both lower case and upper case. -# The MACRO_NAMESPACE option replaces the default "FortranCInterface_" +# All macros require raw names in both lower case and upper case. The +# MACRO_NAMESPACE option replaces the default "FortranCInterface_" # prefix with a given namespace "<macro-ns>". # # The SYMBOLS option lists symbols to mangle automatically with C # preprocessor definitions: -# <function> ==> #define <ns><function> ... -# <module>:<function> ==> #define <ns><module>_<function> ... +# +# :: +# +# <function> ==> #define <ns><function> ... +# <module>:<function> ==> #define <ns><module>_<function> ... +# # If the mangling for some symbol is not known then no preprocessor -# definition is created, and a warning is displayed. -# The SYMBOL_NAMESPACE option prefixes all preprocessor definitions +# definition is created, and a warning is displayed. The +# SYMBOL_NAMESPACE option prefixes all preprocessor definitions # generated by the SYMBOLS option with a given namespace "<ns>". # # Example usage: -# include(FortranCInterface) -# FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_") -# This creates a "FC.h" header that defines mangling macros -# FC_GLOBAL(), FC_GLOBAL_(), FC_MODULE(), and FC_MODULE_(). +# +# :: +# +# include(FortranCInterface) +# FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_") +# +# This creates a "FC.h" header that defines mangling macros FC_GLOBAL(), +# FC_GLOBAL_(), FC_MODULE(), and FC_MODULE_(). # # Example usage: -# include(FortranCInterface) -# FortranCInterface_HEADER(FCMangle.h -# MACRO_NAMESPACE "FC_" -# SYMBOL_NAMESPACE "FC_" -# SYMBOLS mysub mymod:my_sub) +# +# :: +# +# include(FortranCInterface) +# FortranCInterface_HEADER(FCMangle.h +# MACRO_NAMESPACE "FC_" +# SYMBOL_NAMESPACE "FC_" +# SYMBOLS mysub mymod:my_sub) +# # This creates a "FCMangle.h" header that defines the same FC_*() # mangling macros as the previous example plus preprocessor symbols # FC_mysub and FC_mymod_my_sub. # # Another function is provided to verify that the Fortran and C/C++ # compilers work together: -# FortranCInterface_VERIFY([CXX] [QUIET]) -# It tests whether a simple test executable using Fortran and C (and -# C++ when the CXX option is given) compiles and links successfully. -# The result is stored in the cache entry FortranCInterface_VERIFIED_C -# (or FortranCInterface_VERIFIED_CXX if CXX is given) as a boolean. -# If the check fails and QUIET is not given the function terminates -# with a FATAL_ERROR message describing the problem. The purpose of -# this check is to stop a build early for incompatible compiler -# combinations. The test is built in the Release configuration. -# -# FortranCInterface is aware of possible GLOBAL and MODULE manglings -# for many Fortran compilers, but it also provides an interface to -# specify new possible manglings. Set the variables -# FortranCInterface_GLOBAL_SYMBOLS -# FortranCInterface_MODULE_SYMBOLS -# before including FortranCInterface to specify manglings of the -# symbols "MySub", "My_Sub", "MyModule:MySub", and "My_Module:My_Sub". -# For example, the code: -# set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_) -# # ^^^^^ ^^^^^^ ^^^^^ -# set(FortranCInterface_MODULE_SYMBOLS -# __mymodule_MOD_mysub __my_module_MOD_my_sub) -# # ^^^^^^^^ ^^^^^ ^^^^^^^^^ ^^^^^^ -# include(FortranCInterface) +# +# :: +# +# FortranCInterface_VERIFY([CXX] [QUIET]) +# +# It tests whether a simple test executable using Fortran and C (and C++ +# when the CXX option is given) compiles and links successfully. The +# result is stored in the cache entry FortranCInterface_VERIFIED_C (or +# FortranCInterface_VERIFIED_CXX if CXX is given) as a boolean. If the +# check fails and QUIET is not given the function terminates with a +# FATAL_ERROR message describing the problem. The purpose of this check +# is to stop a build early for incompatible compiler combinations. The +# test is built in the Release configuration. +# +# FortranCInterface is aware of possible GLOBAL and MODULE manglings for +# many Fortran compilers, but it also provides an interface to specify +# new possible manglings. Set the variables +# +# :: +# +# FortranCInterface_GLOBAL_SYMBOLS +# FortranCInterface_MODULE_SYMBOLS +# +# before including FortranCInterface to specify manglings of the symbols +# "MySub", "My_Sub", "MyModule:MySub", and "My_Module:My_Sub". For +# example, the code: +# +# :: +# +# set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_) +# # ^^^^^ ^^^^^^ ^^^^^ +# set(FortranCInterface_MODULE_SYMBOLS +# __mymodule_MOD_mysub __my_module_MOD_my_sub) +# # ^^^^^^^^ ^^^^^ ^^^^^^^^^ ^^^^^^ +# include(FortranCInterface) +# # tells FortranCInterface to try given GLOBAL and MODULE manglings. -# (The carets point at raw symbol names for clarity in this example -# but are not needed.) +# (The carets point at raw symbol names for clarity in this example but +# are not needed.) #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/GNUInstallDirs.cmake b/Modules/GNUInstallDirs.cmake index 0302e4b..c8d77c6 100644 --- a/Modules/GNUInstallDirs.cmake +++ b/Modules/GNUInstallDirs.cmake @@ -1,32 +1,49 @@ -# - Define GNU standard installation directories +#.rst: +# GNUInstallDirs +# -------------- +# +# Define GNU standard installation directories +# # Provides install directory variables as defined for GNU software: -# http://www.gnu.org/prep/standards/html_node/Directory-Variables.html +# +# :: +# +# http://www.gnu.org/prep/standards/html_node/Directory-Variables.html +# # Inclusion of this module defines the following variables: -# CMAKE_INSTALL_<dir> - destination for files of a given type -# CMAKE_INSTALL_FULL_<dir> - corresponding absolute path +# +# :: +# +# CMAKE_INSTALL_<dir> - destination for files of a given type +# CMAKE_INSTALL_FULL_<dir> - corresponding absolute path +# # where <dir> is one of: -# BINDIR - user executables (bin) -# SBINDIR - system admin executables (sbin) -# LIBEXECDIR - program executables (libexec) -# SYSCONFDIR - read-only single-machine data (etc) -# SHAREDSTATEDIR - modifiable architecture-independent data (com) -# LOCALSTATEDIR - modifiable single-machine data (var) -# LIBDIR - object code libraries (lib or lib64 or lib/<multiarch-tuple> on Debian) -# INCLUDEDIR - C header files (include) -# OLDINCLUDEDIR - C header files for non-gcc (/usr/include) -# DATAROOTDIR - read-only architecture-independent data root (share) -# DATADIR - read-only architecture-independent data (DATAROOTDIR) -# INFODIR - info documentation (DATAROOTDIR/info) -# LOCALEDIR - locale-dependent data (DATAROOTDIR/locale) -# MANDIR - man documentation (DATAROOTDIR/man) -# DOCDIR - documentation root (DATAROOTDIR/doc/PROJECT_NAME) -# Each CMAKE_INSTALL_<dir> value may be passed to the DESTINATION options of -# install() commands for the corresponding file type. If the includer does -# not define a value the above-shown default will be used and the value will -# appear in the cache for editing by the user. -# Each CMAKE_INSTALL_FULL_<dir> value contains an absolute path constructed -# from the corresponding destination by prepending (if necessary) the value -# of CMAKE_INSTALL_PREFIX. +# +# :: +# +# BINDIR - user executables (bin) +# SBINDIR - system admin executables (sbin) +# LIBEXECDIR - program executables (libexec) +# SYSCONFDIR - read-only single-machine data (etc) +# SHAREDSTATEDIR - modifiable architecture-independent data (com) +# LOCALSTATEDIR - modifiable single-machine data (var) +# LIBDIR - object code libraries (lib or lib64 or lib/<multiarch-tuple> on Debian) +# INCLUDEDIR - C header files (include) +# OLDINCLUDEDIR - C header files for non-gcc (/usr/include) +# DATAROOTDIR - read-only architecture-independent data root (share) +# DATADIR - read-only architecture-independent data (DATAROOTDIR) +# INFODIR - info documentation (DATAROOTDIR/info) +# LOCALEDIR - locale-dependent data (DATAROOTDIR/locale) +# MANDIR - man documentation (DATAROOTDIR/man) +# DOCDIR - documentation root (DATAROOTDIR/doc/PROJECT_NAME) +# +# Each CMAKE_INSTALL_<dir> value may be passed to the DESTINATION +# options of install() commands for the corresponding file type. If the +# includer does not define a value the above-shown default will be used +# and the value will appear in the cache for editing by the user. Each +# CMAKE_INSTALL_FULL_<dir> value contains an absolute path constructed +# from the corresponding destination by prepending (if necessary) the +# value of CMAKE_INSTALL_PREFIX. #============================================================================= # Copyright 2011 Nikita Krupen'ko <krnekit@gmail.com> diff --git a/Modules/GenerateExportHeader.cmake b/Modules/GenerateExportHeader.cmake index b2fda09..5baf9e0 100644 --- a/Modules/GenerateExportHeader.cmake +++ b/Modules/GenerateExportHeader.cmake @@ -1,143 +1,195 @@ -# - Function for generation of export macros for libraries +#.rst: +# GenerateExportHeader +# -------------------- +# +# Function for generation of export macros for libraries +# # This module provides the function GENERATE_EXPORT_HEADER(). # -# The GENERATE_EXPORT_HEADER function can be used to generate a file suitable -# for preprocessor inclusion which contains EXPORT macros to be used in -# library classes. +# The GENERATE_EXPORT_HEADER function can be used to generate a file +# suitable for preprocessor inclusion which contains EXPORT macros to be +# used in library classes. # # GENERATE_EXPORT_HEADER( LIBRARY_TARGET -# [BASE_NAME <base_name>] -# [EXPORT_MACRO_NAME <export_macro_name>] -# [EXPORT_FILE_NAME <export_file_name>] -# [DEPRECATED_MACRO_NAME <deprecated_macro_name>] -# [NO_EXPORT_MACRO_NAME <no_export_macro_name>] -# [STATIC_DEFINE <static_define>] -# [NO_DEPRECATED_MACRO_NAME <no_deprecated_macro_name>] -# [DEFINE_NO_DEPRECATED] -# [PREFIX_NAME <prefix_name>] +# +# :: +# +# [BASE_NAME <base_name>] +# [EXPORT_MACRO_NAME <export_macro_name>] +# [EXPORT_FILE_NAME <export_file_name>] +# [DEPRECATED_MACRO_NAME <deprecated_macro_name>] +# [NO_EXPORT_MACRO_NAME <no_export_macro_name>] +# [STATIC_DEFINE <static_define>] +# [NO_DEPRECATED_MACRO_NAME <no_deprecated_macro_name>] +# [DEFINE_NO_DEPRECATED] +# [PREFIX_NAME <prefix_name>] +# # ) # -# The target properties CXX_VISIBILITY_PRESET and VISIBILITY_INLINES_HIDDEN -# can be used to add the appropriate compile flags for targets. See the -# documentation of those target properties, and the convenience variables -# CMAKE_CXX_VISIBILITY_PRESET and CMAKE_VISIBILITY_INLINES_HIDDEN. -# -# By default GENERATE_EXPORT_HEADER() generates macro names in a file name -# determined by the name of the library. This means that in the simplest case, -# users of generate_export_header will be equivalent to: -# -# set(CMAKE_CXX_VISIBILITY_PRESET hidden) -# set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) -# add_library(somelib someclass.cpp) -# generate_export_header(somelib) -# install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR}) -# install(FILES -# someclass.h -# ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR} -# ) +# The target properties CXX_VISIBILITY_PRESET and +# VISIBILITY_INLINES_HIDDEN can be used to add the appropriate compile +# flags for targets. See the documentation of those target properties, +# and the convenience variables CMAKE_CXX_VISIBILITY_PRESET and +# CMAKE_VISIBILITY_INLINES_HIDDEN. +# +# By default GENERATE_EXPORT_HEADER() generates macro names in a file +# name determined by the name of the library. This means that in the +# simplest case, users of generate_export_header will be equivalent to: +# +# :: +# +# set(CMAKE_CXX_VISIBILITY_PRESET hidden) +# set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) +# add_library(somelib someclass.cpp) +# generate_export_header(somelib) +# install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR}) +# install(FILES +# someclass.h +# ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR} +# ) +# +# # # And in the ABI header files: # -# #include "somelib_export.h" -# class SOMELIB_EXPORT SomeClass { -# ... -# }; +# :: +# +# #include "somelib_export.h" +# class SOMELIB_EXPORT SomeClass { +# ... +# }; # -# The CMake fragment will generate a file in the ${CMAKE_CURRENT_BINARY_DIR} -# called somelib_export.h containing the macros SOMELIB_EXPORT, SOMELIB_NO_EXPORT, -# SOMELIB_DEPRECATED, SOMELIB_DEPRECATED_EXPORT and SOMELIB_DEPRECATED_NO_EXPORT. -# The resulting file should be installed with other headers in the library. # -# The BASE_NAME argument can be used to override the file name and the names -# used for the macros # -# add_library(somelib someclass.cpp) -# generate_export_header(somelib -# BASE_NAME other_name -# ) +# The CMake fragment will generate a file in the +# ${CMAKE_CURRENT_BINARY_DIR} called somelib_export.h containing the +# macros SOMELIB_EXPORT, SOMELIB_NO_EXPORT, SOMELIB_DEPRECATED, +# SOMELIB_DEPRECATED_EXPORT and SOMELIB_DEPRECATED_NO_EXPORT. The +# resulting file should be installed with other headers in the library. +# +# The BASE_NAME argument can be used to override the file name and the +# names used for the macros +# +# :: +# +# add_library(somelib someclass.cpp) +# generate_export_header(somelib +# BASE_NAME other_name +# ) +# +# # # Generates a file called other_name_export.h containing the macros # OTHER_NAME_EXPORT, OTHER_NAME_NO_EXPORT and OTHER_NAME_DEPRECATED etc. # -# The BASE_NAME may be overridden by specifiying other options in the function. -# For example: +# The BASE_NAME may be overridden by specifiying other options in the +# function. For example: +# +# :: +# +# add_library(somelib someclass.cpp) +# generate_export_header(somelib +# EXPORT_MACRO_NAME OTHER_NAME_EXPORT +# ) +# +# +# +# creates the macro OTHER_NAME_EXPORT instead of SOMELIB_EXPORT, but +# other macros and the generated file name is as default. # -# add_library(somelib someclass.cpp) -# generate_export_header(somelib -# EXPORT_MACRO_NAME OTHER_NAME_EXPORT -# ) +# :: +# +# add_library(somelib someclass.cpp) +# generate_export_header(somelib +# DEPRECATED_MACRO_NAME KDE_DEPRECATED +# ) # -# creates the macro OTHER_NAME_EXPORT instead of SOMELIB_EXPORT, but other macros -# and the generated file name is as default. # -# add_library(somelib someclass.cpp) -# generate_export_header(somelib -# DEPRECATED_MACRO_NAME KDE_DEPRECATED -# ) # # creates the macro KDE_DEPRECATED instead of SOMELIB_DEPRECATED. # -# If LIBRARY_TARGET is a static library, macros are defined without values. +# If LIBRARY_TARGET is a static library, macros are defined without +# values. +# +# If the same sources are used to create both a shared and a static +# library, the uppercased symbol ${BASE_NAME}_STATIC_DEFINE should be +# used when building the static library +# +# :: +# +# add_library(shared_variant SHARED ${lib_SRCS}) +# add_library(static_variant ${lib_SRCS}) +# generate_export_header(shared_variant BASE_NAME libshared_and_static) +# set_target_properties(static_variant PROPERTIES +# COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE) +# +# # -# If the same sources are used to create both a shared and a static library, the -# uppercased symbol ${BASE_NAME}_STATIC_DEFINE should be used when building the -# static library +# This will cause the export macros to expand to nothing when building +# the static library. # -# add_library(shared_variant SHARED ${lib_SRCS}) -# add_library(static_variant ${lib_SRCS}) -# generate_export_header(shared_variant BASE_NAME libshared_and_static) -# set_target_properties(static_variant PROPERTIES -# COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE) +# If DEFINE_NO_DEPRECATED is specified, then a macro +# ${BASE_NAME}_NO_DEPRECATED will be defined This macro can be used to +# remove deprecated code from preprocessor output. # -# This will cause the export macros to expand to nothing when building the -# static library. +# :: +# +# option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE) +# if (EXCLUDE_DEPRECATED) +# set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED) +# endif() +# generate_export_header(somelib ${NO_BUILD_DEPRECATED}) # -# If DEFINE_NO_DEPRECATED is specified, then a macro ${BASE_NAME}_NO_DEPRECATED -# will be defined -# This macro can be used to remove deprecated code from preprocessor output. # -# option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE) -# if (EXCLUDE_DEPRECATED) -# set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED) -# endif() -# generate_export_header(somelib ${NO_BUILD_DEPRECATED}) # # And then in somelib: # -# class SOMELIB_EXPORT SomeClass -# { -# public: -# #ifndef SOMELIB_NO_DEPRECATED -# SOMELIB_DEPRECATED void oldMethod(); -# #endif -# }; +# :: +# +# class SOMELIB_EXPORT SomeClass +# { +# public: +# #ifndef SOMELIB_NO_DEPRECATED +# SOMELIB_DEPRECATED void oldMethod(); +# #endif +# }; +# +# +# +# :: # -# #ifndef SOMELIB_NO_DEPRECATED -# void SomeClass::oldMethod() { } -# #endif +# #ifndef SOMELIB_NO_DEPRECATED +# void SomeClass::oldMethod() { } +# #endif # -# If PREFIX_NAME is specified, the argument will be used as a prefix to all -# generated macros. +# +# +# If PREFIX_NAME is specified, the argument will be used as a prefix to +# all generated macros. # # For example: # -# generate_export_header(somelib PREFIX_NAME VTK_) +# :: +# +# generate_export_header(somelib PREFIX_NAME VTK_) +# +# # # Generates the macros VTK_SOMELIB_EXPORT etc. # # -# ADD_COMPILER_EXPORT_FLAGS( [<output_variable>] ) # -# The ADD_COMPILER_EXPORT_FLAGS function -# adds -fvisibility=hidden to CMAKE_CXX_FLAGS if supported, and is a no-op on -# Windows which does not need extra compiler flags for exporting support. You -# may optionally pass a single argument to ADD_COMPILER_EXPORT_FLAGS that will -# be populated with the required CXX_FLAGS required to enable visibility support -# for the compiler/architecture in use. +# ADD_COMPILER_EXPORT_FLAGS( [<output_variable>] ) # -# This function is deprecated. Set the target properties CXX_VISIBILITY_PRESET -# and VISIBILITY_INLINES_HIDDEN instead. +# The ADD_COMPILER_EXPORT_FLAGS function adds -fvisibility=hidden to +# CMAKE_CXX_FLAGS if supported, and is a no-op on Windows which does not +# need extra compiler flags for exporting support. You may optionally +# pass a single argument to ADD_COMPILER_EXPORT_FLAGS that will be +# populated with the required CXX_FLAGS required to enable visibility +# support for the compiler/architecture in use. # +# This function is deprecated. Set the target properties +# CXX_VISIBILITY_PRESET and VISIBILITY_INLINES_HIDDEN instead. #============================================================================= # Copyright 2011 Stephen Kelly <steveire@gmail.com> @@ -337,15 +389,7 @@ endfunction() function(add_compiler_export_flags) if(NOT CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 2.8.12) - if(CMAKE_WARN_DEPRECATED) - set(messageType WARNING) - endif() - if(CMAKE_ERROR_DEPRECATED) - set(messageType FATAL_ERROR) - endif() - if(messageType) - message(${messageType} "The add_compiler_export_flags function is obsolete. Use the CXX_VISIBILITY_PRESET and VISIBILITY_INLINES_HIDDEN target properties instead.") - endif() + message(DEPRECATION "The add_compiler_export_flags function is obsolete. Use the CXX_VISIBILITY_PRESET and VISIBILITY_INLINES_HIDDEN target properties instead.") endif() _test_compiler_hidden_visibility() diff --git a/Modules/GetPrerequisites.cmake b/Modules/GetPrerequisites.cmake index 9e89788..bd899e2 100644 --- a/Modules/GetPrerequisites.cmake +++ b/Modules/GetPrerequisites.cmake @@ -1,111 +1,164 @@ -# - Functions to analyze and list executable file prerequisites. -# This module provides functions to list the .dll, .dylib or .so -# files that an executable or shared library file depends on. (Its +#.rst: +# GetPrerequisites +# ---------------- +# +# Functions to analyze and list executable file prerequisites. +# +# This module provides functions to list the .dll, .dylib or .so files +# that an executable or shared library file depends on. (Its # prerequisites.) # -# It uses various tools to obtain the list of required shared library files: -# dumpbin (Windows) -# objdump (MinGW on Windows) -# ldd (Linux/Unix) -# otool (Mac OSX) +# It uses various tools to obtain the list of required shared library +# files: +# +# :: +# +# dumpbin (Windows) +# objdump (MinGW on Windows) +# ldd (Linux/Unix) +# otool (Mac OSX) +# # The following functions are provided by this module: -# get_prerequisites -# list_prerequisites -# list_prerequisites_by_glob -# gp_append_unique -# is_file_executable -# gp_item_default_embedded_path -# (projects can override with gp_item_default_embedded_path_override) -# gp_resolve_item -# (projects can override with gp_resolve_item_override) -# gp_resolved_file_type -# (projects can override with gp_resolved_file_type_override) -# gp_file_type -# Requires CMake 2.6 or greater because it uses function, break, return and -# PARENT_SCOPE. -# -# GET_PREREQUISITES(<target> <prerequisites_var> <exclude_system> <recurse> -# <exepath> <dirs>) -# Get the list of shared library files required by <target>. The list in -# the variable named <prerequisites_var> should be empty on first entry to -# this function. On exit, <prerequisites_var> will contain the list of -# required shared library files. -# -# <target> is the full path to an executable file. <prerequisites_var> is the -# name of a CMake variable to contain the results. <exclude_system> must be 0 -# or 1 indicating whether to include or exclude "system" prerequisites. If -# <recurse> is set to 1 all prerequisites will be found recursively, if set to -# 0 only direct prerequisites are listed. <exepath> is the path to the top -# level executable used for @executable_path replacment on the Mac. <dirs> is -# a list of paths where libraries might be found: these paths are searched -# first when a target without any path info is given. Then standard system -# locations are also searched: PATH, Framework locations, /usr/lib... -# -# LIST_PREREQUISITES(<target> [<recurse> [<exclude_system> [<verbose>]]]) -# Print a message listing the prerequisites of <target>. # -# <target> is the name of a shared library or executable target or the full -# path to a shared library or executable file. If <recurse> is set to 1 all +# :: +# +# get_prerequisites +# list_prerequisites +# list_prerequisites_by_glob +# gp_append_unique +# is_file_executable +# gp_item_default_embedded_path +# (projects can override with gp_item_default_embedded_path_override) +# gp_resolve_item +# (projects can override with gp_resolve_item_override) +# gp_resolved_file_type +# (projects can override with gp_resolved_file_type_override) +# gp_file_type +# +# Requires CMake 2.6 or greater because it uses function, break, return +# and PARENT_SCOPE. +# +# :: +# +# GET_PREREQUISITES(<target> <prerequisites_var> <exclude_system> <recurse> +# <exepath> <dirs>) +# +# Get the list of shared library files required by <target>. The list +# in the variable named <prerequisites_var> should be empty on first +# entry to this function. On exit, <prerequisites_var> will contain the +# list of required shared library files. +# +# <target> is the full path to an executable file. <prerequisites_var> +# is the name of a CMake variable to contain the results. +# <exclude_system> must be 0 or 1 indicating whether to include or +# exclude "system" prerequisites. If <recurse> is set to 1 all # prerequisites will be found recursively, if set to 0 only direct -# prerequisites are listed. <exclude_system> must be 0 or 1 indicating whether -# to include or exclude "system" prerequisites. With <verbose> set to 0 only -# the full path names of the prerequisites are printed, set to 1 extra -# informatin will be displayed. -# -# LIST_PREREQUISITES_BY_GLOB(<glob_arg> <glob_exp>) -# Print the prerequisites of shared library and executable files matching a -# globbing pattern. <glob_arg> is GLOB or GLOB_RECURSE and <glob_exp> is a -# globbing expression used with "file(GLOB" or "file(GLOB_RECURSE" to retrieve -# a list of matching files. If a matching file is executable, its prerequisites -# are listed. +# prerequisites are listed. <exepath> is the path to the top level +# executable used for @executable_path replacment on the Mac. <dirs> is +# a list of paths where libraries might be found: these paths are +# searched first when a target without any path info is given. Then +# standard system locations are also searched: PATH, Framework +# locations, /usr/lib... +# +# :: +# +# LIST_PREREQUISITES(<target> [<recurse> [<exclude_system> [<verbose>]]]) +# +# Print a message listing the prerequisites of <target>. +# +# <target> is the name of a shared library or executable target or the +# full path to a shared library or executable file. If <recurse> is set +# to 1 all prerequisites will be found recursively, if set to 0 only +# direct prerequisites are listed. <exclude_system> must be 0 or 1 +# indicating whether to include or exclude "system" prerequisites. With +# <verbose> set to 0 only the full path names of the prerequisites are +# printed, set to 1 extra informatin will be displayed. +# +# :: +# +# LIST_PREREQUISITES_BY_GLOB(<glob_arg> <glob_exp>) +# +# Print the prerequisites of shared library and executable files +# matching a globbing pattern. <glob_arg> is GLOB or GLOB_RECURSE and +# <glob_exp> is a globbing expression used with "file(GLOB" or +# "file(GLOB_RECURSE" to retrieve a list of matching files. If a +# matching file is executable, its prerequisites are listed. # # Any additional (optional) arguments provided are passed along as the # optional arguments to the list_prerequisites calls. # -# GP_APPEND_UNIQUE(<list_var> <value>) -# Append <value> to the list variable <list_var> only if the value is not -# already in the list. +# :: +# +# GP_APPEND_UNIQUE(<list_var> <value>) +# +# Append <value> to the list variable <list_var> only if the value is +# not already in the list. +# +# :: +# +# IS_FILE_EXECUTABLE(<file> <result_var>) # -# IS_FILE_EXECUTABLE(<file> <result_var>) -# Return 1 in <result_var> if <file> is a binary executable, 0 otherwise. +# Return 1 in <result_var> if <file> is a binary executable, 0 +# otherwise. +# +# :: +# +# GP_ITEM_DEFAULT_EMBEDDED_PATH(<item> <default_embedded_path_var>) # -# GP_ITEM_DEFAULT_EMBEDDED_PATH(<item> <default_embedded_path_var>) # Return the path that others should refer to the item by when the item # is embedded inside a bundle. # # Override on a per-project basis by providing a project-specific # gp_item_default_embedded_path_override function. # -# GP_RESOLVE_ITEM(<context> <item> <exepath> <dirs> <resolved_item_var>) +# :: +# +# GP_RESOLVE_ITEM(<context> <item> <exepath> <dirs> <resolved_item_var>) +# # Resolve an item into an existing full path file. # # Override on a per-project basis by providing a project-specific # gp_resolve_item_override function. # -# GP_RESOLVED_FILE_TYPE(<original_file> <file> <exepath> <dirs> <type_var>) -# Return the type of <file> with respect to <original_file>. String -# describing type of prerequisite is returned in variable named <type_var>. +# :: +# +# GP_RESOLVED_FILE_TYPE(<original_file> <file> <exepath> <dirs> <type_var>) +# +# Return the type of <file> with respect to <original_file>. String +# describing type of prerequisite is returned in variable named +# <type_var>. # # Use <exepath> and <dirs> if necessary to resolve non-absolute <file> # values -- but only for non-embedded items. # # Possible types are: -# system -# local -# embedded -# other +# +# :: +# +# system +# local +# embedded +# other +# # Override on a per-project basis by providing a project-specific # gp_resolved_file_type_override function. # -# GP_FILE_TYPE(<original_file> <file> <type_var>) -# Return the type of <file> with respect to <original_file>. String -# describing type of prerequisite is returned in variable named <type_var>. +# :: +# +# GP_FILE_TYPE(<original_file> <file> <type_var>) +# +# Return the type of <file> with respect to <original_file>. String +# describing type of prerequisite is returned in variable named +# <type_var>. # # Possible types are: -# system -# local -# embedded -# other +# +# :: +# +# system +# local +# embedded +# other #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/InstallRequiredSystemLibraries.cmake b/Modules/InstallRequiredSystemLibraries.cmake index 2479d68..013a028 100644 --- a/Modules/InstallRequiredSystemLibraries.cmake +++ b/Modules/InstallRequiredSystemLibraries.cmake @@ -1,27 +1,32 @@ +#.rst: +# InstallRequiredSystemLibraries +# ------------------------------ +# +# +# # By including this file, all library files listed in the variable # CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS will be installed with -# install(PROGRAMS ...) into bin for WIN32 and lib -# for non-WIN32. If CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP is set to TRUE -# before including this file, then the INSTALL command is not called. -# The user can use the variable CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS to use a -# custom install command and install them however they want. -# If it is the MSVC compiler, then the microsoft run -# time libraries will be found and automatically added to the -# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS, and installed. -# If CMAKE_INSTALL_DEBUG_LIBRARIES is set and it is the MSVC -# compiler, then the debug libraries are installed when available. -# If CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY is set then only the debug -# libraries are installed when both debug and release are available. -# If CMAKE_INSTALL_MFC_LIBRARIES is set then the MFC run time -# libraries are installed as well as the CRT run time libraries. -# If CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION is set then the libraries are -# installed to that directory rather than the default. -# If CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_NO_WARNINGS is NOT set, then this file -# warns about required files that do not exist. You can set this variable to -# ON before including this file to avoid the warning. For example, the Visual -# Studio Express editions do not include the redistributable files, so if you -# include this file on a machine with only VS Express installed, you'll get -# the warning. +# install(PROGRAMS ...) into bin for WIN32 and lib for non-WIN32. If +# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP is set to TRUE before including +# this file, then the INSTALL command is not called. The user can use +# the variable CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS to use a custom install +# command and install them however they want. If it is the MSVC +# compiler, then the microsoft run time libraries will be found and +# automatically added to the CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS, and +# installed. If CMAKE_INSTALL_DEBUG_LIBRARIES is set and it is the MSVC +# compiler, then the debug libraries are installed when available. If +# CMAKE_INSTALL_DEBUG_LIBRARIES_ONLY is set then only the debug +# libraries are installed when both debug and release are available. If +# CMAKE_INSTALL_MFC_LIBRARIES is set then the MFC run time libraries are +# installed as well as the CRT run time libraries. If +# CMAKE_INSTALL_SYSTEM_RUNTIME_DESTINATION is set then the libraries are +# installed to that directory rather than the default. If +# CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_NO_WARNINGS is NOT set, then this +# file warns about required files that do not exist. You can set this +# variable to ON before including this file to avoid the warning. For +# example, the Visual Studio Express editions do not include the +# redistributable files, so if you include this file on a machine with +# only VS Express installed, you'll get the warning. #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/MacroAddFileDependencies.cmake b/Modules/MacroAddFileDependencies.cmake index d0605a1..38df1d3 100644 --- a/Modules/MacroAddFileDependencies.cmake +++ b/Modules/MacroAddFileDependencies.cmake @@ -1,10 +1,16 @@ -# - MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) -# Using the macro MACRO_ADD_FILE_DEPENDENCIES() is discouraged. There are usually -# better ways to specify the correct dependencies. +#.rst: +# MacroAddFileDependencies +# ------------------------ # -# MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) is just a convenience -# wrapper around the OBJECT_DEPENDS source file property. You can just -# use set_property(SOURCE <file> APPEND PROPERTY OBJECT_DEPENDS depend_files) instead. +# MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) +# +# Using the macro MACRO_ADD_FILE_DEPENDENCIES() is discouraged. There +# are usually better ways to specify the correct dependencies. +# +# MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) is just a +# convenience wrapper around the OBJECT_DEPENDS source file property. +# You can just use set_property(SOURCE <file> APPEND PROPERTY +# OBJECT_DEPENDS depend_files) instead. #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/Platform/Darwin-AppleClang-C.cmake b/Modules/Platform/Darwin-AppleClang-C.cmake new file mode 100644 index 0000000..98971bb --- /dev/null +++ b/Modules/Platform/Darwin-AppleClang-C.cmake @@ -0,0 +1 @@ +include(Platform/Darwin-Clang-C) diff --git a/Modules/Platform/Darwin-AppleClang-CXX.cmake b/Modules/Platform/Darwin-AppleClang-CXX.cmake new file mode 100644 index 0000000..4e9e7c1 --- /dev/null +++ b/Modules/Platform/Darwin-AppleClang-CXX.cmake @@ -0,0 +1 @@ +include(Platform/Darwin-Clang-CXX) diff --git a/Modules/Platform/Darwin.cmake b/Modules/Platform/Darwin.cmake index 72844b5..8ab3e2c 100644 --- a/Modules/Platform/Darwin.cmake +++ b/Modules/Platform/Darwin.cmake @@ -268,6 +268,11 @@ set(CMAKE_C_CREATE_MACOSX_FRAMEWORK set(CMAKE_CXX_CREATE_MACOSX_FRAMEWORK "<CMAKE_CXX_COMPILER> <LANGUAGE_COMPILE_FLAGS> <CMAKE_SHARED_LIBRARY_CREATE_CXX_FLAGS> <LINK_FLAGS> -o <TARGET> <SONAME_FLAG> <TARGET_INSTALLNAME_DIR><TARGET_SONAME> <OBJECTS> <LINK_LIBRARIES>") +# Set default framework search path flag for languages known to use a +# preprocessor that may find headers in frameworks. +set(CMAKE_C_FRAMEWORK_SEARCH_FLAG -F) +set(CMAKE_CXX_FRAMEWORK_SEARCH_FLAG -F) +set(CMAKE_Fortran_FRAMEWORK_SEARCH_FLAG -F) # default to searching for frameworks first if(NOT DEFINED CMAKE_FIND_FRAMEWORK) diff --git a/Modules/Platform/Haiku.cmake b/Modules/Platform/Haiku.cmake index 8987783..825f851 100644 --- a/Modules/Platform/Haiku.cmake +++ b/Modules/Platform/Haiku.cmake @@ -1,22 +1,123 @@ -set(BEOS 1) +# process only once +if(HAIKU) + return() +endif() + +set(HAIKU 1) +set(UNIX 1) -set(CMAKE_DL_LIBS root be) -set(CMAKE_C_COMPILE_OPTIONS_PIC "-fPIC") -set(CMAKE_C_COMPILE_OPTIONS_PIE "-fPIE") +set(CMAKE_DL_LIBS "") set(CMAKE_SHARED_LIBRARY_C_FLAGS "-fPIC") -set(CMAKE_SHARED_LIBRARY_CREATE_C_FLAGS "-nostart") +set(CMAKE_SHARED_LIBRARY_CREATE_C_FLAGS "-shared") set(CMAKE_SHARED_LIBRARY_RUNTIME_C_FLAG "-Wl,-rpath,") set(CMAKE_SHARED_LIBRARY_RUNTIME_C_FLAG_SEP ":") +set(CMAKE_SHARED_LIBRARY_RPATH_LINK_C_FLAG "-Wl,-rpath-link,") set(CMAKE_SHARED_LIBRARY_SONAME_C_FLAG "-Wl,-soname,") +set(CMAKE_EXE_EXPORTS_C_FLAG "-Wl,--export-dynamic") + +# Determine, if the C or C++ compiler is configured for a secondary +# architecture. If so, that will change the search paths we set below. We check +# whether the compiler's library search paths contain a +# "/boot/system/develop/lib/<subdir>/", which we assume to be the secondary +# architecture specific subdirectory and extract the name of the architecture +# accordingly. +set(__HAIKU_COMPILER ${CMAKE_C_COMPILER}) + +if(NOT __HAIKU_COMPILER) + set(__HAIKU_COMPILER ${CMAKE_CXX_COMPILER}) +endif() + +execute_process( + COMMAND ${__HAIKU_COMPILER} -print-search-dirs + OUTPUT_VARIABLE _HAIKU_SEARCH_DIRS + OUTPUT_STRIP_TRAILING_WHITESPACE) + +string(REGEX MATCH ".*\nlibraries: =?([^\n]*:)?/boot/system/develop/lib/([^/]*)/(:[^\n]*)?\n.*" _dummy "\n${_HAIKU_SEARCH_DIRS}\n") +set(CMAKE_HAIKU_SECONDARY_ARCH "${CMAKE_MATCH_2}") + +if(NOT CMAKE_HAIKU_SECONDARY_ARCH) + set(CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR "") + unset(CMAKE_HAIKU_SECONDARY_ARCH) +else() + set(CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR "/${CMAKE_HAIKU_SECONDARY_ARCH}") + + # Override CMAKE_*LIBRARY_ARCHITECTURE. This will cause FIND_LIBRARY to search + # the libraries in the correct subdirectory first. It still isn't completely + # correct, since the parent directories shouldn't be searched at all. The + # primary architecture library might still be found, if there isn't one + # installed for the secondary architecture or it is installed in a less + # specific location. + set(CMAKE_LIBRARY_ARCHITECTURE ${CMAKE_HAIKU_SECONDARY_ARCH}) + set(CMAKE_C_LIBRARY_ARCHITECTURE ${CMAKE_HAIKU_SECONDARY_ARCH}) + set(CMAKE_CXX_LIBRARY_ARCHITECTURE ${CMAKE_HAIKU_SECONDARY_ARCH}) +endif() + +list(APPEND CMAKE_SYSTEM_PREFIX_PATH + /boot/common/non-packaged + /boot/common + /boot/system + ) + +LIST(APPEND CMAKE_HAIKU_COMMON_INCLUDE_DIRECTORIES + /boot/common/non-packaged/develop/headers${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + /boot/common/develop/headers${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + /boot/system/develop/headers/os + /boot/system/develop/headers/os/app + /boot/system/develop/headers/os/device + /boot/system/develop/headers/os/drivers + /boot/system/develop/headers/os/game + /boot/system/develop/headers/os/interface + /boot/system/develop/headers/os/kernel + /boot/system/develop/headers/os/locale + /boot/system/develop/headers/os/mail + /boot/system/develop/headers/os/media + /boot/system/develop/headers/os/midi + /boot/system/develop/headers/os/midi2 + /boot/system/develop/headers/os/net + /boot/system/develop/headers/os/opengl + /boot/system/develop/headers/os/storage + /boot/system/develop/headers/os/support + /boot/system/develop/headers/os/translation + /boot/system/develop/headers/os/add-ons/graphics + /boot/system/develop/headers/os/add-ons/input_server + /boot/system/develop/headers/os/add-ons/screen_saver + /boot/system/develop/headers/os/add-ons/tracker + /boot/system/develop/headers/os/be_apps/Deskbar + /boot/system/develop/headers/os/be_apps/NetPositive + /boot/system/develop/headers/os/be_apps/Tracker + /boot/system/develop/headers/3rdparty + /boot/system/develop/headers/bsd + /boot/system/develop/headers/glibc + /boot/system/develop/headers/gnu + /boot/system/develop/headers/posix + /boot/system/develop/headers${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + ) +IF (CMAKE_HAIKU_SECONDARY_ARCH) + LIST(APPEND CMAKE_HAIKU_COMMON_INCLUDE_DIRECTORIES + /boot/system/develop/headers + ) +ENDIF (CMAKE_HAIKU_SECONDARY_ARCH) + +LIST(APPEND CMAKE_HAIKU_C_INCLUDE_DIRECTORIES + ${CMAKE_HAIKU_COMMON_INCLUDE_DIRECTORIES} + ) + +LIST(APPEND CMAKE_HAIKU_CXX_INCLUDE_DIRECTORIES + ${CMAKE_HAIKU_COMMON_INCLUDE_DIRECTORIES}) + +LIST(APPEND CMAKE_SYSTEM_INCLUDE_PATH ${CMAKE_HAIKU_C_INCLUDE_DIRECTORIES}) + +LIST(APPEND CMAKE_HAIKU_DEVELOP_LIB_DIRECTORIES + /boot/common/non-packaged/develop/lib${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + /boot/common/develop/lib${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + /boot/system/develop/lib${CMAKE_HAIKU_SECONDARY_ARCH_SUBDIR} + ) + +LIST(APPEND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES + ${CMAKE_HAIKU_DEVELOP_LIB_DIRECTORIES} + ) -include(Platform/UnixPaths) -list(APPEND CMAKE_SYSTEM_PREFIX_PATH /boot/common) -list(APPEND CMAKE_SYSTEM_INCLUDE_PATH /boot/common/include) -list(APPEND CMAKE_SYSTEM_LIBRARY_PATH /boot/common/lib) -list(APPEND CMAKE_SYSTEM_PROGRAM_PATH /boot/common/bin) -list(APPEND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES /boot/common/lib) -list(APPEND CMAKE_SYSTEM_INCLUDE_PATH /boot/develop/headers/3rdparty) -list(APPEND CMAKE_SYSTEM_LIBRARY_PATH /boot/develop/lib/x86) +LIST(APPEND CMAKE_SYSTEM_LIBRARY_PATH ${CMAKE_HAIKU_DEVELOP_LIB_DIRECTORIES}) if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) set(CMAKE_INSTALL_PREFIX "/boot/common" CACHE PATH diff --git a/Modules/Platform/Windows-Clang-C.cmake b/Modules/Platform/Windows-Clang-C.cmake new file mode 100644 index 0000000..d007105 --- /dev/null +++ b/Modules/Platform/Windows-Clang-C.cmake @@ -0,0 +1,2 @@ +include(Platform/Windows-Clang) +__windows_compiler_clang(C) diff --git a/Modules/Platform/Windows-Clang-CXX.cmake b/Modules/Platform/Windows-Clang-CXX.cmake new file mode 100644 index 0000000..2c3688a --- /dev/null +++ b/Modules/Platform/Windows-Clang-CXX.cmake @@ -0,0 +1,2 @@ +include(Platform/Windows-Clang) +__windows_compiler_clang(CXX) diff --git a/Modules/Platform/Windows-Clang.cmake b/Modules/Platform/Windows-Clang.cmake new file mode 100644 index 0000000..4c936fe --- /dev/null +++ b/Modules/Platform/Windows-Clang.cmake @@ -0,0 +1,32 @@ + +#============================================================================= +# Copyright 2001-2013 Kitware, Inc. +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +# (To distribute this file outside of CMake, substitute the full +# License text for the above reference.) + +# This module is shared by multiple languages; use include blocker. +if(__WINDOWS_CLANG) + return() +endif() +set(__WINDOWS_CLANG 1) + +if(CMAKE_C_SIMULATE_ID STREQUAL "MSVC" + OR CMAKE_CXX_SIMULATE_ID STREQUAL "MSVC") + include(Platform/Windows-MSVC) + macro(__windows_compiler_clang lang) + __windows_compiler_msvc(${lang}) + endmacro() +else() + include(Platform/Windows-GNU) + macro(__windows_compiler_clang lang) + __windows_compiler_gnu(${lang}) + endmacro() +endif() diff --git a/Modules/Platform/Windows-MSVC.cmake b/Modules/Platform/Windows-MSVC.cmake index 7036ba0..a2cfe33 100644 --- a/Modules/Platform/Windows-MSVC.cmake +++ b/Modules/Platform/Windows-MSVC.cmake @@ -65,7 +65,11 @@ else() endif() if(NOT MSVC_VERSION) - if(CMAKE_C_COMPILER_VERSION) + if(CMAKE_C_SIMULATE_VERSION) + set(_compiler_version ${CMAKE_C_SIMULATE_VERSION}) + elseif(CMAKE_CXX_SIMULATE_VERSION) + set(_compiler_version ${CMAKE_CXX_SIMULATE_VERSION}) + elseif(CMAKE_C_COMPILER_VERSION) set(_compiler_version ${CMAKE_C_COMPILER_VERSION}) else() set(_compiler_version ${CMAKE_CXX_COMPILER_VERSION}) @@ -220,7 +224,7 @@ set (CMAKE_MODULE_LINKER_FLAGS_RELEASE_INIT ${CMAKE_EXE_LINKER_FLAGS_RELEASE_INI set (CMAKE_MODULE_LINKER_FLAGS_MINSIZEREL_INIT ${CMAKE_EXE_LINKER_FLAGS_MINSIZEREL_INIT}) macro(__windows_compiler_msvc lang) - if(NOT "${CMAKE_${lang}_COMPILER_VERSION}" VERSION_LESS 14) + if(NOT MSVC_VERSION LESS 1400) # for 2005 make sure the manifest is put in the dll with mt set(_CMAKE_VS_LINK_DLL "<CMAKE_COMMAND> -E vs_link_dll ") set(_CMAKE_VS_LINK_EXE "<CMAKE_COMMAND> -E vs_link_exe ") diff --git a/Modules/ProcessorCount.cmake b/Modules/ProcessorCount.cmake index 0d1dfda..22ee776 100644 --- a/Modules/ProcessorCount.cmake +++ b/Modules/ProcessorCount.cmake @@ -1,30 +1,41 @@ -# - ProcessorCount(var) +#.rst: +# ProcessorCount +# -------------- +# +# ProcessorCount(var) +# # Determine the number of processors/cores and save value in ${var} # -# Sets the variable named ${var} to the number of physical cores available on -# the machine if the information can be determined. Otherwise it is set to 0. -# Currently this functionality is implemented for AIX, cygwin, FreeBSD, HPUX, -# IRIX, Linux, Mac OS X, QNX, Sun and Windows. +# Sets the variable named ${var} to the number of physical cores +# available on the machine if the information can be determined. +# Otherwise it is set to 0. Currently this functionality is implemented +# for AIX, cygwin, FreeBSD, HPUX, IRIX, Linux, Mac OS X, QNX, Sun and +# Windows. # # This function is guaranteed to return a positive integer (>=1) if it -# succeeds. It returns 0 if there's a problem determining the processor count. +# succeeds. It returns 0 if there's a problem determining the processor +# count. # # Example use, in a ctest -S dashboard script: # -# include(ProcessorCount) -# ProcessorCount(N) -# if(NOT N EQUAL 0) -# set(CTEST_BUILD_FLAGS -j${N}) -# set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N}) -# endif() +# :: +# +# include(ProcessorCount) +# ProcessorCount(N) +# if(NOT N EQUAL 0) +# set(CTEST_BUILD_FLAGS -j${N}) +# set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N}) +# endif() +# +# # -# This function is intended to offer an approximation of the value of the -# number of compute cores available on the current machine, such that you -# may use that value for parallel building and parallel testing. It is meant -# to help utilize as much of the machine as seems reasonable. Of course, -# knowledge of what else might be running on the machine simultaneously -# should be used when deciding whether to request a machine's full capacity -# all for yourself. +# This function is intended to offer an approximation of the value of +# the number of compute cores available on the current machine, such +# that you may use that value for parallel building and parallel +# testing. It is meant to help utilize as much of the machine as seems +# reasonable. Of course, knowledge of what else might be running on the +# machine simultaneously should be used when deciding whether to request +# a machine's full capacity all for yourself. # A more reliable way might be to compile a small C program that uses the CPUID # instruction, but that again requires compiler support or compiling assembler diff --git a/Modules/Qt4ConfigDependentSettings.cmake b/Modules/Qt4ConfigDependentSettings.cmake index 88dc8ec..03fb844 100644 --- a/Modules/Qt4ConfigDependentSettings.cmake +++ b/Modules/Qt4ConfigDependentSettings.cmake @@ -1,3 +1,9 @@ +#.rst: +# Qt4ConfigDependentSettings +# -------------------------- +# +# +# # This file is included by FindQt4.cmake, don't include it directly. #============================================================================= diff --git a/Modules/Qt4Macros.cmake b/Modules/Qt4Macros.cmake index f1aedd7..b5f005f 100644 --- a/Modules/Qt4Macros.cmake +++ b/Modules/Qt4Macros.cmake @@ -1,3 +1,9 @@ +#.rst: +# Qt4Macros +# --------- +# +# +# # This file is included by FindQt4.cmake, don't include it directly. #============================================================================= @@ -355,15 +361,7 @@ endmacro() macro(QT4_AUTOMOC) if(NOT CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 2.8.11) - if(CMAKE_WARN_DEPRECATED) - set(messageType WARNING) - endif() - if(CMAKE_ERROR_DEPRECATED) - set(messageType FATAL_ERROR) - endif() - if(messageType) - message(${messageType} "The qt4_automoc macro is obsolete. Use the CMAKE_AUTOMOC feature instead.") - endif() + message(DEPRECATION "The qt4_automoc macro is obsolete. Use the CMAKE_AUTOMOC feature instead.") endif() QT4_GET_MOC_FLAGS(_moc_INCS) @@ -434,15 +432,16 @@ macro(QT4_CREATE_TRANSLATION _qm_files) set(_ts_pro ${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_ts_name}_lupdate.pro) set(_pro_srcs) foreach(_pro_src ${_my_sources}) - set(_pro_srcs "${_pro_srcs} \"${_pro_src}\"") + set(_pro_srcs "${_pro_srcs} \\\n \"${_pro_src}\"") endforeach() set(_pro_includes) get_directory_property(_inc_DIRS INCLUDE_DIRECTORIES) + list(REMOVE_DUPLICATES _inc_DIRS) foreach(_pro_include ${_inc_DIRS}) get_filename_component(_abs_include "${_pro_include}" ABSOLUTE) - set(_pro_includes "${_pro_includes} \"${_abs_include}\"") + set(_pro_includes "${_pro_includes} \\\n \"${_abs_include}\"") endforeach() - file(WRITE ${_ts_pro} "SOURCES = ${_pro_srcs}\nINCLUDEPATH = ${_pro_includes}\n") + file(WRITE ${_ts_pro} "SOURCES =${_pro_srcs}\nINCLUDEPATH =${_pro_includes}\n") endif() add_custom_command(OUTPUT ${_ts_file} COMMAND ${QT_LUPDATE_EXECUTABLE} @@ -476,15 +475,7 @@ endmacro() function(qt4_use_modules _target _link_type) if(NOT CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 2.8.11) - if(CMAKE_WARN_DEPRECATED) - set(messageType WARNING) - endif() - if(CMAKE_ERROR_DEPRECATED) - set(messageType FATAL_ERROR) - endif() - if(messageType) - message(${messageType} "The qt4_use_modules function is obsolete. Use target_link_libraries with IMPORTED targets instead.") - endif() + message(DEPRECATION "The qt4_use_modules function is obsolete. Use target_link_libraries with IMPORTED targets instead.") endif() if ("${_link_type}" STREQUAL "LINK_PUBLIC" OR "${_link_type}" STREQUAL "LINK_PRIVATE") set(modules ${ARGN}) diff --git a/Modules/SelectLibraryConfigurations.cmake b/Modules/SelectLibraryConfigurations.cmake index 297e1d3..d710856 100644 --- a/Modules/SelectLibraryConfigurations.cmake +++ b/Modules/SelectLibraryConfigurations.cmake @@ -1,20 +1,28 @@ +#.rst: +# SelectLibraryConfigurations +# --------------------------- +# +# +# # select_library_configurations( basename ) # -# This macro takes a library base name as an argument, and will choose good -# values for basename_LIBRARY, basename_LIBRARIES, basename_LIBRARY_DEBUG, and -# basename_LIBRARY_RELEASE depending on what has been found and set. If only -# basename_LIBRARY_RELEASE is defined, basename_LIBRARY will be set to the -# release value, and basename_LIBRARY_DEBUG will be set to -# basename_LIBRARY_DEBUG-NOTFOUND. If only basename_LIBRARY_DEBUG is defined, -# then basename_LIBRARY will take the debug value, and basename_LIBRARY_RELEASE -# will be set to basename_LIBRARY_RELEASE-NOTFOUND. +# This macro takes a library base name as an argument, and will choose +# good values for basename_LIBRARY, basename_LIBRARIES, +# basename_LIBRARY_DEBUG, and basename_LIBRARY_RELEASE depending on what +# has been found and set. If only basename_LIBRARY_RELEASE is defined, +# basename_LIBRARY will be set to the release value, and +# basename_LIBRARY_DEBUG will be set to basename_LIBRARY_DEBUG-NOTFOUND. +# If only basename_LIBRARY_DEBUG is defined, then basename_LIBRARY will +# take the debug value, and basename_LIBRARY_RELEASE will be set to +# basename_LIBRARY_RELEASE-NOTFOUND. # -# If the generator supports configuration types, then basename_LIBRARY and -# basename_LIBRARIES will be set with debug and optimized flags specifying the -# library to be used for the given configuration. If no build type has been set -# or the generator in use does not support configuration types, then -# basename_LIBRARY and basename_LIBRARIES will take only the release value, or -# the debug value if the release one is not set. +# If the generator supports configuration types, then basename_LIBRARY +# and basename_LIBRARIES will be set with debug and optimized flags +# specifying the library to be used for the given configuration. If no +# build type has been set or the generator in use does not support +# configuration types, then basename_LIBRARY and basename_LIBRARIES will +# take only the release value, or the debug value if the release one is +# not set. #============================================================================= # Copyright 2009 Will Dicharry <wdicharry@stellarscience.com> diff --git a/Modules/SquishTestScript.cmake b/Modules/SquishTestScript.cmake index f794b3e..d648749 100644 --- a/Modules/SquishTestScript.cmake +++ b/Modules/SquishTestScript.cmake @@ -1,13 +1,18 @@ +#.rst: +# SquishTestScript +# ---------------- # -# This script launches a GUI test using Squish. You should not call -# the script directly; instead, you should access it via the -# SQUISH_ADD_TEST macro that is defined in FindSquish.cmake. # -# This script starts the Squish server, launches the test on the -# client, and finally stops the squish server. If any of these steps -# fail (including if the tests do not pass) then a fatal error is -# raised. # +# +# +# This script launches a GUI test using Squish. You should not call the +# script directly; instead, you should access it via the SQUISH_ADD_TEST +# macro that is defined in FindSquish.cmake. +# +# This script starts the Squish server, launches the test on the client, +# and finally stops the squish server. If any of these steps fail +# (including if the tests do not pass) then a fatal error is raised. #============================================================================= # Copyright 2008-2009 Kitware, Inc. diff --git a/Modules/TestBigEndian.cmake b/Modules/TestBigEndian.cmake index 193df8f..675aaa3 100644 --- a/Modules/TestBigEndian.cmake +++ b/Modules/TestBigEndian.cmake @@ -1,8 +1,15 @@ -# - Define macro to determine endian type +#.rst: +# TestBigEndian +# ------------- +# +# Define macro to determine endian type +# # Check if the system is big endian or little endian -# TEST_BIG_ENDIAN(VARIABLE) -# VARIABLE - variable to store the result to # +# :: +# +# TEST_BIG_ENDIAN(VARIABLE) +# VARIABLE - variable to store the result to #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/TestCXXAcceptsFlag.cmake b/Modules/TestCXXAcceptsFlag.cmake index 2694737..2bcbea6 100644 --- a/Modules/TestCXXAcceptsFlag.cmake +++ b/Modules/TestCXXAcceptsFlag.cmake @@ -1,11 +1,17 @@ -# - Test CXX compiler for a flag +#.rst: +# TestCXXAcceptsFlag +# ------------------ +# +# Test CXX compiler for a flag +# # Check if the CXX compiler accepts a flag # -# 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) - +# checks if the function exists +# FLAGS - the flags to try +# VARIABLE - variable to store the result #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/TestForANSIForScope.cmake b/Modules/TestForANSIForScope.cmake index 9b4d51c..de4b1f1 100644 --- a/Modules/TestForANSIForScope.cmake +++ b/Modules/TestForANSIForScope.cmake @@ -1,7 +1,15 @@ -# - Check for ANSI for scope support -# Check if the compiler restricts the scope of variables declared in a for-init-statement to the loop body. -# CMAKE_NO_ANSI_FOR_SCOPE - holds result +#.rst: +# TestForANSIForScope +# ------------------- # +# Check for ANSI for scope support +# +# Check if the compiler restricts the scope of variables declared in a +# for-init-statement to the loop body. +# +# :: +# +# CMAKE_NO_ANSI_FOR_SCOPE - holds result #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/TestForANSIStreamHeaders.cmake b/Modules/TestForANSIStreamHeaders.cmake index 060b3a4..c13000b 100644 --- a/Modules/TestForANSIStreamHeaders.cmake +++ b/Modules/TestForANSIStreamHeaders.cmake @@ -1,7 +1,15 @@ -# - Test for compiler support of ANSI stream headers iostream, etc. -# check if the compiler supports the standard ANSI iostream header (without the .h) -# CMAKE_NO_ANSI_STREAM_HEADERS - defined by the results +#.rst: +# TestForANSIStreamHeaders +# ------------------------ # +# Test for compiler support of ANSI stream headers iostream, etc. +# +# check if the compiler supports the standard ANSI iostream header +# (without the .h) +# +# :: +# +# CMAKE_NO_ANSI_STREAM_HEADERS - defined by the results #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/TestForSSTREAM.cmake b/Modules/TestForSSTREAM.cmake index db39c1e..8977583 100644 --- a/Modules/TestForSSTREAM.cmake +++ b/Modules/TestForSSTREAM.cmake @@ -1,7 +1,14 @@ -# - Test for compiler support of ANSI sstream header +#.rst: +# TestForSSTREAM +# -------------- +# +# Test for compiler support of ANSI sstream header +# # check if the compiler supports the standard ANSI sstream header -# CMAKE_NO_ANSI_STRING_STREAM - defined by the results # +# :: +# +# CMAKE_NO_ANSI_STRING_STREAM - defined by the results #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/TestForSTDNamespace.cmake b/Modules/TestForSTDNamespace.cmake index 6a75644..e43b75d 100644 --- a/Modules/TestForSTDNamespace.cmake +++ b/Modules/TestForSTDNamespace.cmake @@ -1,7 +1,14 @@ -# - Test for std:: namespace support +#.rst: +# TestForSTDNamespace +# ------------------- +# +# Test for std:: namespace support +# # check if the compiler supports std:: on stl classes -# CMAKE_NO_STD_NAMESPACE - defined by the results # +# :: +# +# CMAKE_NO_STD_NAMESPACE - defined by the results #============================================================================= # Copyright 2002-2009 Kitware, Inc. diff --git a/Modules/UseEcos.cmake b/Modules/UseEcos.cmake index 0c4fee4..3bd92ca 100644 --- a/Modules/UseEcos.cmake +++ b/Modules/UseEcos.cmake @@ -1,20 +1,29 @@ -# - This module defines variables and macros required to build eCos application. +#.rst: +# UseEcos +# ------- +# +# This module defines variables and macros required to build eCos application. +# # This file contains the following macros: # ECOS_ADD_INCLUDE_DIRECTORIES() - add the eCos include dirs -# ECOS_ADD_EXECUTABLE(name source1 ... sourceN ) - create an eCos executable -# ECOS_ADJUST_DIRECTORY(VAR source1 ... sourceN ) - adjusts the path of the source files and puts the result into VAR +# ECOS_ADD_EXECUTABLE(name source1 ... sourceN ) - create an eCos +# executable ECOS_ADJUST_DIRECTORY(VAR source1 ... sourceN ) - adjusts +# the path of the source files and puts the result into VAR +# +# Macros for selecting the toolchain: ECOS_USE_ARM_ELF_TOOLS() - enable +# the ARM ELF toolchain for the directory where it is called +# ECOS_USE_I386_ELF_TOOLS() - enable the i386 ELF toolchain for the +# directory where it is called ECOS_USE_PPC_EABI_TOOLS() - enable the +# PowerPC toolchain for the directory where it is called +# +# It contains the following variables: ECOS_DEFINITIONS +# ECOSCONFIG_EXECUTABLE ECOS_CONFIG_FILE - defaults to ecos.ecc, if your +# eCos configuration file has a different name, adjust this variable for +# internal use only: # -# Macros for selecting the toolchain: -# ECOS_USE_ARM_ELF_TOOLS() - enable the ARM ELF toolchain for the directory where it is called -# ECOS_USE_I386_ELF_TOOLS() - enable the i386 ELF toolchain for the directory where it is called -# ECOS_USE_PPC_EABI_TOOLS() - enable the PowerPC toolchain for the directory where it is called +# :: # -# It contains the following variables: -# ECOS_DEFINITIONS -# ECOSCONFIG_EXECUTABLE -# ECOS_CONFIG_FILE - defaults to ecos.ecc, if your eCos configuration file has a different name, adjust this variable -# for internal use only: -# ECOS_ADD_TARGET_LIB +# ECOS_ADD_TARGET_LIB #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/UseJava.cmake b/Modules/UseJava.cmake index c9635b5..f7f242b 100644 --- a/Modules/UseJava.cmake +++ b/Modules/UseJava.cmake @@ -1,120 +1,220 @@ -# - Use Module for Java -# This file provides functions for Java. It is assumed that FindJava.cmake -# has already been loaded. See FindJava.cmake for information on how to -# load Java into your CMake project. +#.rst: +# UseJava +# ------- +# +# Use Module for Java +# +# This file provides functions for Java. It is assumed that +# FindJava.cmake has already been loaded. See FindJava.cmake for +# information on how to load Java into your CMake project. # # add_jar(target_name -# [SOURCES] source1 [source2 ...] [resource1 ...] -# [INCLUDE_JARS jar1 [jar2 ...]] -# [ENTRY_POINT entry] -# [VERSION version] -# [OUTPUT_NAME name] -# [OUTPUT_DIR dir] -# ) -# -# This command creates a <target_name>.jar. It compiles the given source files -# (source) and adds the given resource files (resource) to the jar file. If -# only resource files are given then just a jar file is created. The list of -# include jars are added to the classpath when compiling the java sources and -# also to the dependencies of the target. INCLUDE_JARS also accepts other -# target names created by add_jar. For backwards compatibility, jar files -# listed as sources are ignored (as they have been since the first version of -# this module). +# +# :: +# +# [SOURCES] source1 [source2 ...] [resource1 ...] +# [INCLUDE_JARS jar1 [jar2 ...]] +# [ENTRY_POINT entry] +# [VERSION version] +# [OUTPUT_NAME name] +# [OUTPUT_DIR dir] +# ) +# +# +# +# This command creates a <target_name>.jar. It compiles the given +# source files (source) and adds the given resource files (resource) to +# the jar file. If only resource files are given then just a jar file +# is created. The list of include jars are added to the classpath when +# compiling the java sources and also to the dependencies of the target. +# INCLUDE_JARS also accepts other target names created by add_jar. For +# backwards compatibility, jar files listed as sources are ignored (as +# they have been since the first version of this module). # # The default OUTPUT_DIR can also be changed by setting the variable # CMAKE_JAVA_TARGET_OUTPUT_DIR. # # Additional instructions: -# To add compile flags to the target you can set these flags with -# the following variable: # -# set(CMAKE_JAVA_COMPILE_FLAGS -nowarn) +# :: +# +# To add compile flags to the target you can set these flags with +# the following variable: +# +# +# +# :: +# +# set(CMAKE_JAVA_COMPILE_FLAGS -nowarn) +# +# +# +# :: +# +# To add a path or a jar file to the class path you can do this +# with the CMAKE_JAVA_INCLUDE_PATH variable. +# +# +# +# :: +# +# set(CMAKE_JAVA_INCLUDE_PATH /usr/share/java/shibboleet.jar) +# +# +# +# :: +# +# To use a different output name for the target you can set it with: +# +# +# +# :: +# +# add_jar(foobar foobar.java OUTPUT_NAME shibboleet.jar) +# +# +# +# :: +# +# To use a different output directory than CMAKE_CURRENT_BINARY_DIR +# you can set it with: +# +# +# +# :: +# +# add_jar(foobar foobar.java OUTPUT_DIR ${PROJECT_BINARY_DIR}/bin) +# +# +# +# :: +# +# To define an entry point in your jar you can set it with the ENTRY_POINT +# named argument: +# +# +# +# :: +# +# add_jar(example ENTRY_POINT com/examples/MyProject/Main) +# +# +# +# :: +# +# To define a custom manifest for the jar, you can set it with the manifest +# named argument: +# # -# To add a path or a jar file to the class path you can do this -# with the CMAKE_JAVA_INCLUDE_PATH variable. # -# set(CMAKE_JAVA_INCLUDE_PATH /usr/share/java/shibboleet.jar) +# :: # -# To use a different output name for the target you can set it with: +# add_jar(example MANIFEST /path/to/manifest) # -# add_jar(foobar foobar.java OUTPUT_NAME shibboleet.jar) # -# To use a different output directory than CMAKE_CURRENT_BINARY_DIR -# you can set it with: # -# add_jar(foobar foobar.java OUTPUT_DIR ${PROJECT_BINARY_DIR}/bin) +# :: # -# To define an entry point in your jar you can set it with the ENTRY_POINT -# named argument: +# To add a VERSION to the target output name you can set it using +# the VERSION named argument to add_jar. This will create a jar file with the +# name shibboleet-1.0.0.jar and will create a symlink shibboleet.jar +# pointing to the jar with the version information. # -# add_jar(example ENTRY_POINT com/examples/MyProject/Main) # -# To define a custom manifest for the jar, you can set it with the manifest -# named argument: # -# add_jar(example MANIFEST /path/to/manifest) +# :: # -# To add a VERSION to the target output name you can set it using -# the VERSION named argument to add_jar. This will create a jar file with the -# name shibboleet-1.0.0.jar and will create a symlink shibboleet.jar -# pointing to the jar with the version information. +# add_jar(shibboleet shibbotleet.java VERSION 1.2.0) # -# add_jar(shibboleet shibbotleet.java VERSION 1.2.0) # -# If the target is a JNI library, utilize the following commands to -# create a JNI symbolic link: # -# set(CMAKE_JNI_TARGET TRUE) -# add_jar(shibboleet shibbotleet.java VERSION 1.2.0) -# install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet) -# install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR}) +# :: # -# If a single target needs to produce more than one jar from its -# java source code, to prevent the accumulation of duplicate class -# files in subsequent jars, set/reset CMAKE_JAR_CLASSES_PREFIX prior -# to calling the add_jar() function: +# If the target is a JNI library, utilize the following commands to +# create a JNI symbolic link: +# +# +# +# :: +# +# set(CMAKE_JNI_TARGET TRUE) +# add_jar(shibboleet shibbotleet.java VERSION 1.2.0) +# install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet) +# install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR}) +# +# +# +# :: +# +# If a single target needs to produce more than one jar from its +# java source code, to prevent the accumulation of duplicate class +# files in subsequent jars, set/reset CMAKE_JAR_CLASSES_PREFIX prior +# to calling the add_jar() function: +# +# +# +# :: +# +# set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo) +# add_jar(foo foo.java) +# +# +# +# :: +# +# set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar) +# add_jar(bar bar.java) # -# set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo) -# add_jar(foo foo.java) # -# set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar) -# add_jar(bar bar.java) # # Target Properties: -# The add_jar() functions sets some target properties. You can get these -# properties with the -# get_property(TARGET <target_name> PROPERTY <propery_name>) -# command. -# -# INSTALL_FILES The files which should be installed. This is used by -# install_jar(). -# JNI_SYMLINK The JNI symlink which should be installed. -# This is used by install_jni_symlink(). -# JAR_FILE The location of the jar file so that you can include -# it. -# CLASS_DIR The directory where the class files can be found. For -# example to use them with javah. +# +# :: +# +# The add_jar() functions sets some target properties. You can get these +# properties with the +# get_property(TARGET <target_name> PROPERTY <propery_name>) +# command. +# +# +# +# :: +# +# INSTALL_FILES The files which should be installed. This is used by +# install_jar(). +# JNI_SYMLINK The JNI symlink which should be installed. +# This is used by install_jni_symlink(). +# JAR_FILE The location of the jar file so that you can include +# it. +# CLASS_DIR The directory where the class files can be found. For +# example to use them with javah. +# +# # # find_jar(<VAR> -# name | NAMES name1 [name2 ...] -# [PATHS path1 [path2 ... ENV var]] -# [VERSIONS version1 [version2]] -# [DOC "cache documentation string"] -# ) # -# This command is used to find a full path to the named jar. A cache -# entry named by <VAR> is created to stor the result of this command. If -# the full path to a jar is found the result is stored in the variable -# and the search will not repeated unless the variable is cleared. If -# nothing is found, the result will be <VAR>-NOTFOUND, and the search -# will be attempted again next time find_jar is invoked with the same -# variable. -# The name of the full path to a file that is searched for is specified -# by the names listed after NAMES argument. Additional search locations -# can be specified after the PATHS argument. If you require special a -# version of a jar file you can specify it with the VERSIONS argument. -# The argument after DOC will be used for the documentation string in -# the cache. +# :: +# +# name | NAMES name1 [name2 ...] +# [PATHS path1 [path2 ... ENV var]] +# [VERSIONS version1 [version2]] +# [DOC "cache documentation string"] +# ) +# +# +# +# This command is used to find a full path to the named jar. A cache +# entry named by <VAR> is created to stor the result of this command. +# If the full path to a jar is found the result is stored in the +# variable and the search will not repeated unless the variable is +# cleared. If nothing is found, the result will be <VAR>-NOTFOUND, and +# the search will be attempted again next time find_jar is invoked with +# the same variable. The name of the full path to a file that is +# searched for is specified by the names listed after NAMES argument. +# Additional search locations can be specified after the PATHS argument. +# If you require special a version of a jar file you can specify it with +# the VERSIONS argument. The argument after DOC will be used for the +# documentation string in the cache. # # install_jar(TARGET_NAME DESTINATION) # @@ -124,75 +224,95 @@ # install_jni_symlink(TARGET_NAME DESTINATION) # # This command installs the TARGET_NAME JNI symlinks to the given -# DESTINATION. It should be called in the same scope as add_jar() -# or it will fail. +# DESTINATION. It should be called in the same scope as add_jar() or it +# will fail. # # create_javadoc(<VAR> -# PACKAGES pkg1 [pkg2 ...] -# [SOURCEPATH <sourcepath>] -# [CLASSPATH <classpath>] -# [INSTALLPATH <install path>] -# [DOCTITLE "the documentation title"] -# [WINDOWTITLE "the title of the document"] -# [AUTHOR TRUE|FALSE] -# [USE TRUE|FALSE] -# [VERSION TRUE|FALSE] -# ) -# -# Create java documentation based on files or packages. For more +# +# :: +# +# PACKAGES pkg1 [pkg2 ...] +# [SOURCEPATH <sourcepath>] +# [CLASSPATH <classpath>] +# [INSTALLPATH <install path>] +# [DOCTITLE "the documentation title"] +# [WINDOWTITLE "the title of the document"] +# [AUTHOR TRUE|FALSE] +# [USE TRUE|FALSE] +# [VERSION TRUE|FALSE] +# ) +# +# +# +# Create java documentation based on files or packages. For more # details please read the javadoc manpage. # -# There are two main signatures for create_javadoc. The first -# signature works with package names on a path with source files: -# -# Example: -# create_javadoc(my_example_doc -# PACKAGES com.exmaple.foo com.example.bar -# SOURCEPATH "${CMAKE_CURRENT_SOURCE_DIR}" -# CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} -# WINDOWTITLE "My example" -# DOCTITLE "<h1>My example</h1>" -# AUTHOR TRUE -# USE TRUE -# VERSION TRUE -# ) +# There are two main signatures for create_javadoc. The first signature +# works with package names on a path with source files: +# +# :: +# +# Example: +# create_javadoc(my_example_doc +# PACKAGES com.exmaple.foo com.example.bar +# SOURCEPATH "${CMAKE_CURRENT_SOURCE_DIR}" +# CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} +# WINDOWTITLE "My example" +# DOCTITLE "<h1>My example</h1>" +# AUTHOR TRUE +# USE TRUE +# VERSION TRUE +# ) +# +# # # The second signature for create_javadoc works on a given list of # files. # -# create_javadoc(<VAR> -# FILES file1 [file2 ...] -# [CLASSPATH <classpath>] -# [INSTALLPATH <install path>] -# [DOCTITLE "the documentation title"] -# [WINDOWTITLE "the title of the document"] -# [AUTHOR TRUE|FALSE] -# [USE TRUE|FALSE] -# [VERSION TRUE|FALSE] -# ) +# :: +# +# create_javadoc(<VAR> +# FILES file1 [file2 ...] +# [CLASSPATH <classpath>] +# [INSTALLPATH <install path>] +# [DOCTITLE "the documentation title"] +# [WINDOWTITLE "the title of the document"] +# [AUTHOR TRUE|FALSE] +# [USE TRUE|FALSE] +# [VERSION TRUE|FALSE] +# ) +# +# # # Example: -# create_javadoc(my_example_doc -# FILES ${example_SRCS} -# CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} -# WINDOWTITLE "My example" -# DOCTITLE "<h1>My example</h1>" -# AUTHOR TRUE -# USE TRUE -# VERSION TRUE -# ) -# -# Both signatures share most of the options. These options are the -# same as what you can find in the javadoc manpage. Please look at -# the manpage for CLASSPATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and -# VERSION. +# +# :: +# +# create_javadoc(my_example_doc +# FILES ${example_SRCS} +# CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} +# WINDOWTITLE "My example" +# DOCTITLE "<h1>My example</h1>" +# AUTHOR TRUE +# USE TRUE +# VERSION TRUE +# ) +# +# +# +# Both signatures share most of the options. These options are the same +# as what you can find in the javadoc manpage. Please look at the +# manpage for CLASSPATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and VERSION. # # The documentation will be by default installed to # -# ${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR> +# :: # -# if you don't set the INSTALLPATH. +# ${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR> # +# +# +# if you don't set the INSTALLPATH. #============================================================================= # Copyright 2013 OpenGamma Ltd. <graham@opengamma.com> diff --git a/Modules/UseJavaClassFilelist.cmake b/Modules/UseJavaClassFilelist.cmake index 6f3a4e7..e8e6f01 100644 --- a/Modules/UseJavaClassFilelist.cmake +++ b/Modules/UseJavaClassFilelist.cmake @@ -1,8 +1,14 @@ +#.rst: +# UseJavaClassFilelist +# -------------------- # -# This script create a list of compiled Java class files to be added to a -# jar file. This avoids including cmake files which get created in the -# binary directory. # +# +# +# +# This script create a list of compiled Java class files to be added to +# a jar file. This avoids including cmake files which get created in +# the binary directory. #============================================================================= # Copyright 2010-2011 Andreas schneider <asn@redhat.com> diff --git a/Modules/UseJavaSymlinks.cmake b/Modules/UseJavaSymlinks.cmake index 88dd768..90ffdd5 100644 --- a/Modules/UseJavaSymlinks.cmake +++ b/Modules/UseJavaSymlinks.cmake @@ -1,6 +1,12 @@ +#.rst: +# UseJavaSymlinks +# --------------- +# +# # -# Helper script for UseJava.cmake # +# +# Helper script for UseJava.cmake #============================================================================= # Copyright 2010-2011 Andreas schneider <asn@redhat.com> diff --git a/Modules/UsePkgConfig.cmake b/Modules/UsePkgConfig.cmake index b1569f9..6a38502 100644 --- a/Modules/UsePkgConfig.cmake +++ b/Modules/UsePkgConfig.cmake @@ -1,15 +1,21 @@ -# - Obsolete pkg-config module for CMake, use FindPkgConfig instead. +#.rst: +# UsePkgConfig +# ------------ +# +# Obsolete pkg-config module for CMake, use FindPkgConfig instead. +# +# # # This module defines the following macro: # # PKGCONFIG(package includedir libdir linkflags cflags) # -# Calling PKGCONFIG will fill the desired information into the 4 given arguments, -# e.g. PKGCONFIG(libart-2.0 LIBART_INCLUDE_DIR LIBART_LINK_DIR LIBART_LINK_FLAGS LIBART_CFLAGS) -# if pkg-config was NOT found or the specified software package doesn't exist, the -# variable will be empty when the function returns, otherwise they will contain +# Calling PKGCONFIG will fill the desired information into the 4 given +# arguments, e.g. PKGCONFIG(libart-2.0 LIBART_INCLUDE_DIR +# LIBART_LINK_DIR LIBART_LINK_FLAGS LIBART_CFLAGS) if pkg-config was NOT +# found or the specified software package doesn't exist, the variable +# will be empty when the function returns, otherwise they will contain # the respective information -# #============================================================================= # Copyright 2006-2009 Kitware, Inc. diff --git a/Modules/UseQt4.cmake b/Modules/UseQt4.cmake index f05a3d5..35090fc 100644 --- a/Modules/UseQt4.cmake +++ b/Modules/UseQt4.cmake @@ -1,7 +1,12 @@ -# - 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. +#.rst: +# UseQt4 +# ------ +# +# 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. #============================================================================= # Copyright 2005-2009 Kitware, Inc. diff --git a/Modules/UseSWIG.cmake b/Modules/UseSWIG.cmake index 2a09585..00f3e21 100644 --- a/Modules/UseSWIG.cmake +++ b/Modules/UseSWIG.cmake @@ -1,22 +1,33 @@ -# - SWIG module for CMake +#.rst: +# UseSWIG +# ------- +# +# 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}. -# Set Source files properties 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. -# Another special variable is CMAKE_SWIG_OUTDIR, it allows one to specify -# where to write all the swig generated module (swig -outdir option) -# The name-specific variable SWIG_MODULE_<name>_EXTRA_DEPS may be used -# to specify extra dependencies for the generated modules. -# If the source file generated by swig need some special flag you can use +# +# :: +# +# 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}. Set Source +# files properties 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. Another special variable is +# CMAKE_SWIG_OUTDIR, it allows one to specify where to write all the +# swig generated module (swig -outdir option) The name-specific variable +# SWIG_MODULE_<name>_EXTRA_DEPS may be used to specify extra +# dependencies for the generated modules. If the source file generated +# by swig need some special flag you can use # set_source_files_properties( ${swig_generated_file_fullname} -# PROPERTIES COMPILE_FLAGS "-bla") +# +# :: +# +# PROPERTIES COMPILE_FLAGS "-bla") #============================================================================= diff --git a/Modules/Use_wxWindows.cmake b/Modules/Use_wxWindows.cmake index 6c95681..d3025ac 100644 --- a/Modules/Use_wxWindows.cmake +++ b/Modules/Use_wxWindows.cmake @@ -1,17 +1,32 @@ +#.rst: +# Use_wxWindows +# ------------- +# +# +# +# +# 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) # -# 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 +# +# :: +# +# just include Use_wxWindows.cmake +# in your projects CMakeLists.txt +# # include( ${CMAKE_MODULE_PATH}/Use_wxWindows.cmake) -## -# if you are sure you need GL then +# +# :: +# +# if you are sure you need GL then +# # set(WXWINDOWS_USE_GL 1) -# *before* you include this file. +# +# :: +# +# *before* you include this file. #============================================================================= # Copyright 2003-2009 Kitware, Inc. diff --git a/Modules/UsewxWidgets.cmake b/Modules/UsewxWidgets.cmake index bb8c29b..f2f260d 100644 --- a/Modules/UsewxWidgets.cmake +++ b/Modules/UsewxWidgets.cmake @@ -1,19 +1,38 @@ -# - Convenience include for using wxWidgets library. -# Determines if wxWidgets was FOUND and sets the appropriate libs, incdirs, -# flags, etc. INCLUDE_DIRECTORIES and LINK_DIRECTORIES are called. +#.rst: +# UsewxWidgets +# ------------ +# +# Convenience include for using wxWidgets library. +# +# Determines if wxWidgets was FOUND and sets the appropriate libs, +# incdirs, flags, etc. INCLUDE_DIRECTORIES and LINK_DIRECTORIES are +# called. # # USAGE -# # Note that for MinGW users the order of libs is important! -# find_package(wxWidgets REQUIRED net gl core base) -# include(${wxWidgets_USE_FILE}) -# # and for each of your dependent executable/library targets: -# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) +# +# :: +# +# # Note that for MinGW users the order of libs is important! +# find_package(wxWidgets REQUIRED net gl core base) +# include(${wxWidgets_USE_FILE}) +# # and for each of your dependent executable/library targets: +# target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES}) +# +# # # DEPRECATED -# LINK_LIBRARIES is not called in favor of adding dependencies per target. +# +# :: +# +# LINK_LIBRARIES is not called in favor of adding dependencies per target. +# +# # # AUTHOR -# Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> +# +# :: +# +# Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> #============================================================================= # Copyright 2004-2009 Kitware, Inc. diff --git a/Modules/WriteBasicConfigVersionFile.cmake b/Modules/WriteBasicConfigVersionFile.cmake index 4466cd7..95187b4 100644 --- a/Modules/WriteBasicConfigVersionFile.cmake +++ b/Modules/WriteBasicConfigVersionFile.cmake @@ -1,4 +1,14 @@ -# WRITE_BASIC_CONFIG_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion) ) +#.rst: +# WriteBasicConfigVersionFile +# --------------------------- +# +# +# +# :: +# +# WRITE_BASIC_CONFIG_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion) ) +# +# # # Deprecated, see WRITE_BASIC_PACKAGE_VERSION_FILE(), it is identical. diff --git a/Modules/readme.txt b/Modules/readme.txt index 2f11994..2593b4f 100644 --- a/Modules/readme.txt +++ b/Modules/readme.txt @@ -58,36 +58,54 @@ 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. -To correctly document a module, create a comment block at the top with # comments. -There are three types of comments that can be in the block: +To add a module to the CMake documentation, follow these steps: -1. The brief description of the module, this is done by: -# - a small description +1. Add file ``Help/module/FindXxx.rst`` containing just the line:: -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. + .. cmake-module:: ../../Modules/FindXxx.cmake -3. A verbatim line. This is done with two spaces between the # and the text. +2. Modify ``Help/manual/cmake-modules.7.rst`` to reference the module in the + toctree directive as:: -For example: + /module/FindXxx -# - 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 great isn't it? -# VAR_REALLY_COOL - cool right? -# + Keep the toctree in sorted order! + +3. Add to the top of ``Modules/FindXxx.cmake`` a #-comment of the form:: + + #.rst: + # FindXxx + # ------- + # + # ...reStructuredText documentation of module... + + Comment blocks starting with the line ``#.rst:`` may appear anywhere + in the file. + +For example:: + + #.rst + # FindXxx + # ------- + # + # This is a cool module. + # This module does really cool stuff. + # It can do even more than you think. + # + # It even needs two paragraphs to tell you about it. + # And it defines the following variables: + # + # * VAR_COOL: this is great isn't it? + # * VAR_REALLY_COOL: cool right? -Test the documentation formatting by running "cmake --help-module FindXxx". -Edit the comments until the output of this command looks satisfactory. +Test the documentation formatting by running "cmake --help-module FindXxx", +and ideally by enabling the SPHINX_HTML and SPHINX_MAN options to build the +documentation. Edit the comments until generated documentation looks +satisfactory. -To have a .cmake file in this directory NOT show up in the -modules documentation, you should start the file with a blank -line. +To have a .cmake file in this directory NOT show up in the modules +documentation, simply leave out the ``Help/module/<module>.rst`` file and the +``Help/manual/cmake-modules.7.rst`` toctree entry. After the documentation, leave a *BLANK* line, and then add a copyright and licence notice block like this one: diff --git a/Source/CMakeInstallDestinations.cmake b/Source/CMakeInstallDestinations.cmake new file mode 100644 index 0000000..33e8ce8 --- /dev/null +++ b/Source/CMakeInstallDestinations.cmake @@ -0,0 +1,36 @@ +# Keep formatting here consistent with bootstrap script expectations. +set(CMAKE_DATA_DIR_DEFAULT "share/cmake-${CMake_VERSION}") # OTHER +if(BEOS) + set(CMAKE_MAN_DIR_DEFAULT "documentation/man") # HAIKU + set(CMAKE_DOC_DIR_DEFAULT "documentation/doc/cmake-${CMake_VERSION}") # HAIKU +elseif(CYGWIN) + set(CMAKE_DOC_DIR_DEFAULT "share/doc/cmake-${CMake_VERSION}") # CYGWIN + set(CMAKE_MAN_DIR_DEFAULT "share/man") # CYGWIN +else() + set(CMAKE_DOC_DIR_DEFAULT "doc/cmake-${CMake_VERSION}") # OTHER + set(CMAKE_MAN_DIR_DEFAULT "man") # OTHER +endif() + +set(CMAKE_DATA_DIR_DESC "data") +set(CMAKE_DOC_DIR_DESC "docs") +set(CMAKE_MAN_DIR_DESC "man pages") + +foreach(v + CMAKE_DATA_DIR + CMAKE_DOC_DIR + CMAKE_MAN_DIR + ) + # Populate the cache with empty values so we know when the user sets them. + set(${v} "" CACHE STRING "") + set_property(CACHE ${v} PROPERTY HELPSTRING + "Location under install prefix for ${${v}_DESC} (default \"${${v}_DEFAULT}\")" + ) + set_property(CACHE ${v} PROPERTY ADVANCED 1) + + # Use the default when the user did not set this variable. + if(NOT ${v}) + set(${v} "${${v}_DEFAULT}") + endif() + # Remove leading slash to treat as relative to install prefix. + string(REGEX REPLACE "^/" "" ${v} "${${v}}") +endforeach() diff --git a/Source/CMakeLists.txt b/Source/CMakeLists.txt index 4144bea..71fae58 100644 --- a/Source/CMakeLists.txt +++ b/Source/CMakeLists.txt @@ -159,16 +159,7 @@ set(SRCS cmDependsJavaParserHelper.h cmDocumentation.cxx cmDocumentationFormatter.cxx - cmDocumentationFormatterHTML.cxx - cmDocumentationFormatterDocbook.cxx - cmDocumentationFormatterMan.cxx - cmDocumentationFormatterText.cxx - cmDocumentationFormatterUsage.cxx cmDocumentationSection.cxx - cmDocumentCompileDefinitions.h - cmDocumentGeneratorExpressions.h - cmDocumentLocationUndefined.h - cmDocumentVariables.cxx cmDynamicLoader.cxx cmDynamicLoader.h ${ELF_SRCS} @@ -261,6 +252,8 @@ set(SRCS cmPropertyMap.h cmQtAutomoc.cxx cmQtAutomoc.h + cmRST.cxx + cmRST.h cmScriptGenerator.h cmScriptGenerator.cxx cmSourceFile.cxx @@ -439,6 +432,7 @@ set(CTEST_SRCS cmCTest.cxx CTest/cmParseCacheCoverage.cxx CTest/cmParseGTMCoverage.cxx CTest/cmParsePHPCoverage.cxx + CTest/cmParsePythonCoverage.cxx CTest/cmCTestEmptyBinaryDirectoryCommand.cxx CTest/cmCTestGenericHandler.cxx CTest/cmCTestHandlerCommand.cxx @@ -496,8 +490,6 @@ set(CPACK_SRCS CPack/cmCPackTarBZip2Generator.cxx CPack/cmCPackTarCompressGenerator.cxx CPack/cmCPackZIPGenerator.cxx - CPack/cmCPackDocumentVariables.cxx - CPack/cmCPackDocumentMacros.cxx ) if(CYGWIN) diff --git a/Source/CMakeVersion.cmake b/Source/CMakeVersion.cmake index e7d0bb7..b5d8520 100644 --- a/Source/CMakeVersion.cmake +++ b/Source/CMakeVersion.cmake @@ -2,5 +2,5 @@ set(CMake_VERSION_MAJOR 2) set(CMake_VERSION_MINOR 8) set(CMake_VERSION_PATCH 12) -set(CMake_VERSION_TWEAK 20131007) +set(CMake_VERSION_TWEAK 20131018) #set(CMake_VERSION_RC 1) diff --git a/Source/CMakeVersionCompute.cmake b/Source/CMakeVersionCompute.cmake new file mode 100644 index 0000000..a166334 --- /dev/null +++ b/Source/CMakeVersionCompute.cmake @@ -0,0 +1,23 @@ +# Load version number components. +include(${CMake_SOURCE_DIR}/Source/CMakeVersion.cmake) + +# Releases define a small tweak level. +if("${CMake_VERSION_TWEAK}" VERSION_LESS 20000000) + set(CMake_VERSION_IS_RELEASE 1) + set(CMake_VERSION_SOURCE "") +else() + set(CMake_VERSION_IS_RELEASE 0) + include(${CMake_SOURCE_DIR}/Source/CMakeVersionSource.cmake) +endif() + +# Compute the full version string. +set(CMake_VERSION ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}) +if(${CMake_VERSION_TWEAK} GREATER 0) + set(CMake_VERSION ${CMake_VERSION}.${CMake_VERSION_TWEAK}) +endif() +if(CMake_VERSION_RC) + set(CMake_VERSION ${CMake_VERSION}-rc${CMake_VERSION_RC}) +endif() +if(CMake_VERSION_SOURCE) + set(CMake_VERSION ${CMake_VERSION}-${CMake_VERSION_SOURCE}) +endif() diff --git a/Source/CPack/WiX/cmCPackWIXGenerator.cxx b/Source/CPack/WiX/cmCPackWIXGenerator.cxx index cc9dec7..725810b 100644 --- a/Source/CPack/WiX/cmCPackWIXGenerator.cxx +++ b/Source/CPack/WiX/cmCPackWIXGenerator.cxx @@ -1,6 +1,6 @@ /*============================================================================ CMake - Cross Platform Makefile Generator - Copyright 2000-2012 Kitware, Inc., Insight Software Consortium + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium Distributed under the OSI-approved BSD License (the "License"); see accompanying file Copyright.txt for details. @@ -14,6 +14,7 @@ #include <cmSystemTools.h> #include <cmGeneratedFileStream.h> +#include <cmCryptoHash.h> #include <CPack/cmCPackLog.h> #include <CPack/cmCPackComponentGroup.h> @@ -189,6 +190,8 @@ bool cmCPackWIXGenerator::PackageFilesImpl() return false; } + AppendUserSuppliedExtraSources(); + std::stringstream objectFiles; for(size_t i = 0; i < wixSources.size(); ++i) { @@ -205,9 +208,35 @@ bool cmCPackWIXGenerator::PackageFilesImpl() objectFiles << " " << QuotePath(objectFilename); } + AppendUserSuppliedExtraObjects(objectFiles); + return RunLightCommand(objectFiles.str()); } +void cmCPackWIXGenerator::AppendUserSuppliedExtraSources() +{ + const char *cpackWixExtraSources = GetOption("CPACK_WIX_EXTRA_SOURCES"); + if(!cpackWixExtraSources) return; + + cmSystemTools::ExpandListArgument(cpackWixExtraSources, wixSources); +} + +void cmCPackWIXGenerator::AppendUserSuppliedExtraObjects(std::ostream& stream) +{ + const char *cpackWixExtraObjects = GetOption("CPACK_WIX_EXTRA_OBJECTS"); + if(!cpackWixExtraObjects) return; + + std::vector<std::string> expandedExtraObjects; + + cmSystemTools::ExpandListArgument( + cpackWixExtraObjects, expandedExtraObjects); + + for(size_t i = 0; i < expandedExtraObjects.size(); ++i) + { + stream << " " << QuotePath(expandedExtraObjects[i]); + } +} + bool cmCPackWIXGenerator::CreateWiXVariablesIncludeFile() { std::string cpackTopLevel; @@ -319,9 +348,6 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles() directoryDefinitions.AddAttribute("Name", install_root[i]); } - size_t directoryCounter = 0; - size_t fileCounter = 0; - std::string fileDefinitionsFilename = cpackTopLevel + "/files.wxs"; @@ -367,7 +393,8 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles() if (!cpackVendor || !cpackPkgName) { cmCPackLogger(cmCPackLog::LOG_WARNING, "CPACK_PACKAGE_VENDOR and " - "CPACK_PACKAGE_NAME must be defined for shortcut creation" << std::endl); + "CPACK_PACKAGE_NAME must be defined for shortcut creation" + << std::endl); cpackPkgExecutables.clear(); } else @@ -380,7 +407,7 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles() AddDirectoryAndFileDefinitons( toplevel, "INSTALL_ROOT", directoryDefinitions, fileDefinitions, featureDefinitions, - directoryCounter, fileCounter, cpackPkgExecutables, dirIdExecutables); + cpackPkgExecutables, dirIdExecutables); directoryDefinitions.EndElement(); directoryDefinitions.EndElement(); @@ -403,7 +430,10 @@ bool cmCPackWIXGenerator::CreateWiXSourceFiles() std::string directoryId = *it; fileDefinitions.BeginElement("Shortcut"); - std::string shortcutName = fileName; // the iconName is mor likely to contain blanks early on + + // the iconName is more likely to contain blanks early on + std::string shortcutName = fileName; + std::string::size_type const dotPos = shortcutName.find('.'); if(std::string::npos == dotPos) { shortcutName = shortcutName.substr(0, dotPos); } @@ -531,8 +561,6 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons( cmWIXSourceWriter& directoryDefinitions, cmWIXSourceWriter& fileDefinitions, cmWIXSourceWriter& featureDefinitions, - size_t& directoryCounter, - size_t& fileCounter, const std::vector<std::string>& pkgExecutables, std::vector<std::string>& dirIdExecutables) { @@ -550,11 +578,14 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons( std::string fullPath = topdir + "/" + fileName; + std::string relativePath = cmSystemTools::RelativePath( + toplevel.c_str(), fullPath.c_str()); + + std::string id = PathToId(relativePath); + if(cmSystemTools::FileIsDirectory(fullPath.c_str())) { - std::stringstream tmp; - tmp << "DIR_ID_" << ++directoryCounter; - std::string subDirectoryId = tmp.str(); + std::string subDirectoryId = std::string("CM_D") + id; directoryDefinitions.BeginElement("Directory"); directoryDefinitions.AddAttribute("Id", subDirectoryId); @@ -565,20 +596,14 @@ void cmCPackWIXGenerator::AddDirectoryAndFileDefinitons( directoryDefinitions, fileDefinitions, featureDefinitions, - directoryCounter, - fileCounter, pkgExecutables, dirIdExecutables); directoryDefinitions.EndElement(); } else { - std::stringstream tmp; - tmp << "_ID_" << ++fileCounter; - std::string idSuffix = tmp.str(); - - std::string componentId = std::string("CMP") + idSuffix; - std::string fileId = std::string("FILE") + idSuffix; + std::string componentId = std::string("CM_C") + id; + std::string fileId = std::string("CM_F") + id; fileDefinitions.BeginElement("DirectoryRef"); fileDefinitions.AddAttribute("Id", directoryId); @@ -686,3 +711,119 @@ std::string cmCPackWIXGenerator::GetRightmostExtension( return cmSystemTools::LowerCase(extension); } + +std::string cmCPackWIXGenerator::PathToId(const std::string& path) +{ + id_map_t::const_iterator i = pathToIdMap.find(path); + if(i != pathToIdMap.end()) return i->second; + + std::string id = CreateNewIdForPath(path); + return id; +} + +std::string cmCPackWIXGenerator::CreateNewIdForPath(const std::string& path) +{ + std::vector<std::string> components; + cmSystemTools::SplitPath(path.c_str(), components, false); + + size_t replacementCount = 0; + + std::string identifier; + std::string currentComponent; + + for(size_t i = 1; i < components.size(); ++i) + { + if(i != 1) identifier += '.'; + + currentComponent = NormalizeComponentForId( + components[i], replacementCount); + + identifier += currentComponent; + } + + std::string idPrefix = "P"; + size_t replacementPercent = replacementCount * 100 / identifier.size(); + if(replacementPercent > 33 || identifier.size() > 60) + { + identifier = CreateHashedId(path, currentComponent); + idPrefix = "H"; + } + + std::stringstream result; + result << idPrefix << "_" << identifier; + + size_t ambiguityCount = ++idAmbiguityCounter[identifier]; + + if(ambiguityCount > 999) + { + cmCPackLogger(cmCPackLog::LOG_ERROR, + "Error while trying to generate a unique Id for '" << + path << "'" << std::endl); + + return std::string(); + } + else if(ambiguityCount > 1) + { + result << "_" << ambiguityCount; + } + + std::string resultString = result.str(); + + pathToIdMap[path] = resultString; + + return resultString; +} + +std::string cmCPackWIXGenerator::CreateHashedId( + const std::string& path, const std::string& normalizedFilename) +{ + cmsys::auto_ptr<cmCryptoHash> sha1 = cmCryptoHash::New("SHA1"); + std::string hash = sha1->HashString(path.c_str()); + + std::string identifier; + identifier += hash.substr(0, 7) + "_"; + + const size_t maxFileNameLength = 52; + if(normalizedFilename.length() > maxFileNameLength) + { + identifier += normalizedFilename.substr(0, maxFileNameLength - 3); + identifier += "..."; + } + else + { + identifier += normalizedFilename; + } + + return identifier; +} + +std::string cmCPackWIXGenerator::NormalizeComponentForId( + const std::string& component, size_t& replacementCount) +{ + std::string result; + result.resize(component.size()); + + for(size_t i = 0; i < component.size(); ++i) + { + char c = component[i]; + if(IsLegalIdCharacter(c)) + { + result[i] = c; + } + else + { + result[i] = '_'; + ++ replacementCount; + } + } + + return result; +} + +bool cmCPackWIXGenerator::IsLegalIdCharacter(char c) +{ + return (c >= '0' && c <= '9') || + (c >= 'a' && c <= 'z') || + (c >= 'A' && c <= 'Z') || + c == '_' || c == '.'; +} diff --git a/Source/CPack/WiX/cmCPackWIXGenerator.h b/Source/CPack/WiX/cmCPackWIXGenerator.h index aaccf9d..eac69fe 100644 --- a/Source/CPack/WiX/cmCPackWIXGenerator.h +++ b/Source/CPack/WiX/cmCPackWIXGenerator.h @@ -54,6 +54,9 @@ protected: } private: + typedef std::map<std::string, std::string> id_map_t; + typedef std::map<std::string, size_t> ambiguity_map_t; + bool InitializeWiXConfiguration(); bool PackageFilesImpl(); @@ -68,6 +71,10 @@ private: bool CreateWiXSourceFiles(); + void AppendUserSuppliedExtraSources(); + + void AppendUserSuppliedExtraObjects(std::ostream& stream); + bool CreateLicenseFile(); bool RunWiXCommand(const std::string& command); @@ -82,13 +89,10 @@ private: cmWIXSourceWriter& directoryDefinitions, cmWIXSourceWriter& fileDefinitions, cmWIXSourceWriter& featureDefinitions, - size_t& directoryCounter, - size_t& fileCounter, const std::vector<std::string>& pkgExecutables, std::vector<std::string>& dirIdExecutables ); - bool RequireOption(const std::string& name, std::string& value) const; std::string GetArchitecture() const; @@ -99,7 +103,21 @@ private: static std::string GetRightmostExtension(const std::string& filename); + std::string PathToId(const std::string& path); + + std::string CreateNewIdForPath(const std::string& path); + + static std::string CreateHashedId( + const std::string& path, const std::string& normalizedFilename); + + std::string NormalizeComponentForId( + const std::string& component, size_t& replacementCount); + + static bool IsLegalIdCharacter(char c); + std::vector<std::string> wixSources; + id_map_t pathToIdMap; + ambiguity_map_t idAmbiguityCounter; }; #endif diff --git a/Source/CPack/cmCPackDocumentMacros.cxx b/Source/CPack/cmCPackDocumentMacros.cxx deleted file mode 100644 index ddc75a4..0000000 --- a/Source/CPack/cmCPackDocumentMacros.cxx +++ /dev/null @@ -1,16 +0,0 @@ -#include "cmCPackDocumentMacros.h" - -void cmCPackDocumentMacros::GetMacrosDocumentation( - std::vector<cmDocumentationEntry>& ) -{ - // Commented-out example of use - // - // cmDocumentationEntry e("cpack_<macro>", - // "Brief Description" - // "which may be on several lines.", - // "Long description in pre-formatted format" - // " blah\n" - // " blah\n" - //); - //v.push_back(e); -} diff --git a/Source/CPack/cmCPackDocumentMacros.h b/Source/CPack/cmCPackDocumentMacros.h deleted file mode 100644 index 544f74f..0000000 --- a/Source/CPack/cmCPackDocumentMacros.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmCPackDocumentMacros_h -#define cmCPackDocumentMacros_h -#include "cmStandardIncludes.h" -class cmCPackDocumentMacros -{ -public: - static void GetMacrosDocumentation(std::vector<cmDocumentationEntry>& v); -}; - -#endif diff --git a/Source/CPack/cmCPackDocumentVariables.cxx b/Source/CPack/cmCPackDocumentVariables.cxx deleted file mode 100644 index 8b16ae9..0000000 --- a/Source/CPack/cmCPackDocumentVariables.cxx +++ /dev/null @@ -1,122 +0,0 @@ -#include "cmCPackDocumentVariables.h" -#include "cmake.h" - -void cmCPackDocumentVariables::DefineVariables(cmake* cm) -{ - // Subsection: variables defined/used by cpack, - // which are common to all CPack generators - - cm->DefineProperty - ("CPACK_PACKAGING_INSTALL_PREFIX", cmProperty::VARIABLE, - "The prefix used in the built package.", - "Each CPack generator has a default value (like /usr)." - " This default value may" - " be overwritten from the CMakeLists.txt or the cpack command line" - " by setting an alternative value.\n" - "e.g. " - " set(CPACK_PACKAGING_INSTALL_PREFIX \"/opt\")\n" - "This is not the same purpose as CMAKE_INSTALL_PREFIX which" - " is used when installing from the build tree without building" - " a package." - "", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE, - "Boolean toggle to include/exclude top level directory.", - "When preparing a package CPack installs the item under" - " the so-called top level directory. The purpose of" - " is to include (set to 1 or ON or TRUE) the top level directory" - " in the package or not (set to 0 or OFF or FALSE).\n" - "Each CPack generator has a built-in default value for this" - " variable. E.g. Archive generators (ZIP, TGZ, ...) includes" - " the top level whereas RPM or DEB don't. The user may override" - " the default value by setting this variable.\n" - "There is a similar variable " - "CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY " - "which may be used to override the behavior for the component" - " packaging case which may have different default value for" - " historical (now backward compatibility) reason.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE, - "Boolean toggle to include/exclude top level directory " - "(component case).", - "Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY" - " but for the component case. " - "See CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation for" - " the detail.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_SET_DESTDIR", cmProperty::VARIABLE, - "Boolean toggle to make CPack use DESTDIR mechanism when" - " packaging.", "DESTDIR means DESTination DIRectory." - " It is commonly used by makefile " - "users in order to install software at non-default location. It " - "is a basic relocation mechanism that should not be used on" - " Windows (see CMAKE_INSTALL_PREFIX documentation). " - "It is usually invoked like this:\n" - " make DESTDIR=/home/john install\n" - "which will install the concerned software using the" - " installation prefix, e.g. \"/usr/local\" prepended with " - "the DESTDIR value which finally gives \"/home/john/usr/local\"." - " When preparing a package, CPack first installs the items to be " - "packaged in a local (to the build tree) directory by using the " - "same DESTDIR mechanism. Nevertheless, if " - "CPACK_SET_DESTDIR is set then CPack will set DESTDIR before" - " doing the local install. The most noticeable difference is" - " that without CPACK_SET_DESTDIR, CPack uses " - "CPACK_PACKAGING_INSTALL_PREFIX as a prefix whereas with " - "CPACK_SET_DESTDIR set, CPack will use CMAKE_INSTALL_PREFIX as" - " a prefix.\n" - "Manually setting CPACK_SET_DESTDIR may help (or simply be" - " necessary) if some install rules uses absolute " - "DESTINATION (see CMake INSTALL command)." - " However, starting with" - " CPack/CMake 2.8.3 RPM and DEB installers tries to handle DESTDIR" - " automatically so that it is seldom necessary for the user to set" - " it.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_INSTALL_SCRIPT", cmProperty::VARIABLE, - "Extra CMake script provided by the user.", - "If set this CMake script will be executed by CPack " - "during its local [CPack-private] installation " - "which is done right before packaging the files." - " The script is not called by e.g.: make install.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_ABSOLUTE_DESTINATION_FILES", cmProperty::VARIABLE, - "List of files which have been installed using " - " an ABSOLUTE DESTINATION path.", - "This variable is a Read-Only variable which is set internally" - " by CPack during installation and before packaging using" - " CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake " - "scripts. The value can be used within CPack project configuration" - " file and/or CPack<GEN>.cmake file of <GEN> generator.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask CPack to warn each time a file with absolute INSTALL" - " DESTINATION is encountered.", - "This variable triggers the definition of " - "CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs" - " cmake_install.cmake scripts.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask CPack to error out as soon as a file with absolute INSTALL" - " DESTINATION is encountered.", - "The fatal error is emitted before the installation of " - "the offending file takes place. Some CPack generators, like NSIS," - "enforce this internally. " - "This variable triggers the definition of" - "CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs" - "Variables common to all CPack generators"); -} diff --git a/Source/CPack/cmCPackDocumentVariables.h b/Source/CPack/cmCPackDocumentVariables.h deleted file mode 100644 index e7971be..0000000 --- a/Source/CPack/cmCPackDocumentVariables.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmCPackDocumentVariables_h -#define cmCPackDocumentVariables_h -class cmake; -class cmCPackDocumentVariables -{ -public: - static void DefineVariables(cmake* cm); -}; - -#endif diff --git a/Source/CPack/cmCPackGenerator.cxx b/Source/CPack/cmCPackGenerator.cxx index 3c685bd..63a7596 100644 --- a/Source/CPack/cmCPackGenerator.cxx +++ b/Source/CPack/cmCPackGenerator.cxx @@ -26,7 +26,8 @@ #include <algorithm> #if defined(__HAIKU__) -#include <StorageKit.h> +#include <FindDirectory.h> +#include <StorageDefs.h> #endif //---------------------------------------------------------------------- @@ -1263,14 +1264,14 @@ const char* cmCPackGenerator::GetInstallPath() this->InstallPath += "-"; this->InstallPath += this->GetOption("CPACK_PACKAGE_VERSION"); #elif defined(__HAIKU__) - BPath dir; - if (find_directory(B_COMMON_DIRECTORY, &dir) == B_OK) + char dir[B_PATH_NAME_LENGTH]; + if (find_directory(B_SYSTEM_DIRECTORY, -1, false, dir, sizeof(dir)) == B_OK) { - this->InstallPath = dir.Path(); + this->InstallPath = dir; } else { - this->InstallPath = "/boot/common"; + this->InstallPath = "/boot/system"; } #else this->InstallPath = "/usr/local/"; diff --git a/Source/CPack/cpack.cxx b/Source/CPack/cpack.cxx index b188918..169ae9a 100644 --- a/Source/CPack/cpack.cxx +++ b/Source/CPack/cpack.cxx @@ -14,8 +14,6 @@ // Need these for documentation support. #include "cmake.h" #include "cmDocumentation.h" -#include "cmCPackDocumentVariables.h" -#include "cmCPackDocumentMacros.h" #include "cmCPackGeneratorFactory.h" #include "cmCPackGenerator.h" #include "cmake.h" @@ -29,112 +27,35 @@ #include <cmsys/SystemTools.hxx> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cpack - Packaging driver provided by CMake.", 0}, - {0,0,0} + " cpack - Packaging driver provided by CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, - " cpack -G <generator> [options]", - 0}, - {0,0,0} + " cpack -G <generator> [options]"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = +static const char * cmDocumentationOptions[][2] = { - {0, - "The \"cpack\" executable is the CMake packaging program. " - "CMake-generated build trees created for projects that use " - "the INSTALL_* commands have packaging support. " - "This program will generate the package.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = -{ - {"-G <generator>", "Use the specified generator to generate package.", - "CPack may support multiple native packaging systems on certain " - "platforms. A generator is responsible for generating input files for " - "particular system and invoking that systems. Possible generator names " - "are specified in the Generators section." }, - {"-C <Configuration>", "Specify the project configuration", - "This option specifies the configuration that the project was build " - "with, for example 'Debug', 'Release'." }, - {"-D <var>=<value>", "Set a CPack variable.", \ - "Set a variable that can be used by the generator."}, \ - {"--config <config file>", "Specify the config file.", - "Specify the config file to use to create the package. By default " - "CPackConfig.cmake in the current directory will be used." }, - {"--verbose,-V","enable verbose output","Run cpack with verbose output."}, - {"--debug","enable debug output (for CPack developers)", - "Run cpack with debug output (for CPack developers)."}, - {"-P <package name>","override/define CPACK_PACKAGE_NAME", - "If the package name is not specified on cpack commmand line then" - "CPack.cmake defines it as CMAKE_PROJECT_NAME"}, - {"-R <package version>","override/define CPACK_PACKAGE_VERSION", - "If version is not specified on cpack command line then" - "CPack.cmake defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]" - "look into CPack.cmake for detail"}, - {"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY", - "The directory where CPack will be doing its packaging work." - "The resulting package will be found there. Inside this directory" - "CPack creates '_CPack_Packages' sub-directory which is the" - "CPack temporary directory."}, - {"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR", - "If vendor is not specified on cpack command line " - "(or inside CMakeLists.txt) then" - "CPack.cmake defines it with a default value"}, - {"--help-command cmd [file]", "Print help for a single command and exit.", - "Full documentation specific to the given command is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-command-list [file]", "List available commands and exit.", - "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 documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-commands [file]", "Print help for all commands and exit.", - "Full documentation specific for all current command is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable var [file]", - "Print help for a single variable and exit.", - "Full documentation specific to the given variable is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable-list [file]", "List documented variables and exit.", - "The list contains all variables for which help may be obtained by using " - "the --help-variable argument followed by a variable name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variables [file]", "Print help for all variables and exit.", - "Full documentation for all variables is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ccmake", 0}, - {0, 0, 0} + {"-G <generator>", "Use the specified generator to generate package."}, + {"-C <Configuration>", "Specify the project configuration"}, + {"-D <var>=<value>", "Set a CPack variable."}, + {"--config <config file>", "Specify the config file."}, + {"--verbose,-V","enable verbose output"}, + {"--debug","enable debug output (for CPack developers)"}, + {"-P <package name>","override/define CPACK_PACKAGE_NAME"}, + {"-R <package version>","override/define CPACK_PACKAGE_VERSION"}, + {"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY"}, + {"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR"}, + {0,0} }; //---------------------------------------------------------------------------- @@ -307,6 +228,7 @@ int main (int argc, char *argv[]) // This part is used for cpack documentation lookup as well. cminst.AddCMakePaths(); + doc.SetCMakeRoot(cminst.GetCacheDefinition("CMAKE_ROOT")); if ( parsed && !help ) { @@ -533,43 +455,8 @@ int main (int argc, char *argv[]) doc.SetName("cpack"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.PrependSection("Options",cmDocumentationOptions); - // statically (in C++ code) defined variables - cmCPackDocumentVariables::DefineVariables(&cminst); - - std::vector<cmDocumentationEntry> commands; - - std::string docedFile; - std::string docPath; - cmDocumentation::documentedModulesList_t docedModList; - - docedFile = globalMF->GetModulesFile("CPack.cmake"); - if (docedFile.length()!=0) - { - docPath = cmSystemTools::GetFilenamePath(docedFile.c_str()); - doc.getDocumentedModulesListInDir(docPath,"CPack*.cmake",docedModList); - } - - // parse the files for documentation. - cmDocumentation::documentedModulesList_t::iterator docedIt; - for (docedIt = docedModList.begin(); - docedIt!= docedModList.end(); ++docedIt) - { - doc.GetStructuredDocFromFile( - (docedIt->first).c_str(), - commands,&cminst); - } - - std::map<std::string,cmDocumentationSection *> propDocs; - cminst.GetPropertiesDocumentation(propDocs); - doc.SetSections(propDocs); - cminst.GetCommandDocumentation(commands,true,false); - // statically (in C++ code) defined macros/commands - cmCPackDocumentMacros::GetMacrosDocumentation(commands); - doc.SetSection("Commands",commands); - std::vector<cmDocumentationEntry> v; cmCPackGeneratorFactory::DescriptionsMap::const_iterator generatorIt; for( generatorIt = generators.GetGeneratorsList().begin(); @@ -579,12 +466,10 @@ int main (int argc, char *argv[]) cmDocumentationEntry e; e.Name = generatorIt->first.c_str(); e.Brief = generatorIt->second.c_str(); - e.Full = ""; v.push_back(e); } doc.SetSection("Generators",v); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); #undef cout return doc.PrintRequestedDocumentation(std::cout)? 0:1; #define cout no_cout_use_cmCPack_Log diff --git a/Source/CTest/cmCTestBuildCommand.h b/Source/CTest/cmCTestBuildCommand.h index cabc39b..08887fe 100644 --- a/Source/CTest/cmCTestBuildCommand.h +++ b/Source/CTest/cmCTestBuildCommand.h @@ -45,34 +45,8 @@ public: */ virtual const char* GetName() const { return "ctest_build";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Build the project."; - } virtual bool InitialPass(std::vector<std::string> const& args, cmExecutionStatus &status); - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res]\n" - " [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n" - "Builds the given build directory and stores results in Build.xml. " - "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used.\n" - "The TARGET variable can be used to specify a build target. If none " - "is specified, the \"all\" target will be built.\n" - "The RETURN_VALUE option specifies a variable in which to store the " - "return value of the native build tool. " - "The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in " - "which to store the number of build errors and warnings detected." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand); diff --git a/Source/CTest/cmCTestConfigureCommand.h b/Source/CTest/cmCTestConfigureCommand.h index b343fc1..b592c5a 100644 --- a/Source/CTest/cmCTestConfigureCommand.h +++ b/Source/CTest/cmCTestConfigureCommand.h @@ -40,34 +40,6 @@ public: */ virtual const char* GetName() const { return "ctest_configure";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Configure the project build tree."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]\n" - " [OPTIONS options] [RETURN_VALUE res])\n" - "Configures the given build directory and stores results in " - "Configure.xml. " - "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. " - "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. " - "The OPTIONS argument specifies command line arguments to pass to " - "the configuration tool. " - "The RETURN_VALUE option specifies a variable in which to store the " - "return value of the native build tool." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestCoverageCommand.h b/Source/CTest/cmCTestCoverageCommand.h index 2fe762c..11bb411 100644 --- a/Source/CTest/cmCTestCoverageCommand.h +++ b/Source/CTest/cmCTestCoverageCommand.h @@ -41,32 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_coverage";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Collect coverage tool results."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n" - " [LABELS label1 [label2 [...]]])\n" - "Perform the coverage of the given build directory and stores results " - "in Coverage.xml. The second argument is a variable that will hold " - "value." - "\n" - "The LABELS option filters the coverage report to include only " - "source files labeled with at least one of the labels specified." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestCoverageHandler.cxx b/Source/CTest/cmCTestCoverageHandler.cxx index 20aded2..ef071b9 100644 --- a/Source/CTest/cmCTestCoverageHandler.cxx +++ b/Source/CTest/cmCTestCoverageHandler.cxx @@ -11,6 +11,7 @@ ============================================================================*/ #include "cmCTestCoverageHandler.h" #include "cmParsePHPCoverage.h" +#include "cmParsePythonCoverage.h" #include "cmParseGTMCoverage.h" #include "cmParseCacheCoverage.h" #include "cmCTest.h" @@ -392,6 +393,13 @@ int cmCTestCoverageHandler::ProcessHandler() { return error; } + file_count += this->HandlePythonCoverage(&cont); + error = cont.Error; + if ( file_count < 0 ) + { + return error; + } + file_count += this->HandleMumpsCoverage(&cont); error = cont.Error; if ( file_count < 0 ) @@ -761,6 +769,32 @@ int cmCTestCoverageHandler::HandlePHPCoverage( } return static_cast<int>(cont->TotalCoverage.size()); } + +//---------------------------------------------------------------------- +int cmCTestCoverageHandler::HandlePythonCoverage( + cmCTestCoverageHandlerContainer* cont) +{ + cmParsePythonCoverage cov(*cont, this->CTest); + + // Assume the coverage.xml is in the source directory + std::string coverageXMLFile = this->CTest->GetBinaryDir() + "/coverage.xml"; + + if(cmSystemTools::FileExists(coverageXMLFile.c_str())) + { + cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, + "Parsing coverage.py XML file: " << coverageXMLFile + << std::endl); + cov.ReadCoverageXML(coverageXMLFile.c_str()); + } + else + { + cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, + "Cannot find coverage.py XML file: " << coverageXMLFile + << std::endl); + } + return static_cast<int>(cont->TotalCoverage.size()); +} + //---------------------------------------------------------------------- int cmCTestCoverageHandler::HandleMumpsCoverage( cmCTestCoverageHandlerContainer* cont) diff --git a/Source/CTest/cmCTestCoverageHandler.h b/Source/CTest/cmCTestCoverageHandler.h index 92b0b22..3506928 100644 --- a/Source/CTest/cmCTestCoverageHandler.h +++ b/Source/CTest/cmCTestCoverageHandler.h @@ -70,6 +70,10 @@ private: //! Handle coverage using xdebug php coverage int HandlePHPCoverage(cmCTestCoverageHandlerContainer* cont); + + //! Handle coverage for Python with coverage.py + int HandlePythonCoverage(cmCTestCoverageHandlerContainer* cont); + //! Handle coverage for mumps int HandleMumpsCoverage(cmCTestCoverageHandlerContainer* cont); diff --git a/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h b/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h index a763fe9..07e59a4 100644 --- a/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h +++ b/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h @@ -50,26 +50,6 @@ public: */ virtual const char* GetName() const { return "ctest_empty_binary_directory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "empties the binary directory"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_empty_binary_directory( directory )\n" - "Removes a binary directory. This command will perform some checks " - "prior to deleting the directory in an attempt to avoid malicious " - "or accidental directory deletion."; - } - cmTypeMacro(cmCTestEmptyBinaryDirectoryCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestMemCheckCommand.h b/Source/CTest/cmCTestMemCheckCommand.h index 6db47ae..b50170d 100644 --- a/Source/CTest/cmCTestMemCheckCommand.h +++ b/Source/CTest/cmCTestMemCheckCommand.h @@ -43,40 +43,6 @@ public: */ virtual const char* GetName() const { return "ctest_memcheck";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Run tests with a dynamic analysis tool."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n" - " [START start number] [END end number]\n" - " [STRIDE stride number] [EXCLUDE exclude regex ]\n" - " [INCLUDE include regex] \n" - " [EXCLUDE_LABEL exclude regex] \n" - " [INCLUDE_LABEL label regex] \n" - " [PARALLEL_LEVEL level] )\n" - "Tests the given build directory and stores results in MemCheck.xml. " - "The second argument is a variable that will hold value. Optionally, " - "you can specify the starting test number START, the ending test number " - "END, the number of tests to skip between each test STRIDE, a regular " - "expression for tests to run INCLUDE, or a regular expression for tests " - "not to run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular " - "expressions for tests to be included or excluded by the test " - "property LABEL. PARALLEL_LEVEL should be set to a positive number " - "representing the number of tests to be run in parallel." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand); protected: diff --git a/Source/CTest/cmCTestReadCustomFilesCommand.h b/Source/CTest/cmCTestReadCustomFilesCommand.h index b984c84..9c0af81 100644 --- a/Source/CTest/cmCTestReadCustomFilesCommand.h +++ b/Source/CTest/cmCTestReadCustomFilesCommand.h @@ -48,25 +48,6 @@ public: */ virtual const char* GetName() const { return "ctest_read_custom_files";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "read CTestCustom files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_read_custom_files( directory ... )\n" - "Read all the CTestCustom.ctest or CTestCustom.cmake files from " - "the given directory."; - } - cmTypeMacro(cmCTestReadCustomFilesCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestRunScriptCommand.h b/Source/CTest/cmCTestRunScriptCommand.h index 05e7899..f34bd13 100644 --- a/Source/CTest/cmCTestRunScriptCommand.h +++ b/Source/CTest/cmCTestRunScriptCommand.h @@ -49,30 +49,6 @@ public: */ virtual const char* GetName() const { return "ctest_run_script";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "runs a ctest -S script"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 \n" - " script_file_name2 ... [RETURN_VALUE var])\n" - "Runs a script or scripts much like if it was run from ctest -S. " - "If no argument is provided then the current script is run using " - "the current settings of the variables. If NEW_PROCESS is specified " - "then each script will be run in a separate process." - "If RETURN_VALUE is specified the return value of the last script " - "run will be put into var."; - } - cmTypeMacro(cmCTestRunScriptCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestScriptHandler.cxx b/Source/CTest/cmCTestScriptHandler.cxx index 8643cb3..64bcd59 100644 --- a/Source/CTest/cmCTestScriptHandler.cxx +++ b/Source/CTest/cmCTestScriptHandler.cxx @@ -361,12 +361,6 @@ void cmCTestScriptHandler::CreateCMake() this->AddCTestCommand(new cmCTestUploadCommand); } -void cmCTestScriptHandler::GetCommandDocumentation( - std::vector<cmDocumentationEntry>& v) const -{ - this->CMake->GetCommandDocumentation(v); -} - //---------------------------------------------------------------------- // this sets up some variables for the script to use, creates the required // cmake instance and generators, and then reads in the script diff --git a/Source/CTest/cmCTestScriptHandler.h b/Source/CTest/cmCTestScriptHandler.h index 9d852ca..80d5831 100644 --- a/Source/CTest/cmCTestScriptHandler.h +++ b/Source/CTest/cmCTestScriptHandler.h @@ -110,7 +110,6 @@ public: void Initialize(); void CreateCMake(); - void GetCommandDocumentation(std::vector<cmDocumentationEntry>& v) const; cmake* GetCMake() { return this->CMake;} private: // reads in a script diff --git a/Source/CTest/cmCTestSleepCommand.h b/Source/CTest/cmCTestSleepCommand.h index 0f51ddf..c6baf1c 100644 --- a/Source/CTest/cmCTestSleepCommand.h +++ b/Source/CTest/cmCTestSleepCommand.h @@ -49,26 +49,6 @@ public: */ virtual const char* GetName() const { return "ctest_sleep";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "sleeps for some amount of time"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_sleep(<seconds>)\n" - "Sleep for given number of seconds.\n" - " ctest_sleep(<time1> <duration> <time2>)\n" - "Sleep for t=(time1 + duration - time2) seconds if t > 0."; - } - cmTypeMacro(cmCTestSleepCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestStartCommand.h b/Source/CTest/cmCTestStartCommand.h index 6be4770..e5535c1 100644 --- a/Source/CTest/cmCTestStartCommand.h +++ b/Source/CTest/cmCTestStartCommand.h @@ -57,30 +57,6 @@ public: */ virtual const char* GetName() const { return "ctest_start";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the testing for a given model"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_start(Model [TRACK <track>] [APPEND] [source [binary]])\n" - "Starts the testing for a given model. The command should be called " - "after the binary directory is initialized. If the 'source' and " - "'binary' directory are not specified, it reads the " - "CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is " - "specified, the submissions will go to the specified track. " - "If APPEND is used, the existing TAG is used rather than " - "creating a new one based on the current time stamp."; - } - cmTypeMacro(cmCTestStartCommand, cmCTestCommand); private: diff --git a/Source/CTest/cmCTestSubmitCommand.h b/Source/CTest/cmCTestSubmitCommand.h index 53ee875..64c6cae 100644 --- a/Source/CTest/cmCTestSubmitCommand.h +++ b/Source/CTest/cmCTestSubmitCommand.h @@ -50,44 +50,6 @@ public: */ virtual const char* GetName() const { return "ctest_submit";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Submit results to a dashboard server."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_submit([PARTS ...] [FILES ...] [RETRY_COUNT count] " - " [RETRY_DELAY delay][RETURN_VALUE res])\n" - "By default all available parts are submitted if no PARTS or FILES " - "are specified. " - "The PARTS option lists a subset of parts to be submitted. " - "Valid part names are:\n" - " Start = nothing\n" - " Update = ctest_update results, in Update.xml\n" - " Configure = ctest_configure results, in Configure.xml\n" - " Build = ctest_build results, in Build.xml\n" - " Test = ctest_test results, in Test.xml\n" - " Coverage = ctest_coverage results, in Coverage.xml\n" - " MemCheck = ctest_memcheck results, in DynamicAnalysis.xml\n" - " Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml\n" - " ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES\n" - " Submit = nothing\n" - "The FILES option explicitly lists specific files to be submitted. " - "Each individual file must exist at the time of the call.\n" - "The RETRY_DELAY option specifies how long in seconds to wait after " - "a timed-out submission before attempting to re-submit.\n" - "The RETRY_COUNT option specifies how many times to retry a timed-out " - "submission.\n"; - } - cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestTestCommand.h b/Source/CTest/cmCTestTestCommand.h index 130cb69..451ac99 100644 --- a/Source/CTest/cmCTestTestCommand.h +++ b/Source/CTest/cmCTestTestCommand.h @@ -41,45 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_test";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Run tests in the project build tree."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_test([BUILD build_dir] [APPEND]\n" - " [START start number] [END end number]\n" - " [STRIDE stride number] [EXCLUDE exclude regex ]\n" - " [INCLUDE include regex] [RETURN_VALUE res] \n" - " [EXCLUDE_LABEL exclude regex] \n" - " [INCLUDE_LABEL label regex] \n" - " [PARALLEL_LEVEL level] \n" - " [SCHEDULE_RANDOM on] \n" - " [STOP_TIME time of day]) \n" - "Tests the given build directory and stores results in Test.xml. The " - "second argument is a variable that will hold value. Optionally, " - "you can specify the starting test number START, the ending test number " - "END, the number of tests to skip between each test STRIDE, a regular " - "expression for tests to run INCLUDE, or a regular expression for tests " - "to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular " - "expression for test to be included or excluded by the test " - "property LABEL. PARALLEL_LEVEL should be set to a positive number " - "representing the number of tests to be run in parallel. " - "SCHEDULE_RANDOM will launch tests in a random order, and is " - "typically used to detect implicit test dependencies. STOP_TIME is the " - "time of day at which the tests should all stop running." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestTestHandler.cxx b/Source/CTest/cmCTestTestHandler.cxx index 85d7a56..da24ae4 100644 --- a/Source/CTest/cmCTestTestHandler.cxx +++ b/Source/CTest/cmCTestTestHandler.cxx @@ -20,6 +20,7 @@ #include <cmsys/Process.h> #include <cmsys/RegularExpression.hxx> #include <cmsys/Base64.h> +#include <cmsys/Directory.hxx> #include "cmMakefile.h" #include "cmGlobalGenerator.h" #include "cmLocalGenerator.h" @@ -60,10 +61,6 @@ public: */ virtual const char* GetName() const { return "subdirs";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestSubdirCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -161,10 +158,6 @@ public: */ virtual const char* GetName() const { return "add_subdirectory";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestAddSubdirectoryCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -251,10 +244,6 @@ public: */ virtual const char* GetName() const { return "add_test";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestAddTestCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -299,10 +288,6 @@ public: */ virtual const char* GetName() const { return "set_tests_properties";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestSetTestsPropertiesCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -537,6 +522,7 @@ int cmCTestTestHandler::ProcessHandler() this->UseExcludeRegExp(); this->SetExcludeRegExp(val); } + this->SetRerunFailed(cmSystemTools::IsOn(this->GetOption("RerunFailed"))); this->TestResults.clear(); @@ -819,6 +805,13 @@ void cmCTestTestHandler::ComputeTestList() { this->TestList.clear(); // clear list of test this->GetListOfTests(); + + if (this->RerunFailed) + { + this->ComputeTestListForRerunFailed(); + return; + } + cmCTestTestHandler::ListOfTests::size_type tmsize = this->TestList.size(); // how many tests are in based on RegExp? int inREcnt = 0; @@ -881,9 +874,47 @@ void cmCTestTestHandler::ComputeTestList() this->TotalNumberOfTests = this->TestList.size(); // Set the TestList to the final list of all test this->TestList = finalList; + + this->UpdateMaxTestNameWidth(); +} + +void cmCTestTestHandler::ComputeTestListForRerunFailed() +{ + this->ExpandTestsToRunInformationForRerunFailed(); + + cmCTestTestHandler::ListOfTests::iterator it; + ListOfTests finalList; + int cnt = 0; + for ( it = this->TestList.begin(); it != this->TestList.end(); it ++ ) + { + cnt ++; + + // if this test is not in our list of tests to run, then skip it. + if ((this->TestsToRun.size() && + std::find(this->TestsToRun.begin(), this->TestsToRun.end(), cnt) + == this->TestsToRun.end())) + { + continue; + } + + it->Index = cnt; + finalList.push_back(*it); + } + + // Save the total number of tests before exclusions + this->TotalNumberOfTests = this->TestList.size(); + + // Set the TestList to the list of failed tests to rerun + this->TestList = finalList; + + this->UpdateMaxTestNameWidth(); +} + +void cmCTestTestHandler::UpdateMaxTestNameWidth() +{ std::string::size_type max = this->CTest->GetMaxTestNameWidth(); - for (it = this->TestList.begin(); - it != this->TestList.end(); it ++ ) + for ( cmCTestTestHandler::ListOfTests::iterator it = this->TestList.begin(); + it != this->TestList.end(); it ++ ) { cmCTestTestProperties& p = *it; if(max < p.Name.size()) @@ -1708,6 +1739,91 @@ void cmCTestTestHandler::ExpandTestsToRunInformation(size_t numTests) this->TestsToRun.erase(new_end, this->TestsToRun.end()); } +void cmCTestTestHandler::ExpandTestsToRunInformationForRerunFailed() +{ + + std::string dirName = this->CTest->GetBinaryDir() + "/Testing/Temporary"; + + cmsys::Directory directory; + if (directory.Load(dirName.c_str()) == 0) + { + cmCTestLog(this->CTest, ERROR_MESSAGE, "Unable to read the contents of " + << dirName << std::endl); + return; + } + + int numFiles = static_cast<int> + (cmsys::Directory::GetNumberOfFilesInDirectory(dirName.c_str())); + std::string pattern = "LastTestsFailed"; + std::string logName = ""; + + for (int i = 0; i < numFiles; ++i) + { + std::string fileName = directory.GetFile(i); + // bcc crashes if we attempt a normal substring comparison, + // hence the following workaround + std::string fileNameSubstring = fileName.substr(0, pattern.length()); + if (fileNameSubstring.compare(pattern) != 0) + { + continue; + } + if (logName == "") + { + logName = fileName; + } + else + { + // if multiple matching logs were found we use the most recently + // modified one. + int res; + cmSystemTools::FileTimeCompare(logName.c_str(), fileName.c_str(), &res); + if (res == -1) + { + logName = fileName; + } + } + } + + std::string lastTestsFailedLog = this->CTest->GetBinaryDir() + + "/Testing/Temporary/" + logName; + + if ( !cmSystemTools::FileExists(lastTestsFailedLog.c_str()) ) + { + if ( !this->CTest->GetShowOnly() && !this->CTest->ShouldPrintLabels() ) + { + cmCTestLog(this->CTest, ERROR_MESSAGE, lastTestsFailedLog + << " does not exist!" << std::endl); + } + return; + } + + // parse the list of tests to rerun from LastTestsFailed.log + std::ifstream ifs(lastTestsFailedLog.c_str()); + if ( ifs ) + { + std::string line; + std::string::size_type pos; + while ( cmSystemTools::GetLineFromStream(ifs, line) ) + { + pos = line.find(':', 0); + if (pos == line.npos) + { + continue; + } + + int val = atoi(line.substr(0, pos).c_str()); + this->TestsToRun.push_back(val); + } + ifs.close(); + } + else if ( !this->CTest->GetShowOnly() && !this->CTest->ShouldPrintLabels() ) + { + cmCTestLog(this->CTest, ERROR_MESSAGE, "Problem reading file: " + << lastTestsFailedLog.c_str() << + " while generating list of previously failed tests." << std::endl); + } +} + //---------------------------------------------------------------------- // Just for convenience #define SPACE_REGEX "[ \t\r\n]" diff --git a/Source/CTest/cmCTestTestHandler.h b/Source/CTest/cmCTestTestHandler.h index 93b793b..398f052 100644 --- a/Source/CTest/cmCTestTestHandler.h +++ b/Source/CTest/cmCTestTestHandler.h @@ -44,6 +44,12 @@ public: void SetUseUnion(bool val) { this->UseUnion = val; } /** + * Set whether or not CTest should only execute the tests that failed + * on the previous run. By default this is false. + */ + void SetRerunFailed(bool val) { this->RerunFailed = val; } + + /** * This method is called when reading CTest custom file */ void PopulateCustomVectors(cmMakefile *mf); @@ -213,6 +219,12 @@ private: // based on union regex and -I stuff void ComputeTestList(); + // compute the lists of tests that will actually run + // based on LastTestFailed.log + void ComputeTestListForRerunFailed(); + + void UpdateMaxTestNameWidth(); + bool GetValue(const char* tag, std::string& value, std::ifstream& fin); @@ -235,6 +247,7 @@ private: const char* GetTestStatus(int status); void ExpandTestsToRunInformation(size_t numPossibleTests); + void ExpandTestsToRunInformationForRerunFailed(); std::vector<cmStdString> CustomPreTest; std::vector<cmStdString> CustomPostTest; @@ -268,6 +281,8 @@ private: cmsys::RegularExpression DartStuff; std::ostream* LogFile; + + bool RerunFailed; }; #endif diff --git a/Source/CTest/cmCTestUpdateCommand.h b/Source/CTest/cmCTestUpdateCommand.h index c578fff..a785bd8 100644 --- a/Source/CTest/cmCTestUpdateCommand.h +++ b/Source/CTest/cmCTestUpdateCommand.h @@ -41,28 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_update";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Update the work tree from version control."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_update([SOURCE source] [RETURN_VALUE res])\n" - "Updates the given source directory and stores results in Update.xml. " - "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. " - "The RETURN_VALUE option specifies a variable in which to store the " - "result, which is the number of files updated or -1 on error." - ; - } - cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestUploadCommand.h b/Source/CTest/cmCTestUploadCommand.h index 62f379f..e867fb6 100644 --- a/Source/CTest/cmCTestUploadCommand.h +++ b/Source/CTest/cmCTestUploadCommand.h @@ -45,25 +45,6 @@ public: */ virtual const char* GetName() const { return "ctest_upload";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Upload files to a dashboard server."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_upload(FILES ...)\n" - "Pass a list of files to be sent along with the build results to " - "the dashboard server.\n"; - } - cmTypeMacro(cmCTestUploadCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmParsePythonCoverage.cxx b/Source/CTest/cmParsePythonCoverage.cxx new file mode 100644 index 0000000..a086f13 --- /dev/null +++ b/Source/CTest/cmParsePythonCoverage.cxx @@ -0,0 +1,113 @@ +#include "cmStandardIncludes.h" +#include "cmSystemTools.h" +#include "cmXMLParser.h" +#include "cmParsePythonCoverage.h" +#include <cmsys/Directory.hxx> + + +//---------------------------------------------------------------------------- +class cmParsePythonCoverage::XMLParser: public cmXMLParser +{ +public: + XMLParser(cmCTest* ctest, cmCTestCoverageHandlerContainer& cont) + : CTest(ctest), Coverage(cont) + { + } + + virtual ~XMLParser() + { + } + +protected: + + virtual void StartElement(const char* name, const char** atts) + { + if(strcmp(name, "class") == 0) + { + int tagCount = 0; + while(true) + { + if(strcmp(atts[tagCount], "filename") == 0) + { + cmCTestLog(this->CTest, HANDLER_VERBOSE_OUTPUT, "Reading file: " + << atts[tagCount+1] << std::endl); + this->CurFileName = this->Coverage.SourceDir + "/" + + atts[tagCount+1]; + FileLinesType& curFileLines = + this->Coverage.TotalCoverage[this->CurFileName]; + std::ifstream fin(this->CurFileName.c_str()); + if(!fin) + { + cmCTestLog(this->CTest, ERROR_MESSAGE, + "Python Coverage: Error opening " << this->CurFileName + << std::endl); + this->Coverage.Error++; + break; + } + + std::string line; + curFileLines.push_back(-1); + while(cmSystemTools::GetLineFromStream(fin, line)) + { + curFileLines.push_back(-1); + } + + break; + } + ++tagCount; + } + } + else if(strcmp(name, "line") == 0) + { + int tagCount = 0; + int curNumber = -1; + int curHits = -1; + while(true) + { + if(strcmp(atts[tagCount], "hits") == 0) + { + curHits = atoi(atts[tagCount+1]); + } + else if(strcmp(atts[tagCount], "number") == 0) + { + curNumber = atoi(atts[tagCount+1]); + } + + if(curHits > -1 && curNumber > -1) + { + FileLinesType& curFileLines = + this->Coverage.TotalCoverage[this->CurFileName]; + curFileLines[curNumber] = curHits; + break; + } + ++tagCount; + } + } + } + + virtual void EndElement(const char*) {} + +private: + + typedef cmCTestCoverageHandlerContainer::SingleFileCoverageVector + FileLinesType; + cmCTest* CTest; + cmCTestCoverageHandlerContainer& Coverage; + std::string CurFileName; + +}; + + +cmParsePythonCoverage::cmParsePythonCoverage( + cmCTestCoverageHandlerContainer& cont, + cmCTest* ctest) + :Coverage(cont), CTest(ctest) +{ +} + +bool cmParsePythonCoverage::ReadCoverageXML(const char* xmlFile) +{ + cmParsePythonCoverage::XMLParser parser(this->CTest, this->Coverage); + parser.ParseFile(xmlFile); + return true; +} diff --git a/Source/CTest/cmParsePythonCoverage.h b/Source/CTest/cmParsePythonCoverage.h new file mode 100644 index 0000000..668c7f9 --- /dev/null +++ b/Source/CTest/cmParsePythonCoverage.h @@ -0,0 +1,48 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2009 Kitware, Inc. + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ + +#ifndef cmParsePythonCoverage_h +#define cmParsePythonCoverage_h + +#include "cmStandardIncludes.h" +#include "cmCTestCoverageHandler.h" + +/** \class cmParsePythonCoverage + * \brief Parse coverage.py Python coverage information + * + * This class is used to parse the output of the coverage.py tool that + * is currently maintained by Ned Batchelder. That tool has a command + * that produces xml output in the format typically output by the common + * Java-based Cobertura coverage application. This helper class parses + * that XML file to fill the coverage-handler container. + */ +class cmParsePythonCoverage +{ +public: + + //! Create the coverage parser by passing in the coverage handler + //! container and the cmCTest object + cmParsePythonCoverage(cmCTestCoverageHandlerContainer& cont, + cmCTest* ctest); + + //! Read the XML produced by running `coverage xml` + bool ReadCoverageXML(const char* xmlFile); + +private: + + class XMLParser; + cmCTestCoverageHandlerContainer& Coverage; + cmCTest* CTest; + std::string CurFileName; +}; + +#endif diff --git a/Source/CursesDialog/ccmake.cxx b/Source/CursesDialog/ccmake.cxx index 623d7d3..fdfe331 100644 --- a/Source/CursesDialog/ccmake.cxx +++ b/Source/CursesDialog/ccmake.cxx @@ -23,47 +23,27 @@ #include <form.h> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " ccmake - Curses Interface for CMake.", 0}, - {0,0,0} + " ccmake - Curses Interface for CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " ccmake <path-to-source>\n" - " ccmake <path-to-existing-build>", 0}, - {0,0,0} + " ccmake <path-to-existing-build>"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "The \"ccmake\" executable is the CMake curses interface. Project " - "configuration settings may be specified interactively through " - "this GUI. Brief instructions are provided at the bottom of the " - "terminal when the program is running.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { CMAKE_STANDARD_OPTIONS_TABLE, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ctest", 0}, - {0, 0, 0} + {0,0} }; cmCursesForm* cmCursesForm::CurrentForm=0; @@ -106,21 +86,15 @@ int main(int argc, char** argv) if(doc.CheckOptions(argc, argv)) { cmake hcm; - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> compatCommands; + hcm.AddCMakePaths(); + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); std::vector<cmDocumentationEntry> generators; - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); hcm.GetGeneratorDocumentation(generators); doc.SetName("ccmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.SetSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Command",commands); - doc.SetSection("Compatibility Commands",compatCommands); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); return doc.PrintRequestedDocumentation(std::cout)? 0:1; } diff --git a/Source/QtDialog/CMakeLists.txt b/Source/QtDialog/CMakeLists.txt index ef25294..15f9ef1 100644 --- a/Source/QtDialog/CMakeLists.txt +++ b/Source/QtDialog/CMakeLists.txt @@ -112,7 +112,12 @@ endif() if(APPLE) set_target_properties(cmake-gui PROPERTIES - OUTPUT_NAME ${CMAKE_BUNDLE_NAME}) + OUTPUT_NAME ${CMAKE_BUNDLE_NAME} + MACOSX_BUNDLE_INFO_PLIST "${CMAKE_CURRENT_SOURCE_DIR}/Info.plist.in" + MACOSX_BUNDLE_SHORT_VERSION_STRING "${CMAKE_BUNDLE_VERSION}" + # TBD: MACOSX_BUNDLE_BUNDLE_VERSION "${CMAKE_BUNDLE_VERSION}" + MACOSX_BUNDLE_COPYRIGHT "Copyright 2000-2013 Kitware, Inc." + ) endif() set(CMAKE_INSTALL_DESTINATION_ARGS BUNDLE DESTINATION "${CMAKE_BUNDLE_LOCATION}") diff --git a/Source/QtDialog/CMakeSetup.cxx b/Source/QtDialog/CMakeSetup.cxx index 01893f5..095aeb6 100644 --- a/Source/QtDialog/CMakeSetup.cxx +++ b/Source/QtDialog/CMakeSetup.cxx @@ -23,39 +23,27 @@ #include <cmsys/SystemTools.hxx> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cmake-gui - CMake GUI.", 0}, - {0,0,0} + " cmake-gui - CMake GUI."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " cmake-gui [options]\n" " cmake-gui [options] <path-to-source>\n" - " cmake-gui [options] <path-to-existing-build>", 0}, - {0,0,0} + " cmake-gui [options] <path-to-existing-build>"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = +static const char * cmDocumentationOptions[][2] = { - {0, - "The \"cmake-gui\" executable is the CMake GUI. Project " - "configuration settings may be specified interactively. " - "Brief instructions are provided at the bottom of the " - "window when the program is running.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = -{ - {0,0,0} + {0,0} }; int main(int argc, char** argv) @@ -70,30 +58,15 @@ int main(int argc, char** argv) // Construct and print requested documentation. cmake hcm; hcm.AddCMakePaths(); - // just incase the install is bad avoid a seg fault - const char* root = hcm.GetCacheDefinition("CMAKE_ROOT"); - if(root) - { - doc.SetCMakeRoot(root); - } - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> compatCommands; - std::map<std::string,cmDocumentationSection *> propDocs; + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); std::vector<cmDocumentationEntry> generators; - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); hcm.GetGeneratorDocumentation(generators); - hcm.GetPropertiesDocumentation(propDocs); doc.SetName("cmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.AppendSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSection("Compatilbility Commands", compatCommands); - doc.SetSections(propDocs); return (doc.PrintRequestedDocumentation(std::cout)? 0:1); } diff --git a/Source/QtDialog/Info.plist.in b/Source/QtDialog/Info.plist.in new file mode 100644 index 0000000..b9c4af5 --- /dev/null +++ b/Source/QtDialog/Info.plist.in @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<plist version="1.0"> +<dict> + <key>CFBundleDevelopmentRegion</key> + <string>English</string> + <key>CFBundleExecutable</key> + <string>${MACOSX_BUNDLE_EXECUTABLE_NAME}</string> + <key>CFBundleIconFile</key> + <string>${MACOSX_BUNDLE_ICON_FILE}</string> + <key>CFBundleIdentifier</key> + <string>${MACOSX_BUNDLE_GUI_IDENTIFIER}</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundleName</key> + <string>${MACOSX_BUNDLE_BUNDLE_NAME}</string> + <key>CFBundlePackageType</key> + <string>APPL</string> + <key>CFBundleShortVersionString</key> + <string>${MACOSX_BUNDLE_SHORT_VERSION_STRING}</string> + <key>CFBundleSignature</key> + <string>????</string> + <key>CFBundleVersion</key> + <string>${MACOSX_BUNDLE_BUNDLE_VERSION}</string> + <key>CSResourcesFileMapped</key> + <true/> + <key>LSApplicationCategoryType</key> + <string>public.app-category.developer-tools</string> + <key>NSHumanReadableCopyright</key> + <string>${MACOSX_BUNDLE_COPYRIGHT}</string> +</dict> +</plist> diff --git a/Source/cmAddCompileOptionsCommand.h b/Source/cmAddCompileOptionsCommand.h index e9bbf28..38ed208 100644 --- a/Source/cmAddCompileOptionsCommand.h +++ b/Source/cmAddCompileOptionsCommand.h @@ -13,7 +13,6 @@ #define cmAddCompileOptionsCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" class cmAddCompileOptionsCommand : public cmCommand { @@ -38,33 +37,6 @@ public: */ virtual const char* GetName() const {return "add_compile_options";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Adds options to the compilation of source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_compile_options(<option> ...)\n" - "Adds options to the compiler command line for sources in the " - "current directory and below. This command can be used to add any " - "options, but alternative commands exist to add preprocessor " - "definitions or include directories. " - "See documentation of the directory and target COMPILE_OPTIONS " - "properties for details. " - "Arguments to add_compile_options may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmAddCompileOptionsCommand, cmCommand); }; diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h index 1cc1e3a..114957f 100644 --- a/Source/cmAddCustomCommandCommand.h +++ b/Source/cmAddCustomCommandCommand.h @@ -13,12 +13,9 @@ #define cmAddCustomCommandCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmAddCustomCommandCommand - * \brief - * - * cmAddCustomCommandCommand defines a new command (rule) that can + * \brief cmAddCustomCommandCommand defines a new command (rule) that can * be executed within the build process * */ @@ -46,141 +43,6 @@ public: */ virtual const char* GetName() const {return "add_custom_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a custom build rule to the generated build system."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "There are two main signatures for add_custom_command " - "The first signature is for adding a custom command " - "to produce an output.\n" - " add_custom_command(OUTPUT output1 [output2 ...]\n" - " COMMAND command1 [ARGS] [args1...]\n" - " [COMMAND command2 [ARGS] [args2...] ...]\n" - " [MAIN_DEPENDENCY depend]\n" - " [DEPENDS [depends...]]\n" - " [IMPLICIT_DEPENDS <lang1> depend1\n" - " [<lang2> depend2] ...]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM] [APPEND])\n" - "This defines a command to generate specified OUTPUT file(s). " - "A target created in the same directory (CMakeLists.txt file) that " - "specifies any output of the custom command as a source file is given " - "a rule to generate the file using the command at build time. " - "Do not list the output in more than one independent target that may " - "build in parallel or the two instances of the rule may conflict " - "(instead use add_custom_target to drive the command and make the " - "other targets depend on that one). " - "If an output name is a relative path it will be interpreted " - "relative to the build tree directory corresponding to the current " - "source directory. " - "Note that MAIN_DEPENDENCY is completely optional and is " - "used as a suggestion to visual studio about where to hang the " - "custom command. In makefile terms this creates a new target in the " - "following form:\n" - " OUTPUT: MAIN_DEPENDENCY DEPENDS\n" - " COMMAND\n" - "If more than one command is specified they will be executed in order. " - "The optional ARGS argument is for backward compatibility and will be " - "ignored.\n" - "The second signature adds a custom command to a target " - "such as a library or executable. This is useful for " - "performing an operation before or after building the target. " - "The command becomes part of the target and will only execute " - "when the target itself is built. If the target is already built," - " the command will not execute.\n" - " add_custom_command(TARGET target\n" - " PRE_BUILD | PRE_LINK | POST_BUILD\n" - " COMMAND command1 [ARGS] [args1...]\n" - " [COMMAND command2 [ARGS] [args2...] ...]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM])\n" - "This defines a new command that will be associated with " - "building the specified target. When the command will " - "happen is determined by which of the following is specified:\n" - " PRE_BUILD - run before all other dependencies\n" - " PRE_LINK - run after other dependencies\n" - " POST_BUILD - run after the target has been built\n" - "Note that the PRE_BUILD option is only supported on Visual " - "Studio 7 or later. For all other generators PRE_BUILD " - "will be treated as PRE_LINK.\n" - "If WORKING_DIRECTORY is specified the command will be executed " - "in the directory given. " - "If it is a relative path it will be interpreted relative to the " - "build tree directory corresponding to the current source directory. " - "If COMMENT is set, the value will be displayed as a " - "message before the commands are executed at build time. " - "If APPEND is specified the COMMAND and DEPENDS option values " - "are appended to the custom command for the first output specified. " - "There must have already been a previous call to this command with " - "the same output. The COMMENT, WORKING_DIRECTORY, and MAIN_DEPENDENCY " - "options are currently ignored when APPEND is given, " - "but may be used in the future." - "\n" - "If VERBATIM is given then all arguments to the commands will be " - "escaped properly for the build tool so that the invoked command " - "receives each argument unchanged. " - "Note that one level of escapes is still used by the CMake language " - "processor before add_custom_command even sees the arguments. " - "Use of VERBATIM is recommended as it enables correct behavior. " - "When VERBATIM is not given the behavior is platform specific because " - "there is no protection of tool-specific special characters." - "\n" - "If the output of the custom command is not actually " - "created as a file on disk it should be marked as SYMBOLIC with " - "SET_SOURCE_FILES_PROPERTIES.\n" - - "The IMPLICIT_DEPENDS option requests scanning of implicit " - "dependencies of an input file. The language given specifies the " - "programming language whose corresponding dependency scanner should " - "be used. Currently only C and CXX language scanners are supported. " - "The language has to be specified for every file in the " - "IMPLICIT_DEPENDS list. " - "Dependencies discovered from the scanning are added to those of " - "the custom command at build time. Note that the IMPLICIT_DEPENDS " - "option is currently supported only for Makefile generators and " - "will be ignored by other generators." - "\n" - "If COMMAND specifies an executable target (created by " - "ADD_EXECUTABLE) it will automatically be replaced by the location " - "of the executable created at build time. Additionally a " - "target-level dependency will be added so that the executable target " - "will be built before any target using this custom command. However " - "this does NOT add a file-level dependency that would cause the " - "custom command to re-run whenever the executable is recompiled." - "\n" - "Arguments to COMMAND may use \"generator expressions\" with the " - "syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - "References to target names in generator expressions imply " - "target-level dependencies, but NOT file-level dependencies. " - "List target names with the DEPENDS option to add file dependencies." - "\n" - "The DEPENDS option specifies files on which the command depends. " - "If any dependency is an OUTPUT of another custom command in the " - "same directory (CMakeLists.txt file) CMake automatically brings the " - "other custom command into the target in which this command is built. " - "If DEPENDS is not specified the command will run whenever the OUTPUT " - "is missing; if the command does not actually create the OUTPUT then " - "the rule will always run. " - "If DEPENDS specifies any target (created by an ADD_* command) " - "a target-level dependency is created to make sure the target is " - "built before any target using this custom command. Additionally, " - "if the target is an executable or library a file-level dependency " - "is created to cause the custom command to re-run whenever the target " - "is recompiled.\n" - ; - } - cmTypeMacro(cmAddCustomCommandCommand, cmCommand); protected: bool CheckOutputs(const std::vector<std::string>& outputs); diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index d4ed450..d0fcdad 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -45,63 +45,6 @@ public: virtual const char* GetName() const {return "add_custom_target";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a target with no output so it will always be built."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_custom_target(Name [ALL] [command1 [args1...]]\n" - " [COMMAND command2 [args2...] ...]\n" - " [DEPENDS depend depend depend ... ]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM]\n" - " [SOURCES src1 [src2...]])\n" - "Adds a target with the given name that executes the given commands. " - "The target has no output file and is ALWAYS CONSIDERED OUT OF DATE " - "even if the commands try to create a file with the name of the " - "target. Use ADD_CUSTOM_COMMAND to generate a file with dependencies. " - "By default nothing depends on the custom target. Use " - "ADD_DEPENDENCIES to add dependencies to or from other targets. " - "If the ALL option is specified " - "it indicates that this target should be added to the default build " - "target so that it will be run every time " - "(the command cannot be called ALL). " - "The command and arguments are optional and if not specified an " - "empty target will be created. " - "If WORKING_DIRECTORY is set, then the command will be run in that " - "directory. " - "If it is a relative path it will be interpreted relative to the " - "build tree directory corresponding to the current source directory. " - "If COMMENT is set, the value will be displayed as a " - "message before the commands are executed at build time. " - "Dependencies listed with the DEPENDS argument may reference files " - "and outputs of custom commands created with add_custom_command() in " - "the same directory (CMakeLists.txt file).\n" - "If VERBATIM is given then all arguments to the commands will be " - "escaped properly for the build tool so that the invoked command " - "receives each argument unchanged. " - "Note that one level of escapes is still used by the CMake language " - "processor before add_custom_target even sees the arguments. " - "Use of VERBATIM is recommended as it enables correct behavior. " - "When VERBATIM is not given the behavior is platform specific because " - "there is no protection of tool-specific special characters." - "\n" - "The SOURCES option specifies additional source files to be included " - "in the custom target. " - "Specified source files will be added to IDE project files for " - "convenience in editing even if they have not build rules." - ; - } - cmTypeMacro(cmAddCustomTargetCommand, cmCommand); }; diff --git a/Source/cmAddDefinitionsCommand.h b/Source/cmAddDefinitionsCommand.h index ff2c4a0..d05f187 100644 --- a/Source/cmAddDefinitionsCommand.h +++ b/Source/cmAddDefinitionsCommand.h @@ -43,35 +43,6 @@ public: */ virtual const char* GetName() const {return "add_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Adds -D define flags to the compilation of source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_definitions(-DFOO -DBAR ...)\n" - "Adds flags to the compiler command line for sources in the current " - "directory and below. This command can be used to add any flags, " - "but it was originally intended to add preprocessor definitions. " - "Flags beginning in -D or /D that look like preprocessor definitions " - "are automatically added to the COMPILE_DEFINITIONS property for " - "the current directory. Definitions with non-trivial values may be " - "left in the set of flags instead of being converted for reasons of " - "backwards compatibility. See documentation of the directory, " - "target, and source file COMPILE_DEFINITIONS properties for details " - "on adding preprocessor definitions to specific scopes and " - "configurations." - ; - } - cmTypeMacro(cmAddDefinitionsCommand, cmCommand); }; diff --git a/Source/cmAddDependenciesCommand.h b/Source/cmAddDependenciesCommand.h index 148fd99..247cc54 100644 --- a/Source/cmAddDependenciesCommand.h +++ b/Source/cmAddDependenciesCommand.h @@ -42,35 +42,6 @@ public: */ virtual const char* GetName() const { return "add_dependencies";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a dependency between top-level targets."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_dependencies(<target> [<target-dependency>]...)\n" - "Make a top-level <target> depend on other top-level targets to " - "ensure that they build before <target> does. " - "A top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, " - "or ADD_CUSTOM_TARGET. " - "Dependencies added to an IMPORTED target are followed transitively " - "in its place since the target itself does not build. " - "\n" - "See the DEPENDS option of ADD_CUSTOM_TARGET " - "and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom " - "rules. See the OBJECT_DEPENDS option in " - "SET_SOURCE_FILES_PROPERTIES to add file-level dependencies to object " - "files."; - } - cmTypeMacro(cmAddDependenciesCommand, cmCommand); }; diff --git a/Source/cmAddExecutableCommand.h b/Source/cmAddExecutableCommand.h index 2774ce8..30ecce3 100644 --- a/Source/cmAddExecutableCommand.h +++ b/Source/cmAddExecutableCommand.h @@ -43,86 +43,6 @@ public: */ virtual const char* GetName() const { return "add_executable";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add an executable to the project using the specified source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_executable(<name> [WIN32] [MACOSX_BUNDLE]\n" - " [EXCLUDE_FROM_ALL]\n" - " source1 source2 ... sourceN)\n" - "Adds an executable target called <name> to be built from the " - "source files listed in the command invocation. " - "The <name> corresponds to the logical target name and must be " - "globally unique within a project. " - "The actual file name of the executable built is constructed based on " - "conventions of the native platform " - "(such as <name>.exe or just <name>). " - "\n" - "By default the executable file will be created in the build tree " - "directory corresponding to the source tree directory in which " - "the command was invoked. " - "See documentation of the RUNTIME_OUTPUT_DIRECTORY " - "target property to change this location. " - "See documentation of the OUTPUT_NAME target property to change " - "the <name> part of the final file name. " - "\n" - "If WIN32 is given the property WIN32_EXECUTABLE will be set on the " - "target created. " - "See documentation of that target property for details." - "\n" - "If MACOSX_BUNDLE is given the corresponding property will be " - "set on the created target. " - "See documentation of the MACOSX_BUNDLE target property for details." - "\n" - "If EXCLUDE_FROM_ALL is given the corresponding property will be " - "set on the created target. " - "See documentation of the EXCLUDE_FROM_ALL target property for " - "details." - "\n" - "The add_executable command can also create IMPORTED executable " - "targets using this signature:\n" - " add_executable(<name> IMPORTED [GLOBAL])\n" - "An IMPORTED executable target references an executable file located " - "outside the project. " - "No rules are generated to build it. " - "The target name has scope in the directory in which it is created " - "and below, but the GLOBAL option extends visibility. " - "It may be referenced like any target built within the project. " - "IMPORTED executables are useful for convenient reference from " - "commands like add_custom_command. " - "Details about the imported executable are specified by setting " - "properties whose names begin in \"IMPORTED_\". " - "The most important such property is IMPORTED_LOCATION " - "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) " - "which specifies the location of the main executable file on disk. " - "See documentation of the IMPORTED_* properties for more information." - "\n" - "The signature\n" - " add_executable(<name> ALIAS <target>)\n" - "creates an alias, such that <name> can be used to refer to <target> " - "in subsequent commands. The <name> does not appear in the generated " - "buildsystem as a make target. The <target> may not be an IMPORTED " - "target or an ALIAS. Alias targets can be used as linkable targets, " - "targets to read properties from, executables for custom commands and " - "custom targets. They can also be tested for existance with the " - "regular if(TARGET) subcommand. The <name> may not be used to modify " - "properties of <target>, that is, it may not be used as the operand of " - "set_property, set_target_properties, target_link_libraries etc. An " - "ALIAS target may not be installed of exported." - ; - } - cmTypeMacro(cmAddExecutableCommand, cmCommand); }; diff --git a/Source/cmAddLibraryCommand.cxx b/Source/cmAddLibraryCommand.cxx index cbc6ed1..0e61c99 100644 --- a/Source/cmAddLibraryCommand.cxx +++ b/Source/cmAddLibraryCommand.cxx @@ -82,6 +82,12 @@ bool cmAddLibraryCommand ++s; isAlias = true; } + else if(libType == "INTERFACE") + { + ++s; + type = cmTarget::INTERFACE_LIBRARY; + haveSpecifiedType = true; + } else if(*s == "EXCLUDE_FROM_ALL") { ++s; @@ -151,7 +157,8 @@ bool cmAddLibraryCommand if(aliasedType != cmTarget::SHARED_LIBRARY && aliasedType != cmTarget::STATIC_LIBRARY && aliasedType != cmTarget::MODULE_LIBRARY - && aliasedType != cmTarget::OBJECT_LIBRARY) + && aliasedType != cmTarget::OBJECT_LIBRARY + && aliasedType != cmTarget::INTERFACE_LIBRARY) { cmOStringStream e; e << "cannot create ALIAS target \"" << libName @@ -213,6 +220,16 @@ bool cmAddLibraryCommand ); return true; } + if(type == cmTarget::INTERFACE_LIBRARY) + { + if (!cmGeneratorExpression::IsValidTargetName(libName)) + { + cmOStringStream e; + e << "Invalid name for IMPORTED INTERFACE library target: " << libName; + this->SetError(e.str().c_str()); + return false; + } + } // Make sure the target does not already exist. if(this->Makefile->FindTargetToUse(libName.c_str())) @@ -249,6 +266,26 @@ bool cmAddLibraryCommand } } + std::vector<std::string> srclists; + + if(type == cmTarget::INTERFACE_LIBRARY) + { + if (!cmGeneratorExpression::IsValidTargetName(libName) + || libName.find("::") != std::string::npos) + { + cmOStringStream e; + e << "Invalid name for INTERFACE library target: " << libName; + this->SetError(e.str().c_str()); + return false; + } + + this->Makefile->AddLibrary(libName.c_str(), + type, + srclists, + excludeFromAll); + return true; + } + if (s == args.end()) { std::string msg = "You have called ADD_LIBRARY for library "; @@ -258,7 +295,6 @@ bool cmAddLibraryCommand cmSystemTools::Message(msg.c_str() ,"Warning"); } - std::vector<std::string> srclists; while (s != args.end()) { srclists.push_back(*s); diff --git a/Source/cmAddLibraryCommand.h b/Source/cmAddLibraryCommand.h index 59354b0..1001043 100644 --- a/Source/cmAddLibraryCommand.h +++ b/Source/cmAddLibraryCommand.h @@ -43,117 +43,6 @@ public: */ virtual const char* GetName() const { return "add_library";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a library to the project using the specified source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_library(<name> [STATIC | SHARED | MODULE]\n" - " [EXCLUDE_FROM_ALL]\n" - " source1 source2 ... sourceN)\n" - "Adds a library target called <name> to be built from the " - "source files listed in the command invocation. " - "The <name> corresponds to the logical target name and must be " - "globally unique within a project. " - "The actual file name of the library built is constructed based on " - "conventions of the native platform " - "(such as lib<name>.a or <name>.lib)." - "\n" - "STATIC, SHARED, or MODULE may be given to specify the type of library " - "to be created. " - "STATIC libraries are archives of object files for use when linking " - "other targets. " - "SHARED libraries are linked dynamically and loaded at runtime. " - "MODULE libraries are plugins that are not linked into other targets " - "but may be loaded dynamically at runtime using dlopen-like " - "functionality. " - "If no type is given explicitly the type is STATIC or SHARED based " - "on whether the current value of the variable BUILD_SHARED_LIBS is " - "true. " - "For SHARED and MODULE libraries the POSITION_INDEPENDENT_CODE " - "target property is set to TRUE automatically." - "\n" - "By default the library file will be created in the build tree " - "directory corresponding to the source tree directory in which " - "the command was invoked. " - "See documentation of the ARCHIVE_OUTPUT_DIRECTORY, " - "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY " - "target properties to change this location. " - "See documentation of the OUTPUT_NAME target property to change " - "the <name> part of the final file name. " - "\n" - "If EXCLUDE_FROM_ALL is given the corresponding property will be " - "set on the created target. " - "See documentation of the EXCLUDE_FROM_ALL target property for " - "details." - "\n" - "The add_library command can also create IMPORTED library " - "targets using this signature:\n" - " add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED\n" - " [GLOBAL])\n" - "An IMPORTED library target references a library file located " - "outside the project. " - "No rules are generated to build it. " - "The target name has scope in the directory in which it is created " - "and below, but the GLOBAL option extends visibility. " - "It may be referenced like any target built within the project. " - "IMPORTED libraries are useful for convenient reference from " - "commands like target_link_libraries. " - "Details about the imported library are specified by setting " - "properties whose names begin in \"IMPORTED_\". " - "The most important such property is IMPORTED_LOCATION " - "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) " - "which specifies the location of the main library file on disk. " - "See documentation of the IMPORTED_* properties for more information." - "\n" - "The signature\n" - " add_library(<name> OBJECT <src>...)\n" - "creates a special \"object library\" target. " - "An object library compiles source files but does not archive or link " - "their object files into a library. " - "Instead other targets created by add_library or add_executable may " - "reference the objects using an expression of the form " - "$<TARGET_OBJECTS:objlib> as a source, where \"objlib\" is the " - "object library name. " - "For example:\n" - " add_library(... $<TARGET_OBJECTS:objlib> ...)\n" - " add_executable(... $<TARGET_OBJECTS:objlib> ...)\n" - "will include objlib's object files in a library and an executable " - "along with those compiled from their own sources. " - "Object libraries may contain only sources (and headers) that compile " - "to object files. " - "They may contain custom commands generating such sources, but not " - "PRE_BUILD, PRE_LINK, or POST_BUILD commands. " - "Object libraries cannot be imported, exported, installed, or linked." - " " - "Some native build systems may not like targets that have only " - "object files, so consider adding at least one real source file " - "to any target that references $<TARGET_OBJECTS:objlib>." - "\n" - "The signature\n" - " add_library(<name> ALIAS <target>)\n" - "creates an alias, such that <name> can be used to refer to <target> " - "in subsequent commands. The <name> does not appear in the generated " - "buildsystem as a make target. The <target> may not be an IMPORTED " - "target or an ALIAS. Alias targets can be used as linkable targets, " - "targets to read properties from. They can also be tested for " - "existance with the " - "regular if(TARGET) subcommand. The <name> may not be used to modify " - "properties of <target>, that is, it may not be used as the operand of " - "set_property, set_target_properties, target_link_libraries etc. An " - "ALIAS target may not be installed of exported." - ; - } - cmTypeMacro(cmAddLibraryCommand, cmCommand); }; diff --git a/Source/cmAddSubDirectoryCommand.h b/Source/cmAddSubDirectoryCommand.h index e7f907c..1e5b1ab 100644 --- a/Source/cmAddSubDirectoryCommand.h +++ b/Source/cmAddSubDirectoryCommand.h @@ -44,53 +44,6 @@ public: */ virtual const char* GetName() const { return "add_subdirectory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a subdirectory to the build."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_subdirectory(source_dir [binary_dir] \n" - " [EXCLUDE_FROM_ALL])\n" - "Add a subdirectory to the build. The source_dir specifies the " - "directory in which the source CMakeLists.txt and code files are " - "located. If it is a relative " - "path it will be evaluated with respect to the current " - "directory (the typical usage), but it may also be an absolute path. " - "The binary_dir specifies the directory in which to place the output " - "files. If it is a relative path it will be evaluated with respect " - "to the current output directory, but it may also be an absolute " - "path. If binary_dir is not specified, the value of source_dir, " - "before expanding any relative path, will be used (the typical usage). " - "The CMakeLists.txt file in the specified source directory will " - "be processed immediately by CMake before processing in the current " - "input file continues beyond this command.\n" - - "If the EXCLUDE_FROM_ALL argument is provided then targets in the " - "subdirectory will not be included in the ALL target of the parent " - "directory by default, and will be excluded from IDE project files. " - "Users must explicitly build targets in the subdirectory. " - "This is meant for use when the subdirectory contains a separate part " - "of the project that is useful but not necessary, such as a set of " - "examples. " - "Typically the subdirectory should contain its own project() command " - "invocation so that a full build system will be generated in the " - "subdirectory (such as a VS IDE solution file). " - "Note that inter-target dependencies supercede this exclusion. " - "If a target built by the parent project depends on a target in the " - "subdirectory, the dependee target will be included in the parent " - "project build system to satisfy the dependency." - ; - } - cmTypeMacro(cmAddSubDirectoryCommand, cmCommand); }; diff --git a/Source/cmAddTestCommand.h b/Source/cmAddTestCommand.h index ce98aaa..9173454 100644 --- a/Source/cmAddTestCommand.h +++ b/Source/cmAddTestCommand.h @@ -13,7 +13,6 @@ #define cmAddTestCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmAddTestCommand * \brief Add a test to the lists of tests to run. @@ -43,59 +42,6 @@ public: */ virtual const char* GetName() const { return "add_test";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a test to the project with the specified arguments."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_test(testname Exename arg1 arg2 ... )\n" - "If the ENABLE_TESTING command has been run, this command adds a " - "test target to the current directory. If ENABLE_TESTING has not " - "been run, this command does nothing. " - "The tests are run by the testing subsystem by executing Exename " - "with the specified arguments. Exename can be either an executable " - "built by this project or an arbitrary executable on the " - "system (like tclsh). The test will be run with the current working " - "directory set to the CMakeList.txt files corresponding directory " - "in the binary tree. Tests added using this signature do not support " - "generator expressions.\n" - "\n" - " add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]\n" - " [WORKING_DIRECTORY dir]\n" - " COMMAND <command> [arg1 [arg2 ...]])\n" - "Add a test called <name>. " - "The test name may not contain spaces, quotes, or other characters " - "special in CMake syntax. " - "If COMMAND specifies an executable target (created by " - "add_executable) it will automatically be replaced by the location " - "of the executable created at build time. " - "If a CONFIGURATIONS option is given then the test will be executed " - "only when testing under one of the named configurations. " - "If a WORKING_DIRECTORY option is given then the test will be executed " - "in the given directory." - "\n" - "Arguments after COMMAND may use \"generator expressions\" with the " - "syntax \"$<...>\". " - CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS - "Example usage:\n" - " add_test(NAME mytest\n" - " COMMAND testDriver --config $<CONFIGURATION>\n" - " --exe $<TARGET_FILE:myexe>)\n" - "This creates a test \"mytest\" whose command runs a testDriver " - "tool passing the configuration name and the full path to the " - "executable file produced by target \"myexe\"." - ; - } - cmTypeMacro(cmAddTestCommand, cmCommand); private: bool HandleNameMode(std::vector<std::string> const& args); diff --git a/Source/cmAuxSourceDirectoryCommand.h b/Source/cmAuxSourceDirectoryCommand.h index 8a70f19..8b5fa8a 100644 --- a/Source/cmAuxSourceDirectoryCommand.h +++ b/Source/cmAuxSourceDirectoryCommand.h @@ -46,38 +46,6 @@ public: */ virtual const char* GetName() const { return "aux_source_directory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find all source files in a directory."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " aux_source_directory(<dir> <variable>)\n" - "Collects the names of all the source files in the specified " - "directory and stores the list in the <variable> provided. This " - "command is intended to be used by projects that use explicit " - "template instantiation. Template instantiation files can be " - "stored in a \"Templates\" subdirectory and collected automatically " - "using this command to avoid manually listing all instantiations.\n" - "It is tempting to use this command to avoid writing the list of " - "source files for a library or executable target. While this seems " - "to work, there is no way for CMake to generate a build system that " - "knows when a new source file has been added. Normally the " - "generated build system knows when it needs to rerun CMake because " - "the CMakeLists.txt file is modified to add a new source. When the " - "source is just added to the directory without modifying this file, " - "one would have to manually rerun CMake to generate a build system " - "incorporating the new file."; - } - cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand); }; diff --git a/Source/cmBreakCommand.h b/Source/cmBreakCommand.h index 17f57cf..52f0e9c 100644 --- a/Source/cmBreakCommand.h +++ b/Source/cmBreakCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const {return "break";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Break from an enclosing foreach or while loop."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " break()\n" - "Breaks from an enclosing foreach loop or while loop"; - } - cmTypeMacro(cmBreakCommand, cmCommand); }; diff --git a/Source/cmBuildCommand.h b/Source/cmBuildCommand.h index 1bab453..2160655 100644 --- a/Source/cmBuildCommand.h +++ b/Source/cmBuildCommand.h @@ -52,45 +52,6 @@ public: */ virtual const char* GetName() const {return "build_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get the command line to build this project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " build_command(<variable>\n" - " [CONFIGURATION <config>]\n" - " [PROJECT_NAME <projname>]\n" - " [TARGET <target>])\n" - "Sets the given <variable> to a string containing the command line " - "for building one configuration of a target in a project using the " - "build tool appropriate for the current CMAKE_GENERATOR.\n" - "If CONFIGURATION is omitted, CMake chooses a reasonable default " - "value for multi-configuration generators. CONFIGURATION is " - "ignored for single-configuration generators.\n" - "If PROJECT_NAME is omitted, the resulting command line will build " - "the top level PROJECT in the current build tree.\n" - "If TARGET is omitted, the resulting command line will build " - "everything, effectively using build target 'all' or 'ALL_BUILD'.\n" - " build_command(<cachevariable> <makecommand>)\n" - "This second signature is deprecated, but still available for " - "backwards compatibility. Use the first signature instead.\n" - "Sets the given <cachevariable> to a string containing the command " - "to build this project from the root of the build tree using " - "the build tool given by <makecommand>. <makecommand> should be " - "the full path to msdev, devenv, nmake, make or one of the end " - "user build tools." - ; - } - cmTypeMacro(cmBuildCommand, cmCommand); }; diff --git a/Source/cmBuildNameCommand.h b/Source/cmBuildNameCommand.h index 26505a2..faeb3c0 100644 --- a/Source/cmBuildNameCommand.h +++ b/Source/cmBuildNameCommand.h @@ -47,27 +47,6 @@ public: */ virtual const char* GetName() const {return "build_name";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " build_name(variable)\n" - "Sets the specified variable to a string representing the platform " - "and compiler settings. These values are now available through the " - "CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmCMakeHostSystemInformationCommand.h b/Source/cmCMakeHostSystemInformationCommand.h index d1b8700..27ba638 100644 --- a/Source/cmCMakeHostSystemInformationCommand.h +++ b/Source/cmCMakeHostSystemInformationCommand.h @@ -53,41 +53,6 @@ public: return "cmake_host_system_information"; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Query host system specific information."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " cmake_host_system_information(RESULT <variable> QUERY <key> ...)\n" - "Queries system information of the host system on which cmake runs. " - "One or more <key> can be provided to " - "select the information to be queried. " - "The list of queried values is stored in <variable>.\n" - "<key> can be one of the following values:\n" - " NUMBER_OF_LOGICAL_CORES = Number of logical cores.\n" - " NUMBER_OF_PHYSICAL_CORES = Number of physical cores.\n" - " HOSTNAME = Hostname.\n" - " FQDN = Fully qualified domain name.\n" - " TOTAL_VIRTUAL_MEMORY = " - "Total virtual memory in megabytes.\n" - " AVAILABLE_VIRTUAL_MEMORY = " - "Available virtual memory in megabytes.\n" - " TOTAL_PHYSICAL_MEMORY = " - "Total physical memory in megabytes.\n" - " AVAILABLE_PHYSICAL_MEMORY = " - "Available physical memory in megabytes.\n" - ; - } - cmTypeMacro(cmCMakeHostSystemInformationCommand, cmCommand); private: diff --git a/Source/cmCMakeMinimumRequired.h b/Source/cmCMakeMinimumRequired.h index acf2829..0cdd4c5 100644 --- a/Source/cmCMakeMinimumRequired.h +++ b/Source/cmCMakeMinimumRequired.h @@ -47,37 +47,6 @@ public: */ virtual const char* GetName() const {return "cmake_minimum_required";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the minimum required version of cmake for a project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]]\n" - " [FATAL_ERROR])\n" - "If the current version of CMake is lower than that required " - "it will stop processing the project and report an error. " - "When a version higher than 2.4 is specified the command implicitly " - "invokes\n" - " cmake_policy(VERSION major[.minor[.patch[.tweak]]])\n" - "which sets the cmake policy version level to the version specified. " - "When version 2.4 or lower is given the command implicitly invokes\n" - " cmake_policy(VERSION 2.4)\n" - "which enables compatibility features for CMake 2.4 and lower.\n" - "The FATAL_ERROR option is accepted but ignored by CMake 2.6 " - "and higher. " - "It should be specified so CMake versions 2.4 and lower fail with an " - "error instead of just a warning."; - } - cmTypeMacro(cmCMakeMinimumRequired, cmCommand); private: diff --git a/Source/cmCMakePolicyCommand.h b/Source/cmCMakePolicyCommand.h index 4f9faa1..7e3f4e6 100644 --- a/Source/cmCMakePolicyCommand.h +++ b/Source/cmCMakePolicyCommand.h @@ -48,88 +48,6 @@ public: */ virtual const char* GetName() const {return "cmake_policy";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Manage CMake Policy settings."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "As CMake evolves it is sometimes necessary to change existing " - "behavior in order to fix bugs or improve implementations of " - "existing features. " - "The CMake Policy mechanism is designed to help keep existing projects " - "building as new versions of CMake introduce changes in behavior. " - "Each new policy (behavioral change) is given an identifier of " - "the form \"CMP<NNNN>\" where \"<NNNN>\" is an integer index. " - "Documentation associated with each policy describes the OLD and NEW " - "behavior and the reason the policy was introduced. " - "Projects may set each policy to select the desired behavior. " - "When CMake needs to know which behavior to use it checks for " - "a setting specified by the project. " - "If no setting is available the OLD behavior is assumed and a warning " - "is produced requesting that the policy be set.\n" - "The cmake_policy command is used to set policies to OLD or NEW " - "behavior. " - "While setting policies individually is supported, we encourage " - "projects to set policies based on CMake versions.\n" - " cmake_policy(VERSION major.minor[.patch[.tweak]])\n" - "Specify that the current CMake list file is written for the " - "given version of CMake. " - "All policies introduced in the specified version or earlier " - "will be set to use NEW behavior. " - "All policies introduced after the specified version will be unset " - "(unless variable CMAKE_POLICY_DEFAULT_CMP<NNNN> sets a default). " - "This effectively requests behavior preferred as of a given CMake " - "version and tells newer CMake versions to warn about their new " - "policies. " - "The policy version specified must be at least 2.4 or the command " - "will report an error. " - "In order to get compatibility features supporting versions earlier " - "than 2.4 see documentation of policy CMP0001." - "\n" - " cmake_policy(SET CMP<NNNN> NEW)\n" - " cmake_policy(SET CMP<NNNN> OLD)\n" - "Tell CMake to use the OLD or NEW behavior for a given policy. " - "Projects depending on the old behavior of a given policy may " - "silence a policy warning by setting the policy state to OLD. " - "Alternatively one may fix the project to work with the new behavior " - "and set the policy state to NEW." - "\n" - " cmake_policy(GET CMP<NNNN> <variable>)\n" - "Check whether a given policy is set to OLD or NEW behavior. " - "The output variable value will be \"OLD\" or \"NEW\" if the " - "policy is set, and empty otherwise." - "\n" - "CMake keeps policy settings on a stack, so changes made by the " - "cmake_policy command affect only the top of the stack. " - "A new entry on the policy stack is managed automatically for each " - "subdirectory to protect its parents and siblings. " - "CMake also manages a new entry for scripts loaded by include() and " - "find_package() commands except when invoked with the NO_POLICY_SCOPE " - "option (see also policy CMP0011). " - "The cmake_policy command provides an interface to manage custom " - "entries on the policy stack:\n" - " cmake_policy(PUSH)\n" - " cmake_policy(POP)\n" - "Each PUSH must have a matching POP to erase any changes. " - "This is useful to make temporary changes to policy settings." - "\n" - "Functions and macros record policy settings when they are created " - "and use the pre-record policies when they are invoked. " - "If the function or macro implementation sets policies, the changes " - "automatically propagate up through callers until they reach the " - "closest nested policy stack entry." - ; - } - cmTypeMacro(cmCMakePolicyCommand, cmCommand); private: bool HandleSetMode(std::vector<std::string> const& args); diff --git a/Source/cmCTest.cxx b/Source/cmCTest.cxx index 14e1f50..98f19cc 100644 --- a/Source/cmCTest.cxx +++ b/Source/cmCTest.cxx @@ -53,14 +53,10 @@ #include <cm_zlib.h> #include <cmsys/Base64.h> -#if defined(__BEOS__) +#if defined(__BEOS__) || defined(__HAIKU__) #include <be/kernel/OS.h> /* disable_debugger() API. */ #endif -#if defined(__HAIKU__) -#include <os/kernel/OS.h> /* disable_debugger() API. */ -#endif - #define DEBUGOUT std::cout << __LINE__ << " "; std::cout #define DEBUGERR std::cerr << __LINE__ << " "; std::cerr @@ -2187,6 +2183,12 @@ void cmCTest::HandleCommandLineArguments(size_t &i, this->GetHandler("memcheck")-> SetPersistentOption("ExcludeRegularExpression", args[i].c_str()); } + + if(this->CheckArgument(arg, "--rerun-failed")) + { + this->GetHandler("test")->SetPersistentOption("RerunFailed", "true"); + this->GetHandler("memcheck")->SetPersistentOption("RerunFailed", "true"); + } } //---------------------------------------------------------------------- diff --git a/Source/cmCacheManager.cxx b/Source/cmCacheManager.cxx index ed09545..a2baa80 100644 --- a/Source/cmCacheManager.cxx +++ b/Source/cmCacheManager.cxx @@ -935,65 +935,3 @@ bool cmCacheManager::NeedCacheCompatibility(int major, int minor) return (actual_compat && actual_compat <= CMake_VERSION_ENCODE(major, minor, 0)); } - -//---------------------------------------------------------------------------- -void cmCacheManager::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("ADVANCED", cmProperty::CACHE, - "True if entry should be hidden by default in GUIs.", - "This is a boolean value indicating whether the entry is considered " - "interesting only for advanced configuration. " - "The mark_as_advanced() command modifies this property." - ); - - cm->DefineProperty - ("HELPSTRING", cmProperty::CACHE, - "Help associated with entry in GUIs.", - "This string summarizes the purpose of an entry to help users set it " - "through a CMake GUI." - ); - - cm->DefineProperty - ("TYPE", cmProperty::CACHE, - "Widget type for entry in GUIs.", - "Cache entry values are always strings, but CMake GUIs present widgets " - "to help users set values. " - "The GUIs use this property as a hint to determine the widget type. " - "Valid TYPE values are:\n" - " BOOL = Boolean ON/OFF value.\n" - " PATH = Path to a directory.\n" - " FILEPATH = Path to a file.\n" - " STRING = Generic string value.\n" - " INTERNAL = Do not present in GUI at all.\n" - " STATIC = Value managed by CMake, do not change.\n" - " UNINITIALIZED = Type not yet specified.\n" - "Generally the TYPE of a cache entry should be set by the command " - "which creates it (set, option, find_library, etc.)." - ); - - cm->DefineProperty - ("MODIFIED", cmProperty::CACHE, - "Internal management property. Do not set or get.", - "This is an internal cache entry property managed by CMake to " - "track interactive user modification of entries. Ignore it." - ); - - cm->DefineProperty - ("STRINGS", cmProperty::CACHE, - "Enumerate possible STRING entry values for GUI selection.", - "For cache entries with type STRING, this enumerates a set of values. " - "CMake GUIs may use this to provide a selection widget instead of a " - "generic string entry field. " - "This is for convenience only. " - "CMake does not enforce that the value matches one of those listed." - ); - - cm->DefineProperty - ("VALUE", cmProperty::CACHE, - "Value of a cache entry.", - "This property maps to the actual value of a cache entry. " - "Setting this property always sets the value without checking, so " - "use with care." - ); -} diff --git a/Source/cmCacheManager.h b/Source/cmCacheManager.h index a5e5eee..2eb440a 100644 --- a/Source/cmCacheManager.h +++ b/Source/cmCacheManager.h @@ -149,9 +149,6 @@ public: unsigned int GetCacheMinorVersion() { return this->CacheMinorVersion; } bool NeedCacheCompatibility(int major, int minor); - /** Define and document CACHE entry properties. */ - static void DefineProperties(cmake *cm); - protected: ///! Add an entry into the cache void AddCacheEntry(const char* key, const char* value, diff --git a/Source/cmCommand.h b/Source/cmCommand.h index 49f451b..83184a0 100644 --- a/Source/cmCommand.h +++ b/Source/cmCommand.h @@ -127,16 +127,6 @@ public: virtual const char* GetName() const = 0; /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const = 0; - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const = 0; - - /** * Enable the command. */ void EnabledOn() diff --git a/Source/cmCommandArgumentLexer.cxx b/Source/cmCommandArgumentLexer.cxx index e68f6b5..e62e53e 100644 --- a/Source/cmCommandArgumentLexer.cxx +++ b/Source/cmCommandArgumentLexer.cxx @@ -1820,7 +1820,7 @@ void cmCommandArgument_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yysca } /** Set the current line number. - * @param line_number + * @param line_number The line number to set. * @param yyscanner The scanner object. */ void cmCommandArgument_yyset_lineno (int line_number , yyscan_t yyscanner) @@ -1835,7 +1835,7 @@ void cmCommandArgument_yyset_lineno (int line_number , yyscan_t yyscanner) } /** Set the current column. - * @param column_no + * @param column_no The column number to set. * @param yyscanner The scanner object. */ void cmCommandArgument_yyset_column (int column_no , yyscan_t yyscanner) diff --git a/Source/cmComputeLinkDepends.cxx b/Source/cmComputeLinkDepends.cxx index dec2b54..a2f3f7d 100644 --- a/Source/cmComputeLinkDepends.cxx +++ b/Source/cmComputeLinkDepends.cxx @@ -355,9 +355,16 @@ void cmComputeLinkDepends::FollowLinkEntry(BFSEntry const& qe) if(cmTarget::LinkInterface const* iface = entry.Target->GetLinkInterface(this->Config, this->HeadTarget)) { + const bool isIface = + entry.Target->GetType() == cmTarget::INTERFACE_LIBRARY; // This target provides its own link interface information. this->AddLinkEntries(depender_index, iface->Libraries); + if (isIface) + { + return; + } + // Handle dependent shared libraries. this->FollowSharedDeps(depender_index, iface); diff --git a/Source/cmComputeLinkInformation.cxx b/Source/cmComputeLinkInformation.cxx index fb7b5b6..d3b28ed 100644 --- a/Source/cmComputeLinkInformation.cxx +++ b/Source/cmComputeLinkInformation.cxx @@ -655,6 +655,11 @@ void cmComputeLinkInformation::AddItem(std::string const& item, cmTarget* tgt) (this->UseImportLibrary && (impexe || tgt->GetType() == cmTarget::SHARED_LIBRARY)); + if(tgt->GetType() == cmTarget::INTERFACE_LIBRARY) + { + this->Items.push_back(Item(std::string(), true, tgt)); + return; + } // Pass the full path to the target file. std::string lib = tgt->GetFullPath(config, implib, true); if(!this->LinkDependsNoShared || diff --git a/Source/cmConfigure.cmake.h.in b/Source/cmConfigure.cmake.h.in index ab53b1d..348f5d3 100644 --- a/Source/cmConfigure.cmake.h.in +++ b/Source/cmConfigure.cmake.h.in @@ -16,7 +16,6 @@ #cmakedefine HAVE_ENVIRON_NOT_REQUIRE_PROTOTYPE #cmakedefine HAVE_UNSETENV #cmakedefine CMAKE_USE_ELF_PARSER -#cmakedefine CMAKE_STRICT #define CMAKE_ROOT_DIR "${CMake_SOURCE_DIR}" #define CMAKE_BUILD_DIR "${CMake_BINARY_DIR}" #define CMAKE_DATA_DIR "/@CMAKE_DATA_DIR@" diff --git a/Source/cmConfigureFileCommand.h b/Source/cmConfigureFileCommand.h index 0393ecf..605b58b 100644 --- a/Source/cmConfigureFileCommand.h +++ b/Source/cmConfigureFileCommand.h @@ -41,61 +41,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Copy a file to another location and modify its contents."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " configure_file(<input> <output>\n" - " [COPYONLY] [ESCAPE_QUOTES] [@ONLY] \n" - " [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])\n" - "Copies a file <input> to file <output> and substitutes variable " - "values referenced in the file content. " - "If <input> is a relative path it is evaluated with respect to " - "the current source directory. " - "The <input> must be a file, not a directory. " - "If <output> is a relative path it is evaluated with respect to " - "the current binary directory. " - "If <output> names an existing directory the input file is placed " - "in that directory with its original name. " - "\n" - "If the <input> file is modified the build system will re-run CMake " - "to re-configure the file and generate the build system again." - "\n" - "This command replaces any variables in the input file referenced as " - "${VAR} or @VAR@ with their values as determined by CMake. If a " - "variable is not defined, it will be replaced with nothing. " - "If COPYONLY is specified, then no variable expansion will take " - "place. If ESCAPE_QUOTES is specified then any substituted quotes " - "will be C-style escaped. " - "The file will be configured with the current values of CMake " - "variables. If @ONLY is specified, only variables " - "of the form @VAR@ will be replaced and ${VAR} will be ignored. " - "This is useful for configuring scripts that use ${VAR}." - "\n" - "Input file lines of the form \"#cmakedefine VAR ...\" " - "will be replaced with either \"#define VAR ...\" or " - "\"/* #undef VAR */\" depending on whether VAR is set in CMake to " - "any value not considered a false constant by the if() command. " - "(Content of \"...\", if any, is processed as above.) " - "Input file lines of the form \"#cmakedefine01 VAR\" " - "will be replaced with either \"#define VAR 1\" or " - "\"#define VAR 0\" similarly." - "\n" - "With NEWLINE_STYLE the line ending could be adjusted: \n" - " 'UNIX' or 'LF' for \\n, 'DOS', 'WIN32' or 'CRLF' for \\r\\n.\n" - "COPYONLY must not be used with NEWLINE_STYLE.\n"; - } - virtual void FinalPass(); virtual bool HasFinalPass() const { return !this->Immediate; } diff --git a/Source/cmCoreTryCompile.cxx b/Source/cmCoreTryCompile.cxx index 8dfaf3b..bc4bf18 100644 --- a/Source/cmCoreTryCompile.cxx +++ b/Source/cmCoreTryCompile.cxx @@ -99,6 +99,7 @@ int cmCoreTryCompile::TryCompileCode(std::vector<std::string> const& argv) { case cmTarget::SHARED_LIBRARY: case cmTarget::STATIC_LIBRARY: + case cmTarget::INTERFACE_LIBRARY: case cmTarget::UNKNOWN_LIBRARY: break; case cmTarget::EXECUTABLE: diff --git a/Source/cmCreateTestSourceList.h b/Source/cmCreateTestSourceList.h index 3aa0a79..8b1e4de 100644 --- a/Source/cmCreateTestSourceList.h +++ b/Source/cmCreateTestSourceList.h @@ -15,7 +15,7 @@ #include "cmCommand.h" /** \class cmCreateTestSourceList - * \brief + * \brief Test driver generation command * */ @@ -42,46 +42,6 @@ public: */ virtual const char* GetName() const {return "create_test_sourcelist";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create a test driver and source list for building test programs."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " create_test_sourcelist(sourceListName driverName\n" - " test1 test2 test3\n" - " EXTRA_INCLUDE include.h\n" - " FUNCTION function)\n" - "A test driver is a program that links together many small tests into " - "a single executable. This is useful when building static executables " - "with large libraries to shrink the total required size. " - "The list of source files " - "needed to build the test driver will be in sourceListName. " - "DriverName is the name of the test driver program. The rest of " - "the arguments consist of a list of test source files, can be " - "semicolon separated. Each test source file should have a function in " - "it that is the same name as the file with no extension (foo.cxx " - "should have int foo(int, char*[]);) DriverName will be able to " - "call each of the " - "tests by name on the command line. If EXTRA_INCLUDE is specified, " - "then the next argument is included into the generated file. If " - "FUNCTION is specified, then the next argument is taken as a function " - "name that is passed a pointer to ac and av. This can be used to add " - "extra command line processing to each test. The cmake variable " - "CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be " - "placed directly before calling the test main function. " - "CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be " - "placed directly after the call to the test main function."; - } - cmTypeMacro(cmCreateTestSourceList, cmCommand); }; diff --git a/Source/cmDefinePropertyCommand.cxx b/Source/cmDefinePropertyCommand.cxx index 5816829..1ad98af 100644 --- a/Source/cmDefinePropertyCommand.cxx +++ b/Source/cmDefinePropertyCommand.cxx @@ -12,7 +12,6 @@ #include "cmDefinePropertyCommand.h" #include "cmake.h" -// cmDefinePropertiesCommand bool cmDefinePropertyCommand ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &) { diff --git a/Source/cmDefinePropertyCommand.h b/Source/cmDefinePropertyCommand.h index b5175d5..8dc4d96 100644 --- a/Source/cmDefinePropertyCommand.h +++ b/Source/cmDefinePropertyCommand.h @@ -34,53 +34,6 @@ public: */ virtual const char* GetName() const { return "define_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Define and document custom properties."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |\n" - " TEST | VARIABLE | CACHED_VARIABLE>\n" - " PROPERTY <name> [INHERITED]\n" - " BRIEF_DOCS <brief-doc> [docs...]\n" - " FULL_DOCS <full-doc> [docs...])\n" - "Define one property in a scope for use with the " - "set_property and get_property commands. " - "This is primarily useful to associate documentation with property " - "names that may be retrieved with the get_property command. " - "The first argument determines the kind of scope in which the " - "property should be used. It must be one of the following:\n" - " GLOBAL = associated with the global namespace\n" - " DIRECTORY = associated with one directory\n" - " TARGET = associated with one target\n" - " SOURCE = associated with one source file\n" - " TEST = associated with a test named with add_test\n" - " VARIABLE = documents a CMake language variable\n" - " CACHED_VARIABLE = documents a CMake cache variable\n" - "Note that unlike set_property and get_property no actual scope " - "needs to be given; only the kind of scope is important.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property being defined.\n" - "If the INHERITED option then the get_property command will chain " - "up to the next higher scope when the requested property is not " - "set in the scope given to the command. " - "DIRECTORY scope chains to GLOBAL. " - "TARGET, SOURCE, and TEST chain to DIRECTORY.\n" - "The BRIEF_DOCS and FULL_DOCS options are followed by strings to be " - "associated with the property as its brief and full documentation. " - "Corresponding options to the get_property command will retrieve the " - "documentation."; - } - cmTypeMacro(cmDefinePropertyCommand, cmCommand); private: std::string PropertyName; diff --git a/Source/cmDependsFortranLexer.cxx b/Source/cmDependsFortranLexer.cxx index 924d9d2..1eff1e4 100644 --- a/Source/cmDependsFortranLexer.cxx +++ b/Source/cmDependsFortranLexer.cxx @@ -2165,7 +2165,7 @@ void cmDependsFortran_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscan } /** Set the current line number. - * @param line_number + * @param line_number The line number to set. * @param yyscanner The scanner object. */ void cmDependsFortran_yyset_lineno (int line_number , yyscan_t yyscanner) @@ -2180,7 +2180,7 @@ void cmDependsFortran_yyset_lineno (int line_number , yyscan_t yyscanner) } /** Set the current column. - * @param line_number + * @param column_no The column number to set. * @param yyscanner The scanner object. */ void cmDependsFortran_yyset_column (int column_no , yyscan_t yyscanner) diff --git a/Source/cmDependsJavaLexer.cxx b/Source/cmDependsJavaLexer.cxx index 0af44b0..1e505a5 100644 --- a/Source/cmDependsJavaLexer.cxx +++ b/Source/cmDependsJavaLexer.cxx @@ -2330,7 +2330,7 @@ void cmDependsJava_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner } /** Set the current line number. - * @param line_number + * @param line_number The line number to set. * @param yyscanner The scanner object. */ void cmDependsJava_yyset_lineno (int line_number , yyscan_t yyscanner) @@ -2345,7 +2345,7 @@ void cmDependsJava_yyset_lineno (int line_number , yyscan_t yyscanner) } /** Set the current column. - * @param column_no + * @param column_no The column number to set. * @param yyscanner The scanner object. */ void cmDependsJava_yyset_column (int column_no , yyscan_t yyscanner) diff --git a/Source/cmDocumentCompileDefinitions.h b/Source/cmDocumentCompileDefinitions.h deleted file mode 100644 index d15bd6d..0000000 --- a/Source/cmDocumentCompileDefinitions.h +++ /dev/null @@ -1,34 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2011 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentCompileDefinitions_h -#define cmDocumentCompileDefinitions_h - -#define CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER \ - "Disclaimer: Most native build tools have poor support for escaping " \ - "certain values. CMake has work-arounds for many cases but some " \ - "values may just not be possible to pass correctly. If a value " \ - "does not seem to be escaped correctly, do not attempt to " \ - "work-around the problem by adding escape sequences to the value. " \ - "Your work-around may break in a future version of CMake that " \ - "has improved escape support. Instead consider defining the macro " \ - "in a (configured) header file. Then report the limitation. " \ - "Known limitations include:\n" \ - " # - broken almost everywhere\n" \ - " ; - broken in VS IDE 7.0 and Borland Makefiles\n" \ - " , - broken in VS IDE\n" \ - " % - broken in some cases in NMake\n" \ - " & | - broken in some cases on MinGW\n" \ - " ^ < > \\\" - broken in most Make tools on Windows\n" \ - "CMake does not reject these values outright because they do work " \ - "in some cases. Use with caution. " - -#endif diff --git a/Source/cmDocumentGeneratorExpressions.h b/Source/cmDocumentGeneratorExpressions.h deleted file mode 100644 index 7bab741..0000000 --- a/Source/cmDocumentGeneratorExpressions.h +++ /dev/null @@ -1,101 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2010 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentGeneratorExpressions_h -#define cmDocumentGeneratorExpressions_h - -#define CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS \ - "Generator expressions are evaluated during build system generation " \ - "to produce information specific to each build configuration. " \ - "Valid expressions are:\n" \ - " $<0:...> = empty string (ignores \"...\")\n" \ - " $<1:...> = content of \"...\"\n" \ - " $<CONFIG:cfg> = '1' if config is \"cfg\", else '0'\n" \ - " $<CONFIGURATION> = configuration name\n" \ - " $<BOOL:...> = '1' if the '...' is true, else '0'\n" \ - " $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0'\n" \ - " $<ANGLE-R> = A literal '>'. Used to compare " \ - "strings which contain a '>' for example.\n" \ - " $<COMMA> = A literal ','. Used to compare " \ - "strings which contain a ',' for example.\n" \ - " $<SEMICOLON> = A literal ';'. Used to prevent " \ - "list expansion on an argument with ';'.\n" \ - " $<JOIN:list,...> = joins the list with the content of " \ - "\"...\"\n" \ - " $<TARGET_NAME:...> = Marks ... as being the name of a " \ - "target. This is required if exporting targets to multiple " \ - "dependent export sets. The '...' must be a literal name of a " \ - "target- it may not contain generator expressions.\n" \ - " $<INSTALL_INTERFACE:...> = content of \"...\" when the property " \ - "is exported using install(EXPORT), and empty otherwise.\n" \ - " $<BUILD_INTERFACE:...> = content of \"...\" when the property " \ - "is exported using export(), or when the target is used by another " \ - "target in the same buildsystem. Expands to the empty string " \ - "otherwise.\n" \ - " $<PLATFORM_ID> = The CMake-id of the platform " \ - " $<PLATFORM_ID:comp> = '1' if the The CMake-id of the " \ - "platform matches comp, otherwise '0'.\n" \ - " $<C_COMPILER_ID> = The CMake-id of the C compiler " \ - "used.\n" \ - " $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C " \ - "compiler matches comp, otherwise '0'.\n" \ - " $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler " \ - "used.\n" \ - " $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX " \ - "compiler matches comp, otherwise '0'.\n" \ - " $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than " \ - "v2, else '0'.\n" \ - " $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, " \ - "else '0'.\n" \ - " $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, " \ - "else '0'.\n" \ - " $<C_COMPILER_VERSION> = The version of the C compiler used.\n" \ - " $<C_COMPILER_VERSION:ver> = '1' if the version of the C " \ - "compiler matches ver, otherwise '0'.\n" \ - " $<CXX_COMPILER_VERSION> = The version of the CXX compiler " \ - "used.\n" \ - " $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX " \ - "compiler matches ver, otherwise '0'.\n" \ - " $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)\n" \ - " $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)\n" \ - " $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)\n" \ - "where \"tgt\" is the name of a target. " \ - "Target file expressions produce a full path, but _DIR and _NAME " \ - "versions can produce the directory and file name components:\n" \ - " $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>\n" \ - " $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>\n" \ - " $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>\n" \ - "\n" \ - " $<TARGET_PROPERTY:tgt,prop> = The value of the property prop " \ - "on the target tgt.\n" \ - "Note that tgt is not added as a dependency of the target this " \ - "expression is evaluated on.\n" \ - " $<TARGET_POLICY:pol> = '1' if the policy was NEW when " \ - "the 'head' target was created, else '0'. If the policy was not " \ - "set, the warning message for the policy will be emitted. This " \ - "generator expression only works for a subset of policies.\n" \ - " $<INSTALL_PREFIX> = Content of the install prefix when " \ - "the target is exported via INSTALL(EXPORT) and empty otherwise.\n" \ - "Boolean expressions:\n" \ - " $<AND:?[,?]...> = '1' if all '?' are '1', else '0'\n" \ - " $<OR:?[,?]...> = '0' if all '?' are '0', else '1'\n" \ - " $<NOT:?> = '0' if '?' is '1', else '1'\n" \ - "where '?' is always either '0' or '1'.\n" \ - "" - -#define CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS \ - CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS \ - "Expressions with an implicit 'this' target:\n" \ - " $<TARGET_PROPERTY:prop> = The value of the property prop on " \ - "the target on which the generator expression is evaluated.\n" \ - "" - -#endif diff --git a/Source/cmDocumentLocationUndefined.h b/Source/cmDocumentLocationUndefined.h deleted file mode 100644 index 9aecf21..0000000 --- a/Source/cmDocumentLocationUndefined.h +++ /dev/null @@ -1,24 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2011 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentLocationUndefined_h -#define cmDocumentLocationUndefined_h - -#define CM_LOCATION_UNDEFINED_BEHAVIOR(action) \ - "\n" \ - "Do not set properties that affect the location of a target after " \ - action ". These include properties whose names match " \ - "\"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?\", " \ - "\"(IMPLIB_)?(PREFIX|SUFFIX)\", or \"LINKER_LANGUAGE\". " \ - "Failure to follow this rule is not diagnosed and leaves the location " \ - "of the target undefined." - -#endif diff --git a/Source/cmDocumentVariables.cxx b/Source/cmDocumentVariables.cxx deleted file mode 100644 index c01a66e..0000000 --- a/Source/cmDocumentVariables.cxx +++ /dev/null @@ -1,2044 +0,0 @@ -#include "cmDocumentVariables.h" -#include "cmake.h" - -#include <cmsys/ios/sstream> - -void cmDocumentVariables::DefineVariables(cmake* cm) -{ - // Subsection: variables defined by cmake, that give - // information about the project, and cmake - cm->DefineProperty - ("CMAKE_AR", cmProperty::VARIABLE, - "Name of archiving tool for static libraries.", - "This specifies the name of the program that creates archive " - "or static libraries.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_COMMAND", cmProperty::VARIABLE, - "The full path to the cmake executable.", - "This is the full path to the CMake executable cmake which is " - "useful from custom commands that want to use the cmake -E " - "option for portable system commands. " - "(e.g. /usr/local/bin/cmake", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_BINARY_DIR", cmProperty::VARIABLE, - "The path to the top level of the build tree.", - "This is the full path to the top level of the current CMake " - "build tree. For an in-source build, this would be the same " - "as CMAKE_SOURCE_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, - "The path to the top level of the source tree.", - "This is the full path to the top level of the current CMake " - "source tree. For an in-source build, this would be the same " - "as CMAKE_BINARY_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE, - "The path to the binary directory currently being processed.", - "This the full path to the build directory that is currently " - "being processed by cmake. Each directory added by " - "add_subdirectory will create a binary directory in the build " - "tree, and as it is being processed this variable will be set. " - "For in-source builds this is the current source directory " - "being processed.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CURRENT_SOURCE_DIR", cmProperty::VARIABLE, - "The path to the source directory currently being processed.", - "This the full path to the source directory that is currently " - "being processed by cmake. ", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_FILE", cmProperty::VARIABLE, - "Full path to the listfile currently being processed.", - "As CMake processes the listfiles in your project this " - "variable will always be set to the one currently being " - "processed. " - "The value has dynamic scope. " - "When CMake starts processing commands in a source file " - "it sets this variable to the location of the file. " - "When CMake finishes processing commands from the file it " - "restores the previous value. " - "Therefore the value of the variable inside a macro or " - "function is the file invoking the bottom-most entry on " - "the call stack, not the file containing the macro or " - "function definition." - "\n" - "See also CMAKE_PARENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_LINE", cmProperty::VARIABLE, - "The line number of the current file being processed.", - "This is the line number of the file currently being" - " processed by cmake.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_DIR", cmProperty::VARIABLE, - "Full directory of the listfile currently being processed.", - "As CMake processes the listfiles in your project this " - "variable will always be set to the directory where the listfile which " - "is currently being processed (CMAKE_CURRENT_LIST_FILE) is located. " - "The value has dynamic scope. " - "When CMake starts processing commands in a source file " - "it sets this variable to the directory where this file is located. " - "When CMake finishes processing commands from the file it " - "restores the previous value. " - "Therefore the value of the variable inside a macro or " - "function is the directory of the file invoking the bottom-most entry on " - "the call stack, not the directory of the file containing the macro or " - "function definition." - "\n" - "See also CMAKE_CURRENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_SCRIPT_MODE_FILE", cmProperty::VARIABLE, - "Full path to the -P script file currently being processed.", - "When run in -P script mode, CMake sets this variable to the full " - "path of the script file. When run to configure a CMakeLists.txt " - "file, this variable is not set.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_ARGC", cmProperty::VARIABLE, - "Number of command line arguments passed to CMake in script mode.", - "When run in -P script mode, CMake sets this variable to the number " - "of command line arguments. See also CMAKE_ARGV0, 1, 2 ...", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_ARGV0", cmProperty::VARIABLE, - "Command line argument passed to CMake in script mode.", - "When run in -P script mode, CMake sets this variable to " - "the first command line argument. It then also sets CMAKE_ARGV1, " - "CMAKE_ARGV2, ... and so on, up to the number of command line arguments " - "given. See also CMAKE_ARGC.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_BUILD_TOOL", cmProperty::VARIABLE, - "Tool used for the actual build process.", - "This variable is set to the program that will be" - " needed to build the output of CMake. If the " - "generator selected was Visual Studio 6, the " - "CMAKE_BUILD_TOOL will be set to msdev, for " - "Unix Makefiles it will be set to make or gmake, " - "and for Visual Studio 7 it set to devenv. For " - "NMake Makefiles the value is nmake. This can be " - "useful for adding special flags and commands based" - " on the final build environment.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CROSSCOMPILING", cmProperty::VARIABLE, - "Is CMake currently cross compiling.", - "This variable will be set to true by CMake if CMake is cross " - "compiling. Specifically if the build platform is different " - "from the target platform.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHEFILE_DIR", cmProperty::VARIABLE, - "The directory with the CMakeCache.txt file.", - "This is the full path to the directory that has the " - "CMakeCache.txt file in it. This is the same as " - "CMAKE_BINARY_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE, - "Major version of CMake used to create the CMakeCache.txt file", - "This stores the major version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE, - "Minor version of CMake used to create the CMakeCache.txt file", - "This stores the minor version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CACHE_PATCH_VERSION", cmProperty::VARIABLE, - "Patch version of CMake used to create the CMakeCache.txt file", - "This stores the patch version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CFG_INTDIR", cmProperty::VARIABLE, - "Build-time reference to per-configuration output subdirectory.", - "For native build systems supporting multiple configurations " - "in the build tree (such as Visual Studio and Xcode), " - "the value is a reference to a build-time variable specifying " - "the name of the per-configuration output subdirectory. " - "On Makefile generators this evaluates to \".\" because there " - "is only one configuration in a build tree. " - "Example values:\n" - " $(IntDir) = Visual Studio 6\n" - " $(OutDir) = Visual Studio 7, 8, 9\n" - " $(Configuration) = Visual Studio 10\n" - " $(CONFIGURATION) = Xcode\n" - " . = Make-based tools\n" - "Since these values are evaluated by the native build system, this " - "variable is suitable only for use in command lines that will be " - "evaluated at build time. " - "Example of intended usage:\n" - " add_executable(mytool mytool.c)\n" - " add_custom_command(\n" - " OUTPUT out.txt\n" - " COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\n" - " ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt\n" - " DEPENDS mytool in.txt\n" - " )\n" - " add_custom_target(drive ALL DEPENDS out.txt)\n" - "Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose " - "but has been left for compatibility with existing projects. " - "Instead add_custom_command() recognizes executable target names in " - "its COMMAND option, so " - "\"${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\" can be " - "replaced by just \"mytool\"." - "\n" - "This variable is read-only. Setting it is undefined behavior. " - "In multi-configuration build systems the value of this variable " - "is passed as the value of preprocessor symbol \"CMAKE_INTDIR\" to " - "the compilation of all source files.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CTEST_COMMAND", cmProperty::VARIABLE, - "Full path to ctest command installed with cmake.", - "This is the full path to the CTest executable ctest " - "which is useful from custom commands that want " - "to use the cmake -E option for portable system " - "commands.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_DL_LIBS", cmProperty::VARIABLE, - "Name of library containing dlopen and dlcose.", - "The name of the library that has dlopen and " - "dlclose in it, usually -ldl on most UNIX machines.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_EDIT_COMMAND", cmProperty::VARIABLE, - "Full path to cmake-gui or ccmake.", - "This is the full path to the CMake executable " - "that can graphically edit the cache. For example," - " cmake-gui, ccmake, or cmake -i.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_GENERATOR", cmProperty::VARIABLE, - "The generator used to build the project.", - "The name of the generator that is being used to generate the " - "build files. (e.g. \"Unix Makefiles\", " - "\"Visual Studio 6\", etc.)",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXTRA_GENERATOR", cmProperty::VARIABLE, - "The extra generator used to build the project.", - "When using the Eclipse, CodeBlocks or KDevelop generators, CMake " - "generates Makefiles (CMAKE_GENERATOR) and additionally project files " - "for the respective IDE. This IDE project file generator is stored in " - "CMAKE_EXTRA_GENERATOR (e.g. \"Eclipse CDT4\").",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_GENERATOR_TOOLSET", cmProperty::VARIABLE, - "Native build system toolset name specified by user.", - "Some CMake generators support a toolset name to be given to the " - "native build system to choose a compiler. " - "If the user specifies a toolset name (e.g. via the cmake -T option) " - "the value will be available in this variable.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_HOME_DIRECTORY", cmProperty::VARIABLE, - "Path to top of source tree.", - "This is the path to the top level of the source tree.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for libraries that you link to.", - "The suffix to use for the end of a library filename, .lib on Windows." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXECUTABLE_SUFFIX", cmProperty::VARIABLE, - "The suffix for executables on this platform.", - "The suffix to use for the end of an executable filename if any, " - ".exe on Windows." - "\n" - "CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MAJOR_VERSION", cmProperty::VARIABLE, - "The Major version of cmake (i.e. the 2 in 2.X.X)", - "This specifies the major version of the CMake executable" - " being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MAKE_PROGRAM", cmProperty::VARIABLE, - "See CMAKE_BUILD_TOOL.", - "This variable is around for backwards compatibility, " - "see CMAKE_BUILD_TOOL.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VS_PLATFORM_TOOLSET", cmProperty::VARIABLE, - "Visual Studio Platform Toolset name.", - "VS 10 and above use MSBuild under the hood and support multiple " - "compiler toolchains. " - "CMake may specify a toolset explicitly, such as \"v110\" for " - "VS 11 or \"Windows7.1SDK\" for 64-bit support in VS 10 Express. " - "CMake provides the name of the chosen toolset in this variable." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_XCODE_PLATFORM_TOOLSET", cmProperty::VARIABLE, - "Xcode compiler selection.", - "Xcode supports selection of a compiler from one of the installed " - "toolsets. " - "CMake provides the name of the chosen toolset in this variable, " - "if any is explicitly selected (e.g. via the cmake -T option)." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MINOR_VERSION", cmProperty::VARIABLE, - "The Minor version of cmake (i.e. the 4 in X.4.X).", - "This specifies the minor version of the CMake" - " executable being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_PATCH_VERSION", cmProperty::VARIABLE, - "The patch version of cmake (i.e. the 3 in X.X.3).", - "This specifies the patch version of the CMake" - " executable being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_TWEAK_VERSION", cmProperty::VARIABLE, - "The tweak version of cmake (i.e. the 1 in X.X.X.1).", - "This specifies the tweak version of the CMake executable being run. " - "Releases use tweak < 20000000 and development versions use the date " - "format CCYYMMDD for the tweak level." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VERSION", cmProperty::VARIABLE, - "The full version of cmake in major.minor.patch[.tweak[-id]] format.", - "This specifies the full version of the CMake executable being run. " - "This variable is defined by versions 2.6.3 and higher. " - "See variables CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, " - "CMAKE_PATCH_VERSION, and CMAKE_TWEAK_VERSION " - "for individual version components. " - "The [-id] component appears in non-release versions " - "and may be arbitrary text.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_PARENT_LIST_FILE", cmProperty::VARIABLE, - "Full path to the CMake file that included the current one.", - "While processing a CMake file loaded by include() or find_package() " - "this variable contains the full path to the file including it. " - "The top of the include stack is always the CMakeLists.txt for the " - "current directory. " - "See also CMAKE_CURRENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_PROJECT_NAME", cmProperty::VARIABLE, - "The name of the current project.", - "This specifies name of the current project from" - " the closest inherited PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_RANLIB", cmProperty::VARIABLE, - "Name of randomizing tool for static libraries.", - "This specifies name of the program that randomizes " - "libraries on UNIX, not used on Windows, but may be present.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_ROOT", cmProperty::VARIABLE, - "Install directory for running cmake.", - "This is the install root for the running CMake and" - " the Modules directory can be found here. This is" - " commonly used in this format: ${CMAKE_ROOT}/Modules",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SIZEOF_VOID_P", cmProperty::VARIABLE, - "Size of a void pointer.", - "This is set to the size of a pointer on the machine, " - "and is determined by a try compile. If a 64 bit size " - "is found, then the library search path is modified to " - "look for 64 bit libraries first.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SKIP_RPATH", cmProperty::VARIABLE, - "If true, do not add run time path information.", - "If this is set to TRUE, then the rpath information " - "is not added to compiled executables. The default " - "is to add rpath information if the platform supports it. " - "This allows for easy running from the build tree. To omit RPATH " - "in the install step, but not the build step, use " - "CMAKE_SKIP_INSTALL_RPATH instead.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, - "Source directory for project.", - "This is the top level source directory for the project. " - "It corresponds to the source directory given to " - "cmake-gui or ccmake.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE, - "Libraries linked into every executable and shared library.", - "This is the list of libraries that are linked " - "into all executables and libraries.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE, - "Create verbose makefiles if on.", - "This variable defaults to false. You can set " - "this variable to true to make CMake produce verbose " - "makefiles that show each command line as it is used.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_BINARY_DIR", cmProperty::VARIABLE, - "Full path to build directory for project.", - "This is the binary directory of the most recent " - "PROJECT command.",false,"Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_NAME", cmProperty::VARIABLE, - "Name of the project given to the project command.", - "This is the name given to the most " - "recent PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE, - "Top level source directory for the current project.", - "This is the source directory of the most recent " - "PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("<PROJECT-NAME>_BINARY_DIR", cmProperty::VARIABLE, - "Top level binary directory for the named project.", - "A variable is created with the name used in the PROJECT " - "command, and is the binary directory for the project. " - " This can be useful when SUBDIR is used to connect " - "several projects.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("<PROJECT-NAME>_SOURCE_DIR", cmProperty::VARIABLE, - "Top level source directory for the named project.", - "A variable is created with the name used in the PROJECT " - "command, and is the source directory for the project." - " This can be useful when add_subdirectory " - "is used to connect several projects.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_IMPORT_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for import libraries that you link to.", - "The prefix to use for the name of an import library if used " - "on this platform." - "\n" - "CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_IMPORT_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for import libraries that you link to.", - "The suffix to use for the end of an import library filename if used " - "on this platform." - "\n" - "CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for shared libraries that you link to.", - "The prefix to use for the name of a shared library, lib on UNIX." - "\n" - "CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for shared libraries that you link to.", - "The suffix to use for the end of a shared library filename, " - ".dll on Windows." - "\n" - "CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_MODULE_PREFIX", cmProperty::VARIABLE, - "The prefix for loadable modules that you link to.", - "The prefix to use for the name of a loadable module on this platform." - "\n" - "CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_MODULE_SUFFIX", cmProperty::VARIABLE, - "The suffix for shared libraries that you link to.", - "The suffix to use for the end of a loadable module filename " - "on this platform" - "\n" - "CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STATIC_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for static libraries that you link to.", - "The prefix to use for the name of a static library, lib on UNIX." - "\n" - "CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STATIC_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for static libraries that you link to.", - "The suffix to use for the end of a static library filename, " - ".lib on Windows." - "\n" - "CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES", cmProperty::VARIABLE, - "Additional suffixes for shared libraries.", - "Extensions for shared libraries other than that specified by " - "CMAKE_SHARED_LIBRARY_SUFFIX, if any. " - "CMake uses this to recognize external shared library files during " - "analysis of libraries linked by a target.", - false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MINIMUM_REQUIRED_VERSION", cmProperty::VARIABLE, - "Version specified to cmake_minimum_required command", - "Variable containing the VERSION component specified in the " - "cmake_minimum_required command.", - false, - "Variables that Provide Information"); - - - // Variables defined by cmake, that change the behavior - // of cmake - - cm->DefineProperty - ("CMAKE_POLICY_DEFAULT_CMP<NNNN>", cmProperty::VARIABLE, - "Default for CMake Policy CMP<NNNN> when it is otherwise left unset.", - "Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) " - "by default leave policies introduced after the given version unset. " - "Set CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the " - "default for policy CMP<NNNN>, where <NNNN> is the policy number." - "\n" - "This variable should not be set by a project in CMake code; " - "use cmake_policy(SET) instead. " - "Users running CMake may set this variable in the cache " - "(e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) " - "to set a policy not otherwise set by the project. " - "Set to OLD to quiet a policy warning while using old behavior " - "or to NEW to try building the project with new behavior.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_AUTOMOC_RELAXED_MODE", cmProperty::VARIABLE, - "Switch between strict and relaxed automoc mode.", - "By default, automoc behaves exactly as described in the documentation " - "of the AUTOMOC target property. " - "When set to TRUE, it accepts more input and tries to find the correct " - "input file for moc even if it differs from the documented behaviour. " - "In this mode it e.g. also checks whether a header file is intended to " - "be processed by moc when a \"foo.moc\" file has been included.\n" - "Relaxed mode has to be enabled for KDE4 compatibility.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INSTALL_DEFAULT_COMPONENT_NAME", cmProperty::VARIABLE, - "Default component used in install() commands.", - "If an install() command is used without the COMPONENT argument, " - "these files will be grouped into a default component. The name of this " - "default install component will be taken from this variable. " - "It defaults to \"Unspecified\".", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_LIBRARY_PREFIXES", cmProperty::VARIABLE, - "Prefixes to prepend when looking for libraries.", - "This specifies what prefixes to add to library names when " - "the find_library command looks for libraries. On UNIX " - "systems this is typically lib, meaning that when trying " - "to find the foo library it will look for libfoo.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_LIBRARY_SUFFIXES", cmProperty::VARIABLE, - "Suffixes to append when looking for libraries.", - "This specifies what suffixes to add to library names when " - "the find_library command looks for libraries. On Windows " - "systems this is typically .lib and .dll, meaning that when trying " - "to find the foo library it will look for foo.dll etc.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE, - "Specifies the available build types on multi-config generators.", - "This specifies what build types (configurations) will be available " - "such as Debug, Release, RelWithDebInfo etc. " - "This has reasonable defaults on most platforms, " - "but can be extended to provide other build types. " - "See also CMAKE_BUILD_TYPE for details of managing configuration data, " - "and CMAKE_CFG_INTDIR." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE, - "Specifies the build type on single-configuration generators.", - "This statically specifies what build type (configuration) " - "will be built in this build tree. Possible values are " - "empty, Debug, Release, RelWithDebInfo and MinSizeRel. " - "This variable is only meaningful to single-configuration generators " - "(such as make and Ninja) i.e. " - "those which choose a single configuration " - "when CMake runs to generate a build tree as opposed to " - "multi-configuration generators which offer selection of the build " - "configuration within the generated build environment. " - "There are many per-config properties and variables " - "(usually following clean SOME_VAR_<CONFIG> order conventions), " - "such as CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: " - "CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. " - "For example, in a build tree configured " - "to build type Debug, CMake will see to having " - "CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS settings. " - "See also CMAKE_CONFIGURATION_TYPES." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE, - "Version of cmake required to build project", - "From the point of view of backwards compatibility, this " - "specifies what version of CMake should be supported. By " - "default this value is the version number of CMake that " - "you are running. You can set this to an older version of" - " CMake to support deprecated commands of CMake in projects" - " that were written to use older versions of CMake. This " - "can be set by the user or set at the beginning of a " - "CMakeLists file.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE, - "Install directory used by install.", - "If \"make install\" is invoked or INSTALL is built" - ", this directory is prepended onto all install " - "directories. This variable defaults to /usr/local" - " on UNIX and c:/Program Files on Windows.\n" - "On UNIX one can use the DESTDIR mechanism in order" - " to relocate the whole installation. " - "DESTDIR means DESTination DIRectory. It is " - "commonly used by makefile users " - "in order to install software at non-default location. " - "It is usually invoked like this:\n" - " make DESTDIR=/home/john install\n" - "which will install the concerned software using the" - " installation prefix, e.g. \"/usr/local\" prepended with " - "the DESTDIR value which finally gives \"/home/john/usr/local\".\n" - "WARNING: DESTDIR may not be used on Windows because installation" - " prefix usually contains a drive letter like in \"C:/Program Files\"" - " which cannot be prepended with some other prefix." - "\n" - "The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH " - "so that find_package, find_program, find_library, find_path, and " - "find_file will search the prefix for other software." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SKIP_INSTALL_ALL_DEPENDENCY", cmProperty::VARIABLE, - "Don't make the install target depend on the all target.", - "By default, the \"install\" target depends on the \"all\" target. " - "This has the effect, that when \"make install\" is invoked or INSTALL " - "is built, first the \"all\" target is built, then the installation " - "starts. " - "If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency " - "is not created, so the installation process will start immediately, " - "independent from whether the project has been completely built or not." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_MODULE_PATH", cmProperty::VARIABLE, - "List of directories to search for CMake modules.", - "Commands like include() and find_package() search for files in " - "directories listed by this variable before checking the default " - "modules that come with CMake.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_WARN_DEPRECATED", cmProperty::VARIABLE, - "Whether to issue deprecation warnings for macros and functions.", - "If TRUE, this can be used by macros and functions to issue " - "deprecation warnings. This variable is FALSE by default.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ERROR_DEPRECATED", cmProperty::VARIABLE, - "Whether to issue deprecation errors for macros and functions.", - "If TRUE, this can be used by macros and functions to issue " - "fatal errors when deprecated macros or functions are used. This " - "variable is FALSE by default.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_XXX(), with appropriate suffixes added.", - "Specifies a path which will be used by the FIND_XXX() commands. It " - "contains the \"base\" directories, the FIND_XXX() commands append " - "appropriate subdirectories to the base directories. So FIND_PROGRAM() " - "adds /bin to each of the directories in the path, FIND_LIBRARY() " - "appends /lib to each of the directories, and FIND_PATH() and " - "FIND_FILE() append /include . By default it is empty, it is intended " - "to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, " - "CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INCLUDE_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_FILE() and FIND_PATH().", - "Specifies a path which will be used both by FIND_FILE() and " - "FIND_PATH(). Both commands will check each of the contained directories " - "for the existence of the file which is currently searched. By default " - "it is empty, it is intended to be set by the project. See also " - "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_LIBRARY_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_LIBRARY().", - "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() " - "will check each of the contained directories for the existence of the " - "library which is currently searched. By default it is empty, it is " - "intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_PROGRAM_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_PROGRAM().", - "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() " - "will check each of the contained directories for the existence of the " - "program which is currently searched. By default it is empty, it is " - "intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH, " - " CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_PREFIX_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_XXX(), with appropriate suffixes added.", - "Specifies a path which will be used by the FIND_XXX() commands. It " - "contains the \"base\" directories, the FIND_XXX() commands append " - "appropriate subdirectories to the base directories. So FIND_PROGRAM() " - "adds /bin to each of the directories in the path, FIND_LIBRARY() " - "appends /lib to each of the directories, and FIND_PATH() and " - "FIND_FILE() append /include . By default this contains the standard " - "directories for the current system and the CMAKE_INSTALL_PREFIX. " - "It is NOT intended " - "to be modified by the project, use CMAKE_PREFIX_PATH for this. See also " - "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_IGNORE_PATH", cmProperty::VARIABLE, - "Path to be ignored by FIND_XXX() commands.", - "Specifies directories to be ignored by searches in FIND_XXX() " - "commands. " - "This is useful in cross-compiled environments where some system " - "directories contain incompatible but possibly linkable libraries. For " - "example, on cross-compiled cluster environments, this allows a user to " - "ignore directories containing libraries meant for the front-end " - "machine that modules like FindX11 (and others) would normally search. " - "By default this contains a list of directories containing incompatible " - "binaries for the host system. " - "See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_IGNORE_PATH", cmProperty::VARIABLE, - "Path to be ignored by FIND_XXX() commands.", - "Specifies directories to be ignored by searches in FIND_XXX() " - "commands. " - "This is useful in cross-compiled environments where some system " - "directories contain incompatible but possibly linkable libraries. For " - "example, on cross-compiled cluster environments, this allows a user to " - "ignore directories containing libraries meant for the front-end " - "machine that modules like FindX11 (and others) would normally search. " - "By default this is empty; it is intended to be set by the project. " - "Note that CMAKE_IGNORE_PATH takes a list of directory names, NOT a " - "list of prefixes. If you want to ignore paths under prefixes (bin, " - "include, lib, etc.), you'll need to specify them explicitly. " - "See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, " - "CMAKE_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_INCLUDE_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_FILE() and FIND_PATH().", - "Specifies a path which will be used both by FIND_FILE() and " - "FIND_PATH(). Both commands will check each of the contained directories " - "for the existence of the file which is currently searched. By default " - "it contains the standard directories for the current system. It is " - "NOT intended to be modified by the project, use CMAKE_INCLUDE_PATH " - "for this. See also CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_LIBRARY_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_LIBRARY().", - "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() " - "will check each of the contained directories for the existence of the " - "library which is currently searched. By default it contains the " - "standard directories for the current system. It is NOT intended to be " - "modified by the project, use CMAKE_LIBRARY_PATH for this. See " - "also CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_PROGRAM_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_PROGRAM().", - "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() " - "will check each of the contained directories for the existence of the " - "program which is currently searched. By default it contains the " - "standard directories for the current system. It is NOT intended to be " - "modified by the project, use CMAKE_PROGRAM_PATH for this. See also " - "CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_DISABLE_FIND_PACKAGE_<PackageName>", cmProperty::VARIABLE, - "Variable for disabling find_package() calls.", - "Every non-REQUIRED find_package() call in a project can be disabled " - "by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to " - "TRUE. This can be used to build a project without an optional package, " - "although that package is installed.\n" - "This switch should be used during the initial CMake run. Otherwise if " - "the package has already been found in a previous CMake run, the " - "variables which have been stored in the cache will still be there. " - "In that case it is recommended to remove the cache variables for " - "this package from the cache using the cache editor or cmake -U", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_PACKAGE_WARN_NO_MODULE", cmProperty::VARIABLE, - "Tell find_package to warn if called without an explicit mode.", - "If find_package is called without an explicit mode option " - "(MODULE, CONFIG or NO_MODULE) and no Find<pkg>.cmake module is " - "in CMAKE_MODULE_PATH then CMake implicitly assumes that the " - "caller intends to search for a package configuration file. " - "If no package configuration file is found then the wording " - "of the failure message must account for both the case that the " - "package is really missing and the case that the project has a " - "bug and failed to provide the intended Find module. " - "If instead the caller specifies an explicit mode option then " - "the failure message can be more specific." - "\n" - "Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package " - "to warn when it implicitly assumes Config mode. " - "This helps developers enforce use of an explicit mode in all calls " - "to find_package within a project.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE, - "Specify a CMake file that overrides platform information.", - "CMake loads the specified file while enabling support for each " - "language from either the project() or enable_language() commands. " - "It is loaded after CMake's builtin compiler and platform information " - "modules have been loaded but before the information is used. " - "The file may set platform information variables to override CMake's " - "defaults." - "\n" - "This feature is intended for use only in overriding information " - "variables that must be set before CMake builds its first test " - "project to check that the compiler for a language works. " - "It should not be used to load a file in cases that a normal include() " - "will work. " - "Use it only as a last resort for behavior that cannot be achieved " - "any other way. " - "For example, one may set CMAKE_C_FLAGS_INIT to change the default " - "value used to initialize CMAKE_C_FLAGS before it is cached. " - "The override file should NOT be used to set anything that could " - "be set after languages are enabled, such as variables like " - "CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. " - "Information set in the file will be used for try_compile and try_run " - "builds too." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("BUILD_SHARED_LIBS", cmProperty::VARIABLE, - "Global flag to cause add_library to create shared libraries if on.", - "If present and true, this will cause all libraries to be " - "built shared unless the library was explicitly added as a " - "static library. This variable is often added to projects " - "as an OPTION so that each user of a project can decide if " - "they want to build the project using shared or static " - "libraries.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE, - "Skip _BUILD_TYPE flags if true.", - "This is an internal flag used by the generators in " - "CMake to tell CMake to skip the _BUILD_TYPE flags.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_MFC_FLAG", cmProperty::VARIABLE, - "Tell cmake to use MFC for an executable or dll.", - "This can be set in a CMakeLists.txt file and will " - "enable MFC in the application. It should be set " - "to 1 for the static MFC library, and 2 for " - "the shared MFC library. This is used in Visual " - "Studio 6 and 7 project files. The CMakeSetup " - "dialog used MFC and the CMakeLists.txt looks like this:\n" - " add_definitions(-D_AFXDLL)\n" - " set(CMAKE_MFC_FLAG 2)\n" - " add_executable(CMakeSetup WIN32 ${SRCS})\n",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_COLOR_MAKEFILE", cmProperty::VARIABLE, - "Enables color output when using the Makefile generator.", - "When enabled, the generated Makefiles will produce colored output. " - "Default is ON.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ABSOLUTE_DESTINATION_FILES", cmProperty::VARIABLE, - "List of files which have been installed using " - " an ABSOLUTE DESTINATION path.", - "This variable is defined by CMake-generated cmake_install.cmake " - "scripts." - " It can be used (read-only) by programs or scripts that source those" - " install scripts. This is used by some CPack generators (e.g. RPM).", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask cmake_install.cmake script to warn each time a file with " - "absolute INSTALL DESTINATION is encountered.", - "This variable is used by CMake-generated cmake_install.cmake" - " scripts. If one sets this variable to ON while running the" - " script, it may get warning messages from the script.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask cmake_install.cmake script to error out as soon as " - "a file with absolute INSTALL DESTINATION is encountered.", - "The fatal error is emitted before the installation of " - "the offending file takes place." - " This variable is used by CMake-generated cmake_install.cmake" - " scripts. If one sets this variable to ON while running the" - " script, it may get fatal error messages from the script.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_DEBUG_TARGET_PROPERTIES", cmProperty::VARIABLE, - "Enables tracing output for target properties.", - "This variable can be populated with a list of properties to generate " - "debug output for when evaluating target properties. Currently it can " - "only be used when evaluating the INCLUDE_DIRECTORIES, " - "COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties. " - "In that case, it outputs a backtrace for each entry in the target " - "property. Default is unset.", false, "Variables That Change Behavior"); - - // Variables defined by CMake that describe the system - - cm->DefineProperty - ("CMAKE_SYSTEM", cmProperty::VARIABLE, - "Name of system cmake is compiling for.", - "This variable is the composite of CMAKE_SYSTEM_NAME " - "and CMAKE_SYSTEM_VERSION, like this " - "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. " - "If CMAKE_SYSTEM_VERSION is not set, then " - "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE, - "Name of the OS CMake is building for.", - "This is the name of the operating system on " - "which CMake is targeting. On systems that " - "have the uname command, this variable is set " - "to the output of uname -s. Linux, Windows, " - " and Darwin for Mac OS X are the values found " - " on the big three operating systems." ,false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE, - "The name of the CPU CMake is building for.", - "On systems that support uname, this variable is " - "set to the output of uname -p, on windows it is " - "set to the value of the environment variable " - "PROCESSOR_ARCHITECTURE",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE, - "OS version CMake is building for.", - "A numeric version string for the system, on " - "systems that support uname, this variable is " - "set to the output of uname -r. On other " - "systems this is set to major-minor version numbers.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE, - "Target architecture library directory name, if detected.", - "This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE as " - "detected for one of the enabled languages.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_LIBRARY_ARCHITECTURE_REGEX", cmProperty::VARIABLE, - "Regex matching possible target architecture library directory names.", - "This is used to detect CMAKE_<lang>_LIBRARY_ARCHITECTURE from the " - "implicit linker search path by matching the <arch> name.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_SYSTEM", cmProperty::VARIABLE, - "Name of system cmake is being run on.", - "The same as CMAKE_SYSTEM but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_NAME", cmProperty::VARIABLE, - "Name of the OS CMake is running on.", - "The same as CMAKE_SYSTEM_NAME but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_PROCESSOR", cmProperty::VARIABLE, - "The name of the CPU CMake is running on.", - "The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_VERSION", cmProperty::VARIABLE, - "OS version CMake is running on.", - "The same as CMAKE_SYSTEM_VERSION but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("APPLE", cmProperty::VARIABLE, - "True if running on Mac OS X.", - "Set to true on Mac OS X." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("BORLAND", cmProperty::VARIABLE, - "True if the Borland compiler is being used.", - "This is set to true if the Borland compiler is being used.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CYGWIN", cmProperty::VARIABLE, - "True for Cygwin.", - "Set to true when using Cygwin." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("MSVC", cmProperty::VARIABLE, - "True when using Microsoft Visual C", - "Set to true when the compiler is some version of Microsoft Visual C.", - false, - "Variables That Describe the System"); - - int msvc_versions[] = { 60, 70, 71, 80, 90, 100, 110, 120, 0 }; - for (int i = 0; msvc_versions[i] != 0; i ++) - { - const char minor = (char)('0' + (msvc_versions[i] % 10)); - cmStdString varName = "MSVC"; - cmsys_ios::ostringstream majorStr; - - majorStr << (msvc_versions[i] / 10); - varName += majorStr.str(); - if (msvc_versions[i] < 100) - { - varName += minor; - } - - cmStdString verString = majorStr.str() + "." + minor; - - cmStdString shortStr = "True when using Microsoft Visual C " + verString; - cmStdString fullStr = "Set to true when the compiler is version " + - verString + - " of Microsoft Visual C."; - cm->DefineProperty - (varName.c_str(), cmProperty::VARIABLE, - shortStr.c_str(), - fullStr.c_str(), - false, - "Variables That Describe the System"); - } - - cm->DefineProperty - ("MSVC_IDE", cmProperty::VARIABLE, - "True when using the Microsoft Visual C IDE", - "Set to true when the target platform is the Microsoft Visual C IDE, " - "as opposed to the command line compiler.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("MSVC_VERSION", cmProperty::VARIABLE, - "The version of Microsoft Visual C/C++ being used if any.", - "Known version numbers are:\n" - " 1200 = VS 6.0\n" - " 1300 = VS 7.0\n" - " 1310 = VS 7.1\n" - " 1400 = VS 8.0\n" - " 1500 = VS 9.0\n" - " 1600 = VS 10.0\n" - " 1700 = VS 11.0\n" - " 1800 = VS 12.0\n" - "", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_CL_64", cmProperty::VARIABLE, - "Using the 64 bit compiler from Microsoft", - "Set to true when using the 64 bit cl compiler from Microsoft.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_COMPILER_2005", cmProperty::VARIABLE, - "Using the Visual Studio 2005 compiler from Microsoft", - "Set to true when using the Visual Studio 2005 compiler " - "from Microsoft.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("UNIX", cmProperty::VARIABLE, - "True for UNIX and UNIX like operating systems.", - "Set to true when the target system is UNIX or UNIX like " - "(i.e. APPLE and CYGWIN).",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("WIN32", cmProperty::VARIABLE, - "True on windows systems, including win64.", - "Set to true when the target system is Windows.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("XCODE_VERSION", cmProperty::VARIABLE, - "Version of Xcode (Xcode generator only).", - "Under the Xcode generator, this is the version of Xcode as specified in " - "\"Xcode.app/Contents/version.plist\" (such as \"3.1.2\").",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_APPLE", cmProperty::VARIABLE, - "True for Apple OS X operating systems.", - "Set to true when the host system is Apple OS X.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_UNIX", cmProperty::VARIABLE, - "True for UNIX and UNIX like operating systems.", - "Set to true when the host system is UNIX or UNIX like " - "(i.e. APPLE and CYGWIN).",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_WIN32", cmProperty::VARIABLE, - "True on windows systems, including win64.", - "Set to true when the host system is Windows and on Cygwin." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_OBJECT_PATH_MAX", cmProperty::VARIABLE, - "Maximum object file full-path length allowed by native build tools.", - "CMake computes for every source file an object file name that is " - "unique to the source file and deterministic with respect to the " - "full path to the source file. " - "This allows multiple source files in a target to share the same name " - "if they lie in different directories without rebuilding when one is " - "added or removed. " - "However, it can produce long full paths in a few cases, so CMake " - "shortens the path using a hashing scheme when the full path to an " - "object file exceeds a limit. " - "CMake has a built-in limit for each platform that is sufficient for " - "common tools, but some native tools may have a lower limit. " - "This variable may be set to specify the limit explicitly. " - "The value must be an integer no less than 128.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("ENV", cmProperty::VARIABLE, - "Access environment variables.", - "Use the syntax $ENV{VAR} to read environment variable VAR. " - "See also the set() command to set ENV{VAR}." - ,false, - "Variables That Describe the System"); - - // Variables that affect the building of object files and - // targets. - // - cm->DefineProperty - ("CMAKE_INCLUDE_CURRENT_DIR", cmProperty::VARIABLE, - "Automatically add the current source- and build directories " - "to the include path.", - "If this variable is enabled, CMake automatically adds in each " - "directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} " - "to the include path for this directory. These additional include " - "directories do not propagate down to subdirectories. This is useful " - "mainly for out-of-source builds, where files generated into the " - "build tree are included by files located in the source tree.\n" - "By default CMAKE_INCLUDE_CURRENT_DIR is OFF.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE", cmProperty::VARIABLE, - "Automatically add the current source- and build directories " - "to the INTERFACE_INCLUDE_DIRECTORIES.", - "If this variable is enabled, CMake automatically adds for each shared " - "library target, static library target, module target and executable " - "target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to " - "the INTERFACE_INCLUDE_DIRECTORIES." - "By default CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_RPATH", cmProperty::VARIABLE, - "The rpath to use for installed targets.", - "A semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "This is used to initialize the target property " - "INSTALL_RPATH for all targets.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_RPATH_USE_LINK_PATH", cmProperty::VARIABLE, - "Add paths to linker search and installed rpath.", - "CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true " - "will append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "This is used to initialize the target property " - "INSTALL_RPATH_USE_LINK_PATH for all targets.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_NAME_DIR", cmProperty::VARIABLE, - "Mac OS X directory name for installed targets.", - "CMAKE_INSTALL_NAME_DIR is used to initialize the " - "INSTALL_NAME_DIR property on all targets. See that target " - "property for more information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_Fortran_FORMAT", cmProperty::VARIABLE, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This variable is used to initialize the Fortran_FORMAT " - "property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_Fortran_MODULE_DIRECTORY", cmProperty::VARIABLE, - "Fortran module output directory.", - "This variable is used to initialize the " - "Fortran_MODULE_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LIBRARY_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the LIBRARY targets when built.", - "This variable is used to initialize the " - "LIBRARY_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_ARCHIVE_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the ARCHIVE targets when built.", - "This variable is used to initialize the " - "ARCHIVE_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_RUNTIME_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the RUNTIME targets when built.", - "This variable is used to initialize the " - "RUNTIME_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_PDB_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the MS debug symbol files from linker.", - "This variable is used to initialize the " - "PDB_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LINK_DEPENDS_NO_SHARED", cmProperty::VARIABLE, - "Whether to skip link dependencies on shared library files.", - "This variable initializes the LINK_DEPENDS_NO_SHARED " - "property on targets when they are created. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_AUTOMOC", cmProperty::VARIABLE, - "Whether to handle moc automatically for Qt targets.", - "This variable is used to initialize the " - "AUTOMOC property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_AUTOMOC_MOC_OPTIONS", cmProperty::VARIABLE, - "Additional options for moc when using automoc (see CMAKE_AUTOMOC).", - "This variable is used to initialize the " - "AUTOMOC_MOC_OPTIONS property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_GNUtoMS", cmProperty::VARIABLE, - "Convert GNU import libraries (.dll.a) to MS format (.lib).", - "This variable is used to initialize the GNUtoMS property on targets " - "when they are created. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_DEBUG_POSTFIX", cmProperty::VARIABLE, - "See variable CMAKE_<CONFIG>_POSTFIX.", - "This variable is a special case of the more-general " - "CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_<CONFIG>_POSTFIX", cmProperty::VARIABLE, - "Default filename postfix for libraries under configuration <CONFIG>.", - "When a non-executable target is created its <CONFIG>_POSTFIX " - "target property is initialized with the value of this variable " - "if it is set.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_BUILD_WITH_INSTALL_RPATH", cmProperty::VARIABLE, - "Use the install path for the RPATH", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always built with the install path for the RPATH and does not " - "need to be relinked when installed.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_NO_BUILTIN_CHRPATH", cmProperty::VARIABLE, - "Do not use the builtin ELF editor to fix RPATHs on installation.", - "When an ELF binary needs to have a different RPATH after installation " - "than it does in the build tree, CMake uses a builtin editor to change " - "the RPATH in the installed copy. " - "If this variable is set to true then CMake will relink the binary " - "before installation instead of using its builtin editor.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SKIP_BUILD_RPATH", cmProperty::VARIABLE, - "Do not include RPATHs in the build tree.", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always built with no RPATH.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SKIP_INSTALL_RPATH", cmProperty::VARIABLE, - "Do not include RPATHs in the install tree.", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always installed without RPATH, even if RPATH is enabled when " - "building. This can be useful for example to allow running tests from " - "the build directory with RPATH enabled before the installation step. " - "To omit RPATH in both the build and install steps, use " - "CMAKE_SKIP_RPATH instead.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create executables.", - "These flags will be used by the linker when creating an executable." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_EXE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking an executable.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating executables.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_MODULE_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create modules.", - "These flags will be used by the linker when creating a module." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_MODULE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a module.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating modules.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SHARED_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create shared libraries.", - "These flags will be used by the linker when creating a shared library." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SHARED_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a shared library.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating shared libraries.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_STATIC_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create static libraries.", - "These flags will be used by the linker when creating a static library." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_STATIC_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a static library.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating static libraries.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE, - "The flag to be used to add a library search path to a compiler.", - "The flag will be used to specify a library directory to the compiler. " - "On most compilers this is \"-L\".",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_DEF_FILE_FLAG", cmProperty::VARIABLE, - "Linker flag to be used to specify a .def file for dll creation.", - "The flag will be used to add a .def file when creating " - "a dll on Windows; this is only defined on Windows." - ,false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE, - "Flag to be used to link a library into an executable.", - "The flag will be used to specify a library to link to an executable. " - "On most compilers this is \"-l\".",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE, - "Flag to be used to link a library specified by a path to its file.", - "The flag will be used before a library file path is given to the " - "linker. " - "This is needed only on very few platforms.", false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE, - "Use relative paths (May not work!).", - "If this is set to TRUE, then CMake will use " - "relative paths between the source and binary tree. " - "This option does not work for more complicated " - "projects, and relative paths are used when possible. " - "In general, it is not possible to move CMake generated" - " makefiles to a different location regardless " - "of the value of this variable.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE, - "Old executable location variable.", - "The target property RUNTIME_OUTPUT_DIRECTORY supercedes " - "this variable for a target if it is set. " - "Executable targets are otherwise placed in this directory.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE, - "Old library location variable.", - "The target properties ARCHIVE_OUTPUT_DIRECTORY, " - "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede " - "this variable for a target if they are set. " - "Library targets are otherwise placed in this directory.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_TRY_COMPILE_CONFIGURATION", cmProperty::VARIABLE, - "Build configuration used for try_compile and try_run projects.", - "Projects built by try_compile and try_run are built " - "synchronously during the CMake configuration step. " - "Therefore a specific build configuration must be chosen even " - "if the generated build system supports multiple configurations.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_INTERFACE_LIBRARIES", cmProperty::VARIABLE, - "Default value for LINK_INTERFACE_LIBRARIES of targets.", - "This variable is used to initialize the " - "LINK_INTERFACE_LIBRARIES property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_WIN32_EXECUTABLE", cmProperty::VARIABLE, - "Default value for WIN32_EXECUTABLE of targets.", - "This variable is used to initialize the " - "WIN32_EXECUTABLE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_MACOSX_BUNDLE", cmProperty::VARIABLE, - "Default value for MACOSX_BUNDLE of targets.", - "This variable is used to initialize the " - "MACOSX_BUNDLE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_POSITION_INDEPENDENT_CODE", cmProperty::VARIABLE, - "Default value for POSITION_INDEPENDENT_CODE of targets.", - "This variable is used to initialize the " - "POSITION_INDEPENDENT_CODE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_NO_SYSTEM_FROM_IMPORTED", cmProperty::VARIABLE, - "Default value for NO_SYSTEM_FROM_IMPORTED of targets.", - "This variable is used to initialize the " - "NO_SYSTEM_FROM_IMPORTED property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_<LANG>_VISIBILITY_PRESET", cmProperty::VARIABLE, - "Default value for <LANG>_VISIBILITY_PRESET of targets.", - "This variable is used to initialize the " - "<LANG>_VISIBILITY_PRESET property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_VISIBILITY_INLINES_HIDDEN", cmProperty::VARIABLE, - "Default value for VISIBILITY_INLINES_HIDDEN of targets.", - "This variable is used to initialize the " - "VISIBILITY_INLINES_HIDDEN property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::VARIABLE, - "Default value for MAP_IMPORTED_CONFIG_<CONFIG> of targets.", - "This variable is used to initialize the " - "MAP_IMPORTED_CONFIG_<CONFIG> property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - -// Variables defined when the a language is enabled These variables will -// also be defined whenever CMake has loaded its support for compiling (LANG) -// programs. This support will be loaded whenever CMake is used to compile -// (LANG) files. C and CXX are examples of the most common values for (LANG). - - cm->DefineProperty - ("CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>", cmProperty::VARIABLE, - "Specify a CMake file that overrides platform information for <LANG>.", - "This is a language-specific version of " - "CMAKE_USER_MAKE_RULES_OVERRIDE loaded only when enabling " - "language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE, - "The full path to the compiler for LANG.", - "This is the command that will be used as the <LANG> compiler. " - "Once set, you can not change this variable.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_ID", cmProperty::VARIABLE, - "Compiler identification string.", - "A short string unique to the compiler vendor. " - "Possible values include:\n" - " Absoft = Absoft Fortran (absoft.com)\n" - " ADSP = Analog VisualDSP++ (analog.com)\n" - " Clang = LLVM Clang (clang.llvm.org)\n" - " Cray = Cray Compiler (cray.com)\n" - " Embarcadero, Borland = Embarcadero (embarcadero.com)\n" - " G95 = G95 Fortran (g95.org)\n" - " GNU = GNU Compiler Collection (gcc.gnu.org)\n" - " HP = Hewlett-Packard Compiler (hp.com)\n" - " Intel = Intel Compiler (intel.com)\n" - " MIPSpro = SGI MIPSpro (sgi.com)\n" - " MSVC = Microsoft Visual Studio (microsoft.com)\n" - " PGI = The Portland Group (pgroup.com)\n" - " PathScale = PathScale (pathscale.com)\n" - " SDCC = Small Device C Compiler (sdcc.sourceforge.net)\n" - " SunPro = Oracle Solaris Studio (oracle.com)\n" - " TI = Texas Instruments (ti.com)\n" - " TinyCC = Tiny C Compiler (tinycc.org)\n" - " Watcom = Open Watcom (openwatcom.org)\n" - " XL, VisualAge, zOS = IBM XL (ibm.com)\n" - "This variable is not guaranteed to be defined for all " - "compilers or languages.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_PLATFORM_ID", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the platform and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_ABI", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the compiler ABI and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_VERSION", cmProperty::VARIABLE, - "Compiler version string.", - "Compiler version in major[.minor[.patch[.tweak]]] format. " - "This variable is not guaranteed to be defined for all " - "compilers or languages.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_INTERNAL_PLATFORM_ABI", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the compiler ABI and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SIZEOF_DATA_PTR", cmProperty::VARIABLE, - "Size of pointer-to-data types for language <LANG>.", - "This holds the size (in bytes) of pointer-to-data types in the target " - "platform ABI. " - "It is defined for languages C and CXX (C++).", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE, - "True if the compiler is GNU.", - "If the selected <LANG> compiler is the GNU " - "compiler then this is TRUE, if not it is FALSE. " - "Unlike the other per-language variables, this uses the GNU syntax for " - "identifying languages instead of the CMake syntax. Recognized values of " - "the <LANG> suffix are:\n" - " CC = C compiler\n" - " CXX = C++ compiler\n" - " G77 = Fortran compiler", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS", cmProperty::VARIABLE, - "Flags for all build types.", - "<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE, - "Flags for Debug build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE, - "Flags for MinSizeRel build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel." - "Short for minimum size release.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE, - "Flags for Release build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is Release",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE, - "Flags for RelWithDebInfo type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. " - "Short for Release With Debug Information.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE, - "Rule variable to compile a single object file.", - "This is a rule variable that tells CMake how to " - "compile a single object file for the language <LANG>." - ,false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE, - "Rule variable to create a shared library.", - "This is a rule variable that tells CMake how to " - "create a shared library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE, - "Rule variable to create a shared module.", - "This is a rule variable that tells CMake how to " - "create a shared library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE, - "Rule variable to create a static library.", - "This is a rule variable that tells CMake how " - "to create a static library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_CREATE", cmProperty::VARIABLE, - "Rule variable to create a new static archive.", - "This is a rule variable that tells CMake how to create a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_APPEND", cmProperty::VARIABLE, - "Rule variable to append to a static archive.", - "This is a rule variable that tells CMake how to append to a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_FINISH", cmProperty::VARIABLE, - "Rule variable to finish an existing static archive.", - "This is a rule variable that tells CMake how to finish a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE, - "File extensions that should be ignored by the build.", - "This is a list of file extensions that may be " - "part of a project for a given language but are not compiled.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES", cmProperty::VARIABLE, - "Directories implicitly searched by the compiler for header files.", - "CMake does not explicitly specify these directories on compiler " - "command lines for language <LANG>. " - "This prevents system include directories from being treated as user " - "include directories on some compilers.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES", cmProperty::VARIABLE, - "Implicit linker search path detected for language <LANG>.", - "Compilers typically pass directories containing language runtime " - "libraries and default library search paths when they invoke a linker. " - "These paths are implicit linker search directories for the compiler's " - "language. " - "CMake automatically detects these directories for each language and " - "reports the results in this variable." - "\n" - "When a library in one of these directories is given by full path to " - "target_link_libraries() CMake will generate the -l<name> form on " - "link lines to ensure the linker searches its implicit directories " - "for the library. " - "Note that some toolchains read implicit directories from an " - "environment variable such as LIBRARY_PATH so keep its value " - "consistent when operating in a given build tree.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES", cmProperty::VARIABLE, - "Implicit linker framework search path detected for language <LANG>.", - "These paths are implicit linker framework search directories for " - "the compiler's language. " - "CMake automatically detects these directories for each language and " - "reports the results in this variable.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES", cmProperty::VARIABLE, - "Implicit link libraries and flags detected for language <LANG>.", - "Compilers typically pass language runtime library names and " - "other flags when they invoke a linker. " - "These flags are implicit link options for the compiler's language. " - "CMake automatically detects these libraries and flags for each " - "language and reports the results in this variable.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE, - "Target architecture library directory name detected for <lang>.", - "If the <lang> compiler passes to the linker an architecture-specific " - "system library search directory such as <prefix>/lib/<arch> this " - "variable contains the <arch> name if/as detected by CMake.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES", cmProperty::VARIABLE, - "True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.", - "This is used when CMake selects a linker language for a target. " - "Languages compiled directly into the target are always considered. " - "A language compiled into static libraries linked by the target is " - "considered if this variable is true.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE, - "Preference value for linker language selection.", - "The \"linker language\" for executable, shared library, and module " - "targets is the language whose compiler will invoke the linker. " - "The LINKER_LANGUAGE target property sets the language explicitly. " - "Otherwise, the linker language is that whose linker preference value " - "is highest among languages compiled and linked into the target. " - "See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINK_EXECUTABLE", cmProperty::VARIABLE, - "Rule variable to link an executable.", - "Rule variable to link an executable for the given language." - ,false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE, - "Extension for the output of a compile for a single file.", - "This is the extension for an object file for " - "the given <LANG>. For example .obj for C on Windows.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE, - "Extensions of source files for the given language.", - "This is the list of extensions for a " - "given language's source files." - ,false, - "Variables for Languages"); - - cm->DefineProperty( - "CMAKE_<LANG>_COMPILER_LOADED", cmProperty::VARIABLE, - "Defined to true if the language is enabled.", - "When language <LANG> is enabled by project() or enable_language() " - "this variable is defined to 1.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODDIR_FLAG", cmProperty::VARIABLE, - "Fortran flag for module output directory.", - "This stores the flag needed to pass the value of the " - "Fortran_MODULE_DIRECTORY target property to the compiler.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODDIR_DEFAULT", cmProperty::VARIABLE, - "Fortran default module output directory.", - "Most Fortran compilers write .mod files to the current working " - "directory. " - "For those that do not, this is set to \".\" and used when the " - "Fortran_MODULE_DIRECTORY target property is not set.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODOUT_FLAG", cmProperty::VARIABLE, - "Fortran flag to enable module output.", - "Most Fortran compilers write .mod files out by default. " - "For others, this stores the flag needed to enable module output.", - false,"Variables for Languages"); - - // variables that are used by cmake but not to be documented - cm->DefineProperty("CMAKE_MATCH_0", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_1", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_2", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_3", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_4", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_5", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_6", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_7", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_8", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_9", cmProperty::VARIABLE,0,0); - - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ARG1", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ENV_VAR", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ID_RUN", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_ABI_FILES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_CREATE_ASSEMBLY_SOURCE", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_CREATE_PREPROCESSED_SOURCE", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_DEBUG_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELEASE_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_INFORMATION_LOADED", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_LINK_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_RESPONSE_FILE_LINK_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_INCLUDES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_OBJECTS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXE_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXE_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_GENERATOR_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_IMPORT_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_FLAG_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_FLAG_SEP_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_SYSTEM_FLAG_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_NEEDS_REQUIRES_STEP_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_CREATE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG_SEP", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RPATH_LINK_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG_SEP", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RPATH_LINK_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH", - cmProperty::VARIABLE,0,0); - cm->DefineProperty( - "CMAKE_<LANG>_USE_IMPLICIT_LINK_DIRECTORIES_IN_RUNTIME_PATH", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_CREATE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_STATIC_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_STATIC_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_FILES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_DIRS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MAKE_INCLUDE_FROM_ROOT", - cmProperty::VARIABLE,0,0); -} diff --git a/Source/cmDocumentVariables.h b/Source/cmDocumentVariables.h deleted file mode 100644 index 1d59b24..0000000 --- a/Source/cmDocumentVariables.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentVariables_h -#define cmDocumentVariables_h -class cmake; -class cmDocumentVariables -{ -public: - static void DefineVariables(cmake* cm); -}; - -#endif diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index 58ce36b..682478e 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -13,208 +13,70 @@ #include "cmSystemTools.h" #include "cmVersion.h" +#include "cmRST.h" + #include <cmsys/Directory.hxx> #include <cmsys/Glob.hxx> -#include <algorithm> - -//---------------------------------------------------------------------------- -static const char *cmDocumentationStandardOptions[][3] = -{ - {"--copyright [file]", "Print the CMake copyright and exit.", - "If a file is specified, the copyright is written into it."}, - {"--help,-help,-usage,-h,-H,/?", "Print usage information and exit.", - "Usage describes the basic command line interface and its options."}, - {"--help-full [file]", "Print full help and exit.", - "Full help displays most of the documentation provided by the UNIX " - "man page. It is provided for use on non-UNIX platforms, but is " - "also convenient if the man page is not installed. If a file is " - "specified, the help is written into it."}, - {"--help-html [file]", "Print full help in HTML format.", - "This option is used by CMake authors to help produce web pages. " - "If a file is specified, the help is written into it."}, - {"--help-man [file]", "Print full help as a UNIX man page and exit.", - "This option is used by the cmake build to generate the UNIX man page. " - "If a file is specified, the help is written into it."}, - {"--version,-version,/V [file]", - "Show program name/version banner and exit.", - "If a file is specified, the version is written into it."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmModulesDocumentationDescription[][3] = -{ - {0, - " CMake Modules - Modules coming with CMake, the Cross-Platform Makefile " - "Generator.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for the modules and scripts coming with CMake. " - "Using these modules you can check the computer system for " - "installed software packages, features of the compiler and the " - "existence of headers to name just a few.", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmCustomModulesDocumentationDescription[][3] = -{ - {0, - " Custom CMake Modules - Additional Modules for CMake.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for additional modules and scripts for CMake. " - "Using these modules you can check the computer system for " - "installed software packages, features of the compiler and the " - "existence of headers to name just a few.", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmPropertiesDocumentationDescription[][3] = -{ - {0, - " CMake Properties - Properties supported by CMake, " - "the Cross-Platform Makefile Generator.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for the properties supported by CMake. " - "Properties can have different scopes. They can either be assigned to a " - "source file, a directory, a target or globally to CMake. By modifying the " - "values of properties the behaviour of the build system can be customized.", - 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmCompatCommandsDocumentationDescription[][3] = -{ - {0, - " CMake Compatibility Listfile Commands - " - "Obsolete commands supported by CMake for compatibility.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for now obsolete listfile commands from previous " - "CMake versions, which are still supported for compatibility reasons. You " - "should instead use the newer, faster and shinier new commands. ;-)", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmDocumentationModulesHeader[][3] = -{ - {0, - "The following modules are provided with CMake. " - "They can be used with INCLUDE(ModuleName).", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmDocumentationCustomModulesHeader[][3] = -{ - {0, - "The following modules are also available for CMake. " - "They can be used with INCLUDE(ModuleName).", 0}, - {0,0,0} -}; +#include <ctype.h> -//---------------------------------------------------------------------------- -static const char *cmDocumentationGeneratorsHeader[][3] = -{ - {0, - "The following generators are available on this platform:", 0}, - {0,0,0} -}; +#include <algorithm> //---------------------------------------------------------------------------- -static const char *cmDocumentationStandardSeeAlso[][3] = -{ - {0, - "The following resources are available to get help using CMake:", 0}, - {"Home Page", - "http://www.cmake.org", - "The primary starting point for learning about CMake."}, - {"Frequently Asked Questions", - "http://www.cmake.org/Wiki/CMake_FAQ", - "A Wiki is provided containing answers to frequently asked questions. "}, - {"Online Documentation", - "http://www.cmake.org/HTML/Documentation.html", - "Links to available documentation may be found on this web page."}, - {"Mailing List", - "http://www.cmake.org/HTML/MailingLists.html", - "For help and discussion about using cmake, a mailing list is provided at " - "cmake@cmake.org. " - "The list is member-post-only but one may sign up on the CMake web page. " - "Please first read the full documentation at " - "http://www.cmake.org before posting questions to the list."}, - {0,0,0} +static const char *cmDocumentationStandardOptions[][2] = +{ + {"--help,-help,-usage,-h,-H,/?", + "Print usage information and exit."}, + {"--version,-version,/V [<f>]", + "Print version number and exit."}, + {"--help-manual <man> [<f>]", + "Print one help manual and exit."}, + {"--help-manual-list [<f>]", + "List help manuals available and exit."}, + {"--help-command <cmd> [<f>]", + "Print help for one command and exit."}, + {"--help-command-list [<f>]", + "List commands with help available and exit."}, + {"--help-commands [<f>]", + "Print cmake-commands manual and exit."}, + {"--help-module <mod> [<f>]", + "Print help for one module and exit."}, + {"--help-module-list [<f>]", + "List modules with help available and exit."}, + {"--help-modules [<f>]", + "Print cmake-modules manual and exit."}, + {"--help-policy <cmp> [<f>]", + "Print help for one policy and exit."}, + {"--help-policy-list [<f>]", + "List policies with help available and exit."}, + {"--help-policies [<f>]", + "Print cmake-policies manual and exit."}, + {"--help-property <prop> [<f>]", + "Print help for one property and exit."}, + {"--help-property-list [<f>]", + "List properties with help available and exit."}, + {"--help-properties [<f>]", + "Print cmake-properties manual and exit."}, + {"--help-variable var [<f>]", + "Print help for one variable and exit."}, + {"--help-variable-list [<f>]", + "List variables with help available and exit."}, + {"--help-variables [<f>]", + "Print cmake-variables manual and exit."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char *cmDocumentationCopyright[][3] = +static const char *cmDocumentationGeneratorsHeader[][2] = { {0, - "Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. " - "All rights reserved.", 0}, - {0, - "Redistribution and use in source and binary forms, with or without " - "modification, are permitted provided that the following conditions are " - "met:", 0}, - {"", - "Redistributions of source code must retain the above copyright notice, " - "this list of conditions and the following disclaimer.", 0}, - {"", - "Redistributions in binary form must reproduce the above copyright " - "notice, this list of conditions and the following disclaimer in the " - "documentation and/or other materials provided with the distribution.", - 0}, - {"", - "Neither the names of Kitware, Inc., the Insight Software Consortium, " - "nor the names of their contributors may be used to endorse or promote " - "products derived from this software without specific prior written " - "permission.", 0}, - {0, - "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS " - "\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT " - "LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR " - "A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT " - "HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, " - "SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT " - "LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, " - "DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY " - "THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT " - "(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE " - "OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", - 0}, - {0, 0, 0} + "The following generators are available on this platform:"}, + {0,0} }; //---------------------------------------------------------------------------- -#define DOCUMENT_INTRO(type, default_name, desc) \ - static char const *cmDocumentation##type##Intro[2] = { default_name, desc }; -#define GET_DOCUMENT_INTRO(type) cmDocumentation##type##Intro - -DOCUMENT_INTRO(Modules, "cmakemodules", - "Reference of available CMake modules."); -DOCUMENT_INTRO(CustomModules, "cmakecustommodules", - "Reference of available CMake custom modules."); -DOCUMENT_INTRO(Policies, "cmakepolicies", - "Reference of CMake policies."); -DOCUMENT_INTRO(Properties, "cmakeprops", - "Reference of CMake properties."); -DOCUMENT_INTRO(Variables, "cmakevars", - "Reference of CMake variables."); -DOCUMENT_INTRO(Commands, "cmakecommands", - "Reference of available CMake commands."); -DOCUMENT_INTRO(CompatCommands, "cmakecompat", - "Reference of CMake compatibility commands."); - -//---------------------------------------------------------------------------- cmDocumentation::cmDocumentation() -:CurrentFormatter(0) { - this->SetForm(TextForm, 0); this->addCommonStandardDocSections(); this->ShowGenerators = true; } @@ -222,11 +84,6 @@ cmDocumentation::cmDocumentation() //---------------------------------------------------------------------------- cmDocumentation::~cmDocumentation() { - for(std::vector< char* >::iterator i = this->ModuleStrings.begin(); - i != this->ModuleStrings.end(); ++i) - { - delete [] *i; - } for(std::map<std::string,cmDocumentationSection *>::iterator i = this->AllSections.begin(); i != this->AllSections.end(); ++i) @@ -236,30 +93,6 @@ cmDocumentation::~cmDocumentation() } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintCopyright(std::ostream& os) -{ - cmDocumentationSection *sec = this->AllSections["Copyright"]; - const std::vector<cmDocumentationEntry> &entries = sec->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " * "; - this->TextFormatter.SetIndent(" "); - this->TextFormatter.PrintColumn(os, op->Brief.c_str()); - } - else - { - this->TextFormatter.SetIndent(""); - this->TextFormatter.PrintColumn(os, op->Brief.c_str()); - } - os << "\n"; - } - return true; -} - -//---------------------------------------------------------------------------- bool cmDocumentation::PrintVersion(std::ostream& os) { os << this->GetNameString() << " version " @@ -268,317 +101,46 @@ bool cmDocumentation::PrintVersion(std::ostream& os) } //---------------------------------------------------------------------------- -void cmDocumentation::AddSectionToPrint(const char *section) +bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) { - if (this->AllSections.find(section) != this->AllSections.end()) - { - this->PrintSections.push_back(this->AllSections[section]); - } -} - -//---------------------------------------------------------------------------- -void cmDocumentation::ClearSections() -{ - this->PrintSections.erase(this->PrintSections.begin(), - this->PrintSections.end()); - this->ModulesFound.clear(); -} - -//---------------------------------------------------------------------------- -void cmDocumentation::AddDocumentIntroToPrint(const char* intro[2]) -{ - const char* docname = this->GetDocName(false); - if(intro && docname) - { - cmDocumentationSection* section; - std::string desc(""); - - desc += docname; - desc += " - "; - desc += intro[1]; - - section = new cmDocumentationSection("Introduction", "NAME"); - section->Append(0, desc.c_str(), 0); - this->PrintSections.push_back(section); - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os, - const char* docname) -{ - if ((this->CurrentFormatter->GetForm() != HTMLForm) - && (this->CurrentFormatter->GetForm() != DocbookForm) - && (this->CurrentFormatter->GetForm() != ManForm)) - { - this->PrintVersion(os); - } - - // Handle Document Name. docname==0 disables intro. - this->SetDocName(""); - if (docname) - { - if (*docname) - this->SetDocName(docname); - else // empty string was given. select default if possible - this->SetDocName(this->GetDefaultDocName(ht)); - } - switch (ht) { case cmDocumentation::Usage: return this->PrintDocumentationUsage(os); - case cmDocumentation::Single: - return this->PrintDocumentationSingle(os); - case cmDocumentation::SingleModule: - return this->PrintDocumentationSingleModule(os); - case cmDocumentation::SinglePolicy: - return this->PrintDocumentationSinglePolicy(os); - case cmDocumentation::SingleProperty: - return this->PrintDocumentationSingleProperty(os); - case cmDocumentation::SingleVariable: - return this->PrintDocumentationSingleVariable(os); - case cmDocumentation::List: - this->PrintDocumentationList(os,"Commands"); - this->PrintDocumentationList(os,"Compatibility Commands"); - return true; - case cmDocumentation::ModuleList: - // find the modules first, print the custom module docs only if - // any custom modules have been found actually, Alex - this->CreateCustomModulesSection(); - this->CreateModulesSection(); - if (this->AllSections.find("Custom CMake Modules") - != this->AllSections.end()) - { - this->PrintDocumentationList(os,"Custom CMake Modules"); - } - this->PrintDocumentationList(os,"Modules"); - return true; - case cmDocumentation::PropertyList: - this->PrintDocumentationList(os,"Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) - { - this->PrintDocumentationList(os,i->c_str()); - } - return true; - case cmDocumentation::VariableList: - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - i != this->VariableSections.end(); ++i) - { - this->PrintDocumentationList(os,i->c_str()); - } - return true; - case cmDocumentation::Full: - return this->PrintDocumentationFull(os); - case cmDocumentation::Modules: - return this->PrintDocumentationModules(os); - case cmDocumentation::CustomModules: - return this->PrintDocumentationCustomModules(os); - case cmDocumentation::Policies: - return this->PrintDocumentationPolicies(os); - case cmDocumentation::Properties: - return this->PrintDocumentationProperties(os); - case cmDocumentation::Variables: - return this->PrintDocumentationVariables(os); - case cmDocumentation::Commands: - return this->PrintDocumentationCurrentCommands(os); - case cmDocumentation::CompatCommands: - return this->PrintDocumentationCompatCommands(os); - - case cmDocumentation::Copyright: - return this->PrintCopyright(os); + case cmDocumentation::OneManual: + return this->PrintHelpOneManual(os); + case cmDocumentation::OneCommand: + return this->PrintHelpOneCommand(os); + case cmDocumentation::OneModule: + return this->PrintHelpOneModule(os); + case cmDocumentation::OnePolicy: + return this->PrintHelpOnePolicy(os); + case cmDocumentation::OneProperty: + return this->PrintHelpOneProperty(os); + case cmDocumentation::OneVariable: + return this->PrintHelpOneVariable(os); + case cmDocumentation::ListManuals: + return this->PrintHelpListManuals(os); + case cmDocumentation::ListCommands: + return this->PrintHelpListCommands(os); + case cmDocumentation::ListModules: + return this->PrintHelpListModules(os); + case cmDocumentation::ListProperties: + return this->PrintHelpListProperties(os); + case cmDocumentation::ListVariables: + return this->PrintHelpListVariables(os); + case cmDocumentation::ListPolicies: + return this->PrintHelpListPolicies(os); case cmDocumentation::Version: - return true; + return this->PrintVersion(os); default: return false; } } //---------------------------------------------------------------------------- -bool cmDocumentation::CreateModulesSection() -{ - cmDocumentationSection *sec = - new cmDocumentationSection("Standard CMake Modules", "MODULES"); - this->AllSections["Modules"] = sec; - std::string cmakeModules = this->CMakeRoot; - cmakeModules += "/Modules"; - cmsys::Directory dir; - dir.Load(cmakeModules.c_str()); - if (dir.GetNumberOfFiles() > 0) - { - sec->Append(cmDocumentationModulesHeader[0]); - sec->Append(cmModulesDocumentationDescription); - this->CreateModuleDocsForDir(dir, *this->AllSections["Modules"]); - } - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::CreateCustomModulesSection() -{ - bool sectionHasHeader = false; - - std::vector<std::string> dirs; - cmSystemTools::ExpandListArgument(this->CMakeModulePath, dirs); - - for(std::vector<std::string>::const_iterator dirIt = dirs.begin(); - dirIt != dirs.end(); - ++dirIt) - { - cmsys::Directory dir; - dir.Load(dirIt->c_str()); - if (dir.GetNumberOfFiles() > 0) - { - if (!sectionHasHeader) - { - cmDocumentationSection *sec = - new cmDocumentationSection("Custom CMake Modules","CUSTOM MODULES"); - this->AllSections["Custom CMake Modules"] = sec; - sec->Append(cmDocumentationCustomModulesHeader[0]); - sec->Append(cmCustomModulesDocumentationDescription); - sectionHasHeader = true; - } - this->CreateModuleDocsForDir - (dir, *this->AllSections["Custom CMake Modules"]); - } - } - - return true; -} - -//---------------------------------------------------------------------------- -void cmDocumentation -::CreateModuleDocsForDir(cmsys::Directory& dir, - cmDocumentationSection &moduleSection) -{ - // sort the files alphabetically, so the docs for one module are easier - // to find than if they are in random order - std::vector<std::string> sortedFiles; - for(unsigned int i = 0; i < dir.GetNumberOfFiles(); ++i) - { - sortedFiles.push_back(dir.GetFile(i)); - } - std::sort(sortedFiles.begin(), sortedFiles.end()); - - for(std::vector<std::string>::const_iterator fname = sortedFiles.begin(); - fname!=sortedFiles.end(); ++fname) - { - if(fname->length() > 6) - { - if(fname->substr(fname->length()-6, 6) == ".cmake") - { - std::string moduleName = fname->substr(0, fname->length()-6); - // this check is to avoid creating documentation for the modules with - // the same name in multiple directories of CMAKE_MODULE_PATH - if (this->ModulesFound.find(moduleName) == this->ModulesFound.end()) - { - this->ModulesFound.insert(moduleName); - std::string path = dir.GetPath(); - path += "/"; - path += (*fname); - this->CreateSingleModule(path.c_str(), moduleName.c_str(), - moduleSection); - } - } - } - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::CreateSingleModule(const char* fname, - const char* moduleName, - cmDocumentationSection &moduleSection) -{ - 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] == '#') - { - /* line beginnings with ## are mark-up ignore them */ - if (line.size()>=2 && line[1] == '#') continue; - // 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 - { - break; - } - } - - if(text.length() < 2 && brief.length() == 1) - { - 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); - moduleSection.Append(pname, pbrief, ptext); - return true; -} - - -//---------------------------------------------------------------------------- bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) { + int count = 0; bool result = true; // Loop over requested documentation types. @@ -587,13 +149,11 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) i != this->RequestedHelpItems.end(); ++i) { - this->SetForm(i->HelpForm, i->ManSection); this->CurrentArgument = i->Argument; // If a file name was given, use it. Otherwise, default to the // given stream. std::ofstream* fout = 0; std::ostream* s = &os; - std::string docname(""); if(i->Filename.length() > 0) { fout = new std::ofstream(i->Filename.c_str(), std::ios::out); @@ -605,14 +165,14 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) { result = false; } - if(i->Filename != "-") - { - docname = cmSystemTools::GetFilenameWithoutLastExtension(i->Filename); - } + } + else if(++count > 1) + { + os << "\n\n"; } // Print this documentation type to the stream. - if(!this->PrintDocumentation(i->HelpType, *s, docname.c_str()) || !*s) + if(!this->PrintDocumentation(i->HelpType, *s) || !*s) { result = false; } @@ -634,33 +194,27 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) }; -cmDocumentation::Form cmDocumentation::GetFormFromFilename( - const std::string& filename, - int* manSection) +void cmDocumentation::WarnFormFromFilename( + cmDocumentation::RequestedHelpItem& request) { - std::string ext = cmSystemTools::GetFilenameLastExtension(filename); + std::string ext = cmSystemTools::GetFilenameLastExtension(request.Filename); ext = cmSystemTools::UpperCase(ext); if ((ext == ".HTM") || (ext == ".HTML")) { - return cmDocumentation::HTMLForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: HTML help format no longer supported"); } - - if (ext == ".DOCBOOK") + else if (ext == ".DOCBOOK") { - return cmDocumentation::DocbookForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: Docbook help format no longer supported"); } - // ".1" to ".9" should be manpages - if ((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) + else if ((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) { - if (manSection) - { - *manSection = ext[1] - '0'; - } - return cmDocumentation::ManForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: Man help format no longer supported"); } - - return cmDocumentation::TextForm; } //---------------------------------------------------------------------------- @@ -668,29 +222,9 @@ void cmDocumentation::addCommonStandardDocSections() { cmDocumentationSection *sec; - sec = new cmDocumentationSection("Author","AUTHOR"); - sec->Append(cmDocumentationEntry - (0, - "This manual page was generated by the \"--help-man\" option.", - 0)); - this->AllSections["Author"] = sec; - - sec = new cmDocumentationSection("Copyright","COPYRIGHT"); - sec->Append(cmDocumentationCopyright); - this->AllSections["Copyright"] = sec; - - sec = new cmDocumentationSection("See Also","SEE ALSO"); - sec->Append(cmDocumentationStandardSeeAlso); - this->AllSections["Standard See Also"] = sec; - sec = new cmDocumentationSection("Options","OPTIONS"); sec->Append(cmDocumentationStandardOptions); this->AllSections["Options"] = sec; - - sec = new cmDocumentationSection("Compatibility Commands", - "COMPATIBILITY COMMANDS"); - sec->Append(cmCompatCommandsDocumentationDescription); - this->AllSections["Compatibility Commands"] = sec; } //---------------------------------------------------------------------------- @@ -698,27 +232,9 @@ void cmDocumentation::addCMakeStandardDocSections() { cmDocumentationSection *sec; - sec = new cmDocumentationSection("Properties","PROPERTIES"); - sec->Append(cmPropertiesDocumentationDescription); - this->AllSections["Properties Description"] = sec; - sec = new cmDocumentationSection("Generators","GENERATORS"); sec->Append(cmDocumentationGeneratorsHeader); this->AllSections["Generators"] = sec; - - this->PropertySections.push_back("Properties of Global Scope"); - this->PropertySections.push_back("Properties on Directories"); - this->PropertySections.push_back("Properties on Targets"); - this->PropertySections.push_back("Properties on Tests"); - this->PropertySections.push_back("Properties on Source Files"); - this->PropertySections.push_back("Properties on Cache Entries"); - - this->VariableSections.push_back("Variables that Provide Information"); - this->VariableSections.push_back("Variables That Change Behavior"); - this->VariableSections.push_back("Variables That Describe the System"); - this->VariableSections.push_back("Variables that Control the Build"); - this->VariableSections.push_back("Variables for Languages"); - } //---------------------------------------------------------------------------- @@ -737,347 +253,6 @@ void cmDocumentation::addCPackStandardDocSections() sec = new cmDocumentationSection("Generators","GENERATORS"); sec->Append(cmDocumentationGeneratorsHeader); this->AllSections["Generators"] = sec; - - this->VariableSections.push_back( - "Variables common to all CPack generators"); -} - -void cmDocumentation::addAutomaticVariableSections(const std::string& section) -{ - std::vector<std::string>::iterator it; - it = std::find(this->VariableSections.begin(), - this->VariableSections.end(), - section); - /* if the section does not exist then add it */ - if (it==this->VariableSections.end()) - { - this->VariableSections.push_back(section); - } -} -//---------------------------------------------------------------------------- -int cmDocumentation::getDocumentedModulesListInDir( - std::string path, - std::string globExpr, - documentedModulesList_t& docedModuleList) -{ - cmsys::Glob gl; - std::string findExpr; - std::vector<std::string> files; - std::string line; - documentedModuleSectionPair_t docPair; - int nbDocumentedModules = 0; - - findExpr = path + "/" + globExpr; - if (gl.FindFiles(findExpr)) - { - files = gl.GetFiles(); - for (std::vector<std::string>::iterator itf=files.begin(); - itf!=files.end();++itf) - { - std::ifstream fin((*itf).c_str()); - // file access trouble ignore it (ignore this kind of error) - if (!fin) continue; - /* read first line in order to get doc section */ - if (cmSystemTools::GetLineFromStream(fin, line)) - { - /* Doc section indicates that - * this file has structured doc in it. - */ - if (line.find("##section")!=std::string::npos) - { - // ok found one more documented module - ++nbDocumentedModules; - docPair.first = *itf; - // 10 is the size of '##section' + 1 - docPair.second = line.substr(10,std::string::npos); - docedModuleList.push_back(docPair); - } - // No else if no section is found (undocumented module) - } - // No else cannot read first line (ignore this kind of error) - line = ""; - } - } - if (nbDocumentedModules>0) - { - return 0; - } - else - { - return 1; - } -} - -//---------------------------------------------------------------------------- -static void trim(std::string& s) -{ - std::string::size_type pos = s.find_last_not_of(' '); - if(pos != std::string::npos) - { - s.erase(pos + 1); - pos = s.find_first_not_of(' '); - if(pos != std::string::npos) s.erase(0, pos); - } - else - { - s.erase(s.begin(), s.end()); - } -} - -int cmDocumentation::GetStructuredDocFromFile( - const char* fname, - std::vector<cmDocumentationEntry>& commands, - cmake* cm) -{ - enum sdoce { - SDOC_NONE, SDOC_MODULE, SDOC_MACRO, SDOC_FUNCTION, SDOC_VARIABLE, - SDOC_SECTION, - SDOC_UNKNOWN}; - int nbDocItemFound = 0; - int docCtxIdx = 0; - std::vector<int> docContextStack(60); - docContextStack[docCtxIdx]=SDOC_NONE; - cmDocumentationEntry e; - std::ifstream fin(fname); - if(!fin) - { - return nbDocItemFound; - } - std::string section; - std::string name; - std::string full; - std::string brief; - std::string line; - bool newCtx = false; /* we've just entered ##<beginkey> context */ - bool inBrief = false; /* we are currently parsing brief desc. */ - bool inFullFirstParagraph = false; /* we are currently parsing full - desc. first paragraph */ - brief = ""; - full = ""; - bool newParagraph = true; - while ( fin && cmSystemTools::GetLineFromStream(fin, line) ) - { - if(line.size() && line[0] == '#') - { - /* handle structured doc context */ - if ((line.size()>=2) && line[1]=='#') - { - /* markup word is following '##' stopping at first space - * Some markup word like 'section' may have more characters - * following but we don't handle those here. - */ - std::string mkword = line.substr(2,line.find(' ',2)-2); - if (mkword=="macro") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_MACRO; - newCtx = true; - } - else if (mkword=="variable") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_VARIABLE; - newCtx = true; - } - else if (mkword=="function") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_FUNCTION; - newCtx = true; - } - else if (mkword=="module") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_MODULE; - newCtx = true; - } - else if (mkword=="section") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_SECTION; - // 10 is the size of '##section' + 1 - section = line.substr(10,std::string::npos); - /* drop the rest of the line */ - line = ""; - newCtx = true; - } - else if (mkword.substr(0,3)=="end") - { - switch (docContextStack[docCtxIdx]) { - case SDOC_MACRO: - /* for now MACRO and FUNCTION are handled in the same way */ - case SDOC_FUNCTION: - commands.push_back(cmDocumentationEntry(name.c_str(), - brief.c_str(),full.c_str())); - break; - case SDOC_VARIABLE: - this->addAutomaticVariableSections(section); - cm->DefineProperty - (name.c_str(), cmProperty::VARIABLE, - brief.c_str(), - full.c_str(),false, - section.c_str()); - break; - case SDOC_MODULE: - /* not implemented */ - break; - case SDOC_SECTION: - /* not implemented */ - break; - default: - /* ignore other cases */ - break; - } - docCtxIdx--; - newCtx = false; - ++nbDocItemFound; - } - else - { - // error out unhandled context - return nbDocItemFound; - } - /* context is set go to next doc line */ - continue; - } - - // Now parse the text attached to the context - - // The first line after the context mark-up contains:: - // name - brief until. (brief is dot terminated or - // followed by a blank line) - if (newCtx) - { - // no brief (for easy variable definition) - if (line.find("-")==std::string::npos) - { - name = line.substr(1,std::string::npos); - trim(name); - brief = ""; - inBrief = false; - full = ""; - } - // here we have a name and brief beginning - else - { - name = line.substr(1,line.find("-")-1); - trim(name); - // we are parsing the brief context - brief = line.substr(line.find("-")+1,std::string::npos); - trim(brief); - // Brief may already be terminated on the first line - if (brief.find('.')!=std::string::npos) - { - inBrief = false; - full = brief.substr(brief.find('.')+1,std::string::npos); - trim(full); - inFullFirstParagraph = true; - brief = brief.substr(0,brief.find('.')); - } - // brief is continued on following lines - else - { - inBrief = true; - full = ""; - } - } - newCtx = false; - continue; - } - // blank line - if(line.size() <= 2) - { - if (inBrief) { - inBrief = false; - full = ""; - } else { - if (full.length()>0) - { - full += "\n"; - } - // the first paragraph of full has ended - inFullFirstParagraph = false; - } - newParagraph = true; - } - // brief is terminated by '.' - else if (inBrief && (line.find('.')!=std::string::npos)) - { - /* the brief just ended */ - inBrief = false; - std::string endBrief = line.substr(1,line.find('.')); - trim(endBrief); - trim(brief); - brief += " " + endBrief; - full += line.substr(line.find('.')+1,std::string::npos); - trim(full); - inFullFirstParagraph = true; - } - // we handle full text or multi-line brief. - else - { - std::string* text; - if (inBrief) - { - text = &brief; - } - else - { - text = &full; - } - // two spaces - if(line[1] == ' ' && line[2] == ' ') - { - // there is no "full first paragraph at all." - if (line[3] == ' ') - { - inFullFirstParagraph = false; - } - - if(!newParagraph && !inFullFirstParagraph) - { - *text += "\n"; - newParagraph = true; - } - // Skip #, and leave space for pre-formatted - if (inFullFirstParagraph) - { - std::string temp = line.c_str()+1; - trim(temp); - *text += " " + temp; - } - else - { - *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; - } - } - } - /* next line is not the first context line */ - newCtx = false; - } - return nbDocItemFound; } //---------------------------------------------------------------------------- @@ -1089,7 +264,6 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, { RequestedHelpItem help; help.HelpType = cmDocumentation::Usage; - help.HelpForm = cmDocumentation::UsageForm; this->RequestedHelpItems.push_back(help); return true; } @@ -1113,154 +287,159 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, (strcmp(argv[i], "-H") == 0)) { help.HelpType = cmDocumentation::Usage; - help.HelpForm = cmDocumentation::UsageForm; GET_OPT_ARGUMENT(help.Argument); help.Argument = cmSystemTools::LowerCase(help.Argument); // special case for single command if (!help.Argument.empty()) { - help.HelpType = cmDocumentation::Single; + help.HelpType = cmDocumentation::OneCommand; } } else if(strcmp(argv[i], "--help-properties") == 0) { - help.HelpType = cmDocumentation::Properties; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-properties.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-policies") == 0) { - help.HelpType = cmDocumentation::Policies; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-policies.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-variables") == 0) { - help.HelpType = cmDocumentation::Variables; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-variables.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-modules") == 0) { - help.HelpType = cmDocumentation::Modules; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-modules.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-custom-modules") == 0) { - help.HelpType = cmDocumentation::CustomModules; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message( + "Warning: --help-custom-modules no longer supported"); + return true; } else if(strcmp(argv[i], "--help-commands") == 0) { - help.HelpType = cmDocumentation::Commands; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-commands.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-compatcommands") == 0) { - help.HelpType = cmDocumentation::CompatCommands; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message( + "Warning: --help-compatcommands no longer supported"); + return true; } else if(strcmp(argv[i], "--help-full") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message("Warning: --help-full no longer supported"); + return true; } else if(strcmp(argv[i], "--help-html") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::HTMLForm; + cmSystemTools::Message("Warning: --help-html no longer supported"); + return true; } else if(strcmp(argv[i], "--help-man") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::ManForm; - help.ManSection = 1; + cmSystemTools::Message("Warning: --help-man no longer supported"); + return true; } else if(strcmp(argv[i], "--help-command") == 0) { - help.HelpType = cmDocumentation::Single; + help.HelpType = cmDocumentation::OneCommand; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); help.Argument = cmSystemTools::LowerCase(help.Argument); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-module") == 0) { - help.HelpType = cmDocumentation::SingleModule; + help.HelpType = cmDocumentation::OneModule; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-property") == 0) { - help.HelpType = cmDocumentation::SingleProperty; + help.HelpType = cmDocumentation::OneProperty; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-policy") == 0) { - help.HelpType = cmDocumentation::SinglePolicy; + help.HelpType = cmDocumentation::OnePolicy; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-variable") == 0) { - help.HelpType = cmDocumentation::SingleVariable; + help.HelpType = cmDocumentation::OneVariable; + GET_OPT_ARGUMENT(help.Argument); + GET_OPT_ARGUMENT(help.Filename); + this->WarnFormFromFilename(help); + } + else if(strcmp(argv[i], "--help-manual") == 0) + { + help.HelpType = cmDocumentation::OneManual; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-command-list") == 0) { - help.HelpType = cmDocumentation::List; + help.HelpType = cmDocumentation::ListCommands; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-module-list") == 0) { - help.HelpType = cmDocumentation::ModuleList; + help.HelpType = cmDocumentation::ListModules; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-property-list") == 0) { - help.HelpType = cmDocumentation::PropertyList; + help.HelpType = cmDocumentation::ListProperties; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-variable-list") == 0) { - help.HelpType = cmDocumentation::VariableList; + help.HelpType = cmDocumentation::ListVariables; + GET_OPT_ARGUMENT(help.Filename); + } + else if(strcmp(argv[i], "--help-policy-list") == 0) + { + help.HelpType = cmDocumentation::ListPolicies; + GET_OPT_ARGUMENT(help.Filename); + } + else if(strcmp(argv[i], "--help-manual-list") == 0) + { + help.HelpType = cmDocumentation::ListManuals; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--copyright") == 0) { - help.HelpType = cmDocumentation::Copyright; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::UsageForm; + cmSystemTools::Message("Warning: --copyright no longer supported"); + return true; } else if((strcmp(argv[i], "--version") == 0) || (strcmp(argv[i], "-version") == 0) || @@ -1268,7 +447,6 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, { help.HelpType = cmDocumentation::Version; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::UsageForm; } if(help.HelpType != None) { @@ -1281,40 +459,12 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, } //---------------------------------------------------------------------------- -void cmDocumentation::Print(Form f, int manSection, std::ostream& os) -{ - this->SetForm(f, manSection); - this->Print(os); -} - -//---------------------------------------------------------------------------- -void cmDocumentation::Print(std::ostream& os) -{ - // if the formatter supports it, print a master index for - // all sections - this->CurrentFormatter->PrintIndex(os, this->PrintSections); - for(unsigned int i=0; i < this->PrintSections.size(); ++i) - { - std::string name = this->PrintSections[i]-> - GetName((this->CurrentFormatter->GetForm())); - this->CurrentFormatter->PrintSection(os,*this->PrintSections[i], - name.c_str()); - } -} - -//---------------------------------------------------------------------------- void cmDocumentation::SetName(const char* name) { this->NameString = name?name:""; } //---------------------------------------------------------------------------- -void cmDocumentation::SetDocName(const char *docname) -{ - this->DocName = docname?docname:""; -} - -//---------------------------------------------------------------------------- void cmDocumentation::SetSection(const char *name, cmDocumentationSection *section) { @@ -1338,7 +488,7 @@ void cmDocumentation::SetSection(const char *name, //---------------------------------------------------------------------------- void cmDocumentation::SetSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = new cmDocumentationSection(name, @@ -1360,7 +510,7 @@ void cmDocumentation //---------------------------------------------------------------------------- void cmDocumentation::PrependSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = 0; if (this->AllSections.find(name) == this->AllSections.end()) @@ -1396,7 +546,7 @@ void cmDocumentation::PrependSection(const char *name, //---------------------------------------------------------------------------- void cmDocumentation::AppendSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = 0; if (this->AllSections.find(name) == this->AllSections.end()) @@ -1451,471 +601,242 @@ void cmDocumentation::PrependSection(const char *name, } //---------------------------------------------------------------------------- -void cmDocumentation::SetSeeAlsoList(const char *data[][3]) +void cmDocumentation::GlobHelp(std::vector<std::string>& files, + std::string const& pattern) { - cmDocumentationSection *sec = - new cmDocumentationSection("See Also", "SEE ALSO"); - this->AllSections["See Also"] = sec; - this->SeeAlsoString = ".B "; - int i = 0; - while(data[i][1]) + cmsys::Glob gl; + std::string findExpr = this->CMakeRoot + "/Help/" + pattern + ".rst"; + if(gl.FindFiles(findExpr)) { - this->SeeAlsoString += data[i][1]; - this->SeeAlsoString += data[i+1][1]? "(1), ":"(1)"; - ++i; + files = gl.GetFiles(); } - sec->Append(0,this->SeeAlsoString.c_str(),0); - sec->Append(cmDocumentationStandardSeeAlso); } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationGeneric(std::ostream& os, - const char *section) +void cmDocumentation::PrintNames(std::ostream& os, + std::string const& pattern) { - if(this->AllSections.find(section) == this->AllSections.end()) - { - os << "Internal error: " << section << " list is empty." << std::endl; - return false; - } - if(this->CurrentArgument.length() == 0) - { - os << "Required argument missing.\n"; - return false; - } - const std::vector<cmDocumentationEntry> &entries = - this->AllSections[section]->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator ei = - entries.begin(); - ei != entries.end(); ++ei) + std::vector<std::string> files; + this->GlobHelp(files, pattern); + std::vector<std::string> names; + for (std::vector<std::string>::const_iterator i = files.begin(); + i != files.end(); ++i) { - if(this->CurrentArgument == ei->Name) + std::string line; + std::ifstream fin(i->c_str()); + while(fin && cmSystemTools::GetLineFromStream(fin, line)) { - this->PrintDocumentationCommand(os, *ei); - return true; + if(!line.empty() && (isalnum(line[0]) || line[0] == '<')) + { + names.push_back(line); + break; + } } } - return false; + std::sort(names.begin(), names.end()); + for (std::vector<std::string>::iterator i = names.begin(); + i != names.end(); ++i) + { + os << *i << "\n"; + } } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingle(std::ostream& os) +bool cmDocumentation::PrintFiles(std::ostream& os, + std::string const& pattern) { - if (this->PrintDocumentationGeneric(os,"Commands")) - { - return true; - } - if (this->PrintDocumentationGeneric(os,"Compatibility Commands")) + bool found = false; + std::vector<std::string> files; + this->GlobHelp(files, pattern); + std::sort(files.begin(), files.end()); + cmRST r(os, this->CMakeRoot + "/Help"); + for (std::vector<std::string>::const_iterator i = files.begin(); + i != files.end(); ++i) { - return true; + found = r.ProcessFile(i->c_str()) || found; } - - // Argument was not a command. Complain. - os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-command is not a CMake command. " - << "Use --help-command-list to see all commands.\n"; - return false; + return found; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleModule(std::ostream& os) +bool cmDocumentation::PrintHelpOneManual(std::ostream& os) { - if(this->CurrentArgument.length() == 0) + std::string mname = this->CurrentArgument; + std::string::size_type mlen = mname.length(); + if(mlen > 3 && mname[mlen-3] == '(' && + mname[mlen-1] == ')') { - os << "Argument --help-module needs a module name.\n"; - return false; + mname = mname.substr(0, mlen-3) + "." + mname[mlen-2]; } - - std::string moduleName; - // find the module - std::vector<std::string> dirs; - cmSystemTools::ExpandListArgument(this->CMakeModulePath, dirs); - for(std::vector<std::string>::const_iterator dirIt = dirs.begin(); - dirIt != dirs.end(); - ++dirIt) + if(this->PrintFiles(os, "manual/" + mname) || + this->PrintFiles(os, "manual/" + mname + ".[0-9]")) { - moduleName = *dirIt; - moduleName += "/"; - moduleName += this->CurrentArgument; - moduleName += ".cmake"; - if(cmSystemTools::FileExists(moduleName.c_str())) - { - break; - } - moduleName = ""; - } - - if (moduleName.empty()) - { - moduleName = this->CMakeRoot; - moduleName += "/Modules/"; - moduleName += this->CurrentArgument; - moduleName += ".cmake"; - if(!cmSystemTools::FileExists(moduleName.c_str())) - { - moduleName = ""; - } - } - - if(!moduleName.empty()) - { - cmDocumentationSection *sec = - new cmDocumentationSection("Standard CMake Modules", "MODULES"); - this->AllSections["Modules"] = sec; - if (this->CreateSingleModule(moduleName.c_str(), - this->CurrentArgument.c_str(), - *this->AllSections["Modules"])) - { - if(this->AllSections["Modules"]->GetEntries().size()) - { - this->PrintDocumentationCommand - (os, this->AllSections["Modules"]->GetEntries()[0]); - os << "\n Defined in: "; - os << moduleName << "\n"; - return true; - } - else - { - return false; - } - } + return true; } - - // Argument was not a module. Complain. + // Argument was not a manual. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-module is not a CMake module.\n"; + << "\" to --help-manual is not an available manual. " + << "Use --help-manual-list to see all available manuals.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleProperty(std::ostream& os) +bool cmDocumentation::PrintHelpListManuals(std::ostream& os) { - bool done = false; - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - !done && i != this->PropertySections.end(); ++i) - { - done = this->PrintDocumentationGeneric(os,i->c_str()); - } + this->PrintNames(os, "manual/*"); + return true; +} - if (done) +//---------------------------------------------------------------------------- +bool cmDocumentation::PrintHelpOneCommand(std::ostream& os) +{ + std::string cname = cmSystemTools::LowerCase(this->CurrentArgument); + if(this->PrintFiles(os, "command/" + cname)) { return true; } - // Argument was not a command. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-property is not a CMake property. " - << "Use --help-property-list to see all properties.\n"; + << "\" to --help-command is not a CMake command. " + << "Use --help-command-list to see all commands.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSinglePolicy(std::ostream& os) +bool cmDocumentation::PrintHelpListCommands(std::ostream& os) { - if (this->PrintDocumentationGeneric(os,"Policies")) - { - return true; - } - - // Argument was not a policy. Complain. - os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-policy is not a CMake policy.\n"; - return false; + this->PrintNames(os, "command/*"); + return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleVariable(std::ostream& os) +bool cmDocumentation::PrintHelpOneModule(std::ostream& os) { - bool done = false; - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - !done && i != this->VariableSections.end(); ++i) - { - done = this->PrintDocumentationGeneric(os,i->c_str()); - } - - if (done) + std::string mname = this->CurrentArgument; + if(this->PrintFiles(os, "module/" + mname)) { return true; } - - // Argument was not a variable. Complain. + // Argument was not a module. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-variable is not a defined variable. " - << "Use --help-variable-list to see all defined variables.\n"; + << "\" to --help-module is not a CMake module.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationList(std::ostream& os, - const char *section) +bool cmDocumentation::PrintHelpListModules(std::ostream& os) { - if(this->AllSections.find(section) == this->AllSections.end()) + std::vector<std::string> files; + this->GlobHelp(files, "module/*"); + std::vector<std::string> modules; + for (std::vector<std::string>::iterator fi = files.begin(); + fi != files.end(); ++fi) { - os << "Internal error: " << section << " list is empty." << std::endl; - return false; + std::string module = cmSystemTools::GetFilenameName(*fi); + modules.push_back(module.substr(0, module.size()-4)); } - - const std::vector<cmDocumentationEntry> &entries = - this->AllSections[section]->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator ei = - entries.begin(); - ei != entries.end(); ++ei) + std::sort(modules.begin(), modules.end()); + for (std::vector<std::string>::iterator i = modules.begin(); + i != modules.end(); ++i) { - if(ei->Name.size()) - { - os << ei->Name << std::endl; - } + os << *i << "\n"; } return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationUsage(std::ostream& os) +bool cmDocumentation::PrintHelpOneProperty(std::ostream& os) { - this->ClearSections(); - this->AddSectionToPrint("Usage"); - this->AddSectionToPrint("Options"); - if(this->ShowGenerators) + std::string pname = cmSystemTools::HelpFileName(this->CurrentArgument); + if(this->PrintFiles(os, "prop_*/" + pname)) { - this->AddSectionToPrint("Generators"); + return true; } - this->Print(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationFull(std::ostream& os) -{ - this->CreateFullDocumentation(); - this->CurrentFormatter->PrintHeader(GetNameString(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationModules(std::ostream& os) -{ - this->ClearSections(); - this->CreateModulesSection(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Modules)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Modules"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a property. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-property is not a CMake property. " + << "Use --help-property-list to see all properties.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCustomModules(std::ostream& os) +bool cmDocumentation::PrintHelpListProperties(std::ostream& os) { - this->ClearSections(); - this->CreateCustomModulesSection(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(CustomModules)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Custom CMake Modules"); -// the custom modules are most probably not under Kitware's copyright, Alex -// this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); - - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "prop_*/*"); return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationPolicies(std::ostream& os) +bool cmDocumentation::PrintHelpOnePolicy(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Policies)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Policies"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); + std::string pname = this->CurrentArgument; + std::vector<std::string> files; + if(this->PrintFiles(os, "policy/" + pname)) + { + return true; + } - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a policy. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-policy is not a CMake policy.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationProperties(std::ostream& os) +bool cmDocumentation::PrintHelpListPolicies(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Properties)); - this->AddSectionToPrint("Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) - { - this->AddSectionToPrint(i->c_str()); - } - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "policy/*"); return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationVariables(std::ostream& os) +bool cmDocumentation::PrintHelpOneVariable(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Variables)); - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - i != this->VariableSections.end(); ++i) + std::string vname = cmSystemTools::HelpFileName(this->CurrentArgument); + if(this->PrintFiles(os, "variable/" + vname)) { - this->AddSectionToPrint(i->c_str()); + return true; } - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCurrentCommands(std::ostream& os) -{ - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Commands)); - this->AddSectionToPrint("Commands"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a variable. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-variable is not a defined variable. " + << "Use --help-variable-list to see all defined variables.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCompatCommands(std::ostream& os) +bool cmDocumentation::PrintHelpListVariables(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(CompatCommands)); - this->AddSectionToPrint("Compatibility Commands Description"); - this->AddSectionToPrint("Compatibility Commands"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "variable/*"); return true; } //---------------------------------------------------------------------------- -void cmDocumentation -::PrintDocumentationCommand(std::ostream& os, - const cmDocumentationEntry &entry) -{ - // the string "SingleItem" will be used in a few places to detect the case - // that only the documentation for a single item is printed - cmDocumentationSection *sec = new cmDocumentationSection("SingleItem",""); - sec->Append(entry); - this->AllSections["temp"] = sec; - this->ClearSections(); - this->AddSectionToPrint("temp"); - this->Print(os); - this->AllSections.erase("temp"); - delete sec; -} - -//---------------------------------------------------------------------------- -void cmDocumentation::CreateFullDocumentation() +bool cmDocumentation::PrintDocumentationUsage(std::ostream& os) { - this->ClearSections(); - this->CreateCustomModulesSection(); - this->CreateModulesSection(); - - std::set<std::string> emitted; - this->AddSectionToPrint("Name"); - emitted.insert("Name"); - this->AddSectionToPrint("Usage"); - emitted.insert("Usage"); - this->AddSectionToPrint("Description"); - emitted.insert("Description"); - this->AddSectionToPrint("Options"); - emitted.insert("Options"); - this->AddSectionToPrint("Generators"); - emitted.insert("Generators"); - this->AddSectionToPrint("Commands"); - emitted.insert("Commands"); - - - this->AddSectionToPrint("Properties Description"); - emitted.insert("Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) + std::map<std::string,cmDocumentationSection*>::iterator si; + si = this->AllSections.find("Usage"); + if(si != this->AllSections.end()) { - this->AddSectionToPrint(i->c_str()); - emitted.insert(i->c_str()); + this->Formatter.PrintSection(os, *si->second); } - - emitted.insert("Copyright"); - emitted.insert("See Also"); - emitted.insert("Standard See Also"); - emitted.insert("Author"); - - // add any sections not yet written out, or to be written out - for (std::map<std::string, cmDocumentationSection*>::iterator i = - this->AllSections.begin(); - i != this->AllSections.end(); ++i) - { - if (emitted.find(i->first) == emitted.end()) - { - this->AddSectionToPrint(i->first.c_str()); - } - } - - this->AddSectionToPrint("Copyright"); - - if(this->CurrentFormatter->GetForm() == ManForm) + si = this->AllSections.find("Options"); + if(si != this->AllSections.end()) { - this->AddSectionToPrint("See Also"); - this->AddSectionToPrint("Author"); + this->Formatter.PrintSection(os, *si->second); } - else + if(this->ShowGenerators) { - this->AddSectionToPrint("Standard See Also"); + si = this->AllSections.find("Generators"); + if(si != this->AllSections.end()) + { + this->Formatter.PrintSection(os, *si->second); + } } + return true; } //---------------------------------------------------------------------------- -void cmDocumentation::SetForm(Form f, int manSection) -{ - switch(f) - { - case HTMLForm: - this->CurrentFormatter = &this->HTMLFormatter; - break; - case DocbookForm: - this->CurrentFormatter = &this->DocbookFormatter; - break; - case ManForm: - this->ManFormatter.SetManSection(manSection); - this->CurrentFormatter = &this->ManFormatter; - break; - case TextForm: - this->CurrentFormatter = &this->TextFormatter; - break; - case UsageForm: - this->CurrentFormatter = & this->UsageFormatter; - break; - } -} - - -//---------------------------------------------------------------------------- const char* cmDocumentation::GetNameString() const { if(this->NameString.length() > 0) @@ -1929,41 +850,6 @@ const char* cmDocumentation::GetNameString() const } //---------------------------------------------------------------------------- -const char* cmDocumentation::GetDocName(bool fallbackToNameString) const -{ - if (this->DocName.length() > 0) - { - return this->DocName.c_str(); - } - else if (fallbackToNameString) - { - return this->GetNameString(); - } - else - return 0; -} - -//---------------------------------------------------------------------------- -#define CASE_DEFAULT_DOCNAME(doctype) \ - case cmDocumentation::doctype : \ - return GET_DOCUMENT_INTRO(doctype)[0]; -const char* cmDocumentation::GetDefaultDocName(Type ht) const -{ - switch (ht) - { - CASE_DEFAULT_DOCNAME(Modules) - CASE_DEFAULT_DOCNAME(CustomModules) - CASE_DEFAULT_DOCNAME(Policies) - CASE_DEFAULT_DOCNAME(Properties) - CASE_DEFAULT_DOCNAME(Variables) - CASE_DEFAULT_DOCNAME(Commands) - CASE_DEFAULT_DOCNAME(CompatCommands) - default: break; - } - return 0; -} - -//---------------------------------------------------------------------------- bool cmDocumentation::IsOption(const char* arg) const { return ((arg[0] == '-') || (strcmp(arg, "/V") == 0) || diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index e180f60..07e614d 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -15,11 +15,6 @@ #include "cmStandardIncludes.h" #include "cmProperty.h" #include "cmDocumentationFormatter.h" -#include "cmDocumentationFormatterHTML.h" -#include "cmDocumentationFormatterDocbook.h" -#include "cmDocumentationFormatterMan.h" -#include "cmDocumentationFormatterText.h" -#include "cmDocumentationFormatterUsage.h" #include "cmDocumentationSection.h" #include "cmake.h" @@ -37,22 +32,6 @@ public: ~cmDocumentation(); /** - * An helper type pair for [structured] documented modules. - * The comment of those module contains structure markup - * which makes it possible to retrieve the documentation - * of variables, macros and functions defined in the module. - * - first is the filename of the module - * - second is the section of the doc the module belongs too - */ - typedef std::pair<std::string,std::string> documentedModuleSectionPair_t; - /** - * A list of documented module(s). - */ - typedef std::list<documentedModuleSectionPair_t> documentedModulesList_t; - - // High-level interface for standard documents: - - /** * Check command line arguments for documentation options. Returns * true if documentation options are found, and false otherwise. * When true is returned, PrintRequestedDocumentation should be @@ -72,7 +51,7 @@ public: bool PrintRequestedDocumentation(std::ostream& os); /** Print help of the given type. */ - bool PrintDocumentation(Type ht, std::ostream& os, const char* docname=0); + bool PrintDocumentation(Type ht, std::ostream& os); void SetShowGenerators(bool showGen) { this->ShowGenerators = showGen; } @@ -80,61 +59,32 @@ public: void SetName(const char* name); /** Set a section of the documentation. Typical sections include Name, - Usage, Description, Options, SeeAlso */ + Usage, Description, Options */ void SetSection(const char *sectionName, cmDocumentationSection *section); void SetSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void SetSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void SetSections(std::map<std::string,cmDocumentationSection *> §ions); /** Add the documentation to the beginning/end of the section */ void PrependSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void PrependSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void PrependSection(const char *sectionName, cmDocumentationEntry &docs); void AppendSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void AppendSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void AppendSection(const char *sectionName, cmDocumentationEntry &docs); - /** - * Print documentation in the given form. All previously added - * sections will be generated. - */ - void Print(Form f, int manSection, std::ostream& os); - - /** - * Print documentation in the current form. All previously added - * sections will be generated. - */ - void Print(std::ostream& os); - - /** - * Add a section of documentation. This can be used to generate custom help - * documents. - */ - void AddSectionToPrint(const char *section); - - void SetSeeAlsoList(const char *data[][3]); - - /** Clear all previously added sections of help. */ - void ClearSections(); - /** Set cmake root so we can find installed files */ - void SetCMakeRoot(const char* root) { this->CMakeRoot = root;} - - /** Set CMAKE_MODULE_PATH so we can find additional cmake modules */ - void SetCMakeModulePath(const char* path) { this->CMakeModulePath = path;} - - static Form GetFormFromFilename(const std::string& filename, - int* ManSection); + void SetCMakeRoot(const char* root) { this->CMakeRoot = root? root:"";} /** Add common (to all tools) documentation section(s) */ void addCommonStandardDocSections(); @@ -148,124 +98,50 @@ public: /** Add the CPack standard documentation section(s) */ void addCPackStandardDocSections(); - /** Add automatic variables sections */ - void addAutomaticVariableSections(const std::string& section); - - /** - * Retrieve the list of documented module located in - * path which match the globing expression globExpr. - * @param[in] path, directory where to start the search - * we will recurse into it. - * @param[in] globExpr, the globing expression used to - * match the file in path. - * @param[out] the list of obtained pairs (may be empty) - * @return 0 on success 1 on error or empty list - */ - int getDocumentedModulesListInDir( - std::string path, - std::string globExpr, - documentedModulesList_t& docModuleList); - - /** - * Get the documentation of macros, functions and variable documented - * with CMake structured documentation in a CMake script. - * (in fact it may be in any file which follow the structured doc format) - * Structured documentation begin with - * ## (double sharp) in column 1 & 2 immediately followed - * by a markup. Those ## are ignored by the legacy module - * documentation parser @see CreateSingleModule. - * Current markup are ##section, ##module, - * ##macro, ##function, ##variable and ##end. - * ##end is closing either of the previous ones. - * @param[in] fname the script file name to be parsed for documentation - * @param[in,out] commands the vector of command/macros documentation - * entry found in the script file. - * @param[in,out] the cmake object instance to which variable documentation - * will be attached (using @see cmake::DefineProperty) - * @param[in] the documentation section in which the property will be - * inserted. - * @return the number of documented items (command and variable) - * found in the file. - */ - int GetStructuredDocFromFile(const char* fname, - std::vector<cmDocumentationEntry>& commands, - cmake* cm); private: - void SetForm(Form f, int manSection); - void SetDocName(const char* docname); - - bool CreateSingleModule(const char* fname, - const char* moduleName, - cmDocumentationSection &sec); - void CreateModuleDocsForDir(cmsys::Directory& dir, - cmDocumentationSection &moduleSection); - bool CreateModulesSection(); - bool CreateCustomModulesSection(); - void CreateFullDocumentation(); - void AddDocumentIntroToPrint(const char* intro[2]); + void GlobHelp(std::vector<std::string>& files, std::string const& pattern); + void PrintNames(std::ostream& os, std::string const& pattern); + bool PrintFiles(std::ostream& os, std::string const& pattern); - bool PrintCopyright(std::ostream& os); bool PrintVersion(std::ostream& os); - bool PrintDocumentationGeneric(std::ostream& os, const char *section); - bool PrintDocumentationList(std::ostream& os, const char *section); - bool PrintDocumentationSingle(std::ostream& os); - bool PrintDocumentationSingleModule(std::ostream& os); - bool PrintDocumentationSingleProperty(std::ostream& os); - bool PrintDocumentationSinglePolicy(std::ostream& os); - bool PrintDocumentationSingleVariable(std::ostream& os); + bool PrintHelpOneManual(std::ostream& os); + bool PrintHelpOneCommand(std::ostream& os); + bool PrintHelpOneModule(std::ostream& os); + bool PrintHelpOnePolicy(std::ostream& os); + bool PrintHelpOneProperty(std::ostream& os); + bool PrintHelpOneVariable(std::ostream& os); + bool PrintHelpListManuals(std::ostream& os); + bool PrintHelpListCommands(std::ostream& os); + bool PrintHelpListModules(std::ostream& os); + bool PrintHelpListProperties(std::ostream& os); + bool PrintHelpListVariables(std::ostream& os); + bool PrintHelpListPolicies(std::ostream& os); bool PrintDocumentationUsage(std::ostream& os); - bool PrintDocumentationFull(std::ostream& os); - bool PrintDocumentationModules(std::ostream& os); - bool PrintDocumentationCustomModules(std::ostream& os); - bool PrintDocumentationPolicies(std::ostream& os); - bool PrintDocumentationProperties(std::ostream& os); - bool PrintDocumentationVariables(std::ostream& os); - bool PrintDocumentationCurrentCommands(std::ostream& os); - bool PrintDocumentationCompatCommands(std::ostream& os); - void PrintDocumentationCommand(std::ostream& os, - const cmDocumentationEntry &entry); - const char* GetNameString() const; - const char* GetDocName(bool fallbackToNameString = true) const; - const char* GetDefaultDocName(Type ht) const; bool IsOption(const char* arg) const; bool ShowGenerators; std::string NameString; - std::string DocName; std::map<std::string,cmDocumentationSection*> AllSections; - std::string SeeAlsoString; std::string CMakeRoot; - std::string CMakeModulePath; - std::set<std::string> ModulesFound; - std::vector< char* > ModuleStrings; - std::vector<const cmDocumentationSection *> PrintSections; std::string CurrentArgument; struct RequestedHelpItem { - RequestedHelpItem():HelpForm(TextForm), HelpType(None), ManSection(1) {} - cmDocumentationEnums::Form HelpForm; + RequestedHelpItem(): HelpType(None) {} cmDocumentationEnums::Type HelpType; std::string Filename; std::string Argument; - int ManSection; }; std::vector<RequestedHelpItem> RequestedHelpItems; - cmDocumentationFormatter* CurrentFormatter; - cmDocumentationFormatterHTML HTMLFormatter; - cmDocumentationFormatterDocbook DocbookFormatter; - cmDocumentationFormatterMan ManFormatter; - cmDocumentationFormatterText TextFormatter; - cmDocumentationFormatterUsage UsageFormatter; + cmDocumentationFormatter Formatter; - std::vector<std::string> PropertySections; - std::vector<std::string> VariableSections; + static void WarnFormFromFilename(RequestedHelpItem& request); }; #endif diff --git a/Source/cmDocumentationFormatter.cxx b/Source/cmDocumentationFormatter.cxx index 9f01949..29c806d 100644 --- a/Source/cmDocumentationFormatter.cxx +++ b/Source/cmDocumentationFormatter.cxx @@ -11,7 +11,10 @@ ============================================================================*/ #include "cmDocumentationFormatter.h" -cmDocumentationFormatter::cmDocumentationFormatter() +#include "cmDocumentationSection.h" + +cmDocumentationFormatter::cmDocumentationFormatter(): + TextWidth(77), TextIndent("") { } @@ -66,91 +69,162 @@ void cmDocumentationFormatter::PrintFormatted(std::ostream& os, } } -//---------------------------------------------------------------------------- -std::string -cmDocumentationFormatter::ComputeSectionLinkPrefix(std::string const& name) +void cmDocumentationFormatter::PrintPreformatted(std::ostream& os, + const char* text) { - // Map from section name to a prefix for links pointing within the - // section. For example, the commands section should have HTML - // links to each command with names like #command:ADD_EXECUTABLE. - if(name.find("Command") != name.npos) - { - return "command"; - } - else if(name.find("Propert") != name.npos) + bool newline = true; + for(const char* ptr = text; *ptr; ++ptr) { - if(name.find("Global") != name.npos) - { - return "prop_global"; - } - else if(name.find("Direct") != name.npos) + if(newline && *ptr != '\n') { - return "prop_dir"; + os << this->TextIndent; + newline = false; } - else if(name.find("Target") != name.npos) + os << *ptr; + if(*ptr == '\n') { - return "prop_tgt"; + newline = true; } - else if(name.find("Test") != name.npos) + } + os << "\n"; +} + +void cmDocumentationFormatter::PrintParagraph(std::ostream& os, + const char* text) +{ + os << this->TextIndent; + this->PrintColumn(os, text); + os << "\n"; +} + +void cmDocumentationFormatter::SetIndent(const char* indent) +{ + this->TextIndent = indent; +} + +void cmDocumentationFormatter::PrintColumn(std::ostream& os, + const char* text) +{ + // Print text arranged in an indented column of fixed witdh. + const char* l = text; + long column = 0; + bool newSentence = false; + bool firstLine = true; + int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent)); + + // Loop until the end of the text. + while(*l) + { + // Parse the next word. + const char* r = l; + while(*r && (*r != '\n') && (*r != ' ')) { ++r; } + + // Does it fit on this line? + if(r-l < (width-column-(newSentence?1:0))) { - return "prop_test"; + // Word fits on this line. + if(r > l) + { + if(column) + { + // Not first word on line. Separate from the previous word + // by a space, or two if this is a new sentence. + if(newSentence) + { + os << " "; + column += 2; + } + else + { + os << " "; + column += 1; + } + } + else + { + // First word on line. Print indentation unless this is the + // first line. + os << (firstLine?"":this->TextIndent); + } + + // Print the word. + os.write(l, static_cast<long>(r-l)); + newSentence = (*(r-1) == '.'); + } + + if(*r == '\n') + { + // Text provided a newline. Start a new line. + os << "\n"; + ++r; + column = 0; + firstLine = false; + } + else + { + // No provided newline. Continue this line. + column += static_cast<long>(r-l); + } } - else if(name.find("Source") != name.npos) + else { - return "prop_sf"; + // Word does not fit on this line. Start a new line. + os << "\n"; + firstLine = false; + if(r > l) + { + os << this->TextIndent; + os.write(l, static_cast<long>(r-l)); + column = static_cast<long>(r-l); + newSentence = (*(r-1) == '.'); + } + else + { + column = 0; + } } - return "property"; - } - else if(name.find("Variable") != name.npos) - { - return "variable"; - } - else if(name.find("Polic") != name.npos) - { - return "policy"; - } - else if(name.find("Module") != name.npos) - { - return "module"; - } - else if(name.find("Name") != name.npos || - name.find("Introduction") != name.npos) - { - return "name"; - } - else if(name.find("Usage") != name.npos) - { - return "usage"; - } - else if(name.find("Description") != name.npos) - { - return "desc"; - } - else if(name.find("Generators") != name.npos) - { - return "gen"; - } - else if(name.find("Options") != name.npos) - { - return "opt"; - } - else if(name.find("Copyright") != name.npos) - { - return "copy"; - } - else if(name.find("See Also") != name.npos) - { - return "see"; - } - else if(name.find("SingleItem") != name.npos) - { - return "single_item"; + + // Move to beginning of next word. Skip over whitespace. + l = r; + while(*l && (*l == ' ')) { ++l; } } - else +} + +void cmDocumentationFormatter +::PrintSection(std::ostream& os, + cmDocumentationSection const& section) +{ + os << section.GetName() << "\n"; + + const std::vector<cmDocumentationEntry> &entries = + section.GetEntries(); + for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); + op != entries.end(); ++op) { - std::cerr - << "WARNING: ComputeSectionLinkPrefix failed for \"" << name << "\"" - << std::endl; - return "other"; + if(op->Name.size()) + { + os << " " << op->Name; + this->TextIndent = " "; + int align = static_cast<int>(strlen(this->TextIndent))-4; + for(int i = static_cast<int>(op->Name.size()); i < align; ++i) + { + os << " "; + } + if (op->Name.size() > strlen(this->TextIndent)-4 ) + { + os << "\n"; + os.write(this->TextIndent, strlen(this->TextIndent)-2); + } + os << "= "; + this->PrintColumn(os, op->Brief.c_str()); + os << "\n"; + } + else + { + os << "\n"; + this->TextIndent = ""; + this->PrintFormatted(os, op->Brief.c_str()); + } } + os << "\n"; } diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h index 665b9b6..c7da52c 100644 --- a/Source/cmDocumentationFormatter.h +++ b/Source/cmDocumentationFormatter.h @@ -25,19 +25,16 @@ class cmDocumentationEnums public: /** Types of help provided. */ enum Type - { None, Usage, Single, SingleModule, SingleProperty, SingleVariable, - List, ModuleList, PropertyList, VariableList, - Full, Properties, Variables, Modules, CustomModules, Commands, - CompatCommands, Copyright, Version, Policies, SinglePolicy }; - - /** Forms of documentation output. */ - enum Form { TextForm, HTMLForm, ManForm, UsageForm, DocbookForm }; + { + None, Version, Usage, ListManuals, + ListCommands, ListModules, ListProperties, ListVariables, ListPolicies, + OneManual, OneCommand, OneModule, OneProperty, OneVariable, OnePolicy + }; }; class cmDocumentationSection; -/** Base class for printing the documentation in the various supported - formats. */ +/** Print documentation in a simple text format. */ class cmDocumentationFormatter { public: @@ -45,23 +42,15 @@ public: virtual ~cmDocumentationFormatter(); void PrintFormatted(std::ostream& os, const char* text); - virtual cmDocumentationEnums::Form GetForm() const = 0; - - virtual void PrintHeader(const char* /*docname*/, - const char* /*appname*/, - std::ostream& /*os*/) {} - virtual void PrintFooter(std::ostream& /*os*/) {} virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name) = 0; - virtual void PrintPreformatted(std::ostream& os, const char* text) = 0; - virtual void PrintParagraph(std::ostream& os, const char* text) = 0; - virtual void PrintIndex(std::ostream& , - std::vector<const cmDocumentationSection *>&) - {} - - /** Compute a prefix for links into a section (#\<prefix\>_SOMETHING). */ - std::string ComputeSectionLinkPrefix(std::string const& name); + cmDocumentationSection const& section); + virtual void PrintPreformatted(std::ostream& os, const char* text); + virtual void PrintParagraph(std::ostream& os, const char* text); + void PrintColumn(std::ostream& os, const char* text); + void SetIndent(const char* indent); +private: + int TextWidth; + const char* TextIndent; }; #endif diff --git a/Source/cmDocumentationFormatterDocbook.cxx b/Source/cmDocumentationFormatterDocbook.cxx deleted file mode 100644 index 706ce0a..0000000 --- a/Source/cmDocumentationFormatterDocbook.cxx +++ /dev/null @@ -1,254 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#include "cmDocumentationFormatterDocbook.h" -#include "cmDocumentationSection.h" -#include <algorithm> -#include <ctype.h> // for isalnum - -static int cmIsAlnum(int c) -{ - return isalnum(c); -} - -//---------------------------------------------------------------------------- - -// this function is a copy of the one in the HTML formatter -// the three functions below are slightly modified copies -static bool cmDocumentationIsHyperlinkCharDocbook(char c) -{ - // This is not a complete list but works for CMake documentation. - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '.' || c == '/' || c == '~' || c == '@' || - c == ':' || c == '_' || c == '&' || c == '?' || c == '='); -} - -//---------------------------------------------------------------------------- -static void cmDocumentationPrintDocbookChar(std::ostream& os, char c) -{ - // Use an escape sequence if necessary. - switch(c) - { - case '<': - os << "<"; - break; - case '>': - os << ">"; - break; - case '&': - os << "&"; - break; - default: - os << c; - } -} - -//---------------------------------------------------------------------------- -const char* cmDocumentationPrintDocbookLink(std::ostream& os,const char* begin) -{ - // Look for the end of the link. - const char* end = begin; - while(cmDocumentationIsHyperlinkCharDocbook(*end)) - { - ++end; - } - - // Print the hyperlink itself. - os << "<ulink url=\""; - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintDocbookChar(os, *c); - } - os << "\" />"; - - return end; -} - -//---------------------------------------------------------------------------- -void cmDocumentationPrintDocbookEscapes(std::ostream& os, const char* text) -{ - // Hyperlink prefixes. - static const char* hyperlinks[] = {"http://", "ftp://", "mailto:", 0}; - - // Print each character. - for(const char* p = text; *p;) - { - // Handle hyperlinks specially to make them active. - bool found_hyperlink = false; - for(const char** h = hyperlinks; !found_hyperlink && *h; ++h) - { - if(strncmp(p, *h, strlen(*h)) == 0) - { - p = cmDocumentationPrintDocbookLink(os, p); - found_hyperlink = true; - } - } - - // Print other characters normally. - if(!found_hyperlink) - { - cmDocumentationPrintDocbookChar(os, *p++); - } - } -} - -//---------------------------------------------------------------------------- -cmDocumentationFormatterDocbook::cmDocumentationFormatterDocbook() -:cmDocumentationFormatter() -{ -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - os << "<sect1 id=\""; - this->PrintId(os, 0, name); - os << "\">\n<title>" << name << "</title>\n"; - - std::string prefix = this->ComputeSectionLinkPrefix(name); - const std::vector<cmDocumentationEntry> &entries = section.GetEntries(); - - bool hasSubSections = false; - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - hasSubSections = true; - break; - } - } - - bool inAbstract = false; - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - if(inAbstract) - { - os << "</abstract>\n"; - inAbstract = false; - } - os << "<sect2 id=\""; - this->PrintId(os, prefix.c_str(), op->Name); - os << "\">\n<title>"; - cmDocumentationPrintDocbookEscapes(os, op->Name.c_str()); - os << "</title>\n"; - if(op->Full.size()) - { - os << "<abstract>\n<para>"; - cmDocumentationPrintDocbookEscapes(os, op->Brief.c_str()); - os << "</para>\n</abstract>\n"; - this->PrintFormatted(os, op->Full.c_str()); - } - else - { - this->PrintFormatted(os, op->Brief.c_str()); - } - os << "</sect2>\n"; - } - else - { - if(hasSubSections && op == entries.begin()) - { - os << "<abstract>\n"; - inAbstract = true; - } - this->PrintFormatted(os, op->Brief.c_str()); - } - } - - // empty sections are not allowed in docbook. - if(entries.empty()) - { - os << "<para/>\n"; - } - - os << "</sect1>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintPreformatted(std::ostream& os, const char* text) -{ - os << "<para>\n<programlisting>"; - cmDocumentationPrintDocbookEscapes(os, text); - os << "</programlisting>\n</para>\n"; -} - -void cmDocumentationFormatterDocbook -::PrintParagraph(std::ostream& os, const char* text) -{ - os << "<para>"; - cmDocumentationPrintDocbookEscapes(os, text); - os << "</para>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintHeader(const char* docname, const char* appname, std::ostream& os) -{ - this->Docname = docname; - - // this one is used to ensure that we don't create multiple link targets - // with the same name. We can clear it here since we are at the - // start of a document here. - this->EmittedLinkIds.clear(); - - os << "<?xml version=\"1.0\" ?>\n" - "<!DOCTYPE article PUBLIC \"-//OASIS//DTD DocBook V4.5//EN\" " - "\"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd\" [\n" - "<!ENTITY % addindex \"IGNORE\">\n" - "<!ENTITY % English \"INCLUDE\"> ]>\n" - "<article>\n" - "<articleinfo>\n" - "<title>" << docname << " - " << appname << "</title>\n" - "</articleinfo>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook::PrintFooter(std::ostream& os) -{ - os << "</article>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintId(std::ostream& os, const char* prefix, std::string id) -{ - std::replace_if(id.begin(), id.end(), - std::not1(std::ptr_fun(cmIsAlnum)), '_'); - if(prefix) - { - id = std::string(prefix) + "." + id; - } - os << this->Docname << '.' << id; - - // make sure that each id exists only once. Since it seems - // not easily possible to determine which link refers to which id, - // we have at least to make sure that the duplicated id's get a - // different name (by appending an increasing number), Alex - if (this->EmittedLinkIds.find(id) == this->EmittedLinkIds.end()) - { - this->EmittedLinkIds.insert(id); - } - else - { - static unsigned int i=0; - os << i++; - } -} diff --git a/Source/cmDocumentationFormatterDocbook.h b/Source/cmDocumentationFormatterDocbook.h deleted file mode 100644 index 0352d34..0000000 --- a/Source/cmDocumentationFormatterDocbook.h +++ /dev/null @@ -1,43 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterDocbook_h -#define _cmDocumentationFormatterDocbook_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as Docbook. - http://www.oasis-open.org/docbook/xml/4.2/ */ -class cmDocumentationFormatterDocbook : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterDocbook(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::DocbookForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintFooter(std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); -private: - void PrintId(std::ostream& os, const char* prefix, std::string id); - std::set<std::string> EmittedLinkIds; - std::string Docname; -}; - -#endif diff --git a/Source/cmDocumentationFormatterHTML.cxx b/Source/cmDocumentationFormatterHTML.cxx deleted file mode 100644 index 7213b43..0000000 --- a/Source/cmDocumentationFormatterHTML.cxx +++ /dev/null @@ -1,288 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#include "cmDocumentationFormatterHTML.h" -#include "cmDocumentationSection.h" -#include "cmVersion.h" -//---------------------------------------------------------------------------- -static bool cmDocumentationIsHyperlinkChar(char c) -{ - // This is not a complete list but works for CMake documentation. - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '.' || c == '/' || c == '~' || c == '@' || - c == ':' || c == '_' || c == '&' || c == '?' || c == '='); -} - -//---------------------------------------------------------------------------- -static void cmDocumentationPrintHTMLChar(std::ostream& os, char c) -{ - // Use an escape sequence if necessary. - switch (c) - { - case '<': - os << "<"; - break; - case '>': - os << ">"; - break; - case '&': - os << "&"; - break; - case '\n': - os << "<br />"; - break; - default: - os << c; - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentationHTMLIsIdChar(char c) -{ - // From the HTML specification: - // ID and NAME tokens must begin with a letter ([A-Za-z]) and may - // be followed by any number of letters, digits ([0-9]), hyphens - // ("-"), underscores ("_"), colons (":"), and periods ("."). - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '_' || c == ':' || c == '.'); -} - -//---------------------------------------------------------------------------- -void cmDocumentationPrintHTMLId(std::ostream& os, const char* begin) -{ - for(const char* c = begin; *c; ++c) - { - if(cmDocumentationHTMLIsIdChar(*c)) - { - os << *c; - } - } -} - -//---------------------------------------------------------------------------- -const char* cmDocumentationPrintHTMLLink(std::ostream& os, const char* begin) -{ - // Look for the end of the link. - const char* end = begin; - while(cmDocumentationIsHyperlinkChar(*end)) - { - ++end; - } - - // Print the hyperlink itself. - os << "<a href=\""; - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintHTMLChar(os, *c); - } - os << "\">"; - - // The name of the hyperlink is the text itself. - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintHTMLChar(os, *c); - } - os << "</a>"; - - // Return the position at which to continue scanning the input - // string. - return end; -} - - -cmDocumentationFormatterHTML::cmDocumentationFormatterHTML() -:cmDocumentationFormatter() -{ -} - -void cmDocumentationFormatterHTML -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - std::string prefix = this->ComputeSectionLinkPrefix(name); - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - - // skip the index if the help for only a single item (--help-command, - // --help-policy, --help-property, --help-module) is printed - bool isSingleItemHelp = ((name!=0) && (strcmp(name, "SingleItem")==0)); - - if (!isSingleItemHelp) - { - if (name) - { - os << "<h2><a name=\"section_"; - cmDocumentationPrintHTMLId(os, name); - os << "\"></a>" << name << "</h2>\n"; - } - - // Is a list needed? - for(std::vector<cmDocumentationEntry>::const_iterator op - = entries.begin(); op != entries.end(); ++ op ) - { - if (op->Name.size()) - { - os << "<ul>\n"; - for(;op != entries.end() && op->Name.size(); ++op) - { - if(op->Name.size()) - { - os << " <li><a href=\"#" << prefix << ":"; - cmDocumentationPrintHTMLId(os, op->Name.c_str()); - os << "\"><b><code>"; - this->PrintHTMLEscapes(os, op->Name.c_str()); - os << "</code></b></a></li>\n"; - } - } - os << "</ul>\n" ; - break; // Skip outer loop termination test - } - } - } - - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end();) - { - if(op->Name.size()) - { - os << "<ul>\n"; - for(;op != entries.end() && op->Name.size(); ++op) - { - os << " <li>\n"; - if(op->Name.size()) - { - os << " <a name=\"" << prefix << ":"; - cmDocumentationPrintHTMLId(os, op->Name.c_str()); - os << "\"></a><b><code>"; - this->PrintHTMLEscapes(os, op->Name.c_str()); - os << "</code></b>: "; - } - this->PrintHTMLEscapes(os, op->Brief.c_str()); - if(op->Full.size()) - { - os << "<br />\n "; - this->PrintFormatted(os, op->Full.c_str()); - } - os << "\n"; - os << " </li>\n"; - } - os << "</ul>\n"; - } - else - { - this->PrintFormatted(os, op->Brief.c_str()); - os << "\n"; - ++op; - } - } -} - -void cmDocumentationFormatterHTML::PrintPreformatted(std::ostream& os, - const char* text) -{ - os << "<pre>"; - this->PrintHTMLEscapes(os, text); - os << "</pre>\n "; -} - -void cmDocumentationFormatterHTML::PrintParagraph(std::ostream& os, - const char* text) -{ - os << "<p>"; - this->PrintHTMLEscapes(os, text); - os << "</p>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintHeader(const char* docname, - const char* appname, - std::ostream& os) -{ - os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" - << " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n"; - os << "<html xmlns=\"http://www.w3.org/1999/xhtml\"" - << " xml:lang=\"en\" lang=\"en\">\n"; - os << "<head><meta http-equiv=\"Content-Type\" " - << "content=\"text/html;charset=utf-8\" /><title>"; - os << docname << " - " << appname; - os << "</title></head><body>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintFooter(std::ostream& os) -{ - os << "</body></html>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintHTMLEscapes(std::ostream& os, - const char* text) -{ - // Hyperlink prefixes. - static const char* hyperlinks[] = {"http://", "ftp://", "mailto:", 0}; - - // Print each character. - for(const char* p = text; *p;) - { - // Handle hyperlinks specially to make them active. - bool found_hyperlink = false; - for(const char** h = hyperlinks; !found_hyperlink && *h; ++h) - { - if(strncmp(p, *h, strlen(*h)) == 0) - { - p = cmDocumentationPrintHTMLLink(os, p); - found_hyperlink = true; - } - } - - // Print other characters normally. - if(!found_hyperlink) - { - cmDocumentationPrintHTMLChar(os, *p++); - } - } -} - -void cmDocumentationFormatterHTML -::PrintIndex(std::ostream& os, - std::vector<const cmDocumentationSection *>& sections) -{ - // skip the index if only the help for a single item is printed - if ((sections.size() == 1) - && (sections[0]->GetName(this->GetForm()) != 0 ) - && (std::string(sections[0]->GetName(this->GetForm())) == "SingleItem")) - { - return; - } - - os << "<h2><a name=\"section_Index\"></a>Master Index " - << "CMake " << cmVersion::GetCMakeVersion() - << "</h2>\n"; - - if (!sections.empty()) - { - os << "<ul>\n"; - for(unsigned int i=0; i < sections.size(); ++i) - { - std::string name = sections[i]->GetName((this->GetForm())); - os << " <li><a href=\"#section_"; - cmDocumentationPrintHTMLId(os, name.c_str()); - os << "\"><b>" << name << "</b></a></li>\n"; - } - os << "</ul>\n"; - } -} diff --git a/Source/cmDocumentationFormatterHTML.h b/Source/cmDocumentationFormatterHTML.h deleted file mode 100644 index 44bf240..0000000 --- a/Source/cmDocumentationFormatterHTML.h +++ /dev/null @@ -1,42 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterHTML_h -#define _cmDocumentationFormatterHTML_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as HTML. */ -class cmDocumentationFormatterHTML : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterHTML(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::HTMLForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintFooter(std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - virtual void PrintIndex(std::ostream& , - std::vector<const cmDocumentationSection *>&); -private: - void PrintHTMLEscapes(std::ostream& os, const char* text); -}; - -#endif diff --git a/Source/cmDocumentationFormatterMan.cxx b/Source/cmDocumentationFormatterMan.cxx deleted file mode 100644 index 4123c85..0000000 --- a/Source/cmDocumentationFormatterMan.cxx +++ /dev/null @@ -1,102 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterMan.h" -#include "cmDocumentationSection.h" - -#include "cmSystemTools.h" -#include "cmVersion.h" - - -cmDocumentationFormatterMan::cmDocumentationFormatterMan() -:cmDocumentationFormatter() -,ManSection(1) -{ -} - -void cmDocumentationFormatterMan::SetManSection(int manSection) -{ - this->ManSection = manSection; -} - -void cmDocumentationFormatterMan -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name) - { - os << ".SH " << name << "\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << ".TP\n" - << ".B " << (op->Name.size()?op->Name.c_str():"*") << "\n"; - this->PrintFormatted(os, op->Brief.c_str()); - this->PrintFormatted(os, op->Full.c_str()); - } - else - { - os << ".PP\n"; - this->PrintFormatted(os, op->Brief.c_str()); - } - } -} - -void cmDocumentationFormatterMan::EscapeText(std::string& man_text) -{ - cmSystemTools::ReplaceString(man_text, "\\", "\\\\"); - cmSystemTools::ReplaceString(man_text, "-", "\\-"); -} - -void cmDocumentationFormatterMan::PrintPreformatted(std::ostream& os, - const char* text) -{ - std::string man_text = text; - this->EscapeText(man_text); - os << ".nf\n" << man_text; - if (*text && man_text.at(man_text.length()-1) != '\n') - os << "\n"; - os << ".fi\n\n"; -} - -void cmDocumentationFormatterMan::PrintParagraph(std::ostream& os, - const char* text) -{ - std::string man_text = text; - this->EscapeText(man_text); - os << man_text << "\n\n"; -} - - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterMan::PrintHeader(const char* docname, - const char* appname, - std::ostream& os) -{ - std::string s_docname(docname), s_appname(appname); - - this->EscapeText(s_docname); - this->EscapeText(s_appname); - os << ".TH " << s_docname << " " << this->ManSection << " \"" - << cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str() - << "\" \"" << s_appname - << " " << cmVersion::GetCMakeVersion() - << "\"\n"; -} - diff --git a/Source/cmDocumentationFormatterMan.h b/Source/cmDocumentationFormatterMan.h deleted file mode 100644 index b3d069c..0000000 --- a/Source/cmDocumentationFormatterMan.h +++ /dev/null @@ -1,43 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterMan_h -#define _cmDocumentationFormatterMan_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as man page. */ -class cmDocumentationFormatterMan : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterMan(); - - void SetManSection(int manSection); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::ManForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - -private: - void EscapeText(std::string& man_text); - int ManSection; -}; - -#endif diff --git a/Source/cmDocumentationFormatterText.cxx b/Source/cmDocumentationFormatterText.cxx deleted file mode 100644 index 5def194..0000000 --- a/Source/cmDocumentationFormatterText.cxx +++ /dev/null @@ -1,180 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterText.h" -#include "cmDocumentationSection.h" - -cmDocumentationFormatterText::cmDocumentationFormatterText() -:cmDocumentationFormatter() -,TextWidth(77) -,TextIndent("") -{ -} - -void cmDocumentationFormatterText -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name && (strcmp(name, "SingleItem")!=0)) - { - os << - "---------------------------------------" - "---------------------------------------\n"; - os << name << "\n\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " " << op->Name << "\n"; - this->TextIndent = " "; - this->PrintFormatted(os, op->Brief.c_str()); - if(op->Full.size()) - { - os << "\n"; - this->PrintFormatted(os, op->Full.c_str()); - } - } - else - { - this->TextIndent = ""; - this->PrintFormatted(os, op->Brief.c_str()); - } - os << "\n"; - } -} - -void cmDocumentationFormatterText::PrintPreformatted(std::ostream& os, - const char* text) -{ - bool newline = true; - for(const char* ptr = text; *ptr; ++ptr) - { - if(newline && *ptr != '\n') - { - os << this->TextIndent; - newline = false; - } - os << *ptr; - if(*ptr == '\n') - { - newline = true; - } - } - os << "\n"; -} - -void cmDocumentationFormatterText::PrintParagraph(std::ostream& os, - const char* text) -{ - os << this->TextIndent; - this->PrintColumn(os, text); - os << "\n"; -} - -void cmDocumentationFormatterText::SetIndent(const char* indent) -{ - this->TextIndent = indent; -} - -void cmDocumentationFormatterText::PrintColumn(std::ostream& os, - const char* text) -{ - // Print text arranged in an indented column of fixed witdh. - const char* l = text; - long column = 0; - bool newSentence = false; - bool firstLine = true; - int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent)); - - // Loop until the end of the text. - while(*l) - { - // Parse the next word. - const char* r = l; - while(*r && (*r != '\n') && (*r != ' ')) { ++r; } - - // Does it fit on this line? - if(r-l < (width-column-(newSentence?1:0))) - { - // Word fits on this line. - if(r > l) - { - if(column) - { - // Not first word on line. Separate from the previous word - // by a space, or two if this is a new sentence. - if(newSentence) - { - os << " "; - column += 2; - } - else - { - os << " "; - column += 1; - } - } - else - { - // First word on line. Print indentation unless this is the - // first line. - os << (firstLine?"":this->TextIndent); - } - - // Print the word. - os.write(l, static_cast<long>(r-l)); - newSentence = (*(r-1) == '.'); - } - - if(*r == '\n') - { - // Text provided a newline. Start a new line. - os << "\n"; - ++r; - column = 0; - firstLine = false; - } - else - { - // No provided newline. Continue this line. - column += static_cast<long>(r-l); - } - } - else - { - // Word does not fit on this line. Start a new line. - os << "\n"; - firstLine = false; - if(r > l) - { - os << this->TextIndent; - os.write(l, static_cast<long>(r-l)); - column = static_cast<long>(r-l); - newSentence = (*(r-1) == '.'); - } - else - { - column = 0; - } - } - - // Move to beginning of next word. Skip over whitespace. - l = r; - while(*l && (*l == ' ')) { ++l; } - } -} diff --git a/Source/cmDocumentationFormatterText.h b/Source/cmDocumentationFormatterText.h deleted file mode 100644 index d9c2af2..0000000 --- a/Source/cmDocumentationFormatterText.h +++ /dev/null @@ -1,40 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterText_h -#define _cmDocumentationFormatterText_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as plain text. */ -class cmDocumentationFormatterText : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterText(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::TextForm;} - - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - void PrintColumn(std::ostream& os, const char* text); - void SetIndent(const char* indent); -protected: - int TextWidth; - const char* TextIndent; -}; - -#endif diff --git a/Source/cmDocumentationFormatterUsage.cxx b/Source/cmDocumentationFormatterUsage.cxx deleted file mode 100644 index a068e56..0000000 --- a/Source/cmDocumentationFormatterUsage.cxx +++ /dev/null @@ -1,63 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterUsage.h" -#include "cmDocumentationSection.h" - -cmDocumentationFormatterUsage::cmDocumentationFormatterUsage() -:cmDocumentationFormatterText() -{ -} - -void cmDocumentationFormatterUsage -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name) - { - os << name << "\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " " << op->Name; - this->TextIndent = " "; - int align = static_cast<int>(strlen(this->TextIndent))-4; - for(int i = static_cast<int>(op->Name.size()); i < align; ++i) - { - os << " "; - } - if (op->Name.size() > strlen(this->TextIndent)-4 ) - { - os << "\n"; - os.write(this->TextIndent, strlen(this->TextIndent)-2); - } - os << "= "; - this->PrintColumn(os, op->Brief.c_str()); - os << "\n"; - } - else - { - os << "\n"; - this->TextIndent = ""; - this->PrintFormatted(os, op->Brief.c_str()); - } - } - os << "\n"; -} - diff --git a/Source/cmDocumentationFormatterUsage.h b/Source/cmDocumentationFormatterUsage.h deleted file mode 100644 index 3ed3442..0000000 --- a/Source/cmDocumentationFormatterUsage.h +++ /dev/null @@ -1,31 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterUsage_h -#define _cmDocumentationFormatterUsage_h - -#include "cmDocumentationFormatterText.h" - -/** Class to print the documentation as usage on the command line. */ -class cmDocumentationFormatterUsage : public cmDocumentationFormatterText -{ -public: - cmDocumentationFormatterUsage(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::UsageForm;} - - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); -}; - -#endif diff --git a/Source/cmDocumentationSection.cxx b/Source/cmDocumentationSection.cxx index a2dfe70..b0dd8ef 100644 --- a/Source/cmDocumentationSection.cxx +++ b/Source/cmDocumentationSection.cxx @@ -13,69 +13,33 @@ //---------------------------------------------------------------------------- -void cmDocumentationSection::Append(const char *data[][3]) +void cmDocumentationSection::Append(const char *data[][2]) { int i = 0; while(data[i][1]) { this->Entries.push_back(cmDocumentationEntry(data[i][0], - data[i][1], - data[i][2])); + data[i][1])); data += 1; } } //---------------------------------------------------------------------------- -void cmDocumentationSection::Prepend(const char *data[][3]) +void cmDocumentationSection::Prepend(const char *data[][2]) { std::vector<cmDocumentationEntry> tmp; int i = 0; while(data[i][1]) { tmp.push_back(cmDocumentationEntry(data[i][0], - data[i][1], - data[i][2])); + data[i][1])); data += 1; } this->Entries.insert(this->Entries.begin(),tmp.begin(),tmp.end()); } //---------------------------------------------------------------------------- -void cmDocumentationSection::Append(const char *n, const char *b, - const char *f) +void cmDocumentationSection::Append(const char *n, const char *b) { - this->Entries.push_back(cmDocumentationEntry(n,b,f)); + this->Entries.push_back(cmDocumentationEntry(n,b)); } - -#if 0 -//---------------------------------------------------------------------------- -void cmDocumentationSection::Set(const cmDocumentationEntry* header, - const cmDocumentationEntry* section, - const cmDocumentationEntry* footer) -{ - this->Entries.erase(this->Entries.begin(), this->Entries.end()); - if(header) - { - for(const cmDocumentationEntry* op = header; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - if(section) - { - for(const cmDocumentationEntry* op = section; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - if(footer) - { - for(const cmDocumentationEntry* op = footer; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - cmDocumentationEntry empty = {0,0,0}; - this->Entries.push_back(empty); -} -#endif diff --git a/Source/cmDocumentationSection.h b/Source/cmDocumentationSection.h index 4f8c10d..636860d 100644 --- a/Source/cmDocumentationSection.h +++ b/Source/cmDocumentationSection.h @@ -24,8 +24,8 @@ class cmDocumentationSection { public: /** Create a cmSection, with a special name for man-output mode. */ - cmDocumentationSection(const char* name, const char* manName) - :Name(name), ManName(manName) {} + cmDocumentationSection(const char* name, const char*) + :Name(name) {} /** Has any content been added to this section or is it empty ? */ bool IsEmpty() const { return this->Entries.empty(); } @@ -33,10 +33,9 @@ public: /** Clear contents. */ void Clear() { this->Entries.clear(); } - /** Return the name of this section for the given output form. */ - const char* GetName(cmDocumentationEnums::Form form) const - { return (form==cmDocumentationEnums::ManForm ? - this->ManName.c_str() : this->Name.c_str()); } + /** Return the name of this section. */ + const char* GetName() const + { return this->Name.c_str(); } /** Return a pointer to the first entry of this section. */ const std::vector<cmDocumentationEntry> &GetEntries() const @@ -49,11 +48,11 @@ public: { this->Entries.insert(this->Entries.end(),entries.begin(),entries.end()); } /** Append an entry to this section using NULL terminated chars */ - void Append(const char *[][3]); - void Append(const char *n, const char *b, const char *f); + void Append(const char *[][2]); + void Append(const char *n, const char *b); /** prepend some documentation to this section */ - void Prepend(const char *[][3]); + void Prepend(const char *[][2]); void Prepend(const std::vector<cmDocumentationEntry> &entries) { this->Entries.insert(this->Entries.begin(), entries.begin(),entries.end()); } @@ -61,7 +60,6 @@ public: private: std::string Name; - std::string ManName; std::vector<cmDocumentationEntry> Entries; }; diff --git a/Source/cmElseCommand.h b/Source/cmElseCommand.h index f259919..d472e99 100644 --- a/Source/cmElseCommand.h +++ b/Source/cmElseCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "else";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the else portion of an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " else(expression)\n" - "See the if command."; - } - cmTypeMacro(cmElseCommand, cmCommand); }; diff --git a/Source/cmElseIfCommand.h b/Source/cmElseIfCommand.h index 46e2bd9..d811b35 100644 --- a/Source/cmElseIfCommand.h +++ b/Source/cmElseIfCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "elseif";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the elseif portion of an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " elseif(expression)\n" - "See the if command."; - } - cmTypeMacro(cmElseIfCommand, cmCommand); }; diff --git a/Source/cmEnableLanguageCommand.h b/Source/cmEnableLanguageCommand.h index 747448b..a248042 100644 --- a/Source/cmEnableLanguageCommand.h +++ b/Source/cmEnableLanguageCommand.h @@ -45,37 +45,6 @@ public: */ virtual const char* GetName() const {return "enable_language";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Enable a language (CXX/C/Fortran/etc)"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " enable_language(<lang> [OPTIONAL] )\n" - "This command enables support for the named language in CMake. " - "This is the same as the project command but does not create " - "any of the extra variables that are created by the project command. " - "Example languages are CXX, C, Fortran. " - "\n" - "This command must be called in file scope, not in a function call. " - "Furthermore, it must be called in the highest directory common to " - "all targets using the named language directly for compiling sources " - "or indirectly through link dependencies. " - "It is simplest to enable all needed languages in the top-level " - "directory of a project." - "\n" - "The OPTIONAL keyword is a placeholder for future implementation " - "and does not currently work."; - } - cmTypeMacro(cmEnableLanguageCommand, cmCommand); }; diff --git a/Source/cmEnableTestingCommand.h b/Source/cmEnableTestingCommand.h index 9b9e985..e102f5e 100644 --- a/Source/cmEnableTestingCommand.h +++ b/Source/cmEnableTestingCommand.h @@ -50,27 +50,6 @@ public: */ virtual const char* GetName() const { return "enable_testing";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Enable testing for current directory and below."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " enable_testing()\n" - "Enables testing for this directory and below. " - "See also the add_test command. Note that ctest expects to find " - "a test file in the build directory root. Therefore, this command " - "should be in the source directory root."; - } - cmTypeMacro(cmEnableTestingCommand, cmCommand); }; diff --git a/Source/cmEndForEachCommand.h b/Source/cmEndForEachCommand.h index d5ee8a6..44d29b5 100644 --- a/Source/cmEndForEachCommand.h +++ b/Source/cmEndForEachCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endforeach";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a FOREACH block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endforeach(expression)\n" - "See the FOREACH command."; - } - cmTypeMacro(cmEndForEachCommand, cmCommand); }; diff --git a/Source/cmEndFunctionCommand.h b/Source/cmEndFunctionCommand.h index d7b74e9..4fdca6b 100644 --- a/Source/cmEndFunctionCommand.h +++ b/Source/cmEndFunctionCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endfunction";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a function block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endfunction(expression)\n" - "See the function command."; - } - cmTypeMacro(cmEndFunctionCommand, cmCommand); }; diff --git a/Source/cmEndIfCommand.h b/Source/cmEndIfCommand.h index 5c4b9e3..634da60 100644 --- a/Source/cmEndIfCommand.h +++ b/Source/cmEndIfCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "endif";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endif(expression)\n" - "See the if command."; - } - cmTypeMacro(cmEndIfCommand, cmCommand); }; diff --git a/Source/cmEndMacroCommand.h b/Source/cmEndMacroCommand.h index 9d0e70f..db15f27 100644 --- a/Source/cmEndMacroCommand.h +++ b/Source/cmEndMacroCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endmacro";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a macro block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endmacro(expression)\n" - "See the macro command."; - } - cmTypeMacro(cmEndMacroCommand, cmCommand); }; diff --git a/Source/cmEndWhileCommand.h b/Source/cmEndWhileCommand.h index 18ba5ea..41138d1 100644 --- a/Source/cmEndWhileCommand.h +++ b/Source/cmEndWhileCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endwhile";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a while block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endwhile(expression)\n" - "See the while command."; - } - cmTypeMacro(cmEndWhileCommand, cmCommand); }; diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h index f752501..4892dd8 100644 --- a/Source/cmExecProgramCommand.h +++ b/Source/cmExecProgramCommand.h @@ -50,39 +50,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Deprecated. Use the execute_process() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Run an executable program during the processing of the CMakeList.txt" - " file.\n" - " exec_program(Executable [directory in which to run]\n" - " [ARGS <arguments to executable>]\n" - " [OUTPUT_VARIABLE <var>]\n" - " [RETURN_VALUE <var>])\n" - "The executable is run in the optionally specified directory. The " - "executable can include arguments if it is double quoted, but it is " - "better to use the optional ARGS argument to specify arguments to the " - "program. This is because cmake will then be able to escape spaces " - "in the executable path. An optional argument OUTPUT_VARIABLE " - "specifies a variable in which to store the output. " - "To capture the return value of the execution, provide a RETURN_VALUE. " - "If OUTPUT_VARIABLE is specified, then no output will go to the " - "stdout/stderr of the console running cmake.\n" - ; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmExecuteProcessCommand.h b/Source/cmExecuteProcessCommand.h index 0e20a4b..bd0f783 100644 --- a/Source/cmExecuteProcessCommand.h +++ b/Source/cmExecuteProcessCommand.h @@ -49,64 +49,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Execute one or more child processes."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " execute_process(COMMAND <cmd1> [args1...]]\n" - " [COMMAND <cmd2> [args2...] [...]]\n" - " [WORKING_DIRECTORY <directory>]\n" - " [TIMEOUT <seconds>]\n" - " [RESULT_VARIABLE <variable>]\n" - " [OUTPUT_VARIABLE <variable>]\n" - " [ERROR_VARIABLE <variable>]\n" - " [INPUT_FILE <file>]\n" - " [OUTPUT_FILE <file>]\n" - " [ERROR_FILE <file>]\n" - " [OUTPUT_QUIET]\n" - " [ERROR_QUIET]\n" - " [OUTPUT_STRIP_TRAILING_WHITESPACE]\n" - " [ERROR_STRIP_TRAILING_WHITESPACE])\n" - "Runs the given sequence of one or more commands with the standard " - "output of each process piped to the standard input of the next. " - "A single standard error pipe is used for all processes. " - "If WORKING_DIRECTORY is given the named directory will be set as " - "the current working directory of the child processes. " - "If TIMEOUT is given the child processes will be terminated if they " - "do not finish in the specified number of seconds " - "(fractions are allowed). " - "If RESULT_VARIABLE is given the variable will be set to contain " - "the result of running the processes. This will be an integer return " - "code from the last child or a string describing an error condition. " - "If OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named " - "will be set with the contents of the standard output and standard " - "error pipes respectively. If the same variable is named for both " - "pipes their output will be merged in the order produced. " - "If INPUT_FILE, OUTPUT_FILE, or ERROR_FILE is given the file named " - "will be attached to the standard input of the first process, " - "standard output of the last process, or standard error of all " - "processes respectively. " - "If OUTPUT_QUIET or ERROR_QUIET is given then the standard output " - "or standard error results will be quietly ignored. " - "If more than one OUTPUT_* or ERROR_* option is given for the same " - "pipe the precedence is not specified. " - "If no OUTPUT_* or ERROR_* options are given the output will be shared " - "with the corresponding pipes of the CMake process itself.\n" - "The execute_process command is a newer more powerful version of " - "exec_program, but the old command has been kept for compatibility." - ; - } - cmTypeMacro(cmExecuteProcessCommand, cmCommand); }; diff --git a/Source/cmExportBuildFileGenerator.cxx b/Source/cmExportBuildFileGenerator.cxx index cdc3316..50835e2 100644 --- a/Source/cmExportBuildFileGenerator.cxx +++ b/Source/cmExportBuildFileGenerator.cxx @@ -11,42 +11,44 @@ ============================================================================*/ #include "cmExportBuildFileGenerator.h" -#include "cmExportCommand.h" +#include "cmLocalGenerator.h" +#include "cmGlobalGenerator.h" //---------------------------------------------------------------------------- cmExportBuildFileGenerator::cmExportBuildFileGenerator() { - this->ExportCommand = 0; + this->Makefile = 0; } //---------------------------------------------------------------------------- bool cmExportBuildFileGenerator::GenerateMainFile(std::ostream& os) { - std::vector<cmTarget*> allTargets; { std::string expectedTargets; std::string sep; - for(std::vector<cmTarget*>::const_iterator - tei = this->Exports->begin(); - tei != this->Exports->end(); ++tei) + for(std::vector<std::string>::const_iterator + tei = this->Targets.begin(); + tei != this->Targets.end(); ++tei) { - expectedTargets += sep + this->Namespace + (*tei)->GetExportName(); + cmTarget *te = this->Makefile->FindTargetToUse(tei->c_str()); + expectedTargets += sep + this->Namespace + te->GetExportName(); sep = " "; - cmTarget* te = *tei; if(this->ExportedTargets.insert(te).second) { - allTargets.push_back(te); + this->Exports.push_back(te); } else { - if(this->ExportCommand && this->ExportCommand->ErrorMessage.empty()) - { - cmOStringStream e; - e << "given target \"" << te->GetName() << "\" more than once."; - this->ExportCommand->ErrorMessage = e.str(); - } + cmOStringStream e; + e << "given target \"" << te->GetName() << "\" more than once."; + this->Makefile->GetCMakeInstance() + ->IssueMessage(cmake::FATAL_ERROR, e.str().c_str(), this->Backtrace); return false; } + if (te->GetType() == cmTarget::INTERFACE_LIBRARY) + { + this->GenerateRequiredCMakeVersion(os, "2.8.12.20131007"); // 2.8.13 + } } this->GenerateExpectedTargetsCode(os, expectedTargets); @@ -56,8 +58,8 @@ bool cmExportBuildFileGenerator::GenerateMainFile(std::ostream& os) // Create all the imported targets. for(std::vector<cmTarget*>::const_iterator - tei = allTargets.begin(); - tei != allTargets.end(); ++tei) + tei = this->Exports.begin(); + tei != this->Exports.end(); ++tei) { cmTarget* te = *tei; this->GenerateImportTargetCode(os, te); @@ -112,22 +114,28 @@ cmExportBuildFileGenerator std::vector<std::string> &missingTargets) { for(std::vector<cmTarget*>::const_iterator - tei = this->Exports->begin(); - tei != this->Exports->end(); ++tei) + tei = this->Exports.begin(); + tei != this->Exports.end(); ++tei) { // Collect import properties for this target. cmTarget* target = *tei; ImportPropertyMap properties; - this->SetImportLocationProperty(config, suffix, target, properties); + + if (target->GetType() != cmTarget::INTERFACE_LIBRARY) + { + this->SetImportLocationProperty(config, suffix, target, properties); + } if(!properties.empty()) { // Get the rest of the target details. - this->SetImportDetailProperties(config, suffix, - target, properties, missingTargets); - this->SetImportLinkInterface(config, suffix, - cmGeneratorExpression::BuildInterface, - target, properties, missingTargets); - + if (target->GetType() != cmTarget::INTERFACE_LIBRARY) + { + this->SetImportDetailProperties(config, suffix, + target, properties, missingTargets); + this->SetImportLinkInterface(config, suffix, + cmGeneratorExpression::BuildInterface, + target, properties, missingTargets); + } // TOOD: PUBLIC_HEADER_LOCATION // This should wait until the build feature propagation stuff @@ -188,40 +196,95 @@ cmExportBuildFileGenerator //---------------------------------------------------------------------------- void cmExportBuildFileGenerator::HandleMissingTarget( - std::string& link_libs, std::vector<std::string>&, - cmMakefile*, cmTarget* depender, cmTarget* dependee) + std::string& link_libs, std::vector<std::string>& missingTargets, + cmMakefile* mf, cmTarget* depender, cmTarget* dependee) { // The target is not in the export. if(!this->AppendMode) { - // We are not appending, so all exported targets should be - // known here. This is probably user-error. - this->ComplainAboutMissingTarget(depender, dependee); + const std::string name = dependee->GetName(); + std::vector<std::string> namespaces = this->FindNamespaces(mf, name); + + int targetOccurrences = (int)namespaces.size(); + if (targetOccurrences == 1) + { + std::string missingTarget = namespaces[0]; + + missingTarget += dependee->GetExportName(); + link_libs += missingTarget; + missingTargets.push_back(missingTarget); + return; + } + else + { + // We are not appending, so all exported targets should be + // known here. This is probably user-error. + this->ComplainAboutMissingTarget(depender, dependee, targetOccurrences); + } } // Assume the target will be exported by another command. // Append it with the export namespace. link_libs += this->Namespace; link_libs += dependee->GetExportName(); +// if generate time {} +} + + +//---------------------------------------------------------------------------- +std::vector<std::string> +cmExportBuildFileGenerator +::FindNamespaces(cmMakefile* mf, const std::string& name) +{ + std::vector<std::string> namespaces; + cmGlobalGenerator* gg = mf->GetLocalGenerator()->GetGlobalGenerator(); + + std::map<std::string, cmExportBuildFileGenerator*>& exportSets + = gg->GetBuildExportSets(); + + for(std::map<std::string, cmExportBuildFileGenerator*>::const_iterator + expIt = exportSets.begin(); expIt != exportSets.end(); ++expIt) + { + const cmExportBuildFileGenerator* exportSet = expIt->second; + std::vector<std::string> const& targets = exportSet->GetTargets(); + + if (std::find(targets.begin(), targets.end(), name) != targets.end()) + { + namespaces.push_back(exportSet->GetNamespace()); + } + } + + return namespaces; } //---------------------------------------------------------------------------- void cmExportBuildFileGenerator ::ComplainAboutMissingTarget(cmTarget* depender, - cmTarget* dependee) + cmTarget* dependee, + int occurrences) { - if(!this->ExportCommand || !this->ExportCommand->ErrorMessage.empty()) + if(cmSystemTools::GetErrorOccuredFlag()) { return; } cmOStringStream e; - e << "called with target \"" << depender->GetName() - << "\" which requires target \"" << dependee->GetName() - << "\" that is not in the export list.\n" - << "If the required target is not easy to reference in this call, " + e << "export called with target \"" << depender->GetName() + << "\" which requires target \"" << dependee->GetName() << "\" "; + if (occurrences == 0) + { + e << "that is not in the export set.\n"; + } + else + { + e << "that is not in this export set, but " << occurrences + << " times in others.\n"; + } + e << "If the required target is not easy to reference in this call, " << "consider using the APPEND option with multiple separate calls."; - this->ExportCommand->ErrorMessage = e.str(); + + this->Makefile->GetCMakeInstance() + ->IssueMessage(cmake::FATAL_ERROR, e.str().c_str(), this->Backtrace); } std::string diff --git a/Source/cmExportBuildFileGenerator.h b/Source/cmExportBuildFileGenerator.h index 3ffdf8b..2fbd98f 100644 --- a/Source/cmExportBuildFileGenerator.h +++ b/Source/cmExportBuildFileGenerator.h @@ -13,8 +13,7 @@ #define cmExportBuildFileGenerator_h #include "cmExportFileGenerator.h" - -class cmExportCommand; +#include "cmListFileCache.h" /** \class cmExportBuildFileGenerator * \brief Generate a file exporting targets from a build tree. @@ -31,14 +30,22 @@ public: cmExportBuildFileGenerator(); /** Set the list of targets to export. */ - void SetExports(std::vector<cmTarget*> const* exports) - { this->Exports = exports; } + void SetTargets(std::vector<std::string> const& targets) + { this->Targets = targets; } + std::vector<std::string> const& GetTargets() const + { return this->Targets; } + void AppendTargets(std::vector<std::string> const& targets) + { this->Targets.insert(this->Targets.end(), + targets.begin(), targets.end()); } /** Set whether to append generated code to the output file. */ void SetAppendMode(bool append) { this->AppendMode = append; } - /** Set the command instance through which errors should be reported. */ - void SetCommand(cmExportCommand* cmd) { this->ExportCommand = cmd; } + void SetMakefile(cmMakefile *mf) { + this->Makefile = mf; + this->Makefile->GetBacktrace(this->Backtrace); + } + protected: // Implement virtual methods from the superclass. virtual bool GenerateMainFile(std::ostream& os); @@ -53,7 +60,8 @@ protected: cmTarget* dependee); void ComplainAboutMissingTarget(cmTarget* depender, - cmTarget* dependee); + cmTarget* dependee, + int occurrences); /** Fill in properties indicating built file locations. */ void SetImportLocationProperty(const char* config, @@ -63,8 +71,13 @@ protected: std::string InstallNameDir(cmTarget* target, const std::string& config); - std::vector<cmTarget*> const* Exports; - cmExportCommand* ExportCommand; + std::vector<std::string> + FindNamespaces(cmMakefile* mf, const std::string& name); + + std::vector<std::string> Targets; + std::vector<cmTarget*> Exports; + cmMakefile* Makefile; + cmListFileBacktrace Backtrace; }; #endif diff --git a/Source/cmExportCommand.cxx b/Source/cmExportCommand.cxx index f059ceb..86ddc3f 100644 --- a/Source/cmExportCommand.cxx +++ b/Source/cmExportCommand.cxx @@ -20,7 +20,8 @@ #include "cmExportBuildFileGenerator.h" #if defined(__HAIKU__) -#include <StorageKit.h> +#include <FindDirectory.h> +#include <StorageDefs.h> #endif cmExportCommand::cmExportCommand() @@ -107,8 +108,6 @@ bool cmExportCommand fname += this->Filename.GetString(); } - // Collect the targets to be exported. - std::vector<cmTarget*> targets; for(std::vector<std::string>::const_iterator currentTarget = this->Targets.GetVector().begin(); currentTarget != this->Targets.GetVector().end(); @@ -127,14 +126,7 @@ bool cmExportCommand this->Makefile->GetLocalGenerator()-> GetGlobalGenerator()->FindTarget(0, currentTarget->c_str())) { - if((target->GetType() == cmTarget::EXECUTABLE) || - (target->GetType() == cmTarget::STATIC_LIBRARY) || - (target->GetType() == cmTarget::SHARED_LIBRARY) || - (target->GetType() == cmTarget::MODULE_LIBRARY)) - { - targets.push_back(target); - } - else if(target->GetType() == cmTarget::OBJECT_LIBRARY) + if(target->GetType() == cmTarget::OBJECT_LIBRARY) { cmOStringStream e; e << "given OBJECT library \"" << *currentTarget @@ -142,33 +134,28 @@ bool cmExportCommand this->SetError(e.str().c_str()); return false; } - else - { - cmOStringStream e; - e << "given target \"" << *currentTarget - << "\" which is not an executable or library."; - this->SetError(e.str().c_str()); - return false; - } } - else + } + + cmGlobalGenerator *gg = this->Makefile->GetLocalGenerator() + ->GetGlobalGenerator(); + if (this->Append.IsEnabled()) + { + if (cmExportBuildFileGenerator *ebfg = gg->GetExportedTargetsFile(fname)) { - cmOStringStream e; - e << "given target \"" << *currentTarget - << "\" which is not built by this project."; - this->SetError(e.str().c_str()); - return false; + ebfg->AppendTargets(this->Targets.GetVector()); + return true; } } // Setup export file generation. - cmExportBuildFileGenerator ebfg; - ebfg.SetExportFile(fname.c_str()); - ebfg.SetNamespace(this->Namespace.GetCString()); - ebfg.SetAppendMode(this->Append.IsEnabled()); - ebfg.SetExports(&targets); - ebfg.SetCommand(this); - ebfg.SetExportOld(this->ExportOld.IsEnabled()); + cmExportBuildFileGenerator *ebfg = new cmExportBuildFileGenerator; + ebfg->SetExportFile(fname.c_str()); + ebfg->SetNamespace(this->Namespace.GetCString()); + ebfg->SetAppendMode(this->Append.IsEnabled()); + ebfg->SetTargets(this->Targets.GetVector()); + ebfg->SetMakefile(this->Makefile); + ebfg->SetExportOld(this->ExportOld.IsEnabled()); // Compute the set of configurations exported. std::vector<std::string> configurationTypes; @@ -179,27 +166,15 @@ bool cmExportCommand ci = configurationTypes.begin(); ci != configurationTypes.end(); ++ci) { - ebfg.AddConfiguration(ci->c_str()); + ebfg->AddConfiguration(ci->c_str()); } } else { - ebfg.AddConfiguration(""); + ebfg->AddConfiguration(""); } - // Generate the import file. - if(!ebfg.GenerateImportFile() && this->ErrorMessage.empty()) - { - this->SetError("could not write export file."); - return false; - } - - // Report generated error message if any. - if(!this->ErrorMessage.empty()) - { - this->SetError(this->ErrorMessage.c_str()); - return false; - } + gg->AddBuildExportSet(ebfg); return true; } @@ -316,14 +291,15 @@ void cmExportCommand::StorePackageRegistryDir(std::string const& package, const char* hash) { #if defined(__HAIKU__) - BPath dir; - if (find_directory(B_USER_SETTINGS_DIRECTORY, &dir) != B_OK) + char dir[B_PATH_NAME_LENGTH]; + if (find_directory(B_USER_SETTINGS_DIRECTORY, -1, false, dir, sizeof(dir)) != + B_OK) { return; } - dir.Append("cmake/packages"); - dir.Append(package.c_str()); - std::string fname = dir.Path(); + std::string fname = dir; + fname += "/cmake/packages/"; + fname += package; #else const char* home = cmSystemTools::GetEnv("HOME"); if(!home) diff --git a/Source/cmExportCommand.h b/Source/cmExportCommand.h index 87c3452..ea7c3a3 100644 --- a/Source/cmExportCommand.h +++ b/Source/cmExportCommand.h @@ -13,7 +13,6 @@ #define cmExportCommand_h #include "cmCommand.h" -#include "cmDocumentLocationUndefined.h" class cmExportBuildFileGenerator; @@ -47,59 +46,6 @@ public: */ virtual const char* GetName() const { return "export";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Export targets from the build tree for use by outside projects."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>]\n" - " [APPEND] FILE <filename> [EXPORT_LINK_INTERFACE_LIBRARIES])\n" - "Create a file <filename> that may be included by outside projects to " - "import targets from the current project's build tree. " - "This is useful during cross-compiling to build utility executables " - "that can run on the host platform in one project and then import " - "them into another project being compiled for the target platform. " - "If the NAMESPACE option is given the <namespace> string will be " - "prepended to all target names written to the file. " - "If the APPEND option is given the generated code will be appended " - "to the file instead of overwriting it. " - "The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the " - "contents of the properties matching " - "(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when " - "policy CMP0022 is NEW. " - "If a library target is included in the export but " - "a target to which it links is not included the behavior is " - "unspecified." - "\n" - "The file created by this command is specific to the build tree and " - "should never be installed. " - "See the install(EXPORT) command to export targets from an " - "installation tree." - CM_LOCATION_UNDEFINED_BEHAVIOR("passing it to this command") - "\n" - " export(PACKAGE <name>)\n" - "Store the current build directory in the CMake user package registry " - "for package <name>. " - "The find_package command may consider the directory while searching " - "for package <name>. " - "This helps dependent projects find and use a package from the " - "current project's build tree without help from the user. " - "Note that the entry in the package registry that this command " - "creates works only in conjunction with a package configuration " - "file (<name>Config.cmake) that works with the build tree." - ; - } - cmTypeMacro(cmExportCommand, cmCommand); private: diff --git a/Source/cmExportFileGenerator.cxx b/Source/cmExportFileGenerator.cxx index 0a93533..b01e499 100644 --- a/Source/cmExportFileGenerator.cxx +++ b/Source/cmExportFileGenerator.cxx @@ -52,6 +52,12 @@ void cmExportFileGenerator::SetExportFile(const char* mainFile) } //---------------------------------------------------------------------------- +const char* cmExportFileGenerator::GetMainExportFileName() const +{ + return this->MainImportFile.c_str(); +} + +//---------------------------------------------------------------------------- bool cmExportFileGenerator::GenerateImportFile() { // Open the output file to generate it. @@ -378,11 +384,14 @@ void getCompatibleInterfaceProperties(cmTarget *target, if (!info) { - cmMakefile* mf = target->GetMakefile(); - cmOStringStream e; - e << "Exporting the target \"" << target->GetName() << "\" is not " - "allowed since its linker language cannot be determined"; - mf->IssueMessage(cmake::FATAL_ERROR, e.str()); + if (target->GetType() != cmTarget::INTERFACE_LIBRARY) + { + cmMakefile* mf = target->GetMakefile(); + cmOStringStream e; + e << "Exporting the target \"" << target->GetName() << "\" is not " + "allowed since its linker language cannot be determined"; + mf->IssueMessage(cmake::FATAL_ERROR, e.str()); + } return; } @@ -888,6 +897,9 @@ cmExportFileGenerator case cmTarget::UNKNOWN_LIBRARY: os << "add_library(" << targetName << " UNKNOWN IMPORTED)\n"; break; + case cmTarget::INTERFACE_LIBRARY: + os << "add_library(" << targetName << " INTERFACE IMPORTED)\n"; + break; default: // should never happen break; } diff --git a/Source/cmExportFileGenerator.h b/Source/cmExportFileGenerator.h index 9628b96..f3d0807 100644 --- a/Source/cmExportFileGenerator.h +++ b/Source/cmExportFileGenerator.h @@ -33,9 +33,11 @@ public: /** Set the full path to the export file to generate. */ void SetExportFile(const char* mainFile); + const char *GetMainExportFileName() const; /** Set the namespace in which to place exported target names. */ void SetNamespace(const char* ns) { this->Namespace = ns; } + std::string GetNamespace() const { return this->Namespace; } void SetExportOld(bool exportOld) { this->ExportOld = exportOld; } diff --git a/Source/cmExportInstallFileGenerator.cxx b/Source/cmExportInstallFileGenerator.cxx index c8b4a79..133944e 100644 --- a/Source/cmExportInstallFileGenerator.cxx +++ b/Source/cmExportInstallFileGenerator.cxx @@ -114,6 +114,7 @@ bool cmExportInstallFileGenerator::GenerateMainFile(std::ostream& os) std::vector<std::string> missingTargets; bool require2_8_12 = false; + bool require2_8_13 = false; // Create all the imported targets. for(std::vector<cmTargetExport*>::const_iterator tei = allTargets.begin(); @@ -153,6 +154,10 @@ bool cmExportInstallFileGenerator::GenerateMainFile(std::ostream& os) require2_8_12 = true; } } + if (te->GetType() == cmTarget::INTERFACE_LIBRARY) + { + require2_8_13 = true; + } this->PopulateInterfaceProperty("INTERFACE_POSITION_INDEPENDENT_CODE", te, properties); this->PopulateCompatibleInterfaceProperties(te, properties); @@ -160,7 +165,11 @@ bool cmExportInstallFileGenerator::GenerateMainFile(std::ostream& os) this->GenerateInterfaceProperties(te, os, properties); } - if (require2_8_12) + if (require2_8_13) + { + this->GenerateRequiredCMakeVersion(os, "2.8.12.20131007"); + } + else if (require2_8_12) { this->GenerateRequiredCMakeVersion(os, "2.8.12"); } @@ -286,6 +295,14 @@ cmExportInstallFileGenerator cmTargetExport const* te = *tei; ImportPropertyMap properties; std::set<std::string> importedLocations; + if (!properties.empty() + && te->Target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + this->GenerateImportPropertyCode(os, config, te->Target, properties); + this->GenerateImportedFileChecksCode(os, te->Target, properties, + importedLocations); + continue; + } this->SetImportLocationProperty(config, suffix, te->ArchiveGenerator, properties, importedLocations); this->SetImportLocationProperty(config, suffix, te->LibraryGenerator, @@ -415,8 +432,8 @@ cmExportInstallFileGenerator::HandleMissingTarget( } else { - // We are not appending, so all exported targets should be - // known here. This is probably user-error. + // All exported targets should be known here and should be unique. + // This is probably user-error. this->ComplainAboutMissingTarget(depender, dependee, targetOccurrences); } } diff --git a/Source/cmExportLibraryDependencies.h b/Source/cmExportLibraryDependencies.h index d8b65cc..a384a7c 100644 --- a/Source/cmExportLibraryDependencies.h +++ b/Source/cmExportLibraryDependencies.h @@ -50,38 +50,6 @@ public: */ virtual const char* GetName() const { return "export_library_dependencies";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use INSTALL(EXPORT) or EXPORT command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command generates an old-style library dependencies file. " - "Projects requiring CMake 2.6 or later should not use the command. " - "Use instead the install(EXPORT) command to help export targets " - "from an installation tree and the export() command to export targets " - "from a build tree.\n" - "The old-style library dependencies file does not take into account " - "per-configuration names of libraries or the LINK_INTERFACE_LIBRARIES " - "target property.\n" - " export_library_dependencies(<file> [APPEND])\n" - "Create a file named <file> that can be included into a CMake listfile " - "with the INCLUDE command. The file will contain a number of SET " - "commands that will set all the variables needed for library dependency " - "information. This should be the last command in the top level " - "CMakeLists.txt file of the project. If the APPEND option is " - "specified, the SET commands will be appended to the given file " - "instead of replacing it."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmExprLexer.cxx b/Source/cmExprLexer.cxx index 9947c77..aa384cd 100644 --- a/Source/cmExprLexer.cxx +++ b/Source/cmExprLexer.cxx @@ -1716,7 +1716,7 @@ void cmExpr_yyset_extra (YY_EXTRA_TYPE user_defined , yyscan_t yyscanner) } /** Set the current line number. - * @param line_number + * @param line_number The line number to set. * @param yyscanner The scanner object. */ void cmExpr_yyset_lineno (int line_number , yyscan_t yyscanner) @@ -1731,7 +1731,7 @@ void cmExpr_yyset_lineno (int line_number , yyscan_t yyscanner) } /** Set the current column. - * @param column_no + * @param column_no The column number to set. * @param yyscanner The scanner object. */ void cmExpr_yyset_column (int column_no , yyscan_t yyscanner) diff --git a/Source/cmExtraCodeBlocksGenerator.cxx b/Source/cmExtraCodeBlocksGenerator.cxx index dfbb1c0..1e799b8 100644 --- a/Source/cmExtraCodeBlocksGenerator.cxx +++ b/Source/cmExtraCodeBlocksGenerator.cxx @@ -42,13 +42,6 @@ void cmExtraCodeBlocksGenerator { entry.Name = this->GetName(); entry.Brief = "Generates CodeBlocks project files."; - entry.Full = - "Project files for CodeBlocks will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "Additionally a hierarchy of makefiles is generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } cmExtraCodeBlocksGenerator::cmExtraCodeBlocksGenerator() diff --git a/Source/cmExtraEclipseCDT4Generator.cxx b/Source/cmExtraEclipseCDT4Generator.cxx index d80e775..bd3d669 100644 --- a/Source/cmExtraEclipseCDT4Generator.cxx +++ b/Source/cmExtraEclipseCDT4Generator.cxx @@ -48,13 +48,6 @@ void cmExtraEclipseCDT4Generator { entry.Name = this->GetName(); entry.Brief = "Generates Eclipse CDT 4.0 project files."; - entry.Full = - "Project files for Eclipse will be created in the top directory. " - "In out of source builds, a linked resource to the top level source " - "directory will be created. " - "Additionally a hierarchy of makefiles is generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } //---------------------------------------------------------------------------- diff --git a/Source/cmExtraSublimeTextGenerator.cxx b/Source/cmExtraSublimeTextGenerator.cxx index 523fca9..baed733 100644 --- a/Source/cmExtraSublimeTextGenerator.cxx +++ b/Source/cmExtraSublimeTextGenerator.cxx @@ -45,13 +45,6 @@ void cmExtraSublimeTextGenerator { entry.Name = this->GetName(); entry.Brief = "Generates Sublime Text 2 project files."; - entry.Full = - "Project files for Sublime Text 2 will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "Additionally Makefiles (or build.ninja files) are generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } cmExtraSublimeTextGenerator::cmExtraSublimeTextGenerator() diff --git a/Source/cmFLTKWrapUICommand.h b/Source/cmFLTKWrapUICommand.h index 530de2c..b94390c 100644 --- a/Source/cmFLTKWrapUICommand.h +++ b/Source/cmFLTKWrapUICommand.h @@ -54,28 +54,6 @@ public: */ virtual const char* GetName() const { return "fltk_wrap_ui";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create FLTK user interfaces Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " fltk_wrap_ui(resultingLibraryName source1\n" - " source2 ... sourceN )\n" - "Produce .h and .cxx files for all the .fl and .fld files listed. " - "The resulting .h and .cxx files will be added to a variable named " - "resultingLibraryName_FLTK_UI_SRCS which should be added to your " - "library."; - } - private: /** * List of produced files. diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h index aa755d1..ba45815 100644 --- a/Source/cmFileCommand.h +++ b/Source/cmFileCommand.h @@ -48,213 +48,6 @@ public: */ virtual const char* GetName() const { return "file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "File manipulation command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " file(WRITE filename \"message to write\"... )\n" - " file(APPEND filename \"message to write\"... )\n" - " file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])\n" - " file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> filename variable)\n" - " file(STRINGS filename variable [LIMIT_COUNT num]\n" - " [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]\n" - " [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]\n" - " [NEWLINE_CONSUME] [REGEX regex]\n" - " [NO_HEX_CONVERSION])\n" - " file(GLOB variable [RELATIVE path] [globbing expressions]...)\n" - " file(GLOB_RECURSE variable [RELATIVE path] \n" - " [FOLLOW_SYMLINKS] [globbing expressions]...)\n" - " file(RENAME <oldname> <newname>)\n" - " file(REMOVE [file1 ...])\n" - " file(REMOVE_RECURSE [file1 ...])\n" - " file(MAKE_DIRECTORY [directory1 directory2 ...])\n" - " file(RELATIVE_PATH variable directory file)\n" - " file(TO_CMAKE_PATH path result)\n" - " file(TO_NATIVE_PATH path result)\n" - " file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout]\n" - " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]\n" - " [EXPECTED_HASH ALGO=value] [EXPECTED_MD5 sum]\n" - " [TLS_VERIFY on|off] [TLS_CAINFO file])\n" - " file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout]\n" - " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])\n" - " file(TIMESTAMP filename variable [<format string>] [UTC])\n" - " file(GENERATE OUTPUT output_file\n" - " <INPUT input_file|CONTENT input_content>\n" - " [CONDITION expression])\n" - "WRITE will write a message into a file called 'filename'. It " - "overwrites the file if it already exists, and creates the file " - "if it does not exist. (If the file is a build input, use " - "configure_file to update the file only when its content changes.)\n" - "APPEND will write a message into a file same as WRITE, except " - "it will append it to the end of the file\n" - "READ will read the content of a file and store it into the " - "variable. It will start at the given offset and read up to numBytes. " - "If the argument HEX is given, the binary data will be converted to " - "hexadecimal representation and this will be stored in the variable.\n" - "MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 " - "will compute a cryptographic hash of the content of a file.\n" - "STRINGS will parse a list of ASCII strings from a file and " - "store it in a variable. Binary data in the file are ignored. Carriage " - "return (CR) characters are ignored. It works also for Intel Hex and " - "Motorola S-record files, which are automatically converted to binary " - "format when reading them. Disable this using NO_HEX_CONVERSION.\n" - "LIMIT_COUNT sets the maximum number of strings to return. " - "LIMIT_INPUT sets the maximum number of bytes to read from " - "the input file. " - "LIMIT_OUTPUT sets the maximum number of bytes to store in the " - "output variable. " - "LENGTH_MINIMUM sets the minimum length of a string to return. " - "Shorter strings are ignored. " - "LENGTH_MAXIMUM sets the maximum length of a string to return. Longer " - "strings are split into strings no longer than the maximum length. " - "NEWLINE_CONSUME allows newlines to be included in strings instead " - "of terminating them.\n" - "REGEX specifies a regular expression that a string must match to be " - "returned. Typical usage \n" - " file(STRINGS myfile.txt myfile)\n" - "stores a list in the variable \"myfile\" in which each item is " - "a line from the input file.\n" - "GLOB will generate a list of all files that match the globbing " - "expressions and store it into the variable. Globbing expressions " - "are similar to regular expressions, but much simpler. If RELATIVE " - "flag is specified for an expression, the results will be returned " - "as a relative path to the given path. " - "(We do not recommend using GLOB to collect a list of source files " - "from your source tree. If no CMakeLists.txt file changes when a " - "source is added or removed then the generated build system cannot " - "know when to ask CMake to regenerate.)" - "\n" - "Examples of globbing expressions include:\n" - " *.cxx - match all files with extension cxx\n" - " *.vt? - match all files with extension vta,...,vtz\n" - " f[3-5].txt - match files f3.txt, f4.txt, f5.txt\n" - "GLOB_RECURSE will generate a list similar to the regular GLOB, except " - "it will traverse all the subdirectories of the matched directory and " - "match the files. Subdirectories that are symlinks are only traversed " - "if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. " - "See cmake --help-policy CMP0009 for more information.\n" - "Examples of recursive globbing include:\n" - " /dir/*.py - match all python files in /dir and subdirectories\n" - "MAKE_DIRECTORY will create the given directories, also if their parent " - "directories don't exist yet\n" - "RENAME moves a file or directory within a filesystem, " - "replacing the destination atomically." - "\n" - "REMOVE will remove the given files, also in subdirectories\n" - "REMOVE_RECURSE will remove the given files and directories, also " - "non-empty directories\n" - "RELATIVE_PATH will determine relative path from directory to the given" - " file.\n" - "TO_CMAKE_PATH will convert path into a cmake style path with unix /. " - " The input can be a single path or a system path like \"$ENV{PATH}\". " - " Note the double quotes around the ENV call TO_CMAKE_PATH only takes " - " one argument. This command will also convert the native list" - " delimiters for a list of paths like the PATH environment variable.\n" - "TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from " - " a cmake style path into the native path style \\ for windows and / " - "for UNIX.\n" - "DOWNLOAD will download the given URL to the given file. " - "If LOG var is specified a log of the download will be put in var. " - "If STATUS var is specified the status of the operation will" - " be put in var. The status is returned in a list of length 2. " - "The first element is the numeric return value for the operation, " - "and the second element is a string value for the error. A 0 " - "numeric error means no error in the operation. " - "If TIMEOUT time is specified, the operation will " - "timeout after time seconds, time should be specified as an integer. " - "The INACTIVITY_TIMEOUT specifies an integer number of seconds of " - "inactivity after which the operation should terminate. " - "If EXPECTED_HASH ALGO=value is specified, the operation will verify " - "that the downloaded file's actual hash matches the expected value, " - "where ALGO is one of MD5, SHA1, SHA224, SHA256, SHA384, or SHA512. " - "If it does not match, the operation fails with an error. " - "(\"EXPECTED_MD5 sum\" is short-hand for \"EXPECTED_HASH MD5=sum\".) " - "If SHOW_PROGRESS is specified, progress information will be printed " - "as status messages until the operation is complete. " - "For https URLs CMake must be built with OpenSSL. " - "TLS/SSL certificates are not checked by default. " - "Set TLS_VERIFY to ON to check certificates and/or use " - "EXPECTED_HASH to verify downloaded content. " - "Set TLS_CAINFO to specify a custom Certificate Authority file. " - "If either TLS option is not given CMake will check variables " - "CMAKE_TLS_VERIFY and CMAKE_TLS_CAINFO, " - "respectively." - "\n" - "UPLOAD will upload the given file to the given URL. " - "If LOG var is specified a log of the upload will be put in var. " - "If STATUS var is specified the status of the operation will" - " be put in var. The status is returned in a list of length 2. " - "The first element is the numeric return value for the operation, " - "and the second element is a string value for the error. A 0 " - "numeric error means no error in the operation. " - "If TIMEOUT time is specified, the operation will " - "timeout after time seconds, time should be specified as an integer. " - "The INACTIVITY_TIMEOUT specifies an integer number of seconds of " - "inactivity after which the operation should terminate. " - "If SHOW_PROGRESS is specified, progress information will be printed " - "as status messages until the operation is complete." - "\n" - "TIMESTAMP will write a string representation of " - "the modification time of filename to variable.\n" - "Should the command be unable to obtain a timestamp " - "variable will be set to the empty string \"\".\n" - "See documentation of the string TIMESTAMP sub-command for more details." - "\n" - "The file() command also provides COPY and INSTALL signatures:\n" - " file(<COPY|INSTALL> files... DESTINATION <dir>\n" - " [FILE_PERMISSIONS permissions...]\n" - " [DIRECTORY_PERMISSIONS permissions...]\n" - " [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]\n" - " [FILES_MATCHING]\n" - " [[PATTERN <pattern> | REGEX <regex>]\n" - " [EXCLUDE] [PERMISSIONS permissions...]] [...])\n" - "The COPY signature copies files, directories, and symlinks to a " - "destination folder. " - "Relative input paths are evaluated with respect to the current " - "source directory, and a relative destination is evaluated with " - "respect to the current build directory. " - "Copying preserves input file timestamps, and optimizes out a file " - "if it exists at the destination with the same timestamp. " - "Copying preserves input permissions unless explicit permissions or " - "NO_SOURCE_PERMISSIONS are given (default is USE_SOURCE_PERMISSIONS). " - "See the install(DIRECTORY) command for documentation of permissions, " - "PATTERN, REGEX, and EXCLUDE options. " - "\n" - "The INSTALL signature differs slightly from COPY: " - "it prints status messages, and NO_SOURCE_PERMISSIONS is default. " - "Installation scripts generated by the install() command use this " - "signature (with some undocumented options for internal use)." - "\n" - "GENERATE will write an <output_file> with content from an " - "<input_file>, or from <input_content>. The output is generated " - "conditionally based on the content of the <condition>. The file is " - "written at CMake generate-time and the input may contain generator " - "expressions. The <condition>, <output_file> and <input_file> may " - "also contain generator expressions. The <condition> must evaluate to " - "either '0' or '1'. The <output_file> must evaluate to a unique name " - "among all configurations and among all invocations of file(GENERATE)." - // Undocumented INSTALL options: - // - RENAME <name> - // - OPTIONAL - // - FILES keyword to re-enter files... list - // - PERMISSIONS before REGEX is alias for FILE_PERMISSIONS - // - DIR_PERMISSIONS is alias for DIRECTORY_PERMISSIONS - // - TYPE <FILE|DIRECTORY|EXECUTABLE|PROGRAM| - // STATIC_LIBRARY|SHARED_LIBRARY|MODULE> - // - COMPONENTS, CONFIGURATIONS, PROPERTIES (ignored for compat) - ; - } - cmTypeMacro(cmFileCommand, cmCommand); protected: diff --git a/Source/cmFindBase.cxx b/Source/cmFindBase.cxx index 7ce0032..c1e7b1e 100644 --- a/Source/cmFindBase.cxx +++ b/Source/cmFindBase.cxx @@ -20,106 +20,6 @@ cmFindBase::cmFindBase() } //---------------------------------------------------------------------------- -void cmFindBase::GenerateDocumentation() -{ - this->cmFindCommon::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_ARGS_XXX", "<VAR> NAMES name"); - this->GenericDocumentation = - " FIND_XXX(<VAR> name1 [path1 path2 ...])\n" - "This is the short-hand signature for the command that " - "is sufficient in many cases. It is the same " - "as FIND_XXX(<VAR> name1 [PATHS path1 path2 ...])\n" - " FIND_XXX(\n" - " <VAR>\n" - " name | NAMES name1 [name2 ...]\n" - " [HINTS path1 [path2 ... ENV var]]\n" - " [PATHS path1 [path2 ... ENV var]]\n" - " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n" - " [DOC \"cache documentation string\"]\n" - " [NO_DEFAULT_PATH]\n" - " [NO_CMAKE_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PATH]\n" - " [NO_SYSTEM_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_SYSTEM_PATH]\n" - " [CMAKE_FIND_ROOT_PATH_BOTH |\n" - " ONLY_CMAKE_FIND_ROOT_PATH |\n" - " NO_CMAKE_FIND_ROOT_PATH]\n" - " )\n" - "" - "This command is used to find a SEARCH_XXX_DESC. " - "A cache entry named by <VAR> is created to store the result " - "of this command. " - "If the SEARCH_XXX is found the result is stored in the variable " - "and the search will not be repeated unless the variable is cleared. " - "If nothing is found, the result will be " - "<VAR>-NOTFOUND, and the search will be attempted again the " - "next time FIND_XXX is invoked with the same variable. " - "The name of the SEARCH_XXX that " - "is searched for is specified by the names listed " - "after the NAMES argument. Additional search locations " - "can be specified after the PATHS argument. If ENV var is " - "found in the HINTS or PATHS section the environment variable var " - "will be read and converted from a system environment variable to " - "a cmake style list of paths. For example ENV PATH would be a way " - "to list the system path variable. The argument " - "after DOC will be used for the documentation string in " - "the cache. " - "PATH_SUFFIXES specifies additional subdirectories to check below " - "each search path." - "\n" - "If NO_DEFAULT_PATH is specified, then no additional paths are " - "added to the search. " - "If NO_DEFAULT_PATH is not specified, the search process is as follows:\n" - "1. Search paths specified in cmake-specific cache variables. " - "These are intended to be used on the command line with a -DVAR=value. " - "This can be skipped if NO_CMAKE_PATH is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n" - " CMAKE_XXX_PATH\n" - " CMAKE_XXX_MAC_PATH\n" - "2. Search paths specified in cmake-specific environment variables. " - "These are intended to be set in the user's shell configuration. " - "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n" - " CMAKE_XXX_PATH\n" - " CMAKE_XXX_MAC_PATH\n" - "3. Search the paths specified by the HINTS option. " - "These should be paths computed by system introspection, such as a " - "hint provided by the location of another item already found. " - "Hard-coded guesses should be specified with the PATHS option.\n" - "4. Search the standard system environment variables. " - "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.\n" - " PATH\n" - " XXX_SYSTEM\n" // replace with "", LIB, or INCLUDE - "5. Search cmake variables defined in the Platform files " - "for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH " - "is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH\n" - " CMAKE_SYSTEM_XXX_PATH\n" - " CMAKE_SYSTEM_XXX_MAC_PATH\n" - "6. Search the paths specified by the PATHS option " - "or in the short-hand version of the command. " - "These are typically hard-coded guesses.\n" - ; - this->GenericDocumentation += this->GenericDocumentationMacPolicy; - this->GenericDocumentation += this->GenericDocumentationRootPath; - this->GenericDocumentation += this->GenericDocumentationPathsOrder; -} - -//---------------------------------------------------------------------------- -const char* cmFindBase::GetFullDocumentation() const -{ - if(this->GenericDocumentation.empty()) - { - const_cast<cmFindBase *>(this)->GenerateDocumentation(); - } - return this->GenericDocumentation.c_str(); -} - -//---------------------------------------------------------------------------- bool cmFindBase::ParseArguments(std::vector<std::string> const& argsIn) { if(argsIn.size() < 2 ) diff --git a/Source/cmFindBase.h b/Source/cmFindBase.h index 84b0330..0562b1b 100644 --- a/Source/cmFindBase.h +++ b/Source/cmFindBase.h @@ -31,10 +31,7 @@ public: virtual bool ParseArguments(std::vector<std::string> const& args); cmTypeMacro(cmFindBase, cmFindCommon); - virtual const char* GetFullDocumentation() const; - protected: - virtual void GenerateDocumentation(); void PrintFindStuff(); void ExpandPaths(); void AddPathSuffixes(); @@ -44,7 +41,6 @@ protected: // if it has documentation in the cache bool CheckForVariableInCache(); - cmStdString GenericDocumentation; // use by command during find cmStdString VariableDocumentation; cmStdString VariableName; diff --git a/Source/cmFindCommon.cxx b/Source/cmFindCommon.cxx index b44864e..7beeda0 100644 --- a/Source/cmFindCommon.cxx +++ b/Source/cmFindCommon.cxx @@ -37,55 +37,6 @@ cmFindCommon::cmFindCommon() } //---------------------------------------------------------------------------- -void cmFindCommon::GenerateDocumentation() -{ - // Documentation components. - this->GenericDocumentationMacPolicy = - "On Darwin or systems supporting OS X Frameworks, the cmake variable" - " CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:\n" - " \"FIRST\" - Try to find frameworks before standard\n" - " libraries or headers. This is the default on Darwin.\n" - " \"LAST\" - Try to find frameworks after standard\n" - " libraries or headers.\n" - " \"ONLY\" - Only try to find frameworks.\n" - " \"NEVER\" - Never try to find frameworks.\n" - "On Darwin or systems supporting OS X Application Bundles, the cmake " - "variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the " - "following:\n" - " \"FIRST\" - Try to find application bundles before standard\n" - " programs. This is the default on Darwin.\n" - " \"LAST\" - Try to find application bundles after standard\n" - " programs.\n" - " \"ONLY\" - Only try to find application bundles.\n" - " \"NEVER\" - Never try to find application bundles.\n"; - this->GenericDocumentationRootPath = - "The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more " - "directories to be prepended to all other search directories. " - "This effectively \"re-roots\" the entire search under given locations. " - "By default it is empty. It is especially useful when " - "cross-compiling to point to the root directory of the " - "target environment and CMake will search there too. By default at first " - "the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted " - "directories will be searched. " - "The default behavior can be adjusted by setting " - "CMAKE_FIND_ROOT_PATH_MODE_XXX. This behavior can be manually " - "overridden on a per-call basis. " - "By using CMAKE_FIND_ROOT_PATH_BOTH the search order will " - "be as described above. If NO_CMAKE_FIND_ROOT_PATH is used " - "then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH " - "is used then only the re-rooted directories will be searched.\n"; - this->GenericDocumentationPathsOrder = - "The default search order is designed to be most-specific to " - "least-specific for common use cases. " - "Projects may override the order by simply calling the command " - "multiple times and using the NO_* options:\n" - " FIND_XXX(FIND_ARGS_XXX PATHS paths... NO_DEFAULT_PATH)\n" - " FIND_XXX(FIND_ARGS_XXX)\n" - "Once one of the calls succeeds the result variable will be set " - "and stored in the cache so that no call will search again."; -} - -//---------------------------------------------------------------------------- cmFindCommon::~cmFindCommon() { } diff --git a/Source/cmFindCommon.h b/Source/cmFindCommon.h index 542805f..6109a9f 100644 --- a/Source/cmFindCommon.h +++ b/Source/cmFindCommon.h @@ -56,8 +56,6 @@ protected: /** Compute the current default bundle/framework search policy. */ void SelectDefaultMacMode(); - virtual void GenerateDocumentation(); - cmStdString CMakePathName; RootPathMode FindRootPathMode; @@ -85,10 +83,6 @@ protected: std::vector<std::string> SearchPaths; std::set<cmStdString> SearchPathsEmitted; - std::string GenericDocumentationMacPolicy; - std::string GenericDocumentationRootPath; - std::string GenericDocumentationPathsOrder; - bool SearchFrameworkFirst; bool SearchFrameworkOnly; bool SearchFrameworkLast; diff --git a/Source/cmFindFileCommand.cxx b/Source/cmFindFileCommand.cxx index fa66fa1..615e7c1 100644 --- a/Source/cmFindFileCommand.cxx +++ b/Source/cmFindFileCommand.cxx @@ -16,15 +16,3 @@ cmFindFileCommand::cmFindFileCommand() { this->IncludeFileInPath = true; } - -void cmFindFileCommand::GenerateDocumentation() -{ - this->cmFindPathCommand::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "find_path", "find_file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "directory containing the named file", - "full path to named file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "file in a directory", "full path to a file"); -} diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h index 1bfdcbd..3f0baa2 100644 --- a/Source/cmFindFileCommand.h +++ b/Source/cmFindFileCommand.h @@ -35,17 +35,7 @@ public: } virtual const char* GetName() const { return "find_file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find the full path to a file."; - } - cmTypeMacro(cmFindFileCommand, cmFindPathCommand); -protected: - virtual void GenerateDocumentation(); }; diff --git a/Source/cmFindLibraryCommand.cxx b/Source/cmFindLibraryCommand.cxx index 4af7e11..de52df7 100644 --- a/Source/cmFindLibraryCommand.cxx +++ b/Source/cmFindLibraryCommand.cxx @@ -20,62 +20,6 @@ cmFindLibraryCommand::cmFindLibraryCommand() this->NamesPerDirAllowed = true; } -//---------------------------------------------------------------------------- -void cmFindLibraryCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_LIBRARY_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", "LIB"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_LIBRARY_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", "library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "lib"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "NAMES name1 [name2 ...]", - "NAMES name1 [name2 ...] [NAMES_PER_DIR]"); - cmSystemTools::ReplaceString( - this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", - " <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and\n"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_LIBRARY"); - this->GenericDocumentation += - "\n" - "When more than one value is given to the NAMES option this command " - "by default will consider one name at a time and search every directory " - "for it. " - "The NAMES_PER_DIR option tells this command to consider one directory " - "at a time and search for all names in it." - "\n" - "If the library found is a framework, then VAR will be set to " - "the full path to the framework <fullPath>/A.framework. " - "When a full path to a framework is used as a library, " - "CMake will use a -framework A, and a -F<fullPath> to " - "link the framework to the target." - "\n" - "If the global property FIND_LIBRARY_USE_LIB64_PATHS is set all search " - "paths will be tested as normal, with \"64/\" appended, and with all " - "matches of \"lib/\" replaced with \"lib64/\". This property is " - "automatically set for the platforms that are known to need it if at " - "least one of the languages supported by the PROJECT command is enabled."; -} - // cmFindLibraryCommand bool cmFindLibraryCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindLibraryCommand.h b/Source/cmFindLibraryCommand.h index cd0fce8..a9ec40e 100644 --- a/Source/cmFindLibraryCommand.h +++ b/Source/cmFindLibraryCommand.h @@ -51,13 +51,6 @@ public: */ virtual const char* GetName() const {return "find_library";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find a library."; - } cmTypeMacro(cmFindLibraryCommand, cmFindBase); protected: @@ -67,7 +60,6 @@ protected: const char* suffix, bool fresh = true); std::string FindLibrary(); - virtual void GenerateDocumentation(); private: std::string FindNormalLibrary(); std::string FindNormalLibraryNamesPerDir(); diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index aa3a73d..aeca39a 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -19,7 +19,9 @@ #endif #if defined(__HAIKU__) -#include <StorageKit.h> +#include <string.h> +#include <FindDirectory.h> +#include <StorageDefs.h> #endif void cmFindPackageNeedBackwardsCompatibility(const std::string& variable, @@ -77,322 +79,6 @@ cmFindPackageCommand::cmFindPackageCommand() } //---------------------------------------------------------------------------- -void cmFindPackageCommand::GenerateDocumentation() -{ - this->cmFindCommon::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentationRootPath, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_PACKAGE"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_ARGS_XXX", "<package>"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_XXX", "find_package"); - this->CommandDocumentation = - " find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [OPTIONAL_COMPONENTS components...]\n" - " [NO_POLICY_SCOPE])\n" - "Finds and loads settings from an external project. " - "<package>_FOUND will be set to indicate whether the package was found. " - "When the package is found package-specific information is provided " - "through variables and imported targets documented by the package " - "itself. " - "The QUIET option disables messages if the package cannot be found. " - "The MODULE option disables the second signature documented below. " - "The REQUIRED option stops processing with an error message if the " - "package cannot be found." - "\n" - "A package-specific list of required components may be listed after the " - "COMPONENTS option (or after the REQUIRED option if present). " - "Additional optional components may be listed after OPTIONAL_COMPONENTS. " - "Available components and their influence on whether a package is " - "considered to be found are defined by the target package." - "\n" - "The [version] argument requests a version with which the package found " - "should be compatible (format is major[.minor[.patch[.tweak]]]). " - "The EXACT option requests that the version be matched exactly. " - "If no [version] and/or component list is given to a recursive " - "invocation inside a find-module, the corresponding arguments " - "are forwarded automatically from the outer call (including the " - "EXACT flag for [version]). " - "Version support is currently provided only on a package-by-package " - "basis (details below).\n" - "User code should generally look for packages using the above simple " - "signature. The remainder of this command documentation specifies the " - "full command signature and details of the search process. Project " - "maintainers wishing to provide a package to be found by this command " - "are encouraged to read on.\n" - "The command has two modes by which it searches for packages: " - "\"Module\" mode and \"Config\" mode. " - "Module mode is available when the command is invoked with the above " - "reduced signature. " - "CMake searches for a file called \"Find<package>.cmake\" in " - "the CMAKE_MODULE_PATH followed by the CMake installation. " - "If the file is found, it is read and processed by CMake. " - "It is responsible for finding the package, checking the version, " - "and producing any needed messages. " - "Many find-modules provide limited or no support for versioning; " - "check the module documentation. " - "If no module is found and the MODULE option is not given the command " - "proceeds to Config mode.\n" - "The complete Config mode command signature is:\n" - " find_package(<package> [version] [EXACT] [QUIET]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [CONFIG|NO_MODULE]\n" - " [NO_POLICY_SCOPE]\n" - " [NAMES name1 [name2 ...]]\n" - " [CONFIGS config1 [config2 ...]]\n" - " [HINTS path1 [path2 ... ]]\n" - " [PATHS path1 [path2 ... ]]\n" - " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n" - " [NO_DEFAULT_PATH]\n" - " [NO_CMAKE_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PATH]\n" - " [NO_SYSTEM_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PACKAGE_REGISTRY]\n" - " [NO_CMAKE_BUILDS_PATH]\n" - " [NO_CMAKE_SYSTEM_PATH]\n" - " [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]\n" - " [CMAKE_FIND_ROOT_PATH_BOTH |\n" - " ONLY_CMAKE_FIND_ROOT_PATH |\n" - " NO_CMAKE_FIND_ROOT_PATH])\n" - "The CONFIG option may be used to skip Module mode explicitly and " - "switch to Config mode. It is synonymous to using NO_MODULE. " - "Config mode is also implied by use of options not specified in the " - "reduced signature. " - "\n" - "Config mode attempts to locate a configuration file provided by the " - "package to be found. A cache entry called <package>_DIR is created to " - "hold the directory containing the file. " - "By default the command searches for a package with the name <package>. " - "If the NAMES option is given the names following it are used instead " - "of <package>. " - "The command searches for a file called \"<name>Config.cmake\" or " - "\"<lower-case-name>-config.cmake\" for each name specified. " - "A replacement set of possible configuration file names may be given " - "using the CONFIGS option. " - "The search procedure is specified below. Once found, the configuration " - "file is read and processed by CMake. Since the file is provided by the " - "package it already knows the location of package contents. " - "The full path to the configuration file is stored in the cmake " - "variable <package>_CONFIG." - "\n" - "All configuration files which have been considered by CMake while " - "searching for an installation of the package with an appropriate " - "version are stored in the cmake variable <package>_CONSIDERED_CONFIGS, " - "the associated versions in <package>_CONSIDERED_VERSIONS. " - "\n" - "If the package configuration file cannot be found CMake " - "will generate an error describing the problem unless the QUIET " - "argument is specified. If REQUIRED is specified and the package " - "is not found a fatal error is generated and the configure step stops " - "executing. If <package>_DIR has been set to a directory not containing " - "a configuration file CMake will ignore it and search from scratch." - "\n" - "When the [version] argument is given Config mode will only find a " - "version of the package that claims compatibility with the requested " - "version (format is major[.minor[.patch[.tweak]]]). " - "If the EXACT option is given only a version of the package claiming " - "an exact match of the requested version may be found. " - "CMake does not establish any convention for the meaning of version " - "numbers. " - "Package version numbers are checked by \"version\" files provided by " - "the packages themselves. " - "For a candidate package configuration file \"<config-file>.cmake\" the " - "corresponding version file is located next to it and named either " - "\"<config-file>-version.cmake\" or \"<config-file>Version.cmake\". " - "If no such version file is available then the configuration file " - "is assumed to not be compatible with any requested version. " - "A basic version file containing generic version matching code can be " - "created using the macro write_basic_package_version_file(), see its " - "documentation for more details. " - "When a version file is found it is loaded to check the requested " - "version number. " - "The version file is loaded in a nested scope in which the following " - "variables have been defined:\n" - " PACKAGE_FIND_NAME = the <package> name\n" - " PACKAGE_FIND_VERSION = full requested version string\n" - " PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - "The version file checks whether it satisfies the requested version " - "and sets these variables:\n" - " PACKAGE_VERSION = full provided version string\n" - " PACKAGE_VERSION_EXACT = true if version is exact match\n" - " PACKAGE_VERSION_COMPATIBLE = true if version is compatible\n" - " PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version\n" - "These variables are checked by the find_package command to determine " - "whether the configuration file provides an acceptable version. " - "They are not available after the find_package call returns. " - "If the version is acceptable the following variables are set:\n" - " <package>_VERSION = full provided version string\n" - " <package>_VERSION_MAJOR = major version if provided, else 0\n" - " <package>_VERSION_MINOR = minor version if provided, else 0\n" - " <package>_VERSION_PATCH = patch version if provided, else 0\n" - " <package>_VERSION_TWEAK = tweak version if provided, else 0\n" - " <package>_VERSION_COUNT = number of version components, 0 to 4\n" - "and the corresponding package configuration file is loaded. " - "When multiple package configuration files are available whose version " - "files claim compatibility with the version requested it is unspecified " - "which one is chosen. " - "No attempt is made to choose a highest or closest version number." - "\n" - "Config mode provides an elaborate interface and search procedure. " - "Much of the interface is provided for completeness and for use " - "internally by find-modules loaded by Module mode. " - "Most user code should simply call\n" - " find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET])\n" - "in order to find a package. Package maintainers providing CMake " - "package configuration files are encouraged to name and install " - "them such that the procedure outlined below will find them " - "without requiring use of additional options." - "\n" - "CMake constructs a set of possible installation prefixes for the " - "package. Under each prefix several directories are searched for a " - "configuration file. The tables below show the directories searched. " - "Each entry is meant for installation trees following Windows (W), " - "UNIX (U), or Apple (A) conventions.\n" - " <prefix>/ (W)\n" - " <prefix>/(cmake|CMake)/ (W)\n" - " <prefix>/<name>*/ (W)\n" - " <prefix>/<name>*/(cmake|CMake)/ (W)\n" - " <prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U)\n" - "On systems supporting OS X Frameworks and Application Bundles " - "the following directories are searched for frameworks or bundles " - "containing a configuration file:\n" - " <prefix>/<name>.framework/Resources/ (A)\n" - " <prefix>/<name>.framework/Resources/CMake/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/CMake/ (A)\n" - "In all cases the <name> is treated as case-insensitive and corresponds " - "to any of the names specified (<package> or names given by NAMES). " - "Paths with lib/<arch> are enabled if CMAKE_LIBRARY_ARCHITECTURE is set. " - "If PATH_SUFFIXES is specified the suffixes are appended to each " - "(W) or (U) directory entry one-by-one.\n" - "This set of directories is intended to work in cooperation with " - "projects that provide configuration files in their installation trees. " - "Directories above marked with (W) are intended for installations on " - "Windows where the prefix may point at the top of an application's " - "installation directory. Those marked with (U) are intended for " - "installations on UNIX platforms where the prefix is shared by " - "multiple packages. This is merely a convention, so all (W) and (U) " - "directories are still searched on all platforms. " - "Directories marked with (A) are intended for installations on " - "Apple platforms. The cmake variables CMAKE_FIND_FRAMEWORK and " - "CMAKE_FIND_APPBUNDLE determine the order of preference " - "as specified below.\n" - "The set of installation prefixes is constructed using the following " - "steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled.\n" - "1. Search paths specified in cmake-specific cache variables. " - "These are intended to be used on the command line with a -DVAR=value. " - "This can be skipped if NO_CMAKE_PATH is passed.\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "2. Search paths specified in cmake-specific environment variables. " - "These are intended to be set in the user's shell configuration. " - "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n" - " <package>_DIR\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "3. Search paths specified by the HINTS option. " - "These should be paths computed by system introspection, such as a " - "hint provided by the location of another item already found. " - "Hard-coded guesses should be specified with the PATHS option.\n" - "4. Search the standard system environment variables. " - "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. " - "Path entries ending in \"/bin\" or \"/sbin\" are automatically " - "converted to their parent directories.\n" - " PATH\n" - "5. Search project build trees recently configured in a CMake GUI. " - "This can be skipped if NO_CMAKE_BUILDS_PATH is passed. " - "It is intended for the case when a user is building multiple " - "dependent projects one after another.\n" - "6. Search paths stored in the CMake user package registry. " - "This can be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed. " - "On Windows a <package> may appear under registry key\n" - " HKEY_CURRENT_USER\\Software\\Kitware\\CMake\\Packages\\<package>\n" - "as a REG_SZ value, with arbitrary name, that specifies the directory " - "containing the package configuration file. " - "On UNIX platforms a <package> may appear under the directory\n" - " ~/.cmake/packages/<package>\n" - "as a file, with arbitrary name, whose content specifies the directory " - "containing the package configuration file. " - "See the export(PACKAGE) command to create user package registry entries " - "for project build trees." - "\n" - "7. Search cmake variables defined in the Platform files " - "for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH " - "is passed.\n" - " CMAKE_SYSTEM_PREFIX_PATH\n" - " CMAKE_SYSTEM_FRAMEWORK_PATH\n" - " CMAKE_SYSTEM_APPBUNDLE_PATH\n" - "8. Search paths stored in the CMake system package registry. " - "This can be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed. " - "On Windows a <package> may appear under registry key\n" - " HKEY_LOCAL_MACHINE\\Software\\Kitware\\CMake\\Packages\\<package>\n" - "as a REG_SZ value, with arbitrary name, that specifies the directory " - "containing the package configuration file. " - "There is no system package registry on non-Windows platforms." - "\n" - "9. Search paths specified by the PATHS option. " - "These are typically hard-coded guesses.\n" - ; - this->CommandDocumentation += this->GenericDocumentationMacPolicy; - this->CommandDocumentation += this->GenericDocumentationRootPath; - this->CommandDocumentation += this->GenericDocumentationPathsOrder; - this->CommandDocumentation += - "\n" - "Every non-REQUIRED find_package() call can be disabled by setting the " - "variable CMAKE_DISABLE_FIND_PACKAGE_<package> to TRUE. See the " - "documentation for the CMAKE_DISABLE_FIND_PACKAGE_<package> variable for " - "more information.\n" - "When loading a find module or package configuration file find_package " - "defines variables to provide information about the call arguments " - "(and restores their original state before returning):\n" - " <package>_FIND_REQUIRED = true if REQUIRED option was given\n" - " <package>_FIND_QUIETLY = true if QUIET option was given\n" - " <package>_FIND_VERSION = full requested version string\n" - " <package>_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " <package>_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " <package>_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " <package>_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " <package>_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - " <package>_FIND_VERSION_EXACT = true if EXACT option was given\n" - " <package>_FIND_COMPONENTS = list of requested components\n" - " <package>_FIND_REQUIRED_<c> = true if component <c> is required\n" - " false if component <c> is optional\n" - "In Module mode the loaded find module is responsible to honor the " - "request detailed by these variables; see the find module for details. " - "In Config mode find_package handles REQUIRED, QUIET, and version " - "options automatically but leaves it to the package configuration file " - "to handle components in a way that makes sense for the package. " - "The package configuration file may set <package>_FOUND to false " - "to tell find_package that component requirements are not satisfied." - "\n" - "See the cmake_policy() command documentation for discussion of the " - "NO_POLICY_SCOPE option." - ; -} - -//---------------------------------------------------------------------------- -const char* cmFindPackageCommand::GetFullDocumentation() const -{ - if(this->CommandDocumentation.empty()) - { - const_cast<cmFindPackageCommand *>(this)->GenerateDocumentation(); - } - return this->CommandDocumentation.c_str(); -} - -//---------------------------------------------------------------------------- bool cmFindPackageCommand ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &) { @@ -1584,12 +1270,14 @@ void cmFindPackageCommand::AddPrefixesUserRegistry() #if defined(_WIN32) && !defined(__CYGWIN__) this->LoadPackageRegistryWinUser(); #elif defined(__HAIKU__) - BPath dir; - if (find_directory(B_USER_SETTINGS_DIRECTORY, &dir) == B_OK) - { - dir.Append("cmake/packages"); - dir.Append(this->Name.c_str()); - this->LoadPackageRegistryDir(dir.Path()); + char dir[B_PATH_NAME_LENGTH]; + if (find_directory(B_USER_SETTINGS_DIRECTORY, -1, false, dir, sizeof(dir)) == + B_OK) + { + std::string fname = dir; + fname += "/cmake/packages/"; + fname += Name; + this->LoadPackageRegistryDir(fname); } #else if(const char* home = cmSystemTools::GetEnv("HOME")) diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h index c380122..1ed0710 100644 --- a/Source/cmFindPackageCommand.h +++ b/Source/cmFindPackageCommand.h @@ -51,22 +51,7 @@ public: */ virtual const char* GetName() const { return "find_package";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load settings for an external project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const; - cmTypeMacro(cmFindPackageCommand, cmFindCommon); -protected: - virtual void GenerateDocumentation(); private: void AppendSuccessInformation(); void AppendToFoundProperty(bool found); @@ -113,7 +98,6 @@ private: struct OriginalDef { bool exists; std::string value; }; std::map<cmStdString, OriginalDef> OriginalDefs; - std::string CommandDocumentation; cmStdString Name; cmStdString Variable; cmStdString Version; diff --git a/Source/cmFindPathCommand.cxx b/Source/cmFindPathCommand.cxx index 6a43298..8459995 100644 --- a/Source/cmFindPathCommand.cxx +++ b/Source/cmFindPathCommand.cxx @@ -20,51 +20,6 @@ cmFindPathCommand::cmFindPathCommand() this->IncludeFileInPath = false; } -void cmFindPathCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_path"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_INCLUDE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", "INCLUDE"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_INCLUDE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", - "directory containing the named file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "file in a directory"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "include"); - cmSystemTools::ReplaceString( - this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", - " <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and\n"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_INCLUDE"); - if(!this->IncludeFileInPath) - { - this->GenericDocumentation += - "\n" - "When searching for frameworks, if the file is specified as " - "A/b.h, then the framework search will look for " - "A.framework/Headers/b.h. " - "If that is found the path will be set to the path to the framework. " - "CMake will convert this to the correct -F option to include the " - "file. "; - } -} - // cmFindPathCommand bool cmFindPathCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindPathCommand.h b/Source/cmFindPathCommand.h index 759567d..8df4540 100644 --- a/Source/cmFindPathCommand.h +++ b/Source/cmFindPathCommand.h @@ -51,18 +51,8 @@ public: */ virtual const char* GetName() const {return "find_path";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find the directory containing a file."; - } - cmTypeMacro(cmFindPathCommand, cmFindBase); bool IncludeFileInPath; -protected: - virtual void GenerateDocumentation(); private: std::string FindHeaderInFramework(std::string const& file, std::string const& dir); diff --git a/Source/cmFindProgramCommand.cxx b/Source/cmFindProgramCommand.cxx index 909b333..bb27753 100644 --- a/Source/cmFindProgramCommand.cxx +++ b/Source/cmFindProgramCommand.cxx @@ -17,37 +17,6 @@ #include <CoreFoundation/CoreFoundation.h> #endif -void cmFindProgramCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_PROGRAM_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_APPBUNDLE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_APPBUNDLE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", ""); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_PROGRAM_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", "program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "[s]bin"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", ""); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_PROGRAM"); -} - // cmFindProgramCommand bool cmFindProgramCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindProgramCommand.h b/Source/cmFindProgramCommand.h index 8350c9b..7f4811c 100644 --- a/Source/cmFindProgramCommand.h +++ b/Source/cmFindProgramCommand.h @@ -50,19 +50,10 @@ public: */ virtual const char* GetName() const { return "find_program";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find an executable program."; - } - cmTypeMacro(cmFindProgramCommand, cmFindBase); protected: std::string FindProgram(std::vector<std::string> names); - virtual void GenerateDocumentation(); private: std::string FindAppBundle(std::vector<std::string> names); diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h index dc47613..e548ba8 100644 --- a/Source/cmForEachCommand.h +++ b/Source/cmForEachCommand.h @@ -61,52 +61,6 @@ public: */ virtual const char* GetName() const { return "foreach";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Evaluate a group of commands for each value in a list."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " foreach(loop_var arg1 arg2 ...)\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endforeach(loop_var)\n" - "All commands between foreach and the matching endforeach are recorded " - "without being invoked. Once the endforeach is evaluated, the " - "recorded list of commands is invoked once for each argument listed " - "in the original foreach command. Before each iteration of the loop " - "\"${loop_var}\" will be set as a variable with " - "the current value in the list.\n" - " foreach(loop_var RANGE total)\n" - " foreach(loop_var RANGE start stop [step])\n" - "Foreach can also iterate over a generated range of numbers. " - "There are three types of this iteration:\n" - "* When specifying single number, the range will have elements " - "0 to \"total\".\n" - "* When specifying two numbers, the range will have elements from " - "the first number to the second number.\n" - "* The third optional number is the increment used to iterate from " - "the first number to the second number." - "\n" - " foreach(loop_var IN [LISTS [list1 [...]]]\n" - " [ITEMS [item1 [...]]])\n" - "Iterates over a precise list of items. " - "The LISTS option names list-valued variables to be traversed, " - "including empty elements (an empty string is a zero-length list). " - "The ITEMS option ends argument parsing and includes all arguments " - "following it in the iteration." - ; - } - cmTypeMacro(cmForEachCommand, cmCommand); private: bool HandleInMode(std::vector<std::string> const& args); diff --git a/Source/cmFunctionCommand.cxx b/Source/cmFunctionCommand.cxx index a126cd1..85b89d9 100644 --- a/Source/cmFunctionCommand.cxx +++ b/Source/cmFunctionCommand.cxx @@ -66,24 +66,6 @@ public: */ virtual const char* GetName() const { return this->Args[0].c_str(); } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - std::string docs = "Function named: "; - docs += this->GetName(); - return docs.c_str(); - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return this->GetTerseDocumentation(); - } - cmTypeMacro(cmFunctionHelperCommand, cmCommand); std::vector<std::string> Args; diff --git a/Source/cmFunctionCommand.h b/Source/cmFunctionCommand.h index 0a029dc..a8bd3e7 100644 --- a/Source/cmFunctionCommand.h +++ b/Source/cmFunctionCommand.h @@ -59,46 +59,6 @@ public: */ virtual const char* GetName() const { return "function";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Start recording a function for later invocation as a command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " function(<name> [arg1 [arg2 [arg3 ...]]])\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endfunction(<name>)\n" - "Define a function named <name> that takes arguments named " - "arg1 arg2 arg3 (...). Commands listed after function, but before " - "the matching endfunction, are not invoked until the function " - "is invoked. When it is invoked, the commands recorded in the " - "function are first modified by replacing formal parameters (${arg1}) " - "with the arguments passed, and then invoked as normal commands. In " - "addition to referencing the formal parameters you can reference " - "the variable ARGC which will be set to the number of arguments " - "passed into the function as well as ARGV0 ARGV1 ARGV2 ... which " - "will have the actual values of the arguments passed in. This " - "facilitates creating functions with optional arguments. Additionally " - "ARGV holds the list of all arguments given to the function and ARGN " - "holds the list of arguments past the last expected argument." - "\n" - "A function opens a new scope: see set(var PARENT_SCOPE) for details." - "\n" - "See the cmake_policy() command documentation for the behavior of " - "policies inside functions." - ; - } - cmTypeMacro(cmFunctionCommand, cmCommand); }; diff --git a/Source/cmGetCMakePropertyCommand.h b/Source/cmGetCMakePropertyCommand.h index b77eaae..6c58bb4 100644 --- a/Source/cmGetCMakePropertyCommand.h +++ b/Source/cmGetCMakePropertyCommand.h @@ -39,31 +39,6 @@ public: */ virtual const char* GetName() const { return "get_cmake_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of the CMake instance."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_cmake_property(VAR property)\n" - "Get a property from the CMake instance. " - "The value of the property is stored in the variable VAR. " - "If the property is not found, VAR will be set to \"NOTFOUND\". " - "Some supported properties " - "include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and " - "COMPONENTS." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetCMakePropertyCommand, cmCommand); }; diff --git a/Source/cmGetDirectoryPropertyCommand.h b/Source/cmGetDirectoryPropertyCommand.h index d0d5820..aea04ad 100644 --- a/Source/cmGetDirectoryPropertyCommand.h +++ b/Source/cmGetDirectoryPropertyCommand.h @@ -39,37 +39,6 @@ public: */ virtual const char* GetName() const { return "get_directory_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of DIRECTORY scope."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)\n" - "Store a property of directory scope in the named variable. " - "If the property is not defined the empty-string is returned. " - "The DIRECTORY argument specifies another directory from which " - "to retrieve the property value. " - "The specified directory must have already been traversed by " - "CMake." - "\n" - " get_directory_property(<variable> [DIRECTORY <dir>]\n" - " DEFINITION <var-name>)\n" - "Get a variable definition from a directory. " - "This form is useful to get a variable definition from another " - "directory." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand); }; diff --git a/Source/cmGetFilenameComponentCommand.h b/Source/cmGetFilenameComponentCommand.h index 09af332..e2cd219 100644 --- a/Source/cmGetFilenameComponentCommand.h +++ b/Source/cmGetFilenameComponentCommand.h @@ -48,43 +48,6 @@ public: */ virtual const char* GetName() const { return "get_filename_component";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a specific component of a full filename."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_filename_component(<VAR> <FileName> <COMP> [CACHE])\n" - "Set <VAR> to a component of <FileName>, where <COMP> is one of:\n" - " DIRECTORY = Directory without file name\n" - " NAME = File name without directory\n" - " EXT = File name longest extension (.b.c from d/a.b.c)\n" - " NAME_WE = File name without directory or longest extension\n" - " ABSOLUTE = Full path to file\n" - " REALPATH = Full path to existing file with symlinks resolved\n" - " PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)\n" - "Paths are returned with forward slashes and have no trailing slahes. " - "The longest file extension is always considered. " - "If the optional CACHE argument is specified, the result variable is " - "added to the cache.\n" - " get_filename_component(<VAR> FileName\n" - " PROGRAM [PROGRAM_ARGS <ARG_VAR>]\n" - " [CACHE])\n" - "The program in FileName will be found in the system search path or " - "left as a full path. If PROGRAM_ARGS is present with PROGRAM, then " - "any command-line arguments present in the FileName string are split " - "from the program name and stored in <ARG_VAR>. This is used to " - "separate a program name from its arguments in a command line string."; - } - cmTypeMacro(cmGetFilenameComponentCommand, cmCommand); }; diff --git a/Source/cmGetPropertyCommand.h b/Source/cmGetPropertyCommand.h index 3c597fd..e1630ff 100644 --- a/Source/cmGetPropertyCommand.h +++ b/Source/cmGetPropertyCommand.h @@ -41,58 +41,6 @@ public: */ virtual const char* GetName() const { return "get_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_property(<variable>\n" - " <GLOBAL |\n" - " DIRECTORY [dir] |\n" - " TARGET <target> |\n" - " SOURCE <source> |\n" - " TEST <test> |\n" - " CACHE <entry> |\n" - " VARIABLE>\n" - " PROPERTY <name>\n" - " [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])\n" - "Get one property from one object in a scope. " - "The first argument specifies the variable in which to store the " - "result. " - "The second argument determines the scope from which to get the " - "property. It must be one of the following:\n" - "GLOBAL scope is unique and does not accept a name.\n" - "DIRECTORY scope defaults to the current directory but another " - "directory (already processed by CMake) may be named by full or " - "relative path.\n" - "TARGET scope must name one existing target.\n" - "SOURCE scope must name one source file.\n" - "TEST scope must name one existing test.\n" - "CACHE scope must name one cache entry.\n" - "VARIABLE scope is unique and does not accept a name.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property to get. " - "If the property is not set an empty value is returned. " - "If the SET option is given the variable is set to a boolean " - "value indicating whether the property has been set. " - "If the DEFINED option is given the variable is set to a boolean " - "value indicating whether the property has been defined " - "such as with define_property. " - "If BRIEF_DOCS or FULL_DOCS is given then the variable is set to " - "a string containing documentation for the requested property. " - "If documentation is requested for a property that has not been " - "defined NOTFOUND is returned."; - } - cmTypeMacro(cmGetPropertyCommand, cmCommand); private: enum OutType { OutValue, OutDefined, OutBriefDoc, OutFullDoc, OutSet }; diff --git a/Source/cmGetSourceFilePropertyCommand.h b/Source/cmGetSourceFilePropertyCommand.h index 2ba8103..338318e 100644 --- a/Source/cmGetSourceFilePropertyCommand.h +++ b/Source/cmGetSourceFilePropertyCommand.h @@ -34,30 +34,6 @@ public: */ virtual const char* GetName() const { return "get_source_file_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property for a source file."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_source_file_property(VAR file property)\n" - "Get a property from a source file. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". Use set_source_files_properties to set " - "property values. Source file properties usually control how the " - "file is built. One property that is always there is LOCATION" - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand); }; diff --git a/Source/cmGetTargetPropertyCommand.h b/Source/cmGetTargetPropertyCommand.h index f5e1aa7..4985b3c 100644 --- a/Source/cmGetTargetPropertyCommand.h +++ b/Source/cmGetTargetPropertyCommand.h @@ -34,32 +34,6 @@ public: */ virtual const char* GetName() const { return "get_target_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property from a target."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_target_property(VAR target property)\n" - "Get a property from a target. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". Use set_target_properties to set " - "property values. Properties are usually used to control how " - "a target is built, but some query the target instead. " - "This command can get properties for any target so far created. " - "The targets do not need to be in the current CMakeLists.txt file." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetTargetPropertyCommand, cmCommand); }; diff --git a/Source/cmGetTestPropertyCommand.h b/Source/cmGetTestPropertyCommand.h index 01f54d9..2dccabe 100644 --- a/Source/cmGetTestPropertyCommand.h +++ b/Source/cmGetTestPropertyCommand.h @@ -34,29 +34,6 @@ public: */ virtual const char* GetName() const { return "get_test_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of the test."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_test_property(test property VAR)\n" - "Get a property from the Test. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". For a list of standard properties " - "you can type cmake --help-property-list" - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetTestPropertyCommand, cmCommand); }; diff --git a/Source/cmGlobalBorlandMakefileGenerator.cxx b/Source/cmGlobalBorlandMakefileGenerator.cxx index 2a7d61d..6c20952 100644 --- a/Source/cmGlobalBorlandMakefileGenerator.cxx +++ b/Source/cmGlobalBorlandMakefileGenerator.cxx @@ -59,5 +59,4 @@ void cmGlobalBorlandMakefileGenerator { entry.Name = cmGlobalBorlandMakefileGenerator::GetActualName(); entry.Brief = "Generates Borland makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalGenerator.cxx b/Source/cmGlobalGenerator.cxx index 799bbdb..fb205be 100644 --- a/Source/cmGlobalGenerator.cxx +++ b/Source/cmGlobalGenerator.cxx @@ -27,6 +27,7 @@ #include "cmGeneratorTarget.h" #include "cmGeneratorExpression.h" #include "cmGeneratorExpressionEvaluationFile.h" +#include "cmExportBuildFileGenerator.h" #include <cmsys/Directory.hxx> @@ -77,6 +78,12 @@ cmGlobalGenerator::~cmGlobalGenerator() { delete *li; } + for(std::map<std::string, cmExportBuildFileGenerator*>::iterator + i = this->BuildExportSets.begin(); + i != this->BuildExportSets.end(); ++i) + { + delete i->second; + } this->LocalGenerators.clear(); if (this->ExtraGenerator) @@ -183,6 +190,34 @@ void cmGlobalGenerator::ResolveLanguageCompiler(const std::string &lang, doc.c_str(), cmCacheManager::FILEPATH); } +void cmGlobalGenerator::AddBuildExportSet(cmExportBuildFileGenerator* gen) +{ + this->BuildExportSets[gen->GetMainExportFileName()] = gen; +} + +bool cmGlobalGenerator::GenerateImportFile(const std::string &file) +{ + std::map<std::string, cmExportBuildFileGenerator*>::iterator it + = this->BuildExportSets.find(file); + if (it != this->BuildExportSets.end()) + { + bool result = it->second->GenerateImportFile(); + delete it->second; + it->second = 0; + this->BuildExportSets.erase(it); + return result; + } + return false; +} + +bool +cmGlobalGenerator::IsExportedTargetsFile(const std::string &filename) const +{ + const std::map<std::string, cmExportBuildFileGenerator*>::const_iterator it + = this->BuildExportSets.find(filename); + return it != this->BuildExportSets.end(); +} + // Find the make program for the generator, required for try compiles void cmGlobalGenerator::FindMakeProgram(cmMakefile* mf) { @@ -624,6 +659,9 @@ cmGlobalGenerator::EnableLanguage(std::vector<std::string>const& languages, { this->LanguageToOriginalSharedLibFlags[lang] = sharedLibFlags; } + + // Translate compiler ids for compatibility. + this->CheckCompilerIdCompatibility(mf, lang); } // end for each language // Now load files that can override any settings on the platform or for @@ -640,6 +678,44 @@ cmGlobalGenerator::EnableLanguage(std::vector<std::string>const& languages, } //---------------------------------------------------------------------------- +void cmGlobalGenerator::CheckCompilerIdCompatibility(cmMakefile* mf, + std::string lang) +{ + std::string compilerIdVar = "CMAKE_" + lang + "_COMPILER_ID"; + const char* compilerId = mf->GetDefinition(compilerIdVar.c_str()); + if(compilerId && strcmp(compilerId, "AppleClang") == 0) + { + cmPolicies* policies = this->CMakeInstance->GetPolicies(); + switch(mf->GetPolicyStatus(cmPolicies::CMP0025)) + { + case cmPolicies::WARN: + if(!this->CMakeInstance->GetIsInTryCompile()) + { + cmOStringStream w; + w << policies->GetPolicyWarning(cmPolicies::CMP0025) << "\n" + "Converting " << lang << + " compiler id \"AppleClang\" to \"Clang\" for compatibility." + ; + mf->IssueMessage(cmake::AUTHOR_WARNING, w.str()); + } + case cmPolicies::OLD: + // OLD behavior is to convert AppleClang to Clang. + mf->AddDefinition(compilerIdVar.c_str(), "Clang"); + break; + case cmPolicies::REQUIRED_IF_USED: + case cmPolicies::REQUIRED_ALWAYS: + mf->IssueMessage( + cmake::FATAL_ERROR, + policies->GetRequiredPolicyError(cmPolicies::CMP0025) + ); + case cmPolicies::NEW: + // NEW behavior is to keep AppleClang. + break; + } + } +} + +//---------------------------------------------------------------------------- const char* cmGlobalGenerator::GetLanguageOutputExtension(cmSourceFile const& source) { @@ -925,6 +1001,14 @@ void cmGlobalGenerator::Configure() } } +cmExportBuildFileGenerator* +cmGlobalGenerator::GetExportedTargetsFile(const std::string &filename) const +{ + std::map<std::string, cmExportBuildFileGenerator*>::const_iterator it + = this->BuildExportSets.find(filename); + return it == this->BuildExportSets.end() ? 0 : it->second; +} + bool cmGlobalGenerator::CheckALLOW_DUPLICATE_CUSTOM_TARGETS() { // If the property is not enabled then okay. @@ -1050,6 +1134,19 @@ void cmGlobalGenerator::Generate() } this->SetCurrentLocalGenerator(0); + for (std::map<std::string, cmExportBuildFileGenerator*>::iterator + it = this->BuildExportSets.begin(); it != this->BuildExportSets.end(); + ++it) + { + if (!it->second->GenerateImportFile() + && !cmSystemTools::GetErrorOccuredFlag()) + { + this->GetCMakeInstance() + ->IssueMessage(cmake::FATAL_ERROR, "Could not write export file.", + cmListFileBacktrace()); + return; + } + } // Update rule hashes. this->CheckRuleHashes(); @@ -2563,6 +2660,10 @@ void cmGlobalGenerator::WriteSummary() for(std::map<cmStdString,cmTarget *>::const_iterator ti = this->TotalTargets.begin(); ti != this->TotalTargets.end(); ++ti) { + if ((ti->second)->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } this->WriteSummary(ti->second); fout << ti->second->GetSupportDirectory() << "\n"; } diff --git a/Source/cmGlobalGenerator.h b/Source/cmGlobalGenerator.h index 18aba24..c930b2b 100644 --- a/Source/cmGlobalGenerator.h +++ b/Source/cmGlobalGenerator.h @@ -31,6 +31,7 @@ class cmExternalMakefileProjectGenerator; class cmTarget; class cmInstallTargetGenerator; class cmInstallFilesGenerator; +class cmExportBuildFileGenerator; /** \class cmGlobalGenerator * \brief Responable for overseeing the generation process for the entire tree @@ -293,6 +294,13 @@ public: void ProcessEvaluationFiles(); + std::map<std::string, cmExportBuildFileGenerator*>& GetBuildExportSets() + {return this->BuildExportSets;} + void AddBuildExportSet(cmExportBuildFileGenerator*); + bool IsExportedTargetsFile(const std::string &filename) const; + bool GenerateImportFile(const std::string &file); + cmExportBuildFileGenerator* + GetExportedTargetsFile(const std::string &filename) const; protected: typedef std::vector<cmLocalGenerator*> GeneratorVector; // for a project collect all its targets by following depend @@ -344,6 +352,7 @@ protected: bool InstallTargetEnabled; // Sets of named target exports cmExportSetMap ExportSets; + std::map<std::string, cmExportBuildFileGenerator*> BuildExportSets; // Manifest of all targets that will be built for each configuration. // This is computed just before local generators generate. @@ -383,6 +392,8 @@ private: void WriteSummary(); void WriteSummary(cmTarget* target); + void CheckCompilerIdCompatibility(cmMakefile* mf, std::string lang); + cmExternalMakefileProjectGenerator* ExtraGenerator; // track files replaced during a Generate diff --git a/Source/cmGlobalJOMMakefileGenerator.cxx b/Source/cmGlobalJOMMakefileGenerator.cxx index 4af0607..bc15ef2 100644 --- a/Source/cmGlobalJOMMakefileGenerator.cxx +++ b/Source/cmGlobalJOMMakefileGenerator.cxx @@ -65,5 +65,4 @@ void cmGlobalJOMMakefileGenerator { entry.Name = cmGlobalJOMMakefileGenerator::GetActualName(); entry.Brief = "Generates JOM makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalKdevelopGenerator.cxx b/Source/cmGlobalKdevelopGenerator.cxx index a81c26c..e7c857e 100644 --- a/Source/cmGlobalKdevelopGenerator.cxx +++ b/Source/cmGlobalKdevelopGenerator.cxx @@ -28,16 +28,6 @@ void cmGlobalKdevelopGenerator { entry.Name = this->GetName(); entry.Brief = "Generates KDevelop 3 project files."; - entry.Full = - "Project files for KDevelop 3 will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "If you change the settings using KDevelop cmake will try its best " - "to keep your changes when regenerating the project files. " - "Additionally a hierarchy of UNIX makefiles is generated into the " - "build tree. Any " - "standard UNIX-style make program can build the project through the " - "default make target. A \"make install\" target is also provided."; } cmGlobalKdevelopGenerator::cmGlobalKdevelopGenerator() diff --git a/Source/cmGlobalMSYSMakefileGenerator.cxx b/Source/cmGlobalMSYSMakefileGenerator.cxx index d49639b..539d2af 100644 --- a/Source/cmGlobalMSYSMakefileGenerator.cxx +++ b/Source/cmGlobalMSYSMakefileGenerator.cxx @@ -110,6 +110,4 @@ void cmGlobalMSYSMakefileGenerator { entry.Name = cmGlobalMSYSMakefileGenerator::GetActualName(); entry.Brief = "Generates MSYS makefiles."; - entry.Full = "The makefiles use /bin/sh as the shell. " - "They require msys to be installed on the machine."; } diff --git a/Source/cmGlobalMinGWMakefileGenerator.cxx b/Source/cmGlobalMinGWMakefileGenerator.cxx index 1f374d3..e00c7dd 100644 --- a/Source/cmGlobalMinGWMakefileGenerator.cxx +++ b/Source/cmGlobalMinGWMakefileGenerator.cxx @@ -49,6 +49,4 @@ void cmGlobalMinGWMakefileGenerator { entry.Name = cmGlobalMinGWMakefileGenerator::GetActualName(); entry.Brief = "Generates a make file for use with mingw32-make."; - entry.Full = "The makefiles generated use cmd.exe as the shell. " - "They do not require msys or a unix shell."; } diff --git a/Source/cmGlobalNMakeMakefileGenerator.cxx b/Source/cmGlobalNMakeMakefileGenerator.cxx index 7af4ee3..4fbabe4 100644 --- a/Source/cmGlobalNMakeMakefileGenerator.cxx +++ b/Source/cmGlobalNMakeMakefileGenerator.cxx @@ -65,5 +65,4 @@ void cmGlobalNMakeMakefileGenerator { entry.Name = cmGlobalNMakeMakefileGenerator::GetActualName(); entry.Brief = "Generates NMake makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalNinjaGenerator.cxx b/Source/cmGlobalNinjaGenerator.cxx index 61d0272..bdc08b3 100644 --- a/Source/cmGlobalNinjaGenerator.cxx +++ b/Source/cmGlobalNinjaGenerator.cxx @@ -470,10 +470,6 @@ void cmGlobalNinjaGenerator { entry.Name = cmGlobalNinjaGenerator::GetActualName(); entry.Brief = "Generates build.ninja files (experimental)."; - entry.Full = - "A build.ninja file is generated into the build tree. Recent " - "versions of the ninja program can build the project through the " - "\"all\" target. An \"install\" target is also provided."; } // Implemented in all cmGlobaleGenerator sub-classes. @@ -877,7 +873,12 @@ cmGlobalNinjaGenerator cmTargetDependSet const& targetDeps = this->GetTargetDirectDepends(*target); for (cmTargetDependSet::const_iterator i = targetDeps.begin(); - i != targetDeps.end(); ++i) { + i != targetDeps.end(); ++i) + { + if ((*i)->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } this->AppendTargetOutputs(*i, outputs); } } diff --git a/Source/cmGlobalUnixMakefileGenerator3.cxx b/Source/cmGlobalUnixMakefileGenerator3.cxx index 3a9dc44..7ab107f 100644 --- a/Source/cmGlobalUnixMakefileGenerator3.cxx +++ b/Source/cmGlobalUnixMakefileGenerator3.cxx @@ -65,10 +65,6 @@ void cmGlobalUnixMakefileGenerator3 { entry.Name = cmGlobalUnixMakefileGenerator3::GetActualName(); entry.Brief = "Generates standard UNIX makefiles."; - entry.Full = - "A hierarchy of UNIX makefiles is generated into the build tree. Any " - "standard UNIX-style make program can build the project through the " - "default make target. A \"make install\" target is also provided."; } //---------------------------------------------------------------------------- @@ -881,6 +877,10 @@ cmGlobalUnixMakefileGenerator3 for(TargetDependSet::const_iterator di = depends.begin(); di != depends.end(); ++di) { + if ((*di)->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } count += this->CountProgressMarksInTarget(*di, emitted); } } @@ -967,6 +967,10 @@ cmGlobalUnixMakefileGenerator3 { // Create the target-level dependency. cmTarget const* dep = *i; + if (dep->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } cmLocalUnixMakefileGenerator3* lg3 = static_cast<cmLocalUnixMakefileGenerator3*> (dep->GetMakefile()->GetLocalGenerator()); diff --git a/Source/cmGlobalVisualStudio10Generator.cxx b/Source/cmGlobalVisualStudio10Generator.cxx index b2a337c..07ccc33 100644 --- a/Source/cmGlobalVisualStudio10Generator.cxx +++ b/Source/cmGlobalVisualStudio10Generator.cxx @@ -48,11 +48,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 10"; entry.Brief = "Generates Visual Studio 10 (2010) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 10 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 10 IA64\" for Itanium."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio11Generator.cxx b/Source/cmGlobalVisualStudio11Generator.cxx index 8ae7331..41a349e 100644 --- a/Source/cmGlobalVisualStudio11Generator.cxx +++ b/Source/cmGlobalVisualStudio11Generator.cxx @@ -68,11 +68,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 11"; entry.Brief = "Generates Visual Studio 11 (2012) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 11 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 11 ARM\" for ARM."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio12Generator.cxx b/Source/cmGlobalVisualStudio12Generator.cxx index c56dfff..c2cdc0b 100644 --- a/Source/cmGlobalVisualStudio12Generator.cxx +++ b/Source/cmGlobalVisualStudio12Generator.cxx @@ -43,11 +43,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 12"; entry.Brief = "Generates Visual Studio 12 (2013) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 12 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 12 ARM\" for ARM."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio6Generator.cxx b/Source/cmGlobalVisualStudio6Generator.cxx index b3fabda..4006df4 100644 --- a/Source/cmGlobalVisualStudio6Generator.cxx +++ b/Source/cmGlobalVisualStudio6Generator.cxx @@ -200,6 +200,10 @@ void cmGlobalVisualStudio6Generator tt != orderedProjectTargets.end(); ++tt) { cmTarget* target = *tt; + if(target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } // Write the project into the DSW file const char* expath = target->GetProperty("EXTERNAL_MSPROJECT"); if(expath) @@ -401,7 +405,6 @@ void cmGlobalVisualStudio6Generator { entry.Name = cmGlobalVisualStudio6Generator::GetActualName(); entry.Brief = "Generates Visual Studio 6 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio71Generator.cxx b/Source/cmGlobalVisualStudio71Generator.cxx index 51efc46..2643719 100644 --- a/Source/cmGlobalVisualStudio71Generator.cxx +++ b/Source/cmGlobalVisualStudio71Generator.cxx @@ -313,5 +313,4 @@ void cmGlobalVisualStudio71Generator { entry.Name = cmGlobalVisualStudio71Generator::GetActualName(); entry.Brief = "Generates Visual Studio .NET 2003 project files."; - entry.Full = ""; } diff --git a/Source/cmGlobalVisualStudio7Generator.cxx b/Source/cmGlobalVisualStudio7Generator.cxx index b475665..0b9796d 100644 --- a/Source/cmGlobalVisualStudio7Generator.cxx +++ b/Source/cmGlobalVisualStudio7Generator.cxx @@ -392,6 +392,10 @@ void cmGlobalVisualStudio7Generator::WriteTargetDepends( projectTargets.begin(); tt != projectTargets.end(); ++tt) { cmTarget* target = *tt; + if(target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } cmMakefile* mf = target->GetMakefile(); const char *vcprojName = target->GetProperty("GENERATOR_FILE_NAME"); @@ -837,7 +841,6 @@ void cmGlobalVisualStudio7Generator { entry.Name = cmGlobalVisualStudio7Generator::GetActualName(); entry.Brief = "Generates Visual Studio .NET 2002 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio8Generator.cxx b/Source/cmGlobalVisualStudio8Generator.cxx index 1a4c7ff..b9bc1ae 100644 --- a/Source/cmGlobalVisualStudio8Generator.cxx +++ b/Source/cmGlobalVisualStudio8Generator.cxx @@ -65,11 +65,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = vs8generatorName; entry.Brief = "Generates Visual Studio 8 2005 project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 8 2005 Win64\" will create project files for " - "the x64 processor."; } virtual void GetGenerators(std::vector<std::string>& names) const { @@ -147,7 +142,6 @@ void cmGlobalVisualStudio8Generator { entry.Name = cmGlobalVisualStudio8Generator::GetActualName(); entry.Brief = "Generates Visual Studio 8 2005 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- @@ -409,6 +403,10 @@ void cmGlobalVisualStudio8Generator::WriteProjectDepends( for(OrderedTargetDependSet::const_iterator i = depends.begin(); i != depends.end(); ++i) { + if((*i)->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } std::string guid = this->GetGUID((*i)->GetName()); fout << "\t\t{" << guid << "} = {" << guid << "}\n"; } diff --git a/Source/cmGlobalVisualStudio9Generator.cxx b/Source/cmGlobalVisualStudio9Generator.cxx index fba6ed1..aadf982 100644 --- a/Source/cmGlobalVisualStudio9Generator.cxx +++ b/Source/cmGlobalVisualStudio9Generator.cxx @@ -70,11 +70,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = vs9generatorName; entry.Brief = "Generates Visual Studio 9 2008 project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 9 2008 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 9 2008 IA64\" for Itanium."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudioGenerator.cxx b/Source/cmGlobalVisualStudioGenerator.cxx index 5931016..af80070 100644 --- a/Source/cmGlobalVisualStudioGenerator.cxx +++ b/Source/cmGlobalVisualStudioGenerator.cxx @@ -349,6 +349,10 @@ cmGlobalVisualStudioGenerator::GetTargetLinkClosure(cmTarget* target) void cmGlobalVisualStudioGenerator::FollowLinkDepends( cmTarget* target, std::set<cmTarget*>& linked) { + if(target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + return; + } if(linked.insert(target).second && target->GetType() == cmTarget::STATIC_LIBRARY) { diff --git a/Source/cmGlobalWatcomWMakeGenerator.cxx b/Source/cmGlobalWatcomWMakeGenerator.cxx index e3cebc4..6ae8775 100644 --- a/Source/cmGlobalWatcomWMakeGenerator.cxx +++ b/Source/cmGlobalWatcomWMakeGenerator.cxx @@ -62,5 +62,4 @@ void cmGlobalWatcomWMakeGenerator { entry.Name = cmGlobalWatcomWMakeGenerator::GetActualName(); entry.Brief = "Generates Watcom WMake makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalXCodeGenerator.cxx b/Source/cmGlobalXCodeGenerator.cxx index 0a2b32b..c8b6832 100644 --- a/Source/cmGlobalXCodeGenerator.cxx +++ b/Source/cmGlobalXCodeGenerator.cxx @@ -976,6 +976,11 @@ cmGlobalXCodeGenerator::CreateXCodeTargets(cmLocalGenerator* gen, continue; } + if(cmtarget.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } + if(cmtarget.GetType() == cmTarget::UTILITY || cmtarget.GetType() == cmTarget::GLOBAL_TARGET) { @@ -1686,6 +1691,11 @@ void cmGlobalXCodeGenerator::CreateBuildSettings(cmTarget& target, cmXCodeObject* buildSettings, const char* configName) { + if(target.GetType() == cmTarget::INTERFACE_LIBRARY) + { + return; + } + std::string flags; std::string defFlags; bool shared = ((target.GetType() == cmTarget::SHARED_LIBRARY) || @@ -2550,6 +2560,10 @@ cmXCodeObject* cmGlobalXCodeGenerator::CreateXCodeTarget(cmTarget& cmtarget, cmXCodeObject* buildPhases) { + if(cmtarget.GetType() == cmTarget::INTERFACE_LIBRARY) + { + return 0; + } cmXCodeObject* target = this->CreateObject(cmXCodeObject::PBXNativeTarget); target->AddAttribute("buildPhases", buildPhases); @@ -2756,6 +2770,10 @@ void cmGlobalXCodeGenerator ::AddDependAndLinkInformation(cmXCodeObject* target) { cmTarget* cmtarget = target->GetTarget(); + if(cmtarget->GetType() == cmTarget::INTERFACE_LIBRARY) + { + return; + } if(!cmtarget) { cmSystemTools::Error("Error no target on xobject\n"); @@ -2867,7 +2885,8 @@ void cmGlobalXCodeGenerator { linkLibs += this->XCodeEscapePath(li->Value.c_str()); } - else + else if (!li->Target + || li->Target->GetType() != cmTarget::INTERFACE_LIBRARY) { linkLibs += li->Value; } @@ -2909,6 +2928,10 @@ void cmGlobalXCodeGenerator::CreateGroups(cmLocalGenerator* root, { continue; } + if(cmtarget.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } // add the soon to be generated Info.plist file as a source for a // MACOSX_BUNDLE file @@ -3648,7 +3671,6 @@ void cmGlobalXCodeGenerator::GetDocumentation(cmDocumentationEntry& entry) { entry.Name = cmGlobalXCodeGenerator::GetActualName(); entry.Brief = "Generate Xcode project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGraphVizWriter.cxx b/Source/cmGraphVizWriter.cxx index 4816da9..3a7070e 100644 --- a/Source/cmGraphVizWriter.cxx +++ b/Source/cmGraphVizWriter.cxx @@ -534,8 +534,8 @@ int cmGraphVizWriter::CollectAllExternalLibs(int cnt) ostr << this->GraphNodePrefix << cnt++; this->TargetNamesNodes[libName] = ostr.str(); this->TargetPtrs[libName] = NULL; - //str << " \"" << ostr.c_str() << "\" [ label=\"" << libName - //<< "\" shape=\"ellipse\"];" << std::endl; + // str << " \"" << ostr.c_str() << "\" [ label=\"" << libName + // << "\" shape=\"ellipse\"];" << std::endl; } } } diff --git a/Source/cmIfCommand.h b/Source/cmIfCommand.h index f794b78..f2633ad 100644 --- a/Source/cmIfCommand.h +++ b/Source/cmIfCommand.h @@ -66,187 +66,10 @@ public: virtual const char* GetName() const { return "if";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Conditionally execute a group of commands."; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " if(expression)\n" - " # then section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " elseif(expression2)\n" - " # elseif section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " else(expression)\n" - " # else section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endif(expression)\n" - "Evaluates the given expression. If the result is true, the commands " - "in the THEN section are invoked. Otherwise, the commands in the " - "else section are invoked. The elseif and else sections are " - "optional. You may have multiple elseif clauses. Note that " - "the expression in the else and endif clause is optional. Long " - "expressions can be used and there is a traditional order of " - "precedence. " - "Parenthetical expressions are evaluated first followed by unary " - "operators such as EXISTS, COMMAND, and DEFINED. " - "Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES " - "will be evaluated. Then NOT operators and finally AND, OR operators " - "will be evaluated. Possible expressions are:\n" - " if(<constant>)\n" - "True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. " - "False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, '', " - "or ends in the suffix '-NOTFOUND'. " - "Named boolean constants are case-insensitive. " - "If the argument is not one of these constants, " - "it is treated as a variable:" - "\n" - " if(<variable>)\n" - "True if the variable is defined to a value that is not a false " - "constant. False otherwise. " - "(Note macro arguments are not variables.)" - "\n" - " if(NOT <expression>)\n" - "True if the expression is not true." - "\n" - " if(<expr1> AND <expr2>)\n" - "True if both expressions would be considered true individually." - "\n" - " if(<expr1> OR <expr2>)\n" - "True if either expression would be considered true individually." - "\n" - " if(COMMAND command-name)\n" - "True if the given name is a command, macro or function that can be " - "invoked.\n" - " if(POLICY policy-id)\n" - "True if the given name is an existing policy " - "(of the form CMP<NNNN>).\n" - " if(TARGET target-name)\n" - "True if the given name is an existing target, built or imported.\n" - " if(EXISTS file-name)\n" - " if(EXISTS directory-name)\n" - "True if the named file or directory exists. " - "Behavior is well-defined only for full paths.\n" - " if(file1 IS_NEWER_THAN file2)\n" - "True if file1 is newer than file2 or if one of the two files " - "doesn't exist. " - "Behavior is well-defined only for full paths. " - "If the file time stamps are exactly the same, an " - "IS_NEWER_THAN comparison returns true, so that any dependent " - "build operations will occur in the event of a tie. " - "This includes the case of passing the same file name for both " - "file1 and file2.\n" - " if(IS_DIRECTORY directory-name)\n" - "True if the given name is a directory. " - "Behavior is well-defined only for full paths.\n" - " if(IS_SYMLINK file-name)\n" - "True if the given name is a symbolic link. " - "Behavior is well-defined only for full paths.\n" - " if(IS_ABSOLUTE path)\n" - "True if the given path is an absolute path.\n" - " if(<variable|string> MATCHES regex)\n" - "True if the given string or variable's value matches the given " - "regular expression.\n" - " if(<variable|string> LESS <variable|string>)\n" - " if(<variable|string> GREATER <variable|string>)\n" - " if(<variable|string> EQUAL <variable|string>)\n" - "True if the given string or variable's value is a valid number and " - "the inequality or equality is true.\n" - " if(<variable|string> STRLESS <variable|string>)\n" - " if(<variable|string> STRGREATER <variable|string>)\n" - " if(<variable|string> STREQUAL <variable|string>)\n" - "True if the given string or variable's value is lexicographically " - "less (or greater, or equal) than the string or variable on the right.\n" - " if(<variable|string> VERSION_LESS <variable|string>)\n" - " if(<variable|string> VERSION_EQUAL <variable|string>)\n" - " if(<variable|string> VERSION_GREATER <variable|string>)\n" - "Component-wise integer version number comparison (version format is " - "major[.minor[.patch[.tweak]]]).\n" - " if(DEFINED <variable>)\n" - "True if the given variable is defined. It does not matter if the " - "variable is true or false just if it has been set.\n" - " if((expression) AND (expression OR (expression)))\n" - "The expressions inside the parenthesis are evaluated first and " - "then the remaining expression is evaluated as in the previous " - "examples. Where there are nested parenthesis the innermost are " - "evaluated as part of evaluating the expression " - "that contains them." - "\n" - - "The if command was written very early in CMake's history, predating " - "the ${} variable evaluation syntax, and for convenience evaluates " - "variables named by its arguments as shown in the above signatures. " - "Note that normal variable evaluation with ${} applies before the " - "if command even receives the arguments. " - "Therefore code like\n" - " set(var1 OFF)\n" - " set(var2 \"var1\")\n" - " if(${var2})\n" - "appears to the if command as\n" - " if(var1)\n" - "and is evaluated according to the if(<variable>) case " - "documented above. " - "The result is OFF which is false. " - "However, if we remove the ${} from the example then the command sees\n" - " if(var2)\n" - "which is true because var2 is defined to \"var1\" which is not " - "a false constant." - "\n" - "Automatic evaluation applies in the other cases whenever the " - "above-documented signature accepts <variable|string>:\n" - - "1) The left hand argument to MATCHES is first checked to see " - "if it is a defined variable, if so the variable's value is " - "used, otherwise the original value is used. \n" - - "2) If the left hand argument to MATCHES is missing it returns " - "false without error \n" - - "3) Both left and right hand arguments to LESS GREATER EQUAL " - "are independently tested to see if they are defined variables, " - "if so their defined values are used otherwise the original " - "value is used. \n" - - "4) Both left and right hand arguments to STRLESS STREQUAL " - "STRGREATER are independently tested to see if they are defined " - "variables, if so their defined values are used otherwise the " - "original value is used. \n" - - "5) Both left and right hand argumemnts to VERSION_LESS " - "VERSION_EQUAL VERSION_GREATER are independently tested to see " - "if they are defined variables, if so their defined values are " - "used otherwise the original value is used. \n" - - "6) The right hand argument to NOT is tested to see if it is a " - "boolean constant, if so the value is used, otherwise it is " - "assumed to be a variable and it is dereferenced. \n" - - "7) The left and right hand arguments to AND OR are " - "independently tested to see if they are boolean constants, if " - "so they are used as such, otherwise they are assumed to be " - "variables and are dereferenced. \n" - ; - } - // this is a shared function for both If and Else to determine if the // arguments were valid, and if so, was the response true. If there is // an error, the errorString will be set. diff --git a/Source/cmIncludeCommand.cxx b/Source/cmIncludeCommand.cxx index bb891d6..5b93171 100644 --- a/Source/cmIncludeCommand.cxx +++ b/Source/cmIncludeCommand.cxx @@ -88,6 +88,48 @@ bool cmIncludeCommand fname = mfile.c_str(); } } + + std::string fname_abs = + cmSystemTools::CollapseFullPath(fname.c_str(), + this->Makefile->GetStartDirectory()); + + cmGlobalGenerator *gg = this->Makefile->GetLocalGenerator() + ->GetGlobalGenerator(); + if (gg->IsExportedTargetsFile(fname_abs)) + { + const char *modal = 0; + cmake::MessageType messageType = cmake::AUTHOR_WARNING; + + switch(this->Makefile->GetPolicyStatus(cmPolicies::CMP0024)) + { + case cmPolicies::WARN: + modal = "should"; + case cmPolicies::OLD: + break; + case cmPolicies::REQUIRED_IF_USED: + case cmPolicies::REQUIRED_ALWAYS: + case cmPolicies::NEW: + modal = "may"; + messageType = cmake::FATAL_ERROR; + } + if (modal) + { + cmOStringStream e; + e << (this->Makefile->GetPolicies() + ->GetPolicyWarning(cmPolicies::CMP0024)) << "\n"; + e << "The file\n " << fname_abs << "\nwas generated by the export() " + "command. It " << modal << " not be used as the argument to the " + "include() command. Use ALIAS targets instead to refer to targets " + "by alternative names.\n"; + this->Makefile->IssueMessage(messageType, e.str().c_str()); + if (messageType == cmake::FATAL_ERROR) + { + return false; + } + } + gg->GenerateImportFile(fname_abs); + } + std::string fullFilePath; bool readit = this->Makefile->ReadListFile( this->Makefile->GetCurrentListFile(), diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h index d97b7c3..267723d 100644 --- a/Source/cmIncludeCommand.h +++ b/Source/cmIncludeCommand.h @@ -15,9 +15,7 @@ #include "cmCommand.h" /** \class cmIncludeCommand - * \brief - * - * cmIncludeCommand defines a list of distant + * \brief cmIncludeCommand defines a list of distant * files that can be "included" in the current list file. * In almost every sense, this is identical to a C/C++ * #include command. Arguments are first expended as usual. @@ -50,41 +48,6 @@ public: */ virtual const char* GetName() const {return "include";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load and run CMake code from a file or module."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\n" - " [NO_POLICY_SCOPE])\n" - "Load and run CMake code from the file given. " - "Variable reads and writes access the scope of the caller " - "(dynamic scoping). " - "If OPTIONAL is present, then no error " - "is raised if the file does not exist. If RESULT_VARIABLE is given " - "the variable will be set to the full filename which " - "has been included or NOTFOUND if it failed.\n" - "If a module is specified instead of a file, the file with name " - "<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the " - "CMake module directory. There is one exception to this: if the file " - "which calls include() is located itself in the CMake module directory, " - "then first the CMake module directory is searched and " - "CMAKE_MODULE_PATH afterwards. See also policy CMP0017." - "\n" - "See the cmake_policy() command documentation for discussion of the " - "NO_POLICY_SCOPE option." - ; - } - cmTypeMacro(cmIncludeCommand, cmCommand); }; diff --git a/Source/cmIncludeDirectoryCommand.h b/Source/cmIncludeDirectoryCommand.h index 77a340a..c621dcb 100644 --- a/Source/cmIncludeDirectoryCommand.h +++ b/Source/cmIncludeDirectoryCommand.h @@ -43,44 +43,6 @@ public: */ virtual const char* GetName() const { return "include_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add include directories to the build."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n" - "Add the given directories to those the compiler uses to search " - "for include files. Relative paths are interpreted as relative to " - "the current source directory. \n" - "The include directories are added to the directory property " - "INCLUDE_DIRECTORIES for the current CMakeLists file. " - "They are also added to the target property INCLUDE_DIRECTORIES " - "for each target in the current CMakeLists file. " - "The target property values are the ones used by the generators." - "\n" - "By default the directories are appended onto the current list of " - "directories. " - "This default behavior can be changed by setting " - "CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. " - "By using AFTER or BEFORE explicitly, you can select between " - "appending and prepending, independent of the default. " - "\n" - "If the SYSTEM option is given, the compiler will be told the " - "directories are meant as system include directories on some " - "platforms (signalling this setting might achieve effects such as " - "the compiler skipping warnings, or these fixed-install system files " - "not being considered in dependency calculations - see compiler docs)."; - } - cmTypeMacro(cmIncludeDirectoryCommand, cmCommand); protected: diff --git a/Source/cmIncludeExternalMSProjectCommand.h b/Source/cmIncludeExternalMSProjectCommand.h index d5cec01..8ca674f 100644 --- a/Source/cmIncludeExternalMSProjectCommand.h +++ b/Source/cmIncludeExternalMSProjectCommand.h @@ -44,38 +44,6 @@ public: */ virtual const char* GetName() const {return "include_external_msproject";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Include an external Microsoft project file in a workspace."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_external_msproject(projectname location\n" - " [TYPE projectTypeGUID]\n" - " [GUID projectGUID]\n" - " [PLATFORM platformName]\n" - " dep1 dep2 ...)\n" - "Includes an external Microsoft project in the generated workspace " - "file. Currently does nothing on UNIX. This will create a " - "target named [projectname]. This can be used in the add_dependencies " - "command to make things depend on the external project." - "\n" - "TYPE, GUID and PLATFORM are optional parameters that allow one " - "to specify the type of project, id (GUID) of the project and " - "the name of the target platform. " - "This is useful for projects requiring values other than the default " - "(e.g. WIX projects). " - "These options are not supported by the Visual Studio 6 generator."; - } - cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand); }; diff --git a/Source/cmIncludeRegularExpressionCommand.h b/Source/cmIncludeRegularExpressionCommand.h index 2e41775..0c5fa6f 100644 --- a/Source/cmIncludeRegularExpressionCommand.h +++ b/Source/cmIncludeRegularExpressionCommand.h @@ -43,30 +43,6 @@ public: */ virtual const char* GetName() const {return "include_regular_expression";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the regular expression used for dependency checking."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_regular_expression(regex_match [regex_complain])\n" - "Set the regular expressions used in dependency checking. Only files " - "matching regex_match will be traced as dependencies. Only files " - "matching regex_complain will generate warnings if they cannot be " - "found " - "(standard header paths are not searched). The defaults are:\n" - " regex_match = \"^.*$\" (match everything)\n" - " regex_complain = \"^$\" (match empty string only)"; - } - cmTypeMacro(cmIncludeRegularExpressionCommand, cmCommand); }; diff --git a/Source/cmInstallCommand.cxx b/Source/cmInstallCommand.cxx index 3c76bd6..d309a2a 100644 --- a/Source/cmInstallCommand.cxx +++ b/Source/cmInstallCommand.cxx @@ -379,7 +379,8 @@ bool cmInstallCommand::HandleTargetsMode(std::vector<std::string> const& args) target->GetType() != cmTarget::STATIC_LIBRARY && target->GetType() != cmTarget::SHARED_LIBRARY && target->GetType() != cmTarget::MODULE_LIBRARY && - target->GetType() != cmTarget::OBJECT_LIBRARY) + target->GetType() != cmTarget::OBJECT_LIBRARY && + target->GetType() != cmTarget::INTERFACE_LIBRARY) { cmOStringStream e; e << "TARGETS given target \"" << (*targetIt) @@ -626,6 +627,11 @@ bool cmInstallCommand::HandleTargetsMode(std::vector<std::string> const& args) } } break; + case cmTarget::INTERFACE_LIBRARY: + // Nothing to do. An INTERFACE_LIBRARY can be installed, but the + // only effect of that is to make it exportable. It installs no + // other files itself. + break; default: // This should never happen due to the above type check. // Ignore the case. diff --git a/Source/cmInstallCommand.h b/Source/cmInstallCommand.h index 6509501..9db2490 100644 --- a/Source/cmInstallCommand.h +++ b/Source/cmInstallCommand.h @@ -43,307 +43,6 @@ public: */ virtual const char* GetName() const { return "install";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify rules to run at install time."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command generates installation rules for a project. " - "Rules specified by calls to this command within a source directory " - "are executed in order during installation. " - "The order across directories is not defined." - "\n" - "There are multiple signatures for this command. Some of them define " - "installation properties for files and targets. Properties common to " - "multiple signatures are covered here but they are valid only for " - "signatures that specify them.\n" - "DESTINATION arguments specify " - "the directory on disk to which a file will be installed. " - "If a full path (with a leading slash or drive letter) is given it " - "is used directly. If a relative path is given it is interpreted " - "relative to the value of CMAKE_INSTALL_PREFIX. The prefix can " - "be relocated at install time using DESTDIR mechanism explained in the " - "CMAKE_INSTALL_PREFIX variable documentation.\n" - "PERMISSIONS arguments specify permissions for installed files. " - "Valid permissions are " - "OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, " - "GROUP_READ, GROUP_WRITE, GROUP_EXECUTE, " - "WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, " - "SETUID, and SETGID. " - "Permissions that do not make sense on certain platforms are ignored " - "on those platforms.\n" - "The CONFIGURATIONS argument specifies a list of build configurations " - "for which the install rule applies (Debug, Release, etc.).\n" - "The COMPONENT argument specifies an installation component name " - "with which the install rule is associated, such as \"runtime\" or " - "\"development\". During component-specific installation only " - "install rules associated with the given component name will be " - "executed. During a full installation all components are installed." - " If COMPONENT is not provided a default component \"Unspecified\" is" - " created. The default component name may be controlled with the " - "CMAKE_INSTALL_DEFAULT_COMPONENT_NAME variable.\n" - "The RENAME argument specifies a name for an installed file that " - "may be different from the original file. Renaming is allowed only " - "when a single file is installed by the command.\n" - "The OPTIONAL argument specifies that it is not an error if the " - "file to be installed does not exist. " - "\n" - "The TARGETS signature:\n" - " install(TARGETS targets... [EXPORT <export-name>]\n" - " [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|\n" - " PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]\n" - " [DESTINATION <dir>]\n" - " [INCLUDES DESTINATION [<dir> ...]]\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP]\n" - " ] [...])\n" - "The TARGETS form specifies rules for installing targets from a " - "project. There are five kinds of target files that may be " - "installed: ARCHIVE, LIBRARY, RUNTIME, FRAMEWORK, and BUNDLE. " - - "Executables are treated as RUNTIME targets, except that those " - "marked with the MACOSX_BUNDLE property are treated as BUNDLE " - "targets on OS X. " - "Static libraries are always treated as ARCHIVE targets. " - "Module libraries are always treated as LIBRARY targets. " - "For non-DLL platforms shared libraries are treated as LIBRARY " - "targets, except that those marked with the FRAMEWORK property " - "are treated as FRAMEWORK targets on OS X. " - "For DLL platforms the DLL part of a shared library is treated as " - "a RUNTIME target and the corresponding import library is treated as " - "an ARCHIVE target. " - "All Windows-based systems including Cygwin are DLL platforms. " - "The ARCHIVE, LIBRARY, RUNTIME, and FRAMEWORK " - "arguments change the type of target to which the subsequent " - "properties " - "apply. If none is given the installation properties apply to " - "all target types. If only one is given then only targets of that " - "type will be installed (which can be used to install just a DLL or " - "just an import library)." - "The INCLUDES DESTINATION specifies a list of directories which will " - "be added to the INTERFACE_INCLUDE_DIRECTORIES of the <targets> when " - "exported by install(EXPORT). If a relative path is specified, it is " - "treated as relative to the $<INSTALL_PREFIX>." - "\n" - "The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE arguments cause " - "subsequent properties to be applied to installing a FRAMEWORK " - "shared library target's associated files on non-Apple platforms. " - "Rules defined by these arguments are ignored on Apple platforms " - "because the associated files are installed into the appropriate " - "locations inside the framework folder. " - "See documentation of the PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE " - "target properties for details." - "\n" - "Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY " - "option. " - "On some platforms a versioned shared library has a symbolic link " - "such as\n" - " lib<name>.so -> lib<name>.so.1\n" - "where \"lib<name>.so.1\" is the soname of the library and " - "\"lib<name>.so\" is a \"namelink\" allowing linkers to find the " - "library when given \"-l<name>\". " - "The NAMELINK_ONLY option causes installation of only the namelink " - "when a library target is installed. " - "The NAMELINK_SKIP option causes installation of library files other " - "than the namelink when a library target is installed. " - "When neither option is given both portions are installed. " - "On platforms where versioned shared libraries do not have namelinks " - "or when a library is not versioned the NAMELINK_SKIP option installs " - "the library and the NAMELINK_ONLY option installs nothing. " - "See the VERSION and SOVERSION target properties for details on " - "creating versioned shared libraries." - "\n" - "One or more groups of properties may be specified in a single call " - "to the TARGETS form of this command. A target may be installed more " - "than once to different locations. Consider hypothetical " - "targets \"myExe\", \"mySharedLib\", and \"myStaticLib\". The code\n" - " install(TARGETS myExe mySharedLib myStaticLib\n" - " RUNTIME DESTINATION bin\n" - " LIBRARY DESTINATION lib\n" - " ARCHIVE DESTINATION lib/static)\n" - " install(TARGETS mySharedLib DESTINATION /some/full/path)\n" - "will install myExe to <prefix>/bin and myStaticLib to " - "<prefix>/lib/static. " - "On non-DLL platforms mySharedLib will be installed to <prefix>/lib " - "and /some/full/path. On DLL platforms the mySharedLib DLL will be " - "installed to <prefix>/bin and /some/full/path and its import library " - "will be installed to <prefix>/lib/static and /some/full/path." - "\n" - "The EXPORT option associates the installed target files with an " - "export called <export-name>. " - "It must appear before any RUNTIME, LIBRARY, or ARCHIVE options. " - "To actually install the export file itself, call install(EXPORT). " - "See documentation of the install(EXPORT ...) signature below for " - "details." - "\n" - "Installing a target with EXCLUDE_FROM_ALL set to true has " - "undefined behavior." - "\n" - "The FILES signature:\n" - " install(FILES files... DESTINATION <dir>\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [RENAME <name>] [OPTIONAL])\n" - "The FILES form specifies rules for installing files for a " - "project. File names given as relative paths are interpreted with " - "respect to the current source directory. Files installed by this " - "form are by default given permissions OWNER_WRITE, OWNER_READ, " - "GROUP_READ, and WORLD_READ if no PERMISSIONS argument is given." - "\n" - "The PROGRAMS signature:\n" - " install(PROGRAMS files... DESTINATION <dir>\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [RENAME <name>] [OPTIONAL])\n" - "The PROGRAMS form is identical to the FILES form except that the " - "default permissions for the installed file also include " - "OWNER_EXECUTE, GROUP_EXECUTE, and WORLD_EXECUTE. " - "This form is intended to install programs that are not targets, " - "such as shell scripts. Use the TARGETS form to install targets " - "built within the project." - "\n" - "The DIRECTORY signature:\n" - " install(DIRECTORY dirs... DESTINATION <dir>\n" - " [FILE_PERMISSIONS permissions...]\n" - " [DIRECTORY_PERMISSIONS permissions...]\n" - " [USE_SOURCE_PERMISSIONS] [OPTIONAL]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>] [FILES_MATCHING]\n" - " [[PATTERN <pattern> | REGEX <regex>]\n" - " [EXCLUDE] [PERMISSIONS permissions...]] [...])\n" - "The DIRECTORY form installs contents of one or more directories " - "to a given destination. " - "The directory structure is copied verbatim to the destination. " - "The last component of each directory name is appended to the " - "destination directory but a trailing slash may be used to " - "avoid this because it leaves the last component empty. " - "Directory names given as relative paths are interpreted with " - "respect to the current source directory. " - "If no input directory names are given the destination directory " - "will be created but nothing will be installed into it. " - "The FILE_PERMISSIONS and DIRECTORY_PERMISSIONS options specify " - "permissions given to files and directories in the destination. " - "If USE_SOURCE_PERMISSIONS is specified and FILE_PERMISSIONS is not, " - "file permissions will be copied from the source directory structure. " - "If no permissions are specified files will be given the default " - "permissions specified in the FILES form of the command, and the " - "directories will be given the default permissions specified in the " - "PROGRAMS form of the command.\n" - - "Installation of directories may be controlled with fine granularity " - "using the PATTERN or REGEX options. These \"match\" options specify a " - "globbing pattern or regular expression to match directories or files " - "encountered within input directories. They may be used to apply " - "certain options (see below) to a subset of the files and directories " - "encountered. " - "The full path to each input file or directory " - "(with forward slashes) is matched against the expression. " - "A PATTERN will match only complete file names: the portion of the " - "full path matching the pattern must occur at the end of the file name " - "and be preceded by a slash. " - "A REGEX will match any portion of the full path but it may use " - "'/' and '$' to simulate the PATTERN behavior. " - "By default all files and directories are installed whether " - "or not they are matched. " - "The FILES_MATCHING option may be given before the first match option " - "to disable installation of files (but not directories) not matched by " - "any expression. For example, the code\n" - " install(DIRECTORY src/ DESTINATION include/myproj\n" - " FILES_MATCHING PATTERN \"*.h\")\n" - "will extract and install header files from a source tree.\n" - "Some options may follow a PATTERN or REGEX expression and are " - "applied only to files or directories matching them. " - "The EXCLUDE option will skip the matched file or directory. " - "The PERMISSIONS option overrides the permissions setting for the " - "matched file or directory. " - "For example the code\n" - " install(DIRECTORY icons scripts/ DESTINATION share/myproj\n" - " PATTERN \"CVS\" EXCLUDE\n" - " PATTERN \"scripts/*\"\n" - " PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ\n" - " GROUP_EXECUTE GROUP_READ)\n" - "will install the icons directory to share/myproj/icons and the " - "scripts directory to share/myproj. The icons will get default file " - "permissions, the scripts will be given specific permissions, and " - "any CVS directories will be excluded." - "\n" - "The SCRIPT and CODE signature:\n" - " install([[SCRIPT <file>] [CODE <code>]] [...])\n" - "The SCRIPT form will invoke the given CMake script files during " - "installation. If the script file name is a relative path " - "it will be interpreted with respect to the current source directory. " - "The CODE form will invoke the given CMake code during installation. " - "Code is specified as a single argument inside a double-quoted string. " - "For example, the code\n" - " install(CODE \"MESSAGE(\\\"Sample install message.\\\")\")\n" - "will print a message during installation.\n" - "" - "The EXPORT signature:\n" - " install(EXPORT <export-name> DESTINATION <dir>\n" - " [NAMESPACE <namespace>] [FILE <name>.cmake]\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [EXPORT_LINK_INTERFACE_LIBRARIES]\n" - " [COMPONENT <component>])\n" - "The EXPORT form generates and installs a CMake file containing code " - "to import targets from the installation tree into another project. " - "Target installations are associated with the export <export-name> " - "using the EXPORT option of the install(TARGETS ...) signature " - "documented above. The NAMESPACE option will prepend <namespace> to " - "the target names as they are written to the import file. " - "By default the generated file will be called <export-name>.cmake but " - "the FILE option may be used to specify a different name. The value " - "given to the FILE option must be a file name with the \".cmake\" " - "extension. " - "If a CONFIGURATIONS option is given then the file will only be " - "installed when one of the named configurations is installed. " - "Additionally, the generated import file will reference only the " - "matching target configurations. " - "The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the " - "contents of the properties matching " - "(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when " - "policy CMP0022 is NEW. " - "If a COMPONENT option is specified that does not match that given " - "to the targets associated with <export-name> the behavior is " - "undefined. " - "If a library target is included in the export but " - "a target to which it links is not included the behavior is " - "unspecified." - "\n" - "The EXPORT form is useful to help outside projects use targets built " - "and installed by the current project. For example, the code\n" - " install(TARGETS myexe EXPORT myproj DESTINATION bin)\n" - " install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj)\n" - "will install the executable myexe to <prefix>/bin and code to import " - "it in the file \"<prefix>/lib/myproj/myproj.cmake\". " - "An outside project may load this file with the include command " - "and reference the myexe executable from the installation tree using " - "the imported target name mp_myexe as if the target were built " - "in its own tree." - "\n" - "NOTE: This command supercedes the INSTALL_TARGETS command and the " - "target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. " - "It also replaces the FILES forms of the INSTALL_FILES and " - "INSTALL_PROGRAMS commands. " - "The processing order of these install rules relative to those " - "generated by INSTALL_TARGETS, INSTALL_FILES, and INSTALL_PROGRAMS " - "commands is not defined.\n" - ; - } - cmTypeMacro(cmInstallCommand, cmCommand); private: diff --git a/Source/cmInstallFilesCommand.h b/Source/cmInstallFilesCommand.h index bb0a6cc..5583fe4 100644 --- a/Source/cmInstallFilesCommand.h +++ b/Source/cmInstallFilesCommand.h @@ -44,14 +44,6 @@ public: virtual const char* GetName() const { return "install_files";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(FILES ) command instead."; - } - - /** * This is called at the end after all the information * specified by the command is accumulated. Most commands do * not implement this method. At this point, reading and @@ -60,37 +52,6 @@ public: virtual void FinalPass(); virtual bool HasFinalPass() const { return !this->IsFilesForm; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code. " - "The FILES form is directly replaced by the FILES form of the " - "install command. The regexp form can be expressed " - "more clearly using the GLOB form of the file command.\n" - " install_files(<dir> extension file file ...)\n" - "Create rules to install the listed files with the given extension " - "into the given directory. " - "Only files existing in the current source tree or its corresponding " - "location in the binary tree may be listed. " - "If a file specified already has an extension, that extension will be " - "removed first. This is useful for providing lists of source files " - "such as foo.cxx when you want the corresponding foo.h to be " - "installed. A typical extension is '.h'.\n" - " install_files(<dir> regexp)\n" - "Any files in the current source directory that match the regular " - "expression will be installed.\n" - " install_files(<dir> FILES file file ...)\n" - "Any files listed after the FILES keyword will be " - "installed explicitly from the names given. Full paths are allowed in " - "this form.\n" - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmInstallProgramsCommand.h b/Source/cmInstallProgramsCommand.h index 27a0498..95acfa2 100644 --- a/Source/cmInstallProgramsCommand.h +++ b/Source/cmInstallProgramsCommand.h @@ -44,14 +44,6 @@ public: virtual const char* GetName() const { return "install_programs";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(PROGRAMS ) command instead."; - } - - /** * This is called at the end after all the information * specified by the command is accumulated. Most commands do * not implement this method. At this point, reading and @@ -61,33 +53,6 @@ public: virtual bool HasFinalPass() const { return true; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code. " - "The FILES form is directly replaced by the PROGRAMS form of the " - "INSTALL command. The regexp form can be expressed more clearly " - "using the GLOB form of the FILE command.\n" - " install_programs(<dir> file1 file2 [file3 ...])\n" - " install_programs(<dir> FILES file1 [file2 ...])\n" - "Create rules to install the listed programs into the given directory. " - "Use the FILES argument to guarantee that the file list version of " - "the command will be used even when there is only one argument.\n" - " install_programs(<dir> regexp)\n" - "In the second form any program in the current source directory that " - "matches the regular expression will be installed.\n" - "This command is intended to install programs that are not built " - "by cmake, such as shell scripts. See the TARGETS form of " - "the INSTALL command to " - "create installation rules for targets built by cmake.\n" - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmInstallTargetGenerator.cxx b/Source/cmInstallTargetGenerator.cxx index d0768c8..7b9109e 100644 --- a/Source/cmInstallTargetGenerator.cxx +++ b/Source/cmInstallTargetGenerator.cxx @@ -90,6 +90,11 @@ void cmInstallTargetGenerator::GenerateScriptForConfig(std::ostream& os, case cmTarget::STATIC_LIBRARY: type = cmInstallType_STATIC_LIBRARY; break; case cmTarget::SHARED_LIBRARY: type = cmInstallType_SHARED_LIBRARY; break; case cmTarget::MODULE_LIBRARY: type = cmInstallType_MODULE_LIBRARY; break; + case cmTarget::INTERFACE_LIBRARY: + // Not reachable. We never create a cmInstallTargetGenerator for + // an INTERFACE_LIBRARY. + assert(!"INTERFACE_LIBRARY targets have no installable outputs."); + break; case cmTarget::OBJECT_LIBRARY: case cmTarget::UTILITY: case cmTarget::GLOBAL_TARGET: diff --git a/Source/cmInstallTargetsCommand.h b/Source/cmInstallTargetsCommand.h index c47b387..2aa34db 100644 --- a/Source/cmInstallTargetsCommand.h +++ b/Source/cmInstallTargetsCommand.h @@ -44,30 +44,6 @@ public: */ virtual const char* GetName() const { return "install_targets";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(TARGETS ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code.\n" - " install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n" - "Create rules to install the listed targets into the given directory. " - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY " - "is specified, then on systems with special runtime files " - "(Windows DLL), the files will be copied to that directory."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmLinkDirectoriesCommand.h b/Source/cmLinkDirectoriesCommand.h index 9218f44..c6eb40c 100644 --- a/Source/cmLinkDirectoriesCommand.h +++ b/Source/cmLinkDirectoriesCommand.h @@ -45,33 +45,6 @@ public: */ virtual const char* GetName() const { return "link_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify directories in which the linker will look for libraries."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " link_directories(directory1 directory2 ...)\n" - "Specify the paths in which the linker should search for libraries. " - "The command will apply only to targets created after it is called. " - "Relative paths given to this command are interpreted as relative to " - "the current source directory, see CMP0015. \n" - "Note that this command is rarely necessary. Library locations " - "returned by find_package() and find_library() are absolute paths. " - "Pass these absolute library file paths directly to the " - "target_link_libraries() command. CMake will ensure the linker finds " - "them." - ; - } - cmTypeMacro(cmLinkDirectoriesCommand, cmCommand); private: void AddLinkDir(std::string const& dir); diff --git a/Source/cmLinkLibrariesCommand.h b/Source/cmLinkLibrariesCommand.h index c450a1c..74de23c 100644 --- a/Source/cmLinkLibrariesCommand.h +++ b/Source/cmLinkLibrariesCommand.h @@ -44,31 +44,6 @@ public: */ virtual const char* GetName() const { return "link_libraries";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the target_link_libraries() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Link libraries to all targets added later.\n" - " link_libraries(library1 <debug | optimized> library2 ...)\n" - "Specify a list of libraries to be linked into " - "any following targets (typically added with the add_executable " - "or add_library calls). This command is passed " - "down to all subdirectories. " - "The debug and optimized strings may be used to indicate that " - "the next library listed is to be used only for that specific " - "type of build."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmListCommand.h b/Source/cmListCommand.h index f20aa8a..0cb5da2 100644 --- a/Source/cmListCommand.h +++ b/Source/cmListCommand.h @@ -46,66 +46,6 @@ public: */ virtual const char* GetName() const { return "list";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "List operations."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " list(LENGTH <list> <output variable>)\n" - " list(GET <list> <element index> [<element index> ...]\n" - " <output variable>)\n" - " list(APPEND <list> <element> [<element> ...])\n" - " list(FIND <list> <value> <output variable>)\n" - " list(INSERT <list> <element_index> <element> [<element> ...])\n" - " list(REMOVE_ITEM <list> <value> [<value> ...])\n" - " list(REMOVE_AT <list> <index> [<index> ...])\n" - " list(REMOVE_DUPLICATES <list>)\n" - " list(REVERSE <list>)\n" - " list(SORT <list>)\n" - "LENGTH will return a given list's length.\n" - "GET will return list of elements specified by indices from the list.\n" - "APPEND will append elements to the list.\n" - "FIND will return the index of the element specified in the list or -1 " - "if it wasn't found.\n" - "INSERT will insert elements to the list to the specified location.\n" - "REMOVE_AT and REMOVE_ITEM will remove items from the list. The " - "difference is that REMOVE_ITEM will remove the given items, while " - "REMOVE_AT will remove the items at the given indices.\n" - "REMOVE_DUPLICATES will remove duplicated items in the list.\n" - "REVERSE reverses the contents of the list in-place.\n" - "SORT sorts the list in-place alphabetically.\n" - "The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM, " - "REMOVE_DUPLICATES, REVERSE and SORT may create new values for " - "the list within the current CMake variable scope. Similar to " - "the SET command, the LIST command creates new variable values " - "in the current scope, even if the list itself is actually " - "defined in a parent scope. To propagate the results of these " - "operations upwards, use SET with PARENT_SCOPE, SET with CACHE " - "INTERNAL, or some other means of value propagation.\n" - "NOTES: A list in cmake is a ; separated group of strings. " - "To create a list the set command can be used. For example, " - "set(var a b c d e) creates a list with a;b;c;d;e, and " - "set(var \"a b c d e\") creates a string or a list with one " - "item in it.\n" - "When specifying index values, if <element index> is 0 or" - " greater, it is indexed from the " - "beginning of the list, with 0 representing the first list element. " - "If <element index> is -1 or lesser, it is indexed from the end of " - "the list, with -1 representing the last list element. Be careful " - "when counting with negative indices: they do not start from 0. " - "-0 is equivalent to 0, the first list element.\n" - ; - } - cmTypeMacro(cmListCommand, cmCommand); protected: bool HandleLengthCommand(std::vector<std::string> const& args); diff --git a/Source/cmLoadCacheCommand.h b/Source/cmLoadCacheCommand.h index f55cbb3..c8f7236 100644 --- a/Source/cmLoadCacheCommand.h +++ b/Source/cmLoadCacheCommand.h @@ -42,39 +42,6 @@ public: */ virtual const char* GetName() const { return "load_cache";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load in the values from another project's CMake cache."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " load_cache(pathToCacheFile READ_WITH_PREFIX\n" - " prefix entry1...)\n" - "Read the cache and store the requested entries in variables with " - "their name prefixed with the given prefix. " - "This only reads the values, and does not create entries in the local " - "project's cache.\n" - " load_cache(pathToCacheFile [EXCLUDE entry1...]\n" - " [INCLUDE_INTERNALS entry1...])\n" - "Load in the values from another cache and store them in the local " - "project's cache as internal entries. This is useful for a project " - "that depends on another project built in a different tree. " - "EXCLUDE option can be used to provide a list of entries to be " - "excluded. " - "INCLUDE_INTERNALS can be used to provide a list of internal entries " - "to be included. Normally, no internal entries are brought in. Use " - "of this form of the command is strongly discouraged, but it is " - "provided for backward compatibility."; - } - cmTypeMacro(cmLoadCacheCommand, cmCommand); protected: diff --git a/Source/cmLoadCommandCommand.cxx b/Source/cmLoadCommandCommand.cxx index b2acf06..84dd299 100644 --- a/Source/cmLoadCommandCommand.cxx +++ b/Source/cmLoadCommandCommand.cxx @@ -71,23 +71,6 @@ public: */ virtual const char* GetName() const { return info.Name; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - if (this->info.GetTerseDocumentation) - { - cmLoadedCommand::InstallSignalHandlers(info.Name); - const char* ret = info.GetTerseDocumentation(); - cmLoadedCommand::InstallSignalHandlers(info.Name, 1); - return ret; - } - else - { - return "LoadedCommand without any additional documentation"; - } - } static const char* LastName; static void TrapsForSignals(int sig) { @@ -120,24 +103,6 @@ public: } } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - if (this->info.GetFullDocumentation) - { - cmLoadedCommand::InstallSignalHandlers(info.Name); - const char* ret = info.GetFullDocumentation(); - cmLoadedCommand::InstallSignalHandlers(info.Name, 1); - return ret; - } - else - { - return "LoadedCommand without any additional documentation"; - } - } - cmTypeMacro(cmLoadedCommand, cmCommand); cmLoadedCommandInfo info; diff --git a/Source/cmLoadCommandCommand.h b/Source/cmLoadCommandCommand.h index f0b34ee..918f32b 100644 --- a/Source/cmLoadCommandCommand.h +++ b/Source/cmLoadCommandCommand.h @@ -42,31 +42,6 @@ public: */ virtual const char* GetName() const {return "load_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load a command into a running CMake."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " load_command(COMMAND_NAME <loc1> [loc2 ...])\n" - "The given locations are searched for a library whose name is " - "cmCOMMAND_NAME. If found, it is loaded as a module and the command " - "is added to the set of available CMake commands. Usually, " - "TRY_COMPILE is used before this command to compile the module. " - "If the command is successfully loaded a variable named\n" - " CMAKE_LOADED_COMMAND_<COMMAND_NAME>\n" - "will be set to the full path of the module that was loaded. " - "Otherwise the variable will not be set."; - } - cmTypeMacro(cmLoadCommandCommand, cmCommand); }; diff --git a/Source/cmLocalGenerator.cxx b/Source/cmLocalGenerator.cxx index afc04b9..3dde19f 100644 --- a/Source/cmLocalGenerator.cxx +++ b/Source/cmLocalGenerator.cxx @@ -37,7 +37,8 @@ #include <assert.h> #if defined(__HAIKU__) -#include <StorageKit.h> +#include <FindDirectory.h> +#include <StorageDefs.h> #endif cmLocalGenerator::cmLocalGenerator() @@ -349,16 +350,17 @@ void cmLocalGenerator::GenerateInstallRules() prefix = prefix_win32.c_str(); } #elif defined(__HAIKU__) + char dir[B_PATH_NAME_LENGTH]; if (!prefix) { - BPath dir; - if (find_directory(B_COMMON_DIRECTORY, &dir) == B_OK) + if (find_directory(B_SYSTEM_DIRECTORY, -1, false, dir, sizeof(dir)) + == B_OK) { - prefix = dir.Path(); + prefix = dir; } else { - prefix = "/boot/common"; + prefix = "/boot/system"; } } #else @@ -1251,6 +1253,12 @@ std::string cmLocalGenerator::GetIncludeFlags( sysIncludeFlag = this->Makefile->GetDefinition(sysFlagVar.c_str()); } + std::string fwSearchFlagVar = "CMAKE_"; + fwSearchFlagVar += lang; + fwSearchFlagVar += "_FRAMEWORK_SEARCH_FLAG"; + const char* fwSearchFlag = + this->Makefile->GetDefinition(fwSearchFlagVar.c_str()); + bool flagUsed = false; std::set<cmStdString> emitted; #ifdef __APPLE__ @@ -1259,7 +1267,7 @@ std::string cmLocalGenerator::GetIncludeFlags( std::vector<std::string>::const_iterator i; for(i = includes.begin(); i != includes.end(); ++i) { - if(this->Makefile->IsOn("APPLE") + if(fwSearchFlag && *fwSearchFlag && this->Makefile->IsOn("APPLE") && cmSystemTools::IsPathToFramework(i->c_str())) { std::string frameworkDir = *i; @@ -1269,8 +1277,8 @@ std::string cmLocalGenerator::GetIncludeFlags( { OutputFormat format = forResponseFile? RESPONSE : SHELL; includeFlags - << "-F" << this->Convert(frameworkDir.c_str(), - START_OUTPUT, format, true) + << fwSearchFlag << this->Convert(frameworkDir.c_str(), + START_OUTPUT, format, true) << " "; } continue; @@ -1768,13 +1776,21 @@ void cmLocalGenerator::OutputLinkLibraries(std::string& linkLibraries, } // Append the framework search path flags. - std::vector<std::string> const& fwDirs = cli.GetFrameworkPaths(); - for(std::vector<std::string>::const_iterator fdi = fwDirs.begin(); - fdi != fwDirs.end(); ++fdi) + std::string fwSearchFlagVar = "CMAKE_"; + fwSearchFlagVar += linkLanguage; + fwSearchFlagVar += "_FRAMEWORK_SEARCH_FLAG"; + const char* fwSearchFlag = + this->Makefile->GetDefinition(fwSearchFlagVar.c_str()); + if(fwSearchFlag && *fwSearchFlag) { - frameworkPath += "-F"; - frameworkPath += this->Convert(fdi->c_str(), NONE, SHELL, false); - frameworkPath += " "; + std::vector<std::string> const& fwDirs = cli.GetFrameworkPaths(); + for(std::vector<std::string>::const_iterator fdi = fwDirs.begin(); + fdi != fwDirs.end(); ++fdi) + { + frameworkPath += fwSearchFlag; + frameworkPath += this->Convert(fdi->c_str(), NONE, SHELL, false); + frameworkPath += " "; + } } // Append the library search path flags. @@ -1794,6 +1810,10 @@ void cmLocalGenerator::OutputLinkLibraries(std::string& linkLibraries, ItemVector const& items = cli.GetItems(); for(ItemVector::const_iterator li = items.begin(); li != items.end(); ++li) { + if(li->Target && li->Target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } if(li->IsPath) { linkLibs += this->ConvertToLinkReference(li->Value); @@ -1997,6 +2017,10 @@ bool cmLocalGenerator::GetRealDependency(const char* inName, // An object library has no single file on which to depend. // This was listed to get the target-level dependency. return false; + case cmTarget::INTERFACE_LIBRARY: + // An interface library has no file on which to depend. + // This was listed to get the target-level dependency. + return false; case cmTarget::UTILITY: case cmTarget::GLOBAL_TARGET: // A utility target has no file on which to depend. This was listed diff --git a/Source/cmLocalVisualStudio10Generator.cxx b/Source/cmLocalVisualStudio10Generator.cxx index c3789a0..aedd6ed 100644 --- a/Source/cmLocalVisualStudio10Generator.cxx +++ b/Source/cmLocalVisualStudio10Generator.cxx @@ -76,6 +76,10 @@ void cmLocalVisualStudio10Generator::Generate() cmTargets &tgts = this->Makefile->GetTargets(); for(cmTargets::iterator l = tgts.begin(); l != tgts.end(); ++l) { + if(l->second.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } if(static_cast<cmGlobalVisualStudioGenerator*>(this->GlobalGenerator) ->TargetIsFortranOnly(l->second)) { diff --git a/Source/cmLocalVisualStudio6Generator.cxx b/Source/cmLocalVisualStudio6Generator.cxx index f00a937..a665b93 100644 --- a/Source/cmLocalVisualStudio6Generator.cxx +++ b/Source/cmLocalVisualStudio6Generator.cxx @@ -91,6 +91,11 @@ void cmLocalVisualStudio6Generator::AddCMakeListsRules() for(cmTargets::iterator l = tgts.begin(); l != tgts.end(); l++) { + if (l->second.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } + // Add a rule to regenerate the build system when the target // specification source changes. const char* suppRegenRule = @@ -146,6 +151,8 @@ void cmLocalVisualStudio6Generator::OutputDSPFile() case cmTarget::GLOBAL_TARGET: this->SetBuildType(UTILITY, l->first.c_str(), l->second); break; + case cmTarget::INTERFACE_LIBRARY: + continue; default: cmSystemTools::Error("Bad target type: ", l->first.c_str()); break; @@ -1839,7 +1846,8 @@ void cmLocalVisualStudio6Generator options += this->ConvertToOptionallyRelativeOutputPath(l->Value.c_str()); } - else + else if (!l->Target + || l->Target->GetType() != cmTarget::INTERFACE_LIBRARY) { options += l->Value; } diff --git a/Source/cmLocalVisualStudio7Generator.cxx b/Source/cmLocalVisualStudio7Generator.cxx index bd6c860..64de448 100644 --- a/Source/cmLocalVisualStudio7Generator.cxx +++ b/Source/cmLocalVisualStudio7Generator.cxx @@ -78,6 +78,10 @@ void cmLocalVisualStudio7Generator::AddHelperCommands() static_cast<cmGlobalVisualStudio7Generator *>(this->GlobalGenerator); for(cmTargets::iterator l = tgts.begin(); l != tgts.end(); l++) { + if(l->second.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } const char* path = l->second.GetProperty("EXTERNAL_MSPROJECT"); if(path) { @@ -181,6 +185,10 @@ void cmLocalVisualStudio7Generator::WriteProjectFiles() for(cmTargets::iterator l = tgts.begin(); l != tgts.end(); l++) { + if(l->second.GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } // INCLUDE_EXTERNAL_MSPROJECT command only affects the workspace // so don't build a projectfile for it if(!l->second.GetProperty("EXTERNAL_MSPROJECT")) @@ -1258,6 +1266,7 @@ void cmLocalVisualStudio7Generator::OutputBuildTool(std::ostream& fout, } case cmTarget::UTILITY: case cmTarget::GLOBAL_TARGET: + case cmTarget::INTERFACE_LIBRARY: break; } } @@ -1288,7 +1297,8 @@ cmLocalVisualStudio7GeneratorInternals cmLocalGenerator::UNCHANGED); fout << lg->ConvertToXMLOutputPath(rel.c_str()) << " "; } - else + else if (!l->Target + || l->Target->GetType() != cmTarget::INTERFACE_LIBRARY) { fout << l->Value << " "; } diff --git a/Source/cmMacroCommand.cxx b/Source/cmMacroCommand.cxx index 8ba612c..fd6537f 100644 --- a/Source/cmMacroCommand.cxx +++ b/Source/cmMacroCommand.cxx @@ -67,24 +67,6 @@ public: */ virtual const char* GetName() const { return this->Args[0].c_str(); } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - std::string docs = "Macro named: "; - docs += this->GetName(); - return docs.c_str(); - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return this->GetTerseDocumentation(); - } - cmTypeMacro(cmMacroHelperCommand, cmCommand); std::vector<std::string> Args; diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h index aedbb4d..4c585d8 100644 --- a/Source/cmMacroCommand.h +++ b/Source/cmMacroCommand.h @@ -59,50 +59,6 @@ public: */ virtual const char* GetName() const { return "macro";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Start recording a macro for later invocation as a command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " macro(<name> [arg1 [arg2 [arg3 ...]]])\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endmacro(<name>)\n" - "Define a macro named <name> that takes arguments named " - "arg1 arg2 arg3 (...). Commands listed after macro, " - "but before the matching endmacro, are not invoked until the macro " - "is invoked. When it is invoked, the commands recorded in the " - "macro are first modified by replacing formal parameters (${arg1}) " - "with the arguments passed, and then invoked as normal commands. In " - "addition to referencing the formal parameters you can reference " - "the values ${ARGC} which will be set to the number of arguments " - "passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} " - "... which " - "will have the actual values of the arguments passed in. This " - "facilitates creating macros with optional arguments. Additionally " - "${ARGV} holds the list of all arguments given to the macro and " - "${ARGN} " - "holds the list of arguments past the last expected argument. " - "Note that the parameters to a macro and values such as ARGN " - "are not variables in the usual CMake sense. They are string " - "replacements much like the C preprocessor would do with a macro. " - "If you want true CMake variables and/or better CMake scope control " - "you should look at the function command." - "\n" - "See the cmake_policy() command documentation for the behavior of " - "policies inside macros." - ; - } cmTypeMacro(cmMacroCommand, cmCommand); }; diff --git a/Source/cmMakeDirectoryCommand.h b/Source/cmMakeDirectoryCommand.h index a0f866a..49a4009 100644 --- a/Source/cmMakeDirectoryCommand.h +++ b/Source/cmMakeDirectoryCommand.h @@ -51,26 +51,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the file(MAKE_DIRECTORY ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " make_directory(directory)\n" - "Creates the specified directory. Full paths should be given. Any " - "parent directories that do not exist will also be created. Use with " - "care."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmMakefile.cxx b/Source/cmMakefile.cxx index 34541e9..a390e06 100644 --- a/Source/cmMakefile.cxx +++ b/Source/cmMakefile.cxx @@ -21,9 +21,7 @@ #include "cmCacheManager.h" #include "cmFunctionBlocker.h" #include "cmListFileCache.h" -#include "cmDocumentGeneratorExpressions.h" #include "cmCommandArgumentParserHelper.h" -#include "cmDocumentCompileDefinitions.h" #include "cmGeneratorExpression.h" #include "cmTest.h" #ifdef CMAKE_BUILD_WITH_CMAKE @@ -1463,6 +1461,7 @@ void cmMakefile::AddLinkLibraryForTarget(const char *target, // if it is not a static or shared library then you can not link to it if(!((tgt->GetType() == cmTarget::STATIC_LIBRARY) || (tgt->GetType() == cmTarget::SHARED_LIBRARY) || + (tgt->GetType() == cmTarget::INTERFACE_LIBRARY) || tgt->IsExecutableWithExports())) { cmOStringStream e; @@ -1777,14 +1776,6 @@ void cmMakefile::AddDefinition(const char* name, const char* value) return; } -#ifdef CMAKE_STRICT - if (this->GetCMakeInstance()) - { - this->GetCMakeInstance()-> - RecordPropertyAccess(name,cmProperty::VARIABLE); - } -#endif - this->Internal->VarStack.top().Set(name, value); if (this->Internal->VarUsageStack.size() && this->VariableInitialized(name)) @@ -1990,6 +1981,7 @@ void cmMakefile::AddGlobalLinkInformation(const char* name, cmTarget& target) { case cmTarget::UTILITY: case cmTarget::GLOBAL_TARGET: + case cmTarget::INTERFACE_LIBRARY: return; default:; } @@ -2017,7 +2009,8 @@ cmTarget* cmMakefile::AddLibrary(const char* lname, cmTarget::TargetType type, if ( (type != cmTarget::STATIC_LIBRARY) && (type != cmTarget::SHARED_LIBRARY) && (type != cmTarget::MODULE_LIBRARY) - && (type != cmTarget::OBJECT_LIBRARY)) + && (type != cmTarget::OBJECT_LIBRARY) + && (type != cmTarget::INTERFACE_LIBRARY)) { this->IssueMessage(cmake::INTERNAL_ERROR, "cmMakefile::AddLibrary given invalid target type."); @@ -2445,13 +2438,6 @@ bool cmMakefile::IsDefinitionSet(const char* name) const const char* cmMakefile::GetDefinition(const char* name) const { -#ifdef CMAKE_STRICT - if (this->GetCMakeInstance()) - { - this->GetCMakeInstance()-> - RecordPropertyAccess(name,cmProperty::VARIABLE); - } -#endif if (this->WarnUnused) { this->Internal->VarUsageStack.top().insert(name); @@ -4036,243 +4022,14 @@ void cmMakefile::RaiseScope(const char *var, const char *varDef) void cmMakefile::DefineProperties(cmake *cm) { cm->DefineProperty - ("ADDITIONAL_MAKE_CLEAN_FILES", cmProperty::DIRECTORY, - "Additional files to clean during the make clean stage.", - "A list of files that will be cleaned as a part of the " - "\"make clean\" stage. "); - - cm->DefineProperty - ("CLEAN_NO_CUSTOM", cmProperty::DIRECTORY, - "Should the output of custom commands be left.", - "If this is true then the outputs of custom commands for this " - "directory will not be removed during the \"make clean\" stage. "); - - cm->DefineProperty - ("LISTFILE_STACK", cmProperty::DIRECTORY, - "The current stack of listfiles being processed.", - "This property is mainly useful when trying to debug errors " - "in your CMake scripts. It returns a list of what list files " - "are currently being processed, in order. So if one listfile " - "does an INCLUDE command then that is effectively pushing " - "the included listfile onto the stack.", false); - - cm->DefineProperty - ("TEST_INCLUDE_FILE", cmProperty::DIRECTORY, - "A cmake file that will be included when ctest is run.", - "If you specify TEST_INCLUDE_FILE, that file will be " - "included and processed when ctest is run on the directory."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::DIRECTORY, - "Preprocessor definitions for compiling a directory's sources.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\"). " - "This property will be initialized in each directory by its value " - "in the directory's parent.\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does).\n" - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::DIRECTORY, - "Per-configuration preprocessor definitions in a directory.", - "This is the configuration-specific version of COMPILE_DEFINITIONS. " - "This property will be initialized in each directory by its value " - "in the directory's parent.\n"); - - cm->DefineProperty - ("IMPLICIT_DEPENDS_INCLUDE_TRANSFORM", cmProperty::DIRECTORY, - "Specify #include line transforms for dependencies in a directory.", - "This property specifies rules to transform macro-like #include lines " - "during implicit dependency scanning of C and C++ source files. " - "The list of rules must be semicolon-separated with each entry of " - "the form \"A_MACRO(%)=value-with-%\" (the % must be literal). " - "During dependency scanning occurrences of A_MACRO(...) on #include " - "lines will be replaced by the value given with the macro argument " - "substituted for '%'. For example, the entry\n" - " MYDIR(%)=<mydir/%>\n" - "will convert lines of the form\n" - " #include MYDIR(myheader.h)\n" - "to\n" - " #include <mydir/myheader.h>\n" - "allowing the dependency to be followed.\n" - "This property applies to sources in all targets within a directory. " - "The property value is initialized in each directory by its value " - "in the directory's parent."); - - cm->DefineProperty - ("EXCLUDE_FROM_ALL", cmProperty::DIRECTORY, - "Exclude the directory from the all target of its parent.", - "A property on a directory that indicates if its targets are excluded " - "from the default build target. If it is not, then with a Makefile " - "for example typing make will cause the targets to be built. " - "The same concept applies to the default build of other generators.", - false); - - cm->DefineProperty - ("PARENT_DIRECTORY", cmProperty::DIRECTORY, - "Source directory that added current subdirectory.", - "This read-only property specifies the source directory that " - "added the current source directory as a subdirectory of the build. " - "In the top-level directory the value is the empty-string.", false); - - cm->DefineProperty - ("INCLUDE_REGULAR_EXPRESSION", cmProperty::DIRECTORY, - "Include file scanning regular expression.", - "This read-only property specifies the regular expression used " - "during dependency scanning to match include files that should " - "be followed. See the include_regular_expression command.", false); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION", cmProperty::DIRECTORY, - "Enable interprocedural optimization for targets in a directory.", - "If set to true, enables interprocedural optimizations " - "if they are known to be supported by the compiler."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION_<CONFIG>", cmProperty::DIRECTORY, - "Per-configuration interprocedural optimization for a directory.", - "This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. " - "If set, this property overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("VARIABLES", cmProperty::DIRECTORY, - "List of variables defined in the current directory.", - "This read-only property specifies the list of CMake variables " - "currently defined. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty - ("CACHE_VARIABLES", cmProperty::DIRECTORY, - "List of cache variables available in the current directory.", - "This read-only property specifies the list of CMake cache " - "variables currently defined. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty - ("MACROS", cmProperty::DIRECTORY, - "List of macro commands available in the current directory.", - "This read-only property specifies the list of CMake macros " - "currently defined. " - "It is intended for debugging purposes. " - "See the macro command.", false); - - cm->DefineProperty - ("DEFINITIONS", cmProperty::DIRECTORY, - "For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead.", - "This read-only property specifies the list of flags given so far " - "to the add_definitions command. " - "It is intended for debugging purposes. " - "Use the COMPILE_DEFINITIONS instead.", false); - - cm->DefineProperty - ("INCLUDE_DIRECTORIES", cmProperty::DIRECTORY, - "List of preprocessor include file search directories.", - "This property specifies the list of directories given " - "so far to the include_directories command. " - "This property exists on directories and targets. " - "In addition to accepting values from the include_directories " - "command, values may be set directly on any directory or any " - "target using the set_property command. " - "A target gets its initial value for this property from the value " - "of the directory property. " - "A directory gets its initial value from its parent directory if " - "it has one. " - "Both directory and target property values are adjusted by calls " - "to the include_directories command." - "\n" - "The target property values are used by the generators to set " - "the include paths for the compiler. " - "See also the include_directories command."); - - cm->DefineProperty - ("COMPILE_OPTIONS", cmProperty::DIRECTORY, - "List of options to pass to the compiler.", - "This property specifies the list of directories given " - "so far for this property. " - "This property exists on directories and targets." - "\n" - "The target property values are used by the generators to set " - "the options for the compiler.\n" - "Contents of COMPILE_OPTIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("LINK_DIRECTORIES", cmProperty::DIRECTORY, - "List of linker search directories.", - "This read-only property specifies the list of directories given " - "so far to the link_directories command. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty ("RULE_LAUNCH_COMPILE", cmProperty::DIRECTORY, - "Specify a launcher for compile rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_LINK", cmProperty::DIRECTORY, - "Specify a launcher for link rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_CUSTOM", cmProperty::DIRECTORY, - "Specify a launcher for custom rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); - - cm->DefineProperty - ("VS_GLOBAL_SECTION_PRE_<section>", cmProperty::DIRECTORY, - "Specify a preSolution global section in Visual Studio.", - "Setting a property like this generates an entry of the following form " - "in the solution file:\n" - " GlobalSection(<section>) = preSolution\n" - " <contents based on property value>\n" - " EndGlobalSection\n" - "The property must be set to a semicolon-separated list of key=value " - "pairs. Each such pair will be transformed into an entry in the solution " - "global section. Whitespace around key and value is ignored. List " - "elements which do not contain an equal sign are skipped." - "\n" - "This property only works for Visual Studio 7 and above; it is ignored " - "on other generators. The property only applies when set on a directory " - "whose CMakeLists.txt contains a project() command."); - cm->DefineProperty - ("VS_GLOBAL_SECTION_POST_<section>", cmProperty::DIRECTORY, - "Specify a postSolution global section in Visual Studio.", - "Setting a property like this generates an entry of the following form " - "in the solution file:\n" - " GlobalSection(<section>) = postSolution\n" - " <contents based on property value>\n" - " EndGlobalSection\n" - "The property must be set to a semicolon-separated list of key=value " - "pairs. Each such pair will be transformed into an entry in the solution " - "global section. Whitespace around key and value is ignored. List " - "elements which do not contain an equal sign are skipped." - "\n" - "This property only works for Visual Studio 7 and above; it is ignored " - "on other generators. The property only applies when set on a directory " - "whose CMakeLists.txt contains a project() command." - "\n" - "Note that CMake generates postSolution sections ExtensibilityGlobals " - "and ExtensibilityAddIns by default. If you set the corresponding " - "property, it will override the default section. For example, setting " - "VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default " - "contents of the ExtensibilityGlobals section, while keeping " - "ExtensibilityAddIns on its default."); + "", "", true); } //---------------------------------------------------------------------------- diff --git a/Source/cmMakefile.h b/Source/cmMakefile.h index 8bce9fd..ca82336 100644 --- a/Source/cmMakefile.h +++ b/Source/cmMakefile.h @@ -1041,7 +1041,6 @@ private: void EnforceDirectoryLevelRules(); bool GeneratingBuildSystem; - /** * Old version of GetSourceFileWithOutput(const char*) kept for * backward-compatibility. It implements a linear search and support diff --git a/Source/cmMakefileTargetGenerator.cxx b/Source/cmMakefileTargetGenerator.cxx index 33974ae..9ca9149 100644 --- a/Source/cmMakefileTargetGenerator.cxx +++ b/Source/cmMakefileTargetGenerator.cxx @@ -291,7 +291,7 @@ std::string cmMakefileTargetGenerator::GetFlags(const std::string &l) // Add include directory flags. this->LocalGenerator-> - AppendFlags(flags,this->GetFrameworkFlags().c_str()); + AppendFlags(flags,this->GetFrameworkFlags(l).c_str()); // Add target-specific flags. this->LocalGenerator->AddCompileOptions(flags, this->Target, @@ -1004,7 +1004,12 @@ void cmMakefileTargetGenerator::WriteTargetDependRules() i = items.begin(); i != items.end(); ++i) { cmTarget const* linkee = i->Target; - if(linkee && !linkee->IsImported() && emitted.insert(linkee).second) + if(linkee && !linkee->IsImported() + // We can ignore the INTERFACE_LIBRARY items because + // Target->GetLinkInformation already processed their + // link interface and they don't have any output themselves. + && linkee->GetType() != cmTarget::INTERFACE_LIBRARY + && emitted.insert(linkee).second) { cmMakefile* mf = linkee->GetMakefile(); cmLocalGenerator* lg = mf->GetLocalGenerator(); @@ -1513,13 +1518,21 @@ void cmMakefileTargetGenerator::WriteTargetDriverRule(const char* main_output, } //---------------------------------------------------------------------------- -std::string cmMakefileTargetGenerator::GetFrameworkFlags() +std::string cmMakefileTargetGenerator::GetFrameworkFlags(std::string const& l) { if(!this->Makefile->IsOn("APPLE")) { return std::string(); } + std::string fwSearchFlagVar = "CMAKE_" + l + "_FRAMEWORK_SEARCH_FLAG"; + const char* fwSearchFlag = + this->Makefile->GetDefinition(fwSearchFlagVar.c_str()); + if(!(fwSearchFlag && *fwSearchFlag)) + { + return std::string(); + } + std::set<cmStdString> emitted; #ifdef __APPLE__ /* don't insert this when crosscompiling e.g. to iphone */ emitted.insert("/System/Library/Frameworks"); @@ -1554,7 +1567,7 @@ std::string cmMakefileTargetGenerator::GetFrameworkFlags() { if(emitted.insert(*i).second) { - flags += "-F"; + flags += fwSearchFlag; flags += this->Convert(i->c_str(), cmLocalGenerator::START_OUTPUT, cmLocalGenerator::SHELL, true); diff --git a/Source/cmMakefileTargetGenerator.h b/Source/cmMakefileTargetGenerator.h index f7a1e2e..ec2af1c 100644 --- a/Source/cmMakefileTargetGenerator.h +++ b/Source/cmMakefileTargetGenerator.h @@ -124,7 +124,7 @@ protected: void DriveCustomCommands(std::vector<std::string>& depends); // Return the a string with -F flags on apple - std::string GetFrameworkFlags(); + std::string GetFrameworkFlags(std::string const& l); void AppendFortranFormatFlags(std::string& flags, cmSourceFile& source); diff --git a/Source/cmMarkAsAdvancedCommand.h b/Source/cmMarkAsAdvancedCommand.h index adfc553..b65e4a8 100644 --- a/Source/cmMarkAsAdvancedCommand.h +++ b/Source/cmMarkAsAdvancedCommand.h @@ -43,33 +43,6 @@ public: virtual const char* GetName() const {return "mark_as_advanced";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Mark cmake cached variables as advanced."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " mark_as_advanced([CLEAR|FORCE] VAR [VAR2 ...])\n" - "Mark the named cached variables as advanced. An advanced variable " - "will not be displayed in any of the cmake GUIs unless the show " - "advanced option is on. " - "If CLEAR is the first argument advanced variables are changed back " - "to unadvanced. " - "If FORCE is the first argument, then the variable is made advanced. " - "If neither FORCE nor CLEAR is specified, new values will be marked as " - "advanced, but if the variable already has an advanced/non-advanced " - "state, it will not be changed.\n" - "It does nothing in script mode."; - } - - /** * This determines if the command is invoked when in script mode. * mark_as_advanced() will have no effect in script mode, but this will * make many of the modules usable in cmake/ctest scripts, (among them diff --git a/Source/cmMathCommand.h b/Source/cmMathCommand.h index dc0ceb3..c826ef1 100644 --- a/Source/cmMathCommand.h +++ b/Source/cmMathCommand.h @@ -43,28 +43,6 @@ public: */ virtual const char* GetName() const { return "math";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Mathematical expressions."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " math(EXPR <output variable> <math expression>)\n" - "EXPR evaluates mathematical expression and returns result in the " - "output variable. Example mathematical expression is " - "'5 * ( 10 + 13 )'. Supported operators are " - "+ - * / % | & ^ ~ << >> * / %. They have the same meaning " - " as they do in C code."; - } - cmTypeMacro(cmMathCommand, cmCommand); protected: diff --git a/Source/cmMessageCommand.cxx b/Source/cmMessageCommand.cxx index e1dbf34..d85e720 100644 --- a/Source/cmMessageCommand.cxx +++ b/Source/cmMessageCommand.cxx @@ -52,6 +52,23 @@ bool cmMessageCommand status = true; ++i; } + else if (*i == "DEPRECATION") + { + if (this->Makefile->IsOn("CMAKE_ERROR_DEPRECATED")) + { + fatal = true; + type = cmake::DEPRECATION_ERROR; + } + else if (this->Makefile->IsOn("CMAKE_WARN_DEPRECATED")) + { + type = cmake::DEPRECATION_WARNING; + } + else + { + return true; + } + ++i; + } for(;i != args.end(); ++i) { diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h index fc61810..fec9a32 100644 --- a/Source/cmMessageCommand.h +++ b/Source/cmMessageCommand.h @@ -46,45 +46,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Display a message to the user."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR]\n" - " \"message to display\" ...)\n" - "The optional keyword determines the type of message:\n" - " (none) = Important information\n" - " STATUS = Incidental information\n" - " WARNING = CMake Warning, continue processing\n" - " AUTHOR_WARNING = CMake Warning (dev), continue processing\n" - " SEND_ERROR = CMake Error, continue processing,\n" - " but skip generation\n" - " FATAL_ERROR = CMake Error, stop processing and generation\n" - "The CMake command-line tool displays STATUS messages on stdout " - "and all other message types on stderr. " - "The CMake GUI displays all messages in its log area. " - "The interactive dialogs (ccmake and CMakeSetup) show STATUS messages " - "one at a time on a status line and other messages in interactive " - "pop-up boxes." - "\n" - "CMake Warning and Error message text displays using a simple " - "markup language. " - "Non-indented text is formatted in line-wrapped paragraphs delimited " - "by newlines. " - "Indented text is considered pre-formatted." - ; - } - cmTypeMacro(cmMessageCommand, cmCommand); }; diff --git a/Source/cmNewLineStyle.cxx b/Source/cmNewLineStyle.cxx index 6f7b6a9..a7d7429 100644 --- a/Source/cmNewLineStyle.cxx +++ b/Source/cmNewLineStyle.cxx @@ -78,7 +78,7 @@ const std::string cmNewLineStyle::GetCharacters() const return "\r\n"; default: ; - }; + } return ""; } diff --git a/Source/cmOptionCommand.h b/Source/cmOptionCommand.h index 7d02400..89e3ac1 100644 --- a/Source/cmOptionCommand.h +++ b/Source/cmOptionCommand.h @@ -43,29 +43,6 @@ public: virtual const char* GetName() const {return "option";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Provides an option that the user can optionally select."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " option(<option_variable> \"help string describing option\"\n" - " [initial value])\n" - "Provide an option for the user to select as ON or OFF. If no " - "initial value is provided, OFF is used.\n" - "If you have options that depend on the values of other " - "options, see the module help for CMakeDependentOption." - ; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmOutputRequiredFilesCommand.h b/Source/cmOutputRequiredFilesCommand.h index 1d7e394..d43b229 100644 --- a/Source/cmOutputRequiredFilesCommand.h +++ b/Source/cmOutputRequiredFilesCommand.h @@ -42,30 +42,6 @@ public: */ virtual const char* GetName() const { return "output_required_files";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Approximate C preprocessor dependency scanning."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command exists only because ancient CMake versions provided it. " - "CMake handles preprocessor dependency scanning automatically using a " - "more advanced scanner.\n" - " output_required_files(srcfile outputfile)\n" - "Outputs a list of all the source files that are required by the " - "specified srcfile. This list is written into outputfile. This is " - "similar to writing out the dependencies for srcfile except that it " - "jumps from .h files into .cxx, .c and .cpp files if possible."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmPolicies.cxx b/Source/cmPolicies.cxx index f9197e0..6ede28b 100644 --- a/Source/cmPolicies.cxx +++ b/Source/cmPolicies.cxx @@ -601,6 +601,64 @@ cmPolicies::cmPolicies() "The NEW behavior for this policy is to not to allow mixing of the " "keyword and plain signatures.", 2,8,12,0, cmPolicies::WARN); + + this->DefinePolicy( + CMP0024, "CMP0024", + "Disallow include export result.", + "CMake 2.8.12 and lower allowed use of the include() command with the " + "result of the export() command. This relies on the assumption that " + "the export() command has an immediate effect at configure-time during a " + "cmake run. Certain properties of targets are not fully determined " + "until later at generate-time, such as the link language and complete " + "list of link libraries. Future refactoring will change the effect of " + "the export() command to be executed at generate-time. Use ALIAS " + "targets instead in cases where the goal is to refer to targets by " + "another name" + "\n" + "The OLD behavior for this policy is to allow including the result " + "of an export() command. " + "The NEW behavior for this policy is to not to allow including the " + "result of an export() command.", + 2,8,13,0, cmPolicies::WARN); + + this->DefinePolicy( + CMP0025, "CMP0025", + "Compiler id for Apple Clang is now AppleClang.", + "CMake >= 2.8.13 recognize that Apple Clang is a different compiler " + "than upstream Clang and that they have different version numbers. " + "CMake now prefers to present this to projects by setting " + "CMAKE_<LANG>_COMPILER_ID to \"AppleClang\" instead of \"Clang\". " + "However, existing projects may assume the compiler id for Apple Clang " + "is just \"Clang\" as it was in CMake < 2.8.13. " + "Therefore this policy determines for Apple Clang which compiler id " + "to report in CMAKE_<LANG>_COMPILER_ID after <LANG> is enabled by " + "the project() or enable_language() command." + "\n" + "The OLD behavior for this policy is to use compiler id \"Clang\". " + "The NEW behavior for this policy is to use compiler id \"AppleClang\".", + 2,8,13,0, cmPolicies::WARN); + + this->DefinePolicy( + CMP0026, "CMP0026", + "Disallow use of the LOCATION target property.", + "CMake 2.8.12 and lower allowed reading the LOCATION target property to " + "determine the eventual location of build targets. This relies on the " + "assumption that all necessary information is available at " + "configure-time to determine the final location and filename of the " + "target. However, this property is not fully determined until later at " + "generate-time. At generate time, the $<TARGET_FILE> generator " + "expression can be used to determine the eventual LOCATION of a target " + "output." + "\n" + "Code which reads the LOCATION target property can be ported to use the " + "$<TARGET_FILE> generator expression together with the file(GENERATE) " + "subcommand to generate a file containing the target location." + "\n" + "The OLD behavior for this policy is to allow reading the LOCATION " + "property from build-targets. " + "The NEW behavior for this policy is to not to allow reading the " + "LOCATION property from build-targets.", + 2,8,13,0, cmPolicies::WARN); } cmPolicies::~cmPolicies() @@ -877,52 +935,6 @@ cmPolicies::GetPolicyStatus(cmPolicies::PolicyID id) return pos->second->Status; } -void cmPolicies::GetDocumentation(std::vector<cmDocumentationEntry>& v) -{ - // now loop over all the policies and set them as appropriate - std::map<cmPolicies::PolicyID,cmPolicy *>::iterator i - = this->Policies.begin(); - for (;i != this->Policies.end(); ++i) - { - cmOStringStream full; - full << i->second->LongDescription; - full << "\nThis policy was introduced in CMake version "; - full << i->second->GetVersionString() << "."; - if(i->first != cmPolicies::CMP0000) - { - full << " " - << "CMake version " << cmVersion::GetCMakeVersion() << " "; - // add in some more text here based on status - switch (i->second->Status) - { - case cmPolicies::WARN: - full << "warns when the policy is not set and uses OLD behavior. " - << "Use the cmake_policy command to set it to OLD or NEW " - << "explicitly."; - break; - case cmPolicies::OLD: - full << "defaults to the OLD behavior for this policy."; - break; - case cmPolicies::NEW: - full << "defaults to the NEW behavior for this policy."; - break; - case cmPolicies::REQUIRED_IF_USED: - full << "requires the policy to be set to NEW if you use it. " - << "Use the cmake_policy command to set it to NEW."; - break; - case cmPolicies::REQUIRED_ALWAYS: - full << "requires the policy to be set to NEW. " - << "Use the cmake_policy command to set it to NEW."; - break; - } - } - cmDocumentationEntry e(i->second->IDString.c_str(), - i->second->ShortDescription.c_str(), - full.str().c_str()); - v.push_back(e); - } -} - //---------------------------------------------------------------------------- std::string cmPolicies::GetRequiredAlwaysPolicyError(cmPolicies::PolicyID id) diff --git a/Source/cmPolicies.h b/Source/cmPolicies.h index 5b843a9..a9d1b49 100644 --- a/Source/cmPolicies.h +++ b/Source/cmPolicies.h @@ -74,6 +74,9 @@ public: /// target property CMP0022, ///< INTERFACE_LINK_LIBRARIES defines the link interface CMP0023, ///< Disallow mixing keyword and plain tll signatures + CMP0024, ///< Disallow including export() result. + CMP0025, ///< Compiler id for Apple Clang is now AppleClang + CMP0026, ///< Disallow use of the LOCATION target property. /** \brief Always the last entry. * @@ -113,9 +116,6 @@ public: ///! return an error string for when a required policy is unspecified std::string GetRequiredAlwaysPolicyError(cmPolicies::PolicyID id); - ///! Get docs for policies - void GetDocumentation(std::vector<cmDocumentationEntry>& v); - /** Represent a set of policy values. */ typedef std::map<PolicyID, PolicyStatus> PolicyMap; diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h index 9547c4c..f7d086d 100644 --- a/Source/cmProjectCommand.h +++ b/Source/cmProjectCommand.h @@ -45,41 +45,6 @@ public: */ virtual const char* GetName() const {return "project";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a name for the entire project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " project(<projectname> [languageName1 languageName2 ... ] )\n" - "Sets the name of the project. " - "Additionally this sets the variables <projectName>_BINARY_DIR and " - "<projectName>_SOURCE_DIR to the respective values.\n" - "Optionally you can specify which languages your project supports. " - "Example languages are CXX (i.e. C++), C, Fortran, etc. " - "By default C and CXX are enabled. E.g. if you do not have a " - "C++ compiler, you can disable the check for it by explicitly listing " - "the languages you want to support, e.g. C. By using the special " - "language \"NONE\" all checks for any language can be disabled. " - "If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, " - "the file pointed to by that variable will be included as the last step " - "of the project command." - "\n" - "The top-level CMakeLists.txt file for a project must contain a " - "literal, direct call to the project() command; loading one through " - "the include() command is not sufficient. " - "If no such call exists CMake will implicitly add one to the top that " - "enables the default languages (C and CXX)."; - } - cmTypeMacro(cmProjectCommand, cmCommand); }; diff --git a/Source/cmPropertyDefinition.cxx b/Source/cmPropertyDefinition.cxx index b80c863..abc57ce 100644 --- a/Source/cmPropertyDefinition.cxx +++ b/Source/cmPropertyDefinition.cxx @@ -12,20 +12,10 @@ #include "cmPropertyDefinition.h" #include "cmSystemTools.h" -cmDocumentationEntry cmPropertyDefinition::GetDocumentation() const -{ - cmDocumentationEntry e; - e.Name = this->Name; - e.Brief = this->ShortDescription; - e.Full = this->FullDescription; - return e; -} - void cmPropertyDefinition ::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *shortDescription, const char *fullDescription, - const char *sec, bool chain) { this->Name = name; @@ -39,9 +29,5 @@ void cmPropertyDefinition { this->FullDescription = fullDescription; } - if (sec) - { - this->DocumentationSection = sec; - } } diff --git a/Source/cmPropertyDefinition.h b/Source/cmPropertyDefinition.h index 296366d..1b6a7a6 100644 --- a/Source/cmPropertyDefinition.h +++ b/Source/cmPropertyDefinition.h @@ -30,22 +30,14 @@ public: void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentationSection, bool chained); - /// Get the documentation string - cmDocumentationEntry GetDocumentation() const; - /// Default constructor cmPropertyDefinition() { this->Chained = false; }; /// Is the property chained? bool IsChained() const { return this->Chained; }; - /// Get the section if any - const std::string &GetDocumentationSection() const { - return this->DocumentationSection; }; - /// Get the scope cmProperty::ScopeType GetScope() const { return this->Scope; }; @@ -62,7 +54,6 @@ protected: std::string Name; std::string ShortDescription; std::string FullDescription; - std::string DocumentationSection; cmProperty::ScopeType Scope; bool Chained; }; diff --git a/Source/cmPropertyDefinitionMap.cxx b/Source/cmPropertyDefinitionMap.cxx index 20fa07c..db29504 100644 --- a/Source/cmPropertyDefinitionMap.cxx +++ b/Source/cmPropertyDefinitionMap.cxx @@ -17,7 +17,6 @@ void cmPropertyDefinitionMap ::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentationSection, bool chain) { if (!name) @@ -31,64 +30,7 @@ void cmPropertyDefinitionMap { prop = &(*this)[name]; prop->DefineProperty(name,scope,ShortDescription, FullDescription, - DocumentationSection, chain); - } -} - -void cmPropertyDefinitionMap -::GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>& v) const -{ - for(cmPropertyDefinitionMap::const_iterator j = this->begin(); - j != this->end(); ++j) - { - // add a section if needed - std::string secName = j->second.GetDocumentationSection(); - // if a section was not specified then use the scope - if (!secName.size()) - { - switch (j->second.GetScope()) - { - case cmProperty::GLOBAL: - secName = "Properties of Global Scope"; - break; - case cmProperty::TARGET: - secName = "Properties on Targets"; - break; - case cmProperty::SOURCE_FILE: - secName = "Properties on Source Files"; - break; - case cmProperty::DIRECTORY: - secName = "Properties on Directories"; - break; - case cmProperty::TEST: - secName = "Properties on Tests"; - break; - case cmProperty::CACHE: - secName = "Properties on Cache Entries"; - break; - case cmProperty::VARIABLE: - secName = "Variables"; - break; - case cmProperty::CACHED_VARIABLE: - secName = "Cached Variables"; - break; - default: - secName = "Properties of Unknown Scope"; - break; - } - } - if (!v[secName]) - { - v[secName] = new - cmDocumentationSection(secName.c_str(), - cmSystemTools::UpperCase(secName).c_str()); - } - cmDocumentationEntry e = j->second.GetDocumentation(); - if (e.Brief.size() || e.Full.size()) - { - v[secName]->Append(e); - } + chain); } } diff --git a/Source/cmPropertyDefinitionMap.h b/Source/cmPropertyDefinitionMap.h index 007e265..736e243 100644 --- a/Source/cmPropertyDefinitionMap.h +++ b/Source/cmPropertyDefinitionMap.h @@ -24,7 +24,6 @@ public: void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentaitonSection, bool chain); // has a named property been defined @@ -32,9 +31,6 @@ public: // is a named property set to chain bool IsPropertyChained(const char *name); - - void GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>&) const; }; #endif diff --git a/Source/cmPropertyMap.cxx b/Source/cmPropertyMap.cxx index 78f378a..e94e3e9 100644 --- a/Source/cmPropertyMap.cxx +++ b/Source/cmPropertyMap.cxx @@ -40,19 +40,7 @@ void cmPropertyMap::SetProperty(const char *name, const char *value, this->erase(name); return; } -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#else (void)scope; -#endif cmProperty *prop = this->GetOrCreateProperty(name); prop->Set(name,value); @@ -66,19 +54,7 @@ void cmPropertyMap::AppendProperty(const char* name, const char* value, { return; } -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#else (void)scope; -#endif cmProperty *prop = this->GetOrCreateProperty(name); prop->Append(name,value,asString); @@ -95,19 +71,6 @@ const char *cmPropertyMap return 0; } - // has the property been defined? -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#endif - cmPropertyMap::const_iterator it = this->find(name); if (it == this->end()) { diff --git a/Source/cmQTWrapCPPCommand.h b/Source/cmQTWrapCPPCommand.h index 4863402..868eb91 100644 --- a/Source/cmQTWrapCPPCommand.h +++ b/Source/cmQTWrapCPPCommand.h @@ -46,27 +46,6 @@ public: * The name of the command as specified in CMakeList.txt. */ virtual const char* GetName() const { return "qt_wrap_cpp";} - - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create Qt Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " qt_wrap_cpp(resultingLibraryName DestName\n" - " SourceLists ...)\n" - "Produce moc files for all the .h files listed in the SourceLists. " - "The moc files will be added to the library using the DestName " - "source list."; - } }; diff --git a/Source/cmQTWrapUICommand.h b/Source/cmQTWrapUICommand.h index b15c5cd..3406dac 100644 --- a/Source/cmQTWrapUICommand.h +++ b/Source/cmQTWrapUICommand.h @@ -44,30 +44,6 @@ public: * The name of the command as specified in CMakeList.txt. */ virtual const char* GetName() const { return "qt_wrap_ui";} - - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create Qt user interfaces Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " qt_wrap_ui(resultingLibraryName HeadersDestName\n" - " SourcesDestName SourceLists ...)\n" - "Produce .h and .cxx files for all the .ui files listed " - "in the SourceLists. " - "The .h files will be added to the library using the HeadersDestName" - "source list. " - "The .cxx files will be added to the library using the SourcesDestName" - "source list."; - } }; diff --git a/Source/cmRST.cxx b/Source/cmRST.cxx new file mode 100644 index 0000000..72c42d6 --- /dev/null +++ b/Source/cmRST.cxx @@ -0,0 +1,435 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#include "cmRST.h" + +#include "cmSystemTools.h" + +#include <ctype.h> + +//---------------------------------------------------------------------------- +cmRST::cmRST(std::ostream& os, std::string const& docroot): + OS(os), + DocRoot(docroot), + IncludeDepth(0), + OutputLinePending(false), + Markup(MarkupNone), + Directive(DirectiveNone), + CMakeDirective("^.. (cmake:)?(" + "command|variable" + ")::[ \t]+([^ \t\n]+)$"), + CMakeModuleDirective("^.. cmake-module::[ \t]+([^ \t\n]+)$"), + ParsedLiteralDirective("^.. parsed-literal::[ \t]*(.*)$"), + CodeBlockDirective("^.. code-block::[ \t]*(.*)$"), + ReplaceDirective("^.. (\\|[^|]+\\|) replace::[ \t]*(.*)$"), + IncludeDirective("^.. include::[ \t]+([^ \t\n]+)$"), + TocTreeDirective("^.. toctree::[ \t]*(.*)$"), + CMakeRole("(:cmake)?:(" + "command|generator|variable|module|policy|" + "prop_cache|prop_dir|prop_gbl|prop_sf|prop_test|prop_tgt|" + "manual" + "):`(<*([^`<]|[^` \t]<)*)([ \t]+<[^`]*>)?`"), + Substitution("(^|[^A-Za-z0-9_])" + "((\\|[^| \t\r\n]([^|\r\n]*[^| \t\r\n])?\\|)(__|_|))" + "([^A-Za-z0-9_]|$)") +{ +} + +//---------------------------------------------------------------------------- +bool cmRST::ProcessFile(std::string const& fname, bool isModule) +{ + std::ifstream fin(fname.c_str()); + if(fin) + { + this->DocDir = cmSystemTools::GetFilenamePath(fname); + if(isModule) + { + this->ProcessModule(fin); + } + else + { + this->ProcessRST(fin); + } + this->OutputLinePending = true; + return true; + } + return false; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessRST(std::istream& is) +{ + std::string line; + while(cmSystemTools::GetLineFromStream(is, line)) + { + this->ProcessLine(line); + } + this->Reset(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessModule(std::istream& is) +{ + std::string line; + std::string rst; + while(cmSystemTools::GetLineFromStream(is, line)) + { + if(rst == "#") + { + if(line == "#") + { + this->ProcessLine(""); + continue; + } + else if(line.substr(0, 2) == "# ") + { + this->ProcessLine(line.substr(2, line.npos)); + continue; + } + else + { + rst = ""; + this->Reset(); + this->OutputLinePending = true; + } + } + if(line == "#.rst:") + { + rst = "#"; + } + } + if(rst == "#") + { + this->Reset(); + } +} + +//---------------------------------------------------------------------------- +void cmRST::Reset() +{ + if(!this->MarkupLines.empty()) + { + this->UnindentLines(this->MarkupLines); + } + switch(this->Directive) + { + case DirectiveNone: break; + case DirectiveParsedLiteral: this->ProcessDirectiveParsedLiteral(); break; + case DirectiveCodeBlock: this->ProcessDirectiveCodeBlock(); break; + case DirectiveReplace: this->ProcessDirectiveReplace(); break; + case DirectiveTocTree: this->ProcessDirectiveTocTree(); break; + } + this->Markup = MarkupNone; + this->Directive = DirectiveNone; + this->MarkupLines.clear(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessLine(std::string const& line) +{ + // A line starting in .. is an explicit markup start. + if(line == ".." || (line.size() >= 3 && line[0] == '.' && + line[1] == '.' && isspace(line[2]))) + { + this->Reset(); + this->Markup = (line.find_first_not_of(" \t", 2) == line.npos ? + MarkupEmpty : MarkupNormal); + if(this->CMakeDirective.find(line)) + { + // Output cmake domain directives and their content normally. + this->NormalLine(line); + } + else if(this->CMakeModuleDirective.find(line)) + { + // Process cmake-module directive: scan .cmake file comments. + std::string file = this->CMakeModuleDirective.match(1); + if(file.empty() || !this->ProcessInclude(file, IncludeModule)) + { + this->NormalLine(line); + } + } + else if(this->ParsedLiteralDirective.find(line)) + { + // Record the literal lines to output after whole block. + this->Directive = DirectiveParsedLiteral; + this->MarkupLines.push_back(this->ParsedLiteralDirective.match(1)); + } + else if(this->CodeBlockDirective.find(line)) + { + // Record the literal lines to output after whole block. + // Ignore the language spec and record the opening line as blank. + this->Directive = DirectiveCodeBlock; + this->MarkupLines.push_back(""); + } + else if(this->ReplaceDirective.find(line)) + { + // Record the replace directive content. + this->Directive = DirectiveReplace; + this->ReplaceName = this->ReplaceDirective.match(1); + this->MarkupLines.push_back(this->ReplaceDirective.match(2)); + } + else if(this->IncludeDirective.find(line)) + { + // Process the include directive or output the directive and its + // content normally if it fails. + std::string file = this->IncludeDirective.match(1); + if(file.empty() || !this->ProcessInclude(file, IncludeNormal)) + { + this->NormalLine(line); + } + } + else if(this->TocTreeDirective.find(line)) + { + // Record the toctree entries to process after whole block. + this->Directive = DirectiveTocTree; + this->MarkupLines.push_back(this->TocTreeDirective.match(1)); + } + } + // An explicit markup start followed nothing but whitespace and a + // blank line does not consume any indented text following. + else if(this->Markup == MarkupEmpty && line.empty()) + { + this->NormalLine(line); + } + // Indented lines following an explicit markup start are explicit markup. + else if(this->Markup && (line.empty() || isspace(line[0]))) + { + this->Markup = MarkupNormal; + // Record markup lines if the start line was recorded. + if(!this->MarkupLines.empty()) + { + this->MarkupLines.push_back(line); + } + } + // Print non-markup lines. + else + { + this->NormalLine(line); + } +} + +//---------------------------------------------------------------------------- +void cmRST::NormalLine(std::string const& line) +{ + this->Reset(); + this->OutputLine(line); +} + +//---------------------------------------------------------------------------- +void cmRST::OutputLine(std::string const& line_in) +{ + if(this->OutputLinePending) + { + this->OS << "\n"; + this->OutputLinePending = false; + } + std::string line = this->ReplaceSubstitutions(line_in); + std::string::size_type pos = 0; + while(this->CMakeRole.find(line.c_str()+pos)) + { + this->OS << line.substr(pos, this->CMakeRole.start()); + std::string text = this->CMakeRole.match(3); + // If a command reference has no explicit target and + // no explicit "(...)" then add "()" to the text. + if(this->CMakeRole.match(2) == "command" && + this->CMakeRole.match(5).empty() && + text.find_first_of("()") == text.npos) + { + text += "()"; + } + this->OS << "``" << text << "``"; + pos += this->CMakeRole.end(); + } + this->OS << line.substr(pos) << "\n"; +} + +//---------------------------------------------------------------------------- +std::string cmRST::ReplaceSubstitutions(std::string const& line) +{ + std::string out; + std::string::size_type pos = 0; + while(this->Substitution.find(line.c_str()+pos)) + { + std::string::size_type start = this->Substitution.start(2); + std::string::size_type end = this->Substitution.end(2); + std::string substitute = this->Substitution.match(3); + std::map<cmStdString, cmStdString>::iterator + replace = this->Replace.find(substitute); + if(replace != this->Replace.end()) + { + std::pair<std::set<cmStdString>::iterator, bool> replaced = + this->Replaced.insert(substitute); + if(replaced.second) + { + substitute = this->ReplaceSubstitutions(replace->second); + this->Replaced.erase(replaced.first); + } + } + out += line.substr(pos, start); + out += substitute; + pos += end; + } + out += line.substr(pos); + return out; +} + +//---------------------------------------------------------------------------- +bool cmRST::ProcessInclude(std::string file, IncludeType type) +{ + bool found = false; + if(this->IncludeDepth < 10) + { + cmRST r(this->OS, this->DocRoot); + r.IncludeDepth = this->IncludeDepth + 1; + r.OutputLinePending = this->OutputLinePending; + if(type != IncludeTocTree) + { + r.Replace = this->Replace; + } + if(file[0] == '/') + { + file = this->DocRoot + file; + } + else + { + file = this->DocDir + "/" + file; + } + found = r.ProcessFile(file, type == IncludeModule); + if(type != IncludeTocTree) + { + this->Replace = r.Replace; + } + this->OutputLinePending = r.OutputLinePending; + } + return found; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveParsedLiteral() +{ + // Output markup lines as literal text. + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + std::string line = *i; + if(!line.empty()) + { + line = " " + line; + } + this->OutputLine(line); + } + this->OutputLinePending = true; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveCodeBlock() +{ + // Treat markup lines the same as a parsed literal. + this->ProcessDirectiveParsedLiteral(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveReplace() +{ + // Record markup lines as replacement text. + std::string& replacement = this->Replace[this->ReplaceName]; + const char* sep = ""; + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + replacement += sep; + replacement += *i; + sep = " "; + } + this->ReplaceName = ""; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveTocTree() +{ + // Process documents referenced by toctree directive. + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + if(!i->empty() && i->find_first_of(":") == i->npos) + { + this->ProcessInclude(*i + ".rst", IncludeTocTree); + } + } +} + +//---------------------------------------------------------------------------- +void cmRST::UnindentLines(std::vector<std::string>& lines) +{ + // Remove the common indentation from the second and later lines. + std::string indentText; + std::string::size_type indentEnd = 0; + bool first = true; + for(size_t i = 1; i < lines.size(); ++i) + { + std::string const& line = lines[i]; + + // Do not consider empty lines. + if(line.empty()) + { + continue; + } + + // Record indentation on first non-empty line. + if(first) + { + first = false; + indentEnd = line.find_first_not_of(" \t"); + indentText = line.substr(0, indentEnd); + continue; + } + + // Truncate indentation to match that on this line. + if(line.size() < indentEnd) + { + indentEnd = line.size(); + } + for(std::string::size_type j = 0; j != indentEnd; ++j) + { + if(line[j] != indentText[j]) + { + indentEnd = j; + break; + } + } + } + + // Update second and later lines. + for(size_t i = 1; i < lines.size(); ++i) + { + std::string& line = lines[i]; + if(!line.empty()) + { + line = line.substr(indentEnd); + } + } + + // Drop leading blank lines. + size_t leadingEmpty = 0; + for(size_t i = 0; i < lines.size() && lines[i].empty(); ++i) + { + ++leadingEmpty; + } + lines.erase(lines.begin(), lines.begin()+leadingEmpty); + + // Drop trailing blank lines. + size_t trailingEmpty = 0; + for(size_t i = lines.size(); i > 0 && lines[i-1].empty(); --i) + { + ++trailingEmpty; + } + lines.erase(lines.end()-trailingEmpty, lines.end()); +} diff --git a/Source/cmRST.h b/Source/cmRST.h new file mode 100644 index 0000000..9352941 --- /dev/null +++ b/Source/cmRST.h @@ -0,0 +1,83 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#ifndef _cmRST_h +#define _cmRST_h + +#include "cmStandardIncludes.h" + +#include <cmsys/RegularExpression.hxx> + +class cmRST +{ +public: + cmRST(std::ostream& os, std::string const& docroot); + bool ProcessFile(std::string const& fname, bool isModule = false); +private: + enum IncludeType + { + IncludeNormal, + IncludeModule, + IncludeTocTree + }; + enum MarkupType + { + MarkupNone, + MarkupNormal, + MarkupEmpty + }; + enum DirectiveType + { + DirectiveNone, + DirectiveParsedLiteral, + DirectiveCodeBlock, + DirectiveReplace, + DirectiveTocTree + }; + + void ProcessRST(std::istream& is); + void ProcessModule(std::istream& is); + void Reset(); + void ProcessLine(std::string const& line); + void NormalLine(std::string const& line); + void OutputLine(std::string const& line); + std::string ReplaceSubstitutions(std::string const& line); + bool ProcessInclude(std::string file, IncludeType type); + void ProcessDirectiveParsedLiteral(); + void ProcessDirectiveCodeBlock(); + void ProcessDirectiveReplace(); + void ProcessDirectiveTocTree(); + static void UnindentLines(std::vector<std::string>& lines); + + std::ostream& OS; + std::string DocRoot; + int IncludeDepth; + bool OutputLinePending; + MarkupType Markup; + DirectiveType Directive; + cmsys::RegularExpression CMakeDirective; + cmsys::RegularExpression CMakeModuleDirective; + cmsys::RegularExpression ParsedLiteralDirective; + cmsys::RegularExpression CodeBlockDirective; + cmsys::RegularExpression ReplaceDirective; + cmsys::RegularExpression IncludeDirective; + cmsys::RegularExpression TocTreeDirective; + cmsys::RegularExpression CMakeRole; + cmsys::RegularExpression Substitution; + + std::vector<std::string> MarkupLines; + std::string DocDir; + std::map<cmStdString, cmStdString> Replace; + std::set<cmStdString> Replaced; + std::string ReplaceName; +}; + +#endif diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h index 5aedc26..ad73908 100644 --- a/Source/cmRemoveCommand.h +++ b/Source/cmRemoveCommand.h @@ -47,26 +47,6 @@ public: */ virtual const char* GetName() const {return "remove";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the list(REMOVE_ITEM ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " remove(VAR VALUE VALUE ...)\n" - "Removes VALUE from the variable VAR. " - "This is typically used to remove entries from a vector " - "(e.g. semicolon separated list). VALUE is expanded."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmRemoveDefinitionsCommand.h b/Source/cmRemoveDefinitionsCommand.h index 18f6171..4e291fc 100644 --- a/Source/cmRemoveDefinitionsCommand.h +++ b/Source/cmRemoveDefinitionsCommand.h @@ -44,25 +44,6 @@ public: */ virtual const char* GetName() const {return "remove_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Removes -D define flags added by add_definitions."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " remove_definitions(-DFOO -DBAR ...)\n" - "Removes flags (added by add_definitions) from the compiler command " - "line for sources in the current directory and below."; - } - cmTypeMacro(cmRemoveDefinitionsCommand, cmCommand); }; diff --git a/Source/cmReturnCommand.h b/Source/cmReturnCommand.h index a6e87ef..2822b62 100644 --- a/Source/cmReturnCommand.h +++ b/Source/cmReturnCommand.h @@ -47,32 +47,6 @@ public: */ virtual const char* GetName() const {return "return";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Return from a file, directory or function."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " return()\n" - "Returns from a file, directory or function. When this command is " - "encountered in an included file (via include() or find_package()), " - "it causes processing of the current file to stop and control is " - "returned to the including file. If it is encountered in a file which " - "is not included by another file, e.g. a CMakeLists.txt, control is " - "returned to the parent directory if there is one. " - "If return is called in a function, control is returned to the caller " - "of the function. Note that a macro " - "is not a function and does not handle return like a function does."; - } - cmTypeMacro(cmReturnCommand, cmCommand); }; diff --git a/Source/cmSeparateArgumentsCommand.h b/Source/cmSeparateArgumentsCommand.h index d62baf7..ce02360 100644 --- a/Source/cmSeparateArgumentsCommand.h +++ b/Source/cmSeparateArgumentsCommand.h @@ -47,43 +47,6 @@ public: */ virtual const char* GetName() const {return "separate_arguments";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Parse space-separated arguments into a semicolon-separated list."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " separate_arguments(<var> <UNIX|WINDOWS>_COMMAND \"<args>\")\n" - "Parses a unix- or windows-style command-line string \"<args>\" and " - "stores a semicolon-separated list of the arguments in <var>. " - "The entire command line must be given in one \"<args>\" argument." - "\n" - "The UNIX_COMMAND mode separates arguments by unquoted whitespace. " - "It recognizes both single-quote and double-quote pairs. " - "A backslash escapes the next literal character (\\\" is \"); " - "there are no special escapes (\\n is just n)." - "\n" - "The WINDOWS_COMMAND mode parses a windows command-line using the " - "same syntax the runtime library uses to construct argv at startup. " - "It separates arguments by whitespace that is not double-quoted. " - "Backslashes are literal unless they precede double-quotes. " - "See the MSDN article \"Parsing C Command-Line Arguments\" for details." - "\n" - " separate_arguments(VARIABLE)\n" - "Convert the value of VARIABLE to a semi-colon separated list. " - "All spaces are replaced with ';'. This helps with generating " - "command lines."; - } - cmTypeMacro(cmSeparateArgumentsCommand, cmCommand); }; diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index fe1d58d..6cef0a0 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -47,114 +47,6 @@ public: */ virtual const char* GetName() const {return "set";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a CMake, cache or environment variable to a given value."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set(<variable> <value>\n" - " [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])\n" - "Within CMake sets <variable> to the value <value>. " - "<value> is expanded before <variable> is set to it. " - "Normally, set will set a regular CMake variable. " - "If CACHE is present, then the <variable> is put in the cache " - "instead, unless it is already in the cache. " - "See section 'Variable types in CMake' below for details of " - "regular and cache variables and their interactions. " - "If CACHE is used, <type> and <docstring> are required. <type> is used " - "by the CMake GUI to choose a widget with which the user sets a value. " - "The value for <type> may be one of\n" - " FILEPATH = File chooser dialog.\n" - " PATH = Directory chooser dialog.\n" - " STRING = Arbitrary string.\n" - " BOOL = Boolean ON/OFF checkbox.\n" - " INTERNAL = No GUI entry (used for persistent variables).\n" - "If <type> is INTERNAL, the cache variable is marked as internal, " - "and will not be shown to the user in tools like cmake-gui. " - "This is intended for values that should be persisted in the cache, " - "but which users should not normally change. INTERNAL implies FORCE." - "\n" - "Normally, set(...CACHE...) creates cache variables, but does not " - "modify them. " - "If FORCE is specified, the value of the cache variable is set, even " - "if the variable is already in the cache. This should normally be " - "avoided, as it will remove any changes to the cache variable's value " - "by the user.\n" - "If PARENT_SCOPE is present, the variable will be set in the scope " - "above the current scope. Each new directory or function creates a new " - "scope. This command will set the value of a variable into the parent " - "directory or calling function (whichever is applicable to the case at " - "hand). PARENT_SCOPE cannot be combined with CACHE.\n" - "If <value> is not specified then the variable is removed " - "instead of set. See also: the unset() command.\n" - " set(<variable> <value1> ... <valueN>)\n" - "In this case <variable> is set to a semicolon separated list of " - "values.\n" - "<variable> can be an environment variable such as:\n" - " set( ENV{PATH} /home/martink )\n" - "in which case the environment variable will be set.\n" - "*** Variable types in CMake ***\n" - "In CMake there are two types of variables: normal variables and cache " - "variables. Normal variables are meant for the internal use of the " - "script (just like variables in most programming languages); they are " - "not persisted across CMake runs. " - "Cache variables (unless set with INTERNAL) are mostly intended for " - "configuration settings where the first CMake run determines a " - "suitable default value, which the user can then override, by editing " - "the cache with tools such as ccmake or cmake-gui. " - "Cache variables are stored in the CMake cache file, and " - "are persisted across CMake runs. \n" - "Both types can exist at the same time with the same name " - "but different values. " - "When ${FOO} is evaluated, CMake first looks for " - "a normal variable 'FOO' in scope and uses it if set. " - "If and only if no normal variable exists then it falls back to the " - "cache variable 'FOO'.\n" - "Some examples:\n" - "The code 'set(FOO \"x\")' sets the normal variable 'FOO'. It does not " - "touch the cache, but it will hide any existing cache value 'FOO'.\n" - "The code 'set(FOO \"x\" CACHE ...)' checks for 'FOO' in the cache, " - "ignoring any normal variable of the same name. If 'FOO' is in the " - "cache then nothing happens to either the normal variable or the cache " - "variable. If 'FOO' is not in the cache, then it is added to the " - "cache.\n" - "Finally, whenever a cache variable is added or modified by a command, " - "CMake also *removes* the normal variable of the same name from the " - "current scope so that an immediately following evaluation of " - "it will expose the newly cached value.\n" - "Normally projects should avoid using normal and cache variables of " - "the same name, as this interaction can be hard to follow. " - "However, in some situations it can be useful. " - "One example (used by some projects):" - "\n" - "A project has a subproject in its source tree. The child project has " - "its own CMakeLists.txt, which is included from the parent " - "CMakeLists.txt using add_subdirectory(). " - "Now, if the parent and the child project provide the same option " - "(for example a compiler option), the parent gets the first chance " - "to add a user-editable option to the cache. " - "Normally, the child would then use the same value " - "that the parent uses. " - "However, it may be necessary to hard-code the value for the child " - "project's option while still allowing the user to edit the value used " - "by the parent project. The parent project can achieve this simply by " - "setting a normal variable with the same name as the option in a scope " - "sufficient to hide the option's cache variable from the child " - "completely. The parent has already set the cache variable, so the " - "child's set(...CACHE...) will do nothing, and evaluating the option " - "variable will use the value from the normal variable, which hides the " - "cache variable."; - } - cmTypeMacro(cmSetCommand, cmCommand); }; diff --git a/Source/cmSetDirectoryPropertiesCommand.h b/Source/cmSetDirectoryPropertiesCommand.h index 8a50c60..6240598 100644 --- a/Source/cmSetDirectoryPropertiesCommand.h +++ b/Source/cmSetDirectoryPropertiesCommand.h @@ -40,14 +40,6 @@ public: virtual const char* GetName() const { return "set_directory_properties";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a property of the directory."; - } - - /** * Static entry point for use by other commands */ static bool RunCommand(cmMakefile *mf, @@ -55,21 +47,6 @@ public: std::vector<std::string>::const_iterator aitend, std::string &errors); - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n" - "Set a property for the current directory and subdirectories. If the " - "property is not found, CMake will report an error. The properties " - "include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, " - "INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. " - "ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned " - "as a part of \"make clean\" stage."; - } - cmTypeMacro(cmSetDirectoryPropertiesCommand, cmCommand); }; diff --git a/Source/cmSetPropertyCommand.h b/Source/cmSetPropertyCommand.h index 830299d..5470314 100644 --- a/Source/cmSetPropertyCommand.h +++ b/Source/cmSetPropertyCommand.h @@ -37,53 +37,6 @@ public: virtual const char* GetName() const { return "set_property";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a named property in a given scope."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_property(<GLOBAL |\n" - " DIRECTORY [dir] |\n" - " TARGET [target1 [target2 ...]] |\n" - " SOURCE [src1 [src2 ...]] |\n" - " TEST [test1 [test2 ...]] |\n" - " CACHE [entry1 [entry2 ...]]>\n" - " [APPEND] [APPEND_STRING]\n" - " PROPERTY <name> [value1 [value2 ...]])\n" - "Set one property on zero or more objects of a scope. " - "The first argument determines the scope in which the property " - "is set. It must be one of the following:\n" - "GLOBAL scope is unique and does not accept a name.\n" - "DIRECTORY scope defaults to the current directory but another " - "directory (already processed by CMake) may be named by full or " - "relative path.\n" - "TARGET scope may name zero or more existing targets.\n" - "SOURCE scope may name zero or more source files. " - "Note that source file properties are visible only to targets " - "added in the same directory (CMakeLists.txt).\n" - "TEST scope may name zero or more existing tests.\n" - "CACHE scope must name zero or more cache existing entries.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property to set. Remaining arguments are used to " - "compose the property value in the form of a semicolon-separated " - "list. " - "If the APPEND option is given the list is appended to any " - "existing property value." - "If the APPEND_STRING option is given the string is append to any " - "existing property value as string, i.e. it results in a longer " - "string and not a list of strings." - ; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmSetSourceFilesPropertiesCommand.h b/Source/cmSetSourceFilesPropertiesCommand.h index f7009e7..8541a96 100644 --- a/Source/cmSetSourceFilesPropertiesCommand.h +++ b/Source/cmSetSourceFilesPropertiesCommand.h @@ -34,31 +34,6 @@ public: */ virtual const char* GetName() const { return "set_source_files_properties";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Source files can have properties that affect how they are built."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_source_files_properties([file1 [file2 [...]]]\n" - " PROPERTIES prop1 value1\n" - " [prop2 value2 [...]])\n" - "Set properties associated with source files using a key/value " - "paired list. " - "See properties documentation for those known to CMake. " - "Unrecognized properties are ignored. " - "Source file properties are visible only to targets " - "added in the same directory (CMakeLists.txt)."; - } - cmTypeMacro(cmSetSourceFilesPropertiesCommand, cmCommand); static bool RunCommand(cmMakefile *mf, diff --git a/Source/cmSetTargetPropertiesCommand.h b/Source/cmSetTargetPropertiesCommand.h index cf9c193..6221a18 100644 --- a/Source/cmSetTargetPropertiesCommand.h +++ b/Source/cmSetTargetPropertiesCommand.h @@ -35,133 +35,12 @@ public: virtual const char* GetName() const { return "set_target_properties";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Targets can have properties that affect how they are built."; - } - - /** * Used by this command and cmSetPropertiesCommand */ static bool SetOneTarget(const char *tname, std::vector<std::string> &propertyPairs, cmMakefile *mf); - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_target_properties(target1 target2 ...\n" - " PROPERTIES prop1 value1\n" - " prop2 value2 ...)\n" - "Set properties on a target. The syntax for the command is to " - "list all the files you want " - "to change, and then provide the values you want to set next. " - "You can use any prop value pair you want and " - "extract it later with the GET_TARGET_PROPERTY command.\n" - "Properties that affect the name of a target's output file are " - "as follows. " - "The PREFIX and SUFFIX properties override the default target name " - "prefix (such as \"lib\") and suffix (such as \".so\"). " - "IMPORT_PREFIX and IMPORT_SUFFIX are the equivalent properties for " - "the import library corresponding to a DLL " - "(for SHARED library targets). " - "OUTPUT_NAME sets the real name of a target when it is built and " - "can be used to help create two targets of the same name even though " - "CMake requires unique logical target names. There is also a " - "<CONFIG>_OUTPUT_NAME that can set the output name on a " - "per-configuration basis. " - "<CONFIG>_POSTFIX sets a postfix for the real name of the target " - "when it is built under the configuration named by <CONFIG> " - "(in upper-case, such as \"DEBUG_POSTFIX\"). The value of " - "this property is initialized when the target is created to the " - "value of the variable CMAKE_<CONFIG>_POSTFIX (except for executable " - "targets because earlier CMake versions which did not use this " - "variable for executables)." - "\n" - "The LINK_FLAGS property can be used to add extra flags to the " - "link step of a target. LINK_FLAGS_<CONFIG> will add to the " - "configuration <CONFIG>, " - "for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. " - "DEFINE_SYMBOL sets the name of the preprocessor symbol defined when " - "compiling sources in a shared library. " - "If not set here then it is set to target_EXPORTS by default " - "(with some substitutions if the target is not a valid C " - "identifier). This is useful for headers to know whether they are " - "being included from inside their library or outside to properly " - "setup dllexport/dllimport decorations. " - "The COMPILE_FLAGS property sets additional compiler flags used " - "to build sources within the target. It may also be used to pass " - "additional preprocessor definitions." - "\n" - "The LINKER_LANGUAGE property is used to change the tool " - "used to link an executable or shared library. The default is " - "set the language to match the files in the library. CXX and C " - "are common values for this property." - "\n" - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "For executables VERSION can be used to specify the build version. " - "When building or installing appropriate symlinks are created if " - "the platform supports symlinks. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. " - "\n" - "There are a few properties used to specify RPATH rules. " - "INSTALL_RPATH is a semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will " - "append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic " - "generation of an rpath allowing the target to run from the " - "build tree. " - "BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link " - "the target in the build tree with the INSTALL_RPATH. This takes " - "precedence over SKIP_BUILD_RPATH and avoids the need for relinking " - "before installation. INSTALL_NAME_DIR is a string specifying the " - "directory portion of the \"install_name\" field of shared libraries " - "on Mac OSX to use in the installed targets. " - "When the target is created the values of " - "the variables CMAKE_INSTALL_RPATH, " - "CMAKE_INSTALL_RPATH_USE_LINK_PATH, CMAKE_SKIP_BUILD_RPATH, " - "CMAKE_BUILD_WITH_INSTALL_RPATH, and CMAKE_INSTALL_NAME_DIR " - "are used to initialize these properties.\n" - "PROJECT_LABEL can be used to change the name of " - "the target in an IDE like visual studio. VS_KEYWORD can be set " - "to change the visual studio keyword, for example Qt integration " - "works better if this is set to Qt4VSv1.0.\n" - "VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER and " - "VS_SCC_AUXPATH can be set " - "to add support for source control bindings in a Visual Studio " - "project file.\n" - "VS_GLOBAL_<variable> can be set to add a Visual Studio " - "project-specific global variable. " - "Qt integration works better if VS_GLOBAL_QtVersion is set to " - "the Qt version FindQt4.cmake found. For example, \"4.7.3\"\n" - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead." - "\n" - "The EXCLUDE_FROM_DEFAULT_BUILD property is used by the visual " - "studio generators. If it is set to 1 the target will not be " - "part of the default build when you select \"Build Solution\". " - "This can also be set on a per-configuration basis using " - "EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>." - ; - } - cmTypeMacro(cmSetTargetPropertiesCommand, cmCommand); }; diff --git a/Source/cmSetTestsPropertiesCommand.h b/Source/cmSetTestsPropertiesCommand.h index f2f2611..9e85495 100644 --- a/Source/cmSetTestsPropertiesCommand.h +++ b/Source/cmSetTestsPropertiesCommand.h @@ -34,41 +34,6 @@ public: */ virtual const char* GetName() const { return "set_tests_properties";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a property of the tests."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2" - " value2)\n" - "Set a property for the tests. If the property is not found, CMake " - "will report an error. Generator expressions will be expanded the same " - "as supported by the test's add_test call. The properties include:\n" - "WILL_FAIL: If set to true, this will invert the pass/fail flag of the" - " test.\n" - "PASS_REGULAR_EXPRESSION: If set, the test output will be checked " - "against the specified regular expressions and at least one of the" - " regular " - "expressions has to match, otherwise the test will fail.\n" - " Example: PASS_REGULAR_EXPRESSION \"TestPassed;All ok\"\n" - "FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of " - "specified regular expressions, the test will fail.\n" - " Example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"\n" - "Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a " - "list of regular expressions.\n" - "TIMEOUT: Setting this will limit the test runtime to the number of " - "seconds specified.\n"; - } - cmTypeMacro(cmSetTestsPropertiesCommand, cmCommand); static bool SetOneTest(const char *tname, diff --git a/Source/cmSiteNameCommand.h b/Source/cmSiteNameCommand.h index 52a63bc..eb9d4d8 100644 --- a/Source/cmSiteNameCommand.h +++ b/Source/cmSiteNameCommand.h @@ -47,23 +47,6 @@ public: */ virtual const char* GetName() const {return "site_name";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the given variable to the name of the computer."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " site_name(variable)\n"; - } - cmTypeMacro(cmSiteNameCommand, cmCommand); }; diff --git a/Source/cmSourceFile.cxx b/Source/cmSourceFile.cxx index 8bb7d96..d747309 100644 --- a/Source/cmSourceFile.cxx +++ b/Source/cmSourceFile.cxx @@ -16,7 +16,6 @@ #include "cmMakefile.h" #include "cmSystemTools.h" #include "cmake.h" -#include "cmDocumentCompileDefinitions.h" //---------------------------------------------------------------------------- cmSourceFile::cmSourceFile(cmMakefile* mf, const char* name): @@ -382,176 +381,3 @@ void cmSourceFile::SetCustomCommand(cmCustomCommand* cc) this->CustomCommand = cc; delete old; } - -//---------------------------------------------------------------------------- -void cmSourceFile::DefineProperties(cmake *cm) -{ - // define properties - cm->DefineProperty - ("ABSTRACT", cmProperty::SOURCE_FILE, - "Is this source file an abstract class.", - "A property on a source file that indicates if the source file " - "represents a class that is abstract. This only makes sense for " - "languages that have a notion of an abstract class and it is " - "only used by some tools that wrap classes into other languages."); - - cm->DefineProperty - ("COMPILE_FLAGS", cmProperty::SOURCE_FILE, - "Additional flags to be added when compiling this source file.", - "These flags will be added to the list of compile flags when " - "this source file builds. Use COMPILE_DEFINITIONS to pass additional " - "preprocessor definitions."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::SOURCE_FILE, - "Preprocessor definitions for compiling a source file.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\").\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does). Xcode does not support per-configuration " - "definitions on source files.\n" - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::SOURCE_FILE, - "Per-configuration preprocessor definitions on a source file.", - "This is the configuration-specific version of " - "COMPILE_DEFINITIONS. Note that Xcode does not support " - "per-configuration source file flags so this property will " - "be ignored by the Xcode generator."); - - cm->DefineProperty - ("EXTERNAL_OBJECT", cmProperty::SOURCE_FILE, - "If set to true then this is an object file.", - "If this property is set to true then the source file " - "is really an object file and should not be compiled. " - "It will still be linked into the target though."); - - cm->DefineProperty - ("Fortran_FORMAT", cmProperty::SOURCE_FILE, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This property tells CMake whether a given Fortran source file " - "uses fixed-format or free-format. " - "CMake will pass the corresponding format flag to the compiler. " - "Consider using the target-wide Fortran_FORMAT property if all " - "source files in a target share the same format."); - - cm->DefineProperty - ("GENERATED", cmProperty::SOURCE_FILE, - "Is this source file generated as part of the build process.", - "If a source file is generated by the build process CMake will " - "handle it differently in terms of dependency checking etc. " - "Otherwise having a non-existent source file could create problems."); - - cm->DefineProperty - ("HEADER_FILE_ONLY", cmProperty::SOURCE_FILE, - "Is this source file only a header file.", - "A property on a source file that indicates if the source file " - "is a header file with no associated implementation. This is " - "set automatically based on the file extension and is used by " - "CMake to determine if certain dependency information should be " - "computed."); - - cm->DefineProperty - ("KEEP_EXTENSION", cmProperty::SOURCE_FILE, - "Make the output file have the same extension as the source file.", - "If this property is set then the file extension of the output " - "file will be the same as that of the source file. Normally " - "the output file extension is computed based on the language " - "of the source file, for example .cxx will go to a .o extension."); - - cm->DefineProperty - ("LABELS", cmProperty::SOURCE_FILE, - "Specify a list of text labels associated with a source file.", - "This property has meaning only when the source file is listed in " - "a target whose LABELS property is also set. " - "No other semantics are currently specified."); - - cm->DefineProperty - ("LANGUAGE", cmProperty::SOURCE_FILE, - "What programming language is the file.", - "A property that can be set to indicate what programming language " - "the source file is. If it is not set the language is determined " - "based on the file extension. Typical values are CXX C etc. Setting " - "this property for a file means this file will be compiled. " - "Do not set this for headers or files that should not be compiled."); - - cm->DefineProperty - ("LOCATION", cmProperty::SOURCE_FILE, - "The full path to a source file.", - "A read only property on a SOURCE FILE that contains the full path " - "to the source file."); - - cm->DefineProperty - ("MACOSX_PACKAGE_LOCATION", cmProperty::SOURCE_FILE, - "Place a source file inside a Mac OS X bundle, CFBundle, or framework.", - "Executable targets with the MACOSX_BUNDLE property set are built " - "as Mac OS X application bundles on Apple platforms. " - "Shared library targets with the FRAMEWORK property set are built " - "as Mac OS X frameworks on Apple platforms. " - "Module library targets with the BUNDLE property set are built " - "as Mac OS X CFBundle bundles on Apple platforms. " - "Source files listed in the target with this property set will " - "be copied to a directory inside the bundle or framework content " - "folder specified by the property value. " - "For bundles the content folder is \"<name>.app/Contents\". " - "For frameworks the content folder is " - "\"<name>.framework/Versions/<version>\". " - "For cfbundles the content folder is " - "\"<name>.bundle/Contents\" (unless the extension is changed). " - "See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target " - "properties for specifying files meant for Headers, PrivateHeaders, " - "or Resources directories."); - - cm->DefineProperty - ("OBJECT_DEPENDS", cmProperty::SOURCE_FILE, - "Additional files on which a compiled object file depends.", - "Specifies a semicolon-separated list of full-paths to files on which " - "any object files compiled from this source file depend. " - "An object file will be recompiled if any of the named files is newer " - "than it.\n" - "This property need not be used to specify the dependency of a " - "source file on a generated header file that it includes. " - "Although the property was originally introduced for this purpose, it " - "is no longer necessary. " - "If the generated header file is created by a custom command in the " - "same target as the source file, the automatic dependency scanning " - "process will recognize the dependency. " - "If the generated header file is created by another target, an " - "inter-target dependency should be created with the add_dependencies " - "command (if one does not already exist due to linking relationships)."); - - cm->DefineProperty - ("OBJECT_OUTPUTS", cmProperty::SOURCE_FILE, - "Additional outputs for a Makefile rule.", - "Additional outputs created by compilation of this source file. " - "If any of these outputs is missing the object will be recompiled. " - "This is supported only on Makefile generators and will be ignored " - "on other generators."); - - cm->DefineProperty - ("SYMBOLIC", cmProperty::SOURCE_FILE, - "Is this just a name for a rule.", - "If SYMBOLIC (boolean) is set to true the build system will be " - "informed that the source file is not actually created on disk but " - "instead used as a symbolic name for a build rule."); - - cm->DefineProperty - ("WRAP_EXCLUDE", cmProperty::SOURCE_FILE, - "Exclude this source file from any code wrapping techniques.", - "Some packages can wrap source files into alternate languages " - "to provide additional functionality. For example, C++ code " - "can be wrapped into Java or Python etc using SWIG etc. " - "If WRAP_EXCLUDE is set to true (1 etc) that indicates that " - "this source file should not be wrapped."); -} - diff --git a/Source/cmSourceFile.h b/Source/cmSourceFile.h index 6c68b87..4440b05 100644 --- a/Source/cmSourceFile.h +++ b/Source/cmSourceFile.h @@ -90,9 +90,6 @@ public: // Get the properties cmPropertyMap &GetProperties() { return this->Properties; }; - // Define the properties - static void DefineProperties(cmake *cm); - /** * Check whether the given source file location could refer to this * source. diff --git a/Source/cmSourceGroupCommand.h b/Source/cmSourceGroupCommand.h index 9f6b7e4..5d8b48c 100644 --- a/Source/cmSourceGroupCommand.h +++ b/Source/cmSourceGroupCommand.h @@ -43,36 +43,6 @@ public: */ virtual const char* GetName() const {return "source_group";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Define a grouping for sources in the makefile."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " source_group(name [REGULAR_EXPRESSION regex] " - "[FILES src1 src2 ...])\n" - "Defines a group into which sources will be placed in project files. " - "This is mainly used to setup file tabs in Visual Studio. " - "Any file whose name is listed or matches the regular expression will " - "be placed in this group. If a file matches multiple groups, the LAST " - "group that explicitly lists the file will be favored, if any. If no " - "group explicitly lists the file, the LAST group whose regular " - "expression matches the file will be favored.\n" - "The name of the group may contain backslashes to specify subgroups:\n" - " source_group(outer\\\\inner ...)\n" - "For backwards compatibility, this command also supports the " - "format:\n" - " source_group(name regex)"; - } - cmTypeMacro(cmSourceGroupCommand, cmCommand); }; diff --git a/Source/cmStandardIncludes.h b/Source/cmStandardIncludes.h index a4aec2e..d09b304 100644 --- a/Source/cmStandardIncludes.h +++ b/Source/cmStandardIncludes.h @@ -321,14 +321,12 @@ struct cmDocumentationEntry { std::string Name; std::string Brief; - std::string Full; cmDocumentationEntry(){}; - cmDocumentationEntry(const char *doc[3]) + cmDocumentationEntry(const char *doc[2]) { if (doc[0]) this->Name = doc[0]; - if (doc[1]) this->Brief = doc[1]; - if (doc[2]) this->Full = doc[2]; }; - cmDocumentationEntry(const char *n, const char *b, const char *f) - { if (n) this->Name = n; if (b) this->Brief = b; if (f) this->Full = f; }; + if (doc[1]) this->Brief = doc[1];}; + cmDocumentationEntry(const char *n, const char *b) + { if (n) this->Name = n; if (b) this->Brief = b; }; }; /** Data structure to represent a single command line. */ diff --git a/Source/cmStringCommand.h b/Source/cmStringCommand.h index f584cfd..0e833c4 100644 --- a/Source/cmStringCommand.h +++ b/Source/cmStringCommand.h @@ -52,136 +52,6 @@ public: */ virtual const char* GetName() const { return "string";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "String operations."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " string(REGEX MATCH <regular_expression>\n" - " <output variable> <input> [<input>...])\n" - " string(REGEX MATCHALL <regular_expression>\n" - " <output variable> <input> [<input>...])\n" - " string(REGEX REPLACE <regular_expression>\n" - " <replace_expression> <output variable>\n" - " <input> [<input>...])\n" - " string(REPLACE <match_string>\n" - " <replace_string> <output variable>\n" - " <input> [<input>...])\n" - " string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512>\n" - " <output variable> <input>)\n" - " string(COMPARE EQUAL <string1> <string2> <output variable>)\n" - " string(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n" - " string(COMPARE LESS <string1> <string2> <output variable>)\n" - " string(COMPARE GREATER <string1> <string2> <output variable>)\n" - " string(ASCII <number> [<number> ...] <output variable>)\n" - " string(CONFIGURE <string1> <output variable>\n" - " [@ONLY] [ESCAPE_QUOTES])\n" - " string(TOUPPER <string1> <output variable>)\n" - " string(TOLOWER <string1> <output variable>)\n" - " string(LENGTH <string> <output variable>)\n" - " string(SUBSTRING <string> <begin> <length> <output variable>)\n" - " string(STRIP <string> <output variable>)\n" - " string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]\n" - " [RANDOM_SEED <seed>] <output variable>)\n" - " string(FIND <string> <substring> <output variable> [REVERSE])\n" - " string(TIMESTAMP <output variable> [<format string>] [UTC])\n" - " string(MAKE_C_IDENTIFIER <input string> <output variable>)\n" - "REGEX MATCH will match the regular expression once and store the " - "match in the output variable.\n" - "REGEX MATCHALL will match the regular expression as many times as " - "possible and store the matches in the output variable as a list.\n" - "REGEX REPLACE will match the regular expression as many times as " - "possible and substitute the replacement expression for the match " - "in the output. The replace expression may refer to paren-delimited " - "subexpressions of the match using \\1, \\2, ..., \\9. Note that " - "two backslashes (\\\\1) are required in CMake code to get a " - "backslash through argument parsing.\n" - "REPLACE will replace all occurrences of match_string in the input with " - "replace_string and store the result in the output.\n" - "MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 " - "will compute a cryptographic hash of the input string.\n" - "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and " - "store true or false in the output variable.\n" - "ASCII will convert all numbers into corresponding ASCII characters.\n" - "CONFIGURE will transform a string like CONFIGURE_FILE transforms " - "a file.\n" - "TOUPPER/TOLOWER will convert string to upper/lower characters.\n" - "LENGTH will return a given string's length.\n" - "SUBSTRING will return a substring of a given string. If length is " - "-1 the remainder of the string starting at begin will be returned.\n" - "STRIP will return a substring of a given string with leading " - "and trailing spaces removed.\n" - "RANDOM will return a random string of given length consisting of " - "characters from the given alphabet. Default length is 5 " - "characters and default alphabet is all numbers and upper and " - "lower case letters. If an integer RANDOM_SEED is given, its " - "value will be used to seed the random number generator.\n" - "FIND will return the position where the given substring was found " - "in the supplied string. If the REVERSE flag was used, the command " - "will search for the position of the last occurrence of the " - "specified substring.\n" - "The following characters have special meaning in regular expressions:\n" - " ^ Matches at beginning of input\n" - " $ Matches at end of input\n" - " . Matches any single character\n" - " [ ] Matches any character(s) inside the brackets\n" - " [^ ] Matches any character(s) not inside the brackets\n" - " - Inside brackets, specifies an inclusive range between\n" - " characters on either side e.g. [a-f] is [abcdef]\n" - " To match a literal - using brackets, make it the first\n" - " or the last character e.g. [+*/-] matches basic\n" - " mathematical operators.\n" - " * Matches preceding pattern zero or more times\n" - " + Matches preceding pattern one or more times\n" - " ? Matches preceding pattern zero or once only\n" - " | Matches a pattern on either side of the |\n" - " () Saves a matched subexpression, which can be referenced \n" - " in the REGEX REPLACE operation. Additionally it is saved\n" - " by all regular expression-related commands, including \n" - " e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).\n" - "*, + and ? have higher precedence than concatenation. | has lower " - "precedence than concatenation. This means that the regular expression " - "\"^ab+d$\" matches \"abbd\" but not \"ababd\", and the regular " - "expression \"^(ab|cd)$\" matches \"ab\" but not \"abd\".\n" - "TIMESTAMP will write a string representation of " - "the current date and/or time to the output variable.\n" - "Should the command be unable to obtain a timestamp " - "the output variable will be set to the empty string \"\".\n" - "The optional UTC flag requests the current date/time " - "representation to be in Coordinated Universal Time (UTC) " - "rather than local time.\n" - "The optional <format string> may contain the following " - "format specifiers: \n" - " %d The day of the current month (01-31).\n" - " %H The hour on a 24-hour clock (00-23).\n" - " %I The hour on a 12-hour clock (01-12).\n" - " %j The day of the current year (001-366).\n" - " %m The month of the current year (01-12).\n" - " %M The minute of the current hour (00-59).\n" - " %S The second of the current minute.\n" - " 60 represents a leap second. (00-60)\n" - " %U The week number of the current year (00-53).\n" - " %w The day of the current week. 0 is Sunday. (0-6)\n" - " %y The last two digits of the current year (00-99)\n" - " %Y The current year. \n" - "Unknown format specifiers will be ignored " - "and copied to the output as-is.\n" - "If no explicit <format string> is given it will default to:\n" - " %Y-%m-%dT%H:%M:%S for local time.\n" - " %Y-%m-%dT%H:%M:%SZ for UTC.\n" - "MAKE_C_IDENTIFIER will write a string which can be used as an " - "identifier in C."; - } - cmTypeMacro(cmStringCommand, cmCommand); static void ClearMatches(cmMakefile* mf); static void StoreMatches(cmMakefile* mf, cmsys::RegularExpression& re); diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h index 618d5ff..8be8335 100644 --- a/Source/cmSubdirCommand.h +++ b/Source/cmSubdirCommand.h @@ -44,40 +44,6 @@ public: */ virtual const char* GetName() const { return "subdirs";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the add_subdirectory() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Add a list of subdirectories to the build.\n" - " subdirs(dir1 dir2 ..." - "[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]\n" - " [PREORDER] )\n" - "Add a list of subdirectories to the build. The add_subdirectory " - "command should be used instead of subdirs although subdirs will " - "still work. " - "This will cause any CMakeLists.txt files in the sub directories " - "to be processed by CMake. Any directories after the PREORDER flag " - "are traversed first by makefile builds, the PREORDER flag has no " - "effect on IDE projects. " - " Any directories after the EXCLUDE_FROM_ALL marker " - "will not be included in the top level makefile or project file. " - "This is useful for having CMake create makefiles or projects for " - "a set of examples in a project. You would want CMake to " - "generate makefiles or project files for all the examples at " - "the same time, but you would not want them to show up in the " - "top level project or be built each time make is run from the top."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h index b274d01..e6f1f8f 100644 --- a/Source/cmSubdirDependsCommand.h +++ b/Source/cmSubdirDependsCommand.h @@ -44,25 +44,6 @@ public: */ virtual const char* GetName() const { return "subdir_depends";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Does nothing."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " subdir_depends(subdir dep1 dep2 ...)\n" - "Does not do anything. This command used to help projects order " - "parallel builds correctly. This functionality is now automatic."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmSystemTools.cxx b/Source/cmSystemTools.cxx index 9ec4938..cbd4632 100644 --- a/Source/cmSystemTools.cxx +++ b/Source/cmSystemTools.cxx @@ -200,6 +200,13 @@ std::string cmSystemTools::EscapeQuotes(const char* str) return result; } +std::string cmSystemTools::HelpFileName(std::string name) +{ + cmSystemTools::ReplaceString(name, "<", ""); + cmSystemTools::ReplaceString(name, ">", ""); + return name; +} + std::string cmSystemTools::TrimWhitespace(const std::string& s) { std::string::const_iterator start = s.begin(); diff --git a/Source/cmSystemTools.h b/Source/cmSystemTools.h index 9d7dae9..cbc1140 100644 --- a/Source/cmSystemTools.h +++ b/Source/cmSystemTools.h @@ -49,6 +49,9 @@ public: ///! Escape quotes in a string. static std::string EscapeQuotes(const char* str); + /** Map help document name to file name. */ + static std::string HelpFileName(std::string); + /** * Returns a string that has whitespace removed from the start and the end. */ diff --git a/Source/cmTarget.cxx b/Source/cmTarget.cxx index 10b577f..5e10e25 100644 --- a/Source/cmTarget.cxx +++ b/Source/cmTarget.cxx @@ -16,9 +16,6 @@ #include "cmLocalGenerator.h" #include "cmGlobalGenerator.h" #include "cmComputeLinkInformation.h" -#include "cmDocumentCompileDefinitions.h" -#include "cmDocumentGeneratorExpressions.h" -#include "cmDocumentLocationUndefined.h" #include "cmListFileCache.h" #include "cmGeneratorExpression.h" #include "cmGeneratorExpressionDAGChecker.h" @@ -47,6 +44,8 @@ const char* cmTarget::GetTargetTypeName(TargetType targetType) return "UTILITY"; case cmTarget::GLOBAL_TARGET: return "GLOBAL_TARGET"; + case cmTarget::INTERFACE_LIBRARY: + return "INTERFACE_LIBRARY"; case cmTarget::UNKNOWN_LIBRARY: return "UNKNOWN_LIBRARY"; } @@ -217,1384 +216,14 @@ cmTarget::cmTarget() void cmTarget::DefineProperties(cmake *cm) { cm->DefineProperty - ("AUTOMOC", cmProperty::TARGET, - "Should the target be processed with automoc (for Qt projects).", - "AUTOMOC is a boolean specifying whether CMake will handle " - "the Qt moc preprocessor automatically, i.e. without having to use " - "the QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are " - "supported. " - "When this property is set to TRUE, CMake will scan the source files " - "at build time and invoke moc accordingly. " - "If an #include statement like #include \"moc_foo.cpp\" is found, " - "the Q_OBJECT class declaration is expected in the header, and moc is " - "run on the header file. " - "If an #include statement like #include \"foo.moc\" is found, " - "then a Q_OBJECT is expected in the current source file and moc " - "is run on the file itself. " - "Additionally, all header files are parsed for Q_OBJECT macros, " - "and if found, moc is also executed on those files. The resulting " - "moc files, which are not included as shown above in any of the source " - "files are included in a generated <targetname>_automoc.cpp file, " - "which is compiled as part of the target." - "This property is initialized by the value of the variable " - "CMAKE_AUTOMOC if it is set when a target is created.\n" - "Additional command line options for moc can be set via the " - "AUTOMOC_MOC_OPTIONS property.\n" - "By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules " - "for searching the files which will be processed by moc can be relaxed. " - "See the documentation for this variable for more details.\n" - "The global property AUTOMOC_TARGETS_FOLDER can be used to group the " - "automoc targets together in an IDE, e.g. in MSVS."); - - cm->DefineProperty - ("AUTOMOC_MOC_OPTIONS", cmProperty::TARGET, - "Additional options for moc when using automoc (see the AUTOMOC property)", - "This property is only used if the AUTOMOC property is set to TRUE for " - "this target. In this case, it holds additional command line options " - "which will be used when moc is executed during the build, i.e. it is " - "equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() " - "macro.\n" - "By default it is empty."); - - cm->DefineProperty - ("BUILD_WITH_INSTALL_RPATH", cmProperty::TARGET, - "Should build tree targets have install tree rpaths.", - "BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link " - "the target in the build tree with the INSTALL_RPATH. This takes " - "precedence over SKIP_BUILD_RPATH and avoids the need for relinking " - "before installation. " - "This property is initialized by the value of the variable " - "CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("COMPILE_FLAGS", cmProperty::TARGET, - "Additional flags to use when compiling this target's sources.", - "The COMPILE_FLAGS property sets additional compiler flags used " - "to build sources within the target. Use COMPILE_DEFINITIONS " - "to pass additional preprocessor definitions."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::TARGET, - "Preprocessor definitions for compiling a target's sources.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\").\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does).\n" - "Contents of COMPILE_DEFINITIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::TARGET, - "Per-configuration preprocessor definitions on a target.", - "This is the configuration-specific version of COMPILE_DEFINITIONS."); - - cm->DefineProperty - ("COMPILE_OPTIONS", cmProperty::TARGET, - "List of options to pass to the compiler.", - "This property specifies the list of options specified " - "so far for this property. " - "This property exists on directories and targets." - "\n" - "The target property values are used by the generators to set " - "the options for the compiler.\n" - "Contents of COMPILE_OPTIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_COMPILE_OPTIONS", cmProperty::TARGET, - "List of interface options to pass to the compiler.", - "Targets may populate this property to publish the compile options " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own COMPILE_OPTIONS property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the " - "compile options specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("DEFINE_SYMBOL", cmProperty::TARGET, - "Define a symbol when compiling this target's sources.", - "DEFINE_SYMBOL sets the name of the preprocessor symbol defined when " - "compiling sources in a shared library. " - "If not set here then it is set to target_EXPORTS by default " - "(with some substitutions if the target is not a valid C " - "identifier). This is useful for headers to know whether they are " - "being included from inside their library or outside to properly " - "setup dllexport/dllimport decorations. "); - - cm->DefineProperty - ("DEBUG_POSTFIX", cmProperty::TARGET, - "See target property <CONFIG>_POSTFIX.", - "This property is a special case of the more-general <CONFIG>_POSTFIX " - "property for the DEBUG configuration."); - - cm->DefineProperty - ("<CONFIG>_POSTFIX", cmProperty::TARGET, - "Postfix to append to the target file name for configuration <CONFIG>.", - "When building with configuration <CONFIG> the value of this property " - "is appended to the target file name built on disk. " - "For non-executable targets, this property is initialized by the value " - "of the variable CMAKE_<CONFIG>_POSTFIX if it is set when a target is " - "created. " - "This property is ignored on the Mac for Frameworks and App Bundles."); - - cm->DefineProperty - ("EchoString", cmProperty::TARGET, - "A message to be displayed when the target is built.", - "A message to display on some generators (such as makefiles) when " - "the target is built."); - - cm->DefineProperty - ("BUNDLE", cmProperty::TARGET, - "This target is a CFBundle on the Mac.", - "If a module library target has this property set to true it will " - "be built as a CFBundle when built on the mac. It will have the " - "directory structure required for a CFBundle and will be suitable " - "to be used for creating Browser Plugins or other application " - "resources."); - - cm->DefineProperty - ("BUNDLE_EXTENSION", cmProperty::TARGET, - "The file extension used to name a BUNDLE target on the Mac.", - "The default value is \"bundle\" - you can also use \"plugin\" or " - "whatever file extension is required by the host app for your " - "bundle."); - - cm->DefineProperty - ("EXCLUDE_FROM_DEFAULT_BUILD", cmProperty::TARGET, - "Exclude target from \"Build Solution\".", - "This property is only used by Visual Studio generators 7 and above. " - "When set to TRUE, the target will not be built when you press " - "\"Build Solution\"."); - - cm->DefineProperty - ("EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>", cmProperty::TARGET, - "Per-configuration version of target exclusion from \"Build Solution\". ", - "This is the configuration-specific version of " - "EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD " - "is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes " - "precedence in configurations for which it has a value."); - - cm->DefineProperty - ("FRAMEWORK", cmProperty::TARGET, - "This target is a framework on the Mac.", - "If a shared library target has this property set to true it will " - "be built as a framework when built on the mac. It will have the " - "directory structure required for a framework and will be suitable " - "to be used with the -framework option"); - - cm->DefineProperty - ("HAS_CXX", cmProperty::TARGET, - "Link the target using the C++ linker tool (obsolete).", - "This is equivalent to setting the LINKER_LANGUAGE property to CXX. " - "See that property's documentation for details."); - - cm->DefineProperty - ("IMPLICIT_DEPENDS_INCLUDE_TRANSFORM", cmProperty::TARGET, - "Specify #include line transforms for dependencies in a target.", - "This property specifies rules to transform macro-like #include lines " - "during implicit dependency scanning of C and C++ source files. " - "The list of rules must be semicolon-separated with each entry of " - "the form \"A_MACRO(%)=value-with-%\" (the % must be literal). " - "During dependency scanning occurrences of A_MACRO(...) on #include " - "lines will be replaced by the value given with the macro argument " - "substituted for '%'. For example, the entry\n" - " MYDIR(%)=<mydir/%>\n" - "will convert lines of the form\n" - " #include MYDIR(myheader.h)\n" - "to\n" - " #include <mydir/myheader.h>\n" - "allowing the dependency to be followed.\n" - "This property applies to sources in the target on which it is set."); - - cm->DefineProperty - ("IMPORT_PREFIX", cmProperty::TARGET, - "What comes before the import library name.", - "Similar to the target property PREFIX, but used for import libraries " - "(typically corresponding to a DLL) instead of regular libraries. " - "A target property that can be set to override the prefix " - "(such as \"lib\") on an import library name."); - - cm->DefineProperty - ("IMPORT_SUFFIX", cmProperty::TARGET, - "What comes after the import library name.", - "Similar to the target property SUFFIX, but used for import libraries " - "(typically corresponding to a DLL) instead of regular libraries. " - "A target property that can be set to override the suffix " - "(such as \".lib\") on an import library name."); - - cm->DefineProperty - ("IMPORTED", cmProperty::TARGET, - "Read-only indication of whether a target is IMPORTED.", - "The boolean value of this property is true for targets created with " - "the IMPORTED option to add_executable or add_library. " - "It is false for targets built within the project."); - - cm->DefineProperty - ("IMPORTED_CONFIGURATIONS", cmProperty::TARGET, - "Configurations provided for an IMPORTED target.", - "Set this to the list of configuration names available for an " - "IMPORTED target. " - "The names correspond to configurations defined in the project from " - "which the target is imported. " - "If the importing project uses a different set of configurations " - "the names may be mapped using the MAP_IMPORTED_CONFIG_<CONFIG> " - "property. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_IMPLIB", cmProperty::TARGET, - "Full path to the import library for an IMPORTED target.", - "Set this to the location of the \".lib\" part of a windows DLL. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_IMPLIB_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_IMPLIB property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_LINK_DEPENDENT_LIBRARIES", cmProperty::TARGET, - "Dependent shared libraries of an imported shared library.", - "Shared libraries may be linked to other shared libraries as part " - "of their implementation. On some platforms the linker searches " - "for the dependent libraries of shared libraries they are including " - "in the link. " - "Set this property to the list of dependent shared libraries of an " - "imported library. " - "The list " - "should be disjoint from the list of interface libraries in the " - "INTERFACE_LINK_LIBRARIES property. On platforms requiring " - "dependent shared libraries to be found at link time CMake uses this " - "list to add appropriate files or paths to the link command line. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LIBRARIES", cmProperty::TARGET, - "Transitive link interface of an IMPORTED target.", - "Set this to the list of libraries whose interface is included when " - "an IMPORTED library target is linked to another target. " - "The libraries will be included on the link line for the target. " - "Unlike the LINK_INTERFACE_LIBRARIES property, this property applies " - "to all imported target types, including STATIC libraries. " - "This property is ignored for non-imported targets.\n" - "This property is ignored if the target also has a non-empty " - "INTERFACE_LINK_LIBRARIES property.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration.\n" - "This property is ignored if the target also has a non-empty " - "INTERFACE_LINK_LIBRARIES property.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LANGUAGES", cmProperty::TARGET, - "Languages compiled into an IMPORTED static library.", - "Set this to the list of languages of source files compiled to " - "produce a STATIC IMPORTED library (such as \"C\" or \"CXX\"). " - "CMake accounts for these languages when computing how to link a " - "target to the imported library. " - "For example, when a C executable links to an imported C++ static " - "library CMake chooses the C++ linker to satisfy language runtime " - "dependencies of the static library. " - "\n" - "This property is ignored for targets that are not STATIC libraries. " - "This property is ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_MULTIPLICITY", cmProperty::TARGET, - "Repetition count for cycles of IMPORTED static libraries.", - "This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets."); - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.", - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LOCATION", cmProperty::TARGET, - "Full path to the main file on disk for an IMPORTED target.", - "Set this to the location of an IMPORTED target file on disk. " - "For executables this is the location of the executable file. " - "For bundles on OS X this is the location of the executable file " - "inside Contents/MacOS under the application bundle folder. " - "For static libraries and modules this is the location of the " - "library or module. " - "For shared libraries on non-DLL platforms this is the location of " - "the shared library. " - "For frameworks on OS X this is the location of the library file " - "symlink just inside the framework folder. " - "For DLLs this is the location of the \".dll\" part of the library. " - "For UNKNOWN libraries this is the location of the file to be linked. " - "Ignored for non-imported targets." - "\n" - "Projects may skip IMPORTED_LOCATION if the configuration-specific " - "property IMPORTED_LOCATION_<CONFIG> is set. " - "To get the location of an imported target read one of the " - "LOCATION or LOCATION_<CONFIG> properties."); - - cm->DefineProperty - ("IMPORTED_LOCATION_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LOCATION property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_SONAME", cmProperty::TARGET, - "The \"soname\" of an IMPORTED target of shared library type.", - "Set this to the \"soname\" embedded in an imported shared library. " - "This is meaningful only on platforms supporting the feature. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_SONAME_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_SONAME property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_NO_SONAME", cmProperty::TARGET, - "Specifies that an IMPORTED shared library target has no \"soname\". ", - "Set this property to true for an imported shared library file that " - "has no \"soname\" field. " - "CMake may adjust generated link commands for some platforms to prevent " - "the linker from using the path to the library in place of its missing " - "soname. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_NO_SONAME_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_NO_SONAME property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("EXCLUDE_FROM_ALL", cmProperty::TARGET, - "Exclude the target from the all target.", - "A property on a target that indicates if the target is excluded " - "from the default build target. If it is not, then with a Makefile " - "for example typing make will cause this target to be built. " - "The same concept applies to the default build of other generators. " - "Installing a target with EXCLUDE_FROM_ALL set to true has " - "undefined behavior."); - - cm->DefineProperty - ("LINK_LIBRARIES", cmProperty::TARGET, - "List of direct link dependencies.", - "This property specifies the list of libraries or targets which will be " - "used for linking. " - "In addition to accepting values from the target_link_libraries " - "command, values may be set directly on any target using the " - "set_property command. " - "\n" - "The target property values are used by the generators to set " - "the link libraries for the compiler. " - "See also the target_link_libraries command.\n" - "Contents of LINK_LIBRARIES may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of preprocessor include file search directories.", - "This property specifies the list of directories given " - "so far to the include_directories command. " - "This property exists on directories and targets. " - "In addition to accepting values from the include_directories " - "command, values may be set directly on any directory or any " - "target using the set_property command. " - "A target gets its initial value for this property from the value " - "of the directory property. " - "A directory gets its initial value from its parent directory if " - "it has one. " - "Both directory and target property values are adjusted by calls " - "to the include_directories command." - "\n" - "The target property values are used by the generators to set " - "the include paths for the compiler. " - "See also the include_directories command.\n" - "Contents of INCLUDE_DIRECTORIES may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INSTALL_NAME_DIR", cmProperty::TARGET, - "Mac OSX directory name for installed targets.", - "INSTALL_NAME_DIR is a string specifying the " - "directory portion of the \"install_name\" field of shared libraries " - "on Mac OSX to use in the installed targets. "); - - cm->DefineProperty - ("INSTALL_RPATH", cmProperty::TARGET, - "The rpath to use for installed targets.", - "A semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "This property is initialized by the value of the variable " - "CMAKE_INSTALL_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("INSTALL_RPATH_USE_LINK_PATH", cmProperty::TARGET, - "Add paths to linker search and installed rpath.", - "INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will " - "append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "This property is initialized by the value of the variable " - "CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a target is " - "created."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION", cmProperty::TARGET, - "Enable interprocedural optimization for a target.", - "If set to true, enables interprocedural optimizations " - "if they are known to be supported by the compiler."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION_<CONFIG>", cmProperty::TARGET, - "Per-configuration interprocedural optimization for a target.", - "This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. " - "If set, this property overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("LABELS", cmProperty::TARGET, - "Specify a list of text labels associated with a target.", - "Target label semantics are currently unspecified."); - - cm->DefineProperty - ("LINK_FLAGS", cmProperty::TARGET, - "Additional flags to use when linking this target.", - "The LINK_FLAGS property can be used to add extra flags to the " - "link step of a target. LINK_FLAGS_<CONFIG> will add to the " - "configuration <CONFIG>, " - "for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. "); - - cm->DefineProperty - ("LINK_FLAGS_<CONFIG>", cmProperty::TARGET, - "Per-configuration linker flags for a target.", - "This is the configuration-specific version of LINK_FLAGS."); - -#define CM_LINK_SEARCH_SUMMARY \ - "Some linkers support switches such as -Bstatic and -Bdynamic " \ - "to determine whether to use static or shared libraries for -lXXX " \ - "options. CMake uses these options to set the link type for " \ - "libraries whose full paths are not known or (in some cases) are in " \ - "implicit link directories for the platform. " - - cm->DefineProperty - ("LINK_SEARCH_START_STATIC", cmProperty::TARGET, - "Assume the linker looks for static libraries by default.", - CM_LINK_SEARCH_SUMMARY - "By default the linker search type is assumed to be -Bdynamic at " - "the beginning of the library list. This property switches the " - "assumption to -Bstatic. It is intended for use when linking an " - "executable statically (e.g. with the GNU -static option). " - "See also LINK_SEARCH_END_STATIC."); - - cm->DefineProperty - ("LINK_SEARCH_END_STATIC", cmProperty::TARGET, - "End a link line such that static system libraries are used.", - CM_LINK_SEARCH_SUMMARY - "By default CMake adds an option at the end of the library list (if " - "necessary) to set the linker search type back to its starting type. " - "This property switches the final linker search type to -Bstatic " - "regardless of how it started. " - "See also LINK_SEARCH_START_STATIC."); - - cm->DefineProperty - ("LINKER_LANGUAGE", cmProperty::TARGET, - "Specifies language whose compiler will invoke the linker.", - "For executables, shared libraries, and modules, this sets the " - "language whose compiler is used to link the target " - "(such as \"C\" or \"CXX\"). " - "A typical value for an executable is the language of the source " - "file providing the program entry point (main). " - "If not set, the language with the highest linker preference " - "value is the default. " - "See documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables." - "\n" - "If this property is not set by the user, it will be calculated at " - "generate-time by CMake." - ); - - cm->DefineProperty - ("LOCATION", cmProperty::TARGET, - "Read-only location of a target on disk.", - "For an imported target, this read-only property returns the value of " - "the LOCATION_<CONFIG> property for an unspecified configuration " - "<CONFIG> provided by the target.\n" - "For a non-imported target, this property is provided for compatibility " - "with CMake 2.4 and below. " - "It was meant to get the location of an executable target's output file " - "for use in add_custom_command. " - "The path may contain a build-system-specific portion that " - "is replaced at build time with the configuration getting built " - "(such as \"$(ConfigurationName)\" in VS). " - "In CMake 2.6 and above add_custom_command automatically recognizes a " - "target name in its COMMAND and DEPENDS options and computes the " - "target location. " - "In CMake 2.8.4 and above add_custom_command recognizes generator " - "expressions to refer to target locations anywhere in the command. " - "Therefore this property is not needed for creating custom commands." - CM_LOCATION_UNDEFINED_BEHAVIOR("reading this property")); - - cm->DefineProperty - ("LOCATION_<CONFIG>", cmProperty::TARGET, - "Read-only property providing a target location on disk.", - "A read-only property that indicates where a target's main file is " - "located on disk for the configuration <CONFIG>. " - "The property is defined only for library and executable targets. " - "An imported target may provide a set of configurations different " - "from that of the importing project. " - "By default CMake looks for an exact-match but otherwise uses an " - "arbitrary available configuration. " - "Use the MAP_IMPORTED_CONFIG_<CONFIG> property to map imported " - "configurations explicitly." - CM_LOCATION_UNDEFINED_BEHAVIOR("reading this property")); - - cm->DefineProperty - ("LINK_DEPENDS", cmProperty::TARGET, - "Additional files on which a target binary depends for linking.", - "Specifies a semicolon-separated list of full-paths to files on which " - "the link rule for this target depends. " - "The target binary will be linked if any of the named files is newer " - "than it." - "\n" - "This property is ignored by non-Makefile generators. " - "It is intended to specify dependencies on \"linker scripts\" for " - "custom Makefile link rules."); - - cm->DefineProperty - ("LINK_DEPENDS_NO_SHARED", cmProperty::TARGET, - "Do not depend on linked shared library files.", - "Set this property to true to tell CMake generators not to add " - "file-level dependencies on the shared library files linked by " - "this target. " - "Modification to the shared libraries will not be sufficient to " - "re-link this target. " - "Logical target-level dependencies will not be affected so the " - "linked shared libraries will still be brought up to date before " - "this target is built." - "\n" - "This property is initialized by the value of the variable " - "CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is " - "created."); - - cm->DefineProperty - ("LINK_INTERFACE_LIBRARIES", cmProperty::TARGET, - "List public interface libraries for a shared library or executable.", - "By default linking to a shared library target transitively " - "links to targets with which the library itself was linked. " - "For an executable with exports (see the ENABLE_EXPORTS property) " - "no default transitive link dependencies are used. " - "This property replaces the default transitive link dependencies with " - "an explicit list. " - "When the target is linked into another target the libraries " - "listed (and recursively their link interface libraries) will be " - "provided to the other target also. " - "If the list is empty then no transitive link dependencies will be " - "incorporated when this target is linked into another target even if " - "the default set is non-empty. " - "This property is initialized by the value of the variable " - "CMAKE_LINK_INTERFACE_LIBRARIES if it is set when a target is " - "created. " - "This property is ignored for STATIC libraries.\n" - "This property is overriden by the INTERFACE_LINK_LIBRARIES property if " - "policy CMP0022 is NEW.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "Per-configuration list of public interface libraries for a target.", - "This is the configuration-specific version of " - "LINK_INTERFACE_LIBRARIES. " - "If set, this property completely overrides the generic property " - "for the named configuration.\n" - "This property is overriden by the INTERFACE_LINK_LIBRARIES property if " - "policy CMP0022 is NEW.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("INTERFACE_LINK_LIBRARIES", cmProperty::TARGET, - "List public interface libraries for a shared library or executable.", - "This property contains the list of transitive link dependencies. " - "When the target is linked into another target the libraries " - "listed (and recursively their link interface libraries) will be " - "provided to the other target also. " - "This property is overriden by the LINK_INTERFACE_LIBRARIES or " - "LINK_INTERFACE_LIBRARIES_<CONFIG> property if " - "policy CMP0022 is OLD or unset.\n" - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of public include directories for a library.", - "Targets may populate this property to publish the include directories " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own INCLUDE_DIRECTORIES property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the " - "include directories specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_SYSTEM_INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of public system include directories for a library.", - "Targets may populate this property to publish the include directories " - "which contain system headers, and therefore should not result in " - "compiler warnings. Consuming targets will then mark the same include " - "directories as system headers." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_COMPILE_DEFINITIONS", cmProperty::TARGET, - "List of public compile definitions for a library.", - "Targets may populate this property to publish the compile definitions " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own COMPILE_DEFINITIONS property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the " - "compile definitions specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("LINK_INTERFACE_MULTIPLICITY", cmProperty::TARGET, - "Repetition count for STATIC libraries with cyclic dependencies.", - "When linking to a STATIC library target with cyclic dependencies the " - "linker may need to scan more than once through the archives in the " - "strongly connected component of the dependency graph. " - "CMake by default constructs the link line so that the linker will " - "scan through the component at least twice. " - "This property specifies the minimum number of scans if it is larger " - "than the default. " - "CMake uses the largest value specified by any target in a component."); - cm->DefineProperty - ("LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET, - "Per-configuration repetition count for cycles of STATIC libraries.", - "This is the configuration-specific version of " - "LINK_INTERFACE_MULTIPLICITY. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::TARGET, - "Map from project configuration to IMPORTED target's configuration.", - "Set this to the list of configurations of an imported target that " - "may be used for the current project's <CONFIG> configuration. " - "Targets imported from another project may not provide the same set " - "of configuration names available in the current project. " - "Setting this property tells CMake what imported configurations are " - "suitable for use when building the <CONFIG> configuration. " - "The first configuration in the list found to be provided by the " - "imported target is selected. If this property is set and no matching " - "configurations are available, then the imported target is considered " - "to be not found. This property is ignored for non-imported targets.\n" - "This property is initialized by the value of the variable " - "CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is " - "created.", - false /* TODO: make this chained */ ); - - cm->DefineProperty - ("NO_SYSTEM_FROM_IMPORTED", cmProperty::TARGET, - "Do not treat includes from IMPORTED target interfaces as SYSTEM.", - "The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets " - "are treated as SYSTEM includes by default. If this property is " - "enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED " - "targets are not treated as system includes. " - "This property is initialized by the value of the variable " - "CMAKE_NO_SYSTEM_FROM_IMPORTED if it is set when a target is " - "created."); - - cm->DefineProperty - ("OSX_ARCHITECTURES", cmProperty::TARGET, - "Target specific architectures for OS X.", - "The OSX_ARCHITECTURES property sets the target binary architecture " - "for targets on OS X. " - "This property is initialized by the value of the variable " - "CMAKE_OSX_ARCHITECTURES if it is set when a target is created. " - "Use OSX_ARCHITECTURES_<CONFIG> to set the binary architectures on a " - "per-configuration basis. " - "<CONFIG> is an upper-case name (ex: \"OSX_ARCHITECTURES_DEBUG\")."); - - cm->DefineProperty - ("OSX_ARCHITECTURES_<CONFIG>", cmProperty::TARGET, - "Per-configuration OS X binary architectures for a target.", - "This property is the configuration-specific version of " - "OSX_ARCHITECTURES."); - - cm->DefineProperty - ("NAME", cmProperty::TARGET, - "Logical name for the target.", - "Read-only logical name for the target as used by CMake."); - - cm->DefineProperty - ("EXPORT_NAME", cmProperty::TARGET, - "Exported name for target files.", - "This sets the name for the IMPORTED target generated when it this " - "target is is exported. " - "If not set, the logical target name is used by default."); - - cm->DefineProperty - ("OUTPUT_NAME", cmProperty::TARGET, - "Output name for target files.", - "This sets the base name for output files created for an executable or " - "library target. " - "If not set, the logical target name is used by default."); - - cm->DefineProperty - ("OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration target file base name.", - "This is the configuration-specific version of OUTPUT_NAME."); - - cm->DefineProperty - ("ALIASED_TARGET", cmProperty::TARGET, - "Name of target aliased by this target.", - "If this is an ALIAS target, this property contains the name of the " - "target aliased."); - - cm->DefineProperty - ("<CONFIG>_OUTPUT_NAME", cmProperty::TARGET, - "Old per-configuration target file base name.", - "This is a configuration-specific version of OUTPUT_NAME. " - "Use OUTPUT_NAME_<CONFIG> instead."); - - cm->DefineProperty - ("PDB_NAME", cmProperty::TARGET, - "Output name for MS debug symbols .pdb file from linker.", - "Set the base name for debug symbols file created for an " - "executable or shared library target. " - "If not set, the logical target name is used by default. " - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("PDB_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration name for MS debug symbols .pdb file. ", - "This is the configuration-specific version of PDB_NAME. " - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("PRE_INSTALL_SCRIPT", cmProperty::TARGET, - "Deprecated install support.", - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead."); - - cm->DefineProperty - ("PREFIX", cmProperty::TARGET, - "What comes before the library name.", - "A target property that can be set to override the prefix " - "(such as \"lib\") on a library name."); - - cm->DefineProperty - ("<LANG>_VISIBILITY_PRESET", cmProperty::TARGET, - "Value for symbol visibility compile flags", - "The <LANG>_VISIBILITY_PRESET property determines the value passed in " - "a visibility related compile option, such as -fvisibility= for <LANG>. " - "This property only has an affect for libraries and executables with " - "exports. This property is initialized by the value of the variable " - "CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created."); - - cm->DefineProperty - ("VISIBILITY_INLINES_HIDDEN", cmProperty::TARGET, - "Whether to add a compile flag to hide symbols of inline functions", - "The VISIBILITY_INLINES_HIDDEN property determines whether a flag for " - "hiding symbols for inline functions. the value passed used in " - "a visibility related compile option, such as -fvisibility=. This " - "property only has an affect for libraries and executables with " - "exports. This property is initialized by the value of the variable " - "CMAKE_VISIBILITY_INLINES_HIDDEN if it is set when a target is " - "created."); - - cm->DefineProperty - ("POSITION_INDEPENDENT_CODE", cmProperty::TARGET, - "Whether to create a position-independent target", - "The POSITION_INDEPENDENT_CODE property determines whether position " - "independent executables or shared libraries will be created. " - "This property is true by default for SHARED and MODULE library " - "targets and false otherwise. " - "This property is initialized by the value of the variable " - "CMAKE_POSITION_INDEPENDENT_CODE if it is set when a target is " - "created."); - - cm->DefineProperty - ("INTERFACE_POSITION_INDEPENDENT_CODE", cmProperty::TARGET, - "Whether consumers need to create a position-independent target", - "The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of " - "this target whether they must set their POSITION_INDEPENDENT_CODE " - "property to ON. If this property is set to ON, then the " - "POSITION_INDEPENDENT_CODE property on all consumers will be set to " - "ON. Similarly, if this property is set to OFF, then the " - "POSITION_INDEPENDENT_CODE property on all consumers will be set to " - "OFF. If this property is undefined, then consumers will determine " - "their POSITION_INDEPENDENT_CODE property by other means. Consumers " - "must ensure that the targets that they link to have a consistent " - "requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property."); - - cm->DefineProperty - ("COMPATIBLE_INTERFACE_BOOL", cmProperty::TARGET, - "Properties which must be compatible with their link interface", - "The COMPATIBLE_INTERFACE_BOOL property may contain a list of properties" - "for this target which must be consistent when evaluated as a boolean " - "in the INTERFACE of all linked dependees. For example, if a " - "property \"FOO\" appears in the list, then for each dependee, the " - "\"INTERFACE_FOO\" property content in all of its dependencies must be " - "consistent with each other, and with the \"FOO\" property in the " - "dependee. Consistency in this sense has the meaning that if the " - "property is set, then it must have the same boolean value as all " - "others, and if the property is not set, then it is ignored. Note that " - "for each dependee, the set of properties from this property must not " - "intersect with the set of properties from the " - "COMPATIBLE_INTERFACE_STRING property."); - - cm->DefineProperty - ("COMPATIBLE_INTERFACE_STRING", cmProperty::TARGET, - "Properties which must be string-compatible with their link interface", - "The COMPATIBLE_INTERFACE_STRING property may contain a list of " - "properties for this target which must be the same when evaluated as " - "a string in the INTERFACE of all linked dependees. For example, " - "if a property \"FOO\" appears in the list, then for each dependee, the " - "\"INTERFACE_FOO\" property content in all of its dependencies must be " - "equal with each other, and with the \"FOO\" property in the dependee. " - "If the property is not set, then it is ignored. Note that for each " - "dependee, the set of properties from this property must not intersect " - "with the set of properties from the COMPATIBLE_INTERFACE_BOOL " - "property."); - - cm->DefineProperty - ("POST_INSTALL_SCRIPT", cmProperty::TARGET, - "Deprecated install support.", - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead."); - - cm->DefineProperty - ("PRIVATE_HEADER", cmProperty::TARGET, - "Specify private header files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of header files to be placed " - "in the PrivateHeaders directory inside the framework folder. " - "On non-Apple platforms these headers may be installed using the " - "PRIVATE_HEADER option to the install(TARGETS) command."); - - cm->DefineProperty - ("PUBLIC_HEADER", cmProperty::TARGET, - "Specify public header files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of header files to be placed " - "in the Headers directory inside the framework folder. " - "On non-Apple platforms these headers may be installed using the " - "PUBLIC_HEADER option to the install(TARGETS) command."); - - cm->DefineProperty - ("RESOURCE", cmProperty::TARGET, - "Specify resource files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of files to be placed " - "in the Resources directory inside the framework folder. " - "On non-Apple platforms these files may be installed using the " - "RESOURCE option to the install(TARGETS) command."); - - cm->DefineProperty ("RULE_LAUNCH_COMPILE", cmProperty::TARGET, - "Specify a launcher for compile rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_LINK", cmProperty::TARGET, - "Specify a launcher for link rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_CUSTOM", cmProperty::TARGET, - "Specify a launcher for custom rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); - - cm->DefineProperty - ("SKIP_BUILD_RPATH", cmProperty::TARGET, - "Should rpaths be used for the build tree.", - "SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic " - "generation of an rpath allowing the target to run from the " - "build tree. " - "This property is initialized by the value of the variable " - "CMAKE_SKIP_BUILD_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("NO_SONAME", cmProperty::TARGET, - "Whether to set \"soname\" when linking a shared library or module.", - "Enable this boolean property if a generated shared library or module " - "should not have \"soname\" set. Default is to set \"soname\" on all " - "shared libraries and modules as long as the platform supports it. " - "Generally, use this property only for leaf private libraries or " - "plugins. If you use it on normal shared libraries which other targets " - "link against, on some platforms a linker will insert a full path to " - "the library (as specified at link time) into the dynamic section of " - "the dependent binary. Therefore, once installed, dynamic loader may " - "eventually fail to locate the library for the binary."); - - cm->DefineProperty - ("SOVERSION", cmProperty::TARGET, - "What version number is this target.", - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "SOVERSION is ignored if NO_SONAME property is set. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. "); - - cm->DefineProperty - ("STATIC_LIBRARY_FLAGS", cmProperty::TARGET, - "Extra flags to use when linking static libraries.", - "Extra flags to use when linking a static library."); - - cm->DefineProperty - ("STATIC_LIBRARY_FLAGS_<CONFIG>", cmProperty::TARGET, - "Per-configuration flags for creating a static library.", - "This is the configuration-specific version of STATIC_LIBRARY_FLAGS."); - - cm->DefineProperty - ("SUFFIX", cmProperty::TARGET, - "What comes after the target name.", - "A target property that can be set to override the suffix " - "(such as \".so\" or \".exe\") on the name of a library, module or " - "executable."); - - cm->DefineProperty - ("TYPE", cmProperty::TARGET, - "The type of the target.", - "This read-only property can be used to test the type of the given " - "target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, " - "SHARED_LIBRARY, EXECUTABLE or one of the internal target types."); - - cm->DefineProperty - ("VERSION", cmProperty::TARGET, - "What version number is this target.", - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "For executables VERSION can be used to specify the build version. " - "When building or installing appropriate symlinks are created if " - "the platform supports symlinks. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. "); - - - cm->DefineProperty - ("WIN32_EXECUTABLE", cmProperty::TARGET, - "Build an executable with a WinMain entry point on windows.", - "When this property is set to true the executable when linked " - "on Windows will be created with a WinMain() entry point instead " - "of just main(). " - "This makes it a GUI executable instead of a console application. " - "See the CMAKE_MFC_FLAG variable documentation to configure use " - "of MFC for WinMain executables. " - "This property is initialized by the value of the variable " - "CMAKE_WIN32_EXECUTABLE if it is set when a target is created."); - - cm->DefineProperty - ("MACOSX_BUNDLE", cmProperty::TARGET, - "Build an executable as an application bundle on Mac OS X.", - "When this property is set to true the executable when built " - "on Mac OS X will be created as an application bundle. " - "This makes it a GUI executable that can be launched from " - "the Finder. " - "See the MACOSX_BUNDLE_INFO_PLIST target property for information " - "about creation of the Info.plist file for the application bundle. " - "This property is initialized by the value of the variable " - "CMAKE_MACOSX_BUNDLE if it is set when a target is created."); - - cm->DefineProperty - ("MACOSX_BUNDLE_INFO_PLIST", cmProperty::TARGET, - "Specify a custom Info.plist template for a Mac OS X App Bundle.", - "An executable target with MACOSX_BUNDLE enabled will be built as an " - "application bundle on Mac OS X. " - "By default its Info.plist file is created by configuring a template " - "called MacOSXBundleInfo.plist.in located in the CMAKE_MODULE_PATH. " - "This property specifies an alternative template file name which " - "may be a full path.\n" - "The following target properties may be set to specify content to " - "be configured into the file:\n" - " MACOSX_BUNDLE_INFO_STRING\n" - " MACOSX_BUNDLE_ICON_FILE\n" - " MACOSX_BUNDLE_GUI_IDENTIFIER\n" - " MACOSX_BUNDLE_LONG_VERSION_STRING\n" - " MACOSX_BUNDLE_BUNDLE_NAME\n" - " MACOSX_BUNDLE_SHORT_VERSION_STRING\n" - " MACOSX_BUNDLE_BUNDLE_VERSION\n" - " MACOSX_BUNDLE_COPYRIGHT\n" - "CMake variables of the same name may be set to affect all targets " - "in a directory that do not have each specific property set. " - "If a custom Info.plist is specified by this property it may of course " - "hard-code all the settings instead of using the target properties."); - - cm->DefineProperty - ("MACOSX_FRAMEWORK_INFO_PLIST", cmProperty::TARGET, - "Specify a custom Info.plist template for a Mac OS X Framework.", - "A library target with FRAMEWORK enabled will be built as a " - "framework on Mac OS X. " - "By default its Info.plist file is created by configuring a template " - "called MacOSXFrameworkInfo.plist.in located in the CMAKE_MODULE_PATH. " - "This property specifies an alternative template file name which " - "may be a full path.\n" - "The following target properties may be set to specify content to " - "be configured into the file:\n" - " MACOSX_FRAMEWORK_ICON_FILE\n" - " MACOSX_FRAMEWORK_IDENTIFIER\n" - " MACOSX_FRAMEWORK_SHORT_VERSION_STRING\n" - " MACOSX_FRAMEWORK_BUNDLE_VERSION\n" - "CMake variables of the same name may be set to affect all targets " - "in a directory that do not have each specific property set. " - "If a custom Info.plist is specified by this property it may of course " - "hard-code all the settings instead of using the target properties."); - - cm->DefineProperty - ("MACOSX_RPATH", cmProperty::TARGET, - "Whether to use rpaths on Mac OS X.", - "When this property is set to true, the directory portion of the" - "\"install_name\" field of shared libraries will default to \"@rpath\"." - "Runtime paths will also be embedded in binaries using this target." - "This property is initialized by the value of the variable " - "CMAKE_MACOSX_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("ENABLE_EXPORTS", cmProperty::TARGET, - "Specify whether an executable exports symbols for loadable modules.", - "Normally an executable does not export any symbols because it is " - "the final program. It is possible for an executable to export " - "symbols to be used by loadable modules. When this property is " - "set to true CMake will allow other targets to \"link\" to the " - "executable with the TARGET_LINK_LIBRARIES command. " - "On all platforms a target-level dependency on the executable is " - "created for targets that link to it. " - "For DLL platforms an import library will be created for the " - "exported symbols and then used for linking. " - "All Windows-based systems including Cygwin are DLL platforms. " - "For non-DLL platforms that require all symbols to be resolved at " - "link time, such as Mac OS X, the module will \"link\" to the " - "executable using a flag like \"-bundle_loader\". " - "For other non-DLL platforms the link rule is simply ignored since " - "the dynamic loader will automatically bind symbols when the " - "module is loaded. " - ); - - cm->DefineProperty - ("Fortran_FORMAT", cmProperty::TARGET, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This property tells CMake whether the Fortran source files " - "in a target use fixed-format or free-format. " - "CMake will pass the corresponding format flag to the compiler. " - "Use the source-specific Fortran_FORMAT property to change the " - "format of a specific source file. " - "If the variable CMAKE_Fortran_FORMAT is set when a target " - "is created its value is used to initialize this property."); - - cm->DefineProperty - ("Fortran_MODULE_DIRECTORY", cmProperty::TARGET, - "Specify output directory for Fortran modules provided by the target.", - "If the target contains Fortran source files that provide modules " - "and the compiler supports a module output directory this specifies " - "the directory in which the modules will be placed. " - "When this property is not set the modules will be placed in the " - "build directory corresponding to the target's source directory. " - "If the variable CMAKE_Fortran_MODULE_DIRECTORY is set when a target " - "is created its value is used to initialize this property." - "\n" - "Note that some compilers will automatically search the module output " - "directory for modules USEd during compilation but others will not. " - "If your sources USE modules their location must be specified by " - "INCLUDE_DIRECTORIES regardless of this property."); - - cm->DefineProperty - ("GNUtoMS", cmProperty::TARGET, - "Convert GNU import library (.dll.a) to MS format (.lib).", - "When linking a shared library or executable that exports symbols " - "using GNU tools on Windows (MinGW/MSYS) with Visual Studio installed " - "convert the import library (.dll.a) from GNU to MS format (.lib). " - "Both import libraries will be installed by install(TARGETS) and " - "exported by install(EXPORT) and export() to be linked by applications " - "with either GNU- or MS-compatible tools." - "\n" - "If the variable CMAKE_GNUtoMS is set when a target " - "is created its value is used to initialize this property. " - "The variable must be set prior to the first command that enables " - "a language such as project() or enable_language(). " - "CMake provides the variable as an option to the user automatically " - "when configuring on Windows with GNU tools."); - - cm->DefineProperty - ("XCODE_ATTRIBUTE_<an-attribute>", cmProperty::TARGET, - "Set Xcode target attributes directly.", - "Tell the Xcode generator to set '<an-attribute>' to a given value " - "in the generated Xcode project. Ignored on other generators."); - - cm->DefineProperty - ("GENERATOR_FILE_NAME", cmProperty::TARGET, - "Generator's file for this target.", - "An internal property used by some generators to record the name of the " - "project or dsp file associated with this target. Note that at configure " - "time, this property is only set for targets created by " - "include_external_msproject()."); - - cm->DefineProperty - ("SOURCES", cmProperty::TARGET, - "Source names specified for a target.", - "Read-only list of sources specified for a target. " - "The names returned are suitable for passing to the " - "set_source_files_properties command."); - - cm->DefineProperty - ("FOLDER", cmProperty::TARGET, - "Set the folder name. Use to organize targets in an IDE.", - "Targets with no FOLDER property will appear as top level " - "entities in IDEs like Visual Studio. Targets with the same " - "FOLDER property value will appear next to each other in a " - "folder of that name. To nest folders, use FOLDER values such " - "as 'GUI/Dialogs' with '/' characters separating folder levels."); - - cm->DefineProperty - ("PROJECT_LABEL", cmProperty::TARGET, - "Change the name of a target in an IDE.", - "Can be used to change the name of the target in an IDE " - "like Visual Studio. "); - cm->DefineProperty - ("VS_KEYWORD", cmProperty::TARGET, - "Visual Studio project keyword.", - "Can be set to change the visual studio keyword, for example " - "Qt integration works better if this is set to Qt4VSv1.0. "); - cm->DefineProperty - ("VS_SCC_PROVIDER", cmProperty::TARGET, - "Visual Studio Source Code Control Provider.", - "Can be set to change the visual studio source code control " - "provider property."); - cm->DefineProperty - ("VS_SCC_LOCALPATH", cmProperty::TARGET, - "Visual Studio Source Code Control Local Path.", - "Can be set to change the visual studio source code control " - "local path property."); - cm->DefineProperty - ("VS_SCC_PROJECTNAME", cmProperty::TARGET, - "Visual Studio Source Code Control Project.", - "Can be set to change the visual studio source code control " - "project name property."); - cm->DefineProperty - ("VS_SCC_AUXPATH", cmProperty::TARGET, - "Visual Studio Source Code Control Aux Path.", - "Can be set to change the visual studio source code control " - "auxpath property."); - cm->DefineProperty - ("VS_GLOBAL_PROJECT_TYPES", cmProperty::TARGET, - "Visual Studio project type(s).", - "Can be set to one or more UUIDs recognized by Visual Studio " - "to indicate the type of project. This value is copied " - "verbatim into the generated project file. Example for a " - "managed C++ unit testing project:\n" - " {3AC096D0-A1C2-E12C-1390-A8335801FDAB};" - "{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}\n" - "UUIDs are semicolon-delimited."); - cm->DefineProperty - ("VS_GLOBAL_KEYWORD", cmProperty::TARGET, - "Visual Studio project keyword.", - "Sets the \"keyword\" attribute for a generated Visual Studio " - "project. Defaults to \"Win32Proj\". You may wish to override " - "this value with \"ManagedCProj\", for example, in a Visual " - "Studio managed C++ unit test project."); - cm->DefineProperty - ("VS_GLOBAL_ROOTNAMESPACE", cmProperty::TARGET, - "Visual Studio project root namespace.", - "Sets the \"RootNamespace\" attribute for a generated Visual Studio " - "project. The attribute will be generated only if this is set."); - cm->DefineProperty - ("VS_DOTNET_TARGET_FRAMEWORK_VERSION", cmProperty::TARGET, - "Specify the .NET target framework version.", - "Used to specify the .NET target framework version for C++/CLI. " - "For example, \"v4.5\"."); - cm->DefineProperty - ("VS_DOTNET_REFERENCES", cmProperty::TARGET, - "Visual Studio managed project .NET references", - "Adds one or more semicolon-delimited .NET references to a " - "generated Visual Studio project. For example, \"System;" - "System.Windows.Forms\"."); - cm->DefineProperty - ("VS_WINRT_EXTENSIONS", cmProperty::TARGET, - "Visual Studio project C++/CX language extensions for Windows Runtime", - "Can be set to enable C++/CX language extensions."); - cm->DefineProperty - ("VS_WINRT_REFERENCES", cmProperty::TARGET, - "Visual Studio project Windows Runtime Metadata references", - "Adds one or more semicolon-delimited WinRT references to a " - "generated Visual Studio project. For example, \"Windows;" - "Windows.UI.Core\"."); - cm->DefineProperty - ("VS_GLOBAL_<variable>", cmProperty::TARGET, - "Visual Studio project-specific global variable.", - "Tell the Visual Studio generator to set the global variable " - "'<variable>' to a given value in the generated Visual Studio " - "project. Ignored on other generators. Qt integration works " - "better if VS_GLOBAL_QtVersion is set to the version " - "FindQt4.cmake found. For example, \"4.7.3\""); - -#define CM_TARGET_FILE_TYPES_DOC \ - "There are three kinds of target files that may be built: " \ - "archive, library, and runtime. " \ - "Executables are always treated as runtime targets. " \ - "Static libraries are always treated as archive targets. " \ - "Module libraries are always treated as library targets. " \ - "For non-DLL platforms shared libraries are treated as library " \ - "targets. " \ - "For DLL platforms the DLL part of a shared library is treated as " \ - "a runtime target and the corresponding import library is treated as " \ - "an archive target. " \ - "All Windows-based systems including Cygwin are DLL platforms." - -#define CM_TARGET_OUTDIR_DOC(TYPE, type) \ - "This property specifies the directory into which " #type " target " \ - "files should be built. " \ - "Multi-configuration generators (VS, Xcode) append " \ - "a per-configuration subdirectory to the specified directory. " \ - CM_TARGET_FILE_TYPES_DOC " " \ - "This property is initialized by the value of the variable " \ - "CMAKE_" #TYPE "_OUTPUT_DIRECTORY if it is set when a target is created." - -#define CM_TARGET_OUTDIR_CONFIG_DOC(TYPE) \ - "This is a per-configuration version of " #TYPE "_OUTPUT_DIRECTORY, " \ - "but multi-configuration generators (VS, Xcode) do NOT append " \ - "a per-configuration subdirectory to the specified directory. " \ - "This property is initialized by the value of the variable " \ - "CMAKE_" #TYPE "_OUTPUT_DIRECTORY_<CONFIG> " \ - "if it is set when a target is created." - - cm->DefineProperty - ("ARCHIVE_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build ARCHIVE target files.", - CM_TARGET_OUTDIR_DOC(ARCHIVE, archive)); - cm->DefineProperty - ("ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for ARCHIVE target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(ARCHIVE)); - cm->DefineProperty - ("LIBRARY_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build LIBRARY target files.", - CM_TARGET_OUTDIR_DOC(LIBRARY, library)); - cm->DefineProperty - ("LIBRARY_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for LIBRARY target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(LIBRARY)); - cm->DefineProperty - ("RUNTIME_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build RUNTIME target files.", - CM_TARGET_OUTDIR_DOC(RUNTIME, runtime)); - cm->DefineProperty - ("RUNTIME_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for RUNTIME target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(RUNTIME)); - - cm->DefineProperty - ("PDB_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory for MS debug symbols .pdb file from linker.", - "This property specifies the directory into which the MS debug symbols " - "will be placed by the linker. " - "This property is initialized by the value of the variable " - "CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a target is created." - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - cm->DefineProperty - ("PDB_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for MS debug symbols .pdb files.", - "This is a per-configuration version of PDB_OUTPUT_DIRECTORY, " - "but multi-configuration generators (VS, Xcode) do NOT append " - "a per-configuration subdirectory to the specified directory. " - "This property is initialized by the value of the variable " - "CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> " - "if it is set when a target is created." - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("ARCHIVE_OUTPUT_NAME", cmProperty::TARGET, - "Output name for ARCHIVE target files.", - "This property specifies the base name for archive target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("ARCHIVE_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for ARCHIVE target files.", - "This is the configuration-specific version of ARCHIVE_OUTPUT_NAME."); - cm->DefineProperty - ("LIBRARY_OUTPUT_NAME", cmProperty::TARGET, - "Output name for LIBRARY target files.", - "This property specifies the base name for library target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("LIBRARY_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for LIBRARY target files.", - "This is the configuration-specific version of LIBRARY_OUTPUT_NAME."); - cm->DefineProperty - ("RUNTIME_OUTPUT_NAME", cmProperty::TARGET, - "Output name for RUNTIME target files.", - "This property specifies the base name for runtime target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("RUNTIME_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for RUNTIME target files.", - "This is the configuration-specific version of RUNTIME_OUTPUT_NAME."); + "", "", true); } void cmTarget::SetType(TargetType type, const char* name) @@ -1743,6 +372,14 @@ void cmTarget::SetMakefile(cmMakefile* mf) CM_FOR_EACH_TARGET_POLICY(CAPTURE_TARGET_POLICY) #undef CAPTURE_TARGET_POLICY + + if (this->TargetTypeValue == INTERFACE_LIBRARY) + { + // This policy is checked in a few conditions. The properties relevant + // to the policy are always ignored for INTERFACE_LIBRARY targets, + // so ensure that the conditions don't lead to nonsense. + this->PolicyStatusCMP0022 = cmPolicies::NEW; + } } //---------------------------------------------------------------------------- @@ -1808,6 +445,7 @@ bool cmTarget::IsLinkable() this->GetType() == cmTarget::SHARED_LIBRARY || this->GetType() == cmTarget::MODULE_LIBRARY || this->GetType() == cmTarget::UNKNOWN_LIBRARY || + this->GetType() == cmTarget::INTERFACE_LIBRARY || this->IsExecutableWithExports()); } @@ -2579,8 +1217,8 @@ void cmTarget::AddLinkLibrary(cmMakefile& mf, return; } - { cmTarget *tgt = this->Makefile->FindTargetToUse(lib); + { const bool isNonImportedTarget = tgt && !tgt->IsImported(); const std::string libName = (isNonImportedTarget && llt != GENERAL) @@ -2591,7 +1229,8 @@ void cmTarget::AddLinkLibrary(cmMakefile& mf, llt).c_str()); } - if (cmGeneratorExpression::Find(lib) != std::string::npos) + if (cmGeneratorExpression::Find(lib) != std::string::npos + || (tgt && tgt->GetType() == INTERFACE_LIBRARY)) { return; } @@ -4118,6 +2757,43 @@ const char *cmTarget::GetProperty(const char* prop) } //---------------------------------------------------------------------------- +bool cmTarget::HandleLocationPropertyPolicy() +{ + if (this->IsImported()) + { + return true; + } + const char *modal = 0; + cmake::MessageType messageType = cmake::AUTHOR_WARNING; + switch (this->Makefile->GetPolicyStatus(cmPolicies::CMP0026)) + { + case cmPolicies::WARN: + modal = "should"; + case cmPolicies::OLD: + break; + case cmPolicies::REQUIRED_ALWAYS: + case cmPolicies::REQUIRED_IF_USED: + case cmPolicies::NEW: + modal = "may"; + messageType = cmake::FATAL_ERROR; + } + + if (modal) + { + cmOStringStream e; + e << (this->Makefile->GetPolicies() + ->GetPolicyWarning(cmPolicies::CMP0026)) << "\n"; + e << "The LOCATION property " << modal << " not be read from target \"" + << this->GetName() << "\". Use the target name directly with " + "add_custom_command, or use the generator expression $<TARGET_FILE>, " + "as appropriate.\n"; + this->Makefile->IssueMessage(messageType, e.str().c_str()); + } + + return messageType != cmake::FATAL_ERROR; +} + +//---------------------------------------------------------------------------- const char *cmTarget::GetProperty(const char* prop, cmProperty::ScopeType scope) { @@ -4137,10 +2813,16 @@ const char *cmTarget::GetProperty(const char* prop, this->GetType() == cmTarget::STATIC_LIBRARY || this->GetType() == cmTarget::SHARED_LIBRARY || this->GetType() == cmTarget::MODULE_LIBRARY || + this->GetType() == cmTarget::INTERFACE_LIBRARY || this->GetType() == cmTarget::UNKNOWN_LIBRARY) { if(strcmp(prop,"LOCATION") == 0) { + if (!this->HandleLocationPropertyPolicy()) + { + return 0; + } + // Set the LOCATION property of the target. // // For an imported target this is the location of an arbitrary @@ -4156,6 +2838,10 @@ const char *cmTarget::GetProperty(const char* prop, // Support "LOCATION_<CONFIG>". if(strncmp(prop, "LOCATION_", 9) == 0) { + if (!this->HandleLocationPropertyPolicy()) + { + return 0; + } std::string configName = prop+9; this->SetProperty(prop, this->GetLocation(configName.c_str())); } @@ -4168,6 +2854,10 @@ const char *cmTarget::GetProperty(const char* prop, std::string configName(prop, len-9); if(configName != "IMPORTED") { + if (!this->HandleLocationPropertyPolicy()) + { + return 0; + } this->SetProperty(prop, this->GetLocation(configName.c_str())); } } @@ -6061,6 +4751,10 @@ cmTarget::GetImportInfo(const char* config, cmTarget *headTarget) i = this->Internal->ImportInfoMap.insert(entry).first; } + if(this->GetType() == INTERFACE_LIBRARY) + { + return &i->second; + } // If the location is empty then the target is not available for // this configuration. if(i->second.Location.empty() && i->second.ImportLibrary.empty()) @@ -6209,7 +4903,51 @@ void cmTarget::ComputeImportInfo(std::string const& desired_config, const char* loc = 0; const char* imp = 0; std::string suffix; - if (!this->GetMappedConfig(desired_config, &loc, &imp, suffix)) + if (this->GetType() != INTERFACE_LIBRARY && + !this->GetMappedConfig(desired_config, &loc, &imp, suffix)) + { + return; + } + + // Get the link interface. + { + std::string linkProp = "INTERFACE_LINK_LIBRARIES"; + const char *propertyLibs = this->GetProperty(linkProp.c_str()); + + if (this->GetType() != INTERFACE_LIBRARY) + { + if(!propertyLibs) + { + linkProp = "IMPORTED_LINK_INTERFACE_LIBRARIES"; + linkProp += suffix; + propertyLibs = this->GetProperty(linkProp.c_str()); + } + + if(!propertyLibs) + { + linkProp = "IMPORTED_LINK_INTERFACE_LIBRARIES"; + propertyLibs = this->GetProperty(linkProp.c_str()); + } + } + if(propertyLibs) + { + cmListFileBacktrace lfbt; + cmGeneratorExpression ge(lfbt); + + cmGeneratorExpressionDAGChecker dagChecker(lfbt, + this->GetName(), + linkProp, 0, 0); + cmSystemTools::ExpandListArgument(ge.Parse(propertyLibs) + ->Evaluate(this->Makefile, + desired_config.c_str(), + false, + headTarget, + this, + &dagChecker), + info.LinkInterface.Libraries); + } + } + if(this->GetType() == INTERFACE_LIBRARY) { return; } @@ -6286,42 +5024,6 @@ void cmTarget::ComputeImportInfo(std::string const& desired_config, } } - // Get the link interface. - { - std::string linkProp = "INTERFACE_LINK_LIBRARIES"; - const char *propertyLibs = this->GetProperty(linkProp.c_str()); - - if (!propertyLibs) - { - linkProp = "IMPORTED_LINK_INTERFACE_LIBRARIES"; - linkProp += suffix; - propertyLibs = this->GetProperty(linkProp.c_str()); - } - - if(!propertyLibs) - { - linkProp = "IMPORTED_LINK_INTERFACE_LIBRARIES"; - propertyLibs = this->GetProperty(linkProp.c_str()); - } - if(propertyLibs) - { - cmListFileBacktrace lfbt; - cmGeneratorExpression ge(lfbt); - - cmGeneratorExpressionDAGChecker dagChecker(lfbt, - this->GetName(), - linkProp, 0, 0); - cmSystemTools::ExpandListArgument(ge.Parse(propertyLibs) - ->Evaluate(this->Makefile, - desired_config.c_str(), - false, - headTarget, - this, - &dagChecker), - info.LinkInterface.Libraries); - } - } - // Get the link dependencies. { std::string linkProp = "IMPORTED_LINK_DEPENDENT_LIBRARIES"; @@ -6582,6 +5284,11 @@ bool cmTarget::ComputeLinkInterface(const char* config, LinkInterface& iface, } } } + else if (this->GetType() == cmTarget::INTERFACE_LIBRARY) + { + explicitLibraries = newExplicitLibraries; + linkIfaceProp = "INTERFACE_LINK_LIBRARIES"; + } // There is no implicit link interface for executables or modules // so if none was explicitly set then there is no link interface. @@ -6609,7 +5316,8 @@ bool cmTarget::ComputeLinkInterface(const char* config, LinkInterface& iface, this, &dagChecker), iface.Libraries); if(this->GetType() == cmTarget::SHARED_LIBRARY - || this->GetType() == cmTarget::STATIC_LIBRARY) + || this->GetType() == cmTarget::STATIC_LIBRARY + || this->GetType() == cmTarget::INTERFACE_LIBRARY) { // Shared libraries may have runtime implementation dependencies // on other shared libraries that are not in the interface. @@ -6880,13 +5588,16 @@ void checkPropertyConsistency(cmTarget *depender, cmTarget *dependee, std::vector<std::string> props; cmSystemTools::ExpandListArgument(prop, props); + std::string pdir = + dependee->GetMakefile()->GetRequiredDefinition("CMAKE_ROOT"); + pdir += "/Help/prop_tgt/"; for(std::vector<std::string>::iterator pi = props.begin(); pi != props.end(); ++pi) { - if (depender->GetMakefile()->GetCMakeInstance() - ->IsPropertyDefined(pi->c_str(), - cmProperty::TARGET)) + std::string pname = cmSystemTools::HelpFileName(*pi); + std::string pfile = pdir + pname + ".rst"; + if(cmSystemTools::FileExists(pfile.c_str(), true)) { cmOStringStream e; e << "Target \"" << dependee->GetName() << "\" has property \"" diff --git a/Source/cmTarget.h b/Source/cmTarget.h index 27b74ca..3c36da7 100644 --- a/Source/cmTarget.h +++ b/Source/cmTarget.h @@ -72,6 +72,7 @@ public: enum TargetType { EXECUTABLE, STATIC_LIBRARY, SHARED_LIBRARY, MODULE_LIBRARY, OBJECT_LIBRARY, UTILITY, GLOBAL_TARGET, + INTERFACE_LIBRARY, UNKNOWN_LIBRARY}; static const char* GetTargetTypeName(TargetType targetType); enum CustomCommandType { PRE_BUILD, PRE_LINK, POST_BUILD }; @@ -372,7 +373,7 @@ public: /** Get the soname of the target. Allowed only for a shared library. */ std::string GetSOName(const char* config); - /** Whether this library has @rpath and platform supports it. */ + /** Whether this library has \@rpath and platform supports it. */ bool HasMacOSXRpath(const char* config); /** Test for special case of a third-party shared library that has @@ -421,12 +422,12 @@ public: bool IsChrpathUsed(const char* config); /** Return the install name directory for the target in the - * build tree. For example: "@rpath/", "@loader_path/", + * build tree. For example: "\@rpath/", "\@loader_path/", * or "/full/path/to/library". */ std::string GetInstallNameDirForBuildTree(const char* config); /** Return the install name directory for the target in the - * install tree. For example: "@rpath/" or "@loader_path/". */ + * install tree. For example: "\@rpath/" or "\@loader_path/". */ std::string GetInstallNameDirForInstallTree(); cmComputeLinkInformation* GetLinkInformation(const char* config, @@ -553,6 +554,8 @@ public: { return this->TargetTypeValue == STATIC_LIBRARY; } private: + bool HandleLocationPropertyPolicy(); + // The set of include directories that are marked as system include // directories. std::set<cmStdString> SystemIncludeDirectories; diff --git a/Source/cmTargetCompileDefinitionsCommand.h b/Source/cmTargetCompileDefinitionsCommand.h index 585485d..7405e90 100644 --- a/Source/cmTargetCompileDefinitionsCommand.h +++ b/Source/cmTargetCompileDefinitionsCommand.h @@ -38,41 +38,6 @@ public: */ virtual const char* GetName() const { return "target_compile_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add compile definitions to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_compile_definitions(<target> " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify compile definitions to use when compiling a given target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target. " - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the COMPILE_DEFINITIONS property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_COMPILE_DEFINITIONS " - "property of <target>. " - "The following arguments specify compile definitions. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "Arguments to target_compile_definitions may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetCompileDefinitionsCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetCompileOptionsCommand.h b/Source/cmTargetCompileOptionsCommand.h index b9afd71..3713e5a 100644 --- a/Source/cmTargetCompileOptionsCommand.h +++ b/Source/cmTargetCompileOptionsCommand.h @@ -38,43 +38,6 @@ public: */ virtual const char* GetName() const { return "target_compile_options";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add compile options to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_compile_options(<target> [BEFORE] " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify compile options to use when compiling a given target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target. " - "If BEFORE is specified, the content will be prepended to the property " - "instead of being appended.\n" - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the COMPILE_OPTIONS property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_COMPILE_OPTIONS " - "property of <target>. " - "The following arguments specify compile opitions. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "Arguments to target_compile_options may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetCompileOptionsCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetIncludeDirectoriesCommand.h b/Source/cmTargetIncludeDirectoriesCommand.h index fcc37f0..6863ee5 100644 --- a/Source/cmTargetIncludeDirectoriesCommand.h +++ b/Source/cmTargetIncludeDirectoriesCommand.h @@ -39,53 +39,6 @@ public: */ virtual const char* GetName() const { return "target_include_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add include directories to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_include_directories(<target> [SYSTEM] [BEFORE] " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify include directories or targets to use when compiling a given " - "target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target.\n" - "If BEFORE is specified, the content will be prepended to the property " - "instead of being appended.\n" - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the INCLUDE_DIRECTORIES property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_INCLUDE_DIRECTORIES " - "property of <target>. " - "The following arguments specify include directories. Specified " - "include directories may be absolute paths or relative paths. " - "Repeated calls for the same <target> append items in the order called." - "If SYSTEM is specified, the compiler will be told the " - "directories are meant as system include directories on some " - "platforms (signalling this setting might achieve effects such as " - "the compiler skipping warnings, or these fixed-install system files " - "not being considered in dependency calculations - see compiler " - "docs). If SYSTEM is used together with PUBLIC or INTERFACE, the " - "INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be " - "populated with the specified directories." - "\n" - "Arguments to target_include_directories may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetIncludeDirectoriesCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetLinkLibrariesCommand.cxx b/Source/cmTargetLinkLibrariesCommand.cxx index 863b391..22f6a03 100644 --- a/Source/cmTargetLinkLibrariesCommand.cxx +++ b/Source/cmTargetLinkLibrariesCommand.cxx @@ -322,6 +322,15 @@ bool cmTargetLinkLibrariesCommand::HandleLibrary(const char* lib, cmTarget::LinkLibraryType llt) { + if(this->Target->GetType() == cmTarget::INTERFACE_LIBRARY + && this->CurrentProcessingState != ProcessingKeywordLinkInterface) + { + this->Makefile->IssueMessage(cmake::FATAL_ERROR, + "INTERFACE library can only be used with the INTERFACE keyword of " + "target_link_libraries"); + return false; + } + cmTarget::TLLSignature sig = (this->CurrentProcessingState == ProcessingPlainPrivateInterface || this->CurrentProcessingState == ProcessingPlainPublicInterface @@ -407,6 +416,11 @@ cmTargetLinkLibrariesCommand::HandleLibrary(const char* lib, return true; } + if (this->Target->GetType() == cmTarget::INTERFACE_LIBRARY) + { + return true; + } + // Get the list of configurations considered to be DEBUG. std::vector<std::string> const& debugConfigs = this->Makefile->GetCMakeInstance()->GetDebugConfigs(); diff --git a/Source/cmTargetLinkLibrariesCommand.h b/Source/cmTargetLinkLibrariesCommand.h index f2b2543..6fbf722 100644 --- a/Source/cmTargetLinkLibrariesCommand.h +++ b/Source/cmTargetLinkLibrariesCommand.h @@ -13,7 +13,6 @@ #define cmTargetLinkLibrariesCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmTargetLinkLibrariesCommand * \brief Specify a list of libraries to link into executables. @@ -45,151 +44,6 @@ public: */ virtual const char* GetName() const { return "target_link_libraries";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Link a target to given libraries."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_link_libraries(<target> [item1 [item2 [...]]]\n" - " [[debug|optimized|general] <item>] ...)\n" - "Specify libraries or flags to use when linking a given target. " - "The named <target> must have been created in the current directory " - "by a command such as add_executable or add_library. " - "The remaining arguments specify library names or flags. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "If a library name matches that of another target in the project " - "a dependency will automatically be added in the build system to make " - "sure the library being linked is up-to-date before the target links. " - "Item names starting with '-', but not '-l' or '-framework', are " - "treated as linker flags." - "\n" - "A \"debug\", \"optimized\", or \"general\" keyword indicates that " - "the library immediately following it is to be used only for the " - "corresponding build configuration. " - "The \"debug\" keyword corresponds to the Debug configuration " - "(or to configurations named in the DEBUG_CONFIGURATIONS global " - "property if it is set). " - "The \"optimized\" keyword corresponds to all other configurations. " - "The \"general\" keyword corresponds to all configurations, and is " - "purely optional (assumed if omitted). " - "Higher granularity may be achieved for per-configuration rules " - "by creating and linking to IMPORTED library targets. " - "See the IMPORTED mode of the add_library command for more " - "information. " - "\n" - "Library dependencies are transitive by default. " - "When this target is linked into another target then the libraries " - "linked to this target will appear on the link line for the other " - "target too. " - "See the INTERFACE_LINK_LIBRARIES target property to override the " - "set of transitive link dependencies for a target. " - "Calls to other signatures of this command may set the property " - "making any libraries linked exclusively by this signature private." - "\n" - "CMake will also propagate \"usage requirements\" from linked library " - "targets. " - "Usage requirements affect compilation of sources in the <target>. " - "They are specified by properties defined on linked targets. " - "During generation of the build system, CMake integrates " - "usage requirement property values with the corresponding " - "build properties for <target>:\n" - " INTERFACE_COMPILE_DEFINITONS: Appends to COMPILE_DEFINITONS\n" - " INTERFACE_INCLUDE_DIRECTORIES: Appends to INCLUDE_DIRECTORIES\n" - " INTERFACE_POSITION_INDEPENDENT_CODE: Sets POSITION_INDEPENDENT_CODE\n" - " or checked for consistency with existing value\n" - "\n" - "If an <item> is a library in a Mac OX framework, the Headers " - "directory of the framework will also be processed as a \"usage " - "requirement\". This has the same effect as passing the framework " - "directory as an include directory." - " target_link_libraries(<target>\n" - " <PRIVATE|PUBLIC|INTERFACE> <lib> ...\n" - " [<PRIVATE|PUBLIC|INTERFACE> <lib> ... ] ...])\n" - "The PUBLIC, PRIVATE and INTERFACE keywords can be used to specify " - "both the link dependencies and the link interface in one command. " - "Libraries and targets following PUBLIC are linked to, and are " - "made part of the link interface. Libraries and targets " - "following PRIVATE are linked to, but are not made part of the " - "link interface. Libraries following INTERFACE are appended " - "to the link interface and are not used for linking <target>." - "\n" - " target_link_libraries(<target> LINK_INTERFACE_LIBRARIES\n" - " [[debug|optimized|general] <lib>] ...)\n" - "The LINK_INTERFACE_LIBRARIES mode appends the libraries " - "to the INTERFACE_LINK_LIBRARIES target property instead of using them " - "for linking. If policy CMP0022 is not NEW, then this mode also " - "appends libraries to the LINK_INTERFACE_LIBRARIES and its " - "per-configuration equivalent. This signature " - "is for compatibility only. Prefer the INTERFACE mode instead. " - "Libraries specified as \"debug\" are wrapped in a generator " - "expression to correspond to debug builds. If policy CMP0022 is not " - "NEW, the libraries are also appended to the " - "LINK_INTERFACE_LIBRARIES_DEBUG property (or to the properties " - "corresponding to configurations listed in the DEBUG_CONFIGURATIONS " - "global property if it is set). " - "Libraries specified as \"optimized\" are appended to the " - "INTERFACE_LINK_LIBRARIES property. If policy CMP0022 is not NEW, " - "they are also appended to the LINK_INTERFACE_LIBRARIES property. " - "Libraries specified as \"general\" (or without any keyword) are " - "treated as if specified for both \"debug\" and \"optimized\"." - "\n" - " target_link_libraries(<target>\n" - " <LINK_PRIVATE|LINK_PUBLIC>\n" - " [[debug|optimized|general] <lib>] ...\n" - " [<LINK_PRIVATE|LINK_PUBLIC>\n" - " [[debug|optimized|general] <lib>] ...])\n" - "The LINK_PUBLIC and LINK_PRIVATE modes can be used to specify both " - "the link dependencies and the link interface in one command. This " - "signature is for compatibility only. Prefer the PUBLIC or PRIVATE " - "keywords instead. " - "Libraries and targets following LINK_PUBLIC are linked to, and are " - "made part of the INTERFACE_LINK_LIBRARIES. If policy CMP0022 is not " - "NEW, they are also made part of the LINK_INTERFACE_LIBRARIES. " - "Libraries and targets following LINK_PRIVATE are linked to, but are " - "not made part of the INTERFACE_LINK_LIBRARIES (or " - "LINK_INTERFACE_LIBRARIES)." - "\n" - "The library dependency graph is normally acyclic (a DAG), but in the " - "case of mutually-dependent STATIC libraries CMake allows the graph " - "to contain cycles (strongly connected components). " - "When another target links to one of the libraries CMake repeats " - "the entire connected component. " - "For example, the code\n" - " add_library(A STATIC a.c)\n" - " add_library(B STATIC b.c)\n" - " target_link_libraries(A B)\n" - " target_link_libraries(B A)\n" - " add_executable(main main.c)\n" - " target_link_libraries(main A)\n" - "links 'main' to 'A B A B'. " - "(" - "While one repetition is usually sufficient, pathological object " - "file and symbol arrangements can require more. " - "One may handle such cases by manually repeating the component in " - "the last target_link_libraries call. " - "However, if two archives are really so interdependent they should " - "probably be combined into a single archive." - ")" - "\n" - "Arguments to target_link_libraries may use \"generator expressions\" " - "with the syntax \"$<...>\". Note however, that generator expressions " - "will not be used in OLD handling of CMP0003 or CMP0004." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetLinkLibrariesCommand, cmCommand); private: void LinkLibraryTypeSpecifierWarning(int left, int right); diff --git a/Source/cmTargetPropCommandBase.cxx b/Source/cmTargetPropCommandBase.cxx index 1862cb6..e7b6999 100644 --- a/Source/cmTargetPropCommandBase.cxx +++ b/Source/cmTargetPropCommandBase.cxx @@ -47,6 +47,7 @@ bool cmTargetPropCommandBase && (this->Target->GetType() != cmTarget::STATIC_LIBRARY) && (this->Target->GetType() != cmTarget::OBJECT_LIBRARY) && (this->Target->GetType() != cmTarget::MODULE_LIBRARY) + && (this->Target->GetType() != cmTarget::INTERFACE_LIBRARY) && (this->Target->GetType() != cmTarget::EXECUTABLE)) { this->SetError("called with non-compilable target type"); @@ -112,6 +113,14 @@ bool cmTargetPropCommandBase return false; } + if (this->Target->GetType() == cmTarget::INTERFACE_LIBRARY + && scope != "INTERFACE") + { + this->SetError("may only be set INTERFACE properties on INTERFACE " + "targets"); + return false; + } + ++argIndex; std::vector<std::string> content; diff --git a/Source/cmTargetPropCommandBase.h b/Source/cmTargetPropCommandBase.h index 690582f..c402836 100644 --- a/Source/cmTargetPropCommandBase.h +++ b/Source/cmTargetPropCommandBase.h @@ -14,7 +14,6 @@ #define cmTargetPropCommandBase_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" class cmTarget; diff --git a/Source/cmTest.cxx b/Source/cmTest.cxx index 0904431..9cda978 100644 --- a/Source/cmTest.cxx +++ b/Source/cmTest.cxx @@ -92,114 +92,3 @@ void cmTest::AppendProperty(const char* prop, const char* value, bool asString) } this->Properties.AppendProperty(prop, value, cmProperty::TEST, asString); } - -//---------------------------------------------------------------------------- -void cmTest::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("ATTACHED_FILES", cmProperty::TEST, - "Attach a list of files to a dashboard submission.", - "Set this property to a list of files that will be encoded and " - "submitted to the dashboard as an addition to the test result."); - - cm->DefineProperty - ("ATTACHED_FILES_ON_FAIL", cmProperty::TEST, - "Attach a list of files to a dashboard submission if the test fails.", - "Same as ATTACHED_FILES, but these files will only be included if the " - "test does not pass."); - - cm->DefineProperty - ("COST", cmProperty::TEST, - "Set this to a floating point value. Tests in a test set will be " - "run in descending order of cost.", "This property describes the cost " - "of a test. You can explicitly set this value; tests with higher COST " - "values will run first."); - - cm->DefineProperty - ("DEPENDS", cmProperty::TEST, - "Specifies that this test should only be run after the specified " - "list of tests.", - "Set this to a list of tests that must finish before this test is run."); - - cm->DefineProperty - ("ENVIRONMENT", cmProperty::TEST, - "Specify environment variables that should be defined for running " - "a test.", - "If set to a list of environment variables and values of the form " - "MYVAR=value those environment variables will be defined while " - "running the test. The environment is restored to its previous state " - "after the test is done."); - - cm->DefineProperty - ("FAIL_REGULAR_EXPRESSION", cmProperty::TEST, - "If the output matches this regular expression the test will fail.", - "If set, if the output matches one of " - "specified regular expressions, the test will fail." - "For example: FAIL_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\""); - - cm->DefineProperty - ("LABELS", cmProperty::TEST, - "Specify a list of text labels associated with a test.", - "The list is reported in dashboard submissions."); - - cm->DefineProperty - ("RESOURCE_LOCK", cmProperty::TEST, - "Specify a list of resources that are locked by this test.", - "If multiple tests specify the same resource lock, they are guaranteed " - "not to run concurrently."); - - cm->DefineProperty - ("MEASUREMENT", cmProperty::TEST, - "Specify a CDASH measurement and value to be reported for a test.", - "If set to a name then that name will be reported to CDASH as a " - "named measurement with a value of 1. You may also specify a value " - "by setting MEASUREMENT to \"measurement=value\"."); - - cm->DefineProperty - ("PASS_REGULAR_EXPRESSION", cmProperty::TEST, - "The output must match this regular expression for the test to pass.", - "If set, the test output will be checked " - "against the specified regular expressions and at least one of the" - " regular expressions has to match, otherwise the test will fail."); - - cm->DefineProperty - ("PROCESSORS", cmProperty::TEST, - "How many process slots this test requires", - "Denotes the number of processors that this test will require. This is " - "typically used for MPI tests, and should be used in conjunction with " - "the ctest_test PARALLEL_LEVEL option."); - - cm->DefineProperty - ("REQUIRED_FILES", cmProperty::TEST, - "List of files required to run the test.", - "If set to a list of files, the test will not be run unless all of the " - "files exist."); - - cm->DefineProperty - ("RUN_SERIAL", cmProperty::TEST, - "Do not run this test in parallel with any other test.", - "Use this option in conjunction with the ctest_test PARALLEL_LEVEL " - "option to specify that this test should not be run in parallel with " - "any other tests."); - - cm->DefineProperty - ("TIMEOUT", cmProperty::TEST, - "How many seconds to allow for this test.", - "This property if set will limit a test to not take more than " - "the specified number of seconds to run. If it exceeds that the " - "test process will be killed and ctest will move to the next test. " - "This setting takes precedence over " - "CTEST_TESTING_TIMEOUT."); - - cm->DefineProperty - ("WILL_FAIL", cmProperty::TEST, - "If set to true, this will invert the pass/fail flag of the test.", - "This property can be used for tests that are expected to fail and " - "return a non zero return code."); - - cm->DefineProperty - ("WORKING_DIRECTORY", cmProperty::TEST, - "The directory from which the test executable will be called.", - "If this is not set it is called from the directory the test executable " - "is located in."); -} diff --git a/Source/cmTest.h b/Source/cmTest.h index 73ac133..1fe8fc0 100644 --- a/Source/cmTest.h +++ b/Source/cmTest.h @@ -52,9 +52,6 @@ public: bool GetPropertyAsBool(const char *prop) const; cmPropertyMap &GetProperties() { return this->Properties; }; - // Define the properties - static void DefineProperties(cmake *cm); - /** Get the cmMakefile instance that owns this test. */ cmMakefile *GetMakefile() { return this->Makefile;}; diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h index a20594c..8e6bbc1 100644 --- a/Source/cmTryCompileCommand.h +++ b/Source/cmTryCompileCommand.h @@ -42,81 +42,6 @@ public: */ virtual const char* GetName() const { return "try_compile";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Try building some code."; - } - - /** - * More documentation. */ - virtual const char* GetFullDocumentation() const - { - return - " try_compile(RESULT_VAR <bindir> <srcdir>\n" - " <projectName> [targetName] [CMAKE_FLAGS flags...]\n" - " [OUTPUT_VARIABLE <var>])\n" - "Try building a project. In this form, srcdir should contain a " - "complete CMake project with a CMakeLists.txt file and all sources. " - "The bindir and srcdir will not be deleted after this command is run. " - "Specify targetName to build a specific target instead of the 'all' or " - "'ALL_BUILD' target." - "\n" - " try_compile(RESULT_VAR <bindir> <srcfile|SOURCES srcfile...>\n" - " [CMAKE_FLAGS flags...]\n" - " [COMPILE_DEFINITIONS flags...]\n" - " [LINK_LIBRARIES libs...]\n" - " [OUTPUT_VARIABLE <var>]\n" - " [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]])\n" - "Try building an executable from one or more source files. " - "In this form the user need only supply one or more source files " - "that include a definition for 'main'. " - "CMake will create a CMakeLists.txt file to build the source(s) " - "as an executable. " - "Specify COPY_FILE to get a copy of the linked executable at the " - "given fileName and optionally COPY_FILE_ERROR to capture any error." - "\n" - "In this version all files in bindir/CMakeFiles/CMakeTmp " - "will be cleaned automatically. For debugging, --debug-trycompile can " - "be passed to cmake to avoid this clean. However, multiple sequential " - "try_compile operations reuse this single output directory. If you " - "use --debug-trycompile, you can only debug one try_compile call at a " - "time. The recommended procedure is to configure with cmake all the " - "way through once, then delete the cache entry associated with " - "the try_compile call of interest, and then re-run cmake again with " - "--debug-trycompile." - "\n" - "Some extra flags that can be included are, " - "INCLUDE_DIRECTORIES, LINK_DIRECTORIES, and LINK_LIBRARIES. " - "COMPILE_DEFINITIONS are -Ddefinition that will be passed to the " - "compile line.\n" - "The srcfile signature also accepts a LINK_LIBRARIES argument which " - "may contain a list of libraries or IMPORTED targets which will be " - "linked to in the generated project. If LINK_LIBRARIES is specified " - "as a parameter to try_compile, then any LINK_LIBRARIES passed as " - "CMAKE_FLAGS will be ignored.\n" - "try_compile creates a CMakeList.txt " - "file on the fly that looks like this:\n" - " add_definitions( <expanded COMPILE_DEFINITIONS from calling " - "cmake>)\n" - " include_directories(${INCLUDE_DIRECTORIES})\n" - " link_directories(${LINK_DIRECTORIES})\n" - " add_executable(cmTryCompileExec sources)\n" - " target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})\n" - "In both versions of the command, " - "if OUTPUT_VARIABLE is specified, then the " - "output from the build process is stored in the given variable. " - "The success or failure of the try_compile, i.e. TRUE or FALSE " - "respectively, is returned in " - "RESULT_VAR. CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags " - "to the cmake that is run during the build. " - "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build " - "configuration." - ; - } - cmTypeMacro(cmTryCompileCommand, cmCoreTryCompile); }; diff --git a/Source/cmTryRunCommand.h b/Source/cmTryRunCommand.h index 13b9973..d0bf9ce 100644 --- a/Source/cmTryRunCommand.h +++ b/Source/cmTryRunCommand.h @@ -42,63 +42,6 @@ public: */ virtual const char* GetName() const { return "try_run";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Try compiling and then running some code."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR\n" - " bindir srcfile [CMAKE_FLAGS <Flags>]\n" - " [COMPILE_DEFINITIONS <flags>]\n" - " [COMPILE_OUTPUT_VARIABLE comp]\n" - " [RUN_OUTPUT_VARIABLE run]\n" - " [OUTPUT_VARIABLE var]\n" - " [ARGS <arg1> <arg2>...])\n" - "Try compiling a srcfile. Return TRUE or FALSE for success or failure " - "in COMPILE_RESULT_VAR. Then if the compile succeeded, run the " - "executable and return its exit code in RUN_RESULT_VAR. " - "If the executable was built, but failed to run, then RUN_RESULT_VAR " - "will be set to FAILED_TO_RUN. " - "COMPILE_OUTPUT_VARIABLE specifies the variable where the output from " - "the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable " - "where the output from the running executable goes.\n" - "For compatibility reasons OUTPUT_VARIABLE is still supported, which " - "gives you the output from the compile and run step combined.\n" - "Cross compiling issues\n" - "When cross compiling, the executable compiled in the first step " - "usually cannot be run on the build host. try_run() checks the " - "CMAKE_CROSSCOMPILING variable to detect whether CMake is in " - "crosscompiling mode. If that's the case, it will still try to compile " - "the executable, but it will not try to run the executable. Instead it " - "will create cache variables which must be filled by the user or by " - "presetting them in some CMake script file to the values the " - "executable would have produced if it had been run on its actual " - "target platform. These variables are RUN_RESULT_VAR (explanation see " - "above) and if RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an " - "additional cache variable " - "RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT." - "This is intended to hold stdout and stderr from the executable.\n" - "In order to make cross compiling your project easier, use try_run " - "only if really required. If you use try_run, use RUN_OUTPUT_VARIABLE " - "(or OUTPUT_VARIABLE) only if really required. Using them will require " - "that when crosscompiling, the cache variables will have to be set " - "manually to the output of the executable. You can also \"guard\" the " - "calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an " - "easy-to-preset alternative for this case.\n" - "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build " - "configuration." - ; - } - cmTypeMacro(cmTryRunCommand, cmCoreTryCompile); private: void RunExecutable(const std::string& runArgs, diff --git a/Source/cmUnsetCommand.cxx b/Source/cmUnsetCommand.cxx index 5c0cfaa..84f3029 100644 --- a/Source/cmUnsetCommand.cxx +++ b/Source/cmUnsetCommand.cxx @@ -49,7 +49,13 @@ bool cmUnsetCommand::InitialPass(std::vector<std::string> const& args, this->Makefile->RemoveCacheDefinition(variable); return true; } - // ERROR: second argument isn't CACHE + // unset(VAR PARENT_SCOPE) + else if ((args.size() == 2) && (args[1] == "PARENT_SCOPE")) + { + this->Makefile->RaiseScope(variable, 0); + return true; + } + // ERROR: second argument isn't CACHE or PARENT_SCOPE else { this->SetError("called with an invalid second argument"); diff --git a/Source/cmUnsetCommand.h b/Source/cmUnsetCommand.h index 9cf95d9..2308139 100644 --- a/Source/cmUnsetCommand.h +++ b/Source/cmUnsetCommand.h @@ -47,30 +47,6 @@ public: */ virtual const char* GetName() const {return "unset";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Unset a variable, cache variable, or environment variable."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " unset(<variable> [CACHE])\n" - "Removes the specified variable causing it to become undefined. " - "If CACHE is present then the variable is removed from the cache " - "instead of the current scope.\n" - "<variable> can be an environment variable such as:\n" - " unset(ENV{LD_LIBRARY_PATH})\n" - "in which case the variable will be removed from the current " - "environment."; - } - cmTypeMacro(cmUnsetCommand, cmCommand); }; diff --git a/Source/cmUseMangledMesaCommand.h b/Source/cmUseMangledMesaCommand.h index 2f52960..aac7814 100644 --- a/Source/cmUseMangledMesaCommand.h +++ b/Source/cmUseMangledMesaCommand.h @@ -48,27 +48,6 @@ public: virtual const char* GetName() const { return "use_mangled_mesa";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Copy mesa headers for use in combination with system GL."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)\n" - "The path to mesa includes, should contain gl_mangle.h. " - "The mesa headers are copied to the specified output directory. " - "This allows mangled mesa headers to override other GL headers by " - "being added to the include directory path earlier."; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmUtilitySourceCommand.h b/Source/cmUtilitySourceCommand.h index 195f605..0a0653c 100644 --- a/Source/cmUtilitySourceCommand.h +++ b/Source/cmUtilitySourceCommand.h @@ -46,35 +46,6 @@ public: */ virtual const char* GetName() const { return "utility_source";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify the source tree of a third-party utility."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " utility_source(cache_entry executable_name\n" - " path_to_source [file1 file2 ...])\n" - "When a third-party utility's source is included in the distribution, " - "this command specifies its location and name. The cache entry will " - "not be set unless the path_to_source and all listed files exist. It " - "is assumed that the source tree of the utility will have been built " - "before it is needed.\n" - "When cross compiling CMake will print a warning if a utility_source() " - "command is executed, because in many cases it is used to build an " - "executable which is executed later on. This doesn't work when " - "cross compiling, since the executable can run only on their target " - "platform. So in this case the cache entry has to be adjusted manually " - "so it points to an executable which is runnable on the build host."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h index c86f43d..1032745 100644 --- a/Source/cmVariableRequiresCommand.h +++ b/Source/cmVariableRequiresCommand.h @@ -41,34 +41,6 @@ public: */ virtual const char* GetName() const { return "variable_requires";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the if() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Assert satisfaction of an option's required variables.\n" - " variable_requires(TEST_VARIABLE RESULT_VARIABLE\n" - " REQUIRED_VARIABLE1\n" - " REQUIRED_VARIABLE2 ...)\n" - "The first argument (TEST_VARIABLE) is the name of the variable to be " - "tested, if that variable is false nothing else is done. If " - "TEST_VARIABLE is true, then " - "the next argument (RESULT_VARIABLE) is a variable that is set to true " - "if all the required variables are set. " - "The rest of the arguments are variables that must be true or not " - "set to NOTFOUND to avoid an error. If any are not true, an error " - "is reported."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmVariableWatchCommand.h b/Source/cmVariableWatchCommand.h index 545535c..fb6062c 100644 --- a/Source/cmVariableWatchCommand.h +++ b/Source/cmVariableWatchCommand.h @@ -56,27 +56,6 @@ public: */ virtual const char* GetName() const { return "variable_watch";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Watch the CMake variable for change."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " variable_watch(<variable name> [<command to execute>])\n" - "If the specified variable changes, the message will be printed about " - "the variable being changed. If the command is specified, the command " - "will be executed. The command will receive the following arguments:" - " COMMAND(<variable> <access> <value> <current list file> <stack>)"; - } - cmTypeMacro(cmVariableWatchCommand, cmCommand); protected: diff --git a/Source/cmVisualStudio10TargetGenerator.cxx b/Source/cmVisualStudio10TargetGenerator.cxx index a26b291..0dbb5eb 100644 --- a/Source/cmVisualStudio10TargetGenerator.cxx +++ b/Source/cmVisualStudio10TargetGenerator.cxx @@ -490,6 +490,7 @@ void cmVisualStudio10TargetGenerator::WriteProjectConfigurationValues() break; case cmTarget::GLOBAL_TARGET: case cmTarget::UNKNOWN_LIBRARY: + case cmTarget::INTERFACE_LIBRARY: break; } configType += "</ConfigurationType>\n"; @@ -1701,7 +1702,8 @@ void cmVisualStudio10TargetGenerator::AddLibraries( libstring += sep; libstring += path; } - else + else if (!l->Target + || l->Target->GetType() != cmTarget::INTERFACE_LIBRARY) { libstring += sep; libstring += l->Value; @@ -1836,6 +1838,10 @@ void cmVisualStudio10TargetGenerator::WriteProjectReferences() i != depends.end(); ++i) { cmTarget* dt = *i; + if(dt->GetType() == cmTarget::INTERFACE_LIBRARY) + { + continue; + } // skip fortran targets as they can not be processed by MSBuild // the only reference will be in the .sln file if(static_cast<cmGlobalVisualStudioGenerator*>(this->GlobalGenerator) diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h index 1bdf27a..45badd0 100644 --- a/Source/cmWhileCommand.h +++ b/Source/cmWhileCommand.h @@ -68,32 +68,6 @@ public: */ virtual const char* GetName() const { return "while";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Evaluate a group of commands while a condition is true"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " while(condition)\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endwhile(condition)\n" - "All commands between while and the matching endwhile are recorded " - "without being invoked. Once the endwhile is evaluated, the " - "recorded list of commands is invoked as long as the condition " - "is true. The condition is evaluated using the same logic as the " - "if command."; - } - cmTypeMacro(cmWhileCommand, cmCommand); }; diff --git a/Source/cmWriteFileCommand.h b/Source/cmWriteFileCommand.h index 771ef5a..84a38fc 100644 --- a/Source/cmWriteFileCommand.h +++ b/Source/cmWriteFileCommand.h @@ -46,32 +46,6 @@ public: */ virtual const char* GetName() const { return "write_file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the file(WRITE ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " write_file(filename \"message to write\"... [APPEND])\n" - "The first argument is the file name, the rest of the arguments are " - "messages to write. If the argument APPEND is specified, then " - "the message will be appended.\n" - "NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as " - "this one but add some more functionality.\n" - "NOTE 2: When using write_file the produced file cannot be used as an " - "input to CMake (CONFIGURE_FILE, source file ...) because it will " - "lead to an infinite loop. Use configure_file if you want to generate " - "input files to CMake."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmake.cxx b/Source/cmake.cxx index 2249323..d11a40b 100644 --- a/Source/cmake.cxx +++ b/Source/cmake.cxx @@ -10,7 +10,6 @@ See the License for more information. ============================================================================*/ #include "cmake.h" -#include "cmDocumentVariables.h" #include "cmCacheManager.h" #include "cmMakefile.h" #include "cmLocalGenerator.h" @@ -20,7 +19,7 @@ #include "cmFileTimeComparison.h" #include "cmSourceFile.h" #include "cmTest.h" -#include "cmDocumentationFormatterText.h" +#include "cmDocumentationFormatter.h" #if defined(CMAKE_BUILD_WITH_CMAKE) # include "cmGraphVizWriter.h" @@ -219,12 +218,8 @@ void cmake::InitializeProperties() this->PropertyDefinitions.clear(); // initialize properties - cmCacheManager::DefineProperties(this); - cmSourceFile::DefineProperties(this); cmTarget::DefineProperties(this); cmMakefile::DefineProperties(this); - cmTest::DefineProperties(this); - cmake::DefineProperties(this); } void cmake::CleanupCommandsAndMacros() @@ -1865,11 +1860,6 @@ int cmake::Generate() { return -1; } - if (this->GetProperty("REPORT_UNDEFINED_PROPERTIES")) - { - this->ReportUndefinedPropertyAccesses - (this->GetProperty("REPORT_UNDEFINED_PROPERTIES")); - } // Save the cache again after a successful Generate so that any internal // variables created during Generate are saved. (Specifically target GUIDs // for the Visual Studio and Xcode generators.) @@ -2000,45 +1990,6 @@ void cmake::UpdateProgress(const char *msg, float prog) } } -void cmake::GetCommandDocumentation(std::vector<cmDocumentationEntry>& v, - bool withCurrentCommands, - bool withCompatCommands) const -{ - for(RegisteredCommandsMap::const_iterator j = this->Commands.begin(); - j != this->Commands.end(); ++j) - { - if ((( withCompatCommands == false) && ( (*j).second->IsDiscouraged())) - || ((withCurrentCommands == false) && (!(*j).second->IsDiscouraged())) - || (!((*j).second->ShouldAppearInDocumentation())) - ) - { - continue; - } - - cmDocumentationEntry e((*j).second->GetName(), - (*j).second->GetTerseDocumentation(), - (*j).second->GetFullDocumentation()); - v.push_back(e); - } -} - -void cmake::GetPolicyDocumentation(std::vector<cmDocumentationEntry>& v) -{ - this->Policies->GetDocumentation(v); -} - -void cmake::GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>& v) -{ - // loop over the properties and put them into the doc structure - std::map<cmProperty::ScopeType, cmPropertyDefinitionMap>::iterator i; - i = this->PropertyDefinitions.begin(); - for (;i != this->PropertyDefinitions.end(); ++i) - { - i->second.GetPropertiesDocumentation(v); - } -} - void cmake::GetGeneratorDocumentation(std::vector<cmDocumentationEntry>& v) { for(RegisteredGeneratorsVector::const_iterator i = @@ -2422,216 +2373,13 @@ void cmake::GenerateGraphViz(const char* fileName) const #endif } -void cmake::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("REPORT_UNDEFINED_PROPERTIES", cmProperty::GLOBAL, - "If set, report any undefined properties to this file.", - "If this property is set to a filename then when CMake runs " - "it will report any properties or variables that were accessed " - "but not defined into the filename specified in this property." - ); - - cm->DefineProperty - ("TARGET_SUPPORTS_SHARED_LIBS", cmProperty::GLOBAL, - "Does the target platform support shared libraries.", - "TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target " - "platform supports shared libraries. Basically all current general " - "general purpose OS do so, the exception are usually embedded systems " - "with no or special OSs."); - - cm->DefineProperty - ("TARGET_ARCHIVES_MAY_BE_SHARED_LIBS", cmProperty::GLOBAL, - "Set if shared libraries may be named like archives.", - "On AIX shared libraries may be named \"lib<name>.a\". " - "This property is set to true on such platforms."); - - cm->DefineProperty - ("FIND_LIBRARY_USE_LIB64_PATHS", cmProperty::GLOBAL, - "Whether FIND_LIBRARY should automatically search lib64 directories.", - "FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the " - "FIND_LIBRARY command should automatically search the lib64 variant of " - "directories called lib in the search path when building 64-bit " - "binaries."); - cm->DefineProperty - ("FIND_LIBRARY_USE_OPENBSD_VERSIONING", cmProperty::GLOBAL, - "Whether FIND_LIBRARY should find OpenBSD-style shared libraries.", - "This property is a boolean specifying whether the FIND_LIBRARY " - "command should find shared libraries with OpenBSD-style versioned " - "extension: \".so.<major>.<minor>\". " - "The property is set to true on OpenBSD and false on other platforms."); - cm->DefineProperty - ("ENABLED_FEATURES", cmProperty::GLOBAL, - "List of features which are enabled during the CMake run.", - "List of features which are enabled during the CMake run. By default " - "it contains the names of all packages which were found. This is " - "determined using the <NAME>_FOUND variables. Packages which are " - "searched QUIET are not listed. A project can add its own features to " - "this list. " - "This property is used by the macros in FeatureSummary.cmake."); - cm->DefineProperty - ("DISABLED_FEATURES", cmProperty::GLOBAL, - "List of features which are disabled during the CMake run.", - "List of features which are disabled during the CMake run. By default " - "it contains the names of all packages which were not found. This is " - "determined using the <NAME>_FOUND variables. Packages which are " - "searched QUIET are not listed. A project can add its own features to " - "this list. " - "This property is used by the macros in FeatureSummary.cmake."); - cm->DefineProperty - ("PACKAGES_FOUND", cmProperty::GLOBAL, - "List of packages which were found during the CMake run.", - "List of packages which were found during the CMake run. Whether a " - "package has been found is determined using the <NAME>_FOUND variables."); - cm->DefineProperty - ("PACKAGES_NOT_FOUND", cmProperty::GLOBAL, - "List of packages which were not found during the CMake run.", - "List of packages which were not found during the CMake run. Whether a " - "package has been found is determined using the <NAME>_FOUND variables."); - - cm->DefineProperty( - "__CMAKE_DELETE_CACHE_CHANGE_VARS_", cmProperty::GLOBAL, - "Internal property", - "Used to detect compiler changes, Do not set."); - - cm->DefineProperty( - "DEBUG_CONFIGURATIONS", cmProperty::GLOBAL, - "Specify which configurations are for debugging.", - "The value must be a semi-colon separated list of configuration names. " - "Currently this property is used only by the target_link_libraries " - "command (see its documentation for details). " - "Additional uses may be defined in the future. " - "\n" - "This property must be set at the top level of the project and before " - "the first target_link_libraries command invocation. " - "If any entry in the list does not match a valid configuration for " - "the project the behavior is undefined."); - - cm->DefineProperty( - "GLOBAL_DEPENDS_DEBUG_MODE", cmProperty::GLOBAL, - "Enable global target dependency graph debug mode.", - "CMake automatically analyzes the global inter-target dependency graph " - "at the beginning of native build system generation. " - "This property causes it to display details of its analysis to stderr."); - - cm->DefineProperty( - "GLOBAL_DEPENDS_NO_CYCLES", cmProperty::GLOBAL, - "Disallow global target dependency graph cycles.", - "CMake automatically analyzes the global inter-target dependency graph " - "at the beginning of native build system generation. " - "It reports an error if the dependency graph contains a cycle that " - "does not consist of all STATIC library targets. " - "This property tells CMake to disallow all cycles completely, even " - "among static libraries."); - - cm->DefineProperty( - "ALLOW_DUPLICATE_CUSTOM_TARGETS", cmProperty::GLOBAL, - "Allow duplicate custom targets to be created.", - "Normally CMake requires that all targets built in a project have " - "globally unique logical names (see policy CMP0002). " - "This is necessary to generate meaningful project file names in " - "Xcode and VS IDE generators. " - "It also allows the target names to be referenced unambiguously.\n" - "Makefile generators are capable of supporting duplicate custom target " - "names. " - "For projects that care only about Makefile generators and do " - "not wish to support Xcode or VS IDE generators, one may set this " - "property to true to allow duplicate custom targets. " - "The property allows multiple add_custom_target command calls in " - "different directories to specify the same target name. " - "However, setting this property will cause non-Makefile generators " - "to produce an error and refuse to generate the project." - ); - - cm->DefineProperty - ("IN_TRY_COMPILE", cmProperty::GLOBAL, - "Read-only property that is true during a try-compile configuration.", - "True when building a project inside a TRY_COMPILE or TRY_RUN command."); - cm->DefineProperty - ("ENABLED_LANGUAGES", cmProperty::GLOBAL, - "Read-only property that contains the list of currently " - "enabled languages", - "Set to list of currently enabled languages."); - - cm->DefineProperty - ("RULE_LAUNCH_COMPILE", cmProperty::GLOBAL, - "Specify a launcher for compile rules.", - "Makefile generators prefix compiler commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - cm->DefineProperty - ("RULE_LAUNCH_LINK", cmProperty::GLOBAL, - "Specify a launcher for link rules.", - "Makefile generators prefix link and archive commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - cm->DefineProperty - ("RULE_LAUNCH_CUSTOM", cmProperty::GLOBAL, - "Specify a launcher for custom rules.", - "Makefile generators prefix custom commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - - cm->DefineProperty - ("RULE_MESSAGES", cmProperty::GLOBAL, - "Specify whether to report a message for each make rule.", - "This property specifies whether Makefile generators should add a " - "progress message describing what each build rule does. " - "If the property is not set the default is ON. " - "Set the property to OFF to disable granular messages and report only " - "as each target completes. " - "This is intended to allow scripted builds to avoid the build time " - "cost of detailed reports. " - "If a CMAKE_RULE_MESSAGES cache entry exists its value initializes " - "the value of this property. " - "Non-Makefile generators currently ignore this property."); - - cm->DefineProperty - ("USE_FOLDERS", cmProperty::GLOBAL, - "Use the FOLDER target property to organize targets into folders.", - "If not set, CMake treats this property as OFF by default. " - "CMake generators that are capable of organizing into a " - "hierarchy of folders use the values of the FOLDER target " - "property to name those folders. See also the documentation " - "for the FOLDER target property."); - - cm->DefineProperty - ("AUTOMOC_TARGETS_FOLDER", cmProperty::GLOBAL, - "Name of FOLDER for *_automoc targets that are added automatically by " - "CMake for targets for which AUTOMOC is enabled.", - "If not set, CMake uses the FOLDER property of the parent target as a " - "default value for this property. See also the documentation for the " - "FOLDER target property and the AUTOMOC target property."); - - cm->DefineProperty - ("PREDEFINED_TARGETS_FOLDER", cmProperty::GLOBAL, - "Name of FOLDER for targets that are added automatically by CMake.", - "If not set, CMake uses \"CMakePredefinedTargets\" as a default " - "value for this property. Targets such as INSTALL, PACKAGE and " - "RUN_TESTS will be organized into this FOLDER. See also the " - "documentation for the FOLDER target property."); - - // ================================================================ - // define variables as well - // ================================================================ - cmDocumentVariables::DefineVariables(cm); -} - - void cmake::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - bool chained, const char *docSection) + bool chained) { this->PropertyDefinitions[scope].DefineProperty(name,scope,ShortDescription, FullDescription, - docSection, chained); } @@ -2646,112 +2394,6 @@ cmPropertyDefinition *cmake return 0; } -void cmake::RecordPropertyAccess(const char *name, - cmProperty::ScopeType scope) -{ - this->AccessedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(name,scope)); -} - -void cmake::ReportUndefinedPropertyAccesses(const char *filename) -{ - if(!this->GlobalGenerator) - { return; } - FILE *progFile = fopen(filename,"w"); - if(!progFile) - { return; } - - // what are the enabled languages? - std::vector<std::string> enLangs; - this->GlobalGenerator->GetEnabledLanguages(enLangs); - - // Common configuration names. - // TODO: Compute current configuration(s). - std::vector<std::string> enConfigs; - enConfigs.push_back(""); - enConfigs.push_back("DEBUG"); - enConfigs.push_back("RELEASE"); - enConfigs.push_back("MINSIZEREL"); - enConfigs.push_back("RELWITHDEBINFO"); - - // take all the defined properties and add definitions for all the enabled - // languages - std::set<std::pair<cmStdString,cmProperty::ScopeType> > aliasedProperties; - std::map<cmProperty::ScopeType, cmPropertyDefinitionMap>::iterator i; - i = this->PropertyDefinitions.begin(); - for (;i != this->PropertyDefinitions.end(); ++i) - { - cmPropertyDefinitionMap::iterator j; - for (j = i->second.begin(); j != i->second.end(); ++j) - { - // TODO: What if both <LANG> and <CONFIG> appear? - if (j->first.find("<CONFIG>") != std::string::npos) - { - std::vector<std::string>::const_iterator k; - for (k = enConfigs.begin(); k != enConfigs.end(); ++k) - { - std::string tmp = j->first; - cmSystemTools::ReplaceString(tmp, "<CONFIG>", k->c_str()); - // add alias - aliasedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(tmp,i->first)); - } - } - if (j->first.find("<LANG>") != std::string::npos) - { - std::vector<std::string>::const_iterator k; - for (k = enLangs.begin(); k != enLangs.end(); ++k) - { - std::string tmp = j->first; - cmSystemTools::ReplaceString(tmp, "<LANG>", k->c_str()); - // add alias - aliasedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(tmp,i->first)); - } - } - } - } - - std::set<std::pair<cmStdString,cmProperty::ScopeType> >::const_iterator ap; - ap = this->AccessedProperties.begin(); - for (;ap != this->AccessedProperties.end(); ++ap) - { - if (!this->IsPropertyDefined(ap->first.c_str(),ap->second) && - aliasedProperties.find(std::pair<cmStdString,cmProperty::ScopeType> - (ap->first,ap->second)) == - aliasedProperties.end()) - { - const char *scopeStr = ""; - switch (ap->second) - { - case cmProperty::TARGET: - scopeStr = "TARGET"; - break; - case cmProperty::SOURCE_FILE: - scopeStr = "SOURCE_FILE"; - break; - case cmProperty::DIRECTORY: - scopeStr = "DIRECTORY"; - break; - case cmProperty::TEST: - scopeStr = "TEST"; - break; - case cmProperty::VARIABLE: - scopeStr = "VARIABLE"; - break; - case cmProperty::CACHED_VARIABLE: - scopeStr = "CACHED_VARIABLE"; - break; - default: - scopeStr = "unknown"; - break; - } - fprintf(progFile, "%s with scope %s\n", ap->first.c_str(), scopeStr); - } - } - fclose(progFile); -} - bool cmake::IsPropertyDefined(const char *name, cmProperty::ScopeType scope) { return this->PropertyDefinitions[scope].IsPropertyDefined(name); @@ -3127,6 +2769,15 @@ void cmake::IssueMessage(cmake::MessageType t, std::string const& text, { msg << "CMake Debug Log"; } + else if(t == cmake::DEPRECATION_ERROR) + { + msg << "CMake Deprecation Error"; + isError = true; + } + else if (t == cmake::DEPRECATION_WARNING) + { + msg << "CMake Deprecation Warning"; + } else { msg << "CMake Warning"; @@ -3155,7 +2806,7 @@ void cmake::IssueMessage(cmake::MessageType t, std::string const& text, // Add the message text. { msg << ":\n"; - cmDocumentationFormatterText formatter; + cmDocumentationFormatter formatter; formatter.SetIndent(" "); formatter.PrintFormatted(msg, text.c_str()); } diff --git a/Source/cmake.h b/Source/cmake.h index ccf91e3..73e5109 100644 --- a/Source/cmake.h +++ b/Source/cmake.h @@ -65,7 +65,9 @@ class cmake INTERNAL_ERROR, MESSAGE, WARNING, - LOG + LOG, + DEPRECATION_ERROR, + DEPRECATION_WARNING }; @@ -267,20 +269,7 @@ class cmake ///! Get the variable watch object cmVariableWatch* GetVariableWatch() { return this->VariableWatch; } - /** Get the documentation entries for the supported commands. - * If withCurrentCommands is true, the documentation for the - * recommended set of commands is included. - * If withCompatCommands is true, the documentation for discouraged - * (compatibility) commands is included. - * You probably don't want to set both to false. - */ - void GetCommandDocumentation(std::vector<cmDocumentationEntry>& entries, - bool withCurrentCommands = true, - bool withCompatCommands = true) const; - void GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>&); void GetGeneratorDocumentation(std::vector<cmDocumentationEntry>&); - void GetPolicyDocumentation(std::vector<cmDocumentationEntry>& entries); ///! Set/Get a property of this target file void SetProperty(const char *prop, const char *value); @@ -341,8 +330,7 @@ class cmake void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - bool chain = false, - const char *variableGroup = 0); + bool chain = false); // get property definition cmPropertyDefinition *GetPropertyDefinition @@ -356,13 +344,6 @@ class cmake debugging configurations.*/ std::vector<std::string> const& GetDebugConfigs(); - // record accesses of properties and variables - void RecordPropertyAccess(const char *name, cmProperty::ScopeType scope); - void ReportUndefinedPropertyAccesses(const char *filename); - - // Define the properties - static void DefineProperties(cmake *cm); - void SetCMakeEditCommand(const char* s) { this->CMakeEditCommand = s; @@ -482,52 +463,12 @@ private: }; #define CMAKE_STANDARD_OPTIONS_TABLE \ - {"-C <initial-cache>", "Pre-load a script to populate the cache.", \ - "When cmake is first run in an empty build tree, it creates a " \ - "CMakeCache.txt file and populates it with customizable settings " \ - "for the project. This option may be used to specify a file from " \ - "which to load cache entries before the first pass through " \ - "the project's cmake listfiles. The loaded entries take priority " \ - "over the project's default values. The given file should be a CMake " \ - "script containing SET commands that use the CACHE option, " \ - "not a cache-format file."}, \ - {"-D <var>:<type>=<value>", "Create a cmake cache entry.", \ - "When cmake is first run in an empty build tree, it creates a " \ - "CMakeCache.txt file and populates it with customizable settings " \ - "for the project. This option may be used to specify a setting " \ - "that takes priority over the project's default value. The option " \ - "may be repeated for as many cache entries as desired."}, \ - {"-U <globbing_expr>", "Remove matching entries from CMake cache.", \ - "This option may be used to remove one or more variables from the " \ - "CMakeCache.txt file, globbing expressions using * and ? are supported. "\ - "The option may be repeated for as many cache entries as desired.\n" \ - "Use with care, you can make your CMakeCache.txt non-working."}, \ - {"-G <generator-name>", "Specify a build system generator.", \ - "CMake may support multiple native build systems on certain platforms. " \ - "A generator is responsible for generating a particular build " \ - "system. Possible generator names are specified in the Generators " \ - "section."},\ - {"-T <toolset-name>", "Specify toolset name if supported by generator.", \ - "Some CMake generators support a toolset name to be given to the " \ - "native build system to choose a compiler. " \ - "This is supported only on specific generators:\n" \ - " Visual Studio >= 10\n" \ - " Xcode >= 3.0\n" \ - "See native build system documentation for allowed toolset names."}, \ - {"-Wno-dev", "Suppress developer warnings.",\ - "Suppress warnings that are meant for the author"\ - " of the CMakeLists.txt files."},\ - {"-Wdev", "Enable developer warnings.",\ - "Enable warnings that are meant for the author"\ - " of the CMakeLists.txt files."} - - -#define CMAKE_STANDARD_INTRODUCTION \ - {0, \ - "CMake is a cross-platform build system generator. Projects " \ - "specify their build process with platform-independent CMake listfiles " \ - "included in each directory of a source tree with the name " \ - "CMakeLists.txt. " \ - "Users build a project by using CMake to generate a build system " \ - "for a native tool on their platform.", 0} + {"-C <initial-cache>", "Pre-load a script to populate the cache."}, \ + {"-D <var>:<type>=<value>", "Create a cmake cache entry."}, \ + {"-U <globbing_expr>", "Remove matching entries from CMake cache."}, \ + {"-G <generator-name>", "Specify a build system generator."},\ + {"-T <toolset-name>", "Specify toolset name if supported by generator."}, \ + {"-Wno-dev", "Suppress developer warnings."},\ + {"-Wdev", "Enable developer warnings."} + #endif diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx index 73c76e4..5b534f0 100644 --- a/Source/cmakemain.cxx +++ b/Source/cmakemain.cxx @@ -28,33 +28,20 @@ #ifdef CMAKE_BUILD_WITH_CMAKE //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cmake - Cross-Platform Makefile Generator.", 0}, - {0,0,0} + " cmake - Cross-Platform Makefile Generator."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " cmake [options] <path-to-source>\n" - " cmake [options] <path-to-existing-build>", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "The \"cmake\" executable is the CMake command-line interface. It may " - "be used to configure projects in scripts. Project configuration " - "settings " - "may be specified on the command line with the -D option. The -i option " - "will cause cmake to interactively prompt for such settings.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} + " cmake [options] <path-to-existing-build>"}, + {0,0} }; #define CMAKE_BUILD_OPTIONS \ @@ -70,198 +57,31 @@ static const char * cmDocumentationDescription[][3] = " -- = Pass remaining options to the native tool.\n" //---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { CMAKE_STANDARD_OPTIONS_TABLE, - {"-E", "CMake command mode.", - "For true platform independence, CMake provides a list of commands " - "that can be used on all systems. Run with -E help for the usage " - "information. Commands available are: chdir, compare_files, copy, " - "copy_directory, copy_if_different, echo, echo_append, environment, " - "make_directory, md5sum, remove, remove_directory, rename, tar, time, " - "touch, touch_nocreate. In addition, some platform specific commands " - "are available. " - "On Windows: comspec, delete_regv, write_regv. " - "On UNIX: create_symlink."}, - {"-i", "Run in wizard mode.", - "Wizard mode runs cmake interactively without a GUI. The user is " - "prompted to answer questions about the project configuration. " - "The answers are used to set cmake cache values."}, - {"-L[A][H]", "List non-advanced cached variables.", - "List cache variables will run CMake and list all the variables from the " - "CMake cache that are not marked as INTERNAL or ADVANCED. This will " - "effectively display current CMake settings, which can then be changed " - "with -D option. Changing some of the variables may result in more " - "variables being created. If A is specified, then it will display also " - "advanced variables. If H is specified, it will also display help for " - "each variable."}, - {"--build <dir>", "Build a CMake-generated project binary tree.", - "This abstracts a native build tool's command-line interface with the " - "following options:\n" - CMAKE_BUILD_OPTIONS - "Run cmake --build with no options for quick help."}, - {"-N", "View mode only.", - "Only load the cache. Do not actually run configure and generate steps."}, - {"-P <file>", "Process script mode.", - "Process the given cmake file as a script written in the CMake language. " - "No configure or generate step is performed and the cache is not" - " modified. If variables are defined using -D, this must be done " - "before the -P argument."}, - {"--find-package", "Run in pkg-config like mode.", - "Search a package using find_package() and print the resulting flags " - "to stdout. This can be used to use cmake instead of pkg-config to find " - "installed libraries in plain Makefile-based projects or in " - "autoconf-based projects (via share/aclocal/cmake.m4)."}, + {"-E", "CMake command mode."}, + {"-i", "Run in wizard mode."}, + {"-L[A][H]", "List non-advanced cached variables."}, + {"--build <dir>", "Build a CMake-generated project binary tree."}, + {"-N", "View mode only."}, + {"-P <file>", "Process script mode."}, + {"--find-package", "Run in pkg-config like mode."}, {"--graphviz=[file]", "Generate graphviz of dependencies, see " - "CMakeGraphVizOptions.cmake for more.", - "Generate a graphviz input file that will contain all the library and " - "executable dependencies in the project. See the documentation for " - "CMakeGraphVizOptions.cmake for more details. "}, - {"--system-information [file]", "Dump information about this system.", - "Dump a wide range of information about the current system. If run " - "from the top of a binary tree for a CMake project it will dump " - "additional information such as the cache, log files etc."}, + "CMakeGraphVizOptions.cmake for more."}, + {"--system-information [file]", "Dump information about this system."}, {"--debug-trycompile", "Do not delete the try_compile build tree. Only " - "useful on one try_compile at a time.", - "Do not delete the files and directories created for try_compile calls. " - "This is useful in debugging failed try_compiles. It may however " - "change the results of the try-compiles as old junk from a previous " - "try-compile may cause a different test to either pass or fail " - "incorrectly. This option is best used for one try-compile at a time, " - "and only when debugging." }, - {"--debug-output", "Put cmake in a debug mode.", - "Print extra stuff during the cmake run like stack traces with " - "message(send_error ) calls."}, - {"--trace", "Put cmake in trace mode.", - "Print a trace of all calls made and from where with " - "message(send_error ) calls."}, - {"--warn-uninitialized", "Warn about uninitialized values.", - "Print a warning when an uninitialized variable is used."}, - {"--warn-unused-vars", "Warn about unused variables.", - "Find variables that are declared or set, but not used."}, - {"--no-warn-unused-cli", "Don't warn about command line options.", - "Don't find variables that are declared on the command line, but not " - "used."}, + "useful on one try_compile at a time."}, + {"--debug-output", "Put cmake in a debug mode."}, + {"--trace", "Put cmake in trace mode."}, + {"--warn-uninitialized", "Warn about uninitialized values."}, + {"--warn-unused-vars", "Warn about unused variables."}, + {"--no-warn-unused-cli", "Don't warn about command line options."}, {"--check-system-vars", "Find problems with variable usage in system " - "files.", "Normally, unused and uninitialized variables are searched for " - "only in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to " - "warn about other files as well."}, - {"--help-command cmd [file]", "Print help for a single command and exit.", - "Full documentation specific to the given command is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-command-list [file]", "List available listfile commands and exit.", - "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 documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-commands [file]", "Print help for all commands and exit.", - "Full documentation specific for all current commands is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-compatcommands [file]", "Print help for compatibility commands. ", - "Full documentation specific for all compatibility commands is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-module module [file]", "Print help for a single module and exit.", - "Full documentation specific to the given module is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--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 documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-modules [file]", "Print help for all modules and exit.", - "Full documentation for all modules is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-custom-modules [file]" , "Print help for all custom modules and " - "exit.", - "Full documentation for all custom modules is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-policy cmp [file]", - "Print help for a single policy and exit.", - "Full documentation specific to the given policy is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-policies [file]", "Print help for all policies and exit.", - "Full documentation for all policies is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-property prop [file]", - "Print help for a single property and exit.", - "Full documentation specific to the given property is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-property-list [file]", "List available properties and exit.", - "The list contains all properties for which help may be obtained by using " - "the --help-property argument followed by a property name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-properties [file]", "Print help for all properties and exit.", - "Full documentation for all properties is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable var [file]", - "Print help for a single variable and exit.", - "Full documentation specific to the given variable is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable-list [file]", "List documented variables and exit.", - "The list contains all variables for which help may be obtained by using " - "the --help-variable argument followed by a variable name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variables [file]", "Print help for all variables and exit.", - "Full documentation for all variables is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "ccmake", 0}, - {0, "cpack", 0}, - {0, "ctest", 0}, - {0, "cmakecommands", 0}, - {0, "cmakecompat", 0}, - {0, "cmakemodules", 0}, - {0, "cmakeprops", 0}, - {0, "cmakevars", 0}, - {0, 0, 0} + "files."}, + {0,0} }; -//---------------------------------------------------------------------------- -static const char * cmDocumentationNOTE[][3] = -{ - {0, - "CMake no longer configures a project when run with no arguments. " - "In order to configure the project in the current directory, run\n" - " cmake .", 0}, - {0,0,0} -}; #endif int do_cmake(int ac, char** av); @@ -375,57 +195,18 @@ int do_cmake(int ac, char** av) args.push_back(av[i]); } hcm.SetCacheArgs(args); - const char* modulePath = hcm.GetCacheDefinition("CMAKE_MODULE_PATH"); - if (modulePath) - { - doc.SetCMakeModulePath(modulePath); - } - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> policies; - std::vector<cmDocumentationEntry> compatCommands; std::vector<cmDocumentationEntry> generators; - std::map<std::string,cmDocumentationSection *> propDocs; - hcm.GetPolicyDocumentation(policies); - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); - hcm.GetPropertiesDocumentation(propDocs); hcm.GetGeneratorDocumentation(generators); doc.SetName("cmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.AppendSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSection("Policies",policies); - doc.AppendSection("Compatibility Commands",compatCommands); - doc.SetSections(propDocs); - - cmDocumentationEntry e; - e.Brief = - "variables defined by cmake, that give information about the project, " - "and cmake"; - doc.PrependSection("Variables that Provide Information",e); - - doc.SetSeeAlsoList(cmDocumentationSeeAlso); - int result = doc.PrintRequestedDocumentation(std::cout)? 0:1; - - // If we were run with no arguments, but a CMakeLists.txt file - // exists, the user may have been trying to use the old behavior - // of cmake to build a project in-source. Print a message - // explaining the change to standard error and return an error - // condition in case the program is running from a script. - if((ac == 1) && cmSystemTools::FileExists("CMakeLists.txt")) - { - doc.ClearSections(); - doc.SetSection("NOTE", cmDocumentationNOTE); - doc.Print(cmDocumentation::UsageForm, 0, std::cerr); - return 1; - } - return result; + + return doc.PrintRequestedDocumentation(std::cout)? 0:1; } #else if ( ac == 1 ) diff --git a/Source/ctest.cxx b/Source/ctest.cxx index e767a16..16cdd13 100644 --- a/Source/ctest.cxx +++ b/Source/ctest.cxx @@ -20,246 +20,94 @@ #include "CTest/cmCTestLaunch.h" //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " ctest - Testing driver provided by CMake.", 0}, - {0,0,0} + " ctest - Testing driver provided by CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, - " ctest [options]", 0}, - {0,0,0} + " ctest [options]"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "The \"ctest\" executable is the CMake test driver program. " - "CMake-generated build trees created for projects that use " - "the ENABLE_TESTING and ADD_TEST commands have testing support. " - "This program will run the tests and report results.", 0}, - {0,0,0} -}; - //---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { - {"-C <cfg>, --build-config <cfg>", "Choose configuration to test.", - "Some CMake-generated build trees can have multiple build configurations " - "in the same tree. This option can be used to specify which one should " - "be tested. Example configurations are \"Debug\" and \"Release\"."}, - {"-V,--verbose", "Enable verbose output from tests.", - "Test output is normally suppressed and only summary information is " - "displayed. This option will show all test output."}, - {"-VV,--extra-verbose", "Enable more verbose output from tests.", - "Test output is normally suppressed and only summary information is " - "displayed. This option will show even more test output."}, - {"--debug", "Displaying more verbose internals of CTest.", - "This feature will result in a large number of output that is mostly " - "useful for debugging dashboard problems."}, - {"--output-on-failure", "Output anything outputted by the test program " - "if the test should fail. This option can also be enabled by setting " - "the environment variable CTEST_OUTPUT_ON_FAILURE"}, - {"-F", "Enable failover.", "This option allows ctest to resume a test " - "set execution that was previously interrupted. If no interruption " - "occurred, the -F option will have no effect."}, + {"-C <cfg>, --build-config <cfg>", "Choose configuration to test."}, + {"-V,--verbose", "Enable verbose output from tests."}, + {"-VV,--extra-verbose", "Enable more verbose output from tests."}, + {"--debug", "Displaying more verbose internals of CTest."}, + {"--output-on-failure"}, + {"-F", "Enable failover."}, {"-j <jobs>, --parallel <jobs>", "Run the tests in parallel using the" - "given number of jobs.", - "This option tells ctest to run the tests in parallel using given " - "number of jobs. This option can also be set by setting " - "the environment variable CTEST_PARALLEL_LEVEL."}, - {"-Q,--quiet", "Make ctest quiet.", - "This option will suppress all the output. The output log file will " - "still be generated if the --output-log is specified. Options such " - "as --verbose, --extra-verbose, and --debug are ignored if --quiet is " - "specified."}, - {"-O <file>, --output-log <file>", "Output to log file", - "This option tells ctest to write all its output to a log file."}, - {"-N,--show-only", "Disable actual execution of tests.", - "This option tells ctest to list the tests that would be run but not " - "actually run them. Useful in conjunction with the -R and -E options."}, + "given number of jobs."}, + {"-Q,--quiet", "Make ctest quiet."}, + {"-O <file>, --output-log <file>", "Output to log file"}, + {"-N,--show-only", "Disable actual execution of tests."}, {"-L <regex>, --label-regex <regex>", "Run tests with labels matching " - "regular expression.", - "This option tells ctest to run only the tests whose labels match the " - "given regular expression."}, + "regular expression."}, {"-R <regex>, --tests-regex <regex>", "Run tests matching regular " - "expression.", - "This option tells ctest to run only the tests whose names match the " - "given regular expression."}, + "expression."}, {"-E <regex>, --exclude-regex <regex>", "Exclude tests matching regular " - "expression.", - "This option tells ctest to NOT run the tests whose names match the " - "given regular expression."}, + "expression."}, {"-LE <regex>, --label-exclude <regex>", "Exclude tests with labels " - "matching regular expression.", - "This option tells ctest to NOT run the tests whose labels match the " - "given regular expression."}, - {"-D <dashboard>, --dashboard <dashboard>", "Execute dashboard test", - "This option tells ctest to act as a Dart client and perform " - "a dashboard test. All tests are <Mode><Test>, where Mode can be " - "Experimental, Nightly, and Continuous, and Test can be Start, Update, " - "Configure, Build, Test, Coverage, and Submit."}, - {"-D <var>:<type>=<value>", "Define a variable for script mode", - "Pass in variable values on the command line. Use in " - "conjunction with -S to pass variable values to a dashboard script. " - "Parsing -D arguments as variable values is only attempted if " - "the value following -D does not match any of the known dashboard " - "types."}, - {"-M <model>, --test-model <model>", "Sets the model for a dashboard", - "This option tells ctest to act as a Dart client " - "where the TestModel can be Experimental, " - "Nightly, and Continuous. Combining -M and -T is similar to -D"}, + "matching regular expression."}, + {"-D <dashboard>, --dashboard <dashboard>", "Execute dashboard test"}, + {"-D <var>:<type>=<value>", "Define a variable for script mode"}, + {"-M <model>, --test-model <model>", "Sets the model for a dashboard"}, {"-T <action>, --test-action <action>", "Sets the dashboard action to " - "perform", - "This option tells ctest to act as a Dart client " - "and perform some action such as start, build, test etc. " - "Combining -M and -T is similar to -D"}, - {"--track <track>", "Specify the track to submit dashboard to", - "Submit dashboard to specified track instead of default one. By " - "default, the dashboard is submitted to Nightly, Experimental, or " - "Continuous track, but by specifying this option, the track can be " - "arbitrary."}, + "perform"}, + {"--track <track>", "Specify the track to submit dashboard to"}, {"-S <script>, --script <script>", "Execute a dashboard for a " - "configuration", - "This option tells ctest to load in a configuration script which sets " - "a number of parameters such as the binary and source directories. Then " - "ctest will do what is required to create and run a dashboard. This " - "option basically sets up a dashboard and then runs ctest -D with the " - "appropriate options."}, + "configuration"}, {"-SP <script>, --script-new-process <script>", "Execute a dashboard for a " - "configuration", - "This option does the same operations as -S but it will do them in a " - "separate process. This is primarily useful in cases where the script " - "may modify the environment and you do not want the modified environment " - "to impact other -S scripts."}, - {"-A <file>, --add-notes <file>", "Add a notes file with submission", - "This option tells ctest to include a notes file when submitting " - "dashboard. "}, + "configuration"}, + {"-A <file>, --add-notes <file>", "Add a notes file with submission"}, {"-I [Start,End,Stride,test#,test#|Test file], --tests-information", - "Run a specific number of tests by number.", - "This option causes ctest to run tests starting at number Start, ending " - "at number End, and incrementing by Stride. Any additional numbers after " - "Stride are considered individual test numbers. Start, End,or stride " - "can be empty. Optionally a file can be given that contains the same " - "syntax as the command line."}, - {"-U, --union", "Take the Union of -I and -R", - "When both -R and -I are specified by default the intersection of " - "tests are run. By specifying -U the union of tests is run instead."}, - {"--max-width <width>", "Set the max width for a test name to output", - "Set the maximum width for each test name to show in the output. This " - "allows the user to widen the output to avoid clipping the test name which " - "can be very annoying."}, - {"--interactive-debug-mode [0|1]", "Set the interactive mode to 0 or 1.", - "This option causes ctest to run tests in either an interactive mode or " - "a non-interactive mode. On Windows this means that in non-interactive " - "mode, all system debug pop up windows are blocked. In dashboard mode " - "(Experimental, Nightly, Continuous), the default is non-interactive. " - "When just running tests not for a dashboard the default is to allow " - "popups and interactive " - "debugging."}, - {"--no-label-summary", "Disable timing summary information for labels.", - "This option tells ctest not to print summary information for each label " - "associated with the tests run. If there are no labels on the " - "tests, nothing extra is printed."}, - {"--build-and-test", "Configure, build and run a test.", - "This option tells ctest to configure (i.e. run cmake on), build, and or " - "execute a test. The configure and test steps are optional. The arguments " - "to this command line are the source and binary directories. By default " - "this will run CMake on the Source/Bin directories specified unless " - "--build-nocmake is specified. Both --build-makeprogram and " - "--build-generator MUST be provided to use --build-and-test. If " - "--test-command is specified then that will be run after the build is " - "complete. Other options that affect this mode are --build-target " - "--build-nocmake, --build-run-dir, " - "--build-two-config, --build-exe-dir, --build-project," - "--build-noclean, --build-options"}, - {"--build-target", "Specify a specific target to build.", - "This option goes with the --build-and-test option, if left out the all " - "target is built." }, - {"--build-nocmake", "Run the build without running cmake first.", - "Skip the cmake step." }, - {"--build-run-dir", "Specify directory to run programs from.", - "Directory where programs will be after it has been compiled." }, - {"--build-two-config", "Run CMake twice", "" }, - {"--build-exe-dir", "Specify the directory for the executable.", "" }, - {"--build-generator", "Specify the generator to use.", "" }, - {"--build-generator-toolset", "Specify the generator-specific toolset.",""}, - {"--build-project", "Specify the name of the project to build.", "" }, - {"--build-makeprogram", "Specify the make program to use.", "" }, - {"--build-noclean", "Skip the make clean step.", "" }, + "Run a specific number of tests by number."}, + {"-U, --union", "Take the Union of -I and -R"}, + {"--rerun-failed", "Run only the tests that failed previously"}, + {"--max-width <width>", "Set the max width for a test name to output"}, + {"--interactive-debug-mode [0|1]", "Set the interactive mode to 0 or 1."}, + {"--no-label-summary", "Disable timing summary information for labels."}, + {"--build-and-test", "Configure, build and run a test."}, + {"--build-target", "Specify a specific target to build."}, + {"--build-nocmake", "Run the build without running cmake first."}, + {"--build-run-dir", "Specify directory to run programs from."}, + {"--build-two-config", "Run CMake twice"}, + {"--build-exe-dir", "Specify the directory for the executable."}, + {"--build-generator", "Specify the generator to use."}, + {"--build-generator-toolset", "Specify the generator-specific toolset."}, + {"--build-project", "Specify the name of the project to build."}, + {"--build-makeprogram", "Specify the make program to use."}, + {"--build-noclean", "Skip the make clean step."}, {"--build-config-sample", - "A sample executable to use to determine the configuration", - "A sample executable to use to determine the configuration that " - "should be used. e.g. Debug/Release/etc" }, - {"--build-options", "Add extra options to the build step.", - "This option must be the last option with the exception of --test-command" - }, + "A sample executable to use to determine the configuration"}, + {"--build-options", "Add extra options to the build step."}, - {"--test-command", "The test to run with the --build-and-test option.", "" - }, - {"--test-timeout", "The time limit in seconds, internal use only.", "" - }, - {"--tomorrow-tag", "Nightly or experimental starts with next day tag.", - "This is useful if the build will not finish in one day." }, + {"--test-command", "The test to run with the --build-and-test option."}, + {"--test-timeout", "The time limit in seconds, internal use only."}, + {"--tomorrow-tag", "Nightly or experimental starts with next day tag."}, {"--ctest-config", "The configuration file used to initialize CTest state " - "when submitting dashboards.", - "This option tells CTest to use different initialization file instead of " - "CTestConfiguration.tcl. This way multiple initialization files can be " - "used for example to submit to multiple dashboards." }, - {"--overwrite", "Overwrite CTest configuration option.", - "By default ctest uses configuration options from configuration file. " - "This option will overwrite the configuration option." }, - {"--extra-submit <file>[;<file>]", "Submit extra files to the dashboard.", - "This option will submit extra files to the dashboard." }, - {"--force-new-ctest-process", "Run child CTest instances as new processes", - "By default CTest will run child CTest instances within the same process. " - "If this behavior is not desired, this argument will enforce new " - "processes for child CTest processes." }, - {"--schedule-random", "Use a random order for scheduling tests", - "This option will run the tests in a random order. It is commonly used to " - "detect implicit dependencies in a test suite." }, - {"--submit-index", "Submit individual dashboard tests with specific index", - "This option allows performing the same CTest action (such as test) " - "multiple times and submit all stages to the same dashboard (Dart2 " - "required). Each execution requires different index." }, - {"--timeout <seconds>", "Set a global timeout on all tests.", - "This option will set a global timeout on all tests that do not already " - "have a timeout set on them."}, - {"--stop-time <time>", "Set a time at which all tests should stop running.", - "Set a real time of day at which all tests should timeout. Example: " - "7:00:00 -0400. Any time format understood by the curl date parser is " - "accepted. Local time is assumed if no timezone is specified."}, - {"--http1.0", "Submit using HTTP 1.0.", - "This option will force CTest to use HTTP 1.0 to submit files to the " - "dashboard, instead of HTTP 1.1."}, - {"--no-compress-output", "Do not compress test output when submitting.", - "This flag will turn off automatic compression of test output. Use this " - "to maintain compatibility with an older version of CDash which doesn't " - "support compressed test output."}, - {"--print-labels", "Print all available test labels.", - "This option will not run any tests, it will simply print the list of " - "all labels associated with the test set."}, - {"--help-command <cmd> [<file>]", "Show help for a single command and exit.", - "Prints the help for the command to stdout or to the specified file." }, - {"--help-command-list [<file>]", "List available commands and exit.", - "Prints the list of all available listfile commands to stdout or the " - "specified file." }, - {"--help-commands [<file>]", "Print help for all commands and exit.", - "Prints the help for all commands to stdout or to the specified file." }, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ccmake", 0}, - {0, 0, 0} + "when submitting dashboards."}, + {"--overwrite", "Overwrite CTest configuration option."}, + {"--extra-submit <file>[;<file>]", "Submit extra files to the dashboard."}, + {"--force-new-ctest-process", "Run child CTest instances as new processes"}, + {"--schedule-random", "Use a random order for scheduling tests"}, + {"--submit-index", "Submit individual dashboard tests with specific index"}, + {"--timeout <seconds>", "Set a global timeout on all tests."}, + {"--stop-time <time>", + "Set a time at which all tests should stop running."}, + {"--http1.0", "Submit using HTTP 1.0."}, + {"--no-compress-output", "Do not compress test output when submitting."}, + {"--print-labels", "Print all available test labels."}, + {0,0} }; // this is a test driver program for cmCTest. @@ -301,21 +149,20 @@ int main (int argc, char *argv[]) doc.addCTestStandardDocSections(); if(doc.CheckOptions(argc, argv)) { + cmake hcm; + hcm.AddCMakePaths(); + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); + // Construct and print requested documentation. - std::vector<cmDocumentationEntry> commands; cmCTestScriptHandler* ch = static_cast<cmCTestScriptHandler*>(inst.GetHandler("script")); ch->CreateCMake(); - ch->GetCommandDocumentation(commands); doc.SetShowGenerators(false); doc.SetName("ctest"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); #ifdef cout # undef cout #endif diff --git a/Source/kwsys/CMakeLists.txt b/Source/kwsys/CMakeLists.txt index 0f27836..a9d89d4 100644 --- a/Source/kwsys/CMakeLists.txt +++ b/Source/kwsys/CMakeLists.txt @@ -85,6 +85,9 @@ # written. CMAKE_MINIMUM_REQUIRED(VERSION 2.6.3 FATAL_ERROR) +IF(POLICY CMP0025) + CMAKE_POLICY(SET CMP0025 NEW) +ENDIF() #----------------------------------------------------------------------------- # If a namespace is not specified, use "kwsys" and enable testing. diff --git a/Source/kwsys/SystemInformation.cxx b/Source/kwsys/SystemInformation.cxx index beefd7d..2672730 100644 --- a/Source/kwsys/SystemInformation.cxx +++ b/Source/kwsys/SystemInformation.cxx @@ -88,6 +88,15 @@ typedef int siginfo_t; # include <ifaddrs.h> # define KWSYS_SYSTEMINFORMATION_IMPLEMENT_FQDN # endif +# if defined(KWSYS_SYSTEMINFORMATION_HAS_BACKTRACE) +# include <execinfo.h> +# if defined(KWSYS_SYSTEMINFORMATION_HAS_CPP_DEMANGLE) +# include <cxxabi.h> +# endif +# if defined(KWSYS_SYSTEMINFORMATION_HAS_SYMBOL_LOOKUP) +# include <dlfcn.h> +# endif +# endif #endif #if defined(__OpenBSD__) || defined(__NetBSD__) @@ -1734,12 +1743,12 @@ int SystemInformationImplementation::GetFullyQualifiedDomainName( { char host[NI_MAXHOST]={'\0'}; - socklen_t addrlen + const size_t addrlen = (fam==AF_INET?sizeof(struct sockaddr_in):sizeof(struct sockaddr_in6)); ierr=getnameinfo( ifa->ifa_addr, - addrlen, + static_cast<socklen_t>(addrlen), host, NI_MAXHOST, NULL, @@ -3836,7 +3845,8 @@ bool SystemInformationImplementation::QueryLinuxMemory() unsigned long temp; unsigned long cachedMem; unsigned long buffersMem; - char *r=fgets(buffer, sizeof(buffer), fd); // Skip "total: used:..." + // Skip "total: used:..." + char *r=fgets(buffer, static_cast<int>(sizeof(buffer)), fd); int status=0; if(r==buffer) { diff --git a/Source/kwsys/SystemTools.cxx b/Source/kwsys/SystemTools.cxx index e9a1fd3..749002d 100644 --- a/Source/kwsys/SystemTools.cxx +++ b/Source/kwsys/SystemTools.cxx @@ -152,11 +152,6 @@ public: #define _chdir chdir #endif -#if defined(__HAIKU__) -#include <os/kernel/OS.h> -#include <os/storage/Path.h> -#endif - #if defined(__BEOS__) && !defined(__ZETA__) #include <be/kernel/OS.h> #include <be/storage/Path.h> diff --git a/Source/kwsys/testDynamicLoader.cxx b/Source/kwsys/testDynamicLoader.cxx index dd6d603..1bff707 100644 --- a/Source/kwsys/testDynamicLoader.cxx +++ b/Source/kwsys/testDynamicLoader.cxx @@ -15,14 +15,10 @@ #include KWSYS_HEADER(ios/iostream) #include KWSYS_HEADER(stl/string) -#if defined(__BEOS__) +#if defined(__BEOS__) || defined(__HAIKU__) #include <be/kernel/OS.h> /* disable_debugger() API. */ #endif -#if defined(__HAIKU__) -#include <os/kernel/OS.h> /* disable_debugger() API. */ -#endif - // Work-around CMake dependency scanning limitation. This must // duplicate the above list of headers. #if 0 diff --git a/Tests/AliasTarget/CMakeLists.txt b/Tests/AliasTarget/CMakeLists.txt index a5eb0f6..fdb1638 100644 --- a/Tests/AliasTarget/CMakeLists.txt +++ b/Tests/AliasTarget/CMakeLists.txt @@ -45,3 +45,6 @@ get_property(_alt2 TARGET PREFIX::Foo PROPERTY ALIASED_TARGET) if (NOT ${_alt2} STREQUAL foo) message(SEND_ERROR "ALIASED_TARGET is not foo.") endif() + +add_library(iface INTERFACE) +add_library(Alias::Iface ALIAS iface) diff --git a/Tests/Assembler/CMakeLists.txt b/Tests/Assembler/CMakeLists.txt index bb4bccc..1f07dc9 100644 --- a/Tests/Assembler/CMakeLists.txt +++ b/Tests/Assembler/CMakeLists.txt @@ -9,7 +9,7 @@ set(SRCS) # and also generate assembler files from C: if("${CMAKE_GENERATOR}" MATCHES "Makefile|Xcode" AND NOT CMAKE_OSX_ARCHITECTURES) - if(("${CMAKE_C_COMPILER_ID}" MATCHES "^(GNU|Clang|HP|SunPro|XL)$") OR ("${CMAKE_C_COMPILER_ID}" STREQUAL "Intel" AND UNIX)) + if(("${CMAKE_C_COMPILER_ID}" MATCHES "^(GNU|Clang|AppleClang|HP|SunPro|XL)$") OR ("${CMAKE_C_COMPILER_ID}" STREQUAL "Intel" AND UNIX)) set(C_FLAGS "${CMAKE_C_FLAGS}") separate_arguments(C_FLAGS) if(CMAKE_OSX_SYSROOT AND CMAKE_C_SYSROOT_FLAG AND NOT ";${C_FLAGS};" MATCHES ";${CMAKE_C_SYSROOT_FLAG};") diff --git a/Tests/BuildDepends/CMakeLists.txt b/Tests/BuildDepends/CMakeLists.txt index 0687154..9727930 100644 --- a/Tests/BuildDepends/CMakeLists.txt +++ b/Tests/BuildDepends/CMakeLists.txt @@ -13,7 +13,7 @@ project(BuildDepends) set(CMAKE_SUPPRESS_REGENERATION 1) # Xcode needs some help with the fancy dependencies in this test. -if("${CMAKE_GENERATOR}" MATCHES "Xcode") +if(XCODE AND XCODE_VERSION VERSION_LESS 5) set(HELP_XCODE 1) endif() function(help_xcode_depends) diff --git a/Tests/CMakeLib/CMakeLists.txt b/Tests/CMakeLib/CMakeLists.txt index a831e30..0e1fe8d 100644 --- a/Tests/CMakeLib/CMakeLists.txt +++ b/Tests/CMakeLib/CMakeLists.txt @@ -6,13 +6,14 @@ include_directories( set(CMakeLib_TESTS testGeneratedFileStream + testRST testSystemTools testUTF8 testXMLParser testXMLSafe ) -if(WIN32 AND NOT UNIX) # Just if(WIN32) when CMake >= 2.8.4 is required +if(WIN32) list(APPEND CMakeLib_TESTS testVisualStudioSlnParser ) diff --git a/Tests/CMakeLib/testRST.cxx b/Tests/CMakeLib/testRST.cxx new file mode 100644 index 0000000..bad9560 --- /dev/null +++ b/Tests/CMakeLib/testRST.cxx @@ -0,0 +1,96 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#include "cmRST.h" + +#include "cmSystemTools.h" + +void reportLine(std::ostream& os, bool ret, std::string line, bool eol) +{ + if(ret) + { + os << "\"" << line << "\" (" << (eol?"with EOL":"without EOL") << ")"; + } + else + { + os << "EOF"; + } +} + +int testRST(int, char*[]) +{ + std::string dir = cmSystemTools::GetFilenamePath(__FILE__); + if(dir.empty()) + { + dir = "."; + } + std::string a_name = "testRST.actual"; + std::string e_name = dir + "/testRST.expect"; + + // Process the test RST file. + { + std::string fname = dir + "/testRST.rst"; + std::ofstream fout(a_name.c_str()); + if(!fout) + { + std::cerr << "Could not open output " << a_name << std::endl; + return 1; + } + + cmRST r(fout, dir); + if(!r.ProcessFile(fname)) + { + std::cerr << "Could not open input " << fname << std::endl; + return 1; + } + } + + // Compare expected and actual outputs. + std::ifstream e_fin(e_name.c_str()); + std::ifstream a_fin(a_name.c_str()); + if(!e_fin) + { + std::cerr << "Could not open input " << e_name << std::endl; + return 1; + } + if(!a_fin) + { + std::cerr << "Could not open input " << a_name << std::endl; + return 1; + } + int lineno = 0; + bool e_ret; + bool a_ret; + do + { + std::string e_line; + std::string a_line; + bool e_eol; + bool a_eol; + e_ret = cmSystemTools::GetLineFromStream(e_fin, e_line, &e_eol); + a_ret = cmSystemTools::GetLineFromStream(a_fin, a_line, &a_eol); + ++lineno; + if(e_ret != a_ret || e_line != a_line || e_eol != a_eol) + { + a_fin.seekg(0, std::ios::beg); + std::cerr << "Actual output does not match that expected on line " + << lineno << "." << std::endl << "Expected "; + reportLine(std::cerr, e_ret, e_line, e_eol); + std::cerr << " but got "; + reportLine(std::cerr, a_ret, a_line, a_eol); + std::cerr << "." << std::endl + << "Actual output:" << std::endl + << a_fin.rdbuf(); + return 1; + } + } while(e_ret && a_ret); + return 0; +} diff --git a/Tests/CMakeLib/testRST.expect b/Tests/CMakeLib/testRST.expect new file mode 100644 index 0000000..6a89002 --- /dev/null +++ b/Tests/CMakeLib/testRST.expect @@ -0,0 +1,60 @@ +title_text +---------- + +Command ``some_cmd()`` explicit cmake domain. +Command ``some_cmd()`` without target. +Command ``some_cmd`` with target. +Command ``some_cmd_<cmd>()`` placeholder without target. +Command ``some_cmd_<cmd>`` placholder with target. +Command ``some_cmd()`` with parens. +Command ``some_cmd(SUB)`` with subcommand. +Command ``some_cmd(SUB)`` with subcommand and target. +Command ``some_cmd (SUB)`` with space and subcommand and target. +Command ``some command`` with space and target. +Variable ``some variable`` space and target. +Variable ``<PLACEHOLDER>_VARIABLE`` with leading placeholder. +Variable ``VARIABLE_<PLACEHOLDER>`` with trailing placeholder. +Variable ``<PLACEHOLDER>_VARIABLE`` with leading placeholder and target. +Variable ``VARIABLE_<PLACEHOLDER>`` with trailing placeholder and target. +Generator ``Some Generator`` with space. + +First TOC entry. + +|not replaced| +Second TOC entry. + +CMake Module Content + +More CMake Module Content + +.. cmake:command:: some_cmd + + Command some_cmd description. + +.. command:: other_cmd + + Command other_cmd description. + +.. cmake:variable:: some_var + + Variable some_var description. + +.. variable:: other_var + + Variable other_var description. + + Parsed-literal included without directive. + Common Indentation Removed + + # Sample CMake code block + if(condition) + message(indented) + endif() + +substituted text with multiple lines becomes one line + +End of first include. + +Cross-include substitution text with ``some_cmd()`` reference. + +End of second include. diff --git a/Tests/CMakeLib/testRST.rst b/Tests/CMakeLib/testRST.rst new file mode 100644 index 0000000..f7059cf --- /dev/null +++ b/Tests/CMakeLib/testRST.rst @@ -0,0 +1,72 @@ +.. index:: + single: directive ignored + +title_text +---------- + +.. comment ignored +.. + comment ignored + +Command :cmake:command:`some_cmd` explicit cmake domain. +Command :command:`some_cmd` without target. +Command :command:`some_cmd <some_cmd>` with target. +Command :command:`some_cmd_<cmd>` placeholder without target. +Command :command:`some_cmd_<cmd> <some_cmd>` placholder with target. +Command :command:`some_cmd()` with parens. +Command :command:`some_cmd(SUB)` with subcommand. +Command :command:`some_cmd(SUB) <some_cmd>` with subcommand and target. +Command :command:`some_cmd (SUB) <some_cmd>` with space and subcommand and target. +Command :command:`some command <some_cmd>` with space and target. +Variable :variable:`some variable <some_var>` space and target. +Variable :variable:`<PLACEHOLDER>_VARIABLE` with leading placeholder. +Variable :variable:`VARIABLE_<PLACEHOLDER>` with trailing placeholder. +Variable :variable:`<PLACEHOLDER>_VARIABLE <target>` with leading placeholder and target. +Variable :variable:`VARIABLE_<PLACEHOLDER> <target>` with trailing placeholder and target. +Generator :generator:`Some Generator` with space. + +.. |not replaced| replace:: not replaced through toctree + +.. toctree:: + :maxdepth: 2 + + testRSTtoc1 + /testRSTtoc2 + +.. cmake-module:: testRSTmod.cmake + +.. cmake:command:: some_cmd + + Command some_cmd description. + +.. command:: other_cmd + + Command other_cmd description. + +.. cmake:variable:: some_var + + Variable some_var description. + +.. variable:: other_var + + Variable other_var description. + +.. parsed-literal:: + + Parsed-literal included without directive. + Common Indentation Removed + +.. code-block:: cmake + + # Sample CMake code block + if(condition) + message(indented) + endif() + +.. |substitution| replace:: + |nested substitution| + with multiple lines becomes one line +.. |nested substitution| replace:: substituted text + +.. include:: testRSTinclude1.rst +.. include:: /testRSTinclude2.rst diff --git a/Tests/CMakeLib/testRSTinclude1.rst b/Tests/CMakeLib/testRSTinclude1.rst new file mode 100644 index 0000000..91d394e --- /dev/null +++ b/Tests/CMakeLib/testRSTinclude1.rst @@ -0,0 +1,6 @@ +|substitution| + +.. |cross-include substitution| replace:: Cross-include substitution text + with :command:`some_cmd` reference. + +End of first include. diff --git a/Tests/CMakeLib/testRSTinclude2.rst b/Tests/CMakeLib/testRSTinclude2.rst new file mode 100644 index 0000000..f2d619c --- /dev/null +++ b/Tests/CMakeLib/testRSTinclude2.rst @@ -0,0 +1,3 @@ +|cross-include substitution| + +End of second include. diff --git a/Tests/CMakeLib/testRSTmod.cmake b/Tests/CMakeLib/testRSTmod.cmake new file mode 100644 index 0000000..dfa793d --- /dev/null +++ b/Tests/CMakeLib/testRSTmod.cmake @@ -0,0 +1,4 @@ +#.rst: +# CMake Module Content +#.rst: +# More CMake Module Content diff --git a/Tests/CMakeLib/testRSTtoc1.rst b/Tests/CMakeLib/testRSTtoc1.rst new file mode 100644 index 0000000..fa7806e --- /dev/null +++ b/Tests/CMakeLib/testRSTtoc1.rst @@ -0,0 +1,2 @@ +.. |not replaced| replace:: not replaced across toctree +First TOC entry. diff --git a/Tests/CMakeLib/testRSTtoc2.rst b/Tests/CMakeLib/testRSTtoc2.rst new file mode 100644 index 0000000..9fd2fcb --- /dev/null +++ b/Tests/CMakeLib/testRSTtoc2.rst @@ -0,0 +1,2 @@ +|not replaced| +Second TOC entry. diff --git a/Tests/CMakeLists.txt b/Tests/CMakeLists.txt index 7b0727a..2f6a456 100644 --- a/Tests/CMakeLists.txt +++ b/Tests/CMakeLists.txt @@ -246,6 +246,7 @@ if(BUILD_TESTING) ADD_TEST_MACRO(CompileOptions CompileOptions) ADD_TEST_MACRO(CompatibleInterface CompatibleInterface) ADD_TEST_MACRO(AliasTarget AliasTarget) + ADD_TEST_MACRO(InterfaceLibrary InterfaceLibrary) set_tests_properties(EmptyLibrary PROPERTIES PASS_REGULAR_EXPRESSION "CMake Error: CMake can not determine linker language for target: test") ADD_TEST_MACRO(CrossCompile CrossCompile) @@ -507,9 +508,6 @@ if(BUILD_TESTING) list(APPEND TEST_BUILD_DIRS "${CMake_BINARY_DIR}/Tests/SubProject") endif() - if (CMAKE_STRICT) - ADD_TEST_MACRO(DocTest DocTest) - endif () # macro to add a test that will build a nightly release # of CMake for given platform using the release scripts macro(ADD_NIGHTLY_BUILD_TEST name script) @@ -1071,6 +1069,11 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/ endif() endif() + find_package(GTK2 QUIET) + if(GTK2_FOUND) + add_subdirectory(FindGTK2) + endif() + add_test(ExternalProject ${CMAKE_CTEST_COMMAND} --build-and-test "${CMake_SOURCE_DIR}/Tests/ExternalProject" @@ -1960,12 +1963,26 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/ PASS_REGULAR_EXPRESSION "Process file.*XINDEX.m.*Total LOC:.*125.*Percentage Coverage: 85.60.*" ENVIRONMENT COVFILE=) - # Use macro, not function so that build can still be driven by CMake 2.4. - # After 2.6 is required, this could be a function without the extra 'set' - # calls. - # - macro(add_config_tests cfg) - set(cfg "${cfg}") + + # Adding a test case for Python Coverage + configure_file( + "${CMake_SOURCE_DIR}/Tests/PythonCoverage/coverage.xml.in" + "${CMake_BINARY_DIR}/Testing/PythonCoverage/coverage.xml") + configure_file( + "${CMake_SOURCE_DIR}/Tests/PythonCoverage/DartConfiguration.tcl.in" + "${CMake_BINARY_DIR}/Testing/PythonCoverage/DartConfiguration.tcl") + file(COPY "${CMake_SOURCE_DIR}/Tests/PythonCoverage/coveragetest" + DESTINATION "${CMake_BINARY_DIR}/Testing/PythonCoverage") + add_test(NAME CTestPythonCoverage + COMMAND cmake -E chdir + ${CMake_BINARY_DIR}/Testing/PythonCoverage + $<TARGET_FILE:ctest> -T Coverage --debug) + set_tests_properties(CTestPythonCoverage PROPERTIES + PASS_REGULAR_EXPRESSION + "Process file.*foo.py.*Total LOC:.*13.*Percentage Coverage: 84.62.*" + ENVIRONMENT COVFILE=) + + function(add_config_tests cfg) set(base "${CMake_BINARY_DIR}/Tests/CTestConfig") # Test -S script with a -C config arg to ctest: @@ -1989,7 +2006,7 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/ add_test(CTestConfig.Dashboard.${cfg} ${CMAKE_CMAKE_COMMAND} -P "${base}/${cfg}-dashboard.cmake" -VV ) - endmacro() + endfunction() add_config_tests(Debug) add_config_tests(MinSizeRel) @@ -2140,6 +2157,13 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/ set_tests_properties(CTestTestTimeout PROPERTIES PASS_REGULAR_EXPRESSION "TestTimeout *\\.+ *\\*\\*\\*Timeout.*CheckChild *\\.+ *Passed") + add_test( + NAME CTestTestRerunFailed + COMMAND ${CMAKE_CTEST_COMMAND} --rerun-failed) + set_tests_properties(CTestTestRerunFailed PROPERTIES + PASS_REGULAR_EXPRESSION "1/1 Test #1: TestTimeout" DEPENDS CTestTestTimeout + WORKING_DIRECTORY ${CMake_BINARY_DIR}/Tests/CTestTestTimeout) + configure_file( "${CMake_SOURCE_DIR}/Tests/CTestTestZeroTimeout/test.cmake.in" "${CMake_BINARY_DIR}/Tests/CTestTestZeroTimeout/test.cmake" @@ -2199,20 +2223,11 @@ ${CMake_BINARY_DIR}/bin/cmake -DVERSION=master -P ${CMake_SOURCE_DIR}/Utilities/ --output-log "${CMake_BINARY_DIR}/Tests/CTestTestFdSetSize/testOutput.log" ) - # Use macro, not function so that build can still be driven by CMake 2.4. - # After 2.6 is required, this could be a function without the extra 'set' - # calls. - # - macro(add_failed_submit_test name source build in out log regex) - # Have variables named source, build and drop_method because the - # configure_file call expects those variables to be defined. - # - set(source "${source}") - set(build "${build}") + function(add_failed_submit_test name source build in out log regex) configure_file("${in}" "${out}" @ONLY) add_test(${name} ${CMAKE_CTEST_COMMAND} -S "${out}" -V --output-log "${log}") set_tests_properties(${name} PROPERTIES PASS_REGULAR_EXPRESSION "${regex}") - endmacro() + endfunction() set(regex "(Problems when submitting via S*CP") set(regex "${regex}|Error message was: ") diff --git a/Tests/CMakeOnly/CMakeLists.txt b/Tests/CMakeOnly/CMakeLists.txt index be7ddbc..7586de6 100644 --- a/Tests/CMakeOnly/CMakeLists.txt +++ b/Tests/CMakeOnly/CMakeLists.txt @@ -19,6 +19,8 @@ add_CMakeOnly_test(CheckCXXCompilerFlag) add_CMakeOnly_test(CheckLanguage) +add_CMakeOnly_test(CheckStructHasMember) + add_CMakeOnly_test(CompilerIdC) add_CMakeOnly_test(CompilerIdCXX) if(CMAKE_Fortran_COMPILER) diff --git a/Tests/CMakeOnly/CheckStructHasMember/CMakeLists.txt b/Tests/CMakeOnly/CheckStructHasMember/CMakeLists.txt new file mode 100644 index 0000000..f06d5c3 --- /dev/null +++ b/Tests/CMakeOnly/CheckStructHasMember/CMakeLists.txt @@ -0,0 +1,93 @@ +cmake_minimum_required(VERSION 2.8) + +project(CheckStructHasMember) + +set(CMAKE_REQUIRED_INCLUDES "${CMAKE_CURRENT_SOURCE_DIR}") + +include(CheckStructHasMember) + +foreach(_config_type Release RelWithDebInfo MinSizeRel Debug) + set(CMAKE_TRY_COMPILE_CONFIGURATION ${_config_type}) + unset(CSHM_RESULT_S1_${_config_type} CACHE) + unset(CSHM_RESULT_S2_${_config_type} CACHE) + unset(CSHM_RESULT_S3_${_config_type} CACHE) + message(STATUS "Testing configuration ${_config_type}") + + check_struct_has_member("struct non_existent_struct" "foo" "cm_cshm.h" CSHM_RESULT_S1_${_config_type}) + check_struct_has_member("struct struct_with_member" "non_existent_member" "cm_cshm.h" CSHM_RESULT_S2_${_config_type}) + check_struct_has_member("struct struct_with_member" "member" "cm_cshm.h" CSHM_RESULT_S3_${_config_type}) + + if(CSHM_RESULT_S1_${_config_type} OR CSHM_RESULT_S2_${_config_type}) + message(SEND_ERROR "CheckStructHasMember reported a nonexistent member as existing in configuration ${_config_type}") + endif() + + if(NOT CSHM_RESULT_S3_${_config_type}) + message(SEND_ERROR "CheckStructHasMember did not report an existent member as existing in configuration ${_config_type}") + endif() +endforeach() + +foreach(_config_type Release RelWithDebInfo MinSizeRel Debug) + set(CMAKE_TRY_COMPILE_CONFIGURATION ${_config_type}) + unset(CSHM_RESULT_S1_${_config_type}_C CACHE) + unset(CSHM_RESULT_S2_${_config_type}_C CACHE) + unset(CSHM_RESULT_S3_${_config_type}_C CACHE) + message(STATUS "Testing configuration ${_config_type}") + + check_struct_has_member("struct non_existent_struct" "foo" "cm_cshm.h" CSHM_RESULT_S1_${_config_type}_C LANGUAGE C) + check_struct_has_member("struct struct_with_member" "non_existent_member" "cm_cshm.h" CSHM_RESULT_S2_${_config_type}_C LANGUAGE C) + check_struct_has_member("struct struct_with_member" "member" "cm_cshm.h" CSHM_RESULT_S3_${_config_type}_C LANGUAGE C) + + if(CSHM_RESULT_S1_${_config_type}_C OR CSHM_RESULT_S2_${_config_type}_C) + message(SEND_ERROR "CheckStructHasMember reported a nonexistent member as existing in configuration ${_config_type}") + endif() + + if(NOT CSHM_RESULT_S3_${_config_type}_C) + message(SEND_ERROR "CheckStructHasMember did not report an existent member as existing in configuration ${_config_type}") + endif() +endforeach() + +foreach(_config_type Release RelWithDebInfo MinSizeRel Debug) + set(CMAKE_TRY_COMPILE_CONFIGURATION ${_config_type}) + unset(CSHM_RESULT_S1_${_config_type}_CXX CACHE) + unset(CSHM_RESULT_S2_${_config_type}_CXX CACHE) + unset(CSHM_RESULT_S3_${_config_type}_CXX CACHE) + unset(CSHM_RESULT_C1_${_config_type}_CXX CACHE) + unset(CSHM_RESULT_C2_${_config_type}_CXX CACHE) + unset(CSHM_RESULT_C3_${_config_type}_CXX CACHE) + + message(STATUS "Testing configuration ${_config_type}") + + check_struct_has_member("non_existent_struct" "foo" "cm_cshm.h" CSHM_RESULT_S1_${_config_type}_CXX LANGUAGE CXX) + check_struct_has_member("struct_with_non_existent_members" "non_existent_member" "cm_cshm.h" CSHM_RESULT_S2_${_config_type}_CXX LANGUAGE CXX) + check_struct_has_member("struct struct_with_member" "member" "cm_cshm.h" CSHM_RESULT_S3_${_config_type}_CXX LANGUAGE CXX) + check_struct_has_member("ns::non_existent_class" "foo" "cm_cshm.hxx" CSHM_RESULT_C1_${_config_type}_CXX LANGUAGE CXX) + check_struct_has_member("ns::class_with_non_existent_members" "foo" "cm_cshm.hxx" CSHM_RESULT_C2_${_config_type}_CXX LANGUAGE CXX) + check_struct_has_member("ns::class_with_member" "foo" "cm_cshm.hxx" CSHM_RESULT_C3_${_config_type}_CXX LANGUAGE CXX) + + if(CSHM_RESULT_S1_${_config_type}_CXX OR CSHM_RESULT_S2_${_config_type}_CXX OR CSHM_RESULT_C1_${_config_type}_CXX OR CSHM_RESULT_C2_${_config_type}_CXX) + message(SEND_ERROR "CheckStructHasMember reported a nonexistent member as existing in configuration ${_config_type}") + endif() + + if(NOT CSHM_RESULT_S3_${_config_type}_CXX OR NOT CSHM_RESULT_C3_${_config_type}_CXX) + message(SEND_ERROR "CheckStructHasMember did not report an existent member as existing in configuration ${_config_type}") + endif() +endforeach() + + +set(CMAKE_TRY_COMPILE_CONFIGURATION ${CMAKE_BUILD_TYPE}) + +if (CMAKE_COMPILER_IS_GNUCC) + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O3") + unset(CSHM_RESULT_O3 CACHE) + unset(CSHM_RESULT_O3_C CACHE) + unset(CSHM_RESULT_O3_CXX CACHE) + message(STATUS "Testing with optimization -O3") + + check_struct_has_member("class_with_non_existent_members" foo "cm_cshm.h" CSHM_RESULT_O3) + check_struct_has_member("class_with_non_existent_members" foo "cm_cshm.h" CSHM_RESULT_O3_C LANGUAGE C) + check_struct_has_member("class_with_non_existent_members" foo "cm_cshm.h" CSHM_RESULT_O3_CXX LANGUAGE CXX) + + if (CSE_RESULT_O3 OR CSHM_RESULT_O3_C OR CSHM_RESULT_O3_CXX) + message(SEND_ERROR "CheckSymbolExists reported a nonexistent symbol as existing with optimization -O3") + endif () +endif () diff --git a/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.h b/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.h new file mode 100644 index 0000000..82bb049 --- /dev/null +++ b/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.h @@ -0,0 +1,9 @@ +#ifndef _CSHM_DUMMY_H +#define _CSHM_DUMMY_H + +struct non_existent_struct; +struct struct_with_member{ + int member; +}; + +#endif diff --git a/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.hxx b/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.hxx new file mode 100644 index 0000000..458a99b --- /dev/null +++ b/Tests/CMakeOnly/CheckStructHasMember/cm_cshm.hxx @@ -0,0 +1,16 @@ +#ifndef _CSHM_DUMMY_HXX +#define _CSHM_DUMMY_HXX + +namespace ns { + +class non_existent_class; +class class_with_non_existent_members { +}; +class class_with_member { +public: + int foo; +}; + +} + +#endif diff --git a/Tests/CMakeTests/GetPropertyTest.cmake.in b/Tests/CMakeTests/GetPropertyTest.cmake.in index a858418..e99193e 100644 --- a/Tests/CMakeTests/GetPropertyTest.cmake.in +++ b/Tests/CMakeTests/GetPropertyTest.cmake.in @@ -11,17 +11,6 @@ if (NOT FOO_FULL STREQUAL "NOTFOUND") message(SEND_ERROR "property FOO has FULL_DOCS set to '${FOO_FULL}'") endif () -get_property(test_brief GLOBAL PROPERTY ENABLED_FEATURES BRIEF_DOCS) -get_property(test_full GLOBAL PROPERTY ENABLED_FEATURES FULL_DOCS) - -if(test_brief STREQUAL "NOTFOUND") - message(SEND_ERROR "property ENABLED_FEATURES has no BRIEF_DOCS") -endif() - -if(test_full STREQUAL "NOTFOUND") - message(SEND_ERROR "property ENABLED_FEATURES has no FULL_DOCS") -endif() - set(test_var alpha) get_property(result VARIABLE PROPERTY test_var) if(NOT result STREQUAL "alpha") diff --git a/Tests/CompatibleInterface/CMakeLists.txt b/Tests/CompatibleInterface/CMakeLists.txt index ae1d2fa..5ee9fd7 100644 --- a/Tests/CompatibleInterface/CMakeLists.txt +++ b/Tests/CompatibleInterface/CMakeLists.txt @@ -6,7 +6,7 @@ project(CompatibleInterface) include(GenerateExportHeader) set(CMAKE_INCLUDE_CURRENT_DIR ON) -add_library(iface1 empty.cpp) +add_library(iface1 INTERFACE) set_property(TARGET iface1 APPEND PROPERTY COMPATIBLE_INTERFACE_BOOL BOOL_PROP1 diff --git a/Tests/Complex/Library/CMakeLists.txt b/Tests/Complex/Library/CMakeLists.txt index 5c43052..f00cbd6 100644 --- a/Tests/Complex/Library/CMakeLists.txt +++ b/Tests/Complex/Library/CMakeLists.txt @@ -51,7 +51,7 @@ define_property( FULL_DOCS "A simple etst proerty that means nothign and is used for nothing" ) set_target_properties(CMakeTestCLibraryShared PROPERTIES FOO BAR) -if(NOT BEOS AND NOT WIN32) # No libm on BeOS. +if(NOT BEOS AND NOT WIN32 AND NOT HAIKU) # No libm on BeOS. set_target_properties(CMakeTestCLibraryShared PROPERTIES LINK_FLAGS "-lm") endif() get_target_property(FOO_BAR_VAR CMakeTestCLibraryShared FOO) diff --git a/Tests/ComplexOneConfig/Library/CMakeLists.txt b/Tests/ComplexOneConfig/Library/CMakeLists.txt index 5c43052..f00cbd6 100644 --- a/Tests/ComplexOneConfig/Library/CMakeLists.txt +++ b/Tests/ComplexOneConfig/Library/CMakeLists.txt @@ -51,7 +51,7 @@ define_property( FULL_DOCS "A simple etst proerty that means nothign and is used for nothing" ) set_target_properties(CMakeTestCLibraryShared PROPERTIES FOO BAR) -if(NOT BEOS AND NOT WIN32) # No libm on BeOS. +if(NOT BEOS AND NOT WIN32 AND NOT HAIKU) # No libm on BeOS. set_target_properties(CMakeTestCLibraryShared PROPERTIES LINK_FLAGS "-lm") endif() get_target_property(FOO_BAR_VAR CMakeTestCLibraryShared FOO) diff --git a/Tests/DocTest/CMakeLists.txt b/Tests/DocTest/CMakeLists.txt deleted file mode 100644 index 837328e..0000000 --- a/Tests/DocTest/CMakeLists.txt +++ /dev/null @@ -1,7 +0,0 @@ -cmake_minimum_required (VERSION 2.6) -project (DocTest) - -add_executable (DocTest DocTest.cxx) - -set_property(GLOBAL PROPERTY REPORT_UNDEFINED_PROPERTIES - "${CMAKE_CURRENT_BINARY_DIR}/UndefinedProperties.txt") diff --git a/Tests/DocTest/DocTest.cxx b/Tests/DocTest/DocTest.cxx deleted file mode 100644 index a8a62ab..0000000 --- a/Tests/DocTest/DocTest.cxx +++ /dev/null @@ -1,33 +0,0 @@ -#include <fstream> -#include <iostream> -#include <stdio.h> - -int main () -{ - int result = 0; - - // parse the dart test file - std::ifstream fin("UndefinedProperties.txt"); - if(!fin) - { - fprintf(stderr,"failed to find undefined properties file"); - return 1; - } - - char buffer[1024]; - while ( fin ) - { - buffer[0] = 0; - fin.getline(buffer, 1023); - buffer[1023] = 0; - std::string line = buffer; - if(line.size() && line.find("with scope VARIABLE") == std::string::npos) - { - fprintf(stderr, "%s\n", line.c_str()); - result = 1; - } - } - fin.close(); - - return result; -} diff --git a/Tests/ExportImport/Export/CMakeLists.txt b/Tests/ExportImport/Export/CMakeLists.txt index f225ce1..cbae967 100644 --- a/Tests/ExportImport/Export/CMakeLists.txt +++ b/Tests/ExportImport/Export/CMakeLists.txt @@ -436,3 +436,5 @@ export(TARGETS testExe2 testLib4 testLib5 testLib6 testExe3 testExe2lib NAMESPACE bld_ APPEND FILE ExportBuildTree.cmake ) + +add_subdirectory(Interface) diff --git a/Tests/ExportImport/Export/Interface/CMakeLists.txt b/Tests/ExportImport/Export/Interface/CMakeLists.txt new file mode 100644 index 0000000..fc9c0c7 --- /dev/null +++ b/Tests/ExportImport/Export/Interface/CMakeLists.txt @@ -0,0 +1,49 @@ + +add_library(headeronly INTERFACE) +set_property(TARGET headeronly PROPERTY INTERFACE_INCLUDE_DIRECTORIES + "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/headeronly>" + "$<INSTALL_INTERFACE:${CMAKE_INSTALL_PREFIX}/include/headeronly>" +) +set_property(TARGET headeronly PROPERTY INTERFACE_COMPILE_DEFINITIONS "HEADERONLY_DEFINE") + +include(GenerateExportHeader) +add_library(sharedlib SHARED sharedlib.cpp) +generate_export_header(sharedlib) +set_property(TARGET sharedlib PROPERTY INCLUDE_DIRECTORIES + "${CMAKE_CURRENT_SOURCE_DIR}/sharedlib" + "${CMAKE_CURRENT_BINARY_DIR}" +) +set_property(TARGET sharedlib PROPERTY INTERFACE_INCLUDE_DIRECTORIES + "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/sharedlib;${CMAKE_CURRENT_BINARY_DIR}>" + "$<INSTALL_INTERFACE:$<INSTALL_PREFIX>/include/sharedlib>" +) + +set_property(TARGET sharedlib PROPERTY INTERFACE_COMPILE_DEFINITIONS "SHAREDLIB_DEFINE") + +add_library(sharediface INTERFACE) +target_link_libraries(sharediface INTERFACE sharedlib) + +export(TARGETS sharediface sharedlib headeronly + NAMESPACE bld_ + FILE ../ExportInterfaceBuildTree.cmake +) + +install(TARGETS headeronly sharediface sharedlib + EXPORT expInterface + RUNTIME DESTINATION bin + LIBRARY DESTINATION lib NAMELINK_SKIP + ARCHIVE DESTINATION lib + FRAMEWORK DESTINATION Frameworks + BUNDLE DESTINATION Applications +) +install(FILES + headeronly/headeronly.h + DESTINATION include/headeronly +) +install(FILES + sharedlib/sharedlib.h + "${CMAKE_CURRENT_BINARY_DIR}/sharedlib_export.h" + DESTINATION include/sharedlib +) + +install(EXPORT expInterface NAMESPACE exp_ DESTINATION lib/exp) diff --git a/Tests/ExportImport/Export/Interface/headeronly/headeronly.h b/Tests/ExportImport/Export/Interface/headeronly/headeronly.h new file mode 100644 index 0000000..3673c21 --- /dev/null +++ b/Tests/ExportImport/Export/Interface/headeronly/headeronly.h @@ -0,0 +1,7 @@ + +enum { one }; + +struct HeaderOnly +{ + int foo() const { return 0; } +}; diff --git a/Tests/ExportImport/Export/Interface/sharedlib.cpp b/Tests/ExportImport/Export/Interface/sharedlib.cpp new file mode 100644 index 0000000..88ca713 --- /dev/null +++ b/Tests/ExportImport/Export/Interface/sharedlib.cpp @@ -0,0 +1,7 @@ + +#include "sharedlib.h" + +int SharedLibObject::foo() const +{ + return 0; +} diff --git a/Tests/ExportImport/Export/Interface/sharedlib/sharedlib.h b/Tests/ExportImport/Export/Interface/sharedlib/sharedlib.h new file mode 100644 index 0000000..aad9ef3 --- /dev/null +++ b/Tests/ExportImport/Export/Interface/sharedlib/sharedlib.h @@ -0,0 +1,7 @@ + +#include "sharedlib_export.h" + +struct SHAREDLIB_EXPORT SharedLibObject +{ + int foo() const; +}; diff --git a/Tests/ExportImport/Import/CMakeLists.txt b/Tests/ExportImport/Import/CMakeLists.txt index 9c2d597..5e809a2 100644 --- a/Tests/ExportImport/Import/CMakeLists.txt +++ b/Tests/ExportImport/Import/CMakeLists.txt @@ -19,3 +19,6 @@ add_executable(imp_testTransExe1b imp_testTransExe1.c) target_link_libraries(imp_testTransExe1b imp_lib1b) add_subdirectory(try_compile) + +# Test package INTERFACE controls +add_subdirectory(Interface) diff --git a/Tests/ExportImport/Import/Interface/CMakeLists.txt b/Tests/ExportImport/Import/Interface/CMakeLists.txt new file mode 100644 index 0000000..c7bd13e --- /dev/null +++ b/Tests/ExportImport/Import/Interface/CMakeLists.txt @@ -0,0 +1,55 @@ + +# Import targets from the exported build tree. +include(${Import_BINARY_DIR}/../Export/ExportInterfaceBuildTree.cmake) + +# Import targets from the exported install tree. +include(${CMAKE_INSTALL_PREFIX}/lib/exp/expInterface.cmake) + +add_library(define_iface INTERFACE) +set_property(TARGET define_iface PROPERTY + INTERFACE_COMPILE_DEFINITIONS DEFINE_IFACE_DEFINE) + +add_executable(headeronlytest_bld headeronlytest.cpp) +target_link_libraries(headeronlytest_bld bld_headeronly) + +set_property(TARGET bld_sharediface APPEND PROPERTY INTERFACE_LINK_LIBRARIES define_iface) + +add_executable(interfacetest_bld interfacetest.cpp) +target_link_libraries(interfacetest_bld bld_sharediface) + +include(CheckCXXSourceCompiles) + +macro(do_try_compile prefix) + + set(CMAKE_REQUIRED_LIBRARIES ${prefix}headeronly) + check_cxx_source_compiles( + " + #include \"headeronly.h\" + + #ifndef HEADERONLY_DEFINE + #error Expected HEADERONLY_DEFINE + #endif + + int main(int,char**) + { + HeaderOnly ho; + return ho.foo(); + } + " ${prefix}IFACE_TRY_COMPILE) + + if(NOT ${prefix}IFACE_TRY_COMPILE) + message(SEND_ERROR "${prefix} try_compile with IMPORTED INTERFACE target failed!\n\n${OUTPUT}") + endif() +endmacro() + +do_try_compile(bld_) + +add_executable(headeronlytest_exp headeronlytest.cpp) +target_link_libraries(headeronlytest_exp exp_headeronly) + +set_property(TARGET exp_sharediface APPEND PROPERTY INTERFACE_LINK_LIBRARIES define_iface) + +add_executable(interfacetest_exp interfacetest.cpp) +target_link_libraries(interfacetest_exp exp_sharediface) + +do_try_compile(exp_) diff --git a/Tests/ExportImport/Import/Interface/headeronlytest.cpp b/Tests/ExportImport/Import/Interface/headeronlytest.cpp new file mode 100644 index 0000000..20674a7 --- /dev/null +++ b/Tests/ExportImport/Import/Interface/headeronlytest.cpp @@ -0,0 +1,17 @@ + +#include "headeronly.h" + +#ifndef HEADERONLY_DEFINE +#error Expected HEADERONLY_DEFINE +#endif + +#ifdef SHAREDLIB_DEFINE +#error Unexpected SHAREDLIB_DEFINE +#endif + + +int main(int,char**) +{ + HeaderOnly ho; + return ho.foo(); +} diff --git a/Tests/ExportImport/Import/Interface/interfacetest.cpp b/Tests/ExportImport/Import/Interface/interfacetest.cpp new file mode 100644 index 0000000..786458d --- /dev/null +++ b/Tests/ExportImport/Import/Interface/interfacetest.cpp @@ -0,0 +1,20 @@ + +#include "sharedlib.h" + +#ifndef SHAREDLIB_DEFINE +#error Expected SHAREDLIB_DEFINE +#endif + +#ifdef HEADERONLY_DEFINE +#error Unexpected HEADERONLY_DEFINE +#endif + +#ifndef DEFINE_IFACE_DEFINE +#error Expected DEFINE_IFACE_DEFINE +#endif + +int main(int,char**) +{ + SharedLibObject slo; + return slo.foo(); +} diff --git a/Tests/FindGTK2/CMakeLists.txt b/Tests/FindGTK2/CMakeLists.txt new file mode 100644 index 0000000..1c5987c --- /dev/null +++ b/Tests/FindGTK2/CMakeLists.txt @@ -0,0 +1,317 @@ +find_package(GTK2 COMPONENTS gtk glade gtkmm glademm QUIET) + + +# Test GTK2 components +if(GTK2_GTK_FOUND) + add_test(GTK2Components.gtk ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gtk" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Components/gtk" + ${build_generator_args} + --build-target gtk-all-libs + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Components/gtk" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(GTK2_GTKMM_FOUND) + add_test(GTK2Components.gtkmm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gtkmm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Components/gtkmm" + ${build_generator_args} + --build-target gtkmm-all-libs + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Components/gtkmm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + + +# Test GTK2 targets +if(TARGET GTK2::glib) + add_test(GTK2Targets.glib ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/glib" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/glib" + ${build_generator_args} + --build-project glib + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/glib" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gobject) + add_test(GTK2Targets.gobject ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gobject" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gobject" + ${build_generator_args} + --build-project gobject + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gobject" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gio) + add_test(GTK2Targets.gio ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gio" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gio" + ${build_generator_args} + --build-project gio + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gio" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gmodule) + add_test(GTK2Targets.gmodule ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gmodule" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gmodule" + ${build_generator_args} + --build-project gmodule + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gmodule" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gthread) + add_test(GTK2Targets.gthread ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gthread" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gthread" + ${build_generator_args} + --build-project gthread + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gthread" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::atk) + add_test(GTK2Targets.atk ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/atk" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/atk" + ${build_generator_args} + --build-project atk + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/atk" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gdk_pixbuf) + add_test(GTK2Targets.gdk_pixbuf ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gdk_pixbuf" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gdk_pixbuf" + ${build_generator_args} + --build-project gdk_pixbuf + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gdk_pixbuf" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::cairo) + add_test(GTK2Targets.cairo ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/cairo" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/cairo" + ${build_generator_args} + --build-project cairo + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/cairo" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::pango) + add_test(GTK2Targets.pango ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/pango" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pango" + ${build_generator_args} + --build-project pango + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pango" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::pangocairo) + add_test(GTK2Targets.pangocairo ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/pangocairo" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangocairo" + ${build_generator_args} + --build-project pangocairo + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangocairo" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::pangoxft) + add_test(GTK2Targets.pangoxft ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/pangoxft" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangoxft" + ${build_generator_args} + --build-project pangoxft + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangoxft" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::pangoft2) + add_test(GTK2Targets.pangoft2 ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/pangoft2" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangoft2" + ${build_generator_args} + --build-project pangoft2 + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangoft2" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gdk) + add_test(GTK2Targets.gdk ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gdk" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gdk" + ${build_generator_args} + --build-project gdk + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gdk" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gtk) + add_test(GTK2Targets.gtk ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gtk" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gtk" + ${build_generator_args} + --build-project gtk + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gtk" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::sigc++) + add_test(GTK2Targets.sigc++ ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/sigc++" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/sigc++" + ${build_generator_args} + --build-project sigc++ + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/sigc++" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::glibmm) + add_test(GTK2Targets.glibmm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/glibmm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/glibmm" + ${build_generator_args} + --build-project glibmm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/glibmm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::giomm) + add_test(GTK2Targets.giomm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/giomm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/giomm" + ${build_generator_args} + --build-project giomm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/giomm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::atkmm) + add_test(GTK2Targets.atkmm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/atkmm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/atkmm" + ${build_generator_args} + --build-project atkmm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/atkmm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::cairomm) + add_test(GTK2Targets.cairomm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/cairomm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/cairomm" + ${build_generator_args} + --build-project cairomm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/cairomm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::pangomm) + add_test(GTK2Targets.pangomm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/pangomm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangomm" + ${build_generator_args} + --build-project pangomm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/pangomm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gdkmm) + add_test(GTK2Targets.gdkmm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gdkmm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/GTK2Targets/gdkmm" + ${build_generator_args} + --build-project gdkmm + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/GTK2Targets/gdkmm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() + +if(TARGET GTK2::gtkmm) + add_test(GTK2Targets.gtkmm ${CMAKE_CTEST_COMMAND} + --build-and-test + "${CMake_SOURCE_DIR}/Tests/FindGTK2/gtkmm" + "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gtkmm" + ${build_generator_args} + --build-target gtkmm-target + --build-exe-dir "${CMake_BINARY_DIR}/Tests/FindGTK2/GTK2Targets/gtkmm" + --force-new-ctest-process + --test-command ${CMAKE_CTEST_COMMAND} -V + ) +endif() diff --git a/Tests/FindGTK2/atk/CMakeLists.txt b/Tests/FindGTK2/atk/CMakeLists.txt new file mode 100644 index 0000000..be37957 --- /dev/null +++ b/Tests/FindGTK2/atk/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(atk C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(atk WIN32 main.c) +target_link_libraries(atk GTK2::atk) diff --git a/Tests/FindGTK2/atk/main.c b/Tests/FindGTK2/atk/main.c new file mode 100644 index 0000000..e25030e --- /dev/null +++ b/Tests/FindGTK2/atk/main.c @@ -0,0 +1,7 @@ +#include <atk/atk.h> + +int main(int argc, char *argv[]) +{ + const gchar *name = atk_get_toolkit_name(); + return 0; +} diff --git a/Tests/FindGTK2/atkmm/CMakeLists.txt b/Tests/FindGTK2/atkmm/CMakeLists.txt new file mode 100644 index 0000000..e8320b5 --- /dev/null +++ b/Tests/FindGTK2/atkmm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(atkmm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(atkmm WIN32 main.cpp) +target_link_libraries(atkmm GTK2::atkmm) diff --git a/Tests/FindGTK2/atkmm/main.cpp b/Tests/FindGTK2/atkmm/main.cpp new file mode 100644 index 0000000..f455c7a --- /dev/null +++ b/Tests/FindGTK2/atkmm/main.cpp @@ -0,0 +1,8 @@ +#include <atkmm.h> +#include <atkmm/init.h> + +int main(int argc, char *argv[]) +{ + Atk::init(); + return 0; +} diff --git a/Tests/FindGTK2/cairo/CMakeLists.txt b/Tests/FindGTK2/cairo/CMakeLists.txt new file mode 100644 index 0000000..97a7369 --- /dev/null +++ b/Tests/FindGTK2/cairo/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(cairo C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(cairo WIN32 main.c) +target_link_libraries(cairo GTK2::cairo) diff --git a/Tests/FindGTK2/cairo/main.c b/Tests/FindGTK2/cairo/main.c new file mode 100644 index 0000000..1b61001 --- /dev/null +++ b/Tests/FindGTK2/cairo/main.c @@ -0,0 +1,52 @@ +/* Taken from http://cairographics.org/samples/ */ + + +#include <cairo.h> +#include <math.h> +#include <stdio.h> + +int main(int argc, char *argv[]) +{ + char *filename; + if (argc != 2) + { + fprintf (stderr, "Usage: %s OUTPUT_FILENAME\n", argv[0]); + return 1; + } + filename = argv[1]; + double xc = 128.0; + double yc = 128.0; + double radius = 100.0; + double angle1 = 45.0 * (M_PI/180.0); /* angles are specified */ + double angle2 = 180.0 * (M_PI/180.0); /* in radians */ + + cairo_surface_t *im = cairo_image_surface_create(CAIRO_FORMAT_ARGB32, xc * 2, yc * 2); + cairo_t *cr = cairo_create(im); + + + cairo_set_line_width (cr, 10.0); + cairo_arc (cr, xc, yc, radius, angle1, angle2); + cairo_stroke (cr); + + /* draw helping lines */ + cairo_set_source_rgba (cr, 1, 0.2, 0.2, 0.6); + cairo_set_line_width (cr, 6.0); + + cairo_arc (cr, xc, yc, 10.0, 0, 2*M_PI); + cairo_fill (cr); + + cairo_arc (cr, xc, yc, radius, angle1, angle1); + cairo_line_to (cr, xc, yc); + cairo_arc (cr, xc, yc, radius, angle2, angle2); + cairo_line_to (cr, xc, yc); + cairo_stroke (cr); + + cairo_status_t status = cairo_surface_write_to_png (im, filename); + cairo_surface_destroy (im); + if (status != CAIRO_STATUS_SUCCESS) { + fprintf(stderr, "Could not save png to '%s'\n", filename); + } + + cairo_destroy(cr); + return 0; +} diff --git a/Tests/FindGTK2/cairomm/CMakeLists.txt b/Tests/FindGTK2/cairomm/CMakeLists.txt new file mode 100644 index 0000000..47a156e --- /dev/null +++ b/Tests/FindGTK2/cairomm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(cairomm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(cairomm WIN32 main.cpp) +target_link_libraries(cairomm GTK2::cairomm) diff --git a/Tests/FindGTK2/cairomm/main.cpp b/Tests/FindGTK2/cairomm/main.cpp new file mode 100644 index 0000000..ea8f106 --- /dev/null +++ b/Tests/FindGTK2/cairomm/main.cpp @@ -0,0 +1,62 @@ +// Taken from http://cgit.freedesktop.org/cairomm/plain/examples/surfaces/image-surface.cc + + +/* M_PI is defined in math.h in the case of Microsoft Visual C++, Solaris, + * et. al. + */ +#if defined(_MSC_VER) +#define _USE_MATH_DEFINES +#endif + +#include <string> +#include <iostream> +#include <cairommconfig.h> +#include <cairomm/context.h> +#include <cairomm/surface.h> + +#include <cmath> + +int main() +{ + Cairo::RefPtr<Cairo::ImageSurface> surface = + Cairo::ImageSurface::create(Cairo::FORMAT_ARGB32, 600, 400); + + Cairo::RefPtr<Cairo::Context> cr = Cairo::Context::create(surface); + + cr->save(); // save the state of the context + cr->set_source_rgb(0.86, 0.85, 0.47); + cr->paint(); // fill image with the color + cr->restore(); // color is back to black now + + cr->save(); + // draw a border around the image + cr->set_line_width(20.0); // make the line wider + cr->rectangle(0.0, 0.0, surface->get_width(), surface->get_height()); + cr->stroke(); + + cr->set_source_rgba(0.0, 0.0, 0.0, 0.7); + // draw a circle in the center of the image + cr->arc(surface->get_width() / 2.0, surface->get_height() / 2.0, + surface->get_height() / 4.0, 0.0, 2.0 * M_PI); + cr->stroke(); + + // draw a diagonal line + cr->move_to(surface->get_width() / 4.0, surface->get_height() / 4.0); + cr->line_to(surface->get_width() * 3.0 / 4.0, surface->get_height() * 3.0 / 4.0); + cr->stroke(); + cr->restore(); + +#ifdef CAIRO_HAS_PNG_FUNCTIONS + + std::string filename = "image.png"; + surface->write_to_png(filename); + + std::cout << "Wrote png file \"" << filename << "\"" << std::endl; + +#else + + std::cout << "You must compile cairo with PNG support for this example to work." + << std::endl; + +#endif +} diff --git a/Tests/FindGTK2/gdk/CMakeLists.txt b/Tests/FindGTK2/gdk/CMakeLists.txt new file mode 100644 index 0000000..f485236 --- /dev/null +++ b/Tests/FindGTK2/gdk/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gdk C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gdk WIN32 main.c) +target_link_libraries(gdk GTK2::gdk) diff --git a/Tests/FindGTK2/gdk/main.c b/Tests/FindGTK2/gdk/main.c new file mode 100644 index 0000000..ac1bd4b --- /dev/null +++ b/Tests/FindGTK2/gdk/main.c @@ -0,0 +1,7 @@ +#include <gdk/gdk.h> + +int main(int argc, char *argv[]) +{ + gdk_init(argc, argv); + return 0; +} diff --git a/Tests/FindGTK2/gdk_pixbuf/CMakeLists.txt b/Tests/FindGTK2/gdk_pixbuf/CMakeLists.txt new file mode 100644 index 0000000..004e82e --- /dev/null +++ b/Tests/FindGTK2/gdk_pixbuf/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gdk_pixbuf C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gdk_pixbuf WIN32 main.c) +target_link_libraries(gdk_pixbuf GTK2::gdk_pixbuf) diff --git a/Tests/FindGTK2/gdk_pixbuf/main.c b/Tests/FindGTK2/gdk_pixbuf/main.c new file mode 100644 index 0000000..e42b83e --- /dev/null +++ b/Tests/FindGTK2/gdk_pixbuf/main.c @@ -0,0 +1,10 @@ +#include <gdk-pixbuf/gdk-pixbuf.h> + +int main(int argc, char *argv[]) +{ + const char *version = gdk_pixbuf_version; + const guint major = gdk_pixbuf_major_version; + const guint minor = gdk_pixbuf_minor_version; + const guint micro = gdk_pixbuf_micro_version; + return 0; +} diff --git a/Tests/FindGTK2/gdkmm/CMakeLists.txt b/Tests/FindGTK2/gdkmm/CMakeLists.txt new file mode 100644 index 0000000..a54fc4f --- /dev/null +++ b/Tests/FindGTK2/gdkmm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gdkmm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gdkmm WIN32 main.cpp) +target_link_libraries(gdkmm GTK2::gdkmm) diff --git a/Tests/FindGTK2/gdkmm/main.cpp b/Tests/FindGTK2/gdkmm/main.cpp new file mode 100644 index 0000000..935bcc4 --- /dev/null +++ b/Tests/FindGTK2/gdkmm/main.cpp @@ -0,0 +1,7 @@ +#include <gdkmm.h> + +int main(int argc, char *argv[]) +{ + Gdk::Color red = Gdk::Color("red"); + return 0; +} diff --git a/Tests/FindGTK2/gio/CMakeLists.txt b/Tests/FindGTK2/gio/CMakeLists.txt new file mode 100644 index 0000000..db9cdd0 --- /dev/null +++ b/Tests/FindGTK2/gio/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gio C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gio WIN32 main.c) +target_link_libraries(gio GTK2::gio) diff --git a/Tests/FindGTK2/gio/main.c b/Tests/FindGTK2/gio/main.c new file mode 100644 index 0000000..13f4304 --- /dev/null +++ b/Tests/FindGTK2/gio/main.c @@ -0,0 +1,8 @@ +#include <gio/gio.h> + +int main(int argc, char *argv[]) +{ + GFile *file = g_file_new_for_path("path"); + g_object_unref(file); + return 0; +} diff --git a/Tests/FindGTK2/giomm/CMakeLists.txt b/Tests/FindGTK2/giomm/CMakeLists.txt new file mode 100644 index 0000000..46cfef5 --- /dev/null +++ b/Tests/FindGTK2/giomm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(giomm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(giomm WIN32 main.cpp) +target_link_libraries(giomm GTK2::giomm) diff --git a/Tests/FindGTK2/giomm/main.cpp b/Tests/FindGTK2/giomm/main.cpp new file mode 100644 index 0000000..8303ba9 --- /dev/null +++ b/Tests/FindGTK2/giomm/main.cpp @@ -0,0 +1,7 @@ +#include <giomm.h> + +int main(int argc, char *argv[]) +{ + Glib::RefPtr<Gio::File> f = Gio::File::create_for_path("path"); + return 0; +} diff --git a/Tests/FindGTK2/glib/CMakeLists.txt b/Tests/FindGTK2/glib/CMakeLists.txt new file mode 100644 index 0000000..1aa73ff --- /dev/null +++ b/Tests/FindGTK2/glib/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(glib C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(glib WIN32 main.c) +target_link_libraries(glib GTK2::glib) diff --git a/Tests/FindGTK2/glib/main.c b/Tests/FindGTK2/glib/main.c new file mode 100644 index 0000000..80d0554 --- /dev/null +++ b/Tests/FindGTK2/glib/main.c @@ -0,0 +1,11 @@ +#include <glib.h> + +int main(int argc, char *argv[]) +{ + if (!g_file_test("file", G_FILE_TEST_EXISTS)) { + g_print("File not found. \n"); + } else { + g_print("File found. \n"); + } + return 0; +} diff --git a/Tests/FindGTK2/glibmm/CMakeLists.txt b/Tests/FindGTK2/glibmm/CMakeLists.txt new file mode 100644 index 0000000..af8ddcf --- /dev/null +++ b/Tests/FindGTK2/glibmm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(glibmm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(glibmm WIN32 main.cpp) +target_link_libraries(glibmm GTK2::glibmm) diff --git a/Tests/FindGTK2/glibmm/main.cpp b/Tests/FindGTK2/glibmm/main.cpp new file mode 100644 index 0000000..0e8cdae --- /dev/null +++ b/Tests/FindGTK2/glibmm/main.cpp @@ -0,0 +1,7 @@ +#include <glibmm/init.h> + +int main(int, char**) +{ + Glib::init(); + return 0; +} diff --git a/Tests/FindGTK2/gmodule/CMakeLists.txt b/Tests/FindGTK2/gmodule/CMakeLists.txt new file mode 100644 index 0000000..9717da8 --- /dev/null +++ b/Tests/FindGTK2/gmodule/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gmodule C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gmodule WIN32 main.c) +target_link_libraries(gmodule GTK2::gmodule) diff --git a/Tests/FindGTK2/gmodule/main.c b/Tests/FindGTK2/gmodule/main.c new file mode 100644 index 0000000..5c85a6f --- /dev/null +++ b/Tests/FindGTK2/gmodule/main.c @@ -0,0 +1,7 @@ +#include <gmodule.h> + +int main(int argc, char *argv[]) +{ + gboolean b = g_module_supported(); + return 0; +} diff --git a/Tests/FindGTK2/gobject/CMakeLists.txt b/Tests/FindGTK2/gobject/CMakeLists.txt new file mode 100644 index 0000000..c51fd4d --- /dev/null +++ b/Tests/FindGTK2/gobject/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gobject C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gobject WIN32 main.c) +target_link_libraries(gobject GTK2::gobject) diff --git a/Tests/FindGTK2/gobject/main.c b/Tests/FindGTK2/gobject/main.c new file mode 100644 index 0000000..d3e13f9 --- /dev/null +++ b/Tests/FindGTK2/gobject/main.c @@ -0,0 +1,72 @@ +/* Taken from https://developer.gnome.org/gobject/stable/chapter-gobject.html */ + + +#include <glib-object.h> + + +#define MAMAN_TYPE_BAR (maman_bar_get_type ()) +#define MAMAN_BAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MAMAN_TYPE_BAR, MamanBar)) +#define MAMAN_IS_BAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MAMAN_TYPE_BAR)) +#define MAMAN_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MAMAN_TYPE_BAR, MamanBarClass)) +#define MAMAN_IS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MAMAN_TYPE_BAR)) +#define MAMAN_BAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MAMAN_TYPE_BAR, MamanBarClass)) + +typedef struct _MamanBar MamanBar; +typedef struct _MamanBarClass MamanBarClass; + +struct _MamanBar +{ + GObject parent_instance; + + /* instance members */ +}; + +struct _MamanBarClass +{ + GObjectClass parent_class; + + /* class members */ +}; + +/* will create maman_bar_get_type and set maman_bar_parent_class */ +G_DEFINE_TYPE (MamanBar, maman_bar, G_TYPE_OBJECT); + +static GObject * +maman_bar_constructor (GType gtype, + guint n_properties, + GObjectConstructParam *properties) +{ + GObject *obj; + + { + /* Always chain up to the parent constructor */ + obj = G_OBJECT_CLASS (maman_bar_parent_class)->constructor (gtype, n_properties, properties); + } + + /* update the object state depending on constructor properties */ + + return obj; +} + +static void +maman_bar_class_init (MamanBarClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS (klass); + + gobject_class->constructor = maman_bar_constructor; +} + +static void +maman_bar_init (MamanBar *self) +{ + /* initialize the object */ +} + + +int +main(int argc, char *argv[]) +{ + MamanBar *bar = g_object_new (MAMAN_TYPE_BAR, NULL); + g_object_unref(bar); + return 0; +} diff --git a/Tests/FindGTK2/gthread/CMakeLists.txt b/Tests/FindGTK2/gthread/CMakeLists.txt new file mode 100644 index 0000000..a90294d0 --- /dev/null +++ b/Tests/FindGTK2/gthread/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(gthread C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gthread WIN32 main.c) +target_link_libraries(gthread GTK2::gthread) diff --git a/Tests/FindGTK2/gthread/main.c b/Tests/FindGTK2/gthread/main.c new file mode 100644 index 0000000..ce68cbd --- /dev/null +++ b/Tests/FindGTK2/gthread/main.c @@ -0,0 +1,7 @@ +#include <glib.h> + +int main(int argc, char *argv[]) +{ + g_thread_init(NULL); + return 0; +} diff --git a/Tests/FindGTK2/gtk/CMakeLists.txt b/Tests/FindGTK2/gtk/CMakeLists.txt new file mode 100644 index 0000000..11603ae --- /dev/null +++ b/Tests/FindGTK2/gtk/CMakeLists.txt @@ -0,0 +1,14 @@ +cmake_minimum_required(VERSION 2.8) + +project(gtk C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gtk WIN32 main.c) +target_link_libraries(gtk GTK2::gtk) + +add_executable(gtk-all-libs WIN32 main.c) +target_link_libraries(gtk-all-libs ${GTK2_LIBRARIES}) +target_include_directories(gtk-all-libs PRIVATE ${GTK2_INCLUDE_DIRS}) diff --git a/Tests/FindGTK2/gtk/main.c b/Tests/FindGTK2/gtk/main.c new file mode 100644 index 0000000..309c328 --- /dev/null +++ b/Tests/FindGTK2/gtk/main.c @@ -0,0 +1,15 @@ +#include <gtk/gtk.h> + +int main(int argc, char *argv[]) +{ + GtkWidget *window; + + gtk_init (&argc, &argv); + + window = gtk_window_new (GTK_WINDOW_TOPLEVEL); + gtk_widget_show (window); + + gtk_main (); + + return 0; +} diff --git a/Tests/FindGTK2/gtkmm/CMakeLists.txt b/Tests/FindGTK2/gtkmm/CMakeLists.txt new file mode 100644 index 0000000..32aafe2 --- /dev/null +++ b/Tests/FindGTK2/gtkmm/CMakeLists.txt @@ -0,0 +1,14 @@ +cmake_minimum_required(VERSION 2.8) + +project(gtkmm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(gtkmm-target WIN32 main.cpp helloworld.cpp helloworld.h) +target_link_libraries(gtkmm-target GTK2::gtkmm) + +add_executable(gtkmm-all-libs WIN32 main.cpp helloworld.cpp helloworld.h) +target_link_libraries(gtkmm-all-libs ${GTK2_LIBRARIES}) +target_include_directories(gtkmm-all-libs PRIVATE ${GTK2_INCLUDE_DIRS}) diff --git a/Tests/FindGTK2/gtkmm/helloworld.cpp b/Tests/FindGTK2/gtkmm/helloworld.cpp new file mode 100644 index 0000000..535f44a --- /dev/null +++ b/Tests/FindGTK2/gtkmm/helloworld.cpp @@ -0,0 +1,29 @@ +#include "helloworld.h" +#include <iostream> + +HelloWorld::HelloWorld() + : m_button("Hello World") // creates a new button with label "Hello World". +{ + // Sets the border width of the window. + set_border_width(10); + + // When the button receives the "clicked" signal, it will call the + // on_button_clicked() method defined below. + m_button.signal_clicked().connect(sigc::mem_fun(*this, + &HelloWorld::on_button_clicked)); + + // This packs the button into the Window (a container). + add(m_button); + + // The final step is to display this newly created widget... + m_button.show(); +} + +HelloWorld::~HelloWorld() +{ +} + +void HelloWorld::on_button_clicked() +{ + std::cout << "Hello World" << std::endl; +} diff --git a/Tests/FindGTK2/gtkmm/helloworld.h b/Tests/FindGTK2/gtkmm/helloworld.h new file mode 100644 index 0000000..ab9a076 --- /dev/null +++ b/Tests/FindGTK2/gtkmm/helloworld.h @@ -0,0 +1,20 @@ +#ifndef GTKMM_EXAMPLE_HELLOWORLD_H +#define GTKMM_EXAMPLE_HELLOWORLD_H + +#include <gtkmm.h> + +class HelloWorld : public Gtk::Window +{ +public: + HelloWorld(); + virtual ~HelloWorld(); + +protected: + //Signal handlers: + void on_button_clicked(); + + //Member widgets: + Gtk::Button m_button; +}; + +#endif // GTKMM_EXAMPLE_HELLOWORLD_H diff --git a/Tests/FindGTK2/gtkmm/main.cpp b/Tests/FindGTK2/gtkmm/main.cpp new file mode 100644 index 0000000..5ff64d1 --- /dev/null +++ b/Tests/FindGTK2/gtkmm/main.cpp @@ -0,0 +1,13 @@ +#include <gtkmm.h> +#include "helloworld.h" + +int main(int argc, char *argv[]) +{ + Gtk::Main kit(argc, argv); + + HelloWorld helloworld; + //Shows the window and returns when it is closed. + Gtk::Main::run(helloworld); + + return 0; +} diff --git a/Tests/FindGTK2/pango/CMakeLists.txt b/Tests/FindGTK2/pango/CMakeLists.txt new file mode 100644 index 0000000..af382a4 --- /dev/null +++ b/Tests/FindGTK2/pango/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(pango C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(pango WIN32 main.c) +target_link_libraries(pango GTK2::pango) diff --git a/Tests/FindGTK2/pango/main.c b/Tests/FindGTK2/pango/main.c new file mode 100644 index 0000000..ef87ce4 --- /dev/null +++ b/Tests/FindGTK2/pango/main.c @@ -0,0 +1,7 @@ +#include <pango/pango.h> + +int main(int argc, char *argv[]) +{ + gboolean ret = pango_color_parse(NULL, "#ffffff"); + return 0; +} diff --git a/Tests/FindGTK2/pangocairo/CMakeLists.txt b/Tests/FindGTK2/pangocairo/CMakeLists.txt new file mode 100644 index 0000000..8f61379 --- /dev/null +++ b/Tests/FindGTK2/pangocairo/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(pangocairo C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(pangocairo WIN32 main.c) +target_link_libraries(pangocairo GTK2::pangocairo m) diff --git a/Tests/FindGTK2/pangocairo/main.c b/Tests/FindGTK2/pangocairo/main.c new file mode 100644 index 0000000..78268d6 --- /dev/null +++ b/Tests/FindGTK2/pangocairo/main.c @@ -0,0 +1,72 @@ +/* Taken from https://developer.gnome.org/pango/stable/pango-Cairo-Rendering.html */ + + +#include <math.h> +#include <pango/pangocairo.h> +static void +draw_text (cairo_t *cr) +{ +#define RADIUS 150 +#define N_WORDS 10 +#define FONT "Sans Bold 27" + PangoLayout *layout; + PangoFontDescription *desc; + int i; + /* Center coordinates on the middle of the region we are drawing + */ + cairo_translate (cr, RADIUS, RADIUS); + /* Create a PangoLayout, set the font and text */ + layout = pango_cairo_create_layout (cr); + pango_layout_set_text (layout, "Text", -1); + desc = pango_font_description_from_string (FONT); + pango_layout_set_font_description (layout, desc); + pango_font_description_free (desc); + /* Draw the layout N_WORDS times in a circle */ + for (i = 0; i < N_WORDS; i++) + { + int width, height; + double angle = (360. * i) / N_WORDS; + double red; + cairo_save (cr); + /* Gradient from red at angle == 60 to blue at angle == 240 */ + red = (1 + cos ((angle - 60) * G_PI / 180.)) / 2; + cairo_set_source_rgb (cr, red, 0, 1.0 - red); + cairo_rotate (cr, angle * G_PI / 180.); + /* Inform Pango to re-layout the text with the new transformation */ + pango_cairo_update_layout (cr, layout); + pango_layout_get_size (layout, &width, &height); + cairo_move_to (cr, - ((double)width / PANGO_SCALE) / 2, - RADIUS); + pango_cairo_show_layout (cr, layout); + cairo_restore (cr); + } + /* free the layout object */ + g_object_unref (layout); +} +int main (int argc, char **argv) +{ + cairo_t *cr; + char *filename; + cairo_status_t status; + cairo_surface_t *surface; + if (argc != 2) + { + g_printerr ("Usage: cairosimple OUTPUT_FILENAME\n"); + return 1; + } + filename = argv[1]; + surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, + 2 * RADIUS, 2 * RADIUS); + cr = cairo_create (surface); + cairo_set_source_rgb (cr, 1.0, 1.0, 1.0); + cairo_paint (cr); + draw_text (cr); + cairo_destroy (cr); + status = cairo_surface_write_to_png (surface, filename); + cairo_surface_destroy (surface); + if (status != CAIRO_STATUS_SUCCESS) + { + g_printerr ("Could not save png to '%s'\n", filename); + return 1; + } + return 0; +} diff --git a/Tests/FindGTK2/pangoft2/CMakeLists.txt b/Tests/FindGTK2/pangoft2/CMakeLists.txt new file mode 100644 index 0000000..0f84c7f --- /dev/null +++ b/Tests/FindGTK2/pangoft2/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(pangoft2 C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(pangoft2 WIN32 main.c) +target_link_libraries(pangoft2 GTK2::pangoft2) diff --git a/Tests/FindGTK2/pangoft2/main.c b/Tests/FindGTK2/pangoft2/main.c new file mode 100644 index 0000000..cf3459e --- /dev/null +++ b/Tests/FindGTK2/pangoft2/main.c @@ -0,0 +1,8 @@ +#include <pango/pangoft2.h> + +int main(int argc, char *argv[]) +{ + PangoFontMap* pfm = pango_ft2_font_map_new(); + g_object_unref(pfm); + return 0; +} diff --git a/Tests/FindGTK2/pangomm/CMakeLists.txt b/Tests/FindGTK2/pangomm/CMakeLists.txt new file mode 100644 index 0000000..3650c50 --- /dev/null +++ b/Tests/FindGTK2/pangomm/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(pangomm CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(pangomm WIN32 main.cpp) +target_link_libraries(pangomm GTK2::pangomm) diff --git a/Tests/FindGTK2/pangomm/main.cpp b/Tests/FindGTK2/pangomm/main.cpp new file mode 100644 index 0000000..32ec914 --- /dev/null +++ b/Tests/FindGTK2/pangomm/main.cpp @@ -0,0 +1,8 @@ +#include <pangomm.h> +#include <pangomm/init.h> + +int main(int argc, char *argv[]) +{ + Pango::init(); + return 0; +} diff --git a/Tests/FindGTK2/pangoxft/CMakeLists.txt b/Tests/FindGTK2/pangoxft/CMakeLists.txt new file mode 100644 index 0000000..0db16b1 --- /dev/null +++ b/Tests/FindGTK2/pangoxft/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(pangoxft C) + +find_package(GTK2 COMPONENTS gtk REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(pangoxft WIN32 main.c) +target_link_libraries(pangoxft GTK2::pangoxft) diff --git a/Tests/FindGTK2/pangoxft/main.c b/Tests/FindGTK2/pangoxft/main.c new file mode 100644 index 0000000..cb04f61 --- /dev/null +++ b/Tests/FindGTK2/pangoxft/main.c @@ -0,0 +1,7 @@ +#include <pango/pangoxft.h> + +int main(int argc, char *argv[]) +{ + pango_xft_get_context(NULL, 0); + return 0; +} diff --git a/Tests/FindGTK2/sigc++/CMakeLists.txt b/Tests/FindGTK2/sigc++/CMakeLists.txt new file mode 100644 index 0000000..f830b81 --- /dev/null +++ b/Tests/FindGTK2/sigc++/CMakeLists.txt @@ -0,0 +1,10 @@ +cmake_minimum_required(VERSION 2.8) + +project(sigc++ CXX) + +find_package(GTK2 COMPONENTS gtk gtkmm REQUIRED) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +add_executable(sigc++ WIN32 main.cpp) +target_link_libraries(sigc++ GTK2::sigc++) diff --git a/Tests/FindGTK2/sigc++/main.cpp b/Tests/FindGTK2/sigc++/main.cpp new file mode 100644 index 0000000..78428e7 --- /dev/null +++ b/Tests/FindGTK2/sigc++/main.cpp @@ -0,0 +1,30 @@ +// Taken from https://developer.gnome.org/libsigc++-tutorial/stable/ch02.html + + +#include <sigc++/sigc++.h> +#include <iostream> + +class AlienDetector +{ +public: + AlienDetector() {} + + void run() {} + + sigc::signal<void> signal_detected; +}; + +void warn_people() +{ + std::cout << "There are aliens in the carpark!" << std::endl; +} + +int main() +{ + AlienDetector mydetector; + mydetector.signal_detected.connect( sigc::ptr_fun(warn_people) ); + + mydetector.run(); + + return 0; +} diff --git a/Tests/FindPackageModeMakefileTest/CMakeLists.txt b/Tests/FindPackageModeMakefileTest/CMakeLists.txt index 3674f0e..5d1b376 100644 --- a/Tests/FindPackageModeMakefileTest/CMakeLists.txt +++ b/Tests/FindPackageModeMakefileTest/CMakeLists.txt @@ -19,8 +19,16 @@ if(UNIX AND "${CMAKE_GENERATOR}" MATCHES "Makefile") configure_file(FindFoo.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FindFoo.cmake @ONLY) # now set up the test: - get_target_property(cmakeExecutable cmake LOCATION) - + if (NOT CMAKE_VERSION VERSION_LESS 2.8.12) + file(GENERATE OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/cmakeExecutable.mk" + CONTENT "CMAKE = \"$<TARGET_FILE:cmake>\"\n" + ) + else() + get_target_property(cmakeLocation cmake LOCATION) + file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/cmakeExecutable.mk" + "CMAKE = \"${cmakeLocation}\"\n" + ) + endif() configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Makefile.in ${CMAKE_CURRENT_BINARY_DIR}/ConfMakefile @ONLY) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/main.cpp ${CMAKE_CURRENT_BINARY_DIR}/main.cpp COPYONLY) diff --git a/Tests/FindPackageModeMakefileTest/Makefile.in b/Tests/FindPackageModeMakefileTest/Makefile.in index f647901..c91d8a0 100644 --- a/Tests/FindPackageModeMakefileTest/Makefile.in +++ b/Tests/FindPackageModeMakefileTest/Makefile.in @@ -1,4 +1,6 @@ -CMAKE = "@cmakeExecutable@" + +include cmakeExecutable.mk + CMAKE_CURRENT_BINARY_DIR = "@CMAKE_CURRENT_BINARY_DIR@" CMAKE_CXX_COMPILER = "@CMAKE_CXX_COMPILER@" CMAKE_CXX_COMPILER_ID = "@CMAKE_CXX_COMPILER_ID@" diff --git a/Tests/IncludeDirectories/CMakeLists.txt b/Tests/IncludeDirectories/CMakeLists.txt index 35ad8dc..9ee1957 100644 --- a/Tests/IncludeDirectories/CMakeLists.txt +++ b/Tests/IncludeDirectories/CMakeLists.txt @@ -2,7 +2,7 @@ cmake_minimum_required (VERSION 2.6) project(IncludeDirectories) if (((CMAKE_C_COMPILER_ID STREQUAL GNU AND CMAKE_C_COMPILER_VERSION VERSION_GREATER 4.4) - OR CMAKE_C_COMPILER_ID STREQUAL Clang) + OR CMAKE_C_COMPILER_ID STREQUAL Clang OR CMAKE_C_COMPILER_ID STREQUAL AppleClang) AND (CMAKE_GENERATOR STREQUAL "Unix Makefiles" OR CMAKE_GENERATOR STREQUAL "Ninja")) include(CheckCXXCompilerFlag) check_cxx_compiler_flag(-Wunused-variable run_sys_includes_test) diff --git a/Tests/IncludeDirectories/SystemIncludeDirectories/CMakeLists.txt b/Tests/IncludeDirectories/SystemIncludeDirectories/CMakeLists.txt index aec6ff9..1f5c93b 100644 --- a/Tests/IncludeDirectories/SystemIncludeDirectories/CMakeLists.txt +++ b/Tests/IncludeDirectories/SystemIncludeDirectories/CMakeLists.txt @@ -17,3 +17,31 @@ target_include_directories(upstream SYSTEM PUBLIC add_library(consumer consumer.cpp) target_link_libraries(consumer upstream) target_compile_options(consumer PRIVATE -Werror=unused-variable) + +add_library(iface IMPORTED INTERFACE) +set_property(TARGET iface PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/systemlib_header_only") + +add_library(imported_consumer imported_consumer.cpp) +target_link_libraries(imported_consumer iface) +target_compile_options(imported_consumer PRIVATE -Werror=unused-variable) + +macro(do_try_compile error_option) + set(TC_ARGS + IFACE_TRY_COMPILE_${error_option} + "${CMAKE_CURRENT_BINARY_DIR}/try_compile_iface" "${CMAKE_CURRENT_SOURCE_DIR}/imported_consumer.cpp" + LINK_LIBRARIES iface + ) + if (${error_option} STREQUAL WITH_ERROR) + list(APPEND TC_ARGS COMPILE_DEFINITIONS -Werror=unused-variable) + endif() + try_compile(${TC_ARGS}) +endmacro() + +do_try_compile(NO_ERROR) +if (NOT IFACE_TRY_COMPILE_NO_ERROR) + message(SEND_ERROR "try_compile failed with imported target.") +endif() +do_try_compile(WITH_ERROR) +if (NOT IFACE_TRY_COMPILE_WITH_ERROR) + message(SEND_ERROR "try_compile failed with imported target with error option.") +endif() diff --git a/Tests/IncludeDirectories/SystemIncludeDirectories/imported_consumer.cpp b/Tests/IncludeDirectories/SystemIncludeDirectories/imported_consumer.cpp new file mode 100644 index 0000000..1dbe819 --- /dev/null +++ b/Tests/IncludeDirectories/SystemIncludeDirectories/imported_consumer.cpp @@ -0,0 +1,7 @@ + +#include "systemlib.h" + +int main() +{ + return systemlib(); +} diff --git a/Tests/IncludeDirectories/SystemIncludeDirectories/systemlib_header_only/systemlib.h b/Tests/IncludeDirectories/SystemIncludeDirectories/systemlib_header_only/systemlib.h new file mode 100644 index 0000000..93622c4 --- /dev/null +++ b/Tests/IncludeDirectories/SystemIncludeDirectories/systemlib_header_only/systemlib.h @@ -0,0 +1,16 @@ + +#ifndef SYSTEMLIB_H +#define SYSTEMLIB_H + +int systemlib() +{ + return 0; +} + +int unusedFunc() +{ + int unused; + return systemlib(); +} + +#endif diff --git a/Tests/InterfaceLibrary/CMakeLists.txt b/Tests/InterfaceLibrary/CMakeLists.txt new file mode 100644 index 0000000..53aeb03 --- /dev/null +++ b/Tests/InterfaceLibrary/CMakeLists.txt @@ -0,0 +1,15 @@ + +cmake_minimum_required(VERSION 2.8) + +project(InterfaceLibrary) + +add_library(iface_nodepends INTERFACE) +target_compile_definitions(iface_nodepends INTERFACE IFACE_DEFINE) + +add_executable(InterfaceLibrary definetestexe.cpp) +target_link_libraries(InterfaceLibrary iface_nodepends) + +add_subdirectory(libsdir) + +add_executable(sharedlibtestexe sharedlibtestexe.cpp) +target_link_libraries(sharedlibtestexe shared_iface) diff --git a/Tests/InterfaceLibrary/definetestexe.cpp b/Tests/InterfaceLibrary/definetestexe.cpp new file mode 100644 index 0000000..decd37c --- /dev/null +++ b/Tests/InterfaceLibrary/definetestexe.cpp @@ -0,0 +1,9 @@ + +#ifndef IFACE_DEFINE +#error Expected IFACE_DEFINE +#endif + +int main(int,char**) +{ + return 0; +} diff --git a/Tests/InterfaceLibrary/libsdir/CMakeLists.txt b/Tests/InterfaceLibrary/libsdir/CMakeLists.txt new file mode 100644 index 0000000..6999646 --- /dev/null +++ b/Tests/InterfaceLibrary/libsdir/CMakeLists.txt @@ -0,0 +1,26 @@ + +include(GenerateExportHeader) + +add_library(sharedlib SHARED sharedlib.cpp) +generate_export_header(sharedlib) + +add_library(shareddependlib SHARED shareddependlib.cpp) +generate_export_header(shareddependlib) + +set(CMAKE_INCLUDE_CURRENT_DIR ON) +set(CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE ON) + +target_link_libraries(sharedlib PUBLIC shareddependlib) + +target_include_directories(shareddependlib + PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/shareddependlib") +target_compile_definitions(shareddependlib + INTERFACE $<1:SHAREDDEPENDLIB_DEFINE>) + +target_include_directories(sharedlib + PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/sharedlib") +target_compile_definitions(shareddependlib + INTERFACE $<1:SHAREDLIB_DEFINE>) + +add_library(shared_iface INTERFACE) +target_link_libraries(shared_iface INTERFACE sharedlib) diff --git a/Tests/InterfaceLibrary/libsdir/shareddependlib.cpp b/Tests/InterfaceLibrary/libsdir/shareddependlib.cpp new file mode 100644 index 0000000..378ba81 --- /dev/null +++ b/Tests/InterfaceLibrary/libsdir/shareddependlib.cpp @@ -0,0 +1,7 @@ + +#include "shareddependlib.h" + +int SharedDependLibObject::foo() const +{ + return 0; +} diff --git a/Tests/InterfaceLibrary/libsdir/shareddependlib/shareddependlib.h b/Tests/InterfaceLibrary/libsdir/shareddependlib/shareddependlib.h new file mode 100644 index 0000000..ad9b484 --- /dev/null +++ b/Tests/InterfaceLibrary/libsdir/shareddependlib/shareddependlib.h @@ -0,0 +1,12 @@ + +#ifndef SHAREDDEPENDLIB_H +#define SHAREDDEPENDLIB_H + +#include "shareddependlib_export.h" + +struct SHAREDDEPENDLIB_EXPORT SharedDependLibObject +{ + int foo() const; +}; + +#endif diff --git a/Tests/InterfaceLibrary/libsdir/sharedlib.cpp b/Tests/InterfaceLibrary/libsdir/sharedlib.cpp new file mode 100644 index 0000000..c49ce90 --- /dev/null +++ b/Tests/InterfaceLibrary/libsdir/sharedlib.cpp @@ -0,0 +1,12 @@ + +#include "sharedlib.h" + +SharedDependLibObject SharedLibObject::object() const +{ + SharedDependLibObject sdlo; + return sdlo; +} +int SharedLibObject::foo() const +{ + return 0; +} diff --git a/Tests/InterfaceLibrary/libsdir/sharedlib/sharedlib.h b/Tests/InterfaceLibrary/libsdir/sharedlib/sharedlib.h new file mode 100644 index 0000000..5b3c7db --- /dev/null +++ b/Tests/InterfaceLibrary/libsdir/sharedlib/sharedlib.h @@ -0,0 +1,15 @@ + +#ifndef SHAREDLIB_H +#define SHAREDLIB_H + +#include "sharedlib_export.h" + +#include "shareddependlib.h" + +struct SHAREDLIB_EXPORT SharedLibObject +{ + SharedDependLibObject object() const; + int foo() const; +}; + +#endif diff --git a/Tests/InterfaceLibrary/sharedlibtestexe.cpp b/Tests/InterfaceLibrary/sharedlibtestexe.cpp new file mode 100644 index 0000000..c677f70 --- /dev/null +++ b/Tests/InterfaceLibrary/sharedlibtestexe.cpp @@ -0,0 +1,19 @@ + +#ifndef SHAREDLIB_DEFINE +#error Expected SHAREDLIB_DEFINE +#endif + +#ifndef SHAREDDEPENDLIB_DEFINE +#error Expected SHAREDDEPENDLIB_DEFINE +#endif + +#include "sharedlib.h" +#include "shareddependlib.h" + +int main(int,char**) +{ + SharedLibObject sl; + SharedDependLibObject sdl = sl.object(); + + return sdl.foo() + sl.foo(); +} diff --git a/Tests/PositionIndependentTargets/CMakeLists.txt b/Tests/PositionIndependentTargets/CMakeLists.txt index eec893d..e79f3b7 100644 --- a/Tests/PositionIndependentTargets/CMakeLists.txt +++ b/Tests/PositionIndependentTargets/CMakeLists.txt @@ -9,5 +9,6 @@ include_directories("${CMAKE_CURRENT_SOURCE_DIR}") # For pic_test.h add_subdirectory(global) add_subdirectory(targets) +add_subdirectory(interface) add_executable(PositionIndependentTargets main.cpp) diff --git a/Tests/PositionIndependentTargets/interface/CMakeLists.txt b/Tests/PositionIndependentTargets/interface/CMakeLists.txt new file mode 100644 index 0000000..65f3b76 --- /dev/null +++ b/Tests/PositionIndependentTargets/interface/CMakeLists.txt @@ -0,0 +1,27 @@ + +add_library(piciface INTERFACE) +set_property(TARGET piciface PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) + +add_executable(test_empty_iface "${CMAKE_CURRENT_SOURCE_DIR}/../pic_main.cpp") +target_link_libraries(test_empty_iface piciface) + +add_library(sharedlib SHARED "${CMAKE_CURRENT_SOURCE_DIR}/../pic_lib.cpp") +target_link_libraries(sharedlib piciface) +set_property(TARGET sharedlib PROPERTY DEFINE_SYMBOL PIC_TEST_BUILD_DLL) + +add_executable(test_iface_via_shared "${CMAKE_CURRENT_SOURCE_DIR}/../pic_main.cpp") +target_link_libraries(test_iface_via_shared sharedlib) + +add_library(sharedlibpic SHARED "${CMAKE_CURRENT_SOURCE_DIR}/../pic_lib.cpp") +set_property(TARGET sharedlibpic PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) +set_property(TARGET sharedlibpic PROPERTY DEFINE_SYMBOL PIC_TEST_BUILD_DLL) + +add_library(shared_iface INTERFACE) +target_link_libraries(shared_iface INTERFACE sharedlibpic) + +add_executable(test_shared_via_iface "${CMAKE_CURRENT_SOURCE_DIR}/../pic_main.cpp") +target_link_libraries(test_shared_via_iface shared_iface) + +add_executable(test_shared_via_iface_non_conflict "${CMAKE_CURRENT_SOURCE_DIR}/../pic_main.cpp") +set_property(TARGET test_shared_via_iface_non_conflict PROPERTY POSITION_INDEPENDENT_CODE ON) +target_link_libraries(test_shared_via_iface_non_conflict shared_iface) diff --git a/Tests/PythonCoverage/DartConfiguration.tcl.in b/Tests/PythonCoverage/DartConfiguration.tcl.in new file mode 100644 index 0000000..e29cffe --- /dev/null +++ b/Tests/PythonCoverage/DartConfiguration.tcl.in @@ -0,0 +1,8 @@ +# This file is configured by CMake automatically as DartConfiguration.tcl +# If you choose not to use CMake, this file may be hand configured, by +# filling in the required variables. + + +# Configuration directories and files +SourceDirectory: ${CMake_BINARY_DIR}/Testing/PythonCoverage/coveragetest +BuildDirectory: ${CMake_BINARY_DIR}/Testing/PythonCoverage diff --git a/Tests/PythonCoverage/coverage.xml.in b/Tests/PythonCoverage/coverage.xml.in new file mode 100644 index 0000000..fcc1b1c --- /dev/null +++ b/Tests/PythonCoverage/coverage.xml.in @@ -0,0 +1,35 @@ +<?xml version="1.0" ?> +<!DOCTYPE coverage + SYSTEM 'http://cobertura.sourceforge.net/xml/coverage-03.dtd'> +<coverage branch-rate="0" line-rate="0.8462" timestamp="1380469411433" version="3.6"> + <!-- Generated by coverage.py: http://nedbatchelder.com/code/coverage --> + <packages> + <package branch-rate="0" complexity="0" line-rate="0.8462" name=""> + <classes> + <class branch-rate="0" complexity="0" filename="foo.py" line-rate="0.6667" name="foo"> + <methods/> + <lines> + <line hits="1" number="2"/> + <line hits="1" number="3"/> + <line hits="1" number="4"/> + <line hits="1" number="6"/> + <line hits="0" number="7"/> + <line hits="0" number="8"/> + </lines> + </class> + <class branch-rate="0" complexity="0" filename="test_foo.py" line-rate="1" name="test_foo"> + <methods/> + <lines> + <line hits="1" number="2"/> + <line hits="1" number="3"/> + <line hits="1" number="5"/> + <line hits="1" number="7"/> + <line hits="1" number="8"/> + <line hits="1" number="10"/> + <line hits="1" number="11"/> + </lines> + </class> + </classes> + </package> + </packages> +</coverage> diff --git a/Tests/PythonCoverage/coveragetest/foo.py b/Tests/PythonCoverage/coveragetest/foo.py new file mode 100644 index 0000000..97b5a41 --- /dev/null +++ b/Tests/PythonCoverage/coveragetest/foo.py @@ -0,0 +1,8 @@ + +def foo(): + x = 3 + 3 + return x + +def bar(): + y = 2 + 2 + return y diff --git a/Tests/PythonCoverage/coveragetest/test_foo.py b/Tests/PythonCoverage/coveragetest/test_foo.py new file mode 100644 index 0000000..51a69d8 --- /dev/null +++ b/Tests/PythonCoverage/coveragetest/test_foo.py @@ -0,0 +1,11 @@ + +import foo +import unittest + +class TestFoo(unittest.TestCase): + + def testFoo(self): + self.assertEquals(foo.foo(), 6, 'foo() == 6') + +if __name__ == '__main__': + unittest.main() diff --git a/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-result.txt b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-stderr.txt b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-stderr.txt new file mode 100644 index 0000000..6d519f0 --- /dev/null +++ b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old-stderr.txt @@ -0,0 +1,17 @@ +CMake Warning \(dev\) in CMakeLists.txt: + Policy CMP0022 is not set: INTERFACE_LINK_LIBRARIES defines the link + interface. Run "cmake --help-policy CMP0022" for policy details. Use the + cmake_policy command to set the policy and suppress this warning. + + Target "bar" has a INTERFACE_LINK_LIBRARIES property which differs from its + LINK_INTERFACE_LIBRARIES properties. + + INTERFACE_LINK_LIBRARIES: + + foo + + LINK_INTERFACE_LIBRARIES: + + \(empty\) + +This warning is for project developers. Use -Wno-dev to suppress it. diff --git a/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old.cmake b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old.cmake new file mode 100644 index 0000000..c5d3c29 --- /dev/null +++ b/Tests/RunCMake/CMP0022/CMP0022-WARN-empty-old.cmake @@ -0,0 +1,10 @@ + +project(CMP0022-WARN-empty-old) + +add_library(foo SHARED empty_vs6_1.cpp) +add_library(bar SHARED empty_vs6_2.cpp) + +set_property(TARGET bar PROPERTY INTERFACE_LINK_LIBRARIES foo) + +add_library(user empty.cpp) +target_link_libraries(user bar) diff --git a/Tests/RunCMake/CMP0022/CMP0022-export-stderr.txt b/Tests/RunCMake/CMP0022/CMP0022-export-stderr.txt index ae7627e..405dd8d 100644 --- a/Tests/RunCMake/CMP0022/CMP0022-export-stderr.txt +++ b/Tests/RunCMake/CMP0022/CMP0022-export-stderr.txt @@ -1,4 +1,4 @@ -CMake Error at CMP0022-export.cmake:11 \(export\): +CMake Error in CMakeLists.txt: Target "cmp0022NEW" has policy CMP0022 enabled, but also has old-style LINK_INTERFACE_LIBRARIES properties populated, but it was exported without the EXPORT_LINK_INTERFACE_LIBRARIES to export the old-style properties diff --git a/Tests/RunCMake/CMP0022/RunCMakeTest.cmake b/Tests/RunCMake/CMP0022/RunCMakeTest.cmake index dcef0f5..8e5824a 100644 --- a/Tests/RunCMake/CMP0022/RunCMakeTest.cmake +++ b/Tests/RunCMake/CMP0022/RunCMakeTest.cmake @@ -3,6 +3,7 @@ include(RunCMake) run_cmake(CMP0022-WARN) run_cmake(CMP0022-WARN-tll) run_cmake(CMP0022-WARN-static) +run_cmake(CMP0022-WARN-empty-old) run_cmake(CMP0022-NOWARN-static) run_cmake(CMP0022-NOWARN-static-link_libraries) run_cmake(CMP0022-export) diff --git a/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-result.txt b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-stderr.txt b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-stderr.txt new file mode 100644 index 0000000..10f3293 --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED-stderr.txt @@ -0,0 +1 @@ +^$ diff --git a/Tests/RunCMake/CMP0026/CMP0026-IMPORTED.cmake b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED.cmake new file mode 100644 index 0000000..650c8a5 --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-IMPORTED.cmake @@ -0,0 +1,6 @@ + +enable_language(CXX) + +add_library(someimportedlib SHARED IMPORTED) + +get_target_property(_loc someimportedlib LOCATION) diff --git a/Tests/RunCMake/CMP0026/CMP0026-NEW-result.txt b/Tests/RunCMake/CMP0026/CMP0026-NEW-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-NEW-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CMP0026/CMP0026-NEW-stderr.txt b/Tests/RunCMake/CMP0026/CMP0026-NEW-stderr.txt new file mode 100644 index 0000000..2a05a4d --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-NEW-stderr.txt @@ -0,0 +1,11 @@ +CMake Error at CMP0026-NEW.cmake:7 \(get_target_property\): + Policy CMP0026 is not set: Disallow use of the LOCATION target property. + Run "cmake --help-policy CMP0026" for policy details. Use the cmake_policy + command to set the policy and suppress this warning. + + The LOCATION property may not be read from target "somelib". Use the + target name directly with add_custom_command, or use the generator + expression \$<TARGET_FILE>, as appropriate. + +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/CMP0026/CMP0026-NEW.cmake b/Tests/RunCMake/CMP0026/CMP0026-NEW.cmake new file mode 100644 index 0000000..1659ffc --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-NEW.cmake @@ -0,0 +1,7 @@ + +enable_language(CXX) + +cmake_policy(SET CMP0026 NEW) + +add_library(somelib empty.cpp) +get_target_property(_loc somelib LOCATION) diff --git a/Tests/RunCMake/CMP0026/CMP0026-WARN-result.txt b/Tests/RunCMake/CMP0026/CMP0026-WARN-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-WARN-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/CMP0026/CMP0026-WARN-stderr.txt b/Tests/RunCMake/CMP0026/CMP0026-WARN-stderr.txt new file mode 100644 index 0000000..9b88194 --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-WARN-stderr.txt @@ -0,0 +1,12 @@ +CMake Warning \(dev\) at CMP0026-WARN.cmake:5 \(get_target_property\): + Policy CMP0026 is not set: Disallow use of the LOCATION target property. + Run "cmake --help-policy CMP0026" for policy details. Use the cmake_policy + command to set the policy and suppress this warning. + + The LOCATION property should not be read from target "somelib". Use the + target name directly with add_custom_command, or use the generator + expression \$<TARGET_FILE>, as appropriate. + +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) +This warning is for project developers. Use -Wno-dev to suppress it. diff --git a/Tests/RunCMake/CMP0026/CMP0026-WARN.cmake b/Tests/RunCMake/CMP0026/CMP0026-WARN.cmake new file mode 100644 index 0000000..89c5a8a --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMP0026-WARN.cmake @@ -0,0 +1,5 @@ + +enable_language(CXX) + +add_library(somelib empty.cpp) +get_target_property(_loc somelib LOCATION) diff --git a/Tests/RunCMake/CMP0026/CMakeLists.txt b/Tests/RunCMake/CMP0026/CMakeLists.txt new file mode 100644 index 0000000..e8db6b0 --- /dev/null +++ b/Tests/RunCMake/CMP0026/CMakeLists.txt @@ -0,0 +1,3 @@ +cmake_minimum_required(VERSION 2.8) +project(${RunCMake_TEST} NONE) +include(${RunCMake_TEST}.cmake) diff --git a/Tests/RunCMake/CMP0026/RunCMakeTest.cmake b/Tests/RunCMake/CMP0026/RunCMakeTest.cmake new file mode 100644 index 0000000..68000a6 --- /dev/null +++ b/Tests/RunCMake/CMP0026/RunCMakeTest.cmake @@ -0,0 +1,5 @@ +include(RunCMake) + +run_cmake(CMP0026-WARN) +run_cmake(CMP0026-NEW) +run_cmake(CMP0026-IMPORTED) diff --git a/Tests/RunCMake/CMP0026/empty.cpp b/Tests/RunCMake/CMP0026/empty.cpp new file mode 100644 index 0000000..bfbbdde --- /dev/null +++ b/Tests/RunCMake/CMP0026/empty.cpp @@ -0,0 +1,7 @@ +#ifdef _WIN32 +__declspec(dllexport) +#endif +int empty() +{ + return 0; +} diff --git a/Tests/RunCMake/CMakeLists.txt b/Tests/RunCMake/CMakeLists.txt index e45aba3..6d5b07b 100644 --- a/Tests/RunCMake/CMakeLists.txt +++ b/Tests/RunCMake/CMakeLists.txt @@ -53,6 +53,7 @@ endif() add_RunCMake_test(CMP0019) add_RunCMake_test(CMP0022) +add_RunCMake_test(CMP0026) add_RunCMake_test(CTest) if(UNIX AND "${CMAKE_TEST_GENERATOR}" MATCHES "Unix Makefiles") add_RunCMake_test(CompilerChange) @@ -95,11 +96,13 @@ add_RunCMake_test(if) add_RunCMake_test(include) add_RunCMake_test(include_directories) add_RunCMake_test(list) +add_RunCMake_test(message) add_RunCMake_test(try_compile) add_RunCMake_test(variable_watch) add_RunCMake_test(CMP0004) add_RunCMake_test(TargetPolicies) add_RunCMake_test(alias_targets) +add_RunCMake_test(interface_library) find_package(Qt4 QUIET) find_package(Qt5Core QUIET) @@ -119,3 +122,4 @@ endif() add_RunCMake_test(File_Generate) add_RunCMake_test(ExportWithoutLanguage) add_RunCMake_test(target_link_libraries) +add_RunCMake_test(CheckModules) diff --git a/Tests/RunCMake/CheckModules/CMakeLists.txt b/Tests/RunCMake/CheckModules/CMakeLists.txt new file mode 100644 index 0000000..65ac8e8 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CMakeLists.txt @@ -0,0 +1,3 @@ +cmake_minimum_required(VERSION 2.8.11) +project(${RunCMake_TEST}) +include(${RunCMake_TEST}.cmake) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-result.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-stderr.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-stderr.txt new file mode 100644 index 0000000..1b8603a --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey-stderr.txt @@ -0,0 +1,8 @@ +CMake Error at .*/Modules/CheckStructHasMember.cmake:[0-9]+. \(message\): + Unknown arguments: + + C + +Call Stack \(most recent call first\): + CheckStructHasMemberMissingKey.cmake:[0-9]+ \(check_struct_has_member\) + CMakeLists.txt:[0-9]+ \(include\) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey.cmake new file mode 100644 index 0000000..49f51ce --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingKey.cmake @@ -0,0 +1,2 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_K C) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-result.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-stderr.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-stderr.txt new file mode 100644 index 0000000..8fceab0 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage-stderr.txt @@ -0,0 +1,8 @@ +CMake Error at .*/Modules/CheckStructHasMember.cmake:[0-9]+. \(message\): + Unknown arguments: + + LANGUAGE + +Call Stack \(most recent call first\): + CheckStructHasMemberMissingLanguage.cmake:[0-9]+ \(check_struct_has_member\) + CMakeLists.txt:[0-9]+ \(include\) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage.cmake new file mode 100644 index 0000000..b404d66 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberMissingLanguage.cmake @@ -0,0 +1,2 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_K LANGUAGE) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberOk.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberOk.cmake new file mode 100644 index 0000000..b319e18 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberOk.cmake @@ -0,0 +1,4 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_C LANGUAGE C) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_CXX LANGUAGE CXX) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-result.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-stderr.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-stderr.txt new file mode 100644 index 0000000..4598867 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments-stderr.txt @@ -0,0 +1,8 @@ +CMake Error at .*/Modules/CheckStructHasMember.cmake:[0-9]+. \(message\): + Unknown arguments: + + LANGUAGE;C;CXX + +Call Stack \(most recent call first\): + CheckStructHasMemberTooManyArguments.cmake:[0-9]+ \(check_struct_has_member\) + CMakeLists.txt:[0-9]+ \(include\) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments.cmake new file mode 100644 index 0000000..12f8158 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberTooManyArguments.cmake @@ -0,0 +1,2 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_K LANGUAGE C CXX) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-result.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-stderr.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-stderr.txt new file mode 100644 index 0000000..ba9e313 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage-stderr.txt @@ -0,0 +1,10 @@ +CMake Error at .*/Modules/CheckStructHasMember.cmake:[0-9]+. \(message\): + Unknown language: + + FORTRAN + + Supported languages: C, CXX. + +Call Stack \(most recent call first\): + CheckStructHasMemberUnknownLanguage.cmake:[0-9]+ \(check_struct_has_member\) + CMakeLists.txt:[0-9]+ \(include\) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage.cmake new file mode 100644 index 0000000..183058d --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberUnknownLanguage.cmake @@ -0,0 +1,2 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_K LANGUAGE FORTRAN) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-result.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-stderr.txt b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-stderr.txt new file mode 100644 index 0000000..b9fbd38 --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey-stderr.txt @@ -0,0 +1,8 @@ +CMake Error at .*/Modules/CheckStructHasMember.cmake:[0-9]+. \(message\): + Unknown arguments: + + LANGUAG;C + +Call Stack \(most recent call first\): + CheckStructHasMemberWrongKey.cmake:[0-9]+ \(check_struct_has_member\) + CMakeLists.txt:[0-9]+ \(include\) diff --git a/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey.cmake b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey.cmake new file mode 100644 index 0000000..900eb0a --- /dev/null +++ b/Tests/RunCMake/CheckModules/CheckStructHasMemberWrongKey.cmake @@ -0,0 +1,2 @@ +include(CheckStructHasMember) +check_struct_has_member("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC_K LANGUAG C) diff --git a/Tests/RunCMake/CheckModules/RunCMakeTest.cmake b/Tests/RunCMake/CheckModules/RunCMakeTest.cmake new file mode 100644 index 0000000..6a6b36e --- /dev/null +++ b/Tests/RunCMake/CheckModules/RunCMakeTest.cmake @@ -0,0 +1,8 @@ +include(RunCMake) + +run_cmake(CheckStructHasMemberOk) +run_cmake(CheckStructHasMemberUnknownLanguage) +run_cmake(CheckStructHasMemberMissingLanguage) +run_cmake(CheckStructHasMemberMissingKey) +run_cmake(CheckStructHasMemberTooManyArguments) +run_cmake(CheckStructHasMemberWrongKey) diff --git a/Tests/RunCMake/ExportWithoutLanguage/NoLanguage-stderr.txt b/Tests/RunCMake/ExportWithoutLanguage/NoLanguage-stderr.txt index 67a0ae3..5658d85 100644 --- a/Tests/RunCMake/ExportWithoutLanguage/NoLanguage-stderr.txt +++ b/Tests/RunCMake/ExportWithoutLanguage/NoLanguage-stderr.txt @@ -1,6 +1,4 @@ CMake Error: CMake can not determine linker language for target: NoLanguage -CMake Error at NoLanguage.cmake:2 \(export\): +CMake Error in CMakeLists.txt: Exporting the target "NoLanguage" is not allowed since its linker language cannot be determined -Call Stack \(most recent call first\): - CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/ExportWithoutLanguage/header.h b/Tests/RunCMake/ExportWithoutLanguage/header.h new file mode 100644 index 0000000..0c803ed --- /dev/null +++ b/Tests/RunCMake/ExportWithoutLanguage/header.h @@ -0,0 +1,2 @@ + +enum some_compilers { need_more_than_nothing }; diff --git a/Tests/RunCMake/ObsoleteQtMacros/AutomocMacro-WARN-stderr.txt b/Tests/RunCMake/ObsoleteQtMacros/AutomocMacro-WARN-stderr.txt index 6f7e8ee..f358cc4 100644 --- a/Tests/RunCMake/ObsoleteQtMacros/AutomocMacro-WARN-stderr.txt +++ b/Tests/RunCMake/ObsoleteQtMacros/AutomocMacro-WARN-stderr.txt @@ -1,4 +1,4 @@ -CMake Warning at .*/Modules/Qt4Macros.cmake:[^ ]+ \(message\): +CMake Deprecation Warning at .*/Modules/Qt4Macros.cmake:[^ ]+ \(message\): The qt4_automoc macro is obsolete. Use the CMAKE_AUTOMOC feature instead. Call Stack \(most recent call first\): AutomocMacro-WARN.cmake:7 \(qt4_automoc\) diff --git a/Tests/RunCMake/ObsoleteQtMacros/UseModulesMacro-WARN-stderr.txt b/Tests/RunCMake/ObsoleteQtMacros/UseModulesMacro-WARN-stderr.txt index b90c665..c69af65 100644 --- a/Tests/RunCMake/ObsoleteQtMacros/UseModulesMacro-WARN-stderr.txt +++ b/Tests/RunCMake/ObsoleteQtMacros/UseModulesMacro-WARN-stderr.txt @@ -1,4 +1,4 @@ -CMake Warning at .*/Modules/Qt4Macros.cmake:[^ ]+ \(message\): +CMake Deprecation Warning at .*/Modules/Qt4Macros.cmake:[^ ]+ \(message\): The qt4_use_modules function is obsolete. Use target_link_libraries with IMPORTED targets instead. Call Stack \(most recent call first\): diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict4-result.txt b/Tests/RunCMake/PositionIndependentCode/Conflict4-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict4-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict4-stderr.txt b/Tests/RunCMake/PositionIndependentCode/Conflict4-stderr.txt new file mode 100644 index 0000000..76d5ea0 --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict4-stderr.txt @@ -0,0 +1,4 @@ +CMake Error: Property POSITION_INDEPENDENT_CODE on target "conflict" is +implied to be FALSE because it was used to determine the link libraries +already. The INTERFACE_POSITION_INDEPENDENT_CODE property on +dependency "picon" is in conflict. diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict4.cmake b/Tests/RunCMake/PositionIndependentCode/Conflict4.cmake new file mode 100644 index 0000000..ff5dfb3 --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict4.cmake @@ -0,0 +1,8 @@ + +add_library(piciface INTERFACE) + +add_library(picon INTERFACE) +set_property(TARGET picon PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) + +add_executable(conflict "main.cpp") +target_link_libraries(conflict picon $<$<BOOL:$<TARGET_PROPERTY:POSITION_INDEPENDENT_CODE>>:piciface>) diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict5-result.txt b/Tests/RunCMake/PositionIndependentCode/Conflict5-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict5-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict5-stderr.txt b/Tests/RunCMake/PositionIndependentCode/Conflict5-stderr.txt new file mode 100644 index 0000000..ecd0492 --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict5-stderr.txt @@ -0,0 +1,3 @@ +CMake Error: The INTERFACE_POSITION_INDEPENDENT_CODE property of "picoff" does +not agree with the value of POSITION_INDEPENDENT_CODE already determined +for "conflict". diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict5.cmake b/Tests/RunCMake/PositionIndependentCode/Conflict5.cmake new file mode 100644 index 0000000..e6055f4 --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict5.cmake @@ -0,0 +1,9 @@ + +add_library(picon INTERFACE) +set_property(TARGET picon PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) + +add_library(picoff INTERFACE) +set_property(TARGET picoff PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE OFF) + +add_executable(conflict "main.cpp") +target_link_libraries(conflict picon picoff) diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict6-result.txt b/Tests/RunCMake/PositionIndependentCode/Conflict6-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict6-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict6-stderr.txt b/Tests/RunCMake/PositionIndependentCode/Conflict6-stderr.txt new file mode 100644 index 0000000..0254e55 --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict6-stderr.txt @@ -0,0 +1,4 @@ +Property POSITION_INDEPENDENT_CODE on target "conflict" is +implied to be FALSE because it was used to determine the link libraries +already. The INTERFACE_POSITION_INDEPENDENT_CODE property on +dependency "picon" is in conflict. diff --git a/Tests/RunCMake/PositionIndependentCode/Conflict6.cmake b/Tests/RunCMake/PositionIndependentCode/Conflict6.cmake new file mode 100644 index 0000000..7ea7c5f --- /dev/null +++ b/Tests/RunCMake/PositionIndependentCode/Conflict6.cmake @@ -0,0 +1,8 @@ + +add_library(picoff INTERFACE) + +add_library(picon INTERFACE) +set_property(TARGET picon PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON) + +add_executable(conflict "main.cpp") +target_link_libraries(conflict picon $<$<NOT:$<BOOL:$<TARGET_PROPERTY:POSITION_INDEPENDENT_CODE>>>:picoff>) diff --git a/Tests/RunCMake/PositionIndependentCode/RunCMakeTest.cmake b/Tests/RunCMake/PositionIndependentCode/RunCMakeTest.cmake index 64a340c..3a2009b 100644 --- a/Tests/RunCMake/PositionIndependentCode/RunCMakeTest.cmake +++ b/Tests/RunCMake/PositionIndependentCode/RunCMakeTest.cmake @@ -3,3 +3,6 @@ include(RunCMake) run_cmake(Conflict1) run_cmake(Conflict2) run_cmake(Conflict3) +run_cmake(Conflict4) +run_cmake(Conflict5) +run_cmake(Conflict6) diff --git a/Tests/RunCMake/RunCMake.cmake b/Tests/RunCMake/RunCMake.cmake index f770c93..5c7c05c 100644 --- a/Tests/RunCMake/RunCMake.cmake +++ b/Tests/RunCMake/RunCMake.cmake @@ -36,6 +36,9 @@ function(run_cmake test) if(NOT DEFINED RunCMake_TEST_OPTIONS) set(RunCMake_TEST_OPTIONS "") endif() + if(APPLE) + list(APPEND RunCMake_TEST_OPTIONS -DCMAKE_POLICY_DEFAULT_CMP0025=NEW) + endif() execute_process( COMMAND ${CMAKE_COMMAND} "${RunCMake_TEST_SOURCE_DIR}" -G "${RunCMake_GENERATOR}" diff --git a/Tests/RunCMake/include/CMP0024-NEW-result.txt b/Tests/RunCMake/include/CMP0024-NEW-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-NEW-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/include/CMP0024-NEW-stderr.txt b/Tests/RunCMake/include/CMP0024-NEW-stderr.txt new file mode 100644 index 0000000..059d7e4 --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-NEW-stderr.txt @@ -0,0 +1,12 @@ +CMake Error at subdir2/CMakeLists.txt:2 \(include\): + Policy CMP0024 is not set: Disallow include export result. Run "cmake + --help-policy CMP0024" for policy details. Use the cmake_policy command to + set the policy and suppress this warning. + + The file + + .*/Tests/RunCMake/include/CMP0024-NEW-build/subdir1/theTargets.cmake + + was generated by the export\(\) command. It may not be used as the argument + to the include\(\) command. Use ALIAS targets instead to refer to targets by + alternative names. diff --git a/Tests/RunCMake/include/CMP0024-NEW.cmake b/Tests/RunCMake/include/CMP0024-NEW.cmake new file mode 100644 index 0000000..0e03d2a --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-NEW.cmake @@ -0,0 +1,9 @@ + +enable_language(CXX) + +cmake_policy(SET CMP0024 NEW) + +add_library(foo SHARED empty.cpp) + +add_subdirectory(subdir1) +add_subdirectory(subdir2) diff --git a/Tests/RunCMake/include/CMP0024-WARN-result.txt b/Tests/RunCMake/include/CMP0024-WARN-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-WARN-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/include/CMP0024-WARN-stderr.txt b/Tests/RunCMake/include/CMP0024-WARN-stderr.txt new file mode 100644 index 0000000..9c79007 --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-WARN-stderr.txt @@ -0,0 +1,14 @@ +CMake Warning \(dev\) at subdir2/CMakeLists.txt:2 \(include\): + Policy CMP0024 is not set: Disallow include export result. Run "cmake + --help-policy CMP0024" for policy details. Use the cmake_policy command to + set the policy and suppress this warning. + + The file + + .*/Tests/RunCMake/include/CMP0024-WARN-build/subdir1/theTargets.cmake + + was generated by the export\(\) command. It should not be used as the + argument to the include\(\) command. Use ALIAS targets instead to refer to + targets by alternative names. + +This warning is for project developers. Use -Wno-dev to suppress it. diff --git a/Tests/RunCMake/include/CMP0024-WARN.cmake b/Tests/RunCMake/include/CMP0024-WARN.cmake new file mode 100644 index 0000000..783cf78 --- /dev/null +++ b/Tests/RunCMake/include/CMP0024-WARN.cmake @@ -0,0 +1,7 @@ + +enable_language(CXX) + +add_library(foo SHARED empty.cpp) + +add_subdirectory(subdir1) +add_subdirectory(subdir2) diff --git a/Tests/RunCMake/include/RunCMakeTest.cmake b/Tests/RunCMake/include/RunCMakeTest.cmake index 59b87ca..7fc9a12 100644 --- a/Tests/RunCMake/include/RunCMakeTest.cmake +++ b/Tests/RunCMake/include/RunCMakeTest.cmake @@ -2,3 +2,5 @@ include(RunCMake) run_cmake(EmptyString) run_cmake(EmptyStringOptional) +run_cmake(CMP0024-WARN) +run_cmake(CMP0024-NEW) diff --git a/Tests/RunCMake/include/empty.cpp b/Tests/RunCMake/include/empty.cpp new file mode 100644 index 0000000..bfbbdde --- /dev/null +++ b/Tests/RunCMake/include/empty.cpp @@ -0,0 +1,7 @@ +#ifdef _WIN32 +__declspec(dllexport) +#endif +int empty() +{ + return 0; +} diff --git a/Tests/RunCMake/include/subdir1/CMakeLists.txt b/Tests/RunCMake/include/subdir1/CMakeLists.txt new file mode 100644 index 0000000..11a76d1 --- /dev/null +++ b/Tests/RunCMake/include/subdir1/CMakeLists.txt @@ -0,0 +1,2 @@ + +export(TARGETS foo FILE "${CMAKE_CURRENT_BINARY_DIR}/theTargets.cmake") diff --git a/Tests/RunCMake/include/subdir2/CMakeLists.txt b/Tests/RunCMake/include/subdir2/CMakeLists.txt new file mode 100644 index 0000000..7361f9c --- /dev/null +++ b/Tests/RunCMake/include/subdir2/CMakeLists.txt @@ -0,0 +1,2 @@ + +include("${CMAKE_CURRENT_BINARY_DIR}/../subdir1/theTargets.cmake") diff --git a/Tests/RunCMake/interface_library/CMakeLists.txt b/Tests/RunCMake/interface_library/CMakeLists.txt new file mode 100644 index 0000000..12cd3c7 --- /dev/null +++ b/Tests/RunCMake/interface_library/CMakeLists.txt @@ -0,0 +1,3 @@ +cmake_minimum_required(VERSION 2.8.4) +project(${RunCMake_TEST} NONE) +include(${RunCMake_TEST}.cmake) diff --git a/Tests/RunCMake/interface_library/RunCMakeTest.cmake b/Tests/RunCMake/interface_library/RunCMakeTest.cmake new file mode 100644 index 0000000..56caf68 --- /dev/null +++ b/Tests/RunCMake/interface_library/RunCMakeTest.cmake @@ -0,0 +1,4 @@ +include(RunCMake) + +run_cmake(invalid_name) +run_cmake(target_commands) diff --git a/Tests/RunCMake/interface_library/invalid_name-result.txt b/Tests/RunCMake/interface_library/invalid_name-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/interface_library/invalid_name-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/interface_library/invalid_name-stderr.txt b/Tests/RunCMake/interface_library/invalid_name-stderr.txt new file mode 100644 index 0000000..e14fcde --- /dev/null +++ b/Tests/RunCMake/interface_library/invalid_name-stderr.txt @@ -0,0 +1,15 @@ +CMake Error at invalid_name.cmake:2 \(add_library\): + add_library Invalid name for INTERFACE library target: if\$ace +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at invalid_name.cmake:4 \(add_library\): + add_library Invalid name for INTERFACE library target: iface::target +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at invalid_name.cmake:6 \(add_library\): + add_library Invalid name for IMPORTED INTERFACE library target: + if\$target_imported +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/interface_library/invalid_name.cmake b/Tests/RunCMake/interface_library/invalid_name.cmake new file mode 100644 index 0000000..9a965aa --- /dev/null +++ b/Tests/RunCMake/interface_library/invalid_name.cmake @@ -0,0 +1,6 @@ + +add_library(if$ace INTERFACE) + +add_library(iface::target INTERFACE) + +add_library(if$target_imported INTERFACE IMPORTED) diff --git a/Tests/RunCMake/interface_library/target_commands-result.txt b/Tests/RunCMake/interface_library/target_commands-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/interface_library/target_commands-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/interface_library/target_commands-stderr.txt b/Tests/RunCMake/interface_library/target_commands-stderr.txt new file mode 100644 index 0000000..be11b77 --- /dev/null +++ b/Tests/RunCMake/interface_library/target_commands-stderr.txt @@ -0,0 +1,47 @@ +CMake Error at target_commands.cmake:4 \(target_link_libraries\): + INTERFACE library can only be used with the INTERFACE keyword of + target_link_libraries +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:5 \(target_link_libraries\): + INTERFACE library can only be used with the INTERFACE keyword of + target_link_libraries +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:6 \(target_link_libraries\): + INTERFACE library can only be used with the INTERFACE keyword of + target_link_libraries +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:7 \(target_link_libraries\): + INTERFACE library can only be used with the INTERFACE keyword of + target_link_libraries +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:9 \(target_include_directories\): + target_include_directories may only be set INTERFACE properties on + INTERFACE targets +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:10 \(target_include_directories\): + target_include_directories may only be set INTERFACE properties on + INTERFACE targets +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:12 \(target_compile_definitions\): + target_compile_definitions may only be set INTERFACE properties on + INTERFACE targets +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) ++ +CMake Error at target_commands.cmake:13 \(target_compile_definitions\): + target_compile_definitions may only be set INTERFACE properties on + INTERFACE targets +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/interface_library/target_commands.cmake b/Tests/RunCMake/interface_library/target_commands.cmake new file mode 100644 index 0000000..3182e89 --- /dev/null +++ b/Tests/RunCMake/interface_library/target_commands.cmake @@ -0,0 +1,13 @@ + +add_library(iface INTERFACE) + +target_link_libraries(iface PRIVATE foo) +target_link_libraries(iface PUBLIC foo) +target_link_libraries(iface foo) +target_link_libraries(iface LINK_INTERFACE_LIBRARIES foo) + +target_include_directories(iface PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}") +target_include_directories(iface PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}") + +target_compile_definitions(iface PRIVATE SOME_DEFINE) +target_compile_definitions(iface PUBLIC SOME_DEFINE) diff --git a/Tests/RunCMake/message/CMakeLists.txt b/Tests/RunCMake/message/CMakeLists.txt new file mode 100644 index 0000000..12cd3c7 --- /dev/null +++ b/Tests/RunCMake/message/CMakeLists.txt @@ -0,0 +1,3 @@ +cmake_minimum_required(VERSION 2.8.4) +project(${RunCMake_TEST} NONE) +include(${RunCMake_TEST}.cmake) diff --git a/Tests/RunCMake/message/RunCMakeTest.cmake b/Tests/RunCMake/message/RunCMakeTest.cmake new file mode 100644 index 0000000..d2bc0c3 --- /dev/null +++ b/Tests/RunCMake/message/RunCMakeTest.cmake @@ -0,0 +1,5 @@ +include(RunCMake) + +run_cmake(nomessage) +run_cmake(warnmessage) +run_cmake(errormessage) diff --git a/Tests/RunCMake/message/errormessage-result.txt b/Tests/RunCMake/message/errormessage-result.txt new file mode 100644 index 0000000..d00491f --- /dev/null +++ b/Tests/RunCMake/message/errormessage-result.txt @@ -0,0 +1 @@ +1 diff --git a/Tests/RunCMake/message/errormessage-stderr.txt b/Tests/RunCMake/message/errormessage-stderr.txt new file mode 100644 index 0000000..49e7ca9 --- /dev/null +++ b/Tests/RunCMake/message/errormessage-stderr.txt @@ -0,0 +1,4 @@ +CMake Deprecation Error at errormessage.cmake:4 \(message\): + This is an error +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/message/errormessage.cmake b/Tests/RunCMake/message/errormessage.cmake new file mode 100644 index 0000000..7d3b779 --- /dev/null +++ b/Tests/RunCMake/message/errormessage.cmake @@ -0,0 +1,4 @@ + +set(CMAKE_ERROR_DEPRECATED ON) + +message(DEPRECATION "This is an error") diff --git a/Tests/RunCMake/message/nomessage-result.txt b/Tests/RunCMake/message/nomessage-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/message/nomessage-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/message/nomessage-stderr.txt b/Tests/RunCMake/message/nomessage-stderr.txt new file mode 100644 index 0000000..10f3293 --- /dev/null +++ b/Tests/RunCMake/message/nomessage-stderr.txt @@ -0,0 +1 @@ +^$ diff --git a/Tests/RunCMake/message/nomessage.cmake b/Tests/RunCMake/message/nomessage.cmake new file mode 100644 index 0000000..bcc97be --- /dev/null +++ b/Tests/RunCMake/message/nomessage.cmake @@ -0,0 +1,2 @@ + +message(DEPRECATION "This is not issued") diff --git a/Tests/RunCMake/message/warnmessage-result.txt b/Tests/RunCMake/message/warnmessage-result.txt new file mode 100644 index 0000000..573541a --- /dev/null +++ b/Tests/RunCMake/message/warnmessage-result.txt @@ -0,0 +1 @@ +0 diff --git a/Tests/RunCMake/message/warnmessage-stderr.txt b/Tests/RunCMake/message/warnmessage-stderr.txt new file mode 100644 index 0000000..5c44566 --- /dev/null +++ b/Tests/RunCMake/message/warnmessage-stderr.txt @@ -0,0 +1,4 @@ +CMake Deprecation Warning at warnmessage.cmake:4 \(message\): + This is a warning +Call Stack \(most recent call first\): + CMakeLists.txt:3 \(include\) diff --git a/Tests/RunCMake/message/warnmessage.cmake b/Tests/RunCMake/message/warnmessage.cmake new file mode 100644 index 0000000..4c421a1 --- /dev/null +++ b/Tests/RunCMake/message/warnmessage.cmake @@ -0,0 +1,4 @@ + +set(CMAKE_WARN_DEPRECATED ON) + +message(DEPRECATION "This is a warning") diff --git a/Tests/Unset/CMakeLists.txt b/Tests/Unset/CMakeLists.txt index 781da3f..07aa68e 100644 --- a/Tests/Unset/CMakeLists.txt +++ b/Tests/Unset/CMakeLists.txt @@ -51,5 +51,32 @@ if(DEFINED BAR) message(FATAL_ERROR "BAR still defined") endif() +# Test unset(... PARENT_SCOPE) +function(unset_zots) + if(NOT DEFINED ZOT1) + message(FATAL_ERROR "ZOT1 is not defined inside function") + endif() + if(NOT DEFINED ZOT2) + message(FATAL_ERROR "ZOT2 is not defined inside function") + endif() + unset(ZOT1) + unset(ZOT2 PARENT_SCOPE) + if(DEFINED ZOT1) + message(FATAL_ERROR "ZOT1 is defined inside function after unset") + endif() + if(NOT DEFINED ZOT2) + message(FATAL_ERROR + "ZOT2 is not defined inside function after unset(... PARENT_SCOPE)") + endif() +endfunction() +set(ZOT1 1) +set(ZOT2 2) +unset_zots() +if(NOT DEFINED ZOT1) + message(FATAL_ERROR "ZOT1 is not still defined after function") +endif() +if(DEFINED ZOT2) + message(FATAL_ERROR "ZOT2 is still defined after function unset PARENT_SCOPE") +endif() add_executable(Unset unset.c) diff --git a/Utilities/CMakeLists.txt b/Utilities/CMakeLists.txt index bad8d63..410f37a 100644 --- a/Utilities/CMakeLists.txt +++ b/Utilities/CMakeLists.txt @@ -11,157 +11,4 @@ #============================================================================= subdirs(Doxygen KWStyle) -make_directory(${CMake_BINARY_DIR}/Docs) - -# Add a documentation target. -set(DOC_FILES "") - -set(MAN_FILES - ${CMake_BINARY_DIR}/Docs/cmake.1 - ${CMake_BINARY_DIR}/Docs/cmakecommands.1 - ${CMake_BINARY_DIR}/Docs/cmakecompat.1 - ${CMake_BINARY_DIR}/Docs/cmakeprops.1 - ${CMake_BINARY_DIR}/Docs/cmakepolicies.1 - ${CMake_BINARY_DIR}/Docs/cmakevars.1 - ${CMake_BINARY_DIR}/Docs/cmakemodules.1 - ) -set(TEXT_FILES - ${CMake_BINARY_DIR}/Docs/cmake.txt - ${CMake_BINARY_DIR}/Docs/cmake-policies.txt - ${CMake_BINARY_DIR}/Docs/cmake-properties.txt - ${CMake_BINARY_DIR}/Docs/cmake-variables.txt - ${CMake_BINARY_DIR}/Docs/cmake-modules.txt - ${CMake_BINARY_DIR}/Docs/cmake-commands.txt - ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt - ) -set(HTML_FILES - ${CMake_BINARY_DIR}/Docs/cmake.html - ${CMake_BINARY_DIR}/Docs/cmake-policies.html - ${CMake_BINARY_DIR}/Docs/cmake-properties.html - ${CMake_BINARY_DIR}/Docs/cmake-variables.html - ${CMake_BINARY_DIR}/Docs/cmake-modules.html - ${CMake_BINARY_DIR}/Docs/cmake-commands.html - ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html - ) -set(DOCBOOK_FILES - ${CMake_BINARY_DIR}/Docs/cmake.docbook - ) - -macro(ADD_DOCS target dependency) - # Generate documentation for "ctest" executable. - get_target_property(CMD ${target} LOCATION) - # only generate the documentation if the target is actually built - if(CMD) - add_custom_command( - OUTPUT ${CMake_BINARY_DIR}/Docs/${target}.txt - ${${target}-PATH} # Possibly set PATH, see below. - COMMAND ${CMD} - ARGS --help-full ${CMake_BINARY_DIR}/Docs/${target}.txt - --help-full ${CMake_BINARY_DIR}/Docs/${target}.html - --help-full ${CMake_BINARY_DIR}/Docs/${target}.1 - --help-full ${CMake_BINARY_DIR}/Docs/${target}.docbook - DEPENDS ${target} - MAIN_DEPENDENCY ${dependency} - ) - set(DOC_FILES ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/${target}.txt) - list(APPEND MAN_FILES ${CMake_BINARY_DIR}/Docs/${target}.1) - list(APPEND TEXT_FILES ${CMake_BINARY_DIR}/Docs/${target}.txt) - list(APPEND HTML_FILES ${CMake_BINARY_DIR}/Docs/${target}.html) - list(APPEND DOCBOOK_FILES ${CMake_BINARY_DIR}/Docs/${target}.docbook) - endif() -endmacro() - -# Help cmake-gui find the Qt DLLs on Windows. -if(TARGET cmake-gui) - get_property(Qt_BIN_DIR TARGET cmake-gui PROPERTY Qt_BIN_DIR) - set(WIN_SHELL_GENS "Visual Studio|NMake|MinGW|Watcom|Borland") - if(Qt_BIN_DIR AND "${CMAKE_GENERATOR}" MATCHES "${WIN_SHELL_GENS}" - AND NOT CMAKE_NO_AUTO_QT_ENV) - # Tell the macro to set the path before running cmake-gui. - string(REPLACE ";" "\\;" _PATH "PATH=${Qt_BIN_DIR};%PATH%") - set(cmake-gui-PATH COMMAND set "${_PATH}") - endif() -endif() - -# add the docs for the executables -ADD_DOCS(ctest ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt) -ADD_DOCS(cpack ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt) -ADD_DOCS(ccmake ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt) -ADD_DOCS(CMakeSetup ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in) -ADD_DOCS(cmake-gui ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in) - -# add the documentation for cmake itself - -get_target_property(CMD cmake LOCATION) -add_custom_command( - OUTPUT ${CMake_BINARY_DIR}/Docs/cmake.txt - COMMAND ${CMD} - ARGS --copyright ${CMake_BINARY_DIR}/Docs/Copyright.txt - --help-full ${CMake_BINARY_DIR}/Docs/cmake.txt - --help-full ${CMake_BINARY_DIR}/Docs/cmake.html - --help-full ${CMake_BINARY_DIR}/Docs/cmake.1 - --help-full ${CMake_BINARY_DIR}/Docs/cmake.docbook - --help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.txt - --help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.html - --help-policies ${CMake_BINARY_DIR}/Docs/cmakepolicies.1 - --help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.txt - --help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.html - --help-properties ${CMake_BINARY_DIR}/Docs/cmakeprops.1 - --help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.txt - --help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.html - --help-variables ${CMake_BINARY_DIR}/Docs/cmakevars.1 - --help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.txt - --help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.html - --help-modules ${CMake_BINARY_DIR}/Docs/cmakemodules.1 - --help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.txt - --help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.html - --help-commands ${CMake_BINARY_DIR}/Docs/cmakecommands.1 - --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt - --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html - --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmakecompat.1 - DEPENDS cmake - MAIN_DEPENDENCY ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt - ) - -install(FILES ${MAN_FILES} DESTINATION ${CMAKE_MAN_DIR}/man1) -install(FILES - ${TEXT_FILES} - ${HTML_FILES} - ${DOCBOOK_FILES} - DESTINATION ${CMAKE_DOC_DIR} - ) -install(FILES cmake.m4 DESTINATION share/aclocal) - -# Drive documentation generation. -add_custom_target(documentation ALL DEPENDS ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/cmake.txt ) - -# Documentation testing. -if(BUILD_TESTING) - find_package(LibXml2 QUIET) - if(NOT DEFINED LIBXML2_XMLLINT_EXECUTABLE) - find_program(LIBXML2_XMLLINT_EXECUTABLE xmllint) - endif() - mark_as_advanced(LIBXML2_XMLLINT_EXECUTABLE) - if(LIBXML2_XMLLINT_EXECUTABLE) - execute_process(COMMAND ${LIBXML2_XMLLINT_EXECUTABLE} --help - OUTPUT_VARIABLE _help ERROR_VARIABLE _err) - if("${_help}" MATCHES "--path" AND "${_help}" MATCHES "--nonet") - # We provide DTDs in the 'xml' directory so that xmllint can run without - # network access. Note that xmllints's --path option accepts a - # space-separated list of url-encoded paths. - set(_dtd_dir "${CMAKE_CURRENT_SOURCE_DIR}/xml") - string(REPLACE " " "%20" _dtd_dir "${_dtd_dir}") - string(REPLACE ":" "%3A" _dtd_dir "${_dtd_dir}") - add_test(CMake.HTML - ${LIBXML2_XMLLINT_EXECUTABLE} --valid --noout --nonet - --path ${_dtd_dir}/xhtml1 - ${HTML_FILES} - ) - add_test(CMake.DocBook - ${LIBXML2_XMLLINT_EXECUTABLE} --valid --noout --nonet - --path ${_dtd_dir}/docbook-4.5 - ${DOCBOOK_FILES} - ) - endif() - endif() -endif() +add_subdirectory(Sphinx) diff --git a/Utilities/Sphinx/.gitignore b/Utilities/Sphinx/.gitignore new file mode 100644 index 0000000..0d20b64 --- /dev/null +++ b/Utilities/Sphinx/.gitignore @@ -0,0 +1 @@ +*.pyc diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt new file mode 100644 index 0000000..16d9aac --- /dev/null +++ b/Utilities/Sphinx/CMakeLists.txt @@ -0,0 +1,106 @@ +#============================================================================= +# CMake - Cross Platform Makefile Generator +# Copyright 2000-2013 Kitware, Inc., Insight Software Consortium +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +if(NOT CMake_SOURCE_DIR) + set(CMakeHelp_STANDALONE 1) + cmake_minimum_required(VERSION 2.8.2 FATAL_ERROR) + set(CMAKE_LEGACY_CYGWIN_WIN32 0) # Remove when CMake >= 2.8.4 is required + get_filename_component(tmp "${CMAKE_CURRENT_SOURCE_DIR}" PATH) + get_filename_component(CMake_SOURCE_DIR "${tmp}" PATH) + include(${CMake_SOURCE_DIR}/Source/CMakeVersionCompute.cmake) + include(${CMake_SOURCE_DIR}/Source/CMakeInstallDestinations.cmake) + unset(CMAKE_DATA_DIR) + unset(CMAKE_DATA_DIR CACHE) +endif() +project(CMakeHelp NONE) + +option(SPHINX_MAN "Build man pages with Sphinx" OFF) +option(SPHINX_HTML "Build html help with Sphinx" OFF) +find_program(SPHINX_EXECUTABLE + NAMES sphinx-build + DOC "Sphinx Documentation Builder (sphinx-doc.org)" + ) + +if(NOT SPHINX_MAN AND NOT SPHINX_HTML) + return() +elseif(NOT SPHINX_EXECUTABLE) + message(FATAL_ERROR "SPHINX_EXECUTABLE (sphinx-build) is not found!") +endif() + +set(conf_path "${CMAKE_CURRENT_SOURCE_DIR}") +set(conf_copyright "2000-2013 Kitware, Inc.") +set(conf_version "${CMake_MAJOR_VERSION}.${CMake_MINOR_VERSION}.${CMake_PATCH_VERSION}") +set(conf_release "${CMake_VERSION}") +configure_file(conf.py.in conf.py @ONLY) + +set(doc_formats "") +if(SPHINX_HTML) + list(APPEND doc_formats html) +endif() +if(SPHINX_MAN) + list(APPEND doc_formats man) +endif() + +set(doc_format_outputs "") +set(doc_format_last "") +foreach(format ${doc_formats}) + set(doc_format_output "doc_format_${format}") + set(doc_format_log "build-${format}.log") + add_custom_command( + OUTPUT ${doc_format_output} + COMMAND ${SPHINX_EXECUTABLE} + -c ${CMAKE_CURRENT_BINARY_DIR} + -d ${CMAKE_CURRENT_BINARY_DIR}/doctrees + -b ${format} + ${CMake_SOURCE_DIR}/Help + ${CMAKE_CURRENT_BINARY_DIR}/${format} + > ${doc_format_log} # log stdout, pass stderr + DEPENDS ${doc_format_last} + COMMENT "sphinx-build ${format}: see Utilities/Sphinx/${doc_format_log}" + VERBATIM + ) + set_property(SOURCE ${doc_format_output} PROPERTY SYMBOLIC 1) + list(APPEND doc_format_outputs ${doc_format_output}) + set(doc_format_last ${doc_format_output}) +endforeach() + +add_custom_target(documentation ALL DEPENDS ${doc_format_outputs}) + +foreach(t + cmake + ccmake + cmake-gui + cpack + ctest + ) + if(TARGET ${t}) + # Build documentation after main executables. + add_dependencies(documentation ${t}) + endif() +endforeach() + +if(SPHINX_MAN) + file(GLOB man_rst RELATIVE ${CMake_SOURCE_DIR}/Help/manual + ${CMake_SOURCE_DIR}/Help/manual/*.[1-9].rst) + foreach(m ${man_rst}) + if("x${m}" MATCHES "^x(.+)\\.([1-9])\\.rst$") + set(name "${CMAKE_MATCH_1}") + set(sec "${CMAKE_MATCH_2}") + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/${name}.${sec} + DESTINATION ${CMAKE_MAN_DIR}/man${sec}) + endif() + endforeach() +endif() + +if(SPHINX_HTML) + install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html + DESTINATION ${CMAKE_DOC_DIR}) +endif() diff --git a/Utilities/Sphinx/cmake.py b/Utilities/Sphinx/cmake.py new file mode 100644 index 0000000..75f62df --- /dev/null +++ b/Utilities/Sphinx/cmake.py @@ -0,0 +1,282 @@ +#============================================================================= +# CMake - Cross Platform Makefile Generator +# Copyright 2000-2013 Kitware, Inc., Insight Software Consortium +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +import os +import re + +from docutils.parsers.rst import Directive, directives +from docutils.transforms import Transform +from docutils.utils.error_reporting import SafeString, ErrorString +from docutils import io, nodes + +from sphinx.directives import ObjectDescription +from sphinx.domains import Domain, ObjType +from sphinx.roles import XRefRole +from sphinx.util.nodes import make_refnode +from sphinx import addnodes + +class CMakeModule(Directive): + required_arguments = 1 + optional_arguments = 0 + final_argument_whitespace = True + option_spec = {'encoding': directives.encoding} + + def __init__(self, *args, **keys): + self.re_start = re.compile(r'^#\[(?P<eq>=*)\[\.rst:$') + self.re_end = re.compile(r'^#?\](?P<eq>=*)\]$') + Directive.__init__(self, *args, **keys) + + def run(self): + settings = self.state.document.settings + if not settings.file_insertion_enabled: + raise self.warning('"%s" directive disabled.' % self.name) + + env = self.state.document.settings.env + rel_path, path = env.relfn2path(self.arguments[0]) + path = os.path.normpath(path) + encoding = self.options.get('encoding', settings.input_encoding) + e_handler = settings.input_encoding_error_handler + try: + settings.record_dependencies.add(path) + f = io.FileInput(source_path=path, encoding=encoding, + error_handler=e_handler) + except UnicodeEncodeError, error: + raise self.severe('Problems with "%s" directive path:\n' + 'Cannot encode input file path "%s" ' + '(wrong locale?).' % + (self.name, SafeString(path))) + except IOError, error: + raise self.severe('Problems with "%s" directive path:\n%s.' % + (self.name, ErrorString(error))) + raw_lines = f.read().splitlines() + f.close() + rst = None + lines = [] + for line in raw_lines: + if line == '#.rst:': + rst = '#' + line = '' + elif rst == '#': + if line == '#' or line[:2] == '# ': + line = line[2:] + else: + rst = None + line = '' + else: + line = '' + lines.append(line) + self.state_machine.insert_input(lines, path) + return [] + +class _cmake_index_entry: + def __init__(self, desc): + self.desc = desc + + def __call__(self, title, targetid): + return ('pair', u'%s ; %s' % (self.desc, title), targetid, 'main') + +_cmake_index_objs = { + 'command': _cmake_index_entry('command'), + 'generator': _cmake_index_entry('generator'), + 'manual': _cmake_index_entry('manual'), + 'module': _cmake_index_entry('module'), + 'policy': _cmake_index_entry('policy'), + 'prop_cache': _cmake_index_entry('cache property'), + 'prop_dir': _cmake_index_entry('directory property'), + 'prop_gbl': _cmake_index_entry('global property'), + 'prop_sf': _cmake_index_entry('source file property'), + 'prop_test': _cmake_index_entry('test property'), + 'prop_tgt': _cmake_index_entry('target property'), + 'variable': _cmake_index_entry('variable'), + } + +def _cmake_object_inventory(env, document, line, objtype, targetid): + inv = env.domaindata['cmake']['objects'] + if targetid in inv: + document.reporter.warning( + 'CMake object "%s" also described in "%s".' % + (targetid, env.doc2path(inv[targetid][0])), line=line) + inv[targetid] = (env.docname, objtype) + +class CMakeTransform(Transform): + + # Run this transform early since we insert nodes we want + # treated as if they were written in the documents. + default_priority = 210 + + def __init__(self, document, startnode): + Transform.__init__(self, document, startnode) + self.titles = {} + + def parse_title(self, docname): + """Parse a document title as the first line starting in [A-Za-z0-9<] + or fall back to the document basename if no such line exists. + The cmake --help-*-list commands also depend on this convention. + Return the title or False if the document file does not exist. + """ + env = self.document.settings.env + title = self.titles.get(docname) + if title is None: + fname = os.path.join(env.srcdir, docname+'.rst') + try: + f = open(fname, 'r') + except IOError: + title = False + else: + for line in f: + if len(line) > 0 and (line[0].isalnum() or line[0] == '<'): + title = line.rstrip() + break + f.close() + if title is None: + title = os.path.basename(docname) + self.titles[docname] = title + return title + + def apply(self): + env = self.document.settings.env + + # Treat some documents as cmake domain objects. + objtype, sep, tail = env.docname.rpartition('/') + make_index_entry = _cmake_index_objs.get(objtype) + if make_index_entry: + title = self.parse_title(env.docname) + # Insert the object link target. + targetid = '%s:%s' % (objtype, title) + targetnode = nodes.target('', '', ids=[targetid]) + self.document.insert(0, targetnode) + # Insert the object index entry. + indexnode = addnodes.index() + indexnode['entries'] = [make_index_entry(title, targetid)] + self.document.insert(0, indexnode) + # Add to cmake domain object inventory + _cmake_object_inventory(env, self.document, 1, objtype, targetid) + +class CMakeObject(ObjectDescription): + + def handle_signature(self, sig, signode): + # called from sphinx.directives.ObjectDescription.run() + signode += addnodes.desc_name(sig, sig) + return sig + + def add_target_and_index(self, name, sig, signode): + targetid = '%s:%s' % (self.objtype, name) + if targetid not in self.state.document.ids: + signode['names'].append(targetid) + signode['ids'].append(targetid) + signode['first'] = (not self.names) + self.state.document.note_explicit_target(signode) + _cmake_object_inventory(self.env, self.state.document, + self.lineno, self.objtype, targetid) + + make_index_entry = _cmake_index_objs.get(self.objtype) + if make_index_entry: + self.indexnode['entries'].append(make_index_entry(name, targetid)) + +class CMakeXRefRole(XRefRole): + + # See sphinx.util.nodes.explicit_title_re; \x00 escapes '<'. + _re = re.compile(r'^(.+?)(\s*)(?<!\x00)<(.*?)>$', re.DOTALL) + _re_sub = re.compile(r'^([^()\s]+)\s*\(([^()]*)\)$', re.DOTALL) + + def __call__(self, typ, rawtext, text, *args, **keys): + # Translate CMake command cross-references of the form: + # `command_name(SUB_COMMAND)` + # to have an explicit target: + # `command_name(SUB_COMMAND) <command_name>` + if typ == 'cmake:command': + m = CMakeXRefRole._re_sub.match(text) + if m: + text = '%s <%s>' % (text, m.group(1)) + # CMake cross-reference targets frequently contain '<' so escape + # any explicit `<target>` with '<' not preceded by whitespace. + while True: + m = CMakeXRefRole._re.match(text) + if m and len(m.group(2)) == 0: + text = '%s\x00<%s>' % (m.group(1), m.group(3)) + else: + break + return XRefRole.__call__(self, typ, rawtext, text, *args, **keys) + +class CMakeDomain(Domain): + """CMake domain.""" + name = 'cmake' + label = 'CMake' + object_types = { + 'command': ObjType('command', 'command'), + 'generator': ObjType('generator', 'generator'), + 'variable': ObjType('variable', 'variable'), + 'module': ObjType('module', 'module'), + 'policy': ObjType('policy', 'policy'), + 'prop_cache': ObjType('prop_cache', 'prop_cache'), + 'prop_dir': ObjType('prop_dir', 'prop_dir'), + 'prop_gbl': ObjType('prop_gbl', 'prop_gbl'), + 'prop_sf': ObjType('prop_sf', 'prop_sf'), + 'prop_test': ObjType('prop_test', 'prop_test'), + 'prop_tgt': ObjType('prop_tgt', 'prop_tgt'), + 'manual': ObjType('manual', 'manual'), + } + directives = { + 'command': CMakeObject, + 'variable': CMakeObject, + # Other object types cannot be created except by the CMakeTransform + # 'generator': CMakeObject, + # 'module': CMakeObject, + # 'policy': CMakeObject, + # 'prop_cache': CMakeObject, + # 'prop_dir': CMakeObject, + # 'prop_gbl': CMakeObject, + # 'prop_sf': CMakeObject, + # 'prop_test': CMakeObject, + # 'prop_tgt': CMakeObject, + # 'manual': CMakeObject, + } + roles = { + 'command': CMakeXRefRole(fix_parens = True, lowercase = True), + 'generator': CMakeXRefRole(), + 'variable': CMakeXRefRole(), + 'module': CMakeXRefRole(), + 'policy': CMakeXRefRole(), + 'prop_cache': CMakeXRefRole(), + 'prop_dir': CMakeXRefRole(), + 'prop_gbl': CMakeXRefRole(), + 'prop_sf': CMakeXRefRole(), + 'prop_test': CMakeXRefRole(), + 'prop_tgt': CMakeXRefRole(), + 'manual': CMakeXRefRole(), + } + initial_data = { + 'objects': {}, # fullname -> docname, objtype + } + + def clear_doc(self, docname): + for fullname, (fn, _) in self.data['objects'].items(): + if fn == docname: + del self.data['objects'][fullname] + + def resolve_xref(self, env, fromdocname, builder, + typ, target, node, contnode): + targetid = '%s:%s' % (typ, target) + obj = self.data['objects'].get(targetid) + if obj is None: + # TODO: warn somehow? + return None + return make_refnode(builder, fromdocname, obj[0], targetid, + contnode, target) + + def get_objects(self): + for refname, (docname, type) in self.data['objects'].iteritems(): + yield (refname, refname, type, docname, refname, 1) + +def setup(app): + app.add_directive('cmake-module', CMakeModule) + app.add_transform(CMakeTransform) + app.add_domain(CMakeDomain) diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in new file mode 100644 index 0000000..6c9cd77 --- /dev/null +++ b/Utilities/Sphinx/conf.py.in @@ -0,0 +1,48 @@ +#============================================================================= +# CMake - Cross Platform Makefile Generator +# Copyright 2000-2013 Kitware, Inc., Insight Software Consortium +# +# Distributed under the OSI-approved BSD License (the "License"); +# see accompanying file Copyright.txt for details. +# +# This software is distributed WITHOUT ANY WARRANTY; without even the +# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +# See the License for more information. +#============================================================================= +import sys + +sys.path.insert(0, r'@conf_path@') + +source_suffix = '.rst' +master_doc = 'index' +project = 'CMake' +copyright = '@conf_copyright@' + +version = '@conf_version@' # feature version +release = '@conf_release@' # full version string + +primary_domain = 'cmake' + +exclude_patterns = [] + +extensions = ['cmake'] + +man_pages = [ + ('manual/cmake.1', 'cmake', 'CMake Command-Line Reference', [], 1), + ('manual/ccmake.1', 'ccmake', 'CMake Curses Dialog Command-Line Reference', [], 1), + ('manual/cmake-gui.1', 'cmake-gui', 'CMake GUI Command-Line Reference', [], 1), + ('manual/cpack.1', 'cpack', 'CPack Command-Line Reference', [], 1), + ('manual/ctest.1', 'ctest', 'CTest Command-Line Reference', [], 1), + ('manual/cmake-commands.7', 'cmake-commands', 'CMake Language Command Reference', [], 7), + ('manual/cmake-generators.7', 'cmake-generators', 'CMake Generators Reference', [], 7), + ('manual/cmake-modules.7', 'cmake-modules', 'CMake Modules Reference', [], 7), + ('manual/cmake-policies.7', 'cmake-policies', 'CMake Policies Reference', [], 7), + ('manual/cmake-properties.7', 'cmake-properties', 'CMake Properties Reference', [], 7), + ('manual/cmake-variables.7', 'cmake-variables', 'CMake Variables Reference', [], 7), + ('manual/cmake-generator-expressions.7', 'cmake-generator-expressions', 'CMake Generator Expressions', [], 7), +] +man_show_urls = False + +html_show_sourcelink = True +html_static_path = ['@conf_path@/static'] +html_style = 'cmake.css' diff --git a/Utilities/Sphinx/static/cmake.css b/Utilities/Sphinx/static/cmake.css new file mode 100644 index 0000000..2a326d4 --- /dev/null +++ b/Utilities/Sphinx/static/cmake.css @@ -0,0 +1,8 @@ +/* Import the Sphinx theme style. */ +@import url("default.css"); + +/* Wrap sidebar content even within words so that long + document names do not escape sidebar borders. */ +div.sphinxsidebarwrapper { + word-wrap: break-word; +} diff --git a/Utilities/cmbzip2/compress.c b/Utilities/cmbzip2/compress.c index 7d9b3da..feea233 100644 --- a/Utilities/cmbzip2/compress.c +++ b/Utilities/cmbzip2/compress.c @@ -239,7 +239,7 @@ static void sendMTFValues ( EState* s ) { Int32 v, t, i, j, gs, ge, totc, bt, bc, iter; - Int32 nSelectors, alphaSize, minLen, maxLen, selCtr; + Int32 nSelectors = 0, alphaSize, minLen, maxLen, selCtr; Int32 nGroups, nBytes; /*-- diff --git a/Utilities/cmcurl/CMake/CurlTests.c b/Utilities/cmcurl/CMake/CurlTests.c index d74a4f0..c5ba7c2 100644 --- a/Utilities/cmcurl/CMake/CurlTests.c +++ b/Utilities/cmcurl/CMake/CurlTests.c @@ -38,7 +38,7 @@ main () # define PLATFORM_AIX_V3 #endif -#if defined(PLATFORM_SUNOS4) || defined(PLATFORM_AIX_V3) || (defined(__BEOS__) && !defined(__HAIKU__)) +#if defined(PLATFORM_SUNOS4) || defined(PLATFORM_AIX_V3) || defined(__BEOS__) #error "O_NONBLOCK does not work on this platform" #endif int socket; diff --git a/Utilities/cmcurl/CMakeLists.txt b/Utilities/cmcurl/CMakeLists.txt index 74a713d..abf04d8 100644 --- a/Utilities/cmcurl/CMakeLists.txt +++ b/Utilities/cmcurl/CMakeLists.txt @@ -1,4 +1,7 @@ CMAKE_MINIMUM_REQUIRED(VERSION 2.6.3 FATAL_ERROR) +IF(POLICY CMP0025) + CMAKE_POLICY(SET CMP0025 NEW) +ENDIF() PROJECT(LIBCURL C) # Setup package meta-data diff --git a/Utilities/cmcurl/multi.c b/Utilities/cmcurl/multi.c index b501f29..869d568 100644 --- a/Utilities/cmcurl/multi.c +++ b/Utilities/cmcurl/multi.c @@ -763,7 +763,7 @@ static CURLMcode multi_runsingle(struct Curl_multi *multi, struct Curl_message *msg = NULL; bool connected; bool async; - bool protocol_connect; + bool protocol_connect = 0; bool dophase_done; bool done; CURLMcode result = CURLM_OK; diff --git a/Utilities/cmcurl/parsedate.h b/Utilities/cmcurl/parsedate.h index 0ea2d83..b29fe9b 100644 --- a/Utilities/cmcurl/parsedate.h +++ b/Utilities/cmcurl/parsedate.h @@ -1,5 +1,5 @@ #ifndef __PARSEDATE_H -#define __PARSEDATEL_H +#define __PARSEDATE_H /*************************************************************************** * _ _ ____ _ * Project ___| | | | _ \| | diff --git a/Utilities/cmcurl/select.c b/Utilities/cmcurl/select.c index 51adbcf..82f9dc2 100644 --- a/Utilities/cmcurl/select.c +++ b/Utilities/cmcurl/select.c @@ -39,7 +39,7 @@ #error "We can't compile without select() support!" #endif -#if defined(__BEOS__) && !defined(__HAIKU__) +#if defined(__BEOS__) /* BeOS has FD_SET defined in socket.h */ #include <socket.h> #endif diff --git a/Utilities/cmlibarchive/CMakeLists.txt b/Utilities/cmlibarchive/CMakeLists.txt index 8ef0e89..132bfeb 100644 --- a/Utilities/cmlibarchive/CMakeLists.txt +++ b/Utilities/cmlibarchive/CMakeLists.txt @@ -56,7 +56,7 @@ SET(CMAKE_REQUIRED_FLAGS) # Disable warnings to avoid changing 3rd party code. IF("${CMAKE_C_COMPILER_ID}" MATCHES - "^(GNU|Clang|XL|VisualAge|SunPro|MIPSpro|HP|Intel)$") + "^(GNU|Clang|AppleClang|XL|VisualAge|SunPro|MIPSpro|HP|Intel)$") SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -w") ELSEIF("${CMAKE_C_COMPILER_ID}" MATCHES "^(PathScale)$") SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -woffall") diff --git a/Utilities/cmzlib/zconf.h b/Utilities/cmzlib/zconf.h index 6eb52d1..7a3b6fd 100644 --- a/Utilities/cmzlib/zconf.h +++ b/Utilities/cmzlib/zconf.h @@ -237,7 +237,7 @@ # endif #endif -#if defined (__BEOS__) && !defined (__HAIKU__) +#if defined (__BEOS__) # ifdef ZLIB_DLL # ifdef ZLIB_INTERNAL # define ZEXPORT __declspec(dllexport) diff --git a/Utilities/cmzlib/zutil.h b/Utilities/cmzlib/zutil.h index 74ef1f8..3053cd8 100644 --- a/Utilities/cmzlib/zutil.h +++ b/Utilities/cmzlib/zutil.h @@ -147,12 +147,6 @@ extern const char * const z_errmsg[10]; /* indexed by 2-zlib_error */ # define OS_CODE 0x0f #endif -/* Haiku defines both __HAIKU__ and __BEOS__ (for now) */ -/* many BeOS workarounds are no longer needed in Haiku */ -#if defined(__HAIKU__) && defined(__BEOS__) -#undef __BEOS__ -#endif - #if defined(_BEOS_) || defined(RISCOS) # define fdopen(fd,mode) NULL /* No fdopen() */ #endif diff --git a/Utilities/xml/.gitattributes b/Utilities/xml/.gitattributes deleted file mode 100644 index 562b12e..0000000 --- a/Utilities/xml/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -* -whitespace diff --git a/Utilities/xml/docbook-4.5/ChangeLog b/Utilities/xml/docbook-4.5/ChangeLog deleted file mode 100644 index 06f59ce..0000000 --- a/Utilities/xml/docbook-4.5/ChangeLog +++ /dev/null @@ -1,106 +0,0 @@ -2006-10-03 13:23 nwalsh - - * trunk/docbook/sgml/catalog.xml, trunk/docbook/sgml/docbook.cat, - trunk/docbook/sgml/docbook.dcl, trunk/docbook/sgml/docbook.dtd, - calstblx.dtd, catalog.xml, dbcentx.mod, dbgenent.mod, - dbhierx.mod, dbnotnx.mod, dbpoolx.mod, docbook.cat, - docbookx.dtd, htmltblx.mod: DocBook V4.5 released - -2006-06-02 11:28 nwalsh - - * calstblx.dtd, catalog.xml, dbcentx.mod, dbgenent.mod, - dbhierx.mod, dbnotnx.mod, dbpoolx.mod, docbook.cat, - docbookx.dtd, freshmeat.xsl, htmltblx.mod: Changed copyright - dates and version numbers - -2006-05-30 20:58 nwalsh - - * htmltblx.mod: Supply tag omission markers in SGML; suppress - xml:lang in SGML - -2006-03-07 13:11 nwalsh - - * trunk/docbook/sgml/catalog.xml, trunk/docbook/sgml/docbook.cat, - trunk/docbook/sgml/docbook.dcl, trunk/docbook/sgml/docbook.dtd, - calstblx.dtd, catalog.xml, dbcentx.mod, dbgenent.mod, - dbhierx.mod, dbnotnx.mod, dbpoolx.mod, docbook.cat, - docbookx.dtd, freshmeat.xsl, htmltblx.mod: Change version - numbers to 4.5CR2 - -2006-03-07 13:03 nwalsh - - * dbpoolx.mod: Allow citebiblioid anywhere the other citation - elements are allowed - -2006-02-16 21:12 nwalsh - - * calstblx.dtd, catalog.xml, dbcentx.mod, dbgenent.mod, - dbhierx.mod, dbnotnx.mod, dbpoolx.mod, docbook.cat, - docbookx.dtd, freshmeat.xsl, htmltblx.mod: DocBook V4.5 released - -2005-06-29 10:59 nwalsh - - * trunk/docbook/sgml/docbook.dtd, docbookx.dtd: DocBook V4.5CR1 - Released - -2005-06-29 10:58 nwalsh - - * trunk/docbook/sgml/catalog.xml, trunk/docbook/sgml/docbook.cat, - trunk/docbook/sgml/docbook.dcl, calstblx.dtd, catalog.xml, - dbcentx.mod, dbgenent.mod, dbhierx.mod, dbnotnx.mod, - dbpoolx.mod, docbook.cat, htmltblx.mod: Updated version number - -2005-06-29 10:53 nwalsh - - * freshmeat.xsl: Tweaked freshmeat changes - -2005-06-24 21:09 nwalsh - - * calstblx.dtd, dbhierx.mod, dbpoolx.mod, htmltblx.mod, - soextblx.dtd: Added doc: structured comments - -2005-05-05 11:41 nwalsh - - * trunk/docbook/sgml/docbook.dtd, docbookx.dtd: DocBook V4.5b1 - Released - -2005-05-05 11:40 nwalsh - - * trunk/docbook/sgml/catalog.xml, trunk/docbook/sgml/docbook.cat, - trunk/docbook/sgml/docbook.dcl, calstblx.dtd, catalog.xml, - dbcentx.mod, dbgenent.mod, dbhierx.mod, dbnotnx.mod, - dbpoolx.mod, docbook.cat, htmltblx.mod: Updated version number - -2005-05-05 11:37 nwalsh - - * freshmeat.xsl: Prepare for 4.5b1 - -2005-05-05 10:59 nwalsh - - * dbpoolx.mod: RFE 1055480: Make revnumber optional - -2005-05-05 10:54 nwalsh - - * dbpoolx.mod, htmltblx.mod: Allow common attributes on HTML table - elements - -2005-05-05 10:48 nwalsh - - * dbpoolx.mod: Added termdef - -2005-05-05 10:39 nwalsh - - * dbpoolx.mod: Added mathphrase - -2005-05-05 10:33 nwalsh - - * dbhierx.mod: RFE 1070458: Allow colophon in article - -2005-05-05 10:32 nwalsh - - * dbpoolx.mod: RFE 1070770: Allow procedure in example - -2005-05-05 10:21 nwalsh - - * dbpoolx.mod: Add isrn to list of biblioid class attribute values - diff --git a/Utilities/xml/docbook-4.5/README b/Utilities/xml/docbook-4.5/README deleted file mode 100644 index 6fc60c4..0000000 --- a/Utilities/xml/docbook-4.5/README +++ /dev/null @@ -1,8 +0,0 @@ -README for the DocBook XML DTD - -For more information about DocBook, please see - - http://www.oasis-open.org/docbook/ - -Please send all questions, comments, concerns, and bug reports to the -DocBook mailing list: docbook@lists.oasis-open.org diff --git a/Utilities/xml/docbook-4.5/calstblx.dtd b/Utilities/xml/docbook-4.5/calstblx.dtd deleted file mode 100644 index fac58d7..0000000 --- a/Utilities/xml/docbook-4.5/calstblx.dtd +++ /dev/null @@ -1,215 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook CALS Table Model V4.5 ........................................ --> -<!-- File calstblx.mod .................................................... --> - -<!-- Copyright 1992-2002 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - This DTD is based on the CALS Table Model - PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" - - $Id: calstblx.dtd 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the definitions for the CALS Table Model - converted to XML. It has been modified slightly for use in the - combined HTML/CALS models supported by DocBook V4.5. ---> - -<!-- These definitions are not directly related to the table model, but are - used in the default CALS table model and are usually defined elsewhere - (and prior to the inclusion of this table module) in a CALS DTD. --> - -<!ENTITY % bodyatt ""> -<!ENTITY % secur ""> - -<!-- no if zero(s), - yes if any other digits value --> - -<!ENTITY % yesorno 'CDATA'> -<!ENTITY % titles 'title?'> - -<!-- default for use in entry content --> - -<!ENTITY % paracon '#PCDATA'> - -<!-- -The parameter entities as defined below provide the CALS table model -as published (as part of the Example DTD) in MIL-HDBK-28001. - -These following declarations provide the CALS-compliant default definitions -for these entities. However, these entities can and should be redefined -(by giving the appropriate parameter entity declaration(s) prior to the -reference to this Table Model declaration set entity) to fit the needs -of the current application. ---> - -<!ENTITY % tbl.table.name "(table|chart)"> -<!ENTITY % tbl.table-titles.mdl "%titles;,"> -<!ENTITY % tbl.table-main.mdl "(tgroup+|graphic+)"> -<!ENTITY % tbl.table.mdl "%tbl.table-titles.mdl; %tbl.table-main.mdl;"> -<!ENTITY % tbl.table.att ' - tabstyle CDATA #IMPLIED - tocentry %yesorno; #IMPLIED - shortentry %yesorno; #IMPLIED - orient (port|land) #IMPLIED - pgwide %yesorno; #IMPLIED '> -<!ENTITY % tbl.tgroup.mdl "colspec*,spanspec*,thead?,tfoot?,tbody"> -<!ENTITY % tbl.tgroup.att ' - tgroupstyle CDATA #IMPLIED '> -<!ENTITY % tbl.hdft.mdl "colspec*,row+"> -<!ENTITY % tbl.row.mdl "(entry|entrytbl)+"> -<!ENTITY % tbl.entrytbl.mdl "colspec*,spanspec*,thead?,tbody"> -<!ENTITY % tbl.entry.mdl "(para|warning|caution|note|legend|%paracon;)*"> - -<!ENTITY % tbl.frame.attval "top|bottom|topbot|all|sides|none"> -<!ENTITY % tbl.tbody.mdl "row+"> - -<!-- ===== Element and attribute declarations follow. ===== --> - -<!--doc:A formal table in a document.--> -<!ELEMENT table %ho; (%tbl.table.mdl;)> - -<!ATTLIST table - frame (%tbl.frame.attval;) #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - %tbl.table.att; - %bodyatt; - %secur; -> - -<!--doc:A wrapper for the main content of a table, or part of a table.--> -<!ELEMENT tgroup %ho; (%tbl.tgroup.mdl;) > - -<!ATTLIST tgroup - cols CDATA #REQUIRED - %tbl.tgroup.att; - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED - %secur; -> - -<!--doc:Specifications for a column in a table.--> -<!ELEMENT colspec %ho; EMPTY > - -<!ATTLIST colspec - colnum CDATA #IMPLIED - colname CDATA #IMPLIED - colwidth CDATA #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED -> - -<!--doc:Formatting information for a spanned column in a table.--> -<!ELEMENT spanspec %ho; EMPTY > - -<!ATTLIST spanspec - namest CDATA #REQUIRED - nameend CDATA #REQUIRED - spanname CDATA #REQUIRED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED -> - -<!--doc:A table header consisting of one or more rows.--> -<!ELEMENT thead %ho; (%tbl.hdft.mdl;)> -<!ATTLIST thead - valign (top|middle|bottom) #IMPLIED - %secur; -> - -<!--doc:A table footer consisting of one or more rows.--> -<!ELEMENT tfoot %ho; (%tbl.hdft.mdl;)> -<!ATTLIST tfoot - valign (top|middle|bottom) #IMPLIED - %secur; -> - -<!--doc:A wrapper for the rows of a table or informal table.--> -<!ELEMENT tbody %ho; (%tbl.tbody.mdl;)> - -<!ATTLIST tbody - valign (top|middle|bottom) #IMPLIED - %secur; -> - -<!--doc:A row in a table.--> -<!ELEMENT row %ho; (%tbl.row.mdl;)> - -<!ATTLIST row - rowsep %yesorno; #IMPLIED - valign (top|middle|bottom) #IMPLIED - %secur; -> - -<!--doc:A subtable appearing in place of an Entry in a table.--> -<!ELEMENT entrytbl %ho; (%tbl.entrytbl.mdl;)> - -<!ATTLIST entrytbl - cols CDATA #REQUIRED - %tbl.tgroup.att; - colname CDATA #IMPLIED - spanname CDATA #IMPLIED - namest CDATA #IMPLIED - nameend CDATA #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED - %secur; -> - -<!--doc:A cell in a table.--> -<!ELEMENT entry %ho; (%tbl.entry.mdl;)*> - -<!ATTLIST entry - colname CDATA #IMPLIED - namest CDATA #IMPLIED - nameend CDATA #IMPLIED - spanname CDATA #IMPLIED - morerows CDATA #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED - rotate %yesorno; #IMPLIED - valign (top|middle|bottom) #IMPLIED - %secur; -> - -<!-- End of DocBook CALS Table Model V4.5 ................................. --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/catalog.xml b/Utilities/xml/docbook-4.5/catalog.xml deleted file mode 100644 index f75c1d7..0000000 --- a/Utilities/xml/docbook-4.5/catalog.xml +++ /dev/null @@ -1,124 +0,0 @@ -<?xml version='1.0'?> -<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog" prefer="public"> - -<!-- ...................................................................... --> -<!-- XML Catalog data for DocBook XML V4.5 ................................ --> -<!-- File catalog.xml ..................................................... --> - -<!-- Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/. - --> - -<!-- This is the catalog data file for DocBook V4.5. It is provided as - a convenience in building your own catalog files. You need not use - the filenames listed here, and need not use the filename method of - identifying storage objects at all. See the documentation for - detailed information on the files associated with the DocBook DTD. - See XML Catalogs at http://www.oasis-open.org/committees/entity/ for - detailed information on supplying and using catalog data. - --> - -<!-- ...................................................................... --> -<!-- DocBook driver file .................................................. --> - -<public publicId="-//OASIS//DTD DocBook XML V4.5//EN" - uri="docbookx.dtd"/> - -<system systemId="http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" - uri="docbookx.dtd"/> - -<system systemId="http://docbook.org/xml/4.5/docbookx.dtd" - uri="docbookx.dtd"/> - -<!-- ...................................................................... --> -<!-- DocBook modules ...................................................... --> - -<public publicId="-//OASIS//DTD DocBook CALS Table Model V4.5//EN" - uri="calstblx.dtd"/> - -<public publicId="-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" - uri="htmltblx.mod"/> - -<public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" - uri="soextblx.dtd"/> - -<public publicId="-//OASIS//ELEMENTS DocBook Information Pool V4.5//EN" - uri="dbpoolx.mod"/> - -<public publicId="-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" - uri="dbhierx.mod"/> - -<public publicId="-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" - uri="dbgenent.mod"/> - -<public publicId="-//OASIS//ENTITIES DocBook Notations V4.5//EN" - uri="dbnotnx.mod"/> - -<public publicId="-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" - uri="dbcentx.mod"/> - -<!-- ...................................................................... --> -<!-- ISO entity sets ...................................................... --> - -<public publicId="ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML" - uri="ent/isodia.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" - uri="ent/isonum.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Publishing//EN//XML" - uri="ent/isopub.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES General Technical//EN//XML" - uri="ent/isotech.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" - uri="ent/isolat1.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" - uri="ent/isolat2.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Greek Letters//EN//XML" - uri="ent/isogrk1.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML" - uri="ent/isogrk2.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Greek Symbols//EN//XML" - uri="ent/isogrk3.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML" - uri="ent/isogrk4.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML" - uri="ent/isoamsa.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML" - uri="ent/isoamsb.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML" - uri="ent/isoamsc.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML" - uri="ent/isoamsn.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML" - uri="ent/isoamso.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML" - uri="ent/isoamsr.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML" - uri="ent/isobox.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML" - uri="ent/isocyr1.ent"/> - -<public publicId="ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML" - uri="ent/isocyr2.ent"/> - -<!-- End of catalog data for DocBook XML V4.5 ............................. --> -<!-- ...................................................................... --> - -</catalog> diff --git a/Utilities/xml/docbook-4.5/dbcentx.mod b/Utilities/xml/docbook-4.5/dbcentx.mod deleted file mode 100644 index 60de99f..0000000 --- a/Utilities/xml/docbook-4.5/dbcentx.mod +++ /dev/null @@ -1,384 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook character entities module V4.5 ............................... --> -<!-- File dbcentx.mod ..................................................... --> - -<!-- Copyright 1992-2004 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - $Id: dbcentx.mod 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the entity declarations for the standard ISO - entity sets used by DocBook. - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % dbcent PUBLIC - "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" - "dbcentx.mod"> - %dbcent; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!-- ...................................................................... --> - -<![%sgml.features;[ - -<!ENTITY % ISOamsa.module "INCLUDE"> -<![ %ISOamsa.module; [ -<!ENTITY % ISOamsa PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN"> -<!--end of ISOamsa.module-->]]> - -<!ENTITY % ISOamsb.module "INCLUDE"> -<![ %ISOamsb.module; [ -<!ENTITY % ISOamsb PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN"> -<!--end of ISOamsb.module-->]]> - -<!ENTITY % ISOamsc.module "INCLUDE"> -<![ %ISOamsc.module; [ -<!ENTITY % ISOamsc PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN"> -<!--end of ISOamsc.module-->]]> - -<!ENTITY % ISOamsn.module "INCLUDE"> -<![ %ISOamsn.module; [ -<!ENTITY % ISOamsn PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN"> -<!--end of ISOamsn.module-->]]> - -<!ENTITY % ISOamso.module "INCLUDE"> -<![ %ISOamso.module; [ -<!ENTITY % ISOamso PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN"> -<!--end of ISOamso.module-->]]> - -<!ENTITY % ISOamsr.module "INCLUDE"> -<![ %ISOamsr.module; [ -<!ENTITY % ISOamsr PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN"> -<!--end of ISOamsr.module-->]]> - -<!ENTITY % ISObox.module "INCLUDE"> -<![ %ISObox.module; [ -<!ENTITY % ISObox PUBLIC -"ISO 8879:1986//ENTITIES Box and Line Drawing//EN"> -<!--end of ISObox.module-->]]> - -<!ENTITY % ISOcyr1.module "INCLUDE"> -<![ %ISOcyr1.module; [ -<!ENTITY % ISOcyr1 PUBLIC -"ISO 8879:1986//ENTITIES Russian Cyrillic//EN"> -<!--end of ISOcyr1.module-->]]> - -<!ENTITY % ISOcyr2.module "INCLUDE"> -<![ %ISOcyr2.module; [ -<!ENTITY % ISOcyr2 PUBLIC -"ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN"> -<!--end of ISOcyr2.module-->]]> - -<!ENTITY % ISOdia.module "INCLUDE"> -<![ %ISOdia.module; [ -<!ENTITY % ISOdia PUBLIC -"ISO 8879:1986//ENTITIES Diacritical Marks//EN"> -<!--end of ISOdia.module-->]]> - -<!ENTITY % ISOgrk1.module "INCLUDE"> -<![ %ISOgrk1.module; [ -<!ENTITY % ISOgrk1 PUBLIC -"ISO 8879:1986//ENTITIES Greek Letters//EN"> -<!--end of ISOgrk1.module-->]]> - -<!ENTITY % ISOgrk2.module "INCLUDE"> -<![ %ISOgrk2.module; [ -<!ENTITY % ISOgrk2 PUBLIC -"ISO 8879:1986//ENTITIES Monotoniko Greek//EN"> -<!--end of ISOgrk2.module-->]]> - -<!ENTITY % ISOgrk3.module "INCLUDE"> -<![ %ISOgrk3.module; [ -<!ENTITY % ISOgrk3 PUBLIC -"ISO 8879:1986//ENTITIES Greek Symbols//EN"> -<!--end of ISOgrk3.module-->]]> - -<!ENTITY % ISOgrk4.module "INCLUDE"> -<![ %ISOgrk4.module; [ -<!ENTITY % ISOgrk4 PUBLIC -"ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN"> -<!--end of ISOgrk4.module-->]]> - -<!ENTITY % ISOlat1.module "INCLUDE"> -<![ %ISOlat1.module; [ -<!ENTITY % ISOlat1 PUBLIC -"ISO 8879:1986//ENTITIES Added Latin 1//EN"> -<!--end of ISOlat1.module-->]]> - -<!ENTITY % ISOlat2.module "INCLUDE"> -<![ %ISOlat2.module; [ -<!ENTITY % ISOlat2 PUBLIC -"ISO 8879:1986//ENTITIES Added Latin 2//EN"> -<!--end of ISOlat2.module-->]]> - -<!ENTITY % ISOnum.module "INCLUDE"> -<![ %ISOnum.module; [ -<!ENTITY % ISOnum PUBLIC -"ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN"> -<!--end of ISOnum.module-->]]> - -<!ENTITY % ISOpub.module "INCLUDE"> -<![ %ISOpub.module; [ -<!ENTITY % ISOpub PUBLIC -"ISO 8879:1986//ENTITIES Publishing//EN"> -<!--end of ISOpub.module-->]]> - -<!ENTITY % ISOtech.module "INCLUDE"> -<![ %ISOtech.module; [ -<!ENTITY % ISOtech PUBLIC -"ISO 8879:1986//ENTITIES General Technical//EN"> -<!--end of ISOtech.module-->]]> - -<!--end of sgml.features-->]]> - -<![%xml.features;[ - -<!ENTITY % ISOamsa.module "INCLUDE"> -<![%ISOamsa.module;[ -<!ENTITY % ISOamsa PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML" -"ent/isoamsa.ent"> -<!--end of ISOamsa.module-->]]> - -<!ENTITY % ISOamsb.module "INCLUDE"> -<![%ISOamsb.module;[ -<!ENTITY % ISOamsb PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML" -"ent/isoamsb.ent"> -<!--end of ISOamsb.module-->]]> - -<!ENTITY % ISOamsc.module "INCLUDE"> -<![%ISOamsc.module;[ -<!ENTITY % ISOamsc PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML" -"ent/isoamsc.ent"> -<!--end of ISOamsc.module-->]]> - -<!ENTITY % ISOamsn.module "INCLUDE"> -<![%ISOamsn.module;[ -<!ENTITY % ISOamsn PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML" -"ent/isoamsn.ent"> -<!--end of ISOamsn.module-->]]> - -<!ENTITY % ISOamso.module "INCLUDE"> -<![%ISOamso.module;[ -<!ENTITY % ISOamso PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML" -"ent/isoamso.ent"> -<!--end of ISOamso.module-->]]> - -<!ENTITY % ISOamsr.module "INCLUDE"> -<![%ISOamsr.module;[ -<!ENTITY % ISOamsr PUBLIC -"ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML" -"ent/isoamsr.ent"> -<!--end of ISOamsr.module-->]]> - -<!ENTITY % ISObox.module "INCLUDE"> -<![%ISObox.module;[ -<!ENTITY % ISObox PUBLIC -"ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML" -"ent/isobox.ent"> -<!--end of ISObox.module-->]]> - -<!ENTITY % ISOcyr1.module "INCLUDE"> -<![%ISOcyr1.module;[ -<!ENTITY % ISOcyr1 PUBLIC -"ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML" -"ent/isocyr1.ent"> -<!--end of ISOcyr1.module-->]]> - -<!ENTITY % ISOcyr2.module "INCLUDE"> -<![%ISOcyr2.module;[ -<!ENTITY % ISOcyr2 PUBLIC -"ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML" -"ent/isocyr2.ent"> -<!--end of ISOcyr2.module-->]]> - -<!ENTITY % ISOdia.module "INCLUDE"> -<![%ISOdia.module;[ -<!ENTITY % ISOdia PUBLIC -"ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML" -"ent/isodia.ent"> -<!--end of ISOdia.module-->]]> - -<!ENTITY % ISOgrk1.module "INCLUDE"> -<![%ISOgrk1.module;[ -<!ENTITY % ISOgrk1 PUBLIC -"ISO 8879:1986//ENTITIES Greek Letters//EN//XML" -"ent/isogrk1.ent"> -<!--end of ISOgrk1.module-->]]> - -<!ENTITY % ISOgrk2.module "INCLUDE"> -<![%ISOgrk2.module;[ -<!ENTITY % ISOgrk2 PUBLIC -"ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML" -"ent/isogrk2.ent"> -<!--end of ISOgrk2.module-->]]> - -<!ENTITY % ISOgrk3.module "INCLUDE"> -<![%ISOgrk3.module;[ -<!ENTITY % ISOgrk3 PUBLIC -"ISO 8879:1986//ENTITIES Greek Symbols//EN//XML" -"ent/isogrk3.ent"> -<!--end of ISOgrk3.module-->]]> - -<!ENTITY % ISOgrk4.module "INCLUDE"> -<![%ISOgrk4.module;[ -<!ENTITY % ISOgrk4 PUBLIC -"ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML" -"ent/isogrk4.ent"> -<!--end of ISOgrk4.module-->]]> - -<!ENTITY % ISOlat1.module "INCLUDE"> -<![%ISOlat1.module;[ -<!ENTITY % ISOlat1 PUBLIC -"ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" -"ent/isolat1.ent"> -<!--end of ISOlat1.module-->]]> - -<!ENTITY % ISOlat2.module "INCLUDE"> -<![%ISOlat2.module;[ -<!ENTITY % ISOlat2 PUBLIC -"ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" -"ent/isolat2.ent"> -<!--end of ISOlat2.module-->]]> - -<!ENTITY % ISOnum.module "INCLUDE"> -<![%ISOnum.module;[ -<!ENTITY % ISOnum PUBLIC -"ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" -"ent/isonum.ent"> -<!--end of ISOnum.module-->]]> - -<!ENTITY % ISOpub.module "INCLUDE"> -<![%ISOpub.module;[ -<!ENTITY % ISOpub PUBLIC -"ISO 8879:1986//ENTITIES Publishing//EN//XML" -"ent/isopub.ent"> -<!--end of ISOpub.module-->]]> - -<!ENTITY % ISOtech.module "INCLUDE"> -<![%ISOtech.module;[ -<!ENTITY % ISOtech PUBLIC -"ISO 8879:1986//ENTITIES General Technical//EN//XML" -"ent/isotech.ent"> -<!--end of ISOtech.module-->]]> - -<!--end of xml.features-->]]> - -<![ %ISOamsa.module; [ -%ISOamsa; -]]> - -<![ %ISOamsb.module; [ -%ISOamsb; -]]> - -<![ %ISOamsc.module; [ -%ISOamsc; -]]> - -<![ %ISOamsn.module; [ -%ISOamsn; -]]> - -<![ %ISOamso.module; [ -%ISOamso; -]]> - -<![ %ISOamsr.module; [ -%ISOamsr; -]]> - -<![ %ISObox.module; [ -%ISObox; -]]> - -<![ %ISOcyr1.module; [ -%ISOcyr1; -]]> - -<![ %ISOcyr2.module; [ -%ISOcyr2; -]]> - -<![ %ISOdia.module; [ -%ISOdia; -]]> - -<![ %ISOgrk1.module; [ -%ISOgrk1; -]]> - -<![ %ISOgrk2.module; [ -%ISOgrk2; -]]> - -<![ %ISOgrk3.module; [ -%ISOgrk3; -]]> - -<![ %ISOgrk4.module; [ -%ISOgrk4; -]]> - -<![ %ISOlat1.module; [ -%ISOlat1; -]]> - -<![ %ISOlat2.module; [ -%ISOlat2; -]]> - -<![ %ISOnum.module; [ -%ISOnum; -]]> - -<![ %ISOpub.module; [ -%ISOpub; -]]> - -<![ %ISOtech.module; [ -%ISOtech; -]]> - -<!-- End of DocBook character entity sets module V4.5 ..................... --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/dbgenent.mod b/Utilities/xml/docbook-4.5/dbgenent.mod deleted file mode 100644 index ff5ba90..0000000 --- a/Utilities/xml/docbook-4.5/dbgenent.mod +++ /dev/null @@ -1,41 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook additional general entities V4.5 ............................. --> - -<!-- Copyright 1992-2004 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % dbgenent PUBLIC - "-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" - "dbgenent.mod"> - %dbgenent; ---> - -<!-- File dbgenent.mod .................................................... --> - -<!-- You can edit this file to add the following: - - o General entity declarations of any kind. For example: - - <!ENTITY productname "WinWidget"> (small boilerplate) - <!ENTITY legal-notice SYSTEM "notice.sgm"> (large boilerplate) - - o Notation declarations. For example: - - <!NOTATION chicken-scratch SYSTEM> - - o Declarations for and references to external parameter entities - containing collections of any of the above. For example: - - <!ENTITY % all-titles PUBLIC "-//DocTools//ELEMENTS Book Titles//EN" - "booktitles.ent"> - %all-titles; ---> - -<!-- End of DocBook additional general entities V4.5 ...................... --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/dbhierx.mod b/Utilities/xml/docbook-4.5/dbhierx.mod deleted file mode 100644 index 5f839f5..0000000 --- a/Utilities/xml/docbook-4.5/dbhierx.mod +++ /dev/null @@ -1,2193 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook document hierarchy module V4.5 ............................... --> -<!-- File dbhierx.mod ..................................................... --> - -<!-- Copyright 1992-2004 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - $Id: dbhierx.mod 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the definitions for the overall document - hierarchies of DocBook documents. It covers computer documentation - manuals and manual fragments, as well as reference entries (such as - man pages) and technical journals or anthologies containing - articles. - - This module depends on the DocBook information pool module. All - elements and entities referenced but not defined here are assumed - to be defined in the information pool module. - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % dbhier PUBLIC - "-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" - "dbhierx.mod"> - %dbhier; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!-- ...................................................................... --> -<!-- Entities for module inclusions ....................................... --> - -<!ENTITY % dbhier.redecl.module "IGNORE"> -<!ENTITY % dbhier.redecl2.module "IGNORE"> - -<!-- ...................................................................... --> -<!-- Entities for element classes ......................................... --> - -<!ENTITY % local.appendix.class ""> -<!ENTITY % appendix.class "appendix %local.appendix.class;"> - -<!ENTITY % local.article.class ""> -<!ENTITY % article.class "article %local.article.class;"> - -<!ENTITY % local.book.class ""> -<!ENTITY % book.class "book %local.book.class;"> - -<!ENTITY % local.chapter.class ""> -<!ENTITY % chapter.class "chapter %local.chapter.class;"> - -<!ENTITY % local.index.class ""> -<!ENTITY % index.class "index|setindex %local.index.class;"> - -<!ENTITY % local.refentry.class ""> -<!ENTITY % refentry.class "refentry %local.refentry.class;"> - -<!ENTITY % local.section.class ""> -<!ENTITY % section.class "section %local.section.class;"> - -<!ENTITY % local.nav.class ""> -<!ENTITY % nav.class "toc|lot|index|glossary|bibliography - %local.nav.class;"> - -<!-- Redeclaration placeholder ............................................ --> - -<!-- For redeclaring entities that are declared after this point while - retaining their references to the entities that are declared before - this point --> - -<![%dbhier.redecl.module;[ -<!-- Defining rdbhier here makes some buggy XML parsers happy. --> -<!ENTITY % rdbhier ""> -%rdbhier; -<!--end of dbhier.redecl.module-->]]> - -<!-- ...................................................................... --> -<!-- Entities for element mixtures ........................................ --> - -<!ENTITY % local.divcomponent.mix ""> -<!ENTITY % divcomponent.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |%compound.class; - |%genobj.class; |%descobj.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.divcomponent.mix;"> - -<!ENTITY % local.refcomponent.mix ""> -<!ENTITY % refcomponent.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |%compound.class; - |%genobj.class; |%descobj.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.refcomponent.mix;"> - -<!ENTITY % local.indexdivcomponent.mix ""> -<!ENTITY % indexdivcomponent.mix - "itemizedlist|orderedlist|variablelist|simplelist - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |anchor|remark - |%link.char.class; - |beginpage - %local.indexdivcomponent.mix;"> - -<!ENTITY % local.refname.char.mix ""> -<!ENTITY % refname.char.mix - "#PCDATA - |%tech.char.class; - %local.refname.char.mix;"> - -<!ENTITY % local.partcontent.mix ""> -<!ENTITY % partcontent.mix - "%appendix.class;|%chapter.class;|%nav.class;|%article.class; - |preface|%refentry.class;|reference %local.partcontent.mix;"> - -<!ENTITY % local.refinline.char.mix ""> -<!ENTITY % refinline.char.mix - "#PCDATA - |%xref.char.class; |%gen.char.class; - |%link.char.class; |%tech.char.class; - |%base.char.class; |%docinfo.char.class; - |%other.char.class; - |%ndxterm.class; |beginpage - %local.refinline.char.mix;"> - -<!ENTITY % local.refclass.char.mix ""> -<!ENTITY % refclass.char.mix - "#PCDATA - |application - %local.refclass.char.mix;"> - -<!-- Redeclaration placeholder 2 .......................................... --> - -<!-- For redeclaring entities that are declared after this point while - retaining their references to the entities that are declared before - this point --> - -<![%dbhier.redecl2.module;[ -<!-- Defining rdbhier2 here makes some buggy XML parsers happy. --> -<!ENTITY % rdbhier2 ""> -%rdbhier2; -<!--end of dbhier.redecl2.module-->]]> - -<!-- ...................................................................... --> -<!-- Entities for content models .......................................... --> - -<!ENTITY % div.title.content - "title, subtitle?, titleabbrev?"> - -<!ENTITY % bookcomponent.title.content - "title, subtitle?, titleabbrev?"> - -<!ENTITY % sect.title.content - "title, subtitle?, titleabbrev?"> - -<!ENTITY % refsect.title.content - "title, subtitle?, titleabbrev?"> - -<!ENTITY % bookcomponent.content - "((%divcomponent.mix;)+, - (sect1*|(%refentry.class;)*|simplesect*|(%section.class;)*)) - | (sect1+|(%refentry.class;)+|simplesect+|(%section.class;)+)"> - -<!-- ...................................................................... --> -<!-- Set and SetInfo ...................................................... --> - -<!ENTITY % set.content.module "INCLUDE"> -<![%set.content.module;[ -<!ENTITY % set.module "INCLUDE"> -<![%set.module;[ -<!ENTITY % local.set.attrib ""> -<!ENTITY % set.role.attrib "%role.attrib;"> - -<!ENTITY % set.element "INCLUDE"> -<![%set.element;[ -<!--doc:A collection of books.--> -<!ELEMENT set %ho; ((%div.title.content;)?, setinfo?, toc?, (set|%book.class;)+, - setindex?) - %ubiq.inclusion;> -<!--end of set.element-->]]> - -<!-- FPI: SGML formal public identifier --> - - -<!ENTITY % set.attlist "INCLUDE"> -<![%set.attlist;[ -<!ATTLIST set - fpi CDATA #IMPLIED - %status.attrib; - %common.attrib; - %set.role.attrib; - %local.set.attrib; -> -<!--end of set.attlist-->]]> -<!--end of set.module-->]]> - -<!ENTITY % setinfo.module "INCLUDE"> -<![%setinfo.module;[ -<!ENTITY % local.setinfo.attrib ""> -<!ENTITY % setinfo.role.attrib "%role.attrib;"> - -<!ENTITY % setinfo.element "INCLUDE"> -<![%setinfo.element;[ -<!--doc:Meta-information for a Set.--> -<!ELEMENT setinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of setinfo.element-->]]> - -<!-- Contents: IDs of the ToC, Books, and SetIndex that comprise - the set, in the order of their appearance --> - - -<!ENTITY % setinfo.attlist "INCLUDE"> -<![%setinfo.attlist;[ -<!ATTLIST setinfo - contents IDREFS #IMPLIED - %common.attrib; - %setinfo.role.attrib; - %local.setinfo.attrib; -> -<!--end of setinfo.attlist-->]]> -<!--end of setinfo.module-->]]> -<!--end of set.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Book and BookInfo .................................................... --> - -<!ENTITY % book.content.module "INCLUDE"> -<![%book.content.module;[ -<!ENTITY % book.module "INCLUDE"> -<![%book.module;[ - -<!ENTITY % local.book.attrib ""> -<!ENTITY % book.role.attrib "%role.attrib;"> - -<!ENTITY % book.element "INCLUDE"> -<![%book.element;[ -<!--doc:A book.--> -<!ELEMENT book %ho; ((%div.title.content;)?, bookinfo?, - (dedication | toc | lot - | glossary | bibliography | preface - | %chapter.class; | reference | part - | %article.class; - | %appendix.class; - | %index.class; - | colophon)*) - %ubiq.inclusion;> -<!--end of book.element-->]]> - -<!-- FPI: SGML formal public identifier --> - - -<!ENTITY % book.attlist "INCLUDE"> -<![%book.attlist;[ -<!ATTLIST book fpi CDATA #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %book.role.attrib; - %local.book.attrib; -> -<!--end of book.attlist-->]]> -<!--end of book.module-->]]> - -<!ENTITY % bookinfo.module "INCLUDE"> -<![%bookinfo.module;[ -<!ENTITY % local.bookinfo.attrib ""> -<!ENTITY % bookinfo.role.attrib "%role.attrib;"> - -<!ENTITY % bookinfo.element "INCLUDE"> -<![%bookinfo.element;[ -<!--doc:Meta-information for a Book.--> -<!ELEMENT bookinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of bookinfo.element-->]]> - -<!-- Contents: IDs of the ToC, LoTs, Prefaces, Parts, Chapters, - Appendixes, References, GLossary, Bibliography, and indexes - comprising the Book, in the order of their appearance --> - - -<!ENTITY % bookinfo.attlist "INCLUDE"> -<![%bookinfo.attlist;[ -<!ATTLIST bookinfo - contents IDREFS #IMPLIED - %common.attrib; - %bookinfo.role.attrib; - %local.bookinfo.attrib; -> -<!--end of bookinfo.attlist-->]]> -<!--end of bookinfo.module-->]]> -<!--end of book.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Dedication, ToC, and LoT ............................................. --> - -<!ENTITY % dedication.module "INCLUDE"> -<![%dedication.module;[ -<!ENTITY % local.dedication.attrib ""> -<!ENTITY % dedication.role.attrib "%role.attrib;"> - -<!ENTITY % dedication.element "INCLUDE"> -<![%dedication.element;[ -<!--doc:A wrapper for the dedication section of a book.--> -<!ELEMENT dedication %ho; ((%sect.title.content;)?, (%legalnotice.mix;)+)> -<!--end of dedication.element-->]]> - -<!ENTITY % dedication.attlist "INCLUDE"> -<![%dedication.attlist;[ -<!ATTLIST dedication - %status.attrib; - %common.attrib; - %dedication.role.attrib; - %local.dedication.attrib; -> -<!--end of dedication.attlist-->]]> -<!--end of dedication.module-->]]> - -<!ENTITY % colophon.module "INCLUDE"> -<![ %colophon.module; [ -<!ENTITY % local.colophon.attrib ""> -<!ENTITY % colophon.role.attrib "%role.attrib;"> - -<!ENTITY % colophon.element "INCLUDE"> -<![ %colophon.element; [ -<!--doc:Text at the back of a book describing facts about its production.--> -<!ELEMENT colophon %ho; ((%sect.title.content;)?, (%textobject.mix;)+)> -<!--end of colophon.element-->]]> - -<!ENTITY % colophon.attlist "INCLUDE"> -<![ %colophon.attlist; [ -<!ATTLIST colophon - %status.attrib; - %common.attrib; - %colophon.role.attrib; - %local.colophon.attrib;> -<!--end of colophon.attlist-->]]> -<!--end of colophon.module-->]]> - -<!ENTITY % toc.content.module "INCLUDE"> -<![%toc.content.module;[ -<!ENTITY % toc.module "INCLUDE"> -<![%toc.module;[ -<!ENTITY % local.toc.attrib ""> -<!ENTITY % toc.role.attrib "%role.attrib;"> - -<!ENTITY % toc.element "INCLUDE"> -<![%toc.element;[ -<!--doc:A table of contents.--> -<!ELEMENT toc %ho; (beginpage?, - (%bookcomponent.title.content;)?, - tocfront*, - (tocpart | tocchap)*, tocback*)> -<!--end of toc.element-->]]> - -<!ENTITY % toc.attlist "INCLUDE"> -<![%toc.attlist;[ -<!ATTLIST toc - %pagenum.attrib; - %common.attrib; - %toc.role.attrib; - %local.toc.attrib; -> -<!--end of toc.attlist-->]]> -<!--end of toc.module-->]]> - -<!ENTITY % tocfront.module "INCLUDE"> -<![%tocfront.module;[ -<!ENTITY % local.tocfront.attrib ""> -<!ENTITY % tocfront.role.attrib "%role.attrib;"> - -<!ENTITY % tocfront.element "INCLUDE"> -<![%tocfront.element;[ -<!--doc:An entry in a table of contents for a front matter component.--> -<!ELEMENT tocfront %ho; (%para.char.mix;)*> -<!--end of tocfront.element-->]]> - -<!-- to element that this entry represents --> - - -<!ENTITY % tocfront.attlist "INCLUDE"> -<![%tocfront.attlist;[ -<!ATTLIST tocfront - %label.attrib; - %linkend.attrib; %pagenum.attrib; - %common.attrib; - %tocfront.role.attrib; - %local.tocfront.attrib; -> -<!--end of tocfront.attlist-->]]> -<!--end of tocfront.module-->]]> - -<!ENTITY % tocentry.module "INCLUDE"> -<![%tocentry.module;[ -<!ENTITY % local.tocentry.attrib ""> -<!ENTITY % tocentry.role.attrib "%role.attrib;"> - -<!ENTITY % tocentry.element "INCLUDE"> -<![%tocentry.element;[ -<!--doc:A component title in a table of contents.--> -<!ELEMENT tocentry %ho; (%para.char.mix;)*> -<!--end of tocentry.element-->]]> - -<!-- to element that this entry represents --> - - -<!ENTITY % tocentry.attlist "INCLUDE"> -<![%tocentry.attlist;[ -<!ATTLIST tocentry - %linkend.attrib; %pagenum.attrib; - %common.attrib; - %tocentry.role.attrib; - %local.tocentry.attrib; -> -<!--end of tocentry.attlist-->]]> -<!--end of tocentry.module-->]]> - -<!ENTITY % tocpart.module "INCLUDE"> -<![%tocpart.module;[ -<!ENTITY % local.tocpart.attrib ""> -<!ENTITY % tocpart.role.attrib "%role.attrib;"> - -<!ENTITY % tocpart.element "INCLUDE"> -<![%tocpart.element;[ -<!--doc:An entry in a table of contents for a part of a book.--> -<!ELEMENT tocpart %ho; (tocentry+, tocchap*)> -<!--end of tocpart.element-->]]> - -<!ENTITY % tocpart.attlist "INCLUDE"> -<![%tocpart.attlist;[ -<!ATTLIST tocpart - %common.attrib; - %tocpart.role.attrib; - %local.tocpart.attrib; -> -<!--end of tocpart.attlist-->]]> -<!--end of tocpart.module-->]]> - -<!ENTITY % tocchap.module "INCLUDE"> -<![%tocchap.module;[ -<!ENTITY % local.tocchap.attrib ""> -<!ENTITY % tocchap.role.attrib "%role.attrib;"> - -<!ENTITY % tocchap.element "INCLUDE"> -<![%tocchap.element;[ -<!--doc:An entry in a table of contents for a component in the body of a document.--> -<!ELEMENT tocchap %ho; (tocentry+, toclevel1*)> -<!--end of tocchap.element-->]]> - -<!ENTITY % tocchap.attlist "INCLUDE"> -<![%tocchap.attlist;[ -<!ATTLIST tocchap - %label.attrib; - %common.attrib; - %tocchap.role.attrib; - %local.tocchap.attrib; -> -<!--end of tocchap.attlist-->]]> -<!--end of tocchap.module-->]]> - -<!ENTITY % toclevel1.module "INCLUDE"> -<![%toclevel1.module;[ -<!ENTITY % local.toclevel1.attrib ""> -<!ENTITY % toclevel1.role.attrib "%role.attrib;"> - -<!ENTITY % toclevel1.element "INCLUDE"> -<![%toclevel1.element;[ -<!--doc:A top-level entry within a table of contents entry for a chapter-like component.--> -<!ELEMENT toclevel1 %ho; (tocentry+, toclevel2*)> -<!--end of toclevel1.element-->]]> - -<!ENTITY % toclevel1.attlist "INCLUDE"> -<![%toclevel1.attlist;[ -<!ATTLIST toclevel1 - %common.attrib; - %toclevel1.role.attrib; - %local.toclevel1.attrib; -> -<!--end of toclevel1.attlist-->]]> -<!--end of toclevel1.module-->]]> - -<!ENTITY % toclevel2.module "INCLUDE"> -<![%toclevel2.module;[ -<!ENTITY % local.toclevel2.attrib ""> -<!ENTITY % toclevel2.role.attrib "%role.attrib;"> - -<!ENTITY % toclevel2.element "INCLUDE"> -<![%toclevel2.element;[ -<!--doc:A second-level entry within a table of contents entry for a chapter-like component.--> -<!ELEMENT toclevel2 %ho; (tocentry+, toclevel3*)> -<!--end of toclevel2.element-->]]> - -<!ENTITY % toclevel2.attlist "INCLUDE"> -<![%toclevel2.attlist;[ -<!ATTLIST toclevel2 - %common.attrib; - %toclevel2.role.attrib; - %local.toclevel2.attrib; -> -<!--end of toclevel2.attlist-->]]> -<!--end of toclevel2.module-->]]> - -<!ENTITY % toclevel3.module "INCLUDE"> -<![%toclevel3.module;[ -<!ENTITY % local.toclevel3.attrib ""> -<!ENTITY % toclevel3.role.attrib "%role.attrib;"> - -<!ENTITY % toclevel3.element "INCLUDE"> -<![%toclevel3.element;[ -<!--doc:A third-level entry within a table of contents entry for a chapter-like component.--> -<!ELEMENT toclevel3 %ho; (tocentry+, toclevel4*)> -<!--end of toclevel3.element-->]]> - -<!ENTITY % toclevel3.attlist "INCLUDE"> -<![%toclevel3.attlist;[ -<!ATTLIST toclevel3 - %common.attrib; - %toclevel3.role.attrib; - %local.toclevel3.attrib; -> -<!--end of toclevel3.attlist-->]]> -<!--end of toclevel3.module-->]]> - -<!ENTITY % toclevel4.module "INCLUDE"> -<![%toclevel4.module;[ -<!ENTITY % local.toclevel4.attrib ""> -<!ENTITY % toclevel4.role.attrib "%role.attrib;"> - -<!ENTITY % toclevel4.element "INCLUDE"> -<![%toclevel4.element;[ -<!--doc:A fourth-level entry within a table of contents entry for a chapter-like component.--> -<!ELEMENT toclevel4 %ho; (tocentry+, toclevel5*)> -<!--end of toclevel4.element-->]]> - -<!ENTITY % toclevel4.attlist "INCLUDE"> -<![%toclevel4.attlist;[ -<!ATTLIST toclevel4 - %common.attrib; - %toclevel4.role.attrib; - %local.toclevel4.attrib; -> -<!--end of toclevel4.attlist-->]]> -<!--end of toclevel4.module-->]]> - -<!ENTITY % toclevel5.module "INCLUDE"> -<![%toclevel5.module;[ -<!ENTITY % local.toclevel5.attrib ""> -<!ENTITY % toclevel5.role.attrib "%role.attrib;"> - -<!ENTITY % toclevel5.element "INCLUDE"> -<![%toclevel5.element;[ -<!--doc:A fifth-level entry within a table of contents entry for a chapter-like component.--> -<!ELEMENT toclevel5 %ho; (tocentry+)> -<!--end of toclevel5.element-->]]> - -<!ENTITY % toclevel5.attlist "INCLUDE"> -<![%toclevel5.attlist;[ -<!ATTLIST toclevel5 - %common.attrib; - %toclevel5.role.attrib; - %local.toclevel5.attrib; -> -<!--end of toclevel5.attlist-->]]> -<!--end of toclevel5.module-->]]> - -<!ENTITY % tocback.module "INCLUDE"> -<![%tocback.module;[ -<!ENTITY % local.tocback.attrib ""> -<!ENTITY % tocback.role.attrib "%role.attrib;"> - -<!ENTITY % tocback.element "INCLUDE"> -<![%tocback.element;[ -<!--doc:An entry in a table of contents for a back matter component.--> -<!ELEMENT tocback %ho; (%para.char.mix;)*> -<!--end of tocback.element-->]]> - -<!-- to element that this entry represents --> - - -<!ENTITY % tocback.attlist "INCLUDE"> -<![%tocback.attlist;[ -<!ATTLIST tocback - %label.attrib; - %linkend.attrib; %pagenum.attrib; - %common.attrib; - %tocback.role.attrib; - %local.tocback.attrib; -> -<!--end of tocback.attlist-->]]> -<!--end of tocback.module-->]]> -<!--end of toc.content.module-->]]> - -<!ENTITY % lot.content.module "INCLUDE"> -<![%lot.content.module;[ -<!ENTITY % lot.module "INCLUDE"> -<![%lot.module;[ -<!ENTITY % local.lot.attrib ""> -<!ENTITY % lot.role.attrib "%role.attrib;"> - -<!ENTITY % lot.element "INCLUDE"> -<![%lot.element;[ -<!--doc:A list of the titles of formal objects (as tables or figures) in a document.--> -<!ELEMENT lot %ho; (beginpage?, (%bookcomponent.title.content;)?, lotentry*)> -<!--end of lot.element-->]]> - -<!ENTITY % lot.attlist "INCLUDE"> -<![%lot.attlist;[ -<!ATTLIST lot - %label.attrib; - %common.attrib; - %lot.role.attrib; - %local.lot.attrib; -> -<!--end of lot.attlist-->]]> -<!--end of lot.module-->]]> - -<!ENTITY % lotentry.module "INCLUDE"> -<![%lotentry.module;[ -<!ENTITY % local.lotentry.attrib ""> -<!ENTITY % lotentry.role.attrib "%role.attrib;"> - -<!ENTITY % lotentry.element "INCLUDE"> -<![%lotentry.element;[ -<!--doc:An entry in a list of titles.--> -<!ELEMENT lotentry %ho; (%para.char.mix;)*> -<!--end of lotentry.element-->]]> - -<!-- SrcCredit: Information about the source of the entry, - as for a list of illustrations --> -<!-- linkend: to element that this entry represents--> -<!ENTITY % lotentry.attlist "INCLUDE"> -<![%lotentry.attlist;[ -<!ATTLIST lotentry - %linkend.attrib; - %pagenum.attrib; - srccredit CDATA #IMPLIED - %common.attrib; - %lotentry.role.attrib; - %local.lotentry.attrib; -> -<!--end of lotentry.attlist-->]]> -<!--end of lotentry.module-->]]> -<!--end of lot.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Appendix, Chapter, Part, Preface, Reference, PartIntro ............... --> - -<!ENTITY % appendix.module "INCLUDE"> -<![%appendix.module;[ -<!ENTITY % local.appendix.attrib ""> -<!ENTITY % appendix.role.attrib "%role.attrib;"> - -<!ENTITY % appendix.element "INCLUDE"> -<![%appendix.element;[ -<!--doc:An appendix in a Book or Article.--> -<!ELEMENT appendix %ho; (beginpage?, - appendixinfo?, - (%bookcomponent.title.content;), - (%nav.class;)*, - tocchap?, - (%bookcomponent.content;), - (%nav.class;)*) - %ubiq.inclusion;> -<!--end of appendix.element-->]]> - -<!ENTITY % appendix.attlist "INCLUDE"> -<![%appendix.attlist;[ -<!ATTLIST appendix - %label.attrib; - %status.attrib; - %common.attrib; - %appendix.role.attrib; - %local.appendix.attrib; -> -<!--end of appendix.attlist-->]]> -<!--end of appendix.module-->]]> - -<!ENTITY % chapter.module "INCLUDE"> -<![%chapter.module;[ -<!ENTITY % local.chapter.attrib ""> -<!ENTITY % chapter.role.attrib "%role.attrib;"> - -<!ENTITY % chapter.element "INCLUDE"> -<![%chapter.element;[ -<!--doc:A chapter, as of a book.--> -<!ELEMENT chapter %ho; (beginpage?, - chapterinfo?, - (%bookcomponent.title.content;), - (%nav.class;)*, - tocchap?, - (%bookcomponent.content;), - (%nav.class;)*) - %ubiq.inclusion;> -<!--end of chapter.element-->]]> - -<!ENTITY % chapter.attlist "INCLUDE"> -<![%chapter.attlist;[ -<!ATTLIST chapter - %label.attrib; - %status.attrib; - %common.attrib; - %chapter.role.attrib; - %local.chapter.attrib; -> -<!--end of chapter.attlist-->]]> -<!--end of chapter.module-->]]> - -<!ENTITY % part.module "INCLUDE"> -<![%part.module;[ - -<!-- Note that Part was to have its content model reduced in V4.5. This -change will not be made after all. --> - -<!ENTITY % local.part.attrib ""> -<!ENTITY % part.role.attrib "%role.attrib;"> - -<!ENTITY % part.element "INCLUDE"> -<![%part.element;[ -<!--doc:A division in a book.--> -<!ELEMENT part %ho; (beginpage?, - partinfo?, (%bookcomponent.title.content;), partintro?, - (%partcontent.mix;)+) - %ubiq.inclusion;> -<!--end of part.element-->]]> - -<!ENTITY % part.attlist "INCLUDE"> -<![%part.attlist;[ -<!ATTLIST part - %label.attrib; - %status.attrib; - %common.attrib; - %part.role.attrib; - %local.part.attrib; -> -<!--end of part.attlist-->]]> -<!--ELEMENT PartIntro (defined below)--> -<!--end of part.module-->]]> - -<!ENTITY % preface.module "INCLUDE"> -<![%preface.module;[ -<!ENTITY % local.preface.attrib ""> -<!ENTITY % preface.role.attrib "%role.attrib;"> - -<!ENTITY % preface.element "INCLUDE"> -<![%preface.element;[ -<!--doc:Introductory matter preceding the first chapter of a book.--> -<!ELEMENT preface %ho; (beginpage?, - prefaceinfo?, - (%bookcomponent.title.content;), - (%nav.class;)*, - tocchap?, - (%bookcomponent.content;), - (%nav.class;)*) - %ubiq.inclusion;> -<!--end of preface.element-->]]> - -<!ENTITY % preface.attlist "INCLUDE"> -<![%preface.attlist;[ -<!ATTLIST preface - %status.attrib; - %common.attrib; - %preface.role.attrib; - %local.preface.attrib; -> -<!--end of preface.attlist-->]]> -<!--end of preface.module-->]]> - -<!ENTITY % reference.module "INCLUDE"> -<![%reference.module;[ -<!ENTITY % local.reference.attrib ""> -<!ENTITY % reference.role.attrib "%role.attrib;"> - -<!ENTITY % reference.element "INCLUDE"> -<![%reference.element;[ -<!--doc:A collection of reference entries.--> -<!ELEMENT reference %ho; (beginpage?, - referenceinfo?, - (%bookcomponent.title.content;), partintro?, - (%refentry.class;)+) - %ubiq.inclusion;> -<!--end of reference.element-->]]> - -<!ENTITY % reference.attlist "INCLUDE"> -<![%reference.attlist;[ -<!ATTLIST reference - %label.attrib; - %status.attrib; - %common.attrib; - %reference.role.attrib; - %local.reference.attrib; -> -<!--end of reference.attlist-->]]> -<!--ELEMENT PartIntro (defined below)--> -<!--end of reference.module-->]]> - -<!ENTITY % partintro.module "INCLUDE"> -<![%partintro.module;[ -<!ENTITY % local.partintro.attrib ""> -<!ENTITY % partintro.role.attrib "%role.attrib;"> - -<!ENTITY % partintro.element "INCLUDE"> -<![%partintro.element;[ -<!--doc:An introduction to the contents of a part.--> -<!ELEMENT partintro %ho; ((%div.title.content;)?, (%bookcomponent.content;)) - %ubiq.inclusion;> -<!--end of partintro.element-->]]> - -<!ENTITY % partintro.attlist "INCLUDE"> -<![%partintro.attlist;[ -<!ATTLIST partintro - %label.attrib; - %common.attrib; - %partintro.role.attrib; - %local.partintro.attrib; -> -<!--end of partintro.attlist-->]]> -<!--end of partintro.module-->]]> - -<!-- ...................................................................... --> -<!-- Other Info elements .................................................. --> - -<!ENTITY % appendixinfo.module "INCLUDE"> -<![ %appendixinfo.module; [ -<!ENTITY % local.appendixinfo.attrib ""> -<!ENTITY % appendixinfo.role.attrib "%role.attrib;"> - -<!ENTITY % appendixinfo.element "INCLUDE"> -<![ %appendixinfo.element; [ -<!--doc:Meta-information for an Appendix.--> -<!ELEMENT appendixinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of appendixinfo.element-->]]> - -<!ENTITY % appendixinfo.attlist "INCLUDE"> -<![ %appendixinfo.attlist; [ -<!ATTLIST appendixinfo - %common.attrib; - %appendixinfo.role.attrib; - %local.appendixinfo.attrib; -> -<!--end of appendixinfo.attlist-->]]> -<!--end of appendixinfo.module-->]]> - -<!ENTITY % bibliographyinfo.module "INCLUDE"> -<![ %bibliographyinfo.module; [ -<!ENTITY % local.bibliographyinfo.attrib ""> -<!ENTITY % bibliographyinfo.role.attrib "%role.attrib;"> - -<!ENTITY % bibliographyinfo.element "INCLUDE"> -<![ %bibliographyinfo.element; [ -<!--doc:Meta-information for a Bibliography.--> -<!ELEMENT bibliographyinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of bibliographyinfo.element-->]]> - -<!ENTITY % bibliographyinfo.attlist "INCLUDE"> -<![ %bibliographyinfo.attlist; [ -<!ATTLIST bibliographyinfo - %common.attrib; - %bibliographyinfo.role.attrib; - %local.bibliographyinfo.attrib; -> -<!--end of bibliographyinfo.attlist-->]]> -<!--end of bibliographyinfo.module-->]]> - -<!ENTITY % chapterinfo.module "INCLUDE"> -<![ %chapterinfo.module; [ -<!ENTITY % local.chapterinfo.attrib ""> -<!ENTITY % chapterinfo.role.attrib "%role.attrib;"> - -<!ENTITY % chapterinfo.element "INCLUDE"> -<![ %chapterinfo.element; [ -<!--doc:Meta-information for a Chapter.--> -<!ELEMENT chapterinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of chapterinfo.element-->]]> - -<!ENTITY % chapterinfo.attlist "INCLUDE"> -<![ %chapterinfo.attlist; [ -<!ATTLIST chapterinfo - %common.attrib; - %chapterinfo.role.attrib; - %local.chapterinfo.attrib; -> -<!--end of chapterinfo.attlist-->]]> -<!--end of chapterinfo.module-->]]> - -<!ENTITY % glossaryinfo.module "INCLUDE"> -<![ %glossaryinfo.module; [ -<!ENTITY % local.glossaryinfo.attrib ""> -<!ENTITY % glossaryinfo.role.attrib "%role.attrib;"> - -<!ENTITY % glossaryinfo.element "INCLUDE"> -<![ %glossaryinfo.element; [ -<!--doc:Meta-information for a Glossary.--> -<!ELEMENT glossaryinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of glossaryinfo.element-->]]> - -<!ENTITY % glossaryinfo.attlist "INCLUDE"> -<![ %glossaryinfo.attlist; [ -<!ATTLIST glossaryinfo - %common.attrib; - %glossaryinfo.role.attrib; - %local.glossaryinfo.attrib; -> -<!--end of glossaryinfo.attlist-->]]> -<!--end of glossaryinfo.module-->]]> - -<!ENTITY % indexinfo.module "INCLUDE"> -<![ %indexinfo.module; [ -<!ENTITY % local.indexinfo.attrib ""> -<!ENTITY % indexinfo.role.attrib "%role.attrib;"> - -<!ENTITY % indexinfo.element "INCLUDE"> -<![ %indexinfo.element; [ -<!--doc:Meta-information for an Index.--> -<!ELEMENT indexinfo %ho; ((%info.class;)+)> -<!--end of indexinfo.element-->]]> - -<!ENTITY % indexinfo.attlist "INCLUDE"> -<![ %indexinfo.attlist; [ -<!ATTLIST indexinfo - %common.attrib; - %indexinfo.role.attrib; - %local.indexinfo.attrib; -> -<!--end of indexinfo.attlist-->]]> -<!--end of indexinfo.module-->]]> - -<!ENTITY % setindexinfo.module "INCLUDE"> -<![ %setindexinfo.module; [ -<!ENTITY % local.setindexinfo.attrib ""> -<!ENTITY % setindexinfo.role.attrib "%role.attrib;"> - -<!ENTITY % setindexinfo.element "INCLUDE"> -<![ %setindexinfo.element; [ -<!--doc:Meta-information for a SetIndex.--> -<!ELEMENT setindexinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of setindexinfo.element-->]]> - -<!ENTITY % setindexinfo.attlist "INCLUDE"> -<![ %setindexinfo.attlist; [ -<!ATTLIST setindexinfo - %common.attrib; - %setindexinfo.role.attrib; - %local.setindexinfo.attrib; -> -<!--end of setindexinfo.attlist-->]]> -<!--end of setindexinfo.module-->]]> - -<!ENTITY % partinfo.module "INCLUDE"> -<![ %partinfo.module; [ -<!ENTITY % local.partinfo.attrib ""> -<!ENTITY % partinfo.role.attrib "%role.attrib;"> - -<!ENTITY % partinfo.element "INCLUDE"> -<![ %partinfo.element; [ -<!--doc:Meta-information for a Part.--> -<!ELEMENT partinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of partinfo.element-->]]> - -<!ENTITY % partinfo.attlist "INCLUDE"> -<![ %partinfo.attlist; [ -<!ATTLIST partinfo - %common.attrib; - %partinfo.role.attrib; - %local.partinfo.attrib; -> -<!--end of partinfo.attlist-->]]> -<!--end of partinfo.module-->]]> - -<!ENTITY % prefaceinfo.module "INCLUDE"> -<![ %prefaceinfo.module; [ -<!ENTITY % local.prefaceinfo.attrib ""> -<!ENTITY % prefaceinfo.role.attrib "%role.attrib;"> - -<!ENTITY % prefaceinfo.element "INCLUDE"> -<![ %prefaceinfo.element; [ -<!--doc:Meta-information for a Preface.--> -<!ELEMENT prefaceinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of prefaceinfo.element-->]]> - -<!ENTITY % prefaceinfo.attlist "INCLUDE"> -<![ %prefaceinfo.attlist; [ -<!ATTLIST prefaceinfo - %common.attrib; - %prefaceinfo.role.attrib; - %local.prefaceinfo.attrib; -> -<!--end of prefaceinfo.attlist-->]]> -<!--end of prefaceinfo.module-->]]> - -<!ENTITY % refentryinfo.module "INCLUDE"> -<![ %refentryinfo.module; [ -<!ENTITY % local.refentryinfo.attrib ""> -<!ENTITY % refentryinfo.role.attrib "%role.attrib;"> - -<!ENTITY % refentryinfo.element "INCLUDE"> -<![ %refentryinfo.element; [ -<!--doc:Meta-information for a Refentry.--> -<!ELEMENT refentryinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refentryinfo.element-->]]> - -<!ENTITY % refentryinfo.attlist "INCLUDE"> -<![ %refentryinfo.attlist; [ -<!ATTLIST refentryinfo - %common.attrib; - %refentryinfo.role.attrib; - %local.refentryinfo.attrib; -> -<!--end of refentryinfo.attlist-->]]> -<!--end of refentryinfo.module-->]]> - -<!ENTITY % refsectioninfo.module "INCLUDE"> -<![ %refsectioninfo.module; [ -<!ENTITY % local.refsectioninfo.attrib ""> -<!ENTITY % refsectioninfo.role.attrib "%role.attrib;"> - -<!ENTITY % refsectioninfo.element "INCLUDE"> -<![ %refsectioninfo.element; [ -<!--doc:Meta-information for a refsection.--> -<!ELEMENT refsectioninfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refsectioninfo.element-->]]> - -<!ENTITY % refsectioninfo.attlist "INCLUDE"> -<![ %refsectioninfo.attlist; [ -<!ATTLIST refsectioninfo - %common.attrib; - %refsectioninfo.role.attrib; - %local.refsectioninfo.attrib; -> -<!--end of refsectioninfo.attlist-->]]> -<!--end of refsectioninfo.module-->]]> - -<!ENTITY % refsect1info.module "INCLUDE"> -<![ %refsect1info.module; [ -<!ENTITY % local.refsect1info.attrib ""> -<!ENTITY % refsect1info.role.attrib "%role.attrib;"> - -<!ENTITY % refsect1info.element "INCLUDE"> -<![ %refsect1info.element; [ -<!--doc:Meta-information for a RefSect1.--> -<!ELEMENT refsect1info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refsect1info.element-->]]> - -<!ENTITY % refsect1info.attlist "INCLUDE"> -<![ %refsect1info.attlist; [ -<!ATTLIST refsect1info - %common.attrib; - %refsect1info.role.attrib; - %local.refsect1info.attrib; -> -<!--end of refsect1info.attlist-->]]> -<!--end of refsect1info.module-->]]> - -<!ENTITY % refsect2info.module "INCLUDE"> -<![ %refsect2info.module; [ -<!ENTITY % local.refsect2info.attrib ""> -<!ENTITY % refsect2info.role.attrib "%role.attrib;"> - -<!ENTITY % refsect2info.element "INCLUDE"> -<![ %refsect2info.element; [ -<!--doc:Meta-information for a RefSect2.--> -<!ELEMENT refsect2info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refsect2info.element-->]]> - -<!ENTITY % refsect2info.attlist "INCLUDE"> -<![ %refsect2info.attlist; [ -<!ATTLIST refsect2info - %common.attrib; - %refsect2info.role.attrib; - %local.refsect2info.attrib; -> -<!--end of refsect2info.attlist-->]]> -<!--end of refsect2info.module-->]]> - -<!ENTITY % refsect3info.module "INCLUDE"> -<![ %refsect3info.module; [ -<!ENTITY % local.refsect3info.attrib ""> -<!ENTITY % refsect3info.role.attrib "%role.attrib;"> - -<!ENTITY % refsect3info.element "INCLUDE"> -<![ %refsect3info.element; [ -<!--doc:Meta-information for a RefSect3.--> -<!ELEMENT refsect3info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refsect3info.element-->]]> - -<!ENTITY % refsect3info.attlist "INCLUDE"> -<![ %refsect3info.attlist; [ -<!ATTLIST refsect3info - %common.attrib; - %refsect3info.role.attrib; - %local.refsect3info.attrib; -> -<!--end of refsect3info.attlist-->]]> -<!--end of refsect3info.module-->]]> - -<!ENTITY % refsynopsisdivinfo.module "INCLUDE"> -<![ %refsynopsisdivinfo.module; [ -<!ENTITY % local.refsynopsisdivinfo.attrib ""> -<!ENTITY % refsynopsisdivinfo.role.attrib "%role.attrib;"> - -<!ENTITY % refsynopsisdivinfo.element "INCLUDE"> -<![ %refsynopsisdivinfo.element; [ -<!--doc:Meta-information for a RefSynopsisDiv.--> -<!ELEMENT refsynopsisdivinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of refsynopsisdivinfo.element-->]]> - -<!ENTITY % refsynopsisdivinfo.attlist "INCLUDE"> -<![ %refsynopsisdivinfo.attlist; [ -<!ATTLIST refsynopsisdivinfo - %common.attrib; - %refsynopsisdivinfo.role.attrib; - %local.refsynopsisdivinfo.attrib; -> -<!--end of refsynopsisdivinfo.attlist-->]]> -<!--end of refsynopsisdivinfo.module-->]]> - -<!ENTITY % referenceinfo.module "INCLUDE"> -<![ %referenceinfo.module; [ -<!ENTITY % local.referenceinfo.attrib ""> -<!ENTITY % referenceinfo.role.attrib "%role.attrib;"> - -<!ENTITY % referenceinfo.element "INCLUDE"> -<![ %referenceinfo.element; [ -<!--doc:Meta-information for a Reference.--> -<!ELEMENT referenceinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of referenceinfo.element-->]]> - -<!ENTITY % referenceinfo.attlist "INCLUDE"> -<![ %referenceinfo.attlist; [ -<!ATTLIST referenceinfo - %common.attrib; - %referenceinfo.role.attrib; - %local.referenceinfo.attrib; -> -<!--end of referenceinfo.attlist-->]]> -<!--end of referenceinfo.module-->]]> - -<!ENTITY % local.sect1info.attrib ""> -<!ENTITY % sect1info.role.attrib "%role.attrib;"> - -<!ENTITY % sect1info.element "INCLUDE"> -<![%sect1info.element;[ -<!--doc:Meta-information for a Sect1.--> -<!ELEMENT sect1info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sect1info.element-->]]> - -<!ENTITY % sect1info.attlist "INCLUDE"> -<![%sect1info.attlist;[ -<!ATTLIST sect1info - %common.attrib; - %sect1info.role.attrib; - %local.sect1info.attrib; -> -<!--end of sect1info.attlist-->]]> - -<!ENTITY % local.sect2info.attrib ""> -<!ENTITY % sect2info.role.attrib "%role.attrib;"> - -<!ENTITY % sect2info.element "INCLUDE"> -<![%sect2info.element;[ -<!--doc:Meta-information for a Sect2.--> -<!ELEMENT sect2info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sect2info.element-->]]> - -<!ENTITY % sect2info.attlist "INCLUDE"> -<![%sect2info.attlist;[ -<!ATTLIST sect2info - %common.attrib; - %sect2info.role.attrib; - %local.sect2info.attrib; -> -<!--end of sect2info.attlist-->]]> - -<!ENTITY % local.sect3info.attrib ""> -<!ENTITY % sect3info.role.attrib "%role.attrib;"> - -<!ENTITY % sect3info.element "INCLUDE"> -<![%sect3info.element;[ -<!--doc:Meta-information for a Sect3.--> -<!ELEMENT sect3info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sect3info.element-->]]> - -<!ENTITY % sect3info.attlist "INCLUDE"> -<![%sect3info.attlist;[ -<!ATTLIST sect3info - %common.attrib; - %sect3info.role.attrib; - %local.sect3info.attrib; -> -<!--end of sect3info.attlist-->]]> - -<!ENTITY % local.sect4info.attrib ""> -<!ENTITY % sect4info.role.attrib "%role.attrib;"> - -<!ENTITY % sect4info.element "INCLUDE"> -<![%sect4info.element;[ -<!--doc:Meta-information for a Sect4.--> -<!ELEMENT sect4info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sect4info.element-->]]> - -<!ENTITY % sect4info.attlist "INCLUDE"> -<![%sect4info.attlist;[ -<!ATTLIST sect4info - %common.attrib; - %sect4info.role.attrib; - %local.sect4info.attrib; -> -<!--end of sect4info.attlist-->]]> - -<!ENTITY % local.sect5info.attrib ""> -<!ENTITY % sect5info.role.attrib "%role.attrib;"> - -<!ENTITY % sect5info.element "INCLUDE"> -<![%sect5info.element;[ -<!--doc:Meta-information for a Sect5.--> -<!ELEMENT sect5info %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sect5info.element-->]]> - -<!ENTITY % sect5info.attlist "INCLUDE"> -<![%sect5info.attlist;[ -<!ATTLIST sect5info - %common.attrib; - %sect5info.role.attrib; - %local.sect5info.attrib; -> -<!--end of sect5info.attlist-->]]> - -<!-- ...................................................................... --> -<!-- Section (parallel to Sect*) ......................................... --> - -<!ENTITY % section.content.module "INCLUDE"> -<![ %section.content.module; [ -<!ENTITY % section.module "INCLUDE"> -<![ %section.module; [ -<!ENTITY % local.section.attrib ""> -<!ENTITY % section.role.attrib "%role.attrib;"> - -<!ENTITY % section.element "INCLUDE"> -<![ %section.element; [ -<!--doc:A recursive section.--> -<!ELEMENT section %ho; (sectioninfo?, - (%sect.title.content;), - (%nav.class;)*, - (((%divcomponent.mix;)+, - ((%refentry.class;)*|(%section.class;)*|simplesect*)) - | (%refentry.class;)+|(%section.class;)+|simplesect+), - (%nav.class;)*) - %ubiq.inclusion;> -<!--end of section.element-->]]> - -<!ENTITY % section.attlist "INCLUDE"> -<![ %section.attlist; [ -<!ATTLIST section - %label.attrib; - %status.attrib; - %common.attrib; - %section.role.attrib; - %local.section.attrib; -> -<!--end of section.attlist-->]]> -<!--end of section.module-->]]> - -<!ENTITY % sectioninfo.module "INCLUDE"> -<![ %sectioninfo.module; [ -<!ENTITY % sectioninfo.role.attrib "%role.attrib;"> -<!ENTITY % local.sectioninfo.attrib ""> - -<!ENTITY % sectioninfo.element "INCLUDE"> -<![ %sectioninfo.element; [ -<!--doc:Meta-information for a recursive section.--> -<!ELEMENT sectioninfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sectioninfo.element-->]]> - -<!ENTITY % sectioninfo.attlist "INCLUDE"> -<![ %sectioninfo.attlist; [ -<!ATTLIST sectioninfo - %common.attrib; - %sectioninfo.role.attrib; - %local.sectioninfo.attrib; -> -<!--end of sectioninfo.attlist-->]]> -<!--end of sectioninfo.module-->]]> -<!--end of section.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Sect1, Sect2, Sect3, Sect4, Sect5 .................................... --> - -<!ENTITY % sect1.module "INCLUDE"> -<![%sect1.module;[ -<!ENTITY % local.sect1.attrib ""> -<!ENTITY % sect1.role.attrib "%role.attrib;"> - -<!ENTITY % sect1.element "INCLUDE"> -<![%sect1.element;[ -<!--doc:A top-level section of document.--> -<!ELEMENT sect1 %ho; (sect1info?, (%sect.title.content;), (%nav.class;)*, - (((%divcomponent.mix;)+, - ((%refentry.class;)* | sect2* | simplesect*)) - | (%refentry.class;)+ | sect2+ | simplesect+), (%nav.class;)*) - %ubiq.inclusion;> -<!--end of sect1.element-->]]> - -<!-- Renderas: Indicates the format in which the heading should - appear --> - - -<!ENTITY % sect1.attlist "INCLUDE"> -<![%sect1.attlist;[ -<!ATTLIST sect1 - renderas (sect2 - |sect3 - |sect4 - |sect5) #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %sect1.role.attrib; - %local.sect1.attrib; -> -<!--end of sect1.attlist-->]]> -<!--end of sect1.module-->]]> - -<!ENTITY % sect2.module "INCLUDE"> -<![%sect2.module;[ -<!ENTITY % local.sect2.attrib ""> -<!ENTITY % sect2.role.attrib "%role.attrib;"> - -<!ENTITY % sect2.element "INCLUDE"> -<![%sect2.element;[ -<!--doc:A subsection within a Sect1.--> -<!ELEMENT sect2 %ho; (sect2info?, (%sect.title.content;), (%nav.class;)*, - (((%divcomponent.mix;)+, - ((%refentry.class;)* | sect3* | simplesect*)) - | (%refentry.class;)+ | sect3+ | simplesect+), (%nav.class;)*)> -<!--end of sect2.element-->]]> - -<!-- Renderas: Indicates the format in which the heading should - appear --> - - -<!ENTITY % sect2.attlist "INCLUDE"> -<![%sect2.attlist;[ -<!ATTLIST sect2 - renderas (sect1 - |sect3 - |sect4 - |sect5) #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %sect2.role.attrib; - %local.sect2.attrib; -> -<!--end of sect2.attlist-->]]> -<!--end of sect2.module-->]]> - -<!ENTITY % sect3.module "INCLUDE"> -<![%sect3.module;[ -<!ENTITY % local.sect3.attrib ""> -<!ENTITY % sect3.role.attrib "%role.attrib;"> - -<!ENTITY % sect3.element "INCLUDE"> -<![%sect3.element;[ -<!--doc:A subsection within a Sect2.--> -<!ELEMENT sect3 %ho; (sect3info?, (%sect.title.content;), (%nav.class;)*, - (((%divcomponent.mix;)+, - ((%refentry.class;)* | sect4* | simplesect*)) - | (%refentry.class;)+ | sect4+ | simplesect+), (%nav.class;)*)> -<!--end of sect3.element-->]]> - -<!-- Renderas: Indicates the format in which the heading should - appear --> - - -<!ENTITY % sect3.attlist "INCLUDE"> -<![%sect3.attlist;[ -<!ATTLIST sect3 - renderas (sect1 - |sect2 - |sect4 - |sect5) #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %sect3.role.attrib; - %local.sect3.attrib; -> -<!--end of sect3.attlist-->]]> -<!--end of sect3.module-->]]> - -<!ENTITY % sect4.module "INCLUDE"> -<![%sect4.module;[ -<!ENTITY % local.sect4.attrib ""> -<!ENTITY % sect4.role.attrib "%role.attrib;"> - -<!ENTITY % sect4.element "INCLUDE"> -<![%sect4.element;[ -<!--doc:A subsection within a Sect3.--> -<!ELEMENT sect4 %ho; (sect4info?, (%sect.title.content;), (%nav.class;)*, - (((%divcomponent.mix;)+, - ((%refentry.class;)* | sect5* | simplesect*)) - | (%refentry.class;)+ | sect5+ | simplesect+), (%nav.class;)*)> -<!--end of sect4.element-->]]> - -<!-- Renderas: Indicates the format in which the heading should - appear --> - - -<!ENTITY % sect4.attlist "INCLUDE"> -<![%sect4.attlist;[ -<!ATTLIST sect4 - renderas (sect1 - |sect2 - |sect3 - |sect5) #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %sect4.role.attrib; - %local.sect4.attrib; -> -<!--end of sect4.attlist-->]]> -<!--end of sect4.module-->]]> - -<!ENTITY % sect5.module "INCLUDE"> -<![%sect5.module;[ -<!ENTITY % local.sect5.attrib ""> -<!ENTITY % sect5.role.attrib "%role.attrib;"> - -<!ENTITY % sect5.element "INCLUDE"> -<![%sect5.element;[ -<!--doc:A subsection within a Sect4.--> -<!ELEMENT sect5 %ho; (sect5info?, (%sect.title.content;), (%nav.class;)*, - (((%divcomponent.mix;)+, ((%refentry.class;)* | simplesect*)) - | (%refentry.class;)+ | simplesect+), (%nav.class;)*)> -<!--end of sect5.element-->]]> - -<!-- Renderas: Indicates the format in which the heading should - appear --> - - -<!ENTITY % sect5.attlist "INCLUDE"> -<![%sect5.attlist;[ -<!ATTLIST sect5 - renderas (sect1 - |sect2 - |sect3 - |sect4) #IMPLIED - %label.attrib; - %status.attrib; - %common.attrib; - %sect5.role.attrib; - %local.sect5.attrib; -> -<!--end of sect5.attlist-->]]> -<!--end of sect5.module-->]]> - -<!ENTITY % simplesect.module "INCLUDE"> -<![%simplesect.module;[ -<!ENTITY % local.simplesect.attrib ""> -<!ENTITY % simplesect.role.attrib "%role.attrib;"> - -<!ENTITY % simplesect.element "INCLUDE"> -<![%simplesect.element;[ -<!--doc:A section of a document with no subdivisions.--> -<!ELEMENT simplesect %ho; ((%sect.title.content;), (%divcomponent.mix;)+) - %ubiq.inclusion;> -<!--end of simplesect.element-->]]> - -<!ENTITY % simplesect.attlist "INCLUDE"> -<![%simplesect.attlist;[ -<!ATTLIST simplesect - %common.attrib; - %simplesect.role.attrib; - %local.simplesect.attrib; -> -<!--end of simplesect.attlist-->]]> -<!--end of simplesect.module-->]]> - -<!-- ...................................................................... --> -<!-- Bibliography ......................................................... --> - -<!ENTITY % bibliography.content.module "INCLUDE"> -<![%bibliography.content.module;[ -<!ENTITY % bibliography.module "INCLUDE"> -<![%bibliography.module;[ -<!ENTITY % local.bibliography.attrib ""> -<!ENTITY % bibliography.role.attrib "%role.attrib;"> - -<!ENTITY % bibliography.element "INCLUDE"> -<![%bibliography.element;[ -<!--doc:A bibliography.--> -<!ELEMENT bibliography %ho; (bibliographyinfo?, - (%bookcomponent.title.content;)?, - (%component.mix;)*, - (bibliodiv+ | (biblioentry|bibliomixed)+))> -<!--end of bibliography.element-->]]> - -<!ENTITY % bibliography.attlist "INCLUDE"> -<![%bibliography.attlist;[ -<!ATTLIST bibliography - %status.attrib; - %common.attrib; - %bibliography.role.attrib; - %local.bibliography.attrib; -> -<!--end of bibliography.attlist-->]]> -<!--end of bibliography.module-->]]> - -<!ENTITY % bibliodiv.module "INCLUDE"> -<![%bibliodiv.module;[ -<!ENTITY % local.bibliodiv.attrib ""> -<!ENTITY % bibliodiv.role.attrib "%role.attrib;"> - -<!ENTITY % bibliodiv.element "INCLUDE"> -<![%bibliodiv.element;[ -<!--doc:A section of a Bibliography.--> -<!ELEMENT bibliodiv %ho; ((%sect.title.content;)?, (%component.mix;)*, - (biblioentry|bibliomixed)+)> -<!--end of bibliodiv.element-->]]> - -<!ENTITY % bibliodiv.attlist "INCLUDE"> -<![%bibliodiv.attlist;[ -<!ATTLIST bibliodiv - %status.attrib; - %common.attrib; - %bibliodiv.role.attrib; - %local.bibliodiv.attrib; -> -<!--end of bibliodiv.attlist-->]]> -<!--end of bibliodiv.module-->]]> -<!--end of bibliography.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Glossary ............................................................. --> - -<!ENTITY % glossary.content.module "INCLUDE"> -<![%glossary.content.module;[ -<!ENTITY % glossary.module "INCLUDE"> -<![%glossary.module;[ -<!ENTITY % local.glossary.attrib ""> -<!ENTITY % glossary.role.attrib "%role.attrib;"> - -<!ENTITY % glossary.element "INCLUDE"> -<![%glossary.element;[ -<!--doc:A glossary.--> -<!ELEMENT glossary %ho; (glossaryinfo?, - (%bookcomponent.title.content;)?, - (%component.mix;)*, - (glossdiv+ | glossentry+), bibliography?)> -<!--end of glossary.element-->]]> - -<!ENTITY % glossary.attlist "INCLUDE"> -<![%glossary.attlist;[ -<!ATTLIST glossary - %status.attrib; - %common.attrib; - %glossary.role.attrib; - %local.glossary.attrib; -> -<!--end of glossary.attlist-->]]> -<!--end of glossary.module-->]]> - -<!ENTITY % glossdiv.module "INCLUDE"> -<![%glossdiv.module;[ -<!ENTITY % local.glossdiv.attrib ""> -<!ENTITY % glossdiv.role.attrib "%role.attrib;"> - -<!ENTITY % glossdiv.element "INCLUDE"> -<![%glossdiv.element;[ -<!--doc:A division in a Glossary.--> -<!ELEMENT glossdiv %ho; ((%sect.title.content;), (%component.mix;)*, - glossentry+)> -<!--end of glossdiv.element-->]]> - -<!ENTITY % glossdiv.attlist "INCLUDE"> -<![%glossdiv.attlist;[ -<!ATTLIST glossdiv - %status.attrib; - %common.attrib; - %glossdiv.role.attrib; - %local.glossdiv.attrib; -> -<!--end of glossdiv.attlist-->]]> -<!--end of glossdiv.module-->]]> -<!--end of glossary.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Index and SetIndex ................................................... --> - -<!ENTITY % index.content.module "INCLUDE"> -<![%index.content.module;[ -<!ENTITY % indexes.module "INCLUDE"> -<![%indexes.module;[ -<!ENTITY % local.indexes.attrib ""> -<!ENTITY % indexes.role.attrib "%role.attrib;"> - -<!ENTITY % index.element "INCLUDE"> -<![%index.element;[ -<!--doc:An index.--> -<!ELEMENT index %ho; (indexinfo?, - (%bookcomponent.title.content;)?, - (%component.mix;)*, - (indexdiv* | indexentry*)) - %ndxterm.exclusion;> -<!--end of index.element-->]]> - -<!ENTITY % index.attlist "INCLUDE"> -<![%index.attlist;[ -<!ATTLIST index - type CDATA #IMPLIED - %common.attrib; - %indexes.role.attrib; - %local.indexes.attrib; -> -<!--end of index.attlist-->]]> - -<!ENTITY % setindex.element "INCLUDE"> -<![%setindex.element;[ -<!--doc:An index to a set of books.--> -<!ELEMENT setindex %ho; (setindexinfo?, - (%bookcomponent.title.content;)?, - (%component.mix;)*, - (indexdiv* | indexentry*)) - %ndxterm.exclusion;> -<!--end of setindex.element-->]]> - -<!ENTITY % setindex.attlist "INCLUDE"> -<![%setindex.attlist;[ -<!ATTLIST setindex - %common.attrib; - %indexes.role.attrib; - %local.indexes.attrib; -> -<!--end of setindex.attlist-->]]> -<!--end of indexes.module-->]]> - -<!ENTITY % indexdiv.module "INCLUDE"> -<![%indexdiv.module;[ - -<!-- SegmentedList in this content is useful for marking up permuted - indices. --> - -<!ENTITY % local.indexdiv.attrib ""> -<!ENTITY % indexdiv.role.attrib "%role.attrib;"> - -<!ENTITY % indexdiv.element "INCLUDE"> -<![%indexdiv.element;[ -<!--doc:A division in an index.--> -<!ELEMENT indexdiv %ho; ((%sect.title.content;)?, ((%indexdivcomponent.mix;)*, - (indexentry+ | segmentedlist)))> -<!--end of indexdiv.element-->]]> - -<!ENTITY % indexdiv.attlist "INCLUDE"> -<![%indexdiv.attlist;[ -<!ATTLIST indexdiv - %common.attrib; - %indexdiv.role.attrib; - %local.indexdiv.attrib; -> -<!--end of indexdiv.attlist-->]]> -<!--end of indexdiv.module-->]]> - -<!ENTITY % indexentry.module "INCLUDE"> -<![%indexentry.module;[ -<!-- Index entries appear in the index, not the text. --> - -<!ENTITY % local.indexentry.attrib ""> -<!ENTITY % indexentry.role.attrib "%role.attrib;"> - -<!ENTITY % indexentry.element "INCLUDE"> -<![%indexentry.element;[ -<!--doc:An entry in an index.--> -<!ELEMENT indexentry %ho; (primaryie, (seeie|seealsoie)*, - (secondaryie, (seeie|seealsoie|tertiaryie)*)*)> -<!--end of indexentry.element-->]]> - -<!ENTITY % indexentry.attlist "INCLUDE"> -<![%indexentry.attlist;[ -<!ATTLIST indexentry - %common.attrib; - %indexentry.role.attrib; - %local.indexentry.attrib; -> -<!--end of indexentry.attlist-->]]> -<!--end of indexentry.module-->]]> - -<!ENTITY % primsecterie.module "INCLUDE"> -<![%primsecterie.module;[ -<!ENTITY % local.primsecterie.attrib ""> -<!ENTITY % primsecterie.role.attrib "%role.attrib;"> - -<!ENTITY % primaryie.element "INCLUDE"> -<![%primaryie.element;[ -<!--doc:A primary term in an index entry, not in the text.--> -<!ELEMENT primaryie %ho; (%ndxterm.char.mix;)*> -<!--end of primaryie.element-->]]> - -<!-- to IndexTerms that these entries represent --> - -<!ENTITY % primaryie.attlist "INCLUDE"> -<![%primaryie.attlist;[ -<!ATTLIST primaryie - %linkends.attrib; %common.attrib; - %primsecterie.role.attrib; - %local.primsecterie.attrib; -> -<!--end of primaryie.attlist-->]]> - -<!ENTITY % secondaryie.element "INCLUDE"> -<![%secondaryie.element;[ -<!--doc:A secondary term in an index entry, rather than in the text.--> -<!ELEMENT secondaryie %ho; (%ndxterm.char.mix;)*> -<!--end of secondaryie.element-->]]> - -<!-- to IndexTerms that these entries represent --> - -<!ENTITY % secondaryie.attlist "INCLUDE"> -<![%secondaryie.attlist;[ -<!ATTLIST secondaryie - %linkends.attrib; %common.attrib; - %primsecterie.role.attrib; - %local.primsecterie.attrib; -> -<!--end of secondaryie.attlist-->]]> - -<!ENTITY % tertiaryie.element "INCLUDE"> -<![%tertiaryie.element;[ -<!--doc:A tertiary term in an index entry, rather than in the text.--> -<!ELEMENT tertiaryie %ho; (%ndxterm.char.mix;)*> -<!--end of tertiaryie.element-->]]> - -<!-- to IndexTerms that these entries represent --> - -<!ENTITY % tertiaryie.attlist "INCLUDE"> -<![%tertiaryie.attlist;[ -<!ATTLIST tertiaryie - %linkends.attrib; %common.attrib; - %primsecterie.role.attrib; - %local.primsecterie.attrib; -> -<!--end of tertiaryie.attlist-->]]> - -<!--end of primsecterie.module-->]]> - -<!ENTITY % seeie.module "INCLUDE"> -<![%seeie.module;[ -<!ENTITY % local.seeie.attrib ""> -<!ENTITY % seeie.role.attrib "%role.attrib;"> - -<!ENTITY % seeie.element "INCLUDE"> -<![%seeie.element;[ -<!--doc:A See entry in an index, rather than in the text.--> -<!ELEMENT seeie %ho; (%ndxterm.char.mix;)*> -<!--end of seeie.element-->]]> - -<!-- to IndexEntry to look up --> - - -<!ENTITY % seeie.attlist "INCLUDE"> -<![%seeie.attlist;[ -<!ATTLIST seeie - %linkend.attrib; %common.attrib; - %seeie.role.attrib; - %local.seeie.attrib; -> -<!--end of seeie.attlist-->]]> -<!--end of seeie.module-->]]> - -<!ENTITY % seealsoie.module "INCLUDE"> -<![%seealsoie.module;[ -<!ENTITY % local.seealsoie.attrib ""> -<!ENTITY % seealsoie.role.attrib "%role.attrib;"> - -<!ENTITY % seealsoie.element "INCLUDE"> -<![%seealsoie.element;[ -<!--doc:A See also entry in an index, rather than in the text.--> -<!ELEMENT seealsoie %ho; (%ndxterm.char.mix;)*> -<!--end of seealsoie.element-->]]> - -<!-- to related IndexEntries --> - - -<!ENTITY % seealsoie.attlist "INCLUDE"> -<![%seealsoie.attlist;[ -<!ATTLIST seealsoie - %linkends.attrib; %common.attrib; - %seealsoie.role.attrib; - %local.seealsoie.attrib; -> -<!--end of seealsoie.attlist-->]]> -<!--end of seealsoie.module-->]]> -<!--end of index.content.module-->]]> - -<!-- ...................................................................... --> -<!-- RefEntry ............................................................. --> - -<!ENTITY % refentry.content.module "INCLUDE"> -<![%refentry.content.module;[ -<!ENTITY % refentry.module "INCLUDE"> -<![%refentry.module;[ -<!ENTITY % local.refentry.attrib ""> -<!ENTITY % refentry.role.attrib "%role.attrib;"> - -<!ENTITY % refentry.element "INCLUDE"> -<![%refentry.element;[ -<!--doc:A reference page (originally a UNIX man-style reference page).--> -<!ELEMENT refentry %ho; (beginpage?, - (%ndxterm.class;)*, - refentryinfo?, refmeta?, (remark|%link.char.class;)*, - refnamediv+, refsynopsisdiv?, (refsect1+|refsection+)) - %ubiq.inclusion;> -<!--end of refentry.element-->]]> - -<!ENTITY % refentry.attlist "INCLUDE"> -<![%refentry.attlist;[ -<!ATTLIST refentry - %status.attrib; - %common.attrib; - %refentry.role.attrib; - %local.refentry.attrib; -> -<!--end of refentry.attlist-->]]> -<!--end of refentry.module-->]]> - -<!ENTITY % refmeta.module "INCLUDE"> -<![%refmeta.module;[ -<!ENTITY % local.refmeta.attrib ""> -<!ENTITY % refmeta.role.attrib "%role.attrib;"> - -<!ENTITY % refmeta.element "INCLUDE"> -<![%refmeta.element;[ -<!--doc:Meta-information for a reference entry.--> -<!ELEMENT refmeta %ho; ((%ndxterm.class;)*, - refentrytitle, manvolnum?, refmiscinfo*, - (%ndxterm.class;)*) - %beginpage.exclusion;> -<!--end of refmeta.element-->]]> - -<!ENTITY % refmeta.attlist "INCLUDE"> -<![%refmeta.attlist;[ -<!ATTLIST refmeta - %common.attrib; - %refmeta.role.attrib; - %local.refmeta.attrib; -> -<!--end of refmeta.attlist-->]]> -<!--end of refmeta.module-->]]> - -<!ENTITY % refmiscinfo.module "INCLUDE"> -<![%refmiscinfo.module;[ -<!ENTITY % local.refmiscinfo.attrib ""> -<!ENTITY % refmiscinfo.role.attrib "%role.attrib;"> - -<!ENTITY % refmiscinfo.element "INCLUDE"> -<![%refmiscinfo.element;[ -<!--doc:Meta-information for a reference entry other than the title and volume number.--> -<!ELEMENT refmiscinfo %ho; (%docinfo.char.mix;)*> -<!--end of refmiscinfo.element-->]]> - -<!-- Class: Freely assignable parameter; no default --> - - -<!ENTITY % refmiscinfo.attlist "INCLUDE"> -<![%refmiscinfo.attlist;[ -<!ATTLIST refmiscinfo - class CDATA #IMPLIED - %common.attrib; - %refmiscinfo.role.attrib; - %local.refmiscinfo.attrib; -> -<!--end of refmiscinfo.attlist-->]]> -<!--end of refmiscinfo.module-->]]> - -<!ENTITY % refnamediv.module "INCLUDE"> -<![%refnamediv.module;[ -<!ENTITY % local.refnamediv.attrib ""> -<!ENTITY % refnamediv.role.attrib "%role.attrib;"> - -<!ENTITY % refnamediv.element "INCLUDE"> -<![%refnamediv.element;[ -<!--doc:The name, purpose, and classification of a reference page.--> -<!ELEMENT refnamediv %ho; (refdescriptor?, refname+, refpurpose, refclass*, - (remark|%link.char.class;)*)> -<!--end of refnamediv.element-->]]> - -<!ENTITY % refnamediv.attlist "INCLUDE"> -<![%refnamediv.attlist;[ -<!ATTLIST refnamediv - %common.attrib; - %refnamediv.role.attrib; - %local.refnamediv.attrib; -> -<!--end of refnamediv.attlist-->]]> -<!--end of refnamediv.module-->]]> - -<!ENTITY % refdescriptor.module "INCLUDE"> -<![%refdescriptor.module;[ -<!ENTITY % local.refdescriptor.attrib ""> -<!ENTITY % refdescriptor.role.attrib "%role.attrib;"> - -<!ENTITY % refdescriptor.element "INCLUDE"> -<![%refdescriptor.element;[ -<!--doc:A description of the topic of a reference page.--> -<!ELEMENT refdescriptor %ho; (%refname.char.mix;)*> -<!--end of refdescriptor.element-->]]> - -<!ENTITY % refdescriptor.attlist "INCLUDE"> -<![%refdescriptor.attlist;[ -<!ATTLIST refdescriptor - %common.attrib; - %refdescriptor.role.attrib; - %local.refdescriptor.attrib; -> -<!--end of refdescriptor.attlist-->]]> -<!--end of refdescriptor.module-->]]> - -<!ENTITY % refname.module "INCLUDE"> -<![%refname.module;[ -<!ENTITY % local.refname.attrib ""> -<!ENTITY % refname.role.attrib "%role.attrib;"> - -<!ENTITY % refname.element "INCLUDE"> -<![%refname.element;[ -<!--doc:The name of (one of) the subject(s) of a reference page.--> -<!ELEMENT refname %ho; (%refname.char.mix;)*> -<!--end of refname.element-->]]> - -<!ENTITY % refname.attlist "INCLUDE"> -<![%refname.attlist;[ -<!ATTLIST refname - %common.attrib; - %refname.role.attrib; - %local.refname.attrib; -> -<!--end of refname.attlist-->]]> -<!--end of refname.module-->]]> - -<!ENTITY % refpurpose.module "INCLUDE"> -<![%refpurpose.module;[ -<!ENTITY % local.refpurpose.attrib ""> -<!ENTITY % refpurpose.role.attrib "%role.attrib;"> - -<!ENTITY % refpurpose.element "INCLUDE"> -<![%refpurpose.element;[ -<!--doc:A short (one sentence) synopsis of the topic of a reference page.--> -<!ELEMENT refpurpose %ho; (%refinline.char.mix;)*> -<!--end of refpurpose.element-->]]> - -<!ENTITY % refpurpose.attlist "INCLUDE"> -<![%refpurpose.attlist;[ -<!ATTLIST refpurpose - %common.attrib; - %refpurpose.role.attrib; - %local.refpurpose.attrib; -> -<!--end of refpurpose.attlist-->]]> -<!--end of refpurpose.module-->]]> - -<!ENTITY % refclass.module "INCLUDE"> -<![%refclass.module;[ -<!ENTITY % local.refclass.attrib ""> -<!ENTITY % refclass.role.attrib "%role.attrib;"> - -<!ENTITY % refclass.element "INCLUDE"> -<![%refclass.element;[ -<!--doc:The scope or other indication of applicability of a reference entry.--> -<!ELEMENT refclass %ho; (%refclass.char.mix;)*> -<!--end of refclass.element-->]]> - -<!ENTITY % refclass.attlist "INCLUDE"> -<![%refclass.attlist;[ -<!ATTLIST refclass - %common.attrib; - %refclass.role.attrib; - %local.refclass.attrib; -> -<!--end of refclass.attlist-->]]> -<!--end of refclass.module-->]]> - -<!ENTITY % refsynopsisdiv.module "INCLUDE"> -<![%refsynopsisdiv.module;[ -<!ENTITY % local.refsynopsisdiv.attrib ""> -<!ENTITY % refsynopsisdiv.role.attrib "%role.attrib;"> - -<!ENTITY % refsynopsisdiv.element "INCLUDE"> -<![%refsynopsisdiv.element;[ -<!--doc:A syntactic synopsis of the subject of the reference page.--> -<!ELEMENT refsynopsisdiv %ho; (refsynopsisdivinfo?, (%refsect.title.content;)?, - (((%refcomponent.mix;)+, refsect2*) | (refsect2+)))> -<!--end of refsynopsisdiv.element-->]]> - -<!ENTITY % refsynopsisdiv.attlist "INCLUDE"> -<![%refsynopsisdiv.attlist;[ -<!ATTLIST refsynopsisdiv - %common.attrib; - %refsynopsisdiv.role.attrib; - %local.refsynopsisdiv.attrib; -> -<!--end of refsynopsisdiv.attlist-->]]> -<!--end of refsynopsisdiv.module-->]]> - -<!ENTITY % refsection.module "INCLUDE"> -<![%refsection.module;[ -<!ENTITY % local.refsection.attrib ""> -<!ENTITY % refsection.role.attrib "%role.attrib;"> - -<!ENTITY % refsection.element "INCLUDE"> -<![%refsection.element;[ -<!--doc:A recursive section in a refentry.--> -<!ELEMENT refsection %ho; (refsectioninfo?, (%refsect.title.content;), - (((%refcomponent.mix;)+, refsection*) | refsection+))> -<!--end of refsection.element-->]]> - -<!ENTITY % refsection.attlist "INCLUDE"> -<![%refsection.attlist;[ -<!ATTLIST refsection - %status.attrib; - %common.attrib; - %refsection.role.attrib; - %local.refsection.attrib; -> -<!--end of refsection.attlist-->]]> -<!--end of refsection.module-->]]> - -<!ENTITY % refsect1.module "INCLUDE"> -<![%refsect1.module;[ -<!ENTITY % local.refsect1.attrib ""> -<!ENTITY % refsect1.role.attrib "%role.attrib;"> - -<!ENTITY % refsect1.element "INCLUDE"> -<![%refsect1.element;[ -<!--doc:A major subsection of a reference entry.--> -<!ELEMENT refsect1 %ho; (refsect1info?, (%refsect.title.content;), - (((%refcomponent.mix;)+, refsect2*) | refsect2+))> -<!--end of refsect1.element-->]]> - -<!ENTITY % refsect1.attlist "INCLUDE"> -<![%refsect1.attlist;[ -<!ATTLIST refsect1 - %status.attrib; - %common.attrib; - %refsect1.role.attrib; - %local.refsect1.attrib; -> -<!--end of refsect1.attlist-->]]> -<!--end of refsect1.module-->]]> - -<!ENTITY % refsect2.module "INCLUDE"> -<![%refsect2.module;[ -<!ENTITY % local.refsect2.attrib ""> -<!ENTITY % refsect2.role.attrib "%role.attrib;"> - -<!ENTITY % refsect2.element "INCLUDE"> -<![%refsect2.element;[ -<!--doc:A subsection of a RefSect1.--> -<!ELEMENT refsect2 %ho; (refsect2info?, (%refsect.title.content;), - (((%refcomponent.mix;)+, refsect3*) | refsect3+))> -<!--end of refsect2.element-->]]> - -<!ENTITY % refsect2.attlist "INCLUDE"> -<![%refsect2.attlist;[ -<!ATTLIST refsect2 - %status.attrib; - %common.attrib; - %refsect2.role.attrib; - %local.refsect2.attrib; -> -<!--end of refsect2.attlist-->]]> -<!--end of refsect2.module-->]]> - -<!ENTITY % refsect3.module "INCLUDE"> -<![%refsect3.module;[ -<!ENTITY % local.refsect3.attrib ""> -<!ENTITY % refsect3.role.attrib "%role.attrib;"> - -<!ENTITY % refsect3.element "INCLUDE"> -<![%refsect3.element;[ -<!--doc:A subsection of a RefSect2.--> -<!ELEMENT refsect3 %ho; (refsect3info?, (%refsect.title.content;), - (%refcomponent.mix;)+)> -<!--end of refsect3.element-->]]> - -<!ENTITY % refsect3.attlist "INCLUDE"> -<![%refsect3.attlist;[ -<!ATTLIST refsect3 - %status.attrib; - %common.attrib; - %refsect3.role.attrib; - %local.refsect3.attrib; -> -<!--end of refsect3.attlist-->]]> -<!--end of refsect3.module-->]]> -<!--end of refentry.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Article .............................................................. --> - -<!ENTITY % article.module "INCLUDE"> -<![%article.module;[ -<!-- An Article is a chapter-level, stand-alone document that is often, - but need not be, collected into a Book. --> - -<!ENTITY % local.article.attrib ""> -<!ENTITY % article.role.attrib "%role.attrib;"> - -<!ENTITY % article.element "INCLUDE"> -<![%article.element;[ -<!--doc:An article.--> -<!ELEMENT article %ho; ((%div.title.content;)?, articleinfo?, tocchap?, lot*, - (%bookcomponent.content;), - (%nav.class;|%appendix.class;|colophon|ackno)*) - %ubiq.inclusion;> -<!--end of article.element-->]]> - -<!-- Class: Indicates the type of a particular article; - all articles have the same structure and general purpose. - No default. --> -<!-- ParentBook: ID of the enclosing Book --> - - -<!ENTITY % article.attlist "INCLUDE"> -<![%article.attlist;[ -<!ATTLIST article - class (journalarticle - |productsheet - |whitepaper - |techreport - |specification - |faq) #IMPLIED - parentbook IDREF #IMPLIED - %status.attrib; - %common.attrib; - %article.role.attrib; - %local.article.attrib; -> -<!--end of article.attlist-->]]> -<!--end of article.module-->]]> - -<!-- End of DocBook document hierarchy module V4.5 ........................ --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/dbnotnx.mod b/Utilities/xml/docbook-4.5/dbnotnx.mod deleted file mode 100644 index 2416049..0000000 --- a/Utilities/xml/docbook-4.5/dbnotnx.mod +++ /dev/null @@ -1,101 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook notations module V4.5 ........................................ --> -<!-- File dbnotnx.mod ..................................................... --> - -<!-- Copyright 1992-2004 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - $Id: dbnotnx.mod 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the notation declarations used by DocBook. - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % dbnotn PUBLIC - "-//OASIS//ENTITIES DocBook Notations V4.5//EN" - "dbnotnx.mod"> - %dbnotn; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!ENTITY % local.notation.class ""> -<!ENTITY % notation.class - "BMP| CGM-CHAR | CGM-BINARY | CGM-CLEAR | DITROFF | DVI - | EPS | EQN | FAX | GIF | GIF87a | GIF89a - | JPG | JPEG | IGES | PCX - | PIC | PNG | PS | SGML | TBL | TEX | TIFF | WMF | WPG - | SVG | PDF | SWF - | linespecific - %local.notation.class;"> - -<!NOTATION BMP PUBLIC -"+//ISBN 0-7923-94.2-1::Graphic Notation//NOTATION Microsoft Windows bitmap//EN"> -<!NOTATION CGM-CHAR PUBLIC "ISO 8632/2//NOTATION Character encoding//EN"> -<!NOTATION CGM-BINARY PUBLIC "ISO 8632/3//NOTATION Binary encoding//EN"> -<!NOTATION CGM-CLEAR PUBLIC "ISO 8632/4//NOTATION Clear text encoding//EN"> -<!NOTATION DITROFF SYSTEM "DITROFF"> -<!NOTATION DVI SYSTEM "DVI"> -<!NOTATION EPS PUBLIC -"+//ISBN 0-201-18127-4::Adobe//NOTATION PostScript Language Ref. Manual//EN"> -<!NOTATION EQN SYSTEM "EQN"> -<!NOTATION FAX PUBLIC -"-//USA-DOD//NOTATION CCITT Group 4 Facsimile Type 1 Untiled Raster//EN"> -<!NOTATION GIF SYSTEM "GIF"> -<!NOTATION GIF87a PUBLIC -"-//CompuServe//NOTATION Graphics Interchange Format 87a//EN"> - -<!NOTATION GIF89a PUBLIC -"-//CompuServe//NOTATION Graphics Interchange Format 89a//EN"> -<!NOTATION JPG SYSTEM "JPG"> -<!NOTATION JPEG SYSTEM "JPG"> -<!NOTATION IGES PUBLIC -"-//USA-DOD//NOTATION (ASME/ANSI Y14.26M-1987) Initial Graphics Exchange Specification//EN"> -<!NOTATION PCX PUBLIC -"+//ISBN 0-7923-94.2-1::Graphic Notation//NOTATION ZSoft PCX bitmap//EN"> -<!NOTATION PIC SYSTEM "PIC"> -<!NOTATION PNG SYSTEM "http://www.w3.org/TR/REC-png"> -<!NOTATION PS SYSTEM "PS"> -<!NOTATION SGML PUBLIC -"ISO 8879:1986//NOTATION Standard Generalized Markup Language//EN"> -<!NOTATION TBL SYSTEM "TBL"> -<!NOTATION TEX PUBLIC -"+//ISBN 0-201-13448-9::Knuth//NOTATION The TeXbook//EN"> -<!NOTATION TIFF SYSTEM "TIFF"> -<!NOTATION WMF PUBLIC -"+//ISBN 0-7923-94.2-1::Graphic Notation//NOTATION Microsoft Windows Metafile//EN"> -<!NOTATION WPG SYSTEM "WPG"> <!--WordPerfect Graphic format--> -<!NOTATION SVG SYSTEM "http://www.w3.org/TR/SVG/"> -<!NOTATION PDF SYSTEM "http://www.adobe.com/products/acrobat/adobepdf.html"> -<!NOTATION SWF SYSTEM "http://www.macromedia.com/software/flash"> -<!NOTATION linespecific SYSTEM "linespecific"> - -<!-- End of DocBook notations module V4.5 ................................. --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/dbpoolx.mod b/Utilities/xml/docbook-4.5/dbpoolx.mod deleted file mode 100644 index 53b0704..0000000 --- a/Utilities/xml/docbook-4.5/dbpoolx.mod +++ /dev/null @@ -1,8701 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook XML information pool module V4.5 ............................. --> -<!-- File dbpoolx.mod ..................................................... --> - -<!-- Copyright 1992-2004 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - $Id: dbpoolx.mod 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook XML DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook XML DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the definitions for the objects, inline - elements, and so on that are available to be used as the main - content of DocBook documents. Some elements are useful for general - publishing, and others are useful specifically for computer - documentation. - - This module has the following dependencies on other modules: - - o It assumes that a %notation.class; entity is defined by the - driver file or other high-level module. This entity is - referenced in the NOTATION attributes for the graphic-related and - ModeSpec elements. - - o It assumes that an appropriately parameterized table module is - available for use with the table-related elements. - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % dbpool PUBLIC - "-//OASIS//ELEMENTS DocBook XML Information Pool V4.5//EN" - "dbpoolx.mod"> - %dbpool; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!-- ...................................................................... --> -<!-- Forms entities ....................................................... --> -<!-- These PEs provide the hook by which the forms module can be inserted --> -<!-- into the DTD. --> -<!ENTITY % forminlines.hook ""> -<!ENTITY % forms.hook ""> - -<!-- ...................................................................... --> -<!-- General-purpose semantics entities ................................... --> - -<!ENTITY % yesorno.attvals "CDATA"> - -<!-- ...................................................................... --> -<!-- Entities for module inclusions ....................................... --> - -<!ENTITY % dbpool.redecl.module "IGNORE"> - -<!-- ...................................................................... --> -<!-- Entities for element classes and mixtures ............................ --> - -<!-- "Ubiquitous" classes: ndxterm.class and beginpage --> - -<!ENTITY % local.ndxterm.class ""> -<!ENTITY % ndxterm.class - "indexterm %local.ndxterm.class;"> - -<!-- Object-level classes ................................................. --> - -<!ENTITY % local.list.class ""> -<!ENTITY % list.class - "calloutlist|glosslist|bibliolist|itemizedlist|orderedlist|segmentedlist - |simplelist|variablelist %local.list.class;"> - -<!ENTITY % local.admon.class ""> -<!ENTITY % admon.class - "caution|important|note|tip|warning %local.admon.class;"> - -<!ENTITY % local.linespecific.class ""> -<!ENTITY % linespecific.class - "literallayout|programlisting|programlistingco|screen - |screenco|screenshot %local.linespecific.class;"> - -<!ENTITY % local.method.synop.class ""> -<!ENTITY % method.synop.class - "constructorsynopsis - |destructorsynopsis - |methodsynopsis %local.method.synop.class;"> - -<!ENTITY % local.synop.class ""> -<!ENTITY % synop.class - "synopsis|cmdsynopsis|funcsynopsis - |classsynopsis|fieldsynopsis - |%method.synop.class; %local.synop.class;"> - -<!ENTITY % local.para.class ""> -<!ENTITY % para.class - "formalpara|para|simpara %local.para.class;"> - -<!ENTITY % local.informal.class ""> -<!ENTITY % informal.class - "address|blockquote - |graphic|graphicco|mediaobject|mediaobjectco - |informalequation - |informalexample - |informalfigure - |informaltable %local.informal.class;"> - -<!ENTITY % local.formal.class ""> -<!ENTITY % formal.class - "equation|example|figure|table %local.formal.class;"> - -<!-- The DocBook TC may produce an official EBNF module for DocBook. --> -<!-- This PE provides the hook by which it can be inserted into the DTD. --> -<!ENTITY % ebnf.block.hook ""> - -<!ENTITY % local.compound.class ""> -<!ENTITY % compound.class - "msgset|procedure|sidebar|qandaset|task - %ebnf.block.hook; - %local.compound.class;"> - -<!ENTITY % local.genobj.class ""> -<!ENTITY % genobj.class - "anchor|bridgehead|remark|highlights - %local.genobj.class;"> - -<!ENTITY % local.descobj.class ""> -<!ENTITY % descobj.class - "abstract|authorblurb|epigraph - %local.descobj.class;"> - -<!-- Character-level classes .............................................. --> - -<!ENTITY % local.xref.char.class ""> -<!ENTITY % xref.char.class - "footnoteref|xref|biblioref %local.xref.char.class;"> - -<!ENTITY % local.gen.char.class ""> -<!ENTITY % gen.char.class - "abbrev|acronym|citation|citerefentry|citetitle|citebiblioid|emphasis - |firstterm|foreignphrase|glossterm|termdef|footnote|phrase - |orgname|quote|trademark|wordasword - |personname %local.gen.char.class;"> - -<!ENTITY % local.link.char.class ""> -<!ENTITY % link.char.class - "link|olink|ulink %local.link.char.class;"> - -<!-- The DocBook TC may produce an official EBNF module for DocBook. --> -<!-- This PE provides the hook by which it can be inserted into the DTD. --> -<!ENTITY % ebnf.inline.hook ""> - -<!ENTITY % local.tech.char.class ""> -<!ENTITY % tech.char.class - "action|application - |classname|methodname|interfacename|exceptionname - |ooclass|oointerface|ooexception - |package - |command|computeroutput - |database|email|envar|errorcode|errorname|errortype|errortext|filename - |function|guibutton|guiicon|guilabel|guimenu|guimenuitem - |guisubmenu|hardware|interface|keycap - |keycode|keycombo|keysym|literal|code|constant|markup|medialabel - |menuchoice|mousebutton|option|optional|parameter - |prompt|property|replaceable|returnvalue|sgmltag|structfield - |structname|symbol|systemitem|uri|token|type|userinput|varname - %ebnf.inline.hook; - %local.tech.char.class;"> - -<!ENTITY % local.base.char.class ""> -<!ENTITY % base.char.class - "anchor %local.base.char.class;"> - -<!ENTITY % local.docinfo.char.class ""> -<!ENTITY % docinfo.char.class - "author|authorinitials|corpauthor|corpcredit|modespec|othercredit - |productname|productnumber|revhistory - %local.docinfo.char.class;"> - -<!ENTITY % local.other.char.class ""> -<!ENTITY % other.char.class - "remark|subscript|superscript %local.other.char.class;"> - -<!ENTITY % local.inlineobj.char.class ""> -<!ENTITY % inlineobj.char.class - "inlinegraphic|inlinemediaobject|inlineequation %local.inlineobj.char.class;"> - -<!-- ...................................................................... --> -<!-- Entities for content models .......................................... --> - -<!ENTITY % formalobject.title.content "title, titleabbrev?"> - -<!-- Redeclaration placeholder ............................................ --> - -<!-- For redeclaring entities that are declared after this point while - retaining their references to the entities that are declared before - this point --> - -<![%dbpool.redecl.module;[ -<!-- Defining rdbpool here makes some buggy XML parsers happy. --> -<!ENTITY % rdbpool ""> -%rdbpool; -<!--end of dbpool.redecl.module-->]]> - -<!-- Object-level mixtures ................................................ --> - -<!-- - list admn line synp para infm form cmpd gen desc -Component mixture X X X X X X X X X X -Sidebar mixture X X X X X X X a X -Footnote mixture X X X X X -Example mixture X X X X X -Highlights mixture X X X -Paragraph mixture X X X X -Admonition mixture X X X X X X b c -Figure mixture X X X -Table entry mixture X X X X d -Glossary def mixture X X X X X e -Legal notice mixture X X X X f - -a. Just Procedure; not Sidebar itself or MsgSet. -b. No MsgSet. -c. No Highlights. -d. Just Graphic; no other informal objects. -e. No Anchor, BridgeHead, or Highlights. -f. Just BlockQuote; no other informal objects. ---> - -<!ENTITY % local.component.mix ""> -<!ENTITY % component.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |%compound.class; - |%genobj.class; |%descobj.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.component.mix;"> - -<!ENTITY % local.sidebar.mix ""> -<!ENTITY % sidebar.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |procedure - |%genobj.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.sidebar.mix;"> - -<!ENTITY % local.qandaset.mix ""> -<!ENTITY % qandaset.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |procedure - |%genobj.class; - |%ndxterm.class; - %forms.hook; - %local.qandaset.mix;"> - -<!ENTITY % local.revdescription.mix ""> -<!ENTITY % revdescription.mix - "%list.class; |%admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |procedure - |%genobj.class; - |%ndxterm.class; - %local.revdescription.mix;"> - -<!ENTITY % local.footnote.mix ""> -<!ENTITY % footnote.mix - "%list.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - %local.footnote.mix;"> - -<!ENTITY % local.example.mix ""> -<!ENTITY % example.mix - "%list.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%ndxterm.class; |beginpage - |procedure - %forms.hook; - %local.example.mix;"> - -<!ENTITY % local.highlights.mix ""> -<!ENTITY % highlights.mix - "%list.class; |%admon.class; - |%para.class; - |%ndxterm.class; - %local.highlights.mix;"> - -<!-- %formal.class; is explicitly excluded from many contexts in which - paragraphs are used --> -<!ENTITY % local.para.mix ""> -<!ENTITY % para.mix - "%list.class; |%admon.class; - |%linespecific.class; - |%informal.class; - |%formal.class; - %local.para.mix;"> - -<!ENTITY % local.admon.mix ""> -<!ENTITY % admon.mix - "%list.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; |procedure|sidebar - |anchor|bridgehead|remark - |%ndxterm.class; |beginpage - %forms.hook; - %local.admon.mix;"> - -<!ENTITY % local.figure.mix ""> -<!ENTITY % figure.mix - "%linespecific.class; |%synop.class; - |%informal.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.figure.mix;"> - -<!ENTITY % local.tabentry.mix ""> -<!ENTITY % tabentry.mix - "%list.class; |%admon.class; - |%linespecific.class; - |%para.class; |graphic|mediaobject - %forms.hook; - %local.tabentry.mix;"> - -<!ENTITY % local.glossdef.mix ""> -<!ENTITY % glossdef.mix - "%list.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%formal.class; - |remark - |%ndxterm.class; |beginpage - %local.glossdef.mix;"> - -<!ENTITY % local.legalnotice.mix ""> -<!ENTITY % legalnotice.mix - "%list.class; |%admon.class; - |%linespecific.class; - |%para.class; |blockquote - |%ndxterm.class; |beginpage - %local.legalnotice.mix;"> - -<!ENTITY % local.textobject.mix ""> -<!ENTITY % textobject.mix - "%list.class; |%admon.class; - |%linespecific.class; - |%para.class; |blockquote - %local.textobject.mix;"> - -<!ENTITY % local.mediaobject.mix ""> -<!ENTITY % mediaobject.mix - "videoobject|audioobject|imageobject|imageobjectco|textobject %local.mediaobject.mix;"> - -<!ENTITY % local.listpreamble.mix ""> -<!ENTITY % listpreamble.mix - " %admon.class; - |%linespecific.class; |%synop.class; - |%para.class; |%informal.class; - |%genobj.class; |%descobj.class; - |%ndxterm.class; |beginpage - %forms.hook; - %local.listpreamble.mix;"> - -<!-- Character-level mixtures ............................................. --> - -<![%sgml.features;[ -<!ENTITY % local.ubiq.mix ""> -<!ENTITY % ubiq.mix "%ndxterm.class;|beginpage %local.ubiq.mix;"> - -<!ENTITY % ubiq.exclusion "-(%ubiq.mix)"> -<!ENTITY % ubiq.inclusion "+(%ubiq.mix)"> - -<!ENTITY % footnote.exclusion "-(footnote|%formal.class;)"> -<!ENTITY % highlights.exclusion "-(%ubiq.mix;|%formal.class;)"> -<!ENTITY % admon.exclusion "-(%admon.class;)"> -<!ENTITY % formal.exclusion "-(%formal.class;)"> -<!ENTITY % acronym.exclusion "-(acronym)"> -<!ENTITY % beginpage.exclusion "-(beginpage)"> -<!ENTITY % ndxterm.exclusion "-(%ndxterm.class;)"> -<!ENTITY % blockquote.exclusion "-(epigraph)"> -<!ENTITY % remark.exclusion "-(remark|%ubiq.mix;)"> -<!ENTITY % glossterm.exclusion "-(glossterm)"> -<!ENTITY % links.exclusion "-(link|olink|ulink|xref|biblioref)"> -]]><!-- sgml.features --> - -<!-- not [sgml.features[ --> -<!ENTITY % local.ubiq.mix ""> -<!ENTITY % ubiq.mix ""> - -<!ENTITY % ubiq.exclusion ""> -<!ENTITY % ubiq.inclusion ""> - -<!ENTITY % footnote.exclusion ""> -<!ENTITY % highlights.exclusion ""> -<!ENTITY % admon.exclusion ""> -<!ENTITY % formal.exclusion ""> -<!ENTITY % acronym.exclusion ""> -<!ENTITY % beginpage.exclusion ""> -<!ENTITY % ndxterm.exclusion ""> -<!ENTITY % blockquote.exclusion ""> -<!ENTITY % remark.exclusion ""> -<!ENTITY % glossterm.exclusion ""> -<!ENTITY % links.exclusion ""> -<!-- ]] not sgml.features --> - -<!-- - #PCD xref word link cptr base dnfo othr inob (synop) -para.char.mix X X X X X X X X X -title.char.mix X X X X X X X X X -ndxterm.char.mix X X X X X X X X a -cptr.char.mix X X X X X a -smallcptr.char.mix X b a -word.char.mix X c X X X a -docinfo.char.mix X d X b X a - -a. Just InlineGraphic; no InlineEquation. -b. Just Replaceable; no other computer terms. -c. Just Emphasis and Trademark; no other word elements. -d. Just Acronym, Emphasis, and Trademark; no other word elements. ---> - -<!ENTITY % local.para.char.mix ""> -<!ENTITY % para.char.mix - "#PCDATA - |%xref.char.class; |%gen.char.class; - |%link.char.class; |%tech.char.class; - |%base.char.class; |%docinfo.char.class; - |%other.char.class; |%inlineobj.char.class; - |%synop.class; - |%ndxterm.class; |beginpage - %forminlines.hook; - %local.para.char.mix;"> - -<!ENTITY % local.title.char.mix ""> -<!ENTITY % title.char.mix - "#PCDATA - |%xref.char.class; |%gen.char.class; - |%link.char.class; |%tech.char.class; - |%base.char.class; |%docinfo.char.class; - |%other.char.class; |%inlineobj.char.class; - |%ndxterm.class; - %local.title.char.mix;"> - -<!ENTITY % local.ndxterm.char.mix ""> -<!ENTITY % ndxterm.char.mix - "#PCDATA - |%xref.char.class; |%gen.char.class; - |%link.char.class; |%tech.char.class; - |%base.char.class; |%docinfo.char.class; - |%other.char.class; |inlinegraphic|inlinemediaobject - %local.ndxterm.char.mix;"> - -<!ENTITY % local.cptr.char.mix ""> -<!ENTITY % cptr.char.mix - "#PCDATA - |%link.char.class; |%tech.char.class; - |%base.char.class; - |%other.char.class; |inlinegraphic|inlinemediaobject - |%ndxterm.class; |beginpage - %local.cptr.char.mix;"> - -<!ENTITY % local.smallcptr.char.mix ""> -<!ENTITY % smallcptr.char.mix - "#PCDATA - |replaceable - |inlinegraphic|inlinemediaobject - |%ndxterm.class; |beginpage - %local.smallcptr.char.mix;"> - -<!ENTITY % local.word.char.mix ""> -<!ENTITY % word.char.mix - "#PCDATA - |acronym|emphasis|trademark - |%link.char.class; - |%base.char.class; - |%other.char.class; |inlinegraphic|inlinemediaobject - |%ndxterm.class; |beginpage - %local.word.char.mix;"> - -<!ENTITY % local.docinfo.char.mix ""> -<!ENTITY % docinfo.char.mix - "#PCDATA - |%link.char.class; - |emphasis|trademark - |replaceable - |%other.char.class; |inlinegraphic|inlinemediaobject - |%ndxterm.class; - %local.docinfo.char.mix;"> -<!--ENTITY % bibliocomponent.mix (see Bibliographic section, below)--> -<!--ENTITY % person.ident.mix (see Bibliographic section, below)--> - -<!-- ...................................................................... --> -<!-- Entities for attributes and attribute components ..................... --> - -<!-- Effectivity attributes ............................................... --> - - -<!-- Arch: Computer or chip architecture to which element applies; no - default --> - -<!ENTITY % arch.attrib - "arch CDATA #IMPLIED"> - -<!-- Condition: General-purpose effectivity attribute --> - -<!ENTITY % condition.attrib - "condition CDATA #IMPLIED"> - -<!-- Conformance: Standards conformance characteristics --> - -<!ENTITY % conformance.attrib - "conformance NMTOKENS #IMPLIED"> - - -<!-- OS: Operating system to which element applies; no default --> - -<!ENTITY % os.attrib - "os CDATA #IMPLIED"> - - -<!-- Revision: Editorial revision to which element belongs; no default --> - -<!ENTITY % revision.attrib - "revision CDATA #IMPLIED"> - -<!-- Security: Security classification; no default --> - -<!ENTITY % security.attrib - "security CDATA #IMPLIED"> - -<!-- UserLevel: Level of user experience to which element applies; no - default --> - -<!ENTITY % userlevel.attrib - "userlevel CDATA #IMPLIED"> - -<!-- Vendor: Computer vendor to which element applies; no default --> - -<!ENTITY % vendor.attrib - "vendor CDATA #IMPLIED"> - -<!-- Wordsize: Computer word size (32 bit, 64 bit, etc.); no default --> - -<!ENTITY % wordsize.attrib - "wordsize CDATA #IMPLIED"> - -<!ENTITY % local.effectivity.attrib ""> -<!ENTITY % effectivity.attrib - "%arch.attrib; - %condition.attrib; - %conformance.attrib; - %os.attrib; - %revision.attrib; - %security.attrib; - %userlevel.attrib; - %vendor.attrib; - %wordsize.attrib; - %local.effectivity.attrib;" -> - -<!-- Common attributes .................................................... --> - - -<!-- Id: Unique identifier of element; no default --> - -<!ENTITY % id.attrib - "id ID #IMPLIED"> - - -<!-- Id: Unique identifier of element; a value must be supplied; no - default --> - -<!ENTITY % idreq.attrib - "id ID #REQUIRED"> - - -<!-- Lang: Indicator of language in which element is written, for - translation, character set management, etc.; no default --> - -<!ENTITY % lang.attrib - "lang CDATA #IMPLIED"> - - -<!-- Remap: Previous role of element before conversion; no default --> - -<!ENTITY % remap.attrib - "remap CDATA #IMPLIED"> - - -<!-- Role: New role of element in local environment; no default --> - -<!ENTITY % role.attrib - "role CDATA #IMPLIED"> - - -<!-- XRefLabel: Alternate labeling string for XRef text generation; - default is usually title or other appropriate label text already - contained in element --> - -<!ENTITY % xreflabel.attrib - "xreflabel CDATA #IMPLIED"> - - -<!-- RevisionFlag: Revision status of element; default is that element - wasn't revised --> - -<!ENTITY % revisionflag.attrib - "revisionflag (changed - |added - |deleted - |off) #IMPLIED"> - -<!ENTITY % local.common.attrib ""> - -<!-- dir: Bidirectional override --> - -<!ENTITY % dir.attrib - "dir (ltr - |rtl - |lro - |rlo) #IMPLIED"> - -<!-- xml:base: base URI --> - -<![%sgml.features;[ -<!ENTITY % xml-base.attrib ""> -]]> -<!ENTITY % xml-base.attrib - "xml:base CDATA #IMPLIED"> - -<!-- Role is included explicitly on each element --> - -<!ENTITY % common.attrib - "%id.attrib; - %lang.attrib; - %remap.attrib; - %xreflabel.attrib; - %revisionflag.attrib; - %effectivity.attrib; - %dir.attrib; - %xml-base.attrib; - %local.common.attrib;" -> - -<!-- Role is included explicitly on each element --> - -<!ENTITY % idreq.common.attrib - "%idreq.attrib; - %lang.attrib; - %remap.attrib; - %xreflabel.attrib; - %revisionflag.attrib; - %effectivity.attrib; - %dir.attrib; - %xml-base.attrib; - %local.common.attrib;" -> - -<!-- Semi-common attributes and other attribute entities .................. --> - -<!ENTITY % local.graphics.attrib ""> - -<!-- EntityRef: Name of an external entity containing the content - of the graphic --> -<!-- FileRef: Filename, qualified by a pathname if desired, - designating the file containing the content of the graphic --> -<!-- Format: Notation of the element content, if any --> -<!-- SrcCredit: Information about the source of the Graphic --> -<!-- Width: Same as CALS reprowid (desired width) --> -<!-- Depth: Same as CALS reprodep (desired depth) --> -<!-- Align: Same as CALS hplace with 'none' removed; #IMPLIED means - application-specific --> -<!-- Scale: Conflation of CALS hscale and vscale --> -<!-- Scalefit: Same as CALS scalefit --> - -<!ENTITY % graphics.attrib - " - entityref ENTITY #IMPLIED - fileref CDATA #IMPLIED - format (%notation.class;) #IMPLIED - srccredit CDATA #IMPLIED - width CDATA #IMPLIED - contentwidth CDATA #IMPLIED - depth CDATA #IMPLIED - contentdepth CDATA #IMPLIED - align (left - |right - |center) #IMPLIED - valign (top - |middle - |bottom) #IMPLIED - scale CDATA #IMPLIED - scalefit %yesorno.attvals; - #IMPLIED - %local.graphics.attrib;" -> - -<!ENTITY % local.keyaction.attrib ""> - -<!-- Action: Key combination type; default is unspecified if one - child element, Simul if there is more than one; if value is - Other, the OtherAction attribute must have a nonempty value --> -<!-- OtherAction: User-defined key combination type --> - -<!ENTITY % keyaction.attrib - " - action (click - |double-click - |press - |seq - |simul - |other) #IMPLIED - otheraction CDATA #IMPLIED - %local.keyaction.attrib;" -> - - -<!-- Label: Identifying number or string; default is usually the - appropriate number or string autogenerated by a formatter --> - -<!ENTITY % label.attrib - "label CDATA #IMPLIED"> - - -<!-- xml:space: whitespace treatment --> - -<![%sgml.features;[ -<!ENTITY % xml-space.attrib ""> -]]> -<!ENTITY % xml-space.attrib - "xml:space (preserve) #IMPLIED"> - -<!-- Format: whether element is assumed to contain significant white - space --> - -<!ENTITY % linespecific.attrib - "format NOTATION - (linespecific) 'linespecific' - %xml-space.attrib; - linenumbering (numbered|unnumbered) #IMPLIED - continuation (continues|restarts) #IMPLIED - startinglinenumber CDATA #IMPLIED - language CDATA #IMPLIED"> - -<!-- Linkend: link to related information; no default --> - -<!ENTITY % linkend.attrib - "linkend IDREF #IMPLIED"> - - -<!-- Linkend: required link to related information --> - -<!ENTITY % linkendreq.attrib - "linkend IDREF #REQUIRED"> - - -<!-- Linkends: link to one or more sets of related information; no - default --> - -<!ENTITY % linkends.attrib - "linkends IDREFS #IMPLIED"> - - -<!ENTITY % local.mark.attrib ""> -<!ENTITY % mark.attrib - "mark CDATA #IMPLIED - %local.mark.attrib;" -> - - -<!-- MoreInfo: whether element's content has an associated RefEntry --> - -<!ENTITY % moreinfo.attrib - "moreinfo (refentry|none) 'none'"> - - -<!-- Pagenum: number of page on which element appears; no default --> - -<!ENTITY % pagenum.attrib - "pagenum CDATA #IMPLIED"> - -<!ENTITY % local.status.attrib ""> - -<!-- Status: Editorial or publication status of the element - it applies to, such as "in review" or "approved for distribution" --> - -<!ENTITY % status.attrib - "status CDATA #IMPLIED - %local.status.attrib;" -> - - -<!-- Width: width of the longest line in the element to which it - pertains, in number of characters --> - -<!ENTITY % width.attrib - "width CDATA #IMPLIED"> - -<!-- ...................................................................... --> -<!-- Title elements ....................................................... --> - -<!ENTITY % title.module "INCLUDE"> -<![%title.module;[ -<!ENTITY % local.title.attrib ""> -<!ENTITY % title.role.attrib "%role.attrib;"> - -<!ENTITY % title.element "INCLUDE"> -<![%title.element;[ -<!--doc:The text of the title of a section of a document or of a formal block-level element.--> -<!ELEMENT title %ho; (%title.char.mix;)*> -<!--end of title.element-->]]> - -<!ENTITY % title.attlist "INCLUDE"> -<![%title.attlist;[ -<!ATTLIST title - %pagenum.attrib; - %common.attrib; - %title.role.attrib; - %local.title.attrib; -> -<!--end of title.attlist-->]]> -<!--end of title.module-->]]> - -<!ENTITY % titleabbrev.module "INCLUDE"> -<![%titleabbrev.module;[ -<!ENTITY % local.titleabbrev.attrib ""> -<!ENTITY % titleabbrev.role.attrib "%role.attrib;"> - -<!ENTITY % titleabbrev.element "INCLUDE"> -<![%titleabbrev.element;[ -<!--doc:The abbreviation of a Title.--> -<!ELEMENT titleabbrev %ho; (%title.char.mix;)*> -<!--end of titleabbrev.element-->]]> - -<!ENTITY % titleabbrev.attlist "INCLUDE"> -<![%titleabbrev.attlist;[ -<!ATTLIST titleabbrev - %common.attrib; - %titleabbrev.role.attrib; - %local.titleabbrev.attrib; -> -<!--end of titleabbrev.attlist-->]]> -<!--end of titleabbrev.module-->]]> - -<!ENTITY % subtitle.module "INCLUDE"> -<![%subtitle.module;[ -<!ENTITY % local.subtitle.attrib ""> -<!ENTITY % subtitle.role.attrib "%role.attrib;"> - -<!ENTITY % subtitle.element "INCLUDE"> -<![%subtitle.element;[ -<!--doc:The subtitle of a document.--> -<!ELEMENT subtitle %ho; (%title.char.mix;)*> -<!--end of subtitle.element-->]]> - -<!ENTITY % subtitle.attlist "INCLUDE"> -<![%subtitle.attlist;[ -<!ATTLIST subtitle - %common.attrib; - %subtitle.role.attrib; - %local.subtitle.attrib; -> -<!--end of subtitle.attlist-->]]> -<!--end of subtitle.module-->]]> - -<!-- ...................................................................... --> -<!-- Bibliographic entities and elements .................................. --> - -<!-- The bibliographic elements are typically used in the document - hierarchy. They do not appear in content models of information - pool elements. See also the document information elements, - below. --> - -<!ENTITY % local.person.ident.mix ""> -<!ENTITY % person.ident.mix - "honorific|firstname|surname|lineage|othername|affiliation - |authorblurb|contrib %local.person.ident.mix;"> - -<!ENTITY % local.bibliocomponent.mix ""> -<!ENTITY % bibliocomponent.mix - "abbrev|abstract|address|artpagenums|author - |authorgroup|authorinitials|bibliomisc|biblioset - |collab|confgroup|contractnum|contractsponsor - |copyright|corpauthor|corpname|corpcredit|date|edition - |editor|invpartnumber|isbn|issn|issuenum|orgname - |biblioid|citebiblioid|bibliosource|bibliorelation|bibliocoverage - |othercredit|pagenums|printhistory|productname - |productnumber|pubdate|publisher|publishername - |pubsnumber|releaseinfo|revhistory|seriesvolnums - |subtitle|title|titleabbrev|volumenum|citetitle - |personname|%person.ident.mix; - |%ndxterm.class; - %local.bibliocomponent.mix;"> - -<!-- I don't think this is well placed, but it needs to be here because of --> -<!-- the reference to bibliocomponent.mix --> -<!ENTITY % local.info.class ""> -<!ENTITY % info.class - "graphic | mediaobject | legalnotice | modespec - | subjectset | keywordset | itermset | %bibliocomponent.mix; - %local.info.class;"> - - -<!-- BiblioList ........................ --> - -<!ENTITY % bibliolist.module "INCLUDE"> -<![%bibliolist.module;[ -<!ENTITY % local.bibliolist.attrib ""> -<!ENTITY % bibliolist.role.attrib "%role.attrib;"> - -<!ENTITY % bibliolist.element "INCLUDE"> -<![%bibliolist.element;[ -<!--doc:A wrapper for a set of bibliography entries.--> -<!ELEMENT bibliolist %ho; (blockinfo?, (%formalobject.title.content;)?, - (biblioentry|bibliomixed)+)> -<!--end of bibliolist.element-->]]> - -<!ENTITY % bibliolist.attlist "INCLUDE"> -<![%bibliolist.attlist;[ -<!ATTLIST bibliolist - %common.attrib; - %bibliolist.role.attrib; - %local.bibliolist.attrib; -> -<!--end of bibliolist.attlist-->]]> -<!--end of bibliolist.module-->]]> - -<!ENTITY % biblioentry.module "INCLUDE"> -<![%biblioentry.module;[ -<!ENTITY % local.biblioentry.attrib ""> -<!ENTITY % biblioentry.role.attrib "%role.attrib;"> - -<!ENTITY % biblioentry.element "INCLUDE"> -<![%biblioentry.element;[ -<!--doc:An entry in a Bibliography.--> -<!ELEMENT biblioentry %ho; ((articleinfo | (%bibliocomponent.mix;))+) - %ubiq.exclusion;> -<!--end of biblioentry.element-->]]> - -<!ENTITY % biblioentry.attlist "INCLUDE"> -<![%biblioentry.attlist;[ -<!ATTLIST biblioentry - %common.attrib; - %biblioentry.role.attrib; - %local.biblioentry.attrib; -> -<!--end of biblioentry.attlist-->]]> -<!--end of biblioentry.module-->]]> - -<!ENTITY % bibliomixed.module "INCLUDE"> -<![%bibliomixed.module;[ -<!ENTITY % local.bibliomixed.attrib ""> -<!ENTITY % bibliomixed.role.attrib "%role.attrib;"> - -<!ENTITY % bibliomixed.element "INCLUDE"> -<![%bibliomixed.element;[ -<!--doc:An entry in a Bibliography.--> -<!ELEMENT bibliomixed %ho; (#PCDATA | %bibliocomponent.mix; | bibliomset)* - %ubiq.exclusion;> -<!--end of bibliomixed.element-->]]> - -<!ENTITY % bibliomixed.attlist "INCLUDE"> -<![%bibliomixed.attlist;[ -<!ATTLIST bibliomixed - %common.attrib; - %bibliomixed.role.attrib; - %local.bibliomixed.attrib; -> -<!--end of bibliomixed.attlist-->]]> -<!--end of bibliomixed.module-->]]> - -<!ENTITY % articleinfo.module "INCLUDE"> -<![%articleinfo.module;[ -<!ENTITY % local.articleinfo.attrib ""> -<!ENTITY % articleinfo.role.attrib "%role.attrib;"> - -<!ENTITY % articleinfo.element "INCLUDE"> -<![%articleinfo.element;[ -<!--doc:Meta-information for an Article.--> -<!ELEMENT articleinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of articleinfo.element-->]]> - -<!ENTITY % articleinfo.attlist "INCLUDE"> -<![%articleinfo.attlist;[ -<!ATTLIST articleinfo - %common.attrib; - %articleinfo.role.attrib; - %local.articleinfo.attrib; -> -<!--end of articleinfo.attlist-->]]> -<!--end of articleinfo.module-->]]> - -<!ENTITY % biblioset.module "INCLUDE"> -<![%biblioset.module;[ -<!ENTITY % local.biblioset.attrib ""> -<!ENTITY % biblioset.role.attrib "%role.attrib;"> - -<!ENTITY % biblioset.element "INCLUDE"> -<![%biblioset.element;[ -<!--doc:A "raw" container for related bibliographic information.--> -<!ELEMENT biblioset %ho; ((%bibliocomponent.mix;)+) - %ubiq.exclusion;> -<!--end of biblioset.element-->]]> - -<!-- Relation: Relationship of elements contained within BiblioSet --> - - -<!ENTITY % biblioset.attlist "INCLUDE"> -<![%biblioset.attlist;[ -<!ATTLIST biblioset - relation CDATA #IMPLIED - %common.attrib; - %biblioset.role.attrib; - %local.biblioset.attrib; -> -<!--end of biblioset.attlist-->]]> -<!--end of biblioset.module-->]]> - -<!ENTITY % bibliomset.module "INCLUDE"> -<![%bibliomset.module;[ -<!ENTITY % bibliomset.role.attrib "%role.attrib;"> -<!ENTITY % local.bibliomset.attrib ""> - -<!ENTITY % bibliomset.element "INCLUDE"> -<![%bibliomset.element;[ -<!--doc:A "cooked" container for related bibliographic information.--> -<!ELEMENT bibliomset %ho; (#PCDATA | %bibliocomponent.mix; | bibliomset)* - %ubiq.exclusion;> -<!--end of bibliomset.element-->]]> - -<!-- Relation: Relationship of elements contained within BiblioMSet --> - - -<!ENTITY % bibliomset.attlist "INCLUDE"> -<![%bibliomset.attlist;[ -<!ATTLIST bibliomset - relation CDATA #IMPLIED - %common.attrib; - %bibliomset.role.attrib; - %local.bibliomset.attrib; -> -<!--end of bibliomset.attlist-->]]> -<!--end of bibliomset.module-->]]> - -<!ENTITY % bibliomisc.module "INCLUDE"> -<![%bibliomisc.module;[ -<!ENTITY % local.bibliomisc.attrib ""> -<!ENTITY % bibliomisc.role.attrib "%role.attrib;"> - -<!ENTITY % bibliomisc.element "INCLUDE"> -<![%bibliomisc.element;[ -<!--doc:Untyped bibliographic information.--> -<!ELEMENT bibliomisc %ho; (%para.char.mix;)*> -<!--end of bibliomisc.element-->]]> - -<!ENTITY % bibliomisc.attlist "INCLUDE"> -<![%bibliomisc.attlist;[ -<!ATTLIST bibliomisc - %common.attrib; - %bibliomisc.role.attrib; - %local.bibliomisc.attrib; -> -<!--end of bibliomisc.attlist-->]]> -<!--end of bibliomisc.module-->]]> - -<!-- ...................................................................... --> -<!-- Subject, Keyword, and ITermSet elements .............................. --> - -<!ENTITY % subjectset.content.module "INCLUDE"> -<![%subjectset.content.module;[ -<!ENTITY % subjectset.module "INCLUDE"> -<![%subjectset.module;[ -<!ENTITY % local.subjectset.attrib ""> -<!ENTITY % subjectset.role.attrib "%role.attrib;"> - -<!ENTITY % subjectset.element "INCLUDE"> -<![%subjectset.element;[ -<!--doc:A set of terms describing the subject matter of a document.--> -<!ELEMENT subjectset %ho; (subject+)> -<!--end of subjectset.element-->]]> - -<!-- Scheme: Controlled vocabulary employed in SubjectTerms --> - - -<!ENTITY % subjectset.attlist "INCLUDE"> -<![%subjectset.attlist;[ -<!ATTLIST subjectset - scheme NMTOKEN #IMPLIED - %common.attrib; - %subjectset.role.attrib; - %local.subjectset.attrib; -> -<!--end of subjectset.attlist-->]]> -<!--end of subjectset.module-->]]> - -<!ENTITY % subject.module "INCLUDE"> -<![%subject.module;[ -<!ENTITY % local.subject.attrib ""> -<!ENTITY % subject.role.attrib "%role.attrib;"> - -<!ENTITY % subject.element "INCLUDE"> -<![%subject.element;[ -<!--doc:One of a group of terms describing the subject matter of a document.--> -<!ELEMENT subject %ho; (subjectterm+)> -<!--end of subject.element-->]]> - -<!-- Weight: Ranking of this group of SubjectTerms relative - to others, 0 is low, no highest value specified --> - - -<!ENTITY % subject.attlist "INCLUDE"> -<![%subject.attlist;[ -<!ATTLIST subject - weight CDATA #IMPLIED - %common.attrib; - %subject.role.attrib; - %local.subject.attrib; -> -<!--end of subject.attlist-->]]> -<!--end of subject.module-->]]> - -<!ENTITY % subjectterm.module "INCLUDE"> -<![%subjectterm.module;[ -<!ENTITY % local.subjectterm.attrib ""> -<!ENTITY % subjectterm.role.attrib "%role.attrib;"> - -<!ENTITY % subjectterm.element "INCLUDE"> -<![%subjectterm.element;[ -<!--doc:A term in a group of terms describing the subject matter of a document.--> -<!ELEMENT subjectterm %ho; (#PCDATA)> -<!--end of subjectterm.element-->]]> - -<!ENTITY % subjectterm.attlist "INCLUDE"> -<![%subjectterm.attlist;[ -<!ATTLIST subjectterm - %common.attrib; - %subjectterm.role.attrib; - %local.subjectterm.attrib; -> -<!--end of subjectterm.attlist-->]]> -<!--end of subjectterm.module-->]]> -<!--end of subjectset.content.module-->]]> - -<!ENTITY % keywordset.content.module "INCLUDE"> -<![%keywordset.content.module;[ -<!ENTITY % keywordset.module "INCLUDE"> -<![%keywordset.module;[ -<!ENTITY % local.keywordset.attrib ""> -<!ENTITY % keywordset.role.attrib "%role.attrib;"> - -<!ENTITY % keywordset.element "INCLUDE"> -<![%keywordset.element;[ -<!--doc:A set of keywords describing the content of a document.--> -<!ELEMENT keywordset %ho; (keyword+)> -<!--end of keywordset.element-->]]> - -<!ENTITY % keywordset.attlist "INCLUDE"> -<![%keywordset.attlist;[ -<!ATTLIST keywordset - %common.attrib; - %keywordset.role.attrib; - %local.keywordset.attrib; -> -<!--end of keywordset.attlist-->]]> -<!--end of keywordset.module-->]]> - -<!ENTITY % keyword.module "INCLUDE"> -<![%keyword.module;[ -<!ENTITY % local.keyword.attrib ""> -<!ENTITY % keyword.role.attrib "%role.attrib;"> - -<!ENTITY % keyword.element "INCLUDE"> -<![%keyword.element;[ -<!--doc:One of a set of keywords describing the content of a document.--> -<!ELEMENT keyword %ho; (#PCDATA)> -<!--end of keyword.element-->]]> - -<!ENTITY % keyword.attlist "INCLUDE"> -<![%keyword.attlist;[ -<!ATTLIST keyword - %common.attrib; - %keyword.role.attrib; - %local.keyword.attrib; -> -<!--end of keyword.attlist-->]]> -<!--end of keyword.module-->]]> -<!--end of keywordset.content.module-->]]> - -<!ENTITY % itermset.module "INCLUDE"> -<![%itermset.module;[ -<!ENTITY % local.itermset.attrib ""> -<!ENTITY % itermset.role.attrib "%role.attrib;"> - -<!ENTITY % itermset.element "INCLUDE"> -<![%itermset.element;[ -<!--doc:A set of index terms in the meta-information of a document.--> -<!ELEMENT itermset %ho; (indexterm+)> -<!--end of itermset.element-->]]> - -<!ENTITY % itermset.attlist "INCLUDE"> -<![%itermset.attlist;[ -<!ATTLIST itermset - %common.attrib; - %itermset.role.attrib; - %local.itermset.attrib; -> -<!--end of itermset.attlist-->]]> -<!--end of itermset.module-->]]> - -<!-- Bibliographic info for "blocks" --> - -<!ENTITY % blockinfo.module "INCLUDE"> -<![ %blockinfo.module; [ -<!ENTITY % local.blockinfo.attrib ""> -<!ENTITY % blockinfo.role.attrib "%role.attrib;"> - -<!ENTITY % blockinfo.element "INCLUDE"> -<![ %blockinfo.element; [ -<!--doc:Meta-information for a block element.--> -<!ELEMENT blockinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of blockinfo.element-->]]> - -<!ENTITY % blockinfo.attlist "INCLUDE"> -<![ %blockinfo.attlist; [ -<!ATTLIST blockinfo - %common.attrib; - %blockinfo.role.attrib; - %local.blockinfo.attrib; -> -<!--end of blockinfo.attlist-->]]> -<!--end of blockinfo.module-->]]> - -<!-- ...................................................................... --> -<!-- Compound (section-ish) elements ...................................... --> - -<!-- Message set ...................... --> - -<!ENTITY % msgset.content.module "INCLUDE"> -<![%msgset.content.module;[ -<!ENTITY % msgset.module "INCLUDE"> -<![%msgset.module;[ -<!ENTITY % local.msgset.attrib ""> -<!ENTITY % msgset.role.attrib "%role.attrib;"> - -<!ENTITY % msgset.element "INCLUDE"> -<![%msgset.element;[ -<!--doc:A detailed set of messages, usually error messages.--> -<!ELEMENT msgset %ho; (blockinfo?, (%formalobject.title.content;)?, - (msgentry+|simplemsgentry+))> -<!--end of msgset.element-->]]> - -<!ENTITY % msgset.attlist "INCLUDE"> -<![%msgset.attlist;[ -<!ATTLIST msgset - %common.attrib; - %msgset.role.attrib; - %local.msgset.attrib; -> -<!--end of msgset.attlist-->]]> -<!--end of msgset.module-->]]> - -<!ENTITY % msgentry.module "INCLUDE"> -<![%msgentry.module;[ -<!ENTITY % local.msgentry.attrib ""> -<!ENTITY % msgentry.role.attrib "%role.attrib;"> - -<!ENTITY % msgentry.element "INCLUDE"> -<![%msgentry.element;[ -<!--doc:A wrapper for an entry in a message set.--> -<!ELEMENT msgentry %ho; (msg+, msginfo?, msgexplan*)> -<!--end of msgentry.element-->]]> - -<!ENTITY % msgentry.attlist "INCLUDE"> -<![%msgentry.attlist;[ -<!ATTLIST msgentry - %common.attrib; - %msgentry.role.attrib; - %local.msgentry.attrib; -> -<!--end of msgentry.attlist-->]]> -<!--end of msgentry.module-->]]> - -<!ENTITY % simplemsgentry.module "INCLUDE"> -<![ %simplemsgentry.module; [ -<!ENTITY % local.simplemsgentry.attrib ""> -<!ENTITY % simplemsgentry.role.attrib "%role.attrib;"> - -<!ENTITY % simplemsgentry.element "INCLUDE"> -<![ %simplemsgentry.element; [ -<!--doc:A wrapper for a simpler entry in a message set.--> -<!ELEMENT simplemsgentry %ho; (msgtext, msgexplan+)> -<!--end of simplemsgentry.element-->]]> - -<!ENTITY % simplemsgentry.attlist "INCLUDE"> -<![ %simplemsgentry.attlist; [ -<!ATTLIST simplemsgentry - audience CDATA #IMPLIED - level CDATA #IMPLIED - origin CDATA #IMPLIED - %common.attrib; - %simplemsgentry.role.attrib; - %local.simplemsgentry.attrib; -> -<!--end of simplemsgentry.attlist-->]]> -<!--end of simplemsgentry.module-->]]> - -<!ENTITY % msg.module "INCLUDE"> -<![%msg.module;[ -<!ENTITY % local.msg.attrib ""> -<!ENTITY % msg.role.attrib "%role.attrib;"> - -<!ENTITY % msg.element "INCLUDE"> -<![%msg.element;[ -<!--doc:A message in a message set.--> -<!ELEMENT msg %ho; (title?, msgmain, (msgsub | msgrel)*)> -<!--end of msg.element-->]]> - -<!ENTITY % msg.attlist "INCLUDE"> -<![%msg.attlist;[ -<!ATTLIST msg - %common.attrib; - %msg.role.attrib; - %local.msg.attrib; -> -<!--end of msg.attlist-->]]> -<!--end of msg.module-->]]> - -<!ENTITY % msgmain.module "INCLUDE"> -<![%msgmain.module;[ -<!ENTITY % local.msgmain.attrib ""> -<!ENTITY % msgmain.role.attrib "%role.attrib;"> - -<!ENTITY % msgmain.element "INCLUDE"> -<![%msgmain.element;[ -<!--doc:The primary component of a message in a message set.--> -<!ELEMENT msgmain %ho; (title?, msgtext)> -<!--end of msgmain.element-->]]> - -<!ENTITY % msgmain.attlist "INCLUDE"> -<![%msgmain.attlist;[ -<!ATTLIST msgmain - %common.attrib; - %msgmain.role.attrib; - %local.msgmain.attrib; -> -<!--end of msgmain.attlist-->]]> -<!--end of msgmain.module-->]]> - -<!ENTITY % msgsub.module "INCLUDE"> -<![%msgsub.module;[ -<!ENTITY % local.msgsub.attrib ""> -<!ENTITY % msgsub.role.attrib "%role.attrib;"> - -<!ENTITY % msgsub.element "INCLUDE"> -<![%msgsub.element;[ -<!--doc:A subcomponent of a message in a message set.--> -<!ELEMENT msgsub %ho; (title?, msgtext)> -<!--end of msgsub.element-->]]> - -<!ENTITY % msgsub.attlist "INCLUDE"> -<![%msgsub.attlist;[ -<!ATTLIST msgsub - %common.attrib; - %msgsub.role.attrib; - %local.msgsub.attrib; -> -<!--end of msgsub.attlist-->]]> -<!--end of msgsub.module-->]]> - -<!ENTITY % msgrel.module "INCLUDE"> -<![%msgrel.module;[ -<!ENTITY % local.msgrel.attrib ""> -<!ENTITY % msgrel.role.attrib "%role.attrib;"> - -<!ENTITY % msgrel.element "INCLUDE"> -<![%msgrel.element;[ -<!--doc:A related component of a message in a message set.--> -<!ELEMENT msgrel %ho; (title?, msgtext)> -<!--end of msgrel.element-->]]> - -<!ENTITY % msgrel.attlist "INCLUDE"> -<![%msgrel.attlist;[ -<!ATTLIST msgrel - %common.attrib; - %msgrel.role.attrib; - %local.msgrel.attrib; -> -<!--end of msgrel.attlist-->]]> -<!--end of msgrel.module-->]]> - -<!-- MsgText (defined in the Inlines section, below)--> - -<!ENTITY % msginfo.module "INCLUDE"> -<![%msginfo.module;[ -<!ENTITY % local.msginfo.attrib ""> -<!ENTITY % msginfo.role.attrib "%role.attrib;"> - -<!ENTITY % msginfo.element "INCLUDE"> -<![%msginfo.element;[ -<!--doc:Information about a message in a message set.--> -<!ELEMENT msginfo %ho; ((msglevel | msgorig | msgaud)*)> -<!--end of msginfo.element-->]]> - -<!ENTITY % msginfo.attlist "INCLUDE"> -<![%msginfo.attlist;[ -<!ATTLIST msginfo - %common.attrib; - %msginfo.role.attrib; - %local.msginfo.attrib; -> -<!--end of msginfo.attlist-->]]> -<!--end of msginfo.module-->]]> - -<!ENTITY % msglevel.module "INCLUDE"> -<![%msglevel.module;[ -<!ENTITY % local.msglevel.attrib ""> -<!ENTITY % msglevel.role.attrib "%role.attrib;"> - -<!ENTITY % msglevel.element "INCLUDE"> -<![%msglevel.element;[ -<!--doc:The level of importance or severity of a message in a message set.--> -<!ELEMENT msglevel %ho; (%smallcptr.char.mix;)*> -<!--end of msglevel.element-->]]> - -<!ENTITY % msglevel.attlist "INCLUDE"> -<![%msglevel.attlist;[ -<!ATTLIST msglevel - %common.attrib; - %msglevel.role.attrib; - %local.msglevel.attrib; -> -<!--end of msglevel.attlist-->]]> -<!--end of msglevel.module-->]]> - -<!ENTITY % msgorig.module "INCLUDE"> -<![%msgorig.module;[ -<!ENTITY % local.msgorig.attrib ""> -<!ENTITY % msgorig.role.attrib "%role.attrib;"> - -<!ENTITY % msgorig.element "INCLUDE"> -<![%msgorig.element;[ -<!--doc:The origin of a message in a message set.--> -<!ELEMENT msgorig %ho; (%smallcptr.char.mix;)*> -<!--end of msgorig.element-->]]> - -<!ENTITY % msgorig.attlist "INCLUDE"> -<![%msgorig.attlist;[ -<!ATTLIST msgorig - %common.attrib; - %msgorig.role.attrib; - %local.msgorig.attrib; -> -<!--end of msgorig.attlist-->]]> -<!--end of msgorig.module-->]]> - -<!ENTITY % msgaud.module "INCLUDE"> -<![%msgaud.module;[ -<!ENTITY % local.msgaud.attrib ""> -<!ENTITY % msgaud.role.attrib "%role.attrib;"> - -<!ENTITY % msgaud.element "INCLUDE"> -<![%msgaud.element;[ -<!--doc:The audience to which a message in a message set is relevant.--> -<!ELEMENT msgaud %ho; (%para.char.mix;)*> -<!--end of msgaud.element-->]]> - -<!ENTITY % msgaud.attlist "INCLUDE"> -<![%msgaud.attlist;[ -<!ATTLIST msgaud - %common.attrib; - %msgaud.role.attrib; - %local.msgaud.attrib; -> -<!--end of msgaud.attlist-->]]> -<!--end of msgaud.module-->]]> - -<!ENTITY % msgexplan.module "INCLUDE"> -<![%msgexplan.module;[ -<!ENTITY % local.msgexplan.attrib ""> -<!ENTITY % msgexplan.role.attrib "%role.attrib;"> - -<!ENTITY % msgexplan.element "INCLUDE"> -<![%msgexplan.element;[ -<!--doc:Explanatory material relating to a message in a message set.--> -<!ELEMENT msgexplan %ho; (title?, (%component.mix;)+)> -<!--end of msgexplan.element-->]]> - -<!ENTITY % msgexplan.attlist "INCLUDE"> -<![%msgexplan.attlist;[ -<!ATTLIST msgexplan - %common.attrib; - %msgexplan.role.attrib; - %local.msgexplan.attrib; -> -<!--end of msgexplan.attlist-->]]> -<!--end of msgexplan.module-->]]> -<!--end of msgset.content.module-->]]> - -<!ENTITY % task.content.module "INCLUDE"> -<![%task.content.module;[ -<!ENTITY % task.module "INCLUDE"> -<![%task.module;[ -<!ENTITY % local.task.attrib ""> -<!ENTITY % task.role.attrib "%role.attrib;"> - -<!ENTITY % task.element "INCLUDE"> -<![%task.element;[ -<!--doc:A task to be completed.--> -<!ELEMENT task %ho; (blockinfo?,(%ndxterm.class;)*, - (%formalobject.title.content;), - tasksummary?, - taskprerequisites?, - procedure, - example*, - taskrelated?)> -<!--end of task.element-->]]> - -<!ENTITY % task.attlist "INCLUDE"> -<![%task.attlist;[ -<!ATTLIST task - %common.attrib; - %task.role.attrib; - %local.task.attrib; -> -<!--end of task.attlist-->]]> -<!--end of task.module-->]]> - -<!ENTITY % tasksummary.module "INCLUDE"> -<![%tasksummary.module;[ -<!ENTITY % local.tasksummary.attrib ""> -<!ENTITY % tasksummary.role.attrib "%role.attrib;"> - -<!ENTITY % tasksummary.element "INCLUDE"> -<![%tasksummary.element;[ -<!--doc:A summary of a task.--> -<!ELEMENT tasksummary %ho; (blockinfo?, - (%formalobject.title.content;)?, - (%component.mix;)+)> -<!--end of tasksummary.element-->]]> - -<!ENTITY % tasksummary.attlist "INCLUDE"> -<![%tasksummary.attlist;[ -<!ATTLIST tasksummary - %common.attrib; - %tasksummary.role.attrib; - %local.tasksummary.attrib; -> -<!--end of tasksummary.attlist-->]]> -<!--end of tasksummary.module-->]]> - -<!ENTITY % taskprerequisites.module "INCLUDE"> -<![%taskprerequisites.module;[ -<!ENTITY % local.taskprerequisites.attrib ""> -<!ENTITY % taskprerequisites.role.attrib "%role.attrib;"> - -<!ENTITY % taskprerequisites.element "INCLUDE"> -<![%taskprerequisites.element;[ -<!--doc:The prerequisites for a task.--> -<!ELEMENT taskprerequisites %ho; (blockinfo?, - (%formalobject.title.content;)?, - (%component.mix;)+)> -<!--end of taskprerequisites.element-->]]> - -<!ENTITY % taskprerequisites.attlist "INCLUDE"> -<![%taskprerequisites.attlist;[ -<!ATTLIST taskprerequisites - %common.attrib; - %taskprerequisites.role.attrib; - %local.taskprerequisites.attrib; -> -<!--end of taskprerequisites.attlist-->]]> -<!--end of taskprerequisites.module-->]]> - -<!ENTITY % taskrelated.module "INCLUDE"> -<![%taskrelated.module;[ -<!ENTITY % local.taskrelated.attrib ""> -<!ENTITY % taskrelated.role.attrib "%role.attrib;"> - -<!ENTITY % taskrelated.element "INCLUDE"> -<![%taskrelated.element;[ -<!--doc:Information related to a task.--> -<!ELEMENT taskrelated %ho; (blockinfo?, - (%formalobject.title.content;)?, - (%component.mix;)+)> -<!--end of taskrelated.element-->]]> - -<!ENTITY % taskrelated.attlist "INCLUDE"> -<![%taskrelated.attlist;[ -<!ATTLIST taskrelated - %common.attrib; - %taskrelated.role.attrib; - %local.taskrelated.attrib; -> -<!--end of taskrelated.attlist-->]]> -<!--end of taskrelated.module-->]]> -<!--end of task.content.module-->]]> - -<!-- QandASet ........................ --> -<!ENTITY % qandaset.content.module "INCLUDE"> -<![ %qandaset.content.module; [ -<!ENTITY % qandaset.module "INCLUDE"> -<![ %qandaset.module; [ -<!ENTITY % local.qandaset.attrib ""> -<!ENTITY % qandaset.role.attrib "%role.attrib;"> - -<!ENTITY % qandaset.element "INCLUDE"> -<![ %qandaset.element; [ -<!--doc:A question-and-answer set.--> -<!ELEMENT qandaset %ho; (blockinfo?, (%formalobject.title.content;)?, - (%qandaset.mix;)*, - (qandadiv+|qandaentry+))> -<!--end of qandaset.element-->]]> - -<!ENTITY % qandaset.attlist "INCLUDE"> -<![ %qandaset.attlist; [ -<!ATTLIST qandaset - defaultlabel (qanda|number|none) #IMPLIED - %common.attrib; - %qandaset.role.attrib; - %local.qandaset.attrib;> -<!--end of qandaset.attlist-->]]> -<!--end of qandaset.module-->]]> - -<!ENTITY % qandadiv.module "INCLUDE"> -<![ %qandadiv.module; [ -<!ENTITY % local.qandadiv.attrib ""> -<!ENTITY % qandadiv.role.attrib "%role.attrib;"> - -<!ENTITY % qandadiv.element "INCLUDE"> -<![ %qandadiv.element; [ -<!--doc:A titled division in a QandASet.--> -<!ELEMENT qandadiv %ho; (blockinfo?, (%formalobject.title.content;)?, - (%qandaset.mix;)*, - (qandadiv+|qandaentry+))> -<!--end of qandadiv.element-->]]> - -<!ENTITY % qandadiv.attlist "INCLUDE"> -<![ %qandadiv.attlist; [ -<!ATTLIST qandadiv - %common.attrib; - %qandadiv.role.attrib; - %local.qandadiv.attrib;> -<!--end of qandadiv.attlist-->]]> -<!--end of qandadiv.module-->]]> - -<!ENTITY % qandaentry.module "INCLUDE"> -<![ %qandaentry.module; [ -<!ENTITY % local.qandaentry.attrib ""> -<!ENTITY % qandaentry.role.attrib "%role.attrib;"> - -<!ENTITY % qandaentry.element "INCLUDE"> -<![ %qandaentry.element; [ -<!--doc:A question/answer set within a QandASet.--> -<!ELEMENT qandaentry %ho; (blockinfo?, revhistory?, question, answer*)> -<!--end of qandaentry.element-->]]> - -<!ENTITY % qandaentry.attlist "INCLUDE"> -<![ %qandaentry.attlist; [ -<!ATTLIST qandaentry - %common.attrib; - %qandaentry.role.attrib; - %local.qandaentry.attrib;> -<!--end of qandaentry.attlist-->]]> -<!--end of qandaentry.module-->]]> - -<!ENTITY % question.module "INCLUDE"> -<![ %question.module; [ -<!ENTITY % local.question.attrib ""> -<!ENTITY % question.role.attrib "%role.attrib;"> - -<!ENTITY % question.element "INCLUDE"> -<![ %question.element; [ -<!--doc:A question in a QandASet.--> -<!ELEMENT question %ho; (label?, (%qandaset.mix;)+)> -<!--end of question.element-->]]> - -<!ENTITY % question.attlist "INCLUDE"> -<![ %question.attlist; [ -<!ATTLIST question - %common.attrib; - %question.role.attrib; - %local.question.attrib; -> -<!--end of question.attlist-->]]> -<!--end of question.module-->]]> - -<!ENTITY % answer.module "INCLUDE"> -<![ %answer.module; [ -<!ENTITY % local.answer.attrib ""> -<!ENTITY % answer.role.attrib "%role.attrib;"> - -<!ENTITY % answer.element "INCLUDE"> -<![ %answer.element; [ -<!--doc:An answer to a question posed in a QandASet.--> -<!ELEMENT answer %ho; (label?, (%qandaset.mix;)*, qandaentry*)> -<!--end of answer.element-->]]> - -<!ENTITY % answer.attlist "INCLUDE"> -<![ %answer.attlist; [ -<!ATTLIST answer - %common.attrib; - %answer.role.attrib; - %local.answer.attrib; -> -<!--end of answer.attlist-->]]> -<!--end of answer.module-->]]> - -<!ENTITY % label.module "INCLUDE"> -<![ %label.module; [ -<!ENTITY % local.label.attrib ""> -<!ENTITY % label.role.attrib "%role.attrib;"> - -<!ENTITY % label.element "INCLUDE"> -<![ %label.element; [ -<!--doc:A label on a Question or Answer.--> -<!ELEMENT label %ho; (%word.char.mix;)*> -<!--end of label.element-->]]> - -<!ENTITY % label.attlist "INCLUDE"> -<![ %label.attlist; [ -<!ATTLIST label - %common.attrib; - %label.role.attrib; - %local.label.attrib; -> -<!--end of label.attlist-->]]> -<!--end of label.module-->]]> -<!--end of qandaset.content.module-->]]> - -<!-- Procedure ........................ --> - -<!ENTITY % procedure.content.module "INCLUDE"> -<![%procedure.content.module;[ -<!ENTITY % procedure.module "INCLUDE"> -<![%procedure.module;[ -<!ENTITY % local.procedure.attrib ""> -<!ENTITY % procedure.role.attrib "%role.attrib;"> - -<!ENTITY % procedure.element "INCLUDE"> -<![%procedure.element;[ -<!--doc:A list of operations to be performed in a well-defined sequence.--> -<!ELEMENT procedure %ho; (blockinfo?, (%formalobject.title.content;)?, - (%component.mix;)*, step+)> -<!--end of procedure.element-->]]> - -<!ENTITY % procedure.attlist "INCLUDE"> -<![%procedure.attlist;[ -<!ATTLIST procedure - %common.attrib; - %procedure.role.attrib; - %local.procedure.attrib; -> -<!--end of procedure.attlist-->]]> -<!--end of procedure.module-->]]> - -<!ENTITY % step.module "INCLUDE"> -<![%step.module;[ -<!ENTITY % local.step.attrib ""> -<!ENTITY % step.role.attrib "%role.attrib;"> - -<!ENTITY % step.element "INCLUDE"> -<![%step.element;[ -<!--doc:A unit of action in a procedure.--> -<!ELEMENT step %ho; (title?, (((%component.mix;)+, ((substeps|stepalternatives), (%component.mix;)*)?) - | ((substeps|stepalternatives), (%component.mix;)*)))> -<!--end of step.element-->]]> - -<!-- Performance: Whether the Step must be performed --> -<!-- not #REQUIRED! --> - - -<!ENTITY % step.attlist "INCLUDE"> -<![%step.attlist;[ -<!ATTLIST step - performance (optional - |required) "required" - %common.attrib; - %step.role.attrib; - %local.step.attrib; -> -<!--end of step.attlist-->]]> -<!--end of step.module-->]]> - -<!ENTITY % substeps.module "INCLUDE"> -<![%substeps.module;[ -<!ENTITY % local.substeps.attrib ""> -<!ENTITY % substeps.role.attrib "%role.attrib;"> - -<!ENTITY % substeps.element "INCLUDE"> -<![%substeps.element;[ -<!--doc:A wrapper for steps that occur within steps in a procedure.--> -<!ELEMENT substeps %ho; (step+)> -<!--end of substeps.element-->]]> - -<!-- Performance: whether entire set of substeps must be performed --> -<!-- not #REQUIRED! --> - -<!ENTITY % substeps.attlist "INCLUDE"> -<![%substeps.attlist;[ -<!ATTLIST substeps - performance (optional - |required) "required" - %common.attrib; - %substeps.role.attrib; - %local.substeps.attrib; -> -<!--end of substeps.attlist-->]]> -<!--end of substeps.module-->]]> - -<!ENTITY % stepalternatives.module "INCLUDE"> -<![%stepalternatives.module;[ -<!ENTITY % local.stepalternatives.attrib ""> -<!ENTITY % stepalternatives.role.attrib "%role.attrib;"> - -<!ENTITY % stepalternatives.element "INCLUDE"> -<![%stepalternatives.element;[ -<!--doc:Alternative steps in a procedure.--> -<!ELEMENT stepalternatives %ho; (step+)> -<!--end of stepalternatives.element-->]]> - -<!-- Performance: Whether (one of) the alternatives must be performed --> -<!-- not #REQUIRED! --> - -<!ENTITY % stepalternatives.attlist "INCLUDE"> -<![%stepalternatives.attlist;[ -<!ATTLIST stepalternatives - performance (optional - |required) "required" - %common.attrib; - %stepalternatives.role.attrib; - %local.stepalternatives.attrib; -> -<!--end of stepalternatives.attlist-->]]> -<!--end of stepalternatives.module-->]]> -<!--end of procedure.content.module-->]]> - -<!-- Sidebar .......................... --> - -<!ENTITY % sidebar.content.model "INCLUDE"> -<![ %sidebar.content.model; [ - -<!ENTITY % sidebarinfo.module "INCLUDE"> -<![ %sidebarinfo.module; [ -<!ENTITY % local.sidebarinfo.attrib ""> -<!ENTITY % sidebarinfo.role.attrib "%role.attrib;"> - -<!ENTITY % sidebarinfo.element "INCLUDE"> -<![ %sidebarinfo.element; [ -<!--doc:Meta-information for a Sidebar.--> -<!ELEMENT sidebarinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of sidebarinfo.element-->]]> - -<!ENTITY % sidebarinfo.attlist "INCLUDE"> -<![ %sidebarinfo.attlist; [ -<!ATTLIST sidebarinfo - %common.attrib; - %sidebarinfo.role.attrib; - %local.sidebarinfo.attrib; -> -<!--end of sidebarinfo.attlist-->]]> -<!--end of sidebarinfo.module-->]]> - -<!ENTITY % sidebar.module "INCLUDE"> -<![%sidebar.module;[ -<!ENTITY % local.sidebar.attrib ""> -<!ENTITY % sidebar.role.attrib "%role.attrib;"> - -<!ENTITY % sidebar.element "INCLUDE"> -<![%sidebar.element;[ -<!--doc:A portion of a document that is isolated from the main narrative flow.--> -<!ELEMENT sidebar %ho; (sidebarinfo?, - (%formalobject.title.content;)?, - (%sidebar.mix;)+)> -<!--end of sidebar.element-->]]> - -<!ENTITY % sidebar.attlist "INCLUDE"> -<![%sidebar.attlist;[ -<!ATTLIST sidebar - %common.attrib; - %sidebar.role.attrib; - %local.sidebar.attrib; -> -<!--end of sidebar.attlist-->]]> -<!--end of sidebar.module-->]]> -<!--end of sidebar.content.model-->]]> - -<!-- ...................................................................... --> -<!-- Paragraph-related elements ........................................... --> - -<!ENTITY % abstract.module "INCLUDE"> -<![%abstract.module;[ -<!ENTITY % local.abstract.attrib ""> -<!ENTITY % abstract.role.attrib "%role.attrib;"> - -<!ENTITY % abstract.element "INCLUDE"> -<![%abstract.element;[ -<!--doc:A summary.--> -<!ELEMENT abstract %ho; (title?, (%para.class;)+)> -<!--end of abstract.element-->]]> - -<!ENTITY % abstract.attlist "INCLUDE"> -<![%abstract.attlist;[ -<!ATTLIST abstract - %common.attrib; - %abstract.role.attrib; - %local.abstract.attrib; -> -<!--end of abstract.attlist-->]]> -<!--end of abstract.module-->]]> - -<!ENTITY % authorblurb.module "INCLUDE"> -<![%authorblurb.module;[ -<!ENTITY % local.authorblurb.attrib ""> -<!ENTITY % authorblurb.role.attrib "%role.attrib;"> - -<!ENTITY % authorblurb.element "INCLUDE"> -<![%authorblurb.element;[ -<!--doc:A short description or note about an author.--> -<!ELEMENT authorblurb %ho; (title?, (%para.class;)+)> -<!--end of authorblurb.element-->]]> - -<!ENTITY % authorblurb.attlist "INCLUDE"> -<![%authorblurb.attlist;[ -<!ATTLIST authorblurb - %common.attrib; - %authorblurb.role.attrib; - %local.authorblurb.attrib; -> -<!--end of authorblurb.attlist-->]]> -<!--end of authorblurb.module-->]]> - -<!ENTITY % personblurb.module "INCLUDE"> -<![%personblurb.module;[ -<!ENTITY % local.personblurb.attrib ""> -<!ENTITY % personblurb.role.attrib "%role.attrib;"> - -<!ENTITY % personblurb.element "INCLUDE"> -<![%personblurb.element;[ -<!--doc:A short description or note about a person.--> -<!ELEMENT personblurb %ho; (title?, (%para.class;)+)> -<!--end of personblurb.element-->]]> - -<!ENTITY % personblurb.attlist "INCLUDE"> -<![%personblurb.attlist;[ -<!ATTLIST personblurb - %common.attrib; - %personblurb.role.attrib; - %local.personblurb.attrib; -> -<!--end of personblurb.attlist-->]]> -<!--end of personblurb.module-->]]> - -<!ENTITY % blockquote.module "INCLUDE"> -<![%blockquote.module;[ - -<!ENTITY % local.blockquote.attrib ""> -<!ENTITY % blockquote.role.attrib "%role.attrib;"> - -<!ENTITY % blockquote.element "INCLUDE"> -<![%blockquote.element;[ -<!--doc:A quotation set off from the main text.--> -<!ELEMENT blockquote %ho; (blockinfo?, title?, attribution?, (%component.mix;)+) - %blockquote.exclusion;> -<!--end of blockquote.element-->]]> - -<!ENTITY % blockquote.attlist "INCLUDE"> -<![%blockquote.attlist;[ -<!ATTLIST blockquote - %common.attrib; - %blockquote.role.attrib; - %local.blockquote.attrib; -> -<!--end of blockquote.attlist-->]]> -<!--end of blockquote.module-->]]> - -<!ENTITY % attribution.module "INCLUDE"> -<![%attribution.module;[ -<!ENTITY % local.attribution.attrib ""> -<!ENTITY % attribution.role.attrib "%role.attrib;"> - -<!ENTITY % attribution.element "INCLUDE"> -<![%attribution.element;[ -<!--doc:The source of a block quote or epigraph.--> -<!ELEMENT attribution %ho; (%para.char.mix;)*> -<!--end of attribution.element-->]]> - -<!ENTITY % attribution.attlist "INCLUDE"> -<![%attribution.attlist;[ -<!ATTLIST attribution - %common.attrib; - %attribution.role.attrib; - %local.attribution.attrib; -> -<!--end of attribution.attlist-->]]> -<!--end of attribution.module-->]]> - -<!ENTITY % bridgehead.module "INCLUDE"> -<![%bridgehead.module;[ -<!ENTITY % local.bridgehead.attrib ""> -<!ENTITY % bridgehead.role.attrib "%role.attrib;"> - -<!ENTITY % bridgehead.element "INCLUDE"> -<![%bridgehead.element;[ -<!--doc:A free-floating heading.--> -<!ELEMENT bridgehead %ho; (%title.char.mix;)*> -<!--end of bridgehead.element-->]]> - -<!-- Renderas: Indicates the format in which the BridgeHead - should appear --> - - -<!ENTITY % bridgehead.attlist "INCLUDE"> -<![%bridgehead.attlist;[ -<!ATTLIST bridgehead - renderas (other - |sect1 - |sect2 - |sect3 - |sect4 - |sect5) #IMPLIED - %common.attrib; - %bridgehead.role.attrib; - %local.bridgehead.attrib; -> -<!--end of bridgehead.attlist-->]]> -<!--end of bridgehead.module-->]]> - -<!ENTITY % remark.module "INCLUDE"> -<![%remark.module;[ -<!ENTITY % local.remark.attrib ""> -<!ENTITY % remark.role.attrib "%role.attrib;"> - -<!ENTITY % remark.element "INCLUDE"> -<![%remark.element;[ -<!--doc:A remark (or comment) intended for presentation in a draft manuscript.--> -<!ELEMENT remark %ho; (%para.char.mix;)* - %remark.exclusion;> -<!--end of remark.element-->]]> - -<!ENTITY % remark.attlist "INCLUDE"> -<![%remark.attlist;[ -<!ATTLIST remark - %common.attrib; - %remark.role.attrib; - %local.remark.attrib; -> -<!--end of remark.attlist-->]]> -<!--end of remark.module-->]]> - -<!ENTITY % epigraph.module "INCLUDE"> -<![%epigraph.module;[ -<!ENTITY % local.epigraph.attrib ""> -<!ENTITY % epigraph.role.attrib "%role.attrib;"> - -<!ENTITY % epigraph.element "INCLUDE"> -<![%epigraph.element;[ -<!--doc:A short inscription at the beginning of a document or component.--> -<!ELEMENT epigraph %ho; (attribution?, ((%para.class;)|literallayout)+)> -<!--end of epigraph.element-->]]> - -<!ENTITY % epigraph.attlist "INCLUDE"> -<![%epigraph.attlist;[ -<!ATTLIST epigraph - %common.attrib; - %epigraph.role.attrib; - %local.epigraph.attrib; -> -<!--end of epigraph.attlist-->]]> -<!-- Attribution (defined above)--> -<!--end of epigraph.module-->]]> - -<!ENTITY % footnote.module "INCLUDE"> -<![%footnote.module;[ -<!ENTITY % local.footnote.attrib ""> -<!ENTITY % footnote.role.attrib "%role.attrib;"> - -<!ENTITY % footnote.element "INCLUDE"> -<![%footnote.element;[ -<!--doc:A footnote.--> -<!ELEMENT footnote %ho; ((%footnote.mix;)+) - %footnote.exclusion;> -<!--end of footnote.element-->]]> - -<!ENTITY % footnote.attlist "INCLUDE"> -<![%footnote.attlist;[ -<!ATTLIST footnote - %label.attrib; - %common.attrib; - %footnote.role.attrib; - %local.footnote.attrib; -> -<!--end of footnote.attlist-->]]> -<!--end of footnote.module-->]]> - -<!ENTITY % highlights.module "INCLUDE"> -<![%highlights.module;[ -<!ENTITY % local.highlights.attrib ""> -<!ENTITY % highlights.role.attrib "%role.attrib;"> - -<!ENTITY % highlights.element "INCLUDE"> -<![%highlights.element;[ -<!--doc:A summary of the main points of the discussed component.--> -<!ELEMENT highlights %ho; ((%highlights.mix;)+) - %highlights.exclusion;> -<!--end of highlights.element-->]]> - -<!ENTITY % highlights.attlist "INCLUDE"> -<![%highlights.attlist;[ -<!ATTLIST highlights - %common.attrib; - %highlights.role.attrib; - %local.highlights.attrib; -> -<!--end of highlights.attlist-->]]> -<!--end of highlights.module-->]]> - -<!ENTITY % formalpara.module "INCLUDE"> -<![%formalpara.module;[ -<!ENTITY % local.formalpara.attrib ""> -<!ENTITY % formalpara.role.attrib "%role.attrib;"> - -<!ENTITY % formalpara.element "INCLUDE"> -<![%formalpara.element;[ -<!--doc:A paragraph with a title.--> -<!ELEMENT formalpara %ho; (title, (%ndxterm.class;)*, para)> -<!--end of formalpara.element-->]]> - -<!ENTITY % formalpara.attlist "INCLUDE"> -<![%formalpara.attlist;[ -<!ATTLIST formalpara - %common.attrib; - %formalpara.role.attrib; - %local.formalpara.attrib; -> -<!--end of formalpara.attlist-->]]> -<!--end of formalpara.module-->]]> - -<!ENTITY % para.module "INCLUDE"> -<![%para.module;[ -<!ENTITY % local.para.attrib ""> -<!ENTITY % para.role.attrib "%role.attrib;"> - -<!ENTITY % para.element "INCLUDE"> -<![%para.element;[ -<!--doc:A paragraph.--> -<!ELEMENT para %ho; (%para.char.mix; | %para.mix;)*> -<!--end of para.element-->]]> - -<!ENTITY % para.attlist "INCLUDE"> -<![%para.attlist;[ -<!ATTLIST para - %common.attrib; - %para.role.attrib; - %local.para.attrib; -> -<!--end of para.attlist-->]]> -<!--end of para.module-->]]> - -<!ENTITY % simpara.module "INCLUDE"> -<![%simpara.module;[ -<!ENTITY % local.simpara.attrib ""> -<!ENTITY % simpara.role.attrib "%role.attrib;"> - -<!ENTITY % simpara.element "INCLUDE"> -<![%simpara.element;[ -<!--doc:A paragraph that contains only text and inline markup, no block elements.--> -<!ELEMENT simpara %ho; (%para.char.mix;)*> -<!--end of simpara.element-->]]> - -<!ENTITY % simpara.attlist "INCLUDE"> -<![%simpara.attlist;[ -<!ATTLIST simpara - %common.attrib; - %simpara.role.attrib; - %local.simpara.attrib; -> -<!--end of simpara.attlist-->]]> -<!--end of simpara.module-->]]> - -<!ENTITY % admon.module "INCLUDE"> -<![%admon.module;[ -<!ENTITY % local.admon.attrib ""> -<!ENTITY % admon.role.attrib "%role.attrib;"> - - -<!ENTITY % caution.element "INCLUDE"> -<![%caution.element;[ -<!--doc:A note of caution.--> -<!ELEMENT caution %ho; (title?, (%admon.mix;)+) - %admon.exclusion;> -<!--end of caution.element-->]]> - -<!ENTITY % caution.attlist "INCLUDE"> -<![%caution.attlist;[ -<!ATTLIST caution - %common.attrib; - %admon.role.attrib; - %local.admon.attrib; -> -<!--end of caution.attlist-->]]> - - -<!ENTITY % important.element "INCLUDE"> -<![%important.element;[ -<!--doc:An admonition set off from the text.--> -<!ELEMENT important %ho; (title?, (%admon.mix;)+) - %admon.exclusion;> -<!--end of important.element-->]]> - -<!ENTITY % important.attlist "INCLUDE"> -<![%important.attlist;[ -<!ATTLIST important - %common.attrib; - %admon.role.attrib; - %local.admon.attrib; -> -<!--end of important.attlist-->]]> - - -<!ENTITY % note.element "INCLUDE"> -<![%note.element;[ -<!--doc:A message set off from the text.--> -<!ELEMENT note %ho; (title?, (%admon.mix;)+) - %admon.exclusion;> -<!--end of note.element-->]]> - -<!ENTITY % note.attlist "INCLUDE"> -<![%note.attlist;[ -<!ATTLIST note - %common.attrib; - %admon.role.attrib; - %local.admon.attrib; -> -<!--end of note.attlist-->]]> - -<!ENTITY % tip.element "INCLUDE"> -<![%tip.element;[ -<!--doc:A suggestion to the user, set off from the text.--> -<!ELEMENT tip %ho; (title?, (%admon.mix;)+) - %admon.exclusion;> -<!--end of tip.element-->]]> - -<!ENTITY % tip.attlist "INCLUDE"> -<![%tip.attlist;[ -<!ATTLIST tip - %common.attrib; - %admon.role.attrib; - %local.admon.attrib; -> -<!--end of tip.attlist-->]]> - - -<!ENTITY % warning.element "INCLUDE"> -<![%warning.element;[ -<!--doc:An admonition set off from the text.--> -<!ELEMENT warning %ho; (title?, (%admon.mix;)+) - %admon.exclusion;> -<!--end of warning.element-->]]> - -<!ENTITY % warning.attlist "INCLUDE"> -<![%warning.attlist;[ -<!ATTLIST warning - %common.attrib; - %admon.role.attrib; - %local.admon.attrib; -> -<!--end of warning.attlist-->]]> - -<!--end of admon.module-->]]> - -<!-- ...................................................................... --> -<!-- Lists ................................................................ --> - -<!-- GlossList ........................ --> - -<!ENTITY % glosslist.module "INCLUDE"> -<![%glosslist.module;[ -<!ENTITY % local.glosslist.attrib ""> -<!ENTITY % glosslist.role.attrib "%role.attrib;"> - -<!ENTITY % glosslist.element "INCLUDE"> -<![%glosslist.element;[ -<!--doc:A wrapper for a set of GlossEntrys.--> -<!ELEMENT glosslist %ho; (blockinfo?, (%formalobject.title.content;)?, glossentry+)> -<!--end of glosslist.element-->]]> - -<!ENTITY % glosslist.attlist "INCLUDE"> -<![%glosslist.attlist;[ -<!ATTLIST glosslist - %common.attrib; - %glosslist.role.attrib; - %local.glosslist.attrib; -> -<!--end of glosslist.attlist-->]]> -<!--end of glosslist.module-->]]> - -<!ENTITY % glossentry.content.module "INCLUDE"> -<![%glossentry.content.module;[ -<!ENTITY % glossentry.module "INCLUDE"> -<![%glossentry.module;[ -<!ENTITY % local.glossentry.attrib ""> -<!ENTITY % glossentry.role.attrib "%role.attrib;"> - -<!ENTITY % glossentry.element "INCLUDE"> -<![%glossentry.element;[ -<!--doc:An entry in a Glossary or GlossList.--> -<!ELEMENT glossentry %ho; (glossterm, acronym?, abbrev?, - (%ndxterm.class;)*, - revhistory?, (glosssee|glossdef+))> -<!--end of glossentry.element-->]]> - -<!-- SortAs: String by which the GlossEntry is to be sorted - (alphabetized) in lieu of its proper content --> - - -<!ENTITY % glossentry.attlist "INCLUDE"> -<![%glossentry.attlist;[ -<!ATTLIST glossentry - sortas CDATA #IMPLIED - %common.attrib; - %glossentry.role.attrib; - %local.glossentry.attrib; -> -<!--end of glossentry.attlist-->]]> -<!--end of glossentry.module-->]]> - -<!-- GlossTerm (defined in the Inlines section, below)--> -<!ENTITY % glossdef.module "INCLUDE"> -<![%glossdef.module;[ -<!ENTITY % local.glossdef.attrib ""> -<!ENTITY % glossdef.role.attrib "%role.attrib;"> - -<!ENTITY % glossdef.element "INCLUDE"> -<![%glossdef.element;[ -<!--doc:A definition in a GlossEntry.--> -<!ELEMENT glossdef %ho; ((%glossdef.mix;)+, glossseealso*)> -<!--end of glossdef.element-->]]> - -<!-- Subject: List of subjects; keywords for the definition --> - - -<!ENTITY % glossdef.attlist "INCLUDE"> -<![%glossdef.attlist;[ -<!ATTLIST glossdef - subject CDATA #IMPLIED - %common.attrib; - %glossdef.role.attrib; - %local.glossdef.attrib; -> -<!--end of glossdef.attlist-->]]> -<!--end of glossdef.module-->]]> - -<!ENTITY % glosssee.module "INCLUDE"> -<![%glosssee.module;[ -<!ENTITY % local.glosssee.attrib ""> -<!ENTITY % glosssee.role.attrib "%role.attrib;"> - -<!ENTITY % glosssee.element "INCLUDE"> -<![%glosssee.element;[ -<!--doc:A cross-reference from one GlossEntry to another.--> -<!ELEMENT glosssee %ho; (%para.char.mix;)*> -<!--end of glosssee.element-->]]> - -<!-- OtherTerm: Reference to the GlossEntry whose GlossTerm - should be displayed at the point of the GlossSee --> - - -<!ENTITY % glosssee.attlist "INCLUDE"> -<![%glosssee.attlist;[ -<!ATTLIST glosssee - otherterm IDREF #IMPLIED - %common.attrib; - %glosssee.role.attrib; - %local.glosssee.attrib; -> -<!--end of glosssee.attlist-->]]> -<!--end of glosssee.module-->]]> - -<!ENTITY % glossseealso.module "INCLUDE"> -<![%glossseealso.module;[ -<!ENTITY % local.glossseealso.attrib ""> -<!ENTITY % glossseealso.role.attrib "%role.attrib;"> - -<!ENTITY % glossseealso.element "INCLUDE"> -<![%glossseealso.element;[ -<!--doc:A cross-reference from one GlossEntry to another.--> -<!ELEMENT glossseealso %ho; (%para.char.mix;)*> -<!--end of glossseealso.element-->]]> - -<!-- OtherTerm: Reference to the GlossEntry whose GlossTerm - should be displayed at the point of the GlossSeeAlso --> - - -<!ENTITY % glossseealso.attlist "INCLUDE"> -<![%glossseealso.attlist;[ -<!ATTLIST glossseealso - otherterm IDREF #IMPLIED - %common.attrib; - %glossseealso.role.attrib; - %local.glossseealso.attrib; -> -<!--end of glossseealso.attlist-->]]> -<!--end of glossseealso.module-->]]> -<!--end of glossentry.content.module-->]]> - -<!-- ItemizedList and OrderedList ..... --> - -<!ENTITY % itemizedlist.module "INCLUDE"> -<![%itemizedlist.module;[ -<!ENTITY % local.itemizedlist.attrib ""> -<!ENTITY % itemizedlist.role.attrib "%role.attrib;"> - -<!ENTITY % itemizedlist.element "INCLUDE"> -<![%itemizedlist.element;[ -<!--doc:A list in which each entry is marked with a bullet or other dingbat.--> -<!ELEMENT itemizedlist %ho; (blockinfo?, (%formalobject.title.content;)?, - (%listpreamble.mix;)*, listitem+)> - -<!--end of itemizedlist.element-->]]> - -<!-- Spacing: Whether the vertical space in the list should be - compressed --> -<!-- Mark: Keyword, e.g., bullet, dash, checkbox, none; - list of keywords and defaults are implementation specific --> - - -<!ENTITY % itemizedlist.attlist "INCLUDE"> -<![%itemizedlist.attlist;[ -<!ATTLIST itemizedlist - spacing (normal - |compact) #IMPLIED - %mark.attrib; - %common.attrib; - %itemizedlist.role.attrib; - %local.itemizedlist.attrib; -> -<!--end of itemizedlist.attlist-->]]> -<!--end of itemizedlist.module-->]]> - -<!ENTITY % orderedlist.module "INCLUDE"> -<![%orderedlist.module;[ -<!ENTITY % local.orderedlist.attrib ""> -<!ENTITY % orderedlist.role.attrib "%role.attrib;"> - -<!ENTITY % orderedlist.element "INCLUDE"> -<![%orderedlist.element;[ -<!--doc:A list in which each entry is marked with a sequentially incremented label.--> -<!ELEMENT orderedlist %ho; (blockinfo?, (%formalobject.title.content;)?, - (%listpreamble.mix;)*, listitem+)> - -<!--end of orderedlist.element-->]]> - -<!-- Numeration: Style of ListItem numbered; default is expected - to be Arabic --> -<!-- InheritNum: Specifies for a nested list that the numbering - of ListItems should include the number of the item - within which they are nested (e.g., 1a and 1b within 1, - rather than a and b) --> -<!-- Continuation: Where list numbering begins afresh (Restarts, - the default) or continues that of the immediately preceding - list (Continues) --> -<!-- Spacing: Whether the vertical space in the list should be - compressed --> - - -<!ENTITY % orderedlist.attlist "INCLUDE"> -<![%orderedlist.attlist;[ -<!ATTLIST orderedlist - numeration (arabic - |upperalpha - |loweralpha - |upperroman - |lowerroman) #IMPLIED - inheritnum (inherit - |ignore) "ignore" - continuation (continues - |restarts) "restarts" - spacing (normal - |compact) #IMPLIED - %common.attrib; - %orderedlist.role.attrib; - %local.orderedlist.attrib; -> -<!--end of orderedlist.attlist-->]]> -<!--end of orderedlist.module-->]]> - -<!ENTITY % listitem.module "INCLUDE"> -<![%listitem.module;[ -<!ENTITY % local.listitem.attrib ""> -<!ENTITY % listitem.role.attrib "%role.attrib;"> - -<!ENTITY % listitem.element "INCLUDE"> -<![%listitem.element;[ -<!--doc:A wrapper for the elements of a list item.--> -<!ELEMENT listitem %ho; ((%component.mix;)+)> -<!--end of listitem.element-->]]> - -<!-- Override: Indicates the mark to be used for this ListItem - instead of the default mark or the mark specified by - the Mark attribute on the enclosing ItemizedList --> - - -<!ENTITY % listitem.attlist "INCLUDE"> -<![%listitem.attlist;[ -<!ATTLIST listitem - override CDATA #IMPLIED - %common.attrib; - %listitem.role.attrib; - %local.listitem.attrib; -> -<!--end of listitem.attlist-->]]> -<!--end of listitem.module-->]]> - -<!-- SegmentedList .................... --> -<!ENTITY % segmentedlist.content.module "INCLUDE"> -<![%segmentedlist.content.module;[ -<!ENTITY % segmentedlist.module "INCLUDE"> -<![%segmentedlist.module;[ -<!ENTITY % local.segmentedlist.attrib ""> -<!ENTITY % segmentedlist.role.attrib "%role.attrib;"> - -<!ENTITY % segmentedlist.element "INCLUDE"> -<![%segmentedlist.element;[ -<!--doc:A segmented list, a list of sets of elements.--> -<!ELEMENT segmentedlist %ho; ((%formalobject.title.content;)?, - segtitle+, - seglistitem+)> -<!--end of segmentedlist.element-->]]> - -<!ENTITY % segmentedlist.attlist "INCLUDE"> -<![%segmentedlist.attlist;[ -<!ATTLIST segmentedlist - %common.attrib; - %segmentedlist.role.attrib; - %local.segmentedlist.attrib; -> -<!--end of segmentedlist.attlist-->]]> -<!--end of segmentedlist.module-->]]> - -<!ENTITY % segtitle.module "INCLUDE"> -<![%segtitle.module;[ -<!ENTITY % local.segtitle.attrib ""> -<!ENTITY % segtitle.role.attrib "%role.attrib;"> - -<!ENTITY % segtitle.element "INCLUDE"> -<![%segtitle.element;[ -<!--doc:The title of an element of a list item in a segmented list.--> -<!ELEMENT segtitle %ho; (%title.char.mix;)*> -<!--end of segtitle.element-->]]> - -<!ENTITY % segtitle.attlist "INCLUDE"> -<![%segtitle.attlist;[ -<!ATTLIST segtitle - %common.attrib; - %segtitle.role.attrib; - %local.segtitle.attrib; -> -<!--end of segtitle.attlist-->]]> -<!--end of segtitle.module-->]]> - -<!ENTITY % seglistitem.module "INCLUDE"> -<![%seglistitem.module;[ -<!ENTITY % local.seglistitem.attrib ""> -<!ENTITY % seglistitem.role.attrib "%role.attrib;"> - -<!ENTITY % seglistitem.element "INCLUDE"> -<![%seglistitem.element;[ -<!--doc:A list item in a segmented list.--> -<!ELEMENT seglistitem %ho; (seg+)> -<!--end of seglistitem.element-->]]> - -<!ENTITY % seglistitem.attlist "INCLUDE"> -<![%seglistitem.attlist;[ -<!ATTLIST seglistitem - %common.attrib; - %seglistitem.role.attrib; - %local.seglistitem.attrib; -> -<!--end of seglistitem.attlist-->]]> -<!--end of seglistitem.module-->]]> - -<!ENTITY % seg.module "INCLUDE"> -<![%seg.module;[ -<!ENTITY % local.seg.attrib ""> -<!ENTITY % seg.role.attrib "%role.attrib;"> - -<!ENTITY % seg.element "INCLUDE"> -<![%seg.element;[ -<!--doc:An element of a list item in a segmented list.--> -<!ELEMENT seg %ho; (%para.char.mix;)*> -<!--end of seg.element-->]]> - -<!ENTITY % seg.attlist "INCLUDE"> -<![%seg.attlist;[ -<!ATTLIST seg - %common.attrib; - %seg.role.attrib; - %local.seg.attrib; -> -<!--end of seg.attlist-->]]> -<!--end of seg.module-->]]> -<!--end of segmentedlist.content.module-->]]> - -<!-- SimpleList ....................... --> - -<!ENTITY % simplelist.content.module "INCLUDE"> -<![%simplelist.content.module;[ -<!ENTITY % simplelist.module "INCLUDE"> -<![%simplelist.module;[ -<!ENTITY % local.simplelist.attrib ""> -<!ENTITY % simplelist.role.attrib "%role.attrib;"> - -<!ENTITY % simplelist.element "INCLUDE"> -<![%simplelist.element;[ -<!--doc:An undecorated list of single words or short phrases.--> -<!ELEMENT simplelist %ho; (member+)> -<!--end of simplelist.element-->]]> - -<!-- Columns: The number of columns the array should contain --> -<!-- Type: How the Members of the SimpleList should be - formatted: Inline (members separated with commas etc. - inline), Vert (top to bottom in n Columns), or Horiz (in - the direction of text flow) in n Columns. If Column - is 1 or implied, Type=Vert and Type=Horiz give the same - results. --> - - -<!ENTITY % simplelist.attlist "INCLUDE"> -<![%simplelist.attlist;[ -<!ATTLIST simplelist - columns CDATA #IMPLIED - type (inline - |vert - |horiz) "vert" - %common.attrib; - %simplelist.role.attrib; - %local.simplelist.attrib; -> -<!--end of simplelist.attlist-->]]> -<!--end of simplelist.module-->]]> - -<!ENTITY % member.module "INCLUDE"> -<![%member.module;[ -<!ENTITY % local.member.attrib ""> -<!ENTITY % member.role.attrib "%role.attrib;"> - -<!ENTITY % member.element "INCLUDE"> -<![%member.element;[ -<!--doc:An element of a simple list.--> -<!ELEMENT member %ho; (%para.char.mix;)*> -<!--end of member.element-->]]> - -<!ENTITY % member.attlist "INCLUDE"> -<![%member.attlist;[ -<!ATTLIST member - %common.attrib; - %member.role.attrib; - %local.member.attrib; -> -<!--end of member.attlist-->]]> -<!--end of member.module-->]]> -<!--end of simplelist.content.module-->]]> - -<!-- VariableList ..................... --> - -<!ENTITY % variablelist.content.module "INCLUDE"> -<![%variablelist.content.module;[ -<!ENTITY % variablelist.module "INCLUDE"> -<![%variablelist.module;[ -<!ENTITY % local.variablelist.attrib ""> -<!ENTITY % variablelist.role.attrib "%role.attrib;"> - -<!ENTITY % variablelist.element "INCLUDE"> -<![%variablelist.element;[ -<!--doc:A list in which each entry is composed of a set of one or more terms and an associated description.--> -<!ELEMENT variablelist %ho; (blockinfo?, (%formalobject.title.content;)?, - (%listpreamble.mix;)*, varlistentry+)> -<!--end of variablelist.element-->]]> - -<!-- TermLength: Length beyond which the presentation engine - may consider the Term too long and select an alternate - presentation of the Term and, or, its associated ListItem. --> - - -<!ENTITY % variablelist.attlist "INCLUDE"> -<![%variablelist.attlist;[ -<!ATTLIST variablelist - termlength CDATA #IMPLIED - spacing (normal - |compact) #IMPLIED - %common.attrib; - %variablelist.role.attrib; - %local.variablelist.attrib; -> -<!--end of variablelist.attlist-->]]> -<!--end of variablelist.module-->]]> - -<!ENTITY % varlistentry.module "INCLUDE"> -<![%varlistentry.module;[ -<!ENTITY % local.varlistentry.attrib ""> -<!ENTITY % varlistentry.role.attrib "%role.attrib;"> - -<!ENTITY % varlistentry.element "INCLUDE"> -<![%varlistentry.element;[ -<!--doc:A wrapper for a set of terms and the associated description in a variable list.--> -<!ELEMENT varlistentry %ho; (term+, listitem)> -<!--end of varlistentry.element-->]]> - -<!ENTITY % varlistentry.attlist "INCLUDE"> -<![%varlistentry.attlist;[ -<!ATTLIST varlistentry - %common.attrib; - %varlistentry.role.attrib; - %local.varlistentry.attrib; -> -<!--end of varlistentry.attlist-->]]> -<!--end of varlistentry.module-->]]> - -<!ENTITY % term.module "INCLUDE"> -<![%term.module;[ -<!ENTITY % local.term.attrib ""> -<!ENTITY % term.role.attrib "%role.attrib;"> - -<!ENTITY % term.element "INCLUDE"> -<![%term.element;[ -<!--doc:The word or phrase being defined or described in a variable list.--> -<!ELEMENT term %ho; (%para.char.mix;)*> -<!--end of term.element-->]]> - -<!ENTITY % term.attlist "INCLUDE"> -<![%term.attlist;[ -<!ATTLIST term - %common.attrib; - %term.role.attrib; - %local.term.attrib; -> -<!--end of term.attlist-->]]> -<!--end of term.module-->]]> - -<!-- ListItem (defined above)--> -<!--end of variablelist.content.module-->]]> - -<!-- CalloutList ...................... --> - -<!ENTITY % calloutlist.content.module "INCLUDE"> -<![%calloutlist.content.module;[ -<!ENTITY % calloutlist.module "INCLUDE"> -<![%calloutlist.module;[ -<!ENTITY % local.calloutlist.attrib ""> -<!ENTITY % calloutlist.role.attrib "%role.attrib;"> - -<!ENTITY % calloutlist.element "INCLUDE"> -<![%calloutlist.element;[ -<!--doc:A list of Callouts.--> -<!ELEMENT calloutlist %ho; ((%formalobject.title.content;)?, callout+)> -<!--end of calloutlist.element-->]]> - -<!ENTITY % calloutlist.attlist "INCLUDE"> -<![%calloutlist.attlist;[ -<!ATTLIST calloutlist - %common.attrib; - %calloutlist.role.attrib; - %local.calloutlist.attrib; -> -<!--end of calloutlist.attlist-->]]> -<!--end of calloutlist.module-->]]> - -<!ENTITY % callout.module "INCLUDE"> -<![%callout.module;[ -<!ENTITY % local.callout.attrib ""> -<!ENTITY % callout.role.attrib "%role.attrib;"> - -<!ENTITY % callout.element "INCLUDE"> -<![%callout.element;[ -<!--doc:A “called out” description of a marked Area.--> -<!ELEMENT callout %ho; ((%component.mix;)+)> -<!--end of callout.element-->]]> - -<!-- AreaRefs: IDs of one or more Areas or AreaSets described - by this Callout --> - - -<!ENTITY % callout.attlist "INCLUDE"> -<![%callout.attlist;[ -<!ATTLIST callout - arearefs IDREFS #REQUIRED - %common.attrib; - %callout.role.attrib; - %local.callout.attrib; -> -<!--end of callout.attlist-->]]> -<!--end of callout.module-->]]> -<!--end of calloutlist.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Objects .............................................................. --> - -<!-- Examples etc. .................... --> - -<!ENTITY % example.module "INCLUDE"> -<![%example.module;[ -<!ENTITY % local.example.attrib ""> -<!ENTITY % example.role.attrib "%role.attrib;"> - -<!ENTITY % example.element "INCLUDE"> -<![%example.element;[ -<!--doc:A formal example, with a title.--> -<!ELEMENT example %ho; (blockinfo?, (%formalobject.title.content;), (%example.mix;)+) - %formal.exclusion;> -<!--end of example.element-->]]> - -<!ENTITY % example.attlist "INCLUDE"> -<![%example.attlist;[ -<!ATTLIST example - floatstyle CDATA #IMPLIED - %label.attrib; - %width.attrib; - %common.attrib; - %example.role.attrib; - %local.example.attrib; -> -<!--end of example.attlist-->]]> -<!--end of example.module-->]]> - -<!ENTITY % informalexample.module "INCLUDE"> -<![%informalexample.module;[ -<!ENTITY % local.informalexample.attrib ""> -<!ENTITY % informalexample.role.attrib "%role.attrib;"> - -<!ENTITY % informalexample.element "INCLUDE"> -<![%informalexample.element;[ -<!--doc:A displayed example without a title.--> -<!ELEMENT informalexample %ho; (blockinfo?, (%example.mix;)+)> -<!--end of informalexample.element-->]]> - -<!ENTITY % informalexample.attlist "INCLUDE"> -<![%informalexample.attlist;[ -<!ATTLIST informalexample - floatstyle CDATA #IMPLIED - %width.attrib; - %common.attrib; - %informalexample.role.attrib; - %local.informalexample.attrib; -> -<!--end of informalexample.attlist-->]]> -<!--end of informalexample.module-->]]> - -<!ENTITY % programlistingco.module "INCLUDE"> -<![%programlistingco.module;[ -<!ENTITY % local.programlistingco.attrib ""> -<!ENTITY % programlistingco.role.attrib "%role.attrib;"> - -<!ENTITY % programlistingco.element "INCLUDE"> -<![%programlistingco.element;[ -<!--doc:A program listing with associated areas used in callouts.--> -<!ELEMENT programlistingco %ho; (areaspec, programlisting, calloutlist*)> -<!--end of programlistingco.element-->]]> - -<!ENTITY % programlistingco.attlist "INCLUDE"> -<![%programlistingco.attlist;[ -<!ATTLIST programlistingco - %common.attrib; - %programlistingco.role.attrib; - %local.programlistingco.attrib; -> -<!--end of programlistingco.attlist-->]]> -<!-- CalloutList (defined above in Lists)--> -<!--end of informalexample.module-->]]> - -<!ENTITY % areaspec.content.module "INCLUDE"> -<![%areaspec.content.module;[ -<!ENTITY % areaspec.module "INCLUDE"> -<![%areaspec.module;[ -<!ENTITY % local.areaspec.attrib ""> -<!ENTITY % areaspec.role.attrib "%role.attrib;"> - -<!ENTITY % areaspec.element "INCLUDE"> -<![%areaspec.element;[ -<!--doc:A collection of regions in a graphic or code example.--> -<!ELEMENT areaspec %ho; ((area|areaset)+)> -<!--end of areaspec.element-->]]> - -<!-- Units: global unit of measure in which coordinates in - this spec are expressed: - - - CALSPair "x1,y1 x2,y2": lower-left and upper-right - coordinates in a rectangle describing repro area in which - graphic is placed, where X and Y dimensions are each some - number 0..10000 (taken from CALS graphic attributes) - - - LineColumn "line column": line number and column number - at which to start callout text in "linespecific" content - - - LineRange "startline endline": whole lines from startline - to endline in "linespecific" content - - - LineColumnPair "line1 col1 line2 col2": starting and ending - points of area in "linespecific" content that starts at - first position and ends at second position (including the - beginnings of any intervening lines) - - - Other: directive to look at value of OtherUnits attribute - to get implementation-specific keyword - - The default is implementation-specific; usually dependent on - the parent element (GraphicCO gets CALSPair, ProgramListingCO - and ScreenCO get LineColumn) --> -<!-- OtherUnits: User-defined units --> - - -<!ENTITY % areaspec.attlist "INCLUDE"> -<![%areaspec.attlist;[ -<!ATTLIST areaspec - units (calspair - |linecolumn - |linerange - |linecolumnpair - |other) #IMPLIED - otherunits NMTOKEN #IMPLIED - %common.attrib; - %areaspec.role.attrib; - %local.areaspec.attrib; -> -<!--end of areaspec.attlist-->]]> -<!--end of areaspec.module-->]]> - -<!ENTITY % area.module "INCLUDE"> -<![%area.module;[ -<!ENTITY % local.area.attrib ""> -<!ENTITY % area.role.attrib "%role.attrib;"> - -<!ENTITY % area.element "INCLUDE"> -<![%area.element;[ -<!--doc:A region defined for a Callout in a graphic or code example.--> -<!ELEMENT area %ho; EMPTY> -<!--end of area.element-->]]> - -<!-- bug number/symbol override or initialization --> -<!-- to any related information --> -<!-- Units: unit of measure in which coordinates in this - area are expressed; inherits from AreaSet and AreaSpec --> -<!-- OtherUnits: User-defined units --> - - -<!ENTITY % area.attlist "INCLUDE"> -<![%area.attlist;[ -<!ATTLIST area - %label.attrib; - %linkends.attrib; - units (calspair - |linecolumn - |linerange - |linecolumnpair - |other) #IMPLIED - otherunits NMTOKEN #IMPLIED - coords CDATA #REQUIRED - %idreq.common.attrib; - %area.role.attrib; - %local.area.attrib; -> -<!--end of area.attlist-->]]> -<!--end of area.module-->]]> - -<!ENTITY % areaset.module "INCLUDE"> -<![%areaset.module;[ -<!ENTITY % local.areaset.attrib ""> -<!ENTITY % areaset.role.attrib "%role.attrib;"> - -<!ENTITY % areaset.element "INCLUDE"> -<![%areaset.element;[ -<!--doc:A set of related areas in a graphic or code example.--> -<!ELEMENT areaset %ho; (area+)> -<!--end of areaset.element-->]]> - -<!-- bug number/symbol override or initialization --> -<!-- Units: unit of measure in which coordinates in this - area are expressed; inherits from AreaSpec --> - - -<!ENTITY % areaset.attlist "INCLUDE"> -<![%areaset.attlist;[ -<!ATTLIST areaset - %label.attrib; - units (calspair - |linecolumn - |linerange - |linecolumnpair - |other) #IMPLIED - otherunits NMTOKEN #IMPLIED - coords CDATA #REQUIRED - %idreq.common.attrib; - %areaset.role.attrib; - %local.areaset.attrib; -> -<!--end of areaset.attlist-->]]> -<!--end of areaset.module-->]]> -<!--end of areaspec.content.module-->]]> - -<!ENTITY % programlisting.module "INCLUDE"> -<![%programlisting.module;[ -<!ENTITY % local.programlisting.attrib ""> -<!ENTITY % programlisting.role.attrib "%role.attrib;"> - -<!ENTITY % programlisting.element "INCLUDE"> -<![%programlisting.element;[ -<!--doc:A literal listing of all or part of a program.--> -<!ELEMENT programlisting %ho; (%para.char.mix;|co|coref|lineannotation|textobject)*> -<!--end of programlisting.element-->]]> - -<!ENTITY % programlisting.attlist "INCLUDE"> -<![%programlisting.attlist;[ -<!ATTLIST programlisting - %width.attrib; - %linespecific.attrib; - %common.attrib; - %programlisting.role.attrib; - %local.programlisting.attrib; -> -<!--end of programlisting.attlist-->]]> -<!--end of programlisting.module-->]]> - -<!ENTITY % literallayout.module "INCLUDE"> -<![%literallayout.module;[ -<!ENTITY % local.literallayout.attrib ""> -<!ENTITY % literallayout.role.attrib "%role.attrib;"> - -<!ENTITY % literallayout.element "INCLUDE"> -<![%literallayout.element;[ -<!--doc:A block of text in which line breaks and white space are to be reproduced faithfully.--> -<!ELEMENT literallayout %ho; (%para.char.mix;|co|coref|textobject|lineannotation)*> -<!--end of literallayout.element-->]]> - -<!ENTITY % literallayout.attlist "INCLUDE"> -<![%literallayout.attlist;[ -<!ATTLIST literallayout - %width.attrib; - %linespecific.attrib; - class (monospaced|normal) "normal" - %common.attrib; - %literallayout.role.attrib; - %local.literallayout.attrib; -> -<!--end of literallayout.attlist-->]]> -<!-- LineAnnotation (defined in the Inlines section, below)--> -<!--end of literallayout.module-->]]> - -<!ENTITY % screenco.module "INCLUDE"> -<![%screenco.module;[ -<!ENTITY % local.screenco.attrib ""> -<!ENTITY % screenco.role.attrib "%role.attrib;"> - -<!ENTITY % screenco.element "INCLUDE"> -<![%screenco.element;[ -<!--doc:A screen with associated areas used in callouts.--> -<!ELEMENT screenco %ho; (areaspec, screen, calloutlist*)> -<!--end of screenco.element-->]]> - -<!ENTITY % screenco.attlist "INCLUDE"> -<![%screenco.attlist;[ -<!ATTLIST screenco - %common.attrib; - %screenco.role.attrib; - %local.screenco.attrib; -> -<!--end of screenco.attlist-->]]> -<!-- AreaSpec (defined above)--> -<!-- CalloutList (defined above in Lists)--> -<!--end of screenco.module-->]]> - -<!ENTITY % screen.module "INCLUDE"> -<![%screen.module;[ -<!ENTITY % local.screen.attrib ""> -<!ENTITY % screen.role.attrib "%role.attrib;"> - -<!ENTITY % screen.element "INCLUDE"> -<![%screen.element;[ -<!--doc:Text that a user sees or might see on a computer screen.--> -<!ELEMENT screen %ho; (%para.char.mix;|co|coref|textobject|lineannotation)*> -<!--end of screen.element-->]]> - -<!ENTITY % screen.attlist "INCLUDE"> -<![%screen.attlist;[ -<!ATTLIST screen - %width.attrib; - %linespecific.attrib; - %common.attrib; - %screen.role.attrib; - %local.screen.attrib; -> -<!--end of screen.attlist-->]]> -<!--end of screen.module-->]]> - -<!ENTITY % screenshot.content.module "INCLUDE"> -<![%screenshot.content.module;[ -<!ENTITY % screenshot.module "INCLUDE"> -<![%screenshot.module;[ -<!ENTITY % local.screenshot.attrib ""> -<!ENTITY % screenshot.role.attrib "%role.attrib;"> - -<!ENTITY % screenshot.element "INCLUDE"> -<![%screenshot.element;[ -<!--doc:A representation of what the user sees or might see on a computer screen.--> -<!ELEMENT screenshot %ho; (screeninfo?, - (graphic|graphicco - |mediaobject|mediaobjectco))> -<!--end of screenshot.element-->]]> - -<!ENTITY % screenshot.attlist "INCLUDE"> -<![%screenshot.attlist;[ -<!ATTLIST screenshot - %common.attrib; - %screenshot.role.attrib; - %local.screenshot.attrib; -> -<!--end of screenshot.attlist-->]]> -<!--end of screenshot.module-->]]> - -<!ENTITY % screeninfo.module "INCLUDE"> -<![%screeninfo.module;[ -<!ENTITY % local.screeninfo.attrib ""> -<!ENTITY % screeninfo.role.attrib "%role.attrib;"> - -<!ENTITY % screeninfo.element "INCLUDE"> -<![%screeninfo.element;[ -<!--doc:Information about how a screen shot was produced.--> -<!ELEMENT screeninfo %ho; (%para.char.mix;)* - %ubiq.exclusion;> -<!--end of screeninfo.element-->]]> - -<!ENTITY % screeninfo.attlist "INCLUDE"> -<![%screeninfo.attlist;[ -<!ATTLIST screeninfo - %common.attrib; - %screeninfo.role.attrib; - %local.screeninfo.attrib; -> -<!--end of screeninfo.attlist-->]]> -<!--end of screeninfo.module-->]]> -<!--end of screenshot.content.module-->]]> - -<!-- Figures etc. ..................... --> - -<!ENTITY % figure.module "INCLUDE"> -<![%figure.module;[ -<!ENTITY % local.figure.attrib ""> -<!ENTITY % figure.role.attrib "%role.attrib;"> - -<!ENTITY % figure.element "INCLUDE"> -<![%figure.element;[ -<!--doc:A formal figure, generally an illustration, with a title.--> -<!ELEMENT figure %ho; (blockinfo?, (%formalobject.title.content;), - (%figure.mix; | %link.char.class;)+)> -<!--end of figure.element-->]]> - -<!-- Float: Whether the Figure is supposed to be rendered - where convenient (yes (1) value) or at the place it occurs - in the text (no (0) value, the default) --> - - -<!ENTITY % figure.attlist "INCLUDE"> -<![%figure.attlist;[ -<!ATTLIST figure - float %yesorno.attvals; '0' - floatstyle CDATA #IMPLIED - pgwide %yesorno.attvals; #IMPLIED - %label.attrib; - %common.attrib; - %figure.role.attrib; - %local.figure.attrib; -> -<!--end of figure.attlist-->]]> -<!--end of figure.module-->]]> - -<!ENTITY % informalfigure.module "INCLUDE"> -<![ %informalfigure.module; [ -<!ENTITY % local.informalfigure.attrib ""> -<!ENTITY % informalfigure.role.attrib "%role.attrib;"> - -<!ENTITY % informalfigure.element "INCLUDE"> -<![ %informalfigure.element; [ -<!--doc:A untitled figure.--> -<!ELEMENT informalfigure %ho; (blockinfo?, (%figure.mix; | %link.char.class;)+)> -<!--end of informalfigure.element-->]]> - -<!ENTITY % informalfigure.attlist "INCLUDE"> -<![ %informalfigure.attlist; [ -<!-- -Float: Whether the Figure is supposed to be rendered -where convenient (yes (1) value) or at the place it occurs -in the text (no (0) value, the default) ---> -<!ATTLIST informalfigure - float %yesorno.attvals; "0" - floatstyle CDATA #IMPLIED - pgwide %yesorno.attvals; #IMPLIED - %label.attrib; - %common.attrib; - %informalfigure.role.attrib; - %local.informalfigure.attrib; -> -<!--end of informalfigure.attlist-->]]> -<!--end of informalfigure.module-->]]> - -<!ENTITY % graphicco.module "INCLUDE"> -<![%graphicco.module;[ -<!ENTITY % local.graphicco.attrib ""> -<!ENTITY % graphicco.role.attrib "%role.attrib;"> - -<!ENTITY % graphicco.element "INCLUDE"> -<![%graphicco.element;[ -<!--doc:A graphic that contains callout areas.--> -<!ELEMENT graphicco %ho; (areaspec, graphic, calloutlist*)> -<!--end of graphicco.element-->]]> - -<!ENTITY % graphicco.attlist "INCLUDE"> -<![%graphicco.attlist;[ -<!ATTLIST graphicco - %common.attrib; - %graphicco.role.attrib; - %local.graphicco.attrib; -> -<!--end of graphicco.attlist-->]]> -<!-- AreaSpec (defined above in Examples)--> -<!-- CalloutList (defined above in Lists)--> -<!--end of graphicco.module-->]]> - -<!-- Graphical data can be the content of Graphic, or you can reference - an external file either as an entity (Entitref) or a filename - (Fileref). --> - -<!ENTITY % graphic.module "INCLUDE"> -<![%graphic.module;[ -<!ENTITY % local.graphic.attrib ""> -<!ENTITY % graphic.role.attrib "%role.attrib;"> - -<!ENTITY % graphic.element "INCLUDE"> -<![%graphic.element;[ -<!--doc:A displayed graphical object (not an inline).--> -<!ELEMENT graphic %ho; EMPTY> -<!--end of graphic.element-->]]> - -<!ENTITY % graphic.attlist "INCLUDE"> -<![%graphic.attlist;[ -<!ATTLIST graphic - %graphics.attrib; - %common.attrib; - %graphic.role.attrib; - %local.graphic.attrib; -> -<!--end of graphic.attlist-->]]> -<!--end of graphic.module-->]]> - -<!ENTITY % inlinegraphic.module "INCLUDE"> -<![%inlinegraphic.module;[ -<!ENTITY % local.inlinegraphic.attrib ""> -<!ENTITY % inlinegraphic.role.attrib "%role.attrib;"> - -<!ENTITY % inlinegraphic.element "INCLUDE"> -<![%inlinegraphic.element;[ -<!--doc:An object containing or pointing to graphical data that will be rendered inline.--> -<!ELEMENT inlinegraphic %ho; EMPTY> -<!--end of inlinegraphic.element-->]]> - -<!ENTITY % inlinegraphic.attlist "INCLUDE"> -<![%inlinegraphic.attlist;[ -<!ATTLIST inlinegraphic - %graphics.attrib; - %common.attrib; - %inlinegraphic.role.attrib; - %local.inlinegraphic.attrib; -> -<!--end of inlinegraphic.attlist-->]]> -<!--end of inlinegraphic.module-->]]> - -<!ENTITY % mediaobject.content.module "INCLUDE"> -<![ %mediaobject.content.module; [ - -<!ENTITY % mediaobject.module "INCLUDE"> -<![ %mediaobject.module; [ -<!ENTITY % local.mediaobject.attrib ""> -<!ENTITY % mediaobject.role.attrib "%role.attrib;"> - -<!ENTITY % mediaobject.element "INCLUDE"> -<![ %mediaobject.element; [ -<!--doc:A displayed media object (video, audio, image, etc.).--> -<!ELEMENT mediaobject %ho; (objectinfo?, - (%mediaobject.mix;)+, - caption?)> -<!--end of mediaobject.element-->]]> - -<!ENTITY % mediaobject.attlist "INCLUDE"> -<![ %mediaobject.attlist; [ -<!ATTLIST mediaobject - %common.attrib; - %mediaobject.role.attrib; - %local.mediaobject.attrib; -> -<!--end of mediaobject.attlist-->]]> -<!--end of mediaobject.module-->]]> - -<!ENTITY % inlinemediaobject.module "INCLUDE"> -<![ %inlinemediaobject.module; [ -<!ENTITY % local.inlinemediaobject.attrib ""> -<!ENTITY % inlinemediaobject.role.attrib "%role.attrib;"> - -<!ENTITY % inlinemediaobject.element "INCLUDE"> -<![ %inlinemediaobject.element; [ -<!--doc:An inline media object (video, audio, image, and so on).--> -<!ELEMENT inlinemediaobject %ho; (objectinfo?, - (%mediaobject.mix;)+)> -<!--end of inlinemediaobject.element-->]]> - -<!ENTITY % inlinemediaobject.attlist "INCLUDE"> -<![ %inlinemediaobject.attlist; [ -<!ATTLIST inlinemediaobject - %common.attrib; - %inlinemediaobject.role.attrib; - %local.inlinemediaobject.attrib; -> -<!--end of inlinemediaobject.attlist-->]]> -<!--end of inlinemediaobject.module-->]]> - -<!ENTITY % videoobject.module "INCLUDE"> -<![ %videoobject.module; [ -<!ENTITY % local.videoobject.attrib ""> -<!ENTITY % videoobject.role.attrib "%role.attrib;"> - -<!ENTITY % videoobject.element "INCLUDE"> -<![ %videoobject.element; [ -<!--doc:A wrapper for video data and its associated meta-information.--> -<!ELEMENT videoobject %ho; (objectinfo?, videodata)> -<!--end of videoobject.element-->]]> - -<!ENTITY % videoobject.attlist "INCLUDE"> -<![ %videoobject.attlist; [ -<!ATTLIST videoobject - %common.attrib; - %videoobject.role.attrib; - %local.videoobject.attrib; -> -<!--end of videoobject.attlist-->]]> -<!--end of videoobject.module-->]]> - -<!ENTITY % audioobject.module "INCLUDE"> -<![ %audioobject.module; [ -<!ENTITY % local.audioobject.attrib ""> -<!ENTITY % audioobject.role.attrib "%role.attrib;"> - -<!ENTITY % audioobject.element "INCLUDE"> -<![ %audioobject.element; [ -<!--doc:A wrapper for audio data and its associated meta-information.--> -<!ELEMENT audioobject %ho; (objectinfo?, audiodata)> -<!--end of audioobject.element-->]]> - -<!ENTITY % audioobject.attlist "INCLUDE"> -<![ %audioobject.attlist; [ -<!ATTLIST audioobject - %common.attrib; - %audioobject.role.attrib; - %local.audioobject.attrib; -> -<!--end of audioobject.attlist-->]]> -<!--end of audioobject.module-->]]> - -<!ENTITY % imageobject.module "INCLUDE"> -<![ %imageobject.module; [ -<!ENTITY % local.imageobject.attrib ""> -<!ENTITY % imageobject.role.attrib "%role.attrib;"> - -<!ENTITY % imageobject.element "INCLUDE"> -<![ %imageobject.element; [ -<!--doc:A wrapper for image data and its associated meta-information.--> -<!ELEMENT imageobject %ho; (objectinfo?, imagedata)> -<!--end of imageobject.element-->]]> - -<!ENTITY % imageobject.attlist "INCLUDE"> -<![ %imageobject.attlist; [ -<!ATTLIST imageobject - %common.attrib; - %imageobject.role.attrib; - %local.imageobject.attrib; -> -<!--end of imageobject.attlist-->]]> -<!--end of imageobject.module-->]]> - -<!ENTITY % textobject.module "INCLUDE"> -<![ %textobject.module; [ -<!ENTITY % local.textobject.attrib ""> -<!ENTITY % textobject.role.attrib "%role.attrib;"> - -<!ENTITY % textobject.element "INCLUDE"> -<![ %textobject.element; [ -<!--doc:A wrapper for a text description of an object and its associated meta-information.--> -<!ELEMENT textobject %ho; (objectinfo?, (phrase|textdata|(%textobject.mix;)+))> -<!--end of textobject.element-->]]> - -<!ENTITY % textobject.attlist "INCLUDE"> -<![ %textobject.attlist; [ -<!ATTLIST textobject - %common.attrib; - %textobject.role.attrib; - %local.textobject.attrib; -> -<!--end of textobject.attlist-->]]> -<!--end of textobject.module-->]]> - -<!ENTITY % objectinfo.module "INCLUDE"> -<![ %objectinfo.module; [ -<!ENTITY % local.objectinfo.attrib ""> -<!ENTITY % objectinfo.role.attrib "%role.attrib;"> - -<!ENTITY % objectinfo.element "INCLUDE"> -<![ %objectinfo.element; [ -<!--doc:Meta-information for an object.--> -<!ELEMENT objectinfo %ho; ((%info.class;)+) - %beginpage.exclusion;> -<!--end of objectinfo.element-->]]> - -<!ENTITY % objectinfo.attlist "INCLUDE"> -<![ %objectinfo.attlist; [ -<!ATTLIST objectinfo - %common.attrib; - %objectinfo.role.attrib; - %local.objectinfo.attrib; -> -<!--end of objectinfo.attlist-->]]> -<!--end of objectinfo.module-->]]> - -<!--EntityRef: Name of an external entity containing the content - of the object data--> -<!--FileRef: Filename, qualified by a pathname if desired, - designating the file containing the content of the object data--> -<!--Format: Notation of the element content, if any--> -<!--SrcCredit: Information about the source of the image--> -<!ENTITY % local.objectdata.attrib ""> -<!ENTITY % objectdata.attrib - " - entityref ENTITY #IMPLIED - fileref CDATA #IMPLIED - format (%notation.class;) - #IMPLIED - srccredit CDATA #IMPLIED - %local.objectdata.attrib;" -> - -<!ENTITY % videodata.module "INCLUDE"> -<![ %videodata.module; [ -<!ENTITY % local.videodata.attrib ""> -<!ENTITY % videodata.role.attrib "%role.attrib;"> - -<!ENTITY % videodata.element "INCLUDE"> -<![ %videodata.element; [ -<!--doc:Pointer to external video data.--> -<!ELEMENT videodata %ho; EMPTY> -<!--end of videodata.element-->]]> - -<!ENTITY % videodata.attlist "INCLUDE"> -<![ %videodata.attlist; [ - -<!--Width: Same as CALS reprowid (desired width)--> -<!--Depth: Same as CALS reprodep (desired depth)--> -<!--Align: Same as CALS hplace with 'none' removed; #IMPLIED means - application-specific--> -<!--Scale: Conflation of CALS hscale and vscale--> -<!--Scalefit: Same as CALS scalefit--> -<!ATTLIST videodata - width CDATA #IMPLIED - contentwidth CDATA #IMPLIED - depth CDATA #IMPLIED - contentdepth CDATA #IMPLIED - align (left - |right - |center) #IMPLIED - valign (top - |middle - |bottom) #IMPLIED - scale CDATA #IMPLIED - scalefit %yesorno.attvals; - #IMPLIED - %objectdata.attrib; - %common.attrib; - %videodata.role.attrib; - %local.videodata.attrib; -> -<!--end of videodata.attlist-->]]> -<!--end of videodata.module-->]]> - -<!ENTITY % audiodata.module "INCLUDE"> -<![ %audiodata.module; [ -<!ENTITY % local.audiodata.attrib ""> -<!ENTITY % audiodata.role.attrib "%role.attrib;"> - -<!ENTITY % audiodata.element "INCLUDE"> -<![ %audiodata.element; [ -<!--doc:Pointer to external audio data.--> -<!ELEMENT audiodata %ho; EMPTY> -<!--end of audiodata.element-->]]> - -<!ENTITY % audiodata.attlist "INCLUDE"> -<![ %audiodata.attlist; [ -<!ATTLIST audiodata - %objectdata.attrib; - %common.attrib; - %audiodata.role.attrib; - %local.audiodata.attrib; -> -<!--end of audiodata.attlist-->]]> -<!--end of audiodata.module-->]]> - -<!ENTITY % imagedata.module "INCLUDE"> -<![ %imagedata.module; [ -<!ENTITY % local.imagedata.attrib ""> -<!ENTITY % imagedata.role.attrib "%role.attrib;"> - -<!ENTITY % imagedata.element "INCLUDE"> -<![ %imagedata.element; [ -<!--doc:Pointer to external image data.--> -<!ELEMENT imagedata %ho; EMPTY> -<!--end of imagedata.element-->]]> - -<!ENTITY % imagedata.attlist "INCLUDE"> -<![ %imagedata.attlist; [ - -<!--Width: Same as CALS reprowid (desired width)--> -<!--Depth: Same as CALS reprodep (desired depth)--> -<!--Align: Same as CALS hplace with 'none' removed; #IMPLIED means - application-specific--> -<!--Scale: Conflation of CALS hscale and vscale--> -<!--Scalefit: Same as CALS scalefit--> -<!ATTLIST imagedata - width CDATA #IMPLIED - contentwidth CDATA #IMPLIED - depth CDATA #IMPLIED - contentdepth CDATA #IMPLIED - align (left - |right - |center) #IMPLIED - valign (top - |middle - |bottom) #IMPLIED - scale CDATA #IMPLIED - scalefit %yesorno.attvals; - #IMPLIED - %objectdata.attrib; - %common.attrib; - %imagedata.role.attrib; - %local.imagedata.attrib; -> -<!--end of imagedata.attlist-->]]> -<!--end of imagedata.module-->]]> - -<!ENTITY % textdata.module "INCLUDE"> -<![ %textdata.module; [ -<!ENTITY % local.textdata.attrib ""> -<!ENTITY % textdata.role.attrib "%role.attrib;"> - -<!ENTITY % textdata.element "INCLUDE"> -<![ %textdata.element; [ -<!--doc:Pointer to external text data.--> -<!ELEMENT textdata %ho; EMPTY> -<!--end of textdata.element-->]]> - -<!ENTITY % textdata.attlist "INCLUDE"> -<![ %textdata.attlist; [ -<!ATTLIST textdata - encoding CDATA #IMPLIED - %objectdata.attrib; - %common.attrib; - %textdata.role.attrib; - %local.textdata.attrib; -> -<!--end of textdata.attlist-->]]> -<!--end of textdata.module-->]]> - -<!ENTITY % mediaobjectco.module "INCLUDE"> -<![ %mediaobjectco.module; [ -<!ENTITY % local.mediaobjectco.attrib ""> -<!ENTITY % mediaobjectco.role.attrib "%role.attrib;"> - -<!ENTITY % mediaobjectco.element "INCLUDE"> -<![ %mediaobjectco.element; [ -<!--doc:A media object that contains callouts.--> -<!ELEMENT mediaobjectco %ho; (objectinfo?, imageobjectco, - (imageobjectco|textobject)*)> -<!--end of mediaobjectco.element-->]]> - -<!ENTITY % mediaobjectco.attlist "INCLUDE"> -<![ %mediaobjectco.attlist; [ -<!ATTLIST mediaobjectco - %common.attrib; - %mediaobjectco.role.attrib; - %local.mediaobjectco.attrib; -> -<!--end of mediaobjectco.attlist-->]]> -<!--end of mediaobjectco.module-->]]> - -<!ENTITY % imageobjectco.module "INCLUDE"> -<![ %imageobjectco.module; [ -<!ENTITY % local.imageobjectco.attrib ""> -<!ENTITY % imageobjectco.role.attrib "%role.attrib;"> - -<!ENTITY % imageobjectco.element "INCLUDE"> -<![ %imageobjectco.element; [ -<!--doc:A wrapper for an image object with callouts.--> -<!ELEMENT imageobjectco %ho; (areaspec, imageobject, calloutlist*)> -<!--end of imageobjectco.element-->]]> - -<!ENTITY % imageobjectco.attlist "INCLUDE"> -<![ %imageobjectco.attlist; [ -<!ATTLIST imageobjectco - %common.attrib; - %imageobjectco.role.attrib; - %local.imageobjectco.attrib; -> -<!--end of imageobjectco.attlist-->]]> -<!--end of imageobjectco.module-->]]> -<!--end of mediaobject.content.module-->]]> - -<!-- Equations ........................ --> - -<!-- This PE provides a mechanism for replacing equation content, --> -<!-- perhaps adding a new or different model (e.g., MathML) --> -<!ENTITY % equation.content "(alt?, (graphic+|mediaobject+|mathphrase+))"> -<!ENTITY % inlineequation.content "(alt?, (graphic+|inlinemediaobject+|mathphrase+))"> - -<!ENTITY % equation.module "INCLUDE"> -<![%equation.module;[ -<!ENTITY % local.equation.attrib ""> -<!ENTITY % equation.role.attrib "%role.attrib;"> - -<!ENTITY % equation.element "INCLUDE"> -<![%equation.element;[ -<!--doc:A displayed mathematical equation.--> -<!ELEMENT equation %ho; (blockinfo?, (%formalobject.title.content;)?, - (informalequation | %equation.content;))> -<!--end of equation.element-->]]> - -<!ENTITY % equation.attlist "INCLUDE"> -<![%equation.attlist;[ -<!ATTLIST equation - floatstyle CDATA #IMPLIED - %label.attrib; - %common.attrib; - %equation.role.attrib; - %local.equation.attrib; -> -<!--end of equation.attlist-->]]> -<!--end of equation.module-->]]> - -<!ENTITY % informalequation.module "INCLUDE"> -<![%informalequation.module;[ -<!ENTITY % local.informalequation.attrib ""> -<!ENTITY % informalequation.role.attrib "%role.attrib;"> - -<!ENTITY % informalequation.element "INCLUDE"> -<![%informalequation.element;[ -<!--doc:A displayed mathematical equation without a title.--> -<!ELEMENT informalequation %ho; (blockinfo?, %equation.content;) > -<!--end of informalequation.element-->]]> - -<!ENTITY % informalequation.attlist "INCLUDE"> -<![%informalequation.attlist;[ -<!ATTLIST informalequation - floatstyle CDATA #IMPLIED - %common.attrib; - %informalequation.role.attrib; - %local.informalequation.attrib; -> -<!--end of informalequation.attlist-->]]> -<!--end of informalequation.module-->]]> - -<!ENTITY % inlineequation.module "INCLUDE"> -<![%inlineequation.module;[ -<!ENTITY % local.inlineequation.attrib ""> -<!ENTITY % inlineequation.role.attrib "%role.attrib;"> - -<!ENTITY % inlineequation.element "INCLUDE"> -<![%inlineequation.element;[ -<!--doc:A mathematical equation or expression occurring inline.--> -<!ELEMENT inlineequation %ho; (%inlineequation.content;)> -<!--end of inlineequation.element-->]]> - -<!ENTITY % inlineequation.attlist "INCLUDE"> -<![%inlineequation.attlist;[ -<!ATTLIST inlineequation - %common.attrib; - %inlineequation.role.attrib; - %local.inlineequation.attrib; -> -<!--end of inlineequation.attlist-->]]> -<!--end of inlineequation.module-->]]> - -<!ENTITY % alt.module "INCLUDE"> -<![%alt.module;[ -<!ENTITY % local.alt.attrib ""> -<!ENTITY % alt.role.attrib "%role.attrib;"> - -<!ENTITY % alt.element "INCLUDE"> -<![%alt.element;[ -<!--doc:Text representation for a graphical element.--> -<!ELEMENT alt %ho; (#PCDATA)> -<!--end of alt.element-->]]> - -<!ENTITY % alt.attlist "INCLUDE"> -<![%alt.attlist;[ -<!ATTLIST alt - %common.attrib; - %alt.role.attrib; - %local.alt.attrib; -> -<!--end of alt.attlist-->]]> -<!--end of alt.module-->]]> - -<!ENTITY % mathphrase.module "INCLUDE"> -<![%mathphrase.module;[ -<!ENTITY % local.mathphrase.attrib ""> -<!ENTITY % mathphrase.role.attrib "%role.attrib;"> - -<!ENTITY % mathphrase.element "INCLUDE"> -<![%mathphrase.element;[ -<!--doc:A mathematical phrase, an expression that can be represented with ordinary text and a small amount of markup.--> -<!ELEMENT mathphrase %ho; (#PCDATA|subscript|superscript|emphasis)*> -<!--end of mathphrase.element-->]]> - -<!ENTITY % mathphrase.attlist "INCLUDE"> -<![%mathphrase.attlist;[ -<!ATTLIST mathphrase - %common.attrib; - %mathphrase.role.attrib; - %local.mathphrase.attrib; -> -<!--end of mathphrase.attlist-->]]> -<!--end of mathphrase.module-->]]> - -<!-- Tables ........................... --> - -<!ENTITY % table.module "INCLUDE"> -<![%table.module;[ - -<!-- Choose a table model. CALS or OASIS XML Exchange --> - -<!ENTITY % cals.table.module "INCLUDE"> -<![%cals.table.module;[ -<!ENTITY % exchange.table.module "IGNORE"> -]]> -<!ENTITY % exchange.table.module "INCLUDE"> - -<!-- Do we allow the HTML table model as well? --> -<!ENTITY % allow.html.tables "INCLUDE"> -<![%allow.html.tables;[ - <!-- ====================================================== --> - <!-- xhtmltbl.mod defines HTML tables and sets parameter - entities so that, when the CALS table module is read, - we end up allowing any table to be CALS or HTML. - i.e. This include must come first! --> - <!-- ====================================================== --> - -<!ENTITY % htmltbl - PUBLIC "-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" - "htmltblx.mod"> -%htmltbl; -<!--end of allow.html.tables-->]]> - -<!ENTITY % tables.role.attrib "%role.attrib;"> - -<![%cals.table.module;[ -<!-- Add label and role attributes to table and informaltable --> -<!ENTITY % bodyatt " - floatstyle CDATA #IMPLIED - rowheader (firstcol|norowheader) #IMPLIED - %label.attrib;" -> - -<!-- Add common attributes to Table, TGroup, TBody, THead, TFoot, Row, - EntryTbl, and Entry (and InformalTable element). --> -<!ENTITY % secur - "%common.attrib; - %tables.role.attrib;"> - -<!ENTITY % common.table.attribs - "%bodyatt; - %secur;"> - -<!-- Content model for Table. --> -<!ENTITY % tbl.table.mdl - "(blockinfo?, (%formalobject.title.content;), (%ndxterm.class;)*, - textobject*, - (graphic+|mediaobject+|tgroup+))"> - -<!-- Allow either objects or inlines; beware of REs between elements. --> -<!ENTITY % tbl.entry.mdl "%para.char.mix; | %tabentry.mix;"> - -<!-- Reference CALS Table Model --> -<!ENTITY % tablemodel - PUBLIC "-//OASIS//DTD DocBook CALS Table Model V4.5//EN" - "calstblx.dtd"> -]]> - -<![%exchange.table.module;[ -<!-- Add common attributes and the Label attribute to Table and --> -<!-- InformalTable. --> -<!ENTITY % bodyatt - "%common.attrib; - rowheader (firstcol|norowheader) #IMPLIED - %label.attrib; - %tables.role.attrib;"> - -<!ENTITY % common.table.attribs - "%bodyatt;"> - -<!-- Add common attributes to TGroup, ColSpec, TBody, THead, Row, Entry --> - -<!ENTITY % tbl.tgroup.att "%common.attrib;"> -<!ENTITY % tbl.colspec.att "%common.attrib;"> -<!ENTITY % tbl.tbody.att "%common.attrib;"> -<!ENTITY % tbl.thead.att "%common.attrib;"> -<!ENTITY % tbl.row.att "%common.attrib;"> -<!ENTITY % tbl.entry.att "%common.attrib;"> - -<!-- Content model for Table. --> -<!ENTITY % tbl.table.mdl - "(blockinfo?, (%formalobject.title.content;), (%ndxterm.class;)*, - textobject*, - (graphic+|mediaobject+|tgroup+))"> - -<!-- Allow either objects or inlines; beware of REs between elements. --> -<!ENTITY % tbl.entry.mdl "(%para.char.mix; | %tabentry.mix;)*"> - -<!-- Reference OASIS Exchange Table Model --> -<!ENTITY % tablemodel - PUBLIC "-//OASIS//DTD XML Exchange Table Model 19990315//EN" - "soextblx.dtd"> -]]> - -%tablemodel; - -<!--end of table.module-->]]> - -<!ENTITY % informaltable.module "INCLUDE"> -<![%informaltable.module;[ - -<!-- Note that InformalTable is dependent on some of the entity - declarations that customize Table. --> - -<!ENTITY % local.informaltable.attrib ""> - -<!-- the following entity may have been declared by the XHTML table module --> -<!ENTITY % informal.tbl.table.mdl "textobject*, (graphic+|mediaobject+|tgroup+)"> - -<!ENTITY % informaltable.element "INCLUDE"> -<![%informaltable.element;[ -<!--doc:A table without a title.--> -<!ELEMENT informaltable %ho; (blockinfo?, (%informal.tbl.table.mdl;))> -<!--end of informaltable.element-->]]> - -<!-- Frame, Colsep, and Rowsep must be repeated because - they are not in entities in the table module. --> -<!-- includes TabStyle, ToCentry, ShortEntry, - Orient, PgWide --> -<!-- includes Label --> -<!-- includes common attributes --> - -<!ENTITY % informaltable.attlist "INCLUDE"> -<![%informaltable.attlist;[ -<!ATTLIST informaltable - frame (%tbl.frame.attval;) #IMPLIED - colsep %yesorno.attvals; #IMPLIED - rowsep %yesorno.attvals; #IMPLIED - %common.table.attribs; - %tbl.table.att; - %local.informaltable.attrib; -> -<!--end of informaltable.attlist-->]]> -<!--end of informaltable.module-->]]> - -<!ENTITY % caption.module "INCLUDE"> -<![ %caption.module; [ -<!ENTITY % local.caption.attrib ""> -<!ENTITY % caption.role.attrib "%role.attrib;"> - -<!ENTITY % caption.element "INCLUDE"> -<![ %caption.element; [ -<!--doc:A caption.--> -<!ELEMENT caption %ho; (#PCDATA | %textobject.mix;)*> -<!--end of caption.element-->]]> - -<!ENTITY % caption.attlist "INCLUDE"> -<![ %caption.attlist; [ -<!-- attrs comes from HTML tables ... --> - -<![ %allow.html.tables; [ -<!-- common.attrib, but without ID because ID is in attrs --> -<!ENTITY % caption.attlist.content " - %caption.role.attrib; - %attrs; - align (top|bottom|left|right) #IMPLIED - %local.caption.attrib; -"> -]]> -<!ENTITY % caption.attlist.content " - %common.attrib; - %caption.role.attrib; - %local.caption.attrib; -"> - -<!ATTLIST caption %caption.attlist.content;> - -<!--end of caption.attlist-->]]> -<!--end of caption.module-->]]> - -<!-- ...................................................................... --> -<!-- Synopses ............................................................. --> - -<!-- Synopsis ......................... --> - -<!ENTITY % synopsis.module "INCLUDE"> -<![%synopsis.module;[ -<!ENTITY % local.synopsis.attrib ""> -<!ENTITY % synopsis.role.attrib "%role.attrib;"> - -<!ENTITY % synopsis.element "INCLUDE"> -<![%synopsis.element;[ -<!--doc:A general-purpose element for representing the syntax of commands or functions.--> -<!ELEMENT synopsis %ho; (%para.char.mix;|graphic|mediaobject|co|coref|textobject|lineannotation)*> -<!--end of synopsis.element-->]]> - -<!ENTITY % synopsis.attlist "INCLUDE"> -<![%synopsis.attlist;[ -<!ATTLIST synopsis - %label.attrib; - %linespecific.attrib; - %common.attrib; - %synopsis.role.attrib; - %local.synopsis.attrib; -> -<!--end of synopsis.attlist-->]]> - -<!-- LineAnnotation (defined in the Inlines section, below)--> -<!--end of synopsis.module-->]]> - -<!-- CmdSynopsis ...................... --> - -<!ENTITY % cmdsynopsis.content.module "INCLUDE"> -<![%cmdsynopsis.content.module;[ -<!ENTITY % cmdsynopsis.module "INCLUDE"> -<![%cmdsynopsis.module;[ -<!ENTITY % local.cmdsynopsis.attrib ""> -<!ENTITY % cmdsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % cmdsynopsis.element "INCLUDE"> -<![%cmdsynopsis.element;[ -<!--doc:A syntax summary for a software command.--> -<!ELEMENT cmdsynopsis %ho; ((command | arg | group | sbr)+, synopfragment*)> -<!--end of cmdsynopsis.element-->]]> - -<!-- Sepchar: Character that should separate command and all - top-level arguments; alternate value might be e.g., Δ --> - - -<!ENTITY % cmdsynopsis.attlist "INCLUDE"> -<![%cmdsynopsis.attlist;[ -<!ATTLIST cmdsynopsis - %label.attrib; - sepchar CDATA " " - cmdlength CDATA #IMPLIED - %common.attrib; - %cmdsynopsis.role.attrib; - %local.cmdsynopsis.attrib; -> -<!--end of cmdsynopsis.attlist-->]]> -<!--end of cmdsynopsis.module-->]]> - -<!ENTITY % arg.module "INCLUDE"> -<![%arg.module;[ -<!ENTITY % local.arg.attrib ""> -<!ENTITY % arg.role.attrib "%role.attrib;"> - -<!ENTITY % arg.element "INCLUDE"> -<![%arg.element;[ -<!--doc:An argument in a CmdSynopsis.--> -<!ELEMENT arg %ho; (#PCDATA - | arg - | group - | option - | synopfragmentref - | replaceable - | sbr)*> -<!--end of arg.element-->]]> - -<!-- Choice: Whether Arg must be supplied: Opt (optional to - supply, e.g. [arg]; the default), Req (required to supply, - e.g. {arg}), or Plain (required to supply, e.g. arg) --> -<!-- Rep: whether Arg is repeatable: Norepeat (e.g. arg without - ellipsis; the default), or Repeat (e.g. arg...) --> - - -<!ENTITY % arg.attlist "INCLUDE"> -<![%arg.attlist;[ -<!ATTLIST arg - choice (opt - |req - |plain) 'opt' - rep (norepeat - |repeat) 'norepeat' - %common.attrib; - %arg.role.attrib; - %local.arg.attrib; -> -<!--end of arg.attlist-->]]> -<!--end of arg.module-->]]> - -<!ENTITY % group.module "INCLUDE"> -<![%group.module;[ - -<!ENTITY % local.group.attrib ""> -<!ENTITY % group.role.attrib "%role.attrib;"> - -<!ENTITY % group.element "INCLUDE"> -<![%group.element;[ -<!--doc:A group of elements in a CmdSynopsis.--> -<!ELEMENT group %ho; ((arg | group | option | synopfragmentref - | replaceable | sbr)+)> -<!--end of group.element-->]]> - -<!-- Choice: Whether Group must be supplied: Opt (optional to - supply, e.g. [g1|g2|g3]; the default), Req (required to - supply, e.g. {g1|g2|g3}), Plain (required to supply, - e.g. g1|g2|g3), OptMult (can supply zero or more, e.g. - [[g1|g2|g3]]), or ReqMult (must supply one or more, e.g. - {{g1|g2|g3}}) --> -<!-- Rep: whether Group is repeatable: Norepeat (e.g. group - without ellipsis; the default), or Repeat (e.g. group...) --> - - -<!ENTITY % group.attlist "INCLUDE"> -<![%group.attlist;[ -<!ATTLIST group - choice (opt - |req - |plain) 'opt' - rep (norepeat - |repeat) 'norepeat' - %common.attrib; - %group.role.attrib; - %local.group.attrib; -> -<!--end of group.attlist-->]]> -<!--end of group.module-->]]> - -<!ENTITY % sbr.module "INCLUDE"> -<![%sbr.module;[ -<!ENTITY % local.sbr.attrib ""> -<!-- Synopsis break --> -<!ENTITY % sbr.role.attrib "%role.attrib;"> - -<!ENTITY % sbr.element "INCLUDE"> -<![%sbr.element;[ -<!--doc:An explicit line break in a command synopsis.--> -<!ELEMENT sbr %ho; EMPTY> -<!--end of sbr.element-->]]> - -<!ENTITY % sbr.attlist "INCLUDE"> -<![%sbr.attlist;[ -<!ATTLIST sbr - %common.attrib; - %sbr.role.attrib; - %local.sbr.attrib; -> -<!--end of sbr.attlist-->]]> -<!--end of sbr.module-->]]> - -<!ENTITY % synopfragmentref.module "INCLUDE"> -<![%synopfragmentref.module;[ -<!ENTITY % local.synopfragmentref.attrib ""> -<!ENTITY % synopfragmentref.role.attrib "%role.attrib;"> - -<!ENTITY % synopfragmentref.element "INCLUDE"> -<![%synopfragmentref.element;[ -<!--doc:A reference to a fragment of a command synopsis.--> -<!ELEMENT synopfragmentref %ho; (#PCDATA)> -<!--end of synopfragmentref.element-->]]> - -<!-- to SynopFragment of complex synopsis - material for separate referencing --> - - -<!ENTITY % synopfragmentref.attlist "INCLUDE"> -<![%synopfragmentref.attlist;[ -<!ATTLIST synopfragmentref - %linkendreq.attrib; %common.attrib; - %synopfragmentref.role.attrib; - %local.synopfragmentref.attrib; -> -<!--end of synopfragmentref.attlist-->]]> -<!--end of synopfragmentref.module-->]]> - -<!ENTITY % synopfragment.module "INCLUDE"> -<![%synopfragment.module;[ -<!ENTITY % local.synopfragment.attrib ""> -<!ENTITY % synopfragment.role.attrib "%role.attrib;"> - -<!ENTITY % synopfragment.element "INCLUDE"> -<![%synopfragment.element;[ -<!--doc:A portion of a CmdSynopsis broken out from the main body of the synopsis.--> -<!ELEMENT synopfragment %ho; ((arg | group)+)> -<!--end of synopfragment.element-->]]> - -<!ENTITY % synopfragment.attlist "INCLUDE"> -<![%synopfragment.attlist;[ -<!ATTLIST synopfragment - %idreq.common.attrib; - %synopfragment.role.attrib; - %local.synopfragment.attrib; -> -<!--end of synopfragment.attlist-->]]> -<!--end of synopfragment.module-->]]> - -<!-- Command (defined in the Inlines section, below)--> -<!-- Option (defined in the Inlines section, below)--> -<!-- Replaceable (defined in the Inlines section, below)--> -<!--end of cmdsynopsis.content.module-->]]> - -<!-- FuncSynopsis ..................... --> - -<!ENTITY % funcsynopsis.content.module "INCLUDE"> -<![%funcsynopsis.content.module;[ -<!ENTITY % funcsynopsis.module "INCLUDE"> -<![%funcsynopsis.module;[ - -<!ENTITY % local.funcsynopsis.attrib ""> -<!ENTITY % funcsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % funcsynopsis.element "INCLUDE"> -<![%funcsynopsis.element;[ -<!--doc:The syntax summary for a function definition.--> -<!ELEMENT funcsynopsis %ho; ((funcsynopsisinfo | funcprototype)+)> -<!--end of funcsynopsis.element-->]]> - -<!ENTITY % funcsynopsis.attlist "INCLUDE"> -<![%funcsynopsis.attlist;[ -<!ATTLIST funcsynopsis - %label.attrib; - %common.attrib; - %funcsynopsis.role.attrib; - %local.funcsynopsis.attrib; -> -<!--end of funcsynopsis.attlist-->]]> -<!--end of funcsynopsis.module-->]]> - -<!ENTITY % funcsynopsisinfo.module "INCLUDE"> -<![%funcsynopsisinfo.module;[ -<!ENTITY % local.funcsynopsisinfo.attrib ""> -<!ENTITY % funcsynopsisinfo.role.attrib "%role.attrib;"> - -<!ENTITY % funcsynopsisinfo.element "INCLUDE"> -<![%funcsynopsisinfo.element;[ -<!--doc:Information supplementing the FuncDefs of a FuncSynopsis.--> -<!ELEMENT funcsynopsisinfo %ho; (%cptr.char.mix;|textobject|lineannotation)*> -<!--end of funcsynopsisinfo.element-->]]> - -<!ENTITY % funcsynopsisinfo.attlist "INCLUDE"> -<![%funcsynopsisinfo.attlist;[ -<!ATTLIST funcsynopsisinfo - %linespecific.attrib; - %common.attrib; - %funcsynopsisinfo.role.attrib; - %local.funcsynopsisinfo.attrib; -> -<!--end of funcsynopsisinfo.attlist-->]]> -<!--end of funcsynopsisinfo.module-->]]> - -<!ENTITY % funcprototype.module "INCLUDE"> -<![%funcprototype.module;[ -<!ENTITY % local.funcprototype.attrib ""> -<!ENTITY % funcprototype.role.attrib "%role.attrib;"> - -<!ENTITY % funcprototype.element "INCLUDE"> -<![%funcprototype.element;[ -<!--doc:The prototype of a function.--> -<!ELEMENT funcprototype %ho; (modifier*, - funcdef, - (void|varargs|(paramdef+, varargs?)), - modifier*)> - -<!--end of funcprototype.element-->]]> - -<!ENTITY % funcprototype.attlist "INCLUDE"> -<![%funcprototype.attlist;[ -<!ATTLIST funcprototype - %common.attrib; - %funcprototype.role.attrib; - %local.funcprototype.attrib; -> -<!--end of funcprototype.attlist-->]]> -<!--end of funcprototype.module-->]]> - -<!ENTITY % funcdef.module "INCLUDE"> -<![%funcdef.module;[ -<!ENTITY % local.funcdef.attrib ""> -<!ENTITY % funcdef.role.attrib "%role.attrib;"> - -<!ENTITY % funcdef.element "INCLUDE"> -<![%funcdef.element;[ -<!--doc:A function (subroutine) name and its return type.--> -<!ELEMENT funcdef %ho; (#PCDATA - | type - | replaceable - | function)*> -<!--end of funcdef.element-->]]> - -<!ENTITY % funcdef.attlist "INCLUDE"> -<![%funcdef.attlist;[ -<!ATTLIST funcdef - %common.attrib; - %funcdef.role.attrib; - %local.funcdef.attrib; -> -<!--end of funcdef.attlist-->]]> -<!--end of funcdef.module-->]]> - -<!ENTITY % void.module "INCLUDE"> -<![%void.module;[ -<!ENTITY % local.void.attrib ""> -<!ENTITY % void.role.attrib "%role.attrib;"> - -<!ENTITY % void.element "INCLUDE"> -<![%void.element;[ -<!--doc:An empty element in a function synopsis indicating that the function in question takes no arguments.--> -<!ELEMENT void %ho; EMPTY> -<!--end of void.element-->]]> - -<!ENTITY % void.attlist "INCLUDE"> -<![%void.attlist;[ -<!ATTLIST void - %common.attrib; - %void.role.attrib; - %local.void.attrib; -> -<!--end of void.attlist-->]]> -<!--end of void.module-->]]> - -<!ENTITY % varargs.module "INCLUDE"> -<![%varargs.module;[ -<!ENTITY % local.varargs.attrib ""> -<!ENTITY % varargs.role.attrib "%role.attrib;"> - -<!ENTITY % varargs.element "INCLUDE"> -<![%varargs.element;[ -<!--doc:An empty element in a function synopsis indicating a variable number of arguments.--> -<!ELEMENT varargs %ho; EMPTY> -<!--end of varargs.element-->]]> - -<!ENTITY % varargs.attlist "INCLUDE"> -<![%varargs.attlist;[ -<!ATTLIST varargs - %common.attrib; - %varargs.role.attrib; - %local.varargs.attrib; -> -<!--end of varargs.attlist-->]]> -<!--end of varargs.module-->]]> - -<!-- Processing assumes that only one Parameter will appear in a - ParamDef, and that FuncParams will be used at most once, for - providing information on the "inner parameters" for parameters that - are pointers to functions. --> - -<!ENTITY % paramdef.module "INCLUDE"> -<![%paramdef.module;[ -<!ENTITY % local.paramdef.attrib ""> -<!ENTITY % paramdef.role.attrib "%role.attrib;"> - -<!ENTITY % paramdef.element "INCLUDE"> -<![%paramdef.element;[ -<!--doc:Information about a function parameter in a programming language.--> -<!ELEMENT paramdef %ho; (#PCDATA - | initializer - | type - | replaceable - | parameter - | funcparams)*> -<!--end of paramdef.element-->]]> - -<!ENTITY % paramdef.attlist "INCLUDE"> -<![%paramdef.attlist;[ -<!ATTLIST paramdef - choice (opt - |req) #IMPLIED - %common.attrib; - %paramdef.role.attrib; - %local.paramdef.attrib; -> -<!--end of paramdef.attlist-->]]> -<!--end of paramdef.module-->]]> - -<!ENTITY % funcparams.module "INCLUDE"> -<![%funcparams.module;[ -<!ENTITY % local.funcparams.attrib ""> -<!ENTITY % funcparams.role.attrib "%role.attrib;"> - -<!ENTITY % funcparams.element "INCLUDE"> -<![%funcparams.element;[ -<!--doc:Parameters for a function referenced through a function pointer in a synopsis.--> -<!ELEMENT funcparams %ho; (%cptr.char.mix;)*> -<!--end of funcparams.element-->]]> - -<!ENTITY % funcparams.attlist "INCLUDE"> -<![%funcparams.attlist;[ -<!ATTLIST funcparams - %common.attrib; - %funcparams.role.attrib; - %local.funcparams.attrib; -> -<!--end of funcparams.attlist-->]]> -<!--end of funcparams.module-->]]> - -<!-- LineAnnotation (defined in the Inlines section, below)--> -<!-- Replaceable (defined in the Inlines section, below)--> -<!-- Function (defined in the Inlines section, below)--> -<!-- Parameter (defined in the Inlines section, below)--> -<!--end of funcsynopsis.content.module-->]]> - -<!-- ClassSynopsis ..................... --> - -<!ENTITY % classsynopsis.content.module "INCLUDE"> -<![%classsynopsis.content.module;[ - -<!ENTITY % classsynopsis.module "INCLUDE"> -<![%classsynopsis.module;[ -<!ENTITY % local.classsynopsis.attrib ""> -<!ENTITY % classsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % classsynopsis.element "INCLUDE"> -<![%classsynopsis.element;[ -<!--doc:The syntax summary for a class definition.--> -<!ELEMENT classsynopsis %ho; ((ooclass|oointerface|ooexception)+, - (classsynopsisinfo - |fieldsynopsis|%method.synop.class;)*)> -<!--end of classsynopsis.element-->]]> - -<!ENTITY % classsynopsis.attlist "INCLUDE"> -<![%classsynopsis.attlist;[ -<!ATTLIST classsynopsis - language CDATA #IMPLIED - class (class|interface) "class" - %common.attrib; - %classsynopsis.role.attrib; - %local.classsynopsis.attrib; -> -<!--end of classsynopsis.attlist-->]]> -<!--end of classsynopsis.module-->]]> - -<!ENTITY % classsynopsisinfo.module "INCLUDE"> -<![ %classsynopsisinfo.module; [ -<!ENTITY % local.classsynopsisinfo.attrib ""> -<!ENTITY % classsynopsisinfo.role.attrib "%role.attrib;"> - -<!ENTITY % classsynopsisinfo.element "INCLUDE"> -<![ %classsynopsisinfo.element; [ -<!--doc:Information supplementing the contents of a ClassSynopsis.--> -<!ELEMENT classsynopsisinfo %ho; (%cptr.char.mix;|textobject|lineannotation)*> -<!--end of classsynopsisinfo.element-->]]> - -<!ENTITY % classsynopsisinfo.attlist "INCLUDE"> -<![ %classsynopsisinfo.attlist; [ -<!ATTLIST classsynopsisinfo - %linespecific.attrib; - %common.attrib; - %classsynopsisinfo.role.attrib; - %local.classsynopsisinfo.attrib; -> -<!--end of classsynopsisinfo.attlist-->]]> -<!--end of classsynopsisinfo.module-->]]> - -<!ENTITY % ooclass.module "INCLUDE"> -<![%ooclass.module;[ -<!ENTITY % local.ooclass.attrib ""> -<!ENTITY % ooclass.role.attrib "%role.attrib;"> - -<!ENTITY % ooclass.element "INCLUDE"> -<![%ooclass.element;[ -<!--doc:A class in an object-oriented programming language.--> -<!ELEMENT ooclass %ho; ((modifier|package)*, classname)> -<!--end of ooclass.element-->]]> - -<!ENTITY % ooclass.attlist "INCLUDE"> -<![%ooclass.attlist;[ -<!ATTLIST ooclass - %common.attrib; - %ooclass.role.attrib; - %local.ooclass.attrib; -> -<!--end of ooclass.attlist-->]]> -<!--end of ooclass.module-->]]> - -<!ENTITY % oointerface.module "INCLUDE"> -<![%oointerface.module;[ -<!ENTITY % local.oointerface.attrib ""> -<!ENTITY % oointerface.role.attrib "%role.attrib;"> - -<!ENTITY % oointerface.element "INCLUDE"> -<![%oointerface.element;[ -<!--doc:An interface in an object-oriented programming language.--> -<!ELEMENT oointerface %ho; ((modifier|package)*, interfacename)> -<!--end of oointerface.element-->]]> - -<!ENTITY % oointerface.attlist "INCLUDE"> -<![%oointerface.attlist;[ -<!ATTLIST oointerface - %common.attrib; - %oointerface.role.attrib; - %local.oointerface.attrib; -> -<!--end of oointerface.attlist-->]]> -<!--end of oointerface.module-->]]> - -<!ENTITY % ooexception.module "INCLUDE"> -<![%ooexception.module;[ -<!ENTITY % local.ooexception.attrib ""> -<!ENTITY % ooexception.role.attrib "%role.attrib;"> - -<!ENTITY % ooexception.element "INCLUDE"> -<![%ooexception.element;[ -<!--doc:An exception in an object-oriented programming language.--> -<!ELEMENT ooexception %ho; ((modifier|package)*, exceptionname)> -<!--end of ooexception.element-->]]> - -<!ENTITY % ooexception.attlist "INCLUDE"> -<![%ooexception.attlist;[ -<!ATTLIST ooexception - %common.attrib; - %ooexception.role.attrib; - %local.ooexception.attrib; -> -<!--end of ooexception.attlist-->]]> -<!--end of ooexception.module-->]]> - -<!ENTITY % modifier.module "INCLUDE"> -<![%modifier.module;[ -<!ENTITY % local.modifier.attrib ""> -<!ENTITY % modifier.role.attrib "%role.attrib;"> - -<!ENTITY % modifier.element "INCLUDE"> -<![%modifier.element;[ -<!--doc:Modifiers in a synopsis.--> -<!ELEMENT modifier %ho; (%smallcptr.char.mix;)*> -<!--end of modifier.element-->]]> - -<!ENTITY % modifier.attlist "INCLUDE"> -<![%modifier.attlist;[ -<!ATTLIST modifier - %common.attrib; - %modifier.role.attrib; - %local.modifier.attrib; -> -<!--end of modifier.attlist-->]]> -<!--end of modifier.module-->]]> - -<!ENTITY % interfacename.module "INCLUDE"> -<![%interfacename.module;[ -<!ENTITY % local.interfacename.attrib ""> -<!ENTITY % interfacename.role.attrib "%role.attrib;"> - -<!ENTITY % interfacename.element "INCLUDE"> -<![%interfacename.element;[ -<!--doc:The name of an interface.--> -<!ELEMENT interfacename %ho; (%cptr.char.mix;)*> -<!--end of interfacename.element-->]]> - -<!ENTITY % interfacename.attlist "INCLUDE"> -<![%interfacename.attlist;[ -<!ATTLIST interfacename - %common.attrib; - %interfacename.role.attrib; - %local.interfacename.attrib; -> -<!--end of interfacename.attlist-->]]> -<!--end of interfacename.module-->]]> - -<!ENTITY % exceptionname.module "INCLUDE"> -<![%exceptionname.module;[ -<!ENTITY % local.exceptionname.attrib ""> -<!ENTITY % exceptionname.role.attrib "%role.attrib;"> - -<!ENTITY % exceptionname.element "INCLUDE"> -<![%exceptionname.element;[ -<!--doc:The name of an exception.--> -<!ELEMENT exceptionname %ho; (%smallcptr.char.mix;)*> -<!--end of exceptionname.element-->]]> - -<!ENTITY % exceptionname.attlist "INCLUDE"> -<![%exceptionname.attlist;[ -<!ATTLIST exceptionname - %common.attrib; - %exceptionname.role.attrib; - %local.exceptionname.attrib; -> -<!--end of exceptionname.attlist-->]]> -<!--end of exceptionname.module-->]]> - -<!ENTITY % fieldsynopsis.module "INCLUDE"> -<![%fieldsynopsis.module;[ -<!ENTITY % local.fieldsynopsis.attrib ""> -<!ENTITY % fieldsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % fieldsynopsis.element "INCLUDE"> -<![%fieldsynopsis.element;[ -<!--doc:The name of a field in a class definition.--> -<!ELEMENT fieldsynopsis %ho; (modifier*, type?, varname, initializer?)> -<!--end of fieldsynopsis.element-->]]> - -<!ENTITY % fieldsynopsis.attlist "INCLUDE"> -<![%fieldsynopsis.attlist;[ -<!ATTLIST fieldsynopsis - language CDATA #IMPLIED - %common.attrib; - %fieldsynopsis.role.attrib; - %local.fieldsynopsis.attrib; -> -<!--end of fieldsynopsis.attlist-->]]> -<!--end of fieldsynopsis.module-->]]> - -<!ENTITY % initializer.module "INCLUDE"> -<![%initializer.module;[ -<!ENTITY % local.initializer.attrib ""> -<!ENTITY % initializer.role.attrib "%role.attrib;"> - -<!ENTITY % initializer.element "INCLUDE"> -<![%initializer.element;[ -<!--doc:The initializer for a FieldSynopsis.--> -<!ELEMENT initializer %ho; (%smallcptr.char.mix;)*> -<!--end of initializer.element-->]]> - -<!ENTITY % initializer.attlist "INCLUDE"> -<![%initializer.attlist;[ -<!ATTLIST initializer - %common.attrib; - %initializer.role.attrib; - %local.initializer.attrib; -> -<!--end of initializer.attlist-->]]> -<!--end of initializer.module-->]]> - -<!ENTITY % constructorsynopsis.module "INCLUDE"> -<![%constructorsynopsis.module;[ -<!ENTITY % local.constructorsynopsis.attrib ""> -<!ENTITY % constructorsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % constructorsynopsis.element "INCLUDE"> -<![%constructorsynopsis.element;[ -<!--doc:A syntax summary for a constructor.--> -<!ELEMENT constructorsynopsis %ho; (modifier*, - methodname?, - (methodparam+|void?), - exceptionname*)> -<!--end of constructorsynopsis.element-->]]> - -<!ENTITY % constructorsynopsis.attlist "INCLUDE"> -<![%constructorsynopsis.attlist;[ -<!ATTLIST constructorsynopsis - language CDATA #IMPLIED - %common.attrib; - %constructorsynopsis.role.attrib; - %local.constructorsynopsis.attrib; -> -<!--end of constructorsynopsis.attlist-->]]> -<!--end of constructorsynopsis.module-->]]> - -<!ENTITY % destructorsynopsis.module "INCLUDE"> -<![%destructorsynopsis.module;[ -<!ENTITY % local.destructorsynopsis.attrib ""> -<!ENTITY % destructorsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % destructorsynopsis.element "INCLUDE"> -<![%destructorsynopsis.element;[ -<!--doc:A syntax summary for a destructor.--> -<!ELEMENT destructorsynopsis %ho; (modifier*, - methodname?, - (methodparam+|void?), - exceptionname*)> -<!--end of destructorsynopsis.element-->]]> - -<!ENTITY % destructorsynopsis.attlist "INCLUDE"> -<![%destructorsynopsis.attlist;[ -<!ATTLIST destructorsynopsis - language CDATA #IMPLIED - %common.attrib; - %destructorsynopsis.role.attrib; - %local.destructorsynopsis.attrib; -> -<!--end of destructorsynopsis.attlist-->]]> -<!--end of destructorsynopsis.module-->]]> - -<!ENTITY % methodsynopsis.module "INCLUDE"> -<![%methodsynopsis.module;[ -<!ENTITY % local.methodsynopsis.attrib ""> -<!ENTITY % methodsynopsis.role.attrib "%role.attrib;"> - -<!ENTITY % methodsynopsis.element "INCLUDE"> -<![%methodsynopsis.element;[ -<!--doc:A syntax summary for a method.--> -<!ELEMENT methodsynopsis %ho; (modifier*, - (type|void)?, - methodname, - (methodparam+|void?), - exceptionname*, - modifier*)> -<!--end of methodsynopsis.element-->]]> - -<!ENTITY % methodsynopsis.attlist "INCLUDE"> -<![%methodsynopsis.attlist;[ -<!ATTLIST methodsynopsis - language CDATA #IMPLIED - %common.attrib; - %methodsynopsis.role.attrib; - %local.methodsynopsis.attrib; -> -<!--end of methodsynopsis.attlist-->]]> -<!--end of methodsynopsis.module-->]]> - -<!ENTITY % methodname.module "INCLUDE"> -<![%methodname.module;[ -<!ENTITY % local.methodname.attrib ""> -<!ENTITY % methodname.role.attrib "%role.attrib;"> - -<!ENTITY % methodname.element "INCLUDE"> -<![%methodname.element;[ -<!--doc:The name of a method.--> -<!ELEMENT methodname %ho; (%smallcptr.char.mix;)*> -<!--end of methodname.element-->]]> - -<!ENTITY % methodname.attlist "INCLUDE"> -<![%methodname.attlist;[ -<!ATTLIST methodname - %common.attrib; - %methodname.role.attrib; - %local.methodname.attrib; -> -<!--end of methodname.attlist-->]]> -<!--end of methodname.module-->]]> - -<!ENTITY % methodparam.module "INCLUDE"> -<![%methodparam.module;[ -<!ENTITY % local.methodparam.attrib ""> -<!ENTITY % methodparam.role.attrib "%role.attrib;"> - -<!ENTITY % methodparam.element "INCLUDE"> -<![%methodparam.element;[ -<!--doc:Parameters to a method.--> -<!ELEMENT methodparam %ho; (modifier*, - type?, - ((parameter,initializer?)|funcparams), - modifier*)> -<!--end of methodparam.element-->]]> - -<!ENTITY % methodparam.attlist "INCLUDE"> -<![%methodparam.attlist;[ -<!ATTLIST methodparam - choice (opt - |req - |plain) "req" - rep (norepeat - |repeat) "norepeat" - %common.attrib; - %methodparam.role.attrib; - %local.methodparam.attrib; -> -<!--end of methodparam.attlist-->]]> -<!--end of methodparam.module-->]]> -<!--end of classsynopsis.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Document information entities and elements ........................... --> - -<!-- The document information elements include some elements that are - currently used only in the document hierarchy module. They are - defined here so that they will be available for use in customized - document hierarchies. --> - -<!-- .................................. --> - -<!ENTITY % docinfo.content.module "INCLUDE"> -<![%docinfo.content.module;[ - -<!-- Ackno ............................ --> - -<!ENTITY % ackno.module "INCLUDE"> -<![%ackno.module;[ -<!ENTITY % local.ackno.attrib ""> -<!ENTITY % ackno.role.attrib "%role.attrib;"> - -<!ENTITY % ackno.element "INCLUDE"> -<![%ackno.element;[ -<!--doc:Acknowledgements in an Article.--> -<!ELEMENT ackno %ho; (%docinfo.char.mix;)*> -<!--end of ackno.element-->]]> - -<!ENTITY % ackno.attlist "INCLUDE"> -<![%ackno.attlist;[ -<!ATTLIST ackno - %common.attrib; - %ackno.role.attrib; - %local.ackno.attrib; -> -<!--end of ackno.attlist-->]]> -<!--end of ackno.module-->]]> - -<!-- Address .......................... --> - -<!ENTITY % address.content.module "INCLUDE"> -<![%address.content.module;[ -<!ENTITY % address.module "INCLUDE"> -<![%address.module;[ -<!ENTITY % local.address.attrib ""> -<!ENTITY % address.role.attrib "%role.attrib;"> - -<!ENTITY % address.element "INCLUDE"> -<![%address.element;[ -<!--doc:A real-world address, generally a postal address.--> -<!ELEMENT address %ho; (#PCDATA|personname|%person.ident.mix; - |street|pob|postcode|city|state|country|phone - |fax|email|otheraddr)*> -<!--end of address.element-->]]> - -<!ENTITY % address.attlist "INCLUDE"> -<![%address.attlist;[ -<!ATTLIST address - %linespecific.attrib; - %common.attrib; - %address.role.attrib; - %local.address.attrib; -> -<!--end of address.attlist-->]]> -<!--end of address.module-->]]> - - <!ENTITY % street.module "INCLUDE"> - <![%street.module;[ - <!ENTITY % local.street.attrib ""> - <!ENTITY % street.role.attrib "%role.attrib;"> - -<!ENTITY % street.element "INCLUDE"> -<![%street.element;[ -<!--doc:A street address in an address.--> -<!ELEMENT street %ho; (%docinfo.char.mix;)*> -<!--end of street.element-->]]> - -<!ENTITY % street.attlist "INCLUDE"> -<![%street.attlist;[ -<!ATTLIST street - %common.attrib; - %street.role.attrib; - %local.street.attrib; -> -<!--end of street.attlist-->]]> - <!--end of street.module-->]]> - - <!ENTITY % pob.module "INCLUDE"> - <![%pob.module;[ - <!ENTITY % local.pob.attrib ""> - <!ENTITY % pob.role.attrib "%role.attrib;"> - -<!ENTITY % pob.element "INCLUDE"> -<![%pob.element;[ -<!--doc:A post office box in an address.--> -<!ELEMENT pob %ho; (%docinfo.char.mix;)*> -<!--end of pob.element-->]]> - -<!ENTITY % pob.attlist "INCLUDE"> -<![%pob.attlist;[ -<!ATTLIST pob - %common.attrib; - %pob.role.attrib; - %local.pob.attrib; -> -<!--end of pob.attlist-->]]> - <!--end of pob.module-->]]> - - <!ENTITY % postcode.module "INCLUDE"> - <![%postcode.module;[ - <!ENTITY % local.postcode.attrib ""> - <!ENTITY % postcode.role.attrib "%role.attrib;"> - -<!ENTITY % postcode.element "INCLUDE"> -<![%postcode.element;[ -<!--doc:A postal code in an address.--> -<!ELEMENT postcode %ho; (%docinfo.char.mix;)*> -<!--end of postcode.element-->]]> - -<!ENTITY % postcode.attlist "INCLUDE"> -<![%postcode.attlist;[ -<!ATTLIST postcode - %common.attrib; - %postcode.role.attrib; - %local.postcode.attrib; -> -<!--end of postcode.attlist-->]]> - <!--end of postcode.module-->]]> - - <!ENTITY % city.module "INCLUDE"> - <![%city.module;[ - <!ENTITY % local.city.attrib ""> - <!ENTITY % city.role.attrib "%role.attrib;"> - -<!ENTITY % city.element "INCLUDE"> -<![%city.element;[ -<!--doc:The name of a city in an address.--> -<!ELEMENT city %ho; (%docinfo.char.mix;)*> -<!--end of city.element-->]]> - -<!ENTITY % city.attlist "INCLUDE"> -<![%city.attlist;[ -<!ATTLIST city - %common.attrib; - %city.role.attrib; - %local.city.attrib; -> -<!--end of city.attlist-->]]> - <!--end of city.module-->]]> - - <!ENTITY % state.module "INCLUDE"> - <![%state.module;[ - <!ENTITY % local.state.attrib ""> - <!ENTITY % state.role.attrib "%role.attrib;"> - -<!ENTITY % state.element "INCLUDE"> -<![%state.element;[ -<!--doc:A state or province in an address.--> -<!ELEMENT state %ho; (%docinfo.char.mix;)*> -<!--end of state.element-->]]> - -<!ENTITY % state.attlist "INCLUDE"> -<![%state.attlist;[ -<!ATTLIST state - %common.attrib; - %state.role.attrib; - %local.state.attrib; -> -<!--end of state.attlist-->]]> - <!--end of state.module-->]]> - - <!ENTITY % country.module "INCLUDE"> - <![%country.module;[ - <!ENTITY % local.country.attrib ""> - <!ENTITY % country.role.attrib "%role.attrib;"> - -<!ENTITY % country.element "INCLUDE"> -<![%country.element;[ -<!--doc:The name of a country.--> -<!ELEMENT country %ho; (%docinfo.char.mix;)*> -<!--end of country.element-->]]> - -<!ENTITY % country.attlist "INCLUDE"> -<![%country.attlist;[ -<!ATTLIST country - %common.attrib; - %country.role.attrib; - %local.country.attrib; -> -<!--end of country.attlist-->]]> - <!--end of country.module-->]]> - - <!ENTITY % phone.module "INCLUDE"> - <![%phone.module;[ - <!ENTITY % local.phone.attrib ""> - <!ENTITY % phone.role.attrib "%role.attrib;"> - -<!ENTITY % phone.element "INCLUDE"> -<![%phone.element;[ -<!--doc:A telephone number.--> -<!ELEMENT phone %ho; (%docinfo.char.mix;)*> -<!--end of phone.element-->]]> - -<!ENTITY % phone.attlist "INCLUDE"> -<![%phone.attlist;[ -<!ATTLIST phone - %common.attrib; - %phone.role.attrib; - %local.phone.attrib; -> -<!--end of phone.attlist-->]]> - <!--end of phone.module-->]]> - - <!ENTITY % fax.module "INCLUDE"> - <![%fax.module;[ - <!ENTITY % local.fax.attrib ""> - <!ENTITY % fax.role.attrib "%role.attrib;"> - -<!ENTITY % fax.element "INCLUDE"> -<![%fax.element;[ -<!--doc:A fax number.--> -<!ELEMENT fax %ho; (%docinfo.char.mix;)*> -<!--end of fax.element-->]]> - -<!ENTITY % fax.attlist "INCLUDE"> -<![%fax.attlist;[ -<!ATTLIST fax - %common.attrib; - %fax.role.attrib; - %local.fax.attrib; -> -<!--end of fax.attlist-->]]> - <!--end of fax.module-->]]> - - <!-- Email (defined in the Inlines section, below)--> - - <!ENTITY % otheraddr.module "INCLUDE"> - <![%otheraddr.module;[ - <!ENTITY % local.otheraddr.attrib ""> - <!ENTITY % otheraddr.role.attrib "%role.attrib;"> - -<!ENTITY % otheraddr.element "INCLUDE"> -<![%otheraddr.element;[ -<!--doc:Uncategorized information in address.--> -<!ELEMENT otheraddr %ho; (%docinfo.char.mix;)*> -<!--end of otheraddr.element-->]]> - -<!ENTITY % otheraddr.attlist "INCLUDE"> -<![%otheraddr.attlist;[ -<!ATTLIST otheraddr - %common.attrib; - %otheraddr.role.attrib; - %local.otheraddr.attrib; -> -<!--end of otheraddr.attlist-->]]> - <!--end of otheraddr.module-->]]> -<!--end of address.content.module-->]]> - -<!-- Affiliation ...................... --> - -<!ENTITY % affiliation.content.module "INCLUDE"> -<![%affiliation.content.module;[ -<!ENTITY % affiliation.module "INCLUDE"> -<![%affiliation.module;[ -<!ENTITY % local.affiliation.attrib ""> -<!ENTITY % affiliation.role.attrib "%role.attrib;"> - -<!ENTITY % affiliation.element "INCLUDE"> -<![%affiliation.element;[ -<!--doc:The institutional affiliation of an individual.--> -<!ELEMENT affiliation %ho; (shortaffil?, jobtitle*, orgname?, orgdiv*, - address*)> -<!--end of affiliation.element-->]]> - -<!ENTITY % affiliation.attlist "INCLUDE"> -<![%affiliation.attlist;[ -<!ATTLIST affiliation - %common.attrib; - %affiliation.role.attrib; - %local.affiliation.attrib; -> -<!--end of affiliation.attlist-->]]> -<!--end of affiliation.module-->]]> - - <!ENTITY % shortaffil.module "INCLUDE"> - <![%shortaffil.module;[ - <!ENTITY % local.shortaffil.attrib ""> - <!ENTITY % shortaffil.role.attrib "%role.attrib;"> - -<!ENTITY % shortaffil.element "INCLUDE"> -<![%shortaffil.element;[ -<!--doc:A brief description of an affiliation.--> -<!ELEMENT shortaffil %ho; (%docinfo.char.mix;)*> -<!--end of shortaffil.element-->]]> - -<!ENTITY % shortaffil.attlist "INCLUDE"> -<![%shortaffil.attlist;[ -<!ATTLIST shortaffil - %common.attrib; - %shortaffil.role.attrib; - %local.shortaffil.attrib; -> -<!--end of shortaffil.attlist-->]]> - <!--end of shortaffil.module-->]]> - - <!ENTITY % jobtitle.module "INCLUDE"> - <![%jobtitle.module;[ - <!ENTITY % local.jobtitle.attrib ""> - <!ENTITY % jobtitle.role.attrib "%role.attrib;"> - -<!ENTITY % jobtitle.element "INCLUDE"> -<![%jobtitle.element;[ -<!--doc:The title of an individual in an organization.--> -<!ELEMENT jobtitle %ho; (%docinfo.char.mix;)*> -<!--end of jobtitle.element-->]]> - -<!ENTITY % jobtitle.attlist "INCLUDE"> -<![%jobtitle.attlist;[ -<!ATTLIST jobtitle - %common.attrib; - %jobtitle.role.attrib; - %local.jobtitle.attrib; -> -<!--end of jobtitle.attlist-->]]> - <!--end of jobtitle.module-->]]> - - <!-- OrgName (defined elsewhere in this section)--> - - <!ENTITY % orgdiv.module "INCLUDE"> - <![%orgdiv.module;[ - <!ENTITY % local.orgdiv.attrib ""> - <!ENTITY % orgdiv.role.attrib "%role.attrib;"> - -<!ENTITY % orgdiv.element "INCLUDE"> -<![%orgdiv.element;[ -<!--doc:A division of an organization.--> -<!ELEMENT orgdiv %ho; (%docinfo.char.mix;)*> -<!--end of orgdiv.element-->]]> - -<!ENTITY % orgdiv.attlist "INCLUDE"> -<![%orgdiv.attlist;[ -<!ATTLIST orgdiv - %common.attrib; - %orgdiv.role.attrib; - %local.orgdiv.attrib; -> -<!--end of orgdiv.attlist-->]]> - <!--end of orgdiv.module-->]]> - - <!-- Address (defined elsewhere in this section)--> -<!--end of affiliation.content.module-->]]> - -<!-- ArtPageNums ...................... --> - -<!ENTITY % artpagenums.module "INCLUDE"> -<![%artpagenums.module;[ -<!ENTITY % local.artpagenums.attrib ""> -<!ENTITY % artpagenums.role.attrib "%role.attrib;"> - -<!ENTITY % artpagenums.element "INCLUDE"> -<![%artpagenums.element;[ -<!--doc:The page numbers of an article as published.--> -<!ELEMENT artpagenums %ho; (%docinfo.char.mix;)*> -<!--end of artpagenums.element-->]]> - -<!ENTITY % artpagenums.attlist "INCLUDE"> -<![%artpagenums.attlist;[ -<!ATTLIST artpagenums - %common.attrib; - %artpagenums.role.attrib; - %local.artpagenums.attrib; -> -<!--end of artpagenums.attlist-->]]> -<!--end of artpagenums.module-->]]> - -<!-- PersonName --> - -<!ENTITY % personname.module "INCLUDE"> -<![%personname.module;[ -<!ENTITY % local.personname.attrib ""> -<!ENTITY % personname.role.attrib "%role.attrib;"> - -<!ENTITY % personname.element "INCLUDE"> -<![%personname.element;[ -<!--doc:The personal name of an individual.--> -<!ELEMENT personname %ho; ((honorific|firstname|surname|lineage|othername)+)> -<!--end of personname.element-->]]> - -<!ENTITY % personname.attlist "INCLUDE"> -<![%personname.attlist;[ -<!ATTLIST personname - %common.attrib; - %personname.role.attrib; - %local.personname.attrib; -> -<!--end of personname.attlist-->]]> -<!--end of personname.module-->]]> - -<!-- Author ........................... --> - -<!ENTITY % author.module "INCLUDE"> -<![%author.module;[ -<!ENTITY % local.author.attrib ""> -<!ENTITY % author.role.attrib "%role.attrib;"> - -<!ENTITY % author.element "INCLUDE"> -<![%author.element;[ -<!--doc:The name of an individual author.--> -<!ELEMENT author %ho; ((personname|(%person.ident.mix;)+),(personblurb|email|address)*)> -<!--end of author.element-->]]> - -<!ENTITY % author.attlist "INCLUDE"> -<![%author.attlist;[ -<!ATTLIST author - %common.attrib; - %author.role.attrib; - %local.author.attrib; -> -<!--end of author.attlist-->]]> -<!--(see "Personal identity elements" for %person.ident.mix;)--> -<!--end of author.module-->]]> - -<!-- AuthorGroup ...................... --> - -<!ENTITY % authorgroup.content.module "INCLUDE"> -<![%authorgroup.content.module;[ -<!ENTITY % authorgroup.module "INCLUDE"> -<![%authorgroup.module;[ -<!ENTITY % local.authorgroup.attrib ""> -<!ENTITY % authorgroup.role.attrib "%role.attrib;"> - -<!ENTITY % authorgroup.element "INCLUDE"> -<![%authorgroup.element;[ -<!--doc:Wrapper for author information when a document has multiple authors or collabarators.--> -<!ELEMENT authorgroup %ho; ((author|editor|collab|corpauthor|corpcredit|othercredit)+)> -<!--end of authorgroup.element-->]]> - -<!ENTITY % authorgroup.attlist "INCLUDE"> -<![%authorgroup.attlist;[ -<!ATTLIST authorgroup - %common.attrib; - %authorgroup.role.attrib; - %local.authorgroup.attrib; -> -<!--end of authorgroup.attlist-->]]> -<!--end of authorgroup.module-->]]> - - <!-- Author (defined elsewhere in this section)--> - <!-- Editor (defined elsewhere in this section)--> - - <!ENTITY % collab.content.module "INCLUDE"> - <![%collab.content.module;[ - <!ENTITY % collab.module "INCLUDE"> - <![%collab.module;[ - <!ENTITY % local.collab.attrib ""> - <!ENTITY % collab.role.attrib "%role.attrib;"> - -<!ENTITY % collab.element "INCLUDE"> -<![%collab.element;[ -<!--doc:Identifies a collaborator.--> -<!ELEMENT collab %ho; (collabname, affiliation*)> -<!--end of collab.element-->]]> - -<!ENTITY % collab.attlist "INCLUDE"> -<![%collab.attlist;[ -<!ATTLIST collab - %common.attrib; - %collab.role.attrib; - %local.collab.attrib; -> -<!--end of collab.attlist-->]]> - <!--end of collab.module-->]]> - - <!ENTITY % collabname.module "INCLUDE"> - <![%collabname.module;[ - <!ENTITY % local.collabname.attrib ""> - <!ENTITY % collabname.role.attrib "%role.attrib;"> - -<!ENTITY % collabname.element "INCLUDE"> -<![%collabname.element;[ -<!--doc:The name of a collaborator.--> -<!ELEMENT collabname %ho; (%docinfo.char.mix;)*> -<!--end of collabname.element-->]]> - -<!ENTITY % collabname.attlist "INCLUDE"> -<![%collabname.attlist;[ -<!ATTLIST collabname - %common.attrib; - %collabname.role.attrib; - %local.collabname.attrib; -> -<!--end of collabname.attlist-->]]> - <!--end of collabname.module-->]]> - - <!-- Affiliation (defined elsewhere in this section)--> - <!--end of collab.content.module-->]]> - - <!-- CorpAuthor (defined elsewhere in this section)--> - <!-- OtherCredit (defined elsewhere in this section)--> - -<!--end of authorgroup.content.module-->]]> - -<!-- AuthorInitials ................... --> - -<!ENTITY % authorinitials.module "INCLUDE"> -<![%authorinitials.module;[ -<!ENTITY % local.authorinitials.attrib ""> -<!ENTITY % authorinitials.role.attrib "%role.attrib;"> - -<!ENTITY % authorinitials.element "INCLUDE"> -<![%authorinitials.element;[ -<!--doc:The initials or other short identifier for an author.--> -<!ELEMENT authorinitials %ho; (%docinfo.char.mix;)*> -<!--end of authorinitials.element-->]]> - -<!ENTITY % authorinitials.attlist "INCLUDE"> -<![%authorinitials.attlist;[ -<!ATTLIST authorinitials - %common.attrib; - %authorinitials.role.attrib; - %local.authorinitials.attrib; -> -<!--end of authorinitials.attlist-->]]> -<!--end of authorinitials.module-->]]> - -<!-- ConfGroup ........................ --> - -<!ENTITY % confgroup.content.module "INCLUDE"> -<![%confgroup.content.module;[ -<!ENTITY % confgroup.module "INCLUDE"> -<![%confgroup.module;[ -<!ENTITY % local.confgroup.attrib ""> -<!ENTITY % confgroup.role.attrib "%role.attrib;"> - -<!ENTITY % confgroup.element "INCLUDE"> -<![%confgroup.element;[ -<!--doc:A wrapper for document meta-information about a conference.--> -<!ELEMENT confgroup %ho; ((confdates|conftitle|confnum|address|confsponsor)*)> -<!--end of confgroup.element-->]]> - -<!ENTITY % confgroup.attlist "INCLUDE"> -<![%confgroup.attlist;[ -<!ATTLIST confgroup - %common.attrib; - %confgroup.role.attrib; - %local.confgroup.attrib; -> -<!--end of confgroup.attlist-->]]> -<!--end of confgroup.module-->]]> - - <!ENTITY % confdates.module "INCLUDE"> - <![%confdates.module;[ - <!ENTITY % local.confdates.attrib ""> - <!ENTITY % confdates.role.attrib "%role.attrib;"> - -<!ENTITY % confdates.element "INCLUDE"> -<![%confdates.element;[ -<!--doc:The dates of a conference for which a document was written.--> -<!ELEMENT confdates %ho; (%docinfo.char.mix;)*> -<!--end of confdates.element-->]]> - -<!ENTITY % confdates.attlist "INCLUDE"> -<![%confdates.attlist;[ -<!ATTLIST confdates - %common.attrib; - %confdates.role.attrib; - %local.confdates.attrib; -> -<!--end of confdates.attlist-->]]> - <!--end of confdates.module-->]]> - - <!ENTITY % conftitle.module "INCLUDE"> - <![%conftitle.module;[ - <!ENTITY % local.conftitle.attrib ""> - <!ENTITY % conftitle.role.attrib "%role.attrib;"> - -<!ENTITY % conftitle.element "INCLUDE"> -<![%conftitle.element;[ -<!--doc:The title of a conference for which a document was written.--> -<!ELEMENT conftitle %ho; (%docinfo.char.mix;)*> -<!--end of conftitle.element-->]]> - -<!ENTITY % conftitle.attlist "INCLUDE"> -<![%conftitle.attlist;[ -<!ATTLIST conftitle - %common.attrib; - %conftitle.role.attrib; - %local.conftitle.attrib; -> -<!--end of conftitle.attlist-->]]> - <!--end of conftitle.module-->]]> - - <!ENTITY % confnum.module "INCLUDE"> - <![%confnum.module;[ - <!ENTITY % local.confnum.attrib ""> - <!ENTITY % confnum.role.attrib "%role.attrib;"> - -<!ENTITY % confnum.element "INCLUDE"> -<![%confnum.element;[ -<!--doc:An identifier, frequently numerical, associated with a conference for which a document was written.--> -<!ELEMENT confnum %ho; (%docinfo.char.mix;)*> -<!--end of confnum.element-->]]> - -<!ENTITY % confnum.attlist "INCLUDE"> -<![%confnum.attlist;[ -<!ATTLIST confnum - %common.attrib; - %confnum.role.attrib; - %local.confnum.attrib; -> -<!--end of confnum.attlist-->]]> - <!--end of confnum.module-->]]> - - <!-- Address (defined elsewhere in this section)--> - - <!ENTITY % confsponsor.module "INCLUDE"> - <![%confsponsor.module;[ - <!ENTITY % local.confsponsor.attrib ""> - <!ENTITY % confsponsor.role.attrib "%role.attrib;"> - -<!ENTITY % confsponsor.element "INCLUDE"> -<![%confsponsor.element;[ -<!--doc:The sponsor of a conference for which a document was written.--> -<!ELEMENT confsponsor %ho; (%docinfo.char.mix;)*> -<!--end of confsponsor.element-->]]> - -<!ENTITY % confsponsor.attlist "INCLUDE"> -<![%confsponsor.attlist;[ -<!ATTLIST confsponsor - %common.attrib; - %confsponsor.role.attrib; - %local.confsponsor.attrib; -> -<!--end of confsponsor.attlist-->]]> - <!--end of confsponsor.module-->]]> -<!--end of confgroup.content.module-->]]> - -<!-- ContractNum ...................... --> - -<!ENTITY % contractnum.module "INCLUDE"> -<![%contractnum.module;[ -<!ENTITY % local.contractnum.attrib ""> -<!ENTITY % contractnum.role.attrib "%role.attrib;"> - -<!ENTITY % contractnum.element "INCLUDE"> -<![%contractnum.element;[ -<!--doc:The contract number of a document.--> -<!ELEMENT contractnum %ho; (%docinfo.char.mix;)*> -<!--end of contractnum.element-->]]> - -<!ENTITY % contractnum.attlist "INCLUDE"> -<![%contractnum.attlist;[ -<!ATTLIST contractnum - %common.attrib; - %contractnum.role.attrib; - %local.contractnum.attrib; -> -<!--end of contractnum.attlist-->]]> -<!--end of contractnum.module-->]]> - -<!-- ContractSponsor .................. --> - -<!ENTITY % contractsponsor.module "INCLUDE"> -<![%contractsponsor.module;[ -<!ENTITY % local.contractsponsor.attrib ""> -<!ENTITY % contractsponsor.role.attrib "%role.attrib;"> - -<!ENTITY % contractsponsor.element "INCLUDE"> -<![%contractsponsor.element;[ -<!--doc:The sponsor of a contract.--> -<!ELEMENT contractsponsor %ho; (%docinfo.char.mix;)*> -<!--end of contractsponsor.element-->]]> - -<!ENTITY % contractsponsor.attlist "INCLUDE"> -<![%contractsponsor.attlist;[ -<!ATTLIST contractsponsor - %common.attrib; - %contractsponsor.role.attrib; - %local.contractsponsor.attrib; -> -<!--end of contractsponsor.attlist-->]]> -<!--end of contractsponsor.module-->]]> - -<!-- Copyright ........................ --> - -<!ENTITY % copyright.content.module "INCLUDE"> -<![%copyright.content.module;[ -<!ENTITY % copyright.module "INCLUDE"> -<![%copyright.module;[ -<!ENTITY % local.copyright.attrib ""> -<!ENTITY % copyright.role.attrib "%role.attrib;"> - -<!ENTITY % copyright.element "INCLUDE"> -<![%copyright.element;[ -<!--doc:Copyright information about a document.--> -<!ELEMENT copyright %ho; (year+, holder*)> -<!--end of copyright.element-->]]> - -<!ENTITY % copyright.attlist "INCLUDE"> -<![%copyright.attlist;[ -<!ATTLIST copyright - %common.attrib; - %copyright.role.attrib; - %local.copyright.attrib; -> -<!--end of copyright.attlist-->]]> -<!--end of copyright.module-->]]> - - <!ENTITY % year.module "INCLUDE"> - <![%year.module;[ - <!ENTITY % local.year.attrib ""> - <!ENTITY % year.role.attrib "%role.attrib;"> - -<!ENTITY % year.element "INCLUDE"> -<![%year.element;[ -<!--doc:The year of publication of a document.--> -<!ELEMENT year %ho; (%docinfo.char.mix;)*> -<!--end of year.element-->]]> - -<!ENTITY % year.attlist "INCLUDE"> -<![%year.attlist;[ -<!ATTLIST year - %common.attrib; - %year.role.attrib; - %local.year.attrib; -> -<!--end of year.attlist-->]]> - <!--end of year.module-->]]> - - <!ENTITY % holder.module "INCLUDE"> - <![%holder.module;[ - <!ENTITY % local.holder.attrib ""> - <!ENTITY % holder.role.attrib "%role.attrib;"> - -<!ENTITY % holder.element "INCLUDE"> -<![%holder.element;[ -<!--doc:The name of the individual or organization that holds a copyright.--> -<!ELEMENT holder %ho; (%docinfo.char.mix;)*> -<!--end of holder.element-->]]> - -<!ENTITY % holder.attlist "INCLUDE"> -<![%holder.attlist;[ -<!ATTLIST holder - %common.attrib; - %holder.role.attrib; - %local.holder.attrib; -> -<!--end of holder.attlist-->]]> - <!--end of holder.module-->]]> -<!--end of copyright.content.module-->]]> - -<!-- CorpAuthor ....................... --> - -<!ENTITY % corpauthor.module "INCLUDE"> -<![%corpauthor.module;[ -<!ENTITY % local.corpauthor.attrib ""> -<!ENTITY % corpauthor.role.attrib "%role.attrib;"> - -<!ENTITY % corpauthor.element "INCLUDE"> -<![%corpauthor.element;[ -<!--doc:A corporate author, as opposed to an individual.--> -<!ELEMENT corpauthor %ho; (%docinfo.char.mix;)*> -<!--end of corpauthor.element-->]]> - -<!ENTITY % corpauthor.attlist "INCLUDE"> -<![%corpauthor.attlist;[ -<!ATTLIST corpauthor - %common.attrib; - %corpauthor.role.attrib; - %local.corpauthor.attrib; -> -<!--end of corpauthor.attlist-->]]> -<!--end of corpauthor.module-->]]> - -<!-- CorpCredit ...................... --> - -<!ENTITY % corpcredit.module "INCLUDE"> -<![%corpcredit.module;[ -<!ENTITY % local.corpcredit.attrib ""> -<!ENTITY % corpcredit.role.attrib "%role.attrib;"> - -<!ENTITY % corpcredit.element "INCLUDE"> -<![%corpcredit.element;[ -<!--doc:A corporation or organization credited in a document.--> -<!ELEMENT corpcredit %ho; (%docinfo.char.mix;)*> -<!--end of corpcredit.element-->]]> - -<!ENTITY % corpcredit.attlist "INCLUDE"> -<![%corpcredit.attlist;[ -<!ATTLIST corpcredit - class (graphicdesigner - |productioneditor - |copyeditor - |technicaleditor - |translator - |other) #IMPLIED - %common.attrib; - %corpcredit.role.attrib; - %local.corpcredit.attrib; -> -<!--end of corpcredit.attlist-->]]> -<!--end of corpcredit.module-->]]> - -<!-- CorpName ......................... --> - -<!ENTITY % corpname.module "INCLUDE"> -<![%corpname.module;[ -<!ENTITY % local.corpname.attrib ""> - -<!ENTITY % corpname.element "INCLUDE"> -<![%corpname.element;[ -<!--doc:The name of a corporation.--> -<!ELEMENT corpname %ho; (%docinfo.char.mix;)*> -<!--end of corpname.element-->]]> -<!ENTITY % corpname.role.attrib "%role.attrib;"> - -<!ENTITY % corpname.attlist "INCLUDE"> -<![%corpname.attlist;[ -<!ATTLIST corpname - %common.attrib; - %corpname.role.attrib; - %local.corpname.attrib; -> -<!--end of corpname.attlist-->]]> -<!--end of corpname.module-->]]> - -<!-- Date ............................. --> - -<!ENTITY % date.module "INCLUDE"> -<![%date.module;[ -<!ENTITY % local.date.attrib ""> -<!ENTITY % date.role.attrib "%role.attrib;"> - -<!ENTITY % date.element "INCLUDE"> -<![%date.element;[ -<!--doc:The date of publication or revision of a document.--> -<!ELEMENT date %ho; (%docinfo.char.mix;)*> -<!--end of date.element-->]]> - -<!ENTITY % date.attlist "INCLUDE"> -<![%date.attlist;[ -<!ATTLIST date - %common.attrib; - %date.role.attrib; - %local.date.attrib; -> -<!--end of date.attlist-->]]> -<!--end of date.module-->]]> - -<!-- Edition .......................... --> - -<!ENTITY % edition.module "INCLUDE"> -<![%edition.module;[ -<!ENTITY % local.edition.attrib ""> -<!ENTITY % edition.role.attrib "%role.attrib;"> - -<!ENTITY % edition.element "INCLUDE"> -<![%edition.element;[ -<!--doc:The name or number of an edition of a document.--> -<!ELEMENT edition %ho; (%docinfo.char.mix;)*> -<!--end of edition.element-->]]> - -<!ENTITY % edition.attlist "INCLUDE"> -<![%edition.attlist;[ -<!ATTLIST edition - %common.attrib; - %edition.role.attrib; - %local.edition.attrib; -> -<!--end of edition.attlist-->]]> -<!--end of edition.module-->]]> - -<!-- Editor ........................... --> - -<!ENTITY % editor.module "INCLUDE"> -<![%editor.module;[ -<!ENTITY % local.editor.attrib ""> -<!ENTITY % editor.role.attrib "%role.attrib;"> - -<!ENTITY % editor.element "INCLUDE"> -<![%editor.element;[ -<!--doc:The name of the editor of a document.--> -<!ELEMENT editor %ho; ((personname|(%person.ident.mix;)+),(personblurb|email|address)*)> -<!--end of editor.element-->]]> - -<!ENTITY % editor.attlist "INCLUDE"> -<![%editor.attlist;[ -<!ATTLIST editor - %common.attrib; - %editor.role.attrib; - %local.editor.attrib; -> -<!--end of editor.attlist-->]]> - <!--(see "Personal identity elements" for %person.ident.mix;)--> -<!--end of editor.module-->]]> - -<!-- ISBN ............................. --> - -<!ENTITY % isbn.module "INCLUDE"> -<![%isbn.module;[ -<!ENTITY % local.isbn.attrib ""> -<!ENTITY % isbn.role.attrib "%role.attrib;"> - -<!ENTITY % isbn.element "INCLUDE"> -<![%isbn.element;[ -<!--doc:The International Standard Book Number of a document.--> -<!ELEMENT isbn %ho; (%docinfo.char.mix;)*> -<!--end of isbn.element-->]]> - -<!ENTITY % isbn.attlist "INCLUDE"> -<![%isbn.attlist;[ -<!ATTLIST isbn - %common.attrib; - %isbn.role.attrib; - %local.isbn.attrib; -> -<!--end of isbn.attlist-->]]> -<!--end of isbn.module-->]]> - -<!-- ISSN ............................. --> - -<!ENTITY % issn.module "INCLUDE"> -<![%issn.module;[ -<!ENTITY % local.issn.attrib ""> -<!ENTITY % issn.role.attrib "%role.attrib;"> - -<!ENTITY % issn.element "INCLUDE"> -<![%issn.element;[ -<!--doc:The International Standard Serial Number of a periodical.--> -<!ELEMENT issn %ho; (%docinfo.char.mix;)*> -<!--end of issn.element-->]]> - -<!ENTITY % issn.attlist "INCLUDE"> -<![%issn.attlist;[ -<!ATTLIST issn - %common.attrib; - %issn.role.attrib; - %local.issn.attrib; -> -<!--end of issn.attlist-->]]> -<!--end of issn.module-->]]> - -<!-- BiblioId ................. --> -<!ENTITY % biblio.class.attrib - "class (uri - |doi - |isbn - |isrn - |issn - |libraryofcongress - |pubnumber - |other) #IMPLIED - otherclass CDATA #IMPLIED" -> - -<!ENTITY % biblioid.module "INCLUDE"> -<![%biblioid.module;[ -<!ENTITY % local.biblioid.attrib ""> -<!ENTITY % biblioid.role.attrib "%role.attrib;"> - -<!ENTITY % biblioid.element "INCLUDE"> -<![%biblioid.element;[ -<!--doc:An identifier for a document.--> -<!ELEMENT biblioid %ho; (%docinfo.char.mix;)*> -<!--end of biblioid.element-->]]> - -<!ENTITY % biblioid.attlist "INCLUDE"> -<![%biblioid.attlist;[ -<!ATTLIST biblioid - %biblio.class.attrib; - %common.attrib; - %biblioid.role.attrib; - %local.biblioid.attrib; -> -<!--end of biblioid.attlist-->]]> -<!--end of biblioid.module-->]]> - -<!-- CiteBiblioId ................. --> - -<!ENTITY % citebiblioid.module "INCLUDE"> -<![%citebiblioid.module;[ -<!ENTITY % local.citebiblioid.attrib ""> -<!ENTITY % citebiblioid.role.attrib "%role.attrib;"> - -<!ENTITY % citebiblioid.element "INCLUDE"> -<![%citebiblioid.element;[ -<!--doc:A citation of a bibliographic identifier.--> -<!ELEMENT citebiblioid %ho; (%docinfo.char.mix;)*> -<!--end of citebiblioid.element-->]]> - -<!ENTITY % citebiblioid.attlist "INCLUDE"> -<![%citebiblioid.attlist;[ -<!ATTLIST citebiblioid - %biblio.class.attrib; - %common.attrib; - %citebiblioid.role.attrib; - %local.citebiblioid.attrib; -> -<!--end of citebiblioid.attlist-->]]> -<!--end of citebiblioid.module-->]]> - -<!-- BiblioSource ................. --> - -<!ENTITY % bibliosource.module "INCLUDE"> -<![%bibliosource.module;[ -<!ENTITY % local.bibliosource.attrib ""> -<!ENTITY % bibliosource.role.attrib "%role.attrib;"> - -<!ENTITY % bibliosource.element "INCLUDE"> -<![%bibliosource.element;[ -<!--doc:The source of a document.--> -<!ELEMENT bibliosource %ho; (%docinfo.char.mix;)*> -<!--end of bibliosource.element-->]]> - -<!ENTITY % bibliosource.attlist "INCLUDE"> -<![%bibliosource.attlist;[ -<!ATTLIST bibliosource - %biblio.class.attrib; - %common.attrib; - %bibliosource.role.attrib; - %local.bibliosource.attrib; -> -<!--end of bibliosource.attlist-->]]> -<!--end of bibliosource.module-->]]> - -<!-- BiblioRelation ................. --> - -<!ENTITY % bibliorelation.module "INCLUDE"> -<![%bibliorelation.module;[ -<!ENTITY % local.bibliorelation.attrib ""> -<!ENTITY % local.bibliorelation.types ""> - -<!ENTITY % bibliorelation.type.attrib - "type (isversionof - |hasversion - |isreplacedby - |replaces - |isrequiredby - |requires - |ispartof - |haspart - |isreferencedby - |references - |isformatof - |hasformat - |othertype - %local.bibliorelation.types;) #IMPLIED - othertype CDATA #IMPLIED -"> - -<!ENTITY % bibliorelation.role.attrib "%role.attrib;"> - -<!ENTITY % bibliorelation.element "INCLUDE"> -<![%bibliorelation.element;[ -<!--doc:The relationship of a document to another.--> -<!ELEMENT bibliorelation %ho; (%docinfo.char.mix;)*> -<!--end of bibliorelation.element-->]]> - -<!ENTITY % bibliorelation.attlist "INCLUDE"> -<![%bibliorelation.attlist;[ -<!ATTLIST bibliorelation - %biblio.class.attrib; - %bibliorelation.type.attrib; - %common.attrib; - %bibliorelation.role.attrib; - %local.bibliorelation.attrib; -> -<!--end of bibliorelation.attlist-->]]> -<!--end of bibliorelation.module-->]]> - -<!-- BiblioCoverage ................. --> - -<!ENTITY % bibliocoverage.module "INCLUDE"> -<![%bibliocoverage.module;[ -<!ENTITY % local.bibliocoverage.attrib ""> -<!ENTITY % bibliocoverage.role.attrib "%role.attrib;"> - -<!ENTITY % bibliocoverage.element "INCLUDE"> -<![%bibliocoverage.element;[ -<!--doc:The spatial or temporal coverage of a document.--> -<!ELEMENT bibliocoverage %ho; (%docinfo.char.mix;)*> -<!--end of bibliocoverage.element-->]]> - -<!ENTITY % bibliocoverage.attlist "INCLUDE"> -<![%bibliocoverage.attlist;[ -<!ATTLIST bibliocoverage - spatial (dcmipoint|iso3166|dcmibox|tgn|otherspatial) #IMPLIED - otherspatial CDATA #IMPLIED - temporal (dcmiperiod|w3c-dtf|othertemporal) #IMPLIED - othertemporal CDATA #IMPLIED - %common.attrib; - %bibliocoverage.role.attrib; - %local.bibliocoverage.attrib; -> -<!--end of bibliocoverage.attlist-->]]> -<!--end of bibliocoverage.module-->]]> - -<!-- InvPartNumber .................... --> - -<!ENTITY % invpartnumber.module "INCLUDE"> -<![%invpartnumber.module;[ -<!ENTITY % local.invpartnumber.attrib ""> -<!ENTITY % invpartnumber.role.attrib "%role.attrib;"> - -<!ENTITY % invpartnumber.element "INCLUDE"> -<![%invpartnumber.element;[ -<!--doc:An inventory part number.--> -<!ELEMENT invpartnumber %ho; (%docinfo.char.mix;)*> -<!--end of invpartnumber.element-->]]> - -<!ENTITY % invpartnumber.attlist "INCLUDE"> -<![%invpartnumber.attlist;[ -<!ATTLIST invpartnumber - %common.attrib; - %invpartnumber.role.attrib; - %local.invpartnumber.attrib; -> -<!--end of invpartnumber.attlist-->]]> -<!--end of invpartnumber.module-->]]> - -<!-- IssueNum ......................... --> - -<!ENTITY % issuenum.module "INCLUDE"> -<![%issuenum.module;[ -<!ENTITY % local.issuenum.attrib ""> -<!ENTITY % issuenum.role.attrib "%role.attrib;"> - -<!ENTITY % issuenum.element "INCLUDE"> -<![%issuenum.element;[ -<!--doc:The number of an issue of a journal.--> -<!ELEMENT issuenum %ho; (%docinfo.char.mix;)*> -<!--end of issuenum.element-->]]> - -<!ENTITY % issuenum.attlist "INCLUDE"> -<![%issuenum.attlist;[ -<!ATTLIST issuenum - %common.attrib; - %issuenum.role.attrib; - %local.issuenum.attrib; -> -<!--end of issuenum.attlist-->]]> -<!--end of issuenum.module-->]]> - -<!-- LegalNotice ...................... --> - -<!ENTITY % legalnotice.module "INCLUDE"> -<![%legalnotice.module;[ -<!ENTITY % local.legalnotice.attrib ""> -<!ENTITY % legalnotice.role.attrib "%role.attrib;"> - -<!ENTITY % legalnotice.element "INCLUDE"> -<![%legalnotice.element;[ -<!--doc:A statement of legal obligations or requirements.--> -<!ELEMENT legalnotice %ho; (blockinfo?, title?, (%legalnotice.mix;)+) - %formal.exclusion;> -<!--end of legalnotice.element-->]]> - -<!ENTITY % legalnotice.attlist "INCLUDE"> -<![%legalnotice.attlist;[ -<!ATTLIST legalnotice - %common.attrib; - %legalnotice.role.attrib; - %local.legalnotice.attrib; -> -<!--end of legalnotice.attlist-->]]> -<!--end of legalnotice.module-->]]> - -<!-- ModeSpec ......................... --> - -<!ENTITY % modespec.module "INCLUDE"> -<![%modespec.module;[ -<!ENTITY % local.modespec.attrib ""> -<!ENTITY % modespec.role.attrib "%role.attrib;"> - -<!ENTITY % modespec.element "INCLUDE"> -<![%modespec.element;[ -<!--doc:Application-specific information necessary for the completion of an OLink.--> -<!ELEMENT modespec %ho; (%docinfo.char.mix;)* - %ubiq.exclusion;> -<!--end of modespec.element-->]]> - -<!-- Application: Type of action required for completion - of the links to which the ModeSpec is relevant (e.g., - retrieval query) --> - - -<!ENTITY % modespec.attlist "INCLUDE"> -<![%modespec.attlist;[ -<!ATTLIST modespec - application NOTATION - (%notation.class;) #IMPLIED - %common.attrib; - %modespec.role.attrib; - %local.modespec.attrib; -> -<!--end of modespec.attlist-->]]> -<!--end of modespec.module-->]]> - -<!-- OrgName .......................... --> - -<!ENTITY % orgname.module "INCLUDE"> -<![%orgname.module;[ -<!ENTITY % local.orgname.attrib ""> -<!ENTITY % orgname.role.attrib "%role.attrib;"> - -<!ENTITY % orgname.element "INCLUDE"> -<![%orgname.element;[ -<!--doc:The name of an organization other than a corporation.--> -<!ELEMENT orgname %ho; (%docinfo.char.mix;)*> -<!--end of orgname.element-->]]> - -<!ENTITY % orgname.attlist "INCLUDE"> -<![%orgname.attlist;[ -<!ATTLIST orgname - %common.attrib; - class (corporation|nonprofit|consortium|informal|other) #IMPLIED - otherclass CDATA #IMPLIED - %orgname.role.attrib; - %local.orgname.attrib; -> -<!--end of orgname.attlist-->]]> -<!--end of orgname.module-->]]> - -<!-- OtherCredit ...................... --> - -<!ENTITY % othercredit.module "INCLUDE"> -<![%othercredit.module;[ -<!ENTITY % local.othercredit.attrib ""> -<!ENTITY % othercredit.role.attrib "%role.attrib;"> - -<!ENTITY % othercredit.element "INCLUDE"> -<![%othercredit.element;[ -<!--doc:A person or entity, other than an author or editor, credited in a document.--> -<!ELEMENT othercredit %ho; ((personname|(%person.ident.mix;)+), - (personblurb|email|address)*)> -<!--end of othercredit.element-->]]> - -<!ENTITY % othercredit.attlist "INCLUDE"> -<![%othercredit.attlist;[ -<!ATTLIST othercredit - class (graphicdesigner - |productioneditor - |copyeditor - |technicaleditor - |translator - |other) #IMPLIED - %common.attrib; - %othercredit.role.attrib; - %local.othercredit.attrib; -> -<!--end of othercredit.attlist-->]]> - <!--(see "Personal identity elements" for %person.ident.mix;)--> -<!--end of othercredit.module-->]]> - -<!-- PageNums ......................... --> - -<!ENTITY % pagenums.module "INCLUDE"> -<![%pagenums.module;[ -<!ENTITY % local.pagenums.attrib ""> -<!ENTITY % pagenums.role.attrib "%role.attrib;"> - -<!ENTITY % pagenums.element "INCLUDE"> -<![%pagenums.element;[ -<!--doc:The numbers of the pages in a book, for use in a bibliographic entry.--> -<!ELEMENT pagenums %ho; (%docinfo.char.mix;)*> -<!--end of pagenums.element-->]]> - -<!ENTITY % pagenums.attlist "INCLUDE"> -<![%pagenums.attlist;[ -<!ATTLIST pagenums - %common.attrib; - %pagenums.role.attrib; - %local.pagenums.attrib; -> -<!--end of pagenums.attlist-->]]> -<!--end of pagenums.module-->]]> - -<!-- Personal identity elements ....... --> - -<!-- These elements are used only within Author, Editor, and -OtherCredit. --> - -<!ENTITY % person.ident.module "INCLUDE"> -<![%person.ident.module;[ - <!ENTITY % contrib.module "INCLUDE"> - <![%contrib.module;[ - <!ENTITY % local.contrib.attrib ""> - <!ENTITY % contrib.role.attrib "%role.attrib;"> - -<!ENTITY % contrib.element "INCLUDE"> -<![%contrib.element;[ -<!--doc:A summary of the contributions made to a document by a credited source.--> -<!ELEMENT contrib %ho; (%docinfo.char.mix;)*> -<!--end of contrib.element-->]]> - -<!ENTITY % contrib.attlist "INCLUDE"> -<![%contrib.attlist;[ -<!ATTLIST contrib - %common.attrib; - %contrib.role.attrib; - %local.contrib.attrib; -> -<!--end of contrib.attlist-->]]> - <!--end of contrib.module-->]]> - - <!ENTITY % firstname.module "INCLUDE"> - <![%firstname.module;[ - <!ENTITY % local.firstname.attrib ""> - <!ENTITY % firstname.role.attrib "%role.attrib;"> - -<!ENTITY % firstname.element "INCLUDE"> -<![%firstname.element;[ -<!--doc:The first name of a person.--> -<!ELEMENT firstname %ho; (%docinfo.char.mix;)*> -<!--end of firstname.element-->]]> - -<!ENTITY % firstname.attlist "INCLUDE"> -<![%firstname.attlist;[ -<!ATTLIST firstname - %common.attrib; - %firstname.role.attrib; - %local.firstname.attrib; -> -<!--end of firstname.attlist-->]]> - <!--end of firstname.module-->]]> - - <!ENTITY % honorific.module "INCLUDE"> - <![%honorific.module;[ - <!ENTITY % local.honorific.attrib ""> - <!ENTITY % honorific.role.attrib "%role.attrib;"> - -<!ENTITY % honorific.element "INCLUDE"> -<![%honorific.element;[ -<!--doc:The title of a person.--> -<!ELEMENT honorific %ho; (%docinfo.char.mix;)*> -<!--end of honorific.element-->]]> - -<!ENTITY % honorific.attlist "INCLUDE"> -<![%honorific.attlist;[ -<!ATTLIST honorific - %common.attrib; - %honorific.role.attrib; - %local.honorific.attrib; -> -<!--end of honorific.attlist-->]]> - <!--end of honorific.module-->]]> - - <!ENTITY % lineage.module "INCLUDE"> - <![%lineage.module;[ - <!ENTITY % local.lineage.attrib ""> - <!ENTITY % lineage.role.attrib "%role.attrib;"> - -<!ENTITY % lineage.element "INCLUDE"> -<![%lineage.element;[ -<!--doc:The portion of a person's name indicating a relationship to ancestors.--> -<!ELEMENT lineage %ho; (%docinfo.char.mix;)*> -<!--end of lineage.element-->]]> - -<!ENTITY % lineage.attlist "INCLUDE"> -<![%lineage.attlist;[ -<!ATTLIST lineage - %common.attrib; - %lineage.role.attrib; - %local.lineage.attrib; -> -<!--end of lineage.attlist-->]]> - <!--end of lineage.module-->]]> - - <!ENTITY % othername.module "INCLUDE"> - <![%othername.module;[ - <!ENTITY % local.othername.attrib ""> - <!ENTITY % othername.role.attrib "%role.attrib;"> - -<!ENTITY % othername.element "INCLUDE"> -<![%othername.element;[ -<!--doc:A component of a persons name that is not a first name, surname, or lineage.--> -<!ELEMENT othername %ho; (%docinfo.char.mix;)*> -<!--end of othername.element-->]]> - -<!ENTITY % othername.attlist "INCLUDE"> -<![%othername.attlist;[ -<!ATTLIST othername - %common.attrib; - %othername.role.attrib; - %local.othername.attrib; -> -<!--end of othername.attlist-->]]> - <!--end of othername.module-->]]> - - <!ENTITY % surname.module "INCLUDE"> - <![%surname.module;[ - <!ENTITY % local.surname.attrib ""> - <!ENTITY % surname.role.attrib "%role.attrib;"> - -<!ENTITY % surname.element "INCLUDE"> -<![%surname.element;[ -<!--doc:A family name; in western cultures the last name.--> -<!ELEMENT surname %ho; (%docinfo.char.mix;)*> -<!--end of surname.element-->]]> - -<!ENTITY % surname.attlist "INCLUDE"> -<![%surname.attlist;[ -<!ATTLIST surname - %common.attrib; - %surname.role.attrib; - %local.surname.attrib; -> -<!--end of surname.attlist-->]]> - <!--end of surname.module-->]]> -<!--end of person.ident.module-->]]> - -<!-- PrintHistory ..................... --> - -<!ENTITY % printhistory.module "INCLUDE"> -<![%printhistory.module;[ -<!ENTITY % local.printhistory.attrib ""> -<!ENTITY % printhistory.role.attrib "%role.attrib;"> - -<!ENTITY % printhistory.element "INCLUDE"> -<![%printhistory.element;[ -<!--doc:The printing history of a document.--> -<!ELEMENT printhistory %ho; ((%para.class;)+)> -<!--end of printhistory.element-->]]> - -<!ENTITY % printhistory.attlist "INCLUDE"> -<![%printhistory.attlist;[ -<!ATTLIST printhistory - %common.attrib; - %printhistory.role.attrib; - %local.printhistory.attrib; -> -<!--end of printhistory.attlist-->]]> -<!--end of printhistory.module-->]]> - -<!-- ProductName ...................... --> - -<!ENTITY % productname.module "INCLUDE"> -<![%productname.module;[ -<!ENTITY % local.productname.attrib ""> -<!ENTITY % productname.role.attrib "%role.attrib;"> - -<!ENTITY % productname.element "INCLUDE"> -<![%productname.element;[ -<!--doc:The formal name of a product.--> -<!ELEMENT productname %ho; (%para.char.mix;)*> -<!--end of productname.element-->]]> - -<!-- Class: More precisely identifies the item the element names --> - - -<!ENTITY % productname.attlist "INCLUDE"> -<![%productname.attlist;[ -<!ATTLIST productname - class (service - |trade - |registered - |copyright) 'trade' - %common.attrib; - %productname.role.attrib; - %local.productname.attrib; -> -<!--end of productname.attlist-->]]> -<!--end of productname.module-->]]> - -<!-- ProductNumber .................... --> - -<!ENTITY % productnumber.module "INCLUDE"> -<![%productnumber.module;[ -<!ENTITY % local.productnumber.attrib ""> -<!ENTITY % productnumber.role.attrib "%role.attrib;"> - -<!ENTITY % productnumber.element "INCLUDE"> -<![%productnumber.element;[ -<!--doc:A number assigned to a product.--> -<!ELEMENT productnumber %ho; (%docinfo.char.mix;)*> -<!--end of productnumber.element-->]]> - -<!ENTITY % productnumber.attlist "INCLUDE"> -<![%productnumber.attlist;[ -<!ATTLIST productnumber - %common.attrib; - %productnumber.role.attrib; - %local.productnumber.attrib; -> -<!--end of productnumber.attlist-->]]> -<!--end of productnumber.module-->]]> - -<!-- PubDate .......................... --> - -<!ENTITY % pubdate.module "INCLUDE"> -<![%pubdate.module;[ -<!ENTITY % local.pubdate.attrib ""> -<!ENTITY % pubdate.role.attrib "%role.attrib;"> - -<!ENTITY % pubdate.element "INCLUDE"> -<![%pubdate.element;[ -<!--doc:The date of publication of a document.--> -<!ELEMENT pubdate %ho; (%docinfo.char.mix;)*> -<!--end of pubdate.element-->]]> - -<!ENTITY % pubdate.attlist "INCLUDE"> -<![%pubdate.attlist;[ -<!ATTLIST pubdate - %common.attrib; - %pubdate.role.attrib; - %local.pubdate.attrib; -> -<!--end of pubdate.attlist-->]]> -<!--end of pubdate.module-->]]> - -<!-- Publisher ........................ --> - -<!ENTITY % publisher.content.module "INCLUDE"> -<![%publisher.content.module;[ -<!ENTITY % publisher.module "INCLUDE"> -<![%publisher.module;[ -<!ENTITY % local.publisher.attrib ""> -<!ENTITY % publisher.role.attrib "%role.attrib;"> - -<!ENTITY % publisher.element "INCLUDE"> -<![%publisher.element;[ -<!--doc:The publisher of a document.--> -<!ELEMENT publisher %ho; (publishername, address*)> -<!--end of publisher.element-->]]> - -<!ENTITY % publisher.attlist "INCLUDE"> -<![%publisher.attlist;[ -<!ATTLIST publisher - %common.attrib; - %publisher.role.attrib; - %local.publisher.attrib; -> -<!--end of publisher.attlist-->]]> -<!--end of publisher.module-->]]> - - <!ENTITY % publishername.module "INCLUDE"> - <![%publishername.module;[ - <!ENTITY % local.publishername.attrib ""> - <!ENTITY % publishername.role.attrib "%role.attrib;"> - -<!ENTITY % publishername.element "INCLUDE"> -<![%publishername.element;[ -<!--doc:The name of the publisher of a document.--> -<!ELEMENT publishername %ho; (%docinfo.char.mix;)*> -<!--end of publishername.element-->]]> - -<!ENTITY % publishername.attlist "INCLUDE"> -<![%publishername.attlist;[ -<!ATTLIST publishername - %common.attrib; - %publishername.role.attrib; - %local.publishername.attrib; -> -<!--end of publishername.attlist-->]]> - <!--end of publishername.module-->]]> - - <!-- Address (defined elsewhere in this section)--> -<!--end of publisher.content.module-->]]> - -<!-- PubsNumber ....................... --> - -<!ENTITY % pubsnumber.module "INCLUDE"> -<![%pubsnumber.module;[ -<!ENTITY % local.pubsnumber.attrib ""> -<!ENTITY % pubsnumber.role.attrib "%role.attrib;"> - -<!ENTITY % pubsnumber.element "INCLUDE"> -<![%pubsnumber.element;[ -<!--doc:A number assigned to a publication other than an ISBN or ISSN or inventory part number.--> -<!ELEMENT pubsnumber %ho; (%docinfo.char.mix;)*> -<!--end of pubsnumber.element-->]]> - -<!ENTITY % pubsnumber.attlist "INCLUDE"> -<![%pubsnumber.attlist;[ -<!ATTLIST pubsnumber - %common.attrib; - %pubsnumber.role.attrib; - %local.pubsnumber.attrib; -> -<!--end of pubsnumber.attlist-->]]> -<!--end of pubsnumber.module-->]]> - -<!-- ReleaseInfo ...................... --> - -<!ENTITY % releaseinfo.module "INCLUDE"> -<![%releaseinfo.module;[ -<!ENTITY % local.releaseinfo.attrib ""> -<!ENTITY % releaseinfo.role.attrib "%role.attrib;"> - -<!ENTITY % releaseinfo.element "INCLUDE"> -<![%releaseinfo.element;[ -<!--doc:Information about a particular release of a document.--> -<!ELEMENT releaseinfo %ho; (%docinfo.char.mix;)*> -<!--end of releaseinfo.element-->]]> - -<!ENTITY % releaseinfo.attlist "INCLUDE"> -<![%releaseinfo.attlist;[ -<!ATTLIST releaseinfo - %common.attrib; - %releaseinfo.role.attrib; - %local.releaseinfo.attrib; -> -<!--end of releaseinfo.attlist-->]]> -<!--end of releaseinfo.module-->]]> - -<!-- RevHistory ....................... --> - -<!ENTITY % revhistory.content.module "INCLUDE"> -<![%revhistory.content.module;[ -<!ENTITY % revhistory.module "INCLUDE"> -<![%revhistory.module;[ -<!ENTITY % local.revhistory.attrib ""> -<!ENTITY % revhistory.role.attrib "%role.attrib;"> - -<!ENTITY % revhistory.element "INCLUDE"> -<![%revhistory.element;[ -<!--doc:A history of the revisions to a document.--> -<!ELEMENT revhistory %ho; (revision+)> -<!--end of revhistory.element-->]]> - -<!ENTITY % revhistory.attlist "INCLUDE"> -<![%revhistory.attlist;[ -<!ATTLIST revhistory - %common.attrib; - %revhistory.role.attrib; - %local.revhistory.attrib; -> -<!--end of revhistory.attlist-->]]> -<!--end of revhistory.module-->]]> - -<!ENTITY % revision.module "INCLUDE"> -<![%revision.module;[ -<!ENTITY % local.revision.attrib ""> -<!ENTITY % revision.role.attrib "%role.attrib;"> - -<!ENTITY % revision.element "INCLUDE"> -<![%revision.element;[ -<!--doc:An entry describing a single revision in the history of the revisions to a document.--> -<!ELEMENT revision %ho; (revnumber?, date, (author|authorinitials)*, - (revremark|revdescription)?)> -<!--end of revision.element-->]]> - -<!ENTITY % revision.attlist "INCLUDE"> -<![%revision.attlist;[ -<!ATTLIST revision - %common.attrib; - %revision.role.attrib; - %local.revision.attrib; -> -<!--end of revision.attlist-->]]> -<!--end of revision.module-->]]> - -<!ENTITY % revnumber.module "INCLUDE"> -<![%revnumber.module;[ -<!ENTITY % local.revnumber.attrib ""> -<!ENTITY % revnumber.role.attrib "%role.attrib;"> - -<!ENTITY % revnumber.element "INCLUDE"> -<![%revnumber.element;[ -<!--doc:A document revision number.--> -<!ELEMENT revnumber %ho; (%docinfo.char.mix;)*> -<!--end of revnumber.element-->]]> - -<!ENTITY % revnumber.attlist "INCLUDE"> -<![%revnumber.attlist;[ -<!ATTLIST revnumber - %common.attrib; - %revnumber.role.attrib; - %local.revnumber.attrib; -> -<!--end of revnumber.attlist-->]]> -<!--end of revnumber.module-->]]> - -<!-- Date (defined elsewhere in this section)--> -<!-- AuthorInitials (defined elsewhere in this section)--> - -<!ENTITY % revremark.module "INCLUDE"> -<![%revremark.module;[ -<!ENTITY % local.revremark.attrib ""> -<!ENTITY % revremark.role.attrib "%role.attrib;"> - -<!ENTITY % revremark.element "INCLUDE"> -<![%revremark.element;[ -<!--doc:A description of a revision to a document.--> -<!ELEMENT revremark %ho; (%docinfo.char.mix;)*> -<!--end of revremark.element-->]]> - -<!ENTITY % revremark.attlist "INCLUDE"> -<![%revremark.attlist;[ -<!ATTLIST revremark - %common.attrib; - %revremark.role.attrib; - %local.revremark.attrib; -> -<!--end of revremark.attlist-->]]> -<!--end of revremark.module-->]]> - -<!ENTITY % revdescription.module "INCLUDE"> -<![ %revdescription.module; [ -<!ENTITY % local.revdescription.attrib ""> -<!ENTITY % revdescription.role.attrib "%role.attrib;"> - -<!ENTITY % revdescription.element "INCLUDE"> -<![ %revdescription.element; [ -<!--doc:A extended description of a revision to a document.--> -<!ELEMENT revdescription %ho; ((%revdescription.mix;)+)> -<!--end of revdescription.element-->]]> - -<!ENTITY % revdescription.attlist "INCLUDE"> -<![ %revdescription.attlist; [ -<!ATTLIST revdescription - %common.attrib; - %revdescription.role.attrib; - %local.revdescription.attrib; -> -<!--end of revdescription.attlist-->]]> -<!--end of revdescription.module-->]]> -<!--end of revhistory.content.module-->]]> - -<!-- SeriesVolNums .................... --> - -<!ENTITY % seriesvolnums.module "INCLUDE"> -<![%seriesvolnums.module;[ -<!ENTITY % local.seriesvolnums.attrib ""> -<!ENTITY % seriesvolnums.role.attrib "%role.attrib;"> - -<!ENTITY % seriesvolnums.element "INCLUDE"> -<![%seriesvolnums.element;[ -<!--doc:Numbers of the volumes in a series of books.--> -<!ELEMENT seriesvolnums %ho; (%docinfo.char.mix;)*> -<!--end of seriesvolnums.element-->]]> - -<!ENTITY % seriesvolnums.attlist "INCLUDE"> -<![%seriesvolnums.attlist;[ -<!ATTLIST seriesvolnums - %common.attrib; - %seriesvolnums.role.attrib; - %local.seriesvolnums.attrib; -> -<!--end of seriesvolnums.attlist-->]]> -<!--end of seriesvolnums.module-->]]> - -<!-- VolumeNum ........................ --> - -<!ENTITY % volumenum.module "INCLUDE"> -<![%volumenum.module;[ -<!ENTITY % local.volumenum.attrib ""> -<!ENTITY % volumenum.role.attrib "%role.attrib;"> - -<!ENTITY % volumenum.element "INCLUDE"> -<![%volumenum.element;[ -<!--doc:The volume number of a document in a set (as of books in a set or articles in a journal).--> -<!ELEMENT volumenum %ho; (%docinfo.char.mix;)*> -<!--end of volumenum.element-->]]> - -<!ENTITY % volumenum.attlist "INCLUDE"> -<![%volumenum.attlist;[ -<!ATTLIST volumenum - %common.attrib; - %volumenum.role.attrib; - %local.volumenum.attrib; -> -<!--end of volumenum.attlist-->]]> -<!--end of volumenum.module-->]]> - -<!-- .................................. --> - -<!--end of docinfo.content.module-->]]> - -<!-- ...................................................................... --> -<!-- Inline, link, and ubiquitous elements ................................ --> - -<!-- Technical and computer terms ......................................... --> - -<!ENTITY % accel.module "INCLUDE"> -<![%accel.module;[ -<!ENTITY % local.accel.attrib ""> -<!ENTITY % accel.role.attrib "%role.attrib;"> - -<!ENTITY % accel.element "INCLUDE"> -<![%accel.element;[ -<!--doc:A graphical user interface (GUI) keyboard shortcut.--> -<!ELEMENT accel %ho; (%smallcptr.char.mix;)*> -<!--end of accel.element-->]]> - -<!ENTITY % accel.attlist "INCLUDE"> -<![%accel.attlist;[ -<!ATTLIST accel - %common.attrib; - %accel.role.attrib; - %local.accel.attrib; -> -<!--end of accel.attlist-->]]> -<!--end of accel.module-->]]> - -<!ENTITY % action.module "INCLUDE"> -<![%action.module;[ -<!ENTITY % local.action.attrib ""> -<!ENTITY % action.role.attrib "%role.attrib;"> - -<!ENTITY % action.element "INCLUDE"> -<![%action.element;[ -<!--doc:A response to a user event.--> -<!ELEMENT action %ho; (%cptr.char.mix;)*> -<!--end of action.element-->]]> - -<!ENTITY % action.attlist "INCLUDE"> -<![%action.attlist;[ -<!ATTLIST action - %moreinfo.attrib; - %common.attrib; - %action.role.attrib; - %local.action.attrib; -> -<!--end of action.attlist-->]]> -<!--end of action.module-->]]> - -<!ENTITY % application.module "INCLUDE"> -<![%application.module;[ -<!ENTITY % local.application.attrib ""> -<!ENTITY % application.role.attrib "%role.attrib;"> - -<!ENTITY % application.element "INCLUDE"> -<![%application.element;[ -<!--doc:The name of a software program.--> -<!ELEMENT application %ho; (%para.char.mix;)*> -<!--end of application.element-->]]> - -<!ENTITY % application.attlist "INCLUDE"> -<![%application.attlist;[ -<!ATTLIST application - class (hardware - |software) #IMPLIED - %moreinfo.attrib; - %common.attrib; - %application.role.attrib; - %local.application.attrib; -> -<!--end of application.attlist-->]]> -<!--end of application.module-->]]> - -<!ENTITY % classname.module "INCLUDE"> -<![%classname.module;[ -<!ENTITY % local.classname.attrib ""> -<!ENTITY % classname.role.attrib "%role.attrib;"> - -<!ENTITY % classname.element "INCLUDE"> -<![%classname.element;[ -<!--doc:The name of a class, in the object-oriented programming sense.--> -<!ELEMENT classname %ho; (%smallcptr.char.mix;)*> -<!--end of classname.element-->]]> - -<!ENTITY % classname.attlist "INCLUDE"> -<![%classname.attlist;[ -<!ATTLIST classname - %common.attrib; - %classname.role.attrib; - %local.classname.attrib; -> -<!--end of classname.attlist-->]]> -<!--end of classname.module-->]]> - -<!ENTITY % package.module "INCLUDE"> -<![%package.module;[ -<!ENTITY % local.package.attrib ""> -<!ENTITY % package.role.attrib "%role.attrib;"> - -<!ENTITY % package.element "INCLUDE"> -<![%package.element;[ -<!--doc:A package.--> -<!ELEMENT package %ho; (%smallcptr.char.mix;)*> -<!--end of package.element-->]]> - -<!ENTITY % package.attlist "INCLUDE"> -<![%package.attlist;[ -<!ATTLIST package - %common.attrib; - %package.role.attrib; - %local.package.attrib; -> -<!--end of package.attlist-->]]> -<!--end of package.module-->]]> - -<!ENTITY % co.module "INCLUDE"> -<![%co.module;[ -<!ENTITY % local.co.attrib ""> -<!-- CO is a callout area of the LineColumn unit type (a single character - position); the position is directly indicated by the location of CO. --> -<!ENTITY % co.role.attrib "%role.attrib;"> - -<!ENTITY % co.element "INCLUDE"> -<![%co.element;[ -<!--doc:The location of a callout embedded in text.--> -<!ELEMENT co %ho; EMPTY> -<!--end of co.element-->]]> - -<!-- bug number/symbol override or initialization --> -<!-- to any related information --> - - -<!ENTITY % co.attlist "INCLUDE"> -<![%co.attlist;[ -<!ATTLIST co - %label.attrib; - %linkends.attrib; - %idreq.common.attrib; - %co.role.attrib; - %local.co.attrib; -> -<!--end of co.attlist-->]]> -<!--end of co.module-->]]> - -<!ENTITY % coref.module "INCLUDE"> -<![%coref.module;[ -<!ENTITY % local.coref.attrib ""> -<!-- COREF is a reference to a CO --> -<!ENTITY % coref.role.attrib "%role.attrib;"> - -<!ENTITY % coref.element "INCLUDE"> -<![%coref.element;[ -<!--doc:A cross reference to a co.--> -<!ELEMENT coref %ho; EMPTY> -<!--end of coref.element-->]]> - -<!-- bug number/symbol override or initialization --> -<!-- to any related information --> - -<!ENTITY % coref.attlist "INCLUDE"> -<![%coref.attlist;[ -<!ATTLIST coref - %label.attrib; - %linkendreq.attrib; - %common.attrib; - %coref.role.attrib; - %local.coref.attrib; -> -<!--end of coref.attlist-->]]> -<!--end of coref.module-->]]> - -<!ENTITY % command.module "INCLUDE"> -<![%command.module;[ -<!ENTITY % local.command.attrib ""> -<!ENTITY % command.role.attrib "%role.attrib;"> - -<!ENTITY % command.element "INCLUDE"> -<![%command.element;[ -<!--doc:The name of an executable program or other software command.--> -<!ELEMENT command %ho; (%cptr.char.mix;)*> -<!--end of command.element-->]]> - -<!ENTITY % command.attlist "INCLUDE"> -<![%command.attlist;[ -<!ATTLIST command - %moreinfo.attrib; - %common.attrib; - %command.role.attrib; - %local.command.attrib; -> -<!--end of command.attlist-->]]> -<!--end of command.module-->]]> - -<!ENTITY % computeroutput.module "INCLUDE"> -<![%computeroutput.module;[ -<!ENTITY % local.computeroutput.attrib ""> -<!ENTITY % computeroutput.role.attrib "%role.attrib;"> - -<!ENTITY % computeroutput.element "INCLUDE"> -<![%computeroutput.element;[ -<!--doc:Data, generally text, displayed or presented by a computer.--> -<!ELEMENT computeroutput %ho; (%cptr.char.mix;|co)*> -<!--end of computeroutput.element-->]]> - -<!ENTITY % computeroutput.attlist "INCLUDE"> -<![%computeroutput.attlist;[ -<!ATTLIST computeroutput - %moreinfo.attrib; - %common.attrib; - %computeroutput.role.attrib; - %local.computeroutput.attrib; -> -<!--end of computeroutput.attlist-->]]> -<!--end of computeroutput.module-->]]> - -<!ENTITY % database.module "INCLUDE"> -<![%database.module;[ -<!ENTITY % local.database.attrib ""> -<!ENTITY % database.role.attrib "%role.attrib;"> - -<!ENTITY % database.element "INCLUDE"> -<![%database.element;[ -<!--doc:The name of a database, or part of a database.--> -<!ELEMENT database %ho; (%cptr.char.mix;)*> -<!--end of database.element-->]]> - -<!-- Class: Type of database the element names; no default --> - - -<!ENTITY % database.attlist "INCLUDE"> -<![%database.attlist;[ -<!ATTLIST database - class (name - |table - |field - |key1 - |key2 - |record - |index - |view - |primarykey - |secondarykey - |foreignkey - |altkey - |procedure - |datatype - |constraint - |rule - |user - |group) #IMPLIED - %moreinfo.attrib; - %common.attrib; - %database.role.attrib; - %local.database.attrib; -> -<!--end of database.attlist-->]]> -<!--end of database.module-->]]> - -<!ENTITY % email.module "INCLUDE"> -<![%email.module;[ -<!ENTITY % local.email.attrib ""> -<!ENTITY % email.role.attrib "%role.attrib;"> - -<!ENTITY % email.element "INCLUDE"> -<![%email.element;[ -<!--doc:An email address.--> -<!ELEMENT email %ho; (%docinfo.char.mix;)*> -<!--end of email.element-->]]> - -<!ENTITY % email.attlist "INCLUDE"> -<![%email.attlist;[ -<!ATTLIST email - %common.attrib; - %email.role.attrib; - %local.email.attrib; -> -<!--end of email.attlist-->]]> -<!--end of email.module-->]]> - -<!ENTITY % envar.module "INCLUDE"> -<![%envar.module;[ -<!ENTITY % local.envar.attrib ""> -<!ENTITY % envar.role.attrib "%role.attrib;"> - -<!ENTITY % envar.element "INCLUDE"> -<![%envar.element;[ -<!--doc:A software environment variable.--> -<!ELEMENT envar %ho; (%smallcptr.char.mix;)*> -<!--end of envar.element-->]]> - -<!ENTITY % envar.attlist "INCLUDE"> -<![%envar.attlist;[ -<!ATTLIST envar - %common.attrib; - %envar.role.attrib; - %local.envar.attrib; -> -<!--end of envar.attlist-->]]> -<!--end of envar.module-->]]> - - -<!ENTITY % errorcode.module "INCLUDE"> -<![%errorcode.module;[ -<!ENTITY % local.errorcode.attrib ""> -<!ENTITY % errorcode.role.attrib "%role.attrib;"> - -<!ENTITY % errorcode.element "INCLUDE"> -<![%errorcode.element;[ -<!--doc:An error code.--> -<!ELEMENT errorcode %ho; (%smallcptr.char.mix;)*> -<!--end of errorcode.element-->]]> - -<!ENTITY % errorcode.attlist "INCLUDE"> -<![%errorcode.attlist;[ -<!ATTLIST errorcode - %moreinfo.attrib; - %common.attrib; - %errorcode.role.attrib; - %local.errorcode.attrib; -> -<!--end of errorcode.attlist-->]]> -<!--end of errorcode.module-->]]> - -<!ENTITY % errorname.module "INCLUDE"> -<![%errorname.module;[ -<!ENTITY % local.errorname.attrib ""> -<!ENTITY % errorname.role.attrib "%role.attrib;"> - -<!ENTITY % errorname.element "INCLUDE"> -<![%errorname.element;[ -<!--doc:An error name.--> -<!ELEMENT errorname %ho; (%smallcptr.char.mix;)*> -<!--end of errorname.element-->]]> - -<!ENTITY % errorname.attlist "INCLUDE"> -<![%errorname.attlist;[ -<!ATTLIST errorname - %common.attrib; - %errorname.role.attrib; - %local.errorname.attrib; -> -<!--end of errorname.attlist-->]]> -<!--end of errorname.module-->]]> - -<!ENTITY % errortext.module "INCLUDE"> -<![%errortext.module;[ -<!ENTITY % local.errortext.attrib ""> -<!ENTITY % errortext.role.attrib "%role.attrib;"> - -<!ENTITY % errortext.element "INCLUDE"> -<![%errortext.element;[ -<!--doc:An error message..--> -<!ELEMENT errortext %ho; (%smallcptr.char.mix;)*> -<!--end of errortext.element-->]]> - -<!ENTITY % errortext.attlist "INCLUDE"> -<![%errortext.attlist;[ -<!ATTLIST errortext - %common.attrib; - %errortext.role.attrib; - %local.errortext.attrib; -> -<!--end of errortext.attlist-->]]> -<!--end of errortext.module-->]]> - -<!ENTITY % errortype.module "INCLUDE"> -<![%errortype.module;[ -<!ENTITY % local.errortype.attrib ""> -<!ENTITY % errortype.role.attrib "%role.attrib;"> - -<!ENTITY % errortype.element "INCLUDE"> -<![%errortype.element;[ -<!--doc:The classification of an error message.--> -<!ELEMENT errortype %ho; (%smallcptr.char.mix;)*> -<!--end of errortype.element-->]]> - -<!ENTITY % errortype.attlist "INCLUDE"> -<![%errortype.attlist;[ -<!ATTLIST errortype - %common.attrib; - %errortype.role.attrib; - %local.errortype.attrib; -> -<!--end of errortype.attlist-->]]> -<!--end of errortype.module-->]]> - -<!ENTITY % filename.module "INCLUDE"> -<![%filename.module;[ -<!ENTITY % local.filename.attrib ""> -<!ENTITY % filename.role.attrib "%role.attrib;"> - -<!ENTITY % filename.element "INCLUDE"> -<![%filename.element;[ -<!--doc:The name of a file.--> -<!ELEMENT filename %ho; (%cptr.char.mix;)*> -<!--end of filename.element-->]]> - -<!-- Class: Type of filename the element names; no default --> -<!-- Path: Search path (possibly system-specific) in which - file can be found --> - - -<!ENTITY % filename.attlist "INCLUDE"> -<![%filename.attlist;[ -<!ATTLIST filename - class (headerfile - |partition - |devicefile - |libraryfile - |directory - |extension - |symlink) #IMPLIED - path CDATA #IMPLIED - %moreinfo.attrib; - %common.attrib; - %filename.role.attrib; - %local.filename.attrib; -> -<!--end of filename.attlist-->]]> -<!--end of filename.module-->]]> - -<!ENTITY % function.module "INCLUDE"> -<![%function.module;[ -<!ENTITY % local.function.attrib ""> -<!ENTITY % function.role.attrib "%role.attrib;"> - -<!ENTITY % function.element "INCLUDE"> -<![%function.element;[ -<!--doc:The name of a function or subroutine, as in a programming language.--> -<!ELEMENT function %ho; (%cptr.char.mix;)*> -<!--end of function.element-->]]> - -<!ENTITY % function.attlist "INCLUDE"> -<![%function.attlist;[ -<!ATTLIST function - %moreinfo.attrib; - %common.attrib; - %function.role.attrib; - %local.function.attrib; -> -<!--end of function.attlist-->]]> -<!--end of function.module-->]]> - -<!ENTITY % guibutton.module "INCLUDE"> -<![%guibutton.module;[ -<!ENTITY % local.guibutton.attrib ""> -<!ENTITY % guibutton.role.attrib "%role.attrib;"> - -<!ENTITY % guibutton.element "INCLUDE"> -<![%guibutton.element;[ -<!--doc:The text on a button in a GUI.--> -<!ELEMENT guibutton %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guibutton.element-->]]> - -<!ENTITY % guibutton.attlist "INCLUDE"> -<![%guibutton.attlist;[ -<!ATTLIST guibutton - %moreinfo.attrib; - %common.attrib; - %guibutton.role.attrib; - %local.guibutton.attrib; -> -<!--end of guibutton.attlist-->]]> -<!--end of guibutton.module-->]]> - -<!ENTITY % guiicon.module "INCLUDE"> -<![%guiicon.module;[ -<!ENTITY % local.guiicon.attrib ""> -<!ENTITY % guiicon.role.attrib "%role.attrib;"> - -<!ENTITY % guiicon.element "INCLUDE"> -<![%guiicon.element;[ -<!--doc:Graphic and/or text appearing as a icon in a GUI.--> -<!ELEMENT guiicon %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guiicon.element-->]]> - -<!ENTITY % guiicon.attlist "INCLUDE"> -<![%guiicon.attlist;[ -<!ATTLIST guiicon - %moreinfo.attrib; - %common.attrib; - %guiicon.role.attrib; - %local.guiicon.attrib; -> -<!--end of guiicon.attlist-->]]> -<!--end of guiicon.module-->]]> - -<!ENTITY % guilabel.module "INCLUDE"> -<![%guilabel.module;[ -<!ENTITY % local.guilabel.attrib ""> -<!ENTITY % guilabel.role.attrib "%role.attrib;"> - -<!ENTITY % guilabel.element "INCLUDE"> -<![%guilabel.element;[ -<!--doc:The text of a label in a GUI.--> -<!ELEMENT guilabel %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guilabel.element-->]]> - -<!ENTITY % guilabel.attlist "INCLUDE"> -<![%guilabel.attlist;[ -<!ATTLIST guilabel - %moreinfo.attrib; - %common.attrib; - %guilabel.role.attrib; - %local.guilabel.attrib; -> -<!--end of guilabel.attlist-->]]> -<!--end of guilabel.module-->]]> - -<!ENTITY % guimenu.module "INCLUDE"> -<![%guimenu.module;[ -<!ENTITY % local.guimenu.attrib ""> -<!ENTITY % guimenu.role.attrib "%role.attrib;"> - -<!ENTITY % guimenu.element "INCLUDE"> -<![%guimenu.element;[ -<!--doc:The name of a menu in a GUI.--> -<!ELEMENT guimenu %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guimenu.element-->]]> - -<!ENTITY % guimenu.attlist "INCLUDE"> -<![%guimenu.attlist;[ -<!ATTLIST guimenu - %moreinfo.attrib; - %common.attrib; - %guimenu.role.attrib; - %local.guimenu.attrib; -> -<!--end of guimenu.attlist-->]]> -<!--end of guimenu.module-->]]> - -<!ENTITY % guimenuitem.module "INCLUDE"> -<![%guimenuitem.module;[ -<!ENTITY % local.guimenuitem.attrib ""> -<!ENTITY % guimenuitem.role.attrib "%role.attrib;"> - -<!ENTITY % guimenuitem.element "INCLUDE"> -<![%guimenuitem.element;[ -<!--doc:The name of a terminal menu item in a GUI.--> -<!ELEMENT guimenuitem %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guimenuitem.element-->]]> - -<!ENTITY % guimenuitem.attlist "INCLUDE"> -<![%guimenuitem.attlist;[ -<!ATTLIST guimenuitem - %moreinfo.attrib; - %common.attrib; - %guimenuitem.role.attrib; - %local.guimenuitem.attrib; -> -<!--end of guimenuitem.attlist-->]]> -<!--end of guimenuitem.module-->]]> - -<!ENTITY % guisubmenu.module "INCLUDE"> -<![%guisubmenu.module;[ -<!ENTITY % local.guisubmenu.attrib ""> -<!ENTITY % guisubmenu.role.attrib "%role.attrib;"> - -<!ENTITY % guisubmenu.element "INCLUDE"> -<![%guisubmenu.element;[ -<!--doc:The name of a submenu in a GUI.--> -<!ELEMENT guisubmenu %ho; (%smallcptr.char.mix;|accel|superscript|subscript)*> -<!--end of guisubmenu.element-->]]> - -<!ENTITY % guisubmenu.attlist "INCLUDE"> -<![%guisubmenu.attlist;[ -<!ATTLIST guisubmenu - %moreinfo.attrib; - %common.attrib; - %guisubmenu.role.attrib; - %local.guisubmenu.attrib; -> -<!--end of guisubmenu.attlist-->]]> -<!--end of guisubmenu.module-->]]> - -<!ENTITY % hardware.module "INCLUDE"> -<![%hardware.module;[ -<!ENTITY % local.hardware.attrib ""> -<!ENTITY % hardware.role.attrib "%role.attrib;"> - -<!ENTITY % hardware.element "INCLUDE"> -<![%hardware.element;[ -<!--doc:A physical part of a computer system.--> -<!ELEMENT hardware %ho; (%cptr.char.mix;)*> -<!--end of hardware.element-->]]> - -<!ENTITY % hardware.attlist "INCLUDE"> -<![%hardware.attlist;[ -<!ATTLIST hardware - %moreinfo.attrib; - %common.attrib; - %hardware.role.attrib; - %local.hardware.attrib; -> -<!--end of hardware.attlist-->]]> -<!--end of hardware.module-->]]> - -<!ENTITY % interface.module "INCLUDE"> -<![%interface.module;[ -<!ENTITY % local.interface.attrib ""> -<!ENTITY % interface.role.attrib "%role.attrib;"> - -<!ENTITY % interface.element "INCLUDE"> -<![%interface.element;[ -<!--doc:An element of a GUI.--> -<!ELEMENT interface %ho; (%smallcptr.char.mix;|accel)*> -<!--end of interface.element-->]]> - -<!-- Class: Type of the Interface item; no default --> - - -<!ENTITY % interface.attlist "INCLUDE"> -<![%interface.attlist;[ -<!ATTLIST interface - %moreinfo.attrib; - %common.attrib; - %interface.role.attrib; - %local.interface.attrib; -> -<!--end of interface.attlist-->]]> -<!--end of interface.module-->]]> - -<!ENTITY % keycap.module "INCLUDE"> -<![%keycap.module;[ -<!ENTITY % local.keycap.attrib ""> -<!ENTITY % keycap.role.attrib "%role.attrib;"> - -<!ENTITY % keycap.element "INCLUDE"> -<![%keycap.element;[ -<!--doc:The text printed on a key on a keyboard.--> -<!ELEMENT keycap %ho; (%cptr.char.mix;)*> -<!--end of keycap.element-->]]> - -<!ENTITY % keycap.attlist "INCLUDE"> -<![%keycap.attlist;[ -<!ATTLIST keycap - function (alt - |control - |shift - |meta - |escape - |enter - |tab - |backspace - |command - |option - |space - |delete - |insert - |up - |down - |left - |right - |home - |end - |pageup - |pagedown - |other) #IMPLIED - otherfunction CDATA #IMPLIED - %moreinfo.attrib; - %common.attrib; - %keycap.role.attrib; - %local.keycap.attrib; -> -<!--end of keycap.attlist-->]]> -<!--end of keycap.module-->]]> - -<!ENTITY % keycode.module "INCLUDE"> -<![%keycode.module;[ -<!ENTITY % local.keycode.attrib ""> -<!ENTITY % keycode.role.attrib "%role.attrib;"> - -<!ENTITY % keycode.element "INCLUDE"> -<![%keycode.element;[ -<!--doc:The internal, frequently numeric, identifier for a key on a keyboard.--> -<!ELEMENT keycode %ho; (%smallcptr.char.mix;)*> -<!--end of keycode.element-->]]> - -<!ENTITY % keycode.attlist "INCLUDE"> -<![%keycode.attlist;[ -<!ATTLIST keycode - %common.attrib; - %keycode.role.attrib; - %local.keycode.attrib; -> -<!--end of keycode.attlist-->]]> -<!--end of keycode.module-->]]> - -<!ENTITY % keycombo.module "INCLUDE"> -<![%keycombo.module;[ -<!ENTITY % local.keycombo.attrib ""> -<!ENTITY % keycombo.role.attrib "%role.attrib;"> - -<!ENTITY % keycombo.element "INCLUDE"> -<![%keycombo.element;[ -<!--doc:A combination of input actions.--> -<!ELEMENT keycombo %ho; ((keycap|keycombo|keysym|mousebutton)+)> -<!--end of keycombo.element-->]]> - -<!ENTITY % keycombo.attlist "INCLUDE"> -<![%keycombo.attlist;[ -<!ATTLIST keycombo - %keyaction.attrib; - %moreinfo.attrib; - %common.attrib; - %keycombo.role.attrib; - %local.keycombo.attrib; -> -<!--end of keycombo.attlist-->]]> -<!--end of keycombo.module-->]]> - -<!ENTITY % keysym.module "INCLUDE"> -<![%keysym.module;[ -<!ENTITY % local.keysym.attrib ""> -<!ENTITY % keysysm.role.attrib "%role.attrib;"> - -<!ENTITY % keysym.element "INCLUDE"> -<![%keysym.element;[ -<!--doc:The symbolic name of a key on a keyboard.--> -<!ELEMENT keysym %ho; (%smallcptr.char.mix;)*> -<!--end of keysym.element-->]]> - -<!ENTITY % keysym.attlist "INCLUDE"> -<![%keysym.attlist;[ -<!ATTLIST keysym - %common.attrib; - %keysysm.role.attrib; - %local.keysym.attrib; -> -<!--end of keysym.attlist-->]]> -<!--end of keysym.module-->]]> - -<!ENTITY % lineannotation.module "INCLUDE"> -<![%lineannotation.module;[ -<!ENTITY % local.lineannotation.attrib ""> -<!ENTITY % lineannotation.role.attrib "%role.attrib;"> - -<!ENTITY % lineannotation.element "INCLUDE"> -<![%lineannotation.element;[ -<!--doc:A comment on a line in a verbatim listing.--> -<!ELEMENT lineannotation %ho; (%para.char.mix;)*> -<!--end of lineannotation.element-->]]> - -<!ENTITY % lineannotation.attlist "INCLUDE"> -<![%lineannotation.attlist;[ -<!ATTLIST lineannotation - %common.attrib; - %lineannotation.role.attrib; - %local.lineannotation.attrib; -> -<!--end of lineannotation.attlist-->]]> -<!--end of lineannotation.module-->]]> - -<!ENTITY % literal.module "INCLUDE"> -<![%literal.module;[ -<!ENTITY % local.literal.attrib ""> -<!ENTITY % literal.role.attrib "%role.attrib;"> - -<!ENTITY % literal.element "INCLUDE"> -<![%literal.element;[ -<!--doc:Inline text that is some literal value.--> -<!ELEMENT literal %ho; (%cptr.char.mix;)*> -<!--end of literal.element-->]]> - -<!ENTITY % literal.attlist "INCLUDE"> -<![%literal.attlist;[ -<!ATTLIST literal - %moreinfo.attrib; - %common.attrib; - %literal.role.attrib; - %local.literal.attrib; -> -<!--end of literal.attlist-->]]> -<!--end of literal.module-->]]> - -<!ENTITY % code.module "INCLUDE"> -<![%code.module;[ -<!ENTITY % local.code.attrib ""> -<!ENTITY % code.role.attrib "%role.attrib;"> - -<!ENTITY % code.element "INCLUDE"> -<![%code.element;[ -<!--doc:An inline code fragment.--> -<!ELEMENT code %ho; (%cptr.char.mix;)*> -<!--end of code.element-->]]> - -<!ENTITY % code.attlist "INCLUDE"> -<![%code.attlist;[ -<!ATTLIST code - language CDATA #IMPLIED - %common.attrib; - %code.role.attrib; - %local.code.attrib; -> -<!--end of code.attlist-->]]> -<!--end of code.module-->]]> - -<!ENTITY % constant.module "INCLUDE"> -<![ %constant.module; [ -<!ENTITY % local.constant.attrib ""> -<!ENTITY % constant.role.attrib "%role.attrib;"> - -<!ENTITY % constant.element "INCLUDE"> -<![ %constant.element; [ -<!--doc:A programming or system constant.--> -<!ELEMENT constant %ho; (%smallcptr.char.mix;)*> -<!--end of constant.element-->]]> - -<!ENTITY % constant.attlist "INCLUDE"> -<![ %constant.attlist; [ -<!ATTLIST constant - class (limit) #IMPLIED - %common.attrib; - %constant.role.attrib; - %local.constant.attrib; -> -<!--end of constant.attlist-->]]> -<!--end of constant.module-->]]> - -<!ENTITY % varname.module "INCLUDE"> -<![ %varname.module; [ -<!ENTITY % local.varname.attrib ""> -<!ENTITY % varname.role.attrib "%role.attrib;"> - -<!ENTITY % varname.element "INCLUDE"> -<![ %varname.element; [ -<!--doc:The name of a variable.--> -<!ELEMENT varname %ho; (%smallcptr.char.mix;)*> -<!--end of varname.element-->]]> - -<!ENTITY % varname.attlist "INCLUDE"> -<![ %varname.attlist; [ -<!ATTLIST varname - %common.attrib; - %varname.role.attrib; - %local.varname.attrib; -> -<!--end of varname.attlist-->]]> -<!--end of varname.module-->]]> - -<!ENTITY % markup.module "INCLUDE"> -<![%markup.module;[ -<!ENTITY % local.markup.attrib ""> -<!ENTITY % markup.role.attrib "%role.attrib;"> - -<!ENTITY % markup.element "INCLUDE"> -<![%markup.element;[ -<!--doc:A string of formatting markup in text that is to be represented literally.--> -<!ELEMENT markup %ho; (%smallcptr.char.mix;)*> -<!--end of markup.element-->]]> - -<!ENTITY % markup.attlist "INCLUDE"> -<![%markup.attlist;[ -<!ATTLIST markup - %common.attrib; - %markup.role.attrib; - %local.markup.attrib; -> -<!--end of markup.attlist-->]]> -<!--end of markup.module-->]]> - -<!ENTITY % medialabel.module "INCLUDE"> -<![%medialabel.module;[ -<!ENTITY % local.medialabel.attrib ""> -<!ENTITY % medialabel.role.attrib "%role.attrib;"> - -<!ENTITY % medialabel.element "INCLUDE"> -<![%medialabel.element;[ -<!--doc:A name that identifies the physical medium on which some information resides.--> -<!ELEMENT medialabel %ho; (%smallcptr.char.mix;)*> -<!--end of medialabel.element-->]]> - -<!-- Class: Type of medium named by the element; no default --> - - -<!ENTITY % medialabel.attlist "INCLUDE"> -<![%medialabel.attlist;[ -<!ATTLIST medialabel - class (cartridge - |cdrom - |disk - |tape) #IMPLIED - %common.attrib; - %medialabel.role.attrib; - %local.medialabel.attrib; -> -<!--end of medialabel.attlist-->]]> -<!--end of medialabel.module-->]]> - -<!ENTITY % menuchoice.content.module "INCLUDE"> -<![%menuchoice.content.module;[ -<!ENTITY % menuchoice.module "INCLUDE"> -<![%menuchoice.module;[ -<!ENTITY % local.menuchoice.attrib ""> -<!ENTITY % menuchoice.role.attrib "%role.attrib;"> - -<!ENTITY % menuchoice.element "INCLUDE"> -<![%menuchoice.element;[ -<!--doc:A selection or series of selections from a menu.--> -<!ELEMENT menuchoice %ho; (shortcut?, (guibutton|guiicon|guilabel - |guimenu|guimenuitem|guisubmenu|interface)+)> -<!--end of menuchoice.element-->]]> - -<!ENTITY % menuchoice.attlist "INCLUDE"> -<![%menuchoice.attlist;[ -<!ATTLIST menuchoice - %moreinfo.attrib; - %common.attrib; - %menuchoice.role.attrib; - %local.menuchoice.attrib; -> -<!--end of menuchoice.attlist-->]]> -<!--end of menuchoice.module-->]]> - -<!ENTITY % shortcut.module "INCLUDE"> -<![%shortcut.module;[ -<!-- See also KeyCombo --> -<!ENTITY % local.shortcut.attrib ""> -<!ENTITY % shortcut.role.attrib "%role.attrib;"> - -<!ENTITY % shortcut.element "INCLUDE"> -<![%shortcut.element;[ -<!--doc:A key combination for an action that is also accessible through a menu.--> -<!ELEMENT shortcut %ho; ((keycap|keycombo|keysym|mousebutton)+)> -<!--end of shortcut.element-->]]> - -<!ENTITY % shortcut.attlist "INCLUDE"> -<![%shortcut.attlist;[ -<!ATTLIST shortcut - %keyaction.attrib; - %moreinfo.attrib; - %common.attrib; - %shortcut.role.attrib; - %local.shortcut.attrib; -> -<!--end of shortcut.attlist-->]]> -<!--end of shortcut.module-->]]> -<!--end of menuchoice.content.module-->]]> - -<!ENTITY % mousebutton.module "INCLUDE"> -<![%mousebutton.module;[ -<!ENTITY % local.mousebutton.attrib ""> -<!ENTITY % mousebutton.role.attrib "%role.attrib;"> - -<!ENTITY % mousebutton.element "INCLUDE"> -<![%mousebutton.element;[ -<!--doc:The conventional name of a mouse button.--> -<!ELEMENT mousebutton %ho; (%smallcptr.char.mix;)*> -<!--end of mousebutton.element-->]]> - -<!ENTITY % mousebutton.attlist "INCLUDE"> -<![%mousebutton.attlist;[ -<!ATTLIST mousebutton - %moreinfo.attrib; - %common.attrib; - %mousebutton.role.attrib; - %local.mousebutton.attrib; -> -<!--end of mousebutton.attlist-->]]> -<!--end of mousebutton.module-->]]> - -<!ENTITY % msgtext.module "INCLUDE"> -<![%msgtext.module;[ -<!ENTITY % local.msgtext.attrib ""> -<!ENTITY % msgtext.role.attrib "%role.attrib;"> - -<!ENTITY % msgtext.element "INCLUDE"> -<![%msgtext.element;[ -<!--doc:The actual text of a message component in a message set.--> -<!ELEMENT msgtext %ho; ((%component.mix;)+)> -<!--end of msgtext.element-->]]> - -<!ENTITY % msgtext.attlist "INCLUDE"> -<![%msgtext.attlist;[ -<!ATTLIST msgtext - %common.attrib; - %msgtext.role.attrib; - %local.msgtext.attrib; -> -<!--end of msgtext.attlist-->]]> -<!--end of msgtext.module-->]]> - -<!ENTITY % option.module "INCLUDE"> -<![%option.module;[ -<!ENTITY % local.option.attrib ""> -<!ENTITY % option.role.attrib "%role.attrib;"> - -<!ENTITY % option.element "INCLUDE"> -<![%option.element;[ -<!--doc:An option for a software command.--> -<!ELEMENT option %ho; (%cptr.char.mix;)*> -<!--end of option.element-->]]> - -<!ENTITY % option.attlist "INCLUDE"> -<![%option.attlist;[ -<!ATTLIST option - %common.attrib; - %option.role.attrib; - %local.option.attrib; -> -<!--end of option.attlist-->]]> -<!--end of option.module-->]]> - -<!ENTITY % optional.module "INCLUDE"> -<![%optional.module;[ -<!ENTITY % local.optional.attrib ""> -<!ENTITY % optional.role.attrib "%role.attrib;"> - -<!ENTITY % optional.element "INCLUDE"> -<![%optional.element;[ -<!--doc:Optional information.--> -<!ELEMENT optional %ho; (%cptr.char.mix;)*> -<!--end of optional.element-->]]> - -<!ENTITY % optional.attlist "INCLUDE"> -<![%optional.attlist;[ -<!ATTLIST optional - %common.attrib; - %optional.role.attrib; - %local.optional.attrib; -> -<!--end of optional.attlist-->]]> -<!--end of optional.module-->]]> - -<!ENTITY % parameter.module "INCLUDE"> -<![%parameter.module;[ -<!ENTITY % local.parameter.attrib ""> -<!ENTITY % parameter.role.attrib "%role.attrib;"> - -<!ENTITY % parameter.element "INCLUDE"> -<![%parameter.element;[ -<!--doc:A value or a symbolic reference to a value.--> -<!ELEMENT parameter %ho; (%cptr.char.mix;)*> -<!--end of parameter.element-->]]> - -<!-- Class: Type of the Parameter; no default --> - - -<!ENTITY % parameter.attlist "INCLUDE"> -<![%parameter.attlist;[ -<!ATTLIST parameter - class (command - |function - |option) #IMPLIED - %moreinfo.attrib; - %common.attrib; - %parameter.role.attrib; - %local.parameter.attrib; -> -<!--end of parameter.attlist-->]]> -<!--end of parameter.module-->]]> - -<!ENTITY % prompt.module "INCLUDE"> -<![%prompt.module;[ -<!ENTITY % local.prompt.attrib ""> -<!ENTITY % prompt.role.attrib "%role.attrib;"> - -<!ENTITY % prompt.element "INCLUDE"> -<![%prompt.element;[ -<!--doc:A character or string indicating the start of an input field in a computer display.--> -<!ELEMENT prompt %ho; (%smallcptr.char.mix;|co)*> -<!--end of prompt.element-->]]> - -<!ENTITY % prompt.attlist "INCLUDE"> -<![%prompt.attlist;[ -<!ATTLIST prompt - %moreinfo.attrib; - %common.attrib; - %prompt.role.attrib; - %local.prompt.attrib; -> -<!--end of prompt.attlist-->]]> -<!--end of prompt.module-->]]> - -<!ENTITY % property.module "INCLUDE"> -<![%property.module;[ -<!ENTITY % local.property.attrib ""> -<!ENTITY % property.role.attrib "%role.attrib;"> - -<!ENTITY % property.element "INCLUDE"> -<![%property.element;[ -<!--doc:A unit of data associated with some part of a computer system.--> -<!ELEMENT property %ho; (%cptr.char.mix;)*> -<!--end of property.element-->]]> - -<!ENTITY % property.attlist "INCLUDE"> -<![%property.attlist;[ -<!ATTLIST property - %moreinfo.attrib; - %common.attrib; - %property.role.attrib; - %local.property.attrib; -> -<!--end of property.attlist-->]]> -<!--end of property.module-->]]> - -<!ENTITY % replaceable.module "INCLUDE"> -<![%replaceable.module;[ -<!ENTITY % local.replaceable.attrib ""> -<!ENTITY % replaceable.role.attrib "%role.attrib;"> - -<!ENTITY % replaceable.element "INCLUDE"> -<![%replaceable.element;[ -<!--doc:Content that may or must be replaced by the user.--> -<!ELEMENT replaceable %ho; (#PCDATA - | %link.char.class; - | optional - | %base.char.class; - | %other.char.class; - | inlinegraphic - | inlinemediaobject - | co)*> -<!--end of replaceable.element-->]]> - -<!-- Class: Type of information the element represents; no - default --> - - -<!ENTITY % replaceable.attlist "INCLUDE"> -<![%replaceable.attlist;[ -<!ATTLIST replaceable - class (command - |function - |option - |parameter) #IMPLIED - %common.attrib; - %replaceable.role.attrib; - %local.replaceable.attrib; -> -<!--end of replaceable.attlist-->]]> -<!--end of replaceable.module-->]]> - -<!ENTITY % returnvalue.module "INCLUDE"> -<![%returnvalue.module;[ -<!ENTITY % local.returnvalue.attrib ""> -<!ENTITY % returnvalue.role.attrib "%role.attrib;"> - -<!ENTITY % returnvalue.element "INCLUDE"> -<![%returnvalue.element;[ -<!--doc:The value returned by a function.--> -<!ELEMENT returnvalue %ho; (%smallcptr.char.mix;)*> -<!--end of returnvalue.element-->]]> - -<!ENTITY % returnvalue.attlist "INCLUDE"> -<![%returnvalue.attlist;[ -<!ATTLIST returnvalue - %common.attrib; - %returnvalue.role.attrib; - %local.returnvalue.attrib; -> -<!--end of returnvalue.attlist-->]]> -<!--end of returnvalue.module-->]]> - -<!ENTITY % sgmltag.module "INCLUDE"> -<![%sgmltag.module;[ -<!ENTITY % local.sgmltag.attrib ""> -<!ENTITY % sgmltag.role.attrib "%role.attrib;"> - -<!ENTITY % sgmltag.element "INCLUDE"> -<![%sgmltag.element;[ -<!--doc:A component of SGML markup.--> -<!ELEMENT sgmltag %ho; (%smallcptr.char.mix;)*> -<!--end of sgmltag.element-->]]> - -<!-- Class: Type of SGML construct the element names; no default --> - - -<!ENTITY % sgmltag.attlist "INCLUDE"> -<![%sgmltag.attlist;[ -<!ATTLIST sgmltag - class (attribute - |attvalue - |element - |endtag - |emptytag - |genentity - |numcharref - |paramentity - |pi - |xmlpi - |starttag - |sgmlcomment - |prefix - |namespace - |localname) #IMPLIED - namespace CDATA #IMPLIED - %common.attrib; - %sgmltag.role.attrib; - %local.sgmltag.attrib; -> -<!--end of sgmltag.attlist-->]]> -<!--end of sgmltag.module-->]]> - -<!ENTITY % structfield.module "INCLUDE"> -<![%structfield.module;[ -<!ENTITY % local.structfield.attrib ""> -<!ENTITY % structfield.role.attrib "%role.attrib;"> - -<!ENTITY % structfield.element "INCLUDE"> -<![%structfield.element;[ -<!--doc:A field in a structure (in the programming language sense).--> -<!ELEMENT structfield %ho; (%smallcptr.char.mix;)*> -<!--end of structfield.element-->]]> - -<!ENTITY % structfield.attlist "INCLUDE"> -<![%structfield.attlist;[ -<!ATTLIST structfield - %common.attrib; - %structfield.role.attrib; - %local.structfield.attrib; -> -<!--end of structfield.attlist-->]]> -<!--end of structfield.module-->]]> - -<!ENTITY % structname.module "INCLUDE"> -<![%structname.module;[ -<!ENTITY % local.structname.attrib ""> -<!ENTITY % structname.role.attrib "%role.attrib;"> - -<!ENTITY % structname.element "INCLUDE"> -<![%structname.element;[ -<!--doc:The name of a structure (in the programming language sense).--> -<!ELEMENT structname %ho; (%smallcptr.char.mix;)*> -<!--end of structname.element-->]]> - -<!ENTITY % structname.attlist "INCLUDE"> -<![%structname.attlist;[ -<!ATTLIST structname - %common.attrib; - %structname.role.attrib; - %local.structname.attrib; -> -<!--end of structname.attlist-->]]> -<!--end of structname.module-->]]> - -<!ENTITY % symbol.module "INCLUDE"> -<![%symbol.module;[ -<!ENTITY % local.symbol.attrib ""> -<!ENTITY % symbol.role.attrib "%role.attrib;"> - -<!ENTITY % symbol.element "INCLUDE"> -<![%symbol.element;[ -<!--doc:A name that is replaced by a value before processing.--> -<!ELEMENT symbol %ho; (%smallcptr.char.mix;)*> -<!--end of symbol.element-->]]> - -<!-- Class: Type of symbol; no default --> - - -<!ENTITY % symbol.attlist "INCLUDE"> -<![%symbol.attlist;[ -<!ATTLIST symbol - class (limit) #IMPLIED - %common.attrib; - %symbol.role.attrib; - %local.symbol.attrib; -> -<!--end of symbol.attlist-->]]> -<!--end of symbol.module-->]]> - -<!ENTITY % systemitem.module "INCLUDE"> -<![%systemitem.module;[ -<!ENTITY % local.systemitem.attrib ""> -<!ENTITY % systemitem.role.attrib "%role.attrib;"> - -<!ENTITY % systemitem.element "INCLUDE"> -<![%systemitem.element;[ -<!--doc:A system-related item or term.--> -<!ELEMENT systemitem %ho; (%cptr.char.mix; | acronym | co)*> -<!--end of systemitem.element-->]]> - -<!-- Class: Type of system item the element names; no default --> - -<!ENTITY % systemitem.attlist "INCLUDE"> -<![%systemitem.attlist;[ -<!ATTLIST systemitem - class (constant - |daemon - |domainname - |etheraddress - |event - |eventhandler - |filesystem - |fqdomainname - |groupname - |ipaddress - |library - |macro - |netmask - |newsgroup - |osname - |protocol - |resource - |systemname - |username - |process - |server - |service) #IMPLIED - %moreinfo.attrib; - %common.attrib; - %systemitem.role.attrib; - %local.systemitem.attrib; -> -<!--end of systemitem.attlist-->]]> -<!--end of systemitem.module-->]]> - -<!ENTITY % uri.module "INCLUDE"> -<![%uri.module;[ -<!ENTITY % local.uri.attrib ""> -<!ENTITY % uri.role.attrib "%role.attrib;"> - -<!ENTITY % uri.element "INCLUDE"> -<![%uri.element;[ -<!--doc:A Uniform Resource Identifier.--> -<!ELEMENT uri %ho; (%smallcptr.char.mix;)*> -<!--end of uri.element-->]]> - -<!-- Type: Type of URI; no default --> - -<!ENTITY % uri.attlist "INCLUDE"> -<![%uri.attlist;[ -<!ATTLIST uri - type CDATA #IMPLIED - %common.attrib; - %uri.role.attrib; - %local.uri.attrib; -> -<!--end of uri.attlist-->]]> -<!--end of uri.module-->]]> - -<!ENTITY % token.module "INCLUDE"> -<![%token.module;[ -<!ENTITY % local.token.attrib ""> -<!ENTITY % token.role.attrib "%role.attrib;"> - -<!ENTITY % token.element "INCLUDE"> -<![%token.element;[ -<!--doc:A unit of information.--> -<!ELEMENT token %ho; (%smallcptr.char.mix;)*> -<!--end of token.element-->]]> - -<!ENTITY % token.attlist "INCLUDE"> -<![%token.attlist;[ -<!ATTLIST token - %common.attrib; - %token.role.attrib; - %local.token.attrib; -> -<!--end of token.attlist-->]]> -<!--end of token.module-->]]> - -<!ENTITY % type.module "INCLUDE"> -<![%type.module;[ -<!ENTITY % local.type.attrib ""> -<!ENTITY % type.role.attrib "%role.attrib;"> - -<!ENTITY % type.element "INCLUDE"> -<![%type.element;[ -<!--doc:The classification of a value.--> -<!ELEMENT type %ho; (%smallcptr.char.mix;)*> -<!--end of type.element-->]]> - -<!ENTITY % type.attlist "INCLUDE"> -<![%type.attlist;[ -<!ATTLIST type - %common.attrib; - %type.role.attrib; - %local.type.attrib; -> -<!--end of type.attlist-->]]> -<!--end of type.module-->]]> - -<!ENTITY % userinput.module "INCLUDE"> -<![%userinput.module;[ -<!ENTITY % local.userinput.attrib ""> -<!ENTITY % userinput.role.attrib "%role.attrib;"> - -<!ENTITY % userinput.element "INCLUDE"> -<![%userinput.element;[ -<!--doc:Data entered by the user.--> -<!ELEMENT userinput %ho; (%cptr.char.mix;|co)*> -<!--end of userinput.element-->]]> - -<!ENTITY % userinput.attlist "INCLUDE"> -<![%userinput.attlist;[ -<!ATTLIST userinput - %moreinfo.attrib; - %common.attrib; - %userinput.role.attrib; - %local.userinput.attrib; -> -<!--end of userinput.attlist-->]]> -<!--end of userinput.module-->]]> - -<!ENTITY % termdef.module "INCLUDE"> -<![%termdef.module;[ -<!ENTITY % local.termdef.attrib ""> -<!ENTITY % termdef.role.attrib "%role.attrib;"> - -<!ENTITY % termdef.element "INCLUDE"> -<![%termdef.element;[ -<!--doc:An inline definition of a term.--> -<!ELEMENT termdef %ho; (%para.char.mix;)*> -<!--end of termdef.element-->]]> - -<!ENTITY % termdef.attlist "INCLUDE"> -<![%termdef.attlist;[ -<!ATTLIST termdef - %common.attrib; - %termdef.role.attrib; - %local.termdef.attrib; -> -<!--end of termdef.attlist-->]]> -<!--end of termdef.module-->]]> - -<!-- General words and phrases ............................................ --> - -<!ENTITY % abbrev.module "INCLUDE"> -<![%abbrev.module;[ -<!ENTITY % local.abbrev.attrib ""> -<!ENTITY % abbrev.role.attrib "%role.attrib;"> - -<!ENTITY % abbrev.element "INCLUDE"> -<![%abbrev.element;[ -<!--doc:An abbreviation, especially one followed by a period.--> -<!ELEMENT abbrev %ho; (%word.char.mix;)*> -<!--end of abbrev.element-->]]> - -<!ENTITY % abbrev.attlist "INCLUDE"> -<![%abbrev.attlist;[ -<!ATTLIST abbrev - %common.attrib; - %abbrev.role.attrib; - %local.abbrev.attrib; -> -<!--end of abbrev.attlist-->]]> -<!--end of abbrev.module-->]]> - -<!ENTITY % acronym.module "INCLUDE"> -<![%acronym.module;[ -<!ENTITY % local.acronym.attrib ""> -<!ENTITY % acronym.role.attrib "%role.attrib;"> - -<!ENTITY % acronym.element "INCLUDE"> -<![%acronym.element;[ -<!--doc:An often pronounceable word made from the initial (or selected) letters of a name or phrase.--> -<!ELEMENT acronym %ho; (%word.char.mix;)* - %acronym.exclusion;> -<!--end of acronym.element-->]]> - -<!ENTITY % acronym.attlist "INCLUDE"> -<![%acronym.attlist;[ -<!ATTLIST acronym - %common.attrib; - %acronym.role.attrib; - %local.acronym.attrib; -> -<!--end of acronym.attlist-->]]> -<!--end of acronym.module-->]]> - -<!ENTITY % citation.module "INCLUDE"> -<![%citation.module;[ -<!ENTITY % local.citation.attrib ""> -<!ENTITY % citation.role.attrib "%role.attrib;"> - -<!ENTITY % citation.element "INCLUDE"> -<![%citation.element;[ -<!--doc:An inline bibliographic reference to another published work.--> -<!ELEMENT citation %ho; (%para.char.mix;)*> -<!--end of citation.element-->]]> - -<!ENTITY % citation.attlist "INCLUDE"> -<![%citation.attlist;[ -<!ATTLIST citation - %common.attrib; - %citation.role.attrib; - %local.citation.attrib; -> -<!--end of citation.attlist-->]]> -<!--end of citation.module-->]]> - -<!ENTITY % citerefentry.module "INCLUDE"> -<![%citerefentry.module;[ -<!ENTITY % local.citerefentry.attrib ""> -<!ENTITY % citerefentry.role.attrib "%role.attrib;"> - -<!ENTITY % citerefentry.element "INCLUDE"> -<![%citerefentry.element;[ -<!--doc:A citation to a reference page.--> -<!ELEMENT citerefentry %ho; (refentrytitle, manvolnum?)> -<!--end of citerefentry.element-->]]> - -<!ENTITY % citerefentry.attlist "INCLUDE"> -<![%citerefentry.attlist;[ -<!ATTLIST citerefentry - %common.attrib; - %citerefentry.role.attrib; - %local.citerefentry.attrib; -> -<!--end of citerefentry.attlist-->]]> -<!--end of citerefentry.module-->]]> - -<!ENTITY % refentrytitle.module "INCLUDE"> -<![%refentrytitle.module;[ -<!ENTITY % local.refentrytitle.attrib ""> -<!ENTITY % refentrytitle.role.attrib "%role.attrib;"> - -<!ENTITY % refentrytitle.element "INCLUDE"> -<![%refentrytitle.element;[ -<!--doc:The title of a reference page.--> -<!ELEMENT refentrytitle %ho; (%para.char.mix;)*> -<!--end of refentrytitle.element-->]]> - -<!ENTITY % refentrytitle.attlist "INCLUDE"> -<![%refentrytitle.attlist;[ -<!ATTLIST refentrytitle - %common.attrib; - %refentrytitle.role.attrib; - %local.refentrytitle.attrib; -> -<!--end of refentrytitle.attlist-->]]> -<!--end of refentrytitle.module-->]]> - -<!ENTITY % manvolnum.module "INCLUDE"> -<![%manvolnum.module;[ -<!ENTITY % local.manvolnum.attrib ""> -<!ENTITY % namvolnum.role.attrib "%role.attrib;"> - -<!ENTITY % manvolnum.element "INCLUDE"> -<![%manvolnum.element;[ -<!--doc:A reference volume number.--> -<!ELEMENT manvolnum %ho; (%word.char.mix;)*> -<!--end of manvolnum.element-->]]> - -<!ENTITY % manvolnum.attlist "INCLUDE"> -<![%manvolnum.attlist;[ -<!ATTLIST manvolnum - %common.attrib; - %namvolnum.role.attrib; - %local.manvolnum.attrib; -> -<!--end of manvolnum.attlist-->]]> -<!--end of manvolnum.module-->]]> - -<!ENTITY % citetitle.module "INCLUDE"> -<![%citetitle.module;[ -<!ENTITY % local.citetitle.attrib ""> -<!ENTITY % citetitle.role.attrib "%role.attrib;"> - -<!ENTITY % citetitle.element "INCLUDE"> -<![%citetitle.element;[ -<!--doc:The title of a cited work.--> -<!ELEMENT citetitle %ho; (%para.char.mix;)*> -<!--end of citetitle.element-->]]> - -<!-- Pubwork: Genre of published work cited; no default --> - - -<!ENTITY % citetitle.attlist "INCLUDE"> -<![%citetitle.attlist;[ -<!ATTLIST citetitle - pubwork (article - |book - |chapter - |part - |refentry - |section - |journal - |series - |set - |manuscript - |cdrom - |dvd - |wiki - |gopher - |bbs - |emailmessage - |webpage - |newsposting) #IMPLIED - %common.attrib; - %citetitle.role.attrib; - %local.citetitle.attrib; -> -<!--end of citetitle.attlist-->]]> -<!--end of citetitle.module-->]]> - -<!ENTITY % emphasis.module "INCLUDE"> -<![%emphasis.module;[ -<!ENTITY % local.emphasis.attrib ""> -<!ENTITY % emphasis.role.attrib "%role.attrib;"> - -<!ENTITY % emphasis.element "INCLUDE"> -<![%emphasis.element;[ -<!--doc:Emphasized text.--> -<!ELEMENT emphasis %ho; (%para.char.mix;)*> -<!--end of emphasis.element-->]]> - -<!ENTITY % emphasis.attlist "INCLUDE"> -<![%emphasis.attlist;[ -<!ATTLIST emphasis - %common.attrib; - %emphasis.role.attrib; - %local.emphasis.attrib; -> -<!--end of emphasis.attlist-->]]> -<!--end of emphasis.module-->]]> - -<!ENTITY % foreignphrase.module "INCLUDE"> -<![%foreignphrase.module;[ -<!ENTITY % local.foreignphrase.attrib ""> -<!ENTITY % foreignphrase.role.attrib "%role.attrib;"> - -<!ENTITY % foreignphrase.element "INCLUDE"> -<![%foreignphrase.element;[ -<!--doc:A word or phrase in a language other than the primary language of the document.--> -<!ELEMENT foreignphrase %ho; (%para.char.mix;)*> -<!--end of foreignphrase.element-->]]> - -<!ENTITY % foreignphrase.attlist "INCLUDE"> -<![%foreignphrase.attlist;[ -<!ATTLIST foreignphrase - %common.attrib; - %foreignphrase.role.attrib; - %local.foreignphrase.attrib; -> -<!--end of foreignphrase.attlist-->]]> -<!--end of foreignphrase.module-->]]> - -<!ENTITY % glossterm.module "INCLUDE"> -<![%glossterm.module;[ -<!ENTITY % local.glossterm.attrib ""> -<!ENTITY % glossterm.role.attrib "%role.attrib;"> - -<!ENTITY % glossterm.element "INCLUDE"> -<![%glossterm.element;[ -<!--doc:A glossary term.--> -<!ELEMENT glossterm %ho; (%para.char.mix;)* - %glossterm.exclusion;> -<!--end of glossterm.element-->]]> - -<!-- to GlossEntry if Glossterm used in text --> -<!-- BaseForm: Provides the form of GlossTerm to be used - for indexing --> - -<!ENTITY % glossterm.attlist "INCLUDE"> -<![%glossterm.attlist;[ -<!ATTLIST glossterm - baseform CDATA #IMPLIED - %linkend.attrib; - %common.attrib; - %glossterm.role.attrib; - %local.glossterm.attrib; -> -<!--end of glossterm.attlist-->]]> -<!--end of glossterm.module-->]]> - -<!ENTITY % firstterm.module "INCLUDE"> -<![%firstterm.module;[ -<!ENTITY % local.firstterm.attrib ""> -<!ENTITY % firstterm.role.attrib "%role.attrib;"> - -<!ENTITY % firstterm.element "INCLUDE"> -<![%firstterm.element;[ -<!--doc:The first occurrence of a term.--> -<!ELEMENT firstterm %ho; (%para.char.mix;)* - %glossterm.exclusion;> -<!--end of firstterm.element-->]]> - -<!-- to GlossEntry or other explanation --> - - -<!ENTITY % firstterm.attlist "INCLUDE"> -<![%firstterm.attlist;[ -<!ATTLIST firstterm - baseform CDATA #IMPLIED - %linkend.attrib; - %common.attrib; - %firstterm.role.attrib; - %local.firstterm.attrib; -> -<!--end of firstterm.attlist-->]]> -<!--end of firstterm.module-->]]> - -<!ENTITY % phrase.module "INCLUDE"> -<![%phrase.module;[ -<!ENTITY % local.phrase.attrib ""> -<!ENTITY % phrase.role.attrib "%role.attrib;"> - -<!ENTITY % phrase.element "INCLUDE"> -<![%phrase.element;[ -<!--doc:A span of text.--> -<!ELEMENT phrase %ho; (%para.char.mix;)*> -<!--end of phrase.element-->]]> - -<!ENTITY % phrase.attlist "INCLUDE"> -<![%phrase.attlist;[ -<!ATTLIST phrase - %common.attrib; - %phrase.role.attrib; - %local.phrase.attrib; -> -<!--end of phrase.attlist-->]]> -<!--end of phrase.module-->]]> - -<!ENTITY % quote.module "INCLUDE"> -<![%quote.module;[ -<!ENTITY % local.quote.attrib ""> -<!ENTITY % quote.role.attrib "%role.attrib;"> - -<!ENTITY % quote.element "INCLUDE"> -<![%quote.element;[ -<!--doc:An inline quotation.--> -<!ELEMENT quote %ho; (%para.char.mix;)*> -<!--end of quote.element-->]]> - -<!ENTITY % quote.attlist "INCLUDE"> -<![%quote.attlist;[ -<!ATTLIST quote - %common.attrib; - %quote.role.attrib; - %local.quote.attrib; -> -<!--end of quote.attlist-->]]> -<!--end of quote.module-->]]> - -<!ENTITY % ssscript.module "INCLUDE"> -<![%ssscript.module;[ -<!ENTITY % local.ssscript.attrib ""> -<!ENTITY % ssscript.role.attrib "%role.attrib;"> - -<!ENTITY % subscript.element "INCLUDE"> -<![%subscript.element;[ -<!--doc:A subscript (as in H{^2}O, the molecular formula for water).--> -<!ELEMENT subscript %ho; (#PCDATA - | %link.char.class; - | emphasis - | replaceable - | symbol - | inlinegraphic - | inlinemediaobject - | %base.char.class; - | %other.char.class;)* - %ubiq.exclusion;> -<!--end of subscript.element-->]]> - -<!ENTITY % subscript.attlist "INCLUDE"> -<![%subscript.attlist;[ -<!ATTLIST subscript - %common.attrib; - %ssscript.role.attrib; - %local.ssscript.attrib; -> -<!--end of subscript.attlist-->]]> - -<!ENTITY % superscript.element "INCLUDE"> -<![%superscript.element;[ -<!--doc:A superscript (as in x^2, the mathematical notation for x multiplied by itself).--> -<!ELEMENT superscript %ho; (#PCDATA - | %link.char.class; - | emphasis - | replaceable - | symbol - | inlinegraphic - | inlinemediaobject - | %base.char.class; - | %other.char.class;)* - %ubiq.exclusion;> -<!--end of superscript.element-->]]> - -<!ENTITY % superscript.attlist "INCLUDE"> -<![%superscript.attlist;[ -<!ATTLIST superscript - %common.attrib; - %ssscript.role.attrib; - %local.ssscript.attrib; -> -<!--end of superscript.attlist-->]]> -<!--end of ssscript.module-->]]> - -<!ENTITY % trademark.module "INCLUDE"> -<![%trademark.module;[ -<!ENTITY % local.trademark.attrib ""> -<!ENTITY % trademark.role.attrib "%role.attrib;"> - -<!ENTITY % trademark.element "INCLUDE"> -<![%trademark.element;[ -<!--doc:A trademark.--> -<!ELEMENT trademark %ho; (#PCDATA - | %link.char.class; - | %tech.char.class; - | %base.char.class; - | %other.char.class; - | inlinegraphic - | inlinemediaobject - | emphasis)*> -<!--end of trademark.element-->]]> - -<!-- Class: More precisely identifies the item the element names --> - - -<!ENTITY % trademark.attlist "INCLUDE"> -<![%trademark.attlist;[ -<!ATTLIST trademark - class (service - |trade - |registered - |copyright) 'trade' - %common.attrib; - %trademark.role.attrib; - %local.trademark.attrib; -> -<!--end of trademark.attlist-->]]> -<!--end of trademark.module-->]]> - -<!ENTITY % wordasword.module "INCLUDE"> -<![%wordasword.module;[ -<!ENTITY % local.wordasword.attrib ""> -<!ENTITY % wordasword.role.attrib "%role.attrib;"> - -<!ENTITY % wordasword.element "INCLUDE"> -<![%wordasword.element;[ -<!--doc:A word meant specifically as a word and not representing anything else.--> -<!ELEMENT wordasword %ho; (%word.char.mix;)*> -<!--end of wordasword.element-->]]> - -<!ENTITY % wordasword.attlist "INCLUDE"> -<![%wordasword.attlist;[ -<!ATTLIST wordasword - %common.attrib; - %wordasword.role.attrib; - %local.wordasword.attrib; -> -<!--end of wordasword.attlist-->]]> -<!--end of wordasword.module-->]]> - -<!-- Links and cross-references ........................................... --> - -<!ENTITY % link.module "INCLUDE"> -<![%link.module;[ -<!ENTITY % local.link.attrib ""> -<!ENTITY % link.role.attrib "%role.attrib;"> - -<!ENTITY % link.element "INCLUDE"> -<![%link.element;[ -<!--doc:A hypertext link.--> -<!ELEMENT link %ho; (%para.char.mix;)* - %links.exclusion;> -<!--end of link.element-->]]> - -<!-- Endterm: ID of element containing text that is to be - fetched from elsewhere in the document to appear as - the content of this element --> -<!-- to linked-to object --> -<!-- Type: Freely assignable parameter --> - - -<!ENTITY % link.attlist "INCLUDE"> -<![%link.attlist;[ -<!ATTLIST link - endterm IDREF #IMPLIED - xrefstyle CDATA #IMPLIED - type CDATA #IMPLIED - %linkendreq.attrib; - %common.attrib; - %link.role.attrib; - %local.link.attrib; -> -<!--end of link.attlist-->]]> -<!--end of link.module-->]]> - -<!ENTITY % olink.module "INCLUDE"> -<![%olink.module;[ -<!ENTITY % local.olink.attrib ""> -<!ENTITY % olink.role.attrib "%role.attrib;"> - -<!ENTITY % olink.element "INCLUDE"> -<![%olink.element;[ -<!--doc:A link that addresses its target indirectly, through an entity.--> -<!ELEMENT olink %ho; (%para.char.mix;)* - %links.exclusion;> -<!--end of olink.element-->]]> - -<!-- TargetDocEnt: Name of an entity to be the target of the link --> -<!-- LinkMode: ID of a ModeSpec containing instructions for - operating on the entity named by TargetDocEnt --> -<!-- LocalInfo: Information that may be passed to ModeSpec --> -<!-- Type: Freely assignable parameter --> - - -<!ENTITY % olink.attlist "INCLUDE"> -<![%olink.attlist;[ -<!ATTLIST olink - targetdocent ENTITY #IMPLIED - linkmode IDREF #IMPLIED - localinfo CDATA #IMPLIED - type CDATA #IMPLIED - targetdoc CDATA #IMPLIED - targetptr CDATA #IMPLIED - xrefstyle CDATA #IMPLIED - %common.attrib; - %olink.role.attrib; - %local.olink.attrib; -> -<!--end of olink.attlist-->]]> -<!--end of olink.module-->]]> - -<!ENTITY % ulink.module "INCLUDE"> -<![%ulink.module;[ -<!ENTITY % local.ulink.attrib ""> -<!ENTITY % ulink.role.attrib "%role.attrib;"> - -<!ENTITY % ulink.element "INCLUDE"> -<![%ulink.element;[ -<!--doc:A link that addresses its target by means of a URL (Uniform Resource Locator).--> -<!ELEMENT ulink %ho; (%para.char.mix;)* - %links.exclusion;> -<!--end of ulink.element-->]]> - -<!-- URL: uniform resource locator; the target of the ULink --> -<!-- Type: Freely assignable parameter --> - - -<!ENTITY % ulink.attlist "INCLUDE"> -<![%ulink.attlist;[ -<!ATTLIST ulink - url CDATA #REQUIRED - type CDATA #IMPLIED - xrefstyle CDATA #IMPLIED - %common.attrib; - %ulink.role.attrib; - %local.ulink.attrib; -> -<!--end of ulink.attlist-->]]> -<!--end of ulink.module-->]]> - -<!ENTITY % footnoteref.module "INCLUDE"> -<![%footnoteref.module;[ -<!ENTITY % local.footnoteref.attrib ""> -<!ENTITY % footnoteref.role.attrib "%role.attrib;"> - -<!ENTITY % footnoteref.element "INCLUDE"> -<![%footnoteref.element;[ -<!--doc:A cross reference to a footnote (a footnote mark).--> -<!ELEMENT footnoteref %ho; EMPTY> -<!--end of footnoteref.element-->]]> - -<!-- to footnote content supplied elsewhere --> - - -<!ENTITY % footnoteref.attlist "INCLUDE"> -<![%footnoteref.attlist;[ -<!ATTLIST footnoteref - %linkendreq.attrib; %label.attrib; - %common.attrib; - %footnoteref.role.attrib; - %local.footnoteref.attrib; -> -<!--end of footnoteref.attlist-->]]> -<!--end of footnoteref.module-->]]> - -<!ENTITY % xref.module "INCLUDE"> -<![%xref.module;[ -<!ENTITY % local.xref.attrib ""> -<!ENTITY % xref.role.attrib "%role.attrib;"> - -<!ENTITY % xref.element "INCLUDE"> -<![%xref.element;[ -<!--doc:A cross reference to another part of the document.--> -<!ELEMENT xref %ho; EMPTY> -<!--end of xref.element-->]]> - -<!-- Endterm: ID of element containing text that is to be - fetched from elsewhere in the document to appear as - the content of this element --> -<!-- to linked-to object --> - - -<!ENTITY % xref.attlist "INCLUDE"> -<![%xref.attlist;[ -<!ATTLIST xref - endterm IDREF #IMPLIED - xrefstyle CDATA #IMPLIED - %common.attrib; - %linkendreq.attrib; - %xref.role.attrib; - %local.xref.attrib; -> -<!--end of xref.attlist-->]]> -<!--end of xref.module-->]]> - -<!ENTITY % biblioref.module "INCLUDE"> -<![%biblioref.module;[ -<!ENTITY % local.biblioref.attrib ""> -<!ENTITY % biblioref.role.attrib "%role.attrib;"> - -<!ENTITY % biblioref.element "INCLUDE"> -<![%biblioref.element;[ -<!--doc:A cross reference to a bibliographic entry.--> -<!ELEMENT biblioref %ho; EMPTY> -<!--end of biblioref.element-->]]> - -<!ENTITY % biblioref.attlist "INCLUDE"> -<![%biblioref.attlist;[ -<!ATTLIST biblioref - endterm IDREF #IMPLIED - xrefstyle CDATA #IMPLIED - units CDATA #IMPLIED - begin CDATA #IMPLIED - end CDATA #IMPLIED - %common.attrib; - %linkendreq.attrib; - %biblioref.role.attrib; - %local.biblioref.attrib; -> -<!--end of biblioref.attlist-->]]> -<!--end of biblioref.module-->]]> - -<!-- Ubiquitous elements .................................................. --> - -<!ENTITY % anchor.module "INCLUDE"> -<![%anchor.module;[ -<!ENTITY % local.anchor.attrib ""> -<!ENTITY % anchor.role.attrib "%role.attrib;"> - -<!ENTITY % anchor.element "INCLUDE"> -<![%anchor.element;[ -<!--doc:A spot in the document.--> -<!ELEMENT anchor %ho; EMPTY> -<!--end of anchor.element-->]]> - -<!-- required --> -<!-- replaces Lang --> - - -<!ENTITY % anchor.attlist "INCLUDE"> -<![%anchor.attlist;[ -<!ATTLIST anchor - %idreq.attrib; %pagenum.attrib; %remap.attrib; - %xreflabel.attrib; - %revisionflag.attrib; - %effectivity.attrib; - %anchor.role.attrib; - %local.anchor.attrib; -> -<!--end of anchor.attlist-->]]> -<!--end of anchor.module-->]]> - -<!ENTITY % beginpage.module "INCLUDE"> -<![%beginpage.module;[ -<!ENTITY % local.beginpage.attrib ""> -<!ENTITY % beginpage.role.attrib "%role.attrib;"> - -<!ENTITY % beginpage.element "INCLUDE"> -<![%beginpage.element;[ -<!--doc:The location of a page break in a print version of the document.--> -<!ELEMENT beginpage %ho; EMPTY> -<!--end of beginpage.element-->]]> - -<!-- PageNum: Number of page that begins at this point --> - - -<!ENTITY % beginpage.attlist "INCLUDE"> -<![%beginpage.attlist;[ -<!ATTLIST beginpage - %pagenum.attrib; - %common.attrib; - %beginpage.role.attrib; - %local.beginpage.attrib; -> -<!--end of beginpage.attlist-->]]> -<!--end of beginpage.module-->]]> - -<!-- IndexTerms appear in the text flow for generating or linking an - index. --> - -<!ENTITY % indexterm.content.module "INCLUDE"> -<![%indexterm.content.module;[ -<!ENTITY % indexterm.module "INCLUDE"> -<![%indexterm.module;[ -<!ENTITY % local.indexterm.attrib ""> -<!ENTITY % indexterm.role.attrib "%role.attrib;"> - -<!ENTITY % indexterm.element "INCLUDE"> -<![%indexterm.element;[ -<!--doc:A wrapper for terms to be indexed.--> -<!ELEMENT indexterm %ho; (primary?, ((secondary, ((tertiary, (see|seealso+)?) - | see | seealso+)?) | see | seealso+)?) - %ubiq.exclusion;> -<!--end of indexterm.element-->]]> - -<!-- Scope: Indicates which generated indices the IndexTerm - should appear in: Global (whole document set), Local (this - document only), or All (both) --> -<!-- Significance: Whether this IndexTerm is the most pertinent - of its series (Preferred) or not (Normal, the default) --> -<!-- Class: Indicates type of IndexTerm; default is Singular, - or EndOfRange if StartRef is supplied; StartOfRange value - must be supplied explicitly on starts of ranges --> -<!-- StartRef: ID of the IndexTerm that starts the indexing - range ended by this IndexTerm --> -<!-- Zone: IDs of the elements to which the IndexTerm applies, - and indicates that the IndexTerm applies to those entire - elements rather than the point at which the IndexTerm - occurs --> - - -<!ENTITY % indexterm.attlist "INCLUDE"> -<![%indexterm.attlist;[ -<!ATTLIST indexterm - %pagenum.attrib; - scope (all - |global - |local) #IMPLIED - significance (preferred - |normal) "normal" - class (singular - |startofrange - |endofrange) #IMPLIED - startref IDREF #IMPLIED - zone IDREFS #IMPLIED - type CDATA #IMPLIED - %common.attrib; - %indexterm.role.attrib; - %local.indexterm.attrib; -> -<!--end of indexterm.attlist-->]]> -<!--end of indexterm.module-->]]> - -<!ENTITY % primsecter.module "INCLUDE"> -<![%primsecter.module;[ -<!ENTITY % local.primsecter.attrib ""> -<!ENTITY % primsecter.role.attrib "%role.attrib;"> - - -<!ENTITY % primary.element "INCLUDE"> -<![%primary.element;[ -<!--doc:The primary word or phrase under which an index term should be sorted.--> -<!ELEMENT primary %ho; (%ndxterm.char.mix;)*> -<!--end of primary.element-->]]> -<!-- SortAs: Alternate sort string for index sorting, e.g., - "fourteen" for an element containing "14" --> - -<!ENTITY % primary.attlist "INCLUDE"> -<![%primary.attlist;[ -<!ATTLIST primary - sortas CDATA #IMPLIED - %common.attrib; - %primsecter.role.attrib; - %local.primsecter.attrib; -> -<!--end of primary.attlist-->]]> - - -<!ENTITY % secondary.element "INCLUDE"> -<![%secondary.element;[ -<!--doc:A secondary word or phrase in an index term.--> -<!ELEMENT secondary %ho; (%ndxterm.char.mix;)*> -<!--end of secondary.element-->]]> -<!-- SortAs: Alternate sort string for index sorting, e.g., - "fourteen" for an element containing "14" --> - -<!ENTITY % secondary.attlist "INCLUDE"> -<![%secondary.attlist;[ -<!ATTLIST secondary - sortas CDATA #IMPLIED - %common.attrib; - %primsecter.role.attrib; - %local.primsecter.attrib; -> -<!--end of secondary.attlist-->]]> - - -<!ENTITY % tertiary.element "INCLUDE"> -<![%tertiary.element;[ -<!--doc:A tertiary word or phrase in an index term.--> -<!ELEMENT tertiary %ho; (%ndxterm.char.mix;)*> -<!--end of tertiary.element-->]]> -<!-- SortAs: Alternate sort string for index sorting, e.g., - "fourteen" for an element containing "14" --> - -<!ENTITY % tertiary.attlist "INCLUDE"> -<![%tertiary.attlist;[ -<!ATTLIST tertiary - sortas CDATA #IMPLIED - %common.attrib; - %primsecter.role.attrib; - %local.primsecter.attrib; -> -<!--end of tertiary.attlist-->]]> - -<!--end of primsecter.module-->]]> - -<!ENTITY % seeseealso.module "INCLUDE"> -<![%seeseealso.module;[ -<!ENTITY % local.seeseealso.attrib ""> -<!ENTITY % seeseealso.role.attrib "%role.attrib;"> - -<!ENTITY % see.element "INCLUDE"> -<![%see.element;[ -<!--doc:Part of an index term directing the reader instead to another entry in the index.--> -<!ELEMENT see %ho; (%ndxterm.char.mix;)*> -<!--end of see.element-->]]> - -<!ENTITY % see.attlist "INCLUDE"> -<![%see.attlist;[ -<!ATTLIST see - %common.attrib; - %seeseealso.role.attrib; - %local.seeseealso.attrib; -> -<!--end of see.attlist-->]]> - -<!ENTITY % seealso.element "INCLUDE"> -<![%seealso.element;[ -<!--doc:Part of an index term directing the reader also to another entry in the index.--> -<!ELEMENT seealso %ho; (%ndxterm.char.mix;)*> -<!--end of seealso.element-->]]> - -<!ENTITY % seealso.attlist "INCLUDE"> -<![%seealso.attlist;[ -<!ATTLIST seealso - %common.attrib; - %seeseealso.role.attrib; - %local.seeseealso.attrib; -> -<!--end of seealso.attlist-->]]> -<!--end of seeseealso.module-->]]> -<!--end of indexterm.content.module-->]]> - -<!-- End of DocBook XML information pool module V4.5 ...................... --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/docbook.cat b/Utilities/xml/docbook-4.5/docbook.cat deleted file mode 100644 index 25ac4df..0000000 --- a/Utilities/xml/docbook-4.5/docbook.cat +++ /dev/null @@ -1,113 +0,0 @@ - -- ...................................................................... -- - -- Catalog data for DocBook XML V4.5 .................................... -- - -- File docbook.cat ..................................................... -- - - -- Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/. - -- - - -- This is the catalog data file for DocBook XML V4.5. It is provided as - a convenience in building your own catalog files. You need not use - the filenames listed here, and need not use the filename method of - identifying storage objects at all. See the documentation for - detailed information on the files associated with the DocBook DTD. - See SGML Open Technical Resolution 9401 for detailed information - on supplying and using catalog data. - -- - - -- ...................................................................... -- - -- DocBook driver file .................................................. -- - -PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "docbookx.dtd" - - -- ...................................................................... -- - -- DocBook modules ...................................................... -- - -PUBLIC "-//OASIS//DTD DocBook CALS Table Model V4.5//EN" - "calstblx.dtd" - -PUBLIC "-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" - "htmltblx.mod" - -PUBLIC "-//OASIS//DTD XML Exchange Table Model 19990315//EN" - "soextblx.dtd" - -PUBLIC "-//OASIS//ELEMENTS DocBook Information Pool V4.5//EN" - "dbpoolx.mod" - -PUBLIC "-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" - "dbhierx.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" - "dbgenent.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Notations V4.5//EN" - "dbnotnx.mod" - -PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" - "dbcentx.mod" - - -- ...................................................................... -- - -- ISO entity sets ...................................................... -- - -PUBLIC "ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML" - "ent/isodia.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" - "ent/isonum.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Publishing//EN//XML" - "ent/isopub.ent" - -PUBLIC "ISO 8879:1986//ENTITIES General Technical//EN//XML" - "ent/isotech.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" - "ent/isolat1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" - "ent/isolat2.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Greek Letters//EN//XML" - "ent/isogrk1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML" - "ent/isogrk2.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Greek Symbols//EN//XML" - "ent/isogrk3.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML" - "ent/isogrk4.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML" - "ent/isoamsa.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML" - "ent/isoamsb.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML" - "ent/isoamsc.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML" - "ent/isoamsn.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML" - "ent/isoamso.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML" - "ent/isoamsr.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML" - "ent/isobox.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML" - "ent/isocyr1.ent" - -PUBLIC "ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML" - "ent/isocyr2.ent" - - -- End of catalog data for DocBook XML V4.5 ............................. -- - -- ...................................................................... -- diff --git a/Utilities/xml/docbook-4.5/docbookx.dtd b/Utilities/xml/docbook-4.5/docbookx.dtd deleted file mode 100644 index 8b43c59..0000000 --- a/Utilities/xml/docbook-4.5/docbookx.dtd +++ /dev/null @@ -1,170 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook XML DTD V4.5 ................................................. --> -<!-- File docbookx.dtd .................................................... --> - -<!-- Copyright 1992-2006 HaL Computer Systems, Inc., - O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software - Corporation, Norman Walsh, Sun Microsystems, Inc., and the - Organization for the Advancement of Structured Information - Standards (OASIS). - - See also http://docbook.org/specs/ - - $Id: docbookx.dtd 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook XML DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This is the driver file for V4.5 of the DocBook DTD. - Please use the following formal public identifier to identify it: - - "-//OASIS//DTD DocBook XML V4.5//EN" - - For example, if your document's top-level element is Book, and - you are using DocBook directly, use the FPI in the DOCTYPE - declaration: - - <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" - [...]> - - Or, if you have a higher-level driver file that customizes DocBook, - use the FPI in the parameter entity declaration: - - <!ENTITY % DocBookDTD PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> - %DocBookDTD; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!-- ...................................................................... --> -<!-- Enable SGML features ................................................. --> - -<!ENTITY % sgml.features "IGNORE"> -<![%sgml.features;[ -<!ENTITY % xml.features "IGNORE"> -]]> -<!ENTITY % xml.features "INCLUDE"> - -<![%sgml.features;[ -<![%xml.features;[ - -<!-- ERROR: Exactly one of xml.features and sgml.features must be turned on! --> -<!ENTITY % dbnotn SYSTEM "http://www.oasis-open.org/docbook/xml/configerror.txt"> -<!ENTITY % dbcent SYSTEM "http://www.oasis-open.org/docbook/xml/configerror.txt"> -<!ENTITY % dbpool SYSTEM "http://www.oasis-open.org/docbook/xml/configerror.txt"> -<!ENTITY % dbhier SYSTEM "http://www.oasis-open.org/docbook/xml/configerror.txt"> -<!ENTITY % dbgenent SYSTEM "http://www.oasis-open.org/docbook/xml/configerror.txt"> - -]]> -]]> - -<![%sgml.features;[ -<!ENTITY % ho "- O"> -<!ENTITY % hh "- -"> -]]> - -<![%xml.features;[ -<!ENTITY % ho ""> -<!ENTITY % hh ""> -]]> - -<!-- ...................................................................... --> -<!-- Notation declarations ................................................ --> - -<!ENTITY % dbnotn.module "INCLUDE"> -<![%dbnotn.module;[ -<!ENTITY % dbnotn PUBLIC -"-//OASIS//ENTITIES DocBook Notations V4.5//EN" -"dbnotnx.mod"> -%dbnotn; -]]> - -<!-- ...................................................................... --> -<!-- ISO character entity sets ............................................ --> - -<!ENTITY % dbcent.module "INCLUDE"> -<![%dbcent.module;[ - -<!ENTITY % dbcent.euro "INCLUDE"> -<![%dbcent.euro;[ -<![%sgml.features;[ -<!ENTITY euro SDATA "[euro ]"><!-- euro sign --> -]]> -<![%xml.features;[ -<!ENTITY euro "€"><!-- euro sign, U+20AC NEW --> -]]> -]]> - -<!ENTITY % dbcent PUBLIC -"-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" -"dbcentx.mod"> -%dbcent; -]]> - -<!-- ...................................................................... --> -<!-- DTD modules .......................................................... --> - -<!-- Information pool .............. --> - -<!ENTITY % dbpool.module "INCLUDE"> -<![ %dbpool.module; [ -<!ENTITY % dbpool PUBLIC -"-//OASIS//ELEMENTS DocBook Information Pool V4.5//EN" -"dbpoolx.mod"> -%dbpool; -]]> - -<!-- Redeclaration placeholder ..... --> - -<!ENTITY % intermod.redecl.module "IGNORE"> -<![%intermod.redecl.module;[ -<!-- Defining rdbmods here makes some buggy XML parsers happy. --> -<!ENTITY % rdbmods ""> -%rdbmods; -<!--end of intermod.redecl.module-->]]> - -<!-- Document hierarchy ............ --> - -<!ENTITY % dbhier.module "INCLUDE"> -<![ %dbhier.module; [ -<!ENTITY % dbhier PUBLIC -"-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" -"dbhierx.mod"> -%dbhier; -]]> - -<!-- ...................................................................... --> -<!-- Other general entities ............................................... --> - -<!ENTITY % dbgenent.module "INCLUDE"> -<![ %dbgenent.module; [ -<!ENTITY % dbgenent PUBLIC -"-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" -"dbgenent.mod"> -%dbgenent; -]]> - -<!-- End of DocBook XML DTD V4.5 .......................................... --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/ent/README b/Utilities/xml/docbook-4.5/ent/README deleted file mode 100644 index c0da542..0000000 --- a/Utilities/xml/docbook-4.5/ent/README +++ /dev/null @@ -1,14 +0,0 @@ -XML Entity Declarations for Characters - -The character entity sets distributed with DocBook XML are direct -copies of the official entities located at - - http://www.w3.org/2003/entities/ - -They are distributed for historical compatibility and user convenience. -The DocBook Technical Committee no longer attempts to maintain these -definitions and will periodically update them from the W3C site if and -as they are updated there. - -Please direct all questions or comments about the entities to the -individuals or working groups who maintain the official sets. diff --git a/Utilities/xml/docbook-4.5/ent/isoamsa.ent b/Utilities/xml/docbook-4.5/ent/isoamsa.ent deleted file mode 100644 index dac3e62..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamsa.ent +++ /dev/null @@ -1,97 +0,0 @@ - -<!-- - File isoamsa.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamsa.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamsa.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamsa PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamsa.ent" - > - %isoamsa; - ---> - -<!ENTITY cularr "↶" ><!--ANTICLOCKWISE TOP SEMICIRCLE ARROW --> -<!ENTITY curarr "↷" ><!--CLOCKWISE TOP SEMICIRCLE ARROW --> -<!ENTITY dArr "⇓" ><!--DOWNWARDS DOUBLE ARROW --> -<!ENTITY darr2 "⇊" ><!--DOWNWARDS PAIRED ARROWS --> -<!ENTITY dharl "⇃" ><!--DOWNWARDS HARPOON WITH BARB LEFTWARDS --> -<!ENTITY dharr "⇂" ><!--DOWNWARDS HARPOON WITH BARB RIGHTWARDS --> -<!ENTITY dlarr "↙" ><!--SOUTH WEST ARROW --> -<!ENTITY drarr "↘" ><!--SOUTH EAST ARROW --> -<!ENTITY hArr "⇔" ><!--LEFT RIGHT DOUBLE ARROW --> -<!ENTITY harr "↔" ><!--LEFT RIGHT ARROW --> -<!ENTITY harrw "↭" ><!--LEFT RIGHT WAVE ARROW --> -<!ENTITY lAarr "⇚" ><!--LEFTWARDS TRIPLE ARROW --> -<!ENTITY Larr "↞" ><!--LEFTWARDS TWO HEADED ARROW --> -<!ENTITY larr2 "⇇" ><!--LEFTWARDS PAIRED ARROWS --> -<!ENTITY larrhk "↩" ><!--LEFTWARDS ARROW WITH HOOK --> -<!ENTITY larrlp "↫" ><!--LEFTWARDS ARROW WITH LOOP --> -<!ENTITY larrtl "↢" ><!--LEFTWARDS ARROW WITH TAIL --> -<!ENTITY lhard "↽" ><!--LEFTWARDS HARPOON WITH BARB DOWNWARDS --> -<!ENTITY lharu "↼" ><!--LEFTWARDS HARPOON WITH BARB UPWARDS --> -<!ENTITY lrarr2 "⇆" ><!--LEFTWARDS ARROW OVER RIGHTWARDS ARROW --> -<!ENTITY lrhar2 "⇋" ><!--LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON --> -<!ENTITY lsh "↰" ><!--UPWARDS ARROW WITH TIP LEFTWARDS --> -<!ENTITY map "↦" ><!--RIGHTWARDS ARROW FROM BAR --> -<!ENTITY mumap "⊸" ><!--MULTIMAP --> -<!ENTITY nearr "↗" ><!--NORTH EAST ARROW --> -<!ENTITY nhArr "⇎" ><!--LEFT RIGHT DOUBLE ARROW WITH STROKE --> -<!ENTITY nharr "↮" ><!--LEFT RIGHT ARROW WITH STROKE --> -<!ENTITY nlArr "⇍" ><!--LEFTWARDS DOUBLE ARROW WITH STROKE --> -<!ENTITY nlarr "↚" ><!--LEFTWARDS ARROW WITH STROKE --> -<!ENTITY nrArr "⇏" ><!--RIGHTWARDS DOUBLE ARROW WITH STROKE --> -<!ENTITY nrarr "↛" ><!--RIGHTWARDS ARROW WITH STROKE --> -<!ENTITY nwarr "↖" ><!--NORTH WEST ARROW --> -<!ENTITY olarr "↺" ><!--ANTICLOCKWISE OPEN CIRCLE ARROW --> -<!ENTITY orarr "↻" ><!--CLOCKWISE OPEN CIRCLE ARROW --> -<!ENTITY rAarr "⇛" ><!--RIGHTWARDS TRIPLE ARROW --> -<!ENTITY Rarr "↠" ><!--RIGHTWARDS TWO HEADED ARROW --> -<!ENTITY rarr2 "⇉" ><!--RIGHTWARDS PAIRED ARROWS --> -<!ENTITY rarrhk "↪" ><!--RIGHTWARDS ARROW WITH HOOK --> -<!ENTITY rarrlp "↬" ><!--RIGHTWARDS ARROW WITH LOOP --> -<!ENTITY rarrtl "↣" ><!--RIGHTWARDS ARROW WITH TAIL --> -<!ENTITY rarrw "↝" ><!--RIGHTWARDS WAVE ARROW --> -<!ENTITY rhard "⇁" ><!--RIGHTWARDS HARPOON WITH BARB DOWNWARDS --> -<!ENTITY rharu "⇀" ><!--RIGHTWARDS HARPOON WITH BARB UPWARDS --> -<!ENTITY rlarr2 "⇄" ><!--RIGHTWARDS ARROW OVER LEFTWARDS ARROW --> -<!ENTITY rlhar2 "⇌" ><!--RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON --> -<!ENTITY rsh "↱" ><!--UPWARDS ARROW WITH TIP RIGHTWARDS --> -<!ENTITY uArr "⇑" ><!--UPWARDS DOUBLE ARROW --> -<!ENTITY uarr2 "⇈" ><!--UPWARDS PAIRED ARROWS --> -<!ENTITY uharl "↿" ><!--UPWARDS HARPOON WITH BARB LEFTWARDS --> -<!ENTITY uharr "↾" ><!--UPWARDS HARPOON WITH BARB RIGHTWARDS --> -<!ENTITY vArr "⇕" ><!--UP DOWN DOUBLE ARROW --> -<!ENTITY varr "↕" ><!--UP DOWN ARROW --> -<!ENTITY xhArr "⟺" ><!--LONG LEFT RIGHT DOUBLE ARROW --> -<!ENTITY xharr "⟷" ><!--LONG LEFT RIGHT ARROW --> -<!ENTITY xlArr "⟸" ><!--LONG LEFTWARDS DOUBLE ARROW --> -<!ENTITY xrArr "⟹" ><!--LONG RIGHTWARDS DOUBLE ARROW --> diff --git a/Utilities/xml/docbook-4.5/ent/isoamsb.ent b/Utilities/xml/docbook-4.5/ent/isoamsb.ent deleted file mode 100644 index 4065b66..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamsb.ent +++ /dev/null @@ -1,83 +0,0 @@ - -<!-- - File isoamsb.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamsb.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamsb.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamsb PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Binary Operators//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamsb.ent" - > - %isoamsb; - ---> - -<!ENTITY amalg "⨿" ><!--AMALGAMATION OR COPRODUCT --> -<!ENTITY Barwed "⌆" ><!--PERSPECTIVE --> -<!ENTITY barwed "⌅" ><!--PROJECTIVE --> -<!ENTITY Cap "⋒" ><!--DOUBLE INTERSECTION --> -<!ENTITY coprod "∐" ><!--N-ARY COPRODUCT --> -<!ENTITY Cup "⋓" ><!--DOUBLE UNION --> -<!ENTITY cuvee "⋎" ><!--CURLY LOGICAL OR --> -<!ENTITY cuwed "⋏" ><!--CURLY LOGICAL AND --> -<!ENTITY diam "⋄" ><!--DIAMOND OPERATOR --> -<!ENTITY divonx "⋇" ><!--DIVISION TIMES --> -<!ENTITY intcal "⊺" ><!--INTERCALATE --> -<!ENTITY lthree "⋋" ><!--LEFT SEMIDIRECT PRODUCT --> -<!ENTITY ltimes "⋉" ><!--LEFT NORMAL FACTOR SEMIDIRECT PRODUCT --> -<!ENTITY minusb "⊟" ><!--SQUARED MINUS --> -<!ENTITY oast "⊛" ><!--CIRCLED ASTERISK OPERATOR --> -<!ENTITY ocir "⊚" ><!--CIRCLED RING OPERATOR --> -<!ENTITY odash "⊝" ><!--CIRCLED DASH --> -<!ENTITY odot "⊙" ><!--CIRCLED DOT OPERATOR --> -<!ENTITY ominus "⊖" ><!--CIRCLED MINUS --> -<!ENTITY oplus "⊕" ><!--CIRCLED PLUS --> -<!ENTITY osol "⊘" ><!--CIRCLED DIVISION SLASH --> -<!ENTITY otimes "⊗" ><!--CIRCLED TIMES --> -<!ENTITY plusb "⊞" ><!--SQUARED PLUS --> -<!ENTITY plusdo "∔" ><!--DOT PLUS --> -<!ENTITY prod "∏" ><!--N-ARY PRODUCT --> -<!ENTITY rthree "⋌" ><!--RIGHT SEMIDIRECT PRODUCT --> -<!ENTITY rtimes "⋊" ><!--RIGHT NORMAL FACTOR SEMIDIRECT PRODUCT --> -<!ENTITY sdot "⋅" ><!--DOT OPERATOR --> -<!ENTITY sdotb "⊡" ><!--SQUARED DOT OPERATOR --> -<!ENTITY setmn "∖" ><!--SET MINUS --> -<!ENTITY sqcap "⊓" ><!--SQUARE CAP --> -<!ENTITY sqcup "⊔" ><!--SQUARE CUP --> -<!ENTITY ssetmn "∖" ><!--SET MINUS --> -<!ENTITY sstarf "⋆" ><!--STAR OPERATOR --> -<!ENTITY sum "∑" ><!--N-ARY SUMMATION --> -<!ENTITY timesb "⊠" ><!--SQUARED TIMES --> -<!ENTITY top "⊤" ><!--DOWN TACK --> -<!ENTITY uplus "⊎" ><!--MULTISET UNION --> -<!ENTITY wreath "≀" ><!--WREATH PRODUCT --> -<!ENTITY xcirc "◯" ><!--LARGE CIRCLE --> -<!ENTITY xdtri "▽" ><!--WHITE DOWN-POINTING TRIANGLE --> -<!ENTITY xutri "△" ><!--WHITE UP-POINTING TRIANGLE --> diff --git a/Utilities/xml/docbook-4.5/ent/isoamsc.ent b/Utilities/xml/docbook-4.5/ent/isoamsc.ent deleted file mode 100644 index 2fad417..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamsc.ent +++ /dev/null @@ -1,51 +0,0 @@ - -<!-- - File isoamsc.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamsc.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamsc.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamsc PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Delimiters//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamsc.ent" - > - %isoamsc; - ---> - -<!ENTITY dlcorn "⌞" ><!--BOTTOM LEFT CORNER --> -<!ENTITY drcorn "⌟" ><!--BOTTOM RIGHT CORNER --> -<!ENTITY lceil "⌈" ><!--LEFT CEILING --> -<!ENTITY lfloor "⌊" ><!--LEFT FLOOR --> -<!ENTITY lpargt "⦠" ><!--SPHERICAL ANGLE OPENING LEFT --> -<!ENTITY rceil "⌉" ><!--RIGHT CEILING --> -<!ENTITY rfloor "⌋" ><!--RIGHT FLOOR --> -<!ENTITY rpargt "⦔" ><!--RIGHT ARC GREATER-THAN BRACKET --> -<!ENTITY ulcorn "⌜" ><!--TOP LEFT CORNER --> -<!ENTITY urcorn "⌝" ><!--TOP RIGHT CORNER --> diff --git a/Utilities/xml/docbook-4.5/ent/isoamsn.ent b/Utilities/xml/docbook-4.5/ent/isoamsn.ent deleted file mode 100644 index ddca8d1..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamsn.ent +++ /dev/null @@ -1,103 +0,0 @@ - -<!-- - File isoamsn.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - References to the VARIANT SELECTOR 1 character (︀) - should match the uses listed in Unicode Technical Report 25. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamsn.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamsn.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamsn PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Negated Relations//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamsn.ent" - > - %isoamsn; - ---> - -<!ENTITY gnap "⪊" ><!--GREATER-THAN AND NOT APPROXIMATE --> -<!ENTITY gnE "≩" ><!--GREATER-THAN BUT NOT EQUAL TO --> -<!ENTITY gne "⪈" ><!--GREATER-THAN AND SINGLE-LINE NOT EQUAL TO --> -<!ENTITY gnsim "⋧" ><!--GREATER-THAN BUT NOT EQUIVALENT TO --> -<!ENTITY gvnE "≩︀" ><!--GREATER-THAN BUT NOT EQUAL TO - with vertical stroke --> -<!ENTITY lnap "⪉" ><!--LESS-THAN AND NOT APPROXIMATE --> -<!ENTITY lnE "≨" ><!--LESS-THAN BUT NOT EQUAL TO --> -<!ENTITY lne "⪇" ><!--LESS-THAN AND SINGLE-LINE NOT EQUAL TO --> -<!ENTITY lnsim "⋦" ><!--LESS-THAN BUT NOT EQUIVALENT TO --> -<!ENTITY lvnE "≨︀" ><!--LESS-THAN BUT NOT EQUAL TO - with vertical stroke --> -<!ENTITY nap "≉" ><!--NOT ALMOST EQUAL TO --> -<!ENTITY ncong "≇" ><!--NEITHER APPROXIMATELY NOR ACTUALLY EQUAL TO --> -<!ENTITY nequiv "≢" ><!--NOT IDENTICAL TO --> -<!ENTITY ngE "≧̸" ><!--GREATER-THAN OVER EQUAL TO with slash --> -<!ENTITY nge "≱" ><!--NEITHER GREATER-THAN NOR EQUAL TO --> -<!ENTITY nges "⩾̸" ><!--GREATER-THAN OR SLANTED EQUAL TO with slash --> -<!ENTITY ngt "≯" ><!--NOT GREATER-THAN --> -<!ENTITY nlE "≦̸" ><!--LESS-THAN OVER EQUAL TO with slash --> -<!ENTITY nle "≰" ><!--NEITHER LESS-THAN NOR EQUAL TO --> -<!ENTITY nles "⩽̸" ><!--LESS-THAN OR SLANTED EQUAL TO with slash --> -<!ENTITY nlt "≮" ><!--NOT LESS-THAN --> -<!ENTITY nltri "⋪" ><!--NOT NORMAL SUBGROUP OF --> -<!ENTITY nltrie "⋬" ><!--NOT NORMAL SUBGROUP OF OR EQUAL TO --> -<!ENTITY nmid "∤" ><!--DOES NOT DIVIDE --> -<!ENTITY npar "∦" ><!--NOT PARALLEL TO --> -<!ENTITY npr "⊀" ><!--DOES NOT PRECEDE --> -<!ENTITY npre "⪯̸" ><!--PRECEDES ABOVE SINGLE-LINE EQUALS SIGN with slash --> -<!ENTITY nrtri "⋫" ><!--DOES NOT CONTAIN AS NORMAL SUBGROUP --> -<!ENTITY nrtrie "⋭" ><!--DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL --> -<!ENTITY nsc "⊁" ><!--DOES NOT SUCCEED --> -<!ENTITY nsce "⪰̸" ><!--SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN with slash --> -<!ENTITY nsim "≁" ><!--NOT TILDE --> -<!ENTITY nsime "≄" ><!--NOT ASYMPTOTICALLY EQUAL TO --> -<!ENTITY nsmid "∤" ><!--DOES NOT DIVIDE --> -<!ENTITY nspar "∦" ><!--NOT PARALLEL TO --> -<!ENTITY nsub "⊄" ><!--NOT A SUBSET OF --> -<!ENTITY nsubE "⫅̸" ><!--SUBSET OF ABOVE EQUALS SIGN with slash --> -<!ENTITY nsube "⊈" ><!--NEITHER A SUBSET OF NOR EQUAL TO --> -<!ENTITY nsup "⊅" ><!--NOT A SUPERSET OF --> -<!ENTITY nsupE "⫆̸" ><!--SUPERSET OF ABOVE EQUALS SIGN with slash --> -<!ENTITY nsupe "⊉" ><!--NEITHER A SUPERSET OF NOR EQUAL TO --> -<!ENTITY nVDash "⊯" ><!--NEGATED DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE --> -<!ENTITY nVdash "⊮" ><!--DOES NOT FORCE --> -<!ENTITY nvDash "⊭" ><!--NOT TRUE --> -<!ENTITY nvdash "⊬" ><!--DOES NOT PROVE --> -<!ENTITY prnap "⪹" ><!--PRECEDES ABOVE NOT ALMOST EQUAL TO --> -<!ENTITY prnE "⪵" ><!--PRECEDES ABOVE NOT EQUAL TO --> -<!ENTITY prnsim "⋨" ><!--PRECEDES BUT NOT EQUIVALENT TO --> -<!ENTITY scnap "⪺" ><!--SUCCEEDS ABOVE NOT ALMOST EQUAL TO --> -<!ENTITY scnE "⪶" ><!--SUCCEEDS ABOVE NOT EQUAL TO --> -<!ENTITY scnsim "⋩" ><!--SUCCEEDS BUT NOT EQUIVALENT TO --> -<!ENTITY subnE "⫋" ><!--SUBSET OF ABOVE NOT EQUAL TO --> -<!ENTITY subne "⊊" ><!--SUBSET OF WITH NOT EQUAL TO --> -<!ENTITY supnE "⫌" ><!--SUPERSET OF ABOVE NOT EQUAL TO --> -<!ENTITY supne "⊋" ><!--SUPERSET OF WITH NOT EQUAL TO --> -<!ENTITY vsubnE "⫋︀" ><!--SUBSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members --> -<!ENTITY vsubne "⊊︀" ><!--SUBSET OF WITH NOT EQUAL TO - variant with stroke through bottom members --> -<!ENTITY vsupnE "⫌︀" ><!--SUPERSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members --> -<!ENTITY vsupne "⊋︀" ><!--SUPERSET OF WITH NOT EQUAL TO - variant with stroke through bottom members --> diff --git a/Utilities/xml/docbook-4.5/ent/isoamso.ent b/Utilities/xml/docbook-4.5/ent/isoamso.ent deleted file mode 100644 index 278e4b4..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamso.ent +++ /dev/null @@ -1,59 +0,0 @@ - -<!-- - File isoamso.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamso.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamso.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamso PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Ordinary//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamso.ent" - > - %isoamso; - ---> - -<!ENTITY ang "∠" ><!--ANGLE --> -<!ENTITY angmsd "∡" ><!--MEASURED ANGLE --> -<!ENTITY beth "ℶ" ><!--BET SYMBOL --> -<!ENTITY bprime "‵" ><!--REVERSED PRIME --> -<!ENTITY comp "∁" ><!--COMPLEMENT --> -<!ENTITY daleth "ℸ" ><!--DALET SYMBOL --> -<!ENTITY ell "ℓ" ><!--SCRIPT SMALL L --> -<!ENTITY empty "∅" ><!--EMPTY SET --> -<!ENTITY gimel "ℷ" ><!--GIMEL SYMBOL --> -<!ENTITY inodot "ı" ><!--LATIN SMALL LETTER DOTLESS I --> -<!ENTITY jnodot "j" ><!--LATIN SMALL LETTER J --> -<!ENTITY nexist "∄" ><!--THERE DOES NOT EXIST --> -<!ENTITY oS "Ⓢ" ><!--CIRCLED LATIN CAPITAL LETTER S --> -<!ENTITY planck "ℏ" ><!--PLANCK CONSTANT OVER TWO PI --> -<!ENTITY real "ℜ" ><!--BLACK-LETTER CAPITAL R --> -<!ENTITY sbsol "﹨" ><!--SMALL REVERSE SOLIDUS --> -<!ENTITY vprime "′" ><!--PRIME --> -<!ENTITY weierp "℘" ><!--SCRIPT CAPITAL P --> diff --git a/Utilities/xml/docbook-4.5/ent/isoamsr.ent b/Utilities/xml/docbook-4.5/ent/isoamsr.ent deleted file mode 100644 index 18e64bf..0000000 --- a/Utilities/xml/docbook-4.5/ent/isoamsr.ent +++ /dev/null @@ -1,125 +0,0 @@ - -<!-- - File isoamsr.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isoamsr.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isoamsr.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isoamsr PUBLIC - "ISO 8879:1986//ENTITIES Added Math Symbols: Relations//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isoamsr.ent" - > - %isoamsr; - ---> - -<!ENTITY ape "≊" ><!--ALMOST EQUAL OR EQUAL TO --> -<!ENTITY asymp "≈" ><!--ALMOST EQUAL TO --> -<!ENTITY bcong "≌" ><!--ALL EQUAL TO --> -<!ENTITY bepsi "϶" ><!--GREEK REVERSED LUNATE EPSILON SYMBOL --> -<!ENTITY bowtie "⋈" ><!--BOWTIE --> -<!ENTITY bsim "∽" ><!--REVERSED TILDE --> -<!ENTITY bsime "⋍" ><!--REVERSED TILDE EQUALS --> -<!ENTITY bump "≎" ><!--GEOMETRICALLY EQUIVALENT TO --> -<!ENTITY bumpe "≏" ><!--DIFFERENCE BETWEEN --> -<!ENTITY cire "≗" ><!--RING EQUAL TO --> -<!ENTITY colone "≔" ><!--COLON EQUALS --> -<!ENTITY cuepr "⋞" ><!--EQUAL TO OR PRECEDES --> -<!ENTITY cuesc "⋟" ><!--EQUAL TO OR SUCCEEDS --> -<!ENTITY cupre "≼" ><!--PRECEDES OR EQUAL TO --> -<!ENTITY dashv "⊣" ><!--LEFT TACK --> -<!ENTITY ecir "≖" ><!--RING IN EQUAL TO --> -<!ENTITY ecolon "≕" ><!--EQUALS COLON --> -<!ENTITY eDot "≑" ><!--GEOMETRICALLY EQUAL TO --> -<!ENTITY efDot "≒" ><!--APPROXIMATELY EQUAL TO OR THE IMAGE OF --> -<!ENTITY egs "⪖" ><!--SLANTED EQUAL TO OR GREATER-THAN --> -<!ENTITY els "⪕" ><!--SLANTED EQUAL TO OR LESS-THAN --> -<!ENTITY erDot "≓" ><!--IMAGE OF OR APPROXIMATELY EQUAL TO --> -<!ENTITY esdot "≐" ><!--APPROACHES THE LIMIT --> -<!ENTITY fork "⋔" ><!--PITCHFORK --> -<!ENTITY frown "⌢" ><!--FROWN --> -<!ENTITY gap "⪆" ><!--GREATER-THAN OR APPROXIMATE --> -<!ENTITY gE "≧" ><!--GREATER-THAN OVER EQUAL TO --> -<!ENTITY gEl "⪌" ><!--GREATER-THAN ABOVE DOUBLE-LINE EQUAL ABOVE LESS-THAN --> -<!ENTITY gel "⋛" ><!--GREATER-THAN EQUAL TO OR LESS-THAN --> -<!ENTITY ges "⩾" ><!--GREATER-THAN OR SLANTED EQUAL TO --> -<!ENTITY Gg "⋙" ><!--VERY MUCH GREATER-THAN --> -<!ENTITY gl "≷" ><!--GREATER-THAN OR LESS-THAN --> -<!ENTITY gsdot "⋗" ><!--GREATER-THAN WITH DOT --> -<!ENTITY gsim "≳" ><!--GREATER-THAN OR EQUIVALENT TO --> -<!ENTITY Gt "≫" ><!--MUCH GREATER-THAN --> -<!ENTITY lap "⪅" ><!--LESS-THAN OR APPROXIMATE --> -<!ENTITY ldot "⋖" ><!--LESS-THAN WITH DOT --> -<!ENTITY lE "≦" ><!--LESS-THAN OVER EQUAL TO --> -<!ENTITY lEg "⪋" ><!--LESS-THAN ABOVE DOUBLE-LINE EQUAL ABOVE GREATER-THAN --> -<!ENTITY leg "⋚" ><!--LESS-THAN EQUAL TO OR GREATER-THAN --> -<!ENTITY les "⩽" ><!--LESS-THAN OR SLANTED EQUAL TO --> -<!ENTITY lg "≶" ><!--LESS-THAN OR GREATER-THAN --> -<!ENTITY Ll "⋘" ><!--VERY MUCH LESS-THAN --> -<!ENTITY lsim "≲" ><!--LESS-THAN OR EQUIVALENT TO --> -<!ENTITY Lt "≪" ><!--MUCH LESS-THAN --> -<!ENTITY ltrie "⊴" ><!--NORMAL SUBGROUP OF OR EQUAL TO --> -<!ENTITY mid "∣" ><!--DIVIDES --> -<!ENTITY models "⊧" ><!--MODELS --> -<!ENTITY pr "≺" ><!--PRECEDES --> -<!ENTITY prap "⪷" ><!--PRECEDES ABOVE ALMOST EQUAL TO --> -<!ENTITY pre "⪯" ><!--PRECEDES ABOVE SINGLE-LINE EQUALS SIGN --> -<!ENTITY prsim "≾" ><!--PRECEDES OR EQUIVALENT TO --> -<!ENTITY rtrie "⊵" ><!--CONTAINS AS NORMAL SUBGROUP OR EQUAL TO --> -<!ENTITY samalg "∐" ><!--N-ARY COPRODUCT --> -<!ENTITY sc "≻" ><!--SUCCEEDS --> -<!ENTITY scap "⪸" ><!--SUCCEEDS ABOVE ALMOST EQUAL TO --> -<!ENTITY sccue "≽" ><!--SUCCEEDS OR EQUAL TO --> -<!ENTITY sce "⪰" ><!--SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN --> -<!ENTITY scsim "≿" ><!--SUCCEEDS OR EQUIVALENT TO --> -<!ENTITY sfrown "⌢" ><!--FROWN --> -<!ENTITY smid "∣" ><!--DIVIDES --> -<!ENTITY smile "⌣" ><!--SMILE --> -<!ENTITY spar "∥" ><!--PARALLEL TO --> -<!ENTITY sqsub "⊏" ><!--SQUARE IMAGE OF --> -<!ENTITY sqsube "⊑" ><!--SQUARE IMAGE OF OR EQUAL TO --> -<!ENTITY sqsup "⊐" ><!--SQUARE ORIGINAL OF --> -<!ENTITY sqsupe "⊒" ><!--SQUARE ORIGINAL OF OR EQUAL TO --> -<!ENTITY ssmile "⌣" ><!--SMILE --> -<!ENTITY Sub "⋐" ><!--DOUBLE SUBSET --> -<!ENTITY subE "⫅" ><!--SUBSET OF ABOVE EQUALS SIGN --> -<!ENTITY Sup "⋑" ><!--DOUBLE SUPERSET --> -<!ENTITY supE "⫆" ><!--SUPERSET OF ABOVE EQUALS SIGN --> -<!ENTITY thkap "≈" ><!--ALMOST EQUAL TO --> -<!ENTITY thksim "∼" ><!--TILDE OPERATOR --> -<!ENTITY trie "≜" ><!--DELTA EQUAL TO --> -<!ENTITY twixt "≬" ><!--BETWEEN --> -<!ENTITY Vdash "⊩" ><!--FORCES --> -<!ENTITY vDash "⊨" ><!--TRUE --> -<!ENTITY vdash "⊢" ><!--RIGHT TACK --> -<!ENTITY veebar "⊻" ><!--XOR --> -<!ENTITY vltri "⊲" ><!--NORMAL SUBGROUP OF --> -<!ENTITY vprop "∝" ><!--PROPORTIONAL TO --> -<!ENTITY vrtri "⊳" ><!--CONTAINS AS NORMAL SUBGROUP --> -<!ENTITY Vvdash "⊪" ><!--TRIPLE VERTICAL BAR RIGHT TURNSTILE --> diff --git a/Utilities/xml/docbook-4.5/ent/isobox.ent b/Utilities/xml/docbook-4.5/ent/isobox.ent deleted file mode 100644 index 9ae27d4..0000000 --- a/Utilities/xml/docbook-4.5/ent/isobox.ent +++ /dev/null @@ -1,81 +0,0 @@ - -<!-- - File isobox.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isobox.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isobox.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isobox PUBLIC - "ISO 8879:1986//ENTITIES Box and Line Drawing//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isobox.ent" - > - %isobox; - ---> - -<!ENTITY boxDL "╗" ><!--BOX DRAWINGS DOUBLE DOWN AND LEFT --> -<!ENTITY boxDl "╖" ><!--BOX DRAWINGS DOWN DOUBLE AND LEFT SINGLE --> -<!ENTITY boxdL "╕" ><!--BOX DRAWINGS DOWN SINGLE AND LEFT DOUBLE --> -<!ENTITY boxdl "┐" ><!--BOX DRAWINGS LIGHT DOWN AND LEFT --> -<!ENTITY boxDR "╔" ><!--BOX DRAWINGS DOUBLE DOWN AND RIGHT --> -<!ENTITY boxDr "╓" ><!--BOX DRAWINGS DOWN DOUBLE AND RIGHT SINGLE --> -<!ENTITY boxdR "╒" ><!--BOX DRAWINGS DOWN SINGLE AND RIGHT DOUBLE --> -<!ENTITY boxdr "┌" ><!--BOX DRAWINGS LIGHT DOWN AND RIGHT --> -<!ENTITY boxH "═" ><!--BOX DRAWINGS DOUBLE HORIZONTAL --> -<!ENTITY boxh "─" ><!--BOX DRAWINGS LIGHT HORIZONTAL --> -<!ENTITY boxHD "╦" ><!--BOX DRAWINGS DOUBLE DOWN AND HORIZONTAL --> -<!ENTITY boxHd "╤" ><!--BOX DRAWINGS DOWN SINGLE AND HORIZONTAL DOUBLE --> -<!ENTITY boxhD "╥" ><!--BOX DRAWINGS DOWN DOUBLE AND HORIZONTAL SINGLE --> -<!ENTITY boxhd "┬" ><!--BOX DRAWINGS LIGHT DOWN AND HORIZONTAL --> -<!ENTITY boxHU "╩" ><!--BOX DRAWINGS DOUBLE UP AND HORIZONTAL --> -<!ENTITY boxHu "╧" ><!--BOX DRAWINGS UP SINGLE AND HORIZONTAL DOUBLE --> -<!ENTITY boxhU "╨" ><!--BOX DRAWINGS UP DOUBLE AND HORIZONTAL SINGLE --> -<!ENTITY boxhu "┴" ><!--BOX DRAWINGS LIGHT UP AND HORIZONTAL --> -<!ENTITY boxUL "╝" ><!--BOX DRAWINGS DOUBLE UP AND LEFT --> -<!ENTITY boxUl "╜" ><!--BOX DRAWINGS UP DOUBLE AND LEFT SINGLE --> -<!ENTITY boxuL "╛" ><!--BOX DRAWINGS UP SINGLE AND LEFT DOUBLE --> -<!ENTITY boxul "┘" ><!--BOX DRAWINGS LIGHT UP AND LEFT --> -<!ENTITY boxUR "╚" ><!--BOX DRAWINGS DOUBLE UP AND RIGHT --> -<!ENTITY boxUr "╙" ><!--BOX DRAWINGS UP DOUBLE AND RIGHT SINGLE --> -<!ENTITY boxuR "╘" ><!--BOX DRAWINGS UP SINGLE AND RIGHT DOUBLE --> -<!ENTITY boxur "└" ><!--BOX DRAWINGS LIGHT UP AND RIGHT --> -<!ENTITY boxV "║" ><!--BOX DRAWINGS DOUBLE VERTICAL --> -<!ENTITY boxv "│" ><!--BOX DRAWINGS LIGHT VERTICAL --> -<!ENTITY boxVH "╬" ><!--BOX DRAWINGS DOUBLE VERTICAL AND HORIZONTAL --> -<!ENTITY boxVh "╫" ><!--BOX DRAWINGS VERTICAL DOUBLE AND HORIZONTAL SINGLE --> -<!ENTITY boxvH "╪" ><!--BOX DRAWINGS VERTICAL SINGLE AND HORIZONTAL DOUBLE --> -<!ENTITY boxvh "┼" ><!--BOX DRAWINGS LIGHT VERTICAL AND HORIZONTAL --> -<!ENTITY boxVL "╣" ><!--BOX DRAWINGS DOUBLE VERTICAL AND LEFT --> -<!ENTITY boxVl "╢" ><!--BOX DRAWINGS VERTICAL DOUBLE AND LEFT SINGLE --> -<!ENTITY boxvL "╡" ><!--BOX DRAWINGS VERTICAL SINGLE AND LEFT DOUBLE --> -<!ENTITY boxvl "┤" ><!--BOX DRAWINGS LIGHT VERTICAL AND LEFT --> -<!ENTITY boxVR "╠" ><!--BOX DRAWINGS DOUBLE VERTICAL AND RIGHT --> -<!ENTITY boxVr "╟" ><!--BOX DRAWINGS VERTICAL DOUBLE AND RIGHT SINGLE --> -<!ENTITY boxvR "╞" ><!--BOX DRAWINGS VERTICAL SINGLE AND RIGHT DOUBLE --> -<!ENTITY boxvr "├" ><!--BOX DRAWINGS LIGHT VERTICAL AND RIGHT --> diff --git a/Utilities/xml/docbook-4.5/ent/isocyr1.ent b/Utilities/xml/docbook-4.5/ent/isocyr1.ent deleted file mode 100644 index 364b6d8..0000000 --- a/Utilities/xml/docbook-4.5/ent/isocyr1.ent +++ /dev/null @@ -1,108 +0,0 @@ - -<!-- - File isocyr1.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isocyr1.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isocyr1.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isocyr1 PUBLIC - "ISO 8879:1986//ENTITIES Russian Cyrillic//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isocyr1.ent" - > - %isocyr1; - ---> - -<!ENTITY Acy "А" ><!--CYRILLIC CAPITAL LETTER A --> -<!ENTITY acy "а" ><!--CYRILLIC SMALL LETTER A --> -<!ENTITY Bcy "Б" ><!--CYRILLIC CAPITAL LETTER BE --> -<!ENTITY bcy "б" ><!--CYRILLIC SMALL LETTER BE --> -<!ENTITY CHcy "Ч" ><!--CYRILLIC CAPITAL LETTER CHE --> -<!ENTITY chcy "ч" ><!--CYRILLIC SMALL LETTER CHE --> -<!ENTITY Dcy "Д" ><!--CYRILLIC CAPITAL LETTER DE --> -<!ENTITY dcy "д" ><!--CYRILLIC SMALL LETTER DE --> -<!ENTITY Ecy "Э" ><!--CYRILLIC CAPITAL LETTER E --> -<!ENTITY ecy "э" ><!--CYRILLIC SMALL LETTER E --> -<!ENTITY Fcy "Ф" ><!--CYRILLIC CAPITAL LETTER EF --> -<!ENTITY fcy "ф" ><!--CYRILLIC SMALL LETTER EF --> -<!ENTITY Gcy "Г" ><!--CYRILLIC CAPITAL LETTER GHE --> -<!ENTITY gcy "г" ><!--CYRILLIC SMALL LETTER GHE --> -<!ENTITY HARDcy "Ъ" ><!--CYRILLIC CAPITAL LETTER HARD SIGN --> -<!ENTITY hardcy "ъ" ><!--CYRILLIC SMALL LETTER HARD SIGN --> -<!ENTITY Icy "И" ><!--CYRILLIC CAPITAL LETTER I --> -<!ENTITY icy "и" ><!--CYRILLIC SMALL LETTER I --> -<!ENTITY IEcy "Е" ><!--CYRILLIC CAPITAL LETTER IE --> -<!ENTITY iecy "е" ><!--CYRILLIC SMALL LETTER IE --> -<!ENTITY IOcy "Ё" ><!--CYRILLIC CAPITAL LETTER IO --> -<!ENTITY iocy "ё" ><!--CYRILLIC SMALL LETTER IO --> -<!ENTITY Jcy "Й" ><!--CYRILLIC CAPITAL LETTER SHORT I --> -<!ENTITY jcy "й" ><!--CYRILLIC SMALL LETTER SHORT I --> -<!ENTITY Kcy "К" ><!--CYRILLIC CAPITAL LETTER KA --> -<!ENTITY kcy "к" ><!--CYRILLIC SMALL LETTER KA --> -<!ENTITY KHcy "Х" ><!--CYRILLIC CAPITAL LETTER HA --> -<!ENTITY khcy "х" ><!--CYRILLIC SMALL LETTER HA --> -<!ENTITY Lcy "Л" ><!--CYRILLIC CAPITAL LETTER EL --> -<!ENTITY lcy "л" ><!--CYRILLIC SMALL LETTER EL --> -<!ENTITY Mcy "М" ><!--CYRILLIC CAPITAL LETTER EM --> -<!ENTITY mcy "м" ><!--CYRILLIC SMALL LETTER EM --> -<!ENTITY Ncy "Н" ><!--CYRILLIC CAPITAL LETTER EN --> -<!ENTITY ncy "н" ><!--CYRILLIC SMALL LETTER EN --> -<!ENTITY numero "№" ><!--NUMERO SIGN --> -<!ENTITY Ocy "О" ><!--CYRILLIC CAPITAL LETTER O --> -<!ENTITY ocy "о" ><!--CYRILLIC SMALL LETTER O --> -<!ENTITY Pcy "П" ><!--CYRILLIC CAPITAL LETTER PE --> -<!ENTITY pcy "п" ><!--CYRILLIC SMALL LETTER PE --> -<!ENTITY Rcy "Р" ><!--CYRILLIC CAPITAL LETTER ER --> -<!ENTITY rcy "р" ><!--CYRILLIC SMALL LETTER ER --> -<!ENTITY Scy "С" ><!--CYRILLIC CAPITAL LETTER ES --> -<!ENTITY scy "с" ><!--CYRILLIC SMALL LETTER ES --> -<!ENTITY SHCHcy "Щ" ><!--CYRILLIC CAPITAL LETTER SHCHA --> -<!ENTITY shchcy "щ" ><!--CYRILLIC SMALL LETTER SHCHA --> -<!ENTITY SHcy "Ш" ><!--CYRILLIC CAPITAL LETTER SHA --> -<!ENTITY shcy "ш" ><!--CYRILLIC SMALL LETTER SHA --> -<!ENTITY SOFTcy "Ь" ><!--CYRILLIC CAPITAL LETTER SOFT SIGN --> -<!ENTITY softcy "ь" ><!--CYRILLIC SMALL LETTER SOFT SIGN --> -<!ENTITY Tcy "Т" ><!--CYRILLIC CAPITAL LETTER TE --> -<!ENTITY tcy "т" ><!--CYRILLIC SMALL LETTER TE --> -<!ENTITY TScy "Ц" ><!--CYRILLIC CAPITAL LETTER TSE --> -<!ENTITY tscy "ц" ><!--CYRILLIC SMALL LETTER TSE --> -<!ENTITY Ucy "У" ><!--CYRILLIC CAPITAL LETTER U --> -<!ENTITY ucy "у" ><!--CYRILLIC SMALL LETTER U --> -<!ENTITY Vcy "В" ><!--CYRILLIC CAPITAL LETTER VE --> -<!ENTITY vcy "в" ><!--CYRILLIC SMALL LETTER VE --> -<!ENTITY YAcy "Я" ><!--CYRILLIC CAPITAL LETTER YA --> -<!ENTITY yacy "я" ><!--CYRILLIC SMALL LETTER YA --> -<!ENTITY Ycy "Ы" ><!--CYRILLIC CAPITAL LETTER YERU --> -<!ENTITY ycy "ы" ><!--CYRILLIC SMALL LETTER YERU --> -<!ENTITY YUcy "Ю" ><!--CYRILLIC CAPITAL LETTER YU --> -<!ENTITY yucy "ю" ><!--CYRILLIC SMALL LETTER YU --> -<!ENTITY Zcy "З" ><!--CYRILLIC CAPITAL LETTER ZE --> -<!ENTITY zcy "з" ><!--CYRILLIC SMALL LETTER ZE --> -<!ENTITY ZHcy "Ж" ><!--CYRILLIC CAPITAL LETTER ZHE --> -<!ENTITY zhcy "ж" ><!--CYRILLIC SMALL LETTER ZHE --> diff --git a/Utilities/xml/docbook-4.5/ent/isocyr2.ent b/Utilities/xml/docbook-4.5/ent/isocyr2.ent deleted file mode 100644 index 6432d74..0000000 --- a/Utilities/xml/docbook-4.5/ent/isocyr2.ent +++ /dev/null @@ -1,67 +0,0 @@ - -<!-- - File isocyr2.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isocyr2.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isocyr2.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isocyr2 PUBLIC - "ISO 8879:1986//ENTITIES Non-Russian Cyrillic//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isocyr2.ent" - > - %isocyr2; - ---> - -<!ENTITY DJcy "Ђ" ><!--CYRILLIC CAPITAL LETTER DJE --> -<!ENTITY djcy "ђ" ><!--CYRILLIC SMALL LETTER DJE --> -<!ENTITY DScy "Ѕ" ><!--CYRILLIC CAPITAL LETTER DZE --> -<!ENTITY dscy "ѕ" ><!--CYRILLIC SMALL LETTER DZE --> -<!ENTITY DZcy "Џ" ><!--CYRILLIC CAPITAL LETTER DZHE --> -<!ENTITY dzcy "џ" ><!--CYRILLIC SMALL LETTER DZHE --> -<!ENTITY GJcy "Ѓ" ><!--CYRILLIC CAPITAL LETTER GJE --> -<!ENTITY gjcy "ѓ" ><!--CYRILLIC SMALL LETTER GJE --> -<!ENTITY Iukcy "І" ><!--CYRILLIC CAPITAL LETTER BYELORUSSIAN-UKRAINIAN I --> -<!ENTITY iukcy "і" ><!--CYRILLIC SMALL LETTER BYELORUSSIAN-UKRAINIAN I --> -<!ENTITY Jsercy "Ј" ><!--CYRILLIC CAPITAL LETTER JE --> -<!ENTITY jsercy "ј" ><!--CYRILLIC SMALL LETTER JE --> -<!ENTITY Jukcy "Є" ><!--CYRILLIC CAPITAL LETTER UKRAINIAN IE --> -<!ENTITY jukcy "є" ><!--CYRILLIC SMALL LETTER UKRAINIAN IE --> -<!ENTITY KJcy "Ќ" ><!--CYRILLIC CAPITAL LETTER KJE --> -<!ENTITY kjcy "ќ" ><!--CYRILLIC SMALL LETTER KJE --> -<!ENTITY LJcy "Љ" ><!--CYRILLIC CAPITAL LETTER LJE --> -<!ENTITY ljcy "љ" ><!--CYRILLIC SMALL LETTER LJE --> -<!ENTITY NJcy "Њ" ><!--CYRILLIC CAPITAL LETTER NJE --> -<!ENTITY njcy "њ" ><!--CYRILLIC SMALL LETTER NJE --> -<!ENTITY TSHcy "Ћ" ><!--CYRILLIC CAPITAL LETTER TSHE --> -<!ENTITY tshcy "ћ" ><!--CYRILLIC SMALL LETTER TSHE --> -<!ENTITY Ubrcy "Ў" ><!--CYRILLIC CAPITAL LETTER SHORT U --> -<!ENTITY ubrcy "ў" ><!--CYRILLIC SMALL LETTER SHORT U --> -<!ENTITY YIcy "Ї" ><!--CYRILLIC CAPITAL LETTER YI --> -<!ENTITY yicy "ї" ><!--CYRILLIC SMALL LETTER YI --> diff --git a/Utilities/xml/docbook-4.5/ent/isodia.ent b/Utilities/xml/docbook-4.5/ent/isodia.ent deleted file mode 100644 index b49c309..0000000 --- a/Utilities/xml/docbook-4.5/ent/isodia.ent +++ /dev/null @@ -1,55 +0,0 @@ - -<!-- - File isodia.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isodia.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isodia.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isodia PUBLIC - "ISO 8879:1986//ENTITIES Diacritical Marks//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isodia.ent" - > - %isodia; - ---> - -<!ENTITY acute "´" ><!--ACUTE ACCENT --> -<!ENTITY breve "˘" ><!--BREVE --> -<!ENTITY caron "ˇ" ><!--CARON --> -<!ENTITY cedil "¸" ><!--CEDILLA --> -<!ENTITY circ "ˆ" ><!--MODIFIER LETTER CIRCUMFLEX ACCENT --> -<!ENTITY dblac "˝" ><!--DOUBLE ACUTE ACCENT --> -<!ENTITY die "¨" ><!--DIAERESIS --> -<!ENTITY dot "˙" ><!--DOT ABOVE --> -<!ENTITY grave "`" ><!--GRAVE ACCENT --> -<!ENTITY macr "¯" ><!--MACRON --> -<!ENTITY ogon "˛" ><!--OGONEK --> -<!ENTITY ring "˚" ><!--RING ABOVE --> -<!ENTITY tilde "˜" ><!--SMALL TILDE --> -<!ENTITY uml "¨" ><!--DIAERESIS --> diff --git a/Utilities/xml/docbook-4.5/ent/isogrk1.ent b/Utilities/xml/docbook-4.5/ent/isogrk1.ent deleted file mode 100644 index 7826f81..0000000 --- a/Utilities/xml/docbook-4.5/ent/isogrk1.ent +++ /dev/null @@ -1,90 +0,0 @@ - -<!-- - File isogrk1.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isogrk1.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Greek Letters//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isogrk1.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isogrk1 PUBLIC - "ISO 8879:1986//ENTITIES Greek Letters//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isogrk1.ent" - > - %isogrk1; - ---> - -<!ENTITY Agr "Α" ><!--GREEK CAPITAL LETTER ALPHA --> -<!ENTITY agr "α" ><!--GREEK SMALL LETTER ALPHA --> -<!ENTITY Bgr "Β" ><!--GREEK CAPITAL LETTER BETA --> -<!ENTITY bgr "β" ><!--GREEK SMALL LETTER BETA --> -<!ENTITY Dgr "Δ" ><!--GREEK CAPITAL LETTER DELTA --> -<!ENTITY dgr "δ" ><!--GREEK SMALL LETTER DELTA --> -<!ENTITY EEgr "Η" ><!--GREEK CAPITAL LETTER ETA --> -<!ENTITY eegr "η" ><!--GREEK SMALL LETTER ETA --> -<!ENTITY Egr "Ε" ><!--GREEK CAPITAL LETTER EPSILON --> -<!ENTITY egr "ε" ><!--GREEK SMALL LETTER EPSILON --> -<!ENTITY Ggr "Γ" ><!--GREEK CAPITAL LETTER GAMMA --> -<!ENTITY ggr "γ" ><!--GREEK SMALL LETTER GAMMA --> -<!ENTITY Igr "Ι" ><!--GREEK CAPITAL LETTER IOTA --> -<!ENTITY igr "ι" ><!--GREEK SMALL LETTER IOTA --> -<!ENTITY Kgr "Κ" ><!--GREEK CAPITAL LETTER KAPPA --> -<!ENTITY kgr "κ" ><!--GREEK SMALL LETTER KAPPA --> -<!ENTITY KHgr "Χ" ><!--GREEK CAPITAL LETTER CHI --> -<!ENTITY khgr "χ" ><!--GREEK SMALL LETTER CHI --> -<!ENTITY Lgr "Λ" ><!--GREEK CAPITAL LETTER LAMDA --> -<!ENTITY lgr "λ" ><!--GREEK SMALL LETTER LAMDA --> -<!ENTITY Mgr "Μ" ><!--GREEK CAPITAL LETTER MU --> -<!ENTITY mgr "μ" ><!--GREEK SMALL LETTER MU --> -<!ENTITY Ngr "Ν" ><!--GREEK CAPITAL LETTER NU --> -<!ENTITY ngr "ν" ><!--GREEK SMALL LETTER NU --> -<!ENTITY Ogr "Ο" ><!--GREEK CAPITAL LETTER OMICRON --> -<!ENTITY ogr "ο" ><!--GREEK SMALL LETTER OMICRON --> -<!ENTITY OHgr "Ω" ><!--GREEK CAPITAL LETTER OMEGA --> -<!ENTITY ohgr "ω" ><!--GREEK SMALL LETTER OMEGA --> -<!ENTITY Pgr "Π" ><!--GREEK CAPITAL LETTER PI --> -<!ENTITY pgr "π" ><!--GREEK SMALL LETTER PI --> -<!ENTITY PHgr "Φ" ><!--GREEK CAPITAL LETTER PHI --> -<!ENTITY phgr "φ" ><!--GREEK SMALL LETTER PHI --> -<!ENTITY PSgr "Ψ" ><!--GREEK CAPITAL LETTER PSI --> -<!ENTITY psgr "ψ" ><!--GREEK SMALL LETTER PSI --> -<!ENTITY Rgr "Ρ" ><!--GREEK CAPITAL LETTER RHO --> -<!ENTITY rgr "ρ" ><!--GREEK SMALL LETTER RHO --> -<!ENTITY sfgr "ς" ><!--GREEK SMALL LETTER FINAL SIGMA --> -<!ENTITY Sgr "Σ" ><!--GREEK CAPITAL LETTER SIGMA --> -<!ENTITY sgr "σ" ><!--GREEK SMALL LETTER SIGMA --> -<!ENTITY Tgr "Τ" ><!--GREEK CAPITAL LETTER TAU --> -<!ENTITY tgr "τ" ><!--GREEK SMALL LETTER TAU --> -<!ENTITY THgr "Θ" ><!--GREEK CAPITAL LETTER THETA --> -<!ENTITY thgr "θ" ><!--GREEK SMALL LETTER THETA --> -<!ENTITY Ugr "Υ" ><!--GREEK CAPITAL LETTER UPSILON --> -<!ENTITY ugr "υ" ><!--GREEK SMALL LETTER UPSILON --> -<!ENTITY Xgr "Ξ" ><!--GREEK CAPITAL LETTER XI --> -<!ENTITY xgr "ξ" ><!--GREEK SMALL LETTER XI --> -<!ENTITY Zgr "Ζ" ><!--GREEK CAPITAL LETTER ZETA --> -<!ENTITY zgr "ζ" ><!--GREEK SMALL LETTER ZETA --> diff --git a/Utilities/xml/docbook-4.5/ent/isogrk2.ent b/Utilities/xml/docbook-4.5/ent/isogrk2.ent deleted file mode 100644 index 726b7dd..0000000 --- a/Utilities/xml/docbook-4.5/ent/isogrk2.ent +++ /dev/null @@ -1,61 +0,0 @@ - -<!-- - File isogrk2.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isogrk2.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isogrk2.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isogrk2 PUBLIC - "ISO 8879:1986//ENTITIES Monotoniko Greek//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isogrk2.ent" - > - %isogrk2; - ---> - -<!ENTITY Aacgr "Ά" ><!--GREEK CAPITAL LETTER ALPHA WITH TONOS --> -<!ENTITY aacgr "ά" ><!--GREEK SMALL LETTER ALPHA WITH TONOS --> -<!ENTITY Eacgr "Έ" ><!--GREEK CAPITAL LETTER EPSILON WITH TONOS --> -<!ENTITY eacgr "έ" ><!--GREEK SMALL LETTER EPSILON WITH TONOS --> -<!ENTITY EEacgr "Ή" ><!--GREEK CAPITAL LETTER ETA WITH TONOS --> -<!ENTITY eeacgr "ή" ><!--GREEK SMALL LETTER ETA WITH TONOS --> -<!ENTITY Iacgr "Ί" ><!--GREEK CAPITAL LETTER IOTA WITH TONOS --> -<!ENTITY iacgr "ί" ><!--GREEK SMALL LETTER IOTA WITH TONOS --> -<!ENTITY idiagr "ΐ" ><!--GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS --> -<!ENTITY Idigr "Ϊ" ><!--GREEK CAPITAL LETTER IOTA WITH DIALYTIKA --> -<!ENTITY idigr "ϊ" ><!--GREEK SMALL LETTER IOTA WITH DIALYTIKA --> -<!ENTITY Oacgr "Ό" ><!--GREEK CAPITAL LETTER OMICRON WITH TONOS --> -<!ENTITY oacgr "ό" ><!--GREEK SMALL LETTER OMICRON WITH TONOS --> -<!ENTITY OHacgr "Ώ" ><!--GREEK CAPITAL LETTER OMEGA WITH TONOS --> -<!ENTITY ohacgr "ώ" ><!--GREEK SMALL LETTER OMEGA WITH TONOS --> -<!ENTITY Uacgr "Ύ" ><!--GREEK CAPITAL LETTER UPSILON WITH TONOS --> -<!ENTITY uacgr "ύ" ><!--GREEK SMALL LETTER UPSILON WITH TONOS --> -<!ENTITY udiagr "ΰ" ><!--GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS --> -<!ENTITY Udigr "Ϋ" ><!--GREEK CAPITAL LETTER UPSILON WITH DIALYTIKA --> -<!ENTITY udigr "ϋ" ><!--GREEK SMALL LETTER UPSILON WITH DIALYTIKA --> diff --git a/Utilities/xml/docbook-4.5/ent/isogrk3.ent b/Utilities/xml/docbook-4.5/ent/isogrk3.ent deleted file mode 100644 index 28b5c27..0000000 --- a/Utilities/xml/docbook-4.5/ent/isogrk3.ent +++ /dev/null @@ -1,84 +0,0 @@ - -<!-- - File isogrk3.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isogrk3.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Greek Symbols//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isogrk3.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isogrk3 PUBLIC - "ISO 8879:1986//ENTITIES Greek Symbols//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isogrk3.ent" - > - %isogrk3; - ---> - -<!ENTITY alpha "α" ><!--GREEK SMALL LETTER ALPHA --> -<!ENTITY beta "β" ><!--GREEK SMALL LETTER BETA --> -<!ENTITY chi "χ" ><!--GREEK SMALL LETTER CHI --> -<!ENTITY Delta "Δ" ><!--GREEK CAPITAL LETTER DELTA --> -<!ENTITY delta "δ" ><!--GREEK SMALL LETTER DELTA --> -<!ENTITY epsi "ϵ" ><!--GREEK LUNATE EPSILON SYMBOL --> -<!ENTITY epsis "ϵ" ><!--GREEK LUNATE EPSILON SYMBOL --> -<!ENTITY epsiv "ε" ><!--GREEK SMALL LETTER EPSILON --> -<!ENTITY eta "η" ><!--GREEK SMALL LETTER ETA --> -<!ENTITY Gamma "Γ" ><!--GREEK CAPITAL LETTER GAMMA --> -<!ENTITY gamma "γ" ><!--GREEK SMALL LETTER GAMMA --> -<!ENTITY gammad "ϝ" ><!--GREEK SMALL LETTER DIGAMMA --> -<!ENTITY iota "ι" ><!--GREEK SMALL LETTER IOTA --> -<!ENTITY kappa "κ" ><!--GREEK SMALL LETTER KAPPA --> -<!ENTITY kappav "ϰ" ><!--GREEK KAPPA SYMBOL --> -<!ENTITY Lambda "Λ" ><!--GREEK CAPITAL LETTER LAMDA --> -<!ENTITY lambda "λ" ><!--GREEK SMALL LETTER LAMDA --> -<!ENTITY mu "μ" ><!--GREEK SMALL LETTER MU --> -<!ENTITY nu "ν" ><!--GREEK SMALL LETTER NU --> -<!ENTITY Omega "Ω" ><!--GREEK CAPITAL LETTER OMEGA --> -<!ENTITY omega "ω" ><!--GREEK SMALL LETTER OMEGA --> -<!ENTITY Phi "Φ" ><!--GREEK CAPITAL LETTER PHI --> -<!ENTITY phis "ϕ" ><!--GREEK PHI SYMBOL --> -<!ENTITY phiv "φ" ><!--GREEK SMALL LETTER PHI --> -<!ENTITY Pi "Π" ><!--GREEK CAPITAL LETTER PI --> -<!ENTITY pi "π" ><!--GREEK SMALL LETTER PI --> -<!ENTITY piv "ϖ" ><!--GREEK PI SYMBOL --> -<!ENTITY Psi "Ψ" ><!--GREEK CAPITAL LETTER PSI --> -<!ENTITY psi "ψ" ><!--GREEK SMALL LETTER PSI --> -<!ENTITY rho "ρ" ><!--GREEK SMALL LETTER RHO --> -<!ENTITY rhov "ϱ" ><!--GREEK RHO SYMBOL --> -<!ENTITY Sigma "Σ" ><!--GREEK CAPITAL LETTER SIGMA --> -<!ENTITY sigma "σ" ><!--GREEK SMALL LETTER SIGMA --> -<!ENTITY sigmav "ς" ><!--GREEK SMALL LETTER FINAL SIGMA --> -<!ENTITY tau "τ" ><!--GREEK SMALL LETTER TAU --> -<!ENTITY Theta "Θ" ><!--GREEK CAPITAL LETTER THETA --> -<!ENTITY thetas "θ" ><!--GREEK SMALL LETTER THETA --> -<!ENTITY thetav "ϑ" ><!--GREEK THETA SYMBOL --> -<!ENTITY Upsi "ϒ" ><!--GREEK UPSILON WITH HOOK SYMBOL --> -<!ENTITY upsi "υ" ><!--GREEK SMALL LETTER UPSILON --> -<!ENTITY Xi "Ξ" ><!--GREEK CAPITAL LETTER XI --> -<!ENTITY xi "ξ" ><!--GREEK SMALL LETTER XI --> -<!ENTITY zeta "ζ" ><!--GREEK SMALL LETTER ZETA --> diff --git a/Utilities/xml/docbook-4.5/ent/isogrk4.ent b/Utilities/xml/docbook-4.5/ent/isogrk4.ent deleted file mode 100644 index 27c6a51..0000000 --- a/Utilities/xml/docbook-4.5/ent/isogrk4.ent +++ /dev/null @@ -1,84 +0,0 @@ - -<!-- - File isogrk4.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isogrk4.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isogrk4.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isogrk4 PUBLIC - "ISO 8879:1986//ENTITIES Alternative Greek Symbols//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isogrk4.ent" - > - %isogrk4; - ---> - -<!ENTITY b.alpha "𝛂" ><!--MATHEMATICAL BOLD SMALL ALPHA --> -<!ENTITY b.beta "𝛃" ><!--MATHEMATICAL BOLD SMALL BETA --> -<!ENTITY b.chi "𝛘" ><!--MATHEMATICAL BOLD SMALL CHI --> -<!ENTITY b.Delta "𝚫" ><!--MATHEMATICAL BOLD CAPITAL DELTA --> -<!ENTITY b.delta "𝛅" ><!--MATHEMATICAL BOLD SMALL DELTA --> -<!ENTITY b.epsi "𝛆" ><!--MATHEMATICAL BOLD SMALL EPSILON --> -<!ENTITY b.epsiv "𝛜" ><!--MATHEMATICAL BOLD EPSILON SYMBOL --> -<!ENTITY b.eta "𝛈" ><!--MATHEMATICAL BOLD SMALL ETA --> -<!ENTITY b.Gamma "𝚪" ><!--MATHEMATICAL BOLD CAPITAL GAMMA --> -<!ENTITY b.gamma "𝛄" ><!--MATHEMATICAL BOLD SMALL GAMMA --> -<!ENTITY b.Gammad "Ϝ" ><!--GREEK LETTER DIGAMMA --> -<!ENTITY b.gammad "ϝ" ><!--GREEK SMALL LETTER DIGAMMA --> -<!ENTITY b.iota "𝛊" ><!--MATHEMATICAL BOLD SMALL IOTA --> -<!ENTITY b.kappa "𝛋" ><!--MATHEMATICAL BOLD SMALL KAPPA --> -<!ENTITY b.kappav "𝛞" ><!--MATHEMATICAL BOLD KAPPA SYMBOL --> -<!ENTITY b.Lambda "𝚲" ><!--MATHEMATICAL BOLD CAPITAL LAMDA --> -<!ENTITY b.lambda "𝛌" ><!--MATHEMATICAL BOLD SMALL LAMDA --> -<!ENTITY b.mu "𝛍" ><!--MATHEMATICAL BOLD SMALL MU --> -<!ENTITY b.nu "𝛎" ><!--MATHEMATICAL BOLD SMALL NU --> -<!ENTITY b.Omega "𝛀" ><!--MATHEMATICAL BOLD CAPITAL OMEGA --> -<!ENTITY b.omega "𝛚" ><!--MATHEMATICAL BOLD SMALL OMEGA --> -<!ENTITY b.Phi "𝚽" ><!--MATHEMATICAL BOLD CAPITAL PHI --> -<!ENTITY b.phi "𝛗" ><!--MATHEMATICAL BOLD SMALL PHI --> -<!ENTITY b.phiv "𝛟" ><!--MATHEMATICAL BOLD PHI SYMBOL --> -<!ENTITY b.Pi "𝚷" ><!--MATHEMATICAL BOLD CAPITAL PI --> -<!ENTITY b.pi "𝛑" ><!--MATHEMATICAL BOLD SMALL PI --> -<!ENTITY b.piv "𝛡" ><!--MATHEMATICAL BOLD PI SYMBOL --> -<!ENTITY b.Psi "𝚿" ><!--MATHEMATICAL BOLD CAPITAL PSI --> -<!ENTITY b.psi "𝛙" ><!--MATHEMATICAL BOLD SMALL PSI --> -<!ENTITY b.rho "𝛒" ><!--MATHEMATICAL BOLD SMALL RHO --> -<!ENTITY b.rhov "𝛠" ><!--MATHEMATICAL BOLD RHO SYMBOL --> -<!ENTITY b.Sigma "𝚺" ><!--MATHEMATICAL BOLD CAPITAL SIGMA --> -<!ENTITY b.sigma "𝛔" ><!--MATHEMATICAL BOLD SMALL SIGMA --> -<!ENTITY b.sigmav "𝛓" ><!--MATHEMATICAL BOLD SMALL FINAL SIGMA --> -<!ENTITY b.tau "𝛕" ><!--MATHEMATICAL BOLD SMALL TAU --> -<!ENTITY b.Theta "𝚯" ><!--MATHEMATICAL BOLD CAPITAL THETA --> -<!ENTITY b.thetas "𝛉" ><!--MATHEMATICAL BOLD SMALL THETA --> -<!ENTITY b.thetav "𝛝" ><!--MATHEMATICAL BOLD THETA SYMBOL --> -<!ENTITY b.Upsi "𝚼" ><!--MATHEMATICAL BOLD CAPITAL UPSILON --> -<!ENTITY b.upsi "𝛖" ><!--MATHEMATICAL BOLD SMALL UPSILON --> -<!ENTITY b.Xi "𝚵" ><!--MATHEMATICAL BOLD CAPITAL XI --> -<!ENTITY b.xi "𝛏" ><!--MATHEMATICAL BOLD SMALL XI --> -<!ENTITY b.zeta "𝛇" ><!--MATHEMATICAL BOLD SMALL ZETA --> diff --git a/Utilities/xml/docbook-4.5/ent/isolat1.ent b/Utilities/xml/docbook-4.5/ent/isolat1.ent deleted file mode 100644 index 381bd09..0000000 --- a/Utilities/xml/docbook-4.5/ent/isolat1.ent +++ /dev/null @@ -1,103 +0,0 @@ - -<!-- - File isolat1.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isolat1.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Latin 1//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isolat1.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isolat1 PUBLIC - "ISO 8879:1986//ENTITIES Added Latin 1//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isolat1.ent" - > - %isolat1; - ---> - -<!ENTITY Aacute "Á" ><!--LATIN CAPITAL LETTER A WITH ACUTE --> -<!ENTITY aacute "á" ><!--LATIN SMALL LETTER A WITH ACUTE --> -<!ENTITY Acirc "Â" ><!--LATIN CAPITAL LETTER A WITH CIRCUMFLEX --> -<!ENTITY acirc "â" ><!--LATIN SMALL LETTER A WITH CIRCUMFLEX --> -<!ENTITY AElig "Æ" ><!--LATIN CAPITAL LETTER AE --> -<!ENTITY aelig "æ" ><!--LATIN SMALL LETTER AE --> -<!ENTITY Agrave "À" ><!--LATIN CAPITAL LETTER A WITH GRAVE --> -<!ENTITY agrave "à" ><!--LATIN SMALL LETTER A WITH GRAVE --> -<!ENTITY Aring "Å" ><!--LATIN CAPITAL LETTER A WITH RING ABOVE --> -<!ENTITY aring "å" ><!--LATIN SMALL LETTER A WITH RING ABOVE --> -<!ENTITY Atilde "Ã" ><!--LATIN CAPITAL LETTER A WITH TILDE --> -<!ENTITY atilde "ã" ><!--LATIN SMALL LETTER A WITH TILDE --> -<!ENTITY Auml "Ä" ><!--LATIN CAPITAL LETTER A WITH DIAERESIS --> -<!ENTITY auml "ä" ><!--LATIN SMALL LETTER A WITH DIAERESIS --> -<!ENTITY Ccedil "Ç" ><!--LATIN CAPITAL LETTER C WITH CEDILLA --> -<!ENTITY ccedil "ç" ><!--LATIN SMALL LETTER C WITH CEDILLA --> -<!ENTITY Eacute "É" ><!--LATIN CAPITAL LETTER E WITH ACUTE --> -<!ENTITY eacute "é" ><!--LATIN SMALL LETTER E WITH ACUTE --> -<!ENTITY Ecirc "Ê" ><!--LATIN CAPITAL LETTER E WITH CIRCUMFLEX --> -<!ENTITY ecirc "ê" ><!--LATIN SMALL LETTER E WITH CIRCUMFLEX --> -<!ENTITY Egrave "È" ><!--LATIN CAPITAL LETTER E WITH GRAVE --> -<!ENTITY egrave "è" ><!--LATIN SMALL LETTER E WITH GRAVE --> -<!ENTITY ETH "Ð" ><!--LATIN CAPITAL LETTER ETH --> -<!ENTITY eth "ð" ><!--LATIN SMALL LETTER ETH --> -<!ENTITY Euml "Ë" ><!--LATIN CAPITAL LETTER E WITH DIAERESIS --> -<!ENTITY euml "ë" ><!--LATIN SMALL LETTER E WITH DIAERESIS --> -<!ENTITY Iacute "Í" ><!--LATIN CAPITAL LETTER I WITH ACUTE --> -<!ENTITY iacute "í" ><!--LATIN SMALL LETTER I WITH ACUTE --> -<!ENTITY Icirc "Î" ><!--LATIN CAPITAL LETTER I WITH CIRCUMFLEX --> -<!ENTITY icirc "î" ><!--LATIN SMALL LETTER I WITH CIRCUMFLEX --> -<!ENTITY Igrave "Ì" ><!--LATIN CAPITAL LETTER I WITH GRAVE --> -<!ENTITY igrave "ì" ><!--LATIN SMALL LETTER I WITH GRAVE --> -<!ENTITY Iuml "Ï" ><!--LATIN CAPITAL LETTER I WITH DIAERESIS --> -<!ENTITY iuml "ï" ><!--LATIN SMALL LETTER I WITH DIAERESIS --> -<!ENTITY Ntilde "Ñ" ><!--LATIN CAPITAL LETTER N WITH TILDE --> -<!ENTITY ntilde "ñ" ><!--LATIN SMALL LETTER N WITH TILDE --> -<!ENTITY Oacute "Ó" ><!--LATIN CAPITAL LETTER O WITH ACUTE --> -<!ENTITY oacute "ó" ><!--LATIN SMALL LETTER O WITH ACUTE --> -<!ENTITY Ocirc "Ô" ><!--LATIN CAPITAL LETTER O WITH CIRCUMFLEX --> -<!ENTITY ocirc "ô" ><!--LATIN SMALL LETTER O WITH CIRCUMFLEX --> -<!ENTITY Ograve "Ò" ><!--LATIN CAPITAL LETTER O WITH GRAVE --> -<!ENTITY ograve "ò" ><!--LATIN SMALL LETTER O WITH GRAVE --> -<!ENTITY Oslash "Ø" ><!--LATIN CAPITAL LETTER O WITH STROKE --> -<!ENTITY oslash "ø" ><!--LATIN SMALL LETTER O WITH STROKE --> -<!ENTITY Otilde "Õ" ><!--LATIN CAPITAL LETTER O WITH TILDE --> -<!ENTITY otilde "õ" ><!--LATIN SMALL LETTER O WITH TILDE --> -<!ENTITY Ouml "Ö" ><!--LATIN CAPITAL LETTER O WITH DIAERESIS --> -<!ENTITY ouml "ö" ><!--LATIN SMALL LETTER O WITH DIAERESIS --> -<!ENTITY szlig "ß" ><!--LATIN SMALL LETTER SHARP S --> -<!ENTITY THORN "Þ" ><!--LATIN CAPITAL LETTER THORN --> -<!ENTITY thorn "þ" ><!--LATIN SMALL LETTER THORN --> -<!ENTITY Uacute "Ú" ><!--LATIN CAPITAL LETTER U WITH ACUTE --> -<!ENTITY uacute "ú" ><!--LATIN SMALL LETTER U WITH ACUTE --> -<!ENTITY Ucirc "Û" ><!--LATIN CAPITAL LETTER U WITH CIRCUMFLEX --> -<!ENTITY ucirc "û" ><!--LATIN SMALL LETTER U WITH CIRCUMFLEX --> -<!ENTITY Ugrave "Ù" ><!--LATIN CAPITAL LETTER U WITH GRAVE --> -<!ENTITY ugrave "ù" ><!--LATIN SMALL LETTER U WITH GRAVE --> -<!ENTITY Uuml "Ü" ><!--LATIN CAPITAL LETTER U WITH DIAERESIS --> -<!ENTITY uuml "ü" ><!--LATIN SMALL LETTER U WITH DIAERESIS --> -<!ENTITY Yacute "Ý" ><!--LATIN CAPITAL LETTER Y WITH ACUTE --> -<!ENTITY yacute "ý" ><!--LATIN SMALL LETTER Y WITH ACUTE --> -<!ENTITY yuml "ÿ" ><!--LATIN SMALL LETTER Y WITH DIAERESIS --> diff --git a/Utilities/xml/docbook-4.5/ent/isolat2.ent b/Utilities/xml/docbook-4.5/ent/isolat2.ent deleted file mode 100644 index e91ffdb..0000000 --- a/Utilities/xml/docbook-4.5/ent/isolat2.ent +++ /dev/null @@ -1,162 +0,0 @@ - -<!-- - File isolat2.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isolat2.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Added Latin 2//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isolat2.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isolat2 PUBLIC - "ISO 8879:1986//ENTITIES Added Latin 2//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isolat2.ent" - > - %isolat2; - ---> - -<!ENTITY Abreve "Ă" ><!--LATIN CAPITAL LETTER A WITH BREVE --> -<!ENTITY abreve "ă" ><!--LATIN SMALL LETTER A WITH BREVE --> -<!ENTITY Amacr "Ā" ><!--LATIN CAPITAL LETTER A WITH MACRON --> -<!ENTITY amacr "ā" ><!--LATIN SMALL LETTER A WITH MACRON --> -<!ENTITY Aogon "Ą" ><!--LATIN CAPITAL LETTER A WITH OGONEK --> -<!ENTITY aogon "ą" ><!--LATIN SMALL LETTER A WITH OGONEK --> -<!ENTITY Cacute "Ć" ><!--LATIN CAPITAL LETTER C WITH ACUTE --> -<!ENTITY cacute "ć" ><!--LATIN SMALL LETTER C WITH ACUTE --> -<!ENTITY Ccaron "Č" ><!--LATIN CAPITAL LETTER C WITH CARON --> -<!ENTITY ccaron "č" ><!--LATIN SMALL LETTER C WITH CARON --> -<!ENTITY Ccirc "Ĉ" ><!--LATIN CAPITAL LETTER C WITH CIRCUMFLEX --> -<!ENTITY ccirc "ĉ" ><!--LATIN SMALL LETTER C WITH CIRCUMFLEX --> -<!ENTITY Cdot "Ċ" ><!--LATIN CAPITAL LETTER C WITH DOT ABOVE --> -<!ENTITY cdot "ċ" ><!--LATIN SMALL LETTER C WITH DOT ABOVE --> -<!ENTITY Dcaron "Ď" ><!--LATIN CAPITAL LETTER D WITH CARON --> -<!ENTITY dcaron "ď" ><!--LATIN SMALL LETTER D WITH CARON --> -<!ENTITY Dstrok "Đ" ><!--LATIN CAPITAL LETTER D WITH STROKE --> -<!ENTITY dstrok "đ" ><!--LATIN SMALL LETTER D WITH STROKE --> -<!ENTITY Ecaron "Ě" ><!--LATIN CAPITAL LETTER E WITH CARON --> -<!ENTITY ecaron "ě" ><!--LATIN SMALL LETTER E WITH CARON --> -<!ENTITY Edot "Ė" ><!--LATIN CAPITAL LETTER E WITH DOT ABOVE --> -<!ENTITY edot "ė" ><!--LATIN SMALL LETTER E WITH DOT ABOVE --> -<!ENTITY Emacr "Ē" ><!--LATIN CAPITAL LETTER E WITH MACRON --> -<!ENTITY emacr "ē" ><!--LATIN SMALL LETTER E WITH MACRON --> -<!ENTITY ENG "Ŋ" ><!--LATIN CAPITAL LETTER ENG --> -<!ENTITY eng "ŋ" ><!--LATIN SMALL LETTER ENG --> -<!ENTITY Eogon "Ę" ><!--LATIN CAPITAL LETTER E WITH OGONEK --> -<!ENTITY eogon "ę" ><!--LATIN SMALL LETTER E WITH OGONEK --> -<!ENTITY gacute "ǵ" ><!--LATIN SMALL LETTER G WITH ACUTE --> -<!ENTITY Gbreve "Ğ" ><!--LATIN CAPITAL LETTER G WITH BREVE --> -<!ENTITY gbreve "ğ" ><!--LATIN SMALL LETTER G WITH BREVE --> -<!ENTITY Gcedil "Ģ" ><!--LATIN CAPITAL LETTER G WITH CEDILLA --> -<!ENTITY Gcirc "Ĝ" ><!--LATIN CAPITAL LETTER G WITH CIRCUMFLEX --> -<!ENTITY gcirc "ĝ" ><!--LATIN SMALL LETTER G WITH CIRCUMFLEX --> -<!ENTITY Gdot "Ġ" ><!--LATIN CAPITAL LETTER G WITH DOT ABOVE --> -<!ENTITY gdot "ġ" ><!--LATIN SMALL LETTER G WITH DOT ABOVE --> -<!ENTITY Hcirc "Ĥ" ><!--LATIN CAPITAL LETTER H WITH CIRCUMFLEX --> -<!ENTITY hcirc "ĥ" ><!--LATIN SMALL LETTER H WITH CIRCUMFLEX --> -<!ENTITY Hstrok "Ħ" ><!--LATIN CAPITAL LETTER H WITH STROKE --> -<!ENTITY hstrok "ħ" ><!--LATIN SMALL LETTER H WITH STROKE --> -<!ENTITY Idot "İ" ><!--LATIN CAPITAL LETTER I WITH DOT ABOVE --> -<!ENTITY IJlig "IJ" ><!--LATIN CAPITAL LIGATURE IJ --> -<!ENTITY ijlig "ij" ><!--LATIN SMALL LIGATURE IJ --> -<!ENTITY Imacr "Ī" ><!--LATIN CAPITAL LETTER I WITH MACRON --> -<!ENTITY imacr "ī" ><!--LATIN SMALL LETTER I WITH MACRON --> -<!ENTITY inodot "ı" ><!--LATIN SMALL LETTER DOTLESS I --> -<!ENTITY Iogon "Į" ><!--LATIN CAPITAL LETTER I WITH OGONEK --> -<!ENTITY iogon "į" ><!--LATIN SMALL LETTER I WITH OGONEK --> -<!ENTITY Itilde "Ĩ" ><!--LATIN CAPITAL LETTER I WITH TILDE --> -<!ENTITY itilde "ĩ" ><!--LATIN SMALL LETTER I WITH TILDE --> -<!ENTITY Jcirc "Ĵ" ><!--LATIN CAPITAL LETTER J WITH CIRCUMFLEX --> -<!ENTITY jcirc "ĵ" ><!--LATIN SMALL LETTER J WITH CIRCUMFLEX --> -<!ENTITY Kcedil "Ķ" ><!--LATIN CAPITAL LETTER K WITH CEDILLA --> -<!ENTITY kcedil "ķ" ><!--LATIN SMALL LETTER K WITH CEDILLA --> -<!ENTITY kgreen "ĸ" ><!--LATIN SMALL LETTER KRA --> -<!ENTITY Lacute "Ĺ" ><!--LATIN CAPITAL LETTER L WITH ACUTE --> -<!ENTITY lacute "ĺ" ><!--LATIN SMALL LETTER L WITH ACUTE --> -<!ENTITY Lcaron "Ľ" ><!--LATIN CAPITAL LETTER L WITH CARON --> -<!ENTITY lcaron "ľ" ><!--LATIN SMALL LETTER L WITH CARON --> -<!ENTITY Lcedil "Ļ" ><!--LATIN CAPITAL LETTER L WITH CEDILLA --> -<!ENTITY lcedil "ļ" ><!--LATIN SMALL LETTER L WITH CEDILLA --> -<!ENTITY Lmidot "Ŀ" ><!--LATIN CAPITAL LETTER L WITH MIDDLE DOT --> -<!ENTITY lmidot "ŀ" ><!--LATIN SMALL LETTER L WITH MIDDLE DOT --> -<!ENTITY Lstrok "Ł" ><!--LATIN CAPITAL LETTER L WITH STROKE --> -<!ENTITY lstrok "ł" ><!--LATIN SMALL LETTER L WITH STROKE --> -<!ENTITY Nacute "Ń" ><!--LATIN CAPITAL LETTER N WITH ACUTE --> -<!ENTITY nacute "ń" ><!--LATIN SMALL LETTER N WITH ACUTE --> -<!ENTITY napos "ʼn" ><!--LATIN SMALL LETTER N PRECEDED BY APOSTROPHE --> -<!ENTITY Ncaron "Ň" ><!--LATIN CAPITAL LETTER N WITH CARON --> -<!ENTITY ncaron "ň" ><!--LATIN SMALL LETTER N WITH CARON --> -<!ENTITY Ncedil "Ņ" ><!--LATIN CAPITAL LETTER N WITH CEDILLA --> -<!ENTITY ncedil "ņ" ><!--LATIN SMALL LETTER N WITH CEDILLA --> -<!ENTITY Odblac "Ő" ><!--LATIN CAPITAL LETTER O WITH DOUBLE ACUTE --> -<!ENTITY odblac "ő" ><!--LATIN SMALL LETTER O WITH DOUBLE ACUTE --> -<!ENTITY OElig "Œ" ><!--LATIN CAPITAL LIGATURE OE --> -<!ENTITY oelig "œ" ><!--LATIN SMALL LIGATURE OE --> -<!ENTITY Omacr "Ō" ><!--LATIN CAPITAL LETTER O WITH MACRON --> -<!ENTITY omacr "ō" ><!--LATIN SMALL LETTER O WITH MACRON --> -<!ENTITY Racute "Ŕ" ><!--LATIN CAPITAL LETTER R WITH ACUTE --> -<!ENTITY racute "ŕ" ><!--LATIN SMALL LETTER R WITH ACUTE --> -<!ENTITY Rcaron "Ř" ><!--LATIN CAPITAL LETTER R WITH CARON --> -<!ENTITY rcaron "ř" ><!--LATIN SMALL LETTER R WITH CARON --> -<!ENTITY Rcedil "Ŗ" ><!--LATIN CAPITAL LETTER R WITH CEDILLA --> -<!ENTITY rcedil "ŗ" ><!--LATIN SMALL LETTER R WITH CEDILLA --> -<!ENTITY Sacute "Ś" ><!--LATIN CAPITAL LETTER S WITH ACUTE --> -<!ENTITY sacute "ś" ><!--LATIN SMALL LETTER S WITH ACUTE --> -<!ENTITY Scaron "Š" ><!--LATIN CAPITAL LETTER S WITH CARON --> -<!ENTITY scaron "š" ><!--LATIN SMALL LETTER S WITH CARON --> -<!ENTITY Scedil "Ş" ><!--LATIN CAPITAL LETTER S WITH CEDILLA --> -<!ENTITY scedil "ş" ><!--LATIN SMALL LETTER S WITH CEDILLA --> -<!ENTITY Scirc "Ŝ" ><!--LATIN CAPITAL LETTER S WITH CIRCUMFLEX --> -<!ENTITY scirc "ŝ" ><!--LATIN SMALL LETTER S WITH CIRCUMFLEX --> -<!ENTITY Tcaron "Ť" ><!--LATIN CAPITAL LETTER T WITH CARON --> -<!ENTITY tcaron "ť" ><!--LATIN SMALL LETTER T WITH CARON --> -<!ENTITY Tcedil "Ţ" ><!--LATIN CAPITAL LETTER T WITH CEDILLA --> -<!ENTITY tcedil "ţ" ><!--LATIN SMALL LETTER T WITH CEDILLA --> -<!ENTITY Tstrok "Ŧ" ><!--LATIN CAPITAL LETTER T WITH STROKE --> -<!ENTITY tstrok "ŧ" ><!--LATIN SMALL LETTER T WITH STROKE --> -<!ENTITY Ubreve "Ŭ" ><!--LATIN CAPITAL LETTER U WITH BREVE --> -<!ENTITY ubreve "ŭ" ><!--LATIN SMALL LETTER U WITH BREVE --> -<!ENTITY Udblac "Ű" ><!--LATIN CAPITAL LETTER U WITH DOUBLE ACUTE --> -<!ENTITY udblac "ű" ><!--LATIN SMALL LETTER U WITH DOUBLE ACUTE --> -<!ENTITY Umacr "Ū" ><!--LATIN CAPITAL LETTER U WITH MACRON --> -<!ENTITY umacr "ū" ><!--LATIN SMALL LETTER U WITH MACRON --> -<!ENTITY Uogon "Ų" ><!--LATIN CAPITAL LETTER U WITH OGONEK --> -<!ENTITY uogon "ų" ><!--LATIN SMALL LETTER U WITH OGONEK --> -<!ENTITY Uring "Ů" ><!--LATIN CAPITAL LETTER U WITH RING ABOVE --> -<!ENTITY uring "ů" ><!--LATIN SMALL LETTER U WITH RING ABOVE --> -<!ENTITY Utilde "Ũ" ><!--LATIN CAPITAL LETTER U WITH TILDE --> -<!ENTITY utilde "ũ" ><!--LATIN SMALL LETTER U WITH TILDE --> -<!ENTITY Wcirc "Ŵ" ><!--LATIN CAPITAL LETTER W WITH CIRCUMFLEX --> -<!ENTITY wcirc "ŵ" ><!--LATIN SMALL LETTER W WITH CIRCUMFLEX --> -<!ENTITY Ycirc "Ŷ" ><!--LATIN CAPITAL LETTER Y WITH CIRCUMFLEX --> -<!ENTITY ycirc "ŷ" ><!--LATIN SMALL LETTER Y WITH CIRCUMFLEX --> -<!ENTITY Yuml "Ÿ" ><!--LATIN CAPITAL LETTER Y WITH DIAERESIS --> -<!ENTITY Zacute "Ź" ><!--LATIN CAPITAL LETTER Z WITH ACUTE --> -<!ENTITY zacute "ź" ><!--LATIN SMALL LETTER Z WITH ACUTE --> -<!ENTITY Zcaron "Ž" ><!--LATIN CAPITAL LETTER Z WITH CARON --> -<!ENTITY zcaron "ž" ><!--LATIN SMALL LETTER Z WITH CARON --> -<!ENTITY Zdot "Ż" ><!--LATIN CAPITAL LETTER Z WITH DOT ABOVE --> -<!ENTITY zdot "ż" ><!--LATIN SMALL LETTER Z WITH DOT ABOVE --> diff --git a/Utilities/xml/docbook-4.5/ent/isonum.ent b/Utilities/xml/docbook-4.5/ent/isonum.ent deleted file mode 100644 index 884c0c4..0000000 --- a/Utilities/xml/docbook-4.5/ent/isonum.ent +++ /dev/null @@ -1,117 +0,0 @@ - -<!-- - File isonum.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isonum.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isonum.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isonum PUBLIC - "ISO 8879:1986//ENTITIES Numeric and Special Graphic//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isonum.ent" - > - %isonum; - ---> - -<!ENTITY amp "&#38;" ><!--AMPERSAND --> -<!ENTITY apos "'" ><!--APOSTROPHE --> -<!ENTITY ast "*" ><!--ASTERISK --> -<!ENTITY brvbar "¦" ><!--BROKEN BAR --> -<!ENTITY bsol "\" ><!--REVERSE SOLIDUS --> -<!ENTITY cent "¢" ><!--CENT SIGN --> -<!ENTITY colon ":" ><!--COLON --> -<!ENTITY comma "," ><!--COMMA --> -<!ENTITY commat "@" ><!--COMMERCIAL AT --> -<!ENTITY copy "©" ><!--COPYRIGHT SIGN --> -<!ENTITY curren "¤" ><!--CURRENCY SIGN --> -<!ENTITY darr "↓" ><!--DOWNWARDS ARROW --> -<!ENTITY deg "°" ><!--DEGREE SIGN --> -<!ENTITY divide "÷" ><!--DIVISION SIGN --> -<!ENTITY dollar "$" ><!--DOLLAR SIGN --> -<!ENTITY equals "=" ><!--EQUALS SIGN --> -<!ENTITY excl "!" ><!--EXCLAMATION MARK --> -<!ENTITY frac12 "½" ><!--VULGAR FRACTION ONE HALF --> -<!ENTITY frac14 "¼" ><!--VULGAR FRACTION ONE QUARTER --> -<!ENTITY frac18 "⅛" ><!--VULGAR FRACTION ONE EIGHTH --> -<!ENTITY frac34 "¾" ><!--VULGAR FRACTION THREE QUARTERS --> -<!ENTITY frac38 "⅜" ><!--VULGAR FRACTION THREE EIGHTHS --> -<!ENTITY frac58 "⅝" ><!--VULGAR FRACTION FIVE EIGHTHS --> -<!ENTITY frac78 "⅞" ><!--VULGAR FRACTION SEVEN EIGHTHS --> -<!ENTITY gt ">" ><!--GREATER-THAN SIGN --> -<!ENTITY half "½" ><!--VULGAR FRACTION ONE HALF --> -<!ENTITY horbar "―" ><!--HORIZONTAL BAR --> -<!ENTITY hyphen "‐" ><!--HYPHEN --> -<!ENTITY iexcl "¡" ><!--INVERTED EXCLAMATION MARK --> -<!ENTITY iquest "¿" ><!--INVERTED QUESTION MARK --> -<!ENTITY laquo "«" ><!--LEFT-POINTING DOUBLE ANGLE QUOTATION MARK --> -<!ENTITY larr "←" ><!--LEFTWARDS ARROW --> -<!ENTITY lcub "{" ><!--LEFT CURLY BRACKET --> -<!ENTITY ldquo "“" ><!--LEFT DOUBLE QUOTATION MARK --> -<!ENTITY lowbar "_" ><!--LOW LINE --> -<!ENTITY lpar "(" ><!--LEFT PARENTHESIS --> -<!ENTITY lsqb "[" ><!--LEFT SQUARE BRACKET --> -<!ENTITY lsquo "‘" ><!--LEFT SINGLE QUOTATION MARK --> -<!ENTITY lt "&#60;" ><!--LESS-THAN SIGN --> -<!ENTITY micro "µ" ><!--MICRO SIGN --> -<!ENTITY middot "·" ><!--MIDDLE DOT --> -<!ENTITY nbsp " " ><!--NO-BREAK SPACE --> -<!ENTITY not "¬" ><!--NOT SIGN --> -<!ENTITY num "#" ><!--NUMBER SIGN --> -<!ENTITY ohm "Ω" ><!--OHM SIGN --> -<!ENTITY ordf "ª" ><!--FEMININE ORDINAL INDICATOR --> -<!ENTITY ordm "º" ><!--MASCULINE ORDINAL INDICATOR --> -<!ENTITY para "¶" ><!--PILCROW SIGN --> -<!ENTITY percnt "%" ><!--PERCENT SIGN --> -<!ENTITY period "." ><!--FULL STOP --> -<!ENTITY plus "+" ><!--PLUS SIGN --> -<!ENTITY plusmn "±" ><!--PLUS-MINUS SIGN --> -<!ENTITY pound "£" ><!--POUND SIGN --> -<!ENTITY quest "?" ><!--QUESTION MARK --> -<!ENTITY quot """ ><!--QUOTATION MARK --> -<!ENTITY raquo "»" ><!--RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK --> -<!ENTITY rarr "→" ><!--RIGHTWARDS ARROW --> -<!ENTITY rcub "}" ><!--RIGHT CURLY BRACKET --> -<!ENTITY rdquo "”" ><!--RIGHT DOUBLE QUOTATION MARK --> -<!ENTITY reg "®" ><!--REGISTERED SIGN --> -<!ENTITY rpar ")" ><!--RIGHT PARENTHESIS --> -<!ENTITY rsqb "]" ><!--RIGHT SQUARE BRACKET --> -<!ENTITY rsquo "’" ><!--RIGHT SINGLE QUOTATION MARK --> -<!ENTITY sect "§" ><!--SECTION SIGN --> -<!ENTITY semi ";" ><!--SEMICOLON --> -<!ENTITY shy "­" ><!--SOFT HYPHEN --> -<!ENTITY sol "/" ><!--SOLIDUS --> -<!ENTITY sung "♪" ><!--EIGHTH NOTE --> -<!ENTITY sup1 "¹" ><!--SUPERSCRIPT ONE --> -<!ENTITY sup2 "²" ><!--SUPERSCRIPT TWO --> -<!ENTITY sup3 "³" ><!--SUPERSCRIPT THREE --> -<!ENTITY times "×" ><!--MULTIPLICATION SIGN --> -<!ENTITY trade "™" ><!--TRADE MARK SIGN --> -<!ENTITY uarr "↑" ><!--UPWARDS ARROW --> -<!ENTITY verbar "|" ><!--VERTICAL LINE --> -<!ENTITY yen "¥" ><!--YEN SIGN --> diff --git a/Utilities/xml/docbook-4.5/ent/isopub.ent b/Utilities/xml/docbook-4.5/ent/isopub.ent deleted file mode 100644 index a117878..0000000 --- a/Utilities/xml/docbook-4.5/ent/isopub.ent +++ /dev/null @@ -1,125 +0,0 @@ - -<!-- - File isopub.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isopub.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES Publishing//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isopub.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isopub PUBLIC - "ISO 8879:1986//ENTITIES Publishing//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isopub.ent" - > - %isopub; - ---> - -<!ENTITY blank "␣" ><!--OPEN BOX --> -<!ENTITY blk12 "▒" ><!--MEDIUM SHADE --> -<!ENTITY blk14 "░" ><!--LIGHT SHADE --> -<!ENTITY blk34 "▓" ><!--DARK SHADE --> -<!ENTITY block "█" ><!--FULL BLOCK --> -<!ENTITY bull "•" ><!--BULLET --> -<!ENTITY caret "⁁" ><!--CARET INSERTION POINT --> -<!ENTITY check "✓" ><!--CHECK MARK --> -<!ENTITY cir "○" ><!--WHITE CIRCLE --> -<!ENTITY clubs "♣" ><!--BLACK CLUB SUIT --> -<!ENTITY copysr "℗" ><!--SOUND RECORDING COPYRIGHT --> -<!ENTITY cross "✗" ><!--BALLOT X --> -<!ENTITY Dagger "‡" ><!--DOUBLE DAGGER --> -<!ENTITY dagger "†" ><!--DAGGER --> -<!ENTITY dash "‐" ><!--HYPHEN --> -<!ENTITY diams "♦" ><!--BLACK DIAMOND SUIT --> -<!ENTITY dlcrop "⌍" ><!--BOTTOM LEFT CROP --> -<!ENTITY drcrop "⌌" ><!--BOTTOM RIGHT CROP --> -<!ENTITY dtri "▿" ><!--WHITE DOWN-POINTING SMALL TRIANGLE --> -<!ENTITY dtrif "▾" ><!--BLACK DOWN-POINTING SMALL TRIANGLE --> -<!ENTITY emsp " " ><!--EM SPACE --> -<!ENTITY emsp13 " " ><!--THREE-PER-EM SPACE --> -<!ENTITY emsp14 " " ><!--FOUR-PER-EM SPACE --> -<!ENTITY ensp " " ><!--EN SPACE --> -<!ENTITY female "♀" ><!--FEMALE SIGN --> -<!ENTITY ffilig "ffi" ><!--LATIN SMALL LIGATURE FFI --> -<!ENTITY fflig "ff" ><!--LATIN SMALL LIGATURE FF --> -<!ENTITY ffllig "ffl" ><!--LATIN SMALL LIGATURE FFL --> -<!ENTITY filig "fi" ><!--LATIN SMALL LIGATURE FI --> -<!ENTITY flat "♭" ><!--MUSIC FLAT SIGN --> -<!ENTITY fllig "fl" ><!--LATIN SMALL LIGATURE FL --> -<!ENTITY frac13 "⅓" ><!--VULGAR FRACTION ONE THIRD --> -<!ENTITY frac15 "⅕" ><!--VULGAR FRACTION ONE FIFTH --> -<!ENTITY frac16 "⅙" ><!--VULGAR FRACTION ONE SIXTH --> -<!ENTITY frac23 "⅔" ><!--VULGAR FRACTION TWO THIRDS --> -<!ENTITY frac25 "⅖" ><!--VULGAR FRACTION TWO FIFTHS --> -<!ENTITY frac35 "⅗" ><!--VULGAR FRACTION THREE FIFTHS --> -<!ENTITY frac45 "⅘" ><!--VULGAR FRACTION FOUR FIFTHS --> -<!ENTITY frac56 "⅚" ><!--VULGAR FRACTION FIVE SIXTHS --> -<!ENTITY hairsp " " ><!--HAIR SPACE --> -<!ENTITY hearts "♥" ><!--BLACK HEART SUIT --> -<!ENTITY hellip "…" ><!--HORIZONTAL ELLIPSIS --> -<!ENTITY hybull "⁃" ><!--HYPHEN BULLET --> -<!ENTITY incare "℅" ><!--CARE OF --> -<!ENTITY ldquor "„" ><!--DOUBLE LOW-9 QUOTATION MARK --> -<!ENTITY lhblk "▄" ><!--LOWER HALF BLOCK --> -<!ENTITY loz "◊" ><!--LOZENGE --> -<!ENTITY lozf "⧫" ><!--BLACK LOZENGE --> -<!ENTITY lsquor "‚" ><!--SINGLE LOW-9 QUOTATION MARK --> -<!ENTITY ltri "◃" ><!--WHITE LEFT-POINTING SMALL TRIANGLE --> -<!ENTITY ltrif "◂" ><!--BLACK LEFT-POINTING SMALL TRIANGLE --> -<!ENTITY male "♂" ><!--MALE SIGN --> -<!ENTITY malt "✠" ><!--MALTESE CROSS --> -<!ENTITY marker "▮" ><!--BLACK VERTICAL RECTANGLE --> -<!ENTITY mdash "—" ><!--EM DASH --> -<!ENTITY mldr "…" ><!--HORIZONTAL ELLIPSIS --> -<!ENTITY natur "♮" ><!--MUSIC NATURAL SIGN --> -<!ENTITY ndash "–" ><!--EN DASH --> -<!ENTITY nldr "‥" ><!--TWO DOT LEADER --> -<!ENTITY numsp " " ><!--FIGURE SPACE --> -<!ENTITY phone "☎" ><!--BLACK TELEPHONE --> -<!ENTITY puncsp " " ><!--PUNCTUATION SPACE --> -<!ENTITY rdquor "”" ><!--RIGHT DOUBLE QUOTATION MARK --> -<!ENTITY rect "▭" ><!--WHITE RECTANGLE --> -<!ENTITY rsquor "’" ><!--RIGHT SINGLE QUOTATION MARK --> -<!ENTITY rtri "▹" ><!--WHITE RIGHT-POINTING SMALL TRIANGLE --> -<!ENTITY rtrif "▸" ><!--BLACK RIGHT-POINTING SMALL TRIANGLE --> -<!ENTITY rx "℞" ><!--PRESCRIPTION TAKE --> -<!ENTITY sext "✶" ><!--SIX POINTED BLACK STAR --> -<!ENTITY sharp "♯" ><!--MUSIC SHARP SIGN --> -<!ENTITY spades "♠" ><!--BLACK SPADE SUIT --> -<!ENTITY squ "□" ><!--WHITE SQUARE --> -<!ENTITY squf "▪" ><!--BLACK SMALL SQUARE --> -<!ENTITY star "☆" ><!--WHITE STAR --> -<!ENTITY starf "★" ><!--BLACK STAR --> -<!ENTITY target "⌖" ><!--POSITION INDICATOR --> -<!ENTITY telrec "⌕" ><!--TELEPHONE RECORDER --> -<!ENTITY thinsp " " ><!--THIN SPACE --> -<!ENTITY uhblk "▀" ><!--UPPER HALF BLOCK --> -<!ENTITY ulcrop "⌏" ><!--TOP LEFT CROP --> -<!ENTITY urcrop "⌎" ><!--TOP RIGHT CROP --> -<!ENTITY utri "▵" ><!--WHITE UP-POINTING SMALL TRIANGLE --> -<!ENTITY utrif "▴" ><!--BLACK UP-POINTING SMALL TRIANGLE --> -<!ENTITY vellip "⋮" ><!--VERTICAL ELLIPSIS --> diff --git a/Utilities/xml/docbook-4.5/ent/isotech.ent b/Utilities/xml/docbook-4.5/ent/isotech.ent deleted file mode 100644 index 07e8100..0000000 --- a/Utilities/xml/docbook-4.5/ent/isotech.ent +++ /dev/null @@ -1,103 +0,0 @@ - -<!-- - File isotech.ent produced by the XSL script entities.xsl - from input data in unicode.xml. - - Please report any errors to David Carlisle - via the public W3C list www-math@w3.org. - - The numeric character values assigned to each entity - (should) match the Unicode assignments in Unicode 4.0. - - Entity names in this file are derived from files carrying the - following notice: - - (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. - ---> - - -<!-- - Version: $Id: isotech.ent,v 1.2 2003/12/08 15:14:43 davidc Exp $ - - Public identifier: ISO 8879:1986//ENTITIES General Technical//EN//XML - System identifier: http://www.w3.org/2003/entities/iso8879/isotech.ent - - The public identifier should always be used verbatim. - The system identifier may be changed to suit local requirements. - - Typical invocation: - - <!ENTITY % isotech PUBLIC - "ISO 8879:1986//ENTITIES General Technical//EN//XML" - "http://www.w3.org/2003/entities/iso8879/isotech.ent" - > - %isotech; - ---> - -<!ENTITY aleph "ℵ" ><!--ALEF SYMBOL --> -<!ENTITY and "∧" ><!--LOGICAL AND --> -<!ENTITY ang90 "∟" ><!--RIGHT ANGLE --> -<!ENTITY angsph "∢" ><!--SPHERICAL ANGLE --> -<!ENTITY angst "Å" ><!--ANGSTROM SIGN --> -<!ENTITY ap "≈" ><!--ALMOST EQUAL TO --> -<!ENTITY becaus "∵" ><!--BECAUSE --> -<!ENTITY bernou "ℬ" ><!--SCRIPT CAPITAL B --> -<!ENTITY bottom "⊥" ><!--UP TACK --> -<!ENTITY cap "∩" ><!--INTERSECTION --> -<!ENTITY compfn "∘" ><!--RING OPERATOR --> -<!ENTITY cong "≅" ><!--APPROXIMATELY EQUAL TO --> -<!ENTITY conint "∮" ><!--CONTOUR INTEGRAL --> -<!ENTITY cup "∪" ><!--UNION --> -<!ENTITY Dot "¨" ><!--DIAERESIS --> -<!ENTITY DotDot " ⃜" ><!--COMBINING FOUR DOTS ABOVE --> -<!ENTITY equiv "≡" ><!--IDENTICAL TO --> -<!ENTITY exist "∃" ><!--THERE EXISTS --> -<!ENTITY fnof "ƒ" ><!--LATIN SMALL LETTER F WITH HOOK --> -<!ENTITY forall "∀" ><!--FOR ALL --> -<!ENTITY ge "≥" ><!--GREATER-THAN OR EQUAL TO --> -<!ENTITY hamilt "ℋ" ><!--SCRIPT CAPITAL H --> -<!ENTITY iff "⇔" ><!--LEFT RIGHT DOUBLE ARROW --> -<!ENTITY infin "∞" ><!--INFINITY --> -<!ENTITY int "∫" ><!--INTEGRAL --> -<!ENTITY isin "∈" ><!--ELEMENT OF --> -<!ENTITY lagran "ℒ" ><!--SCRIPT CAPITAL L --> -<!ENTITY lang "〈" ><!--LEFT-POINTING ANGLE BRACKET --> -<!ENTITY lArr "⇐" ><!--LEFTWARDS DOUBLE ARROW --> -<!ENTITY le "≤" ><!--LESS-THAN OR EQUAL TO --> -<!ENTITY lowast "∗" ><!--ASTERISK OPERATOR --> -<!ENTITY minus "−" ><!--MINUS SIGN --> -<!ENTITY mnplus "∓" ><!--MINUS-OR-PLUS SIGN --> -<!ENTITY nabla "∇" ><!--NABLA --> -<!ENTITY ne "≠" ><!--NOT EQUAL TO --> -<!ENTITY ni "∋" ><!--CONTAINS AS MEMBER --> -<!ENTITY notin "∉" ><!--NOT AN ELEMENT OF --> -<!ENTITY or "∨" ><!--LOGICAL OR --> -<!ENTITY order "ℴ" ><!--SCRIPT SMALL O --> -<!ENTITY par "∥" ><!--PARALLEL TO --> -<!ENTITY part "∂" ><!--PARTIAL DIFFERENTIAL --> -<!ENTITY permil "‰" ><!--PER MILLE SIGN --> -<!ENTITY perp "⊥" ><!--UP TACK --> -<!ENTITY phmmat "ℳ" ><!--SCRIPT CAPITAL M --> -<!ENTITY Prime "″" ><!--DOUBLE PRIME --> -<!ENTITY prime "′" ><!--PRIME --> -<!ENTITY prop "∝" ><!--PROPORTIONAL TO --> -<!ENTITY radic "√" ><!--SQUARE ROOT --> -<!ENTITY rang "〉" ><!--RIGHT-POINTING ANGLE BRACKET --> -<!ENTITY rArr "⇒" ><!--RIGHTWARDS DOUBLE ARROW --> -<!ENTITY sim "∼" ><!--TILDE OPERATOR --> -<!ENTITY sime "≃" ><!--ASYMPTOTICALLY EQUAL TO --> -<!ENTITY square "□" ><!--WHITE SQUARE --> -<!ENTITY sub "⊂" ><!--SUBSET OF --> -<!ENTITY sube "⊆" ><!--SUBSET OF OR EQUAL TO --> -<!ENTITY sup "⊃" ><!--SUPERSET OF --> -<!ENTITY supe "⊇" ><!--SUPERSET OF OR EQUAL TO --> -<!ENTITY tdot " ⃛" ><!--COMBINING THREE DOTS ABOVE --> -<!ENTITY there4 "∴" ><!--THEREFORE --> -<!ENTITY tprime "‴" ><!--TRIPLE PRIME --> -<!ENTITY Verbar "‖" ><!--DOUBLE VERTICAL LINE --> -<!ENTITY wedgeq "≙" ><!--ESTIMATES --> diff --git a/Utilities/xml/docbook-4.5/htmltblx.mod b/Utilities/xml/docbook-4.5/htmltblx.mod deleted file mode 100644 index cdaefed..0000000 --- a/Utilities/xml/docbook-4.5/htmltblx.mod +++ /dev/null @@ -1,245 +0,0 @@ -<!-- ...................................................................... --> -<!-- DocBook XML HTML Table Module V4.5 ................................... --> -<!-- File htmltblx.mod .................................................... --> - -<!-- Copyright 2003-2006 ArborText, Inc., Norman Walsh, Sun Microsystems, - Inc., and the Organization for the Advancement of Structured Information - Standards (OASIS). - - $Id: htmltblx.mod 6340 2006-10-03 13:23:24Z nwalsh $ - - Permission to use, copy, modify and distribute the DocBook XML DTD - and its accompanying documentation for any purpose and without fee - is hereby granted in perpetuity, provided that the above copyright - notice and this paragraph appear in all copies. The copyright - holders make no representation about the suitability of the DTD for - any purpose. It is provided "as is" without expressed or implied - warranty. - - If you modify the DocBook XML DTD in any way, except for declaring and - referencing additional sets of general entities and declaring - additional notations, label your DTD as a variant of DocBook. See - the maintenance documentation for more information. - - Please direct all questions, bug reports, or suggestions for - changes to the docbook@lists.oasis-open.org mailing list. For more - information, see http://www.oasis-open.org/docbook/. ---> - -<!-- ...................................................................... --> - -<!-- This module contains the definitions for elements that are - isomorphic to the HTML elements. One could argue we should - instead have based ourselves on the XHTML Table Module, but the - HTML one is more like what browsers are likely to accept today - and users are likely to use. - - This module has been developed for use with the DocBook V4.5 - "union table model" in which elements and attlists common to both - models are defined (as the union) in the CALS table module by - setting various parameter entities appropriately in this file. - - In DTD driver files referring to this module, please use an entity - declaration that uses the public identifier shown below: - - <!ENTITY % htmltbl PUBLIC - "-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" - "htmltblx.mod"> - %htmltbl; - - See the documentation for detailed information on the parameter - entity and module scheme used in DocBook, customizing DocBook and - planning for interchange, and changes made since the last release - of DocBook. ---> - -<!--======================= XHTML Tables =======================================--> - -<!ENTITY % html.coreattrs - "%common.attrib; - class CDATA #IMPLIED - style CDATA #IMPLIED - title CDATA #IMPLIED" - > - -<!-- Does not contain lang or dir because they are in %common.attribs --> -<![%sgml.features;[ -<!ENTITY % i18n ""> -]]> -<!ENTITY % i18n - "xml:lang NMTOKEN #IMPLIED" - > - -<!ENTITY % events - "onclick CDATA #IMPLIED - ondblclick CDATA #IMPLIED - onmousedown CDATA #IMPLIED - onmouseup CDATA #IMPLIED - onmouseover CDATA #IMPLIED - onmousemove CDATA #IMPLIED - onmouseout CDATA #IMPLIED - onkeypress CDATA #IMPLIED - onkeydown CDATA #IMPLIED - onkeyup CDATA #IMPLIED" - > - -<!ENTITY % attrs "%html.coreattrs; %i18n; %events;"> - -<!ENTITY % cellhalign - "align (left|center|right|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff CDATA #IMPLIED" - > - -<!ENTITY % cellvalign - "valign (top|middle|bottom|baseline) #IMPLIED" - > - -<!--doc:A group of columns in an HTML table.--> -<!ELEMENT colgroup %ho; (col)*> -<!--doc:Specifications for a column in an HTML table.--> -<!ELEMENT col %ho; EMPTY> -<!--doc:A row in an HTML table.--> -<!ELEMENT tr %ho; (th|td)+> -<!--doc:A table header entry in an HTML table.--> -<!ELEMENT th %ho; (%para.char.mix; | %tabentry.mix; | table | informaltable)*> -<!--doc:A table ntry in an HTML table.--> -<!ELEMENT td %ho; (%para.char.mix; | %tabentry.mix; | table | informaltable)*> - -<!ATTLIST colgroup - %attrs; - span CDATA "1" - width CDATA #IMPLIED - %cellhalign; - %cellvalign; - > - -<!ATTLIST col - %attrs; - span CDATA "1" - width CDATA #IMPLIED - %cellhalign; - %cellvalign; - > - -<!ATTLIST tr - %attrs; - %cellhalign; - %cellvalign; - bgcolor CDATA #IMPLIED - > - -<!ATTLIST th - %attrs; - abbr CDATA #IMPLIED - axis CDATA #IMPLIED - headers IDREFS #IMPLIED - scope (row|col|rowgroup|colgroup) #IMPLIED - rowspan CDATA "1" - colspan CDATA "1" - %cellhalign; - %cellvalign; - nowrap (nowrap) #IMPLIED - bgcolor CDATA #IMPLIED - width CDATA #IMPLIED - height CDATA #IMPLIED - > - -<!ATTLIST td - %attrs; - abbr CDATA #IMPLIED - axis CDATA #IMPLIED - headers IDREFS #IMPLIED - scope (row|col|rowgroup|colgroup) #IMPLIED - rowspan CDATA "1" - colspan CDATA "1" - %cellhalign; - %cellvalign; - nowrap (nowrap) #IMPLIED - bgcolor CDATA #IMPLIED - width CDATA #IMPLIED - height CDATA #IMPLIED - > - -<!-- ====================================================== --> -<!-- Set up to read in the CALS model configured to - merge with the XHTML table model --> -<!-- ====================================================== --> - -<!ENTITY % tables.role.attrib "%role.attrib;"> - -<!-- Add label and role attributes to table and informaltable --> -<!ENTITY % bodyatt " - floatstyle CDATA #IMPLIED - rowheader (firstcol|norowheader) #IMPLIED - %label.attrib;" -> - -<!-- Add common attributes to Table, TGroup, TBody, THead, TFoot, Row, - EntryTbl, and Entry (and InformalTable element). --> - -<!ENTITY % secur " - %common.attrib; - class CDATA #IMPLIED - style CDATA #IMPLIED - title CDATA #IMPLIED - %i18n; - %events; - %tables.role.attrib;"> - -<!ENTITY % common.table.attribs - "%bodyatt; - %secur;"> - -<!-- Content model for Table (that also allows HTML tables) --> -<!ENTITY % tbl.table.mdl - "((blockinfo?, - (%formalobject.title.content;), - (%ndxterm.class;)*, - textobject*, - (graphic+|mediaobject+|tgroup+)) - |(caption, (col*|colgroup*), thead?, tfoot?, (tbody+|tr+)))"> - -<!ENTITY % informal.tbl.table.mdl - "(textobject*, - (graphic+|mediaobject+|tgroup+)) - | ((col*|colgroup*), thead?, tfoot?, (tbody+|tr+))"> - -<!-- Attributes for Table (including HTML ones) --> - -<!-- N.B. rules = (none | groups | rows | cols | all) but it can't be spec'd --> -<!-- that way because 'all' already occurs in a different enumeration in --> -<!-- CALS tables (frame). --> - -<!ENTITY % tbl.table.att ' - tabstyle CDATA #IMPLIED - tocentry %yesorno.attvals; #IMPLIED - shortentry %yesorno.attvals; #IMPLIED - orient (port|land) #IMPLIED - pgwide %yesorno.attvals; #IMPLIED - summary CDATA #IMPLIED - width CDATA #IMPLIED - border CDATA #IMPLIED - rules CDATA #IMPLIED - cellspacing CDATA #IMPLIED - cellpadding CDATA #IMPLIED - align (left|center|right) #IMPLIED - bgcolor CDATA #IMPLIED -'> - -<!ENTITY % tbl.frame.attval "void|above|below|hsides|lhs|rhs|vsides|box|border| -top|bottom|topbot|all|sides|none"> - -<!-- Allow either objects or inlines; beware of REs between elements. --> -<!ENTITY % tbl.entry.mdl "%para.char.mix; | %tabentry.mix;"> - -<!-- thead, tfoot, and tbody are defined in both table models, - so we set up parameter entities to define union models for them - --> - -<!ENTITY % tbl.hdft.mdl "(tr+|(colspec*,row+))"> -<!ENTITY % tbl.tbody.mdl "(tr+|row+)"> -<!ENTITY % tbl.valign.attval "top|middle|bottom|baseline"> - -<!-- End of DocBook XML HTML Table Module V4.5 ............................ --> -<!-- ...................................................................... --> diff --git a/Utilities/xml/docbook-4.5/soextblx.dtd b/Utilities/xml/docbook-4.5/soextblx.dtd deleted file mode 100644 index 4a92e11..0000000 --- a/Utilities/xml/docbook-4.5/soextblx.dtd +++ /dev/null @@ -1,321 +0,0 @@ -<!-- XML EXCHANGE TABLE MODEL DECLARATION MODULE --> - -<!-- This set of declarations defines the XML version of the Exchange - Table Model as of the date shown in the Formal Public Identifier - (FPI) for this entity. - - This set of declarations may be referred to using a public external - entity declaration and reference as shown in the following three - lines: - - <!ENTITY % calstblx - PUBLIC "-//OASIS//DTD XML Exchange Table Model 19990315//EN"> - %calstblx; - - If various parameter entities used within this set of declarations - are to be given non-default values, the appropriate declarations - should be given before calling in this package (i.e., before the - "%calstblx;" reference). ---> - -<!-- The motivation for this XML version of the Exchange Table Model - is simply to create an XML version of the SGML Exchange Table - Model. By design, no effort has been made to "improve" the model. - - This XML version incorporates the logical bare minimum changes - necessary to make the Exchange Table Model a valid XML DTD. - - It has been modified slightly for use in the combined HTML/CALS models - supported by DocBook V4.3 and later. ---> - -<!-- The XML version of the Exchange Table Model differs from - the SGML version in the following ways: - - The following parameter entities have been removed: - - - tbl.table.excep, tbl.hdft.excep, tbl.row.excep, tbl.entry.excep - There are no exceptions in XML. The following normative statement - is made in lieu of exceptions: the exchange table model explicitly - forbids a table from occurring within another table. If the - content model of an entry includes a table element, then this - cannot be enforced by the DTD, but it is a deviation from the - exchange table model to include a table within a table. - - - tbl.hdft.name, tbl.hdft.mdl, tbl.hdft.excep, tbl.hdft.att - The motivation for these elements was to change the table - header/footer elements. Since XML does not allow element declarations - to contain name groups, and the exchange table model does not - allow a table to contain footers, the continued presence of these - attributes seems unnecessary. - - The following parameter entity has been added: - - - tbl.thead.att - This entity parameterizes the attributes on thead. It replaces - the tbl.hdft.att parameter entity. - - Other miscellaneous changes: - - - Tag ommission indicators have been removed - - Comments have been removed from declarations - - NUMBER attributes have been changed to NMTOKEN - - NUTOKEN attributes have been to changed to NMTOKEN - - Removed the grouping characters around the content model - parameter entry for the 'entry' element. This is necessary - so that an entry can contain #PCDATA and be defined as an - optional, repeatable OR group beginning with #PCDATA. ---> - -<!-- This entity includes a set of element and attribute declarations - that partially defines the Exchange table model. However, the model - is not well-defined without the accompanying natural language - description of the semantics (meanings) of these various elements, - attributes, and attribute values. The semantic writeup, also available - from SGML Open, should be used in conjunction with this entity. ---> - -<!-- In order to use the Exchange table model, various parameter entity - declarations are required. A brief description is as follows: - - ENTITY NAME WHERE USED WHAT IT IS - - %yesorno In ATTLIST of: An attribute declared value - almost all elements for a "boolean" attribute - - %paracon In content model of: The "text" (logical content) - <entry> of the model group for <entry> - - %titles In content model of: The "title" part of the model - table element group for the table element - - %tbl.table.name In declaration of: The name of the "table" - table element element - - %tbl.table-titles.mdl In content model of: The model group for the title - table elements part of the content model for - table element - - %tbl.table.mdl In content model of: The model group for the content - table elements model for table element, - often (and by default) defined - in terms of %tbl.table-titles.mdl - and tgroup - - %tbl.table.att In ATTLIST of: Additional attributes on the - table element table element - - %bodyatt In ATTLIST of: Additional attributes on the - table element table element (for backward - compatibility with the SGML - model) - - %tbl.tgroup.mdl In content model of: The model group for the content - <tgroup> model for <tgroup> - - %tbl.tgroup.att In ATTLIST of: Additional attributes on the - <tgroup> <tgroup> element - - %tbl.thead.att In ATTLIST of: Additional attributes on the - <thead> <thead> element - - %tbl.tbody.att In ATTLIST of: Additional attributes on the - <tbody> <tbody> element - - %tbl.colspec.att In ATTLIST of: Additional attributes on the - <colspec> <colspec> element - - %tbl.row.mdl In content model of: The model group for the content - <row> model for <row> - - %tbl.row.att In ATTLIST of: Additional attributes on the - <row> <row> element - - %tbl.entry.mdl In content model of: The model group for the content - <entry> model for <entry> - - %tbl.entry.att In ATTLIST of: Additional attributes on the - <entry> <entry> element - - This set of declarations will use the default definitions shown below - for any of these parameter entities that are not declared before this - set of declarations is referenced. ---> - -<!-- These definitions are not directly related to the table model, but are - used in the default CALS table model and may be defined elsewhere (and - prior to the inclusion of this table module) in the referencing DTD. --> - -<!ENTITY % yesorno 'NMTOKEN'> <!-- no if zero(s), yes if any other value --> -<!ENTITY % titles 'title?'> -<!ENTITY % pcd "#PCDATA"> -<!ENTITY % paracon '%pcd;'> <!-- default for use in entry content --> - -<!-- -The parameter entities as defined below change and simplify the CALS table -model as published (as part of the Example DTD) in MIL-HDBK-28001. The -resulting simplified DTD has support from the SGML Open vendors and is -therefore more interoperable among different systems. - -These following declarations provide the Exchange default definitions -for these entities. However, these entities can be redefined (by giving -the appropriate parameter entity declaration(s) prior to the reference -to this Table Model declaration set entity) to fit the needs of the -current application. - -Note, however, that changes may have significant effect on the ability to -interchange table information. These changes may manifest themselves -in useability, presentation, and possible structure information degradation. ---> - -<!ENTITY % tbl.table.name "table"> -<!ENTITY % tbl.table-titles.mdl "%titles;,"> -<!ENTITY % tbl.table-main.mdl "tgroup+"> -<!ENTITY % tbl.table.mdl "%tbl.table-titles.mdl; %tbl.table-main.mdl;"> -<!ENTITY % tbl.table.att " - pgwide %yesorno; #IMPLIED "> -<!ENTITY % bodyatt ""> -<!ENTITY % tbl.tgroup.mdl "colspec*,thead?,tbody"> -<!ENTITY % tbl.tgroup.att ""> -<!ENTITY % tbl.thead.att ""> -<!ENTITY % tbl.tbody.att ""> -<!ENTITY % tbl.colspec.att ""> -<!ENTITY % tbl.row.mdl "entry+"> -<!ENTITY % tbl.row.att ""> -<!ENTITY % tbl.entry.mdl "(%paracon;)*"> -<!ENTITY % tbl.entry.att ""> - -<!ENTITY % tbl.frame.attval "top|bottom|topbot|all|sides|none"> -<!ENTITY % tbl.tbody.mdl "row+"> - -<!-- ===== Element and attribute declarations follow. ===== --> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.table.name "table" - ENTITY % tbl.table-titles.mdl "%titles;," - ENTITY % tbl.table.mdl "%tbl.table-titles; tgroup+" - ENTITY % tbl.table.att " - pgwide %yesorno; #IMPLIED " ---> - -<!--doc:???--> -<!ELEMENT %tbl.table.name; (%tbl.table.mdl;)> - -<!ATTLIST %tbl.table.name; - frame (%tbl.frame.attval;) #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - %tbl.table.att; - %bodyatt; -> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.tgroup.mdl "colspec*,thead?,tbody" - ENTITY % tbl.tgroup.att "" ---> - -<!--doc:A wrapper for the main content of a table, or part of a table.--> -<!ELEMENT tgroup (%tbl.tgroup.mdl;) > - -<!ATTLIST tgroup - cols NMTOKEN #REQUIRED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - %tbl.tgroup.att; -> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.colspec.att "" ---> - -<!--doc:Specifications for a column in a table.--> -<!ELEMENT colspec EMPTY > - -<!ATTLIST colspec - colnum NMTOKEN #IMPLIED - colname NMTOKEN #IMPLIED - colwidth CDATA #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff NMTOKEN #IMPLIED - %tbl.colspec.att; -> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.thead.att "" ---> - -<!--doc:A table header consisting of one or more rows.--> -<!ELEMENT thead (row+)> - -<!ATTLIST thead - valign (top|middle|bottom) #IMPLIED - %tbl.thead.att; -> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.tbody.att "" ---> - -<!--doc:A wrapper for the rows of a table or informal table.--> -<!ELEMENT tbody (%tbl.tbody.mdl;)> - -<!ATTLIST tbody - valign (top|middle|bottom) #IMPLIED - %tbl.tbody.att; -> - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % tbl.row.mdl "entry+" - ENTITY % tbl.row.att "" ---> - -<!--doc:A row in a table.--> -<!ELEMENT row (%tbl.row.mdl;)> - -<!ATTLIST row - rowsep %yesorno; #IMPLIED - valign (top|middle|bottom) #IMPLIED - %tbl.row.att; -> - - -<!-- - Default declarations previously defined in this entity and - referenced below include: - ENTITY % paracon "#PCDATA" - ENTITY % tbl.entry.mdl "(%paracon;)*" - ENTITY % tbl.entry.att "" ---> - -<!--doc:A cell in a table.--> -<!ELEMENT entry (%tbl.entry.mdl;)*> - -<!ATTLIST entry - colname NMTOKEN #IMPLIED - namest NMTOKEN #IMPLIED - nameend NMTOKEN #IMPLIED - morerows NMTOKEN #IMPLIED - colsep %yesorno; #IMPLIED - rowsep %yesorno; #IMPLIED - align (left|right|center|justify|char) #IMPLIED - char CDATA #IMPLIED - charoff NMTOKEN #IMPLIED - valign (top|middle|bottom) #IMPLIED - %tbl.entry.att; -> diff --git a/Utilities/xml/xhtml1/xhtml-lat1.ent b/Utilities/xml/xhtml1/xhtml-lat1.ent deleted file mode 100644 index ffee223..0000000 --- a/Utilities/xml/xhtml1/xhtml-lat1.ent +++ /dev/null @@ -1,196 +0,0 @@ -<!-- Portions (C) International Organization for Standardization 1986 - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. ---> -<!-- Character entity set. Typical invocation: - <!ENTITY % HTMLlat1 PUBLIC - "-//W3C//ENTITIES Latin 1 for XHTML//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent"> - %HTMLlat1; ---> - -<!ENTITY nbsp " "> <!-- no-break space = non-breaking space, - U+00A0 ISOnum --> -<!ENTITY iexcl "¡"> <!-- inverted exclamation mark, U+00A1 ISOnum --> -<!ENTITY cent "¢"> <!-- cent sign, U+00A2 ISOnum --> -<!ENTITY pound "£"> <!-- pound sign, U+00A3 ISOnum --> -<!ENTITY curren "¤"> <!-- currency sign, U+00A4 ISOnum --> -<!ENTITY yen "¥"> <!-- yen sign = yuan sign, U+00A5 ISOnum --> -<!ENTITY brvbar "¦"> <!-- broken bar = broken vertical bar, - U+00A6 ISOnum --> -<!ENTITY sect "§"> <!-- section sign, U+00A7 ISOnum --> -<!ENTITY uml "¨"> <!-- diaeresis = spacing diaeresis, - U+00A8 ISOdia --> -<!ENTITY copy "©"> <!-- copyright sign, U+00A9 ISOnum --> -<!ENTITY ordf "ª"> <!-- feminine ordinal indicator, U+00AA ISOnum --> -<!ENTITY laquo "«"> <!-- left-pointing double angle quotation mark - = left pointing guillemet, U+00AB ISOnum --> -<!ENTITY not "¬"> <!-- not sign = angled dash, - U+00AC ISOnum --> -<!ENTITY shy "­"> <!-- soft hyphen = discretionary hyphen, - U+00AD ISOnum --> -<!ENTITY reg "®"> <!-- registered sign = registered trade mark sign, - U+00AE ISOnum --> -<!ENTITY macr "¯"> <!-- macron = spacing macron = overline - = APL overbar, U+00AF ISOdia --> -<!ENTITY deg "°"> <!-- degree sign, U+00B0 ISOnum --> -<!ENTITY plusmn "±"> <!-- plus-minus sign = plus-or-minus sign, - U+00B1 ISOnum --> -<!ENTITY sup2 "²"> <!-- superscript two = superscript digit two - = squared, U+00B2 ISOnum --> -<!ENTITY sup3 "³"> <!-- superscript three = superscript digit three - = cubed, U+00B3 ISOnum --> -<!ENTITY acute "´"> <!-- acute accent = spacing acute, - U+00B4 ISOdia --> -<!ENTITY micro "µ"> <!-- micro sign, U+00B5 ISOnum --> -<!ENTITY para "¶"> <!-- pilcrow sign = paragraph sign, - U+00B6 ISOnum --> -<!ENTITY middot "·"> <!-- middle dot = Georgian comma - = Greek middle dot, U+00B7 ISOnum --> -<!ENTITY cedil "¸"> <!-- cedilla = spacing cedilla, U+00B8 ISOdia --> -<!ENTITY sup1 "¹"> <!-- superscript one = superscript digit one, - U+00B9 ISOnum --> -<!ENTITY ordm "º"> <!-- masculine ordinal indicator, - U+00BA ISOnum --> -<!ENTITY raquo "»"> <!-- right-pointing double angle quotation mark - = right pointing guillemet, U+00BB ISOnum --> -<!ENTITY frac14 "¼"> <!-- vulgar fraction one quarter - = fraction one quarter, U+00BC ISOnum --> -<!ENTITY frac12 "½"> <!-- vulgar fraction one half - = fraction one half, U+00BD ISOnum --> -<!ENTITY frac34 "¾"> <!-- vulgar fraction three quarters - = fraction three quarters, U+00BE ISOnum --> -<!ENTITY iquest "¿"> <!-- inverted question mark - = turned question mark, U+00BF ISOnum --> -<!ENTITY Agrave "À"> <!-- latin capital letter A with grave - = latin capital letter A grave, - U+00C0 ISOlat1 --> -<!ENTITY Aacute "Á"> <!-- latin capital letter A with acute, - U+00C1 ISOlat1 --> -<!ENTITY Acirc "Â"> <!-- latin capital letter A with circumflex, - U+00C2 ISOlat1 --> -<!ENTITY Atilde "Ã"> <!-- latin capital letter A with tilde, - U+00C3 ISOlat1 --> -<!ENTITY Auml "Ä"> <!-- latin capital letter A with diaeresis, - U+00C4 ISOlat1 --> -<!ENTITY Aring "Å"> <!-- latin capital letter A with ring above - = latin capital letter A ring, - U+00C5 ISOlat1 --> -<!ENTITY AElig "Æ"> <!-- latin capital letter AE - = latin capital ligature AE, - U+00C6 ISOlat1 --> -<!ENTITY Ccedil "Ç"> <!-- latin capital letter C with cedilla, - U+00C7 ISOlat1 --> -<!ENTITY Egrave "È"> <!-- latin capital letter E with grave, - U+00C8 ISOlat1 --> -<!ENTITY Eacute "É"> <!-- latin capital letter E with acute, - U+00C9 ISOlat1 --> -<!ENTITY Ecirc "Ê"> <!-- latin capital letter E with circumflex, - U+00CA ISOlat1 --> -<!ENTITY Euml "Ë"> <!-- latin capital letter E with diaeresis, - U+00CB ISOlat1 --> -<!ENTITY Igrave "Ì"> <!-- latin capital letter I with grave, - U+00CC ISOlat1 --> -<!ENTITY Iacute "Í"> <!-- latin capital letter I with acute, - U+00CD ISOlat1 --> -<!ENTITY Icirc "Î"> <!-- latin capital letter I with circumflex, - U+00CE ISOlat1 --> -<!ENTITY Iuml "Ï"> <!-- latin capital letter I with diaeresis, - U+00CF ISOlat1 --> -<!ENTITY ETH "Ð"> <!-- latin capital letter ETH, U+00D0 ISOlat1 --> -<!ENTITY Ntilde "Ñ"> <!-- latin capital letter N with tilde, - U+00D1 ISOlat1 --> -<!ENTITY Ograve "Ò"> <!-- latin capital letter O with grave, - U+00D2 ISOlat1 --> -<!ENTITY Oacute "Ó"> <!-- latin capital letter O with acute, - U+00D3 ISOlat1 --> -<!ENTITY Ocirc "Ô"> <!-- latin capital letter O with circumflex, - U+00D4 ISOlat1 --> -<!ENTITY Otilde "Õ"> <!-- latin capital letter O with tilde, - U+00D5 ISOlat1 --> -<!ENTITY Ouml "Ö"> <!-- latin capital letter O with diaeresis, - U+00D6 ISOlat1 --> -<!ENTITY times "×"> <!-- multiplication sign, U+00D7 ISOnum --> -<!ENTITY Oslash "Ø"> <!-- latin capital letter O with stroke - = latin capital letter O slash, - U+00D8 ISOlat1 --> -<!ENTITY Ugrave "Ù"> <!-- latin capital letter U with grave, - U+00D9 ISOlat1 --> -<!ENTITY Uacute "Ú"> <!-- latin capital letter U with acute, - U+00DA ISOlat1 --> -<!ENTITY Ucirc "Û"> <!-- latin capital letter U with circumflex, - U+00DB ISOlat1 --> -<!ENTITY Uuml "Ü"> <!-- latin capital letter U with diaeresis, - U+00DC ISOlat1 --> -<!ENTITY Yacute "Ý"> <!-- latin capital letter Y with acute, - U+00DD ISOlat1 --> -<!ENTITY THORN "Þ"> <!-- latin capital letter THORN, - U+00DE ISOlat1 --> -<!ENTITY szlig "ß"> <!-- latin small letter sharp s = ess-zed, - U+00DF ISOlat1 --> -<!ENTITY agrave "à"> <!-- latin small letter a with grave - = latin small letter a grave, - U+00E0 ISOlat1 --> -<!ENTITY aacute "á"> <!-- latin small letter a with acute, - U+00E1 ISOlat1 --> -<!ENTITY acirc "â"> <!-- latin small letter a with circumflex, - U+00E2 ISOlat1 --> -<!ENTITY atilde "ã"> <!-- latin small letter a with tilde, - U+00E3 ISOlat1 --> -<!ENTITY auml "ä"> <!-- latin small letter a with diaeresis, - U+00E4 ISOlat1 --> -<!ENTITY aring "å"> <!-- latin small letter a with ring above - = latin small letter a ring, - U+00E5 ISOlat1 --> -<!ENTITY aelig "æ"> <!-- latin small letter ae - = latin small ligature ae, U+00E6 ISOlat1 --> -<!ENTITY ccedil "ç"> <!-- latin small letter c with cedilla, - U+00E7 ISOlat1 --> -<!ENTITY egrave "è"> <!-- latin small letter e with grave, - U+00E8 ISOlat1 --> -<!ENTITY eacute "é"> <!-- latin small letter e with acute, - U+00E9 ISOlat1 --> -<!ENTITY ecirc "ê"> <!-- latin small letter e with circumflex, - U+00EA ISOlat1 --> -<!ENTITY euml "ë"> <!-- latin small letter e with diaeresis, - U+00EB ISOlat1 --> -<!ENTITY igrave "ì"> <!-- latin small letter i with grave, - U+00EC ISOlat1 --> -<!ENTITY iacute "í"> <!-- latin small letter i with acute, - U+00ED ISOlat1 --> -<!ENTITY icirc "î"> <!-- latin small letter i with circumflex, - U+00EE ISOlat1 --> -<!ENTITY iuml "ï"> <!-- latin small letter i with diaeresis, - U+00EF ISOlat1 --> -<!ENTITY eth "ð"> <!-- latin small letter eth, U+00F0 ISOlat1 --> -<!ENTITY ntilde "ñ"> <!-- latin small letter n with tilde, - U+00F1 ISOlat1 --> -<!ENTITY ograve "ò"> <!-- latin small letter o with grave, - U+00F2 ISOlat1 --> -<!ENTITY oacute "ó"> <!-- latin small letter o with acute, - U+00F3 ISOlat1 --> -<!ENTITY ocirc "ô"> <!-- latin small letter o with circumflex, - U+00F4 ISOlat1 --> -<!ENTITY otilde "õ"> <!-- latin small letter o with tilde, - U+00F5 ISOlat1 --> -<!ENTITY ouml "ö"> <!-- latin small letter o with diaeresis, - U+00F6 ISOlat1 --> -<!ENTITY divide "÷"> <!-- division sign, U+00F7 ISOnum --> -<!ENTITY oslash "ø"> <!-- latin small letter o with stroke, - = latin small letter o slash, - U+00F8 ISOlat1 --> -<!ENTITY ugrave "ù"> <!-- latin small letter u with grave, - U+00F9 ISOlat1 --> -<!ENTITY uacute "ú"> <!-- latin small letter u with acute, - U+00FA ISOlat1 --> -<!ENTITY ucirc "û"> <!-- latin small letter u with circumflex, - U+00FB ISOlat1 --> -<!ENTITY uuml "ü"> <!-- latin small letter u with diaeresis, - U+00FC ISOlat1 --> -<!ENTITY yacute "ý"> <!-- latin small letter y with acute, - U+00FD ISOlat1 --> -<!ENTITY thorn "þ"> <!-- latin small letter thorn, - U+00FE ISOlat1 --> -<!ENTITY yuml "ÿ"> <!-- latin small letter y with diaeresis, - U+00FF ISOlat1 --> diff --git a/Utilities/xml/xhtml1/xhtml-special.ent b/Utilities/xml/xhtml1/xhtml-special.ent deleted file mode 100644 index 3a83fb6..0000000 --- a/Utilities/xml/xhtml1/xhtml-special.ent +++ /dev/null @@ -1,80 +0,0 @@ -<!-- Special characters for XHTML --> - -<!-- Character entity set. Typical invocation: - <!ENTITY % HTMLspecial PUBLIC - "-//W3C//ENTITIES Special for XHTML//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent"> - %HTMLspecial; ---> - -<!-- Portions (C) International Organization for Standardization 1986: - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. ---> - -<!-- Relevant ISO entity set is given unless names are newly introduced. - New names (i.e., not in ISO 8879 list) do not clash with any - existing ISO 8879 entity names. ISO 10646 character numbers - are given for each character, in hex. values are decimal - conversions of the ISO 10646 values and refer to the document - character set. Names are Unicode names. ---> - -<!-- C0 Controls and Basic Latin --> -<!ENTITY quot """> <!-- quotation mark, U+0022 ISOnum --> -<!ENTITY amp "&#38;"> <!-- ampersand, U+0026 ISOnum --> -<!ENTITY lt "&#60;"> <!-- less-than sign, U+003C ISOnum --> -<!ENTITY gt ">"> <!-- greater-than sign, U+003E ISOnum --> -<!ENTITY apos "'"> <!-- apostrophe = APL quote, U+0027 ISOnum --> - -<!-- Latin Extended-A --> -<!ENTITY OElig "Œ"> <!-- latin capital ligature OE, - U+0152 ISOlat2 --> -<!ENTITY oelig "œ"> <!-- latin small ligature oe, U+0153 ISOlat2 --> -<!-- ligature is a misnomer, this is a separate character in some languages --> -<!ENTITY Scaron "Š"> <!-- latin capital letter S with caron, - U+0160 ISOlat2 --> -<!ENTITY scaron "š"> <!-- latin small letter s with caron, - U+0161 ISOlat2 --> -<!ENTITY Yuml "Ÿ"> <!-- latin capital letter Y with diaeresis, - U+0178 ISOlat2 --> - -<!-- Spacing Modifier Letters --> -<!ENTITY circ "ˆ"> <!-- modifier letter circumflex accent, - U+02C6 ISOpub --> -<!ENTITY tilde "˜"> <!-- small tilde, U+02DC ISOdia --> - -<!-- General Punctuation --> -<!ENTITY ensp " "> <!-- en space, U+2002 ISOpub --> -<!ENTITY emsp " "> <!-- em space, U+2003 ISOpub --> -<!ENTITY thinsp " "> <!-- thin space, U+2009 ISOpub --> -<!ENTITY zwnj "‌"> <!-- zero width non-joiner, - U+200C NEW RFC 2070 --> -<!ENTITY zwj "‍"> <!-- zero width joiner, U+200D NEW RFC 2070 --> -<!ENTITY lrm "‎"> <!-- left-to-right mark, U+200E NEW RFC 2070 --> -<!ENTITY rlm "‏"> <!-- right-to-left mark, U+200F NEW RFC 2070 --> -<!ENTITY ndash "–"> <!-- en dash, U+2013 ISOpub --> -<!ENTITY mdash "—"> <!-- em dash, U+2014 ISOpub --> -<!ENTITY lsquo "‘"> <!-- left single quotation mark, - U+2018 ISOnum --> -<!ENTITY rsquo "’"> <!-- right single quotation mark, - U+2019 ISOnum --> -<!ENTITY sbquo "‚"> <!-- single low-9 quotation mark, U+201A NEW --> -<!ENTITY ldquo "“"> <!-- left double quotation mark, - U+201C ISOnum --> -<!ENTITY rdquo "”"> <!-- right double quotation mark, - U+201D ISOnum --> -<!ENTITY bdquo "„"> <!-- double low-9 quotation mark, U+201E NEW --> -<!ENTITY dagger "†"> <!-- dagger, U+2020 ISOpub --> -<!ENTITY Dagger "‡"> <!-- double dagger, U+2021 ISOpub --> -<!ENTITY permil "‰"> <!-- per mille sign, U+2030 ISOtech --> -<!ENTITY lsaquo "‹"> <!-- single left-pointing angle quotation mark, - U+2039 ISO proposed --> -<!-- lsaquo is proposed but not yet ISO standardized --> -<!ENTITY rsaquo "›"> <!-- single right-pointing angle quotation mark, - U+203A ISO proposed --> -<!-- rsaquo is proposed but not yet ISO standardized --> - -<!-- Currency Symbols --> -<!ENTITY euro "€"> <!-- euro sign, U+20AC NEW --> diff --git a/Utilities/xml/xhtml1/xhtml-symbol.ent b/Utilities/xml/xhtml1/xhtml-symbol.ent deleted file mode 100644 index d0c77ee..0000000 --- a/Utilities/xml/xhtml1/xhtml-symbol.ent +++ /dev/null @@ -1,237 +0,0 @@ -<!-- Mathematical, Greek and Symbolic characters for XHTML --> - -<!-- Character entity set. Typical invocation: - <!ENTITY % HTMLsymbol PUBLIC - "-//W3C//ENTITIES Symbols for XHTML//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent"> - %HTMLsymbol; ---> - -<!-- Portions (C) International Organization for Standardization 1986: - Permission to copy in any form is granted for use with - conforming SGML systems and applications as defined in - ISO 8879, provided this notice is included in all copies. ---> - -<!-- Relevant ISO entity set is given unless names are newly introduced. - New names (i.e., not in ISO 8879 list) do not clash with any - existing ISO 8879 entity names. ISO 10646 character numbers - are given for each character, in hex. values are decimal - conversions of the ISO 10646 values and refer to the document - character set. Names are Unicode names. ---> - -<!-- Latin Extended-B --> -<!ENTITY fnof "ƒ"> <!-- latin small letter f with hook = function - = florin, U+0192 ISOtech --> - -<!-- Greek --> -<!ENTITY Alpha "Α"> <!-- greek capital letter alpha, U+0391 --> -<!ENTITY Beta "Β"> <!-- greek capital letter beta, U+0392 --> -<!ENTITY Gamma "Γ"> <!-- greek capital letter gamma, - U+0393 ISOgrk3 --> -<!ENTITY Delta "Δ"> <!-- greek capital letter delta, - U+0394 ISOgrk3 --> -<!ENTITY Epsilon "Ε"> <!-- greek capital letter epsilon, U+0395 --> -<!ENTITY Zeta "Ζ"> <!-- greek capital letter zeta, U+0396 --> -<!ENTITY Eta "Η"> <!-- greek capital letter eta, U+0397 --> -<!ENTITY Theta "Θ"> <!-- greek capital letter theta, - U+0398 ISOgrk3 --> -<!ENTITY Iota "Ι"> <!-- greek capital letter iota, U+0399 --> -<!ENTITY Kappa "Κ"> <!-- greek capital letter kappa, U+039A --> -<!ENTITY Lambda "Λ"> <!-- greek capital letter lamda, - U+039B ISOgrk3 --> -<!ENTITY Mu "Μ"> <!-- greek capital letter mu, U+039C --> -<!ENTITY Nu "Ν"> <!-- greek capital letter nu, U+039D --> -<!ENTITY Xi "Ξ"> <!-- greek capital letter xi, U+039E ISOgrk3 --> -<!ENTITY Omicron "Ο"> <!-- greek capital letter omicron, U+039F --> -<!ENTITY Pi "Π"> <!-- greek capital letter pi, U+03A0 ISOgrk3 --> -<!ENTITY Rho "Ρ"> <!-- greek capital letter rho, U+03A1 --> -<!-- there is no Sigmaf, and no U+03A2 character either --> -<!ENTITY Sigma "Σ"> <!-- greek capital letter sigma, - U+03A3 ISOgrk3 --> -<!ENTITY Tau "Τ"> <!-- greek capital letter tau, U+03A4 --> -<!ENTITY Upsilon "Υ"> <!-- greek capital letter upsilon, - U+03A5 ISOgrk3 --> -<!ENTITY Phi "Φ"> <!-- greek capital letter phi, - U+03A6 ISOgrk3 --> -<!ENTITY Chi "Χ"> <!-- greek capital letter chi, U+03A7 --> -<!ENTITY Psi "Ψ"> <!-- greek capital letter psi, - U+03A8 ISOgrk3 --> -<!ENTITY Omega "Ω"> <!-- greek capital letter omega, - U+03A9 ISOgrk3 --> - -<!ENTITY alpha "α"> <!-- greek small letter alpha, - U+03B1 ISOgrk3 --> -<!ENTITY beta "β"> <!-- greek small letter beta, U+03B2 ISOgrk3 --> -<!ENTITY gamma "γ"> <!-- greek small letter gamma, - U+03B3 ISOgrk3 --> -<!ENTITY delta "δ"> <!-- greek small letter delta, - U+03B4 ISOgrk3 --> -<!ENTITY epsilon "ε"> <!-- greek small letter epsilon, - U+03B5 ISOgrk3 --> -<!ENTITY zeta "ζ"> <!-- greek small letter zeta, U+03B6 ISOgrk3 --> -<!ENTITY eta "η"> <!-- greek small letter eta, U+03B7 ISOgrk3 --> -<!ENTITY theta "θ"> <!-- greek small letter theta, - U+03B8 ISOgrk3 --> -<!ENTITY iota "ι"> <!-- greek small letter iota, U+03B9 ISOgrk3 --> -<!ENTITY kappa "κ"> <!-- greek small letter kappa, - U+03BA ISOgrk3 --> -<!ENTITY lambda "λ"> <!-- greek small letter lamda, - U+03BB ISOgrk3 --> -<!ENTITY mu "μ"> <!-- greek small letter mu, U+03BC ISOgrk3 --> -<!ENTITY nu "ν"> <!-- greek small letter nu, U+03BD ISOgrk3 --> -<!ENTITY xi "ξ"> <!-- greek small letter xi, U+03BE ISOgrk3 --> -<!ENTITY omicron "ο"> <!-- greek small letter omicron, U+03BF NEW --> -<!ENTITY pi "π"> <!-- greek small letter pi, U+03C0 ISOgrk3 --> -<!ENTITY rho "ρ"> <!-- greek small letter rho, U+03C1 ISOgrk3 --> -<!ENTITY sigmaf "ς"> <!-- greek small letter final sigma, - U+03C2 ISOgrk3 --> -<!ENTITY sigma "σ"> <!-- greek small letter sigma, - U+03C3 ISOgrk3 --> -<!ENTITY tau "τ"> <!-- greek small letter tau, U+03C4 ISOgrk3 --> -<!ENTITY upsilon "υ"> <!-- greek small letter upsilon, - U+03C5 ISOgrk3 --> -<!ENTITY phi "φ"> <!-- greek small letter phi, U+03C6 ISOgrk3 --> -<!ENTITY chi "χ"> <!-- greek small letter chi, U+03C7 ISOgrk3 --> -<!ENTITY psi "ψ"> <!-- greek small letter psi, U+03C8 ISOgrk3 --> -<!ENTITY omega "ω"> <!-- greek small letter omega, - U+03C9 ISOgrk3 --> -<!ENTITY thetasym "ϑ"> <!-- greek theta symbol, - U+03D1 NEW --> -<!ENTITY upsih "ϒ"> <!-- greek upsilon with hook symbol, - U+03D2 NEW --> -<!ENTITY piv "ϖ"> <!-- greek pi symbol, U+03D6 ISOgrk3 --> - -<!-- General Punctuation --> -<!ENTITY bull "•"> <!-- bullet = black small circle, - U+2022 ISOpub --> -<!-- bullet is NOT the same as bullet operator, U+2219 --> -<!ENTITY hellip "…"> <!-- horizontal ellipsis = three dot leader, - U+2026 ISOpub --> -<!ENTITY prime "′"> <!-- prime = minutes = feet, U+2032 ISOtech --> -<!ENTITY Prime "″"> <!-- double prime = seconds = inches, - U+2033 ISOtech --> -<!ENTITY oline "‾"> <!-- overline = spacing overscore, - U+203E NEW --> -<!ENTITY frasl "⁄"> <!-- fraction slash, U+2044 NEW --> - -<!-- Letterlike Symbols --> -<!ENTITY weierp "℘"> <!-- script capital P = power set - = Weierstrass p, U+2118 ISOamso --> -<!ENTITY image "ℑ"> <!-- black-letter capital I = imaginary part, - U+2111 ISOamso --> -<!ENTITY real "ℜ"> <!-- black-letter capital R = real part symbol, - U+211C ISOamso --> -<!ENTITY trade "™"> <!-- trade mark sign, U+2122 ISOnum --> -<!ENTITY alefsym "ℵ"> <!-- alef symbol = first transfinite cardinal, - U+2135 NEW --> -<!-- alef symbol is NOT the same as hebrew letter alef, - U+05D0 although the same glyph could be used to depict both characters --> - -<!-- Arrows --> -<!ENTITY larr "←"> <!-- leftwards arrow, U+2190 ISOnum --> -<!ENTITY uarr "↑"> <!-- upwards arrow, U+2191 ISOnum--> -<!ENTITY rarr "→"> <!-- rightwards arrow, U+2192 ISOnum --> -<!ENTITY darr "↓"> <!-- downwards arrow, U+2193 ISOnum --> -<!ENTITY harr "↔"> <!-- left right arrow, U+2194 ISOamsa --> -<!ENTITY crarr "↵"> <!-- downwards arrow with corner leftwards - = carriage return, U+21B5 NEW --> -<!ENTITY lArr "⇐"> <!-- leftwards double arrow, U+21D0 ISOtech --> -<!-- Unicode does not say that lArr is the same as the 'is implied by' arrow - but also does not have any other character for that function. So lArr can - be used for 'is implied by' as ISOtech suggests --> -<!ENTITY uArr "⇑"> <!-- upwards double arrow, U+21D1 ISOamsa --> -<!ENTITY rArr "⇒"> <!-- rightwards double arrow, - U+21D2 ISOtech --> -<!-- Unicode does not say this is the 'implies' character but does not have - another character with this function so rArr can be used for 'implies' - as ISOtech suggests --> -<!ENTITY dArr "⇓"> <!-- downwards double arrow, U+21D3 ISOamsa --> -<!ENTITY hArr "⇔"> <!-- left right double arrow, - U+21D4 ISOamsa --> - -<!-- Mathematical Operators --> -<!ENTITY forall "∀"> <!-- for all, U+2200 ISOtech --> -<!ENTITY part "∂"> <!-- partial differential, U+2202 ISOtech --> -<!ENTITY exist "∃"> <!-- there exists, U+2203 ISOtech --> -<!ENTITY empty "∅"> <!-- empty set = null set, U+2205 ISOamso --> -<!ENTITY nabla "∇"> <!-- nabla = backward difference, - U+2207 ISOtech --> -<!ENTITY isin "∈"> <!-- element of, U+2208 ISOtech --> -<!ENTITY notin "∉"> <!-- not an element of, U+2209 ISOtech --> -<!ENTITY ni "∋"> <!-- contains as member, U+220B ISOtech --> -<!ENTITY prod "∏"> <!-- n-ary product = product sign, - U+220F ISOamsb --> -<!-- prod is NOT the same character as U+03A0 'greek capital letter pi' though - the same glyph might be used for both --> -<!ENTITY sum "∑"> <!-- n-ary summation, U+2211 ISOamsb --> -<!-- sum is NOT the same character as U+03A3 'greek capital letter sigma' - though the same glyph might be used for both --> -<!ENTITY minus "−"> <!-- minus sign, U+2212 ISOtech --> -<!ENTITY lowast "∗"> <!-- asterisk operator, U+2217 ISOtech --> -<!ENTITY radic "√"> <!-- square root = radical sign, - U+221A ISOtech --> -<!ENTITY prop "∝"> <!-- proportional to, U+221D ISOtech --> -<!ENTITY infin "∞"> <!-- infinity, U+221E ISOtech --> -<!ENTITY ang "∠"> <!-- angle, U+2220 ISOamso --> -<!ENTITY and "∧"> <!-- logical and = wedge, U+2227 ISOtech --> -<!ENTITY or "∨"> <!-- logical or = vee, U+2228 ISOtech --> -<!ENTITY cap "∩"> <!-- intersection = cap, U+2229 ISOtech --> -<!ENTITY cup "∪"> <!-- union = cup, U+222A ISOtech --> -<!ENTITY int "∫"> <!-- integral, U+222B ISOtech --> -<!ENTITY there4 "∴"> <!-- therefore, U+2234 ISOtech --> -<!ENTITY sim "∼"> <!-- tilde operator = varies with = similar to, - U+223C ISOtech --> -<!-- tilde operator is NOT the same character as the tilde, U+007E, - although the same glyph might be used to represent both --> -<!ENTITY cong "≅"> <!-- approximately equal to, U+2245 ISOtech --> -<!ENTITY asymp "≈"> <!-- almost equal to = asymptotic to, - U+2248 ISOamsr --> -<!ENTITY ne "≠"> <!-- not equal to, U+2260 ISOtech --> -<!ENTITY equiv "≡"> <!-- identical to, U+2261 ISOtech --> -<!ENTITY le "≤"> <!-- less-than or equal to, U+2264 ISOtech --> -<!ENTITY ge "≥"> <!-- greater-than or equal to, - U+2265 ISOtech --> -<!ENTITY sub "⊂"> <!-- subset of, U+2282 ISOtech --> -<!ENTITY sup "⊃"> <!-- superset of, U+2283 ISOtech --> -<!ENTITY nsub "⊄"> <!-- not a subset of, U+2284 ISOamsn --> -<!ENTITY sube "⊆"> <!-- subset of or equal to, U+2286 ISOtech --> -<!ENTITY supe "⊇"> <!-- superset of or equal to, - U+2287 ISOtech --> -<!ENTITY oplus "⊕"> <!-- circled plus = direct sum, - U+2295 ISOamsb --> -<!ENTITY otimes "⊗"> <!-- circled times = vector product, - U+2297 ISOamsb --> -<!ENTITY perp "⊥"> <!-- up tack = orthogonal to = perpendicular, - U+22A5 ISOtech --> -<!ENTITY sdot "⋅"> <!-- dot operator, U+22C5 ISOamsb --> -<!-- dot operator is NOT the same character as U+00B7 middle dot --> - -<!-- Miscellaneous Technical --> -<!ENTITY lceil "⌈"> <!-- left ceiling = APL upstile, - U+2308 ISOamsc --> -<!ENTITY rceil "⌉"> <!-- right ceiling, U+2309 ISOamsc --> -<!ENTITY lfloor "⌊"> <!-- left floor = APL downstile, - U+230A ISOamsc --> -<!ENTITY rfloor "⌋"> <!-- right floor, U+230B ISOamsc --> -<!ENTITY lang "〈"> <!-- left-pointing angle bracket = bra, - U+2329 ISOtech --> -<!-- lang is NOT the same character as U+003C 'less than sign' - or U+2039 'single left-pointing angle quotation mark' --> -<!ENTITY rang "〉"> <!-- right-pointing angle bracket = ket, - U+232A ISOtech --> -<!-- rang is NOT the same character as U+003E 'greater than sign' - or U+203A 'single right-pointing angle quotation mark' --> - -<!-- Geometric Shapes --> -<!ENTITY loz "◊"> <!-- lozenge, U+25CA ISOpub --> - -<!-- Miscellaneous Symbols --> -<!ENTITY spades "♠"> <!-- black spade suit, U+2660 ISOpub --> -<!-- black here seems to mean filled as opposed to hollow --> -<!ENTITY clubs "♣"> <!-- black club suit = shamrock, - U+2663 ISOpub --> -<!ENTITY hearts "♥"> <!-- black heart suit = valentine, - U+2665 ISOpub --> -<!ENTITY diams "♦"> <!-- black diamond suit, U+2666 ISOpub --> diff --git a/Utilities/xml/xhtml1/xhtml1-strict.dtd b/Utilities/xml/xhtml1/xhtml1-strict.dtd deleted file mode 100644 index e48fbea..0000000 --- a/Utilities/xml/xhtml1/xhtml1-strict.dtd +++ /dev/null @@ -1,977 +0,0 @@ -<!-- - Extensible HTML version 1.0 Strict DTD - - This is the same as HTML 4 Strict except for - changes due to the differences between XML and SGML. - - Namespace = http://www.w3.org/1999/xhtml - - For further information, see: http://www.w3.org/TR/xhtml1 - - Copyright (c) 1998-2002 W3C (MIT, INRIA, Keio), - All Rights Reserved. - - This DTD module is identified by the PUBLIC and SYSTEM identifiers: - - PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" - - $Revision: 1.1 $ - $Date: 2002/08/01 13:56:03 $ - ---> - -<!--================ Character mnemonic entities =========================--> - -<!ENTITY % HTMLlat1 PUBLIC - "-//W3C//ENTITIES Latin 1 for XHTML//EN" - "xhtml-lat1.ent"> -%HTMLlat1; - -<!ENTITY % HTMLsymbol PUBLIC - "-//W3C//ENTITIES Symbols for XHTML//EN" - "xhtml-symbol.ent"> -%HTMLsymbol; - -<!ENTITY % HTMLspecial PUBLIC - "-//W3C//ENTITIES Special for XHTML//EN" - "xhtml-special.ent"> -%HTMLspecial; - -<!--================== Imported Names ====================================--> - -<!ENTITY % ContentType "CDATA"> - <!-- media type, as per [RFC2045] --> - -<!ENTITY % ContentTypes "CDATA"> - <!-- comma-separated list of media types, as per [RFC2045] --> - -<!ENTITY % Charset "CDATA"> - <!-- a character encoding, as per [RFC2045] --> - -<!ENTITY % Charsets "CDATA"> - <!-- a space separated list of character encodings, as per [RFC2045] --> - -<!ENTITY % LanguageCode "NMTOKEN"> - <!-- a language code, as per [RFC3066] --> - -<!ENTITY % Character "CDATA"> - <!-- a single character, as per section 2.2 of [XML] --> - -<!ENTITY % Number "CDATA"> - <!-- one or more digits --> - -<!ENTITY % LinkTypes "CDATA"> - <!-- space-separated list of link types --> - -<!ENTITY % MediaDesc "CDATA"> - <!-- single or comma-separated list of media descriptors --> - -<!ENTITY % URI "CDATA"> - <!-- a Uniform Resource Identifier, see [RFC2396] --> - -<!ENTITY % UriList "CDATA"> - <!-- a space separated list of Uniform Resource Identifiers --> - -<!ENTITY % Datetime "CDATA"> - <!-- date and time information. ISO date format --> - -<!ENTITY % Script "CDATA"> - <!-- script expression --> - -<!ENTITY % StyleSheet "CDATA"> - <!-- style sheet data --> - -<!ENTITY % Text "CDATA"> - <!-- used for titles etc. --> - -<!ENTITY % Length "CDATA"> - <!-- nn for pixels or nn% for percentage length --> - -<!ENTITY % MultiLength "CDATA"> - <!-- pixel, percentage, or relative --> - -<!ENTITY % Pixels "CDATA"> - <!-- integer representing length in pixels --> - -<!-- these are used for image maps --> - -<!ENTITY % Shape "(rect|circle|poly|default)"> - -<!ENTITY % Coords "CDATA"> - <!-- comma separated list of lengths --> - -<!--=================== Generic Attributes ===============================--> - -<!-- core attributes common to most elements - id document-wide unique id - class space separated list of classes - style associated style info - title advisory title/amplification ---> -<!ENTITY % coreattrs - "id ID #IMPLIED - class CDATA #IMPLIED - style %StyleSheet; #IMPLIED - title %Text; #IMPLIED" - > - -<!-- internationalization attributes - lang language code (backwards compatible) - xml:lang language code (as per XML 1.0 spec) - dir direction for weak/neutral text ---> -<!ENTITY % i18n - "lang %LanguageCode; #IMPLIED - xml:lang %LanguageCode; #IMPLIED - dir (ltr|rtl) #IMPLIED" - > - -<!-- attributes for common UI events - onclick a pointer button was clicked - ondblclick a pointer button was double clicked - onmousedown a pointer button was pressed down - onmouseup a pointer button was released - onmousemove a pointer was moved onto the element - onmouseout a pointer was moved away from the element - onkeypress a key was pressed and released - onkeydown a key was pressed down - onkeyup a key was released ---> -<!ENTITY % events - "onclick %Script; #IMPLIED - ondblclick %Script; #IMPLIED - onmousedown %Script; #IMPLIED - onmouseup %Script; #IMPLIED - onmouseover %Script; #IMPLIED - onmousemove %Script; #IMPLIED - onmouseout %Script; #IMPLIED - onkeypress %Script; #IMPLIED - onkeydown %Script; #IMPLIED - onkeyup %Script; #IMPLIED" - > - -<!-- attributes for elements that can get the focus - accesskey accessibility key character - tabindex position in tabbing order - onfocus the element got the focus - onblur the element lost the focus ---> -<!ENTITY % focus - "accesskey %Character; #IMPLIED - tabindex %Number; #IMPLIED - onfocus %Script; #IMPLIED - onblur %Script; #IMPLIED" - > - -<!ENTITY % attrs "%coreattrs; %i18n; %events;"> - -<!--=================== Text Elements ====================================--> - -<!ENTITY % special.pre - "br | span | bdo | map"> - - -<!ENTITY % special - "%special.pre; | object | img "> - -<!ENTITY % fontstyle "tt | i | b | big | small "> - -<!ENTITY % phrase "em | strong | dfn | code | q | - samp | kbd | var | cite | abbr | acronym | sub | sup "> - -<!ENTITY % inline.forms "input | select | textarea | label | button"> - -<!-- these can occur at block or inline level --> -<!ENTITY % misc.inline "ins | del | script"> - -<!-- these can only occur at block level --> -<!ENTITY % misc "noscript | %misc.inline;"> - -<!ENTITY % inline "a | %special; | %fontstyle; | %phrase; | %inline.forms;"> - -<!-- %Inline; covers inline or "text-level" elements --> -<!ENTITY % Inline "(#PCDATA | %inline; | %misc.inline;)*"> - -<!--================== Block level elements ==============================--> - -<!ENTITY % heading "h1|h2|h3|h4|h5|h6"> -<!ENTITY % lists "ul | ol | dl"> -<!ENTITY % blocktext "pre | hr | blockquote | address"> - -<!ENTITY % block - "p | %heading; | div | %lists; | %blocktext; | fieldset | table"> - -<!ENTITY % Block "(%block; | form | %misc;)*"> - -<!-- %Flow; mixes block and inline and is used for list items etc. --> -<!ENTITY % Flow "(#PCDATA | %block; | form | %inline; | %misc;)*"> - -<!--================== Content models for exclusions =====================--> - -<!-- a elements use %Inline; excluding a --> - -<!ENTITY % a.content - "(#PCDATA | %special; | %fontstyle; | %phrase; | %inline.forms; | %misc.inline;)*"> - -<!-- pre uses %Inline excluding big, small, sup or sup --> - -<!ENTITY % pre.content - "(#PCDATA | a | %fontstyle; | %phrase; | %special.pre; | %misc.inline; - | %inline.forms;)*"> - -<!-- form uses %Block; excluding form --> - -<!ENTITY % form.content "(%block; | %misc;)*"> - -<!-- button uses %Flow; but excludes a, form and form controls --> - -<!ENTITY % button.content - "(#PCDATA | p | %heading; | div | %lists; | %blocktext; | - table | %special; | %fontstyle; | %phrase; | %misc;)*"> - -<!--================ Document Structure ==================================--> - -<!-- the namespace URI designates the document profile --> - -<!ELEMENT html (head, body)> -<!ATTLIST html - %i18n; - id ID #IMPLIED - xmlns %URI; #FIXED 'http://www.w3.org/1999/xhtml' - > - -<!--================ Document Head =======================================--> - -<!ENTITY % head.misc "(script|style|meta|link|object)*"> - -<!-- content model is %head.misc; combined with a single - title and an optional base element in any order --> - -<!ELEMENT head (%head.misc;, - ((title, %head.misc;, (base, %head.misc;)?) | - (base, %head.misc;, (title, %head.misc;))))> - -<!ATTLIST head - %i18n; - id ID #IMPLIED - profile %URI; #IMPLIED - > - -<!-- The title element is not considered part of the flow of text. - It should be displayed, for example as the page header or - window title. Exactly one title is required per document. - --> -<!ELEMENT title (#PCDATA)> -<!ATTLIST title - %i18n; - id ID #IMPLIED - > - -<!-- document base URI --> - -<!ELEMENT base EMPTY> -<!ATTLIST base - href %URI; #REQUIRED - id ID #IMPLIED - > - -<!-- generic metainformation --> -<!ELEMENT meta EMPTY> -<!ATTLIST meta - %i18n; - id ID #IMPLIED - http-equiv CDATA #IMPLIED - name CDATA #IMPLIED - content CDATA #REQUIRED - scheme CDATA #IMPLIED - > - -<!-- - Relationship values can be used in principle: - - a) for document specific toolbars/menus when used - with the link element in document head e.g. - start, contents, previous, next, index, end, help - b) to link to a separate style sheet (rel="stylesheet") - c) to make a link to a script (rel="script") - d) by stylesheets to control how collections of - html nodes are rendered into printed documents - e) to make a link to a printable version of this document - e.g. a PostScript or PDF version (rel="alternate" media="print") ---> - -<!ELEMENT link EMPTY> -<!ATTLIST link - %attrs; - charset %Charset; #IMPLIED - href %URI; #IMPLIED - hreflang %LanguageCode; #IMPLIED - type %ContentType; #IMPLIED - rel %LinkTypes; #IMPLIED - rev %LinkTypes; #IMPLIED - media %MediaDesc; #IMPLIED - > - -<!-- style info, which may include CDATA sections --> -<!ELEMENT style (#PCDATA)> -<!ATTLIST style - %i18n; - id ID #IMPLIED - type %ContentType; #REQUIRED - media %MediaDesc; #IMPLIED - title %Text; #IMPLIED - xml:space (preserve) #FIXED 'preserve' - > - -<!-- script statements, which may include CDATA sections --> -<!ELEMENT script (#PCDATA)> -<!ATTLIST script - id ID #IMPLIED - charset %Charset; #IMPLIED - type %ContentType; #REQUIRED - src %URI; #IMPLIED - defer (defer) #IMPLIED - xml:space (preserve) #FIXED 'preserve' - > - -<!-- alternate content container for non script-based rendering --> - -<!ELEMENT noscript %Block;> -<!ATTLIST noscript - %attrs; - > - -<!--=================== Document Body ====================================--> - -<!ELEMENT body %Block;> -<!ATTLIST body - %attrs; - onload %Script; #IMPLIED - onunload %Script; #IMPLIED - > - -<!ELEMENT div %Flow;> <!-- generic language/style container --> -<!ATTLIST div - %attrs; - > - -<!--=================== Paragraphs =======================================--> - -<!ELEMENT p %Inline;> -<!ATTLIST p - %attrs; - > - -<!--=================== Headings =========================================--> - -<!-- - There are six levels of headings from h1 (the most important) - to h6 (the least important). ---> - -<!ELEMENT h1 %Inline;> -<!ATTLIST h1 - %attrs; - > - -<!ELEMENT h2 %Inline;> -<!ATTLIST h2 - %attrs; - > - -<!ELEMENT h3 %Inline;> -<!ATTLIST h3 - %attrs; - > - -<!ELEMENT h4 %Inline;> -<!ATTLIST h4 - %attrs; - > - -<!ELEMENT h5 %Inline;> -<!ATTLIST h5 - %attrs; - > - -<!ELEMENT h6 %Inline;> -<!ATTLIST h6 - %attrs; - > - -<!--=================== Lists ============================================--> - -<!-- Unordered list --> - -<!ELEMENT ul (li)+> -<!ATTLIST ul - %attrs; - > - -<!-- Ordered (numbered) list --> - -<!ELEMENT ol (li)+> -<!ATTLIST ol - %attrs; - > - -<!-- list item --> - -<!ELEMENT li %Flow;> -<!ATTLIST li - %attrs; - > - -<!-- definition lists - dt for term, dd for its definition --> - -<!ELEMENT dl (dt|dd)+> -<!ATTLIST dl - %attrs; - > - -<!ELEMENT dt %Inline;> -<!ATTLIST dt - %attrs; - > - -<!ELEMENT dd %Flow;> -<!ATTLIST dd - %attrs; - > - -<!--=================== Address ==========================================--> - -<!-- information on author --> - -<!ELEMENT address %Inline;> -<!ATTLIST address - %attrs; - > - -<!--=================== Horizontal Rule ==================================--> - -<!ELEMENT hr EMPTY> -<!ATTLIST hr - %attrs; - > - -<!--=================== Preformatted Text ================================--> - -<!-- content is %Inline; excluding "img|object|big|small|sub|sup" --> - -<!ELEMENT pre %pre.content;> -<!ATTLIST pre - %attrs; - xml:space (preserve) #FIXED 'preserve' - > - -<!--=================== Block-like Quotes ================================--> - -<!ELEMENT blockquote %Block;> -<!ATTLIST blockquote - %attrs; - cite %URI; #IMPLIED - > - -<!--=================== Inserted/Deleted Text ============================--> - -<!-- - ins/del are allowed in block and inline content, but its - inappropriate to include block content within an ins element - occurring in inline content. ---> -<!ELEMENT ins %Flow;> -<!ATTLIST ins - %attrs; - cite %URI; #IMPLIED - datetime %Datetime; #IMPLIED - > - -<!ELEMENT del %Flow;> -<!ATTLIST del - %attrs; - cite %URI; #IMPLIED - datetime %Datetime; #IMPLIED - > - -<!--================== The Anchor Element ================================--> - -<!-- content is %Inline; except that anchors shouldn't be nested --> - -<!ELEMENT a %a.content;> -<!ATTLIST a - %attrs; - %focus; - charset %Charset; #IMPLIED - type %ContentType; #IMPLIED - name NMTOKEN #IMPLIED - href %URI; #IMPLIED - hreflang %LanguageCode; #IMPLIED - rel %LinkTypes; #IMPLIED - rev %LinkTypes; #IMPLIED - shape %Shape; "rect" - coords %Coords; #IMPLIED - > - -<!--===================== Inline Elements ================================--> - -<!ELEMENT span %Inline;> <!-- generic language/style container --> -<!ATTLIST span - %attrs; - > - -<!ELEMENT bdo %Inline;> <!-- I18N BiDi over-ride --> -<!ATTLIST bdo - %coreattrs; - %events; - lang %LanguageCode; #IMPLIED - xml:lang %LanguageCode; #IMPLIED - dir (ltr|rtl) #REQUIRED - > - -<!ELEMENT br EMPTY> <!-- forced line break --> -<!ATTLIST br - %coreattrs; - > - -<!ELEMENT em %Inline;> <!-- emphasis --> -<!ATTLIST em %attrs;> - -<!ELEMENT strong %Inline;> <!-- strong emphasis --> -<!ATTLIST strong %attrs;> - -<!ELEMENT dfn %Inline;> <!-- definitional --> -<!ATTLIST dfn %attrs;> - -<!ELEMENT code %Inline;> <!-- program code --> -<!ATTLIST code %attrs;> - -<!ELEMENT samp %Inline;> <!-- sample --> -<!ATTLIST samp %attrs;> - -<!ELEMENT kbd %Inline;> <!-- something user would type --> -<!ATTLIST kbd %attrs;> - -<!ELEMENT var %Inline;> <!-- variable --> -<!ATTLIST var %attrs;> - -<!ELEMENT cite %Inline;> <!-- citation --> -<!ATTLIST cite %attrs;> - -<!ELEMENT abbr %Inline;> <!-- abbreviation --> -<!ATTLIST abbr %attrs;> - -<!ELEMENT acronym %Inline;> <!-- acronym --> -<!ATTLIST acronym %attrs;> - -<!ELEMENT q %Inline;> <!-- inlined quote --> -<!ATTLIST q - %attrs; - cite %URI; #IMPLIED - > - -<!ELEMENT sub %Inline;> <!-- subscript --> -<!ATTLIST sub %attrs;> - -<!ELEMENT sup %Inline;> <!-- superscript --> -<!ATTLIST sup %attrs;> - -<!ELEMENT tt %Inline;> <!-- fixed pitch font --> -<!ATTLIST tt %attrs;> - -<!ELEMENT i %Inline;> <!-- italic font --> -<!ATTLIST i %attrs;> - -<!ELEMENT b %Inline;> <!-- bold font --> -<!ATTLIST b %attrs;> - -<!ELEMENT big %Inline;> <!-- bigger font --> -<!ATTLIST big %attrs;> - -<!ELEMENT small %Inline;> <!-- smaller font --> -<!ATTLIST small %attrs;> - -<!--==================== Object ======================================--> -<!-- - object is used to embed objects as part of HTML pages. - param elements should precede other content. Parameters - can also be expressed as attribute/value pairs on the - object element itself when brevity is desired. ---> - -<!ELEMENT object (#PCDATA | param | %block; | form | %inline; | %misc;)*> -<!ATTLIST object - %attrs; - declare (declare) #IMPLIED - classid %URI; #IMPLIED - codebase %URI; #IMPLIED - data %URI; #IMPLIED - type %ContentType; #IMPLIED - codetype %ContentType; #IMPLIED - archive %UriList; #IMPLIED - standby %Text; #IMPLIED - height %Length; #IMPLIED - width %Length; #IMPLIED - usemap %URI; #IMPLIED - name NMTOKEN #IMPLIED - tabindex %Number; #IMPLIED - > - -<!-- - param is used to supply a named property value. - In XML it would seem natural to follow RDF and support an - abbreviated syntax where the param elements are replaced - by attribute value pairs on the object start tag. ---> -<!ELEMENT param EMPTY> -<!ATTLIST param - id ID #IMPLIED - name CDATA #IMPLIED - value CDATA #IMPLIED - valuetype (data|ref|object) "data" - type %ContentType; #IMPLIED - > - -<!--=================== Images ===========================================--> - -<!-- - To avoid accessibility problems for people who aren't - able to see the image, you should provide a text - description using the alt and longdesc attributes. - In addition, avoid the use of server-side image maps. - Note that in this DTD there is no name attribute. That - is only available in the transitional and frameset DTD. ---> - -<!ELEMENT img EMPTY> -<!ATTLIST img - %attrs; - src %URI; #REQUIRED - alt %Text; #REQUIRED - longdesc %URI; #IMPLIED - height %Length; #IMPLIED - width %Length; #IMPLIED - usemap %URI; #IMPLIED - ismap (ismap) #IMPLIED - > - -<!-- usemap points to a map element which may be in this document - or an external document, although the latter is not widely supported --> - -<!--================== Client-side image maps ============================--> - -<!-- These can be placed in the same document or grouped in a - separate document although this isn't yet widely supported --> - -<!ELEMENT map ((%block; | form | %misc;)+ | area+)> -<!ATTLIST map - %i18n; - %events; - id ID #REQUIRED - class CDATA #IMPLIED - style %StyleSheet; #IMPLIED - title %Text; #IMPLIED - name NMTOKEN #IMPLIED - > - -<!ELEMENT area EMPTY> -<!ATTLIST area - %attrs; - %focus; - shape %Shape; "rect" - coords %Coords; #IMPLIED - href %URI; #IMPLIED - nohref (nohref) #IMPLIED - alt %Text; #REQUIRED - > - -<!--================ Forms ===============================================--> -<!ELEMENT form %form.content;> <!-- forms shouldn't be nested --> - -<!ATTLIST form - %attrs; - action %URI; #REQUIRED - method (get|post) "get" - enctype %ContentType; "application/x-www-form-urlencoded" - onsubmit %Script; #IMPLIED - onreset %Script; #IMPLIED - accept %ContentTypes; #IMPLIED - accept-charset %Charsets; #IMPLIED - > - -<!-- - Each label must not contain more than ONE field - Label elements shouldn't be nested. ---> -<!ELEMENT label %Inline;> -<!ATTLIST label - %attrs; - for IDREF #IMPLIED - accesskey %Character; #IMPLIED - onfocus %Script; #IMPLIED - onblur %Script; #IMPLIED - > - -<!ENTITY % InputType - "(text | password | checkbox | - radio | submit | reset | - file | hidden | image | button)" - > - -<!-- the name attribute is required for all but submit & reset --> - -<!ELEMENT input EMPTY> <!-- form control --> -<!ATTLIST input - %attrs; - %focus; - type %InputType; "text" - name CDATA #IMPLIED - value CDATA #IMPLIED - checked (checked) #IMPLIED - disabled (disabled) #IMPLIED - readonly (readonly) #IMPLIED - size CDATA #IMPLIED - maxlength %Number; #IMPLIED - src %URI; #IMPLIED - alt CDATA #IMPLIED - usemap %URI; #IMPLIED - onselect %Script; #IMPLIED - onchange %Script; #IMPLIED - accept %ContentTypes; #IMPLIED - > - -<!ELEMENT select (optgroup|option)+> <!-- option selector --> -<!ATTLIST select - %attrs; - name CDATA #IMPLIED - size %Number; #IMPLIED - multiple (multiple) #IMPLIED - disabled (disabled) #IMPLIED - tabindex %Number; #IMPLIED - onfocus %Script; #IMPLIED - onblur %Script; #IMPLIED - onchange %Script; #IMPLIED - > - -<!ELEMENT optgroup (option)+> <!-- option group --> -<!ATTLIST optgroup - %attrs; - disabled (disabled) #IMPLIED - label %Text; #REQUIRED - > - -<!ELEMENT option (#PCDATA)> <!-- selectable choice --> -<!ATTLIST option - %attrs; - selected (selected) #IMPLIED - disabled (disabled) #IMPLIED - label %Text; #IMPLIED - value CDATA #IMPLIED - > - -<!ELEMENT textarea (#PCDATA)> <!-- multi-line text field --> -<!ATTLIST textarea - %attrs; - %focus; - name CDATA #IMPLIED - rows %Number; #REQUIRED - cols %Number; #REQUIRED - disabled (disabled) #IMPLIED - readonly (readonly) #IMPLIED - onselect %Script; #IMPLIED - onchange %Script; #IMPLIED - > - -<!-- - The fieldset element is used to group form fields. - Only one legend element should occur in the content - and if present should only be preceded by whitespace. ---> -<!ELEMENT fieldset (#PCDATA | legend | %block; | form | %inline; | %misc;)*> -<!ATTLIST fieldset - %attrs; - > - -<!ELEMENT legend %Inline;> <!-- fieldset label --> -<!ATTLIST legend - %attrs; - accesskey %Character; #IMPLIED - > - -<!-- - Content is %Flow; excluding a, form and form controls ---> -<!ELEMENT button %button.content;> <!-- push button --> -<!ATTLIST button - %attrs; - %focus; - name CDATA #IMPLIED - value CDATA #IMPLIED - type (button|submit|reset) "submit" - disabled (disabled) #IMPLIED - > - -<!--======================= Tables =======================================--> - -<!-- Derived from IETF HTML table standard, see [RFC1942] --> - -<!-- - The border attribute sets the thickness of the frame around the - table. The default units are screen pixels. - - The frame attribute specifies which parts of the frame around - the table should be rendered. The values are not the same as - CALS to avoid a name clash with the valign attribute. ---> -<!ENTITY % TFrame "(void|above|below|hsides|lhs|rhs|vsides|box|border)"> - -<!-- - The rules attribute defines which rules to draw between cells: - - If rules is absent then assume: - "none" if border is absent or border="0" otherwise "all" ---> - -<!ENTITY % TRules "(none | groups | rows | cols | all)"> - -<!-- horizontal alignment attributes for cell contents - - char alignment char, e.g. char=':' - charoff offset for alignment char ---> -<!ENTITY % cellhalign - "align (left|center|right|justify|char) #IMPLIED - char %Character; #IMPLIED - charoff %Length; #IMPLIED" - > - -<!-- vertical alignment attributes for cell contents --> -<!ENTITY % cellvalign - "valign (top|middle|bottom|baseline) #IMPLIED" - > - -<!ELEMENT table - (caption?, (col*|colgroup*), thead?, tfoot?, (tbody+|tr+))> -<!ELEMENT caption %Inline;> -<!ELEMENT thead (tr)+> -<!ELEMENT tfoot (tr)+> -<!ELEMENT tbody (tr)+> -<!ELEMENT colgroup (col)*> -<!ELEMENT col EMPTY> -<!ELEMENT tr (th|td)+> -<!ELEMENT th %Flow;> -<!ELEMENT td %Flow;> - -<!ATTLIST table - %attrs; - summary %Text; #IMPLIED - width %Length; #IMPLIED - border %Pixels; #IMPLIED - frame %TFrame; #IMPLIED - rules %TRules; #IMPLIED - cellspacing %Length; #IMPLIED - cellpadding %Length; #IMPLIED - > - -<!ATTLIST caption - %attrs; - > - -<!-- -colgroup groups a set of col elements. It allows you to group -several semantically related columns together. ---> -<!ATTLIST colgroup - %attrs; - span %Number; "1" - width %MultiLength; #IMPLIED - %cellhalign; - %cellvalign; - > - -<!-- - col elements define the alignment properties for cells in - one or more columns. - - The width attribute specifies the width of the columns, e.g. - - width=64 width in screen pixels - width=0.5* relative width of 0.5 - - The span attribute causes the attributes of one - col element to apply to more than one column. ---> -<!ATTLIST col - %attrs; - span %Number; "1" - width %MultiLength; #IMPLIED - %cellhalign; - %cellvalign; - > - -<!-- - Use thead to duplicate headers when breaking table - across page boundaries, or for static headers when - tbody sections are rendered in scrolling panel. - - Use tfoot to duplicate footers when breaking table - across page boundaries, or for static footers when - tbody sections are rendered in scrolling panel. - - Use multiple tbody sections when rules are needed - between groups of table rows. ---> -<!ATTLIST thead - %attrs; - %cellhalign; - %cellvalign; - > - -<!ATTLIST tfoot - %attrs; - %cellhalign; - %cellvalign; - > - -<!ATTLIST tbody - %attrs; - %cellhalign; - %cellvalign; - > - -<!ATTLIST tr - %attrs; - %cellhalign; - %cellvalign; - > - - -<!-- Scope is simpler than headers attribute for common tables --> -<!ENTITY % Scope "(row|col|rowgroup|colgroup)"> - -<!-- th is for headers, td for data and for cells acting as both --> - -<!ATTLIST th - %attrs; - abbr %Text; #IMPLIED - axis CDATA #IMPLIED - headers IDREFS #IMPLIED - scope %Scope; #IMPLIED - rowspan %Number; "1" - colspan %Number; "1" - %cellhalign; - %cellvalign; - > - -<!ATTLIST td - %attrs; - abbr %Text; #IMPLIED - axis CDATA #IMPLIED - headers IDREFS #IMPLIED - scope %Scope; #IMPLIED - rowspan %Number; "1" - colspan %Number; "1" - %cellhalign; - %cellvalign; - > @@ -23,6 +23,15 @@ cmake_version_component() " } +# Install destination extraction function. +cmake_install_dest_default() +{ + cat "${cmake_source_dir}/Source/CMakeInstallDestinations.cmake" | sed -n ' +/^ *set(CMAKE_'"${1}"'_DIR_DEFAULT.*) # '"${2}"'$/ { + s/^ *set(CMAKE_'"${1}"'_DIR_DEFAULT *"\([^"]*\)").*$/\1/;p;q;} +' +} + cmake_toupper() { echo "$1" | sed 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/' @@ -42,18 +51,30 @@ cmake_version_tweak="`cmake_version_component TWEAK`" if [ "$cmake_version_tweak" != "0" ]; then cmake_version="${cmake_version}.${cmake_version_tweak}" fi +cmake_version_rc="`cmake_version_component RC`" +if [ "$cmake_version_rc" != "" ]; then + cmake_version="${cmake_version}-rc${cmake_version_rc}" +fi -cmake_data_dir="share/cmake-${cmake_version_major}.${cmake_version_minor}" -cmake_doc_dir="doc/cmake-${cmake_version_major}.${cmake_version_minor}" -cmake_man_dir="man" +cmake_data_dir_keyword="OTHER" +cmake_doc_dir_keyword="OTHER" +cmake_man_dir_keyword="OTHER" +cmake_data_dir="" +cmake_doc_dir="" +cmake_man_dir="" cmake_init_file="" cmake_bootstrap_system_libs="" cmake_bootstrap_qt_gui="" cmake_bootstrap_qt_qmake="" +cmake_sphinx_man="" +cmake_sphinx_html="" +cmake_sphinx_build="" # Determine whether this is a Cygwin environment. if echo "${cmake_system}" | grep CYGWIN >/dev/null 2>&1; then cmake_system_cygwin=true + cmake_doc_dir_keyword="CYGWIN" + cmake_man_dir_keyword="CYGWIN" else cmake_system_cygwin=false fi @@ -75,6 +96,8 @@ fi # Determine whether this is BeOS if echo "${cmake_system}" | grep BeOS >/dev/null 2>&1; then cmake_system_beos=true + cmake_doc_dir_keyword="HAIKU" + cmake_man_dir_keyword="HAIKU" else cmake_system_beos=false fi @@ -82,6 +105,8 @@ fi # Determine whether this is Haiku if echo "${cmake_system}" | grep Haiku >/dev/null 2>&1; then cmake_system_haiku=true + cmake_doc_dir_keyword="HAIKU" + cmake_man_dir_keyword="HAIKU" else cmake_system_haiku=false fi @@ -160,12 +185,15 @@ if ${cmake_system_mingw}; then fi elif ${cmake_system_haiku}; then cmake_default_prefix=`finddir B_COMMON_DIRECTORY` - cmake_man_dir="documentation/man" - cmake_doc_dir="documentation/doc/cmake-${cmake_version}" else cmake_default_prefix="/usr/local" fi +# Lookup default install destinations. +cmake_data_dir_default="`cmake_install_dest_default DATA ${cmake_data_dir_keyword}`" +cmake_doc_dir_default="`cmake_install_dest_default DOC ${cmake_doc_dir_keyword}`" +cmake_man_dir_default="`cmake_install_dest_default MAN ${cmake_man_dir_keyword}`" + CMAKE_KNOWN_C_COMPILERS="cc gcc xlc icc tcc" CMAKE_KNOWN_CXX_COMPILERS="aCC xlC CC g++ c++ icc como " CMAKE_KNOWN_MAKE_PROCESSORS="gmake make" @@ -205,7 +233,6 @@ CMAKE_CXX_SOURCES="\ cmDepends \ cmDependsC \ cmDocumentationFormatter \ - cmDocumentationFormatterText \ cmPolicies \ cmProperty \ cmPropertyMap \ @@ -255,7 +282,6 @@ CMAKE_CXX_SOURCES="\ cmTest \ cmCustomCommand \ cmCustomCommandGenerator \ - cmDocumentVariables \ cmCacheManager \ cmListFileCache \ cmComputeLinkDepends \ @@ -352,15 +378,19 @@ Configuration: --no-qt-gui do not build the Qt-based GUI (default) --qt-qmake=<qmake> use <qmake> as the qmake executable to find Qt + --sphinx-man build man pages with Sphinx + --sphinx-html build html help with Sphinx + --sphinx-build=<sb> use <sb> as the sphinx-build executable + Directory and file names: --prefix=PREFIX install files in tree rooted at PREFIX ['"${cmake_default_prefix}"'] --datadir=DIR install data files in PREFIX/DIR - ['"${cmake_data_dir}"'] + ['"${cmake_data_dir_default}"'] --docdir=DIR install documentation files in PREFIX/DIR - ['"${cmake_doc_dir}"'] + ['"${cmake_doc_dir_default}"'] --mandir=DIR install man pages files in PREFIX/DIR/manN - ['"${cmake_man_dir}"'] + ['"${cmake_man_dir_default}"'] ' exit 10 } @@ -583,6 +613,9 @@ while test $# != 0; do --qt-gui) cmake_bootstrap_qt_gui="1" ;; --no-qt-gui) cmake_bootstrap_qt_gui="0" ;; --qt-qmake=*) cmake_bootstrap_qt_qmake=`cmake_arg "$1"` ;; + --sphinx-man) cmake_sphinx_man="1" ;; + --sphinx-html) cmake_sphinx_html="1" ;; + --sphinx-build=*) cmake_sphinx_build=`cmake_arg "$1"` ;; --help) cmake_usage ;; --version) cmake_version_display ; exit 2 ;; --verbose) cmake_verbose=TRUE ;; @@ -1404,7 +1437,7 @@ cmake_report cmVersionConfig.h${_tmp} "#define CMake_VERSION_PATCH ${cmake_versi cmake_report cmVersionConfig.h${_tmp} "#define CMake_VERSION_TWEAK ${cmake_version_tweak}" cmake_report cmVersionConfig.h${_tmp} "#define CMake_VERSION \"${cmake_version}\"" cmake_report cmConfigure.h${_tmp} "#define CMAKE_ROOT_DIR \"${cmake_root_dir}\"" -cmake_report cmConfigure.h${_tmp} "#define CMAKE_DATA_DIR \"/${cmake_data_dir}\"" +cmake_report cmConfigure.h${_tmp} "#define CMAKE_DATA_DIR \"/bootstrap-not-insalled\"" cmake_report cmConfigure.h${_tmp} "#define CMAKE_BOOTSTRAP" # Regenerate configured headers @@ -1540,6 +1573,21 @@ if [ "x${cmake_bootstrap_qt_qmake}" != "x" ]; then set (QT_QMAKE_EXECUTABLE "'"${cmake_bootstrap_qt_qmake}"'" CACHE FILEPATH "Location of Qt qmake" FORCE) ' >> "${cmake_bootstrap_dir}/InitialCacheFlags.cmake" fi +if [ "x${cmake_sphinx_man}" != "x" ]; then + echo ' +set (SPHINX_MAN "'"${cmake_sphinx_man}"'" CACHE FILEPATH "Build man pages with Sphinx" FORCE) +' >> "${cmake_bootstrap_dir}/InitialCacheFlags.cmake" +fi +if [ "x${cmake_sphinx_html}" != "x" ]; then + echo ' +set (SPHINX_HTML "'"${cmake_sphinx_html}"'" CACHE FILEPATH "Build html help with Sphinx" FORCE) +' >> "${cmake_bootstrap_dir}/InitialCacheFlags.cmake" +fi +if [ "x${cmake_sphinx_build}" != "x" ]; then + echo ' +set (SPHINX_EXECUTABLE "'"${cmake_sphinx_build}"'" CACHE FILEPATH "Location of Qt sphinx-build" FORCE) +' >> "${cmake_bootstrap_dir}/InitialCacheFlags.cmake" +fi # Add user-specified settings. Handle relative-path case for # specification of cmake_init_file. |