annotate src/InStream.java @ 5:bdb8d7c7d4d1

update version0.1
author e085711
date Fri, 15 Apr 2011 18:31:12 +0900
parents 60a87e277536
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
1 /* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
2 *
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
3 * This is free software; you can redistribute it and/or modify
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
4 * it under the terms of the GNU General Public License as published by
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
5 * the Free Software Foundation; either version 2 of the License, or
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
6 * (at your option) any later version.
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
7 *
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
8 * This software is distributed in the hope that it will be useful,
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
11 * GNU General Public License for more details.
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
12 *
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
13 * You should have received a copy of the GNU General Public License
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
14 * along with this software; if not, write to the Free Software
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
16 * USA.
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
17 */
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
18
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
19 //
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
20 // rdr::InStream marshalls data from a buffer stored in RDR (RFB Data
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
21 // Representation).
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
22 //
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
23
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
24 abstract public class InStream {
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
25
4
e085711
parents: 0
diff changeset
26 // check() ensures there is buffer data for at least one item of size
e085711
parents: 0
diff changeset
27 // itemSize bytes. Returns the number of items in the buffer (up to a
e085711
parents: 0
diff changeset
28 // maximum of nItems).
e085711
parents: 0
diff changeset
29
e085711
parents: 0
diff changeset
30 public final int check(int itemSize, int nItems) throws Exception {
e085711
parents: 0
diff changeset
31 if (ptr + itemSize * nItems > end) {
e085711
parents: 0
diff changeset
32 if (ptr + itemSize > end)
e085711
parents: 0
diff changeset
33 return overrun(itemSize, nItems);
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
34
4
e085711
parents: 0
diff changeset
35 nItems = (end - ptr) / itemSize;
e085711
parents: 0
diff changeset
36 }
e085711
parents: 0
diff changeset
37 return nItems;
e085711
parents: 0
diff changeset
38 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
39
4
e085711
parents: 0
diff changeset
40 public final void check(int itemSize) throws Exception {
e085711
parents: 0
diff changeset
41 if (ptr + itemSize > end)
e085711
parents: 0
diff changeset
42 overrun(itemSize, 1);
e085711
parents: 0
diff changeset
43 }
e085711
parents: 0
diff changeset
44
e085711
parents: 0
diff changeset
45 // readU/SN() methods read unsigned and signed N-bit integers.
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
46
4
e085711
parents: 0
diff changeset
47 public final int readS8() throws Exception {
e085711
parents: 0
diff changeset
48 check(1);
e085711
parents: 0
diff changeset
49 return b[ptr++];
e085711
parents: 0
diff changeset
50 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
51
4
e085711
parents: 0
diff changeset
52 public final int readS16() throws Exception {
e085711
parents: 0
diff changeset
53 check(2);
e085711
parents: 0
diff changeset
54 int b0 = b[ptr++];
e085711
parents: 0
diff changeset
55 int b1 = b[ptr++] & 0xff;
e085711
parents: 0
diff changeset
56 return b0 << 8 | b1;
e085711
parents: 0
diff changeset
57 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
58
4
e085711
parents: 0
diff changeset
59 public final int readS32() throws Exception {
e085711
parents: 0
diff changeset
60 check(4);
e085711
parents: 0
diff changeset
61 int b0 = b[ptr++];
e085711
parents: 0
diff changeset
62 int b1 = b[ptr++] & 0xff;
e085711
parents: 0
diff changeset
63 int b2 = b[ptr++] & 0xff;
e085711
parents: 0
diff changeset
64 int b3 = b[ptr++] & 0xff;
e085711
parents: 0
diff changeset
65 return b0 << 24 | b1 << 16 | b2 << 8 | b3;
e085711
parents: 0
diff changeset
66 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
67
4
e085711
parents: 0
diff changeset
68 public final int readU8() throws Exception {
e085711
parents: 0
diff changeset
69 return readS8() & 0xff;
e085711
parents: 0
diff changeset
70 }
e085711
parents: 0
diff changeset
71
e085711
parents: 0
diff changeset
72 public final int readU16() throws Exception {
e085711
parents: 0
diff changeset
73 return readS16() & 0xffff;
e085711
parents: 0
diff changeset
74 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
75
4
e085711
parents: 0
diff changeset
76 public final int readU32() throws Exception {
e085711
parents: 0
diff changeset
77 return readS32() & 0xffffffff;
e085711
parents: 0
diff changeset
78 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
79
4
e085711
parents: 0
diff changeset
80 // readString() reads a string - a U32 length followed by the data.
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
81
4
e085711
parents: 0
diff changeset
82 public final String readString() throws Exception {
e085711
parents: 0
diff changeset
83 int len = readU32();
e085711
parents: 0
diff changeset
84 if (len > maxStringLength)
e085711
parents: 0
diff changeset
85 throw new Exception("InStream max string length exceeded");
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
86
4
e085711
parents: 0
diff changeset
87 char[] str = new char[len];
e085711
parents: 0
diff changeset
88 int i = 0;
e085711
parents: 0
diff changeset
89 while (i < len) {
e085711
parents: 0
diff changeset
90 int j = i + check(1, len - i);
e085711
parents: 0
diff changeset
91 while (i < j) {
e085711
parents: 0
diff changeset
92 str[i++] = (char) b[ptr++];
e085711
parents: 0
diff changeset
93 }
e085711
parents: 0
diff changeset
94 }
e085711
parents: 0
diff changeset
95
e085711
parents: 0
diff changeset
96 return new String(str);
e085711
parents: 0
diff changeset
97 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
98
4
e085711
parents: 0
diff changeset
99 // maxStringLength protects against allocating a huge buffer. Set it
e085711
parents: 0
diff changeset
100 // higher if you need longer strings.
e085711
parents: 0
diff changeset
101
e085711
parents: 0
diff changeset
102 public static int maxStringLength = 65535;
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
103
4
e085711
parents: 0
diff changeset
104 public final void skip(int bytes) throws Exception {
e085711
parents: 0
diff changeset
105 while (bytes > 0) {
e085711
parents: 0
diff changeset
106 int n = check(1, bytes);
e085711
parents: 0
diff changeset
107 ptr += n;
e085711
parents: 0
diff changeset
108 bytes -= n;
e085711
parents: 0
diff changeset
109 }
e085711
parents: 0
diff changeset
110 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
111
4
e085711
parents: 0
diff changeset
112 // readBytes() reads an exact number of bytes into an array at an offset.
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
113
4
e085711
parents: 0
diff changeset
114 public void readBytes(byte[] data, int offset, int length) throws Exception {
e085711
parents: 0
diff changeset
115 int offsetEnd = offset + length;
e085711
parents: 0
diff changeset
116 while (offset < offsetEnd) {
e085711
parents: 0
diff changeset
117 int n = check(1, offsetEnd - offset);
e085711
parents: 0
diff changeset
118 System.arraycopy(b, ptr, data, offset, n);
e085711
parents: 0
diff changeset
119 ptr += n;
e085711
parents: 0
diff changeset
120 offset += n;
e085711
parents: 0
diff changeset
121 }
e085711
parents: 0
diff changeset
122 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
123
4
e085711
parents: 0
diff changeset
124 // readOpaqueN() reads a quantity "without byte-swapping". Because java has
e085711
parents: 0
diff changeset
125 // no byte-ordering, we just use big-endian.
e085711
parents: 0
diff changeset
126
e085711
parents: 0
diff changeset
127 public final int readOpaque8() throws Exception {
e085711
parents: 0
diff changeset
128 return readU8();
e085711
parents: 0
diff changeset
129 }
e085711
parents: 0
diff changeset
130
e085711
parents: 0
diff changeset
131 public final int readOpaque16() throws Exception {
e085711
parents: 0
diff changeset
132 return readU16();
e085711
parents: 0
diff changeset
133 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
134
4
e085711
parents: 0
diff changeset
135 public final int readOpaque32() throws Exception {
e085711
parents: 0
diff changeset
136 return readU32();
e085711
parents: 0
diff changeset
137 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
138
4
e085711
parents: 0
diff changeset
139 public final int readOpaque24A() throws Exception {
e085711
parents: 0
diff changeset
140 check(3);
e085711
parents: 0
diff changeset
141 int b0 = b[ptr++];
e085711
parents: 0
diff changeset
142 int b1 = b[ptr++];
e085711
parents: 0
diff changeset
143 int b2 = b[ptr++];
e085711
parents: 0
diff changeset
144 return b0 << 24 | b1 << 16 | b2 << 8;
e085711
parents: 0
diff changeset
145 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
146
4
e085711
parents: 0
diff changeset
147 public final int readOpaque24B() throws Exception {
e085711
parents: 0
diff changeset
148 check(3);
e085711
parents: 0
diff changeset
149 int b0 = b[ptr++];
e085711
parents: 0
diff changeset
150 int b1 = b[ptr++];
e085711
parents: 0
diff changeset
151 int b2 = b[ptr++];
e085711
parents: 0
diff changeset
152 return b0 << 16 | b1 << 8 | b2;
e085711
parents: 0
diff changeset
153 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
154
4
e085711
parents: 0
diff changeset
155 // pos() returns the position in the stream.
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
156
4
e085711
parents: 0
diff changeset
157 abstract public int pos();
e085711
parents: 0
diff changeset
158
e085711
parents: 0
diff changeset
159 // bytesAvailable() returns true if at least one byte can be read from the
e085711
parents: 0
diff changeset
160 // stream without blocking. i.e. if false is returned then readU8() would
e085711
parents: 0
diff changeset
161 // block.
e085711
parents: 0
diff changeset
162
e085711
parents: 0
diff changeset
163 public boolean bytesAvailable() {
e085711
parents: 0
diff changeset
164 return end != ptr;
e085711
parents: 0
diff changeset
165 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
166
4
e085711
parents: 0
diff changeset
167 // getbuf(), getptr(), getend() and setptr() are "dirty" methods which allow
e085711
parents: 0
diff changeset
168 // you to manipulate the buffer directly. This is useful for a stream which
e085711
parents: 0
diff changeset
169 // is a wrapper around an underlying stream.
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
170
4
e085711
parents: 0
diff changeset
171 public final byte[] getbuf() {
e085711
parents: 0
diff changeset
172 return b;
e085711
parents: 0
diff changeset
173 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
174
4
e085711
parents: 0
diff changeset
175 public final int getptr() {
e085711
parents: 0
diff changeset
176 return ptr;
e085711
parents: 0
diff changeset
177 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
178
4
e085711
parents: 0
diff changeset
179 public final int getend() {
e085711
parents: 0
diff changeset
180 return end;
e085711
parents: 0
diff changeset
181 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
182
4
e085711
parents: 0
diff changeset
183 public final void setptr(int p) {
e085711
parents: 0
diff changeset
184 ptr = p;
e085711
parents: 0
diff changeset
185 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
186
4
e085711
parents: 0
diff changeset
187 // overrun() is implemented by a derived class to cope with buffer overrun.
e085711
parents: 0
diff changeset
188 // It ensures there are at least itemSize bytes of buffer data. Returns
e085711
parents: 0
diff changeset
189 // the number of items in the buffer (up to a maximum of nItems). itemSize
e085711
parents: 0
diff changeset
190 // is supposed to be "small" (a few bytes).
e085711
parents: 0
diff changeset
191
e085711
parents: 0
diff changeset
192 abstract protected int overrun(int itemSize, int nItems) throws Exception;
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
193
4
e085711
parents: 0
diff changeset
194 protected InStream() {
e085711
parents: 0
diff changeset
195 }
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
196
4
e085711
parents: 0
diff changeset
197 protected byte[] b;
e085711
parents: 0
diff changeset
198 protected int ptr;
e085711
parents: 0
diff changeset
199 protected int end;
0
e04119c40b9b upload all file of tighVNCClient
e085711
parents:
diff changeset
200 }