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,
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,
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 WCHAR IconPath
[MAX_PATH
+ 1]; // Path to the file containing the icon
126 INT IconIndex
; // Index of the icon
127 } CONSOLE_START_INFO
, *PCONSOLE_START_INFO
;
129 typedef struct _CONSOLE_CONNECTION_INFO
131 BOOL ConsoleNeeded
; // Used for GUI apps only.
133 /* Adapted from CONSOLE_ALLOCCONSOLE */
134 CONSOLE_START_INFO ConsoleStartInfo
;
136 HANDLE ConsoleHandle
;
140 HANDLE InputWaitHandle
;
141 LPTHREAD_START_ROUTINE CtrlDispatcher
;
142 LPTHREAD_START_ROUTINE PropDispatcher
;
143 } CONSOLE_CONNECTION_INFO
, *PCONSOLE_CONNECTION_INFO
;
149 ULONG nProcessIdsTotal
;
151 } CONSOLE_GETPROCESSLIST
, *PCONSOLE_GETPROCESSLIST
;
158 ULONG NrCharactersToWrite
;
159 ULONG NrCharactersWritten
;
163 } CONSOLE_WRITECONSOLE
, *PCONSOLE_WRITECONSOLE
;
170 ULONG NrCharactersToRead
;
171 ULONG NrCharactersRead
;
173 UNICODE_STRING ExeName
;
174 DWORD CtrlWakeupMask
;
175 DWORD ControlKeyState
;
179 } CONSOLE_READCONSOLE
, *PCONSOLE_READCONSOLE
;
183 PCONSOLE_START_INFO ConsoleStartInfo
;
185 HANDLE ConsoleHandle
;
189 HANDLE InputWaitHandle
;
190 LPTHREAD_START_ROUTINE CtrlDispatcher
;
191 LPTHREAD_START_ROUTINE PropDispatcher
;
192 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
196 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
197 HANDLE ConsoleHandle
;
201 HANDLE InputWaitHandle
;
202 LPTHREAD_START_ROUTINE CtrlDispatcher
;
203 LPTHREAD_START_ROUTINE PropDispatcher
;
204 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
209 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
214 CONSOLE_SCREEN_BUFFER_INFO Info
;
215 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
221 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
228 } CONSOLE_SHOWCURSOR
, *PCONSOLE_SHOWCURSOR
;
234 } CONSOLE_SETCURSOR
, *PCONSOLE_SETCURSOR
;
239 CONSOLE_CURSOR_INFO Info
;
240 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
246 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
250 HANDLE ConsoleHandle
; /* A valid input or output console handle */
252 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
256 // HANDLE OutputHandle;
258 } CONSOLE_GETDISPLAYMODE
, *PCONSOLE_GETDISPLAYMODE
;
265 } CONSOLE_SETDISPLAYMODE
, *PCONSOLE_SETDISPLAYMODE
;
268 * Console hardware states.
270 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
271 #define CONSOLE_HARDWARE_STATE_DIRECT 1
277 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
282 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
283 DWORD ScreenBufferType
; /* Type of the screen buffer: CONSOLE_TEXTMODE_BUFFER or CONSOLE_GRAPHICS_BUFFER */
285 * If we are creating a graphics screen buffer,
286 * this structure holds the initialization information.
288 CONSOLE_GRAPHICS_BUFFER_INFO GraphicsBufferInfo
;
293 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
297 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
298 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
304 } CONSOLE_INVALIDATEDIBITS
, *PCONSOLE_INVALIDATEDIBITS
;
310 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
319 SMALL_RECT WriteRegion
;
321 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
326 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
333 SMALL_RECT ScrollRectangle
;
334 BOOL UseClipRectangle
;
335 SMALL_RECT ClipRectangle
;
336 COORD DestinationOrigin
;
338 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
342 * An attribute or a character are instances of the same entity, namely
343 * a "code" (what would be called an (ANSI) escape sequence). Therefore
344 * encode them inside the same structure.
346 typedef enum _CODE_TYPE
350 CODE_ATTRIBUTE
= 0x03
357 DWORD NumCodesToRead
;
370 } pCode
; // Either a pointer to a character or to an attribute.
371 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
377 ULONG BufferSize
; // Seems unusued
382 ULONG NrCharactersWritten
; // Seems unusued
391 } pCode
; // Either a pointer to a character or to an attribute.
392 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
404 } Code
; // Either a character or an attribute.
409 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
410 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
416 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
421 PINPUT_RECORD InputRecord
;
422 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
431 SMALL_RECT ReadRegion
;
433 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
440 INPUT_RECORD
* InputRecord
;
441 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
445 HANDLE ConsoleHandle
;
446 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
450 HANDLE ConsoleHandle
;
451 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
455 HANDLE ConsoleHandle
;
459 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
464 typedef enum _CONSOLE_HANDLE_TYPE
468 } CONSOLE_HANDLE_TYPE
;
472 HANDLE ConsoleHandle
;
473 CONSOLE_HANDLE_TYPE HandleType
;
477 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
484 } CONSOLE_GETLARGESTWINDOWSIZE
, *PCONSOLE_GETLARGESTWINDOWSIZE
;
492 } CONSOLE_MENUCONTROL
, *PCONSOLE_MENUCONTROL
;
497 } CONSOLE_SETMENUCLOSE
, *PCONSOLE_SETMENUCLOSE
;
503 SMALL_RECT WindowRect
; // New console window position in the screen-buffer frame (Absolute == TRUE)
504 // or in the old window position frame (Absolute == FALSE).
505 } CONSOLE_SETWINDOWINFO
, *PCONSOLE_SETWINDOWINFO
;
510 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
515 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
522 ULONG TargetLength
; // Also used for storing the number of bytes written.
527 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
532 DWORD AliasesBufferLength
;
534 LPWSTR AliasesBuffer
;
535 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
542 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
548 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
553 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
559 UNICODE_STRING ExeName
;
562 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
566 UNICODE_STRING ExeName
;
568 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
572 UNICODE_STRING ExeName
;
573 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
577 UNICODE_STRING ExeName
;
579 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
583 UINT HistoryBufferSize
;
584 UINT NumberOfHistoryBuffers
;
586 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
594 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
599 DWORD NumInputEvents
;
600 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
606 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
610 CONSOLE_SELECTION_INFO Info
;
611 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
615 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
617 } CONSOLE_GETSETINPUTOUTPUTCP
, *PCONSOLE_GETSETINPUTOUTPUTCP
;
619 typedef struct _CONSOLE_API_MESSAGE
623 PCSR_CAPTURE_BUFFER CsrCaptureData
;
624 CSR_API_NUMBER ApiNumber
;
629 /* Console initialization and uninitialization */
630 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
631 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
632 CONSOLE_FREECONSOLE FreeConsoleRequest
;
635 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
638 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
639 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
640 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
641 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
644 CONSOLE_SHOWCURSOR ShowCursorRequest
;
645 CONSOLE_SETCURSOR SetCursorRequest
;
646 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
647 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
650 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
651 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
652 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
653 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
654 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
656 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
657 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
660 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
661 CONSOLE_GETDISPLAYMODE GetDisplayModeRequest
;
662 CONSOLE_SETDISPLAYMODE SetDisplayModeRequest
;
663 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
666 CONSOLE_INVALIDATEDIBITS InvalidateDIBitsRequest
;
667 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
668 CONSOLE_GETLARGESTWINDOWSIZE GetLargestWindowSizeRequest
;
669 CONSOLE_MENUCONTROL MenuControlRequest
;
670 CONSOLE_SETMENUCLOSE SetMenuCloseRequest
;
671 CONSOLE_SETWINDOWINFO SetWindowInfoRequest
;
672 CONSOLE_GETWINDOW GetWindowRequest
;
673 CONSOLE_SETICON SetIconRequest
;
676 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
677 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
678 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
679 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
682 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
683 CONSOLE_WRITEINPUT WriteInputRequest
;
684 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
685 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
687 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
688 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
691 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
692 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
693 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
694 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
695 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
698 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
699 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
700 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
701 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
702 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
704 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
705 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
707 /* Input and Output Code Pages */
708 CONSOLE_GETSETINPUTOUTPUTCP ConsoleCPRequest
;
710 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
712 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
713 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);