Язык shell

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

К теме командного языка и его интерпретатора логически примыкают правила формирования и средства разбора командных строк.

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

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

1. Имя утилиты состоит не менее чем из двух и не более чем из девяти малых латинских букв и/или цифр.
2. Имя опции - это один буквенно-цифровой символ. Опциям предшествует знак минус. После одного минуса могут располагаться несколько опций без аргументов.
3. Опции отделены от своих аргументов.
4. У опций нет необязательных аргументов.
5. Если у опции несколько аргументов, они представляются одним словом и отделяются друг от друга запятыми или экранированными пробелами.
6. Все опции располагаются в командной строке перед операндами.
7. Специальный элемент командной строки --, который не является ни опцией, ни операндом, обозначает конец опций. Все последующие слова трактуются как операнды, даже если они начинаются со знака минус.
8. Порядок разных опций в командной строке не имеет значения. Если повторяется одна опция с аргументами, последние должны интерпретироваться в порядке, указанном в командной строке.
9. Порядок интерпретации операндов может зависеть от утилиты.
10. Если операнд задает читаемый или записываемый файл, то знак минус на его месте используется только для обозначения стандартного ввода (или стандартного вывода, если из контекста ясно, что специфицируется выходной файл).

Стандартным средством разбора опций и их аргументов, заданных в командной строке, является служебная программа getopts (чаще всего реализуемая как обычная встроенная команда shell):

getopts  цепочка_имен_опций переменная 
                          [аргумент ...]

Как правило, shell-процедура, запущенная разбираемой командной строкой, вызывает утилиту getopts многократно (в цикле). При каждом таком вызове getopts помещает имя очередной выделенной ею опции в качестве значения заданной переменной. Место продолжения разбора (индекс в командной строке) запоминается в shell-переменной OPTIND, начальным значением которой служит единица.

Если у опции должен быть аргумент (что обозначается двоеточием после имени опции в цепочке имен опций ), getopts выделяет его из командной строки и помещает в shell-переменную OPTARG.

Заданную при вызове getopts переменную, а также OPTIND и OPTARG следует использовать в качестве локальных, они не должны экспортироваться в окружение.

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

Когда в командной строке обнаруживается опция, отсутствующая в цепочке имен опций, значением заданной переменной становится знак вопроса. Если первый символ цепочки имен опций - двоеточие, то в OPTARG помещается обнаруженный символ, иначе в стандартный протокол выдается диагностическое сообщение. С точки зрения shell-процедуры, вызвавшей getopts, это должно считаться ошибкой; с точки зрения getopts - нет.

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

Если переменой OPTIND присваивается единица, осуществляется (новый) разбор текущей командной строки (сформированной, быть может, с помощью специальной встроенной команды set ) или текущих значений заданных при вызове getopts аргументов.

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

while getopts :abo: c
do
 case $c in
 a | b) FLAG=$c;;
 o)     OARG=$OPTARG;;
 ?)     printf "Использование: %s: [-a | -b] [-o выходной_файл] [аргумент ...]\n" $0
        exit 1;;
 esac
done
shift $(($OPTIND - 1))
printf "Заданный флаг: %s\n" $FLAG
printf "Аргумент опции o: %s\n" $OARG
printf "Остаток командной строки: %s\n" "$*"

Если вызвать shell-процедуру cmd любым из способов, показанных в листинге 2.32, будет выдан результат, приведенный в листинге 2.33.

cmd -a -o f1.o,f2.o file1 -
cmd -ba -o f1.o,f2.o -- file1 -
cmd -o f1.o,f2.o -b -a file1 -

Заданный флаг: a
Аргумент опции o: f1.o,f2.o
Остаток командной строки: file1 -

Для разбора опций и их аргументов средствами языка C служит функция getopt() и ассоциированные с ней внешние переменные (см. листинг 2.34).

#include <unistd.h>
int getopt (int argc, char *const argv[], 
                const char *optstring);
