wireshark/ui/gtk/bytes_view.c

/* bytes_view.c
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 */

/* Code based on:
 *   xtext, the text widget used by X-Chat. Peter Zelezny <zed@xchat.org>.
 *   GtkTextView. Copyright (C) 2000 Red Hat, Inc.
 *   GtkHex. Jaka Mocnik <jaka@gnu.org>.
 *   pango-layout.c: High-level layout driver. Copyright (C) 2000, 2001, 2006 Red Hat Software
 */

#include "config.h"

#include <gtk/gtk.h>
#include "ui/gtk/old-gtk-compat.h"

#include <string.h>
#include <stddef.h>

#include <epan/wmem/wmem.h>
#include <epan/charsets.h>
#include <epan/packet.h>

#include "ui/recent.h"

#define MARGIN 2
#define REFRESH_TIMEOUT 10

static GtkWidgetClass *parent_class = NULL;

struct _BytesView
{
	GtkWidget widget;

	PangoContext *context;

	PangoFontDescription *font;
	int font_ascent;
	int font_descent;
	int fontsize;

	GtkAdjustment *vadj;
	GtkAdjustment *hadj;
#if GTK_CHECK_VERSION(3, 0, 0)
	guint hscroll_policy : 1;
	guint vscroll_policy : 1;
#endif
	gint adj_tag;
	int max_width;

	gboolean bold_highlight;
	int state;

/* data */
	packet_char_enc encoding;	/* ASCII or EBCDIC */
	bytes_view_type format;		/* bytes in hex or bytes as bits */
	guint8 *pd;			/* packet data */
	int len;			/* length of packet data in bytes */
/* data-highlight (field, appendix, protocol) */
	int start[3];
	int end[3];

	int per_line;			/* number of bytes shown per line */
	int use_digits;			/* number of hex digits of byte offset */
};

#include "bytes_view.h"

typedef struct _BytesViewClass
{
	GtkWidgetClass parent_class;

	void (*set_scroll_adjustments)(BytesView *, GtkAdjustment *, GtkAdjustment *);

} BytesViewClass;

static void bytes_view_set_scroll_adjustments(BytesView *, GtkAdjustment *, GtkAdjustment *);
static void bytes_view_adjustment_set(BytesView *);

static void
bytes_view_init(BytesView *bv)
{
	bv->context = NULL;

	bv->encoding = PACKET_CHAR_ENC_CHAR_ASCII;
	bv->format = BYTES_HEX;

	bv->per_line = 16;
	bv->use_digits = 4;

	bv->max_width = 0;
}

static void
bytes_view_destroy(BytesView *bv)
{
	if (bv->pd) {
		g_free(bv->pd);
		bv->pd = NULL;
	}
	if (bv->adj_tag) {
		g_source_remove(bv->adj_tag);
		bv->adj_tag = 0;
	}
	if (bv->vadj) {
		g_object_unref(G_OBJECT(bv->vadj));
		bv->vadj = NULL;
	}
	if (bv->hadj) {
		g_object_unref(G_OBJECT(bv->hadj));
		bv->hadj = NULL;
	}
	if (bv->font) {
		pango_font_description_free(bv->font);
		bv->font = NULL;
	}
	if (bv->context) {
		g_object_unref(bv->context);
		bv->context = NULL;
	}
}

#if GTK_CHECK_VERSION(3, 0, 0)
static void
bytes_view_destroy_widget(GtkWidget *widget)
{
	bytes_view_destroy(BYTES_VIEW(widget));

	GTK_WIDGET_CLASS(parent_class)->destroy(widget);
}

#else

static void
bytes_view_destroy_object(GtkObject *object)
{
	bytes_view_destroy(BYTES_VIEW(object));

	if (GTK_OBJECT_CLASS(parent_class)->destroy)
		(*GTK_OBJECT_CLASS(parent_class)->destroy)(object);
}

#endif

static void
bytes_view_ensure_layout(BytesView *bv)
{
	if (bv->context == NULL) {
		bv->context = gtk_widget_get_pango_context(GTK_WIDGET(bv));
		g_object_ref(bv->context);

		{
		PangoLanguage *lang;
		PangoFontMetrics *metrics;

			/* vte and xchat does it this way */
			lang = pango_context_get_language(bv->context);
			metrics = pango_context_get_metrics(bv->context, bv->font, lang);
			bv->font_ascent = pango_font_metrics_get_ascent(metrics) / PANGO_SCALE;
			bv->font_descent = pango_font_metrics_get_descent(metrics) / PANGO_SCALE;
			pango_font_metrics_unref(metrics);

			bv->fontsize = bv->font_ascent + bv->font_descent;
		}
		g_assert(bv->context);
		bytes_view_adjustment_set(bv);
	}
}

static void
bytes_view_realize(GtkWidget *widget)
{
	BytesView *bv;
	GdkWindowAttr attributes;
	GtkAllocation allocation;
	GdkWindow *win;

#if GTK_CHECK_VERSION(3, 0, 0)
	GtkStyleContext *context;
#endif

	_gtk_widget_set_realized_true(widget);
	bv = BYTES_VIEW(widget);

	gtk_widget_get_allocation(widget, &allocation);

	attributes.window_type = GDK_WINDOW_CHILD;
	attributes.x = allocation.x;
	attributes.y = allocation.y;
	attributes.width = allocation.width;
	attributes.height = allocation.height;
	attributes.wclass = GDK_INPUT_OUTPUT;
	attributes.visual = gtk_widget_get_visual(widget);
	attributes.event_mask = gtk_widget_get_events(widget) | GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK;

#if !GTK_CHECK_VERSION(3, 0, 0)
	attributes.colormap = gtk_widget_get_colormap(widget);

	win = gdk_window_new(gtk_widget_get_parent_window(widget), &attributes, GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP);
#else
	win = gdk_window_new(gtk_widget_get_parent_window(widget), &attributes, GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL);
#endif

	gtk_widget_set_window(widget, win);

#if GTK_CHECK_VERSION(3, 8, 0)
	gtk_widget_register_window(widget, win);
#else
	gdk_window_set_user_data(win, widget);
#endif

#if !GTK_CHECK_VERSION(3, 0, 0)	/* XXX, check */
	gdk_window_set_back_pixmap(win, NULL, FALSE);
#endif

#if GTK_CHECK_VERSION(3, 0, 0)
	context = gtk_widget_get_style_context(widget);
	gtk_style_context_add_class(context, GTK_STYLE_CLASS_VIEW);
	/* gtk_style_context_add_class(context, GTK_STYLE_CLASS_ENTRY); */

#elif GTK_CHECK_VERSION(2, 20, 0)
	gtk_widget_style_attach(widget);
#else
	widget->style = gtk_style_attach(widget->style, win);
#endif
	bytes_view_ensure_layout(bv);
}

