2 * editor.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * Editor-related functions for @ref GeanyEditor.
24 * Geany uses the Scintilla editing widget, and this file is mostly built around
25 * Scintilla's functionality.
28 /* Callbacks for the Scintilla widget (ScintillaObject).
29 * Most important is the sci-notify callback, handled in on_editor_notification().
30 * This includes auto-indentation, comments, auto-completion, calltips, etc.
31 * Also some general Scintilla-related functions.
41 #include "callbacks.h"
43 #include "documentprivate.h"
44 #include "filetypesprivate.h"
45 #include "geanyobject.h"
46 #include "highlighting.h"
47 #include "keybindings.h"
50 #include "projectprivate.h"
51 #include "sciwrappers.h"
54 #include "templates.h"
64 #include <gdk/gdkkeysyms.h>
67 static GHashTable
*snippet_hash
= NULL
;
68 static GtkAccelGroup
*snippet_accel_group
= NULL
;
69 static gboolean autocomplete_scope_shown
= FALSE
;
71 static const gchar geany_cursor_marker
[] = "__GEANY_CURSOR_MARKER__";
73 /* holds word under the mouse or keyboard cursor */
74 static gchar current_word
[GEANY_MAX_WORD_LENGTH
];
76 /* Initialised in keyfile.c. */
77 GeanyEditorPrefs editor_prefs
;
79 EditorInfo editor_info
= {current_word
, -1};
89 } calltip
= {NULL
, FALSE
, NULL
, 0, 0, NULL
};
91 static gchar indent
[100];
94 static void on_new_line_added(GeanyEditor
*editor
);
95 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
);
96 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
);
97 static void auto_multiline(GeanyEditor
*editor
, gint pos
);
98 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
);
99 static void close_block(GeanyEditor
*editor
, gint pos
);
100 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
);
101 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
102 const gchar
*wc
, gboolean stem
);
103 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
);
104 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
);
105 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
);
106 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
);
107 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
);
110 void editor_snippets_free(void)
112 g_hash_table_destroy(snippet_hash
);
113 gtk_window_remove_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
117 static void snippets_load(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
119 gsize i
, j
, len
= 0, len_keys
= 0;
120 gchar
**groups_user
, **groups_sys
;
121 gchar
**keys_user
, **keys_sys
;
125 /* keys are strings, values are GHashTables, so use g_free and g_hash_table_destroy */
127 g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, (GDestroyNotify
) g_hash_table_destroy
);
129 /* first read all globally defined auto completions */
130 groups_sys
= g_key_file_get_groups(sysconfig
, &len
);
131 for (i
= 0; i
< len
; i
++)
133 if (strcmp(groups_sys
[i
], "Keybindings") == 0)
135 keys_sys
= g_key_file_get_keys(sysconfig
, groups_sys
[i
], &len_keys
, NULL
);
136 /* create new hash table for the read section (=> filetype) */
137 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
138 g_hash_table_insert(snippet_hash
, g_strdup(groups_sys
[i
]), tmp
);
140 for (j
= 0; j
< len_keys
; j
++)
142 g_hash_table_insert(tmp
, g_strdup(keys_sys
[j
]),
143 utils_get_setting_string(sysconfig
, groups_sys
[i
], keys_sys
[j
], ""));
145 g_strfreev(keys_sys
);
147 g_strfreev(groups_sys
);
149 /* now read defined completions in user's configuration directory and add / replace them */
150 groups_user
= g_key_file_get_groups(userconfig
, &len
);
151 for (i
= 0; i
< len
; i
++)
153 if (strcmp(groups_user
[i
], "Keybindings") == 0)
155 keys_user
= g_key_file_get_keys(userconfig
, groups_user
[i
], &len_keys
, NULL
);
157 tmp
= g_hash_table_lookup(snippet_hash
, groups_user
[i
]);
159 { /* new key found, create hash table */
160 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
161 g_hash_table_insert(snippet_hash
, g_strdup(groups_user
[i
]), tmp
);
163 for (j
= 0; j
< len_keys
; j
++)
165 value
= g_hash_table_lookup(tmp
, keys_user
[j
]);
167 { /* value = NULL means the key doesn't yet exist, so insert */
168 g_hash_table_insert(tmp
, g_strdup(keys_user
[j
]),
169 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
172 { /* old key and value will be freed by destroy function (g_free) */
173 g_hash_table_replace(tmp
, g_strdup(keys_user
[j
]),
174 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
177 g_strfreev(keys_user
);
179 g_strfreev(groups_user
);
183 static gboolean
on_snippet_keybinding_activate(gchar
*key
)
185 GeanyDocument
*doc
= document_get_current();
188 if (!doc
|| !gtk_widget_has_focus(GTK_WIDGET(doc
->editor
->sci
)))
191 s
= snippets_find_completion_by_name(doc
->file_type
->name
, key
);
192 if (!s
) /* allow user to specify keybindings for "special" snippets */
194 GHashTable
*specials
= g_hash_table_lookup(snippet_hash
, "Special");
196 if (G_LIKELY(specials
!= NULL
))
197 s
= g_hash_table_lookup(specials
, key
);
205 editor_insert_snippet(doc
->editor
, sci_get_current_position(doc
->editor
->sci
), s
);
206 sci_scroll_caret(doc
->editor
->sci
);
212 static void add_kb(GKeyFile
*keyfile
, const gchar
*group
, gchar
**keys
)
218 for (i
= 0; i
< g_strv_length(keys
); i
++)
221 GdkModifierType mods
;
222 gchar
*accel_string
= g_key_file_get_value(keyfile
, group
, keys
[i
], NULL
);
224 gtk_accelerator_parse(accel_string
, &key
, &mods
);
226 if (key
== 0 && mods
== 0)
228 g_warning("Can not parse accelerator \"%s\" from user snippets.conf", accel_string
);
229 g_free(accel_string
);
232 g_free(accel_string
);
234 gtk_accel_group_connect(snippet_accel_group
, key
, mods
, 0,
235 g_cclosure_new_swap((GCallback
)on_snippet_keybinding_activate
,
236 g_strdup(keys
[i
]), (GClosureNotify
)g_free
));
241 static void load_kb(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
243 const gchar kb_group
[] = "Keybindings";
244 gchar
**keys
= g_key_file_get_keys(userconfig
, kb_group
, NULL
, NULL
);
247 /* remove overridden keys from system keyfile */
248 foreach_strv(ptr
, keys
)
249 g_key_file_remove_key(sysconfig
, kb_group
, *ptr
, NULL
);
251 add_kb(userconfig
, kb_group
, keys
);
254 keys
= g_key_file_get_keys(sysconfig
, kb_group
, NULL
, NULL
);
255 add_kb(sysconfig
, kb_group
, keys
);
260 void editor_snippets_init(void)
262 gchar
*sysconfigfile
, *userconfigfile
;
263 GKeyFile
*sysconfig
= g_key_file_new();
264 GKeyFile
*userconfig
= g_key_file_new();
266 sysconfigfile
= g_build_filename(app
->datadir
, "snippets.conf", NULL
);
267 userconfigfile
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
269 /* check for old autocomplete.conf files (backwards compatibility) */
270 if (! g_file_test(userconfigfile
, G_FILE_TEST_IS_REGULAR
))
271 SETPTR(userconfigfile
, g_build_filename(app
->configdir
, "autocomplete.conf", NULL
));
273 /* load the actual config files */
274 g_key_file_load_from_file(sysconfig
, sysconfigfile
, G_KEY_FILE_NONE
, NULL
);
275 g_key_file_load_from_file(userconfig
, userconfigfile
, G_KEY_FILE_NONE
, NULL
);
277 snippets_load(sysconfig
, userconfig
);
279 /* setup snippet keybindings */
280 snippet_accel_group
= gtk_accel_group_new();
281 gtk_window_add_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
282 load_kb(sysconfig
, userconfig
);
284 g_free(sysconfigfile
);
285 g_free(userconfigfile
);
286 g_key_file_free(sysconfig
);
287 g_key_file_free(userconfig
);
291 static gboolean
on_editor_button_press_event(GtkWidget
*widget
, GdkEventButton
*event
,
294 GeanyEditor
*editor
= data
;
295 GeanyDocument
*doc
= editor
->document
;
297 /* it's very unlikely we got a 'real' click even on 0, 0, so assume it is a
298 * fake event to show the editor menu triggered by a key event where we want to use the
299 * text cursor position. */
300 if (event
->x
> 0.0 && event
->y
> 0.0)
301 editor_info
.click_pos
= sci_get_position_from_xy(editor
->sci
,
302 (gint
)event
->x
, (gint
)event
->y
, FALSE
);
304 editor_info
.click_pos
= sci_get_current_position(editor
->sci
);
306 if (event
->button
== 1)
308 guint state
= keybindings_get_modifiers(event
->state
);
310 if (event
->type
== GDK_BUTTON_PRESS
&& editor_prefs
.disable_dnd
)
312 gint ss
= sci_get_selection_start(editor
->sci
);
313 sci_set_selection_end(editor
->sci
, ss
);
315 if (event
->type
== GDK_BUTTON_PRESS
&& state
== GEANY_PRIMARY_MOD_MASK
)
317 sci_set_current_position(editor
->sci
, editor_info
.click_pos
, FALSE
);
319 editor_find_current_word(editor
, editor_info
.click_pos
,
320 current_word
, sizeof current_word
, NULL
);
322 return symbols_goto_tag(current_word
, TRUE
);
324 keybindings_send_command(GEANY_KEY_GROUP_GOTO
, GEANY_KEYS_GOTO_MATCHINGBRACE
);
327 return document_check_disk_status(doc
, FALSE
);
330 /* calls the edit popup menu in the editor */
331 if (event
->button
== 3)
335 /* ensure the editor widget has the focus after this operation */
336 gtk_widget_grab_focus(widget
);
338 editor_find_current_word(editor
, editor_info
.click_pos
,
339 current_word
, sizeof current_word
, NULL
);
341 can_goto
= sci_has_selection(editor
->sci
) || current_word
[0] != '\0';
342 ui_update_popup_goto_items(can_goto
);
343 ui_update_popup_copy_items(doc
);
344 ui_update_insert_include_item(doc
, 0);
346 g_signal_emit_by_name(geany_object
, "update-editor-menu",
347 current_word
, editor_info
.click_pos
, doc
);
349 gtk_menu_popup(GTK_MENU(main_widgets
.editor_menu
),
350 NULL
, NULL
, NULL
, NULL
, event
->button
, event
->time
);
358 static gboolean
is_style_php(gint style
)
360 if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
361 style
== SCE_HPHP_COMPLEX_VARIABLE
)
370 static gint
editor_get_long_line_type(void)
373 switch (app
->project
->priv
->long_line_behaviour
)
375 case 0: /* marker disabled */
377 case 1: /* use global settings */
379 case 2: /* custom (enabled) */
380 return editor_prefs
.long_line_type
;
383 if (!editor_prefs
.long_line_enabled
)
386 return editor_prefs
.long_line_type
;
390 static gint
editor_get_long_line_column(void)
392 if (app
->project
&& app
->project
->priv
->long_line_behaviour
!= 1 /* use global settings */)
393 return app
->project
->priv
->long_line_column
;
395 return editor_prefs
.long_line_column
;
399 #define get_project_pref(id)\
400 (app->project ? app->project->priv->id : editor_prefs.id)
402 static const GeanyEditorPrefs
*
403 get_default_prefs(void)
405 static GeanyEditorPrefs eprefs
;
407 eprefs
= editor_prefs
;
409 /* project overrides */
410 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(NULL
);
411 eprefs
.long_line_type
= editor_get_long_line_type();
412 eprefs
.long_line_column
= editor_get_long_line_column();
413 eprefs
.line_wrapping
= get_project_pref(line_wrapping
);
414 eprefs
.line_break_column
= get_project_pref(line_break_column
);
415 eprefs
.auto_continue_multiline
= get_project_pref(auto_continue_multiline
);
420 /* Gets the prefs for the editor.
421 * Prefs can be different according to project or document.
422 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
423 * settings may have changed, or if this function has been called for a different editor.
424 * @param editor The editor, or @c NULL to get the default prefs.
425 * @return The prefs. */
426 const GeanyEditorPrefs
*editor_get_prefs(GeanyEditor
*editor
)
428 static GeanyEditorPrefs eprefs
;
429 const GeanyEditorPrefs
*dprefs
= get_default_prefs();
431 /* Return the address of the default prefs to allow returning default and editor
432 * pref pointers without invalidating the contents of either. */
437 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(editor
);
438 /* add other editor & document overrides as needed */
443 void editor_toggle_fold(GeanyEditor
*editor
, gint line
, gint modifiers
)
445 ScintillaObject
*sci
;
448 g_return_if_fail(editor
!= NULL
);
451 /* When collapsing a fold range whose starting line is offscreen,
452 * scroll the starting line to display at the top of the view.
453 * Otherwise it can be confusing when the document scrolls down to hide
454 * the folded lines. */
455 if ((sci_get_fold_level(sci
, line
) & SC_FOLDLEVELNUMBERMASK
) > SC_FOLDLEVELBASE
&&
456 !(sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
))
458 gint parent
= sci_get_fold_parent(sci
, line
);
459 gint first
= sci_get_first_visible_line(sci
);
461 parent
= SSM(sci
, SCI_VISIBLEFROMDOCLINE
, parent
, 0);
463 SSM(sci
, SCI_SETFIRSTVISIBLELINE
, parent
, 0);
466 /* find the fold header of the given line in case the one clicked isn't a fold point */
467 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
470 header
= sci_get_fold_parent(sci
, line
);
472 if ((editor_prefs
.unfold_all_children
&& ! (modifiers
& SCMOD_SHIFT
)) ||
473 (! editor_prefs
.unfold_all_children
&& (modifiers
& SCMOD_SHIFT
)))
475 SSM(sci
, SCI_FOLDCHILDREN
, header
, SC_FOLDACTION_TOGGLE
);
479 SSM(sci
, SCI_FOLDLINE
, header
, SC_FOLDACTION_TOGGLE
);
484 static void on_margin_click(GeanyEditor
*editor
, SCNotification
*nt
)
486 /* left click to marker margin marks the line */
489 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
491 /*sci_marker_delete_all(editor->sci, 1);*/
492 sci_toggle_marker_at_line(editor
->sci
, line
, 1); /* toggle the marker */
494 /* left click on the folding margin to toggle folding state of current line */
495 else if (nt
->margin
== 2 && editor_prefs
.folding
)
497 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
498 editor_toggle_fold(editor
, line
, nt
->modifiers
);
503 static void on_update_ui(GeanyEditor
*editor
, G_GNUC_UNUSED SCNotification
*nt
)
505 ScintillaObject
*sci
= editor
->sci
;
506 gint pos
= sci_get_current_position(sci
);
508 /* since Scintilla 2.24, SCN_UPDATEUI is also sent on scrolling though we don't need to handle
509 * this and so ignore every SCN_UPDATEUI events except for content and selection changes */
510 if (! (nt
->updated
& SC_UPDATE_CONTENT
) && ! (nt
->updated
& SC_UPDATE_SELECTION
))
513 /* undo / redo menu update */
514 ui_update_popup_reundo_items(editor
->document
);
516 /* brace highlighting */
517 editor_highlight_braces(editor
, pos
);
519 ui_update_statusbar(editor
->document
, pos
);
522 /** experimental code for inverting selections */
525 for (i
= SSM(sci
, SCI_GETSELECTIONSTART
, 0, 0); i
< SSM(sci
, SCI_GETSELECTIONEND
, 0, 0); i
++)
527 /* need to get colour from getstyleat(), but how? */
528 SSM(sci
, SCI_STYLESETFORE
, STYLE_DEFAULT
, 0);
529 SSM(sci
, SCI_STYLESETBACK
, STYLE_DEFAULT
, 0);
532 sci_get_style_at(sci
, pos
);
538 static void check_line_breaking(GeanyEditor
*editor
, gint pos
)
540 ScintillaObject
*sci
= editor
->sci
;
541 gint line
, lstart
, col
;
544 if (!editor
->line_breaking
|| sci_get_selection_mode(editor
->sci
) != SC_SEL_STREAM
)
547 col
= sci_get_col_from_position(sci
, pos
);
549 line
= sci_get_current_line(sci
);
551 lstart
= sci_get_position_from_line(sci
, line
);
553 /* use column instead of position which might be different with multibyte characters */
554 if (col
< get_project_pref(line_break_column
))
557 /* look for the last space before line_break_column */
558 pos
= sci_get_position_from_col(sci
, line
, get_project_pref(line_break_column
));
562 c
= sci_get_char_at(sci
, --pos
);
565 gint diff
, last_pos
, last_col
;
567 /* remember the distance between the current column and the last column on the line
568 * (we use column position in case the previous line gets altered, such as removing
569 * trailing spaces or in case it contains multibyte characters) */
570 last_pos
= sci_get_line_end_position(sci
, line
);
571 last_col
= sci_get_col_from_position(sci
, last_pos
);
572 diff
= last_col
- col
;
574 /* break the line after the space */
575 sci_set_current_position(sci
, pos
+ 1, FALSE
);
576 sci_cancel(sci
); /* don't select from completion list */
577 sci_send_command(sci
, SCI_NEWLINE
);
580 /* correct cursor position (might not be at line end) */
581 last_pos
= sci_get_line_end_position(sci
, line
);
582 last_col
= sci_get_col_from_position(sci
, last_pos
); /* get last column on line */
583 /* last column - distance is the desired column, then retrieve its document position */
584 pos
= sci_get_position_from_col(sci
, line
, last_col
- diff
);
585 sci_set_current_position(sci
, pos
, FALSE
);
586 sci_scroll_caret(sci
);
593 static void show_autocomplete(ScintillaObject
*sci
, gsize rootlen
, GString
*words
)
595 /* hide autocompletion if only option is already typed */
596 if (rootlen
>= words
->len
||
597 (words
->str
[rootlen
] == '?' && rootlen
>= words
->len
- 2))
599 sci_send_command(sci
, SCI_AUTOCCANCEL
);
602 /* store whether a calltip is showing, so we can reshow it after autocompletion */
603 calltip
.set
= (gboolean
) SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0);
604 SSM(sci
, SCI_AUTOCSHOW
, rootlen
, (sptr_t
) words
->str
);
608 static void show_tags_list(GeanyEditor
*editor
, const GPtrArray
*tags
, gsize rootlen
)
610 ScintillaObject
*sci
= editor
->sci
;
612 g_return_if_fail(tags
);
616 GString
*words
= g_string_sized_new(150);
619 for (j
= 0; j
< tags
->len
; ++j
)
621 TMTag
*tag
= tags
->pdata
[j
];
624 g_string_append_c(words
, '\n');
626 if (j
== editor_prefs
.autocompletion_max_entries
)
628 g_string_append(words
, "...");
631 g_string_append(words
, tag
->name
);
633 /* for now, tag types don't all follow C, so just look at arglist */
634 if (!EMPTY(tag
->arglist
))
635 g_string_append(words
, "?2");
637 g_string_append(words
, "?1");
639 show_autocomplete(sci
, rootlen
, words
);
640 g_string_free(words
, TRUE
);
645 static gint
scope_autocomplete_suffix(ScintillaObject
*sci
, TMParserType lang
,
646 gint pos
, gboolean
*scope_sep
)
648 const gchar
*sep
= tm_parser_scope_separator(lang
);
649 const gsize max_len
= 3;
650 gboolean is_scope_sep
;
653 buf
= g_alloca(max_len
+ 1);
654 sci_get_text_range(sci
, pos
- max_len
, pos
, buf
);
656 is_scope_sep
= g_str_has_suffix(buf
, sep
);
658 *scope_sep
= is_scope_sep
;
661 return tm_parser_scope_autocomplete_suffix(lang
, buf
);
665 static gboolean
reshow_calltip(gpointer data
)
669 g_return_val_if_fail(calltip
.sci
!= NULL
, FALSE
);
671 SSM(calltip
.sci
, SCI_CALLTIPCANCEL
, 0, 0);
672 doc
= document_get_current();
674 if (doc
&& doc
->editor
->sci
== calltip
.sci
)
676 /* we use the position where the calltip was previously started as SCI_GETCURRENTPOS
677 * may be completely wrong in case the user cancelled the auto completion with the mouse */
678 SSM(calltip
.sci
, SCI_CALLTIPSHOW
, calltip
.pos
, (sptr_t
) calltip
.text
);
684 static void request_reshowing_calltip(SCNotification
*nt
)
688 /* delay the reshow of the calltip window to make sure it is actually displayed,
689 * without it might be not visible on SCN_AUTOCCANCEL. the priority is set to
690 * low to hopefully make Scintilla's events happen before reshowing since they
691 * seem to re-cancel the calltip on autoc menu hiding too */
692 g_idle_add_full(G_PRIORITY_LOW
, reshow_calltip
, NULL
, NULL
);
697 static gboolean
autocomplete_scope(GeanyEditor
*editor
, const gchar
*root
, gsize rootlen
)
699 ScintillaObject
*sci
= editor
->sci
;
700 gint pos
= sci_get_current_position(editor
->sci
);
701 gchar typed
= sci_get_char_at(sci
, pos
- 1);
704 GeanyFiletype
*ft
= editor
->document
->file_type
;
706 gboolean function
= FALSE
;
708 gboolean scope_sep_typed
= FALSE
;
709 gboolean ret
= FALSE
;
710 const gchar
*current_scope
;
711 const gchar
*context_sep
= tm_parser_scope_separator(ft
->lang
);
712 gint autocomplete_suffix_len
;
714 if (autocomplete_scope_shown
)
716 /* move at the operator position */
719 /* allow for a space between word and operator */
720 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
724 typed
= sci_get_char_at(sci
, pos
- 1);
727 autocomplete_suffix_len
= scope_autocomplete_suffix(sci
, ft
->lang
, pos
,
729 if (autocomplete_suffix_len
== 0)
732 pos
-= autocomplete_suffix_len
;
734 /* allow for a space between word and operator */
735 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
738 /* if function or array index, skip to matching brace */
739 brace_char
= sci_get_char_at(sci
, pos
- 1);
740 if (pos
> 0 && (brace_char
== ')' || brace_char
== ']'))
742 gint brace_pos
= sci_find_matching_brace(sci
, pos
- 1);
747 function
= brace_char
== ')';
750 /* allow for a space between opening brace and name */
751 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
755 name
= editor_get_word_at_pos(editor
, pos
, NULL
);
759 /* check if invoked on member */
761 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
763 member
= scope_autocomplete_suffix(sci
, ft
->lang
, pos
, NULL
) > 0;
765 if (symbols_get_current_scope(editor
->document
, ¤t_scope
) == -1)
767 tags
= tm_workspace_find_scope_members(editor
->document
->tm_file
, name
, function
,
768 member
, current_scope
, scope_sep_typed
);
771 GPtrArray
*filtered
= g_ptr_array_new();
775 foreach_ptr_array(tag
, i
, tags
)
777 if (g_str_has_prefix(tag
->name
, root
))
778 g_ptr_array_add(filtered
, tag
);
781 if (filtered
->len
> 0)
783 show_tags_list(editor
, filtered
, rootlen
);
787 g_ptr_array_free(tags
, TRUE
);
788 g_ptr_array_free(filtered
, TRUE
);
796 static void on_char_added(GeanyEditor
*editor
, SCNotification
*nt
)
798 ScintillaObject
*sci
= editor
->sci
;
799 gint pos
= sci_get_current_position(sci
);
804 { /* simple indentation (only for CR format) */
805 if (sci_get_eol_mode(sci
) == SC_EOL_CR
)
806 on_new_line_added(editor
);
810 { /* simple indentation (for CR/LF and LF format) */
811 on_new_line_added(editor
);
815 editor_start_auto_complete(editor
, pos
, FALSE
); /* C/C++ ptr-> scope completion */
818 { /* close xml-tags */
819 handle_xml(editor
, pos
, nt
->ch
);
824 auto_close_chars(sci
, pos
, nt
->ch
);
826 editor_show_calltip(editor
, --pos
);
830 { /* hide calltips */
831 if (SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0))
833 SSM(sci
, SCI_CALLTIPCANCEL
, 0, 0);
835 g_free(calltip
.text
);
847 auto_close_chars(sci
, pos
, nt
->ch
);
851 { /* closing bracket handling */
852 if (editor
->auto_indent
)
853 close_block(editor
, pos
- 1);
856 /* scope autocompletion */
858 case ':': /* C/C++ class:: syntax */
859 /* tag autocompletion */
862 if (! editor_start_auto_complete(editor
, pos
, FALSE
))
863 request_reshowing_calltip(nt
);
865 editor_start_auto_complete(editor
, pos
, FALSE
);
868 check_line_breaking(editor
, pos
);
872 /* expand() and fold_changed() are copied from SciTE (thanks) to fix #1923350. */
873 static void expand(ScintillaObject
*sci
, gint
*line
, gboolean doExpand
,
874 gboolean force
, gint visLevels
, gint level
)
876 gint lineMaxSubord
= SSM(sci
, SCI_GETLASTCHILD
, *line
, level
& SC_FOLDLEVELNUMBERMASK
);
877 gint levelLine
= level
;
879 while (*line
<= lineMaxSubord
)
884 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
886 SSM(sci
, SCI_HIDELINES
, *line
, *line
);
891 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
894 levelLine
= SSM(sci
, SCI_GETFOLDLEVEL
, *line
, 0);
895 if (levelLine
& SC_FOLDLEVELHEADERFLAG
)
900 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
902 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 0);
903 expand(sci
, line
, doExpand
, force
, visLevels
- 1, -1);
909 if (!sci_get_fold_expanded(sci
, *line
))
910 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
911 expand(sci
, line
, TRUE
, force
, visLevels
- 1, -1);
915 expand(sci
, line
, FALSE
, force
, visLevels
- 1, -1);
927 static void fold_changed(ScintillaObject
*sci
, gint line
, gint levelNow
, gint levelPrev
)
929 if (levelNow
& SC_FOLDLEVELHEADERFLAG
)
931 if (! (levelPrev
& SC_FOLDLEVELHEADERFLAG
))
933 /* Adding a fold point */
934 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
935 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
936 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
939 else if (levelPrev
& SC_FOLDLEVELHEADERFLAG
)
941 if (! sci_get_fold_expanded(sci
, line
))
942 { /* Removing the fold from one that has been contracted so should expand
943 * otherwise lines are left invisible with no way to make them visible */
944 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
945 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
946 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
949 if (! (levelNow
& SC_FOLDLEVELWHITEFLAG
) &&
950 ((levelPrev
& SC_FOLDLEVELNUMBERMASK
) > (levelNow
& SC_FOLDLEVELNUMBERMASK
)))
952 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0)) {
953 /* See if should still be hidden */
954 gint parentLine
= sci_get_fold_parent(sci
, line
);
957 SSM(sci
, SCI_SHOWLINES
, line
, line
);
959 else if (sci_get_fold_expanded(sci
, parentLine
) &&
960 sci_get_line_is_visible(sci
, parentLine
))
962 SSM(sci
, SCI_SHOWLINES
, line
, line
);
969 static void ensure_range_visible(ScintillaObject
*sci
, gint posStart
, gint posEnd
,
970 gboolean enforcePolicy
)
972 gint lineStart
= sci_get_line_from_position(sci
, MIN(posStart
, posEnd
));
973 gint lineEnd
= sci_get_line_from_position(sci
, MAX(posStart
, posEnd
));
976 for (line
= lineStart
; line
<= lineEnd
; line
++)
978 SSM(sci
, enforcePolicy
? SCI_ENSUREVISIBLEENFORCEPOLICY
: SCI_ENSUREVISIBLE
, line
, 0);
983 static void auto_update_margin_width(GeanyEditor
*editor
)
985 gint next_linecount
= 1;
986 gint linecount
= sci_get_line_count(editor
->sci
);
987 GeanyDocument
*doc
= editor
->document
;
989 while (next_linecount
<= linecount
)
990 next_linecount
*= 10;
992 if (editor
->document
->priv
->line_count
!= next_linecount
)
994 doc
->priv
->line_count
= next_linecount
;
995 sci_set_line_numbers(editor
->sci
, TRUE
);
1000 static void partial_complete(ScintillaObject
*sci
, const gchar
*text
)
1002 gint pos
= sci_get_current_position(sci
);
1004 sci_insert_text(sci
, pos
, text
);
1005 sci_set_current_position(sci
, pos
+ strlen(text
), TRUE
);
1009 /* Complete the next word part from @a entry */
1010 static gboolean
check_partial_completion(GeanyEditor
*editor
, const gchar
*entry
)
1012 gchar
*stem
, *ptr
, *text
= utils_strdupa(entry
);
1014 read_current_word(editor
, -1, current_word
, sizeof current_word
, NULL
, TRUE
);
1015 stem
= current_word
;
1016 if (strstr(text
, stem
) != text
)
1017 return FALSE
; /* shouldn't happen */
1018 if (strlen(text
) <= strlen(stem
))
1021 text
+= strlen(stem
); /* skip stem */
1022 ptr
= strstr(text
+ 1, "_");
1026 partial_complete(editor
->sci
, text
);
1032 foreach_str(ptr
, text
+ 1)
1036 if (g_ascii_isupper(*ptr
) && g_ascii_islower(ptr
[1]))
1039 partial_complete(editor
->sci
, text
);
1048 /* Callback for the "sci-notify" signal to emit a "editor-notify" signal.
1049 * Plugins can connect to the "editor-notify" signal. */
1050 void editor_sci_notify_cb(G_GNUC_UNUSED GtkWidget
*widget
, G_GNUC_UNUSED gint scn
,
1051 gpointer scnt
, gpointer data
)
1053 GeanyEditor
*editor
= data
;
1056 g_return_if_fail(editor
!= NULL
);
1058 g_signal_emit_by_name(geany_object
, "editor-notify", editor
, scnt
, &retval
);
1062 /* recalculate margins width */
1063 static void update_margins(ScintillaObject
*sci
)
1065 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
1066 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
1067 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
1071 static gboolean
on_editor_notify(G_GNUC_UNUSED GObject
*object
, GeanyEditor
*editor
,
1072 SCNotification
*nt
, G_GNUC_UNUSED gpointer data
)
1074 ScintillaObject
*sci
= editor
->sci
;
1075 GeanyDocument
*doc
= editor
->document
;
1077 switch (nt
->nmhdr
.code
)
1079 case SCN_SAVEPOINTLEFT
:
1080 document_set_text_changed(doc
, TRUE
);
1083 case SCN_SAVEPOINTREACHED
:
1084 document_set_text_changed(doc
, FALSE
);
1087 case SCN_MODIFYATTEMPTRO
:
1091 case SCN_MARGINCLICK
:
1092 on_margin_click(editor
, nt
);
1096 on_update_ui(editor
, nt
);
1100 /* Visible lines are only laid out accurately just before painting,
1101 * so we need to only call editor_scroll_to_line here, because the document
1102 * may have line wrapping and folding enabled.
1103 * http://scintilla.sourceforge.net/ScintillaDoc.html#LineWrapping
1104 * This is important e.g. when loading a session and switching pages
1105 * and having the cursor scroll in view. */
1106 /* FIXME: Really we want to do this just before painting, not after it
1107 * as it will cause repainting. */
1108 if (editor
->scroll_percent
> 0.0F
)
1110 editor_scroll_to_line(editor
, -1, editor
->scroll_percent
);
1111 /* disable further scrolling */
1112 editor
->scroll_percent
= -1.0F
;
1117 if (editor_prefs
.show_linenumber_margin
&& (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
)) && nt
->linesAdded
)
1119 /* automatically adjust Scintilla's line numbers margin width */
1120 auto_update_margin_width(editor
);
1122 if (nt
->modificationType
& SC_STARTACTION
&& ! ignore_callback
)
1124 /* get notified about undo changes */
1125 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
1127 if (editor_prefs
.folding
&& (nt
->modificationType
& SC_MOD_CHANGEFOLD
) != 0)
1129 /* handle special fold cases, e.g. #1923350 */
1130 fold_changed(sci
, nt
->line
, nt
->foldLevelNow
, nt
->foldLevelPrev
);
1132 if (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
))
1134 document_update_tag_list_in_idle(doc
);
1139 on_char_added(editor
, nt
);
1142 case SCN_USERLISTSELECTION
:
1143 if (nt
->listType
== 1)
1145 sci_add_text(sci
, nt
->text
);
1149 case SCN_AUTOCSELECTION
:
1150 if (g_str_equal(nt
->text
, "..."))
1157 case SCN_AUTOCCANCELLED
:
1158 /* now that autocomplete is finishing or was cancelled, reshow calltips
1159 * if they were showing */
1160 autocomplete_scope_shown
= FALSE
;
1161 request_reshowing_calltip(nt
);
1164 ensure_range_visible(sci
, nt
->position
, nt
->position
+ nt
->length
, FALSE
);
1167 case SCN_URIDROPPED
:
1168 if (nt
->text
!= NULL
)
1170 document_open_file_list(nt
->text
, strlen(nt
->text
));
1174 case SCN_CALLTIPCLICK
:
1175 if (nt
->position
> 0)
1177 switch (nt
->position
)
1179 case 1: /* up arrow */
1180 if (calltip
.tag_index
> 0)
1181 calltip
.tag_index
--;
1184 case 2: calltip
.tag_index
++; break; /* down arrow */
1186 editor_show_calltip(editor
, -1);
1191 update_margins(sci
);
1194 /* we always return FALSE here to let plugins handle the event too */
1199 /* Note: this is the same as sci_get_tab_width(), but is still useful when you don't have
1200 * a scintilla pointer. */
1201 static gint
get_tab_width(const GeanyIndentPrefs
*indent_prefs
)
1203 if (indent_prefs
->type
== GEANY_INDENT_TYPE_BOTH
)
1204 return indent_prefs
->hard_tab_width
;
1206 return indent_prefs
->width
; /* tab width = indent width */
1210 /* Returns a string containing width chars of whitespace, filled with simple space
1211 * characters or with the right number of tab characters, according to the indent prefs.
1212 * (Result is filled with tabs *and* spaces if width isn't a multiple of
1213 * the tab width). */
1215 get_whitespace(const GeanyIndentPrefs
*iprefs
, gint width
)
1217 g_return_val_if_fail(width
>= 0, NULL
);
1220 return g_strdup("");
1222 if (iprefs
->type
== GEANY_INDENT_TYPE_SPACES
)
1224 return g_strnfill(width
, ' ');
1227 { /* first fill text with tabs and fill the rest with spaces */
1228 const gint tab_width
= get_tab_width(iprefs
);
1229 gint tabs
= width
/ tab_width
;
1230 gint spaces
= width
% tab_width
;
1231 gint len
= tabs
+ spaces
;
1234 str
= g_malloc(len
+ 1);
1236 memset(str
, '\t', tabs
);
1237 memset(str
+ tabs
, ' ', spaces
);
1244 static const GeanyIndentPrefs
*
1245 get_default_indent_prefs(void)
1247 static GeanyIndentPrefs iprefs
;
1249 iprefs
= app
->project
? *app
->project
->priv
->indentation
: *editor_prefs
.indentation
;
1254 /** Gets the indentation prefs for the editor.
1255 * Prefs can be different according to project or document.
1256 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
1257 * settings may have changed, or if this function has been called for a different editor.
1258 * @param editor @nullable The editor, or @c NULL to get the default indent prefs.
1259 * @return The indent prefs. */
1261 const GeanyIndentPrefs
*
1262 editor_get_indent_prefs(GeanyEditor
*editor
)
1264 static GeanyIndentPrefs iprefs
;
1265 const GeanyIndentPrefs
*dprefs
= get_default_indent_prefs();
1267 /* Return the address of the default prefs to allow returning default and editor
1268 * pref pointers without invalidating the contents of either. */
1273 iprefs
.type
= editor
->indent_type
;
1274 iprefs
.width
= editor
->indent_width
;
1276 /* if per-document auto-indent is enabled, but we don't have a global mode set,
1277 * just use basic auto-indenting */
1278 if (editor
->auto_indent
&& iprefs
.auto_indent_mode
== GEANY_AUTOINDENT_NONE
)
1279 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_BASIC
;
1281 if (!editor
->auto_indent
)
1282 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_NONE
;
1288 static void on_new_line_added(GeanyEditor
*editor
)
1290 ScintillaObject
*sci
= editor
->sci
;
1291 gint line
= sci_get_current_line(sci
);
1293 /* simple indentation */
1294 if (editor
->auto_indent
)
1296 insert_indent_after_line(editor
, line
- 1);
1299 if (get_project_pref(auto_continue_multiline
))
1300 { /* " * " auto completion in multiline C/C++/D/Java comments */
1301 auto_multiline(editor
, line
);
1304 if (editor_prefs
.newline_strip
)
1305 { /* strip the trailing spaces on the previous line */
1306 editor_strip_line_trailing_spaces(editor
, line
- 1);
1311 static gboolean
lexer_has_braces(ScintillaObject
*sci
)
1313 gint lexer
= sci_get_lexer(sci
);
1319 case SCLEX_HTML
: /* for PHP & JS */
1320 case SCLEX_PHPSCRIPT
:
1321 case SCLEX_PASCAL
: /* for multiline comments? */
1334 /* Read indent chars for the line that pos is on into indent global variable.
1335 * Note: Use sci_get_line_indentation() and get_whitespace()/editor_insert_text_block()
1336 * instead in any new code. */
1337 static void read_indent(GeanyEditor
*editor
, gint pos
)
1339 ScintillaObject
*sci
= editor
->sci
;
1340 guint i
, len
, j
= 0;
1344 line
= sci_get_line_from_position(sci
, pos
);
1346 len
= sci_get_line_length(sci
, line
);
1347 linebuf
= sci_get_line(sci
, line
);
1349 for (i
= 0; i
< len
&& j
<= (sizeof(indent
) - 1); i
++)
1351 if (linebuf
[i
] == ' ' || linebuf
[i
] == '\t') /* simple indentation */
1352 indent
[j
++] = linebuf
[i
];
1361 static gint
get_brace_indent(ScintillaObject
*sci
, gint line
)
1363 gint start
= sci_get_position_from_line(sci
, line
);
1364 gint end
= sci_get_line_end_position(sci
, line
) - 1;
1365 gint lexer
= sci_get_lexer(sci
);
1369 for (pos
= end
; pos
>= start
&& count
< 1; pos
--)
1371 if (highlighting_is_code_style(lexer
, sci_get_style_at(sci
, pos
)))
1373 gchar c
= sci_get_char_at(sci
, pos
);
1382 return count
> 0 ? 1 : 0;
1386 /* gets the last code position on a line
1387 * warning: if there is no code position on the line, returns the start position */
1388 static gint
get_sci_line_code_end_position(ScintillaObject
*sci
, gint line
)
1390 gint start
= sci_get_position_from_line(sci
, line
);
1391 gint lexer
= sci_get_lexer(sci
);
1394 for (pos
= sci_get_line_end_position(sci
, line
) - 1; pos
> start
; pos
--)
1396 gint style
= sci_get_style_at(sci
, pos
);
1398 if (highlighting_is_code_style(lexer
, style
) && ! isspace(sci_get_char_at(sci
, pos
)))
1406 static gint
get_python_indent(ScintillaObject
*sci
, gint line
)
1408 gint last_char
= get_sci_line_code_end_position(sci
, line
);
1410 /* add extra indentation for Python after colon */
1411 if (sci_get_char_at(sci
, last_char
) == ':' &&
1412 sci_get_style_at(sci
, last_char
) == SCE_P_OPERATOR
)
1420 static gint
get_xml_indent(ScintillaObject
*sci
, gint line
)
1422 gboolean need_close
= FALSE
;
1423 gint end
= get_sci_line_code_end_position(sci
, line
);
1426 /* don't indent if there's a closing tag to the right of the cursor */
1427 pos
= sci_get_current_position(sci
);
1428 if (sci_get_char_at(sci
, pos
) == '<' &&
1429 sci_get_char_at(sci
, pos
+ 1) == '/')
1432 if (sci_get_char_at(sci
, end
) == '>' &&
1433 sci_get_char_at(sci
, end
- 1) != '/')
1435 gint style
= sci_get_style_at(sci
, end
);
1437 if (style
== SCE_H_TAG
|| style
== SCE_H_TAGUNKNOWN
)
1439 gint start
= sci_get_position_from_line(sci
, line
);
1440 gchar
*line_contents
= sci_get_contents_range(sci
, start
, end
+ 1);
1441 gchar
*opened_tag_name
= utils_find_open_xml_tag(line_contents
, end
+ 1 - start
);
1443 if (!EMPTY(opened_tag_name
))
1446 if (sci_get_lexer(sci
) == SCLEX_HTML
&& utils_is_short_html_tag(opened_tag_name
))
1449 g_free(line_contents
);
1450 g_free(opened_tag_name
);
1454 return need_close
? 1 : 0;
1458 static gint
get_indent_size_after_line(GeanyEditor
*editor
, gint line
)
1460 ScintillaObject
*sci
= editor
->sci
;
1462 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1464 g_return_val_if_fail(line
>= 0, 0);
1466 size
= sci_get_line_indentation(sci
, line
);
1468 if (iprefs
->auto_indent_mode
> GEANY_AUTOINDENT_BASIC
)
1470 gint additional_indent
= 0;
1472 if (lexer_has_braces(sci
))
1473 additional_indent
= iprefs
->width
* get_brace_indent(sci
, line
);
1474 else if (sci_get_lexer(sci
) == SCLEX_PYTHON
) /* Python/Cython */
1475 additional_indent
= iprefs
->width
* get_python_indent(sci
, line
);
1477 /* HTML lexer "has braces" because of PHP and JavaScript. If get_brace_indent() did not
1478 * recommend us to insert additional indent, we are probably not in PHP/JavaScript chunk and
1479 * should make the XML-related check */
1480 if (additional_indent
== 0 &&
1481 (sci_get_lexer(sci
) == SCLEX_HTML
||
1482 sci_get_lexer(sci
) == SCLEX_XML
) &&
1483 editor
->document
->file_type
->priv
->xml_indent_tags
)
1485 size
+= iprefs
->width
* get_xml_indent(sci
, line
);
1488 size
+= additional_indent
;
1494 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
)
1496 ScintillaObject
*sci
= editor
->sci
;
1497 gint line_indent
= sci_get_line_indentation(sci
, line
);
1498 gint size
= get_indent_size_after_line(editor
, line
);
1499 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1505 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
&& size
== line_indent
)
1507 /* support tab indents, space aligns style - copy last line 'indent' exactly */
1508 gint start
= sci_get_position_from_line(sci
, line
);
1509 gint end
= sci_get_line_indent_position(sci
, line
);
1511 text
= sci_get_contents_range(sci
, start
, end
);
1515 text
= get_whitespace(iprefs
, size
);
1517 sci_add_text(sci
, text
);
1522 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
)
1524 const gchar
*closing_char
= NULL
;
1527 if (utils_isbrace(c
, 0))
1528 end_pos
= sci_find_matching_brace(sci
, pos
- 1);
1533 if ((editor_prefs
.autoclose_chars
& GEANY_AC_PARENTHESIS
) && end_pos
== -1)
1537 if ((editor_prefs
.autoclose_chars
& GEANY_AC_CBRACKET
) && end_pos
== -1)
1541 if ((editor_prefs
.autoclose_chars
& GEANY_AC_SBRACKET
) && end_pos
== -1)
1545 if (editor_prefs
.autoclose_chars
& GEANY_AC_SQUOTE
)
1549 if (editor_prefs
.autoclose_chars
& GEANY_AC_DQUOTE
)
1550 closing_char
= "\"";
1554 if (closing_char
!= NULL
)
1556 sci_add_text(sci
, closing_char
);
1557 sci_set_current_position(sci
, pos
, TRUE
);
1562 /* Finds a corresponding matching brace to the given pos
1563 * (this is taken from Scintilla Editor.cxx,
1564 * fit to work with close_block) */
1565 static gint
brace_match(ScintillaObject
*sci
, gint pos
)
1567 gchar chBrace
= sci_get_char_at(sci
, pos
);
1568 gchar chSeek
= utils_brace_opposite(chBrace
);
1570 gint direction
= -1;
1575 /* Hack: we need the style at @p pos but it isn't computed yet, so force styling
1576 * of this very position */
1577 sci_colourise(sci
, pos
, pos
+ 1);
1579 styBrace
= sci_get_style_at(sci
, pos
);
1581 if (utils_is_opening_brace(chBrace
, editor_prefs
.brace_match_ltgt
))
1585 while ((pos
>= 0) && (pos
< sci_get_length(sci
)))
1587 chAtPos
= sci_get_char_at(sci
, pos
);
1588 styAtPos
= sci_get_style_at(sci
, pos
);
1590 if ((pos
> sci_get_end_styled(sci
)) || (styAtPos
== styBrace
))
1592 if (chAtPos
== chBrace
)
1594 if (chAtPos
== chSeek
)
1605 /* Called after typing '}'. */
1606 static void close_block(GeanyEditor
*editor
, gint pos
)
1608 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1609 gint x
= 0, cnt
= 0;
1610 gint line
, line_len
;
1612 ScintillaObject
*sci
;
1613 gint line_indent
, last_indent
;
1615 if (iprefs
->auto_indent_mode
< GEANY_AUTOINDENT_CURRENTCHARS
)
1617 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
1621 if (! lexer_has_braces(sci
))
1624 line
= sci_get_line_from_position(sci
, pos
);
1625 line_len
= sci_get_line_end_position(sci
, line
) - sci_get_position_from_line(sci
, line
);
1627 /* check that the line is empty, to not kill text in the line */
1628 line_buf
= sci_get_line(sci
, line
);
1629 line_buf
[line_len
] = '\0';
1630 while (x
< line_len
)
1632 if (isspace(line_buf
[x
]))
1638 if ((line_len
- 1) != cnt
)
1641 if (iprefs
->auto_indent_mode
== GEANY_AUTOINDENT_MATCHBRACES
)
1643 gint start_brace
= brace_match(sci
, pos
);
1645 if (start_brace
>= 0)
1648 gint brace_line
= sci_get_line_from_position(sci
, start_brace
);
1649 gint size
= sci_get_line_indentation(sci
, brace_line
);
1650 gchar
*ind
= get_whitespace(iprefs
, size
);
1651 gchar
*text
= g_strconcat(ind
, "}", NULL
);
1653 line_start
= sci_get_position_from_line(sci
, line
);
1654 sci_set_anchor(sci
, line_start
);
1655 sci_replace_sel(sci
, text
);
1660 /* fall through - unmatched brace (possibly because of TCL, PHP lexer bugs) */
1663 /* GEANY_AUTOINDENT_CURRENTCHARS */
1664 line_indent
= sci_get_line_indentation(sci
, line
);
1665 last_indent
= sci_get_line_indentation(sci
, line
- 1);
1667 if (line_indent
< last_indent
)
1669 line_indent
-= iprefs
->width
;
1670 line_indent
= MAX(0, line_indent
);
1671 sci_set_line_indentation(sci
, line
, line_indent
);
1675 /* checks whether @p c is an ASCII character (e.g. < 0x80) */
1676 #define IS_ASCII(c) (((unsigned char)(c)) < 0x80)
1679 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1680 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1681 * position can be -1, then the current position is used.
1682 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1683 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1684 const gchar
*wc
, gboolean stem
)
1686 gint line
, line_start
, startword
, endword
;
1688 ScintillaObject
*sci
;
1690 g_return_if_fail(editor
!= NULL
);
1694 pos
= sci_get_current_position(sci
);
1696 line
= sci_get_line_from_position(sci
, pos
);
1697 line_start
= sci_get_position_from_line(sci
, line
);
1698 startword
= pos
- line_start
;
1699 endword
= pos
- line_start
;
1702 chunk
= sci_get_line(sci
, line
);
1705 wc
= GEANY_WORDCHARS
;
1707 /* the checks for "c < 0" are to allow any Unicode character which should make the code
1708 * a little bit more Unicode safe, anyway, this allows also any Unicode punctuation,
1709 * TODO: improve this code */
1710 while (startword
> 0 && (strchr(wc
, chunk
[startword
- 1]) || ! IS_ASCII(chunk
[startword
- 1])))
1714 while (chunk
[endword
] != 0 && (strchr(wc
, chunk
[endword
]) || ! IS_ASCII(chunk
[endword
])))
1718 if (startword
!= endword
)
1720 chunk
[endword
] = '\0';
1722 g_strlcpy(word
, chunk
+ startword
, wordlen
); /* ensure null terminated */
1725 g_strlcpy(word
, "", wordlen
);
1731 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1732 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1733 * position can be -1, then the current position is used.
1734 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1735 void editor_find_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1738 read_current_word(editor
, pos
, word
, wordlen
, wc
, FALSE
);
1742 /* Same as editor_find_current_word() but uses editor's word boundaries to decide what the word
1743 * is. This should be used e.g. to get the word to search for */
1744 void editor_find_current_word_sciwc(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
)
1749 g_return_if_fail(editor
!= NULL
);
1752 pos
= sci_get_current_position(editor
->sci
);
1754 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
1755 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
1757 if (start
== end
) /* caret in whitespaces sequence */
1761 if ((guint
)(end
- start
) >= wordlen
)
1762 end
= start
+ (wordlen
- 1);
1763 sci_get_text_range(editor
->sci
, start
, end
, word
);
1769 * Finds the word at the position specified by @a pos. If any word is found, it is returned.
1770 * Otherwise NULL is returned.
1771 * Additional wordchars can be specified to define what to consider as a word.
1773 * @param editor The editor to operate on.
1774 * @param pos The position where the word should be read from.
1775 * May be @c -1 to use the current position.
1776 * @param wordchars The wordchars to separate words. wordchars mean all characters to count
1777 * as part of a word. May be @c NULL to use the default wordchars,
1778 * see @ref GEANY_WORDCHARS.
1780 * @return @nullable A newly-allocated string containing the word at the given @a pos or @c NULL.
1781 * Should be freed when no longer needed.
1786 gchar
*editor_get_word_at_pos(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1788 static gchar cword
[GEANY_MAX_WORD_LENGTH
];
1790 g_return_val_if_fail(editor
!= NULL
, FALSE
);
1792 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, FALSE
);
1794 return (*cword
== '\0') ? NULL
: g_strdup(cword
);
1798 /* Read the word up to position @a pos. */
1799 static const gchar
*
1800 editor_read_word_stem(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1802 static gchar word
[GEANY_MAX_WORD_LENGTH
];
1804 read_current_word(editor
, pos
, word
, sizeof word
, wordchars
, TRUE
);
1806 return (*word
) ? word
: NULL
;
1810 static gint
find_previous_brace(ScintillaObject
*sci
, gint pos
)
1812 gint orig_pos
= pos
;
1814 while (pos
>= 0 && pos
> orig_pos
- 300)
1816 gchar c
= sci_get_char_at(sci
, pos
);
1817 if (utils_is_opening_brace(c
, editor_prefs
.brace_match_ltgt
))
1825 static gint
find_start_bracket(ScintillaObject
*sci
, gint pos
)
1828 gint orig_pos
= pos
;
1830 while (pos
> 0 && pos
> orig_pos
- 300)
1832 gchar c
= sci_get_char_at(sci
, pos
);
1834 if (c
== ')') brackets
++;
1835 else if (c
== '(') brackets
--;
1836 if (brackets
< 0) return pos
; /* found start bracket */
1843 static gchar
*find_calltip(const gchar
*word
, GeanyFiletype
*ft
)
1845 const gchar
*constructor_method
;
1848 GString
*str
= NULL
;
1851 g_return_val_if_fail(ft
&& word
&& *word
, NULL
);
1853 /* use all types in case language uses wrong tag type e.g. python "members" instead of "methods" */
1854 tags
= tm_workspace_find(word
, NULL
, tm_tag_max_t
, NULL
, ft
->lang
);
1857 g_ptr_array_free(tags
, TRUE
);
1861 tag
= TM_TAG(tags
->pdata
[0]);
1863 /* user typed e.g. 'a = Classname(' in Python so lookup __init__() arguments */
1864 constructor_method
= tm_parser_get_constructor_method(tag
->lang
);
1865 if (constructor_method
&& (tag
->type
== tm_tag_class_t
|| tag
->type
== tm_tag_struct_t
))
1867 const TMTagType arg_types
= tm_tag_function_t
| tm_tag_prototype_t
|
1868 tm_tag_method_t
| tm_tag_macro_with_arg_t
;
1869 const gchar
*scope_sep
= tm_parser_scope_separator(ft
->lang
);
1870 gchar
*scope
= EMPTY(tag
->scope
) ? g_strdup(tag
->name
) :
1871 g_strjoin(scope_sep
, tag
->scope
, tag
->name
, NULL
);
1873 g_ptr_array_free(tags
, TRUE
);
1874 tags
= tm_workspace_find(constructor_method
, scope
, arg_types
, NULL
, ft
->lang
);
1878 g_ptr_array_free(tags
, TRUE
);
1883 /* remove tags with no argument list */
1884 for (i
= 0; i
< tags
->len
; i
++)
1886 tag
= TM_TAG(tags
->pdata
[i
]);
1889 tags
->pdata
[i
] = NULL
;
1891 tm_tags_prune((GPtrArray
*) tags
);
1894 g_ptr_array_free(tags
, TRUE
);
1898 { /* remove duplicate calltips */
1899 TMTagAttrType sort_attr
[] = {tm_tag_attr_name_t
, tm_tag_attr_scope_t
,
1900 tm_tag_attr_arglist_t
, 0};
1902 tm_tags_sort((GPtrArray
*) tags
, sort_attr
, TRUE
, FALSE
);
1905 /* if the current word has changed since last time, start with the first tag match */
1906 if (! utils_str_equal(word
, calltip
.last_word
))
1907 calltip
.tag_index
= 0;
1908 /* cache the current word for next time */
1909 g_free(calltip
.last_word
);
1910 calltip
.last_word
= g_strdup(word
);
1911 calltip
.tag_index
= MIN(calltip
.tag_index
, tags
->len
- 1); /* ensure tag_index is in range */
1913 for (i
= calltip
.tag_index
; i
< tags
->len
; i
++)
1915 tag
= TM_TAG(tags
->pdata
[i
]);
1919 gchar
*f
= tm_parser_format_function(tag
->lang
, tag
->name
,
1920 tag
->arglist
, tag
->var_type
, tag
->scope
);
1921 str
= g_string_new(NULL
);
1922 if (calltip
.tag_index
> 0)
1923 g_string_prepend(str
, "\001 "); /* up arrow */
1924 g_string_append(str
, f
);
1927 else /* add a down arrow */
1929 if (calltip
.tag_index
> 0) /* already have an up arrow */
1930 g_string_insert_c(str
, 1, '\002');
1932 g_string_prepend(str
, "\002 ");
1937 g_ptr_array_free(tags
, TRUE
);
1941 gchar
*result
= str
->str
;
1943 g_string_free(str
, FALSE
);
1950 /* use pos = -1 to search for the previous unmatched open bracket. */
1951 gboolean
editor_show_calltip(GeanyEditor
*editor
, gint pos
)
1953 gint orig_pos
= pos
; /* the position for the calltip */
1956 gchar word
[GEANY_MAX_WORD_LENGTH
];
1958 ScintillaObject
*sci
;
1960 g_return_val_if_fail(editor
!= NULL
, FALSE
);
1961 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, FALSE
);
1965 lexer
= sci_get_lexer(sci
);
1969 /* position of '(' is unknown, so go backwards from current position to find it */
1970 pos
= sci_get_current_position(sci
);
1973 pos
= (lexer
== SCLEX_LATEX
) ? find_previous_brace(sci
, pos
) :
1974 find_start_bracket(sci
, pos
);
1979 /* the style 1 before the brace (which may be highlighted) */
1980 style
= sci_get_style_at(sci
, pos
- 1);
1981 if (! highlighting_is_code_style(lexer
, style
))
1984 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
1987 /* skip possible generic/template specification, like foo<int>() */
1988 if (sci_get_char_at(sci
, pos
- 1) == '>')
1990 pos
= sci_find_matching_brace(sci
, pos
- 1);
1994 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
1999 editor_find_current_word(editor
, pos
- 1, word
, sizeof word
, NULL
);
2000 if (word
[0] == '\0')
2003 str
= find_calltip(word
, editor
->document
->file_type
);
2006 g_free(calltip
.text
); /* free the old calltip */
2008 calltip
.pos
= orig_pos
;
2011 utils_wrap_string(calltip
.text
, -1);
2012 SSM(sci
, SCI_CALLTIPSHOW
, orig_pos
, (sptr_t
) calltip
.text
);
2019 /* Current document & global tags autocompletion */
2021 autocomplete_tags(GeanyEditor
*editor
, GeanyFiletype
*ft
, const gchar
*root
, gsize rootlen
)
2026 g_return_val_if_fail(editor
, FALSE
);
2028 tags
= tm_workspace_find_prefix(root
, ft
->lang
, editor_prefs
.autocompletion_max_entries
);
2029 found
= tags
->len
> 0;
2031 show_tags_list(editor
, tags
, rootlen
);
2032 g_ptr_array_free(tags
, TRUE
);
2038 static gboolean
autocomplete_check_html(GeanyEditor
*editor
, gint style
, gint pos
)
2040 GeanyFiletype
*ft
= editor
->document
->file_type
;
2041 gboolean
try = FALSE
;
2043 /* use entity completion when style is not JavaScript, ASP, Python, PHP, ...
2044 * (everything after SCE_HJ_START is for embedded scripting languages) */
2045 if (ft
->id
== GEANY_FILETYPES_HTML
&& style
< SCE_HJ_START
)
2047 else if (sci_get_lexer(editor
->sci
) == SCLEX_XML
&& style
< SCE_HJ_START
)
2049 else if (ft
->id
== GEANY_FILETYPES_PHP
)
2051 /* use entity completion when style is outside of PHP styles */
2052 if (! is_style_php(style
))
2057 gchar root
[GEANY_MAX_WORD_LENGTH
];
2060 read_current_word(editor
, pos
, root
, sizeof(root
), GEANY_WORDCHARS
"&", TRUE
);
2062 /* Allow something like ""some text"".
2063 * for entity completion we want to have completion for '&' within words. */
2064 tmp
= strchr(root
, '&');
2067 return autocomplete_tags(editor
, filetypes_index(GEANY_FILETYPES_HTML
), tmp
, strlen(tmp
));
2074 /* Algorithm based on based on Scite's StartAutoCompleteWord()
2075 * @returns a sorted list of words matching @p root */
2076 static GSList
*get_doc_words(ScintillaObject
*sci
, gchar
*root
, gsize rootlen
)
2079 gint len
, current
, word_end
;
2080 gint pos_find
, flags
;
2083 GSList
*words
= NULL
;
2084 struct Sci_TextToFind ttf
;
2086 len
= sci_get_length(sci
);
2087 current
= sci_get_current_position(sci
) - rootlen
;
2089 ttf
.lpstrText
= root
;
2091 ttf
.chrg
.cpMax
= len
;
2092 ttf
.chrgText
.cpMin
= 0;
2093 ttf
.chrgText
.cpMax
= 0;
2094 flags
= SCFIND_WORDSTART
| SCFIND_MATCHCASE
;
2096 /* search the whole document for the word root and collect results */
2097 pos_find
= SSM(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2098 while (pos_find
>= 0 && pos_find
< len
)
2100 word_end
= pos_find
+ rootlen
;
2101 if (pos_find
!= current
)
2103 word_end
= sci_word_end_position(sci
, word_end
, TRUE
);
2105 word_length
= word_end
- pos_find
;
2106 if (word_length
> rootlen
)
2108 word
= sci_get_contents_range(sci
, pos_find
, word_end
);
2109 /* search whether we already have the word in, otherwise add it */
2110 if (g_slist_find_custom(words
, word
, (GCompareFunc
)strcmp
) != NULL
)
2114 words
= g_slist_prepend(words
, word
);
2118 if (nmatches
== editor_prefs
.autocompletion_max_entries
)
2122 ttf
.chrg
.cpMin
= word_end
;
2123 pos_find
= SSM(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2126 return g_slist_sort(words
, (GCompareFunc
)utils_str_casecmp
);
2130 static gboolean
autocomplete_doc_word(GeanyEditor
*editor
, gchar
*root
, gsize rootlen
)
2132 ScintillaObject
*sci
= editor
->sci
;
2133 GSList
*words
, *node
;
2137 words
= get_doc_words(sci
, root
, rootlen
);
2140 SSM(sci
, SCI_AUTOCCANCEL
, 0, 0);
2144 str
= g_string_sized_new(rootlen
* 2 * 10);
2145 foreach_slist(node
, words
)
2147 g_string_append(str
, node
->data
);
2150 g_string_append_c(str
, '\n');
2153 if (n_words
>= editor_prefs
.autocompletion_max_entries
)
2154 g_string_append(str
, "\n...");
2156 g_slist_free(words
);
2158 show_autocomplete(sci
, rootlen
, str
);
2159 g_string_free(str
, TRUE
);
2164 gboolean
editor_start_auto_complete(GeanyEditor
*editor
, gint pos
, gboolean force
)
2166 gint rootlen
, lexer
, style
;
2168 gchar cword
[GEANY_MAX_WORD_LENGTH
];
2169 ScintillaObject
*sci
;
2170 gboolean ret
= FALSE
;
2171 const gchar
*wordchars
;
2174 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2176 if (! editor_prefs
.auto_complete_symbols
&& ! force
)
2179 /* If we are at the beginning of the document, we skip autocompletion as we can't determine the
2180 * necessary styling information */
2181 if (G_UNLIKELY(pos
< 2))
2185 ft
= editor
->document
->file_type
;
2187 lexer
= sci_get_lexer(sci
);
2188 style
= sci_get_style_at(sci
, pos
- 2);
2190 /* don't autocomplete in comments and strings */
2191 if (!force
&& !highlighting_is_code_style(lexer
, style
))
2194 ret
= autocomplete_check_html(editor
, style
, pos
);
2196 if (ft
->id
== GEANY_FILETYPES_LATEX
)
2197 wordchars
= GEANY_WORDCHARS
"\\"; /* add \ to word chars if we are in a LaTeX file */
2198 else if (ft
->id
== GEANY_FILETYPES_CSS
)
2199 wordchars
= GEANY_WORDCHARS
"-"; /* add - because they are part of property names */
2201 wordchars
= GEANY_WORDCHARS
;
2203 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, TRUE
);
2205 rootlen
= strlen(root
);
2209 if (autocomplete_scope_shown
)
2211 autocomplete_scope_shown
= FALSE
;
2213 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2218 ret
= autocomplete_scope(editor
, root
, rootlen
);
2219 if (!ret
&& autocomplete_scope_shown
)
2220 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2221 autocomplete_scope_shown
= ret
;
2224 if (!ret
&& rootlen
> 0)
2226 if (ft
->id
== GEANY_FILETYPES_PHP
&& style
== SCE_HPHP_DEFAULT
&&
2227 rootlen
== 3 && strcmp(root
, "php") == 0 && pos
>= 5 &&
2228 sci_get_char_at(sci
, pos
- 5) == '<' &&
2229 sci_get_char_at(sci
, pos
- 4) == '?')
2231 /* nothing, don't complete PHP open tags */
2235 /* force is set when called by keyboard shortcut, otherwise start at the
2236 * editor_prefs.symbolcompletion_min_chars'th char */
2237 if (force
|| rootlen
>= editor_prefs
.symbolcompletion_min_chars
)
2239 /* complete tags, except if forcing when completion is already visible */
2240 if (!(force
&& SSM(sci
, SCI_AUTOCACTIVE
, 0, 0)))
2241 ret
= autocomplete_tags(editor
, editor
->document
->file_type
, root
, rootlen
);
2243 /* If forcing and there's nothing else to show, complete from words in document */
2244 if (!ret
&& (force
|| editor_prefs
.autocomplete_doc_words
))
2245 ret
= autocomplete_doc_word(editor
, root
, rootlen
);
2256 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
)
2258 gchar
*result
= NULL
;
2261 g_return_val_if_fail(type
!= NULL
&& name
!= NULL
, NULL
);
2263 tmp
= g_hash_table_lookup(snippet_hash
, type
);
2266 result
= g_hash_table_lookup(tmp
, name
);
2268 /* whether nothing is set for the current filetype(tmp is NULL) or
2269 * the particular completion for this filetype is not set (result is NULL) */
2270 if (tmp
== NULL
|| result
== NULL
)
2272 tmp
= g_hash_table_lookup(snippet_hash
, "Default");
2275 result
= g_hash_table_lookup(tmp
, name
);
2278 /* if result is still NULL here, no completion could be found */
2280 /* result is owned by the hash table and will be freed when the table will destroyed */
2285 static void snippets_replace_specials(gpointer key
, gpointer value
, gpointer user_data
)
2288 GString
*pattern
= user_data
;
2290 g_return_if_fail(key
!= NULL
);
2291 g_return_if_fail(value
!= NULL
);
2293 needle
= g_strconcat("%", (gchar
*) key
, "%", NULL
);
2295 utils_string_replace_all(pattern
, needle
, (gchar
*) value
);
2300 static void fix_indentation(GeanyEditor
*editor
, GString
*buf
)
2302 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
2305 gint cflags
= G_REGEX_MULTILINE
;
2307 /* transform leading tabs into indent widths (in spaces) */
2308 whitespace
= g_strnfill(iprefs
->width
, ' ');
2309 regex
= g_regex_new("^ *(\t)", cflags
, 0, NULL
);
2310 while (utils_string_regex_replace_all(buf
, regex
, 1, whitespace
, TRUE
));
2311 g_regex_unref(regex
);
2313 /* remaining tabs are for alignment */
2314 if (iprefs
->type
!= GEANY_INDENT_TYPE_TABS
)
2315 utils_string_replace_all(buf
, "\t", whitespace
);
2317 /* use leading tabs */
2318 if (iprefs
->type
!= GEANY_INDENT_TYPE_SPACES
)
2322 /* for tabs+spaces mode we want the real tab width, not indent width */
2323 SETPTR(whitespace
, g_strnfill(sci_get_tab_width(editor
->sci
), ' '));
2324 str
= g_strdup_printf("^\t*(%s)", whitespace
);
2326 regex
= g_regex_new(str
, cflags
, 0, NULL
);
2327 while (utils_string_regex_replace_all(buf
, regex
, 1, "\t", TRUE
));
2328 g_regex_unref(regex
);
2337 Sci_Position start
, len
;
2341 #define CURSOR_PLACEHOLDER "_" /* Would rather use … but not all docs are unicode */
2344 /* Replaces the internal cursor markers with the placeholder suitable for
2345 * display. Except for the first cursor if indicator_for_first is FALSE,
2346 * which is simply deleted.
2348 * Returns insertion points as SelectionRange list, so that the caller
2349 * can use the positions (currently for indicators). */
2350 static GSList
*replace_cursor_markers(GeanyEditor
*editor
, GString
*template,
2351 gboolean indicator_for_first
)
2354 GSList
*temp_list
= NULL
;
2355 gint cursor_steps
= 0;
2356 SelectionRange
*sel
;
2360 cursor_steps
= utils_string_find(template, cursor_steps
, -1, geany_cursor_marker
);
2361 if (cursor_steps
== -1)
2364 sel
= g_new0(SelectionRange
, 1);
2365 sel
->start
= cursor_steps
;
2366 g_string_erase(template, cursor_steps
, strlen(geany_cursor_marker
));
2367 if (i
> 0 || indicator_for_first
)
2369 g_string_insert(template, cursor_steps
, CURSOR_PLACEHOLDER
);
2370 sel
->len
= sizeof(CURSOR_PLACEHOLDER
) - 1;
2373 temp_list
= g_slist_append(temp_list
, sel
);
2380 /** Inserts text, replacing \\t tab chars (@c 0x9) and \\n newline chars (@c 0xA)
2381 * accordingly for the document.
2382 * - Leading tabs are replaced with the correct indentation.
2383 * - Non-leading tabs are replaced with spaces (except when using 'Tabs' indent type).
2384 * - Newline chars are replaced with the correct line ending string.
2385 * This is very useful for inserting code without having to handle the indent
2386 * type yourself (Tabs & Spaces mode can be tricky).
2387 * @param editor Editor.
2388 * @param text Intended as e.g. @c "if (foo)\n\tbar();".
2389 * @param insert_pos Document position to insert text at.
2390 * @param cursor_index If >= 0, the index into @a text to place the cursor.
2391 * @param newline_indent_size Indentation size (in spaces) to insert for each newline; use
2392 * -1 to read the indent size from the line with @a insert_pos on it.
2393 * @param replace_newlines Whether to replace newlines. If
2394 * newlines have been replaced already, this should be false, to avoid errors e.g. on Windows.
2395 * @warning Make sure all \\t tab chars in @a text are intended as indent widths or alignment,
2396 * not hard tabs, as those won't be preserved.
2397 * @note This doesn't scroll the cursor in view afterwards. **/
2399 void editor_insert_text_block(GeanyEditor
*editor
, const gchar
*text
, gint insert_pos
,
2400 gint cursor_index
, gint newline_indent_size
, gboolean replace_newlines
)
2402 ScintillaObject
*sci
= editor
->sci
;
2403 gint line_start
= sci_get_line_from_position(sci
, insert_pos
);
2405 const gchar
*eol
= editor_get_eol_char(editor
);
2406 GSList
*jump_locs
, *item
;
2408 g_return_if_fail(text
);
2409 g_return_if_fail(editor
!= NULL
);
2410 g_return_if_fail(insert_pos
>= 0);
2412 buf
= g_string_new(text
);
2414 if (cursor_index
>= 0)
2415 g_string_insert(buf
, cursor_index
, geany_cursor_marker
); /* remember cursor pos */
2417 if (newline_indent_size
== -1)
2419 /* count indent size up to insert_pos instead of asking sci
2420 * because there may be spaces after it */
2421 gchar
*tmp
= sci_get_line(sci
, line_start
);
2424 idx
= insert_pos
- sci_get_position_from_line(sci
, line_start
);
2426 newline_indent_size
= count_indent_size(editor
, tmp
);
2430 /* Add line indents (in spaces) */
2431 if (newline_indent_size
> 0)
2433 const gchar
*nl
= replace_newlines
? "\n" : eol
;
2436 whitespace
= g_strnfill(newline_indent_size
, ' ');
2437 SETPTR(whitespace
, g_strconcat(nl
, whitespace
, NULL
));
2438 utils_string_replace_all(buf
, nl
, whitespace
);
2442 /* transform line endings */
2443 if (replace_newlines
)
2444 utils_string_replace_all(buf
, "\n", eol
);
2446 fix_indentation(editor
, buf
);
2448 jump_locs
= replace_cursor_markers(editor
, buf
, cursor_index
< 0);
2449 sci_insert_text(sci
, insert_pos
, buf
->str
);
2451 foreach_list(item
, jump_locs
)
2453 SelectionRange
*sel
= item
->data
;
2454 gint start
= insert_pos
+ sel
->start
;
2455 gint end
= start
+ sel
->len
;
2456 editor_indicator_set_on_range(editor
, GEANY_INDICATOR_SNIPPET
, start
, end
);
2457 /* jump to first cursor position initially */
2458 if (item
== jump_locs
)
2459 sci_set_selection(sci
, start
, end
);
2462 /* Set cursor to the requested index, or by default to after the snippet */
2463 if (cursor_index
>= 0)
2464 sci_set_current_position(sci
, insert_pos
+ cursor_index
, FALSE
);
2465 else if (jump_locs
== NULL
)
2466 sci_set_current_position(sci
, insert_pos
+ buf
->len
, FALSE
);
2468 g_slist_free_full(jump_locs
, g_free
);
2469 g_string_free(buf
, TRUE
);
2473 static gboolean
find_next_snippet_indicator(GeanyEditor
*editor
, SelectionRange
*sel
)
2475 ScintillaObject
*sci
= editor
->sci
;
2476 gint pos
= sci_get_current_position(sci
);
2478 if (pos
== sci_get_length(sci
))
2479 return FALSE
; /* EOF */
2481 /* Rewind the cursor a bit if we're in the middle (or start) of an indicator,
2482 * and treat that as the next indicator. */
2483 while (SSM(sci
, SCI_INDICATORVALUEAT
, GEANY_INDICATOR_SNIPPET
, pos
) && pos
> 0)
2486 /* Be careful at the beginning of the file */
2487 if (SSM(sci
, SCI_INDICATORVALUEAT
, GEANY_INDICATOR_SNIPPET
, pos
))
2490 sel
->start
= SSM(sci
, SCI_INDICATOREND
, GEANY_INDICATOR_SNIPPET
, pos
);
2491 sel
->len
= SSM(sci
, SCI_INDICATOREND
, GEANY_INDICATOR_SNIPPET
, sel
->start
) - sel
->start
;
2493 /* 0 if there is no remaining cursor */
2494 return sel
->len
> 0;
2498 /* Move the cursor to the next specified cursor position in an inserted snippet.
2499 * Can, and should, be optimized to give better results */
2500 gboolean
editor_goto_next_snippet_cursor(GeanyEditor
*editor
)
2502 ScintillaObject
*sci
= editor
->sci
;
2505 if (find_next_snippet_indicator(editor
, &sel
))
2507 sci_indicator_set(sci
, GEANY_INDICATOR_SNIPPET
);
2508 sci_set_selection(sci
, sel
.start
, sel
.start
+ sel
.len
);
2518 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
)
2520 GHashTable
*specials
;
2522 /* replace 'special' completions */
2523 specials
= g_hash_table_lookup(snippet_hash
, "Special");
2524 if (G_LIKELY(specials
!= NULL
))
2526 g_hash_table_foreach(specials
, snippets_replace_specials
, pattern
);
2529 /* now transform other wildcards */
2530 utils_string_replace_all(pattern
, "%newline%", "\n");
2531 utils_string_replace_all(pattern
, "%ws%", "\t");
2533 /* replace %cursor% by a very unlikely string marker */
2534 utils_string_replace_all(pattern
, "%cursor%", geany_cursor_marker
);
2536 /* unescape '%' after all %wildcards% */
2537 templates_replace_valist(pattern
, "{pc}", "%", NULL
);
2539 /* replace any template {foo} wildcards */
2540 templates_replace_common(pattern
, editor
->document
->file_name
, editor
->document
->file_type
, NULL
);
2544 static gboolean
snippets_complete_constructs(GeanyEditor
*editor
, gint pos
, const gchar
*word
)
2546 ScintillaObject
*sci
= editor
->sci
;
2548 const gchar
*completion
;
2550 gint ft_id
= editor
->document
->file_type
->id
;
2552 str
= g_strdup(word
);
2555 completion
= snippets_find_completion_by_name(filetypes
[ft_id
]->name
, str
);
2556 if (completion
== NULL
)
2562 /* remove the typed word, it will be added again by the used auto completion
2563 * (not really necessary but this makes the auto completion more flexible,
2564 * e.g. with a completion like hi=hello, so typing "hi<TAB>" will result in "hello") */
2565 str_len
= strlen(str
);
2566 sci_set_selection_start(sci
, pos
- str_len
);
2567 sci_set_selection_end(sci
, pos
);
2568 sci_replace_sel(sci
, "");
2569 pos
-= str_len
; /* pos has changed while deleting */
2571 editor_insert_snippet(editor
, pos
, completion
);
2572 sci_scroll_caret(sci
);
2579 static gboolean
at_eol(ScintillaObject
*sci
, gint pos
)
2581 gint line
= sci_get_line_from_position(sci
, pos
);
2584 /* skip any trailing spaces */
2587 c
= sci_get_char_at(sci
, pos
);
2588 if (c
== ' ' || c
== '\t')
2594 return (pos
== sci_get_line_end_position(sci
, line
));
2598 gboolean
editor_complete_snippet(GeanyEditor
*editor
, gint pos
)
2600 gboolean result
= FALSE
;
2603 ScintillaObject
*sci
;
2605 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2608 if (sci_has_selection(sci
))
2610 /* return if we are editing an existing line (chars on right of cursor) */
2611 if (keybindings_lookup_item(GEANY_KEY_GROUP_EDITOR
,
2612 GEANY_KEYS_EDITOR_COMPLETESNIPPET
)->key
== GDK_KEY_space
&&
2613 ! editor_prefs
.complete_snippets_whilst_editing
&& ! at_eol(sci
, pos
))
2616 wc
= snippets_find_completion_by_name("Special", "wordchars");
2617 word
= editor_read_word_stem(editor
, pos
, wc
);
2619 /* prevent completion of "for " */
2621 ! isspace(sci_get_char_at(sci
, pos
- 1))) /* pos points to the line end char so use pos -1 */
2623 sci_start_undo_action(sci
); /* needed because we insert a space separately from construct */
2624 result
= snippets_complete_constructs(editor
, pos
, word
);
2625 sci_end_undo_action(sci
);
2627 sci_cancel(sci
); /* cancel any autocompletion list, etc */
2633 static void insert_closing_tag(GeanyEditor
*editor
, gint pos
, gchar ch
, const gchar
*tag_name
)
2635 ScintillaObject
*sci
= editor
->sci
;
2636 gchar
*to_insert
= NULL
;
2640 const gchar
*gt
= ">";
2641 /* if there is already a '>' behind the cursor, don't add it */
2642 if (sci_get_char_at(sci
, pos
) == '>')
2645 to_insert
= g_strconcat(tag_name
, gt
, NULL
);
2648 to_insert
= g_strconcat("</", tag_name
, ">", NULL
);
2650 sci_start_undo_action(sci
);
2651 sci_replace_sel(sci
, to_insert
);
2653 sci_set_selection(sci
, pos
, pos
);
2654 sci_end_undo_action(sci
);
2660 * (stolen from anjuta and heavily modified)
2661 * This routine will auto complete XML or HTML tags that are still open by closing them
2662 * @param ch The character we are dealing with, currently only works with the '>' character
2663 * @return True if handled, false otherwise
2665 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
)
2667 ScintillaObject
*sci
= editor
->sci
;
2668 gint lexer
= sci_get_lexer(sci
);
2669 gint min
, size
, style
;
2670 gchar
*str_found
, sel
[512];
2671 gboolean result
= FALSE
;
2673 /* If the user has turned us off, quit now.
2674 * This may make sense only in certain languages */
2675 if (! editor_prefs
.auto_close_xml_tags
|| (lexer
!= SCLEX_HTML
&& lexer
!= SCLEX_XML
))
2678 /* return if we are inside any embedded script */
2679 style
= sci_get_style_at(sci
, pos
);
2680 if (style
> SCE_H_XCCOMMENT
&& ! highlighting_is_string_style(lexer
, style
))
2683 /* if ch is /, check for </, else quit */
2684 if (ch
== '/' && sci_get_char_at(sci
, pos
- 2) != '<')
2687 /* Grab the last 512 characters or so */
2688 min
= pos
- (sizeof(sel
) - 1);
2689 if (min
< 0) min
= 0;
2692 return FALSE
; /* Smallest tag is 3 characters e.g. <p> */
2694 sci_get_text_range(sci
, min
, pos
, sel
);
2695 sel
[sizeof(sel
) - 1] = '\0';
2697 if (ch
== '>' && sel
[pos
- min
- 2] == '/')
2698 /* User typed something like "<br/>" */
2703 size
-= 2; /* skip </ */
2704 str_found
= utils_find_open_xml_tag(sel
, size
);
2706 if (lexer
== SCLEX_HTML
&& utils_is_short_html_tag(str_found
))
2710 else if (!EMPTY(str_found
))
2712 insert_closing_tag(editor
, pos
, ch
, str_found
);
2720 /* like sci_get_line_indentation(), but for a string. */
2721 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
)
2724 gsize tab_size
= sci_get_tab_width(editor
->sci
);
2727 g_return_val_if_fail(base_indent
, 0);
2729 for (ptr
= base_indent
; *ptr
!= 0; ptr
++)
2747 /* Handles special cases where HTML is embedded in another language or
2748 * another language is embedded in HTML */
2749 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
)
2751 gint style
, line_start
;
2752 GeanyFiletype
*current_ft
;
2754 g_return_val_if_fail(editor
!= NULL
, NULL
);
2755 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, NULL
);
2757 current_ft
= editor
->document
->file_type
;
2758 line_start
= sci_get_position_from_line(editor
->sci
, line
);
2759 style
= sci_get_style_at(editor
->sci
, line_start
);
2761 /* Handle PHP filetype with embedded HTML */
2762 if (current_ft
->id
== GEANY_FILETYPES_PHP
&& ! is_style_php(style
))
2763 current_ft
= filetypes
[GEANY_FILETYPES_HTML
];
2765 /* Handle languages embedded in HTML */
2766 if (current_ft
->id
== GEANY_FILETYPES_HTML
)
2769 if (style
>= SCE_HJ_DEFAULT
&& style
<= SCE_HJ_REGEX
)
2770 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2772 else if (style
>= SCE_HJA_DEFAULT
&& style
<= SCE_HJA_REGEX
)
2773 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2775 else if (style
>= SCE_HB_DEFAULT
&& style
<= SCE_HB_STRINGEOL
)
2776 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2778 else if (style
>= SCE_HBA_DEFAULT
&& style
<= SCE_HBA_STRINGEOL
)
2779 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2780 /* Embedded Python */
2781 else if (style
>= SCE_HP_DEFAULT
&& style
<= SCE_HP_IDENTIFIER
)
2782 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2784 else if (style
>= SCE_HPA_DEFAULT
&& style
<= SCE_HPA_IDENTIFIER
)
2785 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2787 else if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
2788 style
== SCE_HPHP_COMPLEX_VARIABLE
)
2790 current_ft
= filetypes
[GEANY_FILETYPES_PHP
];
2794 /* Ensure the filetype's config is loaded */
2795 filetypes_load_config(current_ft
->id
, FALSE
);
2801 static void real_comment_multiline(GeanyEditor
*editor
, gint line_start
, gint last_line
)
2804 gchar
*str_begin
, *str_end
;
2805 const gchar
*co
, *cc
;
2809 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
2811 ft
= editor_get_filetype_at_line(editor
, line_start
);
2813 eol
= editor_get_eol_char(editor
);
2814 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2815 g_return_if_reached();
2816 str_begin
= g_strdup_printf("%s%s", (co
!= NULL
) ? co
: "", eol
);
2817 str_end
= g_strdup_printf("%s%s", (cc
!= NULL
) ? cc
: "", eol
);
2819 /* insert the comment strings */
2820 sci_insert_text(editor
->sci
, line_start
, str_begin
);
2821 line_len
= sci_get_position_from_line(editor
->sci
, last_line
+ 2);
2822 sci_insert_text(editor
->sci
, line_len
, str_end
);
2829 /* find @p text inside the range of the current style */
2830 static gint
find_in_current_style(ScintillaObject
*sci
, const gchar
*text
, gboolean backwards
)
2832 gint start
= sci_get_current_position(sci
);
2834 gint len
= sci_get_length(sci
);
2835 gint current_style
= sci_get_style_at(sci
, start
);
2836 struct Sci_TextToFind ttf
;
2838 while (start
> 0 && sci_get_style_at(sci
, start
- 1) == current_style
)
2840 while (end
< len
&& sci_get_style_at(sci
, end
+ 1) == current_style
)
2843 ttf
.lpstrText
= (gchar
*) text
;
2844 ttf
.chrg
.cpMin
= backwards
? end
+ 1 : start
;
2845 ttf
.chrg
.cpMax
= backwards
? start
: end
+ 1;
2846 return sci_find_text(sci
, 0, &ttf
);
2850 static void sci_delete_line(ScintillaObject
*sci
, gint line
)
2852 gint start
= sci_get_position_from_line(sci
, line
);
2853 gint len
= sci_get_line_length(sci
, line
);
2854 SSM(sci
, SCI_DELETERANGE
, start
, len
);
2858 static gboolean
real_uncomment_multiline(GeanyEditor
*editor
)
2860 /* find the beginning of the multi line comment */
2861 gint start
, end
, start_line
, end_line
;
2863 const gchar
*co
, *cc
;
2865 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, FALSE
);
2867 ft
= editor_get_filetype_at_line(editor
, sci_get_current_line(editor
->sci
));
2868 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2869 g_return_val_if_reached(FALSE
);
2871 start
= find_in_current_style(editor
->sci
, co
, TRUE
);
2872 end
= find_in_current_style(editor
->sci
, cc
, FALSE
);
2874 if (start
< 0 || end
< 0 || start
> end
/* who knows */)
2877 start_line
= sci_get_line_from_position(editor
->sci
, start
);
2878 end_line
= sci_get_line_from_position(editor
->sci
, end
);
2880 /* remove comment close chars */
2881 SSM(editor
->sci
, SCI_DELETERANGE
, end
, strlen(cc
));
2882 if (sci_is_blank_line(editor
->sci
, end_line
))
2883 sci_delete_line(editor
->sci
, end_line
);
2885 /* remove comment open chars (do it last since it would move the end position) */
2886 SSM(editor
->sci
, SCI_DELETERANGE
, start
, strlen(co
));
2887 if (sci_is_blank_line(editor
->sci
, start_line
))
2888 sci_delete_line(editor
->sci
, start_line
);
2894 static gint
get_multiline_comment_style(GeanyEditor
*editor
, gint line_start
)
2896 gint lexer
= sci_get_lexer(editor
->sci
);
2899 /* List only those lexers which support multi line comments */
2904 case SCLEX_PHPSCRIPT
:
2906 if (is_style_php(sci_get_style_at(editor
->sci
, line_start
)))
2907 style_comment
= SCE_HPHP_COMMENT
;
2909 style_comment
= SCE_H_COMMENT
;
2913 case SCLEX_LITERATEHASKELL
:
2914 style_comment
= SCE_HA_COMMENTBLOCK
; break;
2915 case SCLEX_LUA
: style_comment
= SCE_LUA_COMMENT
; break;
2916 case SCLEX_CSS
: style_comment
= SCE_CSS_COMMENT
; break;
2917 case SCLEX_SQL
: style_comment
= SCE_SQL_COMMENT
; break;
2918 case SCLEX_CAML
: style_comment
= SCE_CAML_COMMENT
; break;
2919 case SCLEX_D
: style_comment
= SCE_D_COMMENT
; break;
2920 case SCLEX_PASCAL
: style_comment
= SCE_PAS_COMMENT
; break;
2921 case SCLEX_RUST
: style_comment
= SCE_RUST_COMMENTBLOCK
; break;
2922 default: style_comment
= SCE_C_COMMENT
;
2925 return style_comment
;
2929 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise
2930 * returns the amount of uncommented single comment lines, in case of multi line uncomment
2931 * it returns just 1 */
2932 gint
editor_do_uncomment(GeanyEditor
*editor
, gint line
, gboolean toggle
)
2934 gint first_line
, last_line
;
2935 gint x
, i
, line_start
, line_len
;
2936 gint sel_start
, sel_end
;
2940 const gchar
*co
, *cc
;
2941 gboolean single_line
= FALSE
;
2944 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
2947 { /* use selection or current line */
2948 sel_start
= sci_get_selection_start(editor
->sci
);
2949 sel_end
= sci_get_selection_end(editor
->sci
);
2951 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
2952 /* Find the last line with chars selected (not EOL char) */
2953 last_line
= sci_get_line_from_position(editor
->sci
,
2954 sel_end
- editor_get_eol_char_len(editor
));
2955 last_line
= MAX(first_line
, last_line
);
2959 first_line
= last_line
= line
;
2960 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
2963 ft
= editor_get_filetype_at_line(editor
, first_line
);
2965 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
2968 co_len
= strlen(co
);
2972 sci_start_undo_action(editor
->sci
);
2974 for (i
= first_line
; i
<= last_line
; i
++)
2978 line_start
= sci_get_position_from_line(editor
->sci
, i
);
2979 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
2982 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
2985 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
2986 sel
[buf_len
] = '\0';
2988 while (isspace(sel
[x
])) x
++;
2990 /* to skip blank lines */
2991 if (x
< line_len
&& sel
[x
] != '\0')
2993 /* use single line comment */
3000 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3001 if (strncmp(sel
+ x
, co
, co_len
) != 0 ||
3002 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) != 0)
3009 if (strncmp(sel
+ x
, co
, co_len
) != 0)
3013 sci_set_selection(editor
->sci
, line_start
+ x
, line_start
+ x
+ co_len
);
3014 sci_replace_sel(editor
->sci
, "");
3017 /* use multi line comment */
3022 /* skip lines which are already comments */
3023 style_comment
= get_multiline_comment_style(editor
, line_start
);
3024 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3026 if (real_uncomment_multiline(editor
))
3030 /* break because we are already on the last line */
3035 sci_end_undo_action(editor
->sci
);
3037 /* restore selection if there is one
3038 * but don't touch the selection if caller is editor_do_comment_toggle */
3039 if (! toggle
&& sel_start
< sel_end
)
3043 sci_set_selection_start(editor
->sci
, sel_start
- co_len
);
3044 sci_set_selection_end(editor
->sci
, sel_end
- (count
* co_len
));
3048 gint eol_len
= editor_get_eol_char_len(editor
);
3049 sci_set_selection_start(editor
->sci
, sel_start
- co_len
- eol_len
);
3050 sci_set_selection_end(editor
->sci
, sel_end
- co_len
- eol_len
);
3058 void editor_do_comment_toggle(GeanyEditor
*editor
)
3060 gint first_line
, last_line
;
3061 gint x
, i
, line_start
, line_len
, first_line_start
, last_line_start
;
3062 gint sel_start
, sel_end
;
3063 gint count_commented
= 0, count_uncommented
= 0;
3065 const gchar
*co
, *cc
;
3066 gboolean single_line
= FALSE
;
3067 gboolean first_line_was_comment
= FALSE
;
3068 gboolean last_line_was_comment
= FALSE
;
3070 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3073 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3075 sel_start
= sci_get_selection_start(editor
->sci
);
3076 sel_end
= sci_get_selection_end(editor
->sci
);
3078 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3079 /* Find the last line with chars selected (not EOL char) */
3080 last_line
= sci_get_line_from_position(editor
->sci
,
3081 sel_end
- editor_get_eol_char_len(editor
));
3082 last_line
= MAX(first_line
, last_line
);
3084 first_line_start
= sci_get_position_from_line(editor
->sci
, first_line
);
3085 last_line_start
= sci_get_position_from_line(editor
->sci
, last_line
);
3087 ft
= editor_get_filetype_at_line(editor
, first_line
);
3089 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3092 co_len
= strlen(co
);
3096 sci_start_undo_action(editor
->sci
);
3098 for (i
= first_line
; i
<= last_line
; i
++)
3102 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3103 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3106 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3109 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3110 sel
[buf_len
] = '\0';
3112 while (isspace(sel
[x
])) x
++;
3114 /* use single line comment */
3117 gboolean do_continue
= FALSE
;
3120 if (strncmp(sel
+ x
, co
, co_len
) == 0 &&
3121 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) == 0)
3126 if (do_continue
&& i
== first_line
)
3127 first_line_was_comment
= TRUE
;
3128 last_line_was_comment
= do_continue
;
3132 count_uncommented
+= editor_do_uncomment(editor
, i
, TRUE
);
3136 /* we are still here, so the above lines were not already comments, so comment it */
3137 count_commented
+= editor_do_comment(editor
, i
, FALSE
, TRUE
, TRUE
);
3139 /* use multi line comment */
3144 /* skip lines which are already comments */
3145 style_comment
= get_multiline_comment_style(editor
, line_start
);
3146 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3148 if (real_uncomment_multiline(editor
))
3149 count_uncommented
++;
3153 real_comment_multiline(editor
, line_start
, last_line
);
3157 /* break because we are already on the last line */
3162 sci_end_undo_action(editor
->sci
);
3166 /* restore selection or caret position */
3169 gint a
= (first_line_was_comment
) ? - (gint
) co_len
: (gint
) co_len
;
3172 /* don't modify sel_start when the selection starts within indentation */
3173 read_indent(editor
, sel_start
);
3174 indent_len
= (gint
) strlen(indent
);
3175 if ((sel_start
- first_line_start
) <= indent_len
)
3177 /* if the selection start was inside the comment mark, adjust the position */
3178 else if (first_line_was_comment
&&
3179 sel_start
>= (first_line_start
+ indent_len
) &&
3180 sel_start
<= (first_line_start
+ indent_len
+ (gint
) co_len
))
3182 a
= (first_line_start
+ indent_len
) - sel_start
;
3185 if (sel_start
< sel_end
)
3187 gint b
= (count_commented
* (gint
) co_len
) - (count_uncommented
* (gint
) co_len
);
3189 /* same for selection end, but here we add an offset on the offset above */
3190 read_indent(editor
, sel_end
+ b
);
3191 indent_len
= (gint
) strlen(indent
);
3192 if ((sel_end
- last_line_start
) < indent_len
)
3193 b
+= last_line_was_comment
? (gint
) co_len
: -(gint
) co_len
;
3194 else if (last_line_was_comment
&&
3195 sel_end
>= (last_line_start
+ indent_len
) &&
3196 sel_end
<= (last_line_start
+ indent_len
+ (gint
) co_len
))
3198 b
+= (gint
) co_len
- (sel_end
- (last_line_start
+ indent_len
));
3201 sci_set_selection_start(editor
->sci
, sel_start
+ a
);
3202 sci_set_selection_end(editor
->sci
, sel_end
+ b
);
3205 sci_set_current_position(editor
->sci
, sel_start
+ a
, TRUE
);
3209 gint eol_len
= editor_get_eol_char_len(editor
);
3210 if (count_uncommented
> 0)
3212 sci_set_selection_start(editor
->sci
, sel_start
- (gint
) co_len
+ eol_len
);
3213 sci_set_selection_end(editor
->sci
, sel_end
- (gint
) co_len
+ eol_len
);
3215 else if (count_commented
> 0)
3217 sci_set_selection_start(editor
->sci
, sel_start
+ (gint
) co_len
- eol_len
);
3218 sci_set_selection_end(editor
->sci
, sel_end
+ (gint
) co_len
- eol_len
);
3220 if (sel_start
>= sel_end
)
3221 sci_scroll_caret(editor
->sci
);
3226 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise */
3227 gint
editor_do_comment(GeanyEditor
*editor
, gint line
, gboolean allow_empty_lines
, gboolean toggle
,
3228 gboolean single_comment
)
3230 gint first_line
, last_line
;
3231 gint x
, i
, line_start
, line_len
;
3232 gint sel_start
, sel_end
, co_len
;
3235 const gchar
*co
, *cc
;
3236 gboolean single_line
= FALSE
;
3239 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
3242 { /* use selection or current line */
3243 sel_start
= sci_get_selection_start(editor
->sci
);
3244 sel_end
= sci_get_selection_end(editor
->sci
);
3246 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3247 /* Find the last line with chars selected (not EOL char) */
3248 last_line
= sci_get_line_from_position(editor
->sci
,
3249 sel_end
- editor_get_eol_char_len(editor
));
3250 last_line
= MAX(first_line
, last_line
);
3254 first_line
= last_line
= line
;
3255 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3258 ft
= editor_get_filetype_at_line(editor
, first_line
);
3260 if (! filetype_get_comment_open_close(ft
, single_comment
, &co
, &cc
))
3263 co_len
= strlen(co
);
3267 sci_start_undo_action(editor
->sci
);
3269 for (i
= first_line
; i
<= last_line
; i
++)
3273 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3274 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3277 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3280 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3281 sel
[buf_len
] = '\0';
3283 while (isspace(sel
[x
])) x
++;
3285 /* to skip blank lines */
3286 if (allow_empty_lines
|| (x
< line_len
&& sel
[x
] != '\0'))
3288 /* use single line comment */
3291 gint start
= line_start
;
3294 if (ft
->comment_use_indent
)
3295 start
= line_start
+ x
;
3299 gchar
*text
= g_strconcat(co
, editor_prefs
.comment_toggle_mark
, NULL
);
3300 sci_insert_text(editor
->sci
, start
, text
);
3304 sci_insert_text(editor
->sci
, start
, co
);
3307 /* use multi line comment */
3312 /* skip lines which are already comments */
3313 style_comment
= get_multiline_comment_style(editor
, line_start
);
3314 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3317 real_comment_multiline(editor
, line_start
, last_line
);
3320 /* break because we are already on the last line */
3325 sci_end_undo_action(editor
->sci
);
3327 /* restore selection if there is one
3328 * but don't touch the selection if caller is editor_do_comment_toggle */
3329 if (! toggle
&& sel_start
< sel_end
)
3333 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
);
3334 sci_set_selection_end(editor
->sci
, sel_end
+ (count
* co_len
));
3338 gint eol_len
= editor_get_eol_char_len(editor
);
3339 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
+ eol_len
);
3340 sci_set_selection_end(editor
->sci
, sel_end
+ co_len
+ eol_len
);
3347 static gboolean brace_timeout_active
= FALSE
;
3349 static gboolean
delay_match_brace(G_GNUC_UNUSED gpointer user_data
)
3351 GeanyDocument
*doc
= document_get_current();
3352 GeanyEditor
*editor
;
3353 gint brace_pos
= GPOINTER_TO_INT(user_data
);
3354 gint end_pos
, cur_pos
;
3356 brace_timeout_active
= FALSE
;
3360 editor
= doc
->editor
;
3361 cur_pos
= sci_get_current_position(editor
->sci
) - 1;
3363 if (cur_pos
!= brace_pos
)
3366 if (cur_pos
!= brace_pos
)
3368 /* we have moved past the original brace_pos, but after the timeout
3369 * we may now be on a new brace, so check again */
3370 editor_highlight_braces(editor
, cur_pos
);
3374 if (!utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3376 editor_highlight_braces(editor
, cur_pos
);
3379 end_pos
= sci_find_matching_brace(editor
->sci
, brace_pos
);
3383 gint col
= MIN(sci_get_col_from_position(editor
->sci
, brace_pos
),
3384 sci_get_col_from_position(editor
->sci
, end_pos
));
3385 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, col
, 0);
3386 SSM(editor
->sci
, SCI_BRACEHIGHLIGHT
, brace_pos
, end_pos
);
3390 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3391 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, brace_pos
, 0);
3397 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
)
3399 gint brace_pos
= cur_pos
- 1;
3401 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3402 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, (uptr_t
)-1, 0);
3404 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3407 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3412 if (!brace_timeout_active
)
3414 brace_timeout_active
= TRUE
;
3415 /* delaying matching makes scrolling faster e.g. holding down arrow keys */
3416 g_timeout_add(100, delay_match_brace
, GINT_TO_POINTER(brace_pos
));
3421 static gboolean
in_block_comment(gint lexer
, gint style
)
3427 return (style
== SCE_C_COMMENT
||
3428 style
== SCE_C_COMMENTDOC
);
3431 return (style
== SCE_PAS_COMMENT
||
3432 style
== SCE_PAS_COMMENT2
);
3435 return (style
== SCE_D_COMMENT
||
3436 style
== SCE_D_COMMENTDOC
||
3437 style
== SCE_D_COMMENTNESTED
);
3440 case SCLEX_PHPSCRIPT
:
3441 return (style
== SCE_HPHP_COMMENT
);
3444 return (style
== SCE_CSS_COMMENT
);
3447 return (style
== SCE_RUST_COMMENTBLOCK
||
3448 style
== SCE_RUST_COMMENTBLOCKDOC
);
3456 static gboolean
is_comment_char(gchar c
, gint lexer
)
3458 if ((c
== '*' || c
== '+') && lexer
== SCLEX_D
)
3468 static void auto_multiline(GeanyEditor
*editor
, gint cur_line
)
3470 ScintillaObject
*sci
= editor
->sci
;
3471 gint indent_pos
, style
;
3472 gint lexer
= sci_get_lexer(sci
);
3474 /* Use the start of the line enter was pressed on, to avoid any doc keyword styles */
3475 indent_pos
= sci_get_line_indent_position(sci
, cur_line
- 1);
3476 style
= sci_get_style_at(sci
, indent_pos
);
3477 if (!in_block_comment(lexer
, style
))
3480 /* Check whether the comment block continues on this line */
3481 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3482 if (sci_get_style_at(sci
, indent_pos
) == style
|| indent_pos
>= sci_get_length(sci
))
3484 gchar
*previous_line
= sci_get_line(sci
, cur_line
- 1);
3485 /* the type of comment, '*' (C/C++/Java), '+' and the others (D) */
3486 const gchar
*continuation
= "*";
3487 const gchar
*whitespace
= ""; /* to hold whitespace if needed */
3489 gint len
= strlen(previous_line
);
3492 /* find and stop at end of multi line comment */
3494 while (i
>= 0 && isspace(previous_line
[i
])) i
--;
3495 if (i
>= 1 && is_comment_char(previous_line
[i
- 1], lexer
) && previous_line
[i
] == '/')
3497 gint indent_len
, indent_width
;
3499 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3500 indent_len
= sci_get_col_from_position(sci
, indent_pos
);
3501 indent_width
= editor_get_indent_prefs(editor
)->width
;
3503 /* if there is one too many spaces, delete the last space,
3504 * to return to the indent used before the multiline comment was started. */
3505 if (indent_len
% indent_width
== 1)
3506 SSM(sci
, SCI_DELETEBACKNOTLINE
, 0, 0); /* remove whitespace indent */
3507 g_free(previous_line
);
3510 /* check whether we are on the second line of multi line comment */
3512 while (i
< len
&& isspace(previous_line
[i
])) i
++; /* get to start of the line */
3515 previous_line
[i
] == '/' && is_comment_char(previous_line
[i
+ 1], lexer
))
3516 { /* we are on the second line of a multi line comment, so we have to insert white space */
3520 if (style
== SCE_D_COMMENTNESTED
)
3521 continuation
= "+"; /* for nested comments in D */
3523 result
= g_strconcat(whitespace
, continuation
, " ", NULL
);
3524 sci_add_text(sci
, result
);
3527 g_free(previous_line
);
3533 static gboolean
editor_lexer_is_c_like(gint lexer
)
3548 /* inserts a three-line comment at one line above current cursor position */
3549 void editor_insert_multiline_comment(GeanyEditor
*editor
)
3555 gboolean have_multiline_comment
= FALSE
;
3557 const gchar
*co
, *cc
;
3559 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3561 if (! filetype_get_comment_open_close(editor
->document
->file_type
, FALSE
, &co
, &cc
))
3562 g_return_if_reached();
3564 have_multiline_comment
= TRUE
;
3566 sci_start_undo_action(editor
->sci
);
3568 doc
= editor
->document
;
3570 /* insert three lines one line above of the current position */
3571 line
= sci_get_line_from_position(editor
->sci
, editor_info
.click_pos
);
3572 pos
= sci_get_position_from_line(editor
->sci
, line
);
3574 /* use the indent on the current line but only when comment indentation is used
3575 * and we don't have multi line comment characters */
3576 if (editor
->auto_indent
&&
3577 ! have_multiline_comment
&& doc
->file_type
->comment_use_indent
)
3579 read_indent(editor
, editor_info
.click_pos
);
3580 text
= g_strdup_printf("%s\n%s\n%s\n", indent
, indent
, indent
);
3581 text_len
= strlen(text
);
3585 text
= g_strdup("\n\n\n");
3588 sci_insert_text(editor
->sci
, pos
, text
);
3591 /* select the inserted lines for commenting */
3592 sci_set_selection_start(editor
->sci
, pos
);
3593 sci_set_selection_end(editor
->sci
, pos
+ text_len
);
3595 editor_do_comment(editor
, -1, TRUE
, FALSE
, FALSE
);
3597 /* set the current position to the start of the first inserted line */
3600 /* on multi line comment jump to the next line, otherwise add the length of added indentation */
3601 if (have_multiline_comment
)
3604 pos
+= strlen(indent
);
3606 sci_set_current_position(editor
->sci
, pos
, TRUE
);
3607 /* reset the selection */
3608 sci_set_anchor(editor
->sci
, pos
);
3610 sci_end_undo_action(editor
->sci
);
3614 /* Note: If the editor is pending a redraw, set document::scroll_percent instead.
3615 * Scroll the view to make line appear at percent_of_view.
3616 * line can be -1 to use the current position. */
3617 void editor_scroll_to_line(GeanyEditor
*editor
, gint line
, gfloat percent_of_view
)
3622 g_return_if_fail(editor
!= NULL
);
3624 wid
= GTK_WIDGET(editor
->sci
);
3626 if (! gtk_widget_get_window(wid
) || ! gdk_window_is_viewable(gtk_widget_get_window(wid
)))
3627 return; /* prevent gdk_window_scroll warning */
3630 line
= sci_get_current_line(editor
->sci
);
3632 /* sci 'visible line' != doc line number because of folding and line wrapping */
3633 /* calling SCI_VISIBLEFROMDOCLINE for line is more accurate than calling
3634 * SCI_DOCLINEFROMVISIBLE for vis1. */
3635 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0);
3636 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
3637 line
= line
- los
* percent_of_view
;
3638 SSM(editor
->sci
, SCI_SETFIRSTVISIBLELINE
, line
, 0);
3639 sci_scroll_caret(editor
->sci
); /* needed for horizontal scrolling */
3643 /* creates and inserts one tab or whitespace of the amount of the tab width */
3644 void editor_insert_alternative_whitespace(GeanyEditor
*editor
)
3647 GeanyIndentPrefs iprefs
= *editor_get_indent_prefs(editor
);
3649 g_return_if_fail(editor
!= NULL
);
3651 switch (iprefs
.type
)
3653 case GEANY_INDENT_TYPE_TABS
:
3654 iprefs
.type
= GEANY_INDENT_TYPE_SPACES
;
3656 case GEANY_INDENT_TYPE_SPACES
:
3657 case GEANY_INDENT_TYPE_BOTH
: /* most likely we want a tab */
3658 iprefs
.type
= GEANY_INDENT_TYPE_TABS
;
3661 text
= get_whitespace(&iprefs
, iprefs
.width
);
3662 sci_add_text(editor
->sci
, text
);
3667 void editor_select_word(GeanyEditor
*editor
)
3673 g_return_if_fail(editor
!= NULL
);
3675 pos
= SSM(editor
->sci
, SCI_GETCURRENTPOS
, 0, 0);
3676 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
3677 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
3679 if (start
== end
) /* caret in whitespaces sequence */
3681 /* look forward but reverse the selection direction,
3682 * so the caret end up stay as near as the original position. */
3683 end
= sci_word_end_position(editor
->sci
, pos
, FALSE
);
3684 start
= sci_word_end_position(editor
->sci
, end
, TRUE
);
3689 sci_set_selection(editor
->sci
, start
, end
);
3693 /* extra_line is for selecting the cursor line (or anchor line) at the bottom of a selection,
3694 * when those lines have no selection (cursor at start of line). */
3695 void editor_select_lines(GeanyEditor
*editor
, gboolean extra_line
)
3697 gint start
, end
, line
;
3699 g_return_if_fail(editor
!= NULL
);
3701 start
= sci_get_selection_start(editor
->sci
);
3702 end
= sci_get_selection_end(editor
->sci
);
3704 /* check if whole lines are already selected */
3705 if (! extra_line
&& start
!= end
&&
3706 sci_get_col_from_position(editor
->sci
, start
) == 0 &&
3707 sci_get_col_from_position(editor
->sci
, end
) == 0)
3710 line
= sci_get_line_from_position(editor
->sci
, start
);
3711 start
= sci_get_position_from_line(editor
->sci
, line
);
3713 line
= sci_get_line_from_position(editor
->sci
, end
);
3714 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
3716 sci_set_selection(editor
->sci
, start
, end
);
3720 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
)
3722 return sci_get_line_indent_position(sci
, line
) ==
3723 sci_get_line_end_position(sci
, line
);
3727 /* Returns first line of paragraph for GTK_DIR_UP, line after paragraph
3728 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3729 static gint
find_paragraph_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3732 ScintillaObject
*sci
= editor
->sci
;
3734 /* first check current line and return -1 if it is empty to skip creating of a selection */
3735 if (sci_is_blank_line(sci
, line
))
3738 if (direction
== GTK_DIR_UP
)
3748 /* start of document */
3752 if (line
== sci_get_line_count(sci
))
3755 if (sci_is_blank_line(sci
, line
))
3757 /* return line paragraph starts on */
3758 if (direction
== GTK_DIR_UP
)
3767 void editor_select_paragraph(GeanyEditor
*editor
)
3769 gint pos_start
, pos_end
, line_start
, line_found
;
3771 g_return_if_fail(editor
!= NULL
);
3773 line_start
= sci_get_current_line(editor
->sci
);
3775 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_UP
);
3776 if (line_found
== -1)
3779 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3781 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_DOWN
);
3782 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3784 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3788 /* Returns first line of block for GTK_DIR_UP, line after block
3789 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3790 static gint
find_block_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3793 ScintillaObject
*sci
= editor
->sci
;
3795 /* first check current line and return -1 if it is empty to skip creating of a selection */
3796 if (sci_is_blank_line(sci
, line
))
3799 if (direction
== GTK_DIR_UP
)
3804 ind
= sci_get_line_indentation(sci
, line
);
3810 /* start of document */
3814 if (line
== sci_get_line_count(sci
))
3817 if (sci_get_line_indentation(sci
, line
) != ind
||
3818 sci_is_blank_line(sci
, line
))
3820 /* return line block starts on */
3821 if (direction
== GTK_DIR_UP
)
3830 void editor_select_indent_block(GeanyEditor
*editor
)
3832 gint pos_start
, pos_end
, line_start
, line_found
;
3834 g_return_if_fail(editor
!= NULL
);
3836 line_start
= sci_get_current_line(editor
->sci
);
3838 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_UP
);
3839 if (line_found
== -1)
3842 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3844 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_DOWN
);
3845 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3847 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3851 /* simple indentation to indent the current line with the same indent as the previous one */
3852 static void smart_line_indentation(GeanyEditor
*editor
, gint first_line
, gint last_line
)
3854 gint i
, sel_start
= 0, sel_end
= 0;
3856 /* get previous line and use it for read_indent to use that line
3857 * (otherwise it would fail on a line only containing "{" in advanced indentation mode) */
3858 read_indent(editor
, sci_get_position_from_line(editor
->sci
, first_line
- 1));
3860 for (i
= first_line
; i
<= last_line
; i
++)
3862 /* skip the first line or if the indentation of the previous and current line are equal */
3864 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
- 1, 0) ==
3865 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
, 0))
3868 sel_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3869 sel_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3870 if (sel_start
< sel_end
)
3872 sci_set_selection(editor
->sci
, sel_start
, sel_end
);
3873 sci_replace_sel(editor
->sci
, "");
3875 sci_insert_text(editor
->sci
, sel_start
, indent
);
3880 /* simple indentation to indent the current line with the same indent as the previous one */
3881 void editor_smart_line_indentation(GeanyEditor
*editor
)
3883 gint first_line
, last_line
;
3884 gint first_sel_start
, first_sel_end
;
3885 ScintillaObject
*sci
;
3887 g_return_if_fail(editor
!= NULL
);
3891 first_sel_start
= sci_get_selection_start(sci
);
3892 first_sel_end
= sci_get_selection_end(sci
);
3894 first_line
= sci_get_line_from_position(sci
, first_sel_start
);
3895 /* Find the last line with chars selected (not EOL char) */
3896 last_line
= sci_get_line_from_position(sci
, first_sel_end
- editor_get_eol_char_len(editor
));
3897 last_line
= MAX(first_line
, last_line
);
3899 sci_start_undo_action(sci
);
3901 smart_line_indentation(editor
, first_line
, last_line
);
3903 /* set cursor position if there was no selection */
3904 if (first_sel_start
== first_sel_end
)
3906 gint indent_pos
= SSM(sci
, SCI_GETLINEINDENTPOSITION
, first_line
, 0);
3908 /* use indent position as user may wish to change indentation afterwards */
3909 sci_set_current_position(sci
, indent_pos
, FALSE
);
3913 /* fully select all the lines affected */
3914 sci_set_selection_start(sci
, sci_get_position_from_line(sci
, first_line
));
3915 sci_set_selection_end(sci
, sci_get_position_from_line(sci
, last_line
+ 1));
3918 sci_end_undo_action(sci
);
3922 /* increase / decrease current line or selection by one space */
3923 void editor_indentation_by_one_space(GeanyEditor
*editor
, gint pos
, gboolean decrease
)
3925 gint i
, first_line
, last_line
, line_start
, indentation_end
, count
= 0;
3926 gint sel_start
, sel_end
, first_line_offset
= 0;
3928 g_return_if_fail(editor
!= NULL
);
3930 sel_start
= sci_get_selection_start(editor
->sci
);
3931 sel_end
= sci_get_selection_end(editor
->sci
);
3933 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3934 /* Find the last line with chars selected (not EOL char) */
3935 last_line
= sci_get_line_from_position(editor
->sci
, sel_end
- editor_get_eol_char_len(editor
));
3936 last_line
= MAX(first_line
, last_line
);
3941 sci_start_undo_action(editor
->sci
);
3943 for (i
= first_line
; i
<= last_line
; i
++)
3945 indentation_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3948 line_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3949 /* searching backwards for a space to remove */
3950 while (sci_get_char_at(editor
->sci
, indentation_end
) != ' ' && indentation_end
> line_start
)
3953 if (sci_get_char_at(editor
->sci
, indentation_end
) == ' ')
3955 sci_set_selection(editor
->sci
, indentation_end
, indentation_end
+ 1);
3956 sci_replace_sel(editor
->sci
, "");
3958 if (i
== first_line
)
3959 first_line_offset
= -1;
3964 sci_insert_text(editor
->sci
, indentation_end
, " ");
3966 if (i
== first_line
)
3967 first_line_offset
= 1;
3971 /* set cursor position */
3972 if (sel_start
< sel_end
)
3974 gint start
= sel_start
+ first_line_offset
;
3975 if (first_line_offset
< 0)
3976 start
= MAX(sel_start
+ first_line_offset
,
3977 SSM(editor
->sci
, SCI_POSITIONFROMLINE
, first_line
, 0));
3979 sci_set_selection_start(editor
->sci
, start
);
3980 sci_set_selection_end(editor
->sci
, sel_end
+ count
);
3983 sci_set_current_position(editor
->sci
, pos
+ count
, FALSE
);
3985 sci_end_undo_action(editor
->sci
);
3989 void editor_finalize(void)
3991 scintilla_release_resources();
3995 /* wordchars: NULL or a string containing characters to match a word.
3996 * Returns: the current selection or the current word.
3998 * Passing NULL as wordchars is NOT the same as passing GEANY_WORDCHARS: NULL means
3999 * using Scintillas's word boundaries. */
4000 gchar
*editor_get_default_selection(GeanyEditor
*editor
, gboolean use_current_word
,
4001 const gchar
*wordchars
)
4005 g_return_val_if_fail(editor
!= NULL
, NULL
);
4007 if (sci_get_lines_selected(editor
->sci
) == 1)
4008 s
= sci_get_selection_contents(editor
->sci
);
4009 else if (sci_get_lines_selected(editor
->sci
) == 0 && use_current_word
)
4010 { /* use the word at current cursor position */
4011 gchar word
[GEANY_MAX_WORD_LENGTH
];
4013 if (wordchars
!= NULL
)
4014 editor_find_current_word(editor
, -1, word
, sizeof(word
), wordchars
);
4016 editor_find_current_word_sciwc(editor
, -1, word
, sizeof(word
));
4018 if (word
[0] != '\0')
4025 /* Note: Usually the line should be made visible (not folded) before calling this.
4026 * Returns: TRUE if line is/will be displayed to the user, or FALSE if it is
4027 * outside the *vertical* view.
4028 * Warning: You may need horizontal scrolling to make the cursor visible - so always call
4029 * sci_scroll_caret() when this returns TRUE. */
4030 gboolean
editor_line_in_view(GeanyEditor
*editor
, gint line
)
4034 g_return_val_if_fail(editor
!= NULL
, FALSE
);
4036 /* If line is wrapped the result may occur on another virtual line than the first and may be
4037 * still hidden, so increase the line number to check for the next document line */
4038 if (SSM(editor
->sci
, SCI_WRAPCOUNT
, line
, 0) > 1)
4041 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0); /* convert to visible line number */
4042 vis1
= SSM(editor
->sci
, SCI_GETFIRSTVISIBLELINE
, 0, 0);
4043 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
4045 return (line
>= vis1
&& line
< vis1
+ los
);
4049 /* If the current line is outside the current view window, scroll the line
4050 * so it appears at percent_of_view. */
4051 void editor_display_current_line(GeanyEditor
*editor
, gfloat percent_of_view
)
4055 g_return_if_fail(editor
!= NULL
);
4057 line
= sci_get_current_line(editor
->sci
);
4059 /* unfold maybe folded results */
4060 sci_ensure_line_is_visible(editor
->sci
, line
);
4062 /* scroll the line if it's off screen */
4063 if (! editor_line_in_view(editor
, line
))
4064 editor
->scroll_percent
= percent_of_view
;
4066 sci_scroll_caret(editor
->sci
); /* may need horizontal scrolling */
4071 * Deletes all currently set indicators in the @a editor window.
4072 * Error indicators (red squiggly underlines) and usual line markers are removed.
4074 * @param editor The editor to operate on.
4076 void editor_indicator_clear_errors(GeanyEditor
*editor
)
4078 editor_indicator_clear(editor
, GEANY_INDICATOR_ERROR
);
4079 sci_marker_delete_all(editor
->sci
, 0); /* remove the yellow error line marker */
4084 * Deletes all currently set indicators matching @a indic in the @a editor window.
4086 * @param editor The editor to operate on.
4087 * @param indic The indicator number to clear, this is a value of @ref GeanyIndicator.
4092 void editor_indicator_clear(GeanyEditor
*editor
, gint indic
)
4096 g_return_if_fail(editor
!= NULL
);
4098 last_pos
= sci_get_length(editor
->sci
);
4101 sci_indicator_set(editor
->sci
, indic
);
4102 sci_indicator_clear(editor
->sci
, 0, last_pos
);
4108 * Sets an indicator @a indic on @a line.
4109 * Whitespace at the start and the end of the line is not marked.
4111 * @param editor The editor to operate on.
4112 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4113 * @param line The line number which should be marked.
4118 void editor_indicator_set_on_line(GeanyEditor
*editor
, gint indic
, gint line
)
4124 g_return_if_fail(editor
!= NULL
);
4125 g_return_if_fail(line
>= 0);
4127 start
= sci_get_position_from_line(editor
->sci
, line
);
4128 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
4130 /* skip blank lines */
4131 if ((start
+ 1) == end
||
4133 (sci_get_line_end_position(editor
->sci
, line
) - start
) == 0)
4139 linebuf
= sci_get_line(editor
->sci
, line
);
4141 /* don't set the indicator on whitespace */
4142 while (isspace(linebuf
[i
]))
4144 while (len
> 1 && len
> i
&& isspace(linebuf
[len
- 1]))
4151 editor_indicator_set_on_range(editor
, indic
, start
+ i
, end
);
4156 * Sets an indicator on the range specified by @a start and @a end.
4157 * No error checking or whitespace removal is performed, this should be done by the calling
4158 * function if necessary.
4160 * @param editor The editor to operate on.
4161 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4162 * @param start The starting position for the marker.
4163 * @param end The ending position for the marker.
4168 void editor_indicator_set_on_range(GeanyEditor
*editor
, gint indic
, gint start
, gint end
)
4170 g_return_if_fail(editor
!= NULL
);
4174 sci_indicator_set(editor
->sci
, indic
);
4175 sci_indicator_fill(editor
->sci
, start
, end
- start
);
4179 /* Inserts the given colour (format should be #...), if there is a selection starting with 0x...
4180 * the replacement will also start with 0x... */
4181 void editor_insert_color(GeanyEditor
*editor
, const gchar
*colour
)
4183 g_return_if_fail(editor
!= NULL
);
4185 if (sci_has_selection(editor
->sci
))
4187 gint start
= sci_get_selection_start(editor
->sci
);
4188 const gchar
*replacement
= colour
;
4190 if (sci_get_char_at(editor
->sci
, start
) == '0' &&
4191 sci_get_char_at(editor
->sci
, start
+ 1) == 'x')
4193 gint end
= sci_get_selection_end(editor
->sci
);
4195 sci_set_selection_start(editor
->sci
, start
+ 2);
4196 /* we need to also re-set the selection end in case the anchor was located before
4197 * the cursor, since set_selection_start() always moves the cursor, not the anchor */
4198 sci_set_selection_end(editor
->sci
, end
);
4199 replacement
++; /* skip the leading "0x" */
4201 else if (sci_get_char_at(editor
->sci
, start
- 1) == '#')
4202 { /* double clicking something like #00ffff may only select 00ffff because of wordchars */
4203 replacement
++; /* so skip the '#' to only replace the colour value */
4205 sci_replace_sel(editor
->sci
, replacement
);
4208 sci_add_text(editor
->sci
, colour
);
4213 * Retrieves the end of line characters mode (LF, CR/LF, CR) in the given editor.
4214 * If @a editor is @c NULL, the default end of line characters are used.
4216 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4217 * @return The used end of line characters mode.
4222 gint
editor_get_eol_char_mode(GeanyEditor
*editor
)
4224 gint mode
= file_prefs
.default_eol_character
;
4227 mode
= sci_get_eol_mode(editor
->sci
);
4234 * Retrieves the localized name (for displaying) of the used end of line characters
4235 * (LF, CR/LF, CR) in the given editor.
4236 * If @a editor is @c NULL, the default end of line characters are used.
4238 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4239 * @return The name of the end of line characters.
4244 const gchar
*editor_get_eol_char_name(GeanyEditor
*editor
)
4246 gint mode
= file_prefs
.default_eol_character
;
4249 mode
= sci_get_eol_mode(editor
->sci
);
4251 return utils_get_eol_name(mode
);
4256 * Retrieves the length of the used end of line characters (LF, CR/LF, CR) in the given editor.
4257 * If @a editor is @c NULL, the default end of line characters are used.
4258 * The returned value is 1 for CR and LF and 2 for CR/LF.
4260 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4261 * @return The length of the end of line characters.
4266 gint
editor_get_eol_char_len(GeanyEditor
*editor
)
4268 gint mode
= file_prefs
.default_eol_character
;
4271 mode
= sci_get_eol_mode(editor
->sci
);
4275 case SC_EOL_CRLF
: return 2; break;
4276 default: return 1; break;
4282 * Retrieves the used end of line characters (LF, CR/LF, CR) in the given editor.
4283 * If @a editor is @c NULL, the default end of line characters are used.
4284 * The returned value is either "\n", "\r\n" or "\r".
4286 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4287 * @return The end of line characters.
4292 const gchar
*editor_get_eol_char(GeanyEditor
*editor
)
4294 gint mode
= file_prefs
.default_eol_character
;
4297 mode
= sci_get_eol_mode(editor
->sci
);
4299 return utils_get_eol_char(mode
);
4303 static void fold_all(GeanyEditor
*editor
, gboolean want_fold
)
4305 gint lines
, first
, i
;
4307 if (editor
== NULL
|| ! editor_prefs
.folding
)
4310 lines
= sci_get_line_count(editor
->sci
);
4311 first
= sci_get_first_visible_line(editor
->sci
);
4313 for (i
= 0; i
< lines
; i
++)
4315 gint level
= sci_get_fold_level(editor
->sci
, i
);
4317 if (level
& SC_FOLDLEVELHEADERFLAG
)
4319 if (sci_get_fold_expanded(editor
->sci
, i
) == want_fold
)
4320 sci_toggle_fold(editor
->sci
, i
);
4323 editor_scroll_to_line(editor
, first
, 0.0F
);
4327 void editor_unfold_all(GeanyEditor
*editor
)
4329 fold_all(editor
, FALSE
);
4333 void editor_fold_all(GeanyEditor
*editor
)
4335 fold_all(editor
, TRUE
);
4339 void editor_replace_tabs(GeanyEditor
*editor
, gboolean ignore_selection
)
4341 gint anchor_pos
, caret_pos
;
4342 struct Sci_TextToFind ttf
;
4344 g_return_if_fail(editor
!= NULL
);
4346 sci_start_undo_action(editor
->sci
);
4347 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4349 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4350 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4355 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4357 ttf
.lpstrText
= (gchar
*) "\t";
4359 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4360 caret_pos
= sci_get_current_position(editor
->sci
);
4363 gint search_pos
, pos_in_line
, current_tab_true_length
;
4367 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4368 if (search_pos
== -1)
4371 tab_len
= sci_get_tab_width(editor
->sci
);
4372 pos_in_line
= sci_get_col_from_position(editor
->sci
, search_pos
);
4373 current_tab_true_length
= tab_len
- (pos_in_line
% tab_len
);
4374 tab_str
= g_strnfill(current_tab_true_length
, ' ');
4375 sci_set_target_start(editor
->sci
, search_pos
);
4376 sci_set_target_end(editor
->sci
, search_pos
+ 1);
4377 sci_replace_target(editor
->sci
, tab_str
, FALSE
);
4378 /* next search starts after replacement */
4379 ttf
.chrg
.cpMin
= search_pos
+ current_tab_true_length
- 1;
4380 /* update end of range now text has changed */
4381 ttf
.chrg
.cpMax
+= current_tab_true_length
- 1;
4384 if (anchor_pos
> search_pos
)
4385 anchor_pos
+= current_tab_true_length
- 1;
4386 if (caret_pos
> search_pos
)
4387 caret_pos
+= current_tab_true_length
- 1;
4389 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4390 sci_end_undo_action(editor
->sci
);
4394 /* Replaces all occurrences all spaces of the length of a given tab_width,
4395 * optionally restricting the search to the current selection. */
4396 void editor_replace_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4399 gint anchor_pos
, caret_pos
;
4400 static gdouble tab_len_f
= -1.0; /* keep the last used value */
4403 struct Sci_TextToFind ttf
;
4405 g_return_if_fail(editor
!= NULL
);
4407 if (tab_len_f
< 0.0)
4408 tab_len_f
= sci_get_tab_width(editor
->sci
);
4410 if (! dialogs_show_input_numeric(
4411 _("Enter Tab Width"),
4412 _("Enter the amount of spaces which should be replaced by a tab character."),
4413 &tab_len_f
, 1, 100, 1))
4417 tab_len
= (gint
) tab_len_f
;
4418 text
= g_strnfill(tab_len
, ' ');
4420 sci_start_undo_action(editor
->sci
);
4421 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4423 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4424 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4429 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4431 ttf
.lpstrText
= text
;
4433 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4434 caret_pos
= sci_get_current_position(editor
->sci
);
4437 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4438 if (search_pos
== -1)
4440 /* only replace indentation because otherwise we can mess up alignment */
4441 if (search_pos
> sci_get_line_indent_position(editor
->sci
,
4442 sci_get_line_from_position(editor
->sci
, search_pos
)))
4444 ttf
.chrg
.cpMin
= search_pos
+ tab_len
;
4447 sci_set_target_start(editor
->sci
, search_pos
);
4448 sci_set_target_end(editor
->sci
, search_pos
+ tab_len
);
4449 sci_replace_target(editor
->sci
, "\t", FALSE
);
4450 ttf
.chrg
.cpMin
= search_pos
;
4451 /* update end of range now text has changed */
4452 ttf
.chrg
.cpMax
-= tab_len
- 1;
4454 if (anchor_pos
> search_pos
)
4455 anchor_pos
-= tab_len
- 1;
4456 if (caret_pos
> search_pos
)
4457 caret_pos
-= tab_len
- 1;
4459 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4460 sci_end_undo_action(editor
->sci
);
4465 void editor_strip_line_trailing_spaces(GeanyEditor
*editor
, gint line
)
4467 gint line_start
= sci_get_position_from_line(editor
->sci
, line
);
4468 gint line_end
= sci_get_line_end_position(editor
->sci
, line
);
4469 gint i
= line_end
- 1;
4470 gchar ch
= sci_get_char_at(editor
->sci
, i
);
4472 /* Diff hunks should keep trailing spaces */
4473 if (editor
->document
->file_type
->id
== GEANY_FILETYPES_DIFF
)
4476 while ((i
>= line_start
) && ((ch
== ' ') || (ch
== '\t')))
4479 ch
= sci_get_char_at(editor
->sci
, i
);
4481 if (i
< (line_end
- 1))
4483 sci_set_target_start(editor
->sci
, i
+ 1);
4484 sci_set_target_end(editor
->sci
, line_end
);
4485 sci_replace_target(editor
->sci
, "", FALSE
);
4490 void editor_strip_trailing_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4496 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4498 gint selection_start
= sci_get_selection_start(editor
->sci
);
4499 gint selection_end
= sci_get_selection_end(editor
->sci
);
4501 start_line
= sci_get_line_from_position(editor
->sci
, selection_start
);
4502 end_line
= sci_get_line_from_position(editor
->sci
, selection_end
);
4504 if (sci_get_col_from_position(editor
->sci
, selection_end
) > 0)
4510 end_line
= sci_get_line_count(editor
->sci
);
4513 sci_start_undo_action(editor
->sci
);
4515 for (line
= start_line
; line
< end_line
; line
++)
4517 editor_strip_line_trailing_spaces(editor
, line
);
4519 sci_end_undo_action(editor
->sci
);
4523 void editor_ensure_final_newline(GeanyEditor
*editor
)
4525 gint max_lines
= sci_get_line_count(editor
->sci
);
4526 gboolean append_newline
= (max_lines
== 1);
4527 gint end_document
= sci_get_position_from_line(editor
->sci
, max_lines
);
4531 append_newline
= end_document
> sci_get_position_from_line(editor
->sci
, max_lines
- 1);
4535 const gchar
*eol
= editor_get_eol_char(editor
);
4537 sci_insert_text(editor
->sci
, end_document
, eol
);
4542 /* Similar to editor_set_font() but *only* sets the font, and doesn't take care
4543 * of updating properties that might depend on the font */
4544 static void set_font(ScintillaObject
*sci
, const gchar
*font
)
4548 PangoFontDescription
*pfd
;
4551 g_return_if_fail(sci
);
4553 pfd
= pango_font_description_from_string(font
);
4554 size
= pango_font_description_get_size(pfd
) / (gdouble
) PANGO_SCALE
;
4555 font_name
= g_strdup_printf("!%s", pango_font_description_get_family(pfd
));
4556 pango_font_description_free(pfd
);
4558 for (style
= 0; style
<= STYLE_MAX
; style
++)
4559 sci_set_font_fractional(sci
, style
, font_name
, size
);
4565 void editor_set_font(GeanyEditor
*editor
, const gchar
*font
)
4567 g_return_if_fail(editor
);
4569 set_font(editor
->sci
, font
);
4570 update_margins(editor
->sci
);
4571 /* zoom to 100% to prevent confusion */
4572 sci_zoom_off(editor
->sci
);
4576 void editor_set_line_wrapping(GeanyEditor
*editor
, gboolean wrap
)
4578 g_return_if_fail(editor
!= NULL
);
4580 editor
->line_wrapping
= wrap
;
4581 sci_set_lines_wrapped(editor
->sci
, wrap
);
4585 /** Sets the indent type for @a editor.
4586 * @param editor Editor.
4587 * @param type Indent type.
4592 void editor_set_indent_type(GeanyEditor
*editor
, GeanyIndentType type
)
4594 editor_set_indent(editor
, type
, editor
->indent_width
);
4598 /** Sets the indent width for @a editor.
4599 * @param editor Editor.
4600 * @param width New indent width.
4602 * @since 1.27 (API 227)
4605 void editor_set_indent_width(GeanyEditor
*editor
, gint width
)
4607 editor_set_indent(editor
, editor
->indent_type
, width
);
4611 void editor_set_indent(GeanyEditor
*editor
, GeanyIndentType type
, gint width
)
4613 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
4614 ScintillaObject
*sci
= editor
->sci
;
4615 gboolean use_tabs
= type
!= GEANY_INDENT_TYPE_SPACES
;
4617 editor
->indent_type
= type
;
4618 editor
->indent_width
= width
;
4619 sci_set_use_tabs(sci
, use_tabs
);
4621 if (type
== GEANY_INDENT_TYPE_BOTH
)
4623 sci_set_tab_width(sci
, iprefs
->hard_tab_width
);
4624 if (iprefs
->hard_tab_width
!= 8)
4626 static gboolean warn
= TRUE
;
4628 ui_set_statusbar(TRUE
, _("Warning: non-standard hard tab width: %d != 8!"),
4629 iprefs
->hard_tab_width
);
4634 sci_set_tab_width(sci
, width
);
4636 SSM(sci
, SCI_SETINDENT
, width
, 0);
4638 /* remove indent spaces on backspace, if using any spaces to indent */
4639 SSM(sci
, SCI_SETBACKSPACEUNINDENTS
, type
!= GEANY_INDENT_TYPE_TABS
, 0);
4643 /* Convenience function for editor_goto_pos() to pass a line number.
4644 * line_no is 1 based */
4645 gboolean
editor_goto_line(GeanyEditor
*editor
, gint line_no
, gboolean offset
)
4647 g_return_val_if_fail(editor
, FALSE
);
4648 gint line_count
= sci_get_line_count(editor
->sci
);
4651 line_no
+= sci_get_current_line(editor
->sci
) + 1;
4653 /* ensure line_no is in bounds and determine whether to set line marker */
4654 gboolean set_marker
= line_no
> 0 && line_no
< line_count
;
4655 line_no
= line_no
<= 0 ? 0
4656 : line_no
>= line_count
? line_count
- 1
4659 gint pos
= sci_get_position_from_line(editor
->sci
, line_no
);
4660 return editor_goto_pos(editor
, pos
, set_marker
);
4664 /** Moves to position @a pos, switching to the document if necessary,
4665 * setting a marker if @a mark is set.
4667 * @param editor Editor.
4668 * @param pos The position.
4669 * @param mark Whether to set a mark on the position.
4670 * @return @c TRUE if action has been performed, otherwise @c FALSE.
4675 gboolean
editor_goto_pos(GeanyEditor
*editor
, gint pos
, gboolean mark
)
4677 g_return_val_if_fail(editor
, FALSE
);
4678 if (G_UNLIKELY(pos
< 0))
4683 gint line
= sci_get_line_from_position(editor
->sci
, pos
);
4685 /* mark the tag with the yellow arrow */
4686 sci_marker_delete_all(editor
->sci
, 0);
4687 sci_set_marker_at_line(editor
->sci
, line
, 0);
4690 sci_goto_pos(editor
->sci
, pos
, TRUE
);
4691 editor
->scroll_percent
= 0.25F
;
4693 /* finally switch to the page */
4694 document_show_tab(editor
->document
);
4700 on_editor_scroll_event(GtkWidget
*widget
, GdkEventScroll
*event
, gpointer user_data
)
4702 GeanyEditor
*editor
= user_data
;
4704 /* we only handle up and down, leave the rest to Scintilla */
4705 if (event
->direction
!= GDK_SCROLL_UP
&& event
->direction
!= GDK_SCROLL_DOWN
)
4708 /* Handle scroll events if Alt is pressed and scroll whole pages instead of a
4709 * few lines only, maybe this could/should be done in Scintilla directly */
4710 if (event
->state
& GDK_MOD1_MASK
)
4712 sci_send_command(editor
->sci
, (event
->direction
== GDK_SCROLL_DOWN
) ? SCI_PAGEDOWN
: SCI_PAGEUP
);
4715 else if (event
->state
& GDK_SHIFT_MASK
)
4717 gint amount
= (event
->direction
== GDK_SCROLL_DOWN
) ? 8 : -8;
4719 sci_scroll_columns(editor
->sci
, amount
);
4723 return FALSE
; /* let Scintilla handle all other cases */
4727 static gboolean
editor_check_colourise(GeanyEditor
*editor
)
4729 GeanyDocument
*doc
= editor
->document
;
4731 if (!doc
->priv
->colourise_needed
)
4734 doc
->priv
->colourise_needed
= FALSE
;
4735 sci_colourise(editor
->sci
, 0, -1);
4737 /* now that the current document is colourised, fold points are now accurate,
4738 * so force an update of the current function/tag. */
4739 symbols_get_current_function(NULL
, NULL
);
4740 ui_update_statusbar(NULL
, -1);
4746 /* We only want to colourise just before drawing, to save startup time and
4747 * prevent unnecessary recolouring other documents after one is saved.
4748 * Really we want a "draw" signal but there doesn't seem to be one (expose is too late,
4749 * and "show" doesn't work). */
4750 static gboolean
on_editor_focus_in(GtkWidget
*widget
, GdkEventFocus
*event
, gpointer user_data
)
4752 GeanyEditor
*editor
= user_data
;
4754 editor_check_colourise(editor
);
4759 static gboolean
on_editor_draw(GtkWidget
*widget
, cairo_t
*cr
, gpointer user_data
)
4761 GeanyEditor
*editor
= user_data
;
4763 /* This is just to catch any uncolourised documents being drawn that didn't receive focus
4764 * for some reason, maybe it's not necessary but just in case. */
4765 editor_check_colourise(editor
);
4770 static void setup_sci_keys(ScintillaObject
*sci
)
4772 /* disable some Scintilla keybindings to be able to redefine them cleanly */
4773 sci_clear_cmdkey(sci
, 'A' | (SCMOD_CTRL
<< 16)); /* select all */
4774 sci_clear_cmdkey(sci
, 'D' | (SCMOD_CTRL
<< 16)); /* duplicate */
4775 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16)); /* line transpose */
4776 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line copy */
4777 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16)); /* line cut */
4778 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line delete */
4779 sci_clear_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to end delete */
4780 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to beginning delete */
4781 sci_clear_cmdkey(sci
, '/' | (SCMOD_CTRL
<< 16)); /* Previous word part */
4782 sci_clear_cmdkey(sci
, '\\' | (SCMOD_CTRL
<< 16)); /* Next word part */
4783 sci_clear_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16)); /* scroll line up */
4784 sci_clear_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16)); /* scroll line down */
4785 sci_clear_cmdkey(sci
, SCK_HOME
); /* line start */
4786 sci_clear_cmdkey(sci
, SCK_END
); /* line end */
4787 sci_clear_cmdkey(sci
, SCK_END
| (SCMOD_ALT
<< 16)); /* visual line end */
4789 if (editor_prefs
.use_gtk_word_boundaries
)
4791 /* use GtkEntry-like word boundaries */
4792 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16), SCI_WORDRIGHTEND
);
4793 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_WORDRIGHTENDEXTEND
);
4794 sci_assign_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16), SCI_DELWORDRIGHTEND
);
4796 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_ALT
<< 16), SCI_LINESCROLLUP
);
4797 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_ALT
<< 16), SCI_LINESCROLLDOWN
);
4798 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16), SCI_PARAUP
);
4799 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARAUPEXTEND
);
4800 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16), SCI_PARADOWN
);
4801 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARADOWNEXTEND
);
4803 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_ALT
<< 16)); /* clear Alt-Backspace (Undo) */
4807 /* registers a Scintilla image from a named icon from the theme */
4808 static gboolean
register_named_icon(ScintillaObject
*sci
, guint id
, const gchar
*name
)
4810 GError
*error
= NULL
;
4812 gint n_channels
, rowstride
, width
, height
;
4815 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &size
, NULL
);
4816 pixbuf
= gtk_icon_theme_load_icon(gtk_icon_theme_get_default(), name
, size
, 0, &error
);
4819 g_warning("failed to load icon '%s': %s", name
, error
->message
);
4820 g_error_free(error
);
4824 n_channels
= gdk_pixbuf_get_n_channels(pixbuf
);
4825 rowstride
= gdk_pixbuf_get_rowstride(pixbuf
);
4826 width
= gdk_pixbuf_get_width(pixbuf
);
4827 height
= gdk_pixbuf_get_height(pixbuf
);
4829 if (gdk_pixbuf_get_bits_per_sample(pixbuf
) != 8 ||
4830 ! gdk_pixbuf_get_has_alpha(pixbuf
) ||
4832 rowstride
!= width
* n_channels
)
4834 g_warning("incompatible image data for icon '%s'", name
);
4835 g_object_unref(pixbuf
);
4839 SSM(sci
, SCI_RGBAIMAGESETWIDTH
, width
, 0);
4840 SSM(sci
, SCI_RGBAIMAGESETHEIGHT
, height
, 0);
4841 SSM(sci
, SCI_REGISTERRGBAIMAGE
, id
, (sptr_t
)gdk_pixbuf_get_pixels(pixbuf
));
4843 g_object_unref(pixbuf
);
4848 /* Create new editor widget (scintilla).
4849 * @note The @c "sci-notify" signal is connected separately. */
4850 static ScintillaObject
*create_new_sci(GeanyEditor
*editor
)
4852 ScintillaObject
*sci
;
4853 int rectangular_selection_modifier
;
4855 sci
= SCINTILLA(scintilla_new());
4857 /* Scintilla doesn't support RTL languages properly and is primarily
4858 * intended to be used with LTR source code, so override the
4859 * GTK+ default text direction for the Scintilla widget. */
4860 gtk_widget_set_direction(GTK_WIDGET(sci
), GTK_TEXT_DIR_LTR
);
4862 gtk_widget_show(GTK_WIDGET(sci
));
4864 sci_set_codepage(sci
, SC_CP_UTF8
);
4865 /*SSM(sci, SCI_SETWRAPSTARTINDENT, 4, 0);*/
4866 /* disable scintilla provided popup menu */
4867 sci_use_popup(sci
, FALSE
);
4869 setup_sci_keys(sci
);
4871 sci_set_lines_wrapped(sci
, editor
->line_wrapping
);
4872 sci_set_caret_policy_x(sci
, CARET_JUMPS
| CARET_EVEN
, 0);
4873 /* Y policy is set in editor_apply_update_prefs() */
4874 SSM(sci
, SCI_AUTOCSETSEPARATOR
, '\n', 0);
4875 SSM(sci
, SCI_SETSCROLLWIDTHTRACKING
, 1, 0);
4877 /* tag autocompletion images */
4878 register_named_icon(sci
, 1, "classviewer-var");
4879 register_named_icon(sci
, 2, "classviewer-method");
4881 /* necessary for column mode editing, implemented in Scintilla since 2.0 */
4882 SSM(sci
, SCI_SETADDITIONALSELECTIONTYPING
, 1, 0);
4884 /* rectangular selection modifier for creating rectangular selections with the mouse.
4885 * We use the historical Scintilla values by default. */
4887 rectangular_selection_modifier
= SCMOD_ALT
;
4889 rectangular_selection_modifier
= SCMOD_CTRL
;
4891 SSM(sci
, SCI_SETRECTANGULARSELECTIONMODIFIER
, rectangular_selection_modifier
, 0);
4894 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
4896 /* input method editor's candidate window behaviour */
4897 SSM(sci
, SCI_SETIMEINTERACTION
, editor_prefs
.ime_interaction
, 0);
4899 #ifdef GDK_WINDOWING_QUARTZ
4900 # if ! GTK_CHECK_VERSION(3,16,0)
4901 /* "retina" (HiDPI) display support on OS X - requires disabling buffered draw
4902 * on older GTK versions */
4903 SSM(sci
, SCI_SETBUFFEREDDRAW
, 0, 0);
4907 /* only connect signals if this is for the document notebook, not split window */
4908 if (editor
->sci
== NULL
)
4910 g_signal_connect(sci
, "button-press-event", G_CALLBACK(on_editor_button_press_event
), editor
);
4911 g_signal_connect(sci
, "scroll-event", G_CALLBACK(on_editor_scroll_event
), editor
);
4912 g_signal_connect(sci
, "motion-notify-event", G_CALLBACK(on_motion_event
), NULL
);
4913 g_signal_connect(sci
, "focus-in-event", G_CALLBACK(on_editor_focus_in
), editor
);
4914 g_signal_connect(sci
, "draw", G_CALLBACK(on_editor_draw
), editor
);
4920 /** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
4921 * @param editor Editor settings.
4922 * @return @transfer{floating} The new widget.
4927 ScintillaObject
*editor_create_widget(GeanyEditor
*editor
)
4929 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4930 ScintillaObject
*old
, *sci
;
4931 GeanyIndentType old_indent_type
= editor
->indent_type
;
4932 gint old_indent_width
= editor
->indent_width
;
4934 /* temporarily change editor to use the new sci widget */
4936 sci
= create_new_sci(editor
);
4939 editor_set_indent(editor
, iprefs
->type
, iprefs
->width
);
4940 set_font(editor
->sci
, interface_prefs
.editor_font
);
4941 editor_apply_update_prefs(editor
);
4943 /* if editor already had a widget, restore it */
4946 editor
->indent_type
= old_indent_type
;
4947 editor
->indent_width
= old_indent_width
;
4954 GeanyEditor
*editor_create(GeanyDocument
*doc
)
4956 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4957 GeanyEditor
*editor
= g_new0(GeanyEditor
, 1);
4959 editor
->document
= doc
;
4960 doc
->editor
= editor
; /* needed in case some editor functions/callbacks expect it */
4962 editor
->auto_indent
= (iprefs
->auto_indent_mode
!= GEANY_AUTOINDENT_NONE
);
4963 editor
->line_wrapping
= get_project_pref(line_wrapping
);
4964 editor
->scroll_percent
= -1.0F
;
4965 editor
->line_breaking
= FALSE
;
4967 editor
->sci
= editor_create_widget(editor
);
4972 /* in case we need to free some fields in future */
4973 void editor_destroy(GeanyEditor
*editor
)
4979 static void on_document_save(GObject
*obj
, GeanyDocument
*doc
)
4981 gchar
*f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
4983 if (utils_str_equal(doc
->real_path
, f
))
4985 /* reload snippets */
4986 editor_snippets_free();
4987 editor_snippets_init();
4993 gboolean
editor_complete_word_part(GeanyEditor
*editor
)
4997 g_return_val_if_fail(editor
, FALSE
);
4999 if (!SSM(editor
->sci
, SCI_AUTOCACTIVE
, 0, 0))
5002 entry
= sci_get_string(editor
->sci
, SCI_AUTOCGETCURRENTTEXT
, 0);
5004 /* if no word part, complete normally */
5005 if (!check_partial_completion(editor
, entry
))
5006 SSM(editor
->sci
, SCI_AUTOCCOMPLETE
, 0, 0);
5013 void editor_init(void)
5015 static GeanyIndentPrefs indent_prefs
;
5018 memset(&editor_prefs
, 0, sizeof(GeanyEditorPrefs
));
5019 memset(&indent_prefs
, 0, sizeof(GeanyIndentPrefs
));
5020 editor_prefs
.indentation
= &indent_prefs
;
5022 /* use g_signal_connect_after() to allow plugins connecting to the signal before the default
5023 * handler (on_editor_notify) is called */
5024 g_signal_connect_after(geany_object
, "editor-notify", G_CALLBACK(on_editor_notify
), NULL
);
5026 f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
5027 ui_add_config_file_menu_item(f
, NULL
, NULL
);
5029 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
5033 /* TODO: Should these be user-defined instead of hard-coded? */
5034 void editor_set_indentation_guides(GeanyEditor
*editor
)
5039 g_return_if_fail(editor
!= NULL
);
5041 if (! editor_prefs
.show_indent_guide
)
5043 sci_set_indentation_guides(editor
->sci
, SC_IV_NONE
);
5047 lexer
= sci_get_lexer(editor
->sci
);
5050 /* Lines added/removed are prefixed with +/- characters, so
5051 * those lines will not be shown with any indentation guides.
5052 * It can be distracting that only a few of lines in a diff/patch
5053 * file will show the guides. */
5058 /* These languages use indentation for control blocks; the "look forward" method works
5062 case SCLEX_MAKEFILE
:
5066 case SCLEX_PROPERTIES
:
5067 case SCLEX_FORTRAN
: /* Is this the best option for Fortran? */
5069 mode
= SC_IV_LOOKFORWARD
;
5072 /* C-like (structured) languages benefit from the "look both" method */
5075 case SCLEX_PHPSCRIPT
:
5087 case SCLEX_FREEBASIC
:
5091 mode
= SC_IV_LOOKBOTH
;
5099 sci_set_indentation_guides(editor
->sci
, mode
);
5103 /* Apply non-document prefs that can change in the Preferences dialog */
5104 void editor_apply_update_prefs(GeanyEditor
*editor
)
5106 ScintillaObject
*sci
;
5109 g_return_if_fail(editor
!= NULL
);
5111 if (main_status
.quitting
)
5116 sci_set_mark_long_lines(sci
, editor_get_long_line_type(),
5117 editor_get_long_line_column(), editor_prefs
.long_line_color
);
5119 /* update indent width, tab width */
5120 editor_set_indent(editor
, editor
->indent_type
, editor
->indent_width
);
5121 sci_set_tab_indents(sci
, editor_prefs
.use_tab_to_indent
);
5123 sci_assign_cmdkey(sci
, SCK_HOME
| (SCMOD_SHIFT
<< 16),
5124 editor_prefs
.smart_home_key
? SCI_VCHOMEEXTEND
: SCI_HOMEEXTEND
);
5125 sci_assign_cmdkey(sci
, SCK_HOME
| ((SCMOD_SHIFT
| SCMOD_ALT
) << 16),
5126 editor_prefs
.smart_home_key
? SCI_VCHOMERECTEXTEND
: SCI_HOMERECTEXTEND
);
5128 sci_set_autoc_max_height(sci
, editor_prefs
.symbolcompletion_max_height
);
5129 SSM(sci
, SCI_AUTOCSETDROPRESTOFWORD
, editor_prefs
.completion_drops_rest_of_word
, 0);
5131 editor_set_indentation_guides(editor
);
5133 sci_set_visible_white_spaces(sci
, editor_prefs
.show_white_space
);
5134 sci_set_visible_eols(sci
, editor_prefs
.show_line_endings
);
5135 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
5136 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
5138 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
5141 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
5143 /* caret Y policy */
5144 caret_y_policy
= CARET_EVEN
;
5145 if (editor_prefs
.scroll_lines_around_cursor
> 0)
5146 caret_y_policy
|= CARET_SLOP
| CARET_STRICT
;
5147 sci_set_caret_policy_y(sci
, caret_y_policy
, editor_prefs
.scroll_lines_around_cursor
);
5149 /* (dis)allow scrolling past end of document */
5150 sci_set_scroll_stop_at_last_line(sci
, editor_prefs
.scroll_stop_at_last_line
);
5152 sci_set_scrollbar_mode(sci
, editor_prefs
.show_scrollbars
);
5156 /* This is for tab-indents, space aligns formatted code. Spaces should be preserved. */
5157 static void change_tab_indentation(GeanyEditor
*editor
, gint line
, gboolean increase
)
5159 ScintillaObject
*sci
= editor
->sci
;
5160 gint pos
= sci_get_position_from_line(sci
, line
);
5164 sci_insert_text(sci
, pos
, "\t");
5168 if (sci_get_char_at(sci
, pos
) == '\t')
5170 sci_set_selection(sci
, pos
, pos
+ 1);
5171 sci_replace_sel(sci
, "");
5173 else /* remove spaces only if no tabs */
5175 gint width
= sci_get_line_indentation(sci
, line
);
5177 width
-= editor_get_indent_prefs(editor
)->width
;
5178 sci_set_line_indentation(sci
, line
, width
);
5184 static void editor_change_line_indent(GeanyEditor
*editor
, gint line
, gboolean increase
)
5186 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
5187 ScintillaObject
*sci
= editor
->sci
;
5189 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
)
5190 change_tab_indentation(editor
, line
, increase
);
5193 gint width
= sci_get_line_indentation(sci
, line
);
5195 width
+= increase
? iprefs
->width
: -iprefs
->width
;
5196 sci_set_line_indentation(sci
, line
, width
);
5201 void editor_indent(GeanyEditor
*editor
, gboolean increase
)
5203 ScintillaObject
*sci
= editor
->sci
;
5204 gint caret_pos
, caret_line
, caret_offset
, caret_indent_pos
, caret_line_len
;
5205 gint anchor_pos
, anchor_line
, anchor_offset
, anchor_indent_pos
, anchor_line_len
;
5207 /* backup information needed to restore caret and anchor */
5208 caret_pos
= sci_get_current_position(sci
);
5209 anchor_pos
= SSM(sci
, SCI_GETANCHOR
, 0, 0);
5210 caret_line
= sci_get_line_from_position(sci
, caret_pos
);
5211 anchor_line
= sci_get_line_from_position(sci
, anchor_pos
);
5212 caret_offset
= caret_pos
- sci_get_position_from_line(sci
, caret_line
);
5213 anchor_offset
= anchor_pos
- sci_get_position_from_line(sci
, anchor_line
);
5214 caret_indent_pos
= sci_get_line_indent_position(sci
, caret_line
);
5215 anchor_indent_pos
= sci_get_line_indent_position(sci
, anchor_line
);
5216 caret_line_len
= sci_get_line_length(sci
, caret_line
);
5217 anchor_line_len
= sci_get_line_length(sci
, anchor_line
);
5219 if (sci_get_lines_selected(sci
) <= 1)
5221 editor_change_line_indent(editor
, sci_get_current_line(sci
), increase
);
5226 gint line
, lstart
, lend
;
5228 editor_select_lines(editor
, FALSE
);
5229 start
= sci_get_selection_start(sci
);
5230 end
= sci_get_selection_end(sci
);
5231 lstart
= sci_get_line_from_position(sci
, start
);
5232 lend
= sci_get_line_from_position(sci
, end
);
5233 if (end
== sci_get_length(sci
))
5234 lend
++; /* for last line with text on it */
5236 sci_start_undo_action(sci
);
5237 for (line
= lstart
; line
< lend
; line
++)
5239 editor_change_line_indent(editor
, line
, increase
);
5241 sci_end_undo_action(sci
);
5244 /* restore caret and anchor position */
5245 if (caret_pos
>= caret_indent_pos
)
5246 caret_offset
+= sci_get_line_length(sci
, caret_line
) - caret_line_len
;
5247 if (anchor_pos
>= anchor_indent_pos
)
5248 anchor_offset
+= sci_get_line_length(sci
, anchor_line
) - anchor_line_len
;
5250 SSM(sci
, SCI_SETCURRENTPOS
, sci_get_position_from_line(sci
, caret_line
) + caret_offset
, 0);
5251 SSM(sci
, SCI_SETANCHOR
, sci_get_position_from_line(sci
, anchor_line
) + anchor_offset
, 0);
5255 /** Gets snippet by name.
5257 * If @a editor is passed, returns a snippet specific to the document filetype.
5258 * If @a editor is @c NULL, returns a snippet from the default set.
5260 * @param editor @nullable Editor or @c NULL.
5261 * @param snippet_name Snippet name.
5262 * @return @nullable snippet or @c NULL if it was not found. Must not be freed.
5265 const gchar
*editor_find_snippet(GeanyEditor
*editor
, const gchar
*snippet_name
)
5267 const gchar
*subhash_name
= editor
? editor
->document
->file_type
->name
: "Default";
5268 GHashTable
*subhash
= g_hash_table_lookup(snippet_hash
, subhash_name
);
5270 return subhash
? g_hash_table_lookup(subhash
, snippet_name
) : NULL
;
5274 /** Replaces all special sequences in @a snippet and inserts it at @a pos.
5275 * If you insert at the current position, consider calling @c sci_scroll_caret()
5276 * after this function.
5282 void editor_insert_snippet(GeanyEditor
*editor
, gint pos
, const gchar
*snippet
)
5286 pattern
= g_string_new(snippet
);
5287 snippets_make_replacements(editor
, pattern
);
5288 editor_insert_text_block(editor
, pattern
->str
, pos
, -1, -1, TRUE
);
5289 g_string_free(pattern
, TRUE
);
5292 static void *copy_(void *src
) { return src
; }
5293 static void free_(void *doc
) { }
5296 * Gets the GType of GeanyEditor
5298 * @return the GeanyEditor type */
5300 GType
editor_get_type (void);
5302 G_DEFINE_BOXED_TYPE(GeanyEditor
, editor
, copy_
, free_
);