include/fml.h

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  11  * Permission to use, copy, modify, distribute, and sell this software and
  12  * its documentation, in whole or in part, for any purpose, is hereby granted,
  13  * provided that:
  14  *
  15  * 1. This copyright and permission notice appear in all copies of the
  16  * software and its documentation. Notices of copyright or attribution
  17  * which appear at the beginning of any file must remain unchanged.
  18  *
  19  * 2. The names of EUROPAGATE or the project partners may not be used to
  20  * endorse or promote products derived from this software without specific
  21  * prior written permission.
  22  *
  23  * 3. Users of this software (implementors and gateway operators) agree to
  24  * inform the EUROPAGATE consortium of their use of the software. This
  25  * information will be used to evaluate the EUROPAGATE project and the
  26  * software, and to plan further developments. The consortium may use
  27  * the information in later publications.
  28  *
  29  * 4. Users of this software agree to make their best efforts, when
  30  * documenting their use of the software, to acknowledge the EUROPAGATE
  31  * consortium, and the role played by the software in their work.
  32  *
  33  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  34  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  35  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  36  * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
  37  * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
  38  * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
  39  * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
  40  * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  41  * USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44 /*
  45  * FML interpreter. Europagate, 1995
  46  *
  47  * $Log: fml.h,v $
  48  * Revision 1.5  1995/05/16 09:39:38  adam
  49  * LICENSE.
  50  *
  51  * Revision 1.4  1995/02/23  08:32:11  adam
  52  * Changed header.
  53  *
  54  * Revision 1.2  1995/02/22  08:51:02  adam
  55  * Output function can be customized.
  56  *
  57  * Revision 1.1  1995/02/20  21:15:46  adam
  58  * Moved files to include.
  59  *
  60  * Revision 1.3  1995/02/10  15:50:55  adam
  61  * MARC interface implemented. Minor bugs fixed. fmltest can
  62  * be used to format single MARC records. New function '\list'
  63  * implemented.
  64  *
  65  * Revision 1.2  1995/02/09  16:06:06  adam
  66  * FML can be called from the outside multiple times by the functions:
  67  * fml_exec_call and fml_exec_call_str.
  68  * An interactive parameter (-i) to fmltest starts a shell-like
  69  * interface to FML by using the fml_exec_call_str function.
  70  *
  71  * Revision 1.1.1.1  1995/02/06  13:48:10  adam
  72  * First version of the FML interpreter. It's slow and memory isn't
  73  * freed properly. In particular, the FML nodes aren't released yet.
  74  *
  75  */
  76
  77 #ifndef FML_H
  78 #define FML_H
  79 typedef struct Fml_record {
  80     struct fml_node *list;
  81     struct fml_sym_tab *sym_tab;
  82
  83     struct fml_atom *atom_free_list;
  84     struct fml_node *node_free_list;
  85
  86     int escape_char;
  87     int eof_mark;
  88     char *white_chars;
  89     char comment_char;
  90     int (*read_func)(void);
  91     void (*write_func)(int ch);
  92     void (*err_handle)(int no);
  93
  94     int debug;
  95 } *Fml;
  96
  97 Fml fml_open (void);
  98 int fml_preprocess (Fml fml);
  99
 100 void fml_exec (Fml fml);
 101 void fml_exec_call (Fml fml);
 102 void fml_exec_call_str (Fml fml, const char *str);
 103 void fml_exec_call_argv (Fml fml, const char **argv);
 104
 105 #define FML_ERR_NOMEM 1
 106
 107 #endif