Pileus Git - ~andy/gtk/blob - gtk/gtktextlayout.c

   1 /* GTK - The GIMP Toolkit
   2  * gtktextlayout.c - calculate the layout of the text
   3  *
   4  * Copyright (c) 1992-1994 The Regents of the University of California.
   5  * Copyright (c) 1994-1997 Sun Microsystems, Inc.
   6  * Copyright (c) 2000 Red Hat, Inc.
   7  * Tk->Gtk port by Havoc Pennington
   8  * Pango support by Owen Taylor
   9  *
  10  * This file can be used under your choice of two licenses, the LGPL
  11  * and the original Tk license.
  12  *
  13  * LGPL:
  14  *
  15  * This library is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU Lesser General Public
  17  * License as published by the Free Software Foundation; either
  18  * version 2 of the License, or (at your option) any later version.
  19  *
  20  * This library is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  * Lesser General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU Lesser General Public
  26  * License along with this library; if not, write to the Free
  27  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28  *
  29  * Original Tk license:
  30  *
  31  * This software is copyrighted by the Regents of the University of
  32  * California, Sun Microsystems, Inc., and other parties.  The
  33  * following terms apply to all files associated with the software
  34  * unless explicitly disclaimed in individual files.
  35  *
  36  * The authors hereby grant permission to use, copy, modify,
  37  * distribute, and license this software and its documentation for any
  38  * purpose, provided that existing copyright notices are retained in
  39  * all copies and that this notice is included verbatim in any
  40  * distributions. No written agreement, license, or royalty fee is
  41  * required for any of the authorized uses.  Modifications to this
  42  * software may be copyrighted by their authors and need not follow
  43  * the licensing terms described here, provided that the new terms are
  44  * clearly indicated on the first page of each file where they apply.
  45  *
  46  * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
  47  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
  48  * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
  49  * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  *
  52  * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
  53  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  54  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
  55  * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
  56  * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  57  * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  58  *
  59  * GOVERNMENT USE: If you are acquiring this software on behalf of the
  60  * U.S. government, the Government shall have only "Restricted Rights"
  61  * in the software and related documentation as defined in the Federal
  62  * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
  63  * are acquiring the software on behalf of the Department of Defense,
  64  * the software shall be classified as "Commercial Computer Software"
  65  * and the Government shall have only "Restricted Rights" as defined
  66  * in Clause 252.227-7013 (c) (1) of DFARs.  Notwithstanding the
  67  * foregoing, the authors grant the U.S. Government and others acting
  68  * in its behalf permission to use and distribute the software in
  69  * accordance with the terms specified in this license.
  70  *
  71  */
  72 /*
  73  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  74  * file for a list of people on the GTK+ Team.  See the ChangeLog
  75  * files for a list of changes.  These files are distributed with
  76  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  77  */
  78
  79 #define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
  80 #include <config.h>
  81 #include "gtkalias.h"
  82 #include "gtkmarshalers.h"
  83 #include "gtktextlayout.h"
  84 #include "gtktextbtree.h"
  85 #include "gtktextiterprivate.h"
  86
  87 #include <stdlib.h>
  88 #include <string.h>
  89
  90 #define GTK_TEXT_LAYOUT_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutPrivate))
  91
  92 typedef struct _GtkTextLayoutPrivate GtkTextLayoutPrivate;
  93
  94 struct _GtkTextLayoutPrivate
  95 {
  96   /* Cache the line that the cursor is positioned on, as the keyboard
  97      direction only influences the direction of the cursor line.
  98   */
  99   GtkTextLine *cursor_line;
 100 };
 101
 102 static GtkTextLineData *gtk_text_layout_real_wrap (GtkTextLayout *layout,
 103                                                    GtkTextLine *line,
 104                                                    /* may be NULL */
 105                                                    GtkTextLineData *line_data);
 106
 107 static void gtk_text_layout_invalidated     (GtkTextLayout     *layout);
 108
 109 static void gtk_text_layout_real_invalidate        (GtkTextLayout     *layout,
 110                                                     const GtkTextIter *start,
 111                                                     const GtkTextIter *end);
 112 static void gtk_text_layout_invalidate_cache       (GtkTextLayout     *layout,
 113                                                     GtkTextLine       *line);
 114 static void gtk_text_layout_invalidate_cursor_line (GtkTextLayout     *layout);
 115 static void gtk_text_layout_real_free_line_data    (GtkTextLayout     *layout,
 116                                                     GtkTextLine       *line,
 117                                                     GtkTextLineData   *line_data);
 118 static void gtk_text_layout_emit_changed           (GtkTextLayout     *layout,
 119                                                     gint               y,
 120                                                     gint               old_height,
 121                                                     gint               new_height);
 122
 123 static void gtk_text_layout_invalidate_all (GtkTextLayout *layout);
 124
 125 static PangoAttribute *gtk_text_attr_appearance_new (const GtkTextAppearance *appearance);
 126
 127 static void gtk_text_layout_mark_set_handler    (GtkTextBuffer     *buffer,
 128                                                  const GtkTextIter *location,
 129                                                  GtkTextMark       *mark,
 130                                                  gpointer           data);
 131 static void gtk_text_layout_buffer_insert_text  (GtkTextBuffer     *textbuffer,
 132                                                  GtkTextIter       *iter,
 133                                                  gchar             *str,
 134                                                  gint               len,
 135                                                  gpointer           data);
 136 static void gtk_text_layout_buffer_delete_range (GtkTextBuffer     *textbuffer,
 137                                                  GtkTextIter       *start,
 138                                                  GtkTextIter       *end,
 139                                                  gpointer           data);
 140
 141 static void gtk_text_layout_update_cursor_line (GtkTextLayout *layout);
 142
 143 enum {
 144   INVALIDATED,
 145   CHANGED,
 146   ALLOCATE_CHILD,
 147   LAST_SIGNAL
 148 };
 149
 150 enum {
 151   ARG_0,
 152   LAST_ARG
 153 };
 154
 155 #define PIXEL_BOUND(d) (((d) + PANGO_SCALE - 1) / PANGO_SCALE)
 156
 157 static void gtk_text_layout_init       (GtkTextLayout      *text_layout);
 158 static void gtk_text_layout_class_init (GtkTextLayoutClass *klass);
 159 static void gtk_text_layout_finalize   (GObject            *object);
 160
 161
 162 static GtkObjectClass *parent_class = NULL;
 163 static guint signals[LAST_SIGNAL] = { 0 };
 164
 165 PangoAttrType gtk_text_attr_appearance_type = 0;
 166
 167 GType
 168 gtk_text_layout_get_type (void)
 169 {
 170   static GType our_type = 0;
 171
 172   if (our_type == 0)
 173     {
 174       static const GTypeInfo our_info =
 175       {
 176         sizeof (GtkTextLayoutClass),
 177         (GBaseInitFunc) NULL,
 178         (GBaseFinalizeFunc) NULL,
 179         (GClassInitFunc) gtk_text_layout_class_init,
 180         NULL,           /* class_finalize */
 181         NULL,           /* class_data */
 182         sizeof (GtkTextLayout),
 183         0,              /* n_preallocs */
 184         (GInstanceInitFunc) gtk_text_layout_init
 185       };
 186
 187       our_type = g_type_register_static (G_TYPE_OBJECT, "GtkTextLayout",
 188                                          &our_info, 0);
 189     }
 190
 191   return our_type;
 192 }
 193
 194 static void
 195 gtk_text_layout_class_init (GtkTextLayoutClass *klass)
 196 {
 197   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 198
 199   parent_class = g_type_class_peek_parent (klass);
 200
 201   object_class->finalize = gtk_text_layout_finalize;
 202
 203   klass->wrap = gtk_text_layout_real_wrap;
 204   klass->invalidate = gtk_text_layout_real_invalidate;
 205   klass->free_line_data = gtk_text_layout_real_free_line_data;
 206
 207   signals[INVALIDATED] =
 208     g_signal_new ("invalidated",
 209                   G_OBJECT_CLASS_TYPE (object_class),
 210                   G_SIGNAL_RUN_LAST,
 211                   G_STRUCT_OFFSET (GtkTextLayoutClass, invalidated),
 212                   NULL, NULL,
 213                   _gtk_marshal_VOID__VOID,
 214                   G_TYPE_NONE,
 215                   0);
 216
 217   signals[CHANGED] =
 218     g_signal_new ("changed",
 219                   G_OBJECT_CLASS_TYPE (object_class),
 220                   G_SIGNAL_RUN_LAST,
 221                   G_STRUCT_OFFSET (GtkTextLayoutClass, changed),
 222                   NULL, NULL,
 223                   _gtk_marshal_VOID__INT_INT_INT,
 224                   G_TYPE_NONE,
 225                   3,
 226                   G_TYPE_INT,
 227                   G_TYPE_INT,
 228                   G_TYPE_INT);
 229
 230   signals[ALLOCATE_CHILD] =
 231     g_signal_new ("allocate_child",
 232                   G_OBJECT_CLASS_TYPE (object_class),
 233                   G_SIGNAL_RUN_LAST,
 234                   G_STRUCT_OFFSET (GtkTextLayoutClass, allocate_child),
 235                   NULL, NULL,
 236                   _gtk_marshal_VOID__OBJECT_INT_INT,
 237                   G_TYPE_NONE,
 238                   3,
 239                   GTK_TYPE_OBJECT,
 240                   G_TYPE_INT,
 241                   G_TYPE_INT);
 242
 243   g_type_class_add_private (object_class, sizeof (GtkTextLayoutPrivate));
 244 }
 245
 246 static void
 247 gtk_text_layout_init (GtkTextLayout *text_layout)
 248 {
 249   text_layout->cursor_visible = TRUE;
 250 }
 251
 252 GtkTextLayout*
 253 gtk_text_layout_new (void)
 254 {
 255   return g_object_new (GTK_TYPE_TEXT_LAYOUT, NULL);
 256 }
 257
 258 static void
 259 free_style_cache (GtkTextLayout *text_layout)
 260 {
 261   if (text_layout->one_style_cache)
 262     {
 263       gtk_text_attributes_unref (text_layout->one_style_cache);
 264       text_layout->one_style_cache = NULL;
 265     }
 266 }
 267
 268 static void
 269 gtk_text_layout_finalize (GObject *object)
 270 {
 271   GtkTextLayout *layout;
 272
 273   layout = GTK_TEXT_LAYOUT (object);
 274
 275   gtk_text_layout_set_buffer (layout, NULL);
 276
 277   if (layout->default_style)
 278     gtk_text_attributes_unref (layout->default_style);
 279   layout->default_style = NULL;
 280
 281   if (layout->ltr_context)
 282     {
 283       g_object_unref (layout->ltr_context);
 284       layout->ltr_context = NULL;
 285     }
 286   if (layout->rtl_context)
 287     {
 288       g_object_unref (layout->rtl_context);
 289       layout->rtl_context = NULL;
 290     }
 291
 292   if (layout->one_display_cache)
 293     {
 294       GtkTextLineDisplay *tmp_display = layout->one_display_cache;
 295       layout->one_display_cache = NULL;
 296       gtk_text_layout_free_line_display (layout, tmp_display);
 297     }
 298
 299   (* G_OBJECT_CLASS (parent_class)->finalize) (object);
 300 }
 301
 302 void
 303 gtk_text_layout_set_buffer (GtkTextLayout *layout,
 304                             GtkTextBuffer *buffer)
 305 {
 306   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 307   g_return_if_fail (buffer == NULL || GTK_IS_TEXT_BUFFER (buffer));
 308
 309   if (layout->buffer == buffer)
 310     return;
 311
 312   free_style_cache (layout);
 313
 314   if (layout->buffer)
 315     {
 316       _gtk_text_btree_remove_view (_gtk_text_buffer_get_btree (layout->buffer),
 317                                   layout);
 318
 319       g_signal_handlers_disconnect_by_func (layout->buffer,
 320                                             G_CALLBACK (gtk_text_layout_mark_set_handler),
 321                                             layout);
 322       g_signal_handlers_disconnect_by_func (layout->buffer,
 323                                             G_CALLBACK (gtk_text_layout_buffer_insert_text),
 324                                             layout);
 325       g_signal_handlers_disconnect_by_func (layout->buffer,
 326                                             G_CALLBACK (gtk_text_layout_buffer_delete_range),
 327                                             layout);
 328
 329       g_object_unref (layout->buffer);
 330       layout->buffer = NULL;
 331     }
 332
 333   if (buffer)
 334     {
 335       layout->buffer = buffer;
 336
 337       g_object_ref (buffer);
 338
 339       _gtk_text_btree_add_view (_gtk_text_buffer_get_btree (buffer), layout);
 340
 341       /* Bind to all signals that move the insert mark. */
 342       g_signal_connect_after (layout->buffer, "mark_set",
 343                               G_CALLBACK (gtk_text_layout_mark_set_handler), layout);
 344       g_signal_connect_after (layout->buffer, "insert_text",
 345                               G_CALLBACK (gtk_text_layout_buffer_insert_text), layout);
 346       g_signal_connect_after (layout->buffer, "delete_range",
 347                               G_CALLBACK (gtk_text_layout_buffer_delete_range), layout);
 348
 349       gtk_text_layout_update_cursor_line (layout);
 350     }
 351 }
 352
 353 void
 354 gtk_text_layout_default_style_changed (GtkTextLayout *layout)
 355 {
 356   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 357
 358   DV (g_print ("invalidating all due to default style change (%s)\n", G_STRLOC));
 359   gtk_text_layout_invalidate_all (layout);
 360 }
 361
 362 void
 363 gtk_text_layout_set_default_style (GtkTextLayout *layout,
 364                                    GtkTextAttributes *values)
 365 {
 366   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 367   g_return_if_fail (values != NULL);
 368
 369   if (values == layout->default_style)
 370     return;
 371
 372   gtk_text_attributes_ref (values);
 373
 374   if (layout->default_style)
 375     gtk_text_attributes_unref (layout->default_style);
 376
 377   layout->default_style = values;
 378
 379   gtk_text_layout_default_style_changed (layout);
 380 }
 381
 382 void
 383 gtk_text_layout_set_contexts (GtkTextLayout *layout,
 384                               PangoContext  *ltr_context,
 385                               PangoContext  *rtl_context)
 386 {
 387   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 388
 389   if (layout->ltr_context)
 390     g_object_unref (ltr_context);
 391
 392   layout->ltr_context = ltr_context;
 393   g_object_ref (ltr_context);
 394
 395   if (layout->rtl_context)
 396     g_object_unref (rtl_context);
 397
 398   layout->rtl_context = rtl_context;
 399   g_object_ref (rtl_context);
 400
 401   DV (g_print ("invalidating all due to new pango contexts (%s)\n", G_STRLOC));
 402   gtk_text_layout_invalidate_all (layout);
 403 }
 404
 405 /**
 406  * gtk_text_layout_set_cursor_direction:
 407  * @direction: the new direction(s) for which to draw cursors.
 408  *             %GTK_TEXT_DIR_NONE means draw cursors for both
 409  *             left-to-right insertion and right-to-left insertion.
 410  *             (The two cursors will be visually distinguished.)
 411  *
 412  * Sets which text directions (left-to-right and/or right-to-left) for
 413  * which cursors will be drawn for the insertion point. The visual
 414  * point at which new text is inserted depends on whether the new
 415  * text is right-to-left or left-to-right, so it may be desired to
 416  * make the drawn position of the cursor depend on the keyboard state.
 417  **/
 418 void
 419 gtk_text_layout_set_cursor_direction (GtkTextLayout   *layout,
 420                                       GtkTextDirection direction)
 421 {
 422   if (direction != layout->cursor_direction)
 423     {
 424       layout->cursor_direction = direction;
 425       gtk_text_layout_invalidate_cursor_line (layout);
 426     }
 427 }
 428
 429 /**
 430  * gtk_text_layout_set_keyboard_direction:
 431  * @keyboard_dir: the current direction of the keyboard.
 432  *
 433  * Sets the keyboard direction; this is used as for the bidirectional
 434  * base direction for the line with the cursor if the line contains
 435  * only neutral characters.
 436  **/
 437 void
 438 gtk_text_layout_set_keyboard_direction (GtkTextLayout   *layout,
 439                                         GtkTextDirection keyboard_dir)
 440 {
 441   if (keyboard_dir != layout->keyboard_direction)
 442     {
 443       layout->keyboard_direction = keyboard_dir;
 444       gtk_text_layout_invalidate_cursor_line (layout);
 445     }
 446 }
 447
 448 /**
 449  * gtk_text_layout_get_buffer:
 450  * @layout: a #GtkTextLayout
 451  *
 452  * Gets the text buffer used by the layout. See
 453  * gtk_text_layout_set_buffer().
 454  *
 455  * Return value: the text buffer used by the layout.
 456  **/
 457 GtkTextBuffer *
 458 gtk_text_layout_get_buffer (GtkTextLayout *layout)
 459 {
 460   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), NULL);
 461
 462   return layout->buffer;
 463 }
 464
 465 void
 466 gtk_text_layout_set_screen_width (GtkTextLayout *layout, gint width)
 467 {
 468   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 469   g_return_if_fail (width >= 0);
 470   g_return_if_fail (layout->wrap_loop_count == 0);
 471
 472   if (layout->screen_width == width)
 473     return;
 474
 475   layout->screen_width = width;
 476
 477   DV (g_print ("invalidating all due to new screen width (%s)\n", G_STRLOC));
 478   gtk_text_layout_invalidate_all (layout);
 479 }
 480
 481 /**
 482  * gtk_text_layout_set_cursor_visible:
 483  * @layout: a #GtkTextLayout
 484  * @cursor_visible: If %FALSE, then the insertion cursor will not
 485  *   be shown, even if the text is editable.
 486  *
 487  * Sets whether the insertion cursor should be shown. Generally,
 488  * widgets using #GtkTextLayout will hide the cursor when the
 489  * widget does not have the input focus.
 490  **/
 491 void
 492 gtk_text_layout_set_cursor_visible (GtkTextLayout *layout,
 493                                     gboolean       cursor_visible)
 494 {
 495   cursor_visible = (cursor_visible != FALSE);
 496
 497   if (layout->cursor_visible != cursor_visible)
 498     {
 499       GtkTextIter iter;
 500       gint y, height;
 501
 502       layout->cursor_visible = cursor_visible;
 503
 504       /* Now queue a redraw on the paragraph containing the cursor
 505        */
 506       gtk_text_buffer_get_iter_at_mark (layout->buffer, &iter,
 507                                         gtk_text_buffer_get_mark (layout->buffer, "insert"));
 508
 509       gtk_text_layout_get_line_yrange (layout, &iter, &y, &height);
 510       gtk_text_layout_emit_changed (layout, y, height, height);
 511
 512       gtk_text_layout_invalidate_cache (layout, _gtk_text_iter_get_text_line (&iter));
 513     }
 514 }
 515
 516 /**
 517  * gtk_text_layout_get_cursor_visible:
 518  * @layout: a #GtkTextLayout
 519  *
 520  * Returns whether the insertion cursor will be shown.
 521  *
 522  * Return value: if %FALSE, the insertion cursor will not be
 523     shown, even if the text is editable.
 524  **/
 525 gboolean
 526 gtk_text_layout_get_cursor_visible (GtkTextLayout *layout)
 527 {
 528   return layout->cursor_visible;
 529 }
 530
 531 /**
 532  * gtk_text_layout_set_preedit_string:
 533  * @layout: a #PangoLayout
 534  * @preedit_string: a string to display at the insertion point
 535  * @preedit_attrs: a #PangoAttrList of attributes that apply to @preedit_string
 536  * @cursor_pos: position of cursor within preedit string in chars
 537  *
 538  * Set the preedit string and attributes. The preedit string is a
 539  * string showing text that is currently being edited and not
 540  * yet committed into the buffer.
 541  **/
 542 void
 543 gtk_text_layout_set_preedit_string (GtkTextLayout *layout,
 544                                     const gchar   *preedit_string,
 545                                     PangoAttrList *preedit_attrs,
 546                                     gint           cursor_pos)
 547 {
 548   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 549   g_return_if_fail (preedit_attrs != NULL || preedit_string == NULL);
 550
 551   if (layout->preedit_string)
 552     g_free (layout->preedit_string);
 553
 554   if (layout->preedit_attrs)
 555     pango_attr_list_unref (layout->preedit_attrs);
 556
 557   if (preedit_string)
 558     {
 559       layout->preedit_string = g_strdup (preedit_string);
 560       layout->preedit_len = strlen (layout->preedit_string);
 561       pango_attr_list_ref (preedit_attrs);
 562       layout->preedit_attrs = preedit_attrs;
 563
 564       cursor_pos = CLAMP (cursor_pos, 0, g_utf8_strlen (layout->preedit_string, -1));
 565       layout->preedit_cursor = g_utf8_offset_to_pointer (layout->preedit_string, cursor_pos) - layout->preedit_string;
 566     }
 567   else
 568     {
 569       layout->preedit_string = NULL;
 570       layout->preedit_len = 0;
 571       layout->preedit_attrs = NULL;
 572       layout->preedit_cursor = 0;
 573     }
 574
 575   gtk_text_layout_invalidate_cursor_line (layout);
 576 }
 577
 578 void
 579 gtk_text_layout_get_size (GtkTextLayout *layout,
 580                           gint *width,
 581                           gint *height)
 582 {
 583   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 584
 585   if (width)
 586     *width = layout->width;
 587
 588   if (height)
 589     *height = layout->height;
 590 }
 591
 592 static void
 593 gtk_text_layout_invalidated (GtkTextLayout *layout)
 594 {
 595   g_signal_emit (layout, signals[INVALIDATED], 0);
 596 }
 597
 598 static void
 599 gtk_text_layout_emit_changed (GtkTextLayout *layout,
 600                               gint           y,
 601                               gint           old_height,
 602                               gint           new_height)
 603 {
 604   g_signal_emit (layout, signals[CHANGED], 0, y, old_height, new_height);
 605 }
 606
 607 void
 608 gtk_text_layout_changed (GtkTextLayout *layout,
 609                          gint           y,
 610                          gint           old_height,
 611                          gint           new_height)
 612 {
 613   /* Check if the range intersects our cached line display,
 614    * and invalidate the cached line if so.
 615    */
 616   if (layout->one_display_cache)
 617     {
 618       GtkTextLine *line = layout->one_display_cache->line;
 619       gint cache_y = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
 620                                                     line, layout);
 621       gint cache_height = layout->one_display_cache->height;
 622
 623       if (cache_y + cache_height > y && cache_y < y + old_height)
 624         gtk_text_layout_invalidate_cache (layout, line);
 625     }
 626
 627   gtk_text_layout_emit_changed (layout, y, old_height, new_height);
 628 }
 629
 630 void
 631 gtk_text_layout_free_line_data (GtkTextLayout     *layout,
 632                                 GtkTextLine       *line,
 633                                 GtkTextLineData   *line_data)
 634 {
 635   (* GTK_TEXT_LAYOUT_GET_CLASS (layout)->free_line_data)
 636     (layout, line, line_data);
 637 }
 638
 639 void
 640 gtk_text_layout_invalidate (GtkTextLayout *layout,
 641                             const GtkTextIter *start_index,
 642                             const GtkTextIter *end_index)
 643 {
 644   (* GTK_TEXT_LAYOUT_GET_CLASS (layout)->invalidate)
 645     (layout, start_index, end_index);
 646 }
 647
 648 GtkTextLineData*
 649 gtk_text_layout_wrap (GtkTextLayout *layout,
 650                       GtkTextLine  *line,
 651                       /* may be NULL */
 652                       GtkTextLineData *line_data)
 653 {
 654   return (* GTK_TEXT_LAYOUT_GET_CLASS (layout)->wrap) (layout, line, line_data);
 655 }
 656
 657 GSList*
 658 gtk_text_layout_get_lines (GtkTextLayout *layout,
 659                            /* [top_y, bottom_y) */
 660                            gint top_y,
 661                            gint bottom_y,
 662                            gint *first_line_y)
 663 {
 664   GtkTextLine *first_btree_line;
 665   GtkTextLine *last_btree_line;
 666   GtkTextLine *line;
 667   GSList *retval;
 668
 669   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), NULL);
 670   g_return_val_if_fail (bottom_y > top_y, NULL);
 671
 672   retval = NULL;
 673
 674   first_btree_line =
 675     _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
 676                                    layout, top_y, first_line_y);
 677   if (first_btree_line == NULL)
 678     {
 679       /* off the bottom */
 680       return NULL;
 681     }
 682
 683   /* -1 since bottom_y is one past */
 684   last_btree_line =
 685     _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
 686                                     layout, bottom_y - 1, NULL);
 687
 688   if (!last_btree_line)
 689     last_btree_line =
 690       _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
 691
 692   g_assert (last_btree_line != NULL);
 693
 694   line = first_btree_line;
 695   while (TRUE)
 696     {
 697       retval = g_slist_prepend (retval, line);
 698
 699       if (line == last_btree_line)
 700         break;
 701
 702       line = _gtk_text_line_next_excluding_last (line);
 703     }
 704
 705   retval = g_slist_reverse (retval);
 706
 707   return retval;
 708 }
 709
 710 static void
 711 invalidate_cached_style (GtkTextLayout *layout)
 712 {
 713   free_style_cache (layout);
 714 }
 715
 716 /* These should be called around a loop which wraps a CONTIGUOUS bunch
 717  * of display lines. If the lines aren't contiguous you can't call
 718  * these.
 719  */
 720 void
 721 gtk_text_layout_wrap_loop_start (GtkTextLayout *layout)
 722 {
 723   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 724   g_return_if_fail (layout->one_style_cache == NULL);
 725
 726   layout->wrap_loop_count += 1;
 727 }
 728
 729 void
 730 gtk_text_layout_wrap_loop_end (GtkTextLayout *layout)
 731 {
 732   g_return_if_fail (layout->wrap_loop_count > 0);
 733
 734   layout->wrap_loop_count -= 1;
 735
 736   if (layout->wrap_loop_count == 0)
 737     {
 738       /* We cache a some stuff if we're iterating over some lines wrapping
 739        * them. This cleans it up.
 740        */
 741       /* Nuke our cached style */
 742       invalidate_cached_style (layout);
 743       g_assert (layout->one_style_cache == NULL);
 744     }
 745 }
 746
 747 static void
 748 gtk_text_layout_invalidate_all (GtkTextLayout *layout)
 749 {
 750   GtkTextIter start;
 751   GtkTextIter end;
 752
 753   if (layout->buffer == NULL)
 754     return;
 755
 756   gtk_text_buffer_get_bounds (layout->buffer, &start, &end);
 757
 758   gtk_text_layout_invalidate (layout, &start, &end);
 759 }
 760
 761 static void
 762 gtk_text_layout_invalidate_cache (GtkTextLayout *layout,
 763                                   GtkTextLine   *line)
 764 {
 765   if (layout->one_display_cache && line == layout->one_display_cache->line)
 766     {
 767       GtkTextLineDisplay *tmp_display = layout->one_display_cache;
 768       layout->one_display_cache = NULL;
 769       gtk_text_layout_free_line_display (layout, tmp_display);
 770     }
 771 }
 772
 773 /* Now invalidate the paragraph containing the cursor
 774  */
 775 static void
 776 gtk_text_layout_invalidate_cursor_line (GtkTextLayout *layout)
 777 {
 778   GtkTextLayoutPrivate *priv = GTK_TEXT_LAYOUT_GET_PRIVATE (layout);
 779   GtkTextLineData *line_data;
 780
 781   if (priv->cursor_line == NULL)
 782     return;
 783
 784   line_data = _gtk_text_line_get_data (priv->cursor_line, layout);
 785   if (line_data)
 786     {
 787       gtk_text_layout_invalidate_cache (layout, priv->cursor_line);
 788       _gtk_text_line_invalidate_wrap (priv->cursor_line, line_data);
 789       gtk_text_layout_invalidated (layout);
 790     }
 791 }
 792
 793 static void
 794 gtk_text_layout_update_cursor_line(GtkTextLayout *layout)
 795 {
 796   GtkTextLayoutPrivate *priv = GTK_TEXT_LAYOUT_GET_PRIVATE (layout);
 797   GtkTextIter iter;
 798
 799   gtk_text_buffer_get_iter_at_mark (layout->buffer, &iter,
 800                                     gtk_text_buffer_get_mark (layout->buffer, "insert"));
 801
 802   priv->cursor_line = _gtk_text_iter_get_text_line (&iter);
 803 }
 804
 805 static void
 806 gtk_text_layout_real_invalidate (GtkTextLayout *layout,
 807                                  const GtkTextIter *start,
 808                                  const GtkTextIter *end)
 809 {
 810   GtkTextLine *line;
 811   GtkTextLine *last_line;
 812
 813   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 814   g_return_if_fail (layout->wrap_loop_count == 0);
 815
 816   /* Because we may be invalidating a mark, it's entirely possible
 817    * that gtk_text_iter_equal (start, end) in which case we
 818    * should still invalidate the line they are both on. i.e.
 819    * we always invalidate the line with "start" even
 820    * if there's an empty range.
 821    */
 822
 823 #if 0
 824   gtk_text_view_index_spew (start_index, "invalidate start");
 825   gtk_text_view_index_spew (end_index, "invalidate end");
 826 #endif
 827
 828   last_line = _gtk_text_iter_get_text_line (end);
 829   line = _gtk_text_iter_get_text_line (start);
 830
 831   while (TRUE)
 832     {
 833       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
 834
 835       gtk_text_layout_invalidate_cache (layout, line);
 836
 837       if (line_data)
 838         _gtk_text_line_invalidate_wrap (line, line_data);
 839
 840       if (line == last_line)
 841         break;
 842
 843       line = _gtk_text_line_next_excluding_last (line);
 844     }
 845
 846   gtk_text_layout_invalidated (layout);
 847 }
 848
 849 static void
 850 gtk_text_layout_real_free_line_data (GtkTextLayout     *layout,
 851                                      GtkTextLine       *line,
 852                                      GtkTextLineData   *line_data)
 853 {
 854   gtk_text_layout_invalidate_cache (layout, line);
 855
 856   g_free (line_data);
 857 }
 858
 859
 860
 861 /**
 862  * gtk_text_layout_is_valid:
 863  * @layout: a #GtkTextLayout
 864  *
 865  * Check if there are any invalid regions in a #GtkTextLayout's buffer
 866  *
 867  * Return value: %TRUE if any invalid regions were found
 868  **/
 869 gboolean
 870 gtk_text_layout_is_valid (GtkTextLayout *layout)
 871 {
 872   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
 873
 874   return _gtk_text_btree_is_valid (_gtk_text_buffer_get_btree (layout->buffer),
 875                                   layout);
 876 }
 877
 878 static void
 879 update_layout_size (GtkTextLayout *layout)
 880 {
 881   _gtk_text_btree_get_view_size (_gtk_text_buffer_get_btree (layout->buffer),
 882                                 layout,
 883                                 &layout->width, &layout->height);
 884 }
 885
 886 /**
 887  * gtk_text_layout_validate_yrange:
 888  * @layout: a #GtkTextLayout
 889  * @anchor: iter pointing into a line that will be used as the
 890  *          coordinate origin
 891  * @y0_: offset from the top of the line pointed to by @anchor at
 892  *       which to begin validation. (The offset here is in pixels
 893  *       after validation.)
 894  * @y1_: offset from the top of the line pointed to by @anchor at
 895  *       which to end validation. (The offset here is in pixels
 896  *       after validation.)
 897  *
 898  * Ensure that a region of a #GtkTextLayout is valid. The ::changed
 899  * signal will be emitted if any lines are validated.
 900  **/
 901 void
 902 gtk_text_layout_validate_yrange (GtkTextLayout *layout,
 903                                  GtkTextIter   *anchor,
 904                                  gint           y0,
 905                                  gint           y1)
 906 {
 907   GtkTextLine *line;
 908   GtkTextLine *first_line = NULL;
 909   GtkTextLine *last_line = NULL;
 910   gint seen;
 911   gint delta_height = 0;
 912   gint first_line_y = 0;        /* Quiet GCC */
 913   gint last_line_y = 0;         /* Quiet GCC */
 914
 915   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
 916
 917   if (y0 > 0)
 918     y0 = 0;
 919   if (y1 < 0)
 920     y1 = 0;
 921
 922   /* Validate backwards from the anchor line to y0
 923    */
 924   line = _gtk_text_iter_get_text_line (anchor);
 925   line = _gtk_text_line_previous (line);
 926   seen = 0;
 927   while (line && seen < -y0)
 928     {
 929       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
 930       if (!line_data || !line_data->valid)
 931         {
 932           gint old_height = line_data ? line_data->height : 0;
 933
 934           _gtk_text_btree_validate_line (_gtk_text_buffer_get_btree (layout->buffer),
 935                                          line, layout);
 936           line_data = _gtk_text_line_get_data (line, layout);
 937
 938           delta_height += line_data->height - old_height;
 939
 940           first_line = line;
 941           first_line_y = -seen - line_data->height;
 942           if (!last_line)
 943             {
 944               last_line = line;
 945               last_line_y = -seen;
 946             }
 947         }
 948
 949       seen += line_data->height;
 950       line = _gtk_text_line_previous (line);
 951     }
 952
 953   /* Validate forwards to y1 */
 954   line = _gtk_text_iter_get_text_line (anchor);
 955   seen = 0;
 956   while (line && seen < y1)
 957     {
 958       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
 959       if (!line_data || !line_data->valid)
 960         {
 961           gint old_height = line_data ? line_data->height : 0;
 962
 963           _gtk_text_btree_validate_line (_gtk_text_buffer_get_btree (layout->buffer),
 964                                          line, layout);
 965           line_data = _gtk_text_line_get_data (line, layout);
 966
 967           delta_height += line_data->height - old_height;
 968
 969           if (!first_line)
 970             {
 971               first_line = line;
 972               first_line_y = seen;
 973             }
 974           last_line = line;
 975           last_line_y = seen + line_data->height;
 976         }
 977
 978       seen += line_data->height;
 979       line = _gtk_text_line_next_excluding_last (line);
 980     }
 981
 982   /* If we found and validated any invalid lines, update size and
 983    * emit the changed signal
 984    */
 985   if (first_line)
 986     {
 987       gint line_top;
 988
 989       update_layout_size (layout);
 990
 991       line_top = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
 992                                                 first_line, layout);
 993
 994       gtk_text_layout_emit_changed (layout,
 995                                     line_top,
 996                                     last_line_y - first_line_y - delta_height,
 997                                     last_line_y - first_line_y);
 998     }
 999 }
