/* Chrysalide - Outil d'analyse de fichiers binaires
* gtkbufferview.c - affichage de tampons de lignes
*
* Copyright (C) 2010-2014 Cyrille Bagard
*
* This file is part of Chrysalide.
*
* OpenIDA 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.
*
* OpenIDA 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 Foobar. If not, see .
*/
#include "gtkbufferview-int.h"
#include
#include "../glibext/chrysamarshal.h"
/* -------------------------- INTERACTION DIRECTE AVEC GTK -------------------------- */
/* Procède à l'initialisation de l'afficheur de tampons. */
static void gtk_buffer_view_class_init(GtkBufferViewClass *);
/* Procède à l'initialisation de l'afficheur de tampons. */
static void gtk_buffer_view_init(GtkBufferView *);
/* Intègre le focus dans le rendu du composant. */
static gboolean gtk_buffer_view_focus(GtkWidget *, GtkDirectionType);
/* Assure la gestion des clics de souris sur le composant. */
static gboolean gtk_buffer_view_button_press(GtkWidget *, GdkEventButton *);
/* Met à jour l'affichage de la visualisation de code buffer. */
static gboolean gtk_buffer_view_draw(GtkWidget *, cairo_t *);
/* Prend en compte une frappe de touche sur le composant. */
static gboolean gtk_buffer_view_key_press(GtkWidget *, GdkEventKey *);
/* Indique les dimensions de travail du composant d'affichage. */
static void gtk_buffer_view_compute_requested_size(GtkBufferView *, gint *, gint *);
/* Détermine la taille des bonds lors de défilements. */
static void gtk_buffer_view_compute_scroll_inc(GtkBufferView *, gint, GtkOrientation, gdouble *, gdouble *);
/* Indique la position d'affichage d'une adresse donnée. */
static bool gtk_buffer_view_get_address_coordinates(const GtkBufferView *, const vmpa2t *, gint *, gint *, ScrollPositionTweak);
/* Place en cache un rendu destiné à l'aperçu graphique rapide. */
static void gtk_buffer_view_cache_glance(GtkBufferView *, cairo_t *, const GtkAllocation *, double);
/* ------------------------------ ANIMATION DU CURSEUR ------------------------------ */
/* Déplace le curseur en effaçant son éventuelle position. */
static void gtk_buffer_view_relocate_caret(GtkBufferView *, const GdkRectangle *, const vmpa2t *);
/* Redémarre l'affichage du curseur à l'emplacement courant. */
static void restart_caret_blinking(GtkBufferView *);
/* Bascule et relance l'affichage du curseur. */
static gboolean gtk_buffer_view_refresh_caret(GtkBufferView *);
/* ---------------------------------------------------------------------------------- */
/* INTERACTION DIRECTE AVEC GTK */
/* ---------------------------------------------------------------------------------- */
/* Détermine le type du composant d'affichage de tampon de lignes. */
G_DEFINE_TYPE(GtkBufferView, gtk_buffer_view, GTK_TYPE_VIEW_PANEL)
/******************************************************************************
* *
* Paramètres : class = classe GTK à initialiser. *
* *
* Description : Procède à l'initialisation de l'afficheur de tampons. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_class_init(GtkBufferViewClass *class)
{
GtkWidgetClass *widget_class; /* Classe version Widget */
GtkViewPanelClass *panel_class; /* Classe parente */
widget_class = GTK_WIDGET_CLASS(class);
panel_class = GTK_VIEW_PANEL_CLASS(class);
widget_class->focus = gtk_buffer_view_focus;
widget_class->button_press_event = gtk_buffer_view_button_press;
widget_class->draw = gtk_buffer_view_draw;
widget_class->key_press_event = gtk_buffer_view_key_press;
panel_class->compute_size = (compute_requested_size)gtk_buffer_view_compute_requested_size;
panel_class->compute_inc = (compute_scroll_inc)gtk_buffer_view_compute_scroll_inc;
panel_class->get_coordinates = (get_addr_coordinates_fc)gtk_buffer_view_get_address_coordinates;
g_signal_new("caret-moved",
GTK_TYPE_BUFFER_VIEW,
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET(GtkBufferViewClass, caret_moved),
NULL, NULL,
g_cclosure_user_marshal_VOID__UINT64,
G_TYPE_NONE, 1, G_TYPE_UINT64);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à initialiser. *
* *
* Description : Procède à l'initialisation de l'afficheur de tampons. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_init(GtkBufferView *view)
{
GtkViewPanel *viewpanel; /* Instance parente */
viewpanel = GTK_VIEW_PANEL(view);
viewpanel->cache_glance = (cache_glance_fc)gtk_buffer_view_cache_glance;
view->caret.x = 10;
view->caret.y = 10;
view->caret.width = 100;
view->caret.height = 100;
}
/******************************************************************************
* *
* Paramètres : widget = composant GTK visé par l'opération. *
* dir = sens de l'opération : perte ou gain de focus. *
* *
* Description : Intègre le focus dans le rendu du composant. *
* *
* Retour : FALSE pour poursuivre la propagation de l'événement. *
* *
* Remarques : - *
* *
******************************************************************************/
static gboolean gtk_buffer_view_focus(GtkWidget *widget, GtkDirectionType direction)
{
GtkBufferView *view; /* Autre version du composant */
gboolean has_focus; /* Etat courant */
view = GTK_BUFFER_VIEW(widget);
has_focus = gtk_widget_is_focus(widget);
if (has_focus)
restart_caret_blinking(view);
else if (view->caret_timer != 0)
{
g_source_remove(view->caret_timer);
view->caret_timer = 0;
view->show_caret = true;
gtk_buffer_view_refresh_caret(view);
}
return TRUE;
}
/******************************************************************************
* *
* Paramètres : widget = composant GTK visé par l'opération. *
* event = informations liées à l'événement. *
* *
* Description : Assure la gestion des clics de souris sur le composant. *
* *
* Retour : FALSE pour poursuivre la propagation de l'événement. *
* *
* Remarques : - *
* *
******************************************************************************/
static gboolean gtk_buffer_view_button_press(GtkWidget *widget, GdkEventButton *event)
{
GtkBufferView *view; /* Autre version du composant */
GtkViewPanel *pview; /* Autre version du composant */
gint real_x; /* Abscisse absolue réelle */
gint real_y; /* Ordonnée absolue réelle */
size_t index; /* Indice de ligne de tampon */
GBufferLine *line; /* Ligne à la position courante*/
const vmpa2t *addr; /* Position mémoire associée */
GdkRectangle new; /* Nouvel emplacement calculé */
view = GTK_BUFFER_VIEW(widget);
pview = GTK_VIEW_PANEL(widget);
gtk_widget_grab_focus(widget);
real_x = event->x;
real_y = event->y;
gtk_buffer_view_compute_real_coord(view, &real_x, &real_y);
printf(" !mouse! :: (%g ; %g) -> (%d ; %d)\n",
event->x, event->y,
real_x, real_y);
line = g_buffer_view_find_line_at(view->buffer_view, real_y, &index);
if (line == NULL) return FALSE;
printf(" [init ] %p - line = %p (y=%d)\n", view->buffer_view, line, real_y);
if (real_x < view->left_margin)
{
printf("Border Line :: %p\n", line);
}
else
{
addr = g_buffer_view_compute_caret(view->buffer_view, line, index, real_x, pview->display, &new);
gtk_buffer_view_relocate_caret(view, &new, addr);
}
return FALSE;
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* event = informations liées à l'événement. *
* *
* Description : Transcrit les coordonnées à l'écran en coordonnées absolues. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void gtk_buffer_view_compute_fake_coord(GtkBufferView *view, gint *x, gint *y)
{
if (GTK_VIEW_PANEL(view)->hadjustment != NULL)
*x -= gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->hadjustment);
if (GTK_VIEW_PANEL(view)->vadjustment != NULL)
*y += gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->vadjustment);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* event = informations liées à l'événement. *
* *
* Description : Transcrit les coordonnées absolues en coordonnées à l'écran. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void gtk_buffer_view_compute_real_coord(GtkBufferView *view, gint *x, gint *y)
{
if (x != NULL && GTK_VIEW_PANEL(view)->hadjustment != NULL)
*x += gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->hadjustment);
if (y != NULL && GTK_VIEW_PANEL(view)->vadjustment != NULL)
*y += gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->vadjustment);
}
/******************************************************************************
* *
* Paramètres : widget = composant GTK à redessiner. *
* cr = contexte graphique associé à l'événement. *
* *
* Description : Met à jour l'affichage de la visualisation de code buffer. *
* *
* Retour : FALSE pour poursuivre la propagation de l'événement. *
* *
* Remarques : - *
* *
******************************************************************************/
static gboolean gtk_buffer_view_draw(GtkWidget *widget, cairo_t *cr)
{
GtkBufferView *view; /* Autre version du composant */
GtkViewPanel *pview; /* Autre version du composant */
GdkWindow *window; /* Fenêtre à redessiner */
cairo_region_t *region; /* Région visible à redessiner */
cairo_rectangle_int_t area; /* Surface correspondante */
GtkStyleContext *context; /* Contexte du thème actuel */
gint fake_x; /* Abscisse virtuelle */
gint fake_y; /* Ordonnée virtuelle */
view = GTK_BUFFER_VIEW(widget);
pview = GTK_VIEW_PANEL(widget);
window = gtk_widget_get_window(widget);
cairo_save(cr);
gtk_cairo_transform_to_window(cr, widget, window);
region = gdk_window_get_clip_region(window);
cairo_region_get_extents(region, &area);
cairo_region_destroy(region);
/* Dessin de la marge gauche */
context = gtk_widget_get_style_context(widget);
gtk_style_context_save(context);
gtk_style_context_add_class(context, GTK_STYLE_CLASS_TROUGH);
gtk_render_background (context, cr, 0, area.y, view->left_margin, area.height);
gtk_render_frame(context, cr, 0, area.y - 10, view->left_margin, area.height + 20);
gtk_style_context_restore(context);
/* Eventuelle bordure globale */
GTK_WIDGET_CLASS(gtk_buffer_view_parent_class)->draw(widget, cr);
/* Impression du désassemblage */
if (view->buffer_view != NULL)
{
fake_x = 0;
fake_y = 0;
gtk_buffer_view_compute_fake_coord(view, &fake_x, &fake_y);
g_buffer_view_draw(view->buffer_view, cr, fake_x, fake_y, &area, pview->display);
}
/* Curseur clignotant ? */
if (gtk_widget_is_focus(widget))
{
view->show_caret = !view->show_caret;
gtk_buffer_view_refresh_caret(view);
}
cairo_restore(cr);
return TRUE;
}
/******************************************************************************
* *
* Paramètres : widget = composant visé par l'opération. *
* event = informations liées à l'événement. *
* *
* Description : Prend en compte une frappe de touche sur le composant. *
* *
* Retour : FALSE pour poursuivre la propagation de l'événement. *
* *
* Remarques : - *
* *
******************************************************************************/
static gboolean gtk_buffer_view_key_press(GtkWidget *widget, GdkEventKey *event)
{
gboolean result; /* Suites à renvoyer */
GtkBufferView *view; /* Autre version du composant */
GtkViewPanel *pview; /* Autre version du composant */
bool ctrl; /* Statut de la touche Contrôle*/
GdkRectangle area;
const vmpa2t *addr;
result = FALSE;
view = GTK_BUFFER_VIEW(widget);
pview = GTK_VIEW_PANEL(widget);
area = view->caret;
ctrl = (event->state & GDK_CONTROL_MASK);
switch (event->keyval)
{
case GDK_KEY_Left:
printf("LEFT\n");
addr = g_buffer_view_move_caret(view->buffer_view, &area, ctrl, GDK_SCROLL_LEFT, pview->display);
gtk_buffer_view_relocate_caret(view, &area, view->caret_addr);
result = TRUE;
break;
case GDK_KEY_Up:
printf("UP\n");
addr = g_buffer_view_move_caret(view->buffer_view, &area, ctrl, GDK_SCROLL_UP, pview->display);
gtk_buffer_view_relocate_caret(view, &area, view->caret_addr);
result = TRUE;
break;
case GDK_KEY_Right:
printf("RIGHT\n");
addr = g_buffer_view_move_caret(view->buffer_view, &area, ctrl, GDK_SCROLL_RIGHT, pview->display);
gtk_buffer_view_relocate_caret(view, &area, view->caret_addr);
result = TRUE;
break;
case GDK_KEY_Down:
printf("DOWN\n");
addr = g_buffer_view_move_caret(view->buffer_view, &area, ctrl, GDK_SCROLL_DOWN, pview->display);
gtk_buffer_view_relocate_caret(view, &area, view->caret_addr);
result = TRUE;
break;
default:
addr = NULL;
break;
}
printf("ctrl ? %d -- keyval = %d -->> %d\n", ctrl, event->keyval, result);
if (addr != NULL) gtk_view_panel_scroll_to_address(pview, addr, SPT_RAW);
printf("\n");
return result;
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* width = largeur requise à renseigner ou NULL. [OUT] *
* height = hauteur requise à renseigner ou NULL. [OUT] *
* *
* Description : Indique les dimensions de travail du composant d'affichage. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_compute_requested_size(GtkBufferView *view, gint *width, gint *height)
{
if (width != NULL && view->buffer_view != NULL)
*width = g_buffer_view_get_width(view->buffer_view, GTK_VIEW_PANEL(view)->display);
if (height != NULL && view->buffer_view != NULL)
*height = g_buffer_view_get_height(view->buffer_view);
}
/******************************************************************************
* *
* Paramètres : panel = composant GTK d'affichage à mettre à jour. *
* size = taille de l'espace dans la direction donnée. *
* orientation = indication sur le défilement à traiter. *
* step = valeur d'un petit pas de défilement. [OUT] *
* page = valeur d'un grand pas de défilement. [OUT] *
* *
* Description : Détermine la taille des bonds lors de défilements. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_compute_scroll_inc(GtkBufferView *view, gint size, GtkOrientation orientation, gdouble *step, gdouble *page)
{
if (orientation == GTK_ORIENTATION_VERTICAL)
{
*step = 17; // FIXME g_buffer_view_get_line_height(view->buffer_view);
*page = *step * 10;
}
else
GTK_VIEW_PANEL_CLASS(gtk_buffer_view_parent_class)->compute_inc(GTK_VIEW_PANEL(view),
size, orientation, step, page);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* addr = adresse à présenter à l'écran. *
* x = position horizontale au sein du composant. [OUT] *
* y = position verticale au sein du composant. [OUT] *
* tweak = adaptation finale à effectuer. *
* *
* Description : Indique la position d'affichage d'une adresse donnée. *
* *
* Retour : true si l'adresse fait partie du composant, false sinon. *
* *
* Remarques : - *
* *
******************************************************************************/
static bool gtk_buffer_view_get_address_coordinates(const GtkBufferView *view, const vmpa2t *addr, gint *x, gint *y, ScrollPositionTweak tweak)
{
bool result; /* Bilan à remonter */
bool need_code; /* Recherche plus raffinée */
int height; /* Hauteur allouée */
need_code = (tweak == SPT_BOTTOM);
result = g_buffer_view_get_address_coordinates(view->buffer_view, addr, x, y, need_code);
if (result)
{
height = gtk_widget_get_allocated_height(GTK_WIDGET(view));
switch (tweak)
{
case SPT_RAW:
break;
case SPT_TOP:
break;
case SPT_CENTER:
*y -= (height / 2);
break;
case SPT_BOTTOM:
*y -= height;
*y += g_buffer_view_get_line_height(view->buffer_view);
break;
}
}
return result;
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à manipuler. *
* cairo = assistant pour la création de rendus. *
* area = taille de la surface réduite à disposition. *
* scale = échelle vis à vis de la taille réelle. *
* *
* Description : Place en cache un rendu destiné à l'aperçu graphique rapide. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_cache_glance(GtkBufferView *view, cairo_t *cairo, const GtkAllocation *area, double scale)
{
cairo_set_line_width(cairo, 1);
cairo_set_source_rgb(cairo, 0.4, 0.4, 0.4);
cairo_rectangle(cairo, area->x + 0.5, area->y + 0.5, area->width - 1, area->height - 1);
cairo_stroke(cairo);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à mettre à jour. *
* buffer = tampon de lignes à encadrer. *
* *
* Description : Prend acte de l'association d'un tampon de lignes. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void gtk_buffer_view_attach_buffer(GtkBufferView *view, GBufferView *buffer)
{
gint width; /* Largeur de l'objet actuelle */
gint height; /* Hauteur de l'objet actuelle */
if (view->buffer != NULL)
{
g_object_unref(G_OBJECT(view->buffer));
g_object_unref(G_OBJECT(view->buffer_view));
}
view->buffer = g_buffer_view_get_buffer(buffer);
g_object_ref(G_OBJECT(view->buffer));
view->buffer_view = buffer;
/* Taille des marges */
view->line_height = g_buffer_view_get_line_height(view->buffer_view);
view->left_margin = 2 * view->line_height;
view->left_text = -2.5 * view->line_height;
/* Validation finale */
width = g_buffer_view_get_width(view->buffer_view, GTK_VIEW_PANEL(view)->display);
height = g_buffer_view_get_height(view->buffer_view);
width += -view->left_text + 1;
height += 1;
//gtk_widget_set_size_request(GTK_WIDGET(view), width, height);
gtk_widget_queue_draw(GTK_WIDGET(view));
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* *
* Description : Fournit la vue associée au tampon de lignes courant. *
* *
* Retour : Vue mise en place. *
* *
* Remarques : - *
* *
******************************************************************************/
GBufferView *gtk_buffer_view_get_buffer(const GtkBufferView *view)
{
return view->buffer_view;
}
/* ---------------------------------------------------------------------------------- */
/* CONVERSIONS DE COORDONNEES */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : view = composant GTK à consulter. *
* x = abscisse à ajuster. [OUT] *
* x = ordonnée à ajuster. [OUT] *
* *
* Description : Transcrit les coordonnées absolues en coordonnées à l'écran. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
void gtk_buffer_view_compute_relative_coords(GtkBufferView *view, gint *x, gint *y)
{
if (x != NULL && GTK_VIEW_PANEL(view)->hadjustment != NULL)
*x -= gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->hadjustment);
if (y != NULL && GTK_VIEW_PANEL(view)->vadjustment != NULL)
*y -= gtk_adjustment_get_value(GTK_VIEW_PANEL(view)->vadjustment);
}
/* ---------------------------------------------------------------------------------- */
/* ANIMATION DU CURSEUR */
/* ---------------------------------------------------------------------------------- */
/******************************************************************************
* *
* Paramètres : view = composant GTK à manipuler. *
* area = emplacement pour le dessin d'un curseur. *
* addr = position dans la mémoire représentée du curseur. *
* *
* Description : Déplace le curseur en effaçant son éventuelle position. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void gtk_buffer_view_relocate_caret(GtkBufferView *view, const GdkRectangle *area, const vmpa2t *addr)
{
if (view->caret_addr != NULL)
{
gtk_buffer_view_compute_relative_coords(view, &view->caret.x, &view->caret.y);
gtk_widget_queue_draw_area(GTK_WIDGET(view), view->caret.x, view->caret.y,
view->caret.width, view->caret.height);
}
view->caret = *area;
view->caret_addr = addr;
restart_caret_blinking(view);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à manipuler. *
* *
* Description : Indique la position courante du curseur. *
* *
* Retour : Emplacement courant du curseur. *
* *
* Remarques : - *
* *
******************************************************************************/
const vmpa2t *gtk_buffer_view_get_caret_location(const GtkBufferView *view)
{
return view->caret_addr;
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à manipuler. *
* *
* Description : Redémarre l'affichage du curseur à l'emplacement courant. *
* *
* Retour : - *
* *
* Remarques : - *
* *
******************************************************************************/
static void restart_caret_blinking(GtkBufferView *view)
{
if (view->caret_timer != 0)
{
g_source_remove(view->caret_timer);
view->caret_timer = 0;
}
if (view->caret_addr != NULL)
{
view->show_caret = false;
gtk_buffer_view_refresh_caret(view);
view->caret_timer = g_timeout_add_seconds(1, (GSourceFunc)gtk_buffer_view_refresh_caret, view);
}
g_signal_emit_by_name(view, "caret-moved", view->caret_addr);
}
/******************************************************************************
* *
* Paramètres : view = composant GTK à manipuler. *
* *
* Description : Bascule et relance l'affichage du curseur. *
* *
* Retour : TRUE pour poursuivre les basculements automatiques. *
* *
* Remarques : - *
* *
******************************************************************************/
static gboolean gtk_buffer_view_refresh_caret(GtkBufferView *view)
{
GtkWidget *widget; /* Autre version du composant */
GdkWindow *window; /* Fenêtre de support associée */
GdkRectangle area; /* Région adaptée à traiter */
cairo_t *cr; /* Contexte graphique */
GdkRGBA *color; /* Couleur du curseur */
widget = GTK_WIDGET(view);
window = gtk_widget_get_window(widget);
/**
* Si le composant n'est pas encore réalisé (ou caché, en cas de
* basculement entre les types de vues), gdk_cairo_create() ne va
* pas apprécier l'argument NULL. Donc on écourte l'opération.
*/
if (window == NULL)
{
view->show_caret = !view->show_caret;
return TRUE;
}
area = view->caret;
gtk_buffer_view_compute_relative_coords(view, &area.x, &area.y);
/* Réinitialisation de la surface */
if (view->show_caret)
{
view->show_caret = false;
gtk_widget_queue_draw_area(widget, area.x, area.y, area.width, area.height);
}
/* Dessin */
else
{
view->show_caret = true;
cr = gdk_cairo_create(gtk_widget_get_window(widget));
gtk_style_context_get(gtk_widget_get_style_context(widget),
gtk_widget_get_state_flags(widget),
GTK_STYLE_PROPERTY_COLOR, &color, NULL);
cairo_set_source_rgb(cr, color->red, color->green, color->blue);
cairo_rectangle(cr, area.x, area.y, area.width, area.height);
cairo_fill(cr);
cairo_destroy(cr);
}
return TRUE;
}