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
;
193 ULONG NrCharactersWritten
;
195 } CSRSS_WRITE_CONSOLE_OUTPUT_CHAR
, *PCSRSS_WRITE_CONSOLE_OUTPUT_CHAR
;
199 HANDLE ConsoleHandle
;
204 } CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB
, *PCSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB
;
208 HANDLE ConsoleHandle
;
209 CONSOLE_CURSOR_INFO Info
;
210 } CSRSS_CURSOR_INFO
, *PCSRSS_CURSOR_INFO
;
214 HANDLE ConsoleHandle
;
216 } CSRSS_SET_ATTRIB
, *PCSRSS_SET_ATTRIB
;
220 HANDLE ConsoleHandle
;
222 } CSRSS_CONSOLE_MODE
, *PCSRSS_CONSOLE_MODE
;
229 HANDLE OutputHandle
; /* handle to newly created screen buffer */
230 } CSRSS_CREATE_SCREEN_BUFFER
, *PCSRSS_CREATE_SCREEN_BUFFER
;
234 HANDLE OutputHandle
; /* handle to screen buffer to switch to */
235 } CSRSS_SET_SCREEN_BUFFER
, *PCSRSS_SET_SCREEN_BUFFER
;
241 } CSRSS_CONSOLE_TITLE
, *PCSRSS_CONSOLE_TITLE
;
245 HANDLE ConsoleHandle
;
249 SMALL_RECT WriteRegion
;
251 } CSRSS_WRITE_CONSOLE_OUTPUT
, *PCSRSS_WRITE_CONSOLE_OUTPUT
;
256 } CSRSS_FLUSH_INPUT_BUFFER
, *PCSRSS_FLUSH_INPUT_BUFFER
;
260 HANDLE ConsoleHandle
;
262 SMALL_RECT ScrollRectangle
;
263 BOOL UseClipRectangle
;
264 SMALL_RECT ClipRectangle
;
265 COORD DestinationOrigin
;
267 } CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
, *PCSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
;
271 * An attribute or a character are instances of the same entity, namely
272 * a "code" (what would be called an (ANSI) escape sequence). Therefore
273 * encode them inside the same structure.
275 typedef enum _CODE_TYPE
279 CODE_ATTRIBUTE
= 0x03
284 HANDLE ConsoleHandle
;
286 DWORD NumCodesToRead
;
299 } pCode
; // Either a pointer to a character or to an attribute.
300 } CSRSS_READ_CONSOLE_OUTPUT_CODE
, *PCSRSS_READ_CONSOLE_OUTPUT_CODE
;
304 HANDLE ConsoleHandle
;
312 } Code
; // Either a character or an attribute.
317 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
318 } CSRSS_FILL_OUTPUT
, *PCSRSS_FILL_OUTPUT
;
322 HANDLE ConsoleHandle
;
324 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
327 INPUT_RECORD
* InputRecord
;
331 // INPUT_RECORD Input;
334 } CSRSS_GET_CONSOLE_INPUT
, *PCSRSS_GET_CONSOLE_INPUT
;
338 HANDLE ConsoleHandle
;
342 SMALL_RECT ReadRegion
;
344 } CSRSS_READ_CONSOLE_OUTPUT
, *PCSRSS_READ_CONSOLE_OUTPUT
;
348 HANDLE ConsoleHandle
;
351 INPUT_RECORD
* InputRecord
;
352 } CSRSS_WRITE_CONSOLE_INPUT
, *PCSRSS_WRITE_CONSOLE_INPUT
;
357 } CSRSS_CLOSE_HANDLE
, *PCSRSS_CLOSE_HANDLE
;
362 } CSRSS_VERIFY_HANDLE
, *PCSRSS_VERIFY_HANDLE
;
370 } CSRSS_DUPLICATE_HANDLE
, *PCSRSS_DUPLICATE_HANDLE
;
375 typedef enum _HANDLE_TYPE
384 HANDLE_TYPE HandleType
;
388 } CSRSS_OPEN_CONSOLE
, *PCSRSS_OPEN_CONSOLE
;
392 HANDLE InputWaitHandle
;
393 } CSRSS_GET_INPUT_WAIT_HANDLE
, *PCSRSS_GET_INPUT_WAIT_HANDLE
;
397 * Console hardware states.
399 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
400 #define CONSOLE_HARDWARE_STATE_DIRECT 1
404 HANDLE ConsoleHandle
;
406 } CSRSS_CONSOLE_HW_STATE
, *PCSRSS_CONSOLE_HW_STATE
;
411 } CSRSS_GET_CONSOLE_WINDOW
, *PCSRSS_GET_CONSOLE_WINDOW
;
416 } CSRSS_SET_CONSOLE_ICON
, *PCSRSS_SET_CONSOLE_ICON
;
429 ULONG TargetLength
; // Also used for storing the number of bytes written.
434 } CSRSS_CONSOLE_ALIAS
, *PCSRSS_CONSOLE_ALIAS
;
439 DWORD AliasesBufferLength
;
441 LPWSTR AliasesBuffer
;
442 } CSRSS_GET_ALL_CONSOLE_ALIASES
, *PCSRSS_GET_ALL_CONSOLE_ALIASES
;
449 } CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
, *PCSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
;
455 } CSRSS_GET_CONSOLE_ALIASES_EXES
, *PCSRSS_GET_CONSOLE_ALIASES_EXES
;
460 } CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
, *PCSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
;
469 UNICODE_STRING ExeName
;
472 } CSRSS_GET_COMMAND_HISTORY
, *PCSRSS_GET_COMMAND_HISTORY
;
476 UNICODE_STRING ExeName
;
478 } CSRSS_GET_COMMAND_HISTORY_LENGTH
, *PCSRSS_GET_COMMAND_HISTORY_LENGTH
;
482 UNICODE_STRING ExeName
;
483 } CSRSS_EXPUNGE_COMMAND_HISTORY
, *PCSRSS_EXPUNGE_COMMAND_HISTORY
;
487 UNICODE_STRING ExeName
;
489 } CSRSS_SET_HISTORY_NUMBER_COMMANDS
, *PCSRSS_SET_HISTORY_NUMBER_COMMANDS
;
493 UINT HistoryBufferSize
;
494 UINT NumberOfHistoryBuffers
;
496 } CSRSS_HISTORY_INFO
, *PCSRSS_HISTORY_INFO
;
511 } CSRSS_GENERATE_CTRL_EVENT
, *PCSRSS_GENERATE_CTRL_EVENT
;
515 HANDLE ConsoleHandle
;
516 DWORD NumInputEvents
;
517 } CSRSS_GET_NUM_INPUT_EVENTS
, *PCSRSS_GET_NUM_INPUT_EVENTS
;
523 } CSRSS_SET_SCREEN_BUFFER_SIZE
, *PCSRSS_SET_SCREEN_BUFFER_SIZE
;
527 CONSOLE_SELECTION_INFO Info
;
528 } CSRSS_GET_CONSOLE_SELECTION_INFO
, *PCSRSS_GET_CONSOLE_SELECTION_INFO
;
532 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
534 } CSRSS_CONSOLE_CP
, *PCSRSS_CONSOLE_CP
;
536 typedef struct _CONSOLE_API_MESSAGE
540 PCSR_CAPTURE_BUFFER CsrCaptureData
;
541 CSR_API_NUMBER ApiNumber
;
542 ULONG Status
; // ReturnValue; // NTSTATUS Status
546 CSRSS_ALLOC_CONSOLE AllocConsoleRequest
;
547 CSRSS_FREE_CONSOLE FreeConsoleRequest
;
550 CSRSS_OPEN_CONSOLE OpenConsoleRequest
;
551 CSRSS_CLOSE_HANDLE CloseHandleRequest
;
552 CSRSS_VERIFY_HANDLE VerifyHandleRequest
;
553 CSRSS_DUPLICATE_HANDLE DuplicateHandleRequest
;
554 CSRSS_GET_INPUT_WAIT_HANDLE GetConsoleInputWaitHandle
;
557 CSRSS_CURSOR_INFO CursorInfoRequest
;
558 CSRSS_SET_CURSOR_POSITION SetCursorPositionRequest
;
561 CSRSS_CREATE_SCREEN_BUFFER CreateScreenBufferRequest
;
562 CSRSS_SET_SCREEN_BUFFER SetScreenBufferRequest
;
563 CSRSS_SCREEN_BUFFER_INFO ScreenBufferInfoRequest
;
564 CSRSS_SET_SCREEN_BUFFER_SIZE SetScreenBufferSize
;
565 CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER ScrollConsoleScreenBufferRequest
;
567 CSRSS_GET_CONSOLE_SELECTION_INFO GetConsoleSelectionInfo
;
568 CSRSS_FLUSH_INPUT_BUFFER FlushInputBufferRequest
;
571 CSRSS_CONSOLE_MODE ConsoleModeRequest
;
572 CSRSS_CONSOLE_HW_STATE ConsoleHardwareStateRequest
;
575 CSRSS_CONSOLE_TITLE TitleRequest
;
576 CSRSS_GET_CONSOLE_WINDOW GetConsoleWindowRequest
;
577 CSRSS_SET_CONSOLE_ICON SetConsoleIconRequest
;
580 CSRSS_READ_CONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
581 CSRSS_GET_CONSOLE_INPUT GetConsoleInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
582 CSRSS_READ_CONSOLE_OUTPUT ReadConsoleOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
583 CSRSS_READ_CONSOLE_OUTPUT_CODE ReadConsoleOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
586 CSRSS_WRITE_CONSOLE WriteConsoleRequest
;
587 CSRSS_WRITE_CONSOLE_INPUT WriteConsoleInputRequest
;
588 CSRSS_WRITE_CONSOLE_OUTPUT WriteConsoleOutputRequest
;
589 CSRSS_WRITE_CONSOLE_OUTPUT_CHAR WriteConsoleOutputCharRequest
;
590 CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB WriteConsoleOutputAttribRequest
;
592 CSRSS_FILL_OUTPUT FillOutputRequest
;
593 CSRSS_SET_ATTRIB SetAttribRequest
;
596 CSRSS_CONSOLE_ALIAS ConsoleAlias
;
597 CSRSS_GET_ALL_CONSOLE_ALIASES GetAllConsoleAliases
;
598 CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH GetAllConsoleAliasesLength
;
599 CSRSS_GET_CONSOLE_ALIASES_EXES GetConsoleAliasesExes
;
600 CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH GetConsoleAliasesExesLength
;
603 CSRSS_GET_COMMAND_HISTORY GetCommandHistory
;
604 CSRSS_GET_COMMAND_HISTORY_LENGTH GetCommandHistoryLength
;
605 CSRSS_EXPUNGE_COMMAND_HISTORY ExpungeCommandHistory
;
606 CSRSS_SET_HISTORY_NUMBER_COMMANDS SetHistoryNumberCommands
;
607 CSRSS_HISTORY_INFO HistoryInfoRequest
;
609 CSRSS_GENERATE_CTRL_EVENT GenerateCtrlEvent
;
610 CSRSS_GET_NUM_INPUT_EVENTS GetNumInputEventsRequest
;
612 /* Input and Output Code Pages */
613 CSRSS_CONSOLE_CP ConsoleCPRequest
;
615 CSRSS_GET_PROCESS_LIST GetProcessListRequest
;
617 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;