2 * an application for displaying Win32 console
4 * Copyright 2001, 2002 Eric Pouech
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include "wine/port.h"
25 #include "wine/server.h"
26 #include "winecon_private.h"
29 #include "wine/debug.h"
31 WINE_DEFAULT_DEBUG_CHANNEL(wineconsole);
33 void WINECON_Fatal(const char* msg)
35 WINE_ERR("%s\n", msg);
39 /******************************************************************
42 * updates the local copy of cells (band to update)
44 void WINECON_FetchCells(struct inner_data* data, int upd_tp, int upd_bm)
46 SERVER_START_REQ( read_console_output )
48 req->handle = (obj_handle_t)data->hConOut;
51 req->mode = CHAR_INFO_MODE_TEXTATTR;
53 wine_server_set_reply( req, &data->cells[upd_tp * data->curcfg.sb_width],
54 (upd_bm-upd_tp+1) * data->curcfg.sb_width * sizeof(CHAR_INFO) );
55 wine_server_call( req );
58 data->fnRefresh(data, upd_tp, upd_bm);
61 /******************************************************************
62 * WINECON_NotifyWindowChange
64 * Inform server that visible window on sb has changed
66 void WINECON_NotifyWindowChange(struct inner_data* data)
68 SERVER_START_REQ( set_console_output_info )
70 req->handle = (obj_handle_t)data->hConOut;
71 req->win_left = data->curcfg.win_pos.X;
72 req->win_top = data->curcfg.win_pos.Y;
73 req->win_right = data->curcfg.win_pos.X + data->curcfg.win_width - 1;
74 req->win_bottom = data->curcfg.win_pos.Y + data->curcfg.win_height - 1;
75 req->mask = SET_CONSOLE_OUTPUT_INFO_DISPLAY_WINDOW;
76 wine_server_call( req );
81 /******************************************************************
82 * WINECON_GetHistorySize
86 int WINECON_GetHistorySize(HANDLE hConIn)
90 SERVER_START_REQ(get_console_input_info)
92 req->handle = (obj_handle_t)hConIn;
93 if (!wine_server_call_err( req )) ret = reply->history_size;
99 /******************************************************************
100 * WINECON_SetHistorySize
104 BOOL WINECON_SetHistorySize(HANDLE hConIn, int size)
108 SERVER_START_REQ(set_console_input_info)
110 req->handle = (obj_handle_t)hConIn;
111 req->mask = SET_CONSOLE_INPUT_INFO_HISTORY_SIZE;
112 req->history_size = size;
113 ret = !wine_server_call_err( req );
120 /******************************************************************
121 * WINECON_GetHistoryMode
125 int WINECON_GetHistoryMode(HANDLE hConIn)
129 SERVER_START_REQ(get_console_input_info)
131 req->handle = (obj_handle_t)hConIn;
132 if (!wine_server_call_err( req )) ret = reply->history_mode;
138 /******************************************************************
139 * WINECON_SetHistoryMode
143 BOOL WINECON_SetHistoryMode(HANDLE hConIn, int mode)
147 SERVER_START_REQ(set_console_input_info)
149 req->handle = (obj_handle_t)hConIn;
150 req->mask = SET_CONSOLE_INPUT_INFO_HISTORY_MODE;
151 req->history_mode = mode;
152 ret = !wine_server_call_err( req );
158 /******************************************************************
159 * WINECON_GetConsoleTitle
163 BOOL WINECON_GetConsoleTitle(HANDLE hConIn, WCHAR* buffer, size_t len)
167 if (len < sizeof(WCHAR)) return FALSE;
169 SERVER_START_REQ( get_console_input_info )
171 req->handle = (obj_handle_t)hConIn;
172 wine_server_set_reply( req, buffer, len - sizeof(WCHAR) );
173 if ((ret = !wine_server_call_err( req )))
175 len = wine_server_reply_size( reply );
176 buffer[len / sizeof(WCHAR)] = 0;
183 /******************************************************************
184 * WINECON_SetEditionMode
188 static BOOL WINECON_SetEditionMode(HANDLE hConIn, int edition_mode)
192 SERVER_START_REQ( set_console_input_info )
194 req->handle = (obj_handle_t)hConIn;
195 req->mask = SET_CONSOLE_INPUT_INFO_EDITION_MODE;
196 req->edition_mode = edition_mode;
197 ret = !wine_server_call_err( req );
203 /******************************************************************
204 * WINECON_GrabChanges
206 * A change occurs, try to figure out which
208 int WINECON_GrabChanges(struct inner_data* data)
210 struct console_renderer_event evts[256];
211 int i, num, ev_found;
214 SERVER_START_REQ( get_console_renderer_events )
216 wine_server_set_reply( req, evts, sizeof(evts) );
217 req->handle = (obj_handle_t)data->hSynchro;
218 if (!wine_server_call_err( req )) num = wine_server_reply_size(reply) / sizeof(evts[0]);
222 if (!num) {WINE_WARN("hmm renderer signaled but no events available\n"); return 1;}
224 /* FIXME: should do some event compression here (cursor pos, update) */
225 /* step 1: keep only last cursor pos event */
227 for (i = num - 1; i >= 0; i--)
229 if (evts[i].event == CONSOLE_RENDERER_CURSOR_POS_EVENT)
232 evts[i].event = CONSOLE_RENDERER_NONE_EVENT;
236 /* step 2: manage update events */
238 for (i = 0; i < num; i++)
240 if (evts[i].event == CONSOLE_RENDERER_NONE_EVENT ||
241 evts[i].event == CONSOLE_RENDERER_CURSOR_POS_EVENT ||
242 evts[i].event == CONSOLE_RENDERER_CURSOR_GEOM_EVENT) continue;
243 if (evts[i].event != CONSOLE_RENDERER_UPDATE_EVENT)
249 if (ev_found != -1 && /* Only 2 cases where they can NOT merge */
250 !(evts[i ].u.update.bottom + 1 < evts[ev_found].u.update.top ||
251 evts[ev_found].u.update.bottom + 1 < evts[i ].u.update.top))
253 evts[i].u.update.top = min(evts[i ].u.update.top,
254 evts[ev_found].u.update.top);
255 evts[i].u.update.bottom = max(evts[i ].u.update.bottom,
256 evts[ev_found].u.update.bottom);
257 evts[ev_found].event = CONSOLE_RENDERER_NONE_EVENT;
262 WINE_TRACE("Events:");
263 for (i = 0; i < num; i++)
265 switch (evts[i].event)
267 case CONSOLE_RENDERER_NONE_EVENT:
270 case CONSOLE_RENDERER_TITLE_EVENT:
271 WINE_TRACE(" title()");
272 data->fnSetTitle(data);
274 case CONSOLE_RENDERER_ACTIVE_SB_EVENT:
275 SERVER_START_REQ( open_console )
277 req->from = (int)data->hConIn;
278 req->access = GENERIC_READ | GENERIC_WRITE;
279 req->share = FILE_SHARE_READ | FILE_SHARE_WRITE;
280 req->inherit = FALSE;
281 h = wine_server_call_err( req ) ? 0 : (HANDLE)reply->handle;
284 WINE_TRACE(" active(%d)", (int)h);
287 CloseHandle(data->hConOut);
291 case CONSOLE_RENDERER_SB_RESIZE_EVENT:
292 if (data->curcfg.sb_width != evts[i].u.resize.width ||
293 data->curcfg.sb_height != evts[i].u.resize.height || !data->cells)
295 WINE_TRACE(" resize(%d,%d)", evts[i].u.resize.width, evts[i].u.resize.height);
296 data->curcfg.sb_width = evts[i].u.resize.width;
297 data->curcfg.sb_height = evts[i].u.resize.height;
300 data->cells = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, data->cells,
301 data->curcfg.sb_width * data->curcfg.sb_height * sizeof(CHAR_INFO));
303 data->cells = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
304 data->curcfg.sb_width * data->curcfg.sb_height * sizeof(CHAR_INFO));
306 if (!data->cells) WINECON_Fatal("OOM\n");
307 data->fnResizeScreenBuffer(data);
308 data->fnComputePositions(data);
311 case CONSOLE_RENDERER_UPDATE_EVENT:
312 WINE_TRACE(" update(%d,%d)", evts[i].u.update.top, evts[i].u.update.bottom);
313 WINECON_FetchCells(data, evts[i].u.update.top, evts[i].u.update.bottom);
315 case CONSOLE_RENDERER_CURSOR_POS_EVENT:
316 if (evts[i].u.cursor_pos.x != data->cursor.X || evts[i].u.cursor_pos.y != data->cursor.Y)
318 WINE_TRACE(" curs-pos(%d,%d)",evts[i].u.cursor_pos.x, evts[i].u.cursor_pos.y);
319 data->cursor.X = evts[i].u.cursor_pos.x;
320 data->cursor.Y = evts[i].u.cursor_pos.y;
321 data->fnPosCursor(data);
324 case CONSOLE_RENDERER_CURSOR_GEOM_EVENT:
325 if (evts[i].u.cursor_geom.size != data->curcfg.cursor_size ||
326 evts[i].u.cursor_geom.visible != data->curcfg.cursor_visible)
328 WINE_TRACE(" curs-geom(%d,%d)",
329 evts[i].u.cursor_geom.size, evts[i].u.cursor_geom.visible);
330 data->fnShapeCursor(data, evts[i].u.cursor_geom.size,
331 evts[i].u.cursor_geom.visible, FALSE);
334 case CONSOLE_RENDERER_DISPLAY_EVENT:
335 if (evts[i].u.display.left != data->curcfg.win_pos.X)
337 WINE_TRACE(" h-scroll(%d)", evts[i].u.display.left);
338 data->fnScroll(data, evts[i].u.display.left, TRUE);
339 data->fnPosCursor(data);
341 if (evts[i].u.display.top != data->curcfg.win_pos.Y)
343 WINE_TRACE(" v-scroll(%d)", evts[i].u.display.top);
344 data->fnScroll(data, evts[i].u.display.top, FALSE);
345 data->fnPosCursor(data);
347 if (evts[i].u.display.width != data->curcfg.win_width ||
348 evts[i].u.display.height != data->curcfg.win_height)
350 WINE_TRACE(" win-size(%d,%d)", evts[i].u.display.width, evts[i].u.display.height);
351 data->curcfg.win_width = evts[i].u.display.width;
352 data->curcfg.win_height = evts[i].u.display.height;
353 data->fnComputePositions(data);
356 case CONSOLE_RENDERER_EXIT_EVENT:
357 WINE_TRACE(". Exit!!\n");
360 WINE_FIXME("Unknown event type (%d)\n", evts[i].event);
368 /******************************************************************
371 * Apply to data all the configuration elements from cfg. This includes modification
372 * of server side equivalent and visual parts.
373 * If force is FALSE, only the changed items are modified.
375 void WINECON_SetConfig(struct inner_data* data,
376 const struct config_data* cfg, BOOL force)
378 if (force || data->curcfg.cursor_size != cfg->cursor_size ||
379 data->curcfg.cursor_visible != cfg->cursor_visible)
381 CONSOLE_CURSOR_INFO cinfo;
382 cinfo.dwSize = cfg->cursor_size;
383 /* <FIXME>: this hack is needed to pass thru the invariant test operation on server side
384 * (no notification is sent when invariant operation is requested
386 cinfo.bVisible = !cfg->cursor_visible;
387 SetConsoleCursorInfo(data->hConOut, &cinfo);
389 cinfo.bVisible = cfg->cursor_visible;
390 /* this shall update (through notif) curcfg */
391 SetConsoleCursorInfo(data->hConOut, &cinfo);
393 if (force || data->curcfg.history_size != cfg->history_size)
395 data->curcfg.history_size = cfg->history_size;
396 WINECON_SetHistorySize(data->hConIn, cfg->history_size);
398 if (force || data->curcfg.history_nodup != cfg->history_nodup)
400 data->curcfg.history_nodup = cfg->history_nodup;
401 WINECON_SetHistoryMode(data->hConIn, cfg->history_nodup);
403 data->curcfg.menu_mask = cfg->menu_mask;
404 data->curcfg.quick_edit = cfg->quick_edit;
405 if (force || 1 /* FIXME: font info has changed */)
407 data->fnSetFont(data, cfg->face_name, cfg->cell_height, cfg->font_weight);
409 if (force || data->curcfg.def_attr != cfg->def_attr)
411 data->curcfg.def_attr = cfg->def_attr;
412 SetConsoleTextAttribute(data->hConOut, cfg->def_attr);
414 /* now let's look at the window / sb size changes...
415 * since the server checks that sb is always bigger than window,
416 * we have to take care of doing the operations in the right order
418 /* a set of macros to make things easier to read
419 * The Test<A><B> macros test if the <A> (width/height) needs to be changed
420 * for <B> (window / ScreenBuffer)
421 * The Change<A><B> actually modify the <B> dimension of <A>.
423 #define TstSBfWidth() (force || data->curcfg.sb_width != cfg->sb_width)
424 #define TstWinWidth() (force || data->curcfg.win_width != cfg->win_width)
426 #define ChgSBfWidth() do {c.X = cfg->sb_width; \
427 c.Y = data->curcfg.sb_height;\
428 SetConsoleScreenBufferSize(data->hConOut, c);\
430 #define ChgWinWidth() do {pos.Left = pos.Top = 0; \
431 pos.Right = cfg->win_width - 1; \
432 pos.Bottom = data->curcfg.win_height - 1; \
433 SetConsoleWindowInfo(data->hConOut, FALSE, &pos);\
435 #define TstSBfHeight() (force || data->curcfg.sb_height != cfg->sb_height)
436 #define TstWinHeight() (force || data->curcfg.win_height != cfg->win_height)
438 /* since we're going to apply height after width is done, we use width as defined
439 * in cfg, and not in data->curcfg because if won't be updated yet */
440 #define ChgSBfHeight() do {c.X = cfg->sb_width; c.Y = cfg->sb_height; \
441 SetConsoleScreenBufferSize(data->hConOut, c); \
443 #define ChgWinHeight() do {pos.Left = pos.Top = 0; \
444 pos.Right = cfg->win_width - 1; \
445 pos.Bottom = cfg->win_height - 1; \
446 SetConsoleWindowInfo(data->hConOut, FALSE, &pos);\
458 /* we're changing both at the same time, do it in the right order */
459 if (cfg->sb_width >= data->curcfg.win_width)
461 ChgSBfWidth(); ChgWinWidth();
465 ChgWinWidth(); ChgSBfWidth();
470 else if (TstWinWidth()) ChgWinWidth();
475 if (cfg->sb_height >= data->curcfg.win_height)
477 ChgSBfHeight(); ChgWinHeight();
481 ChgWinHeight(); ChgSBfHeight();
486 else if (TstWinHeight()) ChgWinHeight();
497 data->curcfg.exit_on_die = cfg->exit_on_die;
498 if (force || data->curcfg.edition_mode != cfg->edition_mode)
500 data->curcfg.edition_mode = cfg->edition_mode;
501 WINECON_SetEditionMode(data->hConIn, cfg->edition_mode);
503 /* we now need to gather all events we got from the operations above,
504 * in order to get data correctly updated
506 WINECON_GrabChanges(data);
509 /******************************************************************
512 * Destroy wineconsole internal data
514 static void WINECON_Delete(struct inner_data* data)
518 if (data->fnDeleteBackend) data->fnDeleteBackend(data);
519 if (data->hConIn) CloseHandle(data->hConIn);
520 if (data->hConOut) CloseHandle(data->hConOut);
521 if (data->hSynchro) CloseHandle(data->hSynchro);
522 HeapFree(GetProcessHeap(), 0, data->cells);
523 HeapFree(GetProcessHeap(), 0, data);
526 /******************************************************************
529 * Initialisation part I. Creation of server object (console input and
530 * active screen buffer)
532 static struct inner_data* WINECON_Init(HINSTANCE hInst, DWORD pid, LPCWSTR appname,
533 enum init_return (*backend)(struct inner_data*))
535 struct inner_data* data = NULL;
537 struct config_data cfg;
540 data = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*data));
547 if (!si.lpTitle) WINECON_Fatal("Should have a title set");
548 appname = si.lpTitle;
552 WINECON_RegLoad(appname, &cfg);
557 if (si.dwFlags & STARTF_USECOUNTCHARS)
559 cfg.sb_width = si.dwXCountChars;
560 cfg.sb_height = si.dwYCountChars;
562 if (si.dwFlags & STARTF_USEFILLATTRIBUTE)
563 cfg.def_attr = si.dwFillAttribute;
564 /* should always be defined */
567 /* the handles here are created without the whistles and bells required by console
568 * (mainly because wineconsole doesn't need it)
569 * - they are not inheritable
570 * - hConIn is not synchronizable
572 SERVER_START_REQ(alloc_console)
574 req->access = GENERIC_READ | GENERIC_WRITE;
575 req->inherit = FALSE;
578 ret = !wine_server_call_err( req );
579 data->hConIn = (HANDLE)reply->handle_in;
580 data->hSynchro = (HANDLE)reply->event;
583 if (!ret) goto error;
584 WINE_TRACE("using hConIn %p, hSynchro event %p\n", data->hConIn, data->hSynchro);
586 SERVER_START_REQ( set_console_input_info )
588 req->handle = (obj_handle_t)data->hConIn;
589 req->mask = SET_CONSOLE_INPUT_INFO_TITLE;
590 wine_server_add_data( req, appname, lstrlenW(appname) * sizeof(WCHAR) );
591 ret = !wine_server_call_err( req );
594 if (!ret) goto error;
596 SERVER_START_REQ(create_console_output)
598 req->handle_in = (obj_handle_t)data->hConIn;
599 req->access = GENERIC_WRITE|GENERIC_READ;
600 req->share = FILE_SHARE_READ|FILE_SHARE_WRITE;
601 req->inherit = FALSE;
602 ret = !wine_server_call_err( req );
603 data->hConOut = (HANDLE)reply->handle_out;
606 if (!ret) goto error;
607 WINE_TRACE("using hConOut %p\n", data->hConOut);
609 /* filling data->curcfg from cfg */
611 switch ((*backend)(data))
614 WINECON_SetConfig(data, &cfg, TRUE);
615 data->curcfg.registry = cfg.registry;
616 WINECON_DumpConfig("fint", &data->curcfg);
620 case init_not_supported:
621 if (backend == WCCURSES_InitBackend)
623 WINE_ERR("(n)curses was not found at configuration time.\n"
624 "If you want (n)curses support, please install relevant packages.\n"
625 "Now forcing user backend instead of (n)curses.\n");
626 backend = WCUSER_InitBackend;
633 WINE_ERR("failed to init.\n");
635 WINECON_Delete(data);
639 /******************************************************************
642 * Spawn the child process when invoked with wineconsole foo bar
644 static BOOL WINECON_Spawn(struct inner_data* data, LPWSTR cmdLine)
646 PROCESS_INFORMATION info;
650 /* we're in the case wineconsole <exe> <options>... spawn the new process */
651 memset(&startup, 0, sizeof(startup));
652 startup.cb = sizeof(startup);
653 startup.dwFlags = STARTF_USESTDHANDLES;
655 /* the attributes of wineconsole's handles are not adequate for inheritance, so
656 * get them with the correct attributes before process creation
658 if (!DuplicateHandle(GetCurrentProcess(), data->hConIn, GetCurrentProcess(),
659 &startup.hStdInput, GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE, TRUE, 0) ||
660 !DuplicateHandle(GetCurrentProcess(), data->hConOut, GetCurrentProcess(),
661 &startup.hStdOutput, GENERIC_READ|GENERIC_WRITE, TRUE, 0) ||
662 !DuplicateHandle(GetCurrentProcess(), data->hConOut, GetCurrentProcess(),
663 &startup.hStdError, GENERIC_READ|GENERIC_WRITE, TRUE, 0))
665 WINE_ERR("Can't dup handles\n");
666 /* no need to delete handles, we're exiting the programm anyway */
670 done = CreateProcess(NULL, cmdLine, NULL, NULL, TRUE, 0L, NULL, NULL, &startup, &info);
672 /* we no longer need the handles passed to the child for the console */
673 CloseHandle(startup.hStdInput);
674 CloseHandle(startup.hStdOutput);
675 CloseHandle(startup.hStdError);
677 CloseHandle(info.hProcess);
678 CloseHandle(info.hThread);
685 enum {from_event, from_process_name} mode;
686 enum init_return (*backend)(struct inner_data*);
690 /******************************************************************
691 * WINECON_ParseOptions
695 static BOOL WINECON_ParseOptions(const char* lpCmdLine, struct wc_init* wci)
697 memset(wci, 0, sizeof(*wci));
698 wci->ptr = lpCmdLine;
699 wci->mode = from_process_name;
700 wci->backend = WCCURSES_InitBackend;
704 while (*wci->ptr == ' ' || *wci->ptr == '\t') wci->ptr++;
705 if (wci->ptr[0] != '-') break;
706 if (strncmp(wci->ptr, "--use-event=", 12) == 0)
709 wci->event = (HANDLE)strtol(wci->ptr + 12, &end, 10);
710 if (end == wci->ptr + 12) return FALSE;
711 wci->mode = from_event;
713 wci->backend = WCUSER_InitBackend;
715 else if (strncmp(wci->ptr, "--backend=", 10) == 0)
717 if (strncmp(wci->ptr + 10, "user", 4) == 0)
719 wci->backend = WCUSER_InitBackend;
722 else if (strncmp(wci->ptr + 10, "curses", 6) == 0)
736 /******************************************************************
739 * wineconsole can either be started as:
740 * wineconsole --use-event=<int> used when a new console is created (AllocConsole)
741 * wineconsole <pgm> <arguments> used to start the program <pgm> from the command line in
742 * a freshly created console
743 * --backend=(curses|user) can also be used to select the desired backend
745 int PASCAL WinMain(HINSTANCE hInst, HINSTANCE hPrev, LPSTR lpCmdLine, INT nCmdShow)
747 struct inner_data* data;
751 if (!WINECON_ParseOptions(lpCmdLine, &wci))
753 WINE_ERR("Wrong command line options\n");
760 /* case of wineconsole <evt>, signal process that created us that we're up and running */
761 if (!(data = WINECON_Init(hInst, 0, NULL, wci.backend))) return 0;
762 ret = SetEvent(wci.event);
763 if (!ret) WINE_ERR("SetEvent failed.\n");
765 case from_process_name:
769 MultiByteToWideChar(CP_ACP, 0, wci.ptr, -1, buffer, sizeof(buffer) / sizeof(buffer[0]));
771 if (!(data = WINECON_Init(hInst, GetCurrentProcessId(), buffer, wci.backend)))
773 ret = WINECON_Spawn(data, buffer);
775 WINE_MESSAGE("wineconsole: spawning client program failed (%s), invalid/missing command line arguments ?\n", wine_dbgstr_w(buffer));
784 WINE_TRACE("calling MainLoop.\n");
785 ret = data->fnMainLoop(data);
788 WINECON_Delete(data);