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 Server 2003 table from http://j00ru.vexillium.org/csrss_list/api_list.html#Windows_2k3
19 // plus a little bit of Windows 7.
20 typedef enum _CONSRV_API_NUMBER
22 ConsolepOpenConsole
= CONSRV_FIRST_API_NUMBER
,
23 ConsolepGetConsoleInput
,
24 ConsolepWriteConsoleInput
,
25 ConsolepReadConsoleOutput
,
26 ConsolepWriteConsoleOutput
,
27 ConsolepReadConsoleOutputString
,
28 ConsolepWriteConsoleOutputString
,
29 ConsolepFillConsoleOutput
,
31 // ConsolepGetNumberOfFonts,
32 ConsolepGetNumberOfInputEvents
,
33 ConsolepGetScreenBufferInfo
,
34 ConsolepGetCursorInfo
,
35 // ConsolepGetMouseInfo,
36 // ConsolepGetFontInfo,
37 // ConsolepGetFontSize,
38 // ConsolepGetCurrentFont,
40 ConsolepSetActiveScreenBuffer
,
41 ConsolepFlushInputBuffer
,
42 // ConsolepGetLargestWindowSize,
43 ConsolepSetScreenBufferSize
,
44 ConsolepSetCursorPosition
,
45 ConsolepSetCursorInfo
,
46 // ConsolepSetWindowInfo,
47 ConsolepScrollScreenBuffer
,
48 ConsolepSetTextAttribute
,
53 ConsolepDuplicateHandle
,
54 // ConsolepGetHandleInformation,
55 // ConsolepSetHandleInformation,
57 ConsolepVerifyIoHandle
,
62 ConsolepCreateScreenBuffer
,
63 // ConsolepInvalidateBitMapRect,
64 // ConsolepVDMOperation,
66 // ConsolepShowCursor,
67 // ConsolepMenuControl,
68 // ConsolepSetPalette,
69 // ConsolepSetDisplayMode,
70 // ConsolepRegisterVDM,
71 ConsolepGetHardwareState
,
72 ConsolepSetHardwareState
,
73 // ConsolepGetDisplayMode,
76 ConsolepGetAliasesLength
,
77 ConsolepGetAliasExesLength
,
80 ConsolepExpungeCommandHistory
,
81 ConsolepSetNumberOfCommands
,
82 ConsolepGetCommandHistoryLength
,
83 ConsolepGetCommandHistory
,
84 // ConsolepSetCommandHistoryMode,
87 // ConsolepSetKeyShortcuts,
88 // ConsolepSetMenuClose,
89 // ConsolepNotifyLastClose,
90 ConsolepGenerateCtrlEvent
,
91 // ConsolepGetKeyboardLayoutName,
92 ConsolepGetConsoleWindow
,
94 // ConsolepSetLocalEUDC,
95 // ConsolepSetCursorMode,
96 // ConsolepGetCursorMode,
97 // ConsolepRegisterOS2,
98 // ConsolepSetOS2OemFormat,
99 // ConsolepGetNlsMode,
100 // ConsolepSetNlsMode,
101 // ConsolepRegisterConsoleIME,
102 // ConsolepUnregisterConsoleIME,
103 // ConsolepGetLangId,
105 ConsolepGetSelectionInfo
,
106 ConsolepGetProcessList
,
111 } CONSRV_API_NUMBER
, *PCONSRV_API_NUMBER
;
114 typedef struct _CONSOLE_START_INFO
116 DWORD dwStartupFlags
;
118 COORD ScreenBufferSize
;
120 POINT ConsoleWindowOrigin
;
121 SIZE ConsoleWindowSize
;
122 // UNICODE_STRING ConsoleTitle;
123 WCHAR ConsoleTitle
[MAX_PATH
+ 1];
124 } CONSOLE_START_INFO
, *PCONSOLE_START_INFO
;
126 typedef struct _CONSOLE_CONNECTION_INFO
128 BOOL ConsoleNeeded
; // Used for GUI apps only.
130 /* Adapted from CONSOLE_ALLOCCONSOLE */
131 CONSOLE_START_INFO ConsoleStartInfo
;
132 WCHAR AppPath
[MAX_PATH
+ 1];
134 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
138 HANDLE InputWaitHandle
;
139 LPTHREAD_START_ROUTINE CtrlDispatcher
;
140 LPTHREAD_START_ROUTINE PropDispatcher
;
141 } CONSOLE_CONNECTION_INFO
, *PCONSOLE_CONNECTION_INFO
;
147 ULONG nProcessIdsTotal
;
149 } CONSOLE_GETPROCESSLIST
, *PCONSOLE_GETPROCESSLIST
;
156 ULONG NrCharactersToWrite
;
157 ULONG NrCharactersWritten
;
161 } CONSOLE_WRITECONSOLE
, *PCONSOLE_WRITECONSOLE
;
168 WORD NrCharactersToRead
;
169 WORD NrCharactersRead
;
171 UNICODE_STRING ExeName
;
172 DWORD CtrlWakeupMask
;
173 DWORD ControlKeyState
;
177 } CONSOLE_READCONSOLE
, *PCONSOLE_READCONSOLE
;
181 PCONSOLE_START_INFO ConsoleStartInfo
;
182 LPWSTR AppPath
; // Length: MAX_PATH + 1
184 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
188 HANDLE InputWaitHandle
;
189 LPTHREAD_START_ROUTINE CtrlDispatcher
;
190 LPTHREAD_START_ROUTINE PropDispatcher
;
191 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
195 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
196 HANDLE Console
; // ConsoleHandle // In fact, it is a PCSRSS_CONSOLE <-- correct that !!
200 HANDLE InputWaitHandle
;
201 LPTHREAD_START_ROUTINE CtrlDispatcher
;
202 LPTHREAD_START_ROUTINE PropDispatcher
;
203 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
208 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
213 CONSOLE_SCREEN_BUFFER_INFO Info
;
214 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
220 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
225 CONSOLE_CURSOR_INFO Info
;
226 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
232 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
236 HANDLE ConsoleHandle
; /* A valid input or output console handle */
238 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
242 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
247 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
251 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
252 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
258 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
267 SMALL_RECT WriteRegion
;
269 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
274 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
281 SMALL_RECT ScrollRectangle
;
282 BOOL UseClipRectangle
;
283 SMALL_RECT ClipRectangle
;
284 COORD DestinationOrigin
;
286 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
290 * An attribute or a character are instances of the same entity, namely
291 * a "code" (what would be called an (ANSI) escape sequence). Therefore
292 * encode them inside the same structure.
294 typedef enum _CODE_TYPE
298 CODE_ATTRIBUTE
= 0x03
305 DWORD NumCodesToRead
;
318 } pCode
; // Either a pointer to a character or to an attribute.
319 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
330 ULONG NrCharactersWritten
;
340 } pCode
; // Either a pointer to a character or to an attribute.
341 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
353 } Code
; // Either a character or an attribute.
358 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
359 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
365 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
370 PINPUT_RECORD InputRecord
;
371 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
380 SMALL_RECT ReadRegion
;
382 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
389 INPUT_RECORD
* InputRecord
;
390 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
394 HANDLE ConsoleHandle
;
395 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
399 HANDLE ConsoleHandle
;
400 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
404 HANDLE ConsoleHandle
;
408 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
413 typedef enum _CONSOLE_HANDLE_TYPE
417 } CONSOLE_HANDLE_TYPE
;
421 HANDLE ConsoleHandle
;
422 CONSOLE_HANDLE_TYPE HandleType
;
426 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
430 * Console hardware states.
432 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
433 #define CONSOLE_HARDWARE_STATE_DIRECT 1
439 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
444 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
449 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
456 ULONG TargetLength
; // Also used for storing the number of bytes written.
461 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
466 DWORD AliasesBufferLength
;
468 LPWSTR AliasesBuffer
;
469 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
476 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
482 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
487 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
493 UNICODE_STRING ExeName
;
496 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
500 UNICODE_STRING ExeName
;
502 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
506 UNICODE_STRING ExeName
;
507 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
511 UNICODE_STRING ExeName
;
513 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
517 UINT HistoryBufferSize
;
518 UINT NumberOfHistoryBuffers
;
520 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
528 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
533 DWORD NumInputEvents
;
534 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
540 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
544 CONSOLE_SELECTION_INFO Info
;
545 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
549 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
551 } CONSOLE_GETSETINPUTOUTPUTCP
, *PCONSOLE_GETSETINPUTOUTPUTCP
;
553 typedef struct _CONSOLE_API_MESSAGE
557 PCSR_CAPTURE_BUFFER CsrCaptureData
;
558 CSR_API_NUMBER ApiNumber
;
559 NTSTATUS Status
; // ReturnValue;
563 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
564 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
565 CONSOLE_FREECONSOLE FreeConsoleRequest
;
568 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
569 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
570 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
571 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
574 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
575 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
578 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
579 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
580 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
581 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
582 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
584 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
585 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
588 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
589 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
592 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
593 CONSOLE_GETWINDOW GetWindowRequest
;
594 CONSOLE_SETICON SetIconRequest
;
597 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
598 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
599 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
600 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
603 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
604 CONSOLE_WRITEINPUT WriteInputRequest
;
605 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
606 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
608 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
609 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
612 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
613 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
614 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
615 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
616 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
619 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
620 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
621 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
622 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
623 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
625 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
626 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
628 /* Input and Output Code Pages */
629 CONSOLE_GETSETINPUTOUTPUTCP ConsoleCPRequest
;
631 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
633 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
635 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
636 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);