//
// Copyright 2014 Cristian Maglie. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//

package serial

import "io"

// SerialPort object
type SerialPort interface {
	io.ReadWriteCloser

	// Set all parameters together
	SetMode(mode *Mode) error
}

type Mode struct {
	BaudRate int
	DataBits int
	Parity   Parity
	StopBits StopBits
}

type Parity int

const (
	PARITY_NONE Parity = iota
	PARITY_ODD
	PARITY_EVEN
	PARITY_MARK
	PARITY_SPACE
)

type StopBits int

const (
	STOPBITS_ONE StopBits = iota
	STOPBITS_ONEPOINTFIVE
	STOPBITS_TWO
)

// Platform independent error type for serial ports
type SerialPortError struct {
	err  string
	code int
}

const (
	ERROR_PORT_BUSY = iota
	ERROR_PORT_NOT_FOUND
	ERROR_INVALID_SERIAL_PORT
	ERROR_PERMISSION_DENIED
	ERROR_INVALID_PORT_SPEED
	ERROR_INVALID_PORT_DATA_BITS
	ERROR_ENUMERATING_PORTS
	ERROR_OTHER
)

func (e SerialPortError) Error() string {
	switch e.code {
	case ERROR_PORT_BUSY:
		return "Serial port busy"
	case ERROR_PORT_NOT_FOUND:
		return "Serial port not found"
	case ERROR_INVALID_SERIAL_PORT:
		return "Invalid serial port"
	case ERROR_PERMISSION_DENIED:
		return "Permission denied"
	case ERROR_INVALID_PORT_SPEED:
		return "Invalid port speed"
	case ERROR_INVALID_PORT_DATA_BITS:
		return "Invalid port data bits"
	case ERROR_ENUMERATING_PORTS:
		return "Could not enumerate serial ports"
	}
	return e.err
}

func (e SerialPortError) Code() int {
	return e.code
}

// vi:ts=2