2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Console Server DLL
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]; // Console title or full path to the startup shortcut
124 WCHAR AppPath
[MAX_PATH
+ 1]; // Full path of the launched app
125 } CONSOLE_START_INFO
, *PCONSOLE_START_INFO
;
127 typedef struct _CONSOLE_CONNECTION_INFO
129 BOOL ConsoleNeeded
; // Used for GUI apps only.
131 /* Adapted from CONSOLE_ALLOCCONSOLE */
132 CONSOLE_START_INFO ConsoleStartInfo
;
134 HANDLE Console
; // ConsoleHandle // On ReactOS, it is a PCONSOLE
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
;
183 HANDLE Console
; // ConsoleHandle // On ReactOS, it is a PCONSOLE
187 HANDLE InputWaitHandle
;
188 LPTHREAD_START_ROUTINE CtrlDispatcher
;
189 LPTHREAD_START_ROUTINE PropDispatcher
;
190 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
194 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
195 HANDLE Console
; // ConsoleHandle // On ReactOS, it is a PCONSOLE
199 HANDLE InputWaitHandle
;
200 LPTHREAD_START_ROUTINE CtrlDispatcher
;
201 LPTHREAD_START_ROUTINE PropDispatcher
;
202 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
207 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
212 CONSOLE_SCREEN_BUFFER_INFO Info
;
213 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
219 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
224 CONSOLE_CURSOR_INFO Info
;
225 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
231 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
235 HANDLE ConsoleHandle
; /* A valid input or output console handle */
237 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
240 #define CONSOLE_WINDOWED 0 /* Internal console hardware state */
243 // HANDLE OutputHandle;
245 } CONSOLE_GETDISPLAYMODE
, *PCONSOLE_GETDISPLAYMODE
;
252 } CONSOLE_SETDISPLAYMODE
, *PCONSOLE_SETDISPLAYMODE
;
255 * Console hardware states.
257 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
258 #define CONSOLE_HARDWARE_STATE_DIRECT 1
264 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
269 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
274 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
278 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
279 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
285 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
294 SMALL_RECT WriteRegion
;
296 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
301 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
308 SMALL_RECT ScrollRectangle
;
309 BOOL UseClipRectangle
;
310 SMALL_RECT ClipRectangle
;
311 COORD DestinationOrigin
;
313 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
317 * An attribute or a character are instances of the same entity, namely
318 * a "code" (what would be called an (ANSI) escape sequence). Therefore
319 * encode them inside the same structure.
321 typedef enum _CODE_TYPE
325 CODE_ATTRIBUTE
= 0x03
332 DWORD NumCodesToRead
;
345 } pCode
; // Either a pointer to a character or to an attribute.
346 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
357 ULONG NrCharactersWritten
;
367 } pCode
; // Either a pointer to a character or to an attribute.
368 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
380 } Code
; // Either a character or an attribute.
385 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
386 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
392 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
397 PINPUT_RECORD InputRecord
;
398 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
407 SMALL_RECT ReadRegion
;
409 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
416 INPUT_RECORD
* InputRecord
;
417 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
421 HANDLE ConsoleHandle
;
422 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
426 HANDLE ConsoleHandle
;
427 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
431 HANDLE ConsoleHandle
;
435 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
440 typedef enum _CONSOLE_HANDLE_TYPE
444 } CONSOLE_HANDLE_TYPE
;
448 HANDLE ConsoleHandle
;
449 CONSOLE_HANDLE_TYPE HandleType
;
453 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
460 } CONSOLE_GETLARGESTWINDOWSIZE
, *PCONSOLE_GETLARGESTWINDOWSIZE
;
466 SMALL_RECT WindowRect
; // New console window position in the screen-buffer frame (Absolute == TRUE)
467 // or in the old window position frame (Absolute == FALSE).
468 } CONSOLE_SETWINDOWINFO
, *PCONSOLE_SETWINDOWINFO
;
473 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
478 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
485 ULONG TargetLength
; // Also used for storing the number of bytes written.
490 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
495 DWORD AliasesBufferLength
;
497 LPWSTR AliasesBuffer
;
498 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
505 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
511 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
516 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
522 UNICODE_STRING ExeName
;
525 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
529 UNICODE_STRING ExeName
;
531 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
535 UNICODE_STRING ExeName
;
536 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
540 UNICODE_STRING ExeName
;
542 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
546 UINT HistoryBufferSize
;
547 UINT NumberOfHistoryBuffers
;
549 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
557 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
562 DWORD NumInputEvents
;
563 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
569 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
573 CONSOLE_SELECTION_INFO Info
;
574 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
578 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
580 } CONSOLE_GETSETINPUTOUTPUTCP
, *PCONSOLE_GETSETINPUTOUTPUTCP
;
582 typedef struct _CONSOLE_API_MESSAGE
586 PCSR_CAPTURE_BUFFER CsrCaptureData
;
587 CSR_API_NUMBER ApiNumber
;
592 /* Console initialization and uninitialization */
593 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
594 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
595 CONSOLE_FREECONSOLE FreeConsoleRequest
;
598 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
601 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
602 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
603 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
604 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
607 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
608 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
611 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
612 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
613 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
614 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
615 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
617 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
618 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
621 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
622 CONSOLE_GETDISPLAYMODE GetDisplayModeRequest
;
623 CONSOLE_SETDISPLAYMODE SetDisplayModeRequest
;
624 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
627 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
628 CONSOLE_GETLARGESTWINDOWSIZE GetLargestWindowSizeRequest
;
629 CONSOLE_SETWINDOWINFO SetWindowInfoRequest
;
630 CONSOLE_GETWINDOW GetWindowRequest
;
631 CONSOLE_SETICON SetIconRequest
;
634 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
635 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
636 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
637 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
640 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
641 CONSOLE_WRITEINPUT WriteInputRequest
;
642 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
643 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
645 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
646 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
649 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
650 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
651 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
652 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
653 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
656 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
657 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
658 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
659 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
660 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
662 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
663 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
665 /* Input and Output Code Pages */
666 CONSOLE_GETSETINPUTOUTPUTCP ConsoleCPRequest
;
668 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
670 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
671 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);