1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2001. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include "gtktextview.h"
30 #include "gtktextutil.h"
32 #define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
34 #include "gtktextdisplay.h"
35 #include "gtktextbuffer.h"
36 #include "gtkmenuitem.h"
40 #define DRAG_ICON_MAX_WIDTH 250
41 #define DRAG_ICON_MAX_HEIGHT 250
42 #define DRAG_ICON_LAYOUT_BORDER 5
43 #define DRAG_ICON_MAX_LINES 7
44 #define ELLIPSIS_CHARACTER "\xe2\x80\xa6"
46 typedef struct _GtkUnicodeMenuEntry GtkUnicodeMenuEntry;
47 typedef struct _GtkTextUtilCallbackInfo GtkTextUtilCallbackInfo;
49 struct _GtkUnicodeMenuEntry {
54 struct _GtkTextUtilCallbackInfo
56 GtkTextUtilCharChosenFunc func;
60 static const GtkUnicodeMenuEntry bidi_menu_entries[] = {
61 { N_("LRM _Left-to-right mark"), 0x200E },
62 { N_("RLM _Right-to-left mark"), 0x200F },
63 { N_("LRE Left-to-right _embedding"), 0x202A },
64 { N_("RLE Right-to-left e_mbedding"), 0x202B },
65 { N_("LRO Left-to-right _override"), 0x202D },
66 { N_("RLO Right-to-left o_verride"), 0x202E },
67 { N_("PDF _Pop directional formatting"), 0x202C },
68 { N_("ZWS _Zero width space"), 0x200B },
69 { N_("ZWJ Zero width _joiner"), 0x200D },
70 { N_("ZWNJ Zero width _non-joiner"), 0x200C }
73 static GtkTextUtilCallbackInfo *
74 callback_info_new (GtkTextUtilCharChosenFunc func,
77 GtkTextUtilCallbackInfo *info;
79 info = g_slice_new (GtkTextUtilCallbackInfo);
88 callback_info_free (GtkTextUtilCallbackInfo *info)
90 g_slice_free (GtkTextUtilCallbackInfo, info);
94 activate_cb (GtkWidget *menu_item,
97 GtkUnicodeMenuEntry *entry;
98 GtkTextUtilCallbackInfo *info = data;
101 entry = g_object_get_data (G_OBJECT (menu_item), "gtk-unicode-menu-entry");
103 buf[g_unichar_to_utf8 (entry->ch, buf)] = '\0';
105 (* info->func) (buf, info->data);
109 * _gtk_text_util_append_special_char_menuitems
110 * @menushell: a #GtkMenuShell
111 * @callback: call this when an item is chosen
112 * @data: data for callback
114 * Add menuitems for various bidi control characters to a menu;
115 * the menuitems, when selected, will call the given function
116 * with the chosen character.
118 * This function is private/internal in GTK 2.0, the functionality may
119 * become public sometime, but it probably needs more thought first.
120 * e.g. maybe there should be a way to just get the list of items,
121 * instead of requiring the menu items to be created.
124 _gtk_text_util_append_special_char_menuitems (GtkMenuShell *menushell,
125 GtkTextUtilCharChosenFunc func,
130 for (i = 0; i < G_N_ELEMENTS (bidi_menu_entries); i++)
133 GtkTextUtilCallbackInfo *info;
135 info = callback_info_new (func, data);
137 menuitem = gtk_menu_item_new_with_mnemonic (_(bidi_menu_entries[i].label));
138 g_object_set_data (G_OBJECT (menuitem), I_("gtk-unicode-menu-entry"),
139 (gpointer)&bidi_menu_entries[i]);
141 g_signal_connect_data (menuitem, "activate",
142 G_CALLBACK (activate_cb),
143 info, (GClosureNotify) callback_info_free, 0);
145 gtk_widget_show (menuitem);
146 gtk_menu_shell_append (menushell, menuitem);
151 append_n_lines (GString *str, const gchar *text, GSList *lines, gint n_lines)
153 PangoLayoutLine *line;
156 for (i = 0; i < n_lines; i++)
159 g_string_append_len (str, &text[line->start_index], line->length);
165 limit_layout_lines (PangoLayout *layout)
169 GSList *lines, *elem;
172 n_lines = pango_layout_get_line_count (layout);
174 if (n_lines >= DRAG_ICON_MAX_LINES)
176 text = pango_layout_get_text (layout);
177 str = g_string_new (NULL);
178 lines = pango_layout_get_lines_readonly (layout);
180 /* get first lines */
182 append_n_lines (str, text, elem,
183 DRAG_ICON_MAX_LINES / 2);
185 g_string_append (str, "\n" ELLIPSIS_CHARACTER "\n");
188 elem = g_slist_nth (lines, n_lines - DRAG_ICON_MAX_LINES / 2);
189 append_n_lines (str, text, elem,
190 DRAG_ICON_MAX_LINES / 2);
192 pango_layout_set_text (layout, str->str, -1);
193 g_string_free (str, TRUE);
198 * _gtk_text_util_create_drag_icon
199 * @widget: #GtkWidget to extract the pango context
200 * @text: a #gchar to render the icon
201 * @len: length of @text, or -1 for NUL-terminated text
203 * Creates a drag and drop icon from @text.
205 * Returns: a #GdkPixmap to use as DND icon
208 _gtk_text_util_create_drag_icon (GtkWidget *widget,
212 GdkDrawable *drawable = NULL;
213 PangoContext *context;
215 gint pixmap_height, pixmap_width;
216 gint layout_width, layout_height;
218 g_return_val_if_fail (widget != NULL, NULL);
219 g_return_val_if_fail (text != NULL, NULL);
221 context = gtk_widget_get_pango_context (widget);
222 layout = pango_layout_new (context);
224 pango_layout_set_text (layout, text, len);
225 pango_layout_set_wrap (layout, PANGO_WRAP_WORD_CHAR);
226 pango_layout_get_size (layout, &layout_width, &layout_height);
228 layout_width = MIN (layout_width, DRAG_ICON_MAX_WIDTH * PANGO_SCALE);
229 pango_layout_set_width (layout, layout_width);
231 limit_layout_lines (layout);
233 /* get again layout extents, they may have changed */
234 pango_layout_get_size (layout, &layout_width, &layout_height);
236 pixmap_width = layout_width / PANGO_SCALE + DRAG_ICON_LAYOUT_BORDER * 2;
237 pixmap_height = layout_height / PANGO_SCALE + DRAG_ICON_LAYOUT_BORDER * 2;
239 drawable = gdk_pixmap_new (widget->window,
244 gdk_draw_rectangle (drawable,
245 widget->style->base_gc [GTK_WIDGET_STATE (widget)],
251 gdk_draw_layout (drawable,
252 widget->style->text_gc [GTK_WIDGET_STATE (widget)],
253 1 + DRAG_ICON_LAYOUT_BORDER,
254 1 + DRAG_ICON_LAYOUT_BORDER,
257 gdk_draw_rectangle (drawable,
258 widget->style->black_gc,
264 g_object_unref (layout);
270 gtk_text_view_set_attributes_from_style (GtkTextView *text_view,
271 GtkTextAttributes *values,
274 values->appearance.bg_color = style->base[GTK_STATE_NORMAL];
275 values->appearance.fg_color = style->text[GTK_STATE_NORMAL];
278 pango_font_description_free (values->font);
280 values->font = pango_font_description_copy (style->font_desc);
284 _gtk_text_util_create_rich_drag_icon (GtkWidget *widget,
285 GtkTextBuffer *buffer,
289 GdkDrawable *drawable = NULL;
290 gint pixmap_height, pixmap_width;
291 gint layout_width, layout_height;
292 GtkTextBuffer *new_buffer;
293 GtkTextLayout *layout;
294 GtkTextAttributes *style;
295 PangoContext *ltr_context, *rtl_context;
298 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
299 g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);
300 g_return_val_if_fail (start != NULL, NULL);
301 g_return_val_if_fail (end != NULL, NULL);
303 new_buffer = gtk_text_buffer_new (gtk_text_buffer_get_tag_table (buffer));
304 gtk_text_buffer_get_start_iter (new_buffer, &iter);
306 gtk_text_buffer_insert_range (new_buffer, &iter, start, end);
308 gtk_text_buffer_get_start_iter (new_buffer, &iter);
310 layout = gtk_text_layout_new ();
312 ltr_context = gtk_widget_create_pango_context (widget);
313 pango_context_set_base_dir (ltr_context, PANGO_DIRECTION_LTR);
314 rtl_context = gtk_widget_create_pango_context (widget);
315 pango_context_set_base_dir (rtl_context, PANGO_DIRECTION_RTL);
317 gtk_text_layout_set_contexts (layout, ltr_context, rtl_context);
319 g_object_unref (ltr_context);
320 g_object_unref (rtl_context);
322 style = gtk_text_attributes_new ();
324 layout_width = widget->allocation.width;
326 if (GTK_IS_TEXT_VIEW (widget))
328 gtk_widget_ensure_style (widget);
329 gtk_text_view_set_attributes_from_style (GTK_TEXT_VIEW (widget),
330 style, widget->style);
332 layout_width = layout_width
333 - gtk_text_view_get_border_window_size (GTK_TEXT_VIEW (widget), GTK_TEXT_WINDOW_LEFT)
334 - gtk_text_view_get_border_window_size (GTK_TEXT_VIEW (widget), GTK_TEXT_WINDOW_RIGHT);
337 style->direction = gtk_widget_get_direction (widget);
338 style->wrap_mode = PANGO_WRAP_WORD_CHAR;
340 gtk_text_layout_set_default_style (layout, style);
341 gtk_text_attributes_unref (style);
343 gtk_text_layout_set_buffer (layout, new_buffer);
344 gtk_text_layout_set_cursor_visible (layout, FALSE);
345 gtk_text_layout_set_screen_width (layout, layout_width);
347 gtk_text_layout_validate (layout, DRAG_ICON_MAX_HEIGHT);
348 gtk_text_layout_get_size (layout, &layout_width, &layout_height);
350 layout_width = MIN (layout_width, DRAG_ICON_MAX_WIDTH);
351 layout_height = MIN (layout_height, DRAG_ICON_MAX_HEIGHT);
353 pixmap_width = layout_width + DRAG_ICON_LAYOUT_BORDER * 2;
354 pixmap_height = layout_height + DRAG_ICON_LAYOUT_BORDER * 2;
356 drawable = gdk_pixmap_new (widget->window,
357 pixmap_width + 2, pixmap_height + 2, -1);
359 gdk_draw_rectangle (drawable,
360 widget->style->base_gc [GTK_WIDGET_STATE (widget)],
366 gtk_text_layout_draw (layout, widget, drawable,
367 widget->style->text_gc [GTK_WIDGET_STATE (widget)],
368 - (1 + DRAG_ICON_LAYOUT_BORDER),
369 - (1 + DRAG_ICON_LAYOUT_BORDER),
371 pixmap_width, pixmap_height, NULL);
373 gdk_draw_rectangle (drawable,
374 widget->style->black_gc,
380 g_object_unref (layout);
381 g_object_unref (new_buffer);
388 layout_get_char_width (PangoLayout *layout)
391 PangoFontMetrics *metrics;
392 const PangoFontDescription *font_desc;
393 PangoContext *context = pango_layout_get_context (layout);
395 font_desc = pango_layout_get_font_description (layout);
397 font_desc = pango_context_get_font_description (context);
399 metrics = pango_context_get_metrics (context, font_desc, NULL);
400 width = pango_font_metrics_get_approximate_char_width (metrics);
401 pango_font_metrics_unref (metrics);
407 * _gtk_text_util_get_block_cursor_location
408 * @layout: a #PangoLayout
409 * @index: index at which cursor is located
410 * @pos: cursor location
411 * @at_line_end: whether cursor is drawn at line end, not over some
414 * Returns: whether cursor should actually be drawn as a rectangle.
415 * It may not be the case if character at index is invisible.
418 _gtk_text_util_get_block_cursor_location (PangoLayout *layout,
421 gboolean *at_line_end)
423 PangoRectangle strong_pos, weak_pos;
424 PangoLayoutLine *layout_line;
429 g_return_val_if_fail (layout != NULL, FALSE);
430 g_return_val_if_fail (index >= 0, FALSE);
431 g_return_val_if_fail (pos != NULL, FALSE);
433 pango_layout_index_to_pos (layout, index, pos);
437 /* cursor is at some visible character, good */
439 *at_line_end = FALSE;
442 pos->x += pos->width;
443 pos->width = -pos->width;
448 pango_layout_index_to_line_x (layout, index, FALSE, &line_no, NULL);
449 layout_line = pango_layout_get_line_readonly (layout, line_no);
450 g_return_val_if_fail (layout_line != NULL, FALSE);
452 text = pango_layout_get_text (layout);
454 if (index < layout_line->start_index + layout_line->length)
456 /* this may be a zero-width character in the middle of the line,
457 * or it could be a character where line is wrapped, we do want
458 * block cursor in latter case */
459 if (g_utf8_next_char (text + index) - text !=
460 layout_line->start_index + layout_line->length)
462 /* zero-width character in the middle of the line, do not
463 * bother with block cursor */
468 /* Cursor is at the line end. It may be an empty line, or it could
469 * be on the left or on the right depending on text direction, or it
470 * even could be in the middle of visual layout in bidi text. */
472 pango_layout_get_cursor_pos (layout, index, &strong_pos, &weak_pos);
474 if (strong_pos.x != weak_pos.x)
476 /* do not show block cursor in this case, since the character typed
477 * in may or may not appear at the cursor position */
481 /* In case when index points to the end of line, pos->x is always most right
482 * pixel of the layout line, so we need to correct it for RTL text. */
483 if (layout_line->length)
485 if (layout_line->resolved_dir == PANGO_DIRECTION_RTL)
487 PangoLayoutIter *iter;
488 PangoRectangle line_rect;
493 p = g_utf8_prev_char (text + index);
495 pango_layout_line_index_to_x (layout_line, p - text, FALSE, &left);
496 pango_layout_line_index_to_x (layout_line, p - text, TRUE, &right);
497 pos->x = MIN (left, right);
499 iter = pango_layout_get_iter (layout);
500 for (i = 0; i < line_no; i++)
501 pango_layout_iter_next_line (iter);
502 pango_layout_iter_get_line_extents (iter, NULL, &line_rect);
503 pango_layout_iter_free (iter);
506 pos->x += line_rect.x;
513 PangoContext *context = pango_layout_get_context (layout);
514 rtl = pango_context_get_base_dir (context) == PANGO_DIRECTION_RTL;
517 pos->width = layout_get_char_width (layout);
520 pos->x -= pos->width - 1;
525 return pos->width != 0;