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() будут извлекать документацию.