atk/atktext.c

   1 /* ATK - The Accessibility Toolkit for GTK+
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21
  22 #include "atk.h"
  23 #include "atkmarshal.h"
  24
  25 #include <string.h>
  26
  27 /**
  28  * SECTION:atktext
  29  * @Short_description: The ATK interface implemented by components
  30  *  with text content.
  31  * @Title:AtkText
  32  *
  33  * #AtkText should be implemented by #AtkObjects on behalf of widgets
  34  * that have text content which is either attributed or otherwise
  35  * non-trivial.  #AtkObjects whose text content is simple,
  36  * unattributed, and very brief may expose that content via
  37  * #atk_object_get_name instead; however if the text is editable,
  38  * multi-line, typically longer than three or four words, attributed,
  39  * selectable, or if the object already uses the 'name' ATK property
  40  * for other information, the #AtkText interface should be used to
  41  * expose the text content.  In the case of editable text content,
  42  * #AtkEditableText (a subtype of the #AtkText interface) should be
  43  * implemented instead.
  44  *
  45  *  #AtkText provides not only traversal facilities and change
  46  * notification for text content, but also caret tracking and glyph
  47  * bounding box calculations.  Note that the text strings are exposed
  48  * as UTF-8, and are therefore potentially multi-byte, and
  49  * caret-to-byte offset mapping makes no assumptions about the
  50  * character length; also bounding box glyph-to-offset mapping may be
  51  * complex for languages which use ligatures.
  52  */
  53
  54 static GPtrArray *extra_attributes = NULL;
  55
  56 enum {
  57   TEXT_CHANGED,
  58   TEXT_CARET_MOVED,
  59   TEXT_SELECTION_CHANGED,
  60   TEXT_ATTRIBUTES_CHANGED,
  61   TEXT_INSERT,
  62   TEXT_REMOVE,
  63   LAST_SIGNAL
  64 };
  65
  66 static const char boolean[] =
  67   "false\0"
  68   "true";
  69 static const guint8 boolean_offsets[] = {
  70   0, 6
  71 };
  72
  73 static const char style[] =
  74   "normal\0"
  75   "oblique\0"
  76   "italic";
  77 static const guint8 style_offsets[] = {
  78   0, 7, 15
  79 };
  80
  81 static const char variant[] =
  82   "normal\0"
  83   "small_caps";
  84 static const guint8 variant_offsets[] = {
  85   0, 7
  86 };
  87
  88 static const char stretch[] =
  89   "ultra_condensed\0"
  90   "extra_condensed\0"
  91   "condensed\0"
  92   "semi_condensed\0"
  93   "normal\0"
  94   "semi_expanded\0"
  95   "expanded\0"
  96   "extra_expanded\0"
  97   "ultra_expanded";
  98 static const guint8 stretch_offsets[] = {
  99   0, 16, 32, 42, 57, 64, 78, 87, 102
 100 };
 101
 102 static const char justification[] =
 103   "left\0"
 104   "right\0"
 105   "center\0"
 106   "fill";
 107 static const guint8 justification_offsets[] = {
 108   0, 5, 11, 18
 109 };
 110
 111 static const char direction[] =
 112   "none\0"
 113   "ltr\0"
 114   "rtl";
 115 static const guint8 direction_offsets[] = {
 116   0, 5, 9
 117 };
 118
 119 static const char wrap_mode[] =
 120   "none\0"
 121   "char\0"
 122   "word\0"
 123   "word_char";
 124 static const guint8 wrap_mode_offsets[] = {
 125   0, 5, 10, 15
 126 };
 127
 128 static const char underline[] =
 129   "none\0"
 130   "single\0"
 131   "double\0"
 132   "low\0"
 133   "error";
 134 static const guint8 underline_offsets[] = {
 135   0, 5, 12, 19, 23
 136 };
 137
 138 static void atk_text_base_init (AtkTextIface *class);
 139
 140 static void atk_text_real_get_range_extents  (AtkText          *text,
 141                                               gint             start_offset,
 142                                               gint             end_offset,
 143                                               AtkCoordType     coord_type,
 144                                               AtkTextRectangle *rect);
 145
 146 static AtkTextRange** atk_text_real_get_bounded_ranges (AtkText          *text,
 147                                                         AtkTextRectangle *rect,
 148                                                         AtkCoordType     coord_type,
 149                                                         AtkTextClipType  x_clip_type,
 150                                                         AtkTextClipType  y_clip_type);
 151
 152 static guint atk_text_signals[LAST_SIGNAL] = { 0 };
 153
 154 GType
 155 atk_text_get_type (void)
 156 {
 157   static GType type = 0;
 158
 159   if (!type)
 160     {
 161       static const GTypeInfo tinfo =
 162       {
 163         sizeof (AtkTextIface),
 164         (GBaseInitFunc) atk_text_base_init,
 165         (GBaseFinalizeFunc) NULL,
 166         (GClassInitFunc) NULL /* atk_text_interface_init */ ,
 167         (GClassFinalizeFunc) NULL,
 168
 169       };
 170
 171       type = g_type_register_static (G_TYPE_INTERFACE, "AtkText", &tinfo, 0);
 172     }
 173
 174   return type;
 175 }
 176
 177 static void
 178 atk_text_base_init (AtkTextIface *class)
 179 {
 180   static gboolean initialized = FALSE;
 181
 182   if (! initialized)
 183     {
 184       /*
 185        * Note that text_changed signal supports details "insert", "delete",
 186        * possibly "replace".
 187        */
 188
 189       class->get_range_extents = atk_text_real_get_range_extents;
 190       class->get_bounded_ranges = atk_text_real_get_bounded_ranges;
 191
 192       /**
 193        * AtkText::text-changed:
 194        * @atktext: the object which received the signal.
 195        * @arg1: The position (character offset) of the insertion or deletion.
 196        * @arg2: The length (in characters) of text inserted or deleted.
 197        *
 198        * The "text-changed" signal is emitted when the text of the
 199        * object which implements the AtkText interface changes, This
 200        * signal will have a detail which is either "insert" or
 201        * "delete" which identifies whether the text change was an
 202        * insertion or a deletion.
 203        *
 204        * Deprecated: Since 2.9.4. Use #AtkObject::text-insert or
 205        * #AtkObject::text-remove instead.
 206        */
 207       atk_text_signals[TEXT_CHANGED] =
 208         g_signal_new ("text_changed",
 209                       ATK_TYPE_TEXT,
 210                       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
 211                       G_STRUCT_OFFSET (AtkTextIface, text_changed),
 212                       (GSignalAccumulator) NULL, NULL,
 213                       atk_marshal_VOID__INT_INT,
 214                       G_TYPE_NONE,
 215                       2, G_TYPE_INT, G_TYPE_INT);
 216
 217       /**
 218        * AtkText::text-insert:
 219        * @atktext: the object which received the signal.
 220        * @arg1: The position (character offset) of the insertion.
 221        * @arg2: The length (in characters) of text inserted.
 222        * @arg3: The new text inserted
 223        *
 224        * The "text-insert" signal is emitted when a new text is
 225        * inserted. If the signal was not triggered by the user
 226        * (e.g. typing or pasting text), the "system" detail should be
 227        * included.
 228        */
 229       atk_text_signals[TEXT_INSERT] =
 230         g_signal_new ("text_insert",
 231                       ATK_TYPE_TEXT,
 232                       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
 233                       0,
 234                       (GSignalAccumulator) NULL, NULL,
 235                       atk_marshal_VOID__INT_INT_STRING,
 236                       G_TYPE_NONE,
 237                       3, G_TYPE_INT, G_TYPE_INT, G_TYPE_STRING);
 238
 239       /**
 240        * AtkText::text-remove:
 241        * @atktext: the object which received the signal.
 242        * @arg1: The position (character offset) of the removal.
 243        * @arg2: The length (in characters) of text removed.
 244        * @arg3: The old text removed
 245        *
 246        * The "text-remove" signal is emitted when a new text is
 247        * removed. If the signal was not triggered by the user
 248        * (e.g. typing or pasting text), the "system" detail should be
 249        * included.
 250        */
 251       atk_text_signals[TEXT_REMOVE] =
 252         g_signal_new ("text_remove",
 253                       ATK_TYPE_TEXT,
 254                       G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
 255                       0,
 256                       (GSignalAccumulator) NULL, NULL,
 257                       atk_marshal_VOID__INT_INT_STRING,
 258                       G_TYPE_NONE,
 259                       3, G_TYPE_INT, G_TYPE_INT, G_TYPE_STRING);
 260
 261       /**
 262        * AtkText::text-caret-moved:
 263        * @atktext: the object which received the signal.
 264        * @arg1: The new position of the text caret.
 265        *
 266        * The "text-caret-moved" signal is emitted when the caret
 267        * position of the text of an object which implements AtkText
 268        * changes.
 269        */
 270       atk_text_signals[TEXT_CARET_MOVED] =
 271         g_signal_new ("text_caret_moved",
 272                       ATK_TYPE_TEXT,
 273                       G_SIGNAL_RUN_LAST,
 274                       G_STRUCT_OFFSET (AtkTextIface, text_caret_moved),
 275                       (GSignalAccumulator) NULL, NULL,
 276                       g_cclosure_marshal_VOID__INT,
 277                       G_TYPE_NONE,
 278                       1, G_TYPE_INT);
 279
 280       /**
 281        * AtkText::text-selection-changed:
 282        * @atktext: the object which received the signal.
 283        *
 284        * The "text-selection-changed" signal is emitted when the
 285        * selected text of an object which implements AtkText changes.
 286        */
 287       atk_text_signals[TEXT_SELECTION_CHANGED] =
 288         g_signal_new ("text_selection_changed",
 289                       ATK_TYPE_TEXT,
 290                       G_SIGNAL_RUN_LAST,
 291                       G_STRUCT_OFFSET (AtkTextIface, text_selection_changed),
 292                       (GSignalAccumulator) NULL, NULL,
 293                       g_cclosure_marshal_VOID__VOID,
 294                       G_TYPE_NONE, 0);
 295       /**
 296        * AtkText::text-attributes-changed:
 297        * @atktext: the object which received the signal.
 298        *
 299        * The "text-attributes-changed" signal is emitted when the text
 300        * attributes of the text of an object which implements AtkText
 301        * changes.
 302        */
 303       atk_text_signals[TEXT_ATTRIBUTES_CHANGED] =
 304         g_signal_new ("text_attributes_changed",
 305                       ATK_TYPE_TEXT,
 306                       G_SIGNAL_RUN_LAST,
 307                       G_STRUCT_OFFSET (AtkTextIface, text_attributes_changed),
 308                       (GSignalAccumulator) NULL, NULL,
 309                       g_cclosure_marshal_VOID__VOID,
 310                       G_TYPE_NONE, 0);
 311
 312
 313       initialized = TRUE;
 314     }
 315 }
 316
 317 /**
 318  * atk_text_get_text:
 319  * @text: an #AtkText
 320  * @start_offset: start position
 321  * @end_offset: end position, or -1 for the end of the string.
 322  *
 323  * Gets the specified text.
 324  *
 325  * Returns: a newly allocated string containing the text from @start_offset up
 326  *   to, but not including @end_offset. Use g_free() to free the returned string.
 327  **/
 328 gchar*
 329 atk_text_get_text (AtkText      *text,
 330                    gint         start_offset,
 331                    gint         end_offset)
 332 {
 333   AtkTextIface *iface;
 334
 335   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 336
 337   iface = ATK_TEXT_GET_IFACE (text);
 338
 339   if (start_offset < 0 || end_offset < -1 ||
 340       (end_offset != -1 && end_offset < start_offset))
 341     return NULL;
 342
 343   if (iface->get_text)
 344     return (*(iface->get_text)) (text, start_offset, end_offset);
 345   else
 346     return NULL;
 347 }
 348
 349 /**
 350  * atk_text_get_character_at_offset:
 351  * @text: an #AtkText
 352  * @offset: position
 353  *
 354  * Gets the specified text.
 355  *
 356  * Returns: the character at @offset.
 357  **/
 358 gunichar
 359 atk_text_get_character_at_offset (AtkText      *text,
 360                                   gint         offset)
 361 {
 362   AtkTextIface *iface;
 363
 364   g_return_val_if_fail (ATK_IS_TEXT (text), (gunichar) 0);
 365
 366   iface = ATK_TEXT_GET_IFACE (text);
 367
 368   if (iface->get_character_at_offset)
 369     return (*(iface->get_character_at_offset)) (text, offset);
 370   else
 371     return (gunichar) 0;
 372 }
 373
 374 /**
 375  * atk_text_get_text_after_offset:
 376  * @text: an #AtkText
 377  * @offset: position
 378  * @boundary_type: An #AtkTextBoundary
 379  * @start_offset: (out): the start offset of the returned string
 380  * @end_offset: (out): the offset of the first character after the
 381  *              returned substring
 382  *
 383  * Gets the specified text.
 384  *
 385  * Deprecated: This method is deprecated since ATK version
 386  * 2.9.3. Please use atk_text_get_string_at_offset() instead.
 387  *
 388  * Returns: a newly allocated string containing the text after @offset bounded
 389  *   by the specified @boundary_type. Use g_free() to free the returned string.
 390  **/
 391 gchar*
 392 atk_text_get_text_after_offset (AtkText          *text,
 393                                 gint             offset,
 394                                 AtkTextBoundary  boundary_type,
 395                                 gint             *start_offset,
 396                                 gint             *end_offset)
 397 {
 398   AtkTextIface *iface;
 399   gint local_start_offset, local_end_offset;
 400   gint *real_start_offset, *real_end_offset;
 401
 402   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 403
 404   if (start_offset)
 405     real_start_offset = start_offset;
 406   else
 407     real_start_offset = &local_start_offset;
 408   if (end_offset)
 409     real_end_offset = end_offset;
 410   else
 411     real_end_offset = &local_end_offset;
 412
 413   if (offset < 0)
 414     return NULL;
 415
 416   iface = ATK_TEXT_GET_IFACE (text);
 417
 418   if (iface->get_text_after_offset)
 419     return (*(iface->get_text_after_offset)) (text, offset, boundary_type, real_start_offset, real_end_offset);
 420   else
 421     return NULL;
 422 }
 423
 424 /**
 425  * atk_text_get_text_at_offset:
 426  * @text: an #AtkText
 427  * @offset: position
 428  * @boundary_type: An #AtkTextBoundary
 429  * @start_offset: (out): the start offset of the returned string
 430  * @end_offset: (out): the offset of the first character after the
 431  *              returned substring
 432  *
 433  * Gets the specified text.
 434  *
 435  * If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
 436  * offset is returned.
 437  *
 438  * If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
 439  * is from the word start at or before the offset to the word start after
 440  * the offset.
 441  *
 442  * The returned string will contain the word at the offset if the offset
 443  * is inside a word and will contain the word before the offset if the
 444  * offset is not inside a word.
 445  *
 446  * If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
 447  * string is from the sentence start at or before the offset to the sentence
 448  * start after the offset.
 449  *
 450  * The returned string will contain the sentence at the offset if the offset
 451  * is inside a sentence and will contain the sentence before the offset
 452  * if the offset is not inside a sentence.
 453  *
 454  * If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
 455  * string is from the line start at or before the offset to the line
 456  * start after the offset.
 457  *
 458  * Deprecated: This method is deprecated since ATK version
 459  * 2.9.4. Please use atk_text_get_string_at_offset() instead.
 460  *
 461  * Returns: a newly allocated string containing the text at @offset bounded by
 462  *   the specified @boundary_type. Use g_free() to free the returned string.
 463  **/
 464 gchar*
 465 atk_text_get_text_at_offset (AtkText          *text,
 466                              gint             offset,
 467                              AtkTextBoundary  boundary_type,
 468                              gint             *start_offset,
 469                              gint             *end_offset)
 470 {
 471   AtkTextIface *iface;
 472   gint local_start_offset, local_end_offset;
 473   gint *real_start_offset, *real_end_offset;
 474
 475   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 476
 477   if (start_offset)
 478     real_start_offset = start_offset;
 479   else
 480     real_start_offset = &local_start_offset;
 481   if (end_offset)
 482     real_end_offset = end_offset;
 483   else
 484     real_end_offset = &local_end_offset;
 485
 486   iface = ATK_TEXT_GET_IFACE (text);
 487
 488   if (iface->get_text_at_offset)
 489     return (*(iface->get_text_at_offset)) (text, offset, boundary_type, real_start_offset, real_end_offset);
 490   else
 491     return NULL;
 492 }
 493
 494 /**
 495  * atk_text_get_text_before_offset:
 496  * @text: an #AtkText
 497  * @offset: position
 498  * @boundary_type: An #AtkTextBoundary
 499  * @start_offset: (out): the start offset of the returned string
 500  * @end_offset: (out): the offset of the first character after the
 501  *              returned substring
 502  *
 503  * Gets the specified text.
 504  *
 505  * Deprecated: This method is deprecated since ATK version
 506  * 2.9.3. Please use atk_text_get_string_at_offset() instead.
 507  *
 508  * Returns: a newly allocated string containing the text before @offset bounded
 509  *   by the specified @boundary_type. Use g_free() to free the returned string.
 510  **/
 511 gchar*
 512 atk_text_get_text_before_offset (AtkText          *text,
 513                                  gint             offset,
 514                                  AtkTextBoundary  boundary_type,
 515                                  gint             *start_offset,
 516                                  gint             *end_offset)
 517 {
 518   AtkTextIface *iface;
 519   gint local_start_offset, local_end_offset;
 520   gint *real_start_offset, *real_end_offset;
 521
 522   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 523
 524   if (start_offset)
 525     real_start_offset = start_offset;
 526   else
 527     real_start_offset = &local_start_offset;
 528   if (end_offset)
 529     real_end_offset = end_offset;
 530   else
 531     real_end_offset = &local_end_offset;
 532
 533   if (offset < 0)
 534     return NULL;
 535
 536   iface = ATK_TEXT_GET_IFACE (text);
 537
 538   if (iface->get_text_before_offset)
 539     return (*(iface->get_text_before_offset)) (text, offset, boundary_type, real_start_offset, real_end_offset);
 540   else
 541     return NULL;
 542 }
 543
 544 /**
 545  * atk_text_get_string_at_offset:
 546  * @text: an #AtkText
 547  * @offset: position
 548  * @granularity: An #AtkTextGranularity
 549  * @start_offset: (out): the start offset of the returned string, or -1
 550  *                if an error has occurred (e.g. invalid offset, not implemented)
 551  * @end_offset: (out): the offset of the first character after the returned string,
 552  *              or -1 if an error has occurred (e.g. invalid offset, not implemented)
 553  *
 554  * Gets a portion of the text exposed through an #AtkText according to a given @offset
 555  * and a specific @granularity, along with the start and end offsets defining the
 556  * boundaries of such a portion of text.
 557  *
 558  * If @granularity is ATK_TEXT_GRANULARITY_CHAR the character at the
 559  * offset is returned.
 560  *
 561  * If @granularity is ATK_TEXT_GRANULARITY_WORD the returned string
 562  * is from the word start at or before the offset to the word start after
 563  * the offset.
 564  *
 565  * The returned string will contain the word at the offset if the offset
 566  * is inside a word and will contain the word before the offset if the
 567  * offset is not inside a word.
 568  *
 569  * If @granularity is ATK_TEXT_GRANULARITY_SENTENCE the returned string
 570  * is from the sentence start at or before the offset to the sentence
 571  * start after the offset.
 572  *
 573  * The returned string will contain the sentence at the offset if the offset
 574  * is inside a sentence and will contain the sentence before the offset
 575  * if the offset is not inside a sentence.
 576  *
 577  * If @granularity is ATK_TEXT_GRANULARITY_LINE the returned string
 578  * is from the line start at or before the offset to the line
 579  * start after the offset.
 580  *
 581  * If @granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
 582  * is from the start of the paragraph at or before the offset to the start
 583  * of the following paragraph after the offset.
 584  *
 585  * Since: 2.10
 586  *
 587  * Returns: a newly allocated string containing the text at the @offset bounded
 588  *   by the specified @granularity. Use g_free() to free the returned string.
 589  *   Returns %NULL if the offset is invalid or no implementation is available.
 590  **/
 591 gchar* atk_text_get_string_at_offset (AtkText *text,
 592                                       gint offset,
 593                                       AtkTextGranularity granularity,
 594                                       gint *start_offset,
 595                                       gint *end_offset)
 596 {
 597   AtkTextIface *iface;
 598   gint local_start_offset, local_end_offset;
 599   gint *real_start_offset, *real_end_offset;
 600
 601   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 602
 603   if (start_offset)
 604     {
 605       *start_offset = -1;
 606       real_start_offset = start_offset;
 607     }
 608   else
 609     real_start_offset = &local_start_offset;
 610
 611   if (end_offset)
 612     {
 613       *end_offset = -1;
 614       real_end_offset = end_offset;
 615     }
 616   else
 617     real_end_offset = &local_end_offset;
 618
 619   if (offset < 0)
 620     return NULL;
 621
 622   iface = ATK_TEXT_GET_IFACE (text);
 623
 624   if (iface->get_string_at_offset)
 625     return (*(iface->get_string_at_offset)) (text, offset, granularity, real_start_offset, real_end_offset);
 626   else
 627     return NULL;
 628 }
 629
 630 /**
 631  * atk_text_get_caret_offset:
 632  * @text: an #AtkText
 633  *
 634  * Gets the offset position of the caret (cursor).
 635  *
 636  * Returns: the offset position of the caret (cursor).
 637  **/
 638 gint
 639 atk_text_get_caret_offset (AtkText *text)
 640 {
 641   AtkTextIface *iface;
 642
 643   g_return_val_if_fail (ATK_IS_TEXT (text), 0);
 644
 645   iface = ATK_TEXT_GET_IFACE (text);
 646
 647   if (iface->get_caret_offset)
 648     return (*(iface->get_caret_offset)) (text);
 649   else
 650     return 0;
 651 }
 652
 653 /**
 654  * atk_text_get_character_extents:
 655  * @text: an #AtkText
 656  * @offset: The offset of the text character for which bounding information is required.
 657  * @x: Pointer for the x cordinate of the bounding box
 658  * @y: Pointer for the y cordinate of the bounding box
 659  * @width: Pointer for the width of the bounding box
 660  * @height: Pointer for the height of the bounding box
 661  * @coords: specify whether coordinates are relative to the screen or widget window
 662  *
 663  * Get the bounding box containing the glyph representing the character at
 664  *     a particular text offset.
 665  **/
 666 void
 667 atk_text_get_character_extents (AtkText *text,
 668                                 gint offset,
 669                                 gint *x,
 670                                 gint *y,
 671                                 gint *width,
 672                                 gint *height,
 673                                 AtkCoordType coords)
 674 {
 675   AtkTextIface *iface;
 676   gint local_x, local_y, local_width, local_height;
 677   gint *real_x, *real_y, *real_width, *real_height;
 678
 679   g_return_if_fail (ATK_IS_TEXT (text));
 680
 681   if (x)
 682     real_x = x;
 683   else
 684     real_x = &local_x;
 685   if (y)
 686     real_y = y;
 687   else
 688     real_y = &local_y;
 689   if (width)
 690     real_width = width;
 691   else
 692     real_width = &local_width;
 693   if (height)
 694     real_height = height;
 695   else
 696     real_height = &local_height;
 697
 698   *real_x = 0;
 699   *real_y = 0;
 700   *real_width = 0;
 701   *real_height = 0;
 702
 703   if (offset < 0)
 704     return;
 705
 706   iface = ATK_TEXT_GET_IFACE (text);
 707
 708   if (iface->get_character_extents)
 709     (*(iface->get_character_extents)) (text, offset, real_x, real_y, real_width, real_height, coords);
 710
 711   if (*real_width <0)
 712     {
 713       *real_x = *real_x + *real_width;
 714       *real_width *= -1;
 715     }
 716 }
 717
 718 /**
 719  * atk_text_get_run_attributes:
 720  *@text: an #AtkText
 721  *@offset: the offset at which to get the attributes, -1 means the offset of
 722  *the character to be inserted at the caret location.
 723  *@start_offset: (out): the address to put the start offset of the range
 724  *@end_offset: (out): the address to put the end offset of the range
 725  *
 726  *Creates an #AtkAttributeSet which consists of the attributes explicitly
 727  *set at the position @offset in the text. @start_offset and @end_offset are
 728  *set to the start and end of the range around @offset where the attributes are
 729  *invariant. Note that @end_offset is the offset of the first character
 730  *after the range.  See the enum AtkTextAttribute for types of text
 731  *attributes that can be returned. Note that other attributes may also be
 732  *returned.
 733  *
 734  *Returns: (transfer full): an #AtkAttributeSet which contains the attributes
 735  * explicitly set at @offset. This #AtkAttributeSet should be freed by a call
 736  * to atk_attribute_set_free().
 737  **/
 738 AtkAttributeSet*
 739 atk_text_get_run_attributes (AtkText          *text,
 740                              gint             offset,
 741                              gint             *start_offset,
 742                              gint             *end_offset)
 743 {
 744   AtkTextIface *iface;
 745   gint local_start_offset, local_end_offset;
 746   gint *real_start_offset, *real_end_offset;
 747
 748   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 749
 750   if (start_offset)
 751     real_start_offset = start_offset;
 752   else
 753     real_start_offset = &local_start_offset;
 754   if (end_offset)
 755     real_end_offset = end_offset;
 756   else
 757     real_end_offset = &local_end_offset;
 758
 759   if (offset < -1)
 760     return NULL;
 761
 762   iface = ATK_TEXT_GET_IFACE (text);
 763
 764   if (iface->get_run_attributes)
 765     return (*(iface->get_run_attributes)) (text, offset, real_start_offset, real_end_offset);
 766   else
 767     return NULL;
 768 }
 769
 770 /**
 771  * atk_text_get_default_attributes:
 772  *@text: an #AtkText
 773  *
 774  *Creates an #AtkAttributeSet which consists of the default values of
 775  *attributes for the text. See the enum AtkTextAttribute for types of text
 776  *attributes that can be returned. Note that other attributes may also be
 777  *returned.
 778  *
 779  *Returns: (transfer full): an #AtkAttributeSet which contains the default
 780  * values of attributes.  at @offset. this #atkattributeset should be freed by
 781  * a call to atk_attribute_set_free().
 782  */
 783 AtkAttributeSet*
 784 atk_text_get_default_attributes (AtkText          *text)
 785 {
 786   AtkTextIface *iface;
 787
 788   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 789
 790   iface = ATK_TEXT_GET_IFACE (text);
 791
 792   if (iface->get_default_attributes)
 793     return (*(iface->get_default_attributes)) (text);
 794   else
 795     return NULL;
 796 }
 797
 798 /**
 799  * atk_text_get_character_count:
 800  * @text: an #AtkText
 801  *
 802  * Gets the character count.
 803  *
 804  * Returns: the number of characters.
 805  **/
 806 gint
 807 atk_text_get_character_count (AtkText *text)
 808 {
 809   AtkTextIface *iface;
 810
 811   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 812
 813   iface = ATK_TEXT_GET_IFACE (text);
 814
 815   if (iface->get_character_count)
 816     return (*(iface->get_character_count)) (text);
 817   else
 818     return -1;
 819 }
 820
 821 /**
 822  * atk_text_get_offset_at_point:
 823  * @text: an #AtkText
 824  * @x: screen x-position of character
 825  * @y: screen y-position of character
 826  * @coords: specify whether coordinates are relative to the screen or
 827  * widget window
 828  *
 829  * Gets the offset of the character located at coordinates @x and @y. @x and @y
 830  * are interpreted as being relative to the screen or this widget's window
 831  * depending on @coords.
 832  *
 833  * Returns: the offset to the character which is located at
 834  * the specified @x and @y coordinates.
 835  **/
 836 gint
 837 atk_text_get_offset_at_point (AtkText *text,
 838                               gint x,
 839                               gint y,
 840                               AtkCoordType coords)
 841 {
 842   AtkTextIface *iface;
 843
 844   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 845
 846   iface = ATK_TEXT_GET_IFACE (text);
 847
 848   if (iface->get_offset_at_point)
 849     return (*(iface->get_offset_at_point)) (text, x, y, coords);
 850   else
 851     return -1;
 852 }
 853
 854 /**
 855  * atk_text_get_n_selections:
 856  * @text: an #AtkText
 857  *
 858  * Gets the number of selected regions.
 859  *
 860  * Returns: The number of selected regions, or -1 if a failure
 861  *   occurred.
 862  **/
 863 gint
 864 atk_text_get_n_selections (AtkText *text)
 865 {
 866   AtkTextIface *iface;
 867
 868   g_return_val_if_fail (ATK_IS_TEXT (text), -1);
 869
 870   iface = ATK_TEXT_GET_IFACE (text);
 871
 872   if (iface->get_n_selections)
 873     return (*(iface->get_n_selections)) (text);
 874   else
 875     return -1;
 876 }
 877
 878 /**
 879  * atk_text_get_selection:
 880  * @text: an #AtkText
 881  * @selection_num: The selection number.  The selected regions are
 882  * assigned numbers that correspond to how far the region is from the
 883  * start of the text.  The selected region closest to the beginning
 884  * of the text region is assigned the number 0, etc.  Note that adding,
 885  * moving or deleting a selected region can change the numbering.
 886  * @start_offset: (out): passes back the start position of the selected region
 887  * @end_offset: (out): passes back the end position of (e.g. offset immediately past)
 888  * the selected region
 889  *
 890  * Gets the text from the specified selection.
 891  *
 892  * Returns: a newly allocated string containing the selected text. Use g_free()
 893  *   to free the returned string.
 894  **/
 895 gchar*
 896 atk_text_get_selection (AtkText *text,
 897                         gint    selection_num,
 898                         gint    *start_offset,
 899                         gint    *end_offset)
 900 {
 901   AtkTextIface *iface;
 902   gint local_start_offset, local_end_offset;
 903   gint *real_start_offset, *real_end_offset;
 904
 905   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
 906
 907   if (start_offset)
 908     real_start_offset = start_offset;
 909   else
 910     real_start_offset = &local_start_offset;
 911   if (end_offset)
 912     real_end_offset = end_offset;
 913   else
 914     real_end_offset = &local_end_offset;
 915
 916   iface = ATK_TEXT_GET_IFACE (text);
 917
 918   if (iface->get_selection)
 919   {
 920     return (*(iface->get_selection)) (text, selection_num,
 921        real_start_offset, real_end_offset);
 922   }
 923   else
 924     return NULL;
 925 }
 926
 927 /**
 928  * atk_text_add_selection:
 929  * @text: an #AtkText
 930  * @start_offset: the start position of the selected region
 931  * @end_offset: the offset of the first character after the selected region.
 932  *
 933  * Adds a selection bounded by the specified offsets.
 934  *
 935  * Returns: %TRUE if success, %FALSE otherwise
 936  **/
 937 gboolean
 938 atk_text_add_selection (AtkText *text,
 939                         gint    start_offset,
 940                         gint    end_offset)
 941 {
 942   AtkTextIface *iface;
 943
 944   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 945
 946   iface = ATK_TEXT_GET_IFACE (text);
 947
 948   if (iface->add_selection)
 949     return (*(iface->add_selection)) (text, start_offset, end_offset);
 950   else
 951     return FALSE;
 952 }
 953
 954 /**
 955  * atk_text_remove_selection:
 956  * @text: an #AtkText
 957  * @selection_num: The selection number.  The selected regions are
 958  * assigned numbers that correspond to how far the region is from the
 959  * start of the text.  The selected region closest to the beginning
 960  * of the text region is assigned the number 0, etc.  Note that adding,
 961  * moving or deleting a selected region can change the numbering.
 962  *
 963  * Removes the specified selection.
 964  *
 965  * Returns: %TRUE if success, %FALSE otherwise
 966  **/
 967 gboolean
 968 atk_text_remove_selection (AtkText *text,
 969                            gint    selection_num)
 970 {
 971   AtkTextIface *iface;
 972
 973   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
 974
 975   iface = ATK_TEXT_GET_IFACE (text);
 976
 977   if (iface->remove_selection)
 978     return (*(iface->remove_selection)) (text, selection_num);
 979   else
 980     return FALSE;
 981 }
 982
 983 /**
 984  * atk_text_set_selection:
 985  * @text: an #AtkText
 986  * @selection_num: The selection number.  The selected regions are
 987  * assigned numbers that correspond to how far the region is from the
 988  * start of the text.  The selected region closest to the beginning
 989  * of the text region is assigned the number 0, etc.  Note that adding,
 990  * moving or deleting a selected region can change the numbering.
 991  * @start_offset: the new start position of the selection
 992  * @end_offset: the new end position of (e.g. offset immediately past)
 993  * the selection
 994  *
 995  * Changes the start and end offset of the specified selection.
 996  *
 997  * Returns: %TRUE if success, %FALSE otherwise
 998  **/
 999 gboolean
