path: root/src/tab-label.c

/*
 * Tab label
 *
 * Copyright (C) 2017  Patrick McDermott
 *
 * This file is part of Marquee.
 *
 * Marquee is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Marquee is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Marquee.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "tab-label.h"

#include <glib.h>
#include <gtk/gtk.h>
#include <webkit2/webkit2.h>

#include "i18n.h"
#include "notebook.h"
#include "tab-page.h"
#include "web-view.h"

#define SCROLLED_TITLE_FMT "<span font_family=\"monospace\">%s</span>"

struct _MqTabLabel {
	GtkEventBox    parent_instance;
	MqTabPage     *tab_page;
	WebKitWebView *web_view;
	GtkWidget     *image;
	GtkWidget     *label;
	guint          position;
	gchar         *title;
	gboolean       scrolling;
	gchar         *scrolled_title;
	gchar         *scrolled_markup;
	GtkWidget     *popover;
	GtkWidget     *name_popover;
	GtkWidget     *name_entry;
};

enum {
	PROP_TAB_PAGE = 1,
	PROP_WEB_VIEW,
	N_PROPERTIES
};

static GParamSpec *obj_properties[N_PROPERTIES] = {NULL,};

struct _MqTabLabelClass {
	GtkEventBoxClass parent_class;
};

G_DEFINE_TYPE(MqTabLabel, mq_tab_label, GTK_TYPE_EVENT_BOX)

static void
reload_tab_clicked_cb(GtkWidget G_GNUC_UNUSED *button, MqTabLabel *tab_label)
{
	webkit_web_view_reload(tab_label->web_view);
	gtk_widget_hide(tab_label->popover);
}

static void
close_clicked_cb(GtkWidget G_GNUC_UNUSED *button, MqTabLabel *tab_label)
{
	/* This callback handles both the close button on the tab label and the
	 * one on the popover.  Closing the tab automatically hides the popover,
	 * so don't bother conditionally hiding it if it's shown. */

	mq_tab_page_close(tab_label->tab_page);
}

static void
new_tab_clicked_cb(GtkWidget G_GNUC_UNUSED *button, MqTabLabel *tab_label)
{
	mq_notebook_insert_sibling(
		MQ_NOTEBOOK(gtk_widget_get_parent(GTK_WIDGET(tab_label))),
		NULL,
		tab_label->tab_page,
		TRUE);
	gtk_widget_hide(tab_label->popover);
}

static void
new_window_clicked_cb(GtkWidget G_GNUC_UNUSED *button, MqTabLabel *tab_label)
{
	mq_application_add_window(
		mq_tab_page_get_application(tab_label->tab_page), NULL);
	gtk_widget_hide(tab_label->popover);
}

#define BUTTON_ROWS 2
#define BUTTON_COLS 4
#define NEW_BUTTON(Y, X, ICON, TOOLTIP) \
	G_STMT_START { \
		buttons[Y * BUTTON_COLS + X] = gtk_button_new_from_icon_name(\
			ICON, GTK_ICON_SIZE_BUTTON); \
		gtk_widget_set_tooltip_text(buttons[Y * BUTTON_COLS + X], \
			TOOLTIP); \
		gtk_widget_set_can_focus(buttons[Y * BUTTON_COLS + X], FALSE); \
		gtk_grid_attach(GTK_GRID(button_grid), \
			buttons[Y * BUTTON_COLS + X], X, Y, 1, 1); \
	} G_STMT_END
#define CLICKED_CB(Y, X, CB) \
	g_signal_connect(buttons[Y * BUTTON_COLS + X], "clicked", \
		G_CALLBACK(CB), tab_label)

