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
= CONSRV_FIRST_API_NUMBER
,
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
, *PCSRSS_SET_CURSOR
;
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_GET_CURSOR_INFO
, *PCSRSS_GET_CURSOR_INFO
;
236 HANDLE ConsoleHandle
;
237 CONSOLE_CURSOR_INFO Info
;
238 } CSRSS_SET_CURSOR_INFO
, *PCSRSS_SET_CURSOR_INFO
;
242 HANDLE ConsoleHandle
;
244 } CSRSS_SET_ATTRIB
, *PCSRSS_SET_ATTRIB
;
248 HANDLE ConsoleHandle
;
250 } CSRSS_SET_CONSOLE_MODE
, *PCSRSS_SET_CONSOLE_MODE
;
254 HANDLE ConsoleHandle
;
256 } CSRSS_GET_CONSOLE_MODE
, *PCSRSS_GET_CONSOLE_MODE
;
263 HANDLE OutputHandle
; /* handle to newly created screen buffer */
264 } CSRSS_CREATE_SCREEN_BUFFER
, *PCSRSS_CREATE_SCREEN_BUFFER
;
268 HANDLE OutputHandle
; /* handle to screen buffer to switch to */
269 } CSRSS_SET_SCREEN_BUFFER
, *PCSRSS_SET_SCREEN_BUFFER
;
275 } CSRSS_SET_TITLE
, *PCSRSS_SET_TITLE
;
281 } CSRSS_GET_TITLE
, *PCSRSS_GET_TITLE
;
285 HANDLE ConsoleHandle
;
289 SMALL_RECT WriteRegion
;
291 } CSRSS_WRITE_CONSOLE_OUTPUT
, *PCSRSS_WRITE_CONSOLE_OUTPUT
;
296 } CSRSS_FLUSH_INPUT_BUFFER
, *PCSRSS_FLUSH_INPUT_BUFFER
;
300 HANDLE ConsoleHandle
;
302 SMALL_RECT ScrollRectangle
;
303 BOOL UseClipRectangle
;
304 SMALL_RECT ClipRectangle
;
305 COORD DestinationOrigin
;
307 } CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
, *PCSRSS_SCROLL_CONSOLE_SCREEN_BUFFER
;
311 * An attribute or a character are instances of the same entity, namely
312 * a "code" (what would be called an (ANSI) escape sequence). Therefore
313 * encode them inside the same structure.
315 typedef enum _CODE_TYPE
319 CODE_ATTRIBUTE
= 0x03
324 HANDLE ConsoleHandle
;
327 DWORD NumCodesToRead
;
339 } pCode
; // Either a pointer to a character or to an attribute.
340 } CSRSS_READ_CONSOLE_OUTPUT_CODE
, *PCSRSS_READ_CONSOLE_OUTPUT_CODE
;
345 HANDLE ConsoleHandle
;
347 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
350 INPUT_RECORD
* InputRecord
;
354 // INPUT_RECORD Input;
357 } CSRSS_GET_CONSOLE_INPUT
, *PCSRSS_GET_CONSOLE_INPUT
;
361 HANDLE ConsoleHandle
;
365 SMALL_RECT ReadRegion
;
367 } CSRSS_READ_CONSOLE_OUTPUT
, *PCSRSS_READ_CONSOLE_OUTPUT
;
371 HANDLE ConsoleHandle
;
374 INPUT_RECORD
* InputRecord
;
375 } CSRSS_WRITE_CONSOLE_INPUT
, *PCSRSS_WRITE_CONSOLE_INPUT
;
380 } CSRSS_CLOSE_HANDLE
, *PCSRSS_CLOSE_HANDLE
;
385 } CSRSS_VERIFY_HANDLE
, *PCSRSS_VERIFY_HANDLE
;
393 } CSRSS_DUPLICATE_HANDLE
, *PCSRSS_DUPLICATE_HANDLE
;
401 } CSRSS_GET_INPUT_HANDLE
, *PCSRSS_GET_INPUT_HANDLE
,
402 CSRSS_GET_OUTPUT_HANDLE
, *PCSRSS_GET_OUTPUT_HANDLE
;
406 HANDLE InputWaitHandle
;
407 } CSRSS_GET_INPUT_WAIT_HANDLE
, *PCSRSS_GET_INPUT_WAIT_HANDLE
;
409 #define CONSOLE_HARDWARE_STATE_GET 0
410 #define CONSOLE_HARDWARE_STATE_SET 1
412 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
413 #define CONSOLE_HARDWARE_STATE_DIRECT 1
417 HANDLE ConsoleHandle
;
418 DWORD SetGet
; /* 0=get; 1=set */
420 } CSRSS_SETGET_CONSOLE_HW_STATE
, *PCSRSS_SETGET_CONSOLE_HW_STATE
;
425 } CSRSS_GET_CONSOLE_WINDOW
, *PCSRSS_GET_CONSOLE_WINDOW
;
430 } CSRSS_SET_CONSOLE_ICON
, *PCSRSS_SET_CONSOLE_ICON
;
443 ULONG TargetLength
; // Also used for storing the number of bytes written.
448 } CSRSS_CONSOLE_ALIAS
, *PCSRSS_CONSOLE_ALIAS
;
453 DWORD AliasesBufferLength
;
455 LPWSTR AliasesBuffer
;
456 } CSRSS_GET_ALL_CONSOLE_ALIASES
, *PCSRSS_GET_ALL_CONSOLE_ALIASES
;
463 } CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
, *PCSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH
;
469 } CSRSS_GET_CONSOLE_ALIASES_EXES
, *PCSRSS_GET_CONSOLE_ALIASES_EXES
;
474 } CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
, *PCSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH
;
483 UNICODE_STRING ExeName
;
486 } CSRSS_GET_COMMAND_HISTORY
, *PCSRSS_GET_COMMAND_HISTORY
;
490 UNICODE_STRING ExeName
;
492 } CSRSS_GET_COMMAND_HISTORY_LENGTH
, *PCSRSS_GET_COMMAND_HISTORY_LENGTH
;
496 UNICODE_STRING ExeName
;
497 } CSRSS_EXPUNGE_COMMAND_HISTORY
, *PCSRSS_EXPUNGE_COMMAND_HISTORY
;
501 UNICODE_STRING ExeName
;
503 } CSRSS_SET_HISTORY_NUMBER_COMMANDS
, *PCSRSS_SET_HISTORY_NUMBER_COMMANDS
;
507 UINT HistoryBufferSize
;
508 UINT NumberOfHistoryBuffers
;
510 } CSRSS_HISTORY_INFO
, *PCSRSS_HISTORY_INFO
;
525 } CSRSS_GENERATE_CTRL_EVENT
, *PCSRSS_GENERATE_CTRL_EVENT
;
529 HANDLE ConsoleHandle
;
530 DWORD NumInputEvents
;
531 } CSRSS_GET_NUM_INPUT_EVENTS
, *PCSRSS_GET_NUM_INPUT_EVENTS
;
537 } CSRSS_SET_SCREEN_BUFFER_SIZE
, *PCSRSS_SET_SCREEN_BUFFER_SIZE
;
541 CONSOLE_SELECTION_INFO Info
;
542 } CSRSS_GET_CONSOLE_SELECTION_INFO
, *PCSRSS_GET_CONSOLE_SELECTION_INFO
;
547 } CSRSS_GET_CONSOLE_CP
, *PCSRSS_GET_CONSOLE_CP
;
552 } CSRSS_SET_CONSOLE_CP
, *PCSRSS_SET_CONSOLE_CP
;
557 } CSRSS_GET_CONSOLE_OUTPUT_CP
, *PCSRSS_GET_CONSOLE_OUTPUT_CP
;
562 } CSRSS_SET_CONSOLE_OUTPUT_CP
, *PCSRSS_SET_CONSOLE_OUTPUT_CP
;
564 typedef struct _CONSOLE_API_MESSAGE
568 PCSR_CAPTURE_BUFFER CsrCaptureData
;
569 CSR_API_NUMBER ApiNumber
;
570 ULONG Status
; // ReturnValue; // NTSTATUS Status
574 CSRSS_ALLOC_CONSOLE AllocConsoleRequest
;
575 CSRSS_FREE_CONSOLE FreeConsoleRequest
;
578 CSRSS_GET_INPUT_HANDLE GetInputHandleRequest
;
579 CSRSS_GET_OUTPUT_HANDLE GetOutputHandleRequest
;
580 CSRSS_CLOSE_HANDLE CloseHandleRequest
;
581 CSRSS_VERIFY_HANDLE VerifyHandleRequest
;
582 CSRSS_DUPLICATE_HANDLE DuplicateHandleRequest
;
583 CSRSS_GET_INPUT_WAIT_HANDLE GetConsoleInputWaitHandle
;
586 CSRSS_SET_CURSOR SetCursorRequest
;
587 CSRSS_GET_CURSOR_INFO GetCursorInfoRequest
;
588 CSRSS_SET_CURSOR_INFO SetCursorInfoRequest
;
590 CSRSS_FLUSH_INPUT_BUFFER FlushInputBufferRequest
;
593 CSRSS_CREATE_SCREEN_BUFFER CreateScreenBufferRequest
;
594 CSRSS_SET_SCREEN_BUFFER SetScreenBufferRequest
;
595 CSRSS_SCREEN_BUFFER_INFO ScreenBufferInfoRequest
;
596 CSRSS_SET_SCREEN_BUFFER_SIZE SetScreenBufferSize
;
597 CSRSS_SCROLL_CONSOLE_SCREEN_BUFFER ScrollConsoleScreenBufferRequest
;
599 CSRSS_GET_CONSOLE_SELECTION_INFO GetConsoleSelectionInfo
;
602 CSRSS_SET_CONSOLE_MODE SetConsoleModeRequest
;
603 CSRSS_GET_CONSOLE_MODE GetConsoleModeRequest
;
604 CSRSS_SETGET_CONSOLE_HW_STATE ConsoleHardwareStateRequest
;
607 CSRSS_SET_TITLE SetTitleRequest
;
608 CSRSS_GET_TITLE GetTitleRequest
;
609 CSRSS_GET_CONSOLE_WINDOW GetConsoleWindowRequest
;
610 CSRSS_SET_CONSOLE_ICON SetConsoleIconRequest
;
613 CSRSS_READ_CONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
614 CSRSS_GET_CONSOLE_INPUT GetConsoleInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
615 CSRSS_READ_CONSOLE_OUTPUT ReadConsoleOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
616 CSRSS_READ_CONSOLE_OUTPUT_CODE ReadConsoleOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
619 CSRSS_WRITE_CONSOLE WriteConsoleRequest
;
620 CSRSS_WRITE_CONSOLE_INPUT WriteConsoleInputRequest
;
621 CSRSS_WRITE_CONSOLE_OUTPUT WriteConsoleOutputRequest
;
622 CSRSS_WRITE_CONSOLE_OUTPUT_CHAR WriteConsoleOutputCharRequest
;
623 CSRSS_WRITE_CONSOLE_OUTPUT_ATTRIB WriteConsoleOutputAttribRequest
;
625 CSRSS_FILL_OUTPUT FillOutputRequest
;
626 CSRSS_FILL_OUTPUT_ATTRIB FillOutputAttribRequest
;
627 CSRSS_SET_ATTRIB SetAttribRequest
;
630 CSRSS_CONSOLE_ALIAS ConsoleAlias
;
631 CSRSS_GET_ALL_CONSOLE_ALIASES GetAllConsoleAliases
;
632 CSRSS_GET_ALL_CONSOLE_ALIASES_LENGTH GetAllConsoleAliasesLength
;
633 CSRSS_GET_CONSOLE_ALIASES_EXES GetConsoleAliasesExes
;
634 CSRSS_GET_CONSOLE_ALIASES_EXES_LENGTH GetConsoleAliasesExesLength
;
637 CSRSS_GET_COMMAND_HISTORY GetCommandHistory
;
638 CSRSS_GET_COMMAND_HISTORY_LENGTH GetCommandHistoryLength
;
639 CSRSS_EXPUNGE_COMMAND_HISTORY ExpungeCommandHistory
;
640 CSRSS_SET_HISTORY_NUMBER_COMMANDS SetHistoryNumberCommands
;
641 CSRSS_HISTORY_INFO HistoryInfoRequest
;
643 CSRSS_GENERATE_CTRL_EVENT GenerateCtrlEvent
;
644 CSRSS_GET_NUM_INPUT_EVENTS GetNumInputEventsRequest
;
647 CSRSS_GET_CONSOLE_CP GetConsoleCodePage
;
648 CSRSS_SET_CONSOLE_CP SetConsoleCodePage
;
649 CSRSS_GET_CONSOLE_OUTPUT_CP GetConsoleOutputCodePage
;
650 CSRSS_SET_CONSOLE_OUTPUT_CP SetConsoleOutputCodePage
;
652 CSRSS_GET_PROCESS_LIST GetProcessListRequest
;
654 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;