/* ----------------------------------------------------------------- */    
/*  Copyright (c) 2007 by Richard Harter                             */
/*                                                                   */
/*  Permission is hereby granted, free of charge, to any person      */
/*  obtaining a copy of this software and associated documentation   */
/*  files (the "Software"), to deal in the Software without          */
/*  restriction, including without limitation the rights to use,     */
/*  copy, modify, merge, publish, distribute, sublicense, and/or     */
/*  sell copies of the Software, and to permit persons to whom the   */
/*  Software is furnished to do so, subject to the following         */
/*  conditions:                                                      */
/*                                                                   */
/*  The above copyright notice and this permission notice shall be   */
/*  included in all copies or substantial portions of the            */
/*  Software.                                                        */
/*                                                                   */
/*  Derivative works shall include a notice that the derivative work */
/*  is a modified version of the copyrighted software.               */
/*                                                                   */
/*  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY        */
/*  KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE       */
/*  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR          */
/*  PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR   */
/*  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      */
/*  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR             */
/*  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE        */
/*  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.           */
/*                                                                   */
/* ----------------------------------------------------------------- */
/*                                                                   */
/*                     REVISION HISTORY                              */
/*                                                                   */
/* 21 NOV 2007: Initial release by RH                                */
/*                                                                   */
/* ----------------------------------------------------------------- */

#ifndef HAVE_GETFLINE_H
#define HAVE_GETFLINE_H

#include <stdio.h>

enum gfl_flags {
    gfl_clean = 0x1,  gfl_eofok = 0x2,  gfl_cut   = 0x4,
    gfl_trunc = 0x8,  gfl_omit  = 0x10, gfl_exit  = 0x20,
    gfl_log   = 0x40, gfl_nomax = 0x80
};

enum gfl_errors {
    gfl_ok = 0, gfl_stream, gfl_maxlen, gfl_flags,
    gfl_long,   gfl_badeof, gfl_io,     gfl_storage, 
    gfl_corrupt   
};

struct gfl_cb {
    void            * pvt;
    size_t            length;
    enum gfl_errors   errno;
    size_t            maxlen;
    unsigned int      flags;
};

char * getfline      (FILE* fptr, struct gfl_cb * cb);
int    gfl_terminate (            struct gfl_cb * cb);

#endif