Руководство пользователя для GNU Awk

13. Функции, определенные пользователем

Оглавление

• 13.1 Синтаксис определения функции
• 13.2 Примеры определения функций
• 13.3 Вызов пользовательских функций
• 13.4 Оператор return

Сложные awk-программы часто могут быть упрощены определением ваших собственных функций. Пользовательские функции могут вызываться точно так же как и встроенные (см. раздел 7.13 [Вызовы функций], стр. 93), но определять их вы должны сами --- сообщить awk, что они должны делать.

13.1 Синтаксис определения функции

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

Определение функции с именем  name выглядит так:

function name(parameter-list) -
body-of-function ""

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

parameter-list есть список аргументов функции и локальных имен переменных, разделенных запятыми. Когда функция вызывается, имена аргументов используются для помещения значений аргументов, указанных в вызове. Локальные переменные инициализируются пустыми цепочками. Функция не может иметь двух параметров с одинаковыми именами.

Тело функции состоит из операторов awk. Это наиболее важная часть определения, так как она говорит, что функция должна делать. Имена аргументов существуют, чтобы дать телу возможность различать аргументы; локальные переменные предоставляют телу места для временных значений. Синтаксически имена аргументов неотличимы от имен локальных переменных; вместо этого, количество аргументов, указанных в вызове функции, определяет, как много имеется аргументных переменных. Так, если даны три значения аргументов, первые три имени в списке параметров есть аргументы, а остальные являются локальными переменными. Если количество аргументов не одно и тоже во всех вызовах функции, некоторые имена в списке параметров могут быть аргументами в одних случаях и локальными переменными в других. Иначе говоря, можно считать, что опущенные аргументы по умолчанию получают значение пустой цепочки.

Обычно, когда вы пишите функцию, вы знаете, сколько имен вы намерены использовать для аргументов и сколько для локальных переменных. При программировании обычно помещают несколько дополнительных пробелов между аргументами и локальными переменными для указания того, как функция будет использоваться. Во время выполнения тела функции аргументы и значения локальных переменных прячут, или затеняют, те же самые имена, использованные в остальной программе. Затененные переменные недоступны из определения функции, потому что невозможно обратиться к ним, пока их имена заняты локальными переменными. Все другие переменные, используемые в awk-программе, доступны для ссылок или присваиваний из тела функции. Аргументы и локальные переменные играют особую роль только на время выполнения тела функции. Как только оно окончено, можно опять обращаться к переменным, которые были затенены при выполнении тела.

Тело функции может содержать выражения, которые вызывают функции. Они могут даже вызывать определяемую функцию, или непосредственно или через вызов другой функции. Мы говорим в таких случаях, что функция рекурсивна.

Во многих реализациях awk, включая gawk, ключевое слово function может быть сокращено до func. Однако POSIX указывает только слово function. Фактически это имеет некоторые практические следствия. Если gawk находится в POSIX-совместимом режиме (см. раздел 14.1 [Параметры командной строки], стр. 161), то следующий оператор не определяет функцию:

Он определяет правило, которое для каждой записи сцепляет значение переменной `func' с возвращенным значением функции `foo'. Если цепочка-результат не пуста, действие выполняется. И это, конечно, будет не то, что задумано. (awk принимает такой ввод как синтаксически правильный, поскольку функции могут использоваться раньше их определения в программах.) Для обеспечения переносимости программ употребляйте всегда в определениях ключевое слово function.

13.2 Примеры определения функций

Вот определение пользовательской функции с именем myprint, которая берет число и печатает его в указанном формате.

function myprint(num) -
printf "%6.3g"n", num ""

Приведем для иллюстрации  awk-правило, которое использует эту функцию:

$3 ? 0 - myprint($3) ""

Эта программа печатает в специальном формате все третьи поля, которые содержат положительное число. Поэтому, если дано:

то эта программа, используя нашу функцию для форматирования результата, напечатает:

Следующая функция вычеркивает все элементы массива.

function delarray(a, i) -
for (i in a)
delete a[i] ""

При работе с массивами часто нужно вычеркивать все элементы некоторого массива и начинать с начала с новым списком элементов (см. раздел 11.6 [Оператор delete], стр. 128). Вместо повторения такого цикла всюду в программе, everywhere где вы хотите очистить массив, можно просто вызывать delarray.

Приведем пример рекурсивной функции. Она берет цепочку в качестве входного параметра и возвращает цепочку в обратном порядке.

function rev(str, start) -
if (start == 0)
return ""
return (substr(str, start, 1) rev(str, start - 1)) ""

