platypus/buffer.c

/*
 * File Name: buffer.c
 * Compiler: GCC 6.2.0
 * Author: Victor Fernandes, 040772243
 * Course: CST8152 - Compilers, Lab Section: 011
 * Date: September 12, 2016
 * Professor: Svillen Ravev
 * A character buffer utility with three modes of self-incrementation
 through dynamic memory allocation, and ability to set a mark flag.
 * Function list:
 * TODO: Function list and finish algorithm descriptions
 */




#include <limits.h>
#include <stdlib.h>
#include "buffer.h"

/* Initializes and allocates memory for the buffer descriptor
 * Author: Victor Fernandes
 * Version: 0.0.1
 * Called functions: calloc(), malloc(), free()
 * Parameters:
    - short init_capacity (0 - SHRT_MAX)
    - char inc_factor (1 - 255)
    - char o_mode (-1, 0, 1)
 * Return values: pBuffer or NULL
 * Algorithm: Allocates memory for the buffer descriptor. If successful, do bound
 checks on function parameters and assign them to the buffer's variables. Otherwise
 return NULL.
 */
Buffer* b_create(short init_capacity, char inc_factor, char o_mode) {
    pBuffer pBD;    /* Pointer to buffer descriptor */

    /* BEGIN CONFIGURING BUFFER */

    /* Check if init_capacitt is whithin acceptable range */
    if (init_capacity > SHRT_MAX || init_capacity < MIN_CAPACITY) {
        return NULL;
    }

    /* Memory allocation */
    pBD = (Buffer *) calloc(1, sizeof(Buffer));
    if (!pBD) {
        return NULL; /* Abort execution immediatelly if allocation fails */
    }

    /* Attempt to allocate memory to cb_head */
    pBD->cb_head = (char *) malloc(sizeof(char) * init_capacity);
    /* Abort configuration if allocation fails and release memory */
    if (!pBD->cb_head) {
        free(pBD);
        return NULL;
    }

    /* Check and set operation mode */
    if (o_mode == 'f' || inc_factor == FIX_INC_FACTOR) {
        pBD->mode = FIX_OP_MODE;
        pBD->inc_factor = FIX_INC_FACTOR;
    } else if (o_mode == 'a' && (inc_factor >= MIN_INC_FACTOR)) {
        pBD->mode = ADD_OP_MODE;
        pBD->inc_factor = inc_factor;
    } else if (o_mode == 'm' && (inc_factor >= MIN_INC_FACTOR && inc_factor <= MAX_MUL_INC_FACTOR)) {
        pBD->mode = MUL_OP_MODE;
        pBD->inc_factor = inc_factor;
    } else { /* Abort everything if parameters out of range (where applicable) */
        free(pBD);
        return NULL;
    }
    
    pBD->capacity = init_capacity;
    /* END CONFIGURING BUFFER */
    return pBD;
}

/* Reports whether the character buffer is full or not
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return values: -1, 0, 1
 */
int b_isfull(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    if (pBD->addc_offset == pBD->capacity) {
        return TRUE;
    } else {
        return FALSE;
    }
}

/* Reports if character buffer is empty
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: -1, 0, 1
 */
int b_isempty(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    if (pBD->addc_offset == OFFSET_RESET) {
        return TRUE;
    } else {
        return FALSE;
    }
}

/* Reports the current size of the character buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_size(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->addc_offset;
}

/* Reports the current capacity of the character buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_capacity(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->capacity;
}

/* Reports the current character buffer's operational mode
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: -2, -1, 0, 1
 */
int b_mode(Buffer* const pBD) {
    if (!pBD) { return R_FAIL2; }
    return pBD->mode;
}

/* Returns the non-negative value of the increment factor of the buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: size_t
 */
size_t b_incfactor(Buffer* const pBD) {
    if (!pBD) { return 256; }
    return (size_t) pBD->inc_factor;
}

/* Reports the current position of the mark offset in the character buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_mark(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->mark_offset;
}

/* Reports if the character buffer's memory space was relocated after resizing
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: char
 */
char b_flag(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->r_flag;
}

/* Reports character buffer's current character offset
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_getcoffset(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->getc_offset;
}

/* Returns the buffer's actual character buffer address
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
char* b_cbhead(Buffer* const pBD) {
    if (!pBD || !pBD->cb_head) { return NULL; }
    return pBD->cb_head;
}

/* Sets a mark offset on the buffer's mark flag
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_setmark(Buffer* const pBD, short mark) {
    if (!pBD || mark < 0 || mark > pBD->addc_offset) { return R_FAIL1; }
    pBD->mark_offset = mark;
    return pBD->mark_offset;
}

/* Reports the end-of-buffer flag state of the character buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: 1, 0
 */
