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