2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Console Server DLL
4 * FILE: consrv/include/conio_winsrv.h
5 * PURPOSE: Public Console I/O Interface
6 * PROGRAMMERS: Gé van Geldorp
8 * Hermes Belusca-Maito (hermes.belusca@sfr.fr)
13 #define CSR_DEFAULT_CURSOR_SIZE 25
15 typedef struct _FRONTEND FRONTEND
, *PFRONTEND
;
16 /* HACK: */ typedef struct _CONSOLE_INFO
*PCONSOLE_INFO
;
17 typedef struct _FRONTEND_VTBL
19 // NTSTATUS (NTAPI *UnloadFrontEnd)(IN OUT PFRONTEND This);
22 * Internal interface (functions called by the console server only)
24 NTSTATUS (NTAPI
*InitFrontEnd
)(IN OUT PFRONTEND This
,
25 IN
struct _CONSOLE
* Console
);
26 VOID (NTAPI
*DeinitFrontEnd
)(IN OUT PFRONTEND This
);
28 /* Interface used for both text-mode and graphics screen buffers */
29 VOID (NTAPI
*DrawRegion
)(IN OUT PFRONTEND This
,
31 /* Interface used only for text-mode screen buffers */
32 VOID (NTAPI
*WriteStream
)(IN OUT PFRONTEND This
,
39 BOOL (NTAPI
*SetCursorInfo
)(IN OUT PFRONTEND This
,
40 PCONSOLE_SCREEN_BUFFER ScreenBuffer
);
41 BOOL (NTAPI
*SetScreenInfo
)(IN OUT PFRONTEND This
,
42 PCONSOLE_SCREEN_BUFFER ScreenBuffer
,
45 VOID (NTAPI
*ResizeTerminal
)(IN OUT PFRONTEND This
);
46 VOID (NTAPI
*SetActiveScreenBuffer
)(IN OUT PFRONTEND This
);
47 VOID (NTAPI
*ReleaseScreenBuffer
)(IN OUT PFRONTEND This
,
48 IN PCONSOLE_SCREEN_BUFFER ScreenBuffer
);
49 VOID (NTAPI
*RefreshInternalInfo
)(IN OUT PFRONTEND This
);
52 * External interface (functions corresponding to the Console API)
54 VOID (NTAPI
*ChangeTitle
)(IN OUT PFRONTEND This
);
55 BOOL (NTAPI
*ChangeIcon
)(IN OUT PFRONTEND This
,
57 HWND (NTAPI
*GetConsoleWindowHandle
)(IN OUT PFRONTEND This
);
58 VOID (NTAPI
*GetLargestConsoleWindowSize
)(IN OUT PFRONTEND This
,
60 BOOL (NTAPI
*GetSelectionInfo
)(IN OUT PFRONTEND This
,
61 PCONSOLE_SELECTION_INFO pSelectionInfo
);
62 BOOL (NTAPI
*SetPalette
)(IN OUT PFRONTEND This
,
63 HPALETTE PaletteHandle
,
65 ULONG (NTAPI
*GetDisplayMode
)(IN OUT PFRONTEND This
);
66 BOOL (NTAPI
*SetDisplayMode
)(IN OUT PFRONTEND This
,
68 INT (NTAPI
*ShowMouseCursor
)(IN OUT PFRONTEND This
,
70 BOOL (NTAPI
*SetMouseCursor
)(IN OUT PFRONTEND This
,
71 HCURSOR CursorHandle
);
72 HMENU (NTAPI
*MenuControl
)(IN OUT PFRONTEND This
,
75 BOOL (NTAPI
*SetMenuClose
)(IN OUT PFRONTEND This
,
77 } FRONTEND_VTBL
, *PFRONTEND_VTBL
;
81 PFRONTEND_VTBL Vtbl
; /* Virtual table */
82 NTSTATUS (NTAPI
*UnloadFrontEnd
)(IN OUT PFRONTEND This
);
84 struct _CONSOLE
* Console
; /* Console to which the frontend is attached to */
85 PVOID Data
; /* Private data */
86 PVOID OldData
; /* Reserved */
89 /* PauseFlags values (internal only) */
90 #define PAUSED_FROM_KEYBOARD 0x1
91 #define PAUSED_FROM_SCROLLBAR 0x2
92 #define PAUSED_FROM_SELECTION 0x4
94 typedef struct _WINSRV_CONSOLE
96 /******************************* Console Set-up *******************************/
97 /* This **MUST** be FIRST!! */
100 // LONG ReferenceCount; /* Is incremented each time a handle to something in the console (a screen-buffer or the input buffer of this console) gets referenced */
101 // CRITICAL_SECTION Lock;
102 // CONSOLE_STATE State; /* State of the console */
104 FRONTEND FrontEndIFace
; /* Frontend-specific interface */
106 /******************************* Process support ******************************/
107 LIST_ENTRY ProcessList
; /* List of processes owning the console. The first one is the so-called "Console Leader Process" */
108 PCONSOLE_PROCESS_DATA NotifiedLastCloseProcess
; /* Pointer to the unique process that needs to be notified when the console leader process is killed */
109 BOOLEAN NotifyLastClose
; /* TRUE if the console should send a control event when the console leader process is killed */
113 /******************************* Pausing support ******************************/
115 LIST_ENTRY ReadWaitQueue
; /* List head for the queue of unique input buffer read wait blocks */
116 LIST_ENTRY WriteWaitQueue
; /* List head for the queue of current screen-buffer write wait blocks */
118 /**************************** Aliases and Histories ***************************/
119 struct _ALIAS_HEADER
*Aliases
;
120 LIST_ENTRY HistoryBuffers
;
121 ULONG HistoryBufferSize
; /* Size for newly created history buffers */
122 ULONG NumberOfHistoryBuffers
; /* Maximum number of history buffers allowed */
123 BOOLEAN HistoryNoDup
; /* Remove old duplicate history entries */
125 } WINSRV_CONSOLE
, *PWINSRV_CONSOLE
;
128 VOID
ConioPause(PCONSOLE Console
, UINT Flags
);
129 VOID
ConioUnpause(PCONSOLE Console
, UINT Flags
);
131 PCONSOLE_PROCESS_DATA NTAPI
132 ConSrvGetConsoleLeaderProcess(IN PCONSOLE Console
);
134 ConSrvConsoleCtrlEvent(IN ULONG CtrlEvent
,
135 IN PCONSOLE_PROCESS_DATA ProcessData
);
137 ConSrvConsoleProcessCtrlEvent(IN PCONSOLE Console
,
138 IN ULONG ProcessGroupId
,
142 VOID NTAPI
ConioProcessKey(PCONSOLE Console
, MSG
* msg
);
143 NTSTATUS
ConioAddInputEvent(PCONSOLE Console
,
144 PINPUT_RECORD InputEvent
,
145 BOOLEAN AppendToEnd
);
146 NTSTATUS
ConioProcessInputEvent(PCONSOLE Console
,
147 PINPUT_RECORD InputEvent
);
150 #define ConioInitRect(Rect, top, left, bottom, right) \
152 ((Rect)->Top) = top; \
153 ((Rect)->Left) = left; \
154 ((Rect)->Bottom) = bottom; \
155 ((Rect)->Right) = right; \
157 #define ConioIsRectEmpty(Rect) \
158 (((Rect)->Left > (Rect)->Right) || ((Rect)->Top > (Rect)->Bottom))
159 #define ConioRectHeight(Rect) \
160 (((Rect)->Top) > ((Rect)->Bottom) ? 0 : ((Rect)->Bottom) - ((Rect)->Top) + 1)
161 #define ConioRectWidth(Rect) \
162 (((Rect)->Left) > ((Rect)->Right) ? 0 : ((Rect)->Right) - ((Rect)->Left) + 1)
166 * "The lpMultiByteStr and lpWideCharStr pointers must not be the same.
167 * If they are the same, the function fails, and GetLastError returns
168 * ERROR_INVALID_PARAMETER."
170 #define ConsoleUnicodeCharToAnsiChar(Console, dChar, sWChar) \
171 ASSERT((ULONG_PTR)dChar != (ULONG_PTR)sWChar); \
172 WideCharToMultiByte((Console)->OutputCodePage, 0, (sWChar), 1, (dChar), 1, NULL, NULL)
174 #define ConsoleAnsiCharToUnicodeChar(Console, dWChar, sChar) \
175 ASSERT((ULONG_PTR)dWChar != (ULONG_PTR)sChar); \
176 MultiByteToWideChar((Console)->OutputCodePage, 0, (sChar), 1, (dWChar), 1)
178 PCHAR_INFO
ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff
, ULONG X
, ULONG Y
);
179 VOID
ConioDrawConsole(PCONSOLE Console
);
180 NTSTATUS
ConioResizeBuffer(PCONSOLE Console
,
181 PTEXTMODE_SCREEN_BUFFER ScreenBuffer
,
183 NTSTATUS
ConioWriteConsole(PCONSOLE Console
,
184 PTEXTMODE_SCREEN_BUFFER Buff
,
188 DWORD
ConioEffectiveCursorSize(PCONSOLE Console
,