Freeciv-3.3: /fast/freeciv/nightly/main/client/gui-gtk-3.22/luaconsole.c Source File

Freeciv-3.3

Loading...
Searching...
No Matches
luaconsole.c
Go to the documentation of this file.
1/*****************************************************************************
2 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License as published by
5 the Free Software Foundation; either version 2, or (at your option)
6 any later version.
7
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12*****************************************************************************/
13
14#ifdef HAVE_CONFIG_H
15#include <fc_config.h>
16#endif
17
18#include <gdk/gdkkeysyms.h>
19
20/* utility */
21#include "fcintl.h"
22#include "log.h"
23#include "shared.h"
24
25/* common */
26#include "featured_text.h"
27#include "game.h"
28
29/* client */
30#include "options.h"
31
32/* client/gui-gtk-3.22 */
33#include "chatline.h"
34#include "gui_main.h"
35#include "gui_stuff.h"
36
37/* client/luascript */
38#include "script_client.h"
39
40#include "luaconsole.h"
41
42 enum luaconsole_res {
43 LUACONSOLE_RES_OPEN
44};
45
46#define MAX_LUACONSOLE_HISTORY 20
47
48 struct luaconsole_data {
49 struct gui_dialog *shell;
50 GtkTextBuffer *message_buffer;
51 GtkTextView *message_area;
52 GtkWidget *entry;
53
54 struct genlist *history_list;
55 int history_pos;
56};
57
58 static struct luaconsole_data *luaconsole = NULL;
59
60
61static struct luaconsole_data *luaconsole_dialog_get(void);
62static void luaconsole_dialog_create(struct luaconsole_data *pdialog);
63static void luaconsole_dialog_refresh(struct luaconsole_data *pdialog);
64static void luaconsole_dialog_destroy(struct luaconsole_data *pdialog);
65
66static void luaconsole_dialog_area_size_allocate(GtkWidget *widget,
67 GtkAllocation *allocation,
68 gpointer data);
69static void luaconsole_dialog_scroll_to_bottom(void);
70
71static void luaconsole_input_return(GtkEntry *w, gpointer data);
72static gboolean luaconsole_input_handler(GtkWidget *w, GdkEventKey *ev);
73
74static void luaconsole_response_callback(struct gui_dialog *pgui_dialog,
75 int response, gpointer data);
76static void luaconsole_load_file_popup(void);
77static void luaconsole_load_file_callback(GtkWidget *widget, gint response,
78 gpointer data);
79
80/*************************************************************************/
83 void luaconsole_dialog_init(void)
84{
85 fc_assert_ret(luaconsole == NULL);
86
87 /* Create a container for the dialog. */
88 luaconsole = fc_calloc(1, sizeof(*luaconsole));
89 luaconsole->message_buffer = gtk_text_buffer_new(NULL);
90 luaconsole->shell = NULL;
91
92 luaconsole->history_list = genlist_new();
93 luaconsole->history_pos = -1;
94
95 luaconsole_welcome_message();
96}
97
98/*************************************************************************/
101 void luaconsole_dialog_done(void)
102{
103 if (luaconsole != NULL) {
104 if (luaconsole->history_list) {
105 genlist_destroy(luaconsole->history_list);
106 }
107
108 luaconsole_dialog_popdown();
109 free(luaconsole);
110
111 luaconsole = NULL;
112 }
113}
114
115/*************************************************************************/
118 static struct luaconsole_data *luaconsole_dialog_get(void)
119{
120 return luaconsole;
121}
122
123/*************************************************************************/
126 void luaconsole_dialog_popup(bool raise)
127{
128 struct luaconsole_data *pdialog = luaconsole_dialog_get();
129
130 fc_assert_ret(pdialog);
131 if (pdialog->shell == NULL) {
132 luaconsole_dialog_create(pdialog);
133 }
134
135 gui_dialog_present(pdialog->shell);
136 if (raise) {
137 gui_dialog_raise(pdialog->shell);
138 }
139}
140
141/*************************************************************************/
144 void luaconsole_dialog_popdown(void)
145{
146 struct luaconsole_data *pdialog = luaconsole_dialog_get();
147
148 fc_assert_ret(pdialog);
149 if (pdialog->shell == NULL) {
150 luaconsole_dialog_destroy(pdialog);
151 }
152}
153
154/*************************************************************************/
157 bool luaconsole_dialog_is_open(void)
158{
159 struct luaconsole_data *pdialog = luaconsole_dialog_get();
160
161 fc_assert_ret_val(pdialog, FALSE);
162
163 return (NULL != pdialog->shell);
164}
165
166/*************************************************************************/
169 void real_luaconsole_dialog_update(void)
170{
171 struct luaconsole_data *pdialog = luaconsole_dialog_get();
172
173 fc_assert_ret(pdialog);
174
175 if (NULL != pdialog->shell) {
176 luaconsole_dialog_refresh(pdialog);
177 }
178}
179
180/*************************************************************************/
183 static void luaconsole_dialog_create(struct luaconsole_data *pdialog)
184{
185 GtkWidget *entry, *box, *vbox, *sw, *text, *notebook;
186
187 fc_assert_ret(NULL != pdialog);
188
189 if (GUI_GTK_OPTION(message_chat_location) == GUI_GTK_MSGCHAT_SPLIT) {
190 notebook = right_notebook;
191 } else {
192 notebook = bottom_notebook;
193 }
194
195 gui_dialog_new(&pdialog->shell, GTK_NOTEBOOK(notebook), pdialog, TRUE);
196 gui_dialog_set_title(pdialog->shell, _("Client Lua Console"));
197
198 box = pdialog->shell->vbox;
199
200 vbox = gtk_grid_new();
201 gtk_orientable_set_orientation(GTK_ORIENTABLE(vbox),
202 GTK_ORIENTATION_VERTICAL);
203 gtk_container_add(GTK_CONTAINER(box), vbox);
204
205 sw = gtk_scrolled_window_new(NULL, NULL);
206 gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(sw),
207 GTK_SHADOW_ETCHED_IN);
208 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(sw),
209 GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
210 gtk_container_add(GTK_CONTAINER(vbox), sw);
211
212 text = gtk_text_view_new_with_buffer(pdialog->message_buffer);
213 gtk_widget_set_hexpand(text, TRUE);
214 gtk_widget_set_vexpand(text, TRUE);
215 set_message_buffer_view_link_handlers(text);
216 gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
217 gtk_container_add(GTK_CONTAINER(sw), text);
218 g_signal_connect(text, "size-allocate",
219 G_CALLBACK(luaconsole_dialog_area_size_allocate), NULL);
220
221 gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
222 gtk_widget_realize(text);
223 gtk_text_view_set_left_margin(GTK_TEXT_VIEW(text), 5);
224
225 pdialog->message_area = GTK_TEXT_VIEW(text);
226 g_signal_connect(text, "destroy", G_CALLBACK(gtk_widget_destroyed),
227 &pdialog->message_area);
228
229 /* The lua console input line. */
230 entry = gtk_entry_new();
231 g_object_set(entry, "margin", 2, NULL);
232 gtk_container_add(GTK_CONTAINER(vbox), entry);
233 g_signal_connect(entry, "activate", G_CALLBACK(luaconsole_input_return),
234 NULL);
235 g_signal_connect(entry, "key_press_event",
236 G_CALLBACK(luaconsole_input_handler), NULL);
237 pdialog->entry = entry;
238 g_signal_connect(entry, "destroy", G_CALLBACK(gtk_widget_destroyed),
239 &pdialog->entry);
240
241 /* Load lua script command button. */
242 gui_dialog_add_button(pdialog->shell, "window-close", _("_Close"),
243 GTK_RESPONSE_CLOSE);
244
245 gui_dialog_add_button(pdialog->shell, "document-open",
246 _("Load Lua Script"), LUACONSOLE_RES_OPEN);
247 gui_dialog_response_set_callback(pdialog->shell,
248 luaconsole_response_callback);
249
250 luaconsole_dialog_refresh(pdialog);
251 gui_dialog_show_all(pdialog->shell);
252}
253
254/*************************************************************************/
257 static void luaconsole_input_return(GtkEntry *w, gpointer data)
258{
259 const char *theinput;
260 struct luaconsole_data *pdialog = luaconsole_dialog_get();
261
262 fc_assert_ret(pdialog);
263 fc_assert_ret(pdialog->history_list);
264
265 theinput = gtk_entry_get_text(w);
266
267 if (*theinput) {
268 luaconsole_printf(ftc_luaconsole_input, "(input)> %s", theinput);
269 script_client_do_string(theinput);
270
271 if (genlist_size(pdialog->history_list) >= MAX_LUACONSOLE_HISTORY) {
272 void *history_data;
273
274 history_data = genlist_get(pdialog->history_list, -1);
275 genlist_remove(pdialog->history_list, history_data);
276 free(history_data);
277 }
278
279 genlist_prepend(pdialog->history_list, fc_strdup(theinput));
280 pdialog->history_pos = -1;
281 }
282
283 gtk_entry_set_text(w, "");
284}
285
286/*************************************************************************/
289 static void luaconsole_response_callback(struct gui_dialog *pgui_dialog,
290 int response, gpointer data)
291{
292 switch (response) {
293 case LUACONSOLE_RES_OPEN:
294 break;
295 default:
296 gui_dialog_destroy(pgui_dialog);
297 return;
298 }
299
300 switch (response) {
301 case LUACONSOLE_RES_OPEN:
302 luaconsole_load_file_popup();
303 break;
304 }
305}
306
307/*************************************************************************/
310 static void luaconsole_load_file_popup(void)
311{
312 GtkWidget *filesel;
313
314 /* Create the selector */
315 filesel = gtk_file_chooser_dialog_new("Load Lua file", GTK_WINDOW(toplevel),
316 GTK_FILE_CHOOSER_ACTION_OPEN,
317 _("_Cancel"), GTK_RESPONSE_CANCEL,
318 _("_Open"), GTK_RESPONSE_OK,
319 NULL);
320 setup_dialog(filesel, toplevel);
321 gtk_window_set_position(GTK_WINDOW(filesel), GTK_WIN_POS_MOUSE);
322
323 g_signal_connect(filesel, "response",
324 G_CALLBACK(luaconsole_load_file_callback), NULL);
325
326 /* Display that dialog */
327 gtk_window_present(GTK_WINDOW(filesel));
328}
329
330/*************************************************************************/
333 static void luaconsole_load_file_callback(GtkWidget *widget, gint response,
334 gpointer data)
335{
336 if (response == GTK_RESPONSE_OK) {
337 gchar *filename = g_filename_to_utf8(gtk_file_chooser_get_filename
338 (GTK_FILE_CHOOSER(widget)),
339 -1, NULL, NULL, NULL);
340
341 if (NULL != filename) {
342 luaconsole_printf(ftc_luaconsole_input, "(file)> %s", filename);
343 script_client_do_file(filename);
344 g_free(filename);
345 }
346 }
347 gtk_widget_destroy(widget);
348}
349
350/*************************************************************************/
353 static gboolean luaconsole_input_handler(GtkWidget *w, GdkEventKey *ev)
354{
355 struct luaconsole_data *pdialog = luaconsole_dialog_get();
356
357 fc_assert_ret_val(pdialog, FALSE);
358 fc_assert_ret_val(pdialog->history_list, FALSE);
359
360 switch (ev->keyval) {
361 case GDK_KEY_Up:
362 if (pdialog->history_pos < genlist_size(pdialog->history_list) - 1) {
363 gtk_entry_set_text(GTK_ENTRY(w), genlist_get(pdialog->history_list,
364 ++pdialog->history_pos));
365 gtk_editable_set_position(GTK_EDITABLE(w), -1);
366 }
367 return TRUE;
368
369 case GDK_KEY_Down:
370 if (pdialog->history_pos >= 0) {
371 pdialog->history_pos--;
372 }
373
374 if (pdialog->history_pos >= 0) {
375 gtk_entry_set_text(GTK_ENTRY(w), genlist_get(pdialog->history_list,
376 pdialog->history_pos));
377 } else {
378 gtk_entry_set_text(GTK_ENTRY(w), "");
379 }
380 gtk_editable_set_position(GTK_EDITABLE(w), -1);
381 return TRUE;
382
383 default:
384 break;
385 }
386
387 return FALSE;
388}
389
390/*************************************************************************/
395 static void luaconsole_dialog_area_size_allocate(GtkWidget *widget,
396 GtkAllocation *allocation,
397 gpointer data)
398{
399 static int old_width = 0, old_height = 0;
400 if (allocation->width != old_width
401 || allocation->height != old_height) {
402 luaconsole_dialog_scroll_to_bottom();
403 old_width = allocation->width;
404 old_height = allocation->height;
405 }
406}
407
408/*************************************************************************/
414 static void luaconsole_dialog_scroll_to_bottom(void)
415{
416 struct luaconsole_data *pdialog = luaconsole_dialog_get();
417
418 fc_assert_ret(pdialog);
419
420 if (pdialog->shell) {
421 GtkTextIter end;
422
423 fc_assert_ret(NULL != pdialog->message_buffer);
424 fc_assert_ret(NULL != pdialog->message_area);
425
426 gtk_text_buffer_get_end_iter(pdialog->message_buffer, &end);
427 gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(pdialog->message_area),
428 &end, 0.0, TRUE, 1.0, 0.0);
429 }
430}
431
432/*************************************************************************/
435 static void luaconsole_dialog_refresh(struct luaconsole_data *pdialog)
436{
437 fc_assert_ret(NULL != pdialog);
438}
439
440/*************************************************************************/
443 static void luaconsole_dialog_destroy(struct luaconsole_data *pdialog)
444{
445 fc_assert_ret(NULL != pdialog);
446
447 if (pdialog->shell) {
448 gui_dialog_destroy(pdialog->shell);
449 fc_assert(NULL == pdialog->shell);
450 }
451 fc_assert(NULL == pdialog->message_area);
452 fc_assert(NULL == pdialog->entry);
453}
454
455/*************************************************************************/
459 void real_luaconsole_append(const char *astring,
460 const struct text_tag_list *tags)
461{
462 GtkTextBuffer *buf;
463 GtkTextIter iter;
464 GtkTextMark *mark;
465 ft_offset_t text_start_offset;
466 struct luaconsole_data *pdialog = luaconsole_dialog_get();
467
468 fc_assert_ret(pdialog);
469
470 buf = pdialog->message_buffer;
471 gtk_text_buffer_get_end_iter(buf, &iter);
472 gtk_text_buffer_insert(buf, &iter, "\n", -1);
473 mark = gtk_text_buffer_create_mark(buf, NULL, &iter, TRUE);
474
475 if (GUI_GTK_OPTION(show_chat_message_time)) {
476 char timebuf[64];
477 time_t now;
478 struct tm now_tm;
479
480 now = time(NULL);
481 fc_localtime(&now, &now_tm);
482 strftime(timebuf, sizeof(timebuf), "[%H:%M:%S] ", &now_tm);
483 gtk_text_buffer_insert(buf, &iter, timebuf, -1);
484 }
485
486 text_start_offset = gtk_text_iter_get_offset(&iter);
487 gtk_text_buffer_insert(buf, &iter, astring, -1);
488 text_tag_list_iterate(tags, ptag) {
489 apply_text_tag(ptag, buf, text_start_offset, astring);
490 } text_tag_list_iterate_end;
491
492 if (pdialog->message_area) {
493 scroll_if_necessary(GTK_TEXT_VIEW(pdialog->message_area), mark);
494 }
495 gtk_text_buffer_delete_mark(buf, mark);
496}
incite_cost
char * incite_cost
Definition comments.c:74
fcintl.h
_
#define _(String)
Definition fcintl.h:67
ftc_luaconsole_input
const struct ft_color ftc_luaconsole_input
Definition featured_text.c:99
featured_text.h
text_tag_list_iterate_end
#define text_tag_list_iterate_end
Definition featured_text.h:116
text_tag_list_iterate
#define text_tag_list_iterate(tags, ptag)
Definition featured_text.h:114
ft_offset_t
int ft_offset_t
Definition featured_text.h:102
game.h
genlist_remove
bool genlist_remove(struct genlist *pgenlist, const void *punlink)
Definition genlist.c:322
genlist_new
struct genlist * genlist_new(void)
Definition genlist.c:31
genlist_get
void * genlist_get(const struct genlist *pgenlist, int idx)
Definition genlist.c:221
genlist_prepend
void genlist_prepend(struct genlist *pgenlist, void *data)
Definition genlist.c:500
genlist_destroy
void genlist_destroy(struct genlist *pgenlist)
Definition genlist.c:57
genlist_size
int genlist_size(const struct genlist *pgenlist)
Definition genlist.c:192
set_message_buffer_view_link_handlers
void set_message_buffer_view_link_handlers(GtkWidget *view)
Definition chatline.c:745
scroll_if_necessary
void scroll_if_necessary(GtkTextView *textview, GtkTextMark *scroll_target)
Definition chatline.c:558
apply_text_tag
void apply_text_tag(const struct text_tag *ptag, GtkTextBuffer *buf, ft_offset_t text_start_offset, const char *text)
Definition chatline.c:756
bottom_notebook
GtkWidget * bottom_notebook
Definition gui_main.c:129
toplevel
GtkWidget * toplevel
Definition gui_main.c:125
right_notebook
GtkWidget * right_notebook
Definition gui_main.c:129
GUI_GTK_OPTION
#define GUI_GTK_OPTION(optname)
Definition gui_main.h:25
gui_dialog_destroy
void gui_dialog_destroy(struct gui_dialog *dlg)
Definition gui_stuff.c:954
gui_dialog_present
void gui_dialog_present(struct gui_dialog *dlg)
Definition gui_stuff.c:835
gui_dialog_raise
void gui_dialog_raise(struct gui_dialog *dlg)
Definition gui_stuff.c:865
gui_dialog_new
void gui_dialog_new(struct gui_dialog **pdlg, GtkNotebook *notebook, gpointer user_data, bool check_top)
Definition gui_stuff.c:517
gui_dialog_response_set_callback
void gui_dialog_response_set_callback(struct gui_dialog *dlg, GUI_DIALOG_RESPONSE_FUN fun)
Definition gui_stuff.c:988
gui_dialog_show_all
void gui_dialog_show_all(struct gui_dialog *dlg)
Definition gui_stuff.c:795
gui_dialog_set_title
void gui_dialog_set_title(struct gui_dialog *dlg, const char *title)
Definition gui_stuff.c:935
gui_dialog_add_button
GtkWidget * gui_dialog_add_button(struct gui_dialog *dlg, const char *icon_name, const char *text, int response)
Definition gui_stuff.c:706
setup_dialog
void setup_dialog(GtkWidget *shell, GtkWidget *parent)
Definition gui_stuff.c:287
MAX_LUACONSOLE_HISTORY
#define MAX_LUACONSOLE_HISTORY
Definition luaconsole.c:46
luaconsole_dialog_popdown
void luaconsole_dialog_popdown(void)
Definition luaconsole.c:144
luaconsole_dialog_get
static struct luaconsole_data * luaconsole_dialog_get(void)
Definition luaconsole.c:118
luaconsole_dialog_scroll_to_bottom
static void luaconsole_dialog_scroll_to_bottom(void)
Definition luaconsole.c:414
luaconsole_dialog_init
void luaconsole_dialog_init(void)
Definition luaconsole.c:83
luaconsole_dialog_is_open
bool luaconsole_dialog_is_open(void)
Definition luaconsole.c:157
luaconsole_load_file_callback
static void luaconsole_load_file_callback(GtkWidget *widget, gint response, gpointer data)
Definition luaconsole.c:333
luaconsole_dialog_create
static void luaconsole_dialog_create(struct luaconsole_data *pdialog)
Definition luaconsole.c:183
luaconsole_response_callback
static void luaconsole_response_callback(struct gui_dialog *pgui_dialog, int response, gpointer data)
Definition luaconsole.c:289
luaconsole
static struct luaconsole_data * luaconsole
Definition luaconsole.c:58
luaconsole_dialog_refresh
static void luaconsole_dialog_refresh(struct luaconsole_data *pdialog)
Definition luaconsole.c:435
luaconsole_res
luaconsole_res
Definition luaconsole.c:42
LUACONSOLE_RES_OPEN
@ LUACONSOLE_RES_OPEN
Definition luaconsole.c:43
luaconsole_dialog_destroy
static void luaconsole_dialog_destroy(struct luaconsole_data *pdialog)
Definition luaconsole.c:443
luaconsole_input_return
static void luaconsole_input_return(GtkEntry *w, gpointer data)
Definition luaconsole.c:257
real_luaconsole_append
void real_luaconsole_append(const char *astring, const struct text_tag_list *tags)
Definition luaconsole.c:459
luaconsole_load_file_popup
static void luaconsole_load_file_popup(void)
Definition luaconsole.c:310
real_luaconsole_dialog_update
void real_luaconsole_dialog_update(void)
Definition luaconsole.c:169
luaconsole_dialog_popup
void luaconsole_dialog_popup(bool raise)
Definition luaconsole.c:126
luaconsole_input_handler
static gboolean luaconsole_input_handler(GtkWidget *w, GdkEventKey *ev)
Definition luaconsole.c:353
luaconsole_dialog_done
void luaconsole_dialog_done(void)
Definition luaconsole.c:101
luaconsole_dialog_area_size_allocate
static void luaconsole_dialog_area_size_allocate(GtkWidget *widget, GtkAllocation *allocation, gpointer data)
Definition luaconsole.c:395
gui_stuff.h
chatline.h
gui_main.h
luaconsole.h
log.h
fc_assert_ret
#define fc_assert_ret(condition)
Definition log.h:191
fc_assert
#define fc_assert(condition)
Definition log.h:176
fc_assert_ret_val
#define fc_assert_ret_val(condition, val)
Definition log.h:194
luaconsole_welcome_message
void luaconsole_welcome_message(void)
Definition luaconsole_common.c:109
luaconsole_printf
void luaconsole_printf(const struct ft_color color, const char *format,...)
Definition luaconsole_common.c:87
fc_calloc
#define fc_calloc(n, esz)
Definition mem.h:38
fc_strdup
#define fc_strdup(str)
Definition mem.h:43
options.h
GUI_GTK_MSGCHAT_SPLIT
@ GUI_GTK_MSGCHAT_SPLIT
Definition options.h:67
script_client_do_file
bool script_client_do_file(const char *filename)
Definition script_client.c:89
script_client_do_string
bool script_client_do_string(const char *str)
Definition script_client.c:79
script_client.h
shared.h
astring
Definition astring.h:36
entry
Definition registry_ini.c:193
genlist
Definition genlist.h:59
gui_dialog
Definition gui_stuff.h:70
gui_dialog::vbox
GtkWidget * vbox
Definition gui_stuff.h:72
luaconsole_data
Definition luaconsole.c:48
luaconsole_data::shell
struct gui_dialog * shell
Definition luaconsole.c:49
luaconsole_data::history_list
struct genlist * history_list
Definition luaconsole.c:54
luaconsole_data::entry
GtkWidget * entry
Definition luaconsole.c:52
luaconsole_data::message_area
GtkTextView * message_area
Definition luaconsole.c:51
luaconsole_data::history_pos
int history_pos
Definition luaconsole.c:55
luaconsole_data::message_buffer
GtkTextBuffer * message_buffer
Definition luaconsole.c:50
widget
Definition widget.h:112
fc_localtime
struct tm * fc_localtime(const time_t *timep, struct tm *result)
Definition support.c:1301
TRUE
#define TRUE
Definition support.h:46
FALSE
#define FALSE
Definition support.h:47