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->rise != 0)
1402     {
1403       attr = pango_attr_rise_new (appearance->rise);
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 (!size_only)
1412     {
1413       attr = gtk_text_attr_appearance_new (appearance);
1414
1415       attr->start_index = start;
1416       attr->end_index = start + byte_count;
1417
1418       ((GtkTextAttrAppearance *)attr)->appearance.is_text = is_text;
1419
1420       pango_attr_list_insert (attrs, attr);
1421     }
1422 }
1423
1424 static void
1425 add_text_attrs (GtkTextLayout      *layout,
1426                 GtkTextAttributes  *style,
1427                 gint                byte_count,
1428                 PangoAttrList      *attrs,
1429                 gint                start,
1430                 gboolean            size_only)
1431 {
1432   PangoAttribute *attr;
1433
1434   attr = pango_attr_font_desc_new (style->font);
1435   attr->start_index = start;
1436   attr->end_index = start + byte_count;
1437
1438   pango_attr_list_insert (attrs, attr);
1439
1440   if (style->font_scale != 1.0)
1441     {
1442       attr = pango_attr_scale_new (style->font_scale);
1443
1444       attr->start_index = start;
1445       attr->end_index = start + byte_count;
1446
1447       pango_attr_list_insert (attrs, attr);
1448     }
1449 }
1450
1451 static void
1452 add_pixbuf_attrs (GtkTextLayout      *layout,
1453                   GtkTextLineDisplay *display,
1454                   GtkTextAttributes  *style,
1455                   GtkTextLineSegment *seg,
1456                   PangoAttrList      *attrs,
1457                   gint                start)
1458 {
1459   PangoAttribute *attr;
1460   PangoRectangle logical_rect;
1461   GtkTextPixbuf *pixbuf = &seg->body.pixbuf;
1462   gint width, height;
1463
1464   width = gdk_pixbuf_get_width (pixbuf->pixbuf);
1465   height = gdk_pixbuf_get_height (pixbuf->pixbuf);
1466
1467   logical_rect.x = 0;
1468   logical_rect.y = -height * PANGO_SCALE;
1469   logical_rect.width = width * PANGO_SCALE;
1470   logical_rect.height = height * PANGO_SCALE;
1471
1472   attr = pango_attr_shape_new (&logical_rect, &logical_rect);
1473   attr->start_index = start;
1474   attr->end_index = start + seg->byte_count;
1475   pango_attr_list_insert (attrs, attr);
1476
1477   display->shaped_objects =
1478     g_slist_append (display->shaped_objects, pixbuf->pixbuf);
1479 }
1480
1481 static void
1482 add_child_attrs (GtkTextLayout      *layout,
1483                  GtkTextLineDisplay *display,
1484                  GtkTextAttributes  *style,
1485                  GtkTextLineSegment *seg,
1486                  PangoAttrList      *attrs,
1487                  gint                start)
1488 {
1489   PangoAttribute *attr;
1490   PangoRectangle logical_rect;
1491   GtkTextChildAnchor *anchor;
1492   gint width, height;
1493   GSList *tmp_list;
1494
1495   width = 1;
1496   height = 1;
1497
1498   anchor = seg->body.child.obj;
1499
1500   tmp_list = seg->body.child.widgets;
1501   while (tmp_list != NULL)
1502     {
1503       GtkWidget *child = tmp_list->data;
1504
1505       if (_gtk_anchored_child_get_layout (child) == layout)
1506         {
1507           /* Found it */
1508           GtkRequisition req;
1509
1510           gtk_widget_get_child_requisition (child, &req);
1511
1512           width = req.width;
1513           height = req.height;
1514
1515           display->shaped_objects =
1516             g_slist_append (display->shaped_objects, child);
1517
1518           break;
1519         }
1520
1521       tmp_list = g_slist_next (tmp_list);
1522     }
1523
1524   if (tmp_list == NULL)
1525     {
1526       /* If tmp_list == NULL then there is no widget at this anchor in
1527        * this display; not an error. We make up an arbitrary size
1528        * to use, just so the programmer can see the blank spot.
1529        * We also put a NULL in the shaped objects list, to keep
1530        * the correspondence between the list and the shaped chars in
1531        * the layout. A bad hack, yes.
1532        */
1533
1534       width = 30;
1535       height = 20;
1536
1537       display->shaped_objects =
1538         g_slist_append (display->shaped_objects, NULL);
1539     }
1540
1541   logical_rect.x = 0;
1542   logical_rect.y = -height * PANGO_SCALE;
1543   logical_rect.width = width * PANGO_SCALE;
1544   logical_rect.height = height * PANGO_SCALE;
1545
1546   attr = pango_attr_shape_new (&logical_rect, &logical_rect);
1547   attr->start_index = start;
1548   attr->end_index = start + seg->byte_count;
1549   pango_attr_list_insert (attrs, attr);
1550 }
1551
1552 static void
1553 add_cursor (GtkTextLayout      *layout,
1554             GtkTextLineDisplay *display,
1555             GtkTextLineSegment *seg,
1556             gint                start)
1557 {
1558   PangoRectangle strong_pos, weak_pos;
1559   GtkTextCursorDisplay *cursor = NULL; /* Quiet GCC */
1560   gboolean add_weak = FALSE;
1561   gboolean add_strong = FALSE;
1562
1563   /* Hide insertion cursor when we have a selection or the layout
1564    * user has hidden the cursor.
1565    */
1566   if (_gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
1567                                      seg->body.mark.obj) &&
1568       (!layout->cursor_visible ||
1569        gtk_text_buffer_get_selection_bounds (layout->buffer, NULL, NULL)))
1570     return;
1571
1572   pango_layout_get_cursor_pos (display->layout, start, &strong_pos, &weak_pos);
1573
1574   if (layout->cursor_direction == GTK_TEXT_DIR_NONE)
1575     {
1576       add_strong = TRUE;
1577       add_weak = TRUE;
1578     }
1579   else if (display->direction == layout->cursor_direction)
1580     add_strong = TRUE;
1581   else
1582     add_weak = TRUE;
1583
1584   if (add_strong)
1585     {
1586       cursor = g_new (GtkTextCursorDisplay, 1);
1587
1588       cursor->x = PANGO_PIXELS (strong_pos.x);
1589       cursor->y = PANGO_PIXELS (strong_pos.y);
1590       cursor->height = PANGO_PIXELS (strong_pos.height);
1591       cursor->is_strong = TRUE;
1592       cursor->is_weak = (layout->cursor_direction == GTK_TEXT_DIR_NONE) ? FALSE : TRUE;
1593       display->cursors = g_slist_prepend (display->cursors, cursor);
1594     }
1595
1596   if (add_weak)
1597     {
1598       if (weak_pos.x == strong_pos.x && add_strong)
1599         cursor->is_weak = TRUE;
1600       else
1601         {
1602           cursor = g_new (GtkTextCursorDisplay, 1);
1603
1604           cursor->x = PANGO_PIXELS (weak_pos.x);
1605           cursor->y = PANGO_PIXELS (weak_pos.y);
1606           cursor->height = PANGO_PIXELS (weak_pos.height);
1607           cursor->is_strong = (layout->cursor_direction == GTK_TEXT_DIR_NONE) ? FALSE : TRUE;
1608           cursor->is_weak = TRUE;
1609           display->cursors = g_slist_prepend (display->cursors, cursor);
1610         }
1611     }
1612 }
1613
1614 static gboolean
1615 is_shape (PangoLayoutRun *run)
1616 {
1617   GSList *tmp_list = run->item->analysis.extra_attrs;
1618
1619   while (tmp_list)
1620     {
1621       PangoAttribute *attr = tmp_list->data;
1622
1623       if (attr->klass->type == PANGO_ATTR_SHAPE)
1624         return TRUE;
1625
1626       tmp_list = tmp_list->next;
1627     }
1628
1629   return FALSE;
1630 }
1631
1632 static void
1633 allocate_child_widgets (GtkTextLayout      *text_layout,
1634                         GtkTextLineDisplay *display)
1635 {
1636   GSList *shaped = display->shaped_objects;
1637   PangoLayout *layout = display->layout;
1638   PangoLayoutIter *iter;
1639
1640   iter = pango_layout_get_iter (layout);
1641
1642   do
1643     {
1644       PangoLayoutRun *run = pango_layout_iter_get_run (iter);
1645
1646       if (run && is_shape (run))
1647         {
1648           GObject *shaped_object = shaped->data;
1649           shaped = shaped->next;
1650
1651           /* shaped_object is NULL for child anchors with no
1652            * widgets stored at them
1653            */
1654           if (shaped_object && GTK_IS_WIDGET (shaped_object))
1655             {
1656               PangoRectangle extents;
1657
1658               /* We emit "allocate_child" with the x,y of
1659                * the widget with respect to the top of the line
1660                * and the left side of the buffer
1661                */
1662
1663               pango_layout_iter_get_run_extents (iter,
1664                                                  NULL,
1665                                                  &extents);
1666
1667               g_signal_emit (text_layout,
1668                              signals[ALLOCATE_CHILD],
1669                              0,
1670                              shaped_object,
1671                              PANGO_PIXELS (extents.x) + display->x_offset,
1672                              PANGO_PIXELS (extents.y) + display->top_margin);
1673             }
1674         }
1675     }
1676   while (pango_layout_iter_next_run (iter));
1677
1678   pango_layout_iter_free (iter);
1679 }
1680
1681 static void
1682 convert_color (GdkColor       *result,
1683                PangoAttrColor *attr)
1684 {
1685   result->red = attr->color.red;
1686   result->blue = attr->color.blue;
1687   result->green = attr->color.green;
1688 }
1689
1690 /* This function is used to convert the preedit string attributes, which are
1691  * standard PangoAttributes, into the custom attributes used by the text
1692  * widget and insert them into a attr list with a given offset.
1693  */
1694 static void
1695 add_preedit_attrs (GtkTextLayout     *layout,
1696                    GtkTextAttributes *style,
1697                    PangoAttrList     *attrs,
1698                    gint               offset,
1699                    gboolean           size_only)
1700 {
1701   PangoAttrIterator *iter = pango_attr_list_get_iterator (layout->preedit_attrs);
1702
1703   do
1704     {
1705       GtkTextAppearance appearance = style->appearance;
1706       PangoFontDescription *font_desc = pango_font_description_copy_static (style->font);
1707       PangoAttribute *insert_attr;
1708       GSList *extra_attrs = NULL;
1709       GSList *tmp_list;
1710       PangoLanguage *language;
1711       gint start, end;
1712
1713       pango_attr_iterator_range (iter, &start, &end);
1714
1715       if (end == G_MAXINT)
1716         end = layout->preedit_len;
1717
1718       if (end == start)
1719         continue;
1720
1721       pango_attr_iterator_get_font (iter, font_desc, &language, &extra_attrs);
1722
1723       tmp_list = extra_attrs;
1724       while (tmp_list)
1725         {
1726           PangoAttribute *attr = tmp_list->data;
1727
1728           switch (attr->klass->type)
1729             {
1730             case PANGO_ATTR_FOREGROUND:
1731               convert_color (&appearance.fg_color, (PangoAttrColor *)attr);
1732               break;
1733             case PANGO_ATTR_BACKGROUND:
1734               convert_color (&appearance.bg_color, (PangoAttrColor *)attr);
1735               appearance.draw_bg = TRUE;
1736               break;
1737             case PANGO_ATTR_UNDERLINE:
1738               appearance.underline = ((PangoAttrInt *)attr)->value;
1739               break;
1740             case PANGO_ATTR_STRIKETHROUGH:
1741               appearance.strikethrough = ((PangoAttrInt *)attr)->value;
1742               break;
1743             case PANGO_ATTR_RISE:
1744               appearance.rise = ((PangoAttrInt *)attr)->value;
1745               break;
1746             default:
1747               break;
1748             }
1749
1750           pango_attribute_destroy (attr);
1751           tmp_list = tmp_list->next;
1752         }
1753
1754       g_slist_free (extra_attrs);
1755
1756       insert_attr = pango_attr_font_desc_new (font_desc);
1757       insert_attr->start_index = start + offset;
1758       insert_attr->end_index = end + offset;
1759
1760       pango_attr_list_insert (attrs, insert_attr);
1761
1762       if (language)
1763         {
1764           insert_attr = pango_attr_language_new (language);
1765           insert_attr->start_index = start + offset;
1766           insert_attr->end_index = end + offset;
1767
1768           pango_attr_list_insert (attrs, insert_attr);
1769         }
1770
1771       add_generic_attrs (layout, &appearance, end - start,
1772                          attrs, start + offset,
1773                          size_only, TRUE);
1774
1775       pango_font_description_free (font_desc);
1776     }
1777   while (pango_attr_iterator_next (iter));
1778
1779   pango_attr_iterator_destroy (iter);
1780 }
1781
1782 GtkTextLineDisplay *
1783 gtk_text_layout_get_line_display (GtkTextLayout *layout,
1784                                   GtkTextLine   *line,
1785                                   gboolean       size_only)
1786 {
1787   GtkTextLayoutPrivate *priv = GTK_TEXT_LAYOUT_GET_PRIVATE (layout);
1788   GtkTextLineDisplay *display;
1789   GtkTextLineSegment *seg;
1790   GtkTextIter iter;
1791   GtkTextAttributes *style;
1792   gchar *text;
1793   PangoAttrList *attrs;
1794   gint text_allocated, layout_byte_offset, buffer_byte_offset;
1795   PangoRectangle extents;
1796   gboolean para_values_set = FALSE;
1797   GSList *cursor_byte_offsets = NULL;
1798   GSList *cursor_segs = NULL;
1799   GSList *tmp_list1, *tmp_list2;
1800   gboolean saw_widget = FALSE;
1801   PangoDirection base_dir;
1802
1803   g_return_val_if_fail (line != NULL, NULL);
1804
1805   if (layout->one_display_cache)
1806     {
1807       if (line == layout->one_display_cache->line &&
1808           (size_only || !layout->one_display_cache->size_only))
1809         return layout->one_display_cache;
1810       else
1811         {
1812           GtkTextLineDisplay *tmp_display = layout->one_display_cache;
1813           layout->one_display_cache = NULL;
1814           gtk_text_layout_free_line_display (layout, tmp_display);
1815         }
1816     }
1817
1818   display = g_new0 (GtkTextLineDisplay, 1);
1819
1820   display->size_only = size_only;
1821   display->line = line;
1822   display->insert_index = -1;
1823
1824   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
1825                                     &iter, line, 0);
1826
1827   /* Special-case optimization for completely
1828    * invisible lines; makes it faster to deal
1829    * with sequences of invisible lines.
1830    */
1831   if (totally_invisible_line (layout, line, &iter))
1832     return display;
1833
1834   /* Find the bidi base direction */
1835   base_dir = line->dir_propagated_forward;
1836   if (base_dir == PANGO_DIRECTION_NEUTRAL)
1837     base_dir = line->dir_propagated_back;
1838
1839   if (line == priv->cursor_line &&
1840       line->dir_strong == PANGO_DIRECTION_NEUTRAL)
1841     {
1842       base_dir = (layout->keyboard_direction == GTK_TEXT_DIR_LTR) ?
1843          PANGO_DIRECTION_LTR : PANGO_DIRECTION_RTL;
1844     }
1845
1846   /* Allocate space for flat text for buffer
1847    */
1848   text_allocated = _gtk_text_line_byte_count (line);
1849   text = g_malloc (text_allocated);
1850
1851   attrs = pango_attr_list_new ();
1852
1853   /* Iterate over segments, creating display chunks for them. */
1854   layout_byte_offset = 0; /* current length of layout text (includes preedit, does not include invisible text) */
1855   buffer_byte_offset = 0; /* position in the buffer line */
1856   seg = _gtk_text_iter_get_any_segment (&iter);
1857   while (seg != NULL)
1858     {
1859       /* Displayable segments */
1860       if (seg->type == &gtk_text_char_type ||
1861           seg->type == &gtk_text_pixbuf_type ||
1862           seg->type == &gtk_text_child_type)
1863         {
1864           _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
1865                                             &iter, line,
1866                                             buffer_byte_offset);
1867           style = get_style (layout, &iter);
1868
1869           /* We have to delay setting the paragraph values until we
1870            * hit the first pixbuf or text segment because toggles at
1871            * the beginning of the paragraph should affect the
1872            * paragraph-global values
1873            */
1874           if (!para_values_set)
1875             {
1876               set_para_values (layout, base_dir, style, display);
1877               para_values_set = TRUE;
1878             }
1879
1880           /* First see if the chunk is invisible, and ignore it if so. Tk
1881            * looked at tabs, wrap mode, etc. before doing this, but
1882            * that made no sense to me, so I am just skipping the
1883            * invisible chunks
1884            */
1885           if (!style->invisible)
1886             {
1887               if (seg->type == &gtk_text_char_type)
1888                 {
1889                   /* We don't want to split segments because of marks,
1890                    * so we scan forward for more segments only
1891                    * separated from us by marks. In theory, we should
1892                    * also merge segments with identical styles, even
1893                    * if there are toggles in-between
1894                    */
1895
1896                   gint bytes = 0;
1897                   GtkTextLineSegment *prev_seg = NULL;
1898
1899                   while (seg)
1900                     {
1901                       if (seg->type == &gtk_text_char_type)
1902                         {
1903                           memcpy (text + layout_byte_offset, seg->body.chars, seg->byte_count);
1904                           layout_byte_offset += seg->byte_count;
1905                           buffer_byte_offset += seg->byte_count;
1906                           bytes += seg->byte_count;
1907                         }
1908                       else if (seg->type == &gtk_text_right_mark_type ||
1909                                seg->type == &gtk_text_left_mark_type)
1910                         {
1911                           /* If we have preedit string, break out of this loop - we'll almost
1912                            * certainly have different attributes on the preedit string
1913                            */
1914
1915                           if (layout->preedit_len > 0 &&
1916                               _gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
1917                                                              seg->body.mark.obj))
1918                             break;
1919
1920                           if (seg->body.mark.visible)
1921                             {
1922                               cursor_byte_offsets = g_slist_prepend (cursor_byte_offsets, GINT_TO_POINTER (layout_byte_offset));
1923                               cursor_segs = g_slist_prepend (cursor_segs, seg);
1924                             }
1925                         }
1926                       else
1927                         break;
1928
1929                       prev_seg = seg;
1930                       seg = seg->next;
1931                     }
1932
1933                   seg = prev_seg; /* Back up one */
1934                   add_generic_attrs (layout, &style->appearance,
1935                                      bytes,
1936                                      attrs, layout_byte_offset - bytes,
1937                                      size_only, TRUE);
1938                   add_text_attrs (layout, style, bytes, attrs,
1939                                   layout_byte_offset - bytes, size_only);
1940                 }
1941               else if (seg->type == &gtk_text_pixbuf_type)
1942                 {
1943                   add_generic_attrs (layout,
1944                                      &style->appearance,
1945                                      seg->byte_count,
1946                                      attrs, layout_byte_offset,
1947                                      size_only, FALSE);
1948                   add_pixbuf_attrs (layout, display, style,
1949                                     seg, attrs, layout_byte_offset);
1950                   memcpy (text + layout_byte_offset, gtk_text_unknown_char_utf8,
1951                           seg->byte_count);
1952                   layout_byte_offset += seg->byte_count;
1953                   buffer_byte_offset += seg->byte_count;
1954                 }
1955               else if (seg->type == &gtk_text_child_type)
1956                 {
1957                   saw_widget = TRUE;
1958
1959                   add_generic_attrs (layout, &style->appearance,
1960                                      seg->byte_count,
1961                                      attrs, layout_byte_offset,
1962                                      size_only, FALSE);
1963                   add_child_attrs (layout, display, style,
1964                                    seg, attrs, layout_byte_offset);
1965                   memcpy (text + layout_byte_offset, gtk_text_unknown_char_utf8,
1966                           seg->byte_count);
1967                   layout_byte_offset += seg->byte_count;
1968                   buffer_byte_offset += seg->byte_count;
1969                 }
1970               else
1971                 {
1972                   /* We don't know this segment type */
1973                   g_assert_not_reached ();
1974                 }
1975
1976             } /* if (segment was visible) */
1977           else
1978             {
1979               /* Invisible segment */
1980               buffer_byte_offset += seg->byte_count;
1981             }
1982
1983           release_style (layout, style);
1984         }
1985
1986       /* Toggles */
1987       else if (seg->type == &gtk_text_toggle_on_type ||
1988                seg->type == &gtk_text_toggle_off_type)
1989         {
1990           /* Style may have changed, drop our
1991              current cached style */
1992           invalidate_cached_style (layout);
1993         }
1994
1995       /* Marks */
1996       else if (seg->type == &gtk_text_right_mark_type ||
1997                seg->type == &gtk_text_left_mark_type)
1998         {
1999           gint cursor_offset = 0;
2000
2001           /* At the insertion point, add the preedit string, if any */
2002
2003           if (_gtk_text_btree_mark_is_insert (_gtk_text_buffer_get_btree (layout->buffer),
2004                                              seg->body.mark.obj))
2005             {
2006               display->insert_index = layout_byte_offset;
2007
2008               if (layout->preedit_len > 0)
2009                 {
2010                   text_allocated += layout->preedit_len;
2011                   text = g_realloc (text, text_allocated);
2012
2013                   style = get_style (layout, &iter);
2014                   add_preedit_attrs (layout, style, attrs, layout_byte_offset, size_only);
2015                   release_style (layout, style);
2016
2017                   memcpy (text + layout_byte_offset, layout->preedit_string, layout->preedit_len);
2018                   layout_byte_offset += layout->preedit_len;
2019                   /* DO NOT increment the buffer byte offset for preedit */
2020
2021                   cursor_offset = layout->preedit_cursor - layout->preedit_len;
2022                 }
2023             }
2024
2025
2026           /* Display visible marks */
2027
2028           if (seg->body.mark.visible)
2029             {
2030               cursor_byte_offsets = g_slist_prepend (cursor_byte_offsets,
2031                                                      GINT_TO_POINTER (layout_byte_offset + cursor_offset));
2032               cursor_segs = g_slist_prepend (cursor_segs, seg);
2033             }
2034         }
2035
2036       else
2037         g_error ("Unknown segment type: %s", seg->type->name);
2038
2039       seg = seg->next;
2040     }
2041
2042   if (!para_values_set)
2043     {
2044       style = get_style (layout, &iter);
2045       set_para_values (layout, base_dir, style, display);
2046       release_style (layout, style);
2047     }
2048
2049   /* Pango doesn't want the trailing paragraph delimiters */
2050
2051   {
2052     /* Only one character has type G_UNICODE_PARAGRAPH_SEPARATOR in
2053      * Unicode 3.0; update this if that changes.
2054      */
2055 #define PARAGRAPH_SEPARATOR 0x2029
2056     gunichar ch = 0;
2057
2058     if (layout_byte_offset > 0)
2059       {
2060         const char *prev = g_utf8_prev_char (text + layout_byte_offset);
2061         ch = g_utf8_get_char (prev);
2062         if (ch == PARAGRAPH_SEPARATOR || ch == '\r' || ch == '\n')
2063           layout_byte_offset = prev - text; /* chop off */
2064
2065         if (ch == '\n' && layout_byte_offset > 0)
2066           {
2067             /* Possibly chop a CR as well */
2068             prev = g_utf8_prev_char (text + layout_byte_offset);
2069             if (*prev == '\r')
2070               --layout_byte_offset;
2071           }
2072       }
2073   }
2074
2075   pango_layout_set_text (display->layout, text, layout_byte_offset);
2076   pango_layout_set_attributes (display->layout, attrs);
2077
2078   tmp_list1 = cursor_byte_offsets;
2079   tmp_list2 = cursor_segs;
2080   while (tmp_list1)
2081     {
2082       add_cursor (layout, display, tmp_list2->data,
2083                   GPOINTER_TO_INT (tmp_list1->data));
2084       tmp_list1 = tmp_list1->next;
2085       tmp_list2 = tmp_list2->next;
2086     }
2087   g_slist_free (cursor_byte_offsets);
2088   g_slist_free (cursor_segs);
2089
2090   pango_layout_get_extents (display->layout, NULL, &extents);
2091
2092   display->width = PIXEL_BOUND (extents.width) + display->left_margin + display->right_margin;
2093   display->height += PANGO_PIXELS (extents.height);
2094
2095   /* If we aren't wrapping, we need to do the alignment of each
2096    * paragraph ourselves.
2097    */
2098   if (pango_layout_get_width (display->layout) < 0)
2099     {
2100       gint excess = display->total_width - display->width;
2101
2102       switch (pango_layout_get_alignment (display->layout))
2103         {
2104         case PANGO_ALIGN_LEFT:
2105           break;
2106         case PANGO_ALIGN_CENTER:
2107           display->x_offset += excess / 2;
2108           break;
2109         case PANGO_ALIGN_RIGHT:
2110           display->x_offset += excess;
2111           break;
2112         }
2113     }
2114
2115   /* Free this if we aren't in a loop */
2116   if (layout->wrap_loop_count == 0)
2117     invalidate_cached_style (layout);
2118
2119   g_free (text);
2120   pango_attr_list_unref (attrs);
2121
2122   layout->one_display_cache = display;
2123
2124   if (saw_widget)
2125     allocate_child_widgets (layout, display);
2126
2127   return display;
2128 }
2129
2130 void
2131 gtk_text_layout_free_line_display (GtkTextLayout      *layout,
2132                                    GtkTextLineDisplay *display)
2133 {
2134   if (display != layout->one_display_cache)
2135     {
2136       if (display->layout)
2137         g_object_unref (display->layout);
2138
2139       if (display->cursors)
2140         {
2141           g_slist_foreach (display->cursors, (GFunc)g_free, NULL);
2142           g_slist_free (display->cursors);
2143         }
2144       g_slist_free (display->shaped_objects);
2145
2146       g_free (display);
2147     }
2148 }
2149
2150 /* Functions to convert iter <=> index for the line of a GtkTextLineDisplay
2151  * taking into account the preedit string and invisible text if necessary.
2152  */
2153 static gint
2154 line_display_iter_to_index (GtkTextLayout      *layout,
2155                             GtkTextLineDisplay *display,
2156                             const GtkTextIter  *iter)
2157 {
2158   gint index;
2159
2160   g_return_val_if_fail (_gtk_text_iter_get_text_line (iter) == display->line, 0);
2161
2162   index = gtk_text_iter_get_visible_line_index (iter);
2163
2164   if (layout->preedit_len > 0 && display->insert_index >= 0)
2165     {
2166       if (index >= display->insert_index)
2167         index += layout->preedit_len;
2168     }
2169
2170   return index;
2171 }
2172
2173 static void
2174 line_display_index_to_iter (GtkTextLayout      *layout,
2175                             GtkTextLineDisplay *display,
2176                             GtkTextIter        *iter,
2177                             gint                index,
2178                             gint                trailing)
2179 {
2180   g_return_if_fail (!_gtk_text_line_is_last (display->line,
2181                                              _gtk_text_buffer_get_btree (layout->buffer)));
2182
2183   if (layout->preedit_len > 0 && display->insert_index >= 0)
2184     {
2185       if (index >= display->insert_index + layout->preedit_len)
2186         index -= layout->preedit_len;
2187       else if (index > display->insert_index)
2188         {
2189           index = display->insert_index;
2190           trailing = 0;
2191         }
2192     }
2193
2194   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2195                                     iter, display->line, 0);
2196
2197   gtk_text_iter_set_visible_line_index (iter, index);
2198
2199   if (_gtk_text_iter_get_text_line (iter) != display->line)
2200     {
2201       /* Clamp to end of line - really this clamping should have been done
2202        * before here, maybe in Pango, this is a broken band-aid I think
2203        */
2204       _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2205                                         iter, display->line, 0);
2206
2207       if (!gtk_text_iter_ends_line (iter))
2208         gtk_text_iter_forward_to_line_end (iter);
2209     }
2210
2211   gtk_text_iter_forward_chars (iter, trailing);
2212 }
2213
2214 static void
2215 get_line_at_y (GtkTextLayout *layout,
2216                gint           y,
2217                GtkTextLine  **line,
2218                gint          *line_top)
2219 {
2220   if (y < 0)
2221     y = 0;
2222   if (y > layout->height)
2223     y = layout->height;
2224
2225   *line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
2226                                          layout, y, line_top);
2227   if (*line == NULL)
2228     {
2229       *line = _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2230
2231       if (line_top)
2232         *line_top =
2233           _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2234                                         *line, layout);
2235     }
2236 }
2237
2238 /**
2239  * gtk_text_layout_get_line_at_y:
2240  * @layout: a #GtkLayout
2241  * @target_iter: the iterator in which the result is stored
2242  * @y: the y positition
2243  * @line_top: location to store the y coordinate of the
2244  *            top of the line. (Can by %NULL.)
2245  *
2246  * Get the iter at the beginning of the line which is displayed
2247  * at the given y.
2248  **/
2249 void
2250 gtk_text_layout_get_line_at_y (GtkTextLayout *layout,
2251                                GtkTextIter   *target_iter,
2252                                gint           y,
2253                                gint          *line_top)
2254 {
2255   GtkTextLine *line;
2256
2257   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2258   g_return_if_fail (target_iter != NULL);
2259
2260   get_line_at_y (layout, y, &line, line_top);
2261   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2262                                    target_iter, line, 0);
2263 }
2264
2265 void
2266 gtk_text_layout_get_iter_at_pixel (GtkTextLayout *layout,
2267                                    GtkTextIter *target_iter,
2268                                    gint x, gint y)
2269 {
2270   GtkTextLine *line;
2271   gint byte_index, trailing;
2272   gint line_top;
2273   GtkTextLineDisplay *display;
2274
2275   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2276   g_return_if_fail (target_iter != NULL);
2277
2278   get_line_at_y (layout, y, &line, &line_top);
2279
2280   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2281
2282   x -= display->x_offset;
2283   y -= line_top + display->top_margin;
2284
2285   /* If we are below the layout, position the cursor at the last character
2286    * of the line.
2287    */
2288   if (y > display->height - display->top_margin - display->bottom_margin)
2289     {
2290       byte_index = _gtk_text_line_byte_count (line);
2291       trailing = 0;
2292     }
2293   else
2294     {
2295        /* Ignore the "outside" return value from pango. Pango is doing
2296         * the right thing even if we are outside the layout in the
2297         * x-direction.
2298         */
2299       pango_layout_xy_to_index (display->layout, x * PANGO_SCALE, y * PANGO_SCALE,
2300                                 &byte_index, &trailing);
2301     }
2302
2303   line_display_index_to_iter (layout, display, target_iter, byte_index, trailing);
2304
2305   gtk_text_layout_free_line_display (layout, display);
2306 }
2307
2308 /**
2309  * gtk_text_layout_get_cursor_locations:
2310  * @layout: a #GtkTextLayout
2311  * @iter: a #GtkTextIter
2312  * @strong_pos: location to store the strong cursor position (may be %NULL)
2313  * @weak_pos: location to store the weak cursor position (may be %NULL)
2314  *
2315  * Given an iterator within a text layout, determine the positions of the
2316  * strong and weak cursors if the insertion point is at that
2317  * iterator. The position of each cursor is stored as a zero-width
2318  * rectangle. The strong cursor location is the location where
2319  * characters of the directionality equal to the base direction of the
2320  * paragraph are inserted.  The weak cursor location is the location
2321  * where characters of the directionality opposite to the base
2322  * direction of the paragraph are inserted.
2323  **/
2324 void
2325 gtk_text_layout_get_cursor_locations (GtkTextLayout  *layout,
2326                                       GtkTextIter    *iter,
2327                                       GdkRectangle   *strong_pos,
2328                                       GdkRectangle   *weak_pos)
2329 {
2330   GtkTextLine *line;
2331   GtkTextLineDisplay *display;
2332   gint line_top;
2333   gint index;
2334   GtkTextIter insert_iter;
2335
2336   PangoRectangle pango_strong_pos;
2337   PangoRectangle pango_weak_pos;
2338
2339   g_return_if_fail (layout != NULL);
2340   g_return_if_fail (iter != NULL);
2341
2342   line = _gtk_text_iter_get_text_line (iter);
2343   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2344   index = line_display_iter_to_index (layout, display, iter);
2345
2346   line_top = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2347                                            line, layout);
2348
2349   gtk_text_buffer_get_iter_at_mark (layout->buffer, &insert_iter,
2350                                     gtk_text_buffer_get_mark (layout->buffer,
2351                                                               "insert"));
2352
2353   if (gtk_text_iter_equal (iter, &insert_iter))
2354     index += layout->preedit_cursor - layout->preedit_len;
2355
2356   pango_layout_get_cursor_pos (display->layout, index,
2357                                strong_pos ? &pango_strong_pos : NULL,
2358                                weak_pos ? &pango_weak_pos : NULL);
2359
2360   if (strong_pos)
2361     {
2362       strong_pos->x = display->x_offset + pango_strong_pos.x / PANGO_SCALE;
2363       strong_pos->y = line_top + display->top_margin + pango_strong_pos.y / PANGO_SCALE;
2364       strong_pos->width = 0;
2365       strong_pos->height = pango_strong_pos.height / PANGO_SCALE;
2366     }
2367
2368   if (weak_pos)
2369     {
2370       weak_pos->x = display->x_offset + pango_weak_pos.x / PANGO_SCALE;
2371       weak_pos->y = line_top + display->top_margin + pango_weak_pos.y / PANGO_SCALE;
2372       weak_pos->width = 0;
2373       weak_pos->height = pango_weak_pos.height / PANGO_SCALE;
2374     }
2375
2376   gtk_text_layout_free_line_display (layout, display);
2377 }
2378
2379 /**
2380  * gtk_text_layout_get_line_yrange:
2381  * @layout: a #GtkTextLayout
2382  * @iter:   a #GtkTextIter
2383  * @y:      location to store the top of the paragraph in pixels,
2384  *          or %NULL.
2385  * @height  location to store the height of the paragraph in pixels,
2386  *          or %NULL.
2387  *
2388  * Find the range of y coordinates for the paragraph containing
2389  * the given iter.
2390  **/
2391 void
2392 gtk_text_layout_get_line_yrange (GtkTextLayout     *layout,
2393                                  const GtkTextIter *iter,
2394                                  gint              *y,
2395                                  gint              *height)
2396 {
2397   GtkTextLine *line;
2398
2399   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2400   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2401
2402   line = _gtk_text_iter_get_text_line (iter);
2403
2404   if (y)
2405     *y = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2406                                        line, layout);
2407   if (height)
2408     {
2409       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
2410       if (line_data)
2411         *height = line_data->height;
2412       else
2413         *height = 0;
2414     }
2415 }
2416
2417 /**
2418  * _gtk_text_layout_get_line_xrange:
2419  * @layout: a #GtkTextLayout
2420  * @iter:   a #GtkTextIter
2421  * @x:      location to store the top of the paragraph in pixels,
2422  *          or %NULL.
2423  * @width  location to store the height of the paragraph in pixels,
2424  *          or %NULL.
2425  *
2426  * Find the range of X coordinates for the paragraph containing
2427  * the given iter. Private for 2.0 due to API freeze, could
2428  * be made public for 2.2.
2429  **/
2430 void
2431 _gtk_text_layout_get_line_xrange (GtkTextLayout     *layout,
2432                                   const GtkTextIter *iter,
2433                                   gint              *x,
2434                                   gint              *width)
2435 {
2436   GtkTextLine *line;
2437
2438   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2439   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2440
2441   line = _gtk_text_iter_get_text_line (iter);
2442
2443   if (x)
2444     *x = 0; /* FIXME This is wrong; should represent the first available cursor position */
2445
2446   if (width)
2447     {
2448       GtkTextLineData *line_data = _gtk_text_line_get_data (line, layout);
2449       if (line_data)
2450         *width = line_data->width;
2451       else
2452         *width = 0;
2453     }
2454 }
2455
2456 void
2457 gtk_text_layout_get_iter_location (GtkTextLayout     *layout,
2458                                    const GtkTextIter *iter,
2459                                    GdkRectangle      *rect)
2460 {
2461   PangoRectangle pango_rect;
2462   GtkTextLine *line;
2463   GtkTextBTree *tree;
2464   GtkTextLineDisplay *display;
2465   gint byte_index;
2466   gint x_offset;
2467
2468   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
2469   g_return_if_fail (_gtk_text_iter_get_btree (iter) == _gtk_text_buffer_get_btree (layout->buffer));
2470   g_return_if_fail (rect != NULL);
2471
2472   tree = _gtk_text_iter_get_btree (iter);
2473   line = _gtk_text_iter_get_text_line (iter);
2474
2475   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2476
2477   rect->y = _gtk_text_btree_find_line_top (tree, line, layout);
2478
2479   x_offset = display->x_offset * PANGO_SCALE;
2480
2481   byte_index = gtk_text_iter_get_line_index (iter);
2482
2483   pango_layout_index_to_pos (display->layout, byte_index, &pango_rect);
2484
2485   rect->x = PANGO_PIXELS (x_offset + pango_rect.x);
2486   rect->y += PANGO_PIXELS (pango_rect.y) + display->top_margin;
2487   rect->width = PANGO_PIXELS (pango_rect.width);
2488   rect->height = PANGO_PIXELS (pango_rect.height);
2489
2490   gtk_text_layout_free_line_display (layout, display);
2491 }
2492
2493 /* FFIXX */
2494
2495 /* Find the iter for the logical beginning of the first display line whose
2496  * top y is >= y. If none exists, move the iter to the logical beginning
2497  * of the last line in the buffer.
2498  */
2499 static void
2500 find_display_line_below (GtkTextLayout *layout,
2501                          GtkTextIter   *iter,
2502                          gint           y)
2503 {
2504   GtkTextLine *line, *next;
2505   GtkTextLine *found_line = NULL;
2506   gint line_top;
2507   gint found_byte = 0;
2508
2509   line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer),
2510                                         layout, y, &line_top);
2511   if (!line)
2512     {
2513       line =
2514         _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2515
2516       line_top =
2517         _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer),
2518                                       line, layout);
2519     }
2520
2521   while (line && !found_line)
2522     {
2523       GtkTextLineDisplay *display = gtk_text_layout_get_line_display (layout, line, FALSE);
2524       PangoLayoutIter *layout_iter;
2525
2526       layout_iter = pango_layout_get_iter (display->layout);
2527
2528       line_top += display->top_margin;
2529
2530       do
2531         {
2532           gint first_y, last_y;
2533           PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
2534
2535           found_byte = layout_line->start_index;
2536
2537           if (line_top >= y)
2538             {
2539               found_line = line;
2540               break;
2541             }
2542
2543           pango_layout_iter_get_line_yrange (layout_iter, &first_y, &last_y);
2544           line_top += (last_y - first_y) / PANGO_SCALE;
2545         }
2546       while (pango_layout_iter_next_line (layout_iter));
2547
2548       pango_layout_iter_free (layout_iter);
2549
2550       line_top += display->bottom_margin;
2551       gtk_text_layout_free_line_display (layout, display);
2552
2553       next = _gtk_text_line_next_excluding_last (line);
2554       if (!next)
2555         found_line = line;
2556
2557       line = next;
2558     }
2559
2560   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2561                                    iter, found_line, found_byte);
2562 }
2563
2564 /* Find the iter for the logical beginning of the last display line whose
2565  * top y is >= y. If none exists, move the iter to the logical beginning
2566  * of the first line in the buffer.
2567  */
2568 static void
2569 find_display_line_above (GtkTextLayout *layout,
2570                          GtkTextIter   *iter,
2571                          gint           y)
2572 {
2573   GtkTextLine *line;
2574   GtkTextLine *found_line = NULL;
2575   gint line_top;
2576   gint found_byte = 0;
2577
2578   line = _gtk_text_btree_find_line_by_y (_gtk_text_buffer_get_btree (layout->buffer), layout, y, &line_top);
2579   if (!line)
2580     {
2581       line = _gtk_text_btree_get_end_iter_line (_gtk_text_buffer_get_btree (layout->buffer));
2582
2583       line_top = _gtk_text_btree_find_line_top (_gtk_text_buffer_get_btree (layout->buffer), line, layout);
2584     }
2585
2586   while (line && !found_line)
2587     {
2588       GtkTextLineDisplay *display = gtk_text_layout_get_line_display (layout, line, FALSE);
2589       PangoRectangle logical_rect;
2590       PangoLayoutIter *layout_iter;
2591       gint tmp_top;
2592
2593       layout_iter = pango_layout_get_iter (display->layout);
2594
2595       line_top -= display->top_margin + display->bottom_margin;
2596       pango_layout_iter_get_layout_extents (layout_iter, NULL, &logical_rect);
2597       line_top -= logical_rect.height / PANGO_SCALE;
2598
2599       tmp_top = line_top + display->top_margin;
2600
2601       do
2602         {
2603           gint first_y, last_y;
2604           PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
2605
2606           found_byte = layout_line->start_index;
2607
2608           pango_layout_iter_get_line_yrange (layout_iter, &first_y, &last_y);
2609
2610           tmp_top -= (last_y - first_y) / PANGO_SCALE;
2611
2612           if (tmp_top < y)
2613             {
2614               found_line = line;
2615               pango_layout_iter_free (layout_iter);
2616               goto done;
2617             }
2618         }
2619       while (pango_layout_iter_next_line (layout_iter));
2620
2621       pango_layout_iter_free (layout_iter);
2622
2623       gtk_text_layout_free_line_display (layout, display);
2624
2625       line = _gtk_text_line_previous (line);
2626     }
2627
2628  done:
2629
2630   if (found_line)
2631     _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2632                                      iter, found_line, found_byte);
2633   else
2634     gtk_text_buffer_get_iter_at_offset (layout->buffer, iter, 0);
2635 }
2636
2637 /**
2638  * gtk_text_layout_clamp_iter_to_vrange:
2639  * @layout: a #GtkTextLayout
2640  * @iter:   a #GtkTextIter
2641  * @top:    the top of the range
2642  * @bottom: the bottom the range
2643  *
2644  * If the iterator is not fully in the range @top <= y < @bottom,
2645  * then, if possible, move it the minimum distance so that the
2646  * iterator in this range.
2647  *
2648  * Returns: %TRUE if the iterator was moved, otherwise %FALSE.
2649  **/
2650 gboolean
2651 gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout *layout,
2652                                       GtkTextIter   *iter,
2653                                       gint           top,
2654                                       gint           bottom)
2655 {
2656   GdkRectangle iter_rect;
2657
2658   gtk_text_layout_get_iter_location (layout, iter, &iter_rect);
2659
2660   /* If the iter is at least partially above the range, put the iter
2661    * at the first fully visible line after the range.
2662    */
2663   if (iter_rect.y < top)
2664     {
2665       find_display_line_below (layout, iter, top);
2666
2667       return TRUE;
2668     }
2669   /* Otherwise, if the iter is at least partially below the screen, put the
2670    * iter on the last logical position of the last completely visible
2671    * line on screen
2672    */
2673   else if (iter_rect.y + iter_rect.height > bottom)
2674     {
2675       find_display_line_above (layout, iter, bottom);
2676
2677       return TRUE;
2678     }
2679   else
2680     return FALSE;
2681 }
2682
2683 /**
2684  * gtk_text_layout_move_iter_to_previous_line:
2685  * @layout: a #GtkLayout
2686  * @iter:   a #GtkTextIter
2687  *
2688  * Move the iterator to the beginning of the previous line. The lines
2689  * of a wrapped paragraph are treated as distinct for this operation.
2690  **/
2691 gboolean
2692 gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout,
2693                                             GtkTextIter   *iter)
2694 {
2695   GtkTextLine *line;
2696   GtkTextLineDisplay *display;
2697   gint line_byte;
2698   GSList *tmp_list;
2699   PangoLayoutLine *layout_line;
2700   GtkTextIter orig;
2701   gboolean update_byte = FALSE;
2702
2703   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2704   g_return_val_if_fail (iter != NULL, FALSE);
2705
2706   orig = *iter;
2707
2708
2709   line = _gtk_text_iter_get_text_line (iter);
2710   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2711   line_byte = line_display_iter_to_index (layout, display, iter);
2712
2713   /* If display->height == 0 then the line is invisible, so don't
2714    * move onto it.
2715    */
2716   while (display->height == 0)
2717     {
2718       GtkTextLine *prev_line;
2719
2720       prev_line = _gtk_text_line_previous (line);
2721
2722       if (prev_line == NULL)
2723         {
2724           line_display_index_to_iter (layout, display, iter, 0, 0);
2725           goto out;
2726         }
2727
2728       gtk_text_layout_free_line_display (layout, display);
2729
2730       line = prev_line;
2731       display = gtk_text_layout_get_line_display (layout, prev_line, FALSE);
2732       update_byte = TRUE;
2733     }
2734
2735   tmp_list = pango_layout_get_lines (display->layout);
2736   layout_line = tmp_list->data;
2737
2738   if (update_byte)
2739     {
2740       line_byte = layout_line->start_index + layout_line->length;
2741     }
2742
2743   if (line_byte < layout_line->length || !tmp_list->next) /* first line of paragraph */
2744     {
2745       GtkTextLine *prev_line;
2746
2747       prev_line = _gtk_text_line_previous (line);
2748       while (prev_line)
2749         {
2750           gtk_text_layout_free_line_display (layout, display);
2751
2752           display = gtk_text_layout_get_line_display (layout, prev_line, FALSE);
2753
2754           if (display->height > 0)
2755             {
2756               tmp_list = g_slist_last (pango_layout_get_lines (display->layout));
2757               layout_line = tmp_list->data;
2758
2759               line_display_index_to_iter (layout, display, iter,
2760                                           layout_line->start_index + layout_line->length, 0);
2761               break;
2762             }
2763
2764           prev_line = _gtk_text_line_previous (prev_line);
2765         }
2766
2767       if (prev_line == NULL)
2768         line_display_index_to_iter (layout, display, iter, 0, 0);
2769     }
2770   else
2771     {
2772       gint prev_offset = layout_line->start_index;
2773
2774       tmp_list = tmp_list->next;
2775       while (tmp_list)
2776         {
2777           layout_line = tmp_list->data;
2778
2779           if (line_byte < layout_line->start_index + layout_line->length ||
2780               !tmp_list->next)
2781             {
2782               line_display_index_to_iter (layout, display, iter, prev_offset, 0);
2783               break;
2784             }
2785
2786           prev_offset = layout_line->start_index;
2787           tmp_list = tmp_list->next;
2788         }
2789     }
2790
2791  out:
2792
2793   gtk_text_layout_free_line_display (layout, display);
2794
2795   return
2796     !gtk_text_iter_equal (iter, &orig) &&
2797     !gtk_text_iter_is_end (iter);
2798 }
2799
2800 /**
2801  * gtk_text_layout_move_iter_to_next_line:
2802  * @layout: a #GtkLayout
2803  * @iter:   a #GtkTextIter
2804  *
2805  * Move the iterator to the beginning of the next line. The
2806  * lines of a wrapped paragraph are treated as distinct for
2807  * this operation.
2808  **/
2809 gboolean
2810 gtk_text_layout_move_iter_to_next_line (GtkTextLayout *layout,
2811                                         GtkTextIter   *iter)
2812 {
2813   GtkTextLine *line;
2814   GtkTextLineDisplay *display;
2815   gint line_byte;
2816   GtkTextIter orig;
2817   gboolean found = FALSE;
2818   gboolean found_after = FALSE;
2819   gboolean first = TRUE;
2820
2821   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2822   g_return_val_if_fail (iter != NULL, FALSE);
2823
2824   orig = *iter;
2825
2826   line = _gtk_text_iter_get_text_line (iter);
2827
2828   while (line && !found_after)
2829     {
2830       GSList *tmp_list;
2831
2832       display = gtk_text_layout_get_line_display (layout, line, FALSE);
2833
2834       if (display->height == 0)
2835         goto next;
2836
2837       if (first)
2838         {
2839           line_byte = line_display_iter_to_index (layout, display, iter);
2840           first = FALSE;
2841         }
2842       else
2843         line_byte = 0;
2844
2845       tmp_list = pango_layout_get_lines (display->layout);
2846       while (tmp_list && !found_after)
2847         {
2848           PangoLayoutLine *layout_line = tmp_list->data;
2849
2850           if (found)
2851             {
2852               line_display_index_to_iter (layout, display, iter,
2853                                           layout_line->start_index, 0);
2854               found_after = TRUE;
2855             }
2856           else if (line_byte < layout_line->start_index + layout_line->length || !tmp_list->next)
2857             found = TRUE;
2858
2859           tmp_list = tmp_list->next;
2860         }
2861
2862     next:
2863
2864       gtk_text_layout_free_line_display (layout, display);
2865
2866       line = _gtk_text_line_next_excluding_last (line);
2867     }
2868
2869   if (!found_after)
2870     gtk_text_buffer_get_end_iter (layout->buffer, iter);
2871
2872   return
2873     !gtk_text_iter_equal (iter, &orig) &&
2874     !gtk_text_iter_is_end (iter);
2875 }
2876
2877 /**
2878  * gtk_text_layout_move_iter_to_line_end:
2879  * @layout: a #GtkTextLayout
2880  * @direction: if negative, move to beginning of line, otherwise
2881                move to end of line.
2882  *
2883  * Move to the beginning or end of a display line.
2884  **/
2885 gboolean
2886 gtk_text_layout_move_iter_to_line_end (GtkTextLayout *layout,
2887                                        GtkTextIter   *iter,
2888                                        gint           direction)
2889 {
2890   GtkTextLine *line;
2891   GtkTextLineDisplay *display;
2892   gint line_byte;
2893   GSList *tmp_list;
2894   GtkTextIter orig;
2895
2896   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2897   g_return_val_if_fail (iter != NULL, FALSE);
2898
2899   orig = *iter;
2900
2901   line = _gtk_text_iter_get_text_line (iter);
2902   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2903   line_byte = line_display_iter_to_index (layout, display, iter);
2904
2905   tmp_list = pango_layout_get_lines (display->layout);
2906   while (tmp_list)
2907     {
2908       PangoLayoutLine *layout_line = tmp_list->data;
2909
2910       if (line_byte < layout_line->start_index + layout_line->length || !tmp_list->next)
2911         {
2912           line_display_index_to_iter (layout, display, iter,
2913                                       direction < 0 ? layout_line->start_index : layout_line->start_index + layout_line->length,
2914                                       0);
2915
2916           /* FIXME: As a bad hack, we move back one position when we
2917            * are inside a paragraph to avoid going to next line on a
2918            * forced break not at whitespace. Real fix is to keep track
2919            * of whether marks are at leading or trailing edge?  */
2920           if (direction > 0 && layout_line->length > 0 && !gtk_text_iter_ends_line (iter))
2921             gtk_text_iter_backward_char (iter);
2922
2923           break;
2924         }
2925
2926       tmp_list = tmp_list->next;
2927     }
2928
2929   gtk_text_layout_free_line_display (layout, display);
2930
2931   return
2932     !gtk_text_iter_equal (iter, &orig) &&
2933     !gtk_text_iter_is_end (iter);
2934 }
2935
2936
2937 /**
2938  * gtk_text_layout_iter_starts_line:
2939  * @layout: a #GtkTextLayout
2940  * @iter: iterator to test
2941  *
2942  * Tests whether an iterator is at the start of a display line.
2943  **/
2944 gboolean
2945 gtk_text_layout_iter_starts_line (GtkTextLayout       *layout,
2946                                   const GtkTextIter   *iter)
2947 {
2948   GtkTextLine *line;
2949   GtkTextLineDisplay *display;
2950   gint line_byte;
2951   GSList *tmp_list;
2952
2953   g_return_val_if_fail (GTK_IS_TEXT_LAYOUT (layout), FALSE);
2954   g_return_val_if_fail (iter != NULL, FALSE);
2955
2956   line = _gtk_text_iter_get_text_line (iter);
2957   display = gtk_text_layout_get_line_display (layout, line, FALSE);
2958   line_byte = line_display_iter_to_index (layout, display, iter);
2959
2960   tmp_list = pango_layout_get_lines (display->layout);
2961   while (tmp_list)
2962     {
2963       PangoLayoutLine *layout_line = tmp_list->data;
2964
2965       if (line_byte < layout_line->start_index + layout_line->length ||
2966           !tmp_list->next)
2967         {
2968           /* We're located on this line or the para delimiters before
2969            * it
2970            */
2971           gtk_text_layout_free_line_display (layout, display);
2972
2973           if (line_byte == layout_line->start_index)
2974             return TRUE;
2975           else
2976             return FALSE;
2977         }
2978
2979       tmp_list = tmp_list->next;
2980     }
2981
2982   g_assert_not_reached ();
2983   return FALSE;
2984 }
2985
2986 void
2987 gtk_text_layout_get_iter_at_line (GtkTextLayout  *layout,
2988                                   GtkTextIter    *iter,
2989                                   GtkTextLine    *line,
2990                                   gint            byte_offset)
2991 {
2992   _gtk_text_btree_get_iter_at_line (_gtk_text_buffer_get_btree (layout->buffer),
2993                                     iter, line, byte_offset);
2994 }
2995
2996
2997 /**
2998  * gtk_text_layout_move_iter_to_x:
2999  * @layout: a #GtkTextLayout
3000  * @iter:   a #GtkTextIter
3001  * @x:      X coordinate
3002  *
3003  * Keeping the iterator on the same line of the layout, move it to the
3004  * specified X coordinate. The lines of a wrapped paragraph are
3005  * treated as distinct for this operation.
3006  **/
3007 void
3008 gtk_text_layout_move_iter_to_x (GtkTextLayout *layout,
3009                                 GtkTextIter   *iter,
3010                                 gint           x)
3011 {
3012   GtkTextLine *line;
3013   GtkTextLineDisplay *display;
3014   gint line_byte;
3015   PangoLayoutIter *layout_iter;
3016
3017   g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
3018   g_return_if_fail (iter != NULL);
3019
3020   line = _gtk_text_iter_get_text_line (iter);
3021
3022   display = gtk_text_layout_get_line_display (layout, line, FALSE);
3023   line_byte = line_display_iter_to_index (layout, display, iter);
3024
3025   layout_iter = pango_layout_get_iter (display->layout);
3026
3027   do
3028     {
3029       PangoLayoutLine *layout_line = pango_layout_iter_get_line (layout_iter);
3030
3031       if (line_byte < layout_line->start_index + layout_line->length ||
3032           pango_layout_iter_at_last_line (layout_iter))
3033         {
3034           PangoRectangle logical_rect;
3035           gint byte_index, trailing;
3036           gint x_offset = display->x_offset * PANGO_SCALE;
3037
3038           pango_layout_iter_get_line_extents (layout_iter, NULL, &logical_rect);
3039
3040           pango_layout_line_x_to_index (layout_line,
3041                                         x * PANGO_SCALE - x_offset - logical_rect.x,
3042                                         &byte_index, &trailing);
3043
3044           line_display_index_to_iter (layout, display, iter, byte_index, trailing);
3045
3046           break;
3047         }
3048     }
3049   while (pango_layout_iter_next_line (layout_iter));
3050
3051   pango_layout_iter_free (layout_iter);
3052
3053   gtk_text_layout_free_line_display (layout, display);
3054 }
3055
3056 /**
3057  * gtk_text_layout_move_iter_visually:
3058  * @layout:  a #GtkTextLayout
3059  * @iter:    a #GtkTextIter
3060  * @count:   number of characters to move (negative moves left, positive moves right)
3061  *
3062  * Move the iterator a given number of characters visually, treating
3063  * it as the strong cursor position. If @count is positive, then the
3064  * new strong cursor position will be @count positions to the right of
3065  * the old cursor position. If @count is negative then the new strong
3066  * cursor position will be @count positions to the left of the old
3067  * cursor position.
3068  *
3069  * In the presence of bidirection text, the correspondence
3070  * between logical and visual order will depend on the direction
3071  * of the current run, and there may be jumps when the cursor
3072  * is moved off of the end of a run.
3073  **/
3074
3075 gboolean
3076 gtk_text_layout_move_iter_visually (GtkTextLayout *layout,
3077                                     GtkTextIter   *iter,
3078                                     gint           count)
3079 {
3080   GtkTextLineDisplay *display = NULL;
3081   GtkTextIter orig;
3082
3083   g_return_val_if_fail (layout != NULL, FALSE);
3084   g_return_val_if_fail (iter != NULL, FALSE);
3085
3086   orig = *iter;
3087
3088   while (count != 0)
3089     {
3090       GtkTextLine *line = _gtk_text_iter_get_text_line (iter);
3091       gint line_byte;
3092       gint extra_back = 0;
3093       gboolean strong;
3094
3095       int byte_count = _gtk_text_line_byte_count (line);
3096
3097       int new_index;
3098       int new_trailing;
3099
3100       if (!display)
3101         display = gtk_text_layout_get_line_display (layout, line, FALSE);
3102
3103       if (layout->cursor_direction == GTK_TEXT_DIR_NONE)
3104         strong = TRUE;
3105       else
3106         strong = display->direction == layout->cursor_direction;
3107
3108       line_byte = line_display_iter_to_index (layout, display, iter);
3109
3110       if (count > 0)
3111         {
3112           pango_layout_move_cursor_visually (display->layout, strong, line_byte, 0, 1, &new_index, &new_trailing);
3113           count--;
3114         }
3115       else
3116         {
3117           pango_layout_move_cursor_visually (display->layout, strong, line_byte, 0, -1, &new_index, &new_trailing);
3118           count++;
3119         }
3120
3121       /* We need to handle the preedit string specially. Well, we don't really need to
3122        * handle it specially, since hopefully calling gtk_im_context_reset() will
3123        * remove the preedit string; but if we start off in front of the preedit
3124        * string (logically) and end up in or on the back edge of the preedit string,
3125        * we should move the iter one place farther.
3126        */
3127       if (layout->preedit_len > 0 && display->insert_index >= 0)
3128         {
3129           if (line_byte == display->insert_index + layout->preedit_len &&
3130               new_index < display->insert_index + layout->preedit_len)
3131             {
3132               line_byte = display->insert_index;
3133               extra_back = 1;
3134             }
3135         }
3136
3137       if (new_index < 0 || (new_index == 0 && extra_back))
3138         {
3139           line = _gtk_text_line_previous (line);
3140
3141           if (!line)
3142             goto done;
3143
3144           gtk_text_layout_free_line_display (layout, display);
3145           display = gtk_text_layout_get_line_display (layout, line, FALSE);
3146           new_index = _gtk_text_line_byte_count (line);
3147         }
3148       else if (new_index > byte_count)
3149         {
3150           line = _gtk_text_line_next_excluding_last (line);
3151           if (!line)
3152             goto done;
3153
3154           gtk_text_layout_free_line_display (layout, display);
3155           display = gtk_text_layout_get_line_display (layout, line, FALSE);
3156           new_index = 0;
3157         }
3158
3159        line_display_index_to_iter (layout, display, iter, new_index, new_trailing);
3160        if (extra_back)
3161          gtk_text_iter_backward_char (iter);
3162     }
3163
3164   gtk_text_layout_free_line_display (layout, display);
3165
3166  done:
3167
3168   return
3169     !gtk_text_iter_equal (iter, &orig) &&
3170     !gtk_text_iter_is_end (iter);
3171 }
3172
3173 void
3174 gtk_text_layout_spew (GtkTextLayout *layout)
3175 {
3176 #if 0
3177   GtkTextDisplayLine *iter;
3178   guint wrapped = 0;
3179   guint paragraphs = 0;
3180   GtkTextLine *last_line = NULL;
3181
3182   iter = layout->line_list;
3183   while (iter != NULL)
3184     {
3185       if (iter->line != last_line)
3186         {
3187           printf ("%5u  paragraph (%p)\n", paragraphs, iter->line);
3188           ++paragraphs;
3189           last_line = iter->line;
3190         }
3191
3192       printf ("  %5u  y: %d len: %d start: %d bytes: %d\n",
3193               wrapped, iter->y, iter->length, iter->byte_offset,
3194               iter->byte_count);
3195
3196       ++wrapped;
3197       iter = iter->next;
3198     }
3199
3200   printf ("Layout %s recompute\n",
3201           layout->need_recompute ? "needs" : "doesn't need");
3202
3203   printf ("Layout pars: %u lines: %u size: %d x %d Screen width: %d\n",
3204           paragraphs, wrapped, layout->width,
3205           layout->height, layout->screen_width);
3206 #endif
3207 }
3208
3209 /* Catch all situations that move the insertion point.
3210  */
3211 static void
3212 gtk_text_layout_mark_set_handler (GtkTextBuffer     *buffer,
3213                                   const GtkTextIter *location,
3214                                   GtkTextMark       *mark,
3215                                   gpointer           data)
3216 {
3217   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3218
3219   if (mark == gtk_text_buffer_get_insert (buffer))
3220     gtk_text_layout_update_cursor_line (layout);
3221 }
3222
3223 static void
3224 gtk_text_layout_buffer_insert_text (GtkTextBuffer *textbuffer,
3225                                     GtkTextIter   *iter,
3226                                     gchar         *str,
3227                                     gint           len,
3228                                     gpointer       data)
3229 {
3230   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3231
3232   gtk_text_layout_update_cursor_line (layout);
3233 }
3234
3235 static void
3236 gtk_text_layout_buffer_delete_range (GtkTextBuffer *textbuffer,
3237                                      GtkTextIter   *start,
3238                                      GtkTextIter   *end,
3239                                      gpointer       data)
3240 {
3241   GtkTextLayout *layout = GTK_TEXT_LAYOUT (data);
3242
3243   gtk_text_layout_update_cursor_line (layout);
3244 }