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

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS Console Server DLL
   4  * FILE:            consrv/include/conio.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 #include "rect.h"
  14
  15 // This is ALMOST a HACK!!!!!!!
  16 // Helpers for code refactoring
  17 #ifdef USE_NEW_CONSOLE_WAY
  18
  19 #define _CONSRV_CONSOLE  _WINSRV_CONSOLE
  20 #define  CONSRV_CONSOLE   WINSRV_CONSOLE
  21 #define PCONSRV_CONSOLE  PWINSRV_CONSOLE
  22
  23 #else
  24
  25 #define _CONSRV_CONSOLE  _CONSOLE
  26 #define  CONSRV_CONSOLE   CONSOLE
  27 #define PCONSRV_CONSOLE  PCONSOLE
  28
  29 #endif
  30
  31 /* Default attributes */
  32 #define DEFAULT_SCREEN_ATTRIB   (FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED)
  33 #define DEFAULT_POPUP_ATTRIB    (FOREGROUND_BLUE | FOREGROUND_RED   | \
  34                                  BACKGROUND_BLUE | BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_INTENSITY)
  35
  36
  37 /* Object type magic numbers */
  38 typedef enum _CONSOLE_IO_OBJECT_TYPE
  39 {
  40     UNKNOWN         = 0x00, // --> Unknown object
  41     TEXTMODE_BUFFER = 0x01, // --> Output-type object for text SBs
  42     GRAPHICS_BUFFER = 0x02, // --> Output-type object for graphics SBs
  43     SCREEN_BUFFER   = 0x03, // --> Any SB type
  44     INPUT_BUFFER    = 0x04, // --> Input-type object
  45     ANY_TYPE_BUFFER = 0x07, // --> Any IO object
  46 } CONSOLE_IO_OBJECT_TYPE;
  47
  48 typedef struct _CONSOLE_IO_OBJECT
  49 {
  50     CONSOLE_IO_OBJECT_TYPE Type;
  51
  52     struct _CONSOLE* /* PCONSOLE */ Console;
  53     LONG ReferenceCount;    /* Is incremented each time a console object gets referenced */
  54
  55     LONG AccessRead, AccessWrite;
  56     LONG ExclusiveRead, ExclusiveWrite;
  57 } CONSOLE_IO_OBJECT, *PCONSOLE_IO_OBJECT;
  58
  59
  60 /******************************************************************************\
  61 |*                                                                            *|
  62 |*     Abstract "class" for screen-buffers, be they text-mode or graphics     *|
  63 |*                                                                            *|
  64 \******************************************************************************/
  65
  66 /*
  67  * See conoutput.c for the implementation
  68  */
  69
  70 typedef struct _CONSOLE_SCREEN_BUFFER CONSOLE_SCREEN_BUFFER,
  71                                     *PCONSOLE_SCREEN_BUFFER;
  72
  73 typedef struct _CONSOLE_SCREEN_BUFFER_VTBL
  74 {
  75     CONSOLE_IO_OBJECT_TYPE (*GetType)(PCONSOLE_SCREEN_BUFFER This);
  76 } CONSOLE_SCREEN_BUFFER_VTBL, *PCONSOLE_SCREEN_BUFFER_VTBL;
  77
  78 #define GetType(This)   (This)->Vtbl->GetType(This)
  79
  80 struct _CONSOLE_SCREEN_BUFFER
  81 {
  82     CONSOLE_IO_OBJECT Header;           /* Object header - MUST BE IN FIRST PLACE */
  83     PCONSOLE_SCREEN_BUFFER_VTBL Vtbl;   /* Virtual table */
  84
  85     LIST_ENTRY ListEntry;               /* Entry in console's list of buffers */
  86
  87     COORD   ScreenBufferSize;           /* Size of this screen buffer. (Rows, Columns) for text-mode and (Width, Height) for graphics-mode */
  88     COORD   ViewSize;                   /* Associated "view" (i.e. console) size */
  89
  90     COORD   OldScreenBufferSize;        /* Old size of this screen buffer */
  91     COORD   OldViewSize;                /* Old associated view size */
  92
  93     COORD   ViewOrigin;                 /* Beginning offset for the actual display area */
  94
  95 /***** Put that VV in TEXTMODE_SCREEN_BUFFER ?? *****/
  96     USHORT  VirtualY;                   /* Top row of buffer being displayed, reported to callers */
  97
  98     COORD   CursorPosition;             /* Current cursor position */
  99     BOOLEAN CursorBlinkOn;
 100     BOOLEAN ForceCursorOff;
 101 //  ULONG   CursorSize;
 102     CONSOLE_CURSOR_INFO CursorInfo; // FIXME: Keep this member or not ??
 103 /*********************************************/
 104
 105     HPALETTE PaletteHandle;             /* Handle to the color palette associated to this buffer */
 106     UINT     PaletteUsage;              /* The new use of the system palette. See SetSystemPaletteUse 'uUsage' parameter */
 107
 108 //  WORD   ScreenDefaultAttrib;         /* Default screen char attribute */
 109 //  WORD   PopupDefaultAttrib;          /* Default popup char attribute */
 110     USHORT Mode;                        /* Output buffer modes */
 111
 112     // PVOID Data;                         /* Private data for the frontend to use */
 113 };
 114
 115
 116
 117 /******************************************************************************\
 118 |*                                                                            *|
 119 |*           Text-mode and graphics-mode screen-buffer "classes"              *|
 120 |*                                                                            *|
 121 \******************************************************************************/
 122
 123 /*
 124  * See text.c for the implementation
 125  */
 126
 127 /************************************************************************
 128  * Screen buffer structure represents the win32 screen buffer object.   *
 129  * Internally, the portion of the buffer being shown CAN loop past the  *
 130  * bottom of the virtual buffer and wrap around to the top.  Win32 does *
 131  * not do this.  I decided to do this because it eliminates the need to *
 132  * do a massive memcpy() to scroll the contents of the buffer up to     *
 133  * scroll the screen on output, instead I just shift down the position  *
 134  * to be displayed, and let it wrap around to the top again.            *
 135  * The VirtualY member keeps track of the top Y coord that win32        *
 136  * clients THINK is currently being displayed, because they think that  *
 137  * when the display reaches the bottom of the buffer and another line   *
 138  * being printed causes another line to scroll down, that the buffer IS *
 139  * memcpy()'s up, and the bottom of the buffer is still displayed, but  *
 140  * internally, I just wrap back to the top of the buffer.               *
 141  ************************************************************************/
 142
 143 typedef struct _TEXTMODE_BUFFER_INFO
 144 {
 145     COORD   ScreenBufferSize;
 146     USHORT  ScreenAttrib;
 147     USHORT  PopupAttrib;
 148     ULONG   CursorSize;
 149     BOOLEAN IsCursorVisible;
 150 } TEXTMODE_BUFFER_INFO, *PTEXTMODE_BUFFER_INFO;
 151
 152 typedef struct _TEXTMODE_SCREEN_BUFFER
 153 {
 154     CONSOLE_SCREEN_BUFFER;      /* Screen buffer base class - MUST BE IN FIRST PLACE */
 155
 156     PCHAR_INFO Buffer;          /* Pointer to UNICODE screen buffer (Buffer->Char.UnicodeChar only is valid, not Char.AsciiChar) */
 157
 158     WORD ScreenDefaultAttrib;   /* Default screen char attribute */
 159     WORD PopupDefaultAttrib;    /* Default popup char attribute */
 160 } TEXTMODE_SCREEN_BUFFER, *PTEXTMODE_SCREEN_BUFFER;
 161
 162
 163 /*
 164  * See graphics.c for the implementation
 165  */
 166
 167 typedef struct _GRAPHICS_BUFFER_INFO
 168 {
 169     CONSOLE_GRAPHICS_BUFFER_INFO Info;
 170 } GRAPHICS_BUFFER_INFO, *PGRAPHICS_BUFFER_INFO;
 171
 172 typedef struct _GRAPHICS_SCREEN_BUFFER
 173 {
 174     CONSOLE_SCREEN_BUFFER;          /* Screen buffer base class - MUST BE IN FIRST PLACE */
 175
 176     ULONG   BitMapInfoLength;       /* Real size of the structure pointed by BitMapInfo */
 177     LPBITMAPINFO BitMapInfo;        /* Information on the bitmap buffer */
 178     ULONG   BitMapUsage;            /* See the uUsage parameter of GetDIBits */
 179     HANDLE  hSection;               /* Handle to the memory shared section for the bitmap buffer */
 180     PVOID   BitMap;                 /* Our bitmap buffer */
 181
 182     PVOID   ClientBitMap;           /* A copy of the client view of our bitmap buffer */
 183     HANDLE  Mutex;                  /* Our mutex, used to synchronize read / writes to the bitmap buffer */
 184     HANDLE  ClientMutex;            /* A copy of the client handle to our mutex */
 185     HANDLE  ClientProcess;          /* Handle to the client process who opened the buffer, to unmap the view */
 186 } GRAPHICS_SCREEN_BUFFER, *PGRAPHICS_SCREEN_BUFFER;
 187
 188
 189
 190 typedef struct _CONSOLE_INPUT_BUFFER
 191 {
 192     CONSOLE_IO_OBJECT Header;       /* Object header - MUST BE IN FIRST PLACE */
 193
 194     ULONG       InputBufferSize;    /* Size of this input buffer */
 195     LIST_ENTRY  InputEvents;        /* List head for input event queue */
 196     HANDLE      ActiveEvent;        /* Event set when an input event is added in its queue */
 197
 198     USHORT      Mode;               /* Input buffer modes */
 199 } CONSOLE_INPUT_BUFFER, *PCONSOLE_INPUT_BUFFER;
 200
 201
 202 typedef struct _TERMINAL TERMINAL, *PTERMINAL;
 203 /* HACK: */ typedef struct _CONSOLE_INFO *PCONSOLE_INFO;
 204 typedef struct _TERMINAL_VTBL
 205 {
 206     /*
 207      * Internal interface (functions called by the console server only)
 208      */
 209     NTSTATUS (NTAPI *InitTerminal)(IN OUT PTERMINAL This,
 210                                    IN struct _CONSOLE* Console);
 211     VOID (NTAPI *DeinitTerminal)(IN OUT PTERMINAL This);
 212
 213
 214
 215 /************ Line discipline ***************/
 216
 217     /* Interface used only for text-mode screen buffers */
 218
 219     NTSTATUS (NTAPI *ReadStream)(IN OUT PTERMINAL This,
 220                                 /**/IN PUNICODE_STRING ExeName /**/OPTIONAL/**/,/**/
 221                                 IN BOOLEAN Unicode,
 222                                 /**PWCHAR Buffer,**/
 223                                 OUT PVOID Buffer,
 224                                 IN OUT PCONSOLE_READCONSOLE_CONTROL ReadControl,
 225                                 IN ULONG NumCharsToRead,
 226                                 OUT PULONG NumCharsRead OPTIONAL);
 227     NTSTATUS (NTAPI *WriteStream)(IN OUT PTERMINAL This,
 228                                   PTEXTMODE_SCREEN_BUFFER Buff,
 229                                   PWCHAR Buffer,
 230                                   DWORD Length,
 231                                   BOOL Attrib);
 232
 233 /************ Line discipline ***************/
 234
 235
 236
 237     /* Interface used for both text-mode and graphics screen buffers */
 238     VOID (NTAPI *DrawRegion)(IN OUT PTERMINAL This,
 239                              SMALL_RECT* Region);
 240     BOOL (NTAPI *SetCursorInfo)(IN OUT PTERMINAL This,
 241                                 PCONSOLE_SCREEN_BUFFER ScreenBuffer);
 242     BOOL (NTAPI *SetScreenInfo)(IN OUT PTERMINAL This,
 243                                 PCONSOLE_SCREEN_BUFFER ScreenBuffer,
 244                                 SHORT OldCursorX,
 245                                 SHORT OldCursorY);
 246     VOID (NTAPI *ResizeTerminal)(IN OUT PTERMINAL This);
 247     VOID (NTAPI *SetActiveScreenBuffer)(IN OUT PTERMINAL This);
 248     VOID (NTAPI *ReleaseScreenBuffer)(IN OUT PTERMINAL This,
 249                                       IN PCONSOLE_SCREEN_BUFFER ScreenBuffer);
 250
 251     /*
 252      * External interface (functions corresponding to the Console API)
 253      */
 254     VOID (NTAPI *ChangeTitle)(IN OUT PTERMINAL This);
 255     VOID (NTAPI *GetLargestConsoleWindowSize)(IN OUT PTERMINAL This,
 256                                               PCOORD pSize);
 257     BOOL (NTAPI *SetPalette)(IN OUT PTERMINAL This,
 258                              HPALETTE PaletteHandle,
 259                              UINT PaletteUsage);
 260     INT   (NTAPI *ShowMouseCursor)(IN OUT PTERMINAL This,
 261                                    BOOL Show);
 262
 263 #if 0 // Possible future front-end interface
 264     BOOL (NTAPI *GetTerminalProperty)(IN OUT PTERMINAL This,
 265                                       ULONG Flag,
 266                                       PVOID Info,
 267                                       ULONG Size);
 268     BOOL (NTAPI *SetTerminalProperty)(IN OUT PTERMINAL This,
 269                                       ULONG Flag,
 270                                       PVOID Info /*,
 271                                       ULONG Size */);
 272 #endif
 273 } TERMINAL_VTBL, *PTERMINAL_VTBL;
 274
 275 struct _TERMINAL
 276 {
 277     PTERMINAL_VTBL Vtbl;        /* Virtual table */
 278     struct _CONSOLE* Console;   /* Console to which the frontend is attached to */
 279     PVOID Data;                 /* Private data  */
 280 };
 281
 282 /*
 283  * WARNING: Change the state of the console ONLY when the console is locked !
 284  */
 285 typedef enum _CONSOLE_STATE
 286 {
 287     CONSOLE_INITIALIZING,   /* Console is initializing */
 288     CONSOLE_RUNNING     ,   /* Console running */
 289     CONSOLE_TERMINATING ,   /* Console about to be destroyed (but still not) */
 290     CONSOLE_IN_DESTRUCTION  /* Console in destruction */
 291 } CONSOLE_STATE, *PCONSOLE_STATE;
 292
 293 // HACK!!
 294 struct _CONSOLE;
 295 /* HACK: */ typedef struct _CONSOLE *PCONSOLE;
 296 #ifndef USE_NEW_CONSOLE_WAY
 297 #include "conio_winsrv.h"
 298 #endif
 299
 300 typedef struct _CONSOLE
 301 {
 302 /******************************* Console Set-up *******************************/
 303
 304 #ifndef USE_NEW_CONSOLE_WAY
 305     WINSRV_CONSOLE; // HACK HACK!!
 306 #endif
 307
 308     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 */
 309     CRITICAL_SECTION Lock;
 310
 311     CONSOLE_STATE State;                    /* State of the console */
 312     TERMINAL TermIFace;                     /* Frontend-specific interface */
 313
 314     ULONG ConsoleID;                        /* The ID of the console */
 315     LIST_ENTRY ListEntry;                   /* Entry in the list of consoles */
 316
 317     HANDLE UnpauseEvent;                    /* When != NULL, event for pausing the console */
 318
 319 /******************************** Input buffer ********************************/
 320     CONSOLE_INPUT_BUFFER InputBuffer;       /* Input buffer of the console */
 321     UINT InputCodePage;
 322
 323 /******************************* Screen buffers *******************************/
 324     LIST_ENTRY BufferList;                  /* List of all screen buffers for this console */
 325     PCONSOLE_SCREEN_BUFFER ActiveBuffer;    /* Pointer to currently active screen buffer */
 326     UINT OutputCodePage;
 327
 328 /****************************** Other properties ******************************/
 329     UNICODE_STRING OriginalTitle;           /* Original title of console, the one defined when the console leader is launched; it never changes. Always NULL-terminated */
 330     UNICODE_STRING Title;                   /* Title of console. Always NULL-terminated */
 331
 332     COORD   ConsoleSize;                    /* The current size of the console, for text-mode only */
 333     BOOLEAN FixedSize;                      /* TRUE if the console is of fixed size */
 334
 335 } CONSOLE; // , *PCONSOLE;
 336
 337 /* console.c */
 338 VOID NTAPI
 339 ConDrvPause(PCONSOLE Console);
 340 VOID NTAPI
 341 ConDrvUnpause(PCONSOLE Console);
 342
 343 NTSTATUS
 344 ConSrvConsoleCtrlEvent(IN ULONG CtrlEvent,
 345                        IN PCONSOLE_PROCESS_DATA ProcessData);
 346
 347 /* conoutput.c */
 348 PCHAR_INFO ConioCoordToPointer(PTEXTMODE_SCREEN_BUFFER Buff, ULONG X, ULONG Y);
 349 VOID ConioDrawConsole(PCONSOLE /*PCONSRV_CONSOLE*/ Console);
 350 NTSTATUS ConioResizeBuffer(PCONSOLE /*PCONSRV_CONSOLE*/ Console,
 351                            PTEXTMODE_SCREEN_BUFFER ScreenBuffer,
 352                            COORD Size);
 353
 354 /* EOF */