mirror of
https://github.com/reactos/reactos.git
synced 2024-10-09 10:48:55 +00:00
e1f0919480
- Compile with Vista+ defines. - Add basic mouse events support. Tested with Far Manager. svn path=/branches/ros-csrss/; revision=58620
283 lines
14 KiB
C
283 lines
14 KiB
C
/*
|
|
* COPYRIGHT: See COPYING in the top level directory
|
|
* PROJECT: ReactOS Console Server DLL
|
|
* FILE: win32ss/user/consrv/conio.h
|
|
* PURPOSE: Internal console I/O interface
|
|
* PROGRAMMERS:
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#define CSR_DEFAULT_CURSOR_SIZE 25
|
|
#define CURSOR_BLINK_TIME 500
|
|
|
|
/* Default attributes */
|
|
#define DEFAULT_SCREEN_ATTRIB (FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED)
|
|
#define DEFAULT_POPUP_ATTRIB (FOREGROUND_BLUE | FOREGROUND_RED | \
|
|
BACKGROUND_BLUE | BACKGROUND_GREEN | BACKGROUND_RED | BACKGROUND_INTENSITY)
|
|
|
|
|
|
/************************************************************************
|
|
* Screen buffer structure represents the win32 screen buffer object. *
|
|
* Internally, the portion of the buffer being shown CAN loop past the *
|
|
* bottom of the virtual buffer and wrap around to the top. Win32 does *
|
|
* not do this. I decided to do this because it eliminates the need to *
|
|
* do a massive memcpy() to scroll the contents of the buffer up to *
|
|
* scroll the screen on output, instead I just shift down the position *
|
|
* to be displayed, and let it wrap around to the top again. *
|
|
* The VirtualY member keeps track of the top Y coord that win32 *
|
|
* clients THINK is currently being displayed, because they think that *
|
|
* when the display reaches the bottom of the buffer and another line *
|
|
* being printed causes another line to scroll down, that the buffer IS *
|
|
* memcpy()'s up, and the bottom of the buffer is still displayed, but *
|
|
* internally, I just wrap back to the top of the buffer. *
|
|
************************************************************************/
|
|
|
|
typedef struct _CONSOLE_SCREEN_BUFFER
|
|
{
|
|
Object_t Header; /* Object header */
|
|
LIST_ENTRY ListEntry; /* Entry in console's list of buffers */
|
|
|
|
BYTE *Buffer; /* CHAR_INFO */ /* Pointer to screen buffer */
|
|
|
|
COORD ScreenBufferSize; /* Size of this screen buffer */
|
|
COORD CursorPosition; /* Current cursor position */
|
|
|
|
USHORT ShowX, ShowY; /* Beginning offset for the actual display area */
|
|
USHORT VirtualY; /* Top row of buffer being displayed, reported to callers */
|
|
|
|
BOOLEAN CursorBlinkOn;
|
|
BOOLEAN ForceCursorOff;
|
|
ULONG CursorSize;
|
|
CONSOLE_CURSOR_INFO CursorInfo; // FIXME: Keep this member or not ??
|
|
|
|
WORD ScreenDefaultAttrib; /* Default screen char attribute */
|
|
WORD PopupDefaultAttrib; /* Default popup char attribute */
|
|
USHORT Mode;
|
|
} CONSOLE_SCREEN_BUFFER, *PCONSOLE_SCREEN_BUFFER;
|
|
|
|
typedef struct _CONSOLE_INPUT_BUFFER
|
|
{
|
|
Object_t Header; /* Object header */
|
|
|
|
ULONG InputBufferSize; /* Size of this input buffer */
|
|
LIST_ENTRY InputEvents; /* List head for input event queue */
|
|
HANDLE ActiveEvent; /* Event set when an input event is added in its queue */
|
|
LIST_ENTRY ReadWaitQueue; /* List head for the queue of read wait blocks */
|
|
|
|
USHORT Mode; /* Console Input Buffer mode flags */
|
|
} CONSOLE_INPUT_BUFFER, *PCONSOLE_INPUT_BUFFER;
|
|
|
|
typedef struct ConsoleInput_t
|
|
{
|
|
LIST_ENTRY ListEntry;
|
|
INPUT_RECORD InputEvent;
|
|
} ConsoleInput;
|
|
|
|
typedef struct _FRONTEND_VTBL
|
|
{
|
|
/*
|
|
* Internal interface (functions called by the console server only)
|
|
*/
|
|
VOID (WINAPI *CleanupConsole)(struct _CONSOLE* Console);
|
|
VOID (WINAPI *WriteStream)(struct _CONSOLE* Console,
|
|
SMALL_RECT* Block,
|
|
LONG CursorStartX,
|
|
LONG CursorStartY,
|
|
UINT ScrolledLines,
|
|
CHAR *Buffer,
|
|
UINT Length);
|
|
VOID (WINAPI *DrawRegion)(struct _CONSOLE* Console,
|
|
SMALL_RECT* Region);
|
|
BOOL (WINAPI *SetCursorInfo)(struct _CONSOLE* Console,
|
|
PCONSOLE_SCREEN_BUFFER ScreenBuffer);
|
|
BOOL (WINAPI *SetScreenInfo)(struct _CONSOLE* Console,
|
|
PCONSOLE_SCREEN_BUFFER ScreenBuffer,
|
|
UINT OldCursorX,
|
|
UINT OldCursorY);
|
|
BOOL (WINAPI *UpdateScreenInfo)(struct _CONSOLE* Console,
|
|
PCONSOLE_SCREEN_BUFFER ScreenBuffer);
|
|
NTSTATUS (WINAPI *ResizeBuffer)(struct _CONSOLE* Console,
|
|
PCONSOLE_SCREEN_BUFFER ScreenBuffer,
|
|
COORD Size);
|
|
VOID (WINAPI *ResizeTerminal)(struct _CONSOLE* Console);
|
|
BOOL (WINAPI *ProcessKeyCallback)(struct _CONSOLE* Console,
|
|
MSG* msg,
|
|
BYTE KeyStateMenu,
|
|
DWORD ShiftState,
|
|
UINT VirtualKeyCode,
|
|
BOOL Down);
|
|
VOID (WINAPI *RefreshInternalInfo)(struct _CONSOLE* Console);
|
|
|
|
/*
|
|
* External interface (functions corresponding to the Console API)
|
|
*/
|
|
VOID (WINAPI *ChangeTitle)(struct _CONSOLE* Console);
|
|
BOOL (WINAPI *ChangeIcon)(struct _CONSOLE* Console,
|
|
HICON hWindowIcon);
|
|
HWND (WINAPI *GetConsoleWindowHandle)(struct _CONSOLE* Console);
|
|
|
|
} FRONTEND_VTBL, *PFRONTEND_VTBL;
|
|
|
|
#define ConioDrawRegion(Console, Region) (Console)->TermIFace.Vtbl->DrawRegion((Console), (Region))
|
|
#define ConioWriteStream(Console, Block, CurStartX, CurStartY, ScrolledLines, Buffer, Length) \
|
|
(Console)->TermIFace.Vtbl->WriteStream((Console), (Block), (CurStartX), (CurStartY), \
|
|
(ScrolledLines), (Buffer), (Length))
|
|
#define ConioSetCursorInfo(Console, Buff) (Console)->TermIFace.Vtbl->SetCursorInfo((Console), (Buff))
|
|
#define ConioSetScreenInfo(Console, Buff, OldCursorX, OldCursorY) \
|
|
(Console)->TermIFace.Vtbl->SetScreenInfo((Console), (Buff), (OldCursorX), (OldCursorY))
|
|
#define ConioUpdateScreenInfo(Console, Buff) \
|
|
(Console)->TermIFace.Vtbl->UpdateScreenInfo((Console), (Buff))
|
|
#define ConioChangeTitle(Console) (Console)->TermIFace.Vtbl->ChangeTitle(Console)
|
|
#define ConioCleanupConsole(Console) (Console)->TermIFace.Vtbl->CleanupConsole(Console)
|
|
#define ConioChangeIcon(Console, hWindowIcon) (Console)->TermIFace.Vtbl->ChangeIcon((Console), (hWindowIcon))
|
|
#define ConioResizeBuffer(Console, Buff, Size) (Console)->TermIFace.Vtbl->ResizeBuffer((Console), (Buff), (Size))
|
|
#define ConioResizeTerminal(Console) (Console)->TermIFace.Vtbl->ResizeTerminal((Console))
|
|
#define ConioProcessKeyCallback(Console, Msg, KeyStateMenu, ShiftState, VirtualKeyCode, Down) \
|
|
(Console)->TermIFace.Vtbl->ProcessKeyCallback((Console), (Msg), (KeyStateMenu), (ShiftState), (VirtualKeyCode), (Down))
|
|
#define ConioGetConsoleWindowHandle(Console) \
|
|
(Console)->TermIFace.Vtbl->GetConsoleWindowHandle((Console))
|
|
#define ConioRefreshInternalInfo(Console) \
|
|
(Console)->TermIFace.Vtbl->RefreshInternalInfo((Console))
|
|
|
|
typedef struct _FRONTEND_IFACE
|
|
{
|
|
PFRONTEND_VTBL Vtbl; /* Virtual table */
|
|
PVOID Data; /* Private data */
|
|
PVOID OldData; /* Reserved */
|
|
} FRONTEND_IFACE, *PFRONTEND_IFACE;
|
|
|
|
#if 0 // Temporarily put in consrv.h
|
|
/*
|
|
* WARNING: Change the state of the console ONLY when the console is locked !
|
|
*/
|
|
typedef enum _CONSOLE_STATE
|
|
{
|
|
CONSOLE_INITIALIZING, /* Console is initializing */
|
|
CONSOLE_RUNNING , /* Console running */
|
|
CONSOLE_TERMINATING , /* Console about to be destroyed (but still not) */
|
|
CONSOLE_IN_DESTRUCTION /* Console in destruction */
|
|
} CONSOLE_STATE, *PCONSOLE_STATE;
|
|
#endif
|
|
|
|
typedef struct _CONSOLE
|
|
{
|
|
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 */
|
|
CRITICAL_SECTION Lock;
|
|
CONSOLE_STATE State; /* State of the console */
|
|
|
|
// struct _CONSOLE *Prev, *Next; /* Next and Prev consoles in console wheel */
|
|
LIST_ENTRY Entry; /* Entry in the list of consoles */
|
|
LIST_ENTRY ProcessList; /* List of processes owning the console. The first one is the so-called "Console Leader Process" */
|
|
|
|
FRONTEND_IFACE TermIFace; /* Frontend-specific interface */
|
|
|
|
/**************************** Input buffer and data ***************************/
|
|
CONSOLE_INPUT_BUFFER InputBuffer; /* Input buffer of the console */
|
|
|
|
PWCHAR LineBuffer; /* Current line being input, in line buffered mode */
|
|
WORD LineMaxSize; /* Maximum size of line in characters (including CR+LF) */
|
|
WORD LineSize; /* Current size of line */
|
|
WORD LinePos; /* Current position within line */
|
|
BOOLEAN LineComplete; /* User pressed enter, ready to send back to client */
|
|
BOOLEAN LineUpPressed;
|
|
BOOLEAN LineInsertToggle; /* Replace character over cursor instead of inserting */
|
|
ULONG LineWakeupMask; /* Bitmap of which control characters will end line input */
|
|
|
|
BOOLEAN QuickEdit;
|
|
BOOLEAN InsertMode;
|
|
UINT CodePage;
|
|
UINT OutputCodePage;
|
|
|
|
CONSOLE_SELECTION_INFO Selection;
|
|
|
|
/******************************* Screen buffers *******************************/
|
|
LIST_ENTRY BufferList; /* List of all screen buffers for this console */
|
|
PCONSOLE_SCREEN_BUFFER ActiveBuffer; /* Pointer to currently active screen buffer */
|
|
BYTE PauseFlags;
|
|
HANDLE UnpauseEvent;
|
|
LIST_ENTRY WriteWaitQueue; /* List head for the queue of write wait blocks */
|
|
|
|
DWORD HardwareState; /* _GDI_MANAGED, _DIRECT */
|
|
/* BOOLEAN */ ULONG FullScreen; // Give the type of console: GUI (windowed) or TUI (fullscreen)
|
|
|
|
/**************************** Aliases and Histories ***************************/
|
|
struct _ALIAS_HEADER *Aliases;
|
|
LIST_ENTRY HistoryBuffers;
|
|
ULONG HistoryBufferSize; /* Size for newly created history buffers */
|
|
ULONG NumberOfHistoryBuffers; /* Maximum number of history buffers allowed */
|
|
BOOLEAN HistoryNoDup; /* Remove old duplicate history entries */
|
|
|
|
/****************************** Other properties ******************************/
|
|
UNICODE_STRING OriginalTitle; /* Original title of console, the one when the console leader is launched. Always NULL-terminated */
|
|
UNICODE_STRING Title; /* Title of console. Always NULL-terminated */
|
|
|
|
/* SIZE */ COORD ConsoleSize; /* The size of the console */
|
|
COLORREF Colors[16]; /* Colour palette */
|
|
|
|
} CONSOLE, *PCONSOLE;
|
|
|
|
/* CONSOLE_SELECTION_INFO dwFlags values */
|
|
#define CONSOLE_NO_SELECTION 0x0
|
|
#define CONSOLE_SELECTION_IN_PROGRESS 0x1
|
|
#define CONSOLE_SELECTION_NOT_EMPTY 0x2
|
|
#define CONSOLE_MOUSE_SELECTION 0x4
|
|
#define CONSOLE_MOUSE_DOWN 0x8
|
|
|
|
/* HistoryFlags values */
|
|
#define HISTORY_NO_DUP_FLAG 0x1
|
|
|
|
/* PauseFlags values (internal only) */
|
|
#define PAUSED_FROM_KEYBOARD 0x1
|
|
#define PAUSED_FROM_SCROLLBAR 0x2
|
|
#define PAUSED_FROM_SELECTION 0x4
|
|
|
|
/* console.c */
|
|
VOID FASTCALL ConioPause(PCONSOLE Console, UINT Flags);
|
|
VOID FASTCALL ConioUnpause(PCONSOLE Console, UINT Flags);
|
|
ULONG FASTCALL ConSrvConsoleProcessCtrlEvent(PCONSOLE Console,
|
|
ULONG ProcessGroupId,
|
|
DWORD Event);
|
|
|
|
/* coninput.c */
|
|
#define ConSrvGetInputBuffer(ProcessData, Handle, Ptr, Access, LockConsole) \
|
|
ConSrvGetObject((ProcessData), (Handle), (Object_t **)(Ptr), NULL, \
|
|
(Access), (LockConsole), CONIO_INPUT_BUFFER_MAGIC)
|
|
#define ConSrvGetInputBufferAndHandleEntry(ProcessData, Handle, Ptr, Entry, Access, LockConsole) \
|
|
ConSrvGetObject((ProcessData), (Handle), (Object_t **)(Ptr), (Entry), \
|
|
(Access), (LockConsole), CONIO_INPUT_BUFFER_MAGIC)
|
|
#define ConSrvReleaseInputBuffer(Buff, IsConsoleLocked) \
|
|
ConSrvReleaseObject(&(Buff)->Header, (IsConsoleLocked))
|
|
VOID WINAPI ConioProcessKey(PCONSOLE Console, MSG* msg);
|
|
NTSTATUS FASTCALL ConioProcessInputEvent(PCONSOLE Console,
|
|
PINPUT_RECORD InputEvent);
|
|
|
|
/* conoutput.c */
|
|
#define ConioRectHeight(Rect) \
|
|
(((Rect)->Top) > ((Rect)->Bottom) ? 0 : ((Rect)->Bottom) - ((Rect)->Top) + 1)
|
|
#define ConioRectWidth(Rect) \
|
|
(((Rect)->Left) > ((Rect)->Right) ? 0 : ((Rect)->Right) - ((Rect)->Left) + 1)
|
|
#define ConSrvGetScreenBuffer(ProcessData, Handle, Ptr, Access, LockConsole) \
|
|
ConSrvGetObject((ProcessData), (Handle), (Object_t **)(Ptr), NULL, \
|
|
(Access), (LockConsole), CONIO_SCREEN_BUFFER_MAGIC)
|
|
#define ConSrvGetScreenBufferAndHandleEntry(ProcessData, Handle, Ptr, Entry, Access, LockConsole) \
|
|
ConSrvGetObject((ProcessData), (Handle), (Object_t **)(Ptr), (Entry), \
|
|
(Access), (LockConsole), CONIO_SCREEN_BUFFER_MAGIC)
|
|
#define ConSrvReleaseScreenBuffer(Buff, IsConsoleLocked) \
|
|
ConSrvReleaseObject(&(Buff)->Header, (IsConsoleLocked))
|
|
PBYTE FASTCALL ConioCoordToPointer(PCONSOLE_SCREEN_BUFFER Buf, ULONG X, ULONG Y);
|
|
VOID FASTCALL ConioDrawConsole(PCONSOLE Console);
|
|
NTSTATUS FASTCALL ConioWriteConsole(PCONSOLE Console, PCONSOLE_SCREEN_BUFFER Buff,
|
|
CHAR *Buffer, DWORD Length, BOOL Attrib);
|
|
NTSTATUS FASTCALL ConSrvCreateScreenBuffer(IN OUT PCONSOLE Console,
|
|
OUT PCONSOLE_SCREEN_BUFFER* Buffer,
|
|
IN COORD ScreenBufferSize,
|
|
IN USHORT ScreenAttrib,
|
|
IN USHORT PopupAttrib,
|
|
IN BOOLEAN IsCursorVisible,
|
|
IN ULONG CursorSize);
|
|
VOID WINAPI ConioDeleteScreenBuffer(PCONSOLE_SCREEN_BUFFER Buffer);
|
|
DWORD FASTCALL ConioEffectiveCursorSize(PCONSOLE Console, DWORD Scale);
|
|
|
|
/* EOF */
|