gtktextbtree.c 189 KB
Newer Older
1
/*
2
 * Gtktextbtree.c --
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 *      This file contains code that manages the B-tree representation
 *      of text for the text buffer and implements character and
 *      toggle segment types.
 *
 * Copyright (c) 1992-1994 The Regents of the University of California.
 * Copyright (c) 1994-1995 Sun Microsystems, Inc.
 * Copyright (c) 2000      Red Hat, Inc.
 * Tk -> Gtk port by Havoc Pennington <hp@redhat.com>
 *
 * This software is copyrighted by the Regents of the University of
 * California, Sun Microsystems, Inc., and other parties.  The
 * following terms apply to all files associated with the software
 * unless explicitly disclaimed in individual files.
17
 *
18 19 20 21 22 23 24 25 26
 * The authors hereby grant permission to use, copy, modify,
 * distribute, and license this software and its documentation for any
 * purpose, provided that existing copyright notices are retained in
 * all copies and that this notice is included verbatim in any
 * distributions. No written agreement, license, or royalty fee is
 * required for any of the authorized uses.  Modifications to this
 * software may be copyrighted by their authors and need not follow
 * the licensing terms described here, provided that the new terms are
 * clearly indicated on the first page of each file where they apply.
27
 *
28 29 30 31 32
 * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
 * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
 * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
33
 *
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
 * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
 * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
 * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * GOVERNMENT USE: If you are acquiring this software on behalf of the
 * U.S. government, the Government shall have only "Restricted Rights"
 * in the software and related documentation as defined in the Federal
 * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
 * are acquiring the software on behalf of the Department of Defense,
 * the software shall be classified as "Commercial Computer Software"
 * and the Government shall have only "Restricted Rights" as defined
 * in Clause 252.227-7013 (c) (1) of DFARs.  Notwithstanding the
 * foregoing, the authors grant the U.S. Government and others acting
 * in its behalf permission to use and distribute the software in
 * accordance with the terms specified in this license.
52
 *
53 54
 */

55
#define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
56
#include <config.h>
57 58 59 60 61 62 63 64 65
#include "gtktextbtree.h"
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include "gtktexttag.h"
#include "gtktexttagtable.h"
#include "gtktextlayout.h"
#include "gtktextiterprivate.h"
#include "gtkdebug.h"
66
#include "gtktextmarkprivate.h"
67
#include "gtkalias.h"
68 69 70 71 72 73 74 75

/*
 * Types
 */


/*
 * The structure below is used to pass information between
76
 * _gtk_text_btree_get_tags and inc_count:
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 */

typedef struct TagInfo {
  int numTags;                  /* Number of tags for which there
                                 * is currently information in
                                 * tags and counts. */
  int arraySize;                        /* Number of entries allocated for
                                         * tags and counts. */
  GtkTextTag **tags;           /* Array of tags seen so far.
                                * Malloc-ed. */
  int *counts;                  /* Toggle count (so far) for each
                                 * entry in tags.  Malloc-ed. */
} TagInfo;


/*
 * This is used to store per-view width/height info at the tree nodes.
 */

typedef struct _NodeData NodeData;

struct _NodeData {
  gpointer view_id;
  NodeData *next;

  /* Height and width of this node */
  gint height;
104
  signed int width : 24;
105

106 107 108 109 110 111
  /* boolean indicating whether the lines below this node are in need of validation.
   * However, width/height should always represent the current total width and
   * max height for lines below this node; the valid flag indicates whether the
   * width/height on the lines needs recomputing, not whether the totals
   * need recomputing.
   */
112
  guint valid : 8;		/* Actually a boolean */
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
};


/*
 * The data structure below keeps summary information about one tag as part
 * of the tag information in a node.
 */

typedef struct Summary {
  GtkTextTagInfo *info;                     /* Handle for tag. */
  int toggle_count;                     /* Number of transitions into or
                                         * out of this tag that occur in
                                         * the subtree rooted at this node. */
  struct Summary *next;         /* Next in list of all tags for same
                                 * node, or NULL if at end of list. */
} Summary;

/*
 * The data structure below defines a node in the B-tree.
 */

struct _GtkTextBTreeNode {
  GtkTextBTreeNode *parent;         /* Pointer to parent node, or NULL if
                                     * this is the root. */
  GtkTextBTreeNode *next;           /* Next in list of siblings with the
                                     * same parent node, or NULL for end
                                     * of list. */
  Summary *summary;             /* First in malloc-ed list of info
                                 * about tags in this subtree (NULL if
                                 * no tag info in the subtree). */
  int level;                            /* Level of this node in the B-tree.
                                         * 0 refers to the bottom of the tree
                                         * (children are lines, not nodes). */
  union {                               /* First in linked list of children. */
    struct _GtkTextBTreeNode *node;         /* Used if level > 0. */
    GtkTextLine *line;         /* Used if level == 0. */
  } children;
  int num_children;                     /* Number of children of this node. */
  int num_lines;                        /* Total number of lines (leaves) in
                                         * the subtree rooted here. */
  int num_chars;                        /* Number of chars below here */

  NodeData *node_data;
};


/*
 * Used to store the list of views in our btree
 */

typedef struct _BTreeView BTreeView;

struct _BTreeView {
  gpointer view_id;
  GtkTextLayout *layout;
  BTreeView *next;
  BTreeView *prev;
};

