set

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

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

Установка обычной переменной

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

Устанавливает или сбрасывает <variable> в текущем функционном или директорном пространстве:

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

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

Команды 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()