1000
1001 /**
1002  * gtk_text_layout_validate:
1003  * @tree: a #GtkTextLayout
1004  * @max_pixels: the maximum number of pixels to validate. (No more
1005  *              than one paragraph beyond this limit will be validated)
1006  *
1007  * Validate regions of a #GtkTextLayout. The ::changed signal will
1008  * be emitted for each region validated.
1009  **/
1010 void
1011 gtk_text_layout_validate (GtkTextLayout *layout,
1012                           gint           max_pixels)
1013 {
1014   gint y, old_height, new_height;
1015
1016   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
1017
1018   while (max_pixels > 0 &&
1019          _gtk_text_btree_validate (_gtk_text_buffer_get_btree (layout->buffer),
1020                                    layout,  max_pixels,
1021                                    &y, &old_height, &new_height))
1022     {
1023       max_pixels -= new_height;
1024
1025       update_layout_size (layout);
1026       gtk_text_layout_emit_changed (layout, y, old_height, new_height);
1027     }
1028 }
1029
1030 static GtkTextLineData*
1031 gtk_text_layout_real_wrap (GtkTextLayout   *layout,
1032                            GtkTextLine     *line,
1033                            /* may be NULL */
1034                            GtkTextLineData *line_data)
1035 {
1036   GtkTextLineDisplay *display;
1037
1038   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), NULL);
1039   g_return_val_if_fail (line != NULL, NULL);
1040
1041   if (line_data == NULL)
1042     {
1043       line_data = _gtk_text_line_data_new (layout, line);
1044       _gtk_text_line_add_data (line, line_data);
1045     }
1046
1047   display = gtk_text_layout_get_line_display (layout, line, TRUE);
1048   line_data->width = display->width;
1049   line_data->height = display->height;
1050   line_data->valid = TRUE;
1051   gtk_text_layout_free_line_display (layout, display);
1052
1053   return line_data;
1054 }
1055
1056 /*
1057  * Layout utility functions
1058  */
1059
1060 /* If you get the style with get_style () you need to call
1061    release_style () to free it. */
1062 static GtkTextAttributes*
1063 get_style (GtkTextLayout *layout,
1064            const GtkTextIter *iter)
1065 {
1066   GtkTextTag** tags;
1067   gint tag_count = 0;
1068   GtkTextAttributes *style;
1069
1070   /* If we have the one-style cache, then it means
1071      that we haven't seen a toggle since we filled in the
1072      one-style cache.
1073   */
1074   if (layout->one_style_cache != NULL)
1075     {
1076       gtk_text_attributes_ref (layout->one_style_cache);
1077       return layout->one_style_cache;
1078     }
1079
1080   g_assert (layout->one_style_cache == NULL);
1081
1082   /* Get the tags at this spot */
1083   tags = _gtk_text_btree_get_tags (iter, &tag_count);
1084
1085   /* No tags, use default style */
1086   if (tags == NULL || tag_count == 0)
1087     {
1088       /* One ref for the return value, one ref for the
1089          layout->one_style_cache reference */
1090       gtk_text_attributes_ref (layout->default_style);
1091       gtk_text_attributes_ref (layout->default_style);
1092       layout->one_style_cache = layout->default_style;
1093
1094       if (tags)
1095         g_free (tags);
1096
1097       return layout->default_style;
1098     }
1099
1100   /* Sort tags in ascending order of priority */
1101   _gtk_text_tag_array_sort (tags, tag_count);
1102
1103   style = gtk_text_attributes_new ();
1104
1105   gtk_text_attributes_copy_values (layout->default_style,
1106                                    style);
1107
1108   _gtk_text_attributes_fill_from_tags (style,
1109                                        tags,
1110                                        tag_count);
1111
1112   g_free (tags);
1113
1114   g_assert (style->refcount == 1);
1115
1116   /* Leave this style as the last one seen */
1117   g_assert (layout->one_style_cache == NULL);
1118   gtk_text_attributes_ref (style); /* ref held by layout->one_style_cache */
1119   layout->one_style_cache = style;
1120
1121   /* Returning yet another refcount */
1122   return style;
1123 }
1124
1125 static void
1126 release_style (GtkTextLayout *layout,
1127                GtkTextAttributes *style)
1128 {
1129   g_return_if_fail (style != NULL);
1130   g_return_if_fail (style->refcount > 0);
1131
1132   gtk_text_attributes_unref (style);
1133 }
1134
1135 /*
1136  * Lines
1137  */
1138
1139 /* This function tries to optimize the case where a line
1140    is completely invisible */
1141 static gboolean
1142 totally_invisible_line (GtkTextLayout *layout,
1143                         GtkTextLine   *line,
1144                         GtkTextIter   *iter)
1145 {
1146   GtkTextLineSegment *seg;
1147   int bytes = 0;
1148
1149   /* Check if the first char is visible, if so we are partially visible.
1150    * Note that we have to check this since we don't know the current
1151    * invisible/noninvisible toggle state; this function can use the whole btree
1152    * to get it right.
1153    */
1154   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
1155                                     iter, line, 0);
1156
1157   if (!_gtk_text_btree_char_is_invisible (iter))
1158     return FALSE;
1159
1160   bytes = 0;
1161   seg = line->segments;
1162
1163   while (seg != NULL)
1164     {
1165       if (seg->byte_count > 0)
1166         bytes += seg->byte_count;
1167
1168       /* Note that these two tests can cause us to bail out
1169        * when we shouldn't, because a higher-priority tag
1170        * may override these settings. However the important
1171        * thing is to only invisible really-invisible lines, rather
1172        * than to invisible all really-invisible lines.
1173        */
1174
1175       else if (seg->type == &gtk_text_toggle_on_type)
1176         {
1177           invalidate_cached_style (layout);
1178
1179           /* Bail out if an elision-unsetting tag begins */
1180           if (seg->body.toggle.info->tag->invisible_set &&
1181               !seg->body.toggle.info->tag->values->invisible)
1182             break;
1183         }
1184       else if (seg->type == &gtk_text_toggle_off_type)
1185         {
1186           invalidate_cached_style (layout);
1187
1188           /* Bail out if an elision-setting tag ends */
1189           if (seg->body.toggle.info->tag->invisible_set &&
1190               seg->body.toggle.info->tag->values->invisible)
1191             break;
1192         }
1193
1194       seg = seg->next;
1195     }
1196
1197   if (seg != NULL)       /* didn't reach line end */
1198     return FALSE;
1199
1200   return TRUE;
1201 }
1202
1203 static void
1204 set_para_values (GtkTextLayout      *layout,
1205                  PangoDirection      base_dir,
1206                  GtkTextAttributes  *style,
1207                  GtkTextLineDisplay *display)
1208 {
1209   PangoAlignment pango_align = PANGO_ALIGN_LEFT;
1210   int layout_width;
1211
1212   switch (base_dir)
1213     {
1214     /* If no base direction was found, then use the style direction */
1215     case PANGO_DIRECTION_NEUTRAL :
1216       display->direction = style->direction;
1217
1218       /* Override the base direction */
1219       if (display->direction == GTK_TEXT_DIR_RTL)
1220         base_dir = PANGO_DIRECTION_RTL;
1221       else
1222         base_dir = PANGO_DIRECTION_LTR;
1223
1224       break;
1225     case PANGO_DIRECTION_RTL :
1226       display->direction = GTK_TEXT_DIR_RTL;
1227       break;
1228     default:
1229       display->direction = GTK_TEXT_DIR_LTR;
1230       break;
1231     }
1232
1233   if (display->direction == GTK_TEXT_DIR_RTL)
1234     display->layout = pango_layout_new (layout->rtl_context);
1235   else
1236     display->layout = pango_layout_new (layout->ltr_context);
1237
1238   switch (style->justification)
1239     {
1240     case GTK_JUSTIFY_LEFT:
1241       pango_align = (base_dir == PANGO_DIRECTION_LTR) ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
1242       break;
1243     case GTK_JUSTIFY_RIGHT:
1244       pango_align = (base_dir == PANGO_DIRECTION_LTR) ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
1245       break;
1246     case GTK_JUSTIFY_CENTER:
1247       pango_align = PANGO_ALIGN_CENTER;
1248       break;
1249     case GTK_JUSTIFY_FILL:
1250       g_warning ("FIXME we don't support GTK_JUSTIFY_FILL yet");
1251       break;
1252     default:
1253       g_assert_not_reached ();
1254       break;
1255     }
1256
1257   pango_layout_set_alignment (display->layout, pango_align);
1258   pango_layout_set_spacing (display->layout,
1259                             style->pixels_inside_wrap * PANGO_SCALE);
1260
1261   if (style->tabs)
1262     pango_layout_set_tabs (display->layout, style->tabs);
1263
1264   display->top_margin = style->pixels_above_lines;
1265   display->height = style->pixels_above_lines + style->pixels_below_lines;
1266   display->bottom_margin = style->pixels_below_lines;
1267   display->left_margin = style->left_margin;
1268   display->right_margin = style->right_margin;
1269
1270   display->x_offset = display->left_margin;
1271
1272   pango_layout_set_indent (display->layout,
1273                            style->indent * PANGO_SCALE);
1274
1275   switch (style->wrap_mode)
1276     {
1277     case GTK_WRAP_CHAR:
1278       layout_width = layout->screen_width - display->left_margin - display->right_margin;
1279       pango_layout_set_width (display->layout, layout_width * PANGO_SCALE);
1280       pango_layout_set_wrap (display->layout, PANGO_WRAP_CHAR);
1281       break;
1282
1283     case GTK_WRAP_WORD:
1284       layout_width = layout->screen_width - display->left_margin - display->right_margin;
1285       pango_layout_set_width (display->layout, layout_width * PANGO_SCALE);
1286       pango_layout_set_wrap (display->layout, PANGO_WRAP_WORD);
1287       break;
1288
1289     case GTK_WRAP_WORD_CHAR:
1290       layout_width = layout->screen_width - display->left_margin - display->right_margin;
1291       pango_layout_set_width (display->layout, layout_width * PANGO_SCALE);
1292       pango_layout_set_wrap (display->layout, PANGO_WRAP_WORD_CHAR);
1293       break;
1294
1295     case GTK_WRAP_NONE:
1296       break;
1297     }
1298
1299   display->total_width = MAX (layout->screen_width, layout->width) - display->left_margin - display->right_margin;
1300 }
1301
1302 static PangoAttribute *
1303 gtk_text_attr_appearance_copy (const PangoAttribute *attr)
1304 {
1305   const GtkTextAttrAppearance *appearance_attr = (const GtkTextAttrAppearance *)attr;
1306
1307   return gtk_text_attr_appearance_new (&appearance_attr->appearance);
1308 }
1309
1310 static void
1311 gtk_text_attr_appearance_destroy (PangoAttribute *attr)
1312 {
1313   GtkTextAppearance *appearance = &((GtkTextAttrAppearance *)attr)->appearance;
1314
1315   if (appearance->bg_stipple)
1316     g_object_unref (appearance->bg_stipple);
1317   if (appearance->fg_stipple)
1318     g_object_unref (appearance->fg_stipple);
1319
1320   g_free (attr);
1321 }
1322
1323 static gboolean
1324 gtk_text_attr_appearance_compare (const PangoAttribute *attr1,
1325                                   const PangoAttribute *attr2)
1326 {
1327   const GtkTextAppearance *appearance1 = &((const GtkTextAttrAppearance *)attr1)->appearance;
1328   const GtkTextAppearance *appearance2 = &((const GtkTextAttrAppearance *)attr2)->appearance;
1329
1330   return (gdk_color_equal (&appearance1->fg_color, &appearance2->fg_color) &&
1331           gdk_color_equal (&appearance1->bg_color, &appearance2->bg_color) &&
1332           appearance1->fg_stipple ==  appearance2->fg_stipple &&
1333           appearance1->bg_stipple ==  appearance2->bg_stipple &&
1334           appearance1->underline == appearance2->underline &&
1335           appearance1->strikethrough == appearance2->strikethrough &&
1336           appearance1->draw_bg == appearance2->draw_bg);
1337
1338 }
1339
1340 /**
1341  * gtk_text_attr_appearance_new:
1342  * @desc:
1343  *
1344  * Create a new font description attribute. (This attribute
1345  * allows setting family, style, weight, variant, stretch,
1346  * and size simultaneously.)
1347  *
1348  * Return value:
1349  **/
1350 static PangoAttribute *
1351 gtk_text_attr_appearance_new (const GtkTextAppearance *appearance)
1352 {
1353   static PangoAttrClass klass = {
1354     0,
1355     gtk_text_attr_appearance_copy,
1356     gtk_text_attr_appearance_destroy,
1357     gtk_text_attr_appearance_compare
1358   };
1359
1360   GtkTextAttrAppearance *result;
1361
1362   if (!klass.type)
1363     klass.type = gtk_text_attr_appearance_type =
1364       pango_attr_type_register ("GtkTextAttrAppearance");
1365
1366   result = g_new (GtkTextAttrAppearance, 1);
1367   result->attr.klass = &klass;
1368
1369   result->appearance = *appearance;
1370
1371   if (appearance->bg_stipple)
1372     g_object_ref (appearance->bg_stipple);
1373   if (appearance->fg_stipple)
1374     g_object_ref (appearance->fg_stipple);
1375
1376   return (PangoAttribute *)result;
1377 }
1378
1379
1380 static void
1381 add_generic_attrs (GtkTextLayout      *layout,
1382                    GtkTextAppearance  *appearance,
1383                    gint                byte_count,
1384                    PangoAttrList      *attrs,
1385                    gint                start,
1386                    gboolean            size_only,
1387                    gboolean            is_text)
1388 {
1389   PangoAttribute *attr;
1390
1391   if (appearance->underline != PANGO_UNDERLINE_NONE)
1392     {
1393       attr = pango_attr_underline_new (appearance->underline);
1394
1395       attr->start_index = start;
1396       attr->end_index = start + byte_count;
1397
1398       pango_attr_list_insert (attrs, attr);
1399     }
1400
1401   if (appearance->strikethrough)
1402     {
1403       attr = pango_attr_strikethrough_new (appearance->strikethrough);
1404
1405       attr->start_index = start;
1406       attr->end_index = start + byte_count;
1407
1408       pango_attr_list_insert (attrs, attr);
1409     }
1410
1411   if (appearance->rise != 0)
1412     {
1413       attr = pango_attr_rise_new (appearance->rise);
1414
1415       attr->start_index = start;
1416       attr->end_index = start + byte_count;
1417
1418       pango_attr_list_insert (attrs, attr);
1419     }
1420
1421   if (!size_only)
1422     {
1423       attr = gtk_text_attr_appearance_new (appearance);
1424
1425       attr->start_index = start;
1426       attr->end_index = start + byte_count;
1427
1428       ((GtkTextAttrAppearance *)attr)->appearance.is_text = is_text;
1429
1430       pango_attr_list_insert (attrs, attr);
1431     }
1432 }
1433
1434 static void
1435 add_text_attrs (GtkTextLayout      *layout,
1436                 GtkTextAttributes  *style,
1437                 gint                byte_count,
1438                 PangoAttrList      *attrs,
1439                 gint                start,
1440                 gboolean            size_only)
1441 {
1442   PangoAttribute *attr;
1443
1444   attr = pango_attr_font_desc_new (style->font);
1445   attr->start_index = start;
1446   attr->end_index = start + byte_count;
1447
1448   pango_attr_list_insert (attrs, attr);
1449
1450   if (style->font_scale != 1.0)
1451     {
1452       attr = pango_attr_scale_new (style->font_scale);
1453
1454       attr->start_index = start;
1455       attr->end_index = start + byte_count;
1456
1457       pango_attr_list_insert (attrs, attr);
1458     }
1459 }
1460
1461 static void
1462 add_pixbuf_attrs (GtkTextLayout      *layout,
1463                   GtkTextLineDisplay *display,
1464                   GtkTextAttributes  *style,
1465                   GtkTextLineSegment *seg,
1466                   PangoAttrList      *attrs,
1467                   gint                start)
1468 {
1469   PangoAttribute *attr;
1470   PangoRectangle logical_rect;
1471   GtkTextPixbuf *pixbuf = &seg->body.pixbuf;
1472   gint width, height;
1473
1474   width = gdk_pixbuf_get_width (pixbuf->pixbuf);
1475   height = gdk_pixbuf_get_height (pixbuf->pixbuf);
1476
1477   logical_rect.x = 0;
1478   logical_rect.y = -height * PANGO_SCALE;
1479   logical_rect.width = width * PANGO_SCALE;
1480   logical_rect.height = height * PANGO_SCALE;
1481
1482   attr = pango_attr_shape_new_with_data (&logical_rect, &logical_rect,
1483                                          pixbuf->pixbuf, NULL, NULL);
1484   attr->start_index = start;
1485   attr->end_index = start + seg->byte_count;
1486   pango_attr_list_insert (attrs, attr);
1487
1488   display->shaped_objects =
1489     g_slist_append (display->shaped_objects, pixbuf->pixbuf);
1490 }
1491
1492 static void
1493 add_child_attrs (GtkTextLayout      *layout,
1494                  GtkTextLineDisplay *display,
1495                  GtkTextAttributes  *style,
1496                  GtkTextLineSegment *seg,
1497                  PangoAttrList      *attrs,
1498                  gint                start)
1499 {
1500   PangoAttribute *attr;
1501   PangoRectangle logical_rect;
1502   GtkTextChildAnchor *anchor;
1503   gint width, height;
1504   GSList *tmp_list;
1505   GtkWidget *widget;
1506
1507   width = 1;
1508   height = 1;
1509
1510   anchor = seg->body.child.obj;
1511
1512   tmp_list = seg->body.child.widgets;
1513   while (tmp_list != NULL)
1514     {
1515       GtkWidget *child = tmp_list->data;
1516
1517       if (_gtk_anchored_child_get_layout (child) == layout)
1518         {
1519           /* Found it */
1520           GtkRequisition req;
1521
1522           gtk_widget_get_child_requisition (child, &req);
1523
1524           width = req.width;
1525           height = req.height;
1526
1527           widget = child;
1528
1529           break;
1530         }
1531
1532       tmp_list = g_slist_next (tmp_list);
1533     }
1534
1535   if (tmp_list == NULL)
1536     {
1537       /* If tmp_list == NULL then there is no widget at this anchor in
1538        * this display; not an error. We make up an arbitrary size
1539        * to use, just so the programmer can see the blank spot.
1540        * We also put a NULL in the shaped objects list, to keep
1541        * the correspondence between the list and the shaped chars in
1542        * the layout. A bad hack, yes.
1543        */
1544
1545       width = 30;
1546       height = 20;
1547
1548       widget = NULL;
1549     }
1550
1551   display->shaped_objects = g_slist_append (display->shaped_objects, widget);
1552
1553   logical_rect.x = 0;
1554   logical_rect.y = -height * PANGO_SCALE;
1555   logical_rect.width = width * PANGO_SCALE;
1556   logical_rect.height = height * PANGO_SCALE;
1557
1558   attr = pango_attr_shape_new_with_data (&logical_rect, &logical_rect,
1559                                          widget, NULL, NULL);
1560   attr->start_index = start;
1561   attr->end_index = start + seg->byte_count;
1562   pango_attr_list_insert (attrs, attr);
1563 }
1564
1565 static void
1566 add_cursor (GtkTextLayout      *layout,
1567             GtkTextLineDisplay *display,
1568             GtkTextLineSegment *seg,
1569             gint                start)
1570 {
1571   PangoRectangle strong_pos, weak_pos;
1572   GtkTextCursorDisplay *cursor = NULL; /* Quiet GCC */
1573   gboolean add_weak = FALSE;
1574   gboolean add_strong = FALSE;
1575
1576   /* Hide insertion cursor when we have a selection or the layout
1577    * user has hidden the cursor.
1578    */
1579   if (_gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
1580                                      seg->body.mark.obj) &&
1581       (!layout->cursor_visible ||
1582        gtk_text_buffer_get_selection_bounds (layout->buffer, NULL, NULL)))
1583     return;
1584
1585   pango_layout_get_cursor_pos (display->layout, start, &strong_pos, &weak_pos);
1586
1587   if (layout->cursor_direction == GTK_TEXT_DIR_NONE)
1588     {
1589       add_strong = TRUE;
1590       add_weak = TRUE;
1591     }
1592   else if (display->direction == layout->cursor_direction)
1593     add_strong = TRUE;
1594   else
1595     add_weak = TRUE;
1596
1597   if (add_strong)
1598     {
1599       cursor = g_new (GtkTextCursorDisplay, 1);
1600
1601       cursor->x = PANGO_PIXELS (strong_pos.x);
1602       cursor->y = PANGO_PIXELS (strong_pos.y);
1603       cursor->height = PANGO_PIXELS (strong_pos.height);
1604       cursor->is_strong = TRUE;
1605       cursor->is_weak = (layout->cursor_direction == GTK_TEXT_DIR_NONE) ? FALSE : TRUE;
1606       display->cursors = g_slist_prepend (display->cursors, cursor);
1607     }
1608
1609   if (add_weak)
1610     {
1611       if (weak_pos.x == strong_pos.x && add_strong)
1612         cursor->is_weak = TRUE;
1613       else
1614         {
1615           cursor = g_new (GtkTextCursorDisplay, 1);
1616
1617           cursor->x = PANGO_PIXELS (weak_pos.x);
1618           cursor->y = PANGO_PIXELS (weak_pos.y);
1619           cursor->height = PANGO_PIXELS (weak_pos.height);
1620           cursor->is_strong = (layout->cursor_direction == GTK_TEXT_DIR_NONE) ? FALSE : TRUE;
1621           cursor->is_weak = TRUE;
1622           display->cursors = g_slist_prepend (display->cursors, cursor);
1623         }
1624     }
1625 }
1626
1627 static gboolean
1628 is_shape (PangoLayoutRun *run)
1629 {
1630   GSList *tmp_list = run->item->analysis.extra_attrs;
1631
1632   while (tmp_list)
1633     {
1634       PangoAttribute *attr = tmp_list->data;
1635
1636       if (attr->klass->type == PANGO_ATTR_SHAPE)
1637         return TRUE;
1638
1639       tmp_list = tmp_list->next;
1640     }
1641
1642   return FALSE;
1643 }
1644
1645 static void
1646 allocate_child_widgets (GtkTextLayout      *text_layout,
1647                         GtkTextLineDisplay *display)
1648 {
1649   GSList *shaped = display->shaped_objects;
1650   PangoLayout *layout = display->layout;
1651   PangoLayoutIter *iter;
1652
1653   iter = pango_layout_get_iter (layout);
1654
1655   do
1656     {
1657       PangoLayoutRun *run = pango_layout_iter_get_run (iter);
1658
1659       if (run && is_shape (run))
1660         {
1661           GObject *shaped_object = shaped->data;
1662           shaped = shaped->next;
1663
1664           /* shaped_object is NULL for child anchors with no
1665            * widgets stored at them
1666            */
1667           if (shaped_object && GTK_IS_WIDGET (shaped_object))
1668             {
1669               PangoRectangle extents;
1670
1671               /* We emit "allocate_child" with the x,y of
1672                * the widget with respect to the top of the line
1673                * and the left side of the buffer
1674                */
1675
1676               pango_layout_iter_get_run_extents (iter,
1677                                                  NULL,
1678                                                  &extents);
1679
1680               g_signal_emit (text_layout,
1681                              signals[ALLOCATE_CHILD],
1682                              0,
1683                              shaped_object,
1684                              PANGO_PIXELS (extents.x) + display->x_offset,
1685                              PANGO_PIXELS (extents.y) + display->top_margin);
1686             }
1687         }
1688     }
1689   while (pango_layout_iter_next_run (iter));
1690
1691   pango_layout_iter_free (iter);
1692 }
1693
1694 static void
1695 convert_color (GdkColor       *result,
1696                PangoAttrColor *attr)
1697 {
1698   result->red = attr->color.red;
1699   result->blue = attr->color.blue;
1700   result->green = attr->color.green;
1701 }
1702
1703 /* This function is used to convert the preedit string attributes, which are
1704  * standard PangoAttributes, into the custom attributes used by the text
1705  * widget and insert them into a attr list with a given offset.
1706  */
1707 static void
1708 add_preedit_attrs (GtkTextLayout     *layout,
1709                    GtkTextAttributes *style,
1710                    PangoAttrList     *attrs,
1711                    gint               offset,
1712                    gboolean           size_only)
1713 {
1714   PangoAttrIterator *iter = pango_attr_list_get_iterator (layout->preedit_attrs);
1715
1716   do
1717     {
1718       GtkTextAppearance appearance = style->appearance;
1719       PangoFontDescription *font_desc = pango_font_description_copy_static (style->font);
1720       PangoAttribute *insert_attr;
1721       GSList *extra_attrs = NULL;
1722       GSList *tmp_list;
1723       PangoLanguage *language;
1724       gint start, end;
1725
1726       pango_attr_iterator_range (iter, &start, &end);
1727
1728       if (end == G_MAXINT)
1729         end = layout->preedit_len;
1730
1731       if (end == start)
1732         continue;
1733
1734       pango_attr_iterator_get_font (iter, font_desc, &language, &extra_attrs);
1735
1736       tmp_list = extra_attrs;
1737       while (tmp_list)
1738         {
1739           PangoAttribute *attr = tmp_list->data;
1740
1741           switch (attr->klass->type)
1742             {
1743             case PANGO_ATTR_FOREGROUND:
1744               convert_color (&appearance.fg_color, (PangoAttrColor *)attr);
1745               break;
1746             case PANGO_ATTR_BACKGROUND:
1747               convert_color (&appearance.bg_color, (PangoAttrColor *)attr);
1748               appearance.draw_bg = TRUE;
1749               break;
1750             case PANGO_ATTR_UNDERLINE:
1751               appearance.underline = ((PangoAttrInt *)attr)->value;
1752               break;
1753             case PANGO_ATTR_STRIKETHROUGH:
1754               appearance.strikethrough = ((PangoAttrInt *)attr)->value;
1755               break;
1756             case PANGO_ATTR_RISE:
1757               appearance.rise = ((PangoAttrInt *)attr)->value;
1758               break;
1759             default:
1760               break;
1761             }
1762
1763           pango_attribute_destroy (attr);
1764           tmp_list = tmp_list->next;
1765         }
1766
1767       g_slist_free (extra_attrs);
1768
1769       insert_attr = pango_attr_font_desc_new (font_desc);
1770       insert_attr->start_index = start + offset;
1771       insert_attr->end_index = end + offset;
1772
1773       pango_attr_list_insert (attrs, insert_attr);
1774
1775       if (language)
1776         {
1777           insert_attr = pango_attr_language_new (language);
1778           insert_attr->start_index = start + offset;
1779           insert_attr->end_index = end + offset;
1780
1781           pango_attr_list_insert (attrs, insert_attr);
1782         }
1783
1784       add_generic_attrs (layout, &appearance, end - start,
1785                          attrs, start + offset,
1786                          size_only, TRUE);
1787
1788       pango_font_description_free (font_desc);
1789     }
1790   while (pango_attr_iterator_next (iter));
1791
1792   pango_attr_iterator_destroy (iter);
1793 }
1794
1795 GtkTextLineDisplay *
1796 gtk_text_layout_get_line_display (GtkTextLayout *layout,
1797                                   GtkTextLine   *line,
1798                                   gboolean       size_only)
1799 {
1800   GtkTextLayoutPrivate *priv = GTK_TEXT_LAYOUT_GET_PRIVATE (layout);
1801   GtkTextLineDisplay *display;
1802   GtkTextLineSegment *seg;
1803   GtkTextIter iter;
1804   GtkTextAttributes *style;
1805   gchar *text;
1806   PangoAttrList *attrs;
1807   gint text_allocated, layout_byte_offset, buffer_byte_offset;
1808   PangoRectangle extents;
1809   gboolean para_values_set = FALSE;
1810   GSList *cursor_byte_offsets = NULL;
1811   GSList *cursor_segs = NULL;
1812   GSList *tmp_list1, *tmp_list2;
1813   gboolean saw_widget = FALSE;
1814   PangoDirection base_dir;
1815
1816   g_return_val_if_fail (line != NULL, NULL);
1817
1818   if (layout->one_display_cache)
1819     {
1820       if (line == layout->one_display_cache->line &&
1821           (size_only || !layout->one_display_cache->size_only))
1822         return layout->one_display_cache;
1823       else
1824         {
1825           GtkTextLineDisplay *tmp_display = layout->one_display_cache;
1826           layout->one_display_cache = NULL;
1827           gtk_text_layout_free_line_display (layout, tmp_display);
1828         }
1829     }
1830
1831   display = g_new0 (GtkTextLineDisplay, 1);
1832
1833   display->size_only = size_only;
1834   display->line = line;
1835   display->insert_index = -1;
1836
1837   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
1838                                     &iter, line, 0);
1839
1840   /* Special-case optimization for completely
1841    * invisible lines; makes it faster to deal
1842    * with sequences of invisible lines.
1843    */
1844   if (totally_invisible_line (layout, line, &iter))
1845     return display;
1846
1847   /* Find the bidi base direction */
1848   base_dir = line->dir_propagated_forward;
1849   if (base_dir == PANGO_DIRECTION_NEUTRAL)
1850     base_dir = line->dir_propagated_back;
1851
1852   if (line == priv->cursor_line &&
1853       line->dir_strong == PANGO_DIRECTION_NEUTRAL)
1854     {
1855       base_dir = (layout->keyboard_direction == GTK_TEXT_DIR_LTR) ?
1856          PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL;
1857     }
1858
1859   /* Allocate space for flat text for buffer
1860    */
1861   text_allocated = _gtk_text_line_byte_count (line);
1862   text = g_malloc (text_allocated);
1863
1864   attrs = pango_attr_list_new ();
1865
1866   /* Iterate over segments, creating display chunks for them. */
1867   layout_byte_offset = 0; /* current length of layout text (includes preedit, does not include invisible text) */
1868   buffer_byte_offset = 0; /* position in the buffer line */
1869   seg = _gtk_text_iter_get_any_segment (&iter);
1870   while (seg != NULL)
1871     {
1872       /* Displayable segments */
1873       if (seg->type == &gtk_text_char_type ||
1874           seg->type == &gtk_text_pixbuf_type ||
1875           seg->type == &gtk_text_child_type)
1876         {
1877           _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
1878                                             &iter, line,
1879                                             buffer_byte_offset);
1880           style = get_style (layout, &iter);
1881
1882           /* We have to delay setting the paragraph values until we
1883            * hit the first pixbuf or text segment because toggles at
1884            * the beginning of the paragraph should affect the
1885            * paragraph-global values
1886            */
1887           if (!para_values_set)
1888             {
1889               set_para_values (layout, base_dir, style, display);
1890               para_values_set = TRUE;
1891             }
1892
1893           /* First see if the chunk is invisible, and ignore it if so. Tk
1894            * looked at tabs, wrap mode, etc. before doing this, but
1895            * that made no sense to me, so I am just skipping the
1896            * invisible chunks
1897            */
1898           if (!style->invisible)
1899             {
1900               if (seg->type == &gtk_text_char_type)
1901                 {
1902                   /* We don't want to split segments because of marks,
1903                    * so we scan forward for more segments only
1904                    * separated from us by marks. In theory, we should
1905                    * also merge segments with identical styles, even
1906                    * if there are toggles in-between
1907                    */
1908
1909                   gint bytes = 0;
1910                   GtkTextLineSegment *prev_seg = NULL;
1911
1912                   while (seg)
1913                     {
1914                       if (seg->type == &gtk_text_char_type)
1915                         {
1916                           memcpy (text + layout_byte_offset, seg->body.chars, seg->byte_count);
1917                           layout_byte_offset += seg->byte_count;
1918                           buffer_byte_offset += seg->byte_count;
1919                           bytes += seg->byte_count;
1920                         }
1921                       else if (seg->type == &gtk_text_right_mark_type ||
1922                                seg->type == &gtk_text_left_mark_type)
1923                         {
1924                           /* If we have preedit string, break out of this loop - we'll almost
1925                            * certainly have different attributes on the preedit string
1926                            */
1927
1928                           if (layout->preedit_len > 0 &&
1929                               _gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
1930                                                              seg->body.mark.obj))
1931                             break;
1932
1933                           if (seg->body.mark.visible)
1934                             {
1935                               cursor_byte_offsets = g_slist_prepend (cursor_byte_offsets, GINT_TO_POINTER (layout_byte_offset));
1936                               cursor_segs = g_slist_prepend (cursor_segs, seg);
1937                             }
1938                         }
1939                       else
1940                         break;
1941
1942                       prev_seg = seg;
1943                       seg = seg->next;
1944                     }
1945
1946                   seg = prev_seg; /* Back up one */
1947                   add_generic_attrs (layout, &style->appearance,
1948                                      bytes,
1949                                      attrs, layout_byte_offset - bytes,
1950                                      size_only, TRUE);
1951                   add_text_attrs (layout, style, bytes, attrs,
1952                                   layout_byte_offset - bytes, size_only);
1953                 }
1954               else if (seg->type == &gtk_text_pixbuf_type)
1955                 {
1956                   add_generic_attrs (layout,
1957                                      &style->appearance,
1958                                      seg->byte_count,
1959                                      attrs, layout_byte_offset,
1960                                      size_only, FALSE);
1961                   add_pixbuf_attrs (layout, display, style,
1962                                     seg, attrs, layout_byte_offset);
1963                   memcpy (text + layout_byte_offset, gtk_text_unknown_char_utf8,
1964                           seg->byte_count);
1965                   layout_byte_offset += seg->byte_count;
1966                   buffer_byte_offset += seg->byte_count;
1967                 }
1968               else if (seg->type == &gtk_text_child_type)
1969                 {
1970                   saw_widget = TRUE;
1971
1972                   add_generic_attrs (layout, &style->appearance,
1973                                      seg->byte_count,
1974                                      attrs, layout_byte_offset,
1975                                      size_only, FALSE);
1976                   add_child_attrs (layout, display, style,
1977                                    seg, attrs, layout_byte_offset);
1978                   memcpy (text + layout_byte_offset, gtk_text_unknown_char_utf8,
1979                           seg->byte_count);
1980                   layout_byte_offset += seg->byte_count;
1981                   buffer_byte_offset += seg->byte_count;
1982                 }
1983               else
1984                 {
1985                   /* We don't know this segment type */
1986                   g_assert_not_reached ();
1987                 }
1988
1989             } /* if (segment was visible) */
1990           else
1991             {
1992               /* Invisible segment */
1993               buffer_byte_offset += seg->byte_count;
1994             }
1995
1996           release_style (layout, style);
1997         }
1998
1999       /* Toggles */
2000       else if (seg->type == &gtk_text_toggle_on_type ||
2001                seg->type == &gtk_text_toggle_off_type)
2002         {
2003           /* Style may have changed, drop our
2004              current cached style */
2005           invalidate_cached_style (layout);
2006         }
2007
2008       /* Marks */
2009       else if (seg->type == &gtk_text_right_mark_type ||
2010                seg->type == &gtk_text_left_mark_type)
2011         {
2012           gint cursor_offset = 0;
2013
2014           /* At the insertion point, add the preedit string, if any */
2015
2016           if (_gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
2017                                              seg->body.mark.obj))
2018             {
2019               display->insert_index = layout_byte_offset;
2020
2021               if (layout->preedit_len > 0)
2022                 {
2023                   text_allocated += layout->preedit_len;
2024                   text = g_realloc (text, text_allocated);
2025
2026                   style = get_style (layout, &iter);
2027                   add_preedit_attrs (layout, style, attrs, layout_byte_offset, size_only);
2028                   release_style (layout, style);
2029
2030                   memcpy (text + layout_byte_offset, layout->preedit_string, layout->preedit_len);
2031                   layout_byte_offset += layout->preedit_len;
2032                   /* DO NOT increment the buffer byte offset for preedit */
2033
2034                   cursor_offset = layout->preedit_cursor - layout->preedit_len;
2035                 }
2036             }
2037
2038
2039           /* Display visible marks */
2040
2041           if (seg->body.mark.visible)
2042             {
2043               cursor_byte_offsets = g_slist_prepend (cursor_byte_offsets,
2044                                                      GINT_TO_POINTER (layout_byte_offset + cursor_offset));
2045               cursor_segs = g_slist_prepend (cursor_segs, seg);
2046             }
2047         }
2048
2049       else
2050         g_error ("Unknown segment type: %s", seg->type->name);
2051
2052       seg = seg->next;
2053     }
2054
2055   if (!para_values_set)
2056     {
2057       style = get_style (layout, &iter);
2058       set_para_values (layout, base_dir, style, display);
2059       release_style (layout, style);
2060     }
2061
2062   /* Pango doesn't want the trailing paragraph delimiters */
2063
2064   {
2065     /* Only one character has type G_UNICODE_PARAGRAPH_SEPARATOR in
2066      * Unicode 3.0; update this if that changes.
2067      */
2068 #define PARAGRAPH_SEPARATOR 0x2029
2069     gunichar ch = 0;
2070
2071     if (layout_byte_offset > 0)
2072       {
2073         const char *prev = g_utf8_prev_char (text + layout_byte_offset);
2074         ch = g_utf8_get_char (prev);
2075         if (ch == PARAGRAPH_SEPARATOR || ch == '\r' || ch == '\n')
2076           layout_byte_offset = prev - text; /* chop off */
2077
2078         if (ch == '\n' && layout_byte_offset > 0)
2079           {
2080             /* Possibly chop a CR as well */
2081             prev = g_utf8_prev_char (text + layout_byte_offset);
2082             if (*prev == '\r')
2083               --layout_byte_offset;
2084           }
2085       }
2086   }
2087
2088   pango_layout_set_text (display->layout, text, layout_byte_offset);
2089   pango_layout_set_attributes (display->layout, attrs);
2090
2091   tmp_list1 = cursor_byte_offsets;
2092   tmp_list2 = cursor_segs;
2093   while (tmp_list1)
2094     {
2095       add_cursor (layout, display, tmp_list2->data,
2096                   GPOINTER_TO_INT (tmp_list1->data));
2097       tmp_list1 = tmp_list1->next;
2098       tmp_list2 = tmp_list2->next;
2099     }
2100   g_slist_free (cursor_byte_offsets);
2101   g_slist_free (cursor_segs);
2102
2103   pango_layout_get_extents (display->layout, NULL, &extents);
2104
2105   display->width = PIXEL_BOUND (extents.width) + display->left_margin + display->right_margin;
2106   display->height += PANGO_PIXELS (extents.height);
2107
2108   /* If we aren't wrapping, we need to do the alignment of each
2109    * paragraph ourselves.
2110    */
2111   if (pango_layout_get_width (display->layout) < 0)
2112     {
2113       gint excess = display->total_width - display->width;
2114
2115       switch (pango_layout_get_alignment (display->layout))
2116         {
2117         case PANGO_ALIGN_LEFT:
2118           break;
2119         case PANGO_ALIGN_CENTER:
2120           display->x_offset += excess / 2;
2121           break;
2122         case PANGO_ALIGN_RIGHT:
2123           display->x_offset += excess;
2124           break;
2125         }
2126     }
2127
2128   /* Free this if we aren't in a loop */
2129   if (layout->wrap_loop_count == 0)
2130     invalidate_cached_style (layout);
2131
2132   g_free (text);
2133   pango_attr_list_unref (attrs);
2134
2135   layout->one_display_cache = display;
2136
2137   if (saw_widget)
2138     allocate_child_widgets (layout, display);
2139
2140   return display;
2141 }
2142
2143 void
2144 gtk_text_layout_free_line_display (GtkTextLayout      *layout,
2145                                    GtkTextLineDisplay *display)
2146 {
2147   if (display != layout->one_display_cache)
2148     {
2149       if (display->layout)
2150         g_object_unref (display->layout);
2151
2152       if (display->cursors)
2153         {
2154           g_slist_foreach (display->cursors, (GFunc)g_free, NULL);
2155           g_slist_free (display->cursors);
2156         }
2157       g_slist_free (display->shaped_objects);
2158
2159       g_free (display);
2160     }
2161 }
2162
2163 /* Functions to convert iter <=> index for the line of a GtkTextLineDisplay
2164  * taking into account the preedit string and invisible text if necessary.
2165  */
2166 static gint
2167 line_display_iter_to_index (GtkTextLayout      *layout,
2168                             GtkTextLineDisplay *display,
2169                             const GtkTextIter  *iter)
2170 {
2171   gint index;
2172
2173   g_return_val_if_fail (_gtk_text_iter_get_text_line (iter) == display->line, 0);
2174
2175   index = gtk_text_iter_get_visible_line_index (iter);
2176
2177   if (layout->preedit_len > 0 && display->insert_index >= 0)
2178     {
2179       if (index >= display->insert_index)
2180         index += layout->preedit_len;
2181     }
2182
2183   return index;
2184 }
2185
2186 static void
2187 line_display_index_to_iter (GtkTextLayout      *layout,
2188                             GtkTextLineDisplay *display,
2189                             GtkTextIter        *iter,
2190                             gint                index,
2191                             gint                trailing)
2192 {
2193   g_return_if_fail (!_gtk_text_line_is_last (display->line,
2194                                              _gtk_text_buffer_get_btree (layout->buffer)));
2195
2196   if (layout->preedit_len > 0 && display->insert_index >= 0)
2197     {
2198       if (index >= display->insert_index + layout->preedit_len)
2199         index -= layout->preedit_len;
2200       else if (index > display->insert_index)
2201         {
2202           index = display->insert_index;
2203           trailing = 0;
2204         }
2205     }
2206
2207   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2208                                     iter, display->line, 0);
2209
2210   gtk_text_iter_set_visible_line_index (iter, index);
2211
2212   if (_gtk_text_iter_get_text_line (iter) != display->line)
2213     {
2214       /* Clamp to end of line - really this clamping should have been done
2215        * before here, maybe in Pango, this is a broken band-aid I think
2216        */
2217       _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2218                                         iter, display->line, 0);
2219
2220       if (!gtk_text_iter_ends_line (iter))
2221         gtk_text_iter_forward_to_line_end (iter);
2222     }
2223
2224   gtk_text_iter_forward_chars (iter, trailing);
2225 }
2226
2227 static void
2228 get_line_at_y (GtkTextLayout *layout,
2229                gint           y,
2230                GtkTextLine  **line,
2231                gint          *line_top)
2232 {
2233   if (y < 0)
2234     y = 0;
2235   if (y > layout->height)
2236     y = layout->height;
2237
2238   *line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
2239                                          layout, y, line_top);
2240   if (*line == NULL)
2241     {
2242       *line = _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2243
2244       if (line_top)
2245         *line_top =
2246           _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2247                                         *line, layout);
2248     }
2249 }
2250
2251 /**
2252  * gtk_text_layout_get_line_at_y:
2253  * @layout: a #GtkLayout
2254  * @target_iter: the iterator in which the result is stored
2255  * @y: the y positition
2256  * @line_top: location to store the y coordinate of the
2257  *            top of the line. (Can by %NULL.)
2258  *
2259  * Get the iter at the beginning of the line which is displayed
2260  * at the given y.
2261  **/
2262 void
2263 gtk_text_layout_get_line_at_y (GtkTextLayout *layout,
2264                                GtkTextIter   *target_iter,
2265                                gint           y,
2266                                gint          *line_top)
2267 {
2268   GtkTextLine *line;
2269
2270   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2271   g_return_if_fail (target_iter != NULL);
2272
2273   get_line_at_y (layout, y, &line, line_top);
2274   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2275                                    target_iter, line, 0);
2276 }
2277
2278 void
2279 gtk_text_layout_get_iter_at_pixel (GtkTextLayout *layout,
2280                                    GtkTextIter   *target_iter,
2281                                    gint           x,
2282                                    gint           y)
2283 {
2284   gint trailing;
2285
2286   gtk_text_layout_get_iter_at_position (layout, target_iter, &trailing, x, y);
2287
2288   gtk_text_iter_forward_chars (target_iter, trailing);
2289 }
2290
2291 void gtk_text_layout_get_iter_at_position (GtkTextLayout     *layout,
2292                                            GtkTextIter       *target_iter,
2293                                            gint              *trailing,
2294                                            gint               x,
2295                                            gint               y)
2296 {
2297   GtkTextLine *line;
2298   gint byte_index;
2299   gint line_top;
2300   GtkTextLineDisplay *display;
2301
2302   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2303   g_return_if_fail (target_iter != NULL);
2304
2305   get_line_at_y (layout, y, &line, &line_top);
2306
2307   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2308
2309   x -= display->x_offset;
2310   y -= line_top + display->top_margin;
2311
2312   /* If we are below the layout, position the cursor at the last character
2313    * of the line.
2314    */
2315   if (y > display->height - display->top_margin - display->bottom_margin)
2316     {
2317       byte_index = _gtk_text_line_byte_count (line);
2318       *trailing = 0;
2319     }
2320   else
2321     {
2322        /* Ignore the "outside" return value from pango. Pango is doing
2323         * the right thing even if we are outside the layout in the
2324         * x-direction.
2325         */
2326       pango_layout_xy_to_index (display->layout, x * PANGO_SCALE, y * PANGO_SCALE,
2327                                 &byte_index, trailing);
2328     }
2329
2330   line_display_index_to_iter (layout, display, target_iter, byte_index, 0);
2331
2332   gtk_text_layout_free_line_display (layout, display);
2333 }
2334
2335
2336 /**
2337  * gtk_text_layout_get_cursor_locations:
2338  * @layout: a #GtkTextLayout
2339  * @iter: a #GtkTextIter
2340  * @strong_pos: location to store the strong cursor position (may be %NULL)
2341  * @weak_pos: location to store the weak cursor position (may be %NULL)
2342  *
2343  * Given an iterator within a text layout, determine the positions of the
2344  * strong and weak cursors if the insertion point is at that
2345  * iterator. The position of each cursor is stored as a zero-width
2346  * rectangle. The strong cursor location is the location where
2347  * characters of the directionality equal to the base direction of the
2348  * paragraph are inserted.  The weak cursor location is the location
2349  * where characters of the directionality opposite to the base
2350  * direction of the paragraph are inserted.
2351  **/
2352 void
2353 gtk_text_layout_get_cursor_locations (GtkTextLayout  *layout,
2354                                       GtkTextIter    *iter,
2355                                       GdkRectangle   *strong_pos,
2356                                       GdkRectangle   *weak_pos)
2357 {
2358   GtkTextLine *line;
2359   GtkTextLineDisplay *display;
2360   gint line_top;
2361   gint index;
2362   GtkTextIter insert_iter;
2363
2364   PangoRectangle pango_strong_pos;
2365   PangoRectangle pango_weak_pos;
2366
2367   g_return_if_fail (layout != NULL);
2368   g_return_if_fail (iter != NULL);
2369
2370   line = _gtk_text_iter_get_text_line (iter);
2371   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2372   index = line_display_iter_to_index (layout, display, iter);
2373
2374   line_top = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2375                                            line, layout);
2376
2377   gtk_text_buffer_get_iter_at_mark (layout->buffer, &insert_iter,
2378                                     gtk_text_buffer_get_mark (layout->buffer,
2379                                                               "insert"));
2380
2381   if (gtk_text_iter_equal (iter, &insert_iter))
2382     index += layout->preedit_cursor - layout->preedit_len;
2383
2384   pango_layout_get_cursor_pos (display->layout, index,
2385                                strong_pos ? &pango_strong_pos : NULL,
2386                                weak_pos ? &pango_weak_pos : NULL);
2387
2388   if (strong_pos)
2389     {
2390       strong_pos->x = display->x_offset + pango_strong_pos.x / PANGO_SCALE;
2391       strong_pos->y = line_top + display->top_margin + pango_strong_pos.y / PANGO_SCALE;
2392       strong_pos->width = 0;
2393       strong_pos->height = pango_strong_pos.height / PANGO_SCALE;
2394     }
2395
2396   if (weak_pos)
2397     {
2398       weak_pos->x = display->x_offset + pango_weak_pos.x / PANGO_SCALE;
2399       weak_pos->y = line_top + display->top_margin + pango_weak_pos.y / PANGO_SCALE;
2400       weak_pos->width = 0;
2401       weak_pos->height = pango_weak_pos.height / PANGO_SCALE;
2402     }
2403
2404   gtk_text_layout_free_line_display (layout, display);
2405 }
2406
2407 /**
2408  * gtk_text_layout_get_line_yrange:
2409  * @layout: a #GtkTextLayout
2410  * @iter:   a #GtkTextIter
2411  * @y:      location to store the top of the paragraph in pixels,
2412  *          or %NULL.
2413  * @height  location to store the height of the paragraph in pixels,
2414  *          or %NULL.
2415  *
2416  * Find the range of y coordinates for the paragraph containing
2417  * the given iter.
2418  **/
2419 void
2420 gtk_text_layout_get_line_yrange (GtkTextLayout     *layout,
2421                                  const GtkTextIter *iter,
2422                                  gint              *y,
2423                                  gint              *height)
2424 {
2425   GtkTextLine *line;
2426
2427   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2428   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2429
2430   line = _gtk_text_iter_get_text_line (iter);
2431
2432   if (y)
2433     *y = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2434                                        line, layout);
2435   if (height)
2436     {
2437       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
2438       if (line_data)
2439         *height = line_data->height;
2440       else
2441         *height = 0;
2442     }
2443 }
2444
2445 /**
2446  * _gtk_text_layout_get_line_xrange:
2447  * @layout: a #GtkTextLayout
2448  * @iter:   a #GtkTextIter
2449  * @x:      location to store the top of the paragraph in pixels,
2450  *          or %NULL.
2451  * @width  location to store the height of the paragraph in pixels,
2452  *          or %NULL.
2453  *
2454  * Find the range of X coordinates for the paragraph containing
2455  * the given iter. Private for 2.0 due to API freeze, could
2456  * be made public for 2.2.
2457  **/
2458 void
2459 _gtk_text_layout_get_line_xrange (GtkTextLayout     *layout,
2460                                   const GtkTextIter *iter,
2461                                   gint              *x,
2462                                   gint              *width)
2463 {
2464   GtkTextLine *line;
2465
2466   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2467   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2468
2469   line = _gtk_text_iter_get_text_line (iter);
2470
2471   if (x)
2472     *x = 0; /* FIXME This is wrong; should represent the first available cursor position */
2473
2474   if (width)
2475     {
2476       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
2477       if (line_data)
2478         *width = line_data->width;
2479       else
2480         *width = 0;
2481     }
2482 }
2483
2484 void
2485 gtk_text_layout_get_iter_location (GtkTextLayout     *layout,
2486                                    const GtkTextIter *iter,
2487                                    GdkRectangle      *rect)
2488 {
2489   PangoRectangle pango_rect;
2490   GtkTextLine *line;
2491   GtkTextBTree *tree;
2492   GtkTextLineDisplay *display;
2493   gint byte_index;
2494   gint x_offset;
2495
2496   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2497   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2498   g_return_if_fail (rect != NULL);
2499
2500   tree = _gtk_text_iter_get_btree (iter);
2501   line = _gtk_text_iter_get_text_line (iter);
2502
2503   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2504
2505   rect->y = _gtk_text_btree_find_line_top (tree, line, layout);
2506
2507   x_offset = display->x_offset * PANGO_SCALE;
2508
2509   byte_index = gtk_text_iter_get_line_index (iter);
2510
2511   pango_layout_index_to_pos (display->layout, byte_index, &pango_rect);
2512
2513   rect->x = PANGO_PIXELS (x_offset + pango_rect.x);
2514   rect->y += PANGO_PIXELS (pango_rect.y) + display->top_margin;
2515   rect->width = PANGO_PIXELS (pango_rect.width);
2516   rect->height = PANGO_PIXELS (pango_rect.height);
2517
2518   gtk_text_layout_free_line_display (layout, display);
2519 }
2520
2521 /* FFIXX */
2522
2523 /* Find the iter for the logical beginning of the first display line whose
2524  * top y is >= y. If none exists, move the iter to the logical beginning
2525  * of the last line in the buffer.
2526  */
2527 static void
2528 find_display_line_below (GtkTextLayout *layout,
2529                          GtkTextIter   *iter,
2530                          gint           y)
2531 {
2532   GtkTextLine *line, *next;
2533   GtkTextLine *found_line = NULL;
2534   gint line_top;
2535   gint found_byte = 0;
2536
2537   line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
2538                                         layout, y, &line_top);
2539   if (!line)
2540     {
2541       line =
2542         _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2543
2544       line_top =
2545         _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2546                                       line, layout);
2547     }
2548
2549   while (line && !found_line)
2550     {
2551       GtkTextLineDisplay *display = gtk_text_layout_get_line_display (layout, line, FALSE);
2552       PangoLayoutIter *layout_iter;
2553
2554       layout_iter = pango_layout_get_iter (display->layout);
2555
2556       line_top += display->top_margin;
2557
2558       do
2559         {
2560           gint first_y, last_y;
2561           PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
2562
2563           found_byte = layout_line->start_index;
2564
2565           if (line_top >= y)
2566             {
2567               found_line = line;
2568               break;
2569             }
2570
2571           pango_layout_iter_get_line_yrange (layout_iter, &first_y, &last_y);
2572           line_top += (last_y - first_y) / PANGO_SCALE;
2573         }
2574       while (pango_layout_iter_next_line (layout_iter));
2575
2576       pango_layout_iter_free (layout_iter);
2577
2578       line_top += display->bottom_margin;
2579       gtk_text_layout_free_line_display (layout, display);
2580
2581       next = _gtk_text_line_next_excluding_last (line);
2582       if (!next)
2583         found_line = line;
2584
2585       line = next;
2586     }
2587
2588   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2589                                    iter, found_line, found_byte);
2590 }
2591
2592 /* Find the iter for the logical beginning of the last display line whose
2593  * top y is >= y. If none exists, move the iter to the logical beginning
2594  * of the first line in the buffer.
2595  */
2596 static void
2597 find_display_line_above (GtkTextLayout *layout,
2598                          GtkTextIter   *iter,
2599                          gint           y)
2600 {
2601   GtkTextLine *line;
2602   GtkTextLine *found_line = NULL;
2603   gint line_top;
2604   gint found_byte = 0;
2605
2606   line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer), layout, y, &line_top);
2607   if (!line)
2608     {
2609       line = _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2610
2611       line_top = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer), line, layout);
2612     }
2613
2614   while (line && !found_line)
2615     {
2616       GtkTextLineDisplay *display = gtk_text_layout_get_line_display (layout, line, FALSE);
2617       PangoRectangle logical_rect;
2618       PangoLayoutIter *layout_iter;
2619       gint tmp_top;
2620
2621       layout_iter = pango_layout_get_iter (display->layout);
2622
2623       line_top -= display->top_margin + display->bottom_margin;
2624       pango_layout_iter_get_layout_extents (layout_iter, NULL, &logical_rect);
2625       line_top -= logical_rect.height / PANGO_SCALE;
2626
2627       tmp_top = line_top + display->top_margin;
2628
2629       do
2630         {
2631           gint first_y, last_y;
2632           PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
2633
2634           found_byte = layout_line->start_index;
2635
2636           pango_layout_iter_get_line_yrange (layout_iter, &first_y, &last_y);
2637
2638           tmp_top -= (last_y - first_y) / PANGO_SCALE;
2639
2640           if (tmp_top < y)
2641             {
2642               found_line = line;
2643               pango_layout_iter_free (layout_iter);
2644               goto done;
2645             }
2646         }
2647       while (pango_layout_iter_next_line (layout_iter));
2648
2649       pango_layout_iter_free (layout_iter);
2650
2651       gtk_text_layout_free_line_display (layout, display);
2652
2653       line = _gtk_text_line_previous (line);
2654     }
2655
2656  done:
2657
2658   if (found_line)
2659     _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2660                                      iter, found_line, found_byte);
2661   else
2662     gtk_text_buffer_get_iter_at_offset (layout->buffer, iter, 0);
2663 }
2664
2665 /**
2666  * gtk_text_layout_clamp_iter_to_vrange:
2667  * @layout: a #GtkTextLayout
2668  * @iter:   a #GtkTextIter
2669  * @top:    the top of the range
2670  * @bottom: the bottom the range
2671  *
2672  * If the iterator is not fully in the range @top <= y < @bottom,
2673  * then, if possible, move it the minimum distance so that the
2674  * iterator in this range.
2675  *
2676  * Returns: %TRUE if the iterator was moved, otherwise %FALSE.
2677  **/
2678 gboolean
2679 gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout *layout,
2680                                       GtkTextIter   *iter,
2681                                       gint           top,
2682                                       gint           bottom)
2683 {
2684   GdkRectangle iter_rect;
2685
2686   gtk_text_layout_get_iter_location (layout, iter, &iter_rect);
2687
2688   /* If the iter is at least partially above the range, put the iter
2689    * at the first fully visible line after the range.
2690    */
2691   if (iter_rect.y < top)
2692     {
2693       find_display_line_below (layout, iter, top);
2694
2695       return TRUE;
2696     }
2697   /* Otherwise, if the iter is at least partially below the screen, put the
2698    * iter on the last logical position of the last completely visible
2699    * line on screen
2700    */
2701   else if (iter_rect.y + iter_rect.height > bottom)
2702     {
2703       find_display_line_above (layout, iter, bottom);
2704
2705       return TRUE;
2706     }
2707   else
2708     return FALSE;
2709 }
2710
2711 /**
2712  * gtk_text_layout_move_iter_to_previous_line:
2713  * @layout: a #GtkLayout
2714  * @iter:   a #GtkTextIter
2715  *
2716  * Move the iterator to the beginning of the previous line. The lines
2717  * of a wrapped paragraph are treated as distinct for this operation.
2718  **/
2719 gboolean
2720 gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout,
2721                                             GtkTextIter   *iter)
2722 {
2723   GtkTextLine *line;
2724   GtkTextLineDisplay *display;
2725   gint line_byte;
2726   GSList *tmp_list;
2727   PangoLayoutLine *layout_line;
2728   GtkTextIter orig;
2729   gboolean update_byte = FALSE;
2730
2731   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2732   g_return_val_if_fail (iter != NULL, FALSE);
2733
2734   orig = *iter;
2735
2736
2737   line = _gtk_text_iter_get_text_line (iter);
2738   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2739   line_byte = line_display_iter_to_index (layout, display, iter);
2740
2741   /* If display->height == 0 then the line is invisible, so don't
2742    * move onto it.
2743    */
2744   while (display->height == 0)
2745     {
2746       GtkTextLine *prev_line;
2747
2748       prev_line = _gtk_text_line_previous (line);
2749
2750       if (prev_line == NULL)
2751         {
2752           line_display_index_to_iter (layout, display, iter, 0, 0);
2753           goto out;
2754         }
2755
2756       gtk_text_layout_free_line_display (layout, display);
2757
2758       line = prev_line;
2759       display = gtk_text_layout_get_line_display (layout, prev_line, FALSE);
2760       update_byte = TRUE;
2761     }
2762
2763   tmp_list = pango_layout_get_lines (display->layout);
2764   layout_line = tmp_list->data;
2765
2766   if (update_byte)
2767     {
2768       line_byte = layout_line->start_index + layout_line->length;
2769     }
2770
2771   if (line_byte < layout_line->length || !tmp_list->next) /* first line of paragraph */
2772     {
2773       GtkTextLine *prev_line;
2774
2775       prev_line = _gtk_text_line_previous (line);
2776
2777       /* first line of the whole buffer, do not move the iter and return FALSE */
2778       if (prev_line == NULL)
2779         goto out;
2780
2781       while (prev_line)
2782         {
2783           gtk_text_layout_free_line_display (layout, display);
2784
2785           display = gtk_text_layout_get_line_display (layout, prev_line, FALSE);
2786
2787           if (display->height > 0)
2788             {
2789               tmp_list = g_slist_last (pango_layout_get_lines (display->layout));
2790               layout_line = tmp_list->data;
2791
2792               line_display_index_to_iter (layout, display, iter,
2793                                           layout_line->start_index + layout_line->length, 0);
2794               break;
2795             }
2796
2797           prev_line = _gtk_text_line_previous (prev_line);
2798         }
2799     }
2800   else
2801     {
2802       gint prev_offset = layout_line->start_index;
2803
2804       tmp_list = tmp_list->next;
2805       while (tmp_list)
2806         {
2807           layout_line = tmp_list->data;
2808
2809           if (line_byte < layout_line->start_index + layout_line->length ||
2810               !tmp_list->next)
2811             {
2812               line_display_index_to_iter (layout, display, iter, prev_offset, 0);
2813               break;
2814             }
2815
2816           prev_offset = layout_line->start_index;
2817           tmp_list = tmp_list->next;
2818         }
2819     }
2820
2821  out:
2822
2823   gtk_text_layout_free_line_display (layout, display);
2824
2825   return
2826     !gtk_text_iter_equal (iter, &orig) &&
2827     !gtk_text_iter_is_end (iter);
2828 }
2829
2830 /**
2831  * gtk_text_layout_move_iter_to_next_line:
2832  * @layout: a #GtkLayout
2833  * @iter:   a #GtkTextIter
2834  *
2835  * Move the iterator to the beginning of the next line. The
2836  * lines of a wrapped paragraph are treated as distinct for
2837  * this operation.
2838  **/
2839 gboolean
2840 gtk_text_layout_move_iter_to_next_line (GtkTextLayout *layout,
2841                                         GtkTextIter   *iter)
2842 {
2843   GtkTextLine *line;
2844   GtkTextLineDisplay *display;
2845   gint line_byte;
2846   GtkTextIter orig;
2847   gboolean found = FALSE;
2848   gboolean found_after = FALSE;
2849   gboolean first = TRUE;
2850
2851   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2852   g_return_val_if_fail (iter != NULL, FALSE);
2853
2854   orig = *iter;
2855
2856   line = _gtk_text_iter_get_text_line (iter);
2857
2858   while (line && !found_after)
2859     {
2860       GSList *tmp_list;
2861
2862       display = gtk_text_layout_get_line_display (layout, line, FALSE);
2863
2864       if (display->height == 0)
2865         goto next;
2866
2867       if (first)
2868         {
2869           line_byte = line_display_iter_to_index (layout, display, iter);
2870           first = FALSE;
2871         }
2872       else
2873         line_byte = 0;
2874
2875       tmp_list = pango_layout_get_lines (display->layout);
2876       while (tmp_list && !found_after)
2877         {
2878           PangoLayoutLine *layout_line = tmp_list->data;
2879
2880           if (found)
2881             {
2882               line_display_index_to_iter (layout, display, iter,
2883                                           layout_line->start_index, 0);
2884               found_after = TRUE;
2885             }
2886           else if (line_byte < layout_line->start_index + layout_line->length || !tmp_list->next)
2887             found = TRUE;
2888
2889           tmp_list = tmp_list->next;
2890         }
2891
2892     next:
2893
2894       gtk_text_layout_free_line_display (layout, display);
2895
2896       line = _gtk_text_line_next_excluding_last (line);
2897     }
2898
2899   if (!found_after)
2900     gtk_text_buffer_get_end_iter (layout->buffer, iter);
2901
2902   return
2903     !gtk_text_iter_equal (iter, &orig) &&
2904     !gtk_text_iter_is_end (iter);
2905 }
2906
2907 /**
2908  * gtk_text_layout_move_iter_to_line_end:
2909  * @layout: a #GtkTextLayout
2910  * @direction: if negative, move to beginning of line, otherwise
2911                move to end of line.
2912  *
2913  * Move to the beginning or end of a display line.
2914  **/
2915 gboolean
2916 gtk_text_layout_move_iter_to_line_end (GtkTextLayout *layout,
2917                                        GtkTextIter   *iter,
2918                                        gint           direction)
2919 {
2920   GtkTextLine *line;
2921   GtkTextLineDisplay *display;
2922   gint line_byte;
2923   GSList *tmp_list;
2924   GtkTextIter orig;
2925
2926   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2927   g_return_val_if_fail (iter != NULL, FALSE);
2928
2929   orig = *iter;
2930
2931   line = _gtk_text_iter_get_text_line (iter);
2932   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2933   line_byte = line_display_iter_to_index (layout, display, iter);
2934
2935   tmp_list = pango_layout_get_lines (display->layout);
2936   while (tmp_list)
2937     {
2938       PangoLayoutLine *layout_line = tmp_list->data;
2939
2940       if (line_byte < layout_line->start_index + layout_line->length || !tmp_list->next)
2941         {
2942           line_display_index_to_iter (layout, display, iter,
2943                                       direction < 0 ? layout_line->start_index : layout_line->start_index + layout_line->length,
2944                                       0);
2945
2946           /* FIXME: As a bad hack, we move back one position when we
2947            * are inside a paragraph to avoid going to next line on a
2948            * forced break not at whitespace. Real fix is to keep track
2949            * of whether marks are at leading or trailing edge?  */
2950           if (direction > 0 && layout_line->length > 0 && !gtk_text_iter_ends_line (iter))
2951             gtk_text_iter_backward_char (iter);
2952
2953           break;
2954         }
2955
2956       tmp_list = tmp_list->next;
2957     }
2958
2959   gtk_text_layout_free_line_display (layout, display);
2960
2961   return
2962     !gtk_text_iter_equal (iter, &orig) &&
2963     !gtk_text_iter_is_end (iter);
2964 }
2965
2966
2967 /**
2968  * gtk_text_layout_iter_starts_line:
2969  * @layout: a #GtkTextLayout
2970  * @iter: iterator to test
2971  *
2972  * Tests whether an iterator is at the start of a display line.
2973  **/
2974 gboolean
2975 gtk_text_layout_iter_starts_line (GtkTextLayout       *layout,
2976                                   const GtkTextIter   *iter)
2977 {
2978   GtkTextLine *line;
2979   GtkTextLineDisplay *display;
2980   gint line_byte;
2981   GSList *tmp_list;
2982
2983   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2984   g_return_val_if_fail (iter != NULL, FALSE);
2985
2986   line = _gtk_text_iter_get_text_line (iter);
2987   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2988   line_byte = line_display_iter_to_index (layout, display, iter);
2989
2990   tmp_list = pango_layout_get_lines (display->layout);
2991   while (tmp_list)
2992     {
2993       PangoLayoutLine *layout_line = tmp_list->data;
2994
2995       if (line_byte < layout_line->start_index + layout_line->length ||
2996           !tmp_list->next)
2997         {
2998           /* We're located on this line or the para delimiters before
2999            * it
3000            */
3001           gtk_text_layout_free_line_display (layout, display);
3002
3003           if (line_byte == layout_line->start_index)
3004             return TRUE;
3005           else
3006             return FALSE;
3007         }
3008
3009       tmp_list = tmp_list->next;
3010     }
3011
3012   g_assert_not_reached ();
3013   return FALSE;
3014 }
3015
3016 void
3017 gtk_text_layout_get_iter_at_line (GtkTextLayout  *layout,
3018                                   GtkTextIter    *iter,
3019                                   GtkTextLine    *line,
3020                                   gint            byte_offset)
3021 {
3022   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
3023                                     iter, line, byte_offset);
3024 }
3025
3026
3027 /**
3028  * gtk_text_layout_move_iter_to_x:
3029  * @layout: a #GtkTextLayout
3030  * @iter:   a #GtkTextIter
3031  * @x:      X coordinate
3032  *
3033  * Keeping the iterator on the same line of the layout, move it to the
3034  * specified X coordinate. The lines of a wrapped paragraph are
3035  * treated as distinct for this operation.
3036  **/
3037 void
3038 gtk_text_layout_move_iter_to_x (GtkTextLayout *layout,
3039                                 GtkTextIter   *iter,
3040                                 gint           x)
3041 {
3042   GtkTextLine *line;
3043   GtkTextLineDisplay *display;
3044   gint line_byte;
3045   PangoLayoutIter *layout_iter;
3046
3047   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
3048   g_return_if_fail (iter != NULL);
3049
3050   line = _gtk_text_iter_get_text_line (iter);
3051
3052   display = gtk_text_layout_get_line_display (layout, line, FALSE);
3053   line_byte = line_display_iter_to_index (layout, display, iter);
3054
3055   layout_iter = pango_layout_get_iter (display->layout);
3056
3057   do
3058     {
3059       PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
3060
3061       if (line_byte < layout_line->start_index + layout_line->length ||
3062           pango_layout_iter_at_last_line (layout_iter))
3063         {
3064           PangoRectangle logical_rect;
3065           gint byte_index, trailing;
3066           gint x_offset = display->x_offset * PANGO_SCALE;
3067
3068           pango_layout_iter_get_line_extents (layout_iter, NULL, &logical_rect);
3069
3070           pango_layout_line_x_to_index (layout_line,
3071                                         x * PANGO_SCALE - x_offset - logical_rect.x,
3072                                         &byte_index, &trailing);
3073
3074           line_display_index_to_iter (layout, display, iter, byte_index, trailing);
3075
3076           break;
3077         }
3078     }
3079   while (pango_layout_iter_next_line (layout_iter));
3080
3081   pango_layout_iter_free (layout_iter);
3082
3083   gtk_text_layout_free_line_display (layout, display);
3084 }
3085
3086 /**
3087  * gtk_text_layout_move_iter_visually:
3088  * @layout:  a #GtkTextLayout
3089  * @iter:    a #GtkTextIter
3090  * @count:   number of characters to move (negative moves left, positive moves right)
3091  *
3092  * Move the iterator a given number of characters visually, treating
3093  * it as the strong cursor position. If @count is positive, then the
3094  * new strong cursor position will be @count positions to the right of
3095  * the old cursor position. If @count is negative then the new strong
3096  * cursor position will be @count positions to the left of the old
3097  * cursor position.
3098  *
3099  * In the presence of bidirection text, the correspondence
3100  * between logical and visual order will depend on the direction
3101  * of the current run, and there may be jumps when the cursor
3102  * is moved off of the end of a run.
3103  **/
3104
3105 gboolean
3106 gtk_text_layout_move_iter_visually (GtkTextLayout *layout,
3107                                     GtkTextIter   *iter,
3108                                     gint           count)
3109 {
3110   GtkTextLineDisplay *display = NULL;
3111   GtkTextIter orig;
3112
3113   g_return_val_if_fail (layout != NULL, FALSE);
3114   g_return_val_if_fail (iter != NULL, FALSE);
3115
3116   orig = *iter;
3117
3118   while (count != 0)
3119     {
3120       GtkTextLine *line = _gtk_text_iter_get_text_line (iter);
3121       gint line_byte;
3122       gint extra_back = 0;
3123       gboolean strong;
3124
3125       int byte_count = _gtk_text_line_byte_count (line);
3126
3127       int new_index;
3128       int new_trailing;
3129
3130       if (!display)
3131         display = gtk_text_layout_get_line_display (layout, line, FALSE);
3132
3133       if (layout->cursor_direction == GTK_TEXT_DIR_NONE)
3134         strong = TRUE;
3135       else
3136         strong = display->direction == layout->cursor_direction;
3137
3138       line_byte = line_display_iter_to_index (layout, display, iter);
3139
3140       if (count > 0)
3141         {
3142           pango_layout_move_cursor_visually (display->layout, strong, line_byte, 0, 1, &new_index, &new_trailing);
3143           count--;
3144         }
3145       else
3146         {
3147           pango_layout_move_cursor_visually (display->layout, strong, line_byte, 0, -1, &new_index, &new_trailing);
3148           count++;
3149         }
3150
3151       /* We need to handle the preedit string specially. Well, we don't really need to
3152        * handle it specially, since hopefully calling gtk_im_context_reset() will
3153        * remove the preedit string; but if we start off in front of the preedit
3154        * string (logically) and end up in or on the back edge of the preedit string,
3155        * we should move the iter one place farther.
3156        */
3157       if (layout->preedit_len > 0 && display->insert_index >= 0)
3158         {
3159           if (line_byte == display->insert_index + layout->preedit_len &&
3160               new_index < display->insert_index + layout->preedit_len)
3161             {
3162               line_byte = display->insert_index;
3163               extra_back = 1;
3164             }
3165         }
3166
3167       if (new_index < 0 || (new_index == 0 && extra_back))
3168         {
3169           line = _gtk_text_line_previous (line);
3170
3171           if (!line)
3172             goto done;
3173
3174           gtk_text_layout_free_line_display (layout, display);
3175           display = gtk_text_layout_get_line_display (layout, line, FALSE);
3176           new_index = _gtk_text_line_byte_count (line);
3177         }
3178       else if (new_index > byte_count)
3179         {
3180           line = _gtk_text_line_next_excluding_last (line);
3181           if (!line)
3182             goto done;
3183
3184           gtk_text_layout_free_line_display (layout, display);
3185           display = gtk_text_layout_get_line_display (layout, line, FALSE);
3186           new_index = 0;
3187         }
3188
3189        line_display_index_to_iter (layout, display, iter, new_index, new_trailing);
3190        if (extra_back)
3191          gtk_text_iter_backward_char (iter);
3192     }
3193
3194   gtk_text_layout_free_line_display (layout, display);
3195
3196  done:
3197
3198   return
3199     !gtk_text_iter_equal (iter, &orig) &&
3200     !gtk_text_iter_is_end (iter);
3201 }
3202
3203 void
3204 gtk_text_layout_spew (GtkTextLayout *layout)
3205 {
3206 #if 0
3207   GtkTextDisplayLine *iter;
3208   guint wrapped = 0;
3209   guint paragraphs = 0;
3210   GtkTextLine *last_line = NULL;
3211
3212   iter = layout->line_list;
3213   while (iter != NULL)
3214     {
3215       if (iter->line != last_line)
3216         {
3217           printf ("%5u  paragraph (%p)\n", paragraphs, iter->line);
3218           ++paragraphs;
3219           last_line = iter->line;
3220         }
3221
3222       printf ("  %5u  y: %d len: %d start: %d bytes: %d\n",
3223               wrapped, iter->y, iter->length, iter->byte_offset,
3224               iter->byte_count);
3225
3226       ++wrapped;
3227       iter = iter->next;
3228     }
3229
3230   printf ("Layout %s recompute\n",
3231           layout->need_recompute ? "needs" : "doesn't need");
3232
3233   printf ("Layout pars: %u lines: %u size: %d x %d Screen width: %d\n",
3234           paragraphs, wrapped, layout->width,
3235           layout->height, layout->screen_width);
3236 #endif
3237 }
3238
3239 /* Catch all situations that move the insertion point.
3240  */
3241 static void
3242 gtk_text_layout_mark_set_handler (GtkTextBuffer     *buffer,
3243                                   const GtkTextIter *location,
3244                                   GtkTextMark       *mark,
3245                                   gpointer           data)
3246 {
3247   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3248
3249   if (mark == gtk_text_buffer_get_insert (buffer))
3250     gtk_text_layout_update_cursor_line (layout);
3251 }
3252
3253 static void
3254 gtk_text_layout_buffer_insert_text (GtkTextBuffer *textbuffer,
3255                                     GtkTextIter   *iter,
3256                                     gchar         *str,
3257                                     gint           len,
3258                                     gpointer       data)
3259 {
3260   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3261
3262   gtk_text_layout_update_cursor_line (layout);
3263 }
3264
3265 static void
3266 gtk_text_layout_buffer_delete_range (GtkTextBuffer *textbuffer,
3267                                      GtkTextIter   *start,
3268                                      GtkTextIter   *end,
3269                                      gpointer       data)
3270 {
3271   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3272
3273   gtk_text_layout_update_cursor_line (layout);
3274 }