aboutsummaryrefslogtreecommitdiff
path: root/SrcShared/EmTransportSerial.h
blob: d74d2bae2099abea356106398766cfd1039344b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* -*- mode: C++; tab-width: 4 -*- */
/* ===================================================================== *\
	Copyright (c) 1999-2001 Palm, Inc. or its subsidiaries.
	All rights reserved.

	This file is part of the Palm OS Emulator.

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.
\* ===================================================================== */

#ifndef EmTransportSerial_h
#define EmTransportSerial_h

#include "EmTransport.h"

#include <map>
#include <string>
#include <vector>

class EmHostTransportSerial;

class EmTransportSerial : public EmTransport
{
	public:
		typedef string	PortName;
		typedef long	Baud;
		typedef long	StopBits;
		typedef long	DataBits;
		typedef long	HwrHandshake;

		typedef vector<PortName>	PortNameList;
		typedef vector<Baud>		BaudList;

		enum Parity
		{
			kNoParity,
			kOddParity,
			kEvenParity
		};

		enum RTSControl
		{
			kRTSOff,
			kRTSOn,
			kRTSAuto
		};

		// Note: this used to be named "Config", but that runs
		// afoul of a bug in VC++ (see KB Q143082).
		struct ConfigSerial : public EmTransport::Config
		{
									ConfigSerial	(void);
			virtual					~ConfigSerial	(void);

			virtual EmTransport*	NewTransport	(void);
			virtual EmTransport*	GetTransport	(void);

			bool operator==(const ConfigSerial& other) const;

			PortName		fPort;
			Baud			fBaud;
			Parity			fParity;
			StopBits		fStopBits;
			DataBits		fDataBits;
			HwrHandshake	fHwrHandshake;
		};

		typedef map<PortName, EmTransportSerial*>	OpenPortList;

	public:
								EmTransportSerial		(void);
								EmTransportSerial		(const EmTransportDescriptor&);
								EmTransportSerial		(const ConfigSerial&);
		virtual					~EmTransportSerial		(void);

		virtual ErrCode			Open					(void);
		virtual ErrCode			Close					(void);

		virtual ErrCode			Read					(long&, void*);
		virtual ErrCode			Write					(long&, const void*);

		virtual Bool			CanRead					(void);
		virtual Bool			CanWrite				(void);
		virtual long			BytesInBuffer			(long minBytes);
		virtual string			GetSpecificName			(void);

		ErrCode					SetConfig				(const ConfigSerial&);
		void					GetConfig				(ConfigSerial&);

		void					SetRTS					(RTSControl state);
		void					SetDTR					(Bool state);
		void					SetBreak				(Bool state);

		Bool					GetCTS					(void);
		Bool					GetDSR					(void);

		static EmTransportSerial*	GetTransport		(const ConfigSerial&);
		static void				GetDescriptorList		(EmTransportDescriptorList&);
		static void				GetSerialBaudList		(BaudList&);

	private:
		void					HostConstruct			(void);
		void					HostDestruct			(void);

		ErrCode					HostOpen				(void);
		ErrCode					HostClose				(void);

		ErrCode					HostRead				(long&, void*);
		ErrCode					HostWrite				(long&, const void*);
		long					HostBytesInBuffer		(long minBytes);

		ErrCode					HostSetConfig			(const ConfigSerial&);

		void					HostSetRTS				(RTSControl state);
		void					HostSetDTR				(Bool state);
		void					HostSetBreak			(Bool state);

		Bool					HostGetCTS				(void);
		Bool					HostGetDSR				(void);

		static void				HostGetPortNameList		(PortNameList&);
		static void				HostGetSerialBaudList	(BaudList&);

		EmHostTransportSerial*	fHost;
		ConfigSerial			fConfig;
		Bool					fCommEstablished;

		static OpenPortList		fgOpenPorts;
};

#endif /* EmTransportSerial_h */