Blame gtksourceview/gtksourcegutterrendererlines.c

Packit a7d494
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8; coding: utf-8 -*-
Packit a7d494
 * gtksourcegutterrendererlines.c
Packit a7d494
 * This file is part of GtkSourceView
Packit a7d494
 *
Packit a7d494
 * Copyright (C) 2010 - Jesse van den Kieboom
Packit a7d494
 *
Packit a7d494
 * GtkSourceView is free software; you can redistribute it and/or
Packit a7d494
 * modify it under the terms of the GNU Lesser General Public
Packit a7d494
 * License as published by the Free Software Foundation; either
Packit a7d494
 * version 2.1 of the License, or (at your option) any later version.
Packit a7d494
 *
Packit a7d494
 * GtkSourceView is distributed in the hope that it will be useful,
Packit a7d494
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a7d494
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit a7d494
 * Lesser General Public License for more details.
Packit a7d494
 *
Packit a7d494
 * You should have received a copy of the GNU Lesser General Public
Packit a7d494
 * License along with this library; if not, write to the Free Software
Packit a7d494
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
Packit a7d494
 */
Packit a7d494
Packit a7d494
#ifdef HAVE_CONFIG_H
Packit a7d494
#include <config.h>
Packit a7d494
#endif
Packit a7d494
Packit a7d494
#include "gtksourcegutterrendererlines.h"
Packit a7d494
#include "gtksourceview.h"
Packit a7d494
Packit a7d494
struct _GtkSourceGutterRendererLinesPrivate
Packit a7d494
{
Packit a7d494
	gint num_line_digits;
Packit a7d494
	gint prev_line_num;
Packit a7d494
	guint cursor_visible : 1;
Packit a7d494
};
Packit a7d494
Packit a7d494
G_DEFINE_TYPE_WITH_PRIVATE (GtkSourceGutterRendererLines, gtk_source_gutter_renderer_lines, GTK_SOURCE_TYPE_GUTTER_RENDERER_TEXT)
Packit a7d494
Packit a7d494
static GtkTextBuffer *
Packit a7d494
get_buffer (GtkSourceGutterRendererLines *renderer)
Packit a7d494
{
Packit a7d494
	GtkTextView *view;
Packit a7d494
Packit a7d494
	view = gtk_source_gutter_renderer_get_view (GTK_SOURCE_GUTTER_RENDERER (renderer));
Packit a7d494
Packit a7d494
	return view != NULL ? gtk_text_view_get_buffer (view) : NULL;
Packit a7d494
}
Packit a7d494
Packit a7d494
static inline gint
Packit a7d494
count_num_digits (gint num_lines)
Packit a7d494
{
Packit a7d494
	if (num_lines < 100)
Packit a7d494
	{
Packit a7d494
		return 2;
Packit a7d494
	}
Packit a7d494
	else if (num_lines < 1000)
Packit a7d494
	{
Packit a7d494
		return 3;
Packit a7d494
	}
Packit a7d494
	else if (num_lines < 10000)
Packit a7d494
	{
Packit a7d494
		return 4;
Packit a7d494
	}
Packit a7d494
	else if (num_lines < 100000)
Packit a7d494
	{
Packit a7d494
		return 5;
Packit a7d494
	}
Packit a7d494
	else if (num_lines < 1000000)
Packit a7d494
	{
Packit a7d494
		return 6;
Packit a7d494
	}
Packit a7d494
	else
Packit a7d494
	{
Packit a7d494
		return 10;
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
recalculate_size (GtkSourceGutterRendererLines *renderer)
Packit a7d494
{
Packit a7d494
	gint num_lines;
Packit a7d494
	gint num_digits = 0;
Packit a7d494
	GtkTextBuffer *buffer;
Packit a7d494
Packit a7d494
	buffer = get_buffer (renderer);
Packit a7d494
Packit a7d494
	num_lines = gtk_text_buffer_get_line_count (buffer);
Packit a7d494
Packit a7d494
	num_digits = count_num_digits (num_lines);
Packit a7d494
Packit a7d494
	if (num_digits != renderer->priv->num_line_digits)
Packit a7d494
	{
Packit a7d494
		gchar markup[24];
Packit a7d494
		gint size;
Packit a7d494
Packit a7d494
		renderer->priv->num_line_digits = num_digits;
Packit a7d494
Packit a7d494
		num_lines = MAX (num_lines, 99);
Packit a7d494
Packit a7d494
		g_snprintf (markup, sizeof markup, "%d", num_lines);
Packit a7d494
		gtk_source_gutter_renderer_text_measure_markup (GTK_SOURCE_GUTTER_RENDERER_TEXT (renderer),
Packit a7d494
		                                                markup,
Packit a7d494
		                                                &size,
Packit a7d494
		                                                NULL);
Packit a7d494
Packit a7d494
		gtk_source_gutter_renderer_set_size (GTK_SOURCE_GUTTER_RENDERER (renderer),
Packit a7d494
		                                     size);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
on_buffer_changed (GtkSourceBuffer              *buffer,
Packit a7d494
                   GtkSourceGutterRendererLines *renderer)
Packit a7d494
{
Packit a7d494
	recalculate_size (renderer);
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gutter_renderer_change_buffer (GtkSourceGutterRenderer *renderer,
Packit a7d494
                               GtkTextBuffer           *old_buffer)
Packit a7d494
{
Packit a7d494
	GtkSourceGutterRendererLines *lines = GTK_SOURCE_GUTTER_RENDERER_LINES (renderer);
Packit a7d494
	GtkTextBuffer *buffer;
Packit a7d494
Packit a7d494
	if (old_buffer != NULL)
Packit a7d494
	{
Packit a7d494
		g_signal_handlers_disconnect_by_func (old_buffer,
Packit a7d494
						      on_buffer_changed,
Packit a7d494
						      lines);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	buffer = get_buffer (lines);
Packit a7d494
Packit a7d494
	if (buffer != NULL)
Packit a7d494
	{
Packit a7d494
		g_signal_connect_object (buffer,
Packit a7d494
					 "changed",
Packit a7d494
					 G_CALLBACK (on_buffer_changed),
Packit a7d494
					 lines,
Packit a7d494
					 0);
Packit a7d494
Packit a7d494
		recalculate_size (lines);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	lines->priv->prev_line_num = 0;
Packit a7d494
Packit a7d494
	if (GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->change_buffer != NULL)
Packit a7d494
	{
Packit a7d494
		GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->change_buffer (renderer,
Packit a7d494
														 old_buffer);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
on_view_style_updated (GtkTextView                  *view,
Packit a7d494
		       GtkSourceGutterRendererLines *renderer)
Packit a7d494
{
Packit a7d494
	/* Force to recalculate the size. */
Packit a7d494
	renderer->priv->num_line_digits = -1;
Packit a7d494
	recalculate_size (renderer);
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
on_view_notify_cursor_visible (GtkTextView                  *view,
Packit a7d494
                               GParamSpec                   *pspec,
Packit a7d494
                               GtkSourceGutterRendererLines *renderer)
Packit a7d494
{
Packit a7d494
	renderer->priv->cursor_visible = gtk_text_view_get_cursor_visible (view);
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gutter_renderer_change_view (GtkSourceGutterRenderer *renderer,
Packit a7d494
			     GtkTextView             *old_view)
Packit a7d494
{
Packit a7d494
	GtkTextView *new_view;
Packit a7d494
Packit a7d494
	if (old_view != NULL)
Packit a7d494
	{
Packit a7d494
		g_signal_handlers_disconnect_by_func (old_view,
Packit a7d494
						      on_view_style_updated,
Packit a7d494
						      renderer);
Packit a7d494
		g_signal_handlers_disconnect_by_func (old_view,
Packit a7d494
						      on_view_notify_cursor_visible,
Packit a7d494
						      renderer);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	new_view = gtk_source_gutter_renderer_get_view (renderer);
Packit a7d494
Packit a7d494
	if (new_view != NULL)
Packit a7d494
	{
Packit a7d494
		g_signal_connect_object (new_view,
Packit a7d494
					 "style-updated",
Packit a7d494
					 G_CALLBACK (on_view_style_updated),
Packit a7d494
					 renderer,
Packit a7d494
					 0);
Packit a7d494
Packit a7d494
		g_signal_connect_object (new_view,
Packit a7d494
					 "notify::cursor-visible",
Packit a7d494
					 G_CALLBACK (on_view_notify_cursor_visible),
Packit a7d494
					 renderer,
Packit a7d494
					 0);
Packit a7d494
Packit a7d494
		GTK_SOURCE_GUTTER_RENDERER_LINES (renderer)->priv->cursor_visible = gtk_text_view_get_cursor_visible (new_view);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	if (GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->change_view != NULL)
Packit a7d494
	{
Packit a7d494
		GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->change_view (renderer,
Packit a7d494
													       old_view);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gutter_renderer_query_data (GtkSourceGutterRenderer      *renderer,
Packit a7d494
                            GtkTextIter                  *start,
Packit a7d494
                            GtkTextIter                  *end,
Packit a7d494
                            GtkSourceGutterRendererState  state)
Packit a7d494
{
Packit a7d494
	GtkSourceGutterRendererLines *lines = GTK_SOURCE_GUTTER_RENDERER_LINES (renderer);
Packit a7d494
	gchar text[24];
Packit a7d494
	gint line;
Packit a7d494
	gint len;
Packit a7d494
	gboolean current_line;
Packit a7d494
Packit a7d494
	line = gtk_text_iter_get_line (start) + 1;
Packit a7d494
Packit a7d494
	current_line = (state & GTK_SOURCE_GUTTER_RENDERER_STATE_CURSOR) &&
Packit a7d494
	               lines->priv->cursor_visible;
Packit a7d494
Packit a7d494
	if (current_line)
Packit a7d494
	{
Packit a7d494
		len = g_snprintf (text, sizeof text, "%d", line);
Packit a7d494
	}
Packit a7d494
	else
Packit a7d494
	{
Packit a7d494
		len = g_snprintf (text, sizeof text, "%d", line);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	gtk_source_gutter_renderer_text_set_markup (GTK_SOURCE_GUTTER_RENDERER_TEXT (renderer),
Packit a7d494
	                                            text,
Packit a7d494
	                                            len);
Packit a7d494
}
Packit a7d494
Packit a7d494
static gint
Packit a7d494
get_last_visible_line_number (GtkSourceGutterRendererLines *lines)
Packit a7d494
{
Packit a7d494
	GtkTextView *view;
Packit a7d494
	GdkRectangle visible_rect;
Packit a7d494
	GtkTextIter iter;
Packit a7d494
Packit a7d494
	view = gtk_source_gutter_renderer_get_view (GTK_SOURCE_GUTTER_RENDERER (lines));
Packit a7d494
Packit a7d494
	gtk_text_view_get_visible_rect (view, &visible_rect);
Packit a7d494
Packit a7d494
	gtk_text_view_get_line_at_y (view,
Packit a7d494
				     &iter,
Packit a7d494
				     visible_rect.y + visible_rect.height,
Packit a7d494
				     NULL);
Packit a7d494
Packit a7d494
	gtk_text_iter_forward_line (&iter);
Packit a7d494
Packit a7d494
	return gtk_text_iter_get_line (&iter);
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gutter_renderer_end (GtkSourceGutterRenderer *renderer)
Packit a7d494
{
Packit a7d494
	GtkSourceGutterRendererLines *lines = GTK_SOURCE_GUTTER_RENDERER_LINES (renderer);
Packit a7d494
	GtkTextBuffer *buffer = get_buffer (lines);
Packit a7d494
Packit a7d494
	if (buffer != NULL)
Packit a7d494
	{
Packit a7d494
		gint line_num = get_last_visible_line_number (lines);
Packit a7d494
Packit a7d494
		/* When the text is modified in a GtkTextBuffer, GtkTextView tries to
Packit a7d494
		 * redraw the smallest required region. But the information displayed in
Packit a7d494
		 * the gutter may become invalid in a bigger region.
Packit a7d494
		 * See https://bugzilla.gnome.org/show_bug.cgi?id=732418 for an example
Packit a7d494
		 * where line numbers are not updated correctly when splitting a wrapped
Packit a7d494
		 * line.
Packit a7d494
		 * The performances should not be a big problem here. Correctness is
Packit a7d494
		 * more important than performances. It just triggers a second
Packit a7d494
		 * draw.
Packit a7d494
		 * The queue_draw() is called in gutter_renderer_end(), because
Packit a7d494
		 * the first draw is anyway needed to avoid flickering (if the
Packit a7d494
		 * first draw is not done, there will be a white region in the
Packit a7d494
		 * gutter during one frame).
Packit a7d494
		 * Another solution that has better performances is to compare
Packit a7d494
		 * the total number of lines in the buffer, instead of the last
Packit a7d494
		 * visible line. But it has the drawback that the gutter is
Packit a7d494
		 * continuously redrawn during file loading.
Packit a7d494
		 *
Packit a7d494
		 * FIXME A better solution would be to add a vfunc in the
Packit a7d494
		 * GutterRenderer so that the Gutter can ask each renderer for
Packit a7d494
		 * the invalidation region, before drawing. So that only one
Packit a7d494
		 * draw is needed, and the solution would be more generic (if
Packit a7d494
		 * other renderers also need a different invalidation region
Packit a7d494
		 * than the GtkTextView). But the GutterRendererClass doesn't
Packit a7d494
		 * have padding for future expansion, so it must wait for
Packit a7d494
		 * GtkSourceView 4.
Packit a7d494
		 */
Packit a7d494
		if (lines->priv->prev_line_num != line_num)
Packit a7d494
		{
Packit a7d494
			lines->priv->prev_line_num = line_num;
Packit a7d494
			gtk_source_gutter_renderer_queue_draw (renderer);
Packit a7d494
		}
Packit a7d494
	}
Packit a7d494
Packit a7d494
	if (GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->end != NULL)
Packit a7d494
	{
Packit a7d494
		GTK_SOURCE_GUTTER_RENDERER_CLASS (gtk_source_gutter_renderer_lines_parent_class)->end (renderer);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
extend_selection_to_line (GtkSourceGutterRendererLines *renderer,
Packit a7d494
                          GtkTextIter                  *line_start)
Packit a7d494
{
Packit a7d494
	GtkTextIter start;
Packit a7d494
	GtkTextIter end;
Packit a7d494
	GtkTextIter line_end;
Packit a7d494
	GtkTextBuffer *buffer;
Packit a7d494
Packit a7d494
	buffer = get_buffer (renderer);
Packit a7d494
Packit a7d494
	gtk_text_buffer_get_selection_bounds (buffer,
Packit a7d494
	                                      &start,
Packit a7d494
	                                      &end;;
Packit a7d494
Packit a7d494
	line_end = *line_start;
Packit a7d494
Packit a7d494
	if (!gtk_text_iter_ends_line (&line_end))
Packit a7d494
	{
Packit a7d494
		gtk_text_iter_forward_to_line_end (&line_end);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	if (gtk_text_iter_compare (&start, line_start) < 0)
Packit a7d494
	{
Packit a7d494
		gtk_text_buffer_select_range (buffer,
Packit a7d494
		                              &start,
Packit a7d494
		                              &line_end);
Packit a7d494
	}
Packit a7d494
	else if (gtk_text_iter_compare (&end, &line_end) < 0)
Packit a7d494
	{
Packit a7d494
		/* if the selection is in this line, extend
Packit a7d494
		 * the selection to the whole line */
Packit a7d494
		gtk_text_buffer_select_range (buffer,
Packit a7d494
		                              &line_end,
Packit a7d494
		                              line_start);
Packit a7d494
	}
Packit a7d494
	else
Packit a7d494
	{
Packit a7d494
		gtk_text_buffer_select_range (buffer,
Packit a7d494
		                              &end,
Packit a7d494
		                              line_start);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
select_line (GtkSourceGutterRendererLines *renderer,
Packit a7d494
             GtkTextIter                  *line_start)
Packit a7d494
{
Packit a7d494
	GtkTextIter iter;
Packit a7d494
	GtkTextBuffer *buffer;
Packit a7d494
Packit a7d494
	buffer = get_buffer (renderer);
Packit a7d494
Packit a7d494
	iter = *line_start;
Packit a7d494
Packit a7d494
	if (!gtk_text_iter_ends_line (&iter))
Packit a7d494
	{
Packit a7d494
		gtk_text_iter_forward_to_line_end (&iter);
Packit a7d494
	}
Packit a7d494
Packit a7d494
	/* Select the line, put the cursor at the end of the line */
Packit a7d494
	gtk_text_buffer_select_range (buffer, &iter, line_start);
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gutter_renderer_activate (GtkSourceGutterRenderer *renderer,
Packit a7d494
                          GtkTextIter             *iter,
Packit a7d494
                          GdkRectangle            *rect,
Packit a7d494
                          GdkEvent                *event)
Packit a7d494
{
Packit a7d494
	GtkSourceGutterRendererLines *lines;
Packit a7d494
Packit a7d494
	lines = GTK_SOURCE_GUTTER_RENDERER_LINES (renderer);
Packit a7d494
Packit a7d494
	if (event->type == GDK_BUTTON_PRESS && (event->button.button == 1))
Packit a7d494
	{
Packit a7d494
		GtkTextBuffer *buffer;
Packit a7d494
Packit a7d494
		buffer = get_buffer (lines);
Packit a7d494
Packit a7d494
		if ((event->button.state & GDK_CONTROL_MASK) != 0)
Packit a7d494
		{
Packit a7d494
			/* Single click + Ctrl -> select the line */
Packit a7d494
			select_line (lines, iter);
Packit a7d494
		}
Packit a7d494
		else if ((event->button.state & GDK_SHIFT_MASK) != 0)
Packit a7d494
		{
Packit a7d494
			/* Single click + Shift -> extended current
Packit a7d494
			   selection to include the clicked line */
Packit a7d494
			extend_selection_to_line (lines, iter);
Packit a7d494
		}
Packit a7d494
		else
Packit a7d494
		{
Packit a7d494
			gtk_text_buffer_place_cursor (buffer, iter);
Packit a7d494
		}
Packit a7d494
	}
Packit a7d494
	else if (event->type == GDK_2BUTTON_PRESS && (event->button.button == 1))
Packit a7d494
	{
Packit a7d494
		select_line (lines, iter);
Packit a7d494
	}
Packit a7d494
}
Packit a7d494
Packit a7d494
static gboolean
Packit a7d494
gutter_renderer_query_activatable (GtkSourceGutterRenderer *renderer,
Packit a7d494
                                   GtkTextIter             *iter,
Packit a7d494
                                   GdkRectangle            *area,
Packit a7d494
                                   GdkEvent                *event)
Packit a7d494
{
Packit a7d494
	return get_buffer (GTK_SOURCE_GUTTER_RENDERER_LINES (renderer)) != NULL;
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gtk_source_gutter_renderer_lines_class_init (GtkSourceGutterRendererLinesClass *klass)
Packit a7d494
{
Packit a7d494
	GtkSourceGutterRendererClass *renderer_class = GTK_SOURCE_GUTTER_RENDERER_CLASS (klass);
Packit a7d494
Packit a7d494
	renderer_class->query_data = gutter_renderer_query_data;
Packit a7d494
	renderer_class->end = gutter_renderer_end;
Packit a7d494
	renderer_class->query_activatable = gutter_renderer_query_activatable;
Packit a7d494
	renderer_class->activate = gutter_renderer_activate;
Packit a7d494
	renderer_class->change_buffer = gutter_renderer_change_buffer;
Packit a7d494
	renderer_class->change_view = gutter_renderer_change_view;
Packit a7d494
}
Packit a7d494
Packit a7d494
static void
Packit a7d494
gtk_source_gutter_renderer_lines_init (GtkSourceGutterRendererLines *self)
Packit a7d494
{
Packit a7d494
	self->priv = gtk_source_gutter_renderer_lines_get_instance_private (self);
Packit a7d494
}
Packit a7d494
Packit a7d494
GtkSourceGutterRenderer *
Packit a7d494
gtk_source_gutter_renderer_lines_new (void)
Packit a7d494
{
Packit a7d494
	return g_object_new (GTK_SOURCE_TYPE_GUTTER_RENDERER_LINES, NULL);
Packit a7d494
}