Policies/CMake Coding Style - Revision history

Krop: /* Avoid Micro-Optimzations */

2012-12-26T09:18:11Z

‎Avoid Micro-Optimzations

2012-01-15T13:46:58Z

2012-01-15T13:39:31Z

2012-01-15T13:32:42Z

2012-01-14T20:06:10Z

2012-01-14T20:04:03Z

‎Upper/lower casing

2011-09-17T15:55:33Z

new "End Commands" section

2011-09-17T15:47:33Z

lowercase

2011-09-17T15:45:36Z

‎Upper/lower casing: lower-case is preferred over upper-case

2011-09-17T15:42:29Z

‎Indentation: lowercase. also mention not to use tabs

@@ Line 80: / Line 80: @@
 For checking the results inside the Find-module, the macro find_package_handle_standard_args() (coming with CMake) should be used, using the new extended syntax, which supports also version checking.
-==Avoid Micro-Optimzations==
+==Avoid Micro-Optimizations==
 Micro-optimizations like
 <pre>

← Older revision		Revision as of 13:46, 15 January 2012
Line 101:		Line 101:

	So, do not add such code. It is unnecessary and makes the modules look more complicated than necessary.		So, do not add such code. It is unnecessary and makes the modules look more complicated than necessary.
		+
		+	=Writing FooConfig.cmake files=
		+
		+	* See http://quickgit.kde.org/?p=kdeexamples.git&a=tree&hb=HEAD&f=buildsystem/HowToInstallALibrary for a fully commented example
		+
		+	* See also:
		+	** http://www.cmake.org/Wiki/CMake/Tutorials/Exporting_and_Importing_Targets
		+	** http://www.cmake.org/Wiki/CMake/Tutorials/How_to_create_a_ProjectConfig.cmake_file
		+	** http://www.cmake.org/Wiki/CMake/Tutorials/Packaging

@@ Line 48: / Line 48: @@
 <syntaxhighlight lang="cmake">
 if(FOOVAR)
-  some_command(...)
+   some_command(...)
 else()
-  another_command(...)
+   another_command(...)
 endif()
 </syntaxhighlight>
@@ Line 84: / Line 84: @@
 <pre>
 if(FOO_LIBRARY AND FOO_INCLUDE_DIR)
-  set(FOO_FOUND TRUE)
+   set(FOO_FOUND TRUE)
 else()
-  ... execute the whole find-logic
+   ... execute the whole find-logic
 endif()
 </pre>
 should be removed, the find-logic should be executed always. These shortcuts can cause problems e.g. when the same file is used from multiple directories but e.g. with different required versions or components etc.

@@ Line 1: / Line 1: @@
 This document describes the recommended coding style for CMake files in KDE, i.e. CMakeLists.txt files and *.cmake files.
 ==Indentation==
@@ Line 44: / Line 48: @@
 <syntaxhighlight lang="cmake">
 if(FOOVAR)
- some_command(...)
+  some_command(...)
 else()
- another_command(...)
+  another_command(...)
 endif()
 </syntaxhighlight>
@@ Line 53: / Line 57: @@
 <pre>
 if(BARVAR)
-  some_other_command(...)
+   some_other_command(...)
 endif(BARVAR)
 </pre>
 ==(Not) Using pkg-config==
@@ Line 66: / Line 72: @@
 * putting something like if(NOT WIN32) around the pkg-config stuff is not necessary (and should be removed if it is somewhere). If pkg-config is not found, e.g. on Windows, the macros simply do nothing.
