define_property

Определение и документирование пользовательских свойств.

define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |
                 TEST | VARIABLE | CACHED_VARIABLE>
                 PROPERTY <name> [INHERITED]
                 BRIEF_DOCS <brief-doc> [docs...]
                 FULL_DOCS <full-doc> [docs...])

Определите одно свойство в области видимости для использования с командами set_property() и get_property(). Это в первую очередь полезно для связывания документации с именами свойств, которые могут быть получены с помощью команды get_property(). Первый аргумент определяет тип области видимости, в которой должно использоваться свойство. Он должен быть одним из следующих:

GLOBAL    = associated with the global namespace
DIRECTORY = associated with one directory
TARGET    = associated with one target
SOURCE    = associated with one source file
TEST      = associated with a test named with add_test
VARIABLE  = documents a CMake language variable
CACHED_VARIABLE = documents a CMake cache variable

Обратите внимание, что в отличие от set_property() и get_property(), никакой фактической области видимости не требуется; важен только тип области видимости.

Требуемый PROPERTY параметр сразу же следует за именем определяемого свойства.

Если указан параметр INHERITED, то команда get_property() будет переходить к следующей более высокой области видимости, когда запрашиваемое свойство не установлено в заданной области видимости команды.

• DIRECTORY область видимости переходит в область видимости родительского каталога, продолжая подниматься по родительским каталогам до тех пор, пока свойство не будет установлено в каталоге или пока больше нет родителей. Если свойство не найдено даже в корневом каталоге, оно переходит в GLOBAL область видимости.
• TARGET, SOURCE и TEST свойства переходят в DIRECTORY область видимости, включая дальнейшее цепное переключение по каталогам и т.д., если это необходимо.

Обратите внимание, что это поведение цепочки областей видимости применяется только к вызовам get_property(), get_directory_property(), get_target_property(), get_source_file_property() и get_test_property(). При установке свойств поведения наследования нет, поэтому использование APPEND или APPEND_STRING с командой set_property() не будет учитывать унаследованные значения при определении содержимого, которое нужно добавить.

Параметры BRIEF_DOCS и FULL_DOCS следуют за строками, которые должны быть связаны со свойством в качестве краткого и полного описания. Соответствующие параметры команды get_property() позволят получить документацию.