Функции замены

qmake предоставляет функции для обработки содержимого переменных во время процесса конфигурации. Эти функции называются функциями замены. Обычно они возвращают значения, которые можно присвоить другим переменным. Эти значения можно получить, добавив перед функцией оператор $$. Функции замены можно разделить на встроенные функции и функции библиотек.

См. также Функции тестирования.

Встроенные функции замены

Основные функции замены реализованы как встроенные функции.

absolute_path(path[, base])

Возвращает абсолютный путь к path.

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

Например, следующий вызов возвращает строку "/home/johndoe/myproject/readme.txt":

message($$absolute_path("readme.txt", "/home/johndoe/myproject"))

Эта функция была введена в Qt 5.0.

См. также clean_path(), relative_path().

basename(variablename)

Возвращает имя файла, указанное в variablename.

Например:

FILE = /etc/passwd
FILENAME = $$basename(FILE) #passwd

cat(filename[, mode])

Возвращает содержимое filename. Вы можете указать следующие параметры для mode:

• blob возвращает всё содержимое файла как одно значение
• lines возвращает каждую строку как отдельное значение (без символов конца строки)
• true (значение по умолчанию) и false возвращают содержимое файла как отдельные значения, разбитые по правилам разбиения списка значений qmake (как в присваивании переменным). Если mode равно false, значения, содержащие только символ новой строки, вставляются в список, чтобы указать, где в файле были разрывы строк.

clean_path(path)

Возвращает path с нормализованными разделителями каталогов (преобразованными в "/") и удалёнными избыточными, и разрешёнными "." и ".." (по возможности). Эта функция является обёрткой вокруг QDir::cleanPath.

Эта функция была введена в Qt 5.0.

См. также absolute_path(), relative_path(), shell_path(), system_path().

dirname(file)

Возвращает имя части директории указанного файла. Например:

FILE = /etc/X11R6/XF86Config
DIRNAME = $$dirname(FILE) #/etc/X11R6

enumerate_vars

Возвращает список всех определённых имён переменных.

Эта функция была введена в Qt 5.0.

escape_expand(arg1 [, arg2 ..., argn])

Принимает произвольное количество аргументов. Она расширяет последовательности экранирования \n, \r, \t для каждого аргумента и возвращает аргументы в виде списка.

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

message("First line$$escape_expand(\\n)Second line")

find(variablename, substr)

Возвращает все значения в variablename которые соответствуют регулярному выражению substr.

MY_VAR = one two three four
MY_VAR2 = $$join(MY_VAR, " -L", -L) -Lfive
MY_VAR3 = $$member(MY_VAR, 2) $$find(MY_VAR, t.*)

MY_VAR2 будет содержать '-Lone -Ltwo -Lthree -Lfour -Lfive', а MY_VAR3 — 'three two three'.

files(pattern[, recursive=false])

Расширяет указанный шаблон подстановок и возвращает список имён файлов. Если recursive равно true, эта функция спускается в подкаталоги.

first(variablename)

Возвращает первое значение variablename.

Например, следующий вызов возвращает firstname:

CONTACT = firstname middlename surname phone
message($$first(CONTACT))

См. также take_first(), last().

format_number(number[, options...])

Возвращает number в формате, заданном options. Вы можете указать следующие параметры:

• ibase=n задаёт основание входного числа n
• obase=n задаёт основание выходного числа n
• width=n задаёт минимальную ширину выходного числа n. Если выходное число короче width, оно дополняется пробелами
• zeropad дополняет выходное число нулями вместо пробелов
• padsign добавляет пробел перед положительными значениями в выводе
• alwayssign добавляет знак «плюс» перед положительными значениями в выводе
• leftalign размещает заполнение справа от значения в выводе

Числа с плавающей точкой в настоящее время не поддерживаются.

Например, следующий вызов преобразует шестнадцатеричное число BAD в 002989:

message($$format_number(BAD, ibase=16 width=6 zeropad))

Эта функция была введена в Qt 5.0.

fromfile(filename, variablename)

Вычисляет filename как файл проекта qmake и возвращает значение, присвоенное variablename.

См. также infile().

getenv(variablename)

Возвращает значение переменной среды variablename. Это в основном эквивалентно синтаксису $$(variablename). Однако функция getenv поддерживает переменные среды с скобками в их имени.

Эта функция была введена в Qt 5.12.

join(variablename, glue, before, after)

