Geum.ru

Рассел Сейдж. Приемы профессиональной работы в unix перевод "Tricks of the unix masters" by Russel G

Вид материалаДокументы

Содержание


4.2. Извлечение документирующих заголовков
4.1. Программирование и управление документацией
Пример вызова
Переменная среды
Подобный материал:
1   ...   14   15   16   17   18   19   20   21   ...   45

файлов.

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

файле log, может быть использована для обеспечения вывода на экран лю-

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

что вам нужно сделать для этого - записать их в соответствии с командой

more и добавить столько команд в главное меню, сколько вы хотите.


Пояснения


Строка 4 очищает экран, используя команду c, представленную ниже в

этой книге. (Вместо этого вы снова можете использовать команду clear,

если она доступна.)

Строка 5 устанавливает в позиционные параметры выход команды date.

Это то же самое, что мы делали в программе cpiobr. Строки 6-17 выводят

меню. Здесь использован один оператор echo, как описано в cpiobr. Стро-

ка 13 читает команду пользователя.

Строки 20-27 выполняют основную работу программы. Если введенная

команда была просто возвратом каретки (трактуется как нуль), программа

завершается. В строке 23 команда sed просматривает файл $HOME/bin/log.

Это требует, чтобы вы поместили log в подкаталоге двоичных модулей ва-

шего регистрационного каталога. Если вы разместите ее где-либо в другом

месте, вы должны изменить эту строку. Команда sed использует ключ -n,

который запрещает вывод, за исключением того, что явно указано для пе-

чати. Строка -e находит имена файлов.

Данный подход использует функцию замены в команде sed. Таким обра-

зом мы можем заменить все за исключением имени файла, а затем напеча-

тать его. Смысл этой записи примерно такой: сперва мы ищем выражение

more (/more/), находя тем самым все строки в файле протокола, содержа-

щие слово "more". По определению, каждый файл протокола выводится на

экран, используя команду more. Поскольку вы добавляете файлы протокола,

каждая новая строка должна содержать слово more, поэтому файлы нахо-

дятся автоматически по выражению команды sed.

Затем мы указываем команде sed сделать замену. Первое выражение

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

скобки для отметки внутри нее образца .*, тем самым выделяя часть стро-

ки между пробелом после "more" и первой точкой с запятой в конце стро-

ки. Если вы посмотрите на все строки в файле log, которые начинаются с

"more", то вы увидите, что это соответствует имени файла, которое мы

ищем.

Затем мы указываем команде sed заменить всю строку на первый обра-

зец "pattern 1". "Pattern 1" - это запись команды sed для первого отме-

ченного или "отмеченного биркой" выражения. Другими словами, мы замени-

ли имя файла на всю строку целиком и указали команде sed напечатать ре-

зультат, тем самым выдавая на экран имя файла.

Эта работа выполняется для такого количества операторов more,

сколько вы имеете. Чем больше файлов log вы имеете, тем больше файлов

обрабатывает команда sed. Обратите внимание, что оператор sed просмат-

ривает любое количество символов от начала строки для нахождения слова

"more". Не указывая в программе конкретное число символов, на которое

нужно отступить, вы получаете тем самым свободу выбора ваших собствен-

ных уровней отступа.

Если введенная команда не является допустимой, выдается сообщение

об ошибке.

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

вы хотите запустить ее снова, вы должны снова ввести log.


Пример

$ log

1

После запуска программы выводится меню. Введите число 1 для того,

чтобы увидеть все имена log-файлов.

Теперь, когда мы изучили, как распознавать и управлять файлами во-

обще, давайте рассмотрим некоторые систематические методы управления

ИНФОРМАЦИЕЙ в файлах. Мы начинаем в следующей главе с файлов, которые

важны для нас как для программистов.


* ГЛАВА 4. Управление программной документацией *


ВВЕДЕНИЕ

4.1. ПРОГРАММИРОВАНИЕ и УПРАВЛЕНИЕ ДОКУМЕНТАЦИЕЙ

4.2. ИЗВЛЕЧЕНИЕ ДОКУМЕНТИРУЮЩИХ ЗАГОЛОВКОВ

4.2.1. stripc - из файла на языке Си

4.2.2. stripf - из Си-функции

4.2.3. strips - из командного файла Shell

4.3. ctags - создание файла признаков исходного кода проекта


ВВЕДЕНИЕ


Вы решили рискнуть. Продукт на три месяца опаздывает в произ-

водство и нуждается лишь в крохотной доработке. Вы уверены, что знаете,

как работает функция, которая открывает входной буфер. Вы ее недавно

