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
;
194 C_ASSERT(sizeof(CONSRV_API_CONNECTINFO
) == 0x638);
199 ULONG nProcessIdsTotal
;
201 } CONSOLE_GETPROCESSLIST
, *PCONSOLE_GETPROCESSLIST
;
208 ULONG NrCharactersToWrite
;
209 ULONG NrCharactersWritten
;
213 } CONSOLE_WRITECONSOLE
, *PCONSOLE_WRITECONSOLE
;
220 ULONG NrCharactersToRead
;
221 ULONG NrCharactersRead
;
223 UNICODE_STRING ExeName
;
224 DWORD CtrlWakeupMask
;
225 DWORD ControlKeyState
;
229 } CONSOLE_READCONSOLE
, *PCONSOLE_READCONSOLE
;
233 PCONSOLE_START_INFO ConsoleStartInfo
;
235 HANDLE ConsoleHandle
;
239 HANDLE InputWaitHandle
;
240 LPTHREAD_START_ROUTINE CtrlDispatcher
;
241 LPTHREAD_START_ROUTINE PropDispatcher
;
242 } CONSOLE_ALLOCCONSOLE
, *PCONSOLE_ALLOCCONSOLE
;
246 DWORD ProcessId
; // If ProcessId == ATTACH_PARENT_PROCESS == -1, then attach the current process to its parent process console.
247 HANDLE ConsoleHandle
;
251 HANDLE InputWaitHandle
;
252 LPTHREAD_START_ROUTINE CtrlDispatcher
;
253 LPTHREAD_START_ROUTINE PropDispatcher
;
254 } CONSOLE_ATTACHCONSOLE
, *PCONSOLE_ATTACHCONSOLE
;
259 } CONSOLE_FREECONSOLE
, *PCONSOLE_FREECONSOLE
;
264 CONSOLE_SCREEN_BUFFER_INFO Info
;
265 } CONSOLE_GETSCREENBUFFERINFO
, *PCONSOLE_GETSCREENBUFFERINFO
;
271 } CONSOLE_SETCURSORPOSITION
, *PCONSOLE_SETCURSORPOSITION
;
278 } CONSOLE_SHOWCURSOR
, *PCONSOLE_SHOWCURSOR
;
284 } CONSOLE_SETCURSOR
, *PCONSOLE_SETCURSOR
;
289 CONSOLE_CURSOR_INFO Info
;
290 } CONSOLE_GETSETCURSORINFO
, *PCONSOLE_GETSETCURSORINFO
;
296 } CONSOLE_SETTEXTATTRIB
, *PCONSOLE_SETTEXTATTRIB
;
300 HANDLE ConsoleHandle
; /* A valid input or output console handle */
302 } CONSOLE_GETSETCONSOLEMODE
, *PCONSOLE_GETSETCONSOLEMODE
;
306 // HANDLE OutputHandle;
308 } CONSOLE_GETDISPLAYMODE
, *PCONSOLE_GETDISPLAYMODE
;
315 } CONSOLE_SETDISPLAYMODE
, *PCONSOLE_SETDISPLAYMODE
;
318 * Console hardware states.
320 #define CONSOLE_HARDWARE_STATE_GDI_MANAGED 0
321 #define CONSOLE_HARDWARE_STATE_DIRECT 1
327 } CONSOLE_GETSETHWSTATE
, *PCONSOLE_GETSETHWSTATE
;
332 HANDLE OutputHandle
; /* Handle to newly created screen buffer */
333 DWORD ScreenBufferType
; /* Type of the screen buffer: CONSOLE_TEXTMODE_BUFFER or CONSOLE_GRAPHICS_BUFFER */
335 * If we are creating a graphics screen buffer,
336 * this structure holds the initialization information.
338 CONSOLE_GRAPHICS_BUFFER_INFO GraphicsBufferInfo
;
343 } CONSOLE_CREATESCREENBUFFER
, *PCONSOLE_CREATESCREENBUFFER
;
347 HANDLE OutputHandle
; /* Handle to screen buffer to switch to */
348 } CONSOLE_SETACTIVESCREENBUFFER
, *PCONSOLE_SETACTIVESCREENBUFFER
;
354 } CONSOLE_INVALIDATEDIBITS
, *PCONSOLE_INVALIDATEDIBITS
;
359 HPALETTE PaletteHandle
;
361 } CONSOLE_SETPALETTE
, *PCONSOLE_SETPALETTE
;
367 } CONSOLE_GETSETCONSOLETITLE
, *PCONSOLE_GETSETCONSOLETITLE
;
376 SMALL_RECT WriteRegion
;
378 } CONSOLE_WRITEOUTPUT
, *PCONSOLE_WRITEOUTPUT
;
383 } CONSOLE_FLUSHINPUTBUFFER
, *PCONSOLE_FLUSHINPUTBUFFER
;
390 SMALL_RECT ScrollRectangle
;
391 BOOL UseClipRectangle
;
392 SMALL_RECT ClipRectangle
;
393 COORD DestinationOrigin
;
395 } CONSOLE_SCROLLSCREENBUFFER
, *PCONSOLE_SCROLLSCREENBUFFER
;
399 * An attribute or a character are instances of the same entity, namely
400 * a "code" (what would be called an (ANSI) escape sequence). Therefore
401 * encode them inside the same structure.
403 typedef enum _CODE_TYPE
407 CODE_ATTRIBUTE
= 0x03
414 DWORD NumCodesToRead
;
427 } pCode
; // Either a pointer to a character or to an attribute.
428 } CONSOLE_READOUTPUTCODE
, *PCONSOLE_READOUTPUTCODE
;
434 ULONG BufferSize
; // Seems unusued
439 ULONG NrCharactersWritten
; // Seems unusued
448 } pCode
; // Either a pointer to a character or to an attribute.
449 } CONSOLE_WRITEOUTPUTCODE
, *PCONSOLE_WRITEOUTPUTCODE
;
461 } Code
; // Either a character or an attribute.
466 ULONG NrCharactersWritten
; // FIXME: Only for chars, is it removable ?
467 } CONSOLE_FILLOUTPUTCODE
, *PCONSOLE_FILLOUTPUTCODE
;
473 BOOL bRead
; // TRUE --> Read ; FALSE --> Peek
478 PINPUT_RECORD InputRecord
;
479 } CONSOLE_GETINPUT
, *PCONSOLE_GETINPUT
;
488 SMALL_RECT ReadRegion
;
490 } CONSOLE_READOUTPUT
, *PCONSOLE_READOUTPUT
;
496 INPUT_RECORD
* InputRecord
;
499 } CONSOLE_WRITEINPUT
, *PCONSOLE_WRITEINPUT
;
503 HANDLE ConsoleHandle
;
504 } CONSOLE_CLOSEHANDLE
, *PCONSOLE_CLOSEHANDLE
;
508 HANDLE ConsoleHandle
;
509 } CONSOLE_VERIFYHANDLE
, *PCONSOLE_VERIFYHANDLE
;
513 HANDLE ConsoleHandle
;
517 } CONSOLE_DUPLICATEHANDLE
, *PCONSOLE_DUPLICATEHANDLE
;
522 typedef enum _CONSOLE_HANDLE_TYPE
526 } CONSOLE_HANDLE_TYPE
;
530 HANDLE ConsoleHandle
;
531 CONSOLE_HANDLE_TYPE HandleType
;
535 } CONSOLE_OPENCONSOLE
, *PCONSOLE_OPENCONSOLE
;
542 } CONSOLE_GETLARGESTWINDOWSIZE
, *PCONSOLE_GETLARGESTWINDOWSIZE
;
550 } CONSOLE_MENUCONTROL
, *PCONSOLE_MENUCONTROL
;
555 } CONSOLE_SETMENUCLOSE
, *PCONSOLE_SETMENUCLOSE
;
561 SMALL_RECT WindowRect
; // New console window position in the screen-buffer frame (Absolute == TRUE)
562 // or in the old window position frame (Absolute == FALSE).
563 } CONSOLE_SETWINDOWINFO
, *PCONSOLE_SETWINDOWINFO
;
568 } CONSOLE_GETWINDOW
, *PCONSOLE_GETWINDOW
;
573 } CONSOLE_SETICON
, *PCONSOLE_SETICON
;
580 ULONG TargetLength
; // Also used for storing the number of bytes written.
585 } CONSOLE_ADDGETALIAS
, *PCONSOLE_ADDGETALIAS
;
590 DWORD AliasesBufferLength
;
592 LPWSTR AliasesBuffer
;
593 } CONSOLE_GETALLALIASES
, *PCONSOLE_GETALLALIASES
;
600 } CONSOLE_GETALLALIASESLENGTH
, *PCONSOLE_GETALLALIASESLENGTH
;
606 } CONSOLE_GETALIASESEXES
, *PCONSOLE_GETALIASESEXES
;
611 } CONSOLE_GETALIASESEXESLENGTH
, *PCONSOLE_GETALIASESEXESLENGTH
;
617 UNICODE_STRING ExeName
;
620 } CONSOLE_GETCOMMANDHISTORY
, *PCONSOLE_GETCOMMANDHISTORY
;
624 UNICODE_STRING ExeName
;
626 } CONSOLE_GETCOMMANDHISTORYLENGTH
, *PCONSOLE_GETCOMMANDHISTORYLENGTH
;
630 UNICODE_STRING ExeName
;
631 } CONSOLE_EXPUNGECOMMANDHISTORY
, *PCONSOLE_EXPUNGECOMMANDHISTORY
;
635 UNICODE_STRING ExeName
;
637 } CONSOLE_SETHISTORYNUMBERCOMMANDS
, *PCONSOLE_SETHISTORYNUMBERCOMMANDS
;
641 UINT HistoryBufferSize
;
642 UINT NumberOfHistoryBuffers
;
644 } CONSOLE_GETSETHISTORYINFO
, *PCONSOLE_GETSETHISTORYINFO
;
652 } CONSOLE_GENERATECTRLEVENT
, *PCONSOLE_GENERATECTRLEVENT
;
657 DWORD NumInputEvents
;
658 } CONSOLE_GETNUMINPUTEVENTS
, *PCONSOLE_GETNUMINPUTEVENTS
;
664 } CONSOLE_SETSCREENBUFFERSIZE
, *PCONSOLE_SETSCREENBUFFERSIZE
;
668 CONSOLE_SELECTION_INFO Info
;
669 } CONSOLE_GETSELECTIONINFO
, *PCONSOLE_GETSELECTIONINFO
;
673 BOOL InputCP
; // TRUE : Input Code Page ; FALSE : Output Code Page
675 } CONSOLE_GETSETINPUTOUTPUTCP
, *PCONSOLE_GETSETINPUTOUTPUTCP
;
677 typedef struct _CONSOLE_API_MESSAGE
681 PCSR_CAPTURE_BUFFER CsrCaptureData
;
682 CSR_API_NUMBER ApiNumber
;
687 /* Console initialization and uninitialization */
688 CONSOLE_ALLOCCONSOLE AllocConsoleRequest
;
689 CONSOLE_ATTACHCONSOLE AttachConsoleRequest
;
690 CONSOLE_FREECONSOLE FreeConsoleRequest
;
693 CONSOLE_GETPROCESSLIST GetProcessListRequest
;
696 CONSOLE_OPENCONSOLE OpenConsoleRequest
;
697 CONSOLE_CLOSEHANDLE CloseHandleRequest
;
698 CONSOLE_VERIFYHANDLE VerifyHandleRequest
;
699 CONSOLE_DUPLICATEHANDLE DuplicateHandleRequest
;
702 CONSOLE_SHOWCURSOR ShowCursorRequest
;
703 CONSOLE_SETCURSOR SetCursorRequest
;
704 CONSOLE_GETSETCURSORINFO CursorInfoRequest
;
705 CONSOLE_SETCURSORPOSITION SetCursorPositionRequest
;
708 CONSOLE_CREATESCREENBUFFER CreateScreenBufferRequest
;
709 CONSOLE_SETACTIVESCREENBUFFER SetScreenBufferRequest
;
710 CONSOLE_GETSCREENBUFFERINFO ScreenBufferInfoRequest
;
711 CONSOLE_SETSCREENBUFFERSIZE SetScreenBufferSizeRequest
;
712 CONSOLE_SCROLLSCREENBUFFER ScrollScreenBufferRequest
;
714 CONSOLE_GETSELECTIONINFO GetSelectionInfoRequest
;
715 CONSOLE_FLUSHINPUTBUFFER FlushInputBufferRequest
;
718 CONSOLE_GETSETCONSOLEMODE ConsoleModeRequest
;
719 CONSOLE_GETDISPLAYMODE GetDisplayModeRequest
;
720 CONSOLE_SETDISPLAYMODE SetDisplayModeRequest
;
721 CONSOLE_GETSETHWSTATE HardwareStateRequest
;
724 CONSOLE_INVALIDATEDIBITS InvalidateDIBitsRequest
;
725 CONSOLE_SETPALETTE SetPaletteRequest
;
726 CONSOLE_GETSETCONSOLETITLE TitleRequest
;
727 CONSOLE_GETLARGESTWINDOWSIZE GetLargestWindowSizeRequest
;
728 CONSOLE_MENUCONTROL MenuControlRequest
;
729 CONSOLE_SETMENUCLOSE SetMenuCloseRequest
;
730 CONSOLE_SETWINDOWINFO SetWindowInfoRequest
;
731 CONSOLE_GETWINDOW GetWindowRequest
;
732 CONSOLE_SETICON SetIconRequest
;
735 CONSOLE_READCONSOLE ReadConsoleRequest
; // SrvReadConsole / ReadConsole
736 CONSOLE_GETINPUT GetInputRequest
; // SrvGetConsoleInput / PeekConsoleInput & ReadConsoleInput
737 CONSOLE_READOUTPUT ReadOutputRequest
; // SrvReadConsoleOutput / ReadConsoleOutput
738 CONSOLE_READOUTPUTCODE ReadOutputCodeRequest
; // SrvReadConsoleOutputString / ReadConsoleOutputAttribute & ReadConsoleOutputCharacter
741 CONSOLE_WRITECONSOLE WriteConsoleRequest
; // SrvWriteConsole / WriteConsole
742 CONSOLE_WRITEINPUT WriteInputRequest
;
743 CONSOLE_WRITEOUTPUT WriteOutputRequest
;
744 CONSOLE_WRITEOUTPUTCODE WriteOutputCodeRequest
;
746 CONSOLE_FILLOUTPUTCODE FillOutputRequest
;
747 CONSOLE_SETTEXTATTRIB SetTextAttribRequest
;
750 CONSOLE_ADDGETALIAS ConsoleAliasRequest
;
751 CONSOLE_GETALLALIASES GetAllAliasesRequest
;
752 CONSOLE_GETALLALIASESLENGTH GetAllAliasesLengthRequest
;
753 CONSOLE_GETALIASESEXES GetAliasesExesRequest
;
754 CONSOLE_GETALIASESEXESLENGTH GetAliasesExesLengthRequest
;
757 CONSOLE_GETCOMMANDHISTORY GetCommandHistoryRequest
;
758 CONSOLE_GETCOMMANDHISTORYLENGTH GetCommandHistoryLengthRequest
;
759 CONSOLE_EXPUNGECOMMANDHISTORY ExpungeCommandHistoryRequest
;
760 CONSOLE_SETHISTORYNUMBERCOMMANDS SetHistoryNumberCommandsRequest
;
761 CONSOLE_GETSETHISTORYINFO HistoryInfoRequest
;
763 CONSOLE_GENERATECTRLEVENT GenerateCtrlEventRequest
;
764 CONSOLE_GETNUMINPUTEVENTS GetNumInputEventsRequest
;
766 /* Input and Output Code Pages */
767 CONSOLE_GETSETINPUTOUTPUTCP ConsoleCPRequest
;
769 } CONSOLE_API_MESSAGE
, *PCONSOLE_API_MESSAGE
;
771 // Check that a CONSOLE_API_MESSAGE can hold in a CSR_API_MESSAGE.
772 CHECK_API_MSG_SIZE(CONSOLE_API_MESSAGE
);