platypus/buffer.h

/* File Name: buffer.h
 * Version: 1.16.2
 * Author: S^R & Victor Fernandes
 * Date: 1 February 2017
 * Preprocessor directives, type declarations and prototypes 
 necessary for buffer implementation
 * as required for CST8152, Assignment #1, Winter 2017.
 * Function list: b_create, b_addc, b_reset, b_free, b_isfull,
 b_size, b_capacity, b_setmark, b_mark, b_mode, b_incfactor,
 b_load, b_isempty, b_eob, b_getc, b_print, b_pack, b_rflag,
 b_retract, b_retract_to_mark, b_getcoffset, b_cbhead
 */
#ifndef BUFFER_H_
#define BUFFER_H_

/*#pragma warning(1:4001) *//*to enforce C89 type comments  - to make //comments an warning */

/*#pragma warning(error:4001)*//* to enforce C89 comments - to make // comments an error */

/* standard header files */
#include <stdio.h>  /* standard input/output */
#include <mm_malloc.h> /* for dynamic memory allocation.*/
#include <limits.h> /* implementation-defined data type ranges and limits */

/* constant definitions */
#ifndef TRUE 
#define TRUE 1
#endif

#ifndef FALSE 
#define FALSE 0
#endif

#define R_FAIL1 -1         /* fail return value */
#define R_FAIL2 -2         /* fail return value */
#define LOAD_FAIL -2       /* load fail error */
#define SET_R_FLAG 1       /* realloc flag set value */
#define UNSET_R_FLAG 0     /* unset reallocation flag */
#define SET_EOB_FLAG 1     /* set end of buffer flag */
#define UNSET_EOB_FLAG 0   /* unset end of buffer flag */

#define MUL_OP_MODE -1     /* multiplicative op mode */
#define FIX_OP_MODE 0      /* fixed op mode */
#define ADD_OP_MODE 1      /* additive op mode */

#define OFFSET_RESET 0     /* reset character offset */

#define ZERO_CAPACITY 0
#define MIN_CAPACITY 1      /* minimum character buffer capacity */
#define FIX_INC_FACTOR 0    /* fixed increment factor constant */
#define MIN_INC_FACTOR 1    /* minimum additive increment factor constant */
#define MIN_MUL_INC_FACTOR 1    /* minumum multiplicative increment factor constant */
#define MAX_ADD_INC_FACTOR 255  /* maximum additive increment factor constant */
#define MAX_MUL_INC_FACTOR 100  /* maximum multiplicative increment factor constant */

#define ERR_INC_FACTOR 256 /* return value in case of error on reading increment factor */

/* user data type declarations */
typedef struct BufferDescriptor {
    char *cb_head;   /* pointer to the beginning of character array (character buffer) */
    short capacity;    /* current dynamic memory size (in bytes) allocated to character buffer */
    short addc_offset;  /* the offset (in chars) to the add-character location */
    short getc_offset;  /* the offset (in chars) to the get-character location */
    short mark_offset; /* the offset (in chars) to the mark location */
    char  inc_factor; /* character array increment factor */
    char  r_flag;     /* reallocation flag */
    char  mode;       /* operational mode indicator*/
    int   eob;       /* end-of-buffer flag */
} Buffer, *pBuffer;
/*typedef Buffer *pBuffer;*/

/* function declarations */
Buffer* b_create(short, char, char);
pBuffer b_addc(pBuffer const, char);
int b_reset(Buffer* const);
void b_free(Buffer* const);
int b_isfull(Buffer* const);
short b_size(Buffer* const);
short b_capacity(Buffer* const);
char* b_setmark(Buffer* const, short);
short b_mark(Buffer* const);
int b_mode(Buffer* const);
size_t b_incfactor(Buffer* const);
int b_load(FILE* const, Buffer* const);
int b_isempty(Buffer* const);
int b_eob(Buffer* const);
char b_getc(Buffer* const);
int b_print(Buffer* const);
Buffer* b_pack(Buffer* const);
char b_rflag(Buffer* const);
short b_retract(Buffer* const);
short b_retract_to_mark(Buffer* const);
short b_getcoffset(Buffer* const);
char* b_cbhead(Buffer* const);

#endif