src/vte.c

   1 /*
   2  *      vte.c - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 /*
  23  * Virtual Terminal Emulation setup and handling code, using the libvte plugin library.
  24  */
  25
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #ifdef HAVE_VTE
  31
  32 #include "vte.h"
  33
  34 #include "callbacks.h"
  35 #include "document.h"
  36 #include "msgwindow.h"
  37 #include "prefs.h"
  38 #include "sciwrappers.h"
  39 #include "support.h"
  40 #include "ui_utils.h"
  41 #include "utils.h"
  42 #include "keybindings.h"
  43
  44 #include "gtkcompat.h"
  45
  46 /* include stdlib.h AND unistd.h, because on GNU/Linux pid_t seems to be
  47  * in stdlib.h, on FreeBSD in unistd.h, sys/types.h is needed for C89 */
  48 #include <stdlib.h>
  49 #include <sys/types.h>
  50 #include <unistd.h>
  51
  52 #include <gdk/gdkkeysyms.h>
  53 #include <signal.h>
  54 #include <string.h>
  55 #include <errno.h>
  56
  57
  58 VteInfo vte_info;
  59 VteConfig *vc;
  60
  61 static pid_t pid = 0;
  62 static gboolean clean = TRUE;
  63 static GModule *module = NULL;
  64 static struct VteFunctions *vf;
  65 static gchar *gtk_menu_key_accel = NULL;
  66
  67 /* use vte wordchars to select paths */
  68 static const gchar VTE_WORDCHARS[] = "-A-Za-z0-9,./?%&#:_";
  69
  70
  71 /* Incomplete VteTerminal struct from vte/vte.h. */
  72 typedef struct _VteTerminal VteTerminal;
  73 struct _VteTerminal
  74 {
  75         GtkWidget widget;
  76         GtkAdjustment *adjustment;
  77 };
  78
  79 #define VTE_TERMINAL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), VTE_TYPE_TERMINAL, VteTerminal))
  80 #define VTE_TYPE_TERMINAL (vf->vte_terminal_get_type())
  81
  82 typedef enum {
  83         VTE_CURSOR_BLINK_SYSTEM,
  84         VTE_CURSOR_BLINK_ON,
  85         VTE_CURSOR_BLINK_OFF
  86 } VteTerminalCursorBlinkMode;
  87
  88
  89 /* Holds function pointers we need to access the VTE API. */
  90 struct VteFunctions
  91 {
  92         GtkWidget* (*vte_terminal_new) (void);
  93         pid_t (*vte_terminal_fork_command) (VteTerminal *terminal, const char *command, char **argv,
  94                                                                                 char **envv, const char *directory, gboolean lastlog,
  95                                                                                 gboolean utmp, gboolean wtmp);
  96         void (*vte_terminal_set_size) (VteTerminal *terminal, glong columns, glong rows);
  97         void (*vte_terminal_set_word_chars) (VteTerminal *terminal, const char *spec);
  98         void (*vte_terminal_set_mouse_autohide) (VteTerminal *terminal, gboolean setting);
  99         void (*vte_terminal_reset) (VteTerminal *terminal, gboolean full, gboolean clear_history);
 100         GType (*vte_terminal_get_type) (void);
 101         void (*vte_terminal_set_scroll_on_output) (VteTerminal *terminal, gboolean scroll);
 102         void (*vte_terminal_set_scroll_on_keystroke) (VteTerminal *terminal, gboolean scroll);
 103         void (*vte_terminal_set_font_from_string) (VteTerminal *terminal, const char *name);
 104         void (*vte_terminal_set_scrollback_lines) (VteTerminal *terminal, glong lines);
 105         gboolean (*vte_terminal_get_has_selection) (VteTerminal *terminal);
 106         void (*vte_terminal_copy_clipboard) (VteTerminal *terminal);
 107         void (*vte_terminal_paste_clipboard) (VteTerminal *terminal);
 108         void (*vte_terminal_set_emulation) (VteTerminal *terminal, const gchar *emulation);
 109         void (*vte_terminal_set_color_foreground) (VteTerminal *terminal, const GdkColor *foreground);
 110         void (*vte_terminal_set_color_bold) (VteTerminal *terminal, const GdkColor *foreground);
 111         void (*vte_terminal_set_color_background) (VteTerminal *terminal, const GdkColor *background);
 112         void (*vte_terminal_feed_child) (VteTerminal *terminal, const char *data, glong length);
 113         void (*vte_terminal_im_append_menuitems) (VteTerminal *terminal, GtkMenuShell *menushell);
 114         void (*vte_terminal_set_cursor_blink_mode) (VteTerminal *terminal,
 115                                                                                                 VteTerminalCursorBlinkMode mode);
 116         void (*vte_terminal_set_cursor_blinks) (VteTerminal *terminal, gboolean blink);
 117         void (*vte_terminal_select_all) (VteTerminal *terminal);
 118         void (*vte_terminal_set_audible_bell) (VteTerminal *terminal, gboolean is_audible);
 119         void (*vte_terminal_set_background_image_file) (VteTerminal *terminal, const char *path);
 120 };
 121
 122
 123 static void create_vte(void);
 124 static void vte_start(GtkWidget *widget);
 125 static void vte_restart(GtkWidget *widget);
 126 static gboolean vte_button_pressed(GtkWidget *widget, GdkEventButton *event, gpointer user_data);
 127 static gboolean vte_keyrelease_cb(GtkWidget *widget, GdkEventKey *event, gpointer data);
 128 static gboolean vte_keypress_cb(GtkWidget *widget, GdkEventKey *event, gpointer data);
 129 static gboolean vte_register_symbols(GModule *module);
 130 static void vte_popup_menu_clicked(GtkMenuItem *menuitem, gpointer user_data);
 131 static GtkWidget *vte_create_popup_menu(void);
 132 static void vte_commit_cb(VteTerminal *vte, gchar *arg1, guint arg2, gpointer user_data);
 133 static void vte_drag_data_received(GtkWidget *widget, GdkDragContext *drag_context,
 134                                                                    gint x, gint y, GtkSelectionData *data, guint info, guint ltime);
 135
 136
 137 enum
 138 {
 139         POPUP_COPY,
 140         POPUP_PASTE,
 141         POPUP_SELECTALL,
 142         POPUP_CHANGEPATH,
 143         POPUP_RESTARTTERMINAL,
 144         POPUP_PREFERENCES,
 145         TARGET_UTF8_STRING = 0,
 146         TARGET_TEXT,
 147         TARGET_COMPOUND_TEXT,
 148         TARGET_STRING,
 149         TARGET_TEXT_PLAIN
 150 };
 151
 152 static const GtkTargetEntry dnd_targets[] =
 153 {
 154   { "UTF8_STRING", 0, TARGET_UTF8_STRING },
 155   { "TEXT", 0, TARGET_TEXT },
 156   { "COMPOUND_TEXT", 0, TARGET_COMPOUND_TEXT },
 157   { "STRING", 0, TARGET_STRING },
 158   { "text/plain", 0, TARGET_TEXT_PLAIN },
 159 };
 160
 161
 162 static gchar **vte_get_child_environment(void)
 163 {
 164         const gchar *exclude_vars[] = {"COLUMNS", "LINES", "TERM", NULL};
 165
 166         return utils_copy_environment(exclude_vars, "TERM", "xterm", NULL);
 167 }
 168
 169
 170 static void override_menu_key(void)
 171 {
 172         if (gtk_menu_key_accel == NULL) /* for restoring the default value */
 173                 g_object_get(G_OBJECT(gtk_settings_get_default()),
 174                         "gtk-menu-bar-accel", &gtk_menu_key_accel, NULL);
 175
 176         if (vc->ignore_menu_bar_accel)
 177                 gtk_settings_set_string_property(gtk_settings_get_default(),
 178                         "gtk-menu-bar-accel", "<Shift><Control><Mod1><Mod2><Mod3><Mod4><Mod5>F10", "Geany");
 179         else
 180                 gtk_settings_set_string_property(gtk_settings_get_default(),
 181                         "gtk-menu-bar-accel", gtk_menu_key_accel, "Geany");
 182 }
 183
 184
 185 void vte_init(void)
 186 {
 187         if (vte_info.have_vte == FALSE)
 188         {       /* vte_info.have_vte can be false even if VTE is compiled in, think of command line option */
 189                 geany_debug("Disabling terminal support");
 190                 return;
 191         }
 192
 193         if (!EMPTY(vte_info.lib_vte))
 194         {
 195                 module = g_module_open(vte_info.lib_vte, G_MODULE_BIND_LAZY);
 196         }
 197 #ifdef VTE_MODULE_PATH
 198         else
 199         {
 200                 module = g_module_open(VTE_MODULE_PATH, G_MODULE_BIND_LAZY);
 201         }
 202 #endif
 203
 204         if (module == NULL)
 205         {
 206                 gint i;
 207                 const gchar *sonames[] = {
 208 #if GTK_CHECK_VERSION(3, 0, 0)
 209                         "libvte2_90.so", "libvte2_90.so.9", "libvte2_90.dylib",
 210 #else
 211                         "libvte.so", "libvte.so.4", "libvte.so.8", "libvte.so.9", "libvte.dylib",
 212 #endif
 213                         NULL
 214                 };
 215
 216                 for (i = 0; sonames[i] != NULL && module == NULL; i++)
 217                 {
 218                         module = g_module_open(sonames[i], G_MODULE_BIND_LAZY);
 219                 }
 220         }
 221
 222         if (module == NULL)
 223         {
 224                 vte_info.have_vte = FALSE;
 225                 geany_debug("Could not load libvte.so, embedded terminal support disabled");
 226                 return;
 227         }
 228         else
 229         {
 230                 vf = g_new0(struct VteFunctions, 1);
 231                 if (vte_register_symbols(module))
 232                         vte_info.have_vte = TRUE;
 233                 else
 234                 {
 235                         vte_info.have_vte = FALSE;
 236                         g_free(vf);
 237                         /* FIXME: is closing the module safe? see vte_close() and test on FreeBSD */
 238                         /*g_module_close(module);*/
 239                         module = NULL;
 240                         return;
 241                 }
 242         }
 243
 244         create_vte();
 245
 246         /* setup the F10 menu override (so it works before the widget is first realised). */
 247         override_menu_key();
 248 }
 249
 250
 251 static void on_vte_realize(void)
 252 {
 253         /* the vte widget has to be realised before color changes take effect */
 254         vte_apply_user_settings();
 255
 256         vf->vte_terminal_im_append_menuitems(VTE_TERMINAL(vc->vte), GTK_MENU_SHELL(vc->im_submenu));
 257 }
 258
 259
 260 static void create_vte(void)
 261 {
 262         GtkWidget *vte, *scrollbar, *hbox;
 263
 264         vc->vte = vte = vf->vte_terminal_new();
 265         scrollbar = gtk_vscrollbar_new(GTK_ADJUSTMENT(VTE_TERMINAL(vte)->adjustment));
 266         gtk_widget_set_can_focus(scrollbar, FALSE);
 267
 268         /* create menu now so copy/paste shortcuts work */
 269         vc->menu = vte_create_popup_menu();
 270         g_object_ref_sink(vc->menu);
 271
 272         hbox = gtk_hbox_new(FALSE, 0);
 273         gtk_box_pack_start(GTK_BOX(hbox), vte, TRUE, TRUE, 0);
 274         gtk_box_pack_start(GTK_BOX(hbox), scrollbar, FALSE, FALSE, 0);
 275
 276         /* set the default widget size first to prevent VTE expanding too much,
 277          * sometimes causing the hscrollbar to be too big or out of view. */
 278         gtk_widget_set_size_request(GTK_WIDGET(vte), 10, 10);
 279         vf->vte_terminal_set_size(VTE_TERMINAL(vte), 30, 1);
 280
 281         vf->vte_terminal_set_mouse_autohide(VTE_TERMINAL(vte), TRUE);
 282         vf->vte_terminal_set_word_chars(VTE_TERMINAL(vte), VTE_WORDCHARS);
 283
 284         gtk_drag_dest_set(vte, GTK_DEST_DEFAULT_ALL,
 285                 dnd_targets, G_N_ELEMENTS(dnd_targets), GDK_ACTION_COPY);
 286
 287         g_signal_connect(vte, "child-exited", G_CALLBACK(vte_start), NULL);
 288         g_signal_connect(vte, "button-press-event", G_CALLBACK(vte_button_pressed), NULL);
 289         g_signal_connect(vte, "event", G_CALLBACK(vte_keypress_cb), NULL);
 290         g_signal_connect(vte, "key-release-event", G_CALLBACK(vte_keyrelease_cb), NULL);
 291         g_signal_connect(vte, "commit", G_CALLBACK(vte_commit_cb), NULL);
 292         g_signal_connect(vte, "motion-notify-event", G_CALLBACK(on_motion_event), NULL);
 293         g_signal_connect(vte, "drag-data-received", G_CALLBACK(vte_drag_data_received), NULL);
 294
 295         vte_start(vte);
 296
 297         gtk_widget_show_all(hbox);
 298         gtk_notebook_insert_page(GTK_NOTEBOOK(msgwindow.notebook), hbox, gtk_label_new(_("Terminal")), MSG_VTE);
 299
 300         g_signal_connect_after(vte, "realize", G_CALLBACK(on_vte_realize), NULL);
 301 }
 302
 303
 304 void vte_close(void)
 305 {
 306         g_free(vf);
 307         /* free the vte widget before unloading vte module
 308          * this prevents a segfault on X close window if the message window is hidden */
 309         gtk_widget_destroy(vc->vte);
 310         gtk_widget_destroy(vc->menu);
 311         g_object_unref(vc->menu);
 312         g_free(vc->emulation);
 313         g_free(vc->shell);
 314         g_free(vc->image);
 315         g_free(vc->font);
 316         g_free(vc->send_cmd_prefix);
 317         g_free(vc);
 318         g_free(gtk_menu_key_accel);
 319         /* Don't unload the module explicitly because it causes a segfault on FreeBSD. The segfault
 320          * happens when the app really exits, not directly on g_module_close(). This still needs to
 321          * be investigated. */
 322         /*g_module_close(module); */
 323 }
 324
 325
 326 static gboolean vte_keyrelease_cb(GtkWidget *widget, GdkEventKey *event, gpointer data)
 327 {
 328         if (ui_is_keyval_enter_or_return(event->keyval) ||
 329                 ((event->keyval == GDK_c) && (event->state & GDK_CONTROL_MASK)))
 330         {
 331                 /* assume any text on the prompt has been executed when pressing Enter/Return */
 332                 clean = TRUE;
 333         }
 334         return FALSE;
 335 }
 336
 337
 338 static gboolean vte_keypress_cb(GtkWidget *widget, GdkEventKey *event, gpointer data)
 339 {
 340         if (vc->enable_bash_keys)
 341                 return FALSE;   /* Ctrl-[CD] will be handled by the VTE itself */
 342
 343         if (event->type != GDK_KEY_RELEASE)
 344                 return FALSE;
 345
 346         if ((event->keyval == GDK_c ||
 347                 event->keyval == GDK_d ||
 348                 event->keyval == GDK_C ||
 349                 event->keyval == GDK_D) &&
 350                 event->state & GDK_CONTROL_MASK &&
 351                 ! (event->state & GDK_SHIFT_MASK) && ! (event->state & GDK_MOD1_MASK))
 352         {
 353                 vte_restart(widget);
 354                 return TRUE;
 355         }
 356         return FALSE;
 357 }
 358
 359
 360 static void vte_commit_cb(VteTerminal *vte, gchar *arg1, guint arg2, gpointer user_data)
 361 {
 362         clean = FALSE;
 363 }
 364
 365
 366 static void vte_start(GtkWidget *widget)
 367 {
 368         gchar **env;
 369         gchar **argv;
 370
 371         /* split the shell command line, so arguments will work too */
 372         argv = g_strsplit(vc->shell, " ", -1);
 373
 374         if (argv != NULL)
 375         {
 376                 env = vte_get_child_environment();
 377                 pid = vf->vte_terminal_fork_command(VTE_TERMINAL(widget), argv[0], argv, env,
 378                                                                                         vte_info.dir, TRUE, TRUE, TRUE);
 379                 g_strfreev(env);
 380                 g_strfreev(argv);
 381         }
 382         else
 383                 pid = 0; /* use 0 as invalid pid */
 384
 385         clean = TRUE;
 386 }
 387
 388
 389 static void vte_restart(GtkWidget *widget)
 390 {
 391         vte_get_working_directory(); /* try to keep the working directory when restarting the VTE */
 392         if (pid > 0)
 393         {
 394                 kill(pid, SIGINT);
 395                 pid = 0;
 396         }
 397         vf->vte_terminal_reset(VTE_TERMINAL(widget), TRUE, TRUE);
 398         clean = TRUE;
 399 }
 400
 401
 402 static gboolean vte_button_pressed(GtkWidget *widget, GdkEventButton *event, gpointer user_data)
 403 {
 404         if (event->button == 3)
 405         {
 406                 gtk_widget_grab_focus(vc->vte);
 407                 gtk_menu_popup(GTK_MENU(vc->menu), NULL, NULL, NULL, NULL, event->button, event->time);
 408         }
 409         else if (event->button == 2)
 410         {
 411                 gtk_widget_grab_focus(widget);
 412         }
 413         return FALSE;
 414 }
 415
 416
 417 static void vte_set_cursor_blink_mode(void)
 418 {
 419         if (vf->vte_terminal_set_cursor_blink_mode != NULL)
 420                 /* vte >= 0.17.1 */
 421                 vf->vte_terminal_set_cursor_blink_mode(VTE_TERMINAL(vc->vte),
 422                         (vc->cursor_blinks) ? VTE_CURSOR_BLINK_ON : VTE_CURSOR_BLINK_OFF);
 423         else
 424                 /* vte < 0.17.1 */
 425                 vf->vte_terminal_set_cursor_blinks(VTE_TERMINAL(vc->vte), vc->cursor_blinks);
 426 }
 427
 428
 429 static gboolean vte_register_symbols(GModule *mod)
 430 {
 431         #define BIND_SYMBOL(field) \
 432                 g_module_symbol(mod, #field, (void*)&vf->field)
 433         #define BIND_REQUIRED_SYMBOL(field) \
 434                 G_STMT_START { \
 435                         if (! BIND_SYMBOL(field)) \
 436                         { \
 437                                 g_critical(_("invalid VTE library \"%s\": missing symbol \"%s\""), \
 438                                                 g_module_name(mod), #field); \
 439                                 return FALSE; \
 440                         } \
 441                 } G_STMT_END
 442
 443         BIND_REQUIRED_SYMBOL(vte_terminal_new);
 444         BIND_REQUIRED_SYMBOL(vte_terminal_set_size);
 445         BIND_REQUIRED_SYMBOL(vte_terminal_fork_command);
 446         BIND_REQUIRED_SYMBOL(vte_terminal_set_word_chars);
 447         BIND_REQUIRED_SYMBOL(vte_terminal_set_mouse_autohide);
 448         BIND_REQUIRED_SYMBOL(vte_terminal_reset);
 449         BIND_REQUIRED_SYMBOL(vte_terminal_get_type);
 450         BIND_REQUIRED_SYMBOL(vte_terminal_set_scroll_on_output);
 451         BIND_REQUIRED_SYMBOL(vte_terminal_set_scroll_on_keystroke);
 452         BIND_REQUIRED_SYMBOL(vte_terminal_set_font_from_string);
 453         BIND_REQUIRED_SYMBOL(vte_terminal_set_scrollback_lines);
 454         BIND_REQUIRED_SYMBOL(vte_terminal_get_has_selection);
 455         BIND_REQUIRED_SYMBOL(vte_terminal_copy_clipboard);
 456         BIND_REQUIRED_SYMBOL(vte_terminal_paste_clipboard);
 457         BIND_REQUIRED_SYMBOL(vte_terminal_set_emulation);
 458         BIND_REQUIRED_SYMBOL(vte_terminal_set_color_foreground);
 459         BIND_REQUIRED_SYMBOL(vte_terminal_set_color_bold);
 460         BIND_REQUIRED_SYMBOL(vte_terminal_set_color_background);
 461         BIND_REQUIRED_SYMBOL(vte_terminal_set_background_image_file);
 462         BIND_REQUIRED_SYMBOL(vte_terminal_feed_child);
 463         BIND_REQUIRED_SYMBOL(vte_terminal_im_append_menuitems);
 464         if (! BIND_SYMBOL(vte_terminal_set_cursor_blink_mode))
 465                 /* vte_terminal_set_cursor_blink_mode() is only available since 0.17.1, so if we don't find
 466                  * this symbol, we are probably on an older version and use the old API instead */
 467                 BIND_REQUIRED_SYMBOL(vte_terminal_set_cursor_blinks);
 468         BIND_REQUIRED_SYMBOL(vte_terminal_select_all);
 469         BIND_REQUIRED_SYMBOL(vte_terminal_set_audible_bell);
 470
 471         #undef BIND_REQUIRED_SYMBOL
 472         #undef BIND_SYMBOL
 473
 474         return TRUE;
 475 }
 476
 477
 478 void vte_apply_user_settings(void)
 479 {
 480         if (! ui_prefs.msgwindow_visible)
 481                 return;
 482
 483         vf->vte_terminal_set_scrollback_lines(VTE_TERMINAL(vc->vte), vc->scrollback_lines);
 484         vf->vte_terminal_set_scroll_on_keystroke(VTE_TERMINAL(vc->vte), vc->scroll_on_key);
 485         vf->vte_terminal_set_scroll_on_output(VTE_TERMINAL(vc->vte), vc->scroll_on_out);
 486         vf->vte_terminal_set_emulation(VTE_TERMINAL(vc->vte), vc->emulation);
 487         vf->vte_terminal_set_font_from_string(VTE_TERMINAL(vc->vte), vc->font);
 488         vf->vte_terminal_set_color_foreground(VTE_TERMINAL(vc->vte), &vc->colour_fore);
 489         vf->vte_terminal_set_color_bold(VTE_TERMINAL(vc->vte), &vc->colour_fore);
 490         vf->vte_terminal_set_color_background(VTE_TERMINAL(vc->vte), &vc->colour_back);
 491         vf->vte_terminal_set_background_image_file(VTE_TERMINAL(vc->vte), vc->image);
 492         vf->vte_terminal_set_audible_bell(VTE_TERMINAL(vc->vte), prefs.beep_on_errors);
 493         vte_set_cursor_blink_mode();
 494
 495         override_menu_key();
 496 }
 497
 498
 499 static void vte_popup_menu_clicked(GtkMenuItem *menuitem, gpointer user_data)
 500 {
 501         switch (GPOINTER_TO_INT(user_data))
 502         {
 503                 case POPUP_COPY:
 504                 {
 505                         if (vf->vte_terminal_get_has_selection(VTE_TERMINAL(vc->vte)))
 506                                 vf->vte_terminal_copy_clipboard(VTE_TERMINAL(vc->vte));
 507                         break;
 508                 }
 509                 case POPUP_PASTE:
 510                 {
 511                         vf->vte_terminal_paste_clipboard(VTE_TERMINAL(vc->vte));
 512                         break;
 513                 }
 514                 case POPUP_SELECTALL:
 515                 {
 516                         vte_select_all();
 517                         break;
 518                 }
 519                 case POPUP_CHANGEPATH:
 520                 {
 521                         GeanyDocument *doc = document_get_current();
 522                         if (doc != NULL)
 523                                 vte_cwd(doc->file_name, TRUE);
 524                         break;
 525                 }
 526                 case POPUP_RESTARTTERMINAL:
 527                 {
 528                         vte_restart(vc->vte);
 529                         break;
 530                 }
 531                 case POPUP_PREFERENCES:
 532                 {
 533                         GtkWidget *notebook, *tab_page;
 534
 535                         prefs_show_dialog();
 536
 537                         notebook = ui_lookup_widget(ui_widgets.prefs_dialog, "notebook2");
 538                         tab_page = ui_lookup_widget(ui_widgets.prefs_dialog, "frame_term");
 539
 540                         gtk_notebook_set_current_page(GTK_NOTEBOOK(notebook),
 541                                 gtk_notebook_page_num(GTK_NOTEBOOK(notebook), GTK_WIDGET(tab_page)));
 542
 543                         break;
 544                 }
 545         }
 546 }
 547
 548
 549 static GtkWidget *vte_create_popup_menu(void)
 550 {
 551         GtkWidget *menu, *item;
 552         GtkAccelGroup *accel_group;
 553
 554         menu = gtk_menu_new();
 555
 556         accel_group = gtk_accel_group_new();
 557         gtk_window_add_accel_group(GTK_WINDOW(main_widgets.window), accel_group);
 558
 559         item = gtk_image_menu_item_new_from_stock(GTK_STOCK_COPY, NULL);
 560         gtk_widget_add_accelerator(item, "activate", accel_group,
 561                 GDK_c, GEANY_PRIMARY_MOD_MASK | GDK_SHIFT_MASK, GTK_ACCEL_VISIBLE);
 562         gtk_widget_show(item);
 563         gtk_container_add(GTK_CONTAINER(menu), item);
 564         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_COPY));
 565
 566         item = gtk_image_menu_item_new_from_stock(GTK_STOCK_PASTE, NULL);
 567         gtk_widget_add_accelerator(item, "activate", accel_group,
 568                 GDK_v, GEANY_PRIMARY_MOD_MASK | GDK_SHIFT_MASK, GTK_ACCEL_VISIBLE);
 569         gtk_widget_show(item);
 570         gtk_container_add(GTK_CONTAINER(menu), item);
 571         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_PASTE));
 572
 573         item = gtk_separator_menu_item_new();
 574         gtk_widget_show(item);
 575         gtk_container_add(GTK_CONTAINER(menu), item);
 576
 577         item = gtk_image_menu_item_new_from_stock(GTK_STOCK_SELECT_ALL, NULL);
 578         gtk_widget_show(item);
 579         gtk_container_add(GTK_CONTAINER(menu), item);
 580         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_SELECTALL));
 581
 582         item = gtk_separator_menu_item_new();
 583         gtk_widget_show(item);
 584         gtk_container_add(GTK_CONTAINER(menu), item);
 585
 586         item = gtk_image_menu_item_new_with_mnemonic(_("_Set Path From Document"));
 587         gtk_widget_show(item);
 588         gtk_container_add(GTK_CONTAINER(menu), item);
 589         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_CHANGEPATH));
 590
 591         item = gtk_image_menu_item_new_with_mnemonic(_("_Restart Terminal"));
 592         gtk_widget_show(item);
 593         gtk_container_add(GTK_CONTAINER(menu), item);
 594         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_RESTARTTERMINAL));
 595
 596         item = gtk_separator_menu_item_new();
 597         gtk_widget_show(item);
 598         gtk_container_add(GTK_CONTAINER(menu), item);
 599
 600         item = gtk_image_menu_item_new_from_stock(GTK_STOCK_PREFERENCES, NULL);
 601         gtk_widget_show(item);
 602         gtk_container_add(GTK_CONTAINER(menu), item);
 603         g_signal_connect(item, "activate", G_CALLBACK(vte_popup_menu_clicked), GINT_TO_POINTER(POPUP_PREFERENCES));
 604
 605         msgwin_menu_add_common_items(GTK_MENU(menu));
 606
 607         item = gtk_separator_menu_item_new();
 608         gtk_widget_show(item);
 609         gtk_container_add(GTK_CONTAINER(menu), item);
 610
 611         /* the IM submenu should always be the last item to be consistent with other GTK popup menus */
 612         vc->im_submenu = gtk_menu_new();
 613
 614         item = gtk_image_menu_item_new_with_mnemonic(_("_Input Methods"));
 615         gtk_widget_show(item);
 616         gtk_container_add(GTK_CONTAINER(menu), item);
 617
 618         gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), vc->im_submenu);
 619         /* submenu populated after vte realized */
 620         return menu;
 621 }
 622
 623
 624 /* If the command could be executed, TRUE is returned, FALSE otherwise (i.e. there was some text
 625  * on the prompt). */
 626 gboolean vte_send_cmd(const gchar *cmd)
 627 {
 628         if (clean)
 629         {
 630                 vf->vte_terminal_feed_child(VTE_TERMINAL(vc->vte), cmd, strlen(cmd));
 631                 clean = TRUE; /* vte_terminal_feed_child() also marks the vte as not clean */
 632                 return TRUE;
 633         }
 634         else
 635                 return FALSE;
 636 }
 637
 638
 639 /* Taken from Terminal by os-cillation: terminal_screen_get_working_directory, thanks.
 640  * Determines the working directory using various OS-specific mechanisms and stores the determined
 641  * directory in vte_info.dir. Note: vte_info.dir contains the real path. */
 642 const gchar *vte_get_working_directory(void)
 643 {
 644         gchar  buffer[4096 + 1];
 645         gchar *file;
 646         gchar *cwd;
 647         gint   length;
 648
 649         if (pid > 0)
 650         {
 651                 file = g_strdup_printf("/proc/%d/cwd", pid);
 652                 length = readlink(file, buffer, sizeof(buffer));
 653
 654                 if (length > 0 && *buffer == '/')
 655                 {
 656                         buffer[length] = '\0';
 657                         g_free(vte_info.dir);
 658                         vte_info.dir = g_strdup(buffer);
 659                 }
 660                 else if (length == 0)
 661                 {
 662                         cwd = g_get_current_dir();
 663                         if (cwd != NULL)
 664                         {
 665                                 if (chdir(file) == 0)
 666                                 {
 667                                         g_free(vte_info.dir);
 668                                         vte_info.dir = g_get_current_dir();
 669                                         if (chdir(cwd) != 0)
 670                                                 geany_debug("%s: %s", G_STRFUNC, g_strerror(errno));
 671                                 }
 672                                 g_free(cwd);
 673                         }
 674                 }
 675                 g_free(file);
 676         }
 677
 678         return vte_info.dir;
 679 }
 680
 681
 682 /* Changes the current working directory of the VTE to the path of the given filename.
 683  * filename is expected to be in UTF-8 encoding.
 684  * filename can also be a path, then it is used directly.
 685  * If force is set to TRUE, it will always change the cwd
 686  */
 687 void vte_cwd(const gchar *filename, gboolean force)
 688 {
 689         if (vte_info.have_vte && (vc->follow_path || force) &&
 690                 filename != NULL && g_path_is_absolute(filename))
 691         {
 692                 gchar *path;
 693
 694                 if (g_file_test(filename, G_FILE_TEST_IS_DIR))
 695                         path = g_strdup(filename);
 696                 else
 697                         path = g_path_get_dirname(filename);
 698
 699                 vte_get_working_directory(); /* refresh vte_info.dir */
 700                 if (! utils_str_equal(path, vte_info.dir))
 701                 {
 702                         /* use g_shell_quote to avoid problems with spaces, '!' or something else in path */
 703                         gchar *quoted_path = g_shell_quote(path);
 704                         gchar *cmd = g_strconcat(vc->send_cmd_prefix, "cd ", quoted_path, "\n", NULL);
 705                         if (! vte_send_cmd(cmd))
 706                         {
 707                                 ui_set_statusbar(FALSE,
 708                 _("Could not change the directory in the VTE because it probably contains a command."));
 709                                 geany_debug(
 710                 "Could not change the directory in the VTE because it probably contains a command.");
 711                         }
 712                         g_free(quoted_path);
 713                         g_free(cmd);
 714                 }
 715                 g_free(path);
 716         }
 717 }
 718
 719
 720 static void vte_drag_data_received(GtkWidget *widget, GdkDragContext *drag_context,
 721                                                                    gint x, gint y, GtkSelectionData *data, guint info, guint ltime)
 722 {
 723         if (info == TARGET_TEXT_PLAIN)
 724         {
 725                 if (gtk_selection_data_get_format(data) == 8 && gtk_selection_data_get_length(data) > 0)
 726                         vf->vte_terminal_feed_child(VTE_TERMINAL(widget),
 727                                 (const gchar*) gtk_selection_data_get_data(data),
 728                                 gtk_selection_data_get_length(data));
 729         }
 730         else
 731         {
 732                 gchar *text = (gchar*) gtk_selection_data_get_text(data);
 733                 if (!EMPTY(text))
 734                         vf->vte_terminal_feed_child(VTE_TERMINAL(widget), text, strlen(text));
 735                 g_free(text);
 736         }
 737         gtk_drag_finish(drag_context, TRUE, FALSE, ltime);
 738 }
 739
 740
 741 static void on_check_run_in_vte_toggled(GtkToggleButton *togglebutton, GtkWidget *user_data)
 742 {
 743         g_return_if_fail(GTK_IS_WIDGET(user_data));
 744         gtk_widget_set_sensitive(user_data, gtk_toggle_button_get_active(togglebutton));
 745 }
 746
 747
 748 static void on_term_font_set(GtkFontButton *widget, gpointer user_data)
 749 {
 750         const gchar *fontbtn = gtk_font_button_get_font_name(widget);
 751
 752         if (! utils_str_equal(fontbtn, vc->font))
 753         {
 754                 SETPTR(vc->font, g_strdup(gtk_font_button_get_font_name(widget)));
 755                 vte_apply_user_settings();
 756         }
 757 }
 758
 759
 760 static void on_term_fg_color_set(GtkColorButton *widget, gpointer user_data)
 761 {
 762         gtk_color_button_get_color(widget, &vc->colour_fore);
 763 }
 764
 765
 766 static void on_term_bg_color_set(GtkColorButton *widget, gpointer user_data)
 767 {
 768         gtk_color_button_get_color(widget, &vc->colour_back);
 769 }
 770
 771
 772 void vte_append_preferences_tab(void)
 773 {
 774         if (vte_info.have_vte)
 775         {
 776                 GtkWidget *frame_term, *button_shell, *entry_shell;
 777                 GtkWidget *check_run_in_vte, *check_skip_script;
 778                 GtkWidget *font_button, *fg_color_button, *bg_color_button;
 779                 GtkWidget *entry_image, *button_image;
 780
 781                 button_shell = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "button_term_shell"));
 782                 entry_shell = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "entry_shell"));
 783                 ui_setup_open_button_callback(button_shell, NULL,
 784                         GTK_FILE_CHOOSER_ACTION_OPEN, GTK_ENTRY(entry_shell));
 785
 786                 button_image = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "button_term_image"));
 787                 entry_image = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "entry_image"));
 788                 ui_setup_open_button_callback(button_image, NULL,
 789                         GTK_FILE_CHOOSER_ACTION_OPEN, GTK_ENTRY(entry_image));
 790
 791                 check_skip_script = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "check_skip_script"));
 792                 gtk_widget_set_sensitive(check_skip_script, vc->run_in_vte);
 793
 794                 check_run_in_vte = GTK_WIDGET(ui_lookup_widget(ui_widgets.prefs_dialog, "check_run_in_vte"));
 795                 g_signal_connect(G_OBJECT(check_run_in_vte), "toggled",
 796                         G_CALLBACK(on_check_run_in_vte_toggled), check_skip_script);
 797
 798                 font_button = ui_lookup_widget(ui_widgets.prefs_dialog, "font_term");
 799                 g_signal_connect(font_button, "font-set",  G_CALLBACK(on_term_font_set), NULL);
 800
 801                 fg_color_button = ui_lookup_widget(ui_widgets.prefs_dialog, "color_fore");
 802                 g_signal_connect(fg_color_button, "color-set", G_CALLBACK(on_term_fg_color_set), NULL);
 803
 804                 bg_color_button = ui_lookup_widget(ui_widgets.prefs_dialog, "color_back");
 805                 g_signal_connect(bg_color_button, "color-set", G_CALLBACK(on_term_bg_color_set), NULL);
 806
 807                 frame_term = ui_lookup_widget(ui_widgets.prefs_dialog, "frame_term");
 808                 gtk_widget_show_all(frame_term);
 809         }
 810 }
 811
 812
 813 void vte_select_all(void)
 814 {
 815         if (vf->vte_terminal_select_all != NULL)
 816                 vf->vte_terminal_select_all(VTE_TERMINAL(vc->vte));
 817 }
 818
 819
 820 void vte_send_selection_to_vte(void)
 821 {
 822         GeanyDocument *doc;
 823         gchar *text;
 824         gsize len;
 825
 826         doc = document_get_current();
 827         g_return_if_fail(doc != NULL);
 828
 829         if (sci_has_selection(doc->editor->sci))
 830         {
 831                 text = sci_get_selection_contents(doc->editor->sci);
 832         }
 833         else
 834         {       /* Get the current line */
 835                 gint line_num = sci_get_current_line(doc->editor->sci);
 836                 text = sci_get_line(doc->editor->sci, line_num);
 837         }
 838
 839         len = strlen(text);
 840
 841         if (vc->send_selection_unsafe)
 842         {       /* Explicitly append a trailing newline character to get the command executed,
 843                    this is disabled by default as it could cause all sorts of damage. */
 844                 if (text[len-1] != '\n' && text[len-1] != '\r')
 845                 {
 846                         SETPTR(text, g_strconcat(text, "\n", NULL));
 847                         len++;
 848                 }
 849         }
 850         else
 851         {       /* Make sure there is no newline character at the end to prevent unwanted execution */
 852                 while (text[len-1] == '\n' || text[len-1] == '\r')
 853                 {
 854                         text[len-1] = '\0';
 855                         len--;
 856                 }
 857         }
 858
 859         vf->vte_terminal_feed_child(VTE_TERMINAL(vc->vte), text, len);
 860
 861         /* show the VTE */
 862         gtk_notebook_set_current_page(GTK_NOTEBOOK(msgwindow.notebook), MSG_VTE);
 863         gtk_widget_grab_focus(vc->vte);
 864         msgwin_show_hide(TRUE);
 865
 866         g_free(text);
 867 }
 868
 869
 870 #endif