static void
create_tab_popover(GtkWidget *widget, MqTabLabel *tab_label)
{
	GtkWidget *button_grid;
	GtkWidget *buttons[BUTTON_ROWS * BUTTON_COLS];

	/* Set up button grid. */
	button_grid = gtk_grid_new();
	gtk_widget_set_halign(button_grid, GTK_ALIGN_CENTER);

	/* Set up buttons. */
	NEW_BUTTON(0, 0, "view-refresh",       _("Reload tab"));
	NEW_BUTTON(0, 1, "edit-copy",          _("Duplicate tab"));
	NEW_BUTTON(0, 2, "window-new",         _("Move tab to new window"));
	NEW_BUTTON(0, 3, "window-close",       _("Close tab"));
	NEW_BUTTON(1, 0, "tab-new-symbolic",   _("New tab"));
	NEW_BUTTON(1, 1, "window-new",         _("New window"));
	NEW_BUTTON(1, 2, "edit-undo",          _("Undo close tab"));

	CLICKED_CB(0, 0, reload_tab_clicked_cb);
	/* TODO: 0, 1: Duplicate tab */
	gtk_widget_set_sensitive(buttons[0 * BUTTON_COLS + 1], FALSE);
	/* TODO: 0, 2: Move tab to new window */
	gtk_widget_set_sensitive(buttons[0 * BUTTON_COLS + 2], FALSE);
	CLICKED_CB(0, 3, close_clicked_cb);
	CLICKED_CB(1, 0, new_tab_clicked_cb);
	CLICKED_CB(1, 1, new_window_clicked_cb);
	/* TODO: 1, 2: Undo close tab */
	gtk_widget_set_sensitive(buttons[1 * BUTTON_COLS + 2], FALSE);

	/* Set up the popover. */
	tab_label->popover = gtk_popover_new(widget);
	gtk_container_add(GTK_CONTAINER(tab_label->popover), button_grid);

	/* NB: gtk_popover_popup() is new in GTK+ 3.22. */
	gtk_widget_show_all(tab_label->popover);
}

#undef BUTTON_ROWS
#undef BUTTON_COLS
#undef NEW_BUTTON
#undef CLICKED_CB

static void
set_image(MqTabLabel *tab_label, GdkPixbuf *favicon)
{
	if (favicon) {
		gtk_image_set_from_pixbuf(GTK_IMAGE(tab_label->image), favicon);
	} else {
		gtk_image_set_from_icon_name(GTK_IMAGE(tab_label->image),
			"text-html", GTK_ICON_SIZE_BUTTON);
	}
}

static void
update_label(MqTabLabel *tab_label)
{
	gchar *label;

	if (tab_label->scrolling) {
		label = g_strdup_printf("%u. %s", tab_label->position,
			tab_label->scrolled_markup);
		gtk_label_set_markup(GTK_LABEL(tab_label->label), label);
	} else {
		label = g_strdup_printf("%u. %s", tab_label->position,
			tab_label->title);
		gtk_label_set_text(GTK_LABEL(tab_label->label), label);
		gtk_label_set_use_markup(GTK_LABEL(tab_label->label), FALSE);
	}
	g_free(label);
}

static void
set_title(MqTabLabel *tab_label, const gchar *title)
{
	g_free(tab_label->title);
	tab_label->title = g_strdup(title);
	if (tab_label->scrolling) {
		g_free(tab_label->scrolled_title);
		g_free(tab_label->scrolled_markup);
		tab_label->scrolled_title = g_strdup_printf("%s    ", title);
		tab_label->scrolled_markup =
			g_markup_printf_escaped(SCROLLED_TITLE_FMT,
				tab_label->scrolled_title);
	}
	update_label(tab_label);
	gtk_widget_set_tooltip_text(GTK_WIDGET(tab_label), tab_label->title);
}

static void
favicon_cb(WebKitWebView G_GNUC_UNUSED *web_view,
	GParamSpec G_GNUC_UNUSED *param_spec, MqTabLabel *tab_label)
{
	cairo_surface_t *surface;
	GdkPixbuf       *pixbuf;
	GdkPixbuf       *scaled_pixbuf;

	surface = webkit_web_view_get_favicon(tab_label->web_view);
	scaled_pixbuf = NULL;
	if (surface) {
		pixbuf = gdk_pixbuf_get_from_surface(surface, 0, 0,
			cairo_image_surface_get_width(surface),
			cairo_image_surface_get_height(surface));
		if (pixbuf) {
			scaled_pixbuf = gdk_pixbuf_scale_simple(pixbuf, 16, 16,
				GDK_INTERP_BILINEAR);
			g_object_unref(pixbuf);
		}
	}

	set_image(tab_label, scaled_pixbuf);
}

