//-------------------------------------------------------------------------------
// <copyright file="HDLCParser.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, Inc.
//
// 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.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
//   Declarations for the HDLCParser class, which provides utilities for encoding
//   and decoding bytes in HDLC message format (used for sending messages across
//   the payload port)
// </summary>
//
// <owner>Mike Cookson</owner>
//-------------------------------------------------------------------------------

#ifndef HDLCPARSER_H_
#define HDLCPARSER_H_

#include "LqrSMACByteArray.h"
#include "LqrSMACSharedLib.h"
#include <boost/utility.hpp>

namespace LiquidRobotics {
namespace PayloadInterface {

class SHARED_LIB_PUBLIC HDLCParser : public boost::noncopyable
{
public:

	typedef LiquidRobotics::SMACFramework::ByteArray ByteArray;
	typedef LiquidRobotics::SMACFramework::ByteArray::byte byte;

	static const byte ESC;
	static const byte ESCMask;
	static const byte SOF;

	HDLCParser(ByteArray& _block, ByteArray::size_type maxSize);

	virtual ~HDLCParser();

	ByteArray::size_type Feed(const ByteArray& input, ByteArray::size_type offset = 0);
	ByteArray::size_type GetMaxSize() const { return maxSize; }
	void Reset();
	bool Succeeded() const { return succeeded; }
	static unsigned LengthFromBlock(const ByteArray& bytes);

private:

	ByteArray& block;
	bool inBlock;
	bool inEscape;
	bool succeeded;
	ByteArray::size_type blockLength;
	const ByteArray::size_type maxSize;
};

}
}

#endif /* HDLCPARSER_H_ */