/*
 * And the tree itself
 */

struct _GtkTextBTree {
  GtkTextBTreeNode *root_node;          /* Pointer to root of B-tree. */
  GtkTextTagTable *table;
  GHashTable *mark_table;
  guint refcount;
Havoc Pennington's avatar
Havoc Pennington committed
181 182
  GtkTextMark *insert_mark;
  GtkTextMark *selection_bound_mark;
183 184 185
  GtkTextBuffer *buffer;
  BTreeView *views;
  GSList *tag_infos;
186
  gulong tag_changed_handler;
187

188
  /* Incremented when a segment with a byte size > 0
189 190 191 192 193
   * is added to or removed from the tree (i.e. the
   * length of a line may have changed, and lines may
   * have been added or removed). This invalidates
   * all outstanding iterators.
   */
194 195
  guint chars_changed_stamp;
  /* Incremented when any segments are added or deleted;
196 197 198
   * this makes outstanding iterators recalculate their
   * pointed-to segment and segment offset.
   */
199
  guint segments_changed_stamp;
200

201 202 203
  /* Cache the last line in the buffer */
  GtkTextLine *last_line;
  guint last_line_stamp;
204

205 206 207 208 209 210 211
  /* Cache the next-to-last line in the buffer,
   * containing the end iterator
   */
  GtkTextLine *end_iter_line;
  GtkTextLineSegment *end_iter_segment;
  int end_iter_segment_byte_index;
  int end_iter_segment_char_offset;
212
  guint end_iter_line_stamp;
213 214
  guint end_iter_segment_stamp;
  
215
  GHashTable *child_anchor_table;
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
};


/*
 * Upper and lower bounds on how many children a node may have:
 * rebalance when either of these limits is exceeded.  MAX_CHILDREN
 * should be twice MIN_CHILDREN and MIN_CHILDREN must be >= 2.
 */

/* Tk used MAX of 12 and MIN of 6. This makes the tree wide and
   shallow. It appears to be faster to locate a particular line number
   if the tree is narrow and deep, since it is more finely sorted.  I
   guess this may increase memory use though, and make it slower to
   walk the tree in order, or locate a particular byte index (which
   is done by walking the tree in order).
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
   There's basically a tradeoff here. However I'm thinking we want to
   add pixels, byte counts, and char counts to the tree nodes,
   at that point narrow and deep should speed up all operations,
   not just the line number searches.
*/

#if 1
#define MAX_CHILDREN 12
#define MIN_CHILDREN 6
#else
#define MAX_CHILDREN 6
#define MIN_CHILDREN 3
#endif

/*
 * Prototypes
 */

static BTreeView        *gtk_text_btree_get_view                 (GtkTextBTree     *tree,
                                                                  gpointer          view_id);
static void              gtk_text_btree_rebalance                (GtkTextBTree     *tree,
                                                                  GtkTextBTreeNode *node);
static GtkTextLine     * get_last_line                           (GtkTextBTree     *tree);
static void              post_insert_fixup                       (GtkTextBTree     *tree,
                                                                  GtkTextLine      *insert_line,
                                                                  gint              char_count_delta,
                                                                  gint              line_count_delta);
static void              gtk_text_btree_node_adjust_toggle_count (GtkTextBTreeNode *node,
                                                                  GtkTextTagInfo   *info,
                                                                  gint              adjust);
static gboolean          gtk_text_btree_node_has_tag             (GtkTextBTreeNode *node,
                                                                  GtkTextTag       *tag);

static void             segments_changed                (GtkTextBTree     *tree);
static void             chars_changed                   (GtkTextBTree     *tree);
static void             summary_list_destroy            (Summary          *summary);
static GtkTextLine     *gtk_text_line_new               (void);
static void             gtk_text_line_destroy           (GtkTextBTree     *tree,
                                                         GtkTextLine      *line);
static void             gtk_text_line_set_parent        (GtkTextLine      *line,
                                                         GtkTextBTreeNode *node);
static void             gtk_text_btree_node_remove_data (GtkTextBTreeNode *node,
                                                         gpointer          view_id);


static NodeData         *node_data_new          (gpointer  view_id);
static void              node_data_destroy      (NodeData *nd);
static void              node_data_list_destroy (NodeData *nd);
static NodeData         *node_data_find         (NodeData *nd,
                                                 gpointer  view_id);

static GtkTextBTreeNode     *gtk_text_btree_node_new                  (void);
static void                  gtk_text_btree_node_invalidate_downward  (GtkTextBTreeNode *node);
static void                  gtk_text_btree_node_invalidate_upward    (GtkTextBTreeNode *node,
286
                                                                       gpointer          view_id);
287
static NodeData *            gtk_text_btree_node_check_valid          (GtkTextBTreeNode *node,
288
                                                                       gpointer          view_id);
289
static NodeData *            gtk_text_btree_node_check_valid_downward (GtkTextBTreeNode *node,
290
                                                                       gpointer          view_id);
291
static void                  gtk_text_btree_node_check_valid_upward   (GtkTextBTreeNode *node,
292
                                                                       gpointer          view_id);
293 294 295 296 297 298

static void                  gtk_text_btree_node_remove_view         (BTreeView        *view,
                                                                      GtkTextBTreeNode *node,
                                                                      gpointer          view_id);