extern char *optarg;
extern int optind, opterr, optopt;

В общем и целом логика ее работы та же, что и у служебной программы getopts (с соответствующим переименованием используемых переменных). Аргументы argc и argv задают командную строку в том виде, как она передается функции main(), optstring представляет собой цепочку имен опций. Переменная optind (с начальным значением 1 ) служит индексом в массиве argv []. Стандарт POSIX-2001 не специфицирует, как именно getopt() разбирает несколько расположенных поочередно (после одного знака минус) имен опций и определяет, какие опции уже обработаны.

В итоге функция getopt() возвращает имя очередной опции из числа перечисленных в цепочке optstring (если таковое удалось выделить). При наличии у опции аргумента указатель на него помещается в переменную optarg с соответствующим увеличением значения optind.

Если у опции аргумент отсутствует, а на первом месте в optstring задано двоеточие, оно и служит результатом.

Если встретилось имя опции, не перечисленное в optstring, или у опции нет аргумента, а на первом месте в optstring задано не двоеточие, то результатом станет знак вопроса.

В любой из перечисленных выше ошибочных ситуаций в переменную optopt помещается имя "проблемной" опции. Кроме того, в стандартный протокол выдается диагностическое сообщение по образу и подобию утилиты getopts. Для подавления выдачи следует присвоить переменной opterr нулевое значение.

Наконец, если при вызове getopt() указатель argv [optind] не отмечает начало опции (например, он пуст или первый символ указуемой цепочки отличен от знака минус), результат равен -1 как признак того, что разбор опций закончен.

Следующий пример программы (см. листинг 2.35) возвращает нас к рассмотренной выше shell-процедуре cmd. Он показывает, как можно обработать командную строку вызова утилиты, допускающей взаимоисключающие опции a и b, а также опцию o, которая должна иметь аргумент.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* Программа разбирает опции вызвавшей ее командной строки */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include <unistd.h>
#include <stdio.h>
int main (int argc, char *argv []) {
 int c;              /* Имя анализируемой опции                     */
 int aflg = 0;       /* Признак того, что задана опция a            */
 int bflg = 0;       /* Признак того, что задана опция b            */
 int errflg = 0;     /* Флаг наличия ошибки в командной строке      */
 int flg = '?';      /* Флаг (a или b), заданный в командной строке */
 char *ofile = NULL; /* Указатель на аргумент опции o               */
 /* Подавим стандартную диагностику */
 /* независимо от первого символа   */
 /* цепочки имен опций              */
 opterr = 0;
 while ((c = getopt (argc, argv, ":abo:")) != -1) {
   switch (c) {
     case 'a':
    aflg++;
    flg = c;
    if (bflg) {
         fprintf (stderr, "Опции a и b несовместимы\n");
      errflg++;
    }
    break;
     case 'b':
    bflg++;
    flg = c;
    if (aflg) {
         fprintf (stderr, "Опции a и b несовместимы\n");
      errflg++;
    }
    break;
     case 'o':
    ofile = optarg;
    break;
     case ':':
       fprintf (stderr, "Отсутствует аргумент опции -%c\n", optopt);
       errflg++;
       break;
     case '?':
       fprintf (stderr, "Недопустимая опция -%c\n", optopt);
       errflg++;
       break;
   }
 }
  if (errflg) {
   (void) fprintf (stderr, "Использование: %s: [-a | -b] [-o выходной_файл] "
                "[аргумент ...]\n", argv [0]);
   return (1);
 }
 printf ("Заданный флаг: %c\n", flg);
 printf ("Аргумент опции o: %s\n", ofile);
 printf ("Остаток командной строки:");
 for (; optind < argc; optind++) {
   printf (" %s", argv [optind]);
 }
 printf ("\n");
 return 0;
}

Приведенная программа отличается от shell-процедуры cmd более тщательным анализом ошибочных ситуаций и детальной диагностикой.