использовали. Вы увеличиваете размер буфера в вызове функции и запуска-

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

поставку на диске и отправляете ее в производство. Месяц спустя, начи-

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

текстовый процессор, электронная таблица и база данных открыты все

вместе и активны одновременно (что является одним из больших товарных

достоинств вашего продукта), то просто новый буфер настолько велик, что

поглощает ключевой раздел памяти и превращает высоко летающее чудо ин-

тегрированного программного обеспечения в яркую руину.

Почему вы не проверили документацию по этой функции? Выяснение то-

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

а поскольку документацию так трудно сопровождать, то связанные с ней

вещи так или иначе устаревают. Тем не менее, аналогичные провалы не

должны возникать.

Программирование - тяжелая работа, но это только половина работы.

Хорошая документация очень важна, если вы собираетесь иметь возможность

сопровождать ваш программный код, но и управление всей документацией,

связанной с большим программным проектом также является тяжелой рабо-

той. Происходят постоянные изменения, и обычно отсутствует единообразие

подхода. Документирование исходных файлов на Сикак в целом, так и по

каждой функции является хорошим первым шагом, но такая документация не

очень полезна, если вы вынуждены пробираться через дюжины файлов, чтобы

обнаружить, как называется конкретная функция или какие функции состав-

ляют данный модуль.

Если вы хотели бы изучить еще одно средство, связанное с разработ-

кой, см. программу cg в главе 10.


4.1. ПРОГРАММИРОВАНИЕ И УПРАВЛЕНИЕ ДОКУМЕНТАЦИЕЙ


В данной главе представлен набор командных файлов командного про-

цессора для извлечения документирующей информации из исходного кода

программ на Си и командных файлов командного процессора. Используются

две стратегии. Первая состоит в том, что, следуя стандартной "модели

документации" в исходном коде, вы можете придумать командные файлы, ко-

торые просто "вытягивают" самые новые разделы с заголовочной информаци-

ей из файлов с исходным кодом и собирают их затем в новый файл. Такие

файлы служат в качестве каркаса для документации по программе. Следова-

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

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

полностью новый каркас руководства.

Этот подход реализуют командные файлы stripc, stripf и strips.

Stripc и stripf предоставляют листинги блоков документации уровня файла

и уровня функций из ваших исходных файлов на Си, а strips извлекает доку-

ментацию из командных файлов командного процессора.

Второй подход - доступ к определенным видам структур (таким как

функции на Си) в теле самого программного кода. Этим методом вы можете

точно найти, как называется данная функция, без сосредоточенного изуче-

ния горы листингов. Командный файл ctags является и полезным инструмен-

том, и моделью применения этого подхода к другим видам программных

структур.

Ctags объединяет свой выводной файл с редактором vi/ex с целью

предоставления простого способа доступа к любой заданной функции и ее

просмотра, копирования или редактирования в текущей программе. Ctags

делает это путем предоставления признаков, которые понимает vi, для

каждой функции, обнаруженной в любом указанном наборе файлов. Таким об-

разом, вы можете использовать простую команду редактора, чтобы получить

то, что вам нужно. Вы больше не обязаны заботиться о том, какой файл

содержит какую функцию. Ctags - отличный пример применения мощи UNIX в

полном объеме.

Имея такие инструментальные средства, вам не нужно изобретать ко-

лесо, так как вы можете легко находить и выбирать те средства, которые

необходимы вам в конкретном приложении. Вы уже написали программу уп-

равления терминалом Trantor TR-101? Примените ctags и найдите ее. Более

того, самодокументируемый напечатанный файл и документация о функциях,

полученная с помощью этих командных файлов, дают другим программистам

хороший старт в понимании того, что вы сделали. Это даже может слегка

произвести впечатление на вашего начальника.

Каким в общих чертах будет наш подход к созданию таких командных

файлов? У нас есть некоторые потенциальные преимущества в применении

такого вида доступа в системе UNIX. Прежде всего, исходные файлы не от-

личаются от других текстовых файлов, поэтому мы можем использовать все

имеющиеся в UNIX средства поиска и распознавания шаблонов (sed, awk и

т.д.), чтобы находить символьные строки. Во-вторых, мы освоили технику

обхода файловых деревьев и работы с отобранными типами файлов, описан-

ную в предыдущих главах. Наш подход состоит в объединении этих средств

таким образом, чтобы они обеспечивали доступ к структурированной доку-

ментации, содержащейся в программных файлах.


4.2. Извлечение документирующих заголовков

4.2.1. stripc - из файла на языке Си


------------------------------------------------------------------------


