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 typedef enum _CONSRV_API_NUMBER
21 ConsolepOpenConsole
= CONSRV_FIRST_API_NUMBER
,
22 ConsolepGetConsoleInput
,
23 ConsolepWriteConsoleInput
,
24 ConsolepReadConsoleOutput
,
25 ConsolepWriteConsoleOutput
,
26 ConsolepReadConsoleOutputString
,
27 ConsolepWriteConsoleOutputString
,
28 ConsolepFillConsoleOutput
,
30 ConsolepGetNumberOfFonts
,
31 ConsolepGetNumberOfInputEvents
,
32 ConsolepGetScreenBufferInfo
,
33 ConsolepGetCursorInfo
,
37 ConsolepGetCurrentFont
,
39 ConsolepSetActiveScreenBuffer
,
40 ConsolepFlushInputBuffer
,
41 ConsolepGetLargestWindowSize
,
42 ConsolepSetScreenBufferSize
,
43 ConsolepSetCursorPosition
,
44 ConsolepSetCursorInfo
,
45 ConsolepSetWindowInfo
,
46 ConsolepScrollScreenBuffer
,
47 ConsolepSetTextAttribute
,
52 ConsolepDuplicateHandle
,
53 ConsolepGetHandleInformation
,
54 ConsolepSetHandleInformation
,
56 ConsolepVerifyIoHandle
,
57 ConsolepAlloc
, // Not present in Win7
58 ConsolepFree
, // Not present in Win7
61 ConsolepCreateScreenBuffer
,
62 ConsolepInvalidateBitMapRect
,
68 ConsolepSetDisplayMode
,
70 ConsolepGetHardwareState
,
71 ConsolepSetHardwareState
,
72 ConsolepGetDisplayMode
,
75 ConsolepGetAliasesLength
,
76 ConsolepGetAliasExesLength
,
79 ConsolepExpungeCommandHistory
,
80 ConsolepSetNumberOfCommands
,
81 ConsolepGetCommandHistoryLength
,
82 ConsolepGetCommandHistory
,
83 ConsolepSetCommandHistoryMode
, // Not present in Vista+
86 ConsolepSetKeyShortcuts
,
88 ConsolepNotifyLastClose
,
89 ConsolepGenerateCtrlEvent
,
90 ConsolepGetKeyboardLayoutName
,
91 ConsolepGetConsoleWindow
,
94 ConsolepSetCursorMode
,
95 ConsolepGetCursorMode
,
97 ConsolepSetOS2OemFormat
,
100 ConsolepRegisterConsoleIME
, // Not present in Win7
101 ConsolepUnregisterConsoleIME
, // Not present in Win7
102 // ConsolepQueryConsoleIME, // Added only in Vista and Win2k8, not present in Win7
104 ConsolepAttach
, // Not present in Win7
105 ConsolepGetSelectionInfo
,
106 ConsolepGetProcessList
,
108 ConsolepGetHistory
, // Added in Vista+
109 ConsolepSetHistory
, // Added in Vista+
110 // ConsolepSetCurrentFont, // Added in Vista+
111 // ConsolepSetScreenBufferInfo, // Added in Vista+
112 // ConsolepClientConnect, // Added in Win7
115 } CONSRV_API_NUMBER
, *PCONSRV_API_NUMBER
;
118 // See http://msdn.microsoft.com/en-us/library/windows/desktop/bb773359(v=vs.85).aspx
120 typedef struct _CONSOLE_PROPERTIES
123 WORD wPopupFillAttribute
;
126 // Not on MSDN, but show up in binary
131 COORD dwScreenBufferSize
;
133 COORD dwWindowOrigin
;
135 DWORD nInputBufferSize
;
139 WCHAR FaceName
[LF_FACESIZE
];
145 UINT uHistoryBufferSize
;
146 UINT uNumberOfHistoryBuffers
;
148 COLORREF ColorTable
[16];
150 //NT_FE_CONSOLE_PROPS
152 } CONSOLE_PROPERTIES
;
155 // To minimize code changes, some fields were put here even though they really only belong in
156 // CONSRV_API_CONNECTINFO. Do not change the ordering however, as it's required for Windows
159 typedef struct _CONSOLE_START_INFO
165 DWORD dwStartupFlags
;
167 BOOLEAN ConsoleNeeded
; // Used for GUI apps only.
168 LPTHREAD_START_ROUTINE CtrlDispatcher
;
169 LPTHREAD_START_ROUTINE ImeDispatcher
;
170 LPTHREAD_START_ROUTINE PropDispatcher
;
172 WCHAR ConsoleTitle
[MAX_PATH
+ 1]; // Console title or full path to the startup shortcut
176 WCHAR AppPath
[128]; // Full path of the launched app
177 ULONG IconPathLength
;
178 WCHAR IconPath
[MAX_PATH
+ 1]; // Path to the file containing the icon
179 } CONSOLE_START_INFO
, *PCONSOLE_START_INFO
;
181 typedef struct _CONSRV_API_CONNECTINFO
183 HANDLE ConsoleHandle
;
184 HANDLE InputWaitHandle
;
190 /* Adapted from CONSOLE_ALLOCCONSOLE */
191 CONSOLE_START_INFO ConsoleStartInfo
;
192 } CONSRV_API_CONNECTINFO
, *PCONSRV_API_CONNECTINFO
;
195 C_ASSERT(sizeof(CONSRV_API_CONNECTINFO
) == 0x638);
200 HANDLE ConsoleHandle
;
202 PDWORD ProcessIdsList
;
203 } CONSOLE_GETPROCESSLIST
, *PCONSOLE_GETPROCESSLIST
;
207 HANDLE ConsoleHandle
;
209 DWORD ProcessGroupId
;
210 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
214 HANDLE ConsoleHandle
;
215 } CONSOLE_NOTIFYLASTCLOSE
, *PCONSOLE_NOTIFYLASTCLOSE
;
224 ULONG NrCharactersToWrite
;
225 ULONG NrCharactersWritten
;
229 } CONSOLE_WRITECONSOLE
, *PCONSOLE_WRITECONSOLE
;
236 ULONG NrCharactersToRead
;
237 ULONG NrCharactersRead
;
239 UNICODE_STRING ExeName
;
240 DWORD CtrlWakeupMask
;
241 DWORD ControlKeyState
;
245 } CONSOLE_READCONSOLE
, *PCONSOLE_READCONSOLE
;
249 PCONSOLE_START_INFO ConsoleStartInfo
;
251 HANDLE ConsoleHandle
;
255 HANDLE InputWaitHandle
;
256 LPTHREAD_START_ROUTINE CtrlDispatcher
;
257 LPTHREAD_START_ROUTINE PropDispatcher
;
258 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
262 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
263 HANDLE ConsoleHandle
;
267 HANDLE InputWaitHandle
;
268 LPTHREAD_START_ROUTINE CtrlDispatcher
;
269 LPTHREAD_START_ROUTINE PropDispatcher
;
270 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
275 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
279 HANDLE ConsoleHandle
;
281 COORD ScreenBufferSize
;
282 COORD CursorPosition
;
286 COORD MaximumViewSize
;
287 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
291 HANDLE ConsoleHandle
;
294 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
298 HANDLE ConsoleHandle
;
302 } CONSOLE_SHOWCURSOR
, *PCONSOLE_SHOWCURSOR
;
306 HANDLE ConsoleHandle
;
308 HCURSOR CursorHandle
;
309 } CONSOLE_SETCURSOR
, *PCONSOLE_SETCURSOR
;
313 HANDLE ConsoleHandle
;
315 CONSOLE_CURSOR_INFO Info
;
320 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
324 HANDLE ConsoleHandle
;
327 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
331 HANDLE ConsoleHandle
;
334 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
338 HANDLE ConsoleHandle
;
339 DWORD DisplayMode
; // ModeFlags
340 } CONSOLE_GETDISPLAYMODE
, *PCONSOLE_GETDISPLAYMODE
;
344 HANDLE ConsoleHandle
;
346 DWORD DisplayMode
; // ModeFlags
349 } CONSOLE_SETDISPLAYMODE
, *PCONSOLE_SETDISPLAYMODE
;
352 * Console hardware states.
354 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
355 #define CONSOLE_HARDWARE_STATE_DIRECT 1
359 HANDLE ConsoleHandle
;
363 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
369 HANDLE ConsoleHandle
;
373 DWORD ScreenBufferType
; /* Type of the screen buffer: CONSOLE_TEXTMODE_BUFFER or CONSOLE_GRAPHICS_BUFFER */
375 * This structure holds the initialization information
376 * for graphics screen buffers.
378 CONSOLE_GRAPHICS_BUFFER_INFO GraphicsBufferInfo
;
381 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
382 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
386 HANDLE ConsoleHandle
;
387 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
388 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
392 HANDLE ConsoleHandle
;
395 } CONSOLE_INVALIDATEDIBITS
, *PCONSOLE_INVALIDATEDIBITS
;
399 HANDLE ConsoleHandle
;
401 HPALETTE PaletteHandle
;
403 } CONSOLE_SETPALETTE
, *PCONSOLE_SETPALETTE
;
407 HANDLE ConsoleHandle
;
411 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
420 SMALL_RECT WriteRegion
;
422 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
426 HANDLE ConsoleHandle
;
428 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
432 HANDLE ConsoleHandle
;
434 SMALL_RECT ScrollRectangle
;
435 SMALL_RECT ClipRectangle
;
436 BOOL UseClipRectangle
;
437 COORD DestinationOrigin
;
440 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
444 * An attribute or a character are instances of the same entity, namely
445 * a "code" (what would be called an (ANSI) escape sequence). Therefore
446 * encode them inside the same structure.
448 typedef enum _CODE_TYPE
452 CODE_ATTRIBUTE
= 0x03
459 DWORD NumCodesToRead
;
472 } pCode
; // Either a pointer to a character or to an attribute.
473 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
479 ULONG BufferSize
; // Seems unusued
484 ULONG NrCharactersWritten
; // Seems unusued
493 } pCode
; // Either a pointer to a character or to an attribute.
494 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
506 } Code
; // Either a character or an attribute.
511 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
512 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
518 PINPUT_RECORD InputRecord
;
522 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
531 SMALL_RECT ReadRegion
;
533 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
539 INPUT_RECORD
* InputRecord
;
542 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
546 HANDLE ConsoleHandle
;
548 DWORD NumberOfEvents
;
549 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
555 HANDLE ConsoleHandle
;
557 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
562 HANDLE ConsoleHandle
;
564 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
568 HANDLE ConsoleHandle
;
571 BOOLEAN InheritHandle
;
574 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
578 HANDLE ConsoleHandle
;
581 } CONSOLE_GETHANDLEINFO
, *PCONSOLE_GETHANDLEINFO
;
585 HANDLE ConsoleHandle
;
589 } CONSOLE_SETHANDLEINFO
, *PCONSOLE_SETHANDLEINFO
;
594 typedef enum _CONSOLE_HANDLE_TYPE
598 } CONSOLE_HANDLE_TYPE
;
602 HANDLE ConsoleHandle
;
603 CONSOLE_HANDLE_TYPE HandleType
;
608 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
614 HANDLE ConsoleHandle
;
617 } CONSOLE_GETLARGESTWINDOWSIZE
, *PCONSOLE_GETLARGESTWINDOWSIZE
;
621 HANDLE ConsoleHandle
;
626 } CONSOLE_MENUCONTROL
, *PCONSOLE_MENUCONTROL
;
630 HANDLE ConsoleHandle
;
632 } CONSOLE_SETMENUCLOSE
, *PCONSOLE_SETMENUCLOSE
;
636 HANDLE ConsoleHandle
;
639 SMALL_RECT WindowRect
; // New console window position in the screen-buffer frame (Absolute == TRUE)
640 // or in the old window position frame (Absolute == FALSE).
641 } CONSOLE_SETWINDOWINFO
, *PCONSOLE_SETWINDOWINFO
;
645 HANDLE ConsoleHandle
;
647 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
651 HANDLE ConsoleHandle
;
653 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
660 ULONG TargetLength
; // Also used for storing the number of bytes written.
665 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
670 DWORD AliasesBufferLength
;
672 LPWSTR AliasesBuffer
;
673 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
677 HANDLE ConsoleHandle
;
683 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
687 HANDLE ConsoleHandle
;
688 ULONG Length
; // ExeLength; // ExesLength
691 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
695 HANDLE ConsoleHandle
;
698 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
704 HANDLE ConsoleHandle
;
707 // UNICODE_STRING ExeName;
712 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
716 HANDLE ConsoleHandle
;
718 // UNICODE_STRING ExeName;
723 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
727 HANDLE ConsoleHandle
;
728 // UNICODE_STRING ExeName;
733 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
737 UINT HistoryBufferSize
;
738 UINT NumberOfHistoryBuffers
;
740 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
744 HANDLE ConsoleHandle
;
746 // UNICODE_STRING ExeName;
751 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
755 HANDLE ConsoleHandle
;
757 } CONSOLE_SETHISTORYMODE
, *PCONSOLE_SETHISTORYMODE
;
763 HANDLE ConsoleHandle
;
766 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
770 HANDLE ConsoleHandle
;
771 CONSOLE_SELECTION_INFO Info
;
772 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
776 HANDLE ConsoleHandle
;
778 BOOL OutputCP
; // TRUE : Output Code Page ; FALSE : Input Code Page
779 } CONSOLE_GETINPUTOUTPUTCP
, *PCONSOLE_GETINPUTOUTPUTCP
;
783 HANDLE ConsoleHandle
;
785 BOOL OutputCP
; // TRUE : Output Code Page ; FALSE : Input Code Page
787 } CONSOLE_SETINPUTOUTPUTCP
, *PCONSOLE_SETINPUTOUTPUTCP
;
789 typedef struct _CONSOLE_API_MESSAGE
793 PCSR_CAPTURE_BUFFER CsrCaptureData
;
794 CSR_API_NUMBER ApiNumber
;
799 /* Console initialization and uninitialization */
800 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
801 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
802 CONSOLE_FREECONSOLE FreeConsoleRequest
;
805 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
806 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
807 CONSOLE_NOTIFYLASTCLOSE NotifyLastCloseRequest
;
810 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
811 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
812 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
813 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
814 CONSOLE_GETHANDLEINFO GetHandleInfoRequest
;
815 CONSOLE_SETHANDLEINFO SetHandleInfoRequest
;
818 CONSOLE_SHOWCURSOR ShowCursorRequest
;
819 CONSOLE_SETCURSOR SetCursorRequest
;
820 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
821 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
824 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
825 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
826 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
827 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
828 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
830 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
831 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
834 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
835 CONSOLE_GETDISPLAYMODE GetDisplayModeRequest
;
836 CONSOLE_SETDISPLAYMODE SetDisplayModeRequest
;
837 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
840 CONSOLE_INVALIDATEDIBITS InvalidateDIBitsRequest
;
841 CONSOLE_SETPALETTE SetPaletteRequest
;
842 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
843 CONSOLE_GETLARGESTWINDOWSIZE GetLargestWindowSizeRequest
;
844 CONSOLE_MENUCONTROL MenuControlRequest
;
845 CONSOLE_SETMENUCLOSE SetMenuCloseRequest
;
846 CONSOLE_SETWINDOWINFO SetWindowInfoRequest
;
847 CONSOLE_GETWINDOW GetWindowRequest
;
848 CONSOLE_SETICON SetIconRequest
;
851 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
852 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
853 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
854 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
855 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
858 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
859 CONSOLE_WRITEINPUT WriteInputRequest
;
860 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
861 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
863 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
864 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
867 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
868 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
869 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
870 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
871 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
874 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
875 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
876 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
877 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
878 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
879 CONSOLE_SETHISTORYMODE SetHistoryModeRequest
;
881 /* Input and Output Code Pages */
882 CONSOLE_GETINPUTOUTPUTCP GetConsoleCPRequest
;
883 CONSOLE_SETINPUTOUTPUTCP SetConsoleCPRequest
;
885 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
887 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
888 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);