CMake Style Guide

Utensil Song edited this page Apr 25, 2016 · 6 revisions
Clone this wiki locally

Note: See also A Quick Primer on CMake

Naming

Functions: lower_case name. Ex: do_something(...)

Local variables: lower_case name. Local variables are used exclusively inside the file that contained them, and their values were simply passed as parameters to CMake functions. Ex: set(some_variable "...")

Global variables: UPPER_CASE name. Global variables(can also be called "export variables") are intended for exporting up/down-stream via the environment variable mechanism. Ex: set(SOME_VARIABLE "...")

Control statements: lower_case name without repeat the condition in the closing brackets. Ex:

if(condition)
  ...
else() # not repeat condition
  ...
endif() # not repeat condition

Operators: UPPER_CASE name. Ex: if(condition STREQUAL "")

Directives and/or extra options: UPPER_CASE name. Ex: do_something(... USE_THIS)

Examples

An real-world example:

function(set_platform system_name)
  if(${system_name} MATCHES "Darwin")
    set(PLATFORM "darwin")
  elseif(${system_name} MATCHES "Linux")
    set(PLATFORM "linux")
  else()
    set(PLATFORM "")
  endif()
endfunction()

cmake_minimum_required(VERSION 3.0)
set_platform(${CMAKE_SYSTEM_NAME})