static void                  gtk_text_btree_node_destroy             (GtkTextBTree     *tree,
                                                                      GtkTextBTreeNode *node);
Havoc Pennington's avatar
Havoc Pennington committed
299 300
static void                  gtk_text_btree_node_free_empty          (GtkTextBTree *tree,
                                                                      GtkTextBTreeNode *node);
301 302 303 304 305 306 307 308 309
static NodeData         *    gtk_text_btree_node_ensure_data         (GtkTextBTreeNode *node,
                                                                      gpointer          view_id);
static void                  gtk_text_btree_node_remove_data         (GtkTextBTreeNode *node,
                                                                      gpointer          view_id);
static void                  gtk_text_btree_node_get_size            (GtkTextBTreeNode *node,
                                                                      gpointer          view_id,
                                                                      gint             *width,
                                                                      gint             *height);
static GtkTextBTreeNode *    gtk_text_btree_node_common_parent       (GtkTextBTreeNode *node1,
310
                                                                      GtkTextBTreeNode *node2);
311 312 313 314 315 316 317 318 319
static void get_tree_bounds       (GtkTextBTree     *tree,
                                   GtkTextIter      *start,
                                   GtkTextIter      *end);
static void tag_changed_cb        (GtkTextTagTable  *table,
                                   GtkTextTag       *tag,
                                   gboolean          size_changed,
                                   GtkTextBTree     *tree);
static void cleanup_line          (GtkTextLine      *line);
static void recompute_node_counts (GtkTextBTree     *tree,
320
                                   GtkTextBTreeNode *node);
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
static void inc_count             (GtkTextTag       *tag,
                                   int               inc,
                                   TagInfo          *tagInfoPtr);

static void summary_destroy       (Summary          *summary);

static void gtk_text_btree_link_segment   (GtkTextLineSegment *seg,
                                           const GtkTextIter  *iter);
static void gtk_text_btree_unlink_segment (GtkTextBTree       *tree,
                                           GtkTextLineSegment *seg,
                                           GtkTextLine        *line);


static GtkTextTagInfo *gtk_text_btree_get_tag_info          (GtkTextBTree   *tree,
                                                             GtkTextTag     *tag);
static GtkTextTagInfo *gtk_text_btree_get_existing_tag_info (GtkTextBTree   *tree,
                                                             GtkTextTag     *tag);
static void            gtk_text_btree_remove_tag_info       (GtkTextBTree   *tree,
                                                             GtkTextTag     *tag);

Havoc Pennington's avatar
Havoc Pennington committed
341 342 343
static void redisplay_region (GtkTextBTree      *tree,
                              const GtkTextIter *start,
                              const GtkTextIter *end);
344 345 346 347

/* Inline thingies */

static inline void
348
segments_changed (GtkTextBTree *tree)
349 350 351 352 353
{
  tree->segments_changed_stamp += 1;
}

static inline void
354
chars_changed (GtkTextBTree *tree)
355 356 357 358 359 360 361 362 363
{
  tree->chars_changed_stamp += 1;
}

/*
 * BTree operations
 */

GtkTextBTree*
364
_gtk_text_btree_new (GtkTextTagTable *table,
365
                     GtkTextBuffer *buffer)
