src/gerb_file.h

   1 /*
   2  * gEDA - GNU Electronic Design Automation
   3  * This file is a part of gerbv.
   4  *
   5  *   Copyright (C) 2000-2002 Stefan Petersen (spe@stacken.kth.se)
   6  *
   7  * $Id$
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA
  22  */
  23
  24 /** \file gerb_file.h
  25     \brief Header info for the file parsing support functions
  26     \ingroup libgerbv
  27 */
  28
  29 #ifndef GERB_FILE_H
  30 #define GERB_FILE_H
  31
  32 #include <stdio.h>
  33
  34 typedef struct file {
  35     FILE *fd;     /* File descriptor */
  36     int   fileno; /* The integer version of fd */
  37     char *data;   /* Pointer to data mmaped in. May not be changed, use ptr */
  38     int   datalen;/* Length of mmaped data ie file length */
  39     int   ptr;    /* Index in data where we are reading */
  40     char *filename;  /* File name */
  41 } gerb_file_t;
  42
  43
  44 gerb_file_t *gerb_fopen(char const* filename);
  45 int gerb_fgetc(gerb_file_t *fd);
  46 int gerb_fgetint(gerb_file_t *fd, int *len); /* If len != NULL, returns number
  47                                                 of chars parsed in len */
  48 double gerb_fgetdouble(gerb_file_t *fd);
  49 char *gerb_fgetstring(gerb_file_t *fd, char term);
  50 void gerb_ungetc(gerb_file_t *fd);
  51 void gerb_fclose(gerb_file_t *fd);
  52
  53 extern
  54 const char path_separator;
  55
  56 /*
  57  * Search for files in directories pointed out by paths, a NULL terminated
  58  * list of directories to search. If a string in paths starts with a $, then
  59  * characters to / (or string end if no /) is interpreted as a environment
  60  * variable.
  61  */
  62 char *gerb_find_file(char const * filename, char **paths);
  63
  64 #endif /* GERB_FILE_H */