static void
title_cb(WebKitWebView G_GNUC_UNUSED *web_view,
	GParamSpec G_GNUC_UNUSED *param_spec, MqTabLabel *tab_label)
{
	set_title(tab_label, webkit_web_view_get_title(tab_label->web_view));
}

static void
set_web_view(MqTabLabel *tab_label, MqWebView *web_view)
{
	tab_label->web_view = WEBKIT_WEB_VIEW(web_view);

	g_signal_connect(web_view, "notify::favicon",
		G_CALLBACK(favicon_cb), tab_label);
	g_signal_connect(web_view, "notify::title",
		G_CALLBACK(title_cb), tab_label);
}

static void
set_custom_title(MqTabLabel *tab_label, const gchar *title)
{
	/* TODO: Handle empty string.  Set custom title instead of overriding
	 * (temporarily) regular title. */
	mq_tab_page_set_title(tab_label->tab_page, title);
	set_title(tab_label, title);
}

static gboolean
name_entry_key_press_event_cb(GtkEntry G_GNUC_UNUSED *entry, GdkEventKey *event,
	MqTabLabel *tab_label)
{
	switch (event->keyval) {
		case GDK_KEY_Escape:
			gtk_widget_hide(tab_label->name_popover);
			return TRUE;
		case GDK_KEY_Return:
		case GDK_KEY_KP_Enter:
		case GDK_KEY_ISO_Enter:
			set_custom_title(tab_label, gtk_entry_get_text(
					GTK_ENTRY(tab_label->name_entry)));
			gtk_widget_hide(tab_label->name_popover);
			return TRUE;
		default:
			return FALSE;
	}
}

static void
name_entry_changed_cb(GtkEditable *editable, G_GNUC_UNUSED gpointer user_data)
{
	GtkEntry    *entry;
	const gchar *text;
	const gchar *icon;

	entry = GTK_ENTRY(editable);

	text = gtk_entry_get_text(entry);
	if (text && text[0]) {
		icon = "edit-clear-symbolic";
	} else {
		icon = NULL;
	}

	gtk_entry_set_icon_from_icon_name(entry, GTK_ENTRY_ICON_SECONDARY,
		icon);
	gtk_entry_set_icon_activatable(entry, GTK_ENTRY_ICON_SECONDARY,
		icon ? TRUE : FALSE);
	gtk_entry_set_icon_sensitive(entry, GTK_ENTRY_ICON_SECONDARY,
		icon ? TRUE : FALSE);
}

static void
name_entry_icon_press_cb(GtkEntry *entry, GtkEntryIconPosition icon_pos,
	G_GNUC_UNUSED GdkEvent *event, G_GNUC_UNUSED gpointer user_data)
{
	if (icon_pos == GTK_ENTRY_ICON_SECONDARY) {
		gtk_entry_set_text(entry, "");
	}
}

static void
name_close_clicked_cb(G_GNUC_UNUSED GtkButton *button, MqTabLabel *tab_label)
{
	set_custom_title(tab_label, gtk_entry_get_text(
			GTK_ENTRY(tab_label->name_entry)));
	gtk_widget_hide(tab_label->name_popover);
}

