2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Client/Server Runtime SubSystem
4 * FILE: include/reactos/subsys/win/conmsg.h
5 * PURPOSE: Public definitions for communication
6 * between Console API Clients and Servers
7 * PROGRAMMERS: Hermes Belusca-Maito (hermes.belusca@sfr.fr)
15 #define CONSRV_SERVERDLL_INDEX 2
16 #define CONSRV_FIRST_API_NUMBER 512
18 // Windows 2k3 tables, adapted from http://j00ru.vexillium.org/csrss_list/api_list.html#Windows_2k3
19 // plus a little bit of Windows 7. It is for testing purposes. After that I will add stubs.
20 // Some names are also deduced from the subsystems/win32/csrss/csrsrv/server.c ones.
21 typedef enum _CONSRV_API_NUMBER
23 ConsolepOpenConsole
= CONSRV_FIRST_API_NUMBER
,
24 ConsolepGetConsoleInput
,
25 ConsolepWriteConsoleInput
,
26 ConsolepReadConsoleOutput
,
27 ConsolepWriteConsoleOutput
,
28 ConsolepReadConsoleOutputString
,
29 // ConsolepWriteConsoleOutputString,
30 // ConsolepFillConsoleOutput,
32 // ConsolepGetNumberOfFonts,
33 ConsolepGetNumberOfInputEvents
,
34 ConsolepGetScreenBufferInfo
,
35 ConsolepGetCursorInfo
,
36 // ConsolepGetMouseInfo,
37 // ConsolepGetFontInfo,
38 // ConsolepGetFontSize,
39 // ConsolepGetCurrentFont,
41 ConsolepSetActiveScreenBuffer
,
42 ConsolepFlushInputBuffer
,
43 // ConsolepGetLargestWindowSize,
44 ConsolepSetScreenBufferSize
,
45 ConsolepSetCursorPosition
,
46 ConsolepSetCursorInfo
,
47 // ConsolepSetWindowInfo,
48 ConsolepScrollScreenBuffer
,
49 ConsolepSetTextAttribute
,
54 ConsolepDuplicateHandle
,
55 // ConsolepGetHandleInformation,
56 // ConsolepSetHandleInformation,
58 ConsolepVerifyIoHandle
,
63 ConsolepCreateScreenBuffer
,
64 // ConsolepInvalidateBitMapRect,
65 // ConsolepVDMOperation,
67 // ConsolepShowCursor,
68 // ConsolepMenuControl,
69 // ConsolepSetPalette,
70 // ConsolepSetDisplayMode,
71 // ConsolepRegisterVDM,
72 ConsolepGetHardwareState
,
73 ConsolepSetHardwareState
,
74 // ConsolepGetDisplayMode,
77 ConsolepGetAliasesLength
,
78 ConsolepGetAliasExesLength
,
81 ConsolepExpungeCommandHistory
,
82 ConsolepSetNumberOfCommands
,
83 ConsolepGetCommandHistoryLength
,
84 ConsolepGetCommandHistory
,
85 // ConsolepSetCommandHistoryMode,
88 // ConsolepSetKeyShortcuts,
89 // ConsolepSetMenuClose,
90 // ConsolepNotifyLastClose,
91 ConsolepGenerateCtrlEvent
,
92 // ConsolepGetKeyboardLayoutName,
93 ConsolepGetConsoleWindow
,
95 // ConsolepSetLocalEUDC,
96 // ConsolepSetCursorMode,
97 // ConsolepGetCursorMode,
98 // ConsolepRegisterOS2,
99 // ConsolepSetOS2OemFormat,
100 // ConsolepGetNlsMode,
101 // ConsolepSetNlsMode,
102 // ConsolepRegisterConsoleIME,
103 // ConsolepUnregisterConsoleIME,
104 // ConsolepGetLangId,
106 ConsolepGetSelectionInfo
,
107 ConsolepGetProcessList
,
112 } CONSRV_API_NUMBER
, *PCONSRV_API_NUMBER
;
115 #define CSR_API_MESSAGE_HEADER_SIZE(Type) (FIELD_OFFSET(CSR_API_MESSAGE, Data) + sizeof(Type))
116 #define CSRSS_MAX_WRITE_CONSOLE (LPC_MAX_DATA_LENGTH - CSR_API_MESSAGE_HEADER_SIZE(CSRSS_WRITE_CONSOLE))
117 #define CSRSS_MAX_WRITE_CONSOLE_OUTPUT_CHAR (LPC_MAX_DATA_LENGTH - CSR_API_MESSAGE_HEADER_SIZE(CSRSS_WRITE_CONSOLE_OUTPUT_CHAR))
118 #define CSRSS_MAX_WRITE_CONSOLE_OUTPUT_ATTRIB (LPC_MAX_DATA_LENGTH - CSR_API_MESSAGE_HEADER_SIZE(CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB))
119 #define CSRSS_MAX_READ_CONSOLE_OUTPUT_CHAR (LPC_MAX_DATA_LENGTH - CSR_API_MESSAGE_HEADER_SIZE(CSRSS_READ_CONSOLE_OUTPUT_CHAR))
120 #define CSRSS_MAX_READ_CONSOLE_OUTPUT_ATTRIB (LPC_MAX_DATA_LENGTH - CSR_API_MESSAGE_HEADER_SIZE(CSRSS_READ_CONSOLE_OUTPUT_ATTRIB))
122 #define CONSOLE_INPUT_MODE_VALID (0x0f)
123 #define CONSOLE_OUTPUT_MODE_VALID (0x03)
130 ULONG nProcessIdsTotal
;
131 } CSRSS_GET_PROCESS_LIST
, *PCSRSS_GET_PROCESS_LIST
;
135 HANDLE ConsoleHandle
;
137 ULONG NrCharactersToWrite
;
138 ULONG NrCharactersWritten
;
141 } CSRSS_WRITE_CONSOLE
, *PCSRSS_WRITE_CONSOLE
;
145 HANDLE ConsoleHandle
;
147 WORD NrCharactersToRead
;
148 WORD NrCharactersRead
;
154 UNICODE_STRING ExeName
;
155 DWORD CtrlWakeupMask
;
156 DWORD ControlKeyState
;
157 } CSRSS_READ_CONSOLE
, *PCSRSS_READ_CONSOLE
;
161 LPTHREAD_START_ROUTINE CtrlDispatcher
;
167 } CSRSS_ALLOC_CONSOLE
, *PCSRSS_ALLOC_CONSOLE
;
172 } CSRSS_FREE_CONSOLE
, *PCSRSS_FREE_CONSOLE
;
176 HANDLE ConsoleHandle
;
177 CONSOLE_SCREEN_BUFFER_INFO Info
;
178 } CSRSS_SCREEN_BUFFER_INFO
, *PCSRSS_SCREEN_BUFFER_INFO
;
182 HANDLE ConsoleHandle
;
184 } CSRSS_SET_CURSOR_POSITION
, *PCSRSS_SET_CURSOR_POSITION
;
188 HANDLE ConsoleHandle
;
197 ULONG NrCharactersWritten
;
198 } CSRSS_FILL_OUTPUT
, *PCSRSS_FILL_OUTPUT
;
202 HANDLE ConsoleHandle
;
206 } CSRSS_FILL_OUTPUT_ATTRIB
, *PCSRSS_FILL_OUTPUT_ATTRIB
;
210 HANDLE ConsoleHandle
;
215 ULONG NrCharactersWritten
;
217 } CSRSS_WRITE_CONSOLE_OUTPUT_CHAR
, *PCSRSS_WRITE_CONSOLE_OUTPUT_CHAR
;
221 HANDLE ConsoleHandle
;
226 } CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB
, *PCSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB
;
230 HANDLE ConsoleHandle
;
231 CONSOLE_CURSOR_INFO Info
;
232 } CSRSS_CURSOR_INFO
, *PCSRSS_CURSOR_INFO
;
236 HANDLE ConsoleHandle
;
238 } CSRSS_SET_ATTRIB
, *PCSRSS_SET_ATTRIB
;
242 HANDLE ConsoleHandle
;
244 } CSRSS_CONSOLE_MODE
, *PCSRSS_CONSOLE_MODE
;
251 HANDLE OutputHandle
; /* handle to newly created screen buffer */
252 } CSRSS_CREATE_SCREEN_BUFFER
, *PCSRSS_CREATE_SCREEN_BUFFER
;
256 HANDLE OutputHandle
; /* handle to screen buffer to switch to */
257 } CSRSS_SET_SCREEN_BUFFER
, *PCSRSS_SET_SCREEN_BUFFER
;
263 } CSRSS_CONSOLE_TITLE
, *PCSRSS_CONSOLE_TITLE
;
267 HANDLE ConsoleHandle
;
271 SMALL_RECT WriteRegion
;
273 } CSRSS_WRITE_CONSOLE_OUTPUT
, *PCSRSS_WRITE_CONSOLE_OUTPUT
;
278 } CSRSS_FLUSH_INPUT_BUFFER
, *PCSRSS_FLUSH_INPUT_BUFFER
;
282 HANDLE ConsoleHandle
;
284 SMALL_RECT ScrollRectangle
;
285 BOOL UseClipRectangle
;
286 SMALL_RECT ClipRectangle
;
287 COORD DestinationOrigin
;
289 } CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
, *PCSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
;
293 * An attribute or a character are instances of the same entity, namely
294 * a "code" (what would be called an (ANSI) escape sequence). Therefore
295 * encode them inside the same structure.
297 typedef enum _CODE_TYPE
301 CODE_ATTRIBUTE
= 0x03
306 HANDLE ConsoleHandle
;
309 DWORD NumCodesToRead
;
321 } pCode
; // Either a pointer to a character or to an attribute.
322 } CSRSS_READ_CONSOLE_OUTPUT_CODE
, *PCSRSS_READ_CONSOLE_OUTPUT_CODE
;
327 HANDLE ConsoleHandle
;
329 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
332 INPUT_RECORD
* InputRecord
;
336 // INPUT_RECORD Input;
339 } CSRSS_GET_CONSOLE_INPUT
, *PCSRSS_GET_CONSOLE_INPUT
;
343 HANDLE ConsoleHandle
;
347 SMALL_RECT ReadRegion
;
349 } CSRSS_READ_CONSOLE_OUTPUT
, *PCSRSS_READ_CONSOLE_OUTPUT
;
353 HANDLE ConsoleHandle
;
356 INPUT_RECORD
* InputRecord
;
357 } CSRSS_WRITE_CONSOLE_INPUT
, *PCSRSS_WRITE_CONSOLE_INPUT
;
362 } CSRSS_CLOSE_HANDLE
, *PCSRSS_CLOSE_HANDLE
;
367 } CSRSS_VERIFY_HANDLE
, *PCSRSS_VERIFY_HANDLE
;
375 } CSRSS_DUPLICATE_HANDLE
, *PCSRSS_DUPLICATE_HANDLE
;
380 typedef enum _HANDLE_TYPE
389 HANDLE_TYPE HandleType
;
393 } CSRSS_OPEN_CONSOLE
, *PCSRSS_OPEN_CONSOLE
;
397 HANDLE InputWaitHandle
;
398 } CSRSS_GET_INPUT_WAIT_HANDLE
, *PCSRSS_GET_INPUT_WAIT_HANDLE
;
402 * Console hardware states.
404 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
405 #define CONSOLE_HARDWARE_STATE_DIRECT 1
409 HANDLE ConsoleHandle
;
411 } CSRSS_CONSOLE_HW_STATE
, *PCSRSS_CONSOLE_HW_STATE
;
416 } CSRSS_GET_CONSOLE_WINDOW
, *PCSRSS_GET_CONSOLE_WINDOW
;
421 } CSRSS_SET_CONSOLE_ICON
, *PCSRSS_SET_CONSOLE_ICON
;
434 ULONG TargetLength
; // Also used for storing the number of bytes written.
439 } CSRSS_CONSOLE_ALIAS
, *PCSRSS_CONSOLE_ALIAS
;
444 DWORD AliasesBufferLength
;
446 LPWSTR AliasesBuffer
;
447 } CSRSS_GET_ALL_CONSOLE_ALIASES
, *PCSRSS_GET_ALL_CONSOLE_ALIASES
;
454 } CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
, *PCSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
;
460 } CSRSS_GET_CONSOLE_ALIASES_EXES
, *PCSRSS_GET_CONSOLE_ALIASES_EXES
;
465 } CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
, *PCSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
;
474 UNICODE_STRING ExeName
;
477 } CSRSS_GET_COMMAND_HISTORY
, *PCSRSS_GET_COMMAND_HISTORY
;
481 UNICODE_STRING ExeName
;
483 } CSRSS_GET_COMMAND_HISTORY_LENGTH
, *PCSRSS_GET_COMMAND_HISTORY_LENGTH
;
487 UNICODE_STRING ExeName
;
488 } CSRSS_EXPUNGE_COMMAND_HISTORY
, *PCSRSS_EXPUNGE_COMMAND_HISTORY
;
492 UNICODE_STRING ExeName
;
494 } CSRSS_SET_HISTORY_NUMBER_COMMANDS
, *PCSRSS_SET_HISTORY_NUMBER_COMMANDS
;
498 UINT HistoryBufferSize
;
499 UINT NumberOfHistoryBuffers
;
501 } CSRSS_HISTORY_INFO
, *PCSRSS_HISTORY_INFO
;
516 } CSRSS_GENERATE_CTRL_EVENT
, *PCSRSS_GENERATE_CTRL_EVENT
;
520 HANDLE ConsoleHandle
;
521 DWORD NumInputEvents
;
522 } CSRSS_GET_NUM_INPUT_EVENTS
, *PCSRSS_GET_NUM_INPUT_EVENTS
;
528 } CSRSS_SET_SCREEN_BUFFER_SIZE
, *PCSRSS_SET_SCREEN_BUFFER_SIZE
;
532 CONSOLE_SELECTION_INFO Info
;
533 } CSRSS_GET_CONSOLE_SELECTION_INFO
, *PCSRSS_GET_CONSOLE_SELECTION_INFO
;
537 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
539 } CSRSS_CONSOLE_CP
, *PCSRSS_CONSOLE_CP
;
541 typedef struct _CONSOLE_API_MESSAGE
545 PCSR_CAPTURE_BUFFER CsrCaptureData
;
546 CSR_API_NUMBER ApiNumber
;
547 ULONG Status
; // ReturnValue; // NTSTATUS Status
551 CSRSS_ALLOC_CONSOLE AllocConsoleRequest
;
552 CSRSS_FREE_CONSOLE FreeConsoleRequest
;
555 CSRSS_OPEN_CONSOLE OpenConsoleRequest
;
556 CSRSS_CLOSE_HANDLE CloseHandleRequest
;
557 CSRSS_VERIFY_HANDLE VerifyHandleRequest
;
558 CSRSS_DUPLICATE_HANDLE DuplicateHandleRequest
;
559 CSRSS_GET_INPUT_WAIT_HANDLE GetConsoleInputWaitHandle
;
562 CSRSS_CURSOR_INFO CursorInfoRequest
;
563 CSRSS_SET_CURSOR_POSITION SetCursorPositionRequest
;
566 CSRSS_CREATE_SCREEN_BUFFER CreateScreenBufferRequest
;
567 CSRSS_SET_SCREEN_BUFFER SetScreenBufferRequest
;
568 CSRSS_SCREEN_BUFFER_INFO ScreenBufferInfoRequest
;
569 CSRSS_SET_SCREEN_BUFFER_SIZE SetScreenBufferSize
;
570 CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER ScrollConsoleScreenBufferRequest
;
572 CSRSS_GET_CONSOLE_SELECTION_INFO GetConsoleSelectionInfo
;
573 CSRSS_FLUSH_INPUT_BUFFER FlushInputBufferRequest
;
576 CSRSS_CONSOLE_MODE ConsoleModeRequest
;
577 CSRSS_CONSOLE_HW_STATE ConsoleHardwareStateRequest
;
580 CSRSS_CONSOLE_TITLE TitleRequest
;
581 CSRSS_GET_CONSOLE_WINDOW GetConsoleWindowRequest
;
582 CSRSS_SET_CONSOLE_ICON SetConsoleIconRequest
;
585 CSRSS_READ_CONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
586 CSRSS_GET_CONSOLE_INPUT GetConsoleInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
587 CSRSS_READ_CONSOLE_OUTPUT ReadConsoleOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
588 CSRSS_READ_CONSOLE_OUTPUT_CODE ReadConsoleOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
591 CSRSS_WRITE_CONSOLE WriteConsoleRequest
;
592 CSRSS_WRITE_CONSOLE_INPUT WriteConsoleInputRequest
;
593 CSRSS_WRITE_CONSOLE_OUTPUT WriteConsoleOutputRequest
;
594 CSRSS_WRITE_CONSOLE_OUTPUT_CHAR WriteConsoleOutputCharRequest
;
595 CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB WriteConsoleOutputAttribRequest
;
597 CSRSS_FILL_OUTPUT FillOutputRequest
;
598 CSRSS_FILL_OUTPUT_ATTRIB FillOutputAttribRequest
;
599 CSRSS_SET_ATTRIB SetAttribRequest
;
602 CSRSS_CONSOLE_ALIAS ConsoleAlias
;
603 CSRSS_GET_ALL_CONSOLE_ALIASES GetAllConsoleAliases
;
604 CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH GetAllConsoleAliasesLength
;
605 CSRSS_GET_CONSOLE_ALIASES_EXES GetConsoleAliasesExes
;
606 CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH GetConsoleAliasesExesLength
;
609 CSRSS_GET_COMMAND_HISTORY GetCommandHistory
;
610 CSRSS_GET_COMMAND_HISTORY_LENGTH GetCommandHistoryLength
;
611 CSRSS_EXPUNGE_COMMAND_HISTORY ExpungeCommandHistory
;
612 CSRSS_SET_HISTORY_NUMBER_COMMANDS SetHistoryNumberCommands
;
613 CSRSS_HISTORY_INFO HistoryInfoRequest
;
615 CSRSS_GENERATE_CTRL_EVENT GenerateCtrlEvent
;
616 CSRSS_GET_NUM_INPUT_EVENTS GetNumInputEventsRequest
;
618 /* Input and Output Code Pages */
619 CSRSS_CONSOLE_CP ConsoleCPRequest
;
621 CSRSS_GET_PROCESS_LIST GetProcessListRequest
;
623 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;