Именования

Ведущий знак вопроса

Ведущий знак вопроса в имени обозначает условное исполнение действия (“operates conditionally”, Thinking Forth, L. Brodie). Классический пример — слово ?DUP. Означает «может быть DUP» (“may be DUP”), здесь условность отражется и на стековом эффекте. Еще пример, слово ?DO — выполняет функцию DO если граничные значения различны.

Общее свойство: есть родственное слово с безусловным поведением.

По аналогии названы слова: ?FOREACH-LIST (работает как FOREACH-LIST, но делает очередную итерацию только если обработчик вернул TRUE, а иначе прекращает), ?EXIT (выполняет EXIT если дано TRUE).

Такие слова как: ?COMP, ?STACK, ?CSP — тоже имеют условное поведение, но не имеют родственных слов (безусловного варианта действия) в силу недостаточной факторизации и устоявшейся практики.

Использование же ведущего знака вопроса для слов, просто возвращающих флаг, является моветоном.

Слова, возвращающие флаг

Пример: IS-WHITE — слово анализирует аргумент на стеке. Используется префикс IS-, общий вид: IS-[SOMETHING] (или, Is[Something]).

Пример: STATE? — слово дает флаг по состоянию связанного или заданного косвенным образом объекта. Знак вопроса выступает суффиксом. Обычно, есть родственные слова с тем же корнем.

Одновременное использование и префикса “IS” и суффикса “?” излишне.

Замечание. Во многих форт-системах есть слово IS, которое работает как слово TO и по смыслу служит для установки значения (утверждение), а не для получения (вопрос).

 Прописные и строчные

В имена вкладывается (мной вкладывается :) дополнительная информация на основе вида составляющих их букв. Возможные варианты: все ПРОПИСНЫЕ, Смешанный, все строчные. В таком же порядке код идет от низкоуровневого (прописные) к высокоуровневому (строчные). В качестве бонуса, это еще и согласуется с другим значением слова «прописной» — «обыкновенный». Таким образом, более общие и глобальные слова именуются в верхнем регистре (например, лексикон форт-процессора), а более локальные и узко специализированные слова (ad-hoc), замыкания на частные объекты (например, интерфейс механизма доступа к MySQL-серверу) — именуются в нижнем регистре; часто эти слова идут и в отдельный словарь.

Второй бонус: неправильный код должен выглядеть неправильно. Соглашение в использовании регистра букв делает более заметными некоторые неудачные элементы дизайна системы (у Джоэля Спольски есть хорошая статья на эту тему: Making Wrong Code Look Wrong). Для проверки согласованности используются следующии критерии:

  • в определении прописных слов используются только прописные слова (хотя, допустимы обоснованные исключения);
  • в высокоуровневом коде не должно быть прописных слов (кроме, быть может, структур управления классического форта).

Замечание. Использовать везде только один регистр — это лишать исходный код одного из каналов информации, это как убрать одну из составляющих RGB-палитры. А каналов этих и так мало.

Нарушение систематики

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

  • CELLS и /CELL (одна пара),
  • CHARS и /CHAR (другая пара).
Очевидно, что эти пары подобны. Говоря более строго, между первой и второй парой легко установить изоморфизм: CELLS—CHARS, /CELL—/CHAR (по моему предположению, такая систематика происходит даже неосознанно). Сравним сигнатуры этих слов:
  • CELLS, /CELL,
  • CHARS, /CHAR.
Сигнатуры тоже изоморфны: соответствие элементов между первой и второй парой очевидно и однозначно. Такая общая схема является естественной и ожидаемой.

Теперь посмотрим на следующие пары стандартных слов (пример того, как делать не надо):

  • CELLS, CELL,
  • CHARS, CHAR.
Вопрос: что здесь не так, где здесь «грязь»? — Да, слово CHAR выпадает по сигнатуре из схемы, которую задают остальные три слова. Либо слово CELL должно быть как слово CHAR, либо наоборот.

Грубо обобщая: слова, имеющие подобные имена, должны иметь и подобную сигнатуру. Если между какими-то под-наборами слов легко проглядывается подобие на 7/8, то, по хорошему, оно должно быть полным.

Вот, еще пример нарушения этого принципа, из библиотеки str.f:

  • STR+, STR!,
  • S+, S!.
Имена подобны, а сигнатуры расходятся. Здесь, беря в качестве базы первые три слова, получаем для последнего подходящую сигнатуру: S!, при этом addr u из первой пары будет соответствовать s1 из второй, и s из первой — s2 из второй. Формально, в качестве базы можно взять из этих четырех любые три слова и вывести сигнатуру для четвертого, но содержательной будет только половина случаев (т.е., два из четырех). Второй случай: S+. Отсюда следует вывод, что не какое-то одно конкретное слово является «неправильным», а только лишь подсистема слов в целом содержит недостаток в виде несогласованности.

Мера грануляции

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

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

Пример. Модуль qname.core.f (quoted name) определяет слова для интерпретации однословных литералов, но не ввязывает их в систему; привязка к NOTFOUND осуществляется в qname.f.

Пример. Модуль zstack.immutable.f определяет лишь базовые операции некого z-стека, а control-stack.f оборачивает его, предоставляя локальный для потока управляющий стек, а в другом месте он может послужить для воплощения пула локальных для хранилища объектов. Суффикс immutable в имени файла говорит о том, что в результате трансляции этого файла образуется только неизменяемый объект (или объекты), в том числе как код так и данные.

Пример. Модуль QSORT.F определяет лишь алгоритм сортировки над словами сравнения и обмена элементов, но никак не определяет этих слов.

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

Заимствования имен

При реализации известных интерфейсов используются их устоявшиеся лексиконы, нет нужды придумывать новые. Например, при реализации DOM-интерфейса был взят напрямую и его же лексикон, закрепленный в спецификации w3c (при разработке этих стандартов народ кучи копий ломает в поисках лучших имен ;). Слова для работы со строками: STARTS-WITH, ENDS-WITH, SUBSTRING-AFTER, SUBSTRING-BEFORE, CONTAINS — и действуют и называются по соответствующему лексикону XPath functions.

Ссылки по теме