win32ss/user/winsrv/consrv/include/conio_winsrv.h

   1 /*
   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
   7  *                  Jeffrey Morlan
   8  *                  Hermes Belusca-Maito (hermes.belusca@sfr.fr)
   9  */
  10
  11 #pragma once
  12
  13 #define CSR_DEFAULT_CURSOR_SIZE 25
  14
  15 typedef struct _FRONTEND FRONTEND, *PFRONTEND;
  16 /* HACK: */ typedef struct _CONSOLE_INFO *PCONSOLE_INFO;
  17 typedef struct _FRONTEND_VTBL
  18 {
  19     // NTSTATUS (NTAPI *UnloadFrontEnd)(IN OUT PFRONTEND This);
  20
  21     /*
  22      * Internal interface (functions called by the console server only)
  23      */
  24     NTSTATUS (NTAPI *InitFrontEnd)(IN OUT PFRONTEND This,
  25                                    IN struct _CONSOLE* Console);
  26     VOID (NTAPI *DeinitFrontEnd)(IN OUT PFRONTEND This);
  27
  28     /* Interface used for both text-mode and graphics screen buffers */
  29     VOID (NTAPI *DrawRegion)(IN OUT PFRONTEND This,
  30                              SMALL_RECT* Region);
  31     /* Interface used only for text-mode screen buffers */
  32     VOID (NTAPI *WriteStream)(IN OUT PFRONTEND This,
  33                               SMALL_RECT* Region,
  34                               SHORT CursorStartX,
  35                               SHORT CursorStartY,
  36                               UINT ScrolledLines,
  37                               PWCHAR Buffer,
  38                               UINT Length);
  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,
  43                                 SHORT OldCursorX,
  44                                 SHORT OldCursorY);
  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     BOOL (NTAPI *ProcessKeyCallback)(IN OUT PFRONTEND This,
  50                                      MSG* msg,
  51                                      BYTE KeyStateMenu,
  52                                      DWORD ShiftState,
  53                                      UINT VirtualKeyCode,
  54                                      BOOL Down);
  55     VOID (NTAPI *RefreshInternalInfo)(IN OUT PFRONTEND This);
  56
  57     /*
  58      * External interface (functions corresponding to the Console API)
  59      */
  60     VOID (NTAPI *ChangeTitle)(IN OUT PFRONTEND This);
  61     BOOL (NTAPI *ChangeIcon)(IN OUT PFRONTEND This,
  62                              HICON IconHandle);
  63     HWND (NTAPI *GetConsoleWindowHandle)(IN OUT PFRONTEND This);
  64     VOID (NTAPI *GetLargestConsoleWindowSize)(IN OUT PFRONTEND This,
  65                                               PCOORD pSize);
  66     BOOL (NTAPI *GetSelectionInfo)(IN OUT PFRONTEND This,
  67                                    PCONSOLE_SELECTION_INFO pSelectionInfo);
  68     BOOL (NTAPI *SetPalette)(IN OUT PFRONTEND This,
  69                              HPALETTE PaletteHandle,
  70                              UINT PaletteUsage);
  71     ULONG (NTAPI *GetDisplayMode)(IN OUT PFRONTEND This);
  72     BOOL  (NTAPI *SetDisplayMode)(IN OUT PFRONTEND This,
  73                                   ULONG NewMode);
  74     INT   (NTAPI *ShowMouseCursor)(IN OUT PFRONTEND This,
  75                                    BOOL Show);
  76     BOOL  (NTAPI *SetMouseCursor)(IN OUT PFRONTEND This,
  77                                   HCURSOR CursorHandle);
  78     HMENU (NTAPI *MenuControl)(IN OUT PFRONTEND This,
  79                                UINT CmdIdLow,
  80                                UINT CmdIdHigh);
  81     BOOL  (NTAPI *SetMenuClose)(IN OUT PFRONTEND This,
  82                                 BOOL Enable);
  83 } FRONTEND_VTBL, *PFRONTEND_VTBL;
  84
  85 struct _FRONTEND
  86 {
  87     PFRONTEND_VTBL Vtbl;        /* Virtual table */
  88     NTSTATUS (NTAPI *UnloadFrontEnd)(IN OUT PFRONTEND This);
  89
  90     struct _CONSOLE* Console;   /* Console to which the frontend is attached to */
  91     PVOID Data;                 /* Private data  */
  92     PVOID OldData;              /* Reserved      */
  93 };
  94
  95 /* PauseFlags values (internal only) */
  96 #define PAUSED_FROM_KEYBOARD  0x1
  97 #define PAUSED_FROM_SCROLLBAR 0x2
  98 #define PAUSED_FROM_SELECTION 0x4
  99
 100 typedef struct _WINSRV_CONSOLE
 101 {
 102 /******************************* Console Set-up *******************************/
 103     /* This **MUST** be FIRST!! */
 104     // CONSOLE;
 105
 106     // 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 */
 107     // CRITICAL_SECTION Lock;
 108     // CONSOLE_STATE State;                    /* State of the console */
 109
 110     FRONTEND FrontEndIFace;                     /* Frontend-specific interface */
 111
 112 /******************************* Process support ******************************/
 113     LIST_ENTRY ProcessList;         /* List of processes owning the console. The first one is the so-called "Console Leader Process" */
 114     PCONSOLE_PROCESS_DATA NotifiedLastCloseProcess; /* Pointer to the unique process that needs to be notified when the console leader process is killed */
 115     BOOLEAN NotifyLastClose;        /* TRUE if the console should send a control event when the console leader process is killed */
 116
 117     BOOLEAN QuickEdit;
 118
 119 /******************************* Pausing support ******************************/
 120     BYTE PauseFlags;
 121     LIST_ENTRY  ReadWaitQueue;      /* List head for the queue of unique input buffer read wait blocks */
 122     LIST_ENTRY WriteWaitQueue;      /* List head for the queue of current screen-buffer write wait blocks */
 123
 124 /**************************** Aliases and Histories ***************************/
 125     struct _ALIAS_HEADER *Aliases;
 126     LIST_ENTRY HistoryBuffers;
 127     ULONG HistoryBufferSize;                /* Size for newly created history buffers */
 128     ULONG NumberOfHistoryBuffers;           /* Maximum number of history buffers allowed */
 129     BOOLEAN HistoryNoDup;                   /* Remove old duplicate history entries */
 130
 131 } WINSRV_CONSOLE, *PWINSRV_CONSOLE;
 132
 133 /* console.c */
 134 VOID ConioPause(PCONSOLE Console, UINT Flags);
 135 VOID ConioUnpause(PCONSOLE Console, UINT Flags);
 136
 137 PCONSOLE_PROCESS_DATA NTAPI
 138 ConSrvGetConsoleLeaderProcess(IN PCONSOLE Console);
 139 NTSTATUS
 140 ConSrvConsoleCtrlEvent(IN ULONG CtrlEvent,
 141                        IN PCONSOLE_PROCESS_DATA ProcessData);
 142 NTSTATUS NTAPI
 143 ConSrvConsoleProcessCtrlEvent(IN PCONSOLE Console,
 144                               IN ULONG ProcessGroupId,
 145                               IN ULONG CtrlEvent);
 146
 147 /* coninput.c */
 148 VOID NTAPI ConioProcessKey(PCONSOLE Console, MSG* msg);
 149 NTSTATUS ConioAddInputEvent(PCONSOLE Console,
 150                                      PINPUT_RECORD InputEvent,
 151                                      BOOLEAN AppendToEnd);
 152 NTSTATUS ConioProcessInputEvent(PCONSOLE Console,
 153                                          PINPUT_RECORD InputEvent);
 154
 155 /* conoutput.c */
 156 #define ConioInitRect(Rect, top, left, bottom, right) \
 157 do {    \
 158     ((Rect)->Top) = top;    \
 159     ((Rect)->Left) = left;  \
 160     ((Rect)->Bottom) = bottom;  \
 161     ((Rect)->Right) = right;    \
 162 } while (0)
 163 #define ConioIsRectEmpty(Rect) \
 164     (((Rect)->Left > (Rect)->Right) || ((Rect)->Top > (Rect)->Bottom))
 165 #define ConioRectHeight(Rect) \
 166     (((Rect)->Top) > ((Rect)->Bottom) ? 0 : ((Rect)->Bottom) - ((Rect)->Top) + 1)
 167 #define ConioRectWidth(Rect) \
 168     (((Rect)->Left) > ((Rect)->Right) ? 0 : ((Rect)->Right) - ((Rect)->Left) + 1)
 169
 170 #define ConsoleUnicodeCharToAnsiChar(Console, dChar, sWChar) \
 171     WideCharToMultiByte((Console)->OutputCodePage, 0, (sWChar), 1, (dChar), 1, NULL, NULL)
 172
 173 #define ConsoleAnsiCharToUnicodeChar(Console, dWChar, sChar) \
 174     MultiByteToWideChar((Console)->OutputCodePage, 0, (sChar), 1, (dWChar), 1)
 175
 176 PCHAR_INFO ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff, ULONG X, ULONG Y);
 177 VOID ConioDrawConsole(PCONSOLE Console);
 178 NTSTATUS ConioResizeBuffer(PCONSOLE Console,
 179                            PTEXTMODE_SCREEN_BUFFER ScreenBuffer,
 180                            COORD Size);
 181 NTSTATUS ConioWriteConsole(PCONSOLE Console,
 182                            PTEXTMODE_SCREEN_BUFFER Buff,
 183                            PWCHAR Buffer,
 184                            DWORD Length,
 185                            BOOL Attrib);
 186 DWORD ConioEffectiveCursorSize(PCONSOLE Console,
 187                                         DWORD Scale);
 188
 189 /* EOF */