static void
bytes_view_unrealize(GtkWidget *widget)
{
	BytesView *bv = BYTES_VIEW(widget);

	if (bv->context) {
		g_object_unref(bv->context);
		bv->context = NULL;
	}
	/* if there are still events in the queue, this'll avoid segfault */
#if !GTK_CHECK_VERSION(3, 8, 0)
	gdk_window_set_user_data(gtk_widget_get_window(widget), NULL);
#endif

	if (parent_class->unrealize)
		(*GTK_WIDGET_CLASS(parent_class)->unrealize)(widget);
}

static GtkAdjustment *
bytes_view_ensure_vadj(BytesView *bv)
{
	if (bv->vadj == NULL) {
		bytes_view_set_scroll_adjustments(bv, bv->hadj, bv->vadj);
		g_assert(bv->vadj != NULL);
	}
	return bv->vadj;
}

static GtkAdjustment *
bytes_view_ensure_hadj(BytesView *bv)
{
	if (bv->hadj == NULL) {
		bytes_view_set_scroll_adjustments(bv, bv->hadj, bv->vadj);
		g_assert(bv->hadj != NULL);
	}
	return bv->hadj;
}

static gboolean
bytes_view_scroll(GtkWidget *widget, GdkEventScroll *event)
{
	BytesView *bv = BYTES_VIEW(widget);

	gdouble new_value;

	if (event->direction == GDK_SCROLL_UP) {	/* mouse wheel pageUp */
		bytes_view_ensure_vadj(bv);

		new_value = gtk_adjustment_get_value(bv->vadj) - (gtk_adjustment_get_page_increment(bv->vadj) / 10);
		if (new_value < gtk_adjustment_get_lower(bv->vadj))
			new_value = gtk_adjustment_get_lower(bv->vadj);
		gtk_adjustment_set_value(bv->vadj, new_value);

	} else if (event->direction == GDK_SCROLL_DOWN) {	/* mouse wheel pageDn */
		bytes_view_ensure_vadj(bv);

		new_value = gtk_adjustment_get_value(bv->vadj) + (gtk_adjustment_get_page_increment(bv->vadj) / 10);
		if (new_value > (gtk_adjustment_get_upper(bv->vadj) - gtk_adjustment_get_page_size(bv->vadj)))
			new_value = gtk_adjustment_get_upper(bv->vadj) - gtk_adjustment_get_page_size(bv->vadj);
		gtk_adjustment_set_value(bv->vadj, new_value);
	}
	return FALSE;
}

static void
bytes_view_allocate(GtkWidget *widget, GtkAllocation *allocation)
{
	gtk_widget_set_allocation(widget, allocation);

	if (gtk_widget_get_realized(widget)) {
		BytesView *bv = BYTES_VIEW(widget);

		gdk_window_move_resize(gtk_widget_get_window(widget), allocation->x, allocation->y, allocation->width, allocation->height);
		bytes_view_adjustment_set(bv);
	}
}

#if GTK_CHECK_VERSION(3, 0, 0)
static void
bytes_view_get_preferred_width(GtkWidget *widget _U_, gint *minimum, gint *natural)
{
	*minimum = *natural = 200;
}

static void
bytes_view_get_preferred_height(GtkWidget *widget _U_, gint *minimum, gint *natural)
{
	*minimum = *natural = 90;
}

#else

static void
bytes_view_size_request(GtkWidget *widget _U_, GtkRequisition *requisition)
{
	requisition->width = 200;
	requisition->height = 90;
}
#endif

static GSList *
_pango_runs_build(BytesView *bv, const char *str, int len)
{
	GSList *runs = NULL;

	PangoAttrList *attrs;
	PangoAttrIterator *iter;

	GList *run_list;
	GList *tmp_list;

	attrs = pango_attr_list_new();
	pango_attr_list_insert_before(attrs, pango_attr_font_desc_new(bv->font));

	iter = pango_attr_list_get_iterator(attrs);

	run_list = pango_itemize(bv->context, str, 0, len, attrs, iter);

	for (tmp_list = run_list; tmp_list; tmp_list = tmp_list->next) {
		PangoLayoutRun *run = g_slice_new(PangoLayoutRun);
		PangoItem *run_item = (PangoItem *)tmp_list->data;

		run->item = run_item;

		/* XXX pango_layout_get_item_properties(run_item, &state->properties); */

		run->glyphs = pango_glyph_string_new();
		pango_shape(str + run_item->offset, run_item->length, &run_item->analysis, run->glyphs);

		runs = g_slist_prepend(runs, run);
	}

	g_list_free(run_list);

	pango_attr_iterator_destroy(iter);
	pango_attr_list_unref(attrs);

	return g_slist_reverse(runs);
}

static int
_pango_glyph_string_to_pixels(PangoGlyphString *glyphs, PangoFont *font _U_)
{
#if PANGO_VERSION_MAJOR == 1 && PANGO_VERSION_MINOR >= 14
	return pango_glyph_string_get_width(glyphs) / PANGO_SCALE;
#else
	PangoRectangle logical_rect;

	pango_glyph_string_extents(glyphs, font, NULL, &logical_rect);
 	/*  pango_extents_to_pixels(&logical_rect, NULL); */

	return (logical_rect.width / PANGO_SCALE);
#endif
}

