174 |
Глава 10. Макросы |
(defmacro nil! (x) ‘(setf ,x nil))
Запятая-эт действует похожим образом, но вставляет поэлементно свой аргумент (который должен быть списком) в середину другого списка:
>(setf lst ’(a b c)) (A B C)
>‘(lst is ,lst) (LST IS (A B C))
>‘(its elements are ,@lst) (ITS ELEMENTS ARE A B C)
Это может оказаться полезным для макросов, которые используют ос таточный аргумент, например, для представления тела кода. Предполо жим, мы хотим создать макрос while, который вычисляет свои аргумен ты до тех пор, пока проверочное выражение остается истинным:
> (let ((x 0)) (while (< x 10)
(princ x) (incf x)))
0123456789 NIL
Мы можем определить такой макрос, используя остаточный параметр, который соберет все выражения тела макроса в список, а затем этот список будет встроен в результат раскрытия макроса благодаря ,@:
(defmacro while (test &rest body) ‘(do ()
((not ,test)) ,@body))
10.4. Пример: быстрая сортировка
На рис. 10.1 приведен пример1 функции, полностью построенной на мак росах, – функции, выполняющей сортировку векторов с помощью алго ритма быстрой сортировки (quicksort).°
Алгоритм быстрой сортировки выполняется следующим образом:
1.Один из элементов принимается в качестве опорного. Многие реали зации выбирают элемент из середины вектора.
2.Затем производится разбиение вектора, при этом его элементы пере ставляются местами до тех пор, пока все элементы, меньшие опорно го, не будут находиться по левую сторону от больших или равных ему.
3.Наконец, если хотя бы одна из частей состоит из двух и более элемен тов, алгоритм применяется рекурсивно к каждому из сегментов.
1Код на рис. 10.1 содержит слегка исправленный код. Ошибка найдена Дже дом Кросби. – Прим. перев.
10.5. Проектирование макросов |
175 |
|
|
|
|
|
(defun quicksort (vec l r) |
|
|
(let ((i l) |
|
|
(j r) |
|
|
(p (svref vec (round (+ l r) 2)))) |
; 1 |
|
(while (<= i j) |
; 2 |
|
(while (< (svref vec i) p) (incf i)) |
|
|
(while (> (svref vec j) p) (decf j)) |
|
|
(when (<= i j) |
|
|
(rotatef (svref vec i) (svref vec j)) |
|
|
(incf i) |
|
|
(decf j))) |
|
|
(if (>= (- j l) 1) (quicksort vec l j)) |
; 3 |
|
(if (>= (- r i) 1) (quicksort vec i r))) |
|
|
vec) |
|
|
|
|
Рис. 10.1. Быстрая сортировка
С каждым последующим вызовом сортируемый список становится ко роче, и так до тех пор, пока весь список не будет отсортирован.
Реализация этого алгоритма (рис. 10.1) требует указания вектора и двух чисел, задающих диапазон сортировки. Элемент, находящийся в сере дине этого диапазона, выбирается в качестве опорного элемента (p). За тем по мере продвижения вдоль вектора к окончанию диапазона произ водятся перестановки его элементов, которые либо слишком большие, чтобы находиться слева, либо слишком малые, чтобы находиться спра ва. (Перестановка двух элементов осуществляется с помощью rotatef.) Далее эта процедура повторяется рекурсивно для каждой полученной части, содержащей более одного элемента.
Помимо макроса while, определенного в предыдущем разделе, в quicksort (рис. 10.1) задействованы встроенные макросы when, incf, decf и rotatef. Их использование существенно упрощает код, делая его аккуратным
ипонятным.
10.5.Проектирование макросов
Написание макросов – это отдельная разновидность программирова ния, имеющая собственные уникальные цели и проблемы. Умение из менять поведение компилятора отчасти похоже на возможность изме нять сам компилятор. Поэтому при разработке макросов нужно мыс лить как создатель языка.
В этом разделе будут рассмотрены основные трудности, связанные с на писанием макросов, и методики их разрешения. В качестве примера мы создадим макрос ntimes, вычисляющий свое тело n раз:
> (ntimes 10 (princ "."))
176 Глава 10. Макросы
..........
NIL
Ниже приведено некорректное определение макроса ntimes, иллюстри рующее некоторые проблемы, связанные с проектированием макросов:
(defmacro ntimes (n &rest body) |
; wrong |
‘(do ((x 0 (+ x 1))) |
|
((>= x ,n)) |
|
,@body)) |
|
На первый взгляд такое определение кажется вполне корректным. Для приведенного выше примера оно будет работать нормально, однако на самом деле в нем есть две проблемы.
Первой проблемой, о которой должны думать разработчики макросов, является непреднамеренный захват переменных. Это случается, когда имя переменной, используемой в раскрытии макроса, совпадает с име нем переменной, которая уже существует в том окружении, куда встав ляется раскрытие макроса. Некорректное определение ntimes создает переменную с именем x. Поэтому если макрос вызывается там, где уже существует переменная с таким же именем, результат его выполнения может не соответствовать нашим ожиданиям:
> (let ((x 10)) (ntimes 5
(setf x (+ x 1)))
x)
10
Мы предполагали, что значение x будет увеличено в пять раз и в итоге будет равно 15. Но поскольку переменная x используется еще и внутри макроса как итерируемая переменная в do, setf будет увеличивать зна чение этой переменной, а не той, что предполагалось. Раскрыв этот макрос, мы увидим, что предыдущее выражение выглядит следующим образом:
(let ((x 10))
(do ((x 0 (+ x 1))) ((> x 5))
(setf x (+ x 1)))
x)
Наиболее общим решением будет не использовать обычные символы в тех местах, где они могут быть захвачены. Вместо этого можно исполь зовать gensym (см. раздел 8.4). В связи с тем что read интернирует каж дый встреченный символ, gensym никоим образом не будет равен (с точ ки зрения eql) любому другому символу, встречающемуся в тексте про граммы. Переписав наше определение ntimes с использованием gensym вместо x, мы сможем избавиться от вышеописанной проблемы:
(defmacro ntimes (n &rest body) |
; wrong |
(let ((g (gensym))) |
|
10.5. Проектирование макросов |
177 |
‘(do ((,g 0 (+ ,g 1))) ((>= ,g ,n))
,@body)))
Тем не менее в данном определении по-прежнему кроется другая про блема: повторное вычисление. Поскольку первый аргумент встраивает ся непосредственно в вызов do, он будет вычисляться на каждой итера ции. Эта ошибка ясно демонстрируется примером, в котором первое вы ражение содержит побочные эффекты:
> (let ((v 10))
(ntimes (setf v (- v 1)) (princ ".")))
.....
NIL
Поскольку начальное значение v равно 10 и setf возвращает значение своего второго аргумента, мы ожидали получить девять точек, однако в действительности их только пять.
Чтобы разобраться с причиной такого эффекта, посмотрим на результат раскрытия макроса:
(let ((v 10))
(do ((#:g1 0 (+ #:g1 1)))
((>= #:g1 (setf v (- v 1)))) (princ ".")))
На каждой итерации мы сравниваем значение переменной (gensym при печати обычно предваряется #:) не с числом 9, а с выражением, которое уменьшается на единицу при каждом вызове.
Нежелательных повторных вычислений можно избежать, вычислив значение выражения перед началом цикла и записав его в переменную. Обычно для этого требуется еще один gensym:
(defmacro ntimes (n &rest body) (let ((g (gensym))
(h (gensym))) ‘(let ((,h ,n))
(do ((,g 0 (+ ,g 1))) ((>= ,g ,h))
,@body))))
Эта версия ntimes является полностью корректной.
Непреднамеренные повторные вычисления и захват переменных – ос новные проблемы, возникающие при разработке макросов, но есть и другие. С опытом видеть ошибки в макросах станет так же легко и ес тественно, как предупреждать деление на ноль. Но поскольку макросы наделяют нас новыми возможностями, то и сложности, с которыми нам придется столкнуться, тоже новы.
Ваша реализация Common Lisp содержит множество примеров, на кото рых вы можете поучиться проектировать макросы. Раскрывая вызовы