//////////////////////////////////////////////////////////////////////////////
/// \file   Serial.h
/// \brief  RS232 serial i/o.
/// \author JD Gascuel.
///
/// \copyright (c) 2011-2016 JD Gascuel. All rights reserved.
/// $Id$
//////////////////////////////////////////////////////////////////////////////
//
// BSD 2-Clause License:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////////
// HISTORY
//  2012-09-22 : [jDG] Split from Frog.cpp to OSTC_Planner.cpp
//  2013-03-17 : [jDG] Adapted from OSTC Planner to OSTC Companion.
//  2014-07-07 : [jDG] Cleanups for Subsurface google-summer-of-code.
//  2014-07-25 : [jDG] BSD 2-clause license.

#ifndef SERIAL_H
#define SERIAL_H

class QString;

#include <QtGlobal>         // Q_OS_WIN

#ifdef Q_OS_WIN
#ifndef NOMINMAX
#   define NOMINMAX
#endif
//#   define  NOMINMAX
#   include <windows.h>
#   define  S_HANDLE                HANDLE
#   undef NOMINMAX
#else
#   define  S_HANDLE                int
#endif

//////////////////////////////////////////////////////////////////////////////
// \brief RS232 serial i/o
class  Serial
{
    S_HANDLE    _hSerial;
    bool        _isOpen;

public:
    inline Serial()
        : _hSerial(0),
          _isOpen(false)
    {}

    virtual ~Serial();

    virtual void open(const QString &port, const QString& type);
    virtual void close();

    virtual void writeByte(unsigned char byte) const;
    virtual unsigned char readByte() const;

    virtual void writeBlock(const unsigned char* ptr, unsigned int size) const;
    virtual unsigned int readBlock(unsigned char* ptr, unsigned int size) const;

    virtual void purge();
    virtual void flush() const;

    void writeShort(unsigned short word) const;
    unsigned short readShort() const;

    void writeInt24(unsigned int int24) const;
    unsigned int readInt24() const;

    void sleep(int msec) const;

    inline bool isOpen() const { return _isOpen; }
};

#endif // SERIAL_H