static int
xtext_draw_layout_line(cairo_t *cr, gint x, gint y, GSList *runs)
{
	while (runs) {
		PangoLayoutRun *run = (PangoLayoutRun *)runs->data;

		cairo_move_to(cr, x, y);
		pango_cairo_show_glyph_string(cr, run->item->analysis.font, run->glyphs);

		x += _pango_glyph_string_to_pixels(run->glyphs, run->item->analysis.font);
		runs = runs->next;
	}
	return x;
}

static int
_pango_runs_width(GSList *runs)
{
	int width = 0;

	while (runs) {
		PangoLayoutRun *run = (PangoLayoutRun *)runs->data;

		width += _pango_glyph_string_to_pixels(run->glyphs, run->item->analysis.font);
		runs = runs->next;
	}
	return width;
}

static void
_pango_runs_free(GSList *runs)
{
	GSList *list = runs;

	while (list) {
		PangoLayoutRun *run = (PangoLayoutRun *)list->data;

		pango_item_free(run->item);
		pango_glyph_string_free(run->glyphs);
		g_slice_free(PangoLayoutRun, run);

		list = list->next;
	}
	g_slist_free(runs);
}

typedef int bytes_view_line_cb(BytesView *, void *data, int x, int arg1, const char *str, int len);

static int
bytes_view_flush_render(BytesView *bv, void *data, int x, int y, const char *str, int len)
{
	cairo_t *cr = (cairo_t *)data;
	GSList *line_runs;
	int str_width;

#if GTK_CHECK_VERSION(3, 0, 0)
	GtkStyleContext *context;
	GdkRGBA bg_color, fg_color;
#endif

	if (len < 1)
		return 0;

	line_runs = _pango_runs_build(bv, str, len);

	/* XXX, cliping */

#if GTK_CHECK_VERSION(3, 0, 0)
	context = gtk_widget_get_style_context(GTK_WIDGET(bv));
#endif

	if (bv->state == GTK_STATE_SELECTED || bv->state == GTK_STATE_INSENSITIVE) {
		str_width = _pango_runs_width(line_runs);

		/* background */
#if GTK_CHECK_VERSION(3, 0, 0)
		gtk_style_context_get_background_color(context, (GtkStateFlags)( (bv->state == GTK_STATE_SELECTED ? GTK_STATE_FLAG_FOCUSED : 0) | GTK_STATE_FLAG_SELECTED), &bg_color);
		gdk_cairo_set_source_rgba(cr, &bg_color);
#else
		gdk_cairo_set_source_color(cr, &gtk_widget_get_style(GTK_WIDGET(bv))->base[bv->state]);
#endif
		cairo_rectangle(cr, x, y - bv->font_ascent, str_width, bv->fontsize);
		cairo_fill(cr);
	}

	/* text */
#if GTK_CHECK_VERSION(3, 0, 0)
	gtk_style_context_get_color(context, (GtkStateFlags)(GTK_STATE_FLAG_FOCUSED | (bv->state == GTK_STATE_SELECTED ? GTK_STATE_FLAG_SELECTED : GTK_STATE_FLAG_NORMAL)), &fg_color);
	gdk_cairo_set_source_rgba(cr, &fg_color);
#else
	gdk_cairo_set_source_color(cr, &gtk_widget_get_style(GTK_WIDGET(bv))->text[bv->state]);
#endif
	str_width = xtext_draw_layout_line(cr, x, y, line_runs)-x;

	_pango_runs_free(line_runs);

	return str_width;
}

static int
_pango_runs_find_index(GSList *runs, int x_pos, const char *str)
{
	int start_pos = 0;

	while (runs) {
		PangoLayoutRun *run = (PangoLayoutRun *)runs->data;
		int width;

		width = _pango_glyph_string_to_pixels(run->glyphs, run->item->analysis.font);

		if (x_pos >= start_pos && x_pos < start_pos + width) {
			gboolean char_trailing;
			int pos;

			pango_glyph_string_x_to_index(run->glyphs,
					(char *) str + run->item->offset, run->item->length,
					&run->item->analysis,
					(x_pos - start_pos) * PANGO_SCALE,
					&pos, &char_trailing);

			return run->item->offset + pos;
		}

		start_pos += width;
		runs = runs->next;
	}
	return -1;
}

static int
bytes_view_flush_pos(BytesView *bv, void *data, int x, int search_x, const char *str, int len)
{
	int *pos_x = (int *)data;
	GSList *line_runs;
	int line_width;

	if (len < 1)
		return 0;

	line_runs = _pango_runs_build(bv, str, len);

	line_width = _pango_runs_width(line_runs);

	if (x <= search_x && x + line_width > search_x) {
		int off_x = search_x - x;
		int pos_run;

		if ((pos_run = _pango_runs_find_index(line_runs, off_x, str)) != -1)
			*pos_x = (-*pos_x) + pos_run;

		return -1;	/* terminate */
	} else
		*pos_x -= len;

	_pango_runs_free(line_runs);

	return line_width;
}

static void
bytes_view_render_state(BytesView *bv, int state)
{
	g_assert(state == GTK_STATE_NORMAL || state == GTK_STATE_SELECTED || state == GTK_STATE_INSENSITIVE);

	if (bv->bold_highlight) {
		pango_font_description_set_weight(bv->font,
				(state == GTK_STATE_SELECTED) ? PANGO_WEIGHT_BOLD : PANGO_WEIGHT_NORMAL);
		bv->state = GTK_STATE_NORMAL;
	} else
		bv->state = state;
}

#define BYTE_VIEW_SEP    8      /* insert a space every BYTE_VIEW_SEP bytes */