366 367 368 369 370
{
  GtkTextBTree *tree;
  GtkTextBTreeNode *root_node;
  GtkTextLine *line, *line2;

371 372 373
  g_return_val_if_fail (GTK_IS_TEXT_TAG_TABLE (table), NULL);
  g_return_val_if_fail (GTK_IS_TEXT_BUFFER (buffer), NULL);

374 375 376 377 378 379 380 381
  /*
   * The tree will initially have two empty lines.  The second line
   * isn't actually part of the tree's contents, but its presence
   * makes several operations easier.  The tree will have one GtkTextBTreeNode,
   * which is also the root of the tree.
   */

  /* Create the root node. */
382 383 384 385 386

  root_node = gtk_text_btree_node_new ();

  line = gtk_text_line_new ();
  line2 = gtk_text_line_new ();
387 388 389 390 391 392 393 394 395

  root_node->parent = NULL;
  root_node->next = NULL;
  root_node->summary = NULL;
  root_node->level = 0;
  root_node->children.line = line;
  root_node->num_children = 2;
  root_node->num_lines = 2;
  root_node->num_chars = 2;
396

397 398 399
  line->parent = root_node;
  line->next = line2;

400
  line->segments = _gtk_char_segment_new ("\n", 1);
401 402 403

  line2->parent = root_node;
  line2->next = NULL;
404
  line2->segments = _gtk_char_segment_new ("\n", 1);
405 406

  /* Create the tree itself */
407

408 409 410 411 412 413
  tree = g_new0(GtkTextBTree, 1);
  tree->root_node = root_node;
  tree->table = table;
  tree->views = NULL;

  /* Set these to values that are unlikely to be found
414 415 416 417 418
   * in random memory garbage, and also avoid
   * duplicates between tree instances.
   */
  tree->chars_changed_stamp = g_random_int ();
  tree->segments_changed_stamp = g_random_int ();
419

420 421 422
  tree->last_line_stamp = tree->chars_changed_stamp - 1;
  tree->last_line = NULL;

423
  tree->end_iter_line_stamp = tree->chars_changed_stamp - 1;
424
  tree->end_iter_segment_stamp = tree->segments_changed_stamp - 1;
425
  tree->end_iter_line = NULL;
426 427 428
  tree->end_iter_segment_byte_index = 0;
  tree->end_iter_segment_char_offset = 0;
  
Manish Singh's avatar
Manish Singh committed
429
  g_object_ref (tree->table);
430

Manish Singh's avatar
Manish Singh committed
431
  tree->tag_changed_handler = g_signal_connect (tree->table,
432 433 434 435
						"tag_changed",
						G_CALLBACK (tag_changed_cb),
						tree);

436
  tree->mark_table = g_hash_table_new (g_str_hash, g_str_equal);
437 438
  tree->child_anchor_table = NULL;
  
439
  /* We don't ref the buffer, since the buffer owns us;
440 441 442
   * we'd have some circularity issues. The buffer always
   * lasts longer than the BTree
   */
443
  tree->buffer = buffer;
444

445 446
  {
    GtkTextIter start;
Havoc Pennington's avatar
Havoc Pennington committed
447
    GtkTextLineSegment *seg;
448

449
    _gtk_text_btree_get_iter_at_line_char (tree, &start, 0, 0);
450

451

452
    tree->insert_mark = _gtk_text_btree_set_mark (tree,
Havoc Pennington's avatar
Havoc Pennington committed
453 454 455 456 457 458 459
                                                 NULL,
                                                 "insert",
                                                 FALSE,
                                                 &start,
                                                 FALSE);

    seg = tree->insert_mark->segment;
460

Havoc Pennington's avatar
Havoc Pennington committed
461 462
    seg->body.mark.not_deleteable = TRUE;
    seg->body.mark.visible = TRUE;
463

464
    tree->selection_bound_mark = _gtk_text_btree_set_mark (tree,
Havoc Pennington's avatar
Havoc Pennington committed
465 466 467 468 469 470 471
                                                          NULL,
                                                          "selection_bound",
                                                          FALSE,
                                                          &start,
                                                          FALSE);

    seg = tree->selection_bound_mark->segment;
472

Havoc Pennington's avatar
Havoc Pennington committed
473 474
    seg->body.mark.not_deleteable = TRUE;

Manish Singh's avatar
Manish Singh committed
475 476
    g_object_ref (tree->insert_mark);
    g_object_ref (tree->selection_bound_mark);
477 478 479
  }

  tree->refcount = 1;
480

481 482 483 484
  return tree;
}

void
485
_gtk_text_btree_ref (GtkTextBTree *tree)
486
{
487 488 489
  g_return_if_fail (tree != NULL);
  g_return_if_fail (tree->refcount > 0);

490 491 492 493
  tree->refcount += 1;
}

void
494
_gtk_text_btree_unref (GtkTextBTree *tree)
495
{
496 497
  g_return_if_fail (tree != NULL);
  g_return_if_fail (tree->refcount > 0);
498 499 500 501

  tree->refcount -= 1;

  if (tree->refcount == 0)
502
    {      
Manish Singh's avatar
Manish Singh committed
503
      g_signal_handler_disconnect (tree->table,
504
                                   tree->tag_changed_handler);
505

Manish Singh's avatar
Manish Singh committed
506
      g_object_unref (tree->table);
507 508 509 510 511
      tree->table = NULL;
      
      gtk_text_btree_node_destroy (tree, tree->root_node);
      tree->root_node = NULL;
      
Havoc Pennington's avatar
Havoc Pennington committed
512
      g_assert (g_hash_table_size (tree->mark_table) == 0);
Havoc Pennington's avatar
Havoc Pennington committed
513
      g_hash_table_destroy (tree->mark_table);
514
      tree->mark_table = NULL;
515 516 517 518 519 520
      if (tree->child_anchor_table != NULL) 
	{
	  g_hash_table_destroy (tree->child_anchor_table);
	  tree->child_anchor_table = NULL;
	}

Manish Singh's avatar
Manish Singh committed
521
      g_object_unref (tree->insert_mark);
522
      tree->insert_mark = NULL;
Manish Singh's avatar
Manish Singh committed
523
      g_object_unref (tree->selection_bound_mark);
524
      tree->selection_bound_mark = NULL;
525

Havoc Pennington's avatar
Havoc Pennington committed
526
      g_free (tree);
527 528 529 530
    }
}

GtkTextBuffer*
531
_gtk_text_btree_get_buffer (GtkTextBTree *tree)
532 533 534 535 536
{
  return tree->buffer;
}

guint
537
_gtk_text_btree_get_chars_changed_stamp (GtkTextBTree *tree)
538 539 540 541 542
{
  return tree->chars_changed_stamp;
}

guint
543
_gtk_text_btree_get_segments_changed_stamp (GtkTextBTree *tree)
544 545 546 547 548
{
  return tree->segments_changed_stamp;
}

void
549
_gtk_text_btree_segments_changed (GtkTextBTree *tree)
550
{
551 552
  g_return_if_fail (tree != NULL);
  segments_changed (tree);
553 554 555 556 557 558
}

/*
 * Indexable segment mutation
 */

559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
/*
 *  The following function is responsible for resolving the bidi direction
 *  for the lines between start and end. But it also calculates any
 *  dependent bidi direction for surrounding lines that change as a result
 *  of the bidi direction decisions within the range. The function is
 *  trying to do as little propagation as is needed.
 */