int b_eob(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->eob;
}

/* Adds one character symbol to the character buffer, incrementing its size if
possible and needed
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: b_isfull(), realloc()
 * Parameters:
    - pBuffer const pBD
    - char symbol (1-255)
 * Return value: pBuffer or NULL
 * Algorithm:
 */
Buffer* b_addc(Buffer* const pBD, char symbol) {
    /* Variables used for calculating required space for reallocating cb_head
    for additive or multiplicative modes */
    short avail_space, new_inc, new_cap = 0;

    /* These pointers are used to compare the address of cb_head, in the event it is
    moved to a new address space in memory after reallocation*/
    char *old_addr;
    char *tmp_addr;

    /* Check if pointers are valid before trying anything */
    if (!pBD || !pBD->cb_head) {
        return NULL;
    }

    pBD->r_flag = UNSET_R_FLAG;
    /* BEGIN BUFFER INCREASE */
    if (pBD->addc_offset == pBD->capacity){
        if (pBD->mode == FIX_OP_MODE) { /* Fixed mode */
            return NULL;
        }
        else if (pBD->mode == ADD_OP_MODE) { /* Calculate new size for additive mode */
            new_cap = pBD->capacity + (unsigned char) pBD->inc_factor;

            /* Maximum additive increment is 255, therefore, if the current
            capacity happens to be SHRT_MAX - 1, the value will underflow to a negative number
            every time, and never "wrap" to a value greater than 1.
            */
            if (new_cap < MIN_CAPACITY){
                return NULL;
            }
        }
        else if (pBD->mode == MUL_OP_MODE) { /* Calculate new size in multiplicative mode */
            if (pBD->capacity == SHRT_MAX){
                return NULL;
            }

            /* Mathematically, new_inc cannot be negative, since avail_space will
            always be greater or equal to 0.
            */
            avail_space = SHRT_MAX - pBD->capacity;
            new_inc = (avail_space * (unsigned char) pBD->inc_factor / 100);
            /* The same situation in Additive mode (L284) applies to Multiplicative Mode */
            if (new_inc <= MIN_CAPACITY && pBD->capacity < SHRT_MAX) {
                new_cap = SHRT_MAX;
            }
            else {
                new_cap = pBD->capacity + new_inc;
            }
        }

        /* Reallocate memory to character buffer */
        old_addr = pBD->cb_head; /* Keep track of old pointer address for checking if it changed */
        tmp_addr = (char *)realloc(pBD->cb_head, sizeof(char) * new_cap);
        if (tmp_addr == NULL){
            return NULL; /* Abort everything if allocation fails */
        }
        pBD->cb_head = tmp_addr;
        pBD->capacity = new_cap;
        if (old_addr == pBD->cb_head) { /* Compare the old and new addresses and set flag appropriately */
            pBD->r_flag = SET_R_FLAG;
        }
    } /* END BUFFER INCREASE */

    /* Finally, add new symbol to the buffer after increasing it (or not) */
    pBD->cb_head[pBD->addc_offset] = symbol;
    pBD->addc_offset++;
    return pBD;

}

/* Gets one character symbol from the buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: char
 */
char b_getc(Buffer* const pBD) {
    if (!pBD) { return R_FAIL2; }
    if (b_getcoffset(pBD) == pBD->addc_offset) {
        pBD->eob = SET_EOB_FLAG;
        return R_FAIL1;
    } else {
        pBD->eob = UNSET_EOB_FLAG;
    }
    return pBD->cb_head[pBD->getc_offset++];
}

/* Prints the output of the buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: b_isempty(), b_getc(), b_eob(), printf()
 * Parameters:
    - pBuffer const pBD
 * Return value: int
 */
int b_print(Buffer* const pBD) {
    int char_count = 0; /* Counter to track how many characters were sent to output */
    char char_buf;  /* "Buffer" character to load before output */
    short tmp_offset = pBD->getc_offset;

    if (!pBD || !pBD->cb_head) { return R_FAIL1; }

    if (b_isempty(pBD) == TRUE) { printf("The Buffer is empty.\n"); }
    else {
        pBD->getc_offset = OFFSET_RESET;
        /* Trick the buffer into resetting the eob while printing the contents.
         * The EOB flag will be set again once the loop is finished.
         *
        char_buf = b_getc(pBD);
        b_retract(pBD);
        for (char_count = 0; b_eob(pBD) == FALSE; char_count++) {
            char_buf = b_getc(pBD);
            printf("%c", (char) char_buf);
        }
        printf("\n");*/
        do {
            char_buf = b_getc(pBD);
            printf("%c", (char) char_buf);
            char_count++;
        } while (b_eob(pBD) == FALSE);
        printf("\n");
    }
    /* Restore the getc_offset after printing */
    pBD->getc_offset = tmp_offset;
    return char_count;
}

