xref: /reactos/base/applications/mstsc/proto.h (revision 1734f297)
1 /* -*- c-basic-offset: 8 -*-
2    rdesktop: A Remote Desktop Protocol client.
3    Copyright (C) Matthew Chapman 1999-2008
4 
5    This program is free software: you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation, either version 3 of the License, or
8    (at your option) any later version.
9 
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14 
15    You should have received a copy of the GNU General Public License
16    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18 
19 #ifndef RDESKTOP_PROTO_H
20 #define RDESKTOP_PROTO_H
21 
22 /* *INDENT-OFF* */
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 /* *INDENT-ON* */
27 /* bitmap.c */
28 RD_BOOL bitmap_decompress(uint8 * output, int width, int height, uint8 * input, int size, int Bpp);
29 /* cache.c */
30 void cache_rebuild_bmpcache_linked_list(uint8 id, sint16 * idx, int count);
31 void cache_bump_bitmap(uint8 id, uint16 idx, int bump);
32 void cache_evict_bitmap(uint8 id);
33 RD_HBITMAP cache_get_bitmap(uint8 id, uint16 idx);
34 void cache_put_bitmap(uint8 id, uint16 idx, RD_HBITMAP bitmap);
35 void cache_save_state(void);
36 FONTGLYPH *cache_get_font(uint8 font, uint16 character);
37 void cache_put_font(uint8 font, uint16 character, uint16 offset, uint16 baseline, uint16 width,
38 		    uint16 height, RD_HGLYPH pixmap);
39 DATABLOB *cache_get_text(uint8 cache_id);
40 void cache_put_text(uint8 cache_id, void *data, int length);
41 uint8 *cache_get_desktop(uint32 offset, int cx, int cy, int bytes_per_pixel);
42 void cache_put_desktop(uint32 offset, int cx, int cy, int scanline, int bytes_per_pixel,
43 		       uint8 * data);
44 RD_HCURSOR cache_get_cursor(uint16 cache_idx);
45 void cache_put_cursor(uint16 cache_idx, RD_HCURSOR cursor);
46 BRUSHDATA *cache_get_brush_data(uint8 colour_code, uint8 idx);
47 void cache_put_brush_data(uint8 colour_code, uint8 idx, BRUSHDATA * brush_data);
48 /* channels.c */
49 VCHANNEL *channel_register(char *name, uint32 flags, void (*callback) (STREAM));
50 STREAM channel_init(VCHANNEL * channel, uint32 length);
51 void channel_send(STREAM s, VCHANNEL * channel);
52 void channel_process(STREAM s, uint16 mcs_channel);
53 /* cliprdr.c */
54 void cliprdr_send_simple_native_format_announce(uint32 format);
55 void cliprdr_send_native_format_announce(uint8 * formats_data, uint32 formats_data_length);
56 void cliprdr_send_data_request(uint32 format);
57 void cliprdr_send_data(uint8 * data, uint32 length);
58 void cliprdr_set_mode(const char *optarg);
59 RD_BOOL cliprdr_init(void);
60 /* ctrl.c */
61 int ctrl_init(const char *user, const char *domain, const char *host);
62 void ctrl_cleanup();
63 RD_BOOL ctrl_is_slave();
64 int ctrl_send_command(const char *cmd, const char *args);
65 void ctrl_add_fds(int *n, fd_set * rfds);
66 void ctrl_check_fds(fd_set * rfds, fd_set * wfds);
67 
68 /* disk.c */
69 int disk_enum_devices(uint32 * id, char *optarg);
70 RD_NTSTATUS disk_query_information(RD_NTHANDLE handle, uint32 info_class, STREAM out);
71 RD_NTSTATUS disk_set_information(RD_NTHANDLE handle, uint32 info_class, STREAM in, STREAM out);
72 RD_NTSTATUS disk_check_notify(RD_NTHANDLE handle);
73 RD_NTSTATUS disk_create_notify(RD_NTHANDLE handle, uint32 info_class);
74 RD_NTSTATUS disk_query_volume_information(RD_NTHANDLE handle, uint32 info_class, STREAM out);
75 RD_NTSTATUS disk_query_directory(RD_NTHANDLE handle, uint32 info_class, char *pattern, STREAM out);
76 /* mppc.c */
77 int mppc_expand(uint8 * data, uint32 clen, uint8 ctype, uint32 * roff, uint32 * rlen);
78 /* ewmhints.c */
79 int get_current_workarea(uint32 * x, uint32 * y, uint32 * width, uint32 * height);
80 void ewmh_init(void);
81 /* iso.c */
82 STREAM iso_init(int length);
83 void iso_send(STREAM s);
84 STREAM iso_recv(uint8 * rdpver);
85 RD_BOOL iso_connect(char *server, char *username, char *domain, char *password, RD_BOOL reconnect,
86 		    uint32 * selected_protocol);
87 void iso_disconnect(void);
88 void iso_reset_state(void);
89 /* cssp.c */
90 RD_BOOL cssp_connect(char *server, char *user, char *domain, char *password, STREAM s);
91 /* licence.c */
92 void licence_process(STREAM s);
93 /* mcs.c */
94 STREAM mcs_init(int length);
95 void mcs_send_to_channel(STREAM s, uint16 channel);
96 void mcs_send(STREAM s);
97 STREAM mcs_recv(uint16 * channel, uint8 * rdpver);
98 RD_BOOL mcs_connect_start(char *server, char *username, char *domain, char *password,
99 			  RD_BOOL reconnect, uint32 * selected_protocol);
100 RD_BOOL mcs_connect_finalize(STREAM s);
101 void mcs_disconnect(void);
102 void mcs_reset_state(void);
103 /* orders.c */
104 void process_orders(STREAM s, uint16 num_orders);
105 void reset_order_state(void);
106 /* parallel.c */
107 int parallel_enum_devices(uint32 * id, char *optarg);
108 /* printer.c */
109 int printer_enum_devices(uint32 * id, char *optarg);
110 /* printercache.c */
111 int printercache_load_blob(char *printer_name, uint8 ** data);
112 void printercache_process(STREAM s);
113 /* pstcache.c */
114 void pstcache_touch_bitmap(uint8 cache_id, uint16 cache_idx, uint32 stamp);
115 RD_BOOL pstcache_load_bitmap(uint8 cache_id, uint16 cache_idx);
116 RD_BOOL pstcache_save_bitmap(uint8 cache_id, uint16 cache_idx, uint8 * key, uint8 width,
117 			     uint8 height, uint16 length, uint8 * data);
118 int pstcache_enumerate(uint8 id, HASH_KEY * keylist);
119 RD_BOOL pstcache_init(uint8 cache_id);
120 /* rdesktop.c */
121 int main(int argc, char *argv[]);
122 void generate_random(uint8 * random);
123 void *xmalloc(int size);
124 void exit_if_null(void *ptr);
125 char *xstrdup(const char *s);
126 void *xrealloc(void *oldmem, size_t size);
127 void xfree(void *mem);
128 void error(char *format, ...);
129 void warning(char *format, ...);
130 void unimpl(char *format, ...);
131 void hexdump(unsigned char *p, unsigned int len);
132 char *next_arg(char *src, char needle);
133 void toupper_str(char *p);
134 RD_BOOL str_startswith(const char *s, const char *prefix);
135 RD_BOOL str_handle_lines(const char *input, char **rest, str_handle_lines_t linehandler,
136 			 void *data);
137 RD_BOOL subprocess(char *const argv[], str_handle_lines_t linehandler, void *data);
138 char *l_to_a(long N, int base);
139 int load_licence(unsigned char **data);
140 void save_licence(unsigned char *data, int length);
141 void rd_create_ui(void);
142 RD_BOOL rd_pstcache_mkdir(void);
143 int rd_open_file(char *filename);
144 void rd_close_file(int fd);
145 int rd_read_file(int fd, void *ptr, int len);
146 int rd_write_file(int fd, void *ptr, int len);
147 int rd_lseek_file(int fd, int offset);
148 RD_BOOL rd_lock_file(int fd, int start, int len);
149 /* rdp5.c */
150 void rdp5_process(STREAM s);
151 /* rdp.c */
152 void rdp_out_unistr(STREAM s, char *string, int len);
153 void rdp_in_unistr(STREAM s, int in_len, char **string, uint32 * str_size);
154 void rdp_send_input(uint32 time, uint16 message_type, uint16 device_flags, uint16 param1,
155 		    uint16 param2);
156 void rdp_send_client_window_status(int status);
157 void process_colour_pointer_pdu(STREAM s);
158 void process_new_pointer_pdu(STREAM s);
159 void process_cached_pointer_pdu(STREAM s);
160 void process_system_pointer_pdu(STREAM s);
161 void process_bitmap_updates(STREAM s);
162 void process_palette(STREAM s);
163 void process_disconnect_pdu(STREAM s, uint32 * ext_disc_reason);
164 void rdp_main_loop(RD_BOOL * deactivated, uint32 * ext_disc_reason);
165 RD_BOOL rdp_loop(RD_BOOL * deactivated, uint32 * ext_disc_reason);
166 RD_BOOL rdp_connect(char *server, uint32 flags, char *domain, char *password, char *command,
167 		    char *directory, RD_BOOL reconnect);
168 void rdp_reset_state(void);
169 void rdp_disconnect(void);
170 /* rdpdr.c */
171 int get_device_index(RD_NTHANDLE handle);
172 void convert_to_unix_filename(char *filename);
173 void rdpdr_send_completion(uint32 device, uint32 id, uint32 status, uint32 result, uint8 * buffer,
174 			   uint32 length);
175 RD_BOOL rdpdr_init();
176 void rdpdr_add_fds(int *n, fd_set * rfds, fd_set * wfds, struct timeval *tv, RD_BOOL * timeout);
177 struct async_iorequest *rdpdr_remove_iorequest(struct async_iorequest *prev,
178 					       struct async_iorequest *iorq);
179 void rdpdr_check_fds(fd_set * rfds, fd_set * wfds, RD_BOOL timed_out);
180 RD_BOOL rdpdr_abort_io(uint32 fd, uint32 major, RD_NTSTATUS status);
181 /* rdpsnd.c */
182 void rdpsnd_record(const void *data, unsigned int size);
183 RD_BOOL rdpsnd_init(char *optarg);
184 void rdpsnd_show_help(void);
185 void rdpsnd_add_fds(int *n, fd_set * rfds, fd_set * wfds, struct timeval *tv);
186 void rdpsnd_check_fds(fd_set * rfds, fd_set * wfds);
187 struct audio_packet *rdpsnd_queue_current_packet(void);
188 RD_BOOL rdpsnd_queue_empty(void);
189 void rdpsnd_queue_next(unsigned long completed_in_us);
190 int rdpsnd_queue_next_tick(void);
191 void rdpsnd_reset_state(void);
192 /* secure.c */
193 void sec_hash_to_string(char *out, int out_size, uint8 * in, int in_size);
194 void sec_hash_sha1_16(uint8 * out, uint8 * in, uint8 * salt1);
195 void sec_hash_48(uint8 * out, uint8 * in, uint8 * salt1, uint8 * salt2, uint8 salt);
196 void sec_hash_16(uint8 * out, uint8 * in, uint8 * salt1, uint8 * salt2);
197 void buf_out_uint32(uint8 * buffer, uint32 value);
198 void sec_sign(uint8 * signature, int siglen, uint8 * session_key, int keylen, uint8 * data,
199 	      int datalen);
200 void sec_decrypt(uint8 * data, int length);
201 STREAM sec_init(uint32 flags, int maxlen);
202 void sec_send_to_channel(STREAM s, uint32 flags, uint16 channel);
203 void sec_send(STREAM s, uint32 flags);
204 void sec_process_mcs_data(STREAM s);
205 STREAM sec_recv(uint8 * rdpver);
206 RD_BOOL sec_connect(char *server, char *username, char *domain, char *password, RD_BOOL reconnect);
207 void sec_disconnect(void);
208 void sec_reset_state(void);
209 /* serial.c */
210 int serial_enum_devices(uint32 * id, char *optarg);
211 RD_BOOL serial_get_event(RD_NTHANDLE handle, uint32 * result);
212 RD_BOOL serial_get_timeout(RD_NTHANDLE handle, uint32 length, uint32 * timeout,
213 			   uint32 * itv_timeout);
214 /* tcp.c */
215 STREAM tcp_init(uint32 maxlen);
216 void tcp_send(STREAM s);
217 STREAM tcp_recv(STREAM s, uint32 length);
218 RD_BOOL tcp_connect(char *server);
219 void tcp_disconnect(void);
220 char *tcp_get_address(void);
221 RD_BOOL tcp_is_connected(void);
222 void tcp_reset_state(void);
223 RD_BOOL tcp_tls_connect(void);
224 RD_BOOL tcp_tls_get_server_pubkey(STREAM s);
225 void tcp_run_ui(RD_BOOL run);
226 
227 /* asn.c */
228 RD_BOOL ber_in_header(STREAM s, int *tagval, int *length);
229 void ber_out_header(STREAM s, int tagval, int length);
230 RD_BOOL ber_parse_header(STREAM s, int tagval, int *length);
231 void ber_out_integer(STREAM s, int value);
232 
233 /* xclip.c */
234 void ui_clip_format_announce(uint8 * data, uint32 length);
235 void ui_clip_handle_data(uint8 * data, uint32 length);
236 void ui_clip_request_failed(void);
237 void ui_clip_request_data(uint32 format);
238 void ui_clip_sync(void);
239 void ui_clip_set_mode(const char *optarg);
240 void xclip_init(void);
241 void xclip_deinit(void);
242 /* xkeymap.c */
243 RD_BOOL xkeymap_from_locale(const char *locale);
244 FILE *xkeymap_open(const char *filename);
245 void xkeymap_init(void);
246 RD_BOOL handle_special_keys(uint32 keysym, unsigned int state, uint32 ev_time, RD_BOOL pressed);
247 key_translation xkeymap_translate_key(uint32 keysym, unsigned int keycode, unsigned int state);
248 void xkeymap_send_keys(uint32 keysym, unsigned int keycode, unsigned int state, uint32 ev_time,
249 		       RD_BOOL pressed, uint8 nesting);
250 uint16 xkeymap_translate_button(unsigned int button);
251 char *get_ksname(uint32 keysym);
252 void save_remote_modifiers(uint8 scancode);
253 void restore_remote_modifiers(uint32 ev_time, uint8 scancode);
254 void ensure_remote_modifiers(uint32 ev_time, key_translation tr);
255 unsigned int read_keyboard_state(void);
256 uint16 ui_get_numlock_state(unsigned int state);
257 void reset_modifier_keys(void);
258 void rdp_send_scancode(uint32 time, uint16 flags, uint8 scancode);
259 /* xwin.c */
260 RD_BOOL get_key_state(unsigned int state, uint32 keysym);
261 RD_BOOL ui_init(void);
262 void ui_init_connection(void);
263 void ui_deinit(void);
264 RD_BOOL ui_create_window(void);
265 void ui_resize_window(void);
266 void ui_destroy_window(void);
267 RD_BOOL ui_have_window(void);
268 void xwin_toggle_fullscreen(void);
269 int ui_select(int rdp_socket);
270 void ui_move_pointer(int x, int y);
271 RD_HBITMAP ui_create_bitmap(int width, int height, uint8 * data);
272 void ui_paint_bitmap(int x, int y, int cx, int cy, int width, int height, uint8 * data);
273 void ui_destroy_bitmap(RD_HBITMAP bmp);
274 RD_HGLYPH ui_create_glyph(int width, int height, uint8 * data);
275 void ui_destroy_glyph(RD_HGLYPH glyph);
276 RD_HCURSOR ui_create_cursor(unsigned int x, unsigned int y, int width, int height, uint8 * andmask,
277 			    uint8 * xormask, int bpp);
278 void ui_set_cursor(RD_HCURSOR cursor);
279 void ui_destroy_cursor(RD_HCURSOR cursor);
280 void ui_set_null_cursor(void);
281 RD_HCOLOURMAP ui_create_colourmap(COLOURMAP * colours);
282 void ui_destroy_colourmap(RD_HCOLOURMAP map);
283 void ui_set_colourmap(RD_HCOLOURMAP map);
284 void ui_set_clip(int x, int y, int cx, int cy);
285 void ui_reset_clip(void);
286 void ui_bell(void);
287 void ui_destblt(uint8 opcode, int x, int y, int cx, int cy);
288 void ui_patblt(uint8 opcode, int x, int y, int cx, int cy, BRUSH * brush, int bgcolour,
289 	       int fgcolour);
290 void ui_screenblt(uint8 opcode, int x, int y, int cx, int cy, int srcx, int srcy);
291 void ui_memblt(uint8 opcode, int x, int y, int cx, int cy, RD_HBITMAP src, int srcx, int srcy);
292 void ui_triblt(uint8 opcode, int x, int y, int cx, int cy, RD_HBITMAP src, int srcx, int srcy,
293 	       BRUSH * brush, int bgcolour, int fgcolour);
294 void ui_line(uint8 opcode, int startx, int starty, int endx, int endy, PEN * pen);
295 void ui_rect(int x, int y, int cx, int cy, int colour);
296 void ui_polygon(uint8 opcode, uint8 fillmode, RD_POINT * point, int npoints, BRUSH * brush,
297 		int bgcolour, int fgcolour);
298 void ui_polyline(uint8 opcode, RD_POINT * points, int npoints, PEN * pen);
299 void ui_ellipse(uint8 opcode, uint8 fillmode, int x, int y, int cx, int cy, BRUSH * brush,
300 		int bgcolour, int fgcolour);
301 void ui_draw_glyph(int mixmode, int x, int y, int cx, int cy, RD_HGLYPH glyph, int srcx, int srcy,
302 		   int bgcolour, int fgcolour);
303 void ui_draw_text(uint8 font, uint8 flags, uint8 opcode, int mixmode, int x, int y, int clipx,
304 		  int clipy, int clipcx, int clipcy, int boxx, int boxy, int boxcx, int boxcy,
305 		  BRUSH * brush, int bgcolour, int fgcolour, uint8 * text, uint8 length);
306 void ui_desktop_save(uint32 offset, int x, int y, int cx, int cy);
307 void ui_desktop_restore(uint32 offset, int x, int y, int cx, int cy);
308 void ui_begin_update(void);
309 void ui_end_update(void);
310 void ui_seamless_begin(RD_BOOL hidden);
311 void ui_seamless_end();
312 void ui_seamless_hide_desktop(void);
313 void ui_seamless_unhide_desktop(void);
314 void ui_seamless_toggle(void);
315 void ui_seamless_create_window(unsigned long id, unsigned long group, unsigned long parent,
316 			       unsigned long flags);
317 void ui_seamless_destroy_window(unsigned long id, unsigned long flags);
318 void ui_seamless_destroy_group(unsigned long id, unsigned long flags);
319 void ui_seamless_seticon(unsigned long id, const char *format, int width, int height, int chunk,
320 			 const char *data, int chunk_len);
321 void ui_seamless_delicon(unsigned long id, const char *format, int width, int height);
322 void ui_seamless_move_window(unsigned long id, int x, int y, int width, int height,
323 			     unsigned long flags);
324 void ui_seamless_restack_window(unsigned long id, unsigned long behind, unsigned long flags);
325 void ui_seamless_settitle(unsigned long id, const char *title, unsigned long flags);
326 void ui_seamless_setstate(unsigned long id, unsigned int state, unsigned long flags);
327 void ui_seamless_syncbegin(unsigned long flags);
328 void ui_seamless_ack(unsigned int serial);
329 /* lspci.c */
330 RD_BOOL lspci_init(void);
331 /* seamless.c */
332 RD_BOOL seamless_init(void);
333 void seamless_reset_state(void);
334 unsigned int seamless_send_sync(void);
335 unsigned int seamless_send_state(unsigned long id, unsigned int state, unsigned long flags);
336 unsigned int seamless_send_position(unsigned long id, int x, int y, int width, int height,
337 				    unsigned long flags);
338 void seamless_select_timeout(struct timeval *tv);
339 unsigned int seamless_send_zchange(unsigned long id, unsigned long below, unsigned long flags);
340 unsigned int seamless_send_focus(unsigned long id, unsigned long flags);
341 unsigned int seamless_send_destroy(unsigned long id);
342 unsigned int seamless_send_spawn(char *cmd);
343 unsigned int seamless_send_persistent(RD_BOOL);
344 
345 /* scard.c */
346 void scard_lock(int lock);
347 void scard_unlock(int lock);
348 int scard_enum_devices(uint32 * id, char *optarg);
349 void scardSetInfo(uint32 epoch, uint32 device, uint32 id, uint32 bytes_out);
350 void scard_reset_state();
351 
352 /* *INDENT-OFF* */
353 #ifdef __cplusplus
354 }
355 #endif
356 /* *INDENT-ON* */
357 
358 #endif
359