/*
 * FIFO Buffer
 * Implementation uses arrays to conserve memory
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Daniel Eisterhold
 *
 * 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.
 *
 * 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.
 *
 *
 *
 * Modified/Ammended by Alessandro Carcione 2020
 */

#pragma once

#include "targets.h"

// If this is 256 then the compiler can optimise out the modulo because the head/tail are uint8_t types
#define FIFO_SIZE 256

class FIFO
{
private:
    uint8_t head;
    uint8_t tail;
    uint16_t numElements;
    uint8_t buffer[FIFO_SIZE] = {0};

public:
    FIFO();
    ~FIFO();
    void ICACHE_RAM_ATTR push(const uint8_t data);
    void ICACHE_RAM_ATTR pushBytes(const uint8_t *data, int len);
    uint8_t ICACHE_RAM_ATTR pop();
    void ICACHE_RAM_ATTR popBytes(uint8_t *data, int len);
    uint8_t ICACHE_RAM_ATTR peek();
    uint16_t ICACHE_RAM_ATTR size();
    void ICACHE_RAM_ATTR flush();
};