static void
gtk_text_btree_resolve_bidi (GtkTextIter *start,
			     GtkTextIter *end)
{
  GtkTextBTree *tree = _gtk_text_iter_get_btree (start);
  GtkTextLine *start_line, *end_line, *start_line_prev, *end_line_next, *line;
  PangoDirection last_strong, dir_above_propagated, dir_below_propagated;

  /* Resolve the strong bidi direction for all lines between
   * start and end.
  */
  start_line = _gtk_text_iter_get_text_line (start);
  start_line_prev = _gtk_text_line_previous (start_line);
  end_line = _gtk_text_iter_get_text_line (end);
  end_line_next = _gtk_text_line_next (end_line);
  
  line = start_line;
  while (line && line != end_line_next)
    {
      /* Loop through the segments and search for a strong character
       */
      GtkTextLineSegment *seg = line->segments;
      line->dir_strong = PANGO_DIRECTION_NEUTRAL;
      
      while (seg)
        {
592
          if (seg->type == &gtk_text_char_type && seg->byte_count > 0)
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
            {
	      PangoDirection pango_dir;

              pango_dir = pango_find_base_dir (seg->body.chars,
					       seg->byte_count);
	      
              if (pango_dir != PANGO_DIRECTION_NEUTRAL)
                {
                  line->dir_strong = pango_dir;
                  break;
                }
            }
          seg = seg->next;
        }

      line = _gtk_text_line_next (line);
    }

  /* Sweep forward */

  /* The variable dir_above_propagated contains the forward propagated
   * direction before start. It is neutral if start is in the beginning
   * of the buffer.
   */
  dir_above_propagated = PANGO_DIRECTION_NEUTRAL;
  if (start_line_prev)
    dir_above_propagated = start_line_prev->dir_propagated_forward;

  /* Loop forward and propagate the direction of each paragraph 
   * to all neutral lines.
   */
  line = start_line;
  last_strong = dir_above_propagated;
  while (line != end_line_next)
    {
      if (line->dir_strong != PANGO_DIRECTION_NEUTRAL)
        last_strong = line->dir_strong;
      
      line->dir_propagated_forward = last_strong;
      
      line = _gtk_text_line_next (line);
    }

  /* Continue propagating as long as the previous resolved forward
   * is different from last_strong.
   */
  {
    GtkTextIter end_propagate;
    
    while (line &&
	   line->dir_strong == PANGO_DIRECTION_NEUTRAL &&
	   line->dir_propagated_forward != last_strong)
      {
        GtkTextLine *prev = line;
        line->dir_propagated_forward = last_strong;
        
        line = _gtk_text_line_next(line);
        if (!line)
          {
            line = prev;
            break;
          }
      }

    /* The last line to invalidate is the last line before the
     * line with the strong character. Or in case of the end of the
     * buffer, the last line of the buffer. (There seems to be an
     * extra "virtual" last line in the buffer that must not be used
     * calling _gtk_text_btree_get_iter_at_line (causes crash). Thus the
     * _gtk_text_line_previous is ok in that case as well.)
     */
    line = _gtk_text_line_previous (line);
    _gtk_text_btree_get_iter_at_line (tree, &end_propagate, line, 0);
    _gtk_text_btree_invalidate_region (tree, end, &end_propagate);
  }
  
  /* Sweep backward */

  /* The variable dir_below_propagated contains the backward propagated
   * direction after end. It is neutral if end is at the end of
   * the buffer.
  */
  dir_below_propagated = PANGO_DIRECTION_NEUTRAL;
  if (end_line_next)
    dir_below_propagated = end_line_next->dir_propagated_back;

  /* Loop backward and propagate the direction of each paragraph 
   * to all neutral lines.
   */
  line = end_line;
  last_strong = dir_below_propagated;
  while (line != start_line_prev)
    {
      if (line->dir_strong != PANGO_DIRECTION_NEUTRAL)
        last_strong = line->dir_strong;

      line->dir_propagated_back = last_strong;

      line = _gtk_text_line_previous (line);
    }

  /* Continue propagating as long as the resolved backward dir
   * is different from last_strong.
   */
  {
    GtkTextIter start_propagate;

    while (line &&
	   line->dir_strong == PANGO_DIRECTION_NEUTRAL &&
	   line->dir_propagated_back != last_strong)
      {
        GtkTextLine *prev = line;
        line->dir_propagated_back = last_strong;

        line = _gtk_text_line_previous (line);
        if (!line)
          {
            line = prev;
            break;
          }
      }

    /* We only need to invalidate for backwards propagation if the
     * line we ended up on didn't get a direction from forwards
     * propagation.
     */
    if (line && line->dir_propagated_forward == PANGO_DIRECTION_NEUTRAL)
      {
        _gtk_text_btree_get_iter_at_line (tree, &start_propagate, line, 0);
        _gtk_text_btree_invalidate_region(tree, &start_propagate, start);
      }
  }
}

727
void
728
_gtk_text_btree_delete (GtkTextIter *start,
729
                        GtkTextIter *end)
