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