set

Устанавливает переменную обычного, кэша или среды заданному значению. См. документацию cmake-language(7) переменные для области действия и взаимодействия обычных переменных и записей кэша.

Подписи этой команды, которые задают <value>... заполнитель, ожидают ноль или более аргументов. Несколько аргументов будут объединены как список, разделённый точкой с запятой, чтобы сформировать фактическое значение переменной, которое будет установлено.

Установить обычную переменную

set(<variable> <value>... [PARENT_SCOPE])

Установить или сбросить <variable> в текущей области действия функции или каталога:

• Если задан хотя бы один <value>..., установить переменную в это значение.
• Если значение не задано, сбросить переменную. Это эквивалентно unset(<variable>).

Если задан параметр PARENT_SCOPE, переменная будет установлена в области действия, выше текущей области действия. Каждый новый каталог или команда function() создаёт новую область действия. Область действия также может быть создана с помощью команды block(). set(PARENT_SCOPE) установит значение переменной в родительский каталог, вызывающую функцию или охватывающую область (в зависимости от ситуации). Предыдущее состояние значения переменной остаётся неизменным в текущей области действия (например, если оно было неопределено ранее, оно всё ещё неопределено, а если оно имело значение, это значение всё ещё сохраняется).

Команды block(PROPAGATE) и return(PROPAGATE) могут быть использованы в качестве альтернативного метода для команд set(PARENT_SCOPE) и unset(PARENT_SCOPE) для обновления родительской области действия.

Установить запись кэша

set(<variable> <value>... CACHE <type> <docstring> [FORCE])

Устанавливает заданную запись кэша <variable> (запись кэша). Поскольку записи кэша предназначены для предоставления настраиваемых пользователем значений, по умолчанию это не перезаписывает существующие записи кэша. Используйте параметр FORCE для перезаписи существующих записей.

<type> должен быть задан как один из:

BOOL

Булево ON/OFF значение. cmake-gui(1) предлагает флажок.

FILEPATH

Путь к файлу на диске. cmake-gui(1) предлагает диалог выбора файла.

PATH

Путь к каталогу на диске. cmake-gui(1) предлагает диалог выбора файла.

STRING

Строка текста. cmake-gui(1) предлагает текстовое поле или раскрывающийся список, если свойство записи кэша STRINGS установлено.

INTERNAL

Строка текста. cmake-gui(1) не отображает внутренние записи. Они могут использоваться для хранения переменных на протяжении нескольких запусков. Использование этого типа подразумевает FORCE.

<docstring> должен быть задан как строка текста, предоставляющая краткое описание параметра для отображения пользователям cmake-gui(1).

Если запись кэша не существует до вызова или задан параметр FORCE, то запись кэша будет установлена в заданное значение.

Примечание

Содержимое переменной кэша не будет напрямую доступно, если обычная переменная с тем же именем уже существует (см. правила оценки переменных). Если политика CMP0126 установлена в OLD, любое привязывание обычной переменной в текущей области действия будет удалено.

Возможно, что запись кэша существует до вызова, но тип не задан, если она была создана в команде cmake(1) пользователем через параметр -D<var>=<value> без указания типа. В этом случае команда set добавит тип. Кроме того, если <type> равняется PATH или FILEPATH, а <value> предоставленный в командной строке — это относительный путь, то команда set обработает путь как относительный к текущей рабочей директории и преобразует его в абсолютный путь.

Установить переменную среды

set(ENV{<variable>} [<value>])

Устанавливает Environment Variable заданному значению. Последующие вызовы $ENV{<variable>} вернут это новое значение.

Эта команда влияет только на текущий процесс CMake, а не на процесс, из которого был вызван CMake, ни на системную среду в целом, ни на среду последующих процессов сборки или тестирования.

Если после ENV{<variable>} нет аргументов или если <value> — пустая строка, то эта команда очистит любое существующее значение переменной среды.

Аргументы после <value> игнорируются. Если дополнительные аргументы найдены, то выводится предупреждение автора.

См. также

• unset()