730 731 732 733 734
{
  GtkTextLineSegment *prev_seg;             /* The segment just before the start
                                             * of the deletion range. */
  GtkTextLineSegment *last_seg;             /* The segment just after the end
                                             * of the deletion range. */
735
  GtkTextLineSegment *seg, *next, *next2;
736 737 738 739 740
  GtkTextLine *curline;
  GtkTextBTreeNode *curnode, *node;
  GtkTextBTree *tree;
  GtkTextLine *start_line;
  GtkTextLine *end_line;
741
  GtkTextLine *deleted_lines = NULL;        /* List of lines we've deleted */
742
  gint start_byte_offset;
743 744 745

  g_return_if_fail (start != NULL);
  g_return_if_fail (end != NULL);
746 747
  g_return_if_fail (_gtk_text_iter_get_btree (start) ==
                    _gtk_text_iter_get_btree (end));
748

749
  gtk_text_iter_order (start, end);
750

751
  tree = _gtk_text_iter_get_btree (start);
752 753 754 755
 
  if (gtk_debug_flags & GTK_DEBUG_TEXT)
    _gtk_text_btree_check (tree);
  
756
  /* Broadcast the need for redisplay before we break the iterators */
757
  DV (g_print ("invalidating due to deleting some text (%s)\n", G_STRLOC));
758
  _gtk_text_btree_invalidate_region (tree, start, end);
759 760

  /* Save the byte offset so we can reset the iterators */
761 762
  start_byte_offset = gtk_text_iter_get_line_index (start);

763 764
  start_line = _gtk_text_iter_get_text_line (start);
  end_line = _gtk_text_iter_get_text_line (end);
765

766 767 768 769 770 771 772 773 774
  /*
   * Split the start and end segments, so we have a place
   * to insert our new text.
   *
   * Tricky point:  split at end first;  otherwise the split
   * at end may invalidate seg and/or prev_seg. This allows
   * us to avoid invalidating segments for start.
   */

775
  last_seg = gtk_text_line_segment_split (end);
776 777 778 779 780
  if (last_seg != NULL)
    last_seg = last_seg->next;
  else
    last_seg = end_line->segments;

781
  prev_seg = gtk_text_line_segment_split (start);
782 783 784 785 786 787 788 789 790 791 792 793 794
  if (prev_seg != NULL)
    {
      seg = prev_seg->next;
      prev_seg->next = last_seg;
    }
  else
    {
      seg = start_line->segments;
      start_line->segments = last_seg;
    }

  /* notify iterators that their segments need recomputation,
     just for robustness. */
795 796
  segments_changed (tree);

797 798 799 800 801 802 803 804 805
  /*
   * Delete all of the segments between prev_seg and last_seg.
   */

  curline = start_line;
  curnode = curline->parent;
  while (seg != last_seg)
    {
      gint char_count = 0;
806

807 808 809 810 811 812 813 814 815 816
      if (seg == NULL)
        {
          GtkTextLine *nextline;

          /*
           * We just ran off the end of a line.  First find the
           * next line, then go back to the old line and delete it
           * (unless it's the starting line for the range).
           */

817
          nextline = _gtk_text_line_next (curline);
818 819 820 821 822 823
          if (curline != start_line)
            {
              if (curnode == start_line->parent)
                start_line->next = curline->next;
              else
                curnode->children.line = curline->next;
824

825 826 827
              for (node = curnode; node != NULL;
                   node = node->parent)
                {
828 829 830
                  /* Don't update node->num_chars, because
                   * that was done when we deleted the segments.
                   */
831 832
                  node->num_lines -= 1;
                }
833

834
              curnode->num_children -= 1;
835 836
              curline->next = deleted_lines;
              deleted_lines = curline;
837
            }
838

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
          curline = nextline;
          seg = curline->segments;

          /*
           * If the GtkTextBTreeNode is empty then delete it and its parents,
           * recursively upwards until a non-empty GtkTextBTreeNode is found.
           */

          while (curnode->num_children == 0)
            {
              GtkTextBTreeNode *parent;

              parent = curnode->parent;
              if (parent->children.node == curnode)
                {
                  parent->children.node = curnode->next;
                }
              else
                {
                  GtkTextBTreeNode *prevnode = parent->children.node;
                  while (prevnode->next != curnode)
                    {
                      prevnode = prevnode->next;
                    }
                  prevnode->next = curnode->next;
                }
              parent->num_children--;
Havoc Pennington's avatar
Havoc Pennington committed
866
              gtk_text_btree_node_free_empty (tree, curnode);
867 868 869 870 871 872 873 874
              curnode = parent;
            }
          curnode = curline->parent;
          continue;
        }

      next = seg->next;
      char_count = seg->char_count;
875

Havoc Pennington's avatar
Havoc Pennington committed
876
      if ((*seg->type->deleteFunc)(seg, curline, FALSE) != 0)
877 878 879 880 881
        {
          /*
           * This segment refuses to die.  Move it to prev_seg and
           * advance prev_seg if the segment has left gravity.
           */
882

883 884 885 886 887
          if (prev_seg == NULL)
            {
              seg->next = start_line->segments;
              start_line->segments = seg;
            }
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
          else if (prev_seg->next &&
		   seg->type == &gtk_text_toggle_off_type &&
		   prev_seg->next->type == &gtk_text_toggle_on_type &&
		   seg->body.toggle.info == prev_seg->next->body.toggle.info)
	    {
	      /* Try to match an off toggle with the matching on toggle
	       * if it immediately follows. This is a common case, and
	       * handling it here prevents quadratic blowup in
	       * cleanup_line() below. See bug 317125.
	       */
	      next2 = prev_seg->next->next;
	      g_free ((char *)prev_seg->next);
	      prev_seg->next = next2;
	      g_free ((char *)seg);
	      seg = NULL;
	    }
	  else
	    {
906 907 908
              seg->next = prev_seg->next;
              prev_seg->next = seg;
            }
909 910

          if (seg && seg->type->leftGravity)
911 912 913 914 915 916 917 918 919 920 921 922 923 924
            {
              prev_seg = seg;
            }
        }
      else
        {
          /* Segment is gone. Decrement the char count of the node and
             all its parents. */
          for (node = curnode; node != NULL;
               node = node->parent)
            {
              node->num_chars -= char_count;
            }
        }
925

926 927 928 929 930 931 932 933 934 935 936 937 938
      seg = next;
    }

  /*
   * If the beginning and end of the deletion range are in different
   * lines, join the two lines together and discard the ending line.
   */

  if (start_line != end_line)
    {
      BTreeView *view;
      GtkTextBTreeNode *ancestor_node;
      GtkTextLine *prevline;
939
      int chars_moved;      
940

941 942
      /* last_seg was appended to start_line up at the top of this function */
      chars_moved = 0;
943 944 945
      for (seg = last_seg; seg != NULL;
           seg = seg->next)
        {
946
          chars_moved += seg->char_count;
947 948 949 950 951
          if (seg->type->lineChangeFunc != NULL)
            {
              (*seg->type->lineChangeFunc)(seg, end_line);
            }
        }
952 953 954 955 956 957 958

      for (node = start_line->parent; node != NULL;
           node = node->parent)
        {
          node->num_chars += chars_moved;
        }
      
959 960 961 962
      curnode = end_line->parent;
      for (node = curnode; node != NULL;
           node = node->parent)
        {
963
          node->num_chars -= chars_moved;
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
          node->num_lines--;
        }
      curnode->num_children--;
      prevline = curnode->children.line;
      if (prevline == end_line)
        {
          curnode->children.line = end_line->next;
        }
      else
        {
          while (prevline->next != end_line)
            {
              prevline = prevline->next;
            }
          prevline->next = end_line->next;
        }
      end_line->next = deleted_lines;
      deleted_lines = end_line;

      /* We now fix up the per-view aggregates. We add all the height and
       * width for the deleted lines to the start line, so that when revalidation
       * occurs, the correct change in size is seen.
       */
      ancestor_node = gtk_text_btree_node_common_parent (curnode, start_line->parent);
      view = tree->views;
      while (view)
990 991 992 993 994 995 996 997 998 999 1000
        {
          GtkTextLine *line;
          GtkTextLineData *ld;

          gint deleted_width = 0;
          gint deleted_height = 0;

          line = deleted_lines;
          while (line)
            {
              GtkTextLine *next_line = line->next;
1001
              ld = _gtk_text_line_get_data (line, view->view_id);
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016

              if (ld)
                {
                  deleted_width = MAX (deleted_width, ld->width);
                  deleted_height += ld->height;
                }

              if (!view->next)
                gtk_text_line_destroy (tree, line);

              line = next_line;
            }

          if (deleted_width > 0 || deleted_height > 0)
            {
1017
              ld = _gtk_text_line_get_data (start_line, view->view_id);
1018 1019 1020 1021 1022 1023 1024 1025
              
              if (ld == NULL)
                {
                  /* This means that start_line has never been validated.
                   * We don't really want to do the validation here but
                   * we do need to store our temporary sizes. So we
                   * create the line data and assume a line w/h of 0.
                   */
1026 1027
                  ld = _gtk_text_line_data_new (view->layout, start_line);
                  _gtk_text_line_add_data (start_line, ld);
1028 1029 1030 1031 1032
                  ld->width = 0;
                  ld->height = 0;
                  ld->valid = FALSE;
                }
              
1033 1034 1035 1036 1037 1038 1039 1040
              ld->width = MAX (deleted_width, ld->width);
              ld->height += deleted_height;
              ld->valid = FALSE;
            }

          gtk_text_btree_node_check_valid_downward (ancestor_node, view->view_id);
          if (ancestor_node->parent)
            gtk_text_btree_node_check_valid_upward (ancestor_node->parent, view->view_id);
1041

1042 1043 1044
          view = view->next;
        }

1045 1046 1047
      /* avoid dangling pointer */
      deleted_lines = NULL;
      
1048
      gtk_text_btree_rebalance (tree, curnode);
1049 1050 1051 1052 1053 1054
    }

  /*
   * Cleanup the segments in the new line.
   */

1055
  cleanup_line (start_line);
1056 1057 1058 1059 1060

  /*
   * Lastly, rebalance the first GtkTextBTreeNode of the range.
   */

1061 1062
  gtk_text_btree_rebalance (tree, start_line->parent);

1063 1064
  /* Notify outstanding iterators that they
     are now hosed */
1065 1066
  chars_changed (tree);
  segments_changed (tree);
1067 1068

  if (gtk_debug_flags & GTK_DEBUG_TEXT)
1069
    _gtk_text_btree_check (tree);
1070 1071

  /* Re-initialize our iterators */
1072
  _gtk_text_btree_get_iter_at_line (tree, start, start_line, start_byte_offset);
1073
  *end = *start;
1074 1075

  gtk_text_btree_resolve_bidi (start, end);
1076 1077 1078
}