-==Writing CMake Find-modules==
+==Follow CMake's readme.txt==
-* Follow the style guide from CMake when writing some FindFoo.cmake module:
+Follow the style guide from CMake when writing some FindFoo.cmake module:
 [http://www.cmake.org/cgi-bin/viewcvs.cgi/Modules/readme.txt?root=CMake&view=markup readme.txt]
-* For checking the results inside the Find-module, the macro find_package_handle_standard_args() (coming with CMake) should be used, using the new extended syntax, which supports also version checking.
+==Use FindPackageHandleStandardArgs.cmake==
-* Micro-optimizations like
+==Avoid Micro-Optimzations==
 <pre>
 if(FOO_LIBRARY AND FOO_INCLUDE_DIR)

@@ Line 32: / Line 32: @@
 Mixed casing as shown below works too, but should '''not''' be done within KDE:
-<syntaxhighlight lang="cmake">
+<pre>
 Add_Executable(hello hello.c)
 aDd_ExEcUtAbLe(blub blub.c)
-</syntaxhighlight>
+</pre>
 == End commands ==
@@ Line 42: / Line 42: @@
 For example, do this:
-<pre>
+<syntaxhighlight lang="cmake">
 if(FOOVAR)
   some_command(...)
@@ Line 48: / Line 48: @@
   another_command(...)
 endif()
-</pre>
+</syntaxhighlight>
 and not this:
 <pre>
-if(FOOVAR)
+if(BARVAR)
-   some_command(...)
+   some_other_command(...)
-else(FOOVAR)
+endif(BARVAR)
-  another_command(...)
-endif(FOOVAR)
 </pre>

@@ Line 16: / Line 16: @@
 ==Upper/lower casing==
-CMake commands are case-insensitive (only the commands, not the arguments or variable names). So all the following versions work:
+Most important: use consistent upper- or lowercasing within one file !
 <syntaxhighlight lang="cmake">
 add_executable(foo foo.c)
 ADD_EXECUTABLE(bar bar.c)
 Add_Executable(hello hello.c)
 aDd_ExEcUtAbLe(blub blub.c)
 </syntaxhighlight>
 == End commands ==

@@ Line 9: / Line 9: @@
 * while/endwhile
 * macro/endmacro
-* function/endfunction (CMake 2.6)
+* function/endfunction
 Use spaces for indenting, 2, 3 or 4 spaces preferably. Use the same amount
@@ Line 27: / Line 27: @@
 In KDE the ''all-lowercase'' style is preferred. Mixing upper- and lowercase should not be done in KDE CMake files.
 ==(Not) Using pkg-config==

@@ Line 32: / Line 32: @@
 You are free to use pkg-config in FindXXX.cmake modules, as long as the following conditions are met:
 * the FindXXX.cmake must also work without pkg-config, as long as the package is either installed to one of the default locations (as /usr or /usr/local) or if CMAKE_PREFIX_PATH is set accordingly
-* use only FIND_PACKAGE(PkgConfig), don't use INCLUDE(UsePkgConfig), this one is deprecated
+* use only find_package(PkgConfig), don't use include(UsePkgConfig), this one is deprecated
-* make sure the variables created by PKG_CHECK_MODULES() are all prefixed with "PC_", so they don't mix up with other variables, e.g. set via FIND_PATH() etc.
+* make sure the variables created by pkg_check_modules() are all prefixed with "PC_", so they don't mix up with other variables, e.g. set via find_path() etc.
 * FindLibXml2.cmake as shipped with CMake 2.8.5 is a good example how pkg-config should be handled
 * putting something like if(NOT WIN32) around the pkg-config stuff is not necessary (and should be removed if it is somewhere). If pkg-config is not found, e.g. on Windows, the macros simply do nothing.

@@ Line 26: / Line 26: @@
 But this would be ugly.
-In KDE the ''all-lowercase style is preferred''. The all-uppercase style is also ok. Mixing upper- and lowercase should not be done in KDE CMake files.
+In KDE the ''all-lowercase'' style is preferred. Mixing upper- and lowercase should not be done in KDE CMake files.
-Although all-lowercase is preferred, if a file is apparently in all-uppercase style, then stay consistent and also use all-uppercase in this file.
 ==(Not) Using pkg-config==

@@ Line 4: / Line 4: @@
 Indent all code correctly, i.e. the body of
-* IF/ELSE/ENDIF
-* FOREACH/ENDFOREACH
+* if/else/endif
-* WHILE/ENDWHILE
+* foreach/endforeach
-* MACRO/ENDMACRO
+* while/endwhile
-* FUNCTION/ENDFUNCTION (CMake 2.6)
+* macro/endmacro
 Use spaces for indenting, 2, 3 or 4 spaces preferably. Use the same amount
-of spaces for indenting as is used in the rest of the file.
+of spaces for indenting as is used in the rest of the file. Do not use tabs.
 ==Upper/lower casing==