Spec-Zone.ru › CMake 3.7

find_program

Краткая форма записи:

find_program (<VAR> name1 [path1 path2 ...])

Общая форма записи:

find_program (
          <VAR>
          name | NAMES name1 [name2 ...] [NAMES_PER_DIR]
          [HINTS path1 [path2 ... ENV var]]
          [PATHS path1 [path2 ... ENV var]]
          [PATH_SUFFIXES suffix1 [suffix2 ...]]
          [DOC "cache documentation string"]
          [NO_DEFAULT_PATH]
          [NO_CMAKE_ENVIRONMENT_PATH]
          [NO_CMAKE_PATH]
          [NO_SYSTEM_ENVIRONMENT_PATH]
          [NO_CMAKE_SYSTEM_PATH]
          [CMAKE_FIND_ROOT_PATH_BOTH |
           ONLY_CMAKE_FIND_ROOT_PATH |
           NO_CMAKE_FIND_ROOT_PATH]
         )

Эта команда используется для поиска программы. Для хранения результата этой команды создается запись кэша с именем <VAR>. Если программа найдена, результат сохраняется в переменной, и поиск не повторяется, пока переменная не будет очищена. Если ничего не найдено, результатом будет <VAR>-NOTFOUND, и при следующем вызове find_program с той же переменной поиск будет выполнен снова.

Доступны следующие параметры:

NAMES

Указывает одно или несколько возможных имен программы.

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

HINTS, PATHS
Указывает дополнительные каталоги для поиска помимо расположений по умолчанию. Подпараметр ENV var считывает пути из системной переменной окружения.
PATH_SUFFIXES
Указывает дополнительные подкаталоги для проверки внутри каждого учитываемого каталога.
DOC
Указывает строку описания для записи кэша <VAR>.

Если указан параметр NO_DEFAULT_PATH, дополнительные пути для поиска не добавляются. Если параметр NO_DEFAULT_PATH не указан, поиск выполняется следующим образом:

  1. Поиск путей, указанных в переменных кэша, специфичных для CMake. Они предназначены для использования в командной строке с параметром -DVAR=value. Этот этап можно пропустить, передав NO_CMAKE_PATH.
    • <prefix>/[s]bin для каждого <prefix> в CMAKE_PREFIX_PATH
    • CMAKE_PROGRAM_PATH
    • CMAKE_APPBUNDLE_PATH
  2. Поиск путей, указанных в переменных окружения, специфичных для CMake. Они предназначены для установки в конфигурации оболочки пользователя. Этот этап можно пропустить, передав NO_CMAKE_ENVIRONMENT_PATH.
    • <prefix>/[s]bin для каждого <prefix> в CMAKE_PREFIX_PATH
    • CMAKE_PROGRAM_PATH
    • CMAKE_APPBUNDLE_PATH
  3. Поиск путей, указанных в параметре HINTS. Это должны быть пути, полученные в результате анализа системы, например подсказка, основанная на расположении уже найденного элемента. Жестко заданные предположительные пути следует указывать с помощью параметра PATHS.
  4. Поиск в стандартных системных переменных окружения. Этот этап можно пропустить, передав аргумент NO_SYSTEM_ENVIRONMENT_PATH.
    • PATH
  5. Поиск в переменных CMake, определенных в файлах Platform для текущей системы. Этот этап можно пропустить, передав NO_CMAKE_SYSTEM_PATH.
    • <prefix>/[s]bin для каждого <prefix> в CMAKE_SYSTEM_PREFIX_PATH
    • CMAKE_SYSTEM_PROGRAM_PATH
    • CMAKE_SYSTEM_APPBUNDLE_PATH
  6. Поиск путей, указанных в параметре PATHS или в краткой форме команды. Обычно это жестко заданные предположительные пути.

В OS X переменные CMAKE_FIND_FRAMEWORK и CMAKE_FIND_APPBUNDLE определяют порядок предпочтения между компонентами пакетов в стиле Apple и в стиле Unix.

Переменная CMake CMAKE_FIND_ROOT_PATH указывает один или несколько каталогов, добавляемых в начало списка всех остальных каталогов поиска. Фактически это переносит корень всего поиска в заданные расположения. Пути, являющиеся потомками CMAKE_STAGING_PREFIX, исключаются из этого переноса, поскольку эта переменная всегда указывает путь в целевой системе. По умолчанию CMAKE_FIND_ROOT_PATH пуста.

Переменная CMAKE_SYSROOT также позволяет указать ровно один каталог, используемый в качестве префикса. Установка CMAKE_SYSROOT имеет и другие последствия. Дополнительные сведения см. в документации к этой переменной.

Эти переменные особенно полезны при кросс-компиляции: с их помощью можно указать корневой каталог целевой среды, где CMake также будет выполнять поиск. По умолчанию сначала выполняется поиск в каталогах, перечисленных в CMAKE_FIND_ROOT_PATH, затем — в каталоге CMAKE_SYSROOT, после чего поиск выполняется в каталогах без перенесенного корня. Поведение по умолчанию можно изменить, задав CMAKE_FIND_ROOT_PATH_MODE_PROGRAM. Это поведение можно вручную переопределить для отдельного вызова с помощью параметров:

CMAKE_FIND_ROOT_PATH_BOTH
Выполнять поиск в описанном выше порядке.
NO_CMAKE_FIND_ROOT_PATH
Не использовать переменную CMAKE_FIND_ROOT_PATH.
ONLY_CMAKE_FIND_ROOT_PATH
Выполнять поиск только в каталогах с перенесенным корнем и каталогах внутри CMAKE_STAGING_PREFIX.

Порядок поиска по умолчанию рассчитан на переход от наиболее конкретных вариантов к наименее конкретным в типичных случаях использования. Проекты могут переопределить порядок, просто вызвав команду несколько раз и используя параметры NO_*:

find_program (<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_program (<VAR> NAMES name)

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

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

© 2000–2019 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.7/command/find_program.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API