src/vte.c

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