configure_file

Копирует файл в другое место и изменяет его содержимое.

configure_file(<input> <output>
               [COPYONLY] [ESCAPE_QUOTES] [@ONLY]
               [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

Копирует файл <input> в файл <output> и подставляет значения переменных, указанных как @VAR@ или ${VAR} в содержимом входного файла. Каждая ссылка на переменную будет заменена текущим значением переменной или пустой строкой, если переменная не определена. Кроме того, строки входного файла вида:

#cmakedefine VAR ...

будут заменены на:

#define VAR ...

или:

/* #undef VAR */

в зависимости от того, установлено ли значение VAR в CMake, отличное от значения, которое рассматривается как ложное константой командой if(). Содержимое «…», если оно есть, после имени переменной обрабатывается аналогичным образом. Строки входного файла вида #cmakedefine01 VAR будут заменены на #define VAR 1 или #define VAR 0 аналогичным образом.

Если входной файл изменён, система сборки повторно запустит CMake, чтобы переконфигурировать файл и сгенерировать систему сборки заново.

Аргументы:

<input>

Путь к входному файлу. Относительный путь учитывается относительно значения CMAKE_CURRENT_SOURCE_DIR. Входной путь должен указывать на файл, а не на директорию.

<output>

Путь к выходному файлу или директории. Относительный путь учитывается относительно значения CMAKE_CURRENT_BINARY_DIR. Если путь указывает на существующую директорию, выходной файл помещается в эту директорию с тем же именем файла, что и входной файл.

COPYONLY

Копирует файл без замены ссылок на переменные или другого содержимого. Этот параметр нельзя использовать с NEWLINE_STYLE.

ESCAPE_QUOTES

Экранирует любые заменённые кавычки обратными слешами (в стиле C).

@ONLY

Ограничивает замену переменных ссылками вида @VAR@. Это полезно для конфигурирования скриптов, использующих синтаксис ${VAR}.

NEWLINE_STYLE <style>

Указывает стиль новой строки для выходного файла. Укажите UNIX или LF для новых строк \n, или укажите DOS, WIN32, или CRLF для новых строк \r\n. Этот параметр нельзя использовать с COPYONLY.

Пример

Рассмотрим исходное дерево, содержащее файл %%%CODE_BLOCK_32%%:

#cmakedefine FOO_ENABLE
#cmakedefine FOO_STRING "@FOO_STRING@"

Смежный файл CMakeLists.txt может использовать configure_file для конфигурирования заголовка:

option(FOO_ENABLE "Enable Foo" ON)
if(FOO_ENABLE)
  set(FOO_STRING "foo")
endif()
configure_file(foo.h.in foo.h @ONLY)

Это создаёт файл foo.h в директории сборки, соответствующей данной директории исходных файлов. Если включён параметр FOO_ENABLE, сконфигурированный файл будет содержать:

#define FOO_ENABLE
#define FOO_STRING "foo"

В противном случае он будет содержать:

/* #undef FOO_ENABLE */
/* #undef FOO_STRING */

Затем можно использовать команду include_directories(), чтобы указать выходную директорию в качестве директории включения:

include_directories(${CMAKE_CURRENT_BINARY_DIR})

чтобы источники могли включать заголовок как #include <foo.h>.