nb_readline.h

#ifndef  __NB_READLINE_H
#define  __NB_READLINE_H
/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#include <predef.h>
#include <stdint.h>
#include <nbrtos.h>
 
#ifdef __cplusplus
extern "C"
#endif
int readline(int fd, char *buf, uint32_t buflen, uint32_t *rdidx, bool *done, uint32_t timeout);
 
class FdLineReader {
public:
    enum class eLineEnd : uint16_t {
        CR = 1,
        LF = 2,
        CRLF = 3,
 
        None = 0, // internal tracking only, not allowed to be used as a setting
    };
protected:
    int fd;
    char *buf;
    uint16_t buflen;
    uint16_t rdidx;
    uint16_t doEcho  :  1;
    uint16_t done    :  1;
    // Stored as raw 2-bit codes (eLineEnd values) rather than the scoped enum
    // type itself, to avoid GCC's unconditional "bitfield too small to hold all
    // values of 'enum class'" warning. GetLineEnd()/GetLineEndEcho() expose them
    // as eLineEnd, so the public interface is unchanged. eLineEnd's underlying
    // type is uint16_t, so this keeps the struct layout byte-identical.
    uint16_t lineEnd :  2;
    uint16_t endState:  2;
    uint16_t doEndEcho: 2;
    TickTimeout timeout;
    uint32_t timeoutTicks;   // configured per-ReadLine() timeout in ticks; 0 = wait forever
 
public:
    FdLineReader(char *rdbuf, uint16_t rdbuf_len);
    FdLineReader(char *rdbuf, uint16_t rdbuf_len, int ioFd, uint32_t timeout = 0);
 
    virtual int ReadLine(bool noblock = false);
    inline char *GetLine() const { return buf; }
    inline bool HaveLine() { return done!=0; }
 
    void SetLineEnd(eLineEnd newEnd);
    eLineEnd GetLineEnd() { return (eLineEnd)lineEnd; }
 
    void SetLineEndEcho(eLineEnd newEndEcho);
    eLineEnd GetLineEndEcho() { return (eLineEnd)doEndEcho; }
 
    operator char *() const { return GetLine(); }
    inline operator bool () { return done!=0; }
 
    friend int readline(int fd, char *buf, uint32_t buflen, uint32_t *rdidx, bool *done, uint32_t timeout);
};
 
class FdHistoryReader : public FdLineReader
{
protected:
    char *bufpool;
    uint8_t bufcount;
    uint8_t idx_next;
    uint8_t idx_active;
    uint8_t total;
    uint8_t isEscaped;
 
    void SwapBufs(int dir, char **pNext, char **pEnd);
 
public:
    FdHistoryReader(char *rdbuf, uint16_t rdbuf_len, uint8_t rdbuf_count);
    FdHistoryReader(char *rdbuf, uint16_t rdbuf_len, uint8_t rdbuf_count, int ioFd, uint32_t timeout = 0);
 
    virtual int ReadLine(bool noblock = false) override;
};
 
 
#endif   /* ----- #ifndef __NB_READLINE_H  ----- */