Объединяет значение variablename со значением glue. Если это значение не пустое, эта функция предваряет его before и добавляет в конце after. variablename — единственное обязательное поле, остальные по умолчанию пусты. Если вам нужно закодировать пробелы в glue, before, или after, вы должны их экранировать.

last(variablename)

Возвращает последнее значение variablename.

Например, следующий вызов возвращает phone:

CONTACT = firstname middlename surname phone
message($$last(CONTACT))

См. также take_last(), first().

list(arg1 [, arg2 ..., argn])

Принимает произвольное количество аргументов. Она создаёт переменную с уникальным именем, содержащую список аргументов, и возвращает имя этой переменной. Вы можете использовать эту переменную для написания цикла, как показано в следующем фрагменте кода:

for(var, $$list(foo bar baz)) {
    ...
}

вместо:

values = foo bar baz
for(var, values) {
    ...
}

lower(arg1 [, arg2 ..., argn])

Принимает произвольное количество аргументов и преобразует их в нижний регистр.

См. также upper().

member(variablename [, start [, end]])

Возвращает срез значения списка variablename с индексами элементов от start до end (включительно).

Если start не указано, оно по умолчанию равно нулю. Это использование эквивалентно $$first(variablename).

Если end не указано, оно по умолчанию равно start. Это использование представляет собой простой индексирование массива, так как будет возвращён ровно один элемент.

Также можно указать start и end в одном аргументе, разделив числа двумя точками.

Отрицательные числа представляют индексы, начинающиеся с конца списка, где -1 — последний элемент.

Если любой из индексов выходит за пределы диапазона, возвращается пустой список.

Если end меньше start, элементы возвращаются в обратном порядке.

Примечание: Тот факт, что конечный индекс включительный и неупорядоченный, подразумевает, что пустой список будет возвращён только тогда, когда индекс недействителен (что подразумевается пустой переменной ввода).

См. также str_member().

num_add(arg1 [, arg2 ..., argn])

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

Вычитание неявно поддерживается, так как можно просто добавить знак минус перед числовым значением для его отрицания:

sum = $$num_add($$first, -$$second)

Если операнд может быть уже отрицательным, необходим другой шаг для нормализации числа:

second_neg = -$$second
second_neg ~= s/^--//
sum = $$num_add($$first, $$second_neg)

Эта функция была введена в Qt 5.8.

prompt(question [, decorate])

Отображает указанный question и возвращает значение, считанное со стандартного ввода.

Если decorate равно true (значение по умолчанию), к вопросу добавляются префикс и суффикс, определяющие его как запрос.

quote(string)

Преобразует всю string в единый сущность и возвращает результат. Это просто изящный способ заключить строку в двойные кавычки.

re_escape(string)

Возвращает string с каждым специальным символом регулярного выражения, экранированным обратной косой чертой. Эта функция является обёрткой вокруг QRegExp::escape.

read_registry(tree, key[, flag])

Возвращает значение ключа реестра key внутри дерева tree.

Поддерживаются только деревья HKEY_CURRENT_USER (HKCU) и HKEY_LOCAL_MACHINE (HKLM).

flag может быть WOW64_32KEY (32) или WOW64_64KEY (64).

Примечание: Эта функция доступна только на системах Windows.

Эта функция была введена в Qt 5.12.1.

relative_path(filePath[, base])

Возвращает путь к filePath относительно base.

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

Если filePath относительный, он сначала разрешается относительно базовой директории; в этом случае эта функция фактически действует как $$clean_path().

Эта функция была введена в Qt 5.0.

См. также absolute_path(), clean_path().

replace(string, old_string, new_string)

Заменяет каждую строку old_string на new_string в содержимом переменной, переданной как string. Например, код

MESSAGE = This is a tent.
message($$replace(MESSAGE, tent, test))

выводит сообщение:

This is a test.

resolve_depends(variablename, prefix)

Это внутренняя функция, которой вам, как правило, не потребуется.

Эта функция была представлена в Qt 5.0.

reverse(variablename)

Возвращает значения variablename в обратном порядке.

Эта функция была представлена в Qt 5.0.

section(variablename, separator, begin, end)

Возвращает часть значения variablename. Эта функция является обёрткой вокруг QString::section.

Например, следующий вызов выводит surname:

CONTACT = firstname:middlename:surname:phone
message($$section(CONTACT, :, 2, 2))

shadowed(path)

Преобразует путь из каталога исходного проекта в каталог сборки. Эта функция возвращает path для сборок из исходного кода. Она возвращает пустую строку, если path указывает на расположение вне дерева исходного кода.

Эта функция была представлена в Qt 5.0.