static void
_bytes_view_line_common(BytesView *bv, void *data, const int org_off, int xx, int arg1, bytes_view_line_cb flush)
{
	static const guchar hexchars[16] = {
		'0', '1', '2', '3', '4', '5', '6', '7',
		'8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };

	const guint8 *pd = bv->pd;
	const int len = bv->len;

	int state;

	char str[128];
	int cur = 0;

	int off;
	guchar c;
	int byten;
	int j;

	int scroll_x;
	int dx;

	g_assert(org_off >= 0);

	scroll_x = (int) gtk_adjustment_get_value(bytes_view_ensure_hadj(bv));

	state = GTK_STATE_NORMAL;
	bytes_view_render_state(bv, GTK_STATE_NORMAL);

	/* Print the line number */
	j = bv->use_digits;
	do {
		j--;
		c = (org_off >> (j*4)) & 0xF;
		str[cur++] = hexchars[c];
	} while (j != 0);
	str[cur++] = ' ';
	str[cur++] = ' ';

	/* Print the hex bit */
	for (byten = 0, off = org_off; byten < bv->per_line; byten++) {
		gboolean byte_highlighted =
			(off >= bv->start[0] && off < bv->end[0]) ||
			(off >= bv->start[1] && off < bv->end[1]);
		gboolean proto_byte_highlighted =
			(off >= bv->start[2] && off < bv->end[2]);

		int state_cur = (off < len && byte_highlighted) ?
				GTK_STATE_SELECTED :
				(off < len && proto_byte_highlighted) ?
				GTK_STATE_INSENSITIVE :
				GTK_STATE_NORMAL;

		if (state_cur != state) {
			/* ok, we want to put space, we prefer to put it in STATE_NORMAL or STATE_INSENSITIVE */
			int space_now = (state_cur != GTK_STATE_NORMAL && state_cur != GTK_STATE_INSENSITIVE)
				|| state == GTK_STATE_NORMAL;

			if (space_now && byten) {
				str[cur++] = ' ';
				/* insert a space every BYTE_VIEW_SEP bytes */
				if ((off % BYTE_VIEW_SEP) == 0)
					str[cur++] = ' ';
			}

			if ((dx = flush(bv, data, xx - scroll_x, arg1, str, cur)) < 0)
				return;
			xx += dx;
			cur = 0;
			bytes_view_render_state(bv, state_cur);
			state = state_cur;

			if (!space_now && byten) {
				str[cur++] = ' ';
				/* insert a space every BYTE_VIEW_SEP bytes */
				if ((off % BYTE_VIEW_SEP) == 0)
					str[cur++] = ' ';
			}

		} else if (byten) {
			str[cur++] = ' ';
			/* insert a space every BYTE_VIEW_SEP bytes */
			if ((off % BYTE_VIEW_SEP) == 0)
				str[cur++] = ' ';
		}

		if (off < len) {
			switch (bv->format) {
				case BYTES_HEX:
					str[cur++] = hexchars[(pd[off] & 0xf0) >> 4];
					str[cur++] = hexchars[pd[off] & 0x0f];
					break;
				case BYTES_BITS:
					/* XXX, bitmask */
					for (j = 7; j >= 0; j--)
						str[cur++] = (pd[off] & (1 << j)) ? '1' : '0';
					break;
			}
		} else {
			switch (bv->format) {
				case BYTES_HEX:
					str[cur++] = ' ';
					str[cur++] = ' ';
					break;
				case BYTES_BITS:
					for (j = 7; j >= 0; j--)
						str[cur++] = ' ';
					break;
			}
		}
		off++;
	}

	if (state != GTK_STATE_NORMAL) {
		if ((dx = flush(bv, data, xx - scroll_x, arg1, str, cur)) < 0)
			return;
		xx += dx;
		cur = 0;
		bytes_view_render_state(bv, GTK_STATE_NORMAL);
		state = GTK_STATE_NORMAL;
	}

	/* Print some space at the end of the line */
	str[cur++] = ' '; str[cur++] = ' '; str[cur++] = ' ';

	/* Print the ASCII bit */
	for (byten = 0, off = org_off; byten < bv->per_line; byten++) {
		gboolean byte_highlighted =
			(off >= bv->start[0] && off < bv->end[0]) ||
			(off >= bv->start[1] && off < bv->end[1]);
		gboolean proto_byte_highlighted =
			(off >= bv->start[2] && off < bv->end[2]);

		int state_cur = (off < len && byte_highlighted) ?
				GTK_STATE_SELECTED :
				(off < len && proto_byte_highlighted) ?
				GTK_STATE_INSENSITIVE :
				GTK_STATE_NORMAL;

		if (state_cur != state) {
			int space_now = (state_cur != GTK_STATE_NORMAL && state_cur != GTK_STATE_INSENSITIVE)
				|| state == GTK_STATE_NORMAL;

			if (space_now && byten) {
				/* insert a space every BYTE_VIEW_SEP bytes */
				if ((off % BYTE_VIEW_SEP) == 0)
					str[cur++] = ' ';
			}

			if ((dx = flush(bv, data, xx - scroll_x, arg1, str, cur)) < 0)
				return;
			xx += dx;
			cur = 0;
			bytes_view_render_state(bv, state_cur);
			state = state_cur;

			if (!space_now && byten) {
				/* insert a space every BYTE_VIEW_SEP bytes */
				if ((off % BYTE_VIEW_SEP) == 0)
					str[cur++] = ' ';
			}

		} else if (byten) {
			/* insert a space every BYTE_VIEW_SEP bytes */
			if ((off % BYTE_VIEW_SEP) == 0)
				str[cur++] = ' ';
		}

		if (off < len) {
			c = (bv->encoding == PACKET_CHAR_ENC_CHAR_EBCDIC) ?
				EBCDIC_to_ASCII1(pd[off]) :
				pd[off];

			str[cur++] = g_ascii_isprint(c) ? c : '.';
		} else
			str[cur++] = ' ';

		off++;
	}

	if (cur) {
		if ((dx = flush(bv, data, xx - scroll_x, arg1, str, cur)) < 0)
			return;
		xx += dx;
		/* cur = 0; */
	}

	if (state != GTK_STATE_NORMAL) {
		bytes_view_render_state(bv, GTK_STATE_NORMAL);
		/* state = GTK_STATE_NORMAL; */
	}

	if (bv->max_width < xx)
		bv->max_width = xx;
}

static void
_bytes_view_render_line(BytesView *bv, cairo_t *cr, const int org_off, int yy)
{
	_bytes_view_line_common(bv, cr, org_off, MARGIN, yy, bytes_view_flush_render);
}

static int
_bytes_view_find_pos(BytesView *bv, const int org_off, int search_x)
{
	int pos_x = 0;

	_bytes_view_line_common(bv, &pos_x, org_off, MARGIN, search_x, bytes_view_flush_pos);

	return pos_x;
}

static void
bytes_view_render(BytesView *bv, cairo_t *cr, GdkRectangle *area)
{
	const int old_max_width = bv->max_width;

	int width, height;
	int y;
	int off;

	guint line, lines_max;
	guint lines_max_full;

#if GTK_CHECK_VERSION(3, 0, 0)
	GtkStyleContext *context;
	GdkRGBA bg_color;
#endif

	if (!gtk_widget_get_realized(GTK_WIDGET(bv)))
		return;

	bytes_view_ensure_layout(bv);

#if GTK_CHECK_VERSION(3, 0, 0)
	width = gtk_widget_get_allocated_width(GTK_WIDGET(bv));
	height = gtk_widget_get_allocated_height(GTK_WIDGET(bv));
#elif GTK_CHECK_VERSION(2,24,0)
	width = gdk_window_get_width(gtk_widget_get_window(GTK_WIDGET(bv)));
	height = gdk_window_get_height(gtk_widget_get_window(GTK_WIDGET(bv)));
#else
	ws_gdk_drawable_get_size(gtk_widget_get_window(GTK_WIDGET(bv)), &width, &height);
#endif

	if (width < 32 + MARGIN || height < bv->fontsize)
		return;

	if (area) {
		line = area->y / bv->fontsize;
		lines_max = 1 + (area->y + area->height) / bv->fontsize;
	} else {
		line = 0;
		lines_max = (guint) -1;
	}
	/* g_print("from %d to %d\n", line, lines_max); */

	y = (bv->fontsize * line);

	/* clear */
#if GTK_CHECK_VERSION(3, 0, 0)
	context = gtk_widget_get_style_context(GTK_WIDGET(bv));
	gtk_style_context_get_background_color(context, (GtkStateFlags)(GTK_STATE_FLAG_FOCUSED | GTK_STATE_FLAG_NORMAL), &bg_color);
	gdk_cairo_set_source_rgba(cr, &bg_color);
#else
	gdk_cairo_set_source_color(cr, &gtk_widget_get_style(GTK_WIDGET(bv))->base[GTK_STATE_NORMAL]);
#endif
	if (area)
		cairo_rectangle(cr, area->x, area->y, area->x + area->width, area->y + area->height);
	else
		cairo_rectangle(cr, 0, 0, width, height);
	cairo_fill(cr);

	if (bv->pd) {
		guint real_line = line + (guint) gtk_adjustment_get_value(bytes_view_ensure_vadj(bv));

		lines_max_full = (height / bv->fontsize) + 1;
		if (lines_max_full < lines_max)
			lines_max = lines_max_full;

		off = real_line * bv->per_line;

		while (off < bv->len) {
			_bytes_view_render_line(bv, cr, off, y + bv->font_ascent);
			line++;
			if (line >= lines_max)
				break;

			off += bv->per_line;
			y += bv->fontsize;
		}
	}

	if (old_max_width != bv->max_width)
		bytes_view_adjustment_set(bv);
}

static void
bytes_view_render_full(BytesView *bv)
{
	cairo_t *cr;

	if (bv->adj_tag) {
		g_source_remove(bv->adj_tag);
		bv->adj_tag = 0;
	}

	cr = gdk_cairo_create(gtk_widget_get_window(GTK_WIDGET(bv)));
	bytes_view_render(bv, cr, NULL);
	cairo_destroy(cr);
}

#if GTK_CHECK_VERSION(3, 0, 0)
static gboolean
bytes_view_draw(GtkWidget *widget, cairo_t *cr)
{
	GdkRectangle area;

	gdk_cairo_get_clip_rectangle(cr, &area);

	bytes_view_render(BYTES_VIEW(widget), cr, &area);
	return FALSE;
}

#else

static gboolean
bytes_view_expose(GtkWidget *widget, GdkEventExpose *event)
{
	BytesView *bv = BYTES_VIEW(widget);
	cairo_t *cr;

	cr = gdk_cairo_create(gtk_widget_get_window(GTK_WIDGET(bv)));

	gdk_cairo_region(cr, event->region);
	cairo_clip(cr);

	bytes_view_render(bv, cr, &event->area);

	cairo_destroy(cr);
	return FALSE;
}

#endif

#if !GTK_CHECK_VERSION(2, 14, 0)
static void
_gtk_adjustment_configure(GtkAdjustment *adj,
			  gdouble	 value,
			  gdouble	 lower,
			  gdouble	 upper,
			  gdouble	 step_increment,
			  gdouble	 page_increment,
			  gdouble	 page_size)
{
	adj->value = value;
	adj->lower = lower;
	adj->upper = upper;
	adj->step_increment = step_increment;
	adj->page_increment = page_increment;
	adj->page_size = page_size;

	gtk_adjustment_changed(adj);
}

#elif GTK_CHECK_VERSION(3, 0, 0)

#define _gtk_adjustment_configure(adj, val, low, up, step, page, size) \
	gtk_adjustment_configure(adj, val, low, MAX((up), (size)), step, page, size)

#else

#define _gtk_adjustment_configure(adj, val, low, up, step, page, size) \
	gtk_adjustment_configure(adj, val, low, up, step, page, size)

#endif


static void
bytes_view_adjustment_set(BytesView *bv)
{
	GtkAllocation allocation;
	double lower, upper, page_size, step_increment, page_increment, value;

	if (bv->vadj == NULL || bv->hadj == NULL)
		return;

	if (bv->context == NULL) {
		bytes_view_ensure_layout(bv);
		/* bytes_view_ensure_layout will call bytes_view_adjustment_set() again */
		return;
	}

	gtk_widget_get_allocation(GTK_WIDGET(bv), &allocation);

	if (bv->vadj) {
		lower = 0;
		upper = (int) (bv->len / bv->per_line);
		if ((bv->len % bv->per_line))
			upper++;

		page_size = (allocation.height - bv->font_descent) / bv->fontsize;
		page_increment = page_size;
		step_increment = 1;

		value = gtk_adjustment_get_value(bv->vadj);

		if (value > upper - page_size)
			value = upper - page_size;

		if (value < 0)
			value = 0;

		_gtk_adjustment_configure(bv->vadj, value, lower, upper, step_increment, page_increment, page_size);
	}

	if (bv->hadj) {
		lower = 0;
		upper = bv->max_width;

		page_size = allocation.width;
		page_increment = page_size;
		step_increment = page_size / 10.0;

		value = gtk_adjustment_get_value(bv->hadj);

		if (value > upper - page_size)
			value = upper - page_size;

		if (value < 0)
			value = 0;

		_gtk_adjustment_configure(bv->hadj, value, lower, upper, step_increment, page_increment, page_size);
	}
}

static gint
bytes_view_adjustment_timeout(BytesView *bv)
{
	bv->adj_tag = 0;
	bytes_view_render_full(bv);
	return 0;
}

static void
bytes_view_adjustment_changed(GtkAdjustment *adj, BytesView *bv)
{
	/*  delay rendering when scrolling (10ms) */
	if (adj && ((adj == bv->vadj) || (adj == bv->hadj))) {
		if (!bv->adj_tag)
			bv->adj_tag = g_timeout_add(REFRESH_TIMEOUT, (GSourceFunc) bytes_view_adjustment_timeout, bv);
	}
}

static void
bytes_view_set_scroll_adjustments(BytesView *bv, GtkAdjustment *hadj, GtkAdjustment *vadj)
{
	gboolean need_adjust = FALSE;

	g_return_if_fail(!hadj || GTK_IS_ADJUSTMENT(hadj));
	g_return_if_fail(!vadj || GTK_IS_ADJUSTMENT(vadj));

	if (!vadj)
		vadj = GTK_ADJUSTMENT(gtk_adjustment_new(0.0, 0.0, 0.0, 0.0, 0.0, 0.0));

	if (!hadj)
		hadj = GTK_ADJUSTMENT(gtk_adjustment_new(0.0, 0.0, 0.0, 0.0, 0.0, 0.0));

	if (bv->vadj && (bv->vadj != vadj)) {
		g_signal_handlers_disconnect_by_func(bv->vadj, bytes_view_adjustment_changed, bv);
		g_object_unref(bv->vadj);
	}
	if (bv->vadj != vadj) {
		bv->vadj = vadj;
		g_object_ref_sink(bv->vadj);

		g_signal_connect(bv->vadj, "value-changed", G_CALLBACK(bytes_view_adjustment_changed), bv);
		need_adjust = TRUE;
#if GTK_CHECK_VERSION(3, 0, 0)
		g_object_notify(G_OBJECT(bv), "vadjustment");
#endif
	}

	if (bv->hadj && (bv->hadj != hadj)) {
		g_signal_handlers_disconnect_by_func(bv->hadj, bytes_view_adjustment_changed, bv);
		g_object_unref(bv->hadj);
	}
	if (bv->hadj != hadj) {
		bv->hadj = hadj;
		g_object_ref_sink(bv->hadj);

		g_signal_connect(bv->hadj, "value-changed", G_CALLBACK(bytes_view_adjustment_changed), bv);
		need_adjust = TRUE;
#if GTK_CHECK_VERSION(3, 0, 0)
		g_object_notify(G_OBJECT(bv), "hadjustment");
#endif
	}

	if (need_adjust)
		bytes_view_adjustment_set(bv);
}

#if GTK_CHECK_VERSION(3, 0, 0)
enum {
	PROP_0,
	PROP_HADJUSTMENT,
	PROP_VADJUSTMENT,
	PROP_HSCROLL_POLICY,
	PROP_VSCROLL_POLICY
};

static void
bytes_view_set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
{
	BytesView *bv = BYTES_VIEW(object);

	switch (prop_id) {
		case PROP_HADJUSTMENT:
			bytes_view_set_scroll_adjustments(bv, (GtkAdjustment *)g_value_get_object(value), bv->vadj);
			break;

		case PROP_VADJUSTMENT:
			bytes_view_set_scroll_adjustments(bv, bv->hadj, (GtkAdjustment *)g_value_get_object(value));
			break;

		case PROP_HSCROLL_POLICY:
			bv->hscroll_policy = g_value_get_enum(value);
			gtk_widget_queue_resize(GTK_WIDGET(bv));
			break;

		case PROP_VSCROLL_POLICY:
			bv->vscroll_policy = g_value_get_enum(value);
			gtk_widget_queue_resize(GTK_WIDGET(bv));
			break;

		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
			break;
	}
}

static void
bytes_view_get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
{
	BytesView *bv = BYTES_VIEW(object);

	switch (prop_id) {
		case PROP_HADJUSTMENT:
			g_value_set_object(value, bv->hadj);
			break;

		case PROP_VADJUSTMENT:
			g_value_set_object(value, bv->vadj);
			break;

		case PROP_HSCROLL_POLICY:
			g_value_set_enum(value, bv->hscroll_policy);
			break;

		case PROP_VSCROLL_POLICY:
			g_value_set_enum(value, bv->vscroll_policy);
			break;

		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
			break;
	}
}

#else

/* bv_VOID__OBJECT_OBJECT() generated by:
 *   $ echo 'VOID:OBJECT,OBJECT' | glib-genmarshal --prefix=bv --body
 * (glib-genmarshal version 2.32.4)
 * I *really hope* it's portable over platforms and can be put generated.
 */

static void
bv_VOID__OBJECT_OBJECT(GClosure *closure, GValue *return_value _U_, guint n_params, const GValue *param_values, gpointer hint _U_, gpointer marshal_data)
{
	typedef void (*GMarshalFunc_VOID__OBJECT_OBJECT)(gpointer, gpointer, gpointer, gpointer);

	register GMarshalFunc_VOID__OBJECT_OBJECT callback;
	register GCClosure *cc = (GCClosure*) closure;
	register gpointer data1, data2;

	g_return_if_fail(n_params == 3);

	if (G_CCLOSURE_SWAP_DATA(closure)) {
		data1 = closure->data;
		data2 = g_value_peek_pointer(param_values + 0);
	} else {
		data1 = g_value_peek_pointer(param_values + 0);
		data2 = closure->data;
	}
	callback = (GMarshalFunc_VOID__OBJECT_OBJECT) (marshal_data ? marshal_data : cc->callback);

	callback(data1, g_value_get_object(param_values + 1), g_value_get_object(param_values + 2), data2);
}

#endif

static void
bytes_view_class_init(BytesViewClass *klass)
{
#if !GTK_CHECK_VERSION(3, 0, 0)
	GtkObjectClass *object_class;
#endif
	GtkWidgetClass *widget_class;

	parent_class = (GtkWidgetClass *) g_type_class_peek_parent(klass);

#if !GTK_CHECK_VERSION(3, 0, 0)
	object_class = (GtkObjectClass *) klass;
#endif
	widget_class = (GtkWidgetClass *) klass;

#if GTK_CHECK_VERSION(3, 0, 0)
	widget_class->destroy = bytes_view_destroy_widget;
#else
	object_class->destroy = bytes_view_destroy_object;
#endif
	widget_class->realize = bytes_view_realize;
	widget_class->unrealize = bytes_view_unrealize;
#if GTK_CHECK_VERSION(3, 0, 0)
	widget_class->get_preferred_width = bytes_view_get_preferred_width;
	widget_class->get_preferred_height = bytes_view_get_preferred_height;
#else
	widget_class->size_request = bytes_view_size_request;
#endif
	widget_class->size_allocate = bytes_view_allocate;

#if GTK_CHECK_VERSION(3, 0, 0)
	widget_class->draw = bytes_view_draw;
#else
	widget_class->expose_event = bytes_view_expose;
#endif

	widget_class->scroll_event = bytes_view_scroll;

#if GTK_CHECK_VERSION(3, 0, 0)
	{
		GObjectClass *gobject_class = G_OBJECT_CLASS(klass);

		gobject_class->set_property = bytes_view_set_property;
		gobject_class->get_property = bytes_view_get_property;

		/* XXX, move some code from widget->destroy to gobject->finalize? */
		/* gobject_class->finalize = bytes_view_finalize; */

		g_object_class_override_property(gobject_class, PROP_HADJUSTMENT,    "hadjustment");
		g_object_class_override_property(gobject_class, PROP_VADJUSTMENT,    "vadjustment");
		g_object_class_override_property(gobject_class, PROP_HSCROLL_POLICY, "hscroll-policy");
		g_object_class_override_property(gobject_class, PROP_VSCROLL_POLICY, "vscroll-policy");
	}
#else
	klass->set_scroll_adjustments = bytes_view_set_scroll_adjustments;

	widget_class->set_scroll_adjustments_signal =
		g_signal_new(g_intern_static_string("set-scroll-adjustments"),
			G_OBJECT_CLASS_TYPE(object_class),
			(GSignalFlags)(G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION),
			offsetof(BytesViewClass, set_scroll_adjustments),
			NULL, NULL,
			bv_VOID__OBJECT_OBJECT,
			G_TYPE_NONE, 2,
			GTK_TYPE_ADJUSTMENT,
			GTK_TYPE_ADJUSTMENT);
#endif
}

GType
bytes_view_get_type(void)
{
	static GType bytes_view_gtype = 0;

	if (!bytes_view_gtype) {
		static const GTypeInfo bytes_view_info = {
			sizeof (BytesViewClass),
			NULL, /* base_init */
			NULL, /* base_finalize */
			(GClassInitFunc) bytes_view_class_init,
			NULL, /* class finalize */
			NULL, /* class_data */
			sizeof(BytesView),
			0, /* n_preallocs */
			(GInstanceInitFunc) bytes_view_init,
			NULL /* value_table */
		};

#if GTK_CHECK_VERSION(3, 0, 0)
		static const GInterfaceInfo scrollable_info = {
			NULL,
			NULL,
			NULL
		};
#endif

		bytes_view_gtype = g_type_register_static(GTK_TYPE_WIDGET,
							  "BytesView",
							  &bytes_view_info,
							  (GTypeFlags)0);

#if GTK_CHECK_VERSION(3, 0, 0)
		g_type_add_interface_static(bytes_view_gtype,
					    GTK_TYPE_SCROLLABLE,
					    &scrollable_info);
#endif
	}
	return bytes_view_gtype;
}

int
bytes_view_byte_from_xy(BytesView *bv, int x, int y)
{
	/* hex_pos_byte array generated with hex_view_get_byte(0, 0, 0...70) */
	static const int hex_pos_byte[70] = {
		-1, -1,
		0, 0, 0, 1, 1, 1, 2, 2, 2, 3, 3, 3,
		4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7,
		-1,
		8, 8, 8, 9, 9, 9, 10, 10, 10, 11, 11, 11,
		12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15,
		-1, -1,
		0, 1, 2, 3, 4, 5, 6, 7,
		-1,
		8, 9, 10, 11, 12, 13, 14, 15
	};

	/* bits_pos_byte array generated with bit_view_get_byte(0, 0, 0...84) */
	static const int bits_pos_byte[84] = {
		-1, -1,
		0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1,
		2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3,
		4, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 5, 5, 5, 5, 5,
		6, 6, 6, 6, 6, 6, 6, 6, 6, 7, 7, 7, 7, 7, 7, 7, 7, 7,
		-1, -1,
		0, 1, 2, 3, 4, 5, 6, 7
	};

	int char_x, off_x = 1;
	int char_y, off_y;

	if (x < MARGIN)
		return -1;

	bytes_view_ensure_layout(bv);

	char_y = (int) gtk_adjustment_get_value(bytes_view_ensure_vadj(bv)) + (y / bv->fontsize);
	off_y = char_y * bv->per_line;

	char_x = _bytes_view_find_pos(bv, off_y, x);
	if (/* char_x < 0 || */ char_x < bv->use_digits)
		return -1;
	char_x -= bv->use_digits;

	switch (bv->format) {
		case BYTES_BITS:
			g_return_val_if_fail(char_x >= 0 && char_x < (int) G_N_ELEMENTS(bits_pos_byte), -1);
			off_x = bits_pos_byte[char_x];
			break;

		case BYTES_HEX:
			g_return_val_if_fail(char_x >= 0 && char_x < (int) G_N_ELEMENTS(hex_pos_byte), -1);
			off_x = hex_pos_byte[char_x];
			break;
	}

	if (off_x == -1)
		return -1;

	return off_y + off_x;
}

void
bytes_view_scroll_to_byte(BytesView *bv, int byte)
{
	int line;

	g_return_if_fail(byte >= 0 && byte < bv->len);

	line = byte / bv->per_line;

	bytes_view_ensure_vadj(bv);

	if (line > gtk_adjustment_get_upper(bv->vadj) - gtk_adjustment_get_page_size(bv->vadj)) {
		line = (int)(gtk_adjustment_get_upper(bv->vadj) - gtk_adjustment_get_page_size(bv->vadj));

		if (line < 0)
			line = 0;
	}

	/* after bytes_view_scroll_to_byte() we always do bytes_view_refresh() so we can block it */
	g_signal_handlers_block_by_func(bv->vadj, bytes_view_adjustment_changed, bv);
	gtk_adjustment_set_value(bv->vadj, line);
	g_signal_handlers_unblock_by_func(bv->vadj, bytes_view_adjustment_changed, bv);

	/* XXX, scroll hadj? */
}

void
bytes_view_set_font(BytesView *bv, PangoFontDescription *font)
{
	if (bv->font)
		pango_font_description_free(bv->font);

#if GTK_CHECK_VERSION(3, 0, 0)
	gtk_widget_override_font(GTK_WIDGET(bv), font);
#else
	gtk_widget_modify_font(GTK_WIDGET(bv), font);
#endif
	bv->font = pango_font_description_copy(font);
	bv->max_width = 0;

	if (bv->context) {
		g_object_unref(bv->context);
		bv->context = NULL;
		bytes_view_ensure_layout(bv);
	}
}

void
bytes_view_set_data(BytesView *bv, const guint8 *data, int len)
{
	g_free(bv->pd);
	bv->pd = (guint8 *)g_memdup(data, len);
	bv->len = len;

	/*
	 * How many of the leading digits of the offset will we supply?
	 * We always supply at least 4 digits, but if the maximum offset
	 * won't fit in 4 digits, we use as many digits as will be needed.
	 */
	if (((len - 1) & 0xF0000000) != 0)
		bv->use_digits = 8; /* need all 8 digits */
	else if (((len - 1) & 0x0F000000) != 0)
		bv->use_digits = 7; /* need 7 digits */
	else if (((len - 1) & 0x00F00000) != 0)
		bv->use_digits = 6; /* need 6 digits */
	else if (((len - 1) & 0x000F0000) != 0)
		bv->use_digits = 5; /* need 5 digits */
	else
		bv->use_digits = 4; /* we'll supply 4 digits */

	bytes_view_ensure_vadj(bv);

	bytes_view_adjustment_set(bv);
}

void
bytes_view_set_encoding(BytesView *bv, packet_char_enc enc)
{
	bv->encoding = enc;
}

void
bytes_view_set_format(BytesView *bv, int format)
{
	g_assert(format == BYTES_HEX || format == BYTES_BITS);

	bv->format = (bytes_view_type)format;

	switch (format) {
		case BYTES_BITS:
			bv->per_line = 8;
			break;

		case BYTES_HEX:
			bv->per_line = 16;
			break;
	}
}

void
bytes_view_set_highlight_style(BytesView *bv, gboolean inverse)
{
	bv->bold_highlight = !inverse;
}

void
bytes_view_set_highlight(BytesView *bv, int start, int end, guint64 mask _U_, int maskle _U_)
{
	bv->start[0] = start;
	bv->end[0] = end;
}

void
bytes_view_set_highlight_extra(BytesView *bv, int id, int start, int end)
{
	bv->start[id] = start;
	bv->end[id] = end;
}

void
bytes_view_refresh(BytesView *bv)
{
	/* bytes_view_render_full(bv); */
	gtk_widget_queue_draw(GTK_WIDGET(bv));
}

GtkWidget *
bytes_view_new(void)
{
	GtkWidget *widget;

	widget = (GtkWidget *) g_object_new(BYTES_VIEW_TYPE, NULL);

	g_assert(widget != NULL);

	return widget;
}

/*
 * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 8
 * tab-width: 8
 * indent-tabs-mode: t
 * End:
 *
 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 * :indentSize=8:tabSize=8:noTabs=false:
 */