ИМЯ: stripc

------------------------------------------------------------------------


stripc Извлекает документирующий заголовок

из исходного файла на языке Си.


НАЗНАЧЕНИЕ


Печатает первый блок строк комментария в файле с исходным кодом на

Си так, чтобы вы могли быстро идентифицировать назначение программы на

Си.


ФОРМАТ


stripc файл [...]


ПРИМЕР ВЫЗОВА


stripc prog*.c > header


Извлекает начальные блоки комментариев из всех файлов и помещает в

один файл с именем header.


ИСХОДНЫЙ КОД ДЛЯ stripc


1 :

2 # @(#) stripc v1.0 Strip comment header Author: Russ Sage


4 if [ "$#" -eq "0" ]

5 then echo "stripc: arg count error" >&2

6 echo "usage: stripc file [...]" >&2

7 exit 1

8 fi


10 for FILE in $@

11 do

12 if [ ! -s $FILE ]

13 then echo "file \"$FILE\" does not exist" >&2

14 continue

15 fi


17 awk '/\/\*/, / \*\// { if ($0 != " */")

18 print

19 else {print;exit}

20 }' $FILE

21 echo "L"

22 done


(Перед тем как вводить этот исходный код, обратите внимание, что в

строке 21 должен быть действительно символ control- L, введенный между

двумя кавычками, по причинам, рассмотренным ниже.)


ПЕРЕМЕННАЯ СРЕДЫ


FILE Хранит имя файла, полученное из командной строки.


ОПИСАНИЕ

ЗАЧЕМ НАМ НУЖЕН stripc?


В больших проектах по разработке программного обеспечения требу-

ется обычно много времени для работы с документацией. Имеются программ-

ные файлы для документирования, функциональные спецификации для написа-

ния программ и, наконец, руководства и справочные карты, глоссарии,

указатели и т.д. Настоящий программный код должен иметь свою собствен-

ную встроенную документацию, иначе управление этим кодом становится

очень трудным.

Чтобы избежать путаницы, нужно создать модель документации, а за-

тем сделать ее стандартом, которому должны следовать все программисты.

Даже если эта модель не будет абсолютно идеальной, ее наличие является

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

Следующие два инструментальные средства, которые мы предлагаем,

следуют модели документации, описанной в дальнейшем тексте. Эта модель

последовательна и понятна, ее можно дополнить или изменить по вашему

усмотрению.


ЧТО ДЕЛАЕТ stripc?


Stripc печатает только первый заголовочный блок комментариев из

начала исходного файла на языке Си. Желательно, чтобы этот блок содер-

жал всю важную информацию о файле: его официальное имя, для чего он

предназначен, кто его создал, когда он был создан и т.д. Внутри файла

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

ма. Эта модель предполагает, что весь ваш код содержит очень мало глав-

ных программ и много независимых модулей.

Рассмотрим на модельном исходном файле, какого рода информацию мы

должны извлечь из исходных файлов.


/*

* Это документирующий заголовок для файла

* с исходным кодом на языке Си.

* Он поясняет, что содержится в файле (программы, функции,

* библиотеки и т.д.) и идентифицирует проект.

*

*/ Это отметка конца заголовочного комментария.

L Инструменты извлечения применяют control-L как разделитель.

/* Это документирующий заголовок для главной части программы.

* Главная пометка должна объяснять, что это за программа

* и что она делает. Здесь могут быть также указаны автор,

* дата и история изменений.

*/

main()

{

/* Здесь находится главная Си-программа */

}

L

/* Это документирующий заголовок для определенной функции,

* которая за ним следует. Документируется последователь-

* ность вызова, вход и выход и общее назначение этой

* функции.

*/

func(arg1,arg2)

int arg1;

char arg2;

{

/* Текст функции находится здесь */

}

L

/* Аналогично, этот блок комментариев документирует

* следующую функцию. Наличие документации вместе с кодом

* сокращает объем накладных расходов при чтении и

* изменении кода.

*/

func(arg1,arg2)

int arg1, arg2;

{

/* Текст функции находится здесь */

}


Как указывалось ранее, функция main не обязательна и, вероятно,

встречается только в одном или двух файлах, в зависимости от вида прог-

рамм, которые вы пишете. Один файл может иметь столько функций, сколько

вы хотите, но рекомендуемое максимальное число - от одной до трех, в

зависимости от того, как эти функции взаимосвязаны. В каждом файле

имейте дело только с одной программируемой идеей и ее реализацией.

При изучении этой модели вы видите, что обеспечивается три уровня

документации. Заголовок в начале файла извлекается с помощью stripc.