1000 atk_text_set_selection (AtkText *text,
1001                         gint    selection_num,
1002                         gint    start_offset,
1003                         gint    end_offset)
1004 {
1005   AtkTextIface *iface;
1006
1007   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
1008
1009   iface = ATK_TEXT_GET_IFACE (text);
1010
1011   if (iface->set_selection)
1012   {
1013     return (*(iface->set_selection)) (text, selection_num,
1014        start_offset, end_offset);
1015   }
1016   else
1017     return FALSE;
1018 }
1019
1020 /**
1021  * atk_text_set_caret_offset:
1022  * @text: an #AtkText
1023  * @offset: position
1024  *
1025  * Sets the caret (cursor) position to the specified @offset.
1026  *
1027  * Returns: %TRUE if success, %FALSE otherwise.
1028  **/
1029 gboolean
1030 atk_text_set_caret_offset (AtkText *text,
1031                            gint    offset)
1032 {
1033   AtkTextIface *iface;
1034
1035   g_return_val_if_fail (ATK_IS_TEXT (text), FALSE);
1036
1037   iface = ATK_TEXT_GET_IFACE (text);
1038
1039   if (iface->set_caret_offset)
1040     {
1041       return (*(iface->set_caret_offset)) (text, offset);
1042     }
1043   else
1044     {
1045       return FALSE;
1046     }
1047 }
1048
1049 /**
1050  * atk_text_get_range_extents:
1051  * @text: an #AtkText
1052  * @start_offset: The offset of the first text character for which boundary
1053  *        information is required.
1054  * @end_offset: The offset of the text character after the last character
1055  *        for which boundary information is required.
1056  * @coord_type: Specify whether coordinates are relative to the screen or widget window.
1057  * @rect: A pointer to a AtkTextRectangle which is filled in by this function.
1058  *
1059  * Get the bounding box for text within the specified range.
1060  *
1061  * Since: 1.3
1062  **/
1063 void
1064 atk_text_get_range_extents (AtkText          *text,
1065                             gint             start_offset,
1066                             gint             end_offset,
1067                             AtkCoordType     coord_type,
1068                             AtkTextRectangle *rect)
1069 {
1070   AtkTextIface *iface;
1071
1072   g_return_if_fail (ATK_IS_TEXT (text));
1073   g_return_if_fail (rect);
1074   g_return_if_fail (start_offset >= 0 && start_offset < end_offset);
1075
1076   iface = ATK_TEXT_GET_IFACE (text);
1077
1078   if (iface->get_range_extents)
1079     (*(iface->get_range_extents)) (text, start_offset, end_offset, coord_type, rect);
1080 }
1081
1082 /**
1083  * atk_text_get_bounded_ranges:
1084  * @text: an #AtkText
1085  * @rect: An AtkTextRectangle giving the dimensions of the bounding box.
1086  * @coord_type: Specify whether coordinates are relative to the screen or widget window.
1087  * @x_clip_type: Specify the horizontal clip type.
1088  * @y_clip_type: Specify the vertical clip type.
1089  *
1090  * Get the ranges of text in the specified bounding box.
1091  *
1092  * Since: 1.3
1093  *
1094  * Returns: (array zero-terminated=1): Array of AtkTextRange. The last
1095  *          element of the array returned by this function will be NULL.
1096  **/
1097 AtkTextRange**
1098 atk_text_get_bounded_ranges (AtkText          *text,
1099                              AtkTextRectangle *rect,
1100                              AtkCoordType      coord_type,
1101                              AtkTextClipType   x_clip_type,
1102                              AtkTextClipType   y_clip_type)
1103 {
1104   AtkTextIface *iface;
1105
1106   g_return_val_if_fail (ATK_IS_TEXT (text), NULL);
1107   g_return_val_if_fail (rect, NULL);
1108
1109   iface = ATK_TEXT_GET_IFACE (text);
1110
1111   if (iface->get_bounded_ranges)
1112     return (*(iface->get_bounded_ranges)) (text, rect, coord_type, x_clip_type, y_clip_type);
1113   else
1114     return NULL;
1115 }
1116
1117 /**
1118  * atk_attribute_set_free:
1119  * @attrib_set: The #AtkAttributeSet to free
1120  *
1121  * Frees the memory used by an #AtkAttributeSet, including all its
1122  * #AtkAttributes.
1123  **/
1124 void
1125 atk_attribute_set_free (AtkAttributeSet *attrib_set)
1126 {
1127   GSList *temp;
1128
1129   temp = attrib_set;
1130
1131   while (temp != NULL)
1132     {
1133       AtkAttribute *att;
1134
1135       att = temp->data;
1136
1137       g_free (att->name);
1138       g_free (att->value);
1139       g_free (att);
1140       temp = temp->next;
1141     }
1142   g_slist_free (attrib_set);
1143 }
1144
1145 /**
1146  * atk_text_attribute_register:
1147  * @name: a name string
1148  *
1149  * Associate @name with a new #AtkTextAttribute
1150  *
1151  * Returns: an #AtkTextAttribute associated with @name
1152  **/
1153 AtkTextAttribute
1154 atk_text_attribute_register (const gchar *name)
1155 {
1156   g_return_val_if_fail (name, ATK_TEXT_ATTR_INVALID);
1157
1158   if (!extra_attributes)
1159     extra_attributes = g_ptr_array_new ();
1160
1161   g_ptr_array_add (extra_attributes, g_strdup (name));
1162   return extra_attributes->len + ATK_TEXT_ATTR_LAST_DEFINED;
1163 }
1164
1165 /**
1166  * atk_text_attribute_get_name:
1167  * @attr: The #AtkTextAttribute whose name is required
1168  *
1169  * Gets the name corresponding to the #AtkTextAttribute
1170  *
1171  * Returns: a string containing the name; this string should not be freed
1172  **/
1173 const gchar*
1174 atk_text_attribute_get_name (AtkTextAttribute attr)
1175 {
1176   GTypeClass *type_class;
1177   GEnumValue *value;
1178   const gchar *name = NULL;
1179
1180   type_class = g_type_class_ref (ATK_TYPE_TEXT_ATTRIBUTE);
1181   g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), NULL);
1182
1183   value = g_enum_get_value (G_ENUM_CLASS (type_class), attr);
1184
1185   if (value)
1186     {
1187       name = value->value_nick;
1188     }
1189   else
1190     {
1191       if (extra_attributes)
1192         {
1193           gint n = attr;
1194
1195           n -= ATK_TEXT_ATTR_LAST_DEFINED + 1;
1196
1197           if (n < extra_attributes->len)
1198
1199             name = g_ptr_array_index (extra_attributes, n);
1200         }
1201     }
1202   g_type_class_unref (type_class);
1203   return name;
1204 }
1205
1206 /**
1207  * atk_text_attribute_for_name:
1208  * @name: a string which is the (non-localized) name of an ATK text attribute.
1209  *
1210  * Get the #AtkTextAttribute type corresponding to a text attribute name.
1211  *
1212  * Returns: the #AtkTextAttribute enumerated type corresponding to the specified
1213 name,
1214  *          or #ATK_TEXT_ATTRIBUTE_INVALID if no matching text attribute is found.
1215  **/
1216 AtkTextAttribute
1217 atk_text_attribute_for_name (const gchar *name)
1218 {
1219   GTypeClass *type_class;
1220   GEnumValue *value;
1221   AtkTextAttribute type = ATK_TEXT_ATTR_INVALID;
1222
1223   g_return_val_if_fail (name, ATK_TEXT_ATTR_INVALID);
1224
1225   type_class = g_type_class_ref (ATK_TYPE_TEXT_ATTRIBUTE);
1226   g_return_val_if_fail (G_IS_ENUM_CLASS (type_class), ATK_TEXT_ATTR_INVALID);
1227
1228   value = g_enum_get_value_by_nick (G_ENUM_CLASS (type_class), name);
1229
1230   if (value)
1231     {
1232       type = value->value;
1233     }
1234   else
1235     {
1236       gint i;
1237
1238       if (extra_attributes)
1239         {
1240           for (i = 0; i < extra_attributes->len; i++)
1241             {
1242               gchar *extra_attribute = (gchar *)g_ptr_array_index (extra_attributes, i);
1243
1244               g_return_val_if_fail (extra_attribute, ATK_TEXT_ATTR_INVALID);
1245
1246               if (strcmp (name, extra_attribute) == 0)
1247                 {
1248                   type = i + 1 + ATK_TEXT_ATTR_LAST_DEFINED;
1249                   break;
1250                 }
1251             }
1252         }
1253     }
1254   g_type_class_unref (type_class);
1255
1256   return type;
1257 }
1258
1259 /**
1260  * atk_text_attribute_get_value:
1261  * @attr: The #AtkTextAttribute for which a value is required
1262  * @index_: The index of the required value
1263  *
1264  * Gets the value for the index of the #AtkTextAttribute
1265  *
1266  * Returns: a string containing the value; this string should not be freed;
1267  * NULL is returned if there are no values maintained for the attr value.
1268  **/
1269 const gchar*
1270 atk_text_attribute_get_value (AtkTextAttribute attr,
1271                               gint             index)
1272 {
1273   switch (attr)
1274     {
1275     case ATK_TEXT_ATTR_INVISIBLE:
1276     case ATK_TEXT_ATTR_EDITABLE:
1277     case ATK_TEXT_ATTR_BG_FULL_HEIGHT:
1278     case ATK_TEXT_ATTR_STRIKETHROUGH:
1279     case ATK_TEXT_ATTR_BG_STIPPLE:
1280     case ATK_TEXT_ATTR_FG_STIPPLE:
1281       g_assert (index >= 0 && index < G_N_ELEMENTS (boolean_offsets));
1282       return boolean + boolean_offsets[index];
1283     case ATK_TEXT_ATTR_UNDERLINE:
1284       g_assert (index >= 0 && index < G_N_ELEMENTS (underline_offsets));
1285       return underline + underline_offsets[index];
1286     case ATK_TEXT_ATTR_WRAP_MODE:
1287       g_assert (index >= 0 && index < G_N_ELEMENTS (wrap_mode_offsets));
1288       return wrap_mode + wrap_mode_offsets[index];
1289     case ATK_TEXT_ATTR_DIRECTION:
1290       g_assert (index >= 0 && index < G_N_ELEMENTS (direction_offsets));
1291       return direction + direction_offsets[index];
1292     case ATK_TEXT_ATTR_JUSTIFICATION:
1293       g_assert (index >= 0 && index < G_N_ELEMENTS (justification_offsets));
1294       return justification + justification_offsets[index];
1295     case ATK_TEXT_ATTR_STRETCH:
1296       g_assert (index >= 0 && index < G_N_ELEMENTS (stretch_offsets));
1297       return stretch + stretch_offsets[index];
1298     case ATK_TEXT_ATTR_VARIANT:
1299       g_assert (index >= 0 && index < G_N_ELEMENTS (variant_offsets));
1300       return variant + variant_offsets[index];
1301     case ATK_TEXT_ATTR_STYLE:
1302       g_assert (index >= 0 && index < G_N_ELEMENTS (style_offsets));
1303       return style + style_offsets[index];
1304     default:
1305       return NULL;
1306    }
1307 }
1308
1309 static void
1310 atk_text_rectangle_union (AtkTextRectangle *src1,
1311                           AtkTextRectangle *src2,
1312                           AtkTextRectangle *dest)
1313 {
1314   gint dest_x, dest_y;
1315
1316   dest_x = MIN (src1->x, src2->x);
1317   dest_y = MIN (src1->y, src2->y);
1318   dest->width = MAX (src1->x + src1->width, src2->x + src2->width) - dest_x;
1319   dest->height = MAX (src1->y + src1->height, src2->y + src2->height) - dest_y;
1320   dest->x = dest_x;
1321   dest->y = dest_y;
1322 }
1323
1324 static gboolean
1325 atk_text_rectangle_contain (AtkTextRectangle *clip,
1326                             AtkTextRectangle *bounds,
1327                             AtkTextClipType  x_clip_type,
1328                             AtkTextClipType  y_clip_type)
1329 {
1330   gboolean x_min_ok, x_max_ok, y_min_ok, y_max_ok;
1331
1332   x_min_ok = (bounds->x >= clip->x) ||
1333              ((bounds->x + bounds->width >= clip->x) &&
1334               ((x_clip_type == ATK_TEXT_CLIP_NONE) ||
1335                (x_clip_type == ATK_TEXT_CLIP_MAX)));
1336
1337   x_max_ok = (bounds->x + bounds->width <= clip->x + clip->width) ||
1338              ((bounds->x <= clip->x + clip->width) &&
1339               ((x_clip_type == ATK_TEXT_CLIP_NONE) ||
1340                (x_clip_type == ATK_TEXT_CLIP_MIN)));
1341
1342   y_min_ok = (bounds->y >= clip->y) ||
1343              ((bounds->y + bounds->height >= clip->y) &&
1344               ((y_clip_type == ATK_TEXT_CLIP_NONE) ||
1345                (y_clip_type == ATK_TEXT_CLIP_MAX)));
1346
1347   y_max_ok = (bounds->y + bounds->height <= clip->y + clip->height) ||
1348              ((bounds->y <= clip->y + clip->height) &&
1349               ((y_clip_type == ATK_TEXT_CLIP_NONE) ||
1350                (y_clip_type == ATK_TEXT_CLIP_MIN)));
1351
1352   return (x_min_ok && x_max_ok && y_min_ok && y_max_ok);
1353
1354 }
1355
1356 static void
1357 atk_text_real_get_range_extents (AtkText           *text,
1358                                  gint              start_offset,
1359                                  gint              end_offset,
1360                                  AtkCoordType      coord_type,
1361                                  AtkTextRectangle  *rect)
1362 {
1363   gint i;
1364   AtkTextRectangle cbounds, bounds;
1365
1366   atk_text_get_character_extents (text, start_offset,
1367                                   &bounds.x, &bounds.y,
1368                                   &bounds.width, &bounds.height,
1369                                   coord_type);
1370
1371   for (i = start_offset + 1; i < end_offset; i++)
1372     {
1373       atk_text_get_character_extents (text, i,
1374                                       &cbounds.x, &cbounds.y,
1375                                       &cbounds.width, &cbounds.height,
1376                                       coord_type);
1377       atk_text_rectangle_union (&bounds, &cbounds, &bounds);
1378     }
1379
1380   rect->x = bounds.x;
1381   rect->y = bounds.y;
1382   rect->width = bounds.width;
1383   rect->height = bounds.height;
1384 }
1385
1386 static AtkTextRange**
1387 atk_text_real_get_bounded_ranges (AtkText          *text,
1388                                   AtkTextRectangle *rect,
1389                                   AtkCoordType     coord_type,
1390                                   AtkTextClipType  x_clip_type,
1391                                   AtkTextClipType  y_clip_type)
1392 {
1393   gint bounds_min_offset, bounds_max_offset;
1394   gint min_line_start, min_line_end;
1395   gint max_line_start, max_line_end;
1396   gchar *line;
1397   gint curr_offset;
1398   gint offset;
1399   gint num_ranges = 0;
1400   gint range_size = 1;
1401   AtkTextRectangle cbounds;
1402   AtkTextRange **range;
1403
1404   range = NULL;
1405   bounds_min_offset = atk_text_get_offset_at_point (text, rect->x, rect->y, coord_type);
1406   bounds_max_offset = atk_text_get_offset_at_point (text, rect->x + rect->width, rect->y + rect->height, coord_type);
1407
1408   if (bounds_min_offset == 0 &&
1409       bounds_min_offset == bounds_max_offset)
1410     return NULL;
1411
1412   line = atk_text_get_text_at_offset (text, bounds_min_offset,
1413                                       ATK_TEXT_BOUNDARY_LINE_START,
1414                                       &min_line_start, &min_line_end);
1415   g_free (line);
1416   line = atk_text_get_text_at_offset (text, bounds_max_offset,
1417                                       ATK_TEXT_BOUNDARY_LINE_START,
1418                                       &max_line_start, &max_line_end);
1419   g_free (line);
1420   bounds_min_offset = MIN (min_line_start, max_line_start);
1421   bounds_max_offset = MAX (min_line_end, max_line_end);
1422
1423   curr_offset = bounds_min_offset;
1424   while (curr_offset < bounds_max_offset)
1425     {
1426       offset = curr_offset;
1427
1428       while (curr_offset < bounds_max_offset)
1429         {
1430           atk_text_get_character_extents (text, curr_offset,
1431                                           &cbounds.x, &cbounds.y,
1432                                           &cbounds.width, &cbounds.height,
1433                                           coord_type);
1434           if (!atk_text_rectangle_contain (rect, &cbounds, x_clip_type, y_clip_type))
1435             break;
1436           curr_offset++;
1437         }
1438       if (curr_offset > offset)
1439         {
1440           AtkTextRange *one_range = g_new (AtkTextRange, 1);
1441
1442           one_range->start_offset = offset;
1443           one_range->end_offset = curr_offset;
1444           one_range->content = atk_text_get_text (text, offset, curr_offset);
1445           atk_text_get_range_extents (text, offset, curr_offset, coord_type, &one_range->bounds);
1446
1447           if (num_ranges >= range_size - 1)
1448             {
1449               range_size *= 2;
1450               range = g_realloc (range, range_size * sizeof (gpointer));
1451             }
1452           range[num_ranges] = one_range;
1453           num_ranges++;
1454         }
1455       curr_offset++;
1456       if (range)
1457         range[num_ranges] = NULL;
1458     }
1459   return range;
1460 }
1461
1462 /**
1463  * atk_text_free_ranges:
1464  * @ranges: (array): A pointer to an array of #AtkTextRange which is
1465  *   to be freed.
1466  *
1467  * Frees the memory associated with an array of AtkTextRange. It is assumed
1468  * that the array was returned by the function atk_text_get_bounded_ranges
1469  * and is NULL terminated.
1470  *
1471  * Since: 1.3
1472  **/
1473 void
1474 atk_text_free_ranges (AtkTextRange **ranges)
1475 {
1476   AtkTextRange **first = ranges;
1477
1478   if (ranges)
1479     {
1480       while (*ranges)
1481         {
1482           AtkTextRange *range;
1483
1484           range = *ranges;
1485           ranges++;
1486           g_free (range->content);
1487           g_free (range);
1488         }
1489       g_free (first);
1490     }
1491 }
1492
1493 static AtkTextRange *
1494 atk_text_range_copy (AtkTextRange *src)
1495 {
1496   AtkTextRange *dst = g_new0 (AtkTextRange, 1);
1497   dst->bounds = src->bounds;
1498   dst->start_offset = src->start_offset;
1499   dst->end_offset = src->end_offset;
1500   if (src->content)
1501     dst->content = g_strdup (src->content);
1502   return dst;
1503 }
1504
1505 static void
1506 atk_text_range_free (AtkTextRange *range)
1507 {
1508   g_free (range->content);
1509   g_free (range);
1510 }
1511
1512 G_DEFINE_BOXED_TYPE (AtkTextRange, atk_text_range, atk_text_range_copy,
1513                      atk_text_range_free)