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 typedef struct _CONSOLE_PROPS
117 DWORD dwStartupFlags
;
119 COORD ScreenBufferSize
;
121 POINT ConsoleWindowOrigin
;
122 SIZE ConsoleWindowSize
;
123 // UNICODE_STRING ConsoleTitle;
124 WCHAR ConsoleTitle
[MAX_PATH
+ 1];
125 } CONSOLE_PROPS
, *PCONSOLE_PROPS
;
127 typedef struct _CONSOLE_CONNECTION_INFO
129 BOOL ConsoleNeeded
; // Used for GUI apps only.
131 /* Adapted from CONSOLE_ALLOCCONSOLE */
132 CONSOLE_PROPS ConsoleProps
;
133 WCHAR AppPath
[MAX_PATH
+ 1];
135 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
139 HANDLE InputWaitHandle
;
140 LPTHREAD_START_ROUTINE CtrlDispatcher
;
141 } CONSOLE_CONNECTION_INFO
, *PCONSOLE_CONNECTION_INFO
;
144 #define CONSOLE_INPUT_MODE_VALID 0x0f
145 #define CONSOLE_OUTPUT_MODE_VALID 0x03
151 ULONG nProcessIdsTotal
;
153 } CONSOLE_GETPROCESSLIST
, *PCONSOLE_GETPROCESSLIST
;
160 ULONG NrCharactersToWrite
;
161 ULONG NrCharactersWritten
;
165 } CONSOLE_WRITECONSOLE
, *PCONSOLE_WRITECONSOLE
;
172 WORD NrCharactersToRead
;
173 WORD NrCharactersRead
;
175 UNICODE_STRING ExeName
;
176 DWORD CtrlWakeupMask
;
177 DWORD ControlKeyState
;
181 } CONSOLE_READCONSOLE
, *PCONSOLE_READCONSOLE
;
185 PCONSOLE_PROPS ConsoleProps
;
188 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
192 HANDLE InputWaitHandle
;
193 LPTHREAD_START_ROUTINE CtrlDispatcher
;
194 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
198 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
199 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
203 HANDLE InputWaitHandle
;
204 LPTHREAD_START_ROUTINE CtrlDispatcher
;
205 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
210 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
215 CONSOLE_SCREEN_BUFFER_INFO Info
;
216 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
222 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
227 CONSOLE_CURSOR_INFO Info
;
228 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
234 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
238 HANDLE ConsoleHandle
; /* A valid input or output console handle */
240 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
244 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
249 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
253 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
254 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
260 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
269 SMALL_RECT WriteRegion
;
271 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
276 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
283 SMALL_RECT ScrollRectangle
;
284 BOOL UseClipRectangle
;
285 SMALL_RECT ClipRectangle
;
286 COORD DestinationOrigin
;
288 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
292 * An attribute or a character are instances of the same entity, namely
293 * a "code" (what would be called an (ANSI) escape sequence). Therefore
294 * encode them inside the same structure.
296 typedef enum _CODE_TYPE
300 CODE_ATTRIBUTE
= 0x03
307 DWORD NumCodesToRead
;
320 } pCode
; // Either a pointer to a character or to an attribute.
321 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
332 ULONG NrCharactersWritten
;
342 } pCode
; // Either a pointer to a character or to an attribute.
343 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
355 } Code
; // Either a character or an attribute.
360 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
361 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
367 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
372 PINPUT_RECORD InputRecord
;
373 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
382 SMALL_RECT ReadRegion
;
384 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
391 INPUT_RECORD
* InputRecord
;
392 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
396 HANDLE ConsoleHandle
;
397 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
401 HANDLE ConsoleHandle
;
402 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
406 HANDLE ConsoleHandle
;
410 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
415 typedef enum _CONSOLE_HANDLE_TYPE
419 } CONSOLE_HANDLE_TYPE
;
423 HANDLE ConsoleHandle
;
424 CONSOLE_HANDLE_TYPE HandleType
;
428 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
433 HANDLE InputWaitHandle
;
434 } CSRSS_GET_INPUT_WAIT_HANDLE
, *PCSRSS_GET_INPUT_WAIT_HANDLE
;
439 * Console hardware states.
441 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
442 #define CONSOLE_HARDWARE_STATE_DIRECT 1
448 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
453 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
458 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
465 ULONG TargetLength
; // Also used for storing the number of bytes written.
470 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
475 DWORD AliasesBufferLength
;
477 LPWSTR AliasesBuffer
;
478 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
485 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
491 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
496 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
502 UNICODE_STRING ExeName
;
505 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
509 UNICODE_STRING ExeName
;
511 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
515 UNICODE_STRING ExeName
;
516 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
520 UNICODE_STRING ExeName
;
522 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
526 UINT HistoryBufferSize
;
527 UINT NumberOfHistoryBuffers
;
529 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
537 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
542 DWORD NumInputEvents
;
543 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
549 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
553 CONSOLE_SELECTION_INFO Info
;
554 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
558 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
560 } CONSOLE_GETSETINPUTOUTPUTCP
, *PCONSOLE_GETSETINPUTOUTPUTCP
;
562 typedef struct _CONSOLE_API_MESSAGE
566 PCSR_CAPTURE_BUFFER CsrCaptureData
;
567 CSR_API_NUMBER ApiNumber
;
568 ULONG Status
; // ReturnValue; // NTSTATUS Status
572 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
573 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
574 CONSOLE_FREECONSOLE FreeConsoleRequest
;
577 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
578 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
579 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
580 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
582 CSRSS_GET_INPUT_WAIT_HANDLE GetConsoleInputWaitHandle
;
586 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
587 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
590 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
591 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
592 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
593 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
594 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
596 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
597 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
600 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
601 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
604 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
605 CONSOLE_GETWINDOW GetWindowRequest
;
606 CONSOLE_SETICON SetIconRequest
;
609 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
610 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
611 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
612 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
615 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
616 CONSOLE_WRITEINPUT WriteInputRequest
;
617 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
618 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
620 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
621 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
624 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
625 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
626 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
627 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
628 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
631 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
632 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
633 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
634 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
635 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
637 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
638 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
640 /* Input and Output Code Pages */
641 CONSOLE_GETSETINPUTOUTPUTCP ConsoleCPRequest
;
643 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
645 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
647 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
648 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);