termreader.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006  SRI International
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * SRI International: 333 Ravenswood Ave, Menlo Park, CA 94025
 */

#ifndef TERMREADER_H
#define TERMREADER_H

#include "libicl.h"
#include "glib.h"

#ifdef NORMAL_GC
#undef CHECK_LEAKS
#include <gc/leak_detector.h>
#undef strdup
  EXTERN char* gc_strdup(char*s);
#define strdup(s) gc_strdup(s)
#else
#define CHECK_LEAKS()
#endif

#ifdef __cplusplus
extern "C" {
#endif

  struct TermReaderStruct;
  typedef struct TermReaderStruct TermReader;

  typedef ICLTerm* (*TermReaderGetNext)(TermReader*, double);
  typedef void (*TermReaderCleanup)(TermReader*);

  enum TermReaderTypeEnum {
    UNKNOWNTERMREADERTYPE = -1,
    STRINGTERMREADERTYPE = 0,
    BINARYTERMREADERTYPE = 1,
    FILETERMREADERTYPE = 2
  }
  ;
  typedef enum TermReaderTypeEnum TermReaderType;

  enum TermReaderErrorNum {
    TERMREADER_BINUNREACHABLE = -106,
    TERMREADER_BINNOTENOUGHARGS = -105,
    TERMREADER_BINBADICLSTRUCT = -104,
    TERMREADER_BINBADICLSTR = -103,
    TERMREADER_BINBADICLVAR = -102,
    TERMREADER_BINUNEXPECTEDTYPE = -101,
    TERMREADER_BINUNEXPECTEDSENTINEL = -100,
    
    TERMREADER_NOTINITIALIZED = -3,
    TERMREADER_READERR = -2,
    TERMREADER_SELECTERR = -1,

    TERMREADER_OKAY = 0,

    TERMREADER_TIMEOUT = 1,
    TERMREADER_NOCONN = 2,
    TERMREADER_EOF = 3,
    TERMREADER_BINNOTENOUGHDATA = 100
  }
  ;

  EXTERN TermReader* termReader_create();
  EXTERN void termReader_free(TermReader* t);

  EXTERN void termReader_setError(TermReader* t, gint errnum);
  EXTERN gint termReader_getError(TermReader* t);
  EXTERN void termReader_setSocket(TermReader* t, gint newsocket);
  EXTERN gint termReader_getSocket(TermReader* t);
  EXTERN void termReader_setType(TermReader* t, TermReaderType type);
  EXTERN TermReaderType termReader_getType(TermReader* t);
  EXTERN void termReader_setReaderSpecificData(TermReader* t, gpointer g);
  EXTERN gpointer termReader_getReaderSpecificData(TermReader* t);
  EXTERN void termReader_setGetNextCallback(TermReader* t, TermReaderGetNext g);
  EXTERN void termReader_setCleanupCallback(TermReader* t, TermReaderCleanup c);
  
  EXTERN ICLTerm* termReader_getNextTerm(TermReader* t, double timeout);

#ifdef __cplusplus
}
#endif

#endif

---