src/sciwrappers.c

   1 /*
   2  *      sciwrappers.c - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 /** @file sciwrappers.h
  23  * Wrapper functions for the Scintilla editor widget @c SCI_* messages.
  24  * You should also check the http://scintilla.org documentation, as it is more detailed.
  25  *
  26  * To get Scintilla notifications, use the
  27  * @link pluginsignals.c @c "editor-notify" signal @endlink.
  28  *
  29  * @note These functions were originally from the cssed project
  30  * (http://cssed.sf.net, thanks).
  31  * @see scintilla_send_message().
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 # include "config.h"
  36 #endif
  37
  38 #include "sciwrappers.h"
  39
  40 #include "utils.h"
  41
  42 #include <string.h>
  43
  44
  45 #define SSM(s, m, w, l) scintilla_send_message(s, m, w, l)
  46
  47
  48 /* line numbers visibility */
  49 void sci_set_line_numbers(ScintillaObject *sci, gboolean set)
  50 {
  51         if (set)
  52         {
  53                 gchar tmp_str[15];
  54                 gint len = (gint) SSM(sci, SCI_GETLINECOUNT, 0, 0);
  55                 gint width;
  56
  57                 g_snprintf(tmp_str, 15, "_%d", len);
  58                 width = sci_text_width(sci, STYLE_LINENUMBER, tmp_str);
  59                 SSM(sci, SCI_SETMARGINWIDTHN, 0, width);
  60                 SSM(sci, SCI_SETMARGINSENSITIVEN, 0, FALSE); /* use default behaviour */
  61         }
  62         else
  63         {
  64                 SSM(sci, SCI_SETMARGINWIDTHN, 0, 0);
  65         }
  66 }
  67
  68
  69 void sci_set_mark_long_lines(ScintillaObject *sci, gint type, gint column, const gchar *colour)
  70 {
  71         glong colour_val = utils_parse_color_to_bgr(colour); /* Scintilla uses a "long" value */
  72
  73         if (column == 0)
  74                 type = 2;
  75         switch (type)
  76         {
  77                 case 0:
  78                 {
  79                         SSM(sci, SCI_SETEDGEMODE, EDGE_LINE, 0);
  80                         break;
  81                 }
  82                 case 1:
  83                 {
  84                         SSM(sci, SCI_SETEDGEMODE, EDGE_BACKGROUND, 0);
  85                         break;
  86                 }
  87                 case 2:
  88                 {
  89                         SSM(sci, SCI_SETEDGEMODE, EDGE_NONE, 0);
  90                         return;
  91                 }
  92         }
  93         SSM(sci, SCI_SETEDGECOLUMN, (uptr_t) column, 0);
  94         SSM(sci, SCI_SETEDGECOLOUR, (uptr_t) colour_val, 0);
  95 }
  96
  97
  98 /* symbol margin visibility */
  99 void sci_set_symbol_margin(ScintillaObject *sci, gboolean set)
 100 {
 101         if (set)
 102         {
 103                 SSM(sci, SCI_SETMARGINWIDTHN, 1, 16);
 104                 SSM(sci, SCI_SETMARGINSENSITIVEN, 1, TRUE);
 105         }
 106         else
 107         {
 108                 SSM(sci, SCI_SETMARGINWIDTHN, 1, 0);
 109                 SSM(sci, SCI_SETMARGINSENSITIVEN, 1, FALSE);
 110         }
 111 }
 112
 113
 114 /* folding margin visibility */
 115 void sci_set_folding_margin_visible(ScintillaObject *sci, gboolean set)
 116 {
 117         if (set)
 118         {
 119                 SSM(sci, SCI_SETMARGINWIDTHN, 2, 12);
 120                 SSM(sci, SCI_SETMARGINSENSITIVEN, 2, TRUE);
 121         }
 122         else
 123         {
 124                 SSM(sci, SCI_SETMARGINSENSITIVEN, 2, FALSE);
 125                 SSM(sci, SCI_SETMARGINWIDTHN, 2, 0);
 126         }
 127 }
 128
 129
 130 /* end of lines */
 131 void sci_set_visible_eols(ScintillaObject *sci, gboolean set)
 132 {
 133         SSM(sci, SCI_SETVIEWEOL, set != FALSE, 0);
 134 }
 135
 136
 137 void sci_set_visible_white_spaces(ScintillaObject *sci, gboolean set)
 138 {
 139         if (set)
 140                 SSM(sci, SCI_SETVIEWWS, SCWS_VISIBLEALWAYS, 0);
 141         else
 142                 SSM(sci, SCI_SETVIEWWS, SCWS_INVISIBLE, 0);
 143 }
 144
 145
 146 void sci_set_lines_wrapped(ScintillaObject *sci, gboolean set)
 147 {
 148         if (set)
 149                 SSM(sci, SCI_SETWRAPMODE, SC_WRAP_WORD, 0);
 150         else
 151                 SSM(sci, SCI_SETWRAPMODE, SC_WRAP_NONE, 0);
 152 }
 153
 154
 155 gint sci_get_eol_mode(ScintillaObject *sci)
 156 {
 157         return (gint) SSM(sci, SCI_GETEOLMODE, 0, 0);
 158 }
 159
 160
 161 void sci_set_eol_mode(ScintillaObject *sci, gint eolmode)
 162 {
 163         SSM(sci, SCI_SETEOLMODE, (uptr_t) eolmode, 0);
 164 }
 165
 166
 167 void sci_convert_eols(ScintillaObject *sci, gint eolmode)
 168 {
 169         SSM(sci, SCI_CONVERTEOLS, (uptr_t) eolmode, 0);
 170 }
 171
 172
 173 void sci_add_text(ScintillaObject *sci, const gchar *text)
 174 {
 175         if (text != NULL)
 176         { /* if null text is passed scintilla will segfault */
 177                 SSM(sci, SCI_ADDTEXT, strlen(text), (sptr_t) text);
 178         }
 179 }
 180
 181
 182 /** Sets all text.
 183  * @param sci Scintilla widget.
 184  * @param text Text. */
 185 GEANY_API_SYMBOL
 186 void sci_set_text(ScintillaObject *sci, const gchar *text)
 187 {
 188         if( text != NULL ){ /* if null text is passed to scintilla will segfault */
 189                 SSM(sci, SCI_SETTEXT, 0, (sptr_t) text);
 190         }
 191 }
 192
 193
 194 gboolean sci_can_undo(ScintillaObject *sci)
 195 {
 196         return SSM(sci, SCI_CANUNDO, 0, 0) != FALSE;
 197 }
 198
 199
 200 gboolean sci_can_redo(ScintillaObject *sci)
 201 {
 202         return SSM(sci, SCI_CANREDO, 0, 0) != FALSE;
 203 }
 204
 205
 206 void sci_undo(ScintillaObject *sci)
 207 {
 208         if (sci_can_undo(sci))
 209                 SSM(sci, SCI_UNDO, 0, 0);
 210 }
 211
 212
 213 void sci_redo(ScintillaObject *sci)
 214 {
 215         if (sci_can_redo(sci))
 216                 SSM(sci, SCI_REDO, 0, 0);
 217 }
 218
 219
 220 /** Begins grouping a set of edits together as one Undo action.
 221  * You must call sci_end_undo_action() after making your edits.
 222  * @param sci Scintilla @c GtkWidget. */
 223 GEANY_API_SYMBOL
 224 void sci_start_undo_action(ScintillaObject *sci)
 225 {
 226         SSM(sci, SCI_BEGINUNDOACTION, 0, 0);
 227 }
 228
 229
 230 /** Ends grouping a set of edits together as one Undo action.
 231  * @param sci Scintilla @c GtkWidget.
 232  * @see sci_start_undo_action(). */
 233 GEANY_API_SYMBOL
 234 void sci_end_undo_action(ScintillaObject *sci)
 235 {
 236         SSM(sci, SCI_ENDUNDOACTION, 0, 0);
 237 }
 238
 239
 240 void sci_set_undo_collection(ScintillaObject *sci, gboolean set)
 241 {
 242         SSM(sci, SCI_SETUNDOCOLLECTION, set != FALSE, 0);
 243 }
 244
 245
 246 void sci_empty_undo_buffer(ScintillaObject *sci)
 247 {
 248         SSM(sci, SCI_EMPTYUNDOBUFFER, 0, 0);
 249 }
 250
 251
 252 gboolean sci_is_modified(ScintillaObject *sci)
 253 {
 254         return (SSM(sci, SCI_GETMODIFY, 0, 0) != 0);
 255 }
 256
 257
 258 void sci_zoom_in(ScintillaObject *sci)
 259 {
 260         SSM(sci, SCI_ZOOMIN, 0, 0);
 261 }
 262
 263
 264 void sci_zoom_out(ScintillaObject *sci)
 265 {
 266         SSM(sci, SCI_ZOOMOUT, 0, 0);
 267 }
 268
 269
 270 void sci_zoom_off(ScintillaObject *sci)
 271 {
 272         SSM(sci, SCI_SETZOOM, 0, 0);
 273 }
 274
 275
 276 /** Sets a line marker.
 277  * @param sci Scintilla widget.
 278  * @param line_number Line number.
 279  * @param marker Marker number. */
 280 GEANY_API_SYMBOL
 281 void sci_set_marker_at_line(ScintillaObject *sci, gint line_number, gint marker)
 282 {
 283         SSM(sci, SCI_MARKERADD, (uptr_t) line_number, marker);
 284 }
 285
 286
 287 /** Deletes a line marker.
 288  * @param sci Scintilla widget.
 289  * @param line_number Line number.
 290  * @param marker Marker number. */
 291 GEANY_API_SYMBOL
 292 void sci_delete_marker_at_line(ScintillaObject *sci, gint line_number, gint marker)
 293 {
 294         SSM(sci, SCI_MARKERDELETE, (uptr_t) line_number, marker);
 295 }
 296
 297
 298 /** Checks if a line has a marker set.
 299  * @param sci Scintilla widget.
 300  * @param line Line number.
 301  * @param marker Marker number.
 302  * @return Whether it's set. */
 303 GEANY_API_SYMBOL
 304 gboolean sci_is_marker_set_at_line(ScintillaObject *sci, gint line, gint marker)
 305 {
 306         gint state;
 307
 308         state = (gint) SSM(sci, SCI_MARKERGET, (uptr_t) line, 0);
 309         return (state & (1 << marker));
 310 }
 311
 312
 313 void sci_toggle_marker_at_line(ScintillaObject *sci, gint line, gint marker)
 314 {
 315         gboolean set = sci_is_marker_set_at_line(sci, line, marker);
 316
 317         if (!set)
 318                 sci_set_marker_at_line(sci, line, marker);
 319         else
 320                 sci_delete_marker_at_line(sci, line, marker);
 321 }
 322
 323
 324 /* Returns the line number of the next marker that matches marker_mask, or -1.
 325  * marker_mask is a bitor of 1 << marker_index. (See MarkerHandleSet::MarkValue()).
 326  * Note: If there is a marker on the line, it returns the same line. */
 327 gint sci_marker_next(ScintillaObject *sci, gint line, gint marker_mask, gboolean wrap)
 328 {
 329         gint marker_line;
 330
 331         marker_line = (gint) SSM(sci, SCI_MARKERNEXT, (uptr_t) line, marker_mask);
 332         if (wrap && marker_line == -1)
 333                 marker_line = (gint) SSM(sci, SCI_MARKERNEXT, 0, marker_mask);
 334         return marker_line;
 335 }
 336
 337
 338 /* Returns the line number of the previous marker that matches marker_mask, or -1.
 339  * marker_mask is a bitor of 1 << marker_index. (See MarkerHandleSet::MarkValue()).
 340  * Note: If there is a marker on the line, it returns the same line. */
 341 gint sci_marker_previous(ScintillaObject *sci, gint line, gint marker_mask, gboolean wrap)
 342 {
 343         gint marker_line;
 344
 345         marker_line = (gint) SSM(sci, SCI_MARKERPREVIOUS, (uptr_t) line, marker_mask);
 346         if (wrap && marker_line == -1)
 347         {
 348                 gint len = sci_get_length(sci);
 349                 gint last_line = sci_get_line_from_position(sci, len - 1);
 350
 351                 marker_line = (gint) SSM(sci, SCI_MARKERPREVIOUS, (uptr_t) last_line, marker_mask);
 352         }
 353         return marker_line;
 354 }
 355
 356
 357 /** Gets the line number from @a position.
 358  * @param sci Scintilla widget.
 359  * @param position Position.
 360  * @return The line. */
 361 GEANY_API_SYMBOL
 362 gint sci_get_line_from_position(ScintillaObject *sci, gint position)
 363 {
 364         return (gint) SSM(sci, SCI_LINEFROMPOSITION, (uptr_t) position, 0);
 365 }
 366
 367
 368 /** Gets the column number relative to the start of the line that @a position is on.
 369  * @param sci Scintilla widget.
 370  * @param position Position.
 371  * @return The column. */
 372 GEANY_API_SYMBOL
 373 gint sci_get_col_from_position(ScintillaObject *sci, gint position)
 374 {
 375         return (gint) SSM(sci, SCI_GETCOLUMN, (uptr_t) position, 0);
 376 }
 377
 378
 379 gint sci_get_position_from_col(ScintillaObject *sci, gint line, gint col)
 380 {
 381         return (gint) SSM(sci, SCI_FINDCOLUMN, line, col);
 382 }
 383
 384
 385 /** Gets the position for the start of @a line.
 386  * @param sci Scintilla widget.
 387  * @param line Line.
 388  * @return Position. */
 389 GEANY_API_SYMBOL
 390 gint sci_get_position_from_line(ScintillaObject *sci, gint line)
 391 {
 392         return (gint) SSM(sci, SCI_POSITIONFROMLINE, (uptr_t) line, 0);
 393 }
 394
 395
 396 /** Gets the cursor position.
 397  * @param sci Scintilla widget.
 398  * @return Position. */
 399 GEANY_API_SYMBOL
 400 gint sci_get_current_position(ScintillaObject *sci)
 401 {
 402         return (gint) SSM(sci, SCI_GETCURRENTPOS, 0, 0);
 403 }
 404
 405
 406 gint sci_get_cursor_virtual_space(ScintillaObject *sci)
 407 {
 408         gint selection_mode = sci_get_selection_mode(sci);
 409
 410         return selection_mode == SC_SEL_RECTANGLE || selection_mode == SC_SEL_THIN ?
 411                 SSM(sci, SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE, 0, 0) :
 412                 SSM(sci, SCI_GETSELECTIONNCARETVIRTUALSPACE,
 413                         SSM(sci, SCI_GETMAINSELECTION, 0, 0), 0);
 414 }
 415
 416
 417 /** Sets the cursor position.
 418  * @param sci Scintilla widget.
 419  * @param position Position.
 420  * @param scroll_to_caret Whether to scroll the cursor in view. */
 421 GEANY_API_SYMBOL
 422 void sci_set_current_position(ScintillaObject *sci, gint position, gboolean scroll_to_caret)
 423 {
 424         if (scroll_to_caret)
 425                 SSM(sci, SCI_GOTOPOS, (uptr_t) position, 0);
 426         else
 427         {
 428                 SSM(sci, SCI_SETCURRENTPOS, (uptr_t) position, 0);
 429                 SSM(sci, SCI_SETANCHOR, (uptr_t) position, 0); /* to avoid creation of a selection */
 430         }
 431         SSM(sci, SCI_CHOOSECARETX, 0, 0);
 432 }
 433
 434
 435 /* Set the cursor line without scrolling the view.
 436  * Use sci_goto_line() to also scroll. */
 437 void sci_set_current_line(ScintillaObject *sci, gint line)
 438 {
 439         gint pos = sci_get_position_from_line(sci, line);
 440         sci_set_current_position(sci, pos, FALSE);
 441 }
 442
 443
 444 /** Gets the total number of lines.
 445  * @param sci Scintilla widget.
 446  * @return The line count. */
 447 GEANY_API_SYMBOL
 448 gint sci_get_line_count(ScintillaObject *sci)
 449 {
 450         return (gint) SSM(sci, SCI_GETLINECOUNT, 0, 0);
 451 }
 452
 453
 454 /** Sets the selection start position.
 455  * @param sci Scintilla widget.
 456  * @param position Position. */
 457 GEANY_API_SYMBOL
 458 void sci_set_selection_start(ScintillaObject *sci, gint position)
 459 {
 460         SSM(sci, SCI_SETSELECTIONSTART, (uptr_t) position, 0);
 461 }
 462
 463
 464 /** Sets the selection end position.
 465  * @param sci Scintilla widget.
 466  * @param position Position. */
 467 GEANY_API_SYMBOL
 468 void sci_set_selection_end(ScintillaObject *sci, gint position)
 469 {
 470         SSM(sci, SCI_SETSELECTIONEND, (uptr_t) position, 0);
 471 }
 472
 473
 474 void sci_set_selection(ScintillaObject *sci, gint anchorPos, gint currentPos)
 475 {
 476         SSM(sci, SCI_SETSEL, (uptr_t) anchorPos, currentPos);
 477 }
 478
 479
 480 /** Gets the position at the end of a line
 481  * @param sci Scintilla widget.
 482  * @param line Line.
 483  * @return The position at the end of the line. */
 484 GEANY_API_SYMBOL
 485 gint sci_get_line_end_position(ScintillaObject *sci, gint line)
 486 {
 487         return (gint) SSM(sci, SCI_GETLINEENDPOSITION, (uptr_t) line, 0);
 488 }
 489
 490
 491 void sci_cut(ScintillaObject *sci)
 492 {
 493         SSM(sci, SCI_CUT, 0, 0);
 494 }
 495
 496
 497 void sci_copy(ScintillaObject *sci)
 498 {
 499         SSM(sci, SCI_COPY, 0, 0);
 500 }
 501
 502
 503 void sci_paste(ScintillaObject *sci)
 504 {
 505         SSM(sci, SCI_PASTE, 0, 0);
 506 }
 507
 508
 509 void sci_clear(ScintillaObject *sci)
 510 {
 511         SSM(sci, SCI_CLEAR, 0, 0);
 512 }
 513
 514
 515 /** Gets the selection start position.
 516  * @param sci Scintilla widget.
 517  * @return Position. */
 518 GEANY_API_SYMBOL
 519 gint sci_get_selection_start(ScintillaObject *sci)
 520 {
 521         return (gint) SSM(sci, SCI_GETSELECTIONSTART, 0, 0);
 522 }
 523
 524
 525 /** Gets the selection end position.
 526  * @param sci Scintilla widget.
 527  * @return Position. */
 528 GEANY_API_SYMBOL
 529 gint sci_get_selection_end(ScintillaObject *sci)
 530 {
 531         return (gint) SSM(sci, SCI_GETSELECTIONEND, 0, 0);
 532 }
 533
 534
 535 /** Replaces selection.
 536  * @param sci Scintilla widget.
 537  * @param text Text. */
 538 GEANY_API_SYMBOL
 539 void sci_replace_sel(ScintillaObject *sci, const gchar *text)
 540 {
 541         SSM(sci, SCI_REPLACESEL, 0, (sptr_t) text);
 542 }
 543
 544
 545 /** Gets the length of all text.
 546  * @param sci Scintilla widget.
 547  * @return Length. */
 548 GEANY_API_SYMBOL
 549 gint sci_get_length(ScintillaObject *sci)
 550 {
 551         return (gint) SSM(sci, SCI_GETLENGTH, 0, 0);
 552 }
 553
 554
 555 /** Gets the currently used lexer
 556  * @param sci Scintilla widget.
 557  * @returns The lexer ID
 558  */
 559 GEANY_API_SYMBOL
 560 gint sci_get_lexer(ScintillaObject *sci)
 561 {
 562         return (gint) SSM(sci, SCI_GETLEXER, 0, 0);
 563 }
 564
 565
 566 void sci_set_lexer(ScintillaObject *sci, guint lexer_id)
 567 {
 568         gint old = sci_get_lexer(sci);
 569
 570         SSM(sci, SCI_SETLEXER, lexer_id, 0);
 571
 572         if (old != (gint)lexer_id)
 573                 SSM(sci, SCI_CLEARDOCUMENTSTYLE, 0, 0);
 574 }
 575
 576
 577 /** Gets line length.
 578  * @param sci Scintilla widget.
 579  * @param line Line number.
 580  * @return Length. */
 581 GEANY_API_SYMBOL
 582 gint sci_get_line_length(ScintillaObject *sci, gint line)
 583 {
 584         return (gint) SSM(sci, SCI_LINELENGTH, (uptr_t) line, 0);
 585 }
 586
 587
 588 /* safe way to read Scintilla string into new memory.
 589  * works with any string buffer messages that follow the Windows message convention. */
 590 gchar *sci_get_string(ScintillaObject *sci, guint msg, gulong wParam)
 591 {
 592         gint size = (gint) SSM(sci, msg, wParam, 0);
 593         gchar *str = g_malloc(size + 1);
 594
 595         SSM(sci, msg, wParam, (sptr_t) str);
 596         str[size] = '\0';       /* ensure termination, needed for SCI_GETLINE */
 597         return str;
 598 }
 599
 600
 601 /** Gets line contents.
 602  * @param sci Scintilla widget.
 603  * @param line_num Line number.
 604  * @return A @c NULL-terminated copy of the line text. */
 605 GEANY_API_SYMBOL
 606 gchar *sci_get_line(ScintillaObject *sci, gint line_num)
 607 {
 608         return sci_get_string(sci, SCI_GETLINE, (gulong) line_num);
 609 }
 610
 611
 612 /** Gets all text.
 613  * @deprecated sci_get_text is deprecated and should not be used in newly-written code.
 614  * Use sci_get_contents() instead.
 615  *
 616  * @param sci Scintilla widget.
 617  * @param len Length of @a text buffer, usually sci_get_length() + 1.
 618  * @param text Text buffer; must be allocated @a len + 1 bytes for null-termination. */
 619 GEANY_API_SYMBOL
 620 void sci_get_text(ScintillaObject *sci, gint len, gchar *text)
 621 {
 622         SSM(sci, SCI_GETTEXT, (uptr_t) len, (sptr_t) text);
 623 }
 624
 625
 626 /** Allocates and fills a buffer with text from the start of the document.
 627  * @param sci Scintilla widget.
 628  * @param buffer_len Buffer length to allocate, including the terminating
 629  * null char, e.g. sci_get_length() + 1. Alternatively use @c -1 to get all
 630  * text (since Geany 1.23).
 631  * @return A copy of the text. Should be freed when no longer needed.
 632  *
 633  * @since 1.23 (0.17)
 634  */
 635 GEANY_API_SYMBOL
 636 gchar *sci_get_contents(ScintillaObject *sci, gint buffer_len)
 637 {
 638         gchar *text;
 639
 640         if (buffer_len < 0)
 641                 buffer_len = sci_get_length(sci) + 1;
 642
 643         text = g_malloc(buffer_len);
 644         SSM(sci, SCI_GETTEXT, (uptr_t) buffer_len, (sptr_t) text);
 645         return text;
 646 }
 647
 648
 649 /** Gets selected text.
 650  * @deprecated sci_get_selected_text is deprecated and should not be used in newly-written code.
 651  * Use sci_get_selection_contents() instead.
 652  *
 653  * @param sci Scintilla widget.
 654  * @param text Text buffer; must be allocated sci_get_selected_text_length() + 1 bytes
 655  * for null-termination. */
 656 GEANY_API_SYMBOL
 657 void sci_get_selected_text(ScintillaObject *sci, gchar *text)
 658 {
 659         SSM(sci, SCI_GETSELTEXT, 0, (sptr_t) text);
 660 }
 661
 662
 663 /** Gets selected text.
 664  * @param sci Scintilla widget.
 665  *
 666  * @return The selected text. Should be freed when no longer needed.
 667  *
 668  * @since 0.17
 669  */
 670 GEANY_API_SYMBOL
 671 gchar *sci_get_selection_contents(ScintillaObject *sci)
 672 {
 673         return sci_get_string(sci, SCI_GETSELTEXT, 0);
 674 }
 675
 676
 677 /** Gets selected text length.
 678  * @param sci Scintilla widget.
 679  * @return Length. */
 680 GEANY_API_SYMBOL
 681 gint sci_get_selected_text_length(ScintillaObject *sci)
 682 {
 683         return (gint) SSM(sci, SCI_GETSELTEXT, 0, 0);
 684 }
 685
 686
 687 gint sci_get_position_from_xy(ScintillaObject *sci, gint x, gint y, gboolean nearby)
 688 {
 689         /* for nearby return -1 if there is no character near to the x,y point. */
 690         return (gint) SSM(sci, (nearby) ? SCI_POSITIONFROMPOINTCLOSE : SCI_POSITIONFROMPOINT, (uptr_t) x, y);
 691 }
 692
 693
 694 /** Checks if a line is visible (folding may have hidden it).
 695  * @param sci Scintilla widget.
 696  * @param line Line number.
 697  * @return Whether @a line will be drawn on the screen. */
 698 GEANY_API_SYMBOL
 699 gboolean sci_get_line_is_visible(ScintillaObject *sci, gint line)
 700 {
 701         return SSM(sci, SCI_GETLINEVISIBLE, (uptr_t) line, 0) != FALSE;
 702 }
 703
 704
 705 /** Makes @a line visible (folding may have hidden it).
 706  * @param sci Scintilla widget.
 707  * @param line Line number. */
 708 GEANY_API_SYMBOL
 709 void sci_ensure_line_is_visible(ScintillaObject *sci, gint line)
 710 {
 711         SSM(sci, SCI_ENSUREVISIBLE, (uptr_t) line, 0);
 712 }
 713
 714
 715 gint sci_get_fold_level(ScintillaObject *sci, gint line)
 716 {
 717         return (gint) SSM(sci, SCI_GETFOLDLEVEL, (uptr_t) line, 0);
 718 }
 719
 720
 721 /* Get the line number of the fold point before start_line, or -1 if there isn't one */
 722 gint sci_get_fold_parent(ScintillaObject *sci, gint start_line)
 723 {
 724         return (gint) SSM(sci, SCI_GETFOLDPARENT, (uptr_t) start_line, 0);
 725 }
 726
 727
 728 void sci_toggle_fold(ScintillaObject *sci, gint line)
 729 {
 730         SSM(sci, SCI_TOGGLEFOLD, (uptr_t) line, 0);
 731 }
 732
 733
 734 gboolean sci_get_fold_expanded(ScintillaObject *sci, gint line)
 735 {
 736         return SSM(sci, SCI_GETFOLDEXPANDED, (uptr_t) line, 0) != FALSE;
 737 }
 738
 739
 740 void sci_colourise(ScintillaObject *sci, gint start, gint end)
 741 {
 742         SSM(sci, SCI_COLOURISE, (uptr_t) start, end);
 743 }
 744
 745
 746 void sci_clear_all(ScintillaObject *sci)
 747 {
 748         SSM(sci, SCI_CLEARALL, 0, 0);
 749 }
 750
 751
 752 gint sci_get_end_styled(ScintillaObject *sci)
 753 {
 754         return (gint) SSM(sci, SCI_GETENDSTYLED, 0, 0);
 755 }
 756
 757
 758 void sci_set_tab_width(ScintillaObject *sci, gint width)
 759 {
 760         SSM(sci, SCI_SETTABWIDTH, (uptr_t) width, 0);
 761 }
 762
 763
 764 /** Gets display tab width (this is not indent width, see GeanyIndentPrefs).
 765  * @param sci Scintilla widget.
 766  * @return Width.
 767  *
 768  * @since 0.15
 769  **/
 770 GEANY_API_SYMBOL
 771 gint sci_get_tab_width(ScintillaObject *sci)
 772 {
 773         return (gint) SSM(sci, SCI_GETTABWIDTH, 0, 0);
 774 }
 775
 776
 777 /** Gets a character.
 778  * @param sci Scintilla widget.
 779  * @param pos Position.
 780  * @return Char. */
 781 GEANY_API_SYMBOL
 782 gchar sci_get_char_at(ScintillaObject *sci, gint pos)
 783 {
 784         return (gchar) SSM(sci, SCI_GETCHARAT, (uptr_t) pos, 0);
 785 }
 786
 787
 788 void sci_set_savepoint(ScintillaObject *sci)
 789 {
 790         SSM(sci, SCI_SETSAVEPOINT, 0, 0);
 791 }
 792
 793
 794 void sci_set_indentation_guides(ScintillaObject *sci, gint mode)
 795 {
 796         SSM(sci, SCI_SETINDENTATIONGUIDES, (uptr_t) mode, 0);
 797 }
 798
 799
 800 void sci_use_popup(ScintillaObject *sci, gboolean enable)
 801 {
 802         SSM(sci, SCI_USEPOPUP, enable != FALSE, 0);
 803 }
 804
 805
 806 /** Checks if there's a selection.
 807  * @param sci Scintilla widget.
 808  * @return Whether a selection is present.
 809  *
 810  * @since 0.15
 811  **/
 812 GEANY_API_SYMBOL
 813 gboolean sci_has_selection(ScintillaObject *sci)
 814 {
 815         if (SSM(sci, SCI_GETSELECTIONEND, 0, 0) - SSM(sci, SCI_GETSELECTIONSTART, 0, 0))
 816                 return TRUE;
 817         else
 818                 return FALSE;
 819 }
 820
 821
 822 void sci_goto_pos(ScintillaObject *sci, gint pos, gboolean unfold)
 823 {
 824         if (unfold) SSM(sci, SCI_ENSUREVISIBLE, (uptr_t) SSM(sci, SCI_LINEFROMPOSITION, (uptr_t) pos, 0), 0);
 825         SSM(sci, SCI_GOTOPOS, (uptr_t) pos, 0);
 826 }
 827
 828
 829 void sci_set_search_anchor(ScintillaObject *sci)
 830 {
 831         SSM(sci, SCI_SEARCHANCHOR, 0, 0);
 832 }
 833
 834
 835 /* removes a selection if pos < 0 */
 836 void sci_set_anchor(ScintillaObject *sci, gint pos)
 837 {
 838         if (pos < 0)
 839                 pos = sci_get_current_position(sci);
 840
 841         SSM(sci, SCI_SETANCHOR, (uptr_t) pos, 0);
 842 }
 843
 844
 845 /** Scrolls the cursor in view.
 846  * @param sci Scintilla widget. */
 847 GEANY_API_SYMBOL
 848 void sci_scroll_caret(ScintillaObject *sci)
 849 {
 850         SSM(sci, SCI_SCROLLCARET, 0, 0);
 851 }
 852
 853
 854 void sci_scroll_columns(ScintillaObject *sci, gint columns)
 855 {
 856         SSM(sci, SCI_LINESCROLL, (uptr_t) columns, 0);
 857 }
 858
 859
 860 gint sci_search_next(ScintillaObject *sci, gint flags, const gchar *text)
 861 {
 862         /* FIXME: SCI_SEACHNEXT() actually returns long */
 863         return (gint) SSM(sci, SCI_SEARCHNEXT, (uptr_t) flags, (sptr_t) text);
 864 }
 865
 866
 867 gint sci_search_prev(ScintillaObject *sci, gint flags, const gchar *text)
 868 {
 869         /* FIXME: SCI_SEACHPREV() actually returns long */
 870         return (gint) SSM(sci, SCI_SEARCHPREV, (uptr_t) flags, (sptr_t) text);
 871 }
 872
 873
 874 /** Finds text in the document.
 875  * The @a ttf argument should be a pointer to a Sci_TextToFind structure which contains
 876  * the text to find and the range in which the text should be searched.
 877  *
 878  * Please refer to the Scintilla documentation for a more detailed description.
 879  *
 880  * @param sci Scintilla widget.
 881  * @param flags Bitmask of Scintilla search flags (@c SCFIND_*, see Scintilla documentation).
 882  * @param ttf Pointer to a TextToFind structure which contains the text to find and the range.
 883  * @return The position of the start of the found text if it succeeds, otherwise @c -1.
 884  *         The @c chrgText.cpMin and @c chrgText.cpMax members of @c TextToFind are filled in
 885  *         with the start and end positions of the found text.
 886  */
 887 GEANY_API_SYMBOL
 888 gint sci_find_text(ScintillaObject *sci, gint flags, struct Sci_TextToFind *ttf)
 889 {
 890         return (gint) SSM(sci, SCI_FINDTEXT, (uptr_t) flags, (sptr_t) ttf);
 891 }
 892
 893
 894 /** Sets the font for a particular style.
 895  * @param sci Scintilla widget.
 896  * @param style The style.
 897  * @param font The font name.
 898  * @param size The font size. */
 899 GEANY_API_SYMBOL
 900 void sci_set_font(ScintillaObject *sci, gint style, const gchar *font, gint size)
 901 {
 902         SSM(sci, SCI_STYLESETFONT, (uptr_t) style, (sptr_t) font);
 903         SSM(sci, SCI_STYLESETSIZE, (uptr_t) style, size);
 904 }
 905
 906
 907 /** Jumps to the specified line in the document.
 908  * If @a unfold is set and @a line is hidden by a fold, it is unfolded
 909  * first to ensure it is visible.
 910  * @param sci Scintilla widget.
 911  * @param line Line.
 912  * @param unfold Whether to unfold first.
 913  */
 914 GEANY_API_SYMBOL
 915 void sci_goto_line(ScintillaObject *sci, gint line, gboolean unfold)
 916 {
 917         if (unfold) SSM(sci, SCI_ENSUREVISIBLE, (uptr_t) line, 0);
 918         SSM(sci, SCI_GOTOLINE, (uptr_t) line, 0);
 919 }
 920
 921
 922 void sci_marker_delete_all(ScintillaObject *sci, gint marker)
 923 {
 924         SSM(sci, SCI_MARKERDELETEALL, (uptr_t) marker, 0);
 925 }
 926
 927
 928 /** Gets style ID at @a position.
 929  * @param sci Scintilla widget.
 930  * @param position Position.
 931  * @return Style ID. */
 932 GEANY_API_SYMBOL
 933 gint sci_get_style_at(ScintillaObject *sci, gint position)
 934 {
 935         return (gint) SSM(sci, SCI_GETSTYLEAT, (uptr_t) position, 0);
 936 }
 937
 938
 939 void sci_set_codepage(ScintillaObject *sci, gint cp)
 940 {
 941         g_return_if_fail(cp == 0 || cp == SC_CP_UTF8);
 942         SSM(sci, SCI_SETCODEPAGE, (uptr_t) cp, 0);
 943 }
 944
 945
 946 void sci_assign_cmdkey(ScintillaObject *sci, gint key, gint command)
 947 {
 948         SSM(sci, SCI_ASSIGNCMDKEY, (uptr_t) key, command);
 949 }
 950
 951
 952 void sci_clear_cmdkey(ScintillaObject *sci, gint key)
 953 {
 954         SSM(sci, SCI_CLEARCMDKEY, (uptr_t) key, 0);
 955 }
 956
 957
 958 /** Gets text between @a start and @a end.
 959  * @deprecated sci_get_text_range is deprecated and should not be used in newly-written code.
 960  * Use sci_get_contents_range() instead.
 961  *
 962  * @param sci Scintilla widget.
 963  * @param start Start.
 964  * @param end End.
 965  * @param text Text will be zero terminated and must be allocated (end - start + 1) bytes. */
 966 GEANY_API_SYMBOL
 967 void sci_get_text_range(ScintillaObject *sci, gint start, gint end, gchar *text)
 968 {
 969         struct Sci_TextRange tr;
 970         tr.chrg.cpMin = start;
 971         tr.chrg.cpMax = end;
 972         tr.lpstrText = text;
 973         SSM(sci, SCI_GETTEXTRANGE, 0, (sptr_t) &tr);
 974 }
 975
 976
 977 /** Gets text between @a start and @a end.
 978  * @param sci Scintilla widget.
 979  * @param start Start position.
 980  * @param end End position.
 981  * @return The text inside the given range. Should be freed when no longer needed.
 982  *
 983  * @since 0.17
 984  */
 985 GEANY_API_SYMBOL
 986 gchar *sci_get_contents_range(ScintillaObject *sci, gint start, gint end)
 987 {
 988         gchar *text;
 989
 990         g_return_val_if_fail(start < end, NULL);
 991
 992         text = g_malloc((gsize) (end - start) + 1);
 993         sci_get_text_range(sci, start, end, text);
 994         return text;
 995 }
 996
 997
 998 void sci_line_duplicate(ScintillaObject *sci)
 999 {
1000         SSM(sci, SCI_LINEDUPLICATE, 0, 0);
1001 }
1002
1003
1004 void sci_selection_duplicate(ScintillaObject *sci)
1005 {
1006         SSM(sci, SCI_SELECTIONDUPLICATE, 0, 0);
1007 }
1008
1009
1010 /** Inserts text.
1011  * @param sci Scintilla widget.
1012  * @param pos Position, or -1 for current.
1013  * @param text Text. */
1014 GEANY_API_SYMBOL
1015 void sci_insert_text(ScintillaObject *sci, gint pos, const gchar *text)
1016 {
1017         SSM(sci, SCI_INSERTTEXT, (uptr_t) pos, (sptr_t) text);
1018 }
1019
1020
1021 GEANY_API_SYMBOL
1022 void sci_set_target_start(ScintillaObject *sci, gint start)
1023 {
1024         SSM(sci, SCI_SETTARGETSTART, (uptr_t) start, 0);
1025 }
1026
1027
1028 GEANY_API_SYMBOL
1029 void sci_set_target_end(ScintillaObject *sci, gint end)
1030 {
1031         SSM(sci, SCI_SETTARGETEND, (uptr_t) end, 0);
1032 }
1033
1034
1035 GEANY_API_SYMBOL
1036 gint sci_replace_target(ScintillaObject *sci, const gchar *text, gboolean regex)
1037 {
1038         return (gint) SSM(sci, (regex) ? SCI_REPLACETARGETRE : SCI_REPLACETARGET, (uptr_t) -1, (sptr_t) text);
1039 }
1040
1041
1042 void sci_set_keywords(ScintillaObject *sci, guint k, const gchar *text)
1043 {
1044         SSM(sci, SCI_SETKEYWORDS, k, (sptr_t) text);
1045 }
1046
1047
1048 void sci_set_readonly(ScintillaObject *sci, gboolean readonly)
1049 {
1050         SSM(sci, SCI_SETREADONLY, readonly != FALSE, 0);
1051 }
1052
1053
1054 /** Sends Scintilla commands without any parameters.
1055  * @param sci The Scintilla @c GtkWidget.
1056  * @param cmd @c SCI_COMMAND.
1057  * @see http://scintilla.org for the documentation.
1058  *
1059  *  @since 0.16
1060  */
1061 GEANY_API_SYMBOL
1062 void sci_send_command(ScintillaObject *sci, gint cmd)
1063 {
1064         SSM(sci, cmd, 0, 0);
1065 }
1066
1067
1068 /** Gets current line number.
1069  * @param sci Scintilla widget.
1070  * @return Line number. */
1071 GEANY_API_SYMBOL
1072 gint sci_get_current_line(ScintillaObject *sci)
1073 {
1074         return (gint) SSM(sci, SCI_LINEFROMPOSITION, (uptr_t) SSM(sci, SCI_GETCURRENTPOS, 0, 0), 0);
1075 }
1076
1077
1078 /* Get number of lines partially or fully selected.
1079  * Returns 1 if there is a partial selection on the same line.
1080  * Returns 2 if a whole line is selected including the line break char(s). */
1081 gint sci_get_lines_selected(ScintillaObject *sci)
1082 {
1083         gint start = (gint) SSM(sci, SCI_GETSELECTIONSTART, 0, 0);
1084         gint end = (gint) SSM(sci, SCI_GETSELECTIONEND, 0, 0);
1085         gint line_start;
1086         gint line_end;
1087
1088         if (start == end)
1089                 return 0; /* no selection */
1090
1091         line_start = (gint) SSM(sci, SCI_LINEFROMPOSITION, (uptr_t) start, 0);
1092         line_end = (gint) SSM(sci, SCI_LINEFROMPOSITION, (uptr_t) end, 0);
1093
1094         return line_end - line_start + 1;
1095 }
1096
1097
1098 gint sci_get_first_visible_line(ScintillaObject *sci)
1099 {
1100         return (gint) SSM(sci, SCI_GETFIRSTVISIBLELINE, 0, 0);
1101 }
1102
1103
1104 /**
1105  *  Sets the current indicator. This is necessary to define an indicator for a range of text or
1106  *  clearing indicators for a range of text.
1107  *
1108  *  @param sci Scintilla widget.
1109  *  @param indic The indicator number to set.
1110  *
1111  *  @see sci_indicator_clear
1112  *
1113  *  @since 0.16
1114  */
1115 GEANY_API_SYMBOL
1116 void sci_indicator_set(ScintillaObject *sci, gint indic)
1117 {
1118         SSM(sci, SCI_SETINDICATORCURRENT, (uptr_t) indic, 0);
1119 }
1120
1121
1122 void sci_indicator_fill(ScintillaObject *sci, gint pos, gint len)
1123 {
1124         SSM(sci, SCI_INDICATORFILLRANGE, (uptr_t) pos, len);
1125 }
1126
1127
1128 /**
1129  *  Clears the currently set indicator from a range of text.
1130  *  Starting at @a pos, @a len characters long.
1131  *  In order to make this function properly, you need to set the current indicator before with
1132  *  @ref sci_indicator_set().
1133  *
1134  *  @param sci Scintilla widget.
1135  *  @param pos Starting position.
1136  *  @param len Length.
1137  *
1138  *  @since 0.16
1139  */
1140 GEANY_API_SYMBOL
1141 void sci_indicator_clear(ScintillaObject *sci, gint pos, gint len)
1142 {
1143         SSM(sci, SCI_INDICATORCLEARRANGE, (uptr_t) pos, len);
1144 }
1145
1146
1147 void sci_select_all(ScintillaObject *sci)
1148 {
1149         SSM(sci, SCI_SELECTALL, 0, 0);
1150 }
1151
1152
1153 gint sci_get_line_indent_position(ScintillaObject *sci, gint line)
1154 {
1155         return (gint) SSM(sci, SCI_GETLINEINDENTPOSITION, (uptr_t) line, 0);
1156 }
1157
1158
1159 void sci_set_autoc_max_height(ScintillaObject *sci, gint val)
1160 {
1161         SSM(sci, SCI_AUTOCSETMAXHEIGHT, (uptr_t) val, 0);
1162 }
1163
1164
1165 /** Finds a matching brace at @a pos.
1166  * @param sci Scintilla widget.
1167  * @param pos Position.
1168  * @return Matching brace position.
1169  *
1170  * @since 0.15
1171  **/
1172 GEANY_API_SYMBOL
1173 gint sci_find_matching_brace(ScintillaObject *sci, gint pos)
1174 {
1175         return (gint) SSM(sci, SCI_BRACEMATCH, (uptr_t) pos, 0);
1176 }
1177
1178
1179 gint sci_get_overtype(ScintillaObject *sci)
1180 {
1181         return (gint) SSM(sci, SCI_GETOVERTYPE, 0, 0);
1182 }
1183
1184
1185 void sci_set_tab_indents(ScintillaObject *sci, gboolean set)
1186 {
1187         SSM(sci, SCI_SETTABINDENTS, set != FALSE, 0);
1188 }
1189
1190
1191 void sci_set_use_tabs(ScintillaObject *sci, gboolean set)
1192 {
1193         SSM(sci, SCI_SETUSETABS, set != FALSE, 0);
1194 }
1195
1196
1197 gint sci_get_pos_at_line_sel_start(ScintillaObject *sci, gint line)
1198 {
1199         return (gint) SSM(sci, SCI_GETLINESELSTARTPOSITION, (uptr_t) line, 0);
1200 }
1201
1202
1203 gint sci_get_pos_at_line_sel_end(ScintillaObject *sci, gint line)
1204 {
1205         return (gint) SSM(sci, SCI_GETLINESELENDPOSITION, (uptr_t) line, 0);
1206 }
1207
1208
1209 /** Gets selection mode.
1210  * @param sci Scintilla widget.
1211  * @return Selection mode. */
1212 GEANY_API_SYMBOL
1213 gint sci_get_selection_mode(ScintillaObject *sci)
1214 {
1215         return (gint) SSM(sci, SCI_GETSELECTIONMODE, 0, 0);
1216 }
1217
1218
1219 /** Sets selection mode.
1220  * @param sci Scintilla widget.
1221  * @param mode Mode. */
1222 GEANY_API_SYMBOL
1223 void sci_set_selection_mode(ScintillaObject *sci, gint mode)
1224 {
1225         SSM(sci, SCI_SETSELECTIONMODE, (uptr_t) mode, 0);
1226 }
1227
1228
1229 void sci_set_scrollbar_mode(ScintillaObject *sci, gboolean visible)
1230 {
1231         SSM(sci, SCI_SETHSCROLLBAR, visible != FALSE, 0);
1232         SSM(sci, SCI_SETVSCROLLBAR, visible != FALSE, 0);
1233 }
1234
1235
1236 /** Sets the indentation of a line.
1237  * @param sci Scintilla widget.
1238  * @param line Line to indent.
1239  * @param indent Indentation width.
1240  *
1241  * @since 0.19
1242  */
1243 GEANY_API_SYMBOL
1244 void sci_set_line_indentation(ScintillaObject *sci, gint line, gint indent)
1245 {
1246         SSM(sci, SCI_SETLINEINDENTATION, (uptr_t) line, indent);
1247 }
1248
1249
1250 /** Gets the indentation width of a line.
1251  * @param sci Scintilla widget.
1252  * @param line Line to get the indentation from.
1253  * @return Indentation width.
1254  *
1255  * @since 0.19
1256  */
1257 GEANY_API_SYMBOL
1258 gint sci_get_line_indentation(ScintillaObject *sci, gint line)
1259 {
1260         return (gint) SSM(sci, SCI_GETLINEINDENTATION, (uptr_t) line, 0);
1261 }
1262
1263
1264 void sci_set_caret_policy_x(ScintillaObject *sci, gint policy, gint slop)
1265 {
1266         SSM(sci, SCI_SETXCARETPOLICY, (uptr_t) policy, slop);
1267 }
1268
1269
1270 void sci_set_caret_policy_y(ScintillaObject *sci, gint policy, gint slop)
1271 {
1272         SSM(sci, SCI_SETYCARETPOLICY, (uptr_t) policy, slop);
1273 }
1274
1275
1276 void sci_set_scroll_stop_at_last_line(ScintillaObject *sci, gboolean set)
1277 {
1278         SSM(sci, SCI_SETENDATLASTLINE, set != FALSE, 0);
1279 }
1280
1281
1282 void sci_cancel(ScintillaObject *sci)
1283 {
1284         SSM(sci, SCI_CANCEL, 0, 0);
1285 }
1286
1287
1288 gint sci_get_position_after(ScintillaObject *sci, gint start)
1289 {
1290         return (gint) SSM(sci, SCI_POSITIONAFTER, (uptr_t) start, 0);
1291 }
1292
1293
1294 void sci_lines_join(ScintillaObject *sci)
1295 {
1296         SSM(sci, SCI_LINESJOIN, 0, 0);
1297 }
1298
1299
1300 gint sci_text_width(ScintillaObject *sci, gint styleNumber, const gchar *text)
1301 {
1302         return (gint) SSM(sci, SCI_TEXTWIDTH, (uptr_t) styleNumber, (sptr_t) text);
1303 }
1304
1305
1306 void sci_move_selected_lines_down(ScintillaObject *sci)
1307 {
1308         SSM(sci, SCI_MOVESELECTEDLINESDOWN, 0, 0);
1309 }
1310
1311
1312 void sci_move_selected_lines_up(ScintillaObject *sci)
1313 {
1314         SSM(sci, SCI_MOVESELECTEDLINESUP, 0, 0);
1315 }
1316
1317
1318 gint sci_word_start_position(ScintillaObject *sci, gint position, gboolean onlyWordCharacters)
1319 {
1320         return SSM(sci, SCI_WORDSTARTPOSITION, position, onlyWordCharacters);
1321 }
1322
1323
1324 gint sci_word_end_position(ScintillaObject *sci, gint position, gboolean onlyWordCharacters)
1325 {
1326         return SSM(sci, SCI_WORDENDPOSITION, position, onlyWordCharacters);
1327 }
1328