void
1079
_gtk_text_btree_insert (GtkTextIter *iter,
1080 1081
                        const gchar *text,
                        gint         len)
1082 1083 1084 1085 1086
{
  GtkTextLineSegment *prev_seg;     /* The segment just before the first
                                     * new segment (NULL means new segment
                                     * is at beginning of line). */
  GtkTextLineSegment *cur_seg;              /* Current segment;  new characters
1087
                                             * are inserted just after this one.
1088 1089 1090 1091 1092 1093
                                             * NULL means insert at beginning of
                                             * line. */
  GtkTextLine *line;           /* Current line (new segments are
                                * added to this line). */
  GtkTextLineSegment *seg;
  GtkTextLine *newline;
Havoc Pennington's avatar
Havoc Pennington committed
1094 1095 1096 1097 1098 1099
  int chunk_len;                        /* # characters in current chunk. */
  gint sol;                           /* start of line */
  gint eol;                           /* Pointer to character just after last
                                       * one in current chunk.
                                       */
  gint delim;                          /* index of paragraph delimiter */
1100
  int line_count_delta;                /* Counts change to total number of
Havoc Pennington's avatar
Havoc Pennington committed
1101 1102
                                        * lines in file.
                                        */
1103 1104 1105 1106 1107

  int char_count_delta;                /* change to number of chars */
  GtkTextBTree *tree;
  gint start_byte_index;
  GtkTextLine *start_line;
1108 1109 1110 1111

  g_return_if_fail (text != NULL);
  g_return_if_fail (iter != NULL);

1112
  if (len < 0)
1113
    len = strlen (text);
1114 1115

  /* extract iterator info */
1116 1117
  tree = _gtk_text_iter_get_btree (iter);
  line = _gtk_text_iter_get_text_line (iter);
1118
  
1119
  start_line = line;
1120
  start_byte_index = gtk_text_iter_get_line_index (iter);
1121

1122 1123 1124 1125 1126
  /* Get our insertion segment split. Note this assumes line allows
   * char insertions, which isn't true of the "last" line. But iter
   * should not be on that line, as we assert here.
   */
  g_assert (!_gtk_text_line_is_last (line, tree));
1127
  prev_seg = gtk_text_line_segment_split (iter);
1128 1129 1130
  cur_seg = prev_seg;

  /* Invalidate all iterators */
1131 1132
  chars_changed (tree);
  segments_changed (tree);
1133
  
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
  /*
   * Chop the text up into lines and create a new segment for
   * each line, plus a new line for the leftovers from the
   * previous line.
   */

  eol = 0;
  sol = 0;
  line_count_delta = 0;
  char_count_delta = 0;
  while (eol < len)
    {
1146 1147
      sol = eol;
      
Havoc Pennington's avatar
Havoc Pennington committed
1148 1149 1150 1151
      pango_find_paragraph_boundary (text + sol,
                                     len - sol,
                                     &delim,
                                     &eol);      
1152

1153 1154 1155
      /* make these relative to the start of the text */
      delim += sol;
      eol += sol;
1156 1157 1158 1159 1160 1161

      g_assert (eol >= sol);
      g_assert (delim >= sol);
      g_assert (eol >= delim);
      g_assert (sol >= 0);
      g_assert (eol <= len);
1162
      
Havoc Pennington's avatar
Havoc Pennington committed
1163
      chunk_len = eol - sol;
1164 1165

      g_assert (g_utf8_validate (&text[sol], chunk_len, NULL));
Havoc Pennington's avatar
Havoc Pennington committed
1166
      seg = _gtk_char_segment_new (&text[sol], chunk_len);
1167 1168

      char_count_delta += seg->char_count;
1169

1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
      if (cur_seg == NULL)
        {
          seg->next = line->segments;
          line->segments = seg;
        }
      else
        {
          seg->next = cur_seg->next;
          cur_seg->next = seg;
        }

Havoc Pennington's avatar
Havoc Pennington committed
1181
      if (delim == eol)
1182 1183 1184 1185 1186
        {
          /* chunk didn't end with a paragraph separator */
          g_assert (eol == len);
          break;
        }
1187 1188 1189 1190 1191 1192

      /*
       * The chunk ended with a newline, so create a new GtkTextLine
       * and move the remainder of the old line to it.
       */

1193 1194
      newline = gtk_text_line_new ();
      gtk_text_line_set_parent (newline, line->parent);
1195 1196 1197 1198 1199 1200
      newline->next = line->next;
      line->next = newline;
      newline->segments = seg->next;
      seg->next = NULL;
      line = newline;
      cur_seg = NULL;
1201
      line_count_delta++;
1202 1203 1204 1205 1206 1207 1208
    }

  /*
   * Cleanup the starting line for the insertion, plus the ending
   * line if it's different.
   */

1209
  cleanup_line (start_line);
1210 1211
  if (line != start_line)
    {
1212
      cleanup_line (line);
1213 1214
    }

1215 1216
  post_insert_fixup (tree, line, line_count_delta, char_count_delta);

1217 1218 1219 1220