static void
create_name_popover(MqTabLabel *tab_label)
{
	GtkWidget *close_button;
	GtkWidget *box;

	/* Title entry */
	tab_label->name_entry = gtk_entry_new();
	g_signal_connect(tab_label->name_entry, "key-press-event",
		G_CALLBACK(name_entry_key_press_event_cb), tab_label);
	g_signal_connect(GTK_EDITABLE(tab_label->name_entry), "changed",
		G_CALLBACK(name_entry_changed_cb), NULL);
	g_signal_connect(GTK_ENTRY(tab_label->name_entry), "icon-press",
		G_CALLBACK(name_entry_icon_press_cb), NULL);
	gtk_entry_set_text(GTK_ENTRY(tab_label->name_entry), tab_label->title);

	/* Close button */
	close_button = gtk_button_new_from_icon_name("window-close",
		GTK_ICON_SIZE_BUTTON);
	gtk_button_set_relief(GTK_BUTTON(close_button), GTK_RELIEF_NONE);
	gtk_widget_set_tooltip_text(close_button, _("Rename tab"));
	gtk_widget_set_can_focus(close_button, FALSE);
	g_signal_connect(close_button, "clicked",
		G_CALLBACK(name_close_clicked_cb), tab_label);

	/* Box */
	box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
	gtk_box_pack_start(GTK_BOX(box), tab_label->name_entry, FALSE, FALSE,
		0);
	gtk_box_pack_end(GTK_BOX(box), close_button, FALSE, FALSE, 0);

	/* Set up the popover. */
	tab_label->name_popover = gtk_popover_new(GTK_WIDGET(tab_label));
	gtk_container_add(GTK_CONTAINER(tab_label->name_popover), box);

	/* NB: gtk_popover_popup() is new in GTK+ 3.22. */
	gtk_widget_show_all(tab_label->name_popover);
}

static gboolean
button_press_cb(GtkWidget *widget, GdkEventButton *event,
	MqTabLabel *tab_label)
{
	if (event->type == GDK_2BUTTON_PRESS) {
		create_name_popover(tab_label);
	} else if (event->button == 2) {
		mq_tab_page_close(tab_label->tab_page);
	} else if (event->button == 3) {
		create_tab_popover(widget, tab_label);
	}

	return FALSE;
}

static void
finalize(GObject *object)
{
	MqTabLabel *tab_label;

	tab_label = MQ_TAB_LABEL(object);

	g_free(tab_label->scrolled_title);
	g_free(tab_label->scrolled_markup);

	G_OBJECT_CLASS(mq_tab_label_parent_class)->finalize(object);
}

static void
get_property(GObject *object, guint property_id, GValue *value,
	GParamSpec *param_spec)
{
	MqTabLabel *tab_label;

	tab_label = MQ_TAB_LABEL(object);

	switch (property_id) {
		case PROP_TAB_PAGE:
			g_value_set_object(value, tab_label->tab_page);
			break;
		case PROP_WEB_VIEW:
			g_value_set_object(value, tab_label->web_view);
			break;
		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id,
				param_spec);
			break;
	}
}

static void
set_property(GObject *object, guint property_id, const GValue *value,
	GParamSpec *param_spec)
{
	MqTabLabel *tab_label;

	tab_label = MQ_TAB_LABEL(object);

	switch (property_id) {
		case PROP_TAB_PAGE:
			tab_label->tab_page = g_value_get_object(value);
			break;
		case PROP_WEB_VIEW:
			set_web_view(tab_label, g_value_get_object(value));
			break;
		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id,
				param_spec);
			break;
	}
}

static void
mq_tab_label_class_init(MqTabLabelClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS(klass);

	object_class->finalize     = finalize;
	object_class->get_property = get_property;
	object_class->set_property = set_property;

	obj_properties[PROP_TAB_PAGE] = g_param_spec_object(
		"tab-page",
		P_("MqTabPage"),
		P_("The ancestral MqTabPage instance"),
		MQ_TYPE_TAB_PAGE,
		G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
		G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB);
	obj_properties[PROP_WEB_VIEW] = g_param_spec_object(
		"web-view",
		P_("MqWebView"),
		P_("The associated MqWebView instance"),
		MQ_TYPE_WEB_VIEW,
		G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
		G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB);
	g_object_class_install_properties(object_class, N_PROPERTIES,
		obj_properties);
}

