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)
231 if (ev_found != -1) evts[ev_found].event = CONSOLE_RENDERER_NONE_EVENT;
235 /* step 2: manage update events */
237 for (i = 0; i < num - 1; i++)
239 if (evts[i].event == CONSOLE_RENDERER_NONE_EVENT) continue;
240 if (evts[i].event != CONSOLE_RENDERER_UPDATE_EVENT)
246 if (ev_found != -1 &&
247 !(evts[i ].u.update.bottom + 1 < evts[ev_found].u.update.top ||
248 evts[ev_found].u.update.bottom + 1 < evts[i ].u.update.top))
250 evts[i].u.update.top = min(evts[i ].u.update.top,
251 evts[ev_found].u.update.top);
252 evts[i].u.update.bottom = max(evts[i ].u.update.bottom,
253 evts[ev_found].u.update.bottom);
254 evts[ev_found].event = CONSOLE_RENDERER_NONE_EVENT;
259 WINE_TRACE("Events:");
260 for (i = 0; i < num; i++)
262 switch (evts[i].event)
264 case CONSOLE_RENDERER_NONE_EVENT:
266 case CONSOLE_RENDERER_TITLE_EVENT:
267 data->fnSetTitle(data);
269 case CONSOLE_RENDERER_ACTIVE_SB_EVENT:
270 SERVER_START_REQ( open_console )
272 req->from = (int)data->hConIn;
273 req->access = GENERIC_READ | GENERIC_WRITE;
274 req->share = FILE_SHARE_READ | FILE_SHARE_WRITE;
275 req->inherit = FALSE;
276 h = wine_server_call_err( req ) ? 0 : (HANDLE)reply->handle;
279 WINE_TRACE(" active(%d)", (int)h);
282 CloseHandle(data->hConOut);
286 case CONSOLE_RENDERER_SB_RESIZE_EVENT:
287 if (data->curcfg.sb_width != evts[i].u.resize.width ||
288 data->curcfg.sb_height != evts[i].u.resize.height || !data->cells)
290 WINE_TRACE(" resize(%d,%d)", evts[i].u.resize.width, evts[i].u.resize.height);
291 data->curcfg.sb_width = evts[i].u.resize.width;
292 data->curcfg.sb_height = evts[i].u.resize.height;
294 data->cells = HeapReAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, data->cells,
295 data->curcfg.sb_width * data->curcfg.sb_height * sizeof(CHAR_INFO));
296 if (!data->cells) WINECON_Fatal("OOM\n");
297 data->fnResizeScreenBuffer(data);
298 data->fnComputePositions(data);
301 case CONSOLE_RENDERER_UPDATE_EVENT:
302 WINE_TRACE(" update(%d,%d)", evts[i].u.update.top, evts[i].u.update.bottom);
303 WINECON_FetchCells(data, evts[i].u.update.top, evts[i].u.update.bottom);
305 case CONSOLE_RENDERER_CURSOR_POS_EVENT:
306 if (evts[i].u.cursor_pos.x != data->cursor.X || evts[i].u.cursor_pos.y != data->cursor.Y)
308 WINE_TRACE(" curs-pos(%d,%d)",evts[i].u.cursor_pos.x, evts[i].u.cursor_pos.y);
309 data->cursor.X = evts[i].u.cursor_pos.x;
310 data->cursor.Y = evts[i].u.cursor_pos.y;
311 data->fnPosCursor(data);
314 case CONSOLE_RENDERER_CURSOR_GEOM_EVENT:
315 if (evts[i].u.cursor_geom.size != data->curcfg.cursor_size ||
316 evts[i].u.cursor_geom.visible != data->curcfg.cursor_visible)
318 WINE_TRACE(" curs-geom(%d,%d)",
319 evts[i].u.cursor_geom.size, evts[i].u.cursor_geom.visible);
320 data->fnShapeCursor(data, evts[i].u.cursor_geom.size,
321 evts[i].u.cursor_geom.visible, FALSE);
324 case CONSOLE_RENDERER_DISPLAY_EVENT:
325 if (evts[i].u.display.left != data->curcfg.win_pos.X)
327 WINE_TRACE(" h-scroll(%d)", evts[i].u.display.left);
328 data->fnScroll(data, evts[i].u.display.left, TRUE);
329 data->fnPosCursor(data);
331 if (evts[i].u.display.top != data->curcfg.win_pos.Y)
333 WINE_TRACE(" v-scroll(%d)", evts[i].u.display.top);
334 data->fnScroll(data, evts[i].u.display.top, FALSE);
335 data->fnPosCursor(data);
337 if (evts[i].u.display.width != data->curcfg.win_width ||
338 evts[i].u.display.height != data->curcfg.win_height)
340 WINE_TRACE(" win-size(%d,%d)", evts[i].u.display.width, evts[i].u.display.height);
341 data->curcfg.win_width = evts[i].u.display.width;
342 data->curcfg.win_height = evts[i].u.display.height;
343 data->fnComputePositions(data);
346 case CONSOLE_RENDERER_EXIT_EVENT:
347 WINE_TRACE(". Exit!!\n");
350 WINE_FIXME("Unknown event type (%d)\n", evts[i].event);
358 /******************************************************************
361 * Apply to data all the configuration elements from cfg. This includes modification
362 * of server side equivalent and visual parts.
363 * If force is FALSE, only the changed items are modified.
365 void WINECON_SetConfig(struct inner_data* data,
366 const struct config_data* cfg, BOOL force)
368 if (force || data->curcfg.cursor_size != cfg->cursor_size ||
369 data->curcfg.cursor_visible != cfg->cursor_visible)
371 CONSOLE_CURSOR_INFO cinfo;
372 cinfo.dwSize = cfg->cursor_size;
373 /* <FIXME>: this hack is needed to pass thru the invariant test operation on server side
374 * (no notification is sent when invariant operation is requested
376 cinfo.bVisible = !cfg->cursor_visible;
377 SetConsoleCursorInfo(data->hConOut, &cinfo);
379 cinfo.bVisible = cfg->cursor_visible;
380 /* this shall update (through notif) curcfg */
381 SetConsoleCursorInfo(data->hConOut, &cinfo);
383 if (force || data->curcfg.history_size != cfg->history_size)
385 data->curcfg.history_size = cfg->history_size;
386 WINECON_SetHistorySize(data->hConIn, cfg->history_size);
388 if (force || data->curcfg.history_nodup != cfg->history_nodup)
390 data->curcfg.history_nodup = cfg->history_nodup;
391 WINECON_SetHistoryMode(data->hConIn, cfg->history_nodup);
393 data->curcfg.menu_mask = cfg->menu_mask;
394 data->curcfg.quick_edit = cfg->quick_edit;
395 if (force || 1 /* FIXME: font info has changed */)
397 data->fnSetFont(data, cfg->face_name, cfg->cell_height, cfg->font_weight);
399 if (force || data->curcfg.def_attr != cfg->def_attr)
401 data->curcfg.def_attr = cfg->def_attr;
402 SetConsoleTextAttribute(data->hConOut, cfg->def_attr);
404 /* now let's look at the window / sb size changes...
405 * since the server checks that sb is always bigger than window,
406 * we have to take care of doing the operations in the right order
408 /* a set of macros to make things easier to read
409 * The Test<A><B> macros test if the <A> (width/height) needs to be changed
410 * for <B> (window / ScreenBuffer)
411 * The Change<A><B> actually modify the <B> dimension of <A>.
413 #define TstSBfWidth() (force || data->curcfg.sb_width != cfg->sb_width)
414 #define TstWinWidth() (force || data->curcfg.win_width != cfg->win_width)
416 #define ChgSBfWidth() do {c.X = cfg->sb_width; \
417 c.Y = data->curcfg.sb_height;\
418 SetConsoleScreenBufferSize(data->hConOut, c);\
420 #define ChgWinWidth() do {pos.Left = pos.Top = 0; \
421 pos.Right = cfg->win_width - 1; \
422 pos.Bottom = data->curcfg.win_height - 1; \
423 SetConsoleWindowInfo(data->hConOut, FALSE, &pos);\
425 #define TstSBfHeight() (force || data->curcfg.sb_height != cfg->sb_height)
426 #define TstWinHeight() (force || data->curcfg.win_height != cfg->win_height)
428 /* since we're going to apply height after width is done, we use width as defined
429 * in cfg, and not in data->curcfg because if won't be updated yet */
430 #define ChgSBfHeight() do {c.X = cfg->sb_width; c.Y = cfg->sb_height; \
431 SetConsoleScreenBufferSize(data->hConOut, c); \
433 #define ChgWinHeight() do {pos.Left = pos.Top = 0; \
434 pos.Right = cfg->win_width - 1; \
435 pos.Bottom = cfg->win_height - 1; \
436 SetConsoleWindowInfo(data->hConOut, FALSE, &pos);\
448 /* we're changing both at the same time, do it in the right order */
449 if (cfg->sb_width >= data->curcfg.win_width)
451 ChgSBfWidth(); ChgWinWidth();
455 ChgWinWidth(); ChgSBfWidth();
460 else if (TstWinWidth()) ChgWinWidth();
465 if (cfg->sb_height >= data->curcfg.win_height)
467 ChgSBfHeight(); ChgWinHeight();
471 ChgWinHeight(); ChgSBfHeight();
476 else if (TstWinHeight()) ChgWinHeight();
487 data->curcfg.exit_on_die = cfg->exit_on_die;
488 if (force || data->curcfg.edition_mode != cfg->edition_mode)
490 data->curcfg.edition_mode = cfg->edition_mode;
491 WINECON_SetEditionMode(data->hConIn, cfg->edition_mode);
493 /* we now need to gather all events we got from the operations above,
494 * in order to get data correctly updated
496 WINECON_GrabChanges(data);
499 /******************************************************************
502 * Destroy wineconsole internal data
504 static void WINECON_Delete(struct inner_data* data)
508 if (data->fnDeleteBackend) data->fnDeleteBackend(data);
509 if (data->hConIn) CloseHandle(data->hConIn);
510 if (data->hConOut) CloseHandle(data->hConOut);
511 if (data->hSynchro) CloseHandle(data->hSynchro);
512 if (data->cells) HeapFree(GetProcessHeap(), 0, data->cells);
513 HeapFree(GetProcessHeap(), 0, data);
516 /******************************************************************
519 * Initialisation part I. Creation of server object (console input and
520 * active screen buffer)
522 static struct inner_data* WINECON_Init(HINSTANCE hInst, DWORD pid, LPCWSTR appname,
523 enum init_return (*backend)(struct inner_data*))
525 struct inner_data* data = NULL;
527 struct config_data cfg;
530 data = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*data));
537 if (!si.lpTitle) WINECON_Fatal("Should have a title set");
538 appname = si.lpTitle;
542 WINECON_RegLoad(appname, &cfg);
547 if (si.dwFlags & STARTF_USECOUNTCHARS)
549 cfg.sb_width = si.dwXCountChars;
550 cfg.sb_height = si.dwYCountChars;
552 if (si.dwFlags & STARTF_USEFILLATTRIBUTE)
553 cfg.def_attr = si.dwFillAttribute;
554 /* should always be defined */
557 /* the handles here are created without the whistles and bells required by console
558 * (mainly because wineconsole doesn't need it)
559 * - they are not inheritable
560 * - hConIn is not synchronizable
562 SERVER_START_REQ(alloc_console)
564 req->access = GENERIC_READ | GENERIC_WRITE;
565 req->inherit = FALSE;
568 ret = !wine_server_call_err( req );
569 data->hConIn = (HANDLE)reply->handle_in;
570 data->hSynchro = (HANDLE)reply->event;
573 if (!ret) goto error;
574 WINE_TRACE("using hConIn %p, hSynchro event %p\n", data->hConIn, data->hSynchro);
576 SERVER_START_REQ( set_console_input_info )
578 req->handle = (obj_handle_t)data->hConIn;
579 req->mask = SET_CONSOLE_INPUT_INFO_TITLE;
580 wine_server_add_data( req, appname, lstrlenW(appname) * sizeof(WCHAR) );
581 ret = !wine_server_call_err( req );
584 if (!ret) goto error;
586 SERVER_START_REQ(create_console_output)
588 req->handle_in = (obj_handle_t)data->hConIn;
589 req->access = GENERIC_WRITE|GENERIC_READ;
590 req->share = FILE_SHARE_READ|FILE_SHARE_WRITE;
591 req->inherit = FALSE;
592 ret = !wine_server_call_err( req );
593 data->hConOut = (HANDLE)reply->handle_out;
596 if (!ret) goto error;
597 WINE_TRACE("using hConOut %p\n", data->hConOut);
599 /* filling data->curcfg from cfg */
601 switch ((*backend)(data))
604 WINECON_SetConfig(data, &cfg, TRUE);
605 data->curcfg.registry = cfg.registry;
606 WINECON_DumpConfig("fint", &data->curcfg);
610 case init_not_supported:
611 if (backend == WCCURSES_InitBackend)
613 WINE_ERR("(n)curses was not found at configuration time.\n"
614 "If you want (n)curses support, please install relevant packages.\n"
615 "Now forcing user backend instead of (n)curses.\n");
616 backend = WCUSER_InitBackend;
623 WINE_ERR("failed to init.\n");
625 WINECON_Delete(data);
629 /******************************************************************
632 * Spawn the child process when invoked with wineconsole foo bar
634 static BOOL WINECON_Spawn(struct inner_data* data, LPWSTR cmdLine)
636 PROCESS_INFORMATION info;
640 /* we're in the case wineconsole <exe> <options>... spawn the new process */
641 memset(&startup, 0, sizeof(startup));
642 startup.cb = sizeof(startup);
643 startup.dwFlags = STARTF_USESTDHANDLES;
645 /* the attributes of wineconsole's handles are not adequate for inheritance, so
646 * get them with the correct attributes before process creation
648 if (!DuplicateHandle(GetCurrentProcess(), data->hConIn, GetCurrentProcess(),
649 &startup.hStdInput, GENERIC_READ|GENERIC_WRITE|SYNCHRONIZE, TRUE, 0) ||
650 !DuplicateHandle(GetCurrentProcess(), data->hConOut, GetCurrentProcess(),
651 &startup.hStdOutput, GENERIC_READ|GENERIC_WRITE, TRUE, 0) ||
652 !DuplicateHandle(GetCurrentProcess(), data->hConOut, GetCurrentProcess(),
653 &startup.hStdError, GENERIC_READ|GENERIC_WRITE, TRUE, 0))
655 WINE_ERR("Can't dup handles\n");
656 /* no need to delete handles, we're exiting the programm anyway */
660 done = CreateProcess(NULL, cmdLine, NULL, NULL, TRUE, 0L, NULL, NULL, &startup, &info);
662 /* we no longer need the handles passed to the child for the console */
663 CloseHandle(startup.hStdInput);
664 CloseHandle(startup.hStdOutput);
665 CloseHandle(startup.hStdError);
667 CloseHandle(info.hProcess);
668 CloseHandle(info.hThread);
675 enum {from_event, from_process_name} mode;
676 enum init_return (*backend)(struct inner_data*);
680 /******************************************************************
681 * WINECON_ParseOptions
685 static BOOL WINECON_ParseOptions(const char* lpCmdLine, struct wc_init* wci)
687 memset(wci, 0, sizeof(*wci));
688 wci->ptr = lpCmdLine;
689 wci->mode = from_process_name;
690 wci->backend = WCCURSES_InitBackend;
694 while (*wci->ptr == ' ' || *wci->ptr == '\t') wci->ptr++;
695 if (wci->ptr[0] != '-') break;
696 if (strncmp(wci->ptr, "--use-event=", 12) == 0)
699 wci->event = (HANDLE)strtol(wci->ptr + 12, &end, 10);
700 if (end == wci->ptr + 12) return FALSE;
701 wci->mode = from_event;
703 wci->backend = WCUSER_InitBackend;
705 else if (strncmp(wci->ptr, "--backend=", 10) == 0)
707 if (strncmp(wci->ptr + 10, "user", 4) == 0)
709 wci->backend = WCUSER_InitBackend;
712 else if (strncmp(wci->ptr + 10, "curses", 6) == 0)
726 /******************************************************************
729 * wineconsole can either be started as:
730 * wineconsole --use-event=<int> used when a new console is created (AllocConsole)
731 * wineconsole <pgm> <arguments> used to start the program <pgm> from the command line in
732 * a freshly created console
733 * --backend=(curses|user) can also be used to select the desired backend
735 int PASCAL WinMain(HINSTANCE hInst, HINSTANCE hPrev, LPSTR lpCmdLine, INT nCmdShow)
737 struct inner_data* data;
741 if (!WINECON_ParseOptions(lpCmdLine, &wci))
743 WINE_ERR("Wrong command line options\n");
750 /* case of wineconsole <evt>, signal process that created us that we're up and running */
751 if (!(data = WINECON_Init(hInst, 0, NULL, wci.backend))) return 0;
752 ret = SetEvent(wci.event);
753 if (!ret) WINE_ERR("SetEvent failed.\n");
755 case from_process_name:
759 MultiByteToWideChar(CP_ACP, 0, wci.ptr, -1, buffer, sizeof(buffer) / sizeof(buffer[0]));
761 if (!(data = WINECON_Init(hInst, GetCurrentProcessId(), buffer, wci.backend)))
763 ret = WINECON_Spawn(data, buffer);
765 WINE_MESSAGE("wineconsole: spawning client program failed (%s), invalid/missing command line arguments ?\n", wine_dbgstr_w(buffer));
774 WINE_TRACE("calling MainLoop.\n");
775 ret = data->fnMainLoop(data);
778 WINECON_Delete(data);