char_dev.hpp

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef CHAR_DEV_HPP_
#define CHAR_DEV_HPP_

#include <stdint.h>

#include "FreeRTOS.h"
#include "queue.h"
#include "semphr.h"



class CharDev
{
    public:
        virtual bool getChar(char* pInputChar, unsigned int timeout=portMAX_DELAY) = 0;

        virtual bool putChar(char out, unsigned int timeout=portMAX_DELAY) = 0;

        virtual bool flush(void) { return true; }

        bool put  (const char* pString, unsigned int timeout=0xffffffff);
        void putline(const char* pBuff, unsigned int timeout=0xffffffff);
        bool gets(char* pBuff, int maxLen, unsigned int timeout=0xffffffff);

        int printf(const char *format, ...);

        int scanf(const char *format, ...);

        inline uint16_t getPrintfMemSize(void) const { return mPrintfMemSize; }

        bool isReady(void) { return mReady; }
        void setReady(bool r) { mReady = r; }
    protected:
        CharDev();
        virtual ~CharDev();

    private:
        char *mpPrintfMem;                  
        uint16_t mPrintfMemSize;            
        SemaphoreHandle_t mPrintfSemaphore; 
        bool mReady;                        
};



#endif /* CHAR_DEV_HPP_ */