serialbase.h

Go to the documentation of this file.

//======================================================================
//======================================================================

#ifndef SERIALBASE_H_
#define SERIALBASE_H_

#include "sdhlibrary_settings.h"

#if SDH_USE_VCC
# pragma warning(disable : 4290)
#endif

//----------------------------------------------------------------------
// System Includes - include with <>
//----------------------------------------------------------------------

#if SDH_USE_VCC
# include <windows.h>
# include <strsafe.h>
#else
# include <errno.h>
#endif

//----------------------------------------------------------------------
// Project Includes - include with ""
//----------------------------------------------------------------------

#include "sdhexception.h"
#include "dbg.h"
#include "sdhbase.h" // for g_sdh_debug_log

//----------------------------------------------------------------------
// Defines, enums, unions, structs,
//----------------------------------------------------------------------

NAMESPACE_SDH_START

typedef void* tDeviceHandle;  

#if SDH_USE_VCC
# define snprintf _snprintf
#endif

//----------------------------------------------------------------------
// Global variables
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Function and class member declarations
//----------------------------------------------------------------------





class VCC_EXPORT cSerialBaseException: public cSDHErrorCommunication
{
 public:
    cSerialBaseException( cMsg const & _msg )
        : cSDHErrorCommunication( "cSerialBaseException", _msg )
    {}

    cSerialBaseException( char const* _type, cMsg const & _msg )
        : cSDHErrorCommunication( _type, _msg )
    {}
};
//======================================================================


class VCC_EXPORT cSerialBase
{
 protected:

    char ungetch;

    bool ungetch_valid;

    double timeout;

 public:
    cSerialBase()
    : // init members
        ungetch('\0'),
        ungetch_valid(false),
        timeout( -1.0 ),
        // setting the timeout does not make sense here. should be left to virtual SetTimeout()
        dbg( false, "magenta", g_sdh_debug_log )
    {
        // nothing more to do
    }

    virtual ~cSerialBase( void )
    {
    }


    virtual void Open( void ) = 0;

    virtual bool IsOpen( void )
        throw() = 0;

    virtual void Close( void ) = 0;

    virtual void SetTimeout( double _timeout )
    {
        timeout = _timeout;
    }

    virtual double GetTimeout()
    {
        return timeout;
    }

    class cSetTimeoutTemporarily
    {
        cSerialBase* serial_base;
        double       old_timeout;
    public:
        cSetTimeoutTemporarily( cSerialBase* _serial_base, double new_timeout )
        : serial_base(_serial_base),
          old_timeout( serial_base->GetTimeout() )
        {
            if ( new_timeout != old_timeout )
                serial_base->SetTimeout( new_timeout );
        }

        ~cSetTimeoutTemporarily()
        {
            if ( old_timeout != serial_base->GetTimeout() )
                serial_base->SetTimeout( old_timeout );
        }
    };



    virtual int write( char const *ptr, int len=0 ) = 0;

    virtual ssize_t Read( void *data, ssize_t size, long timeout_us, bool return_on_less_data ) = 0;


    virtual char* readline( char* line, int size, char const* eol = "\n", bool return_on_less_data = false );

    cDBG dbg;

#if SDH_USE_VCC
    typedef DWORD tErrorCode;
#else
    typedef int tErrorCode;
#endif

    virtual tErrorCode GetErrorNumber()
    {
#if SDH_USE_VCC
        return GetLastError();
#else
        return errno;
#endif
    }

    virtual char const* GetErrorMessage( tErrorCode dw );

    char const* GetLastErrorMessage( void )
    {
        return GetErrorMessage( GetErrorNumber() );
    }

    virtual bool UseCRC16()
    {
        return false;
    }
    //----------------------------------------------------------------------

};
//======================================================================

NAMESPACE_SDH_END

#endif


//======================================================================
/*
  Here are some settings for the emacs/xemacs editor (and can be safely ignored):
  (e.g. to explicitely set C++ mode for *.h header files)

  Local Variables:
  mode:C++
  mode:ELSE
  End:
*/
//======================================================================