static void
mq_tab_label_init(MqTabLabel *tab_label)
{
	GtkWidget *close_button;
	GtkWidget *box;

	tab_label->title = g_strdup(_("New Tab"));

	/* Set up tab image. */
	tab_label->image = gtk_image_new_from_icon_name("text-html",
		GTK_ICON_SIZE_BUTTON);

	/* Set up tab label. */
	tab_label->label = gtk_label_new(NULL);
	gtk_label_set_ellipsize(GTK_LABEL(tab_label->label),
		PANGO_ELLIPSIZE_END);
	gtk_widget_set_hexpand(tab_label->label, TRUE);
	gtk_widget_set_size_request(tab_label->label, 50, 1);

	/* Set up close button. */
	close_button = gtk_button_new_from_icon_name("window-close",
		GTK_ICON_SIZE_BUTTON);
	gtk_button_set_relief(GTK_BUTTON(close_button), GTK_RELIEF_NONE);
	gtk_widget_set_tooltip_text(close_button, _("Close tab"));
	g_signal_connect(close_button, "clicked",
		G_CALLBACK(close_clicked_cb), tab_label);

	/* Pack tab box. */
	box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
	gtk_box_pack_start(GTK_BOX(box), tab_label->image, FALSE, FALSE, 0);
	gtk_box_pack_start(GTK_BOX(box), tab_label->label, TRUE, TRUE, 0);
	gtk_box_pack_start(GTK_BOX(box), close_button, FALSE, FALSE, 0);
	gtk_widget_show_all(box);

	/* Set up event box. */
	g_signal_connect(tab_label, "button-press-event",
		G_CALLBACK(button_press_cb), tab_label);
	gtk_event_box_set_visible_window(GTK_EVENT_BOX(tab_label), FALSE);
	gtk_container_add(GTK_CONTAINER(tab_label), box);
}

GtkWidget *
mq_tab_label_new(MqTabPage *tab_page, MqWebView *web_view)
{
	return g_object_new(MQ_TYPE_TAB_LABEL,
		"tab-page", tab_page,
		"web-view", web_view,
		NULL);
}

void
mq_tab_label_set_position(MqTabLabel *tab_label, guint position)
{
	tab_label->position = position;
	update_label(tab_label);
}

void
mq_tab_label_begin_scrolling(MqTabLabel *tab_label)
{
	if (tab_label->scrolling) {
		/* Avoid leaking tab_label->scrolled_title and
		 * tab_label->scrolled_markup. */
		return;
	}

	tab_label->scrolling = TRUE;
	tab_label->scrolled_title = g_strdup_printf("%s    ", tab_label->title);
	tab_label->scrolled_markup = g_markup_printf_escaped(SCROLLED_TITLE_FMT,
		tab_label->scrolled_title);
}

void
mq_tab_label_end_scrolling(MqTabLabel *tab_label)
{
	tab_label->scrolling = FALSE;
	g_free(tab_label->scrolled_title);
	g_free(tab_label->scrolled_markup);
	tab_label->scrolled_title = NULL;
	tab_label->scrolled_markup = NULL;

	update_label(tab_label);
}

void
mq_tab_label_scroll(MqTabLabel *tab_label)
{
	gchar c[5];  /* Up to 4 bytes for a UTF-8 character, plus NUL */
	gsize i;
	gsize j;

	/* Save the first (possibly multibyte) character. */
	c[0] = tab_label->scrolled_title[0];
	for (i = 1; tab_label->scrolled_title[i] & 0x80; ++i) {
		c[i] = tab_label->scrolled_title[i];
	}
	c[i] = '\0';

	/* Shift all characters. */
	for (j = 0; tab_label->scrolled_title[i]; ++i, ++j) {
		tab_label->scrolled_title[j] = tab_label->scrolled_title[i];
	}

	/* Set the last (possibly multibyte) character. */
	for (--j, i = 0; c[i]; ++i, ++j) {
		tab_label->scrolled_title[j] = c[i];
	}

	g_free(tab_label->scrolled_markup);
	tab_label->scrolled_markup = g_markup_printf_escaped(SCROLLED_TITLE_FMT,
		tab_label->scrolled_title);
	update_label(tab_label);
}