Если эта функция находится в файле с именем `rev.awk', мы можем проверить ее следующим образом:

$ echo "Don't Panic!"
-- ? gawk --source '- print rev($0, length($0)) ""' -f rev.awk
a !cinaP t'noD

Вот пример, где используется встроенная функция strftime. (См. раздел 12.5 [Функции для действий с отметками времени], стр. 148, для подробной информации о strftime.) Функция ctime в Си получает timestamp и возвращает ее в хорошо известной форме. Здесь приведена ее awk-версия:

# ctime.awk # # awk-версия функции  ctime(3) в Си
function ctime(ts, format) -
format = "%a %b %d %H:%M:%S %Z %Y" if (ts == 0)
ts = systime() # по умолчанию используется текущее время
return strftime(format, ts) ""

13.3 Вызов функций, определенных пользователем

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

Вызов функции состоит из имени функции с последующими аргументами в скобках. То, что вы пишите в вызове в качестве аргументов, также есть выражения awk; каждый раз, когда выполняется вызов, эти выражения вычисляются и их значения становятся фактическими аргументами. Например, вот вызов foo с тремя аргументами (первый есть конкатенация цепочек):

ВНИМАНИЕ: символы whitespace (пробелы и табуляции) не допускаются между именем функции и открывающей скобкой списка аргументов. Если вы по ошибке напишете здесь whitespace, то awk может подумать, что вы хотите соединить переменную с выражением в скобках. Вместе с тем awk замечает, что используется имя функции, а не переменной, и выдает сообщение об ошибке.

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

вы не должны думать об аргументе для myfunc как о "переменной foo." Вместо этого вы должны думать об аргументе как о строковом значении "bar". Если функция myfunc изменяет значения своих локальных переменных, это не влияет ни на какие другие переменные. Так, если myfunc делает так:

function myfunc(str) -
print str str = "zzz" print str ""

для изменения своего первого аргумента --- переменной str, это не изменит значения foo в месте вызова. Роль foo при вызове myfunc кончается, когда вычисляется ее значение "bar". Если str также существует вне myfunc, тело функции не может изменить это внешнее значение, потому что оно затенено во время выполнения тела myfunc и не может быть увидено или изменено оттуда.

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

Например:

function changeit(array, ind, nvalue) -
array[ind] = nvalue ""
BEGIN -
a[1] = 1; a[2] = 2; a[3] = 3 changeit(a, 2, "two")
printf "a[1] = %s, a[2] = %s, a[3] = %s"n",
a[1], a[2], a[3] ""

Эта программа печатает `a[1] = 1, a[2] = two, a[3] = 3', потому что changeit присваивает "two" второму элементу массива a.

Некоторые реализации awk позволяют вызывать функции, которые не были определены, и только сообщают об этом во время исполнения, когда программа фактически пытается вызвать функцию.

Например:

BEGIN -
if (0)
foo() else
bar() "" function bar() - ... "" # заметим, что  `foo' не определена

Так как оператор `if' никогда не будет `true', неопределенность foo не создает проблем. Хотя обычно это проблема, если программа вызывает неопределенную функцию.

Если было указано `--lint' (см. раздел 14.1 [Параметры командной строки], стр. 161), gawk сообщит о вызове неопределенных функций.

Некоторые реализации awk генерируют динамические ошибки, если вы используете оператор next (см, раздел 9.7 [Оператор next], стр. 111) внутри функции пользователя. gawk не имеет этой проблемы.

13.4 Оператор return

Тело функции пользователя может содержать оператор return. Этот оператор возвращает управление продолжению awk-программы. Его можно также использовать для возврата значения функции для использования в остальной части программы. Это выглядит так: return [expression]. Часть expression не обязательна. Если она опущена, возвращаемое значение не определено и, следовательно, непредсказуемо. Оператор return без expression подразумевается в конце каждого определения функции. Так что если управление достигает конца тела функции, то функция возвращает непредсказуемое значение. awk не предупреждает об использовании возвращенного значения такой функции.

Иногда нужно написать функцию для выполнения определенных действий, а не для получения возвращаемого значения. Такая функция соответствует пустой функции в Си или процедуре в Паскале. Так, может быть целесообразным не возвращать никакого значения; нужно просто держать в уме, что если вы используете значение такой функции, вы идете на риск. Вот пример пользовательской функции, которая возвращает значение наибольшего числа среди элементов массива:

function maxelt(vec, i, ret) -
for (i in vec) -
if (ret == "" ---- vec[i] ? ret)
ret = vec[i] "" return ret ""

Вы вызываете maxelt с одним аргументом, который есть имя массива. Локальные переменные i и ret не предназначены быть аргументами; если бы не было ничего, что препятствовало бы вам передать два или три аргумента функции maxelt, результаты могли бы быть странными. Дополнительный пробел перед i в списке параметров указывает, что i и ret не предполагаются быть аргументами. Это есть соглашение, которому вы должны следовать при определении функций.

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

awk ' function maxelt(vec, i, ret) -
for (i in vec) -
if (ret == "" ---- vec[i] ? ret)
ret = vec[i] "" return ret ""
# Загрузка всех полей каждой записи в  nums. -
for(i = 1; i != NF; i++)
nums[NR, i] = $i ""
END -
print maxelt(nums) ""'

Если задан следующий ввод:

1 5 23 8 16 44 3 5 2 8 26 256 291 1396 2962 100 -6 467 998 1101 99385 11 0 225

наша программа должна сообщить нам, что 99385 есть наибольшее число в массиве.