/*
  cgi-util.h
  
  version 2.0.2
  
  by Bill Kendrick <bill@newbreedsoftware.com>
  and Mike Simons <msimons@fsimons01.erols.com>
  
  New Breed Software
  http://www.newbreedsoftware.com/cgi-util/
  
  April 6, 1996 - August 9, 1999
  
  version 2.0.2A Billard: cgi_nextentrystr()

*/


#define CGIUTILVER "2.0.2"


/* Form data (name/value entries): */

typedef struct entry_type
{
  char * name;
  char * val;
} cgi_entry_type;

extern cgi_entry_type * cgi_entries;


/* Number of unique name/value entries found (by cgi_init() below). */

extern int cgi_num_entries;


/* Possible error states: */

enum {
  CGIERR_NONE,
  CGIERR_NOT_INTEGER,
  CGIERR_NOT_DOUBLE,
  CGIERR_NOT_BOOL,
  CGIERR_UNKNOWN_METHOD,
  CGIERR_INCORRECT_TYPE,
  CGIERR_NULL_QUERY_STRING,
  CGIERR_BAD_CONTENT_LENGTH,
  CGIERR_CONTENT_LENGTH_DISCREPANCY,
  CGIERR_CANT_OPEN,
  CGIERR_OUT_OF_MEMORY,
  CGIERR_NUM_ERRS
};

extern char * cgi_error_strings[CGIERR_NUM_ERRS];


/* Current error state. */

extern int cgi_errno;


enum {
  CGIREQ_NONE,
  CGIREQ_GET,
  CGIREQ_POST,
  CGIREQ_UNKNOWN
};

/*
  Request method:
*/

extern int cgi_request_method;


/*
  Initializes CGI - receives form data (via either "post" or "get" method).
*/

int cgi_init(void);


/*
  Quits the CGI - frees data structures.
*/

void cgi_quit(void);


/*
  Searches for an entry (name) and returns its value or an empty string.
  
  field_name = string (name) to search for.
*/

char * cgi_getentrystr(char *field_name);

/*
  Same as cgi_getentrystr but begins the search at the start argument,
  which should be a variable that is initialized to 0 for the first call.
  Allows for checkboxes, selects, that have multiple values all with
  the same name. 
 
  start = 0;        // to start the scan from the beginning
  
  // loop thru all the entries with name of "check1"
  // note that start is call-by-reference

  while (check1 = cgi_nextentrystr(&start,"check1"))
    printf("%s ",check1);
 
*/


char * cgi_nextentrystr(int *start, char *field_name);


/*
  Searches for an entry (name) and returns its value or 0.
  
  return = value, converted from string to integer.
  field_name = string (name) to search for.
*/

int cgi_getentryint(char *field_name);


/*
  Searches for an entry (name) and returns its value or 0.0.
  
  return = value, converted from string to double.
  field_name = string (name) to search for.
*/

double cgi_getentrydouble(char *field_name);



/*
  Searches for an entry (name) and returns:
  
  0 if the value is "no" or "off"
  1 if the value is "yes" or "on"
  def if the value is none of those
  
  return = determined by entry's value (yes/on=1, no/off=0, else def)
  field_name = string (name) to search for.
*/

int cgi_getentrybool(char *field_name, int def);



/*
  Opens "filename" and displays it to stdout (browser).

  return = -1 on error, 0 on ok.
*/

int cgi_dump_no_abort(char * filename);



/*
  Opens "filename" and displays it to stdout (browser).
  
  Displays error message to stdout and aborts on error.
*/

void cgi_dump(char * filename);



/*
  Makes sure an email address is formatted correctly.
  
  Returns 1 on good address, 0 on badly formatted one.
*/

int cgi_goodemailaddress(char * addr);



/*
  Displays a generic error message and quits (exit(0);).
*/

void cgi_error(char * reason);


/*
  Returns the english text string for a CGI error.
*/

char * cgi_strerror(int err);