shell_path(path)

Преобразует все разделители каталогов в path в разделители, совместимые с оболочкой, используемой при сборке проекта (то есть, оболочкой, вызываемой инструментом make). Например, косые черты преобразуются в обратные слеши при использовании оболочки Windows.

Эта функция была представлена в Qt 5.0.

См. также system_path().

shell_quote(arg)

Приводит arg в кавычки для оболочки, используемой при сборке проекта.

Эта функция была представлена в Qt 5.0.

См. также system_quote().

size(variablename)

Возвращает количество значений variablename.

См. также str_size().

sort_depends(variablename, prefix)

Это внутренняя функция, которой вам, как правило, не потребуется.

Эта функция была представлена в Qt 5.0.

sorted(variablename)

Возвращает список значений в variablename с элементами, отсортированными по возрастанию в ASCII порядке.

Числовая сортировка может быть выполнена путём дополнения значений нулями до фиксированной длины с помощью функции format_number().

Эта функция была представлена в Qt 5.8.

split(variablename, separator)

Разделяет значение variablename на отдельные значения и возвращает их как список. Эта функция является обёрткой вокруг QString::split.

Например:

CONTACT = firstname:middlename:surname:phone
message($$split(CONTACT, :))

sprintf(string, arguments...)

Заменяет %1-%9 в string на аргументы, переданные в списке аргументов функции arguments, и возвращает обработанную строку.

str_member(arg [, start [, end]])

Эта функция идентична member(), за исключением того, что она работает со строковым значением вместо переменной списка, и, следовательно, индексы относятся к позициям символов.

Эта функция может использоваться для реализации многих общих операций среза строк:

# $$left(VAR, len)
left = $$str_member(VAR, 0, $$num_add($$len, -1))

# $$right(VAR, len)
right = $$str_member(VAR, -$$num, -1)

# $$mid(VAR, off, len)
mid = $$str_member(VAR, $$off, $$num_add($$off, $$len, -1))

# $$mid(VAR, off)
mid = $$str_member(VAR, $$off, -1)

# $$reverse(VAR)
reverse = $$str_member(VAR, -1, 0)

Примечание: В этих реализациях необходимо отдельно обработать нулевой len аргумент.

См. также member(), num_add().

Эта функция была представлена в Qt 5.8.

str_size(arg)

Возвращает количество символов в аргументе.

См. также size().

Эта функция была представлена в Qt 5.8.

system(command[, mode[, stsvar]])

Вы можете использовать этот вариант функции system для получения stdout от команды и присвоения его переменной.

Например:

UNAME = $$system(uname -s)
contains( UNAME, [lL]inux ):message( This looks like Linux ($$UNAME) to me )

Как и $$cat(), аргумент mode принимает blob, lines, true, и false в качестве значения. Однако правила разделения слов в старой версии (т.е. пустые или true, и false) немного отличаются.

Если вы передадите stsvar, код выхода команды будет сохранён в этой переменной. Если команда аварийно завершится, статус будет -1, иначе — ненулевой код выхода, выбранный командой. Обычно достаточно сравнить статус с нулём (успех).

См. также тестовую версию system().

system_path(path)

Преобразует все разделители каталогов в path в разделители, совместимые с оболочкой, используемой функциями system() для вызова команд. Например, косые черты преобразуются в обратные слеши для оболочки Windows.

Эта функция была представлена в Qt 5.0.

См. также shell_path().

system_quote(arg)

Приводит arg в кавычки для оболочки, используемой функциями system().

Эта функция была представлена в Qt 5.0.

См. также shell_quote().

take_first(variablename)

Возвращает первое значение из variablename и удаляет его из исходной переменной.

Это удобно для реализации очередей, например.

Эта функция была представлена в Qt 5.8.

См. также take_last(), first().

take_last(variablename)

Возвращает последнее значение из variablename и удаляет его из исходной переменной.

Это удобно для реализации стеков, например.

Эта функция была представлена в Qt 5.8.

См. также take_first(), last().

unique(variablename)

Возвращает список значений из variablename с удаленными дублирующимися элементами. Например:

ARGS = 1 2 3 2 5 1
ARGS = $$unique(ARGS) #1 2 3 5

upper(arg1 [, arg2 ..., argn])

Принимает любое количество аргументов и преобразует их в верхний регистр.

См. также lower().

val_escape(variablename)

Экранирует значения variablename таким образом, чтобы они могли быть обработаны как код qmake.

Эта функция была представлена в Qt 5.0.