8.5. Пример. Реализация функций fopen и getc

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

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

Структура данных, описывающая файл, содержится в <stdio.h>, который необходимо включать (с помощью #include) в любой исходный файл, если в том осуществляется стандартный ввод-вывод. Этот же заголовочный файл включен и в исходные тексты библиотеки ввода-вывода.

В следующем фрагменте, типичном для файла <stdio.h>, имена, используемые только в библиотечных функциях, начинаются с подчеркивания. Это сделано для того, чтобы они случайно не совпали с именами, фигурирующими в программе пользователя. Такое соглашение соблюдается во всех программах стандартной библиотеки.

  #define NULL      0
  #define EOF       (-1)
  #define BUFSIZ    1024
  #define OPEN_MAX  20 /* max число одновременно открытых файлов */

  typedef struct _iobuf {
      int  cnt;   /* количество оставшихся символов */
      char *ptr;  /* позиция следующего символа */
      char *base; /* адрес буфера */
      int  flag;  /* режим доступа */
      int  fd;    /* дескриптор файла */
  } FILE;
  extern FILE _iob[OPEN_MAX];

  #define stdin  (&_iob[0])
  #define stdout (&_iob[1])
  #define stderr (&_iob[2])

  enum _flags {
      _READ  = 01,  /* файл открыт на чтение */
      _WRITE = 02,  /* файл открыт на запись */
      _UNBUF = 04,  /* файл не буферизуется */
      _EOF   = 010, /* в данном файле встретился EOF */
      _ERR   = 020  /* в данном файле встретилась ошибка */
  };

  int _fillbuf(FILE *);
  int _flushbuf(int, FILE *);

  #define feof(p) (((p)->flag & _EOF) != 0)
  #define ferror(p) (((p)->flag & _ERR) != 0)
  #define fileno(p) ((p)->fd)

  #define getc(p) (--(p)->cnt >= 0 \
               ? (unsigned char) *(p)->ptr++ : _fillbuf(p))
  #define putc(x, p) (--(p)->cnt >= 0 \
               ? *(p)->ptr++ = (x) : _flushbuf((x),p))

  #define getchar()  getc(stdin)
  #define putchar(x) putc((x), stdout)

Макрос getc обычно уменьшает счетчик числа символов, находящихся в буфере, и возвращает символ, после чего приращивает указатель на единицу. (Напомним, что длинные #define с помощью обратной наклонной черты можно продолжить на следующих строках.) Когда значение счетчика становится отрицательным, getc вызывает _fillbuf, чтобы снова заполнить буфер, инициализировать содержимое структуры и выдать символ. Типы возвращаемых символов приводятся к unsigned; это гарантирует, что все они будут положительными.

Хотя в деталях ввод-вывод здесь не рассматривается, мы все же привели полное определение putc. Сделано это, чтобы показать, что она действует во многом так же, как и getc, вызывая функцию _flushbuf, когда буфер полон. В тексте имеются макросы, позволяющие получать доступ к флажкам ошибки и конца файла, а также к его дескриптору.

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

  #include <fcntl.h>
  #include "syscalls.h"

  /* права для владельца, группы и остальных */
  #define PERMS 0666

  /* fopen: открывает файл, возвращает файловый указатель */
  FILE *fopen(char *name, char *mode)
  {
      int fd;
      FILE *fp;

      if (*mode != 'r' && *mode != 'w' && *mode != 'a')
          return NULL;
      for (fp = _iob; fp < _iob + OPEN_MAX; fp++)
          if ((fp->flag & (_READ | _WRITE)) == 0)
              break;             /* найдена свободная позиция*/
      if (fp >= _iob + OPEN_MAX) /* нет свободной позиции */
          return NULL;
      if (*mode == 'w')
          fd = creat(name, PERMS);
      else if (*mode == 'a') {
          if ((fd = open(name, O_WRONLY, 0)) == -1)
              fd = creat(name, PERMS);
          lseek(fd, 0L, 2);
      } else
          fd = open(name, O_RDONLY, 0);
      if (fd == -1)       /* невозможен доступ по имени name */
          return NULL;
      fp->fd = fd;
      fp->cnt = 0;
      fp->base = NULL;
      fp->flag = (*mode == 'r') ? _READ : _WRITE;
      return fp;
  }

Приведенная здесь версия fopen реализует не все режимы доступа, оговоренные стандартом; но, мы думаем, их реализация в полном объеме не намного увеличит длину программы. Наша fopen не распознает буквы b, сигнализирующей о бинарном вводе-выводе (поскольку в системах UNIX это не имеет смысла), и знака +, указывающего на возможность одновременно читать и писать.

Для любого файла в момент первого обращения к нему с помощью макровызова getc счетчик cnt равен нулю. Следствием этого будет вызов _fillbuf. Если выяснится, что файл на чтение не открыт, то функция _fillbuf немедленно возвратит EOF. В противном случае она попытается запросить память для буфера (если чтение должно быть с буферизацией).

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

  #include "syscalls.h"

  /* _fillbuf: запрос памяти и заполнение буфера */
  int _fillbuf(FILE *fp)
  {
      int bufsize;

      if ((fp->flag & (_READ | _EOF | _ERR)) != _READ)
          return EOF;
      bufsize = (fp->flag & _UNBUF) ? 1 : BUFSIZ;
      if (fp->base == NULL)    /* буфера еще нет */
          if ((fp->base - (char *) malloc(bufslze)) == NULL)
              return EOF;      /* нельзя получить буфер */
      fp->ptr = fp->base;
      fp->cnt = read(fp->fd, fp->ptr, bufsize);
      if (--fp->cnt < 0) {
          if (fp->cnt == -1)
              fp->flag |= _EOF;
          else
              fp->flag |= _ERR;
          fp->cnt = 0;
          return EOF;
      }
      return (unsigned char) *fp->ptr++;
  }

Единственное, что осталось невыясненным, — это каким образом организовать начало счета. Массив _iob следует определить и инициализировать так, чтобы перед тем как программа начнет работать, в нем уже была информация о файлах stdin, stdout и stderr.

  FILE _iob[OPEN_MAX] = {    /* stdin, stdout, stderr */
      { 0, (char *) 0, (char *) 0, _READ, 0 },
      { 0, (char *) 0, (char *) 0, _WRITE, 1 },
      { 0, (char *) 0, (char *) 0, _WRITE | _UNBUF, 2 }
  };

Инициализация flag как части структуры показывает, что stdin открыт на чтение, stdout — на запись, a stderr — на запись без буферизации.

  int fseek(FILE *fp, long offset, int origin)