programs/wineconsole/winecon_private.h

   1 /*
   2  * an application for displaying Win32 console
   3  *
   4  * Copyright 2001 Eric Pouech
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include <windef.h>
  23 #include <winbase.h>
  24 #include <wincon.h>
  25
  26 #include "wineconsole_res.h"
  27
  28 /* this is the configuration stored & loaded into the registry */
  29 struct config_data {
  30     unsigned    cell_width;     /* width in pixels of a character */
  31     unsigned    cell_height;    /* height in pixels of a character */
  32     int         cursor_size;    /* in % of cell height */
  33     int         cursor_visible;
  34     DWORD       def_attr;
  35     WCHAR       face_name[32];  /* name of font (size is LF_FACESIZE) */
  36     DWORD       font_weight;
  37     DWORD       history_size;   /* number of commands in history buffer */
  38     DWORD       history_nodup;  /* TRUE if commands are not stored twice in buffer */
  39     DWORD       menu_mask;      /* MK_CONTROL MK_SHIFT mask to drive submenu opening */
  40     DWORD       quick_edit;     /* whether mouse ops are sent to app (false) or used for content selection (true) */
  41     unsigned    sb_width;       /* active screen buffer width */
  42     unsigned    sb_height;      /* active screen buffer height */
  43     unsigned    win_width;      /* size (in cells) of visible part of window (width & height) */
  44     unsigned    win_height;
  45     COORD       win_pos;        /* position (in cells) of visible part of screen buffer in window */
  46     BOOL        exit_on_die;    /* whether the wineconsole should quit if server destroys the console */
  47     unsigned    edition_mode;   /* edition mode flavor while line editing */
  48     WCHAR*      registry;       /* <x> part of HKLU\\<x>\\Console where config is read from (NULL if default settings) */
  49 };
  50
  51 struct inner_data {
  52     struct config_data  curcfg;
  53
  54     CHAR_INFO*          cells;          /* local copy of cells (sb_width * sb_height) */
  55
  56     COORD               cursor;         /* position in cells of cursor */
  57
  58     HANDLE              hConIn;         /* console input handle */
  59     HANDLE              hConOut;        /* screen buffer handle: has to be changed when active sb changes */
  60     HANDLE              hSynchro;       /* waitable handle signalled by server when something in server has been modified */
  61     HWND                hWnd;           /* handle of 'user' window or NULL for 'curses' */
  62     INT                 nCmdShow;       /* argument of WinMain */
  63
  64     int                 (*fnMainLoop)(struct inner_data* data);
  65     void                (*fnPosCursor)(const struct inner_data* data);
  66     void                (*fnShapeCursor)(struct inner_data* data, int size, int vis, BOOL force);
  67     void                (*fnComputePositions)(struct inner_data* data);
  68     void                (*fnRefresh)(const struct inner_data* data, int tp, int bm);
  69     void                (*fnResizeScreenBuffer)(struct inner_data* data);
  70     void                (*fnSetTitle)(const struct inner_data* data);
  71     void                (*fnScroll)(struct inner_data* data, int pos, BOOL horz);
  72     void                (*fnSetFont)(struct inner_data* data, const WCHAR* font, unsigned height, unsigned weight);
  73     void                (*fnDeleteBackend)(struct inner_data* data);
  74
  75     void*               private;        /* data part belonging to the choosen backed */
  76 };
  77
  78 /* from wineconsole.c */
  79 extern void WINECON_Fatal(const char* msg);
  80 extern void WINECON_NotifyWindowChange(struct inner_data* data);
  81 extern int  WINECON_GetHistorySize(HANDLE hConIn);
  82 extern BOOL WINECON_SetHistorySize(HANDLE hConIn, int size);
  83 extern int  WINECON_GetHistoryMode(HANDLE hConIn);
  84 extern BOOL WINECON_SetHistoryMode(HANDLE hConIn, int mode);
  85 extern BOOL WINECON_GetConsoleTitle(HANDLE hConIn, WCHAR* buffer, size_t len);
  86 extern void WINECON_FetchCells(struct inner_data* data, int upd_tp, int upd_bm);
  87 extern int  WINECON_GrabChanges(struct inner_data* data);
  88 extern VOID WINECON_SetConfig(struct inner_data* data,
  89                               const struct config_data* cfg);
  90 /* from registry.c */
  91 extern void WINECON_RegLoad(const WCHAR* appname, struct config_data* cfg);
  92 extern void WINECON_RegSave(const struct config_data* cfg);
  93 extern void WINECON_DumpConfig(const char* pfx, const struct config_data* cfg);
  94
  95 /* backends... */
  96 enum init_return {
  97     init_success, init_failed, init_not_supported
  98 };
  99 extern enum init_return WCUSER_InitBackend(struct inner_data* data);
 100 extern enum init_return WCCURSES_InitBackend(struct inner_data* data);