/* Loads symbols from a file to the buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - FILE* const fi
    - pBuffer const pBD
 * Return value: int
 */
int b_load(FILE* const fi, Buffer* const pBD) {
    char char_buf; /* "Buffer" character to be loaded before adding to cb_head */
    int char_count = 0; /* Character counter */
    /*char eof_flag;*/

    if (!fi || !pBD) { return LOAD_FAIL; }
/*
    for (char_count = 0; !feof(fi); char_count++) {
        char_buf = (char) fgetc(fi);
        if (char_buf == EOF) { break; }

        if (!b_addc(pBD, char_buf)) { return LOAD_FAIL; }
    }*/
    do {
        char_buf = (char) fgetc(fi);
        if (char_buf == EOF) { break; }

        if (!b_addc(pBD, char_buf)) { return LOAD_FAIL; }
        char_count++;
    } while (!feof(fi));
    /*eof_flag = feof(fi);
    for (char_count = 0; !eof_flag; char_count++) {
        char_buf = (char) fgetc(fi);
        eof_flag = feof(fi);
        
        if (char_buf == EOF) { 
            break;
        }

        if (b_addc(pBD, char_buf) == NULL) {
            return LOAD_FAIL;
        }
    }*/
    return char_count;
}

/* Resets the buffer
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: int
 */
int b_reset(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }

    pBD->addc_offset = OFFSET_RESET;
    pBD->getc_offset = OFFSET_RESET;
    pBD->mark_offset = OFFSET_RESET;
    pBD->eob = UNSET_EOB_FLAG;
    return TRUE;
}

/* Retracts the buffer's character offset to the mark
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_retract_to_mark(Buffer* const pBD) {
    /* Check if any offsets are out of bounds */
    if(!pBD ||
        pBD->getc_offset < OFFSET_RESET || pBD->getc_offset > pBD->capacity ||
        pBD->mark_offset < OFFSET_RESET || pBD->mark_offset > pBD->capacity) {
        return R_FAIL1;
    }
    pBD->getc_offset = pBD->mark_offset;
    return pBD->getc_offset;
}

/* Retracts the buffer's character offset one character backwards
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: short
 */
short b_retract(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    else if (pBD->getc_offset > OFFSET_RESET) {
        pBD->getc_offset--;
    }
    return pBD->getc_offset;
}
/* Returns the buffer's memory reallocation flag
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: N/A
 * Parameters:
    - pBuffer const pBD
 * Return value: char
 */
char b_rflag(Buffer* const pBD) {
    if (!pBD) { return R_FAIL1; }
    return pBD->r_flag;
}

/* Reduce the size of the character buffer to free up memory
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: realloc()
 * Parameters:
    - pBuffer const pBD
 * Return value: Buffer* const
 */
Buffer* b_pack(Buffer* const pBD) {
    short new_cap; /* Used to set the new buffer capacity value */
    
    /* Temporary pointers used to compare old and new pointer addresses */
    char *old_addr; 
    char *tmp_addr;

    if (!pBD || !pBD->cb_head) { return NULL; }

    /* Configure new capacity value */
    new_cap = pBD->addc_offset + 1;
    old_addr = pBD->cb_head;

    /* Reallocate cb_head to new size */
    tmp_addr = realloc(pBD->cb_head, sizeof(char) * new_cap);
    if (!tmp_addr){ return NULL; } /* Abort if realloc failed */

    /* Assign new address to cb_head and reassign capacity value */
    pBD->cb_head = tmp_addr;
    pBD->capacity = new_cap;

    /* Compare old and new addresses and set R_FLAG accordingly */
    if (old_addr != pBD->cb_head){
        pBD->r_flag = SET_R_FLAG;
    }
    return pBD;
}

/* Deallocate and release all memory used by the buffer.
 * Author: Victor Fernandes, 040772243
 * Version: 0.0.1
 * Called functions: free()
 * Parameters:
    - pBuffer const pBD
 * Return value: N/A
 */
void b_free(Buffer* const pBD) {
    free(pBD->cb_head);
    free(pBD);
}