Этот заголовок относится ко всему файлу в целом. Заголовок в начале

главной программы относится ко всей программе и поддерживается с по-

мощью stripf. Заголовок для каждой функции относится к этой функции.

Эти заголовки обслуживаются командным файлом stripf, который обсужда-

ется ниже.

Отметим, что между функциями имеется прогон формата (символ

control-L кода ASCII). В предыдущем листинге мы указали эту комбинацию

клавиш с помощью символа L, чтобы наши текстовые процессоры не произ-

водили лишних страниц при форматировании рукописи данной книги. Вам

нужно в каждом случае действительно вводить control-L вместо L при

размещении комментариев в ваших файлах и при вводе исходного кода дан-

ного и последующих командных файлов. Символ прогона формата использу-

ется в модели заголовка для отметки верхней границы первой функции в

файле и для прогона страниц на печатающем устройстве при чистовой

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

В начале каждой функции (перед main или перед именем функции) дол-

жен существовать документирующий заголовок. Этот заголовок обычно отра-

жает наиболее недавние изменения в этом модуле, и его можно считать бо-

лее достоверным, чем заголовок документа, который был напечатан

несколько недель или даже месяцев назад.

Входом для stripc является последовательность имен файлов с исход-

ным кодом. Для каждого файла в командной строке проверяется, существует

ли он и имеет ли размер больше, чем ноль байт. Если он не удовлетворяет

этим критериям, то печатается сообщение об ошибке и проверяется следую-

щий файл. Каждый файл читается с первого байта, и в нем ищется символь-

ная строка начала комментария (/*). Когда она найдена, информация до

символьной строки конца комментария (*/) построчно выводится в stdout.

Если правые символы не найдены, ничего не печатается, но сообщение об

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

как каждый файл обработан, в конце печатается прогон формата, который

разбивает выводную информацию на страницы-разделы. Это применяется в

основном, когда документирующие заголовки очень длинные и нуждаются в

визуальной разбивке.

Отметим, что "извлечение" ("strip") здесь и в следующих двух ути-

литах означает не УДАЛЕНИЕ, а копирование соответствующей информации.

Никаких изменений во входных файлах не делается.

Когда все файлы в командной строке обработаны, командный файл за-

вершается.


ПРИМЕРЫ


1. $ stripc test?.c > test.filehdrs

Извлекает блок файловых комментариев из всех файлов, соответствую-

щих строке "test", за которой следуют один произвольный символ, а затем

.c. Сюда подходят test1, testA, testb и т.д. Все блоки комментариев по-

мещаются в файл test.filehdrs в таком порядке, как они обрабатывались

бы в цикле for.

2. $ for DIR in src1 src2 src3

> do

> stripc $DIR/*.c > /tmp/$DIR.hdrs

> done

Этот цикл проходит каждый из трех каталогов src1, src2 и src3. В

каждом из них имеются исходные файлы, из которых нужно извлечь докумен-

тирующие заголовки. Каждый раз берется один каталог, и stripc вызыва-

ется для всех исходных файлов на языке Си из данного каталога. Выход,

т.е. все документирующие заголовки из файлов в этом каталоге, помеща-

ется в файл в каталоге /tmp. Файлы в /tmp имеют имена /tmp/src1.hdrs,

/tmp/src2.hdrs и /tmp/src3.hdrs. Отметим, что число файлов, передавае-

мых stripc, имеет ограничение в 255 символов. После этого командная

строка переполняется и выполнение командного файла аварийно заверша-

ется.


ПОЯСНЕНИЯ


Строки 4-8 делают проверку на ошибки. Если число параметров в ко-

мандной строке нулевое, возникает ошибка. При вызове stripc должно быть

хотя бы одно имя файла.

Цикл for в строках 10-22 пробегает по каждому имени файла из

списка позиционных параметров в командной строке.

Первым делом, в строках 12-15 проверяется существование файла.

Если файл не существует, выдается соответствующее сообщение об ошибке и

цикл продолжается со следующим файлом.

Строки 17-20 - это цикл awk, который делает всю важную работу.

Входным для awk является имя файла, которое сейчас обрабатывает цикл

for.

Если вы не очень знакомы с программой awk, сообщим, что она вызы-

вается так:

awk программа имя-файла

где программа состоит из последовательности предложений, имеющих

вид:

шаблон { действие }

Указанное действие применяется к тексту, который соответствует

шаблону. Для того чтобы утилита awk работала корректно, вы должны зак-

лючить всю программу в одинарные кавычки.

В stripc для указания начала комментария (/*) и конца комментария