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_at_pointer(GTK_MENU(main_widgets
.editor_menu
), (GdkEvent
*) event
);
356 static gboolean
is_style_php(gint style
)
358 if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
359 style
== SCE_HPHP_COMPLEX_VARIABLE
)
368 static gint
editor_get_long_line_type(void)
371 switch (app
->project
->priv
->long_line_behaviour
)
373 case 0: /* marker disabled */
375 case 1: /* use global settings */
377 case 2: /* custom (enabled) */
378 return editor_prefs
.long_line_type
;
381 if (!editor_prefs
.long_line_enabled
)
384 return editor_prefs
.long_line_type
;
388 static gint
editor_get_long_line_column(void)
390 if (app
->project
&& app
->project
->priv
->long_line_behaviour
!= 1 /* use global settings */)
391 return app
->project
->priv
->long_line_column
;
393 return editor_prefs
.long_line_column
;
397 #define get_project_pref(id)\
398 (app->project ? app->project->priv->id : editor_prefs.id)
400 static const GeanyEditorPrefs
*
401 get_default_prefs(void)
403 static GeanyEditorPrefs eprefs
;
405 eprefs
= editor_prefs
;
407 /* project overrides */
408 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(NULL
);
409 eprefs
.long_line_type
= editor_get_long_line_type();
410 eprefs
.long_line_column
= editor_get_long_line_column();
411 eprefs
.line_wrapping
= get_project_pref(line_wrapping
);
412 eprefs
.line_break_column
= get_project_pref(line_break_column
);
413 eprefs
.auto_continue_multiline
= get_project_pref(auto_continue_multiline
);
418 /* Gets the prefs for the editor.
419 * Prefs can be different according to project or document.
420 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
421 * settings may have changed, or if this function has been called for a different editor.
422 * @param editor The editor, or @c NULL to get the default prefs.
423 * @return The prefs. */
424 const GeanyEditorPrefs
*editor_get_prefs(GeanyEditor
*editor
)
426 static GeanyEditorPrefs eprefs
;
427 const GeanyEditorPrefs
*dprefs
= get_default_prefs();
429 /* Return the address of the default prefs to allow returning default and editor
430 * pref pointers without invalidating the contents of either. */
435 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(editor
);
436 /* add other editor & document overrides as needed */
441 void editor_toggle_fold(GeanyEditor
*editor
, gint line
, gint modifiers
)
443 ScintillaObject
*sci
;
446 g_return_if_fail(editor
!= NULL
);
449 /* When collapsing a fold range whose starting line is offscreen,
450 * scroll the starting line to display at the top of the view.
451 * Otherwise it can be confusing when the document scrolls down to hide
452 * the folded lines. */
453 if ((sci_get_fold_level(sci
, line
) & SC_FOLDLEVELNUMBERMASK
) > SC_FOLDLEVELBASE
&&
454 !(sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
))
456 gint parent
= sci_get_fold_parent(sci
, line
);
457 gint first
= sci_get_first_visible_line(sci
);
459 parent
= SSM(sci
, SCI_VISIBLEFROMDOCLINE
, parent
, 0);
461 SSM(sci
, SCI_SETFIRSTVISIBLELINE
, parent
, 0);
464 /* find the fold header of the given line in case the one clicked isn't a fold point */
465 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
468 header
= sci_get_fold_parent(sci
, line
);
470 if ((editor_prefs
.unfold_all_children
&& ! (modifiers
& SCMOD_SHIFT
)) ||
471 (! editor_prefs
.unfold_all_children
&& (modifiers
& SCMOD_SHIFT
)))
473 SSM(sci
, SCI_FOLDCHILDREN
, header
, SC_FOLDACTION_TOGGLE
);
477 SSM(sci
, SCI_FOLDLINE
, header
, SC_FOLDACTION_TOGGLE
);
482 static void on_margin_click(GeanyEditor
*editor
, SCNotification
*nt
)
484 /* left click to marker margin marks the line */
487 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
489 /*sci_marker_delete_all(editor->sci, 1);*/
490 sci_toggle_marker_at_line(editor
->sci
, line
, 1); /* toggle the marker */
492 /* left click on the folding margin to toggle folding state of current line */
493 else if (nt
->margin
== 2 && editor_prefs
.folding
)
495 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
496 editor_toggle_fold(editor
, line
, nt
->modifiers
);
501 static void on_update_ui(GeanyEditor
*editor
, G_GNUC_UNUSED SCNotification
*nt
)
503 ScintillaObject
*sci
= editor
->sci
;
504 gint pos
= sci_get_current_position(sci
);
506 /* since Scintilla 2.24, SCN_UPDATEUI is also sent on scrolling though we don't need to handle
507 * this and so ignore every SCN_UPDATEUI events except for content and selection changes */
508 if (! (nt
->updated
& SC_UPDATE_CONTENT
) && ! (nt
->updated
& SC_UPDATE_SELECTION
))
511 /* undo / redo menu update */
512 ui_update_popup_reundo_items(editor
->document
);
514 /* brace highlighting */
515 editor_highlight_braces(editor
, pos
);
517 ui_update_statusbar(editor
->document
, pos
);
520 /** experimental code for inverting selections */
523 for (i
= SSM(sci
, SCI_GETSELECTIONSTART
, 0, 0); i
< SSM(sci
, SCI_GETSELECTIONEND
, 0, 0); i
++)
525 /* need to get colour from getstyleat(), but how? */
526 SSM(sci
, SCI_STYLESETFORE
, STYLE_DEFAULT
, 0);
527 SSM(sci
, SCI_STYLESETBACK
, STYLE_DEFAULT
, 0);
530 sci_get_style_at(sci
, pos
);
536 static void check_line_breaking(GeanyEditor
*editor
, gint pos
)
538 ScintillaObject
*sci
= editor
->sci
;
539 gint line
, lstart
, col
;
542 if (!editor
->line_breaking
|| sci_get_selection_mode(editor
->sci
) != SC_SEL_STREAM
)
545 col
= sci_get_col_from_position(sci
, pos
);
547 line
= sci_get_current_line(sci
);
549 lstart
= sci_get_position_from_line(sci
, line
);
551 /* use column instead of position which might be different with multibyte characters */
552 if (col
< get_project_pref(line_break_column
))
555 /* look for the last space before line_break_column */
556 pos
= sci_get_position_from_col(sci
, line
, get_project_pref(line_break_column
));
560 c
= sci_get_char_at(sci
, --pos
);
563 gint diff
, last_pos
, last_col
;
565 /* remember the distance between the current column and the last column on the line
566 * (we use column position in case the previous line gets altered, such as removing
567 * trailing spaces or in case it contains multibyte characters) */
568 last_pos
= sci_get_line_end_position(sci
, line
);
569 last_col
= sci_get_col_from_position(sci
, last_pos
);
570 diff
= last_col
- col
;
572 /* break the line after the space */
573 sci_set_current_position(sci
, pos
+ 1, FALSE
);
574 sci_cancel(sci
); /* don't select from completion list */
575 sci_send_command(sci
, SCI_NEWLINE
);
578 /* correct cursor position (might not be at line end) */
579 last_pos
= sci_get_line_end_position(sci
, line
);
580 last_col
= sci_get_col_from_position(sci
, last_pos
); /* get last column on line */
581 /* last column - distance is the desired column, then retrieve its document position */
582 pos
= sci_get_position_from_col(sci
, line
, last_col
- diff
);
583 sci_set_current_position(sci
, pos
, FALSE
);
584 sci_scroll_caret(sci
);
591 static void show_autocomplete(ScintillaObject
*sci
, gsize rootlen
, GString
*words
)
593 /* hide autocompletion if only option is already typed */
594 if (rootlen
>= words
->len
||
595 (words
->str
[rootlen
] == '?' && rootlen
>= words
->len
- 2))
597 sci_send_command(sci
, SCI_AUTOCCANCEL
);
600 /* store whether a calltip is showing, so we can reshow it after autocompletion */
601 calltip
.set
= (gboolean
) SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0);
602 SSM(sci
, SCI_AUTOCSETORDER
, SC_ORDER_CUSTOM
, 0);
603 SSM(sci
, SCI_AUTOCSHOW
, rootlen
, (sptr_t
) words
->str
);
607 static void show_tags_list(GeanyEditor
*editor
, const GPtrArray
*tags
, gsize rootlen
)
609 ScintillaObject
*sci
= editor
->sci
;
611 g_return_if_fail(tags
);
615 GString
*words
= g_string_sized_new(150);
618 for (j
= 0; j
< tags
->len
; ++j
)
620 TMTag
*tag
= tags
->pdata
[j
];
625 g_string_append_c(words
, '\n');
627 if (j
== editor_prefs
.autocompletion_max_entries
)
629 g_string_append(words
, "...");
632 g_string_append(words
, tag
->name
);
634 group
= tm_parser_get_sidebar_group(tag
->lang
, tag
->type
);
635 if (group
>= 0 && tm_parser_get_sidebar_info(tag
->lang
, group
, &icon_id
))
638 sprintf(buf
, "?%u", icon_id
+ 1);
639 g_string_append(words
, buf
);
642 show_autocomplete(sci
, rootlen
, words
);
643 g_string_free(words
, TRUE
);
648 static gint
scope_autocomplete_suffix(ScintillaObject
*sci
, TMParserType lang
,
649 gint pos
, gboolean
*scope_sep
)
651 const gchar
*sep
= tm_parser_scope_separator(lang
);
652 const gsize max_len
= 3;
653 gboolean is_scope_sep
;
656 buf
= g_alloca(max_len
+ 1);
657 sci_get_text_range(sci
, pos
- max_len
, pos
, buf
);
659 is_scope_sep
= g_str_has_suffix(buf
, sep
);
661 *scope_sep
= is_scope_sep
;
664 return tm_parser_scope_autocomplete_suffix(lang
, buf
);
668 static gboolean
reshow_calltip(gpointer data
)
672 g_return_val_if_fail(calltip
.sci
!= NULL
, FALSE
);
674 SSM(calltip
.sci
, SCI_CALLTIPCANCEL
, 0, 0);
675 doc
= document_get_current();
677 if (doc
&& doc
->editor
->sci
== calltip
.sci
)
679 /* we use the position where the calltip was previously started as SCI_GETCURRENTPOS
680 * may be completely wrong in case the user cancelled the auto completion with the mouse */
681 SSM(calltip
.sci
, SCI_CALLTIPSHOW
, calltip
.pos
, (sptr_t
) calltip
.text
);
687 static void request_reshowing_calltip(SCNotification
*nt
)
691 /* delay the reshow of the calltip window to make sure it is actually displayed,
692 * without it might be not visible on SCN_AUTOCCANCEL. the priority is set to
693 * low to hopefully make Scintilla's events happen before reshowing since they
694 * seem to re-cancel the calltip on autoc menu hiding too */
695 g_idle_add_full(G_PRIORITY_LOW
, reshow_calltip
, NULL
, NULL
);
700 static gboolean
autocomplete_scope(GeanyEditor
*editor
, const gchar
*root
, gsize rootlen
)
702 ScintillaObject
*sci
= editor
->sci
;
703 gint pos
= sci_get_current_position(editor
->sci
);
704 gint line
= sci_get_current_line(editor
->sci
) + 1;
707 GeanyFiletype
*ft
= editor
->document
->file_type
;
709 gboolean function
= FALSE
;
711 gboolean scope_sep_typed
= FALSE
;
712 gboolean ret
= FALSE
;
713 const gchar
*current_scope
;
714 gint autocomplete_suffix_len
;
716 if (autocomplete_scope_shown
)
718 /* move at the operator position */
721 /* allow for a space between word and operator */
722 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
726 autocomplete_suffix_len
= scope_autocomplete_suffix(sci
, ft
->lang
, pos
,
728 if (autocomplete_suffix_len
== 0)
731 pos
-= autocomplete_suffix_len
;
733 /* allow for a space between word and operator */
734 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
737 /* if function or array index, skip to matching brace */
738 brace_char
= sci_get_char_at(sci
, pos
- 1);
739 if (pos
> 0 && (brace_char
== ')' || brace_char
== ']'))
741 gint brace_pos
= sci_find_matching_brace(sci
, pos
- 1);
746 function
= brace_char
== ')';
749 /* allow for a space between opening brace and name */
750 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
754 name
= editor_get_word_at_pos(editor
, pos
, NULL
);
758 /* check if invoked on member */
760 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
762 member
= scope_autocomplete_suffix(sci
, ft
->lang
, pos
, NULL
) > 0;
764 if (symbols_get_current_scope(editor
->document
, ¤t_scope
) == -1)
766 tags
= tm_workspace_find_scope_members(editor
->document
->tm_file
, name
, function
,
767 member
, current_scope
, line
, scope_sep_typed
);
770 GPtrArray
*filtered
= g_ptr_array_new();
774 foreach_ptr_array(tag
, i
, tags
)
776 if (g_str_has_prefix(tag
->name
, root
))
777 g_ptr_array_add(filtered
, tag
);
780 if (filtered
->len
> 0)
782 show_tags_list(editor
, filtered
, rootlen
);
786 g_ptr_array_free(tags
, TRUE
);
787 g_ptr_array_free(filtered
, TRUE
);
795 static void on_char_added(GeanyEditor
*editor
, SCNotification
*nt
)
797 ScintillaObject
*sci
= editor
->sci
;
798 gint pos
= sci_get_current_position(sci
);
803 { /* simple indentation (only for CR format) */
804 if (sci_get_eol_mode(sci
) == SC_EOL_CR
)
805 on_new_line_added(editor
);
809 { /* simple indentation (for CR/LF and LF format) */
810 on_new_line_added(editor
);
814 editor_start_auto_complete(editor
, pos
, FALSE
); /* C/C++ ptr-> scope completion */
817 { /* close xml-tags */
818 handle_xml(editor
, pos
, nt
->ch
);
823 auto_close_chars(sci
, pos
, nt
->ch
);
825 editor_show_calltip(editor
, --pos
);
829 { /* hide calltips */
830 if (SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0))
832 SSM(sci
, SCI_CALLTIPCANCEL
, 0, 0);
834 g_free(calltip
.text
);
846 auto_close_chars(sci
, pos
, nt
->ch
);
850 { /* closing bracket handling */
851 if (editor
->auto_indent
)
852 close_block(editor
, pos
- 1);
855 /* scope autocompletion */
857 case ':': /* C/C++ class:: syntax */
858 /* tag autocompletion */
861 if (! editor_start_auto_complete(editor
, pos
, FALSE
))
862 request_reshowing_calltip(nt
);
864 editor_start_auto_complete(editor
, pos
, FALSE
);
867 check_line_breaking(editor
, pos
);
871 /* expand() and fold_changed() are copied from SciTE (thanks) to fix #1923350. */
872 static void expand(ScintillaObject
*sci
, gint
*line
, gboolean doExpand
,
873 gboolean force
, gint visLevels
, gint level
)
875 gint lineMaxSubord
= SSM(sci
, SCI_GETLASTCHILD
, *line
, level
& SC_FOLDLEVELNUMBERMASK
);
876 gint levelLine
= level
;
878 while (*line
<= lineMaxSubord
)
883 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
885 SSM(sci
, SCI_HIDELINES
, *line
, *line
);
890 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
893 levelLine
= SSM(sci
, SCI_GETFOLDLEVEL
, *line
, 0);
894 if (levelLine
& SC_FOLDLEVELHEADERFLAG
)
899 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
901 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 0);
902 expand(sci
, line
, doExpand
, force
, visLevels
- 1, -1);
908 if (!sci_get_fold_expanded(sci
, *line
))
909 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
910 expand(sci
, line
, TRUE
, force
, visLevels
- 1, -1);
914 expand(sci
, line
, FALSE
, force
, visLevels
- 1, -1);
926 static void fold_changed(ScintillaObject
*sci
, gint line
, gint levelNow
, gint levelPrev
)
928 if (levelNow
& SC_FOLDLEVELHEADERFLAG
)
930 if (! (levelPrev
& SC_FOLDLEVELHEADERFLAG
))
932 /* Adding a fold point */
933 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
934 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
935 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
938 else if (levelPrev
& SC_FOLDLEVELHEADERFLAG
)
940 if (! sci_get_fold_expanded(sci
, line
))
941 { /* Removing the fold from one that has been contracted so should expand
942 * otherwise lines are left invisible with no way to make them visible */
943 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
944 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
945 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
948 if (! (levelNow
& SC_FOLDLEVELWHITEFLAG
) &&
949 ((levelPrev
& SC_FOLDLEVELNUMBERMASK
) > (levelNow
& SC_FOLDLEVELNUMBERMASK
)))
951 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0)) {
952 /* See if should still be hidden */
953 gint parentLine
= sci_get_fold_parent(sci
, line
);
956 SSM(sci
, SCI_SHOWLINES
, line
, line
);
958 else if (sci_get_fold_expanded(sci
, parentLine
) &&
959 sci_get_line_is_visible(sci
, parentLine
))
961 SSM(sci
, SCI_SHOWLINES
, line
, line
);
968 static void ensure_range_visible(ScintillaObject
*sci
, gint posStart
, gint posEnd
,
969 gboolean enforcePolicy
)
971 gint lineStart
= sci_get_line_from_position(sci
, MIN(posStart
, posEnd
));
972 gint lineEnd
= sci_get_line_from_position(sci
, MAX(posStart
, posEnd
));
975 for (line
= lineStart
; line
<= lineEnd
; line
++)
977 SSM(sci
, enforcePolicy
? SCI_ENSUREVISIBLEENFORCEPOLICY
: SCI_ENSUREVISIBLE
, line
, 0);
982 static void auto_update_margin_width(GeanyEditor
*editor
)
984 gint next_linecount
= 1;
985 gint linecount
= sci_get_line_count(editor
->sci
);
986 GeanyDocument
*doc
= editor
->document
;
988 while (next_linecount
<= linecount
)
989 next_linecount
*= 10;
991 if (editor
->document
->priv
->line_count
!= next_linecount
)
993 doc
->priv
->line_count
= next_linecount
;
994 sci_set_line_numbers(editor
->sci
, TRUE
);
999 static void partial_complete(ScintillaObject
*sci
, const gchar
*text
)
1001 gint pos
= sci_get_current_position(sci
);
1003 sci_insert_text(sci
, pos
, text
);
1004 sci_set_current_position(sci
, pos
+ strlen(text
), TRUE
);
1008 /* Complete the next word part from @a entry */
1009 static gboolean
check_partial_completion(GeanyEditor
*editor
, const gchar
*entry
)
1011 gchar
*stem
, *ptr
, *text
= utils_strdupa(entry
);
1013 read_current_word(editor
, -1, current_word
, sizeof current_word
, NULL
, TRUE
);
1014 stem
= current_word
;
1015 if (strstr(text
, stem
) != text
)
1016 return FALSE
; /* shouldn't happen */
1017 if (strlen(text
) <= strlen(stem
))
1020 text
+= strlen(stem
); /* skip stem */
1021 ptr
= strstr(text
+ 1, "_");
1025 partial_complete(editor
->sci
, text
);
1031 foreach_str(ptr
, text
+ 1)
1035 if (g_ascii_isupper(*ptr
) && g_ascii_islower(ptr
[1]))
1038 partial_complete(editor
->sci
, text
);
1047 /* Callback for the "sci-notify" signal to emit a "editor-notify" signal.
1048 * Plugins can connect to the "editor-notify" signal. */
1049 void editor_sci_notify_cb(G_GNUC_UNUSED GtkWidget
*widget
, G_GNUC_UNUSED gint scn
,
1050 gpointer scnt
, gpointer data
)
1052 GeanyEditor
*editor
= data
;
1055 g_return_if_fail(editor
!= NULL
);
1057 g_signal_emit_by_name(geany_object
, "editor-notify", editor
, scnt
, &retval
);
1061 /* recalculate margins width */
1062 static void update_margins(ScintillaObject
*sci
)
1064 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
1065 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
1066 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
1070 static gboolean
on_editor_notify(G_GNUC_UNUSED GObject
*object
, GeanyEditor
*editor
,
1071 SCNotification
*nt
, G_GNUC_UNUSED gpointer data
)
1073 ScintillaObject
*sci
= editor
->sci
;
1074 GeanyDocument
*doc
= editor
->document
;
1076 switch (nt
->nmhdr
.code
)
1078 case SCN_SAVEPOINTLEFT
:
1079 document_set_text_changed(doc
, TRUE
);
1082 case SCN_SAVEPOINTREACHED
:
1083 document_set_text_changed(doc
, FALSE
);
1086 case SCN_MODIFYATTEMPTRO
:
1090 case SCN_MARGINCLICK
:
1091 on_margin_click(editor
, nt
);
1095 on_update_ui(editor
, nt
);
1099 /* Visible lines are only laid out accurately just before painting,
1100 * so we need to only call editor_scroll_to_line here, because the document
1101 * may have line wrapping and folding enabled.
1102 * https://scintilla.sourceforge.io/ScintillaDoc.html#LineWrapping
1103 * This is important e.g. when loading a session and switching pages
1104 * and having the cursor scroll in view. */
1105 /* FIXME: Really we want to do this just before painting, not after it
1106 * as it will cause repainting. */
1107 if (editor
->scroll_percent
> 0.0F
)
1109 editor_scroll_to_line(editor
, -1, editor
->scroll_percent
);
1110 /* disable further scrolling */
1111 editor
->scroll_percent
= -1.0F
;
1116 if (editor_prefs
.show_linenumber_margin
&& (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
)) && nt
->linesAdded
)
1118 /* automatically adjust Scintilla's line numbers margin width */
1119 auto_update_margin_width(editor
);
1121 if (nt
->modificationType
& SC_STARTACTION
&& ! ignore_callback
)
1123 /* get notified about undo changes */
1124 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
1126 if (editor_prefs
.folding
&& (nt
->modificationType
& SC_MOD_CHANGEFOLD
) != 0)
1128 /* handle special fold cases, e.g. #1923350 */
1129 fold_changed(sci
, nt
->line
, nt
->foldLevelNow
, nt
->foldLevelPrev
);
1131 if (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
))
1133 document_update_tag_list_in_idle(doc
);
1138 on_char_added(editor
, nt
);
1141 case SCN_USERLISTSELECTION
:
1142 if (nt
->listType
== 1)
1144 sci_add_text(sci
, nt
->text
);
1148 case SCN_AUTOCSELECTION
:
1149 if (g_str_equal(nt
->text
, "..."))
1156 case SCN_AUTOCCANCELLED
:
1157 /* now that autocomplete is finishing or was cancelled, reshow calltips
1158 * if they were showing */
1159 autocomplete_scope_shown
= FALSE
;
1160 request_reshowing_calltip(nt
);
1163 ensure_range_visible(sci
, nt
->position
, nt
->position
+ nt
->length
, FALSE
);
1166 case SCN_URIDROPPED
:
1167 if (nt
->text
!= NULL
)
1169 document_open_file_list(nt
->text
, strlen(nt
->text
));
1173 case SCN_CALLTIPCLICK
:
1174 if (nt
->position
> 0)
1176 switch (nt
->position
)
1178 case 1: /* up arrow */
1179 if (calltip
.tag_index
> 0)
1180 calltip
.tag_index
--;
1183 case 2: calltip
.tag_index
++; break; /* down arrow */
1185 editor_show_calltip(editor
, -1);
1190 update_margins(sci
);
1193 /* we always return FALSE here to let plugins handle the event too */
1198 /* Note: this is the same as sci_get_tab_width(), but is still useful when you don't have
1199 * a scintilla pointer. */
1200 static gint
get_tab_width(const GeanyIndentPrefs
*indent_prefs
)
1202 if (indent_prefs
->type
== GEANY_INDENT_TYPE_BOTH
)
1203 return indent_prefs
->hard_tab_width
;
1205 return indent_prefs
->width
; /* tab width = indent width */
1209 /* Returns a string containing width chars of whitespace, filled with simple space
1210 * characters or with the right number of tab characters, according to the indent prefs.
1211 * (Result is filled with tabs *and* spaces if width isn't a multiple of
1212 * the tab width). */
1214 get_whitespace(const GeanyIndentPrefs
*iprefs
, gint width
)
1216 g_return_val_if_fail(width
>= 0, NULL
);
1219 return g_strdup("");
1221 if (iprefs
->type
== GEANY_INDENT_TYPE_SPACES
)
1223 return g_strnfill(width
, ' ');
1226 { /* first fill text with tabs and fill the rest with spaces */
1227 const gint tab_width
= get_tab_width(iprefs
);
1228 gint tabs
= width
/ tab_width
;
1229 gint spaces
= width
% tab_width
;
1230 gint len
= tabs
+ spaces
;
1233 str
= g_malloc(len
+ 1);
1235 memset(str
, '\t', tabs
);
1236 memset(str
+ tabs
, ' ', spaces
);
1243 static const GeanyIndentPrefs
*
1244 get_default_indent_prefs(void)
1246 static GeanyIndentPrefs iprefs
;
1248 iprefs
= app
->project
? *app
->project
->priv
->indentation
: *editor_prefs
.indentation
;
1253 /** Gets the indentation prefs for the editor.
1254 * Prefs can be different according to project or document.
1255 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
1256 * settings may have changed, or if this function has been called for a different editor.
1257 * @param editor @nullable The editor, or @c NULL to get the default indent prefs.
1258 * @return The indent prefs. */
1260 const GeanyIndentPrefs
*
1261 editor_get_indent_prefs(GeanyEditor
*editor
)
1263 static GeanyIndentPrefs iprefs
;
1264 const GeanyIndentPrefs
*dprefs
= get_default_indent_prefs();
1266 /* Return the address of the default prefs to allow returning default and editor
1267 * pref pointers without invalidating the contents of either. */
1272 iprefs
.type
= editor
->indent_type
;
1273 iprefs
.width
= editor
->indent_width
;
1275 /* if per-document auto-indent is enabled, but we don't have a global mode set,
1276 * just use basic auto-indenting */
1277 if (editor
->auto_indent
&& iprefs
.auto_indent_mode
== GEANY_AUTOINDENT_NONE
)
1278 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_BASIC
;
1280 if (!editor
->auto_indent
)
1281 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_NONE
;
1287 static void on_new_line_added(GeanyEditor
*editor
)
1289 ScintillaObject
*sci
= editor
->sci
;
1290 gint line
= sci_get_current_line(sci
);
1292 /* simple indentation */
1293 if (editor
->auto_indent
)
1295 insert_indent_after_line(editor
, line
- 1);
1298 if (get_project_pref(auto_continue_multiline
))
1299 { /* " * " auto completion in multiline C/C++/D/Java comments */
1300 auto_multiline(editor
, line
);
1303 if (editor_prefs
.newline_strip
)
1304 { /* strip the trailing spaces on the previous line */
1305 editor_strip_line_trailing_spaces(editor
, line
- 1);
1310 static gboolean
lexer_has_braces(ScintillaObject
*sci
)
1312 gint lexer
= sci_get_lexer(sci
);
1318 case SCLEX_HTML
: /* for PHP & JS */
1319 case SCLEX_PHPSCRIPT
:
1320 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 GPtrArray
*get_constructor_tags(GeanyFiletype
*ft
, TMTag
*tag
,
1844 const gchar
*constructor_method
)
1846 if (constructor_method
&& (tag
->type
== tm_tag_class_t
|| tag
->type
== tm_tag_struct_t
))
1848 const TMTagType arg_types
= tm_tag_function_t
| tm_tag_prototype_t
|
1849 tm_tag_method_t
| tm_tag_macro_with_arg_t
;
1850 const gchar
*scope_sep
= tm_parser_scope_separator(ft
->lang
);
1851 gchar
*scope
= EMPTY(tag
->scope
) ? g_strdup(tag
->name
) :
1852 g_strjoin(scope_sep
, tag
->scope
, tag
->name
, NULL
);
1853 GPtrArray
*constructor_tags
;
1855 constructor_tags
= tm_workspace_find(constructor_method
, scope
, arg_types
, NULL
, ft
->lang
);
1857 if (constructor_tags
->len
!= 0)
1858 { /* found constructor tag, so use it instead of the class tag */
1859 return constructor_tags
;
1863 g_ptr_array_free(constructor_tags
, TRUE
);
1870 static void update_tag_name_and_scope_for_calltip(const gchar
*word
, TMTag
*tag
,
1871 const gchar
*constructor_method
,
1872 const gchar
**tag_name
, const gchar
**scope
)
1874 if (tag_name
== NULL
|| scope
== NULL
)
1877 /* Remove scope and replace name with the current calltip word if the current tag
1878 * is the constructor method of the current calltip word, e.g. for Python:
1879 * "SomeClass.__init__ (self, arg1, ...)" will be changed to "SomeClass (self, arg1, ...)" */
1880 if (constructor_method
&&
1881 utils_str_equal(constructor_method
, tag
->name
) &&
1882 !utils_str_equal(word
, tag
->name
))
1890 static gchar
*find_calltip(const gchar
*word
, GeanyFiletype
*ft
)
1892 const gchar
*constructor_method
;
1895 GString
*str
= NULL
;
1898 g_return_val_if_fail(ft
&& word
&& *word
, NULL
);
1900 /* use all types in case language uses wrong tag type e.g. python "members" instead of "methods" */
1901 tags
= tm_workspace_find(word
, NULL
, tm_tag_max_t
, NULL
, ft
->lang
);
1904 g_ptr_array_free(tags
, TRUE
);
1908 tag
= TM_TAG(tags
->pdata
[0]);
1910 /* user typed e.g. 'a = Classname(' in Python so lookup __init__() arguments */
1911 constructor_method
= tm_parser_get_constructor_method(tag
->lang
);
1912 if (constructor_method
)
1914 GPtrArray
*constructor_tags
= get_constructor_tags(ft
, tag
, constructor_method
);
1915 if (constructor_tags
)
1917 g_ptr_array_free(tags
, TRUE
);
1918 tags
= constructor_tags
;
1922 /* remove tags with no argument list */
1923 for (i
= 0; i
< tags
->len
; i
++)
1925 tag
= TM_TAG(tags
->pdata
[i
]);
1928 tags
->pdata
[i
] = NULL
;
1930 tm_tags_prune((GPtrArray
*) tags
);
1933 g_ptr_array_free(tags
, TRUE
);
1937 { /* remove duplicate calltips */
1938 TMTagAttrType sort_attr
[] = {tm_tag_attr_name_t
, tm_tag_attr_scope_t
,
1939 tm_tag_attr_arglist_t
, 0};
1941 tm_tags_sort((GPtrArray
*) tags
, sort_attr
, TRUE
, FALSE
);
1944 /* if the current word has changed since last time, start with the first tag match */
1945 if (! utils_str_equal(word
, calltip
.last_word
))
1946 calltip
.tag_index
= 0;
1947 /* cache the current word for next time */
1948 g_free(calltip
.last_word
);
1949 calltip
.last_word
= g_strdup(word
);
1950 calltip
.tag_index
= MIN(calltip
.tag_index
, tags
->len
- 1); /* ensure tag_index is in range */
1952 for (i
= calltip
.tag_index
; i
< tags
->len
; i
++)
1954 tag
= TM_TAG(tags
->pdata
[i
]);
1958 const gchar
*tag_name
= tag
->name
;
1959 const gchar
*scope
= tag
->scope
;
1962 update_tag_name_and_scope_for_calltip(word
, tag
, constructor_method
, &tag_name
, &scope
);
1963 f
= tm_parser_format_function(tag
->lang
, tag_name
, tag
->arglist
, tag
->var_type
, scope
);
1964 str
= g_string_new(NULL
);
1965 if (calltip
.tag_index
> 0)
1966 g_string_prepend(str
, "\001 "); /* up arrow */
1967 g_string_append(str
, f
);
1970 else /* add a down arrow */
1972 if (calltip
.tag_index
> 0) /* already have an up arrow */
1973 g_string_insert_c(str
, 1, '\002');
1975 g_string_prepend(str
, "\002 ");
1980 g_ptr_array_free(tags
, TRUE
);
1984 gchar
*result
= str
->str
;
1986 g_string_free(str
, FALSE
);
1993 /* use pos = -1 to search for the previous unmatched open bracket. */
1994 gboolean
editor_show_calltip(GeanyEditor
*editor
, gint pos
)
1996 gint orig_pos
= pos
; /* the position for the calltip */
1999 gchar word
[GEANY_MAX_WORD_LENGTH
];
2001 ScintillaObject
*sci
;
2003 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2004 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, FALSE
);
2008 lexer
= sci_get_lexer(sci
);
2012 /* position of '(' is unknown, so go backwards from current position to find it */
2013 pos
= sci_get_current_position(sci
);
2016 pos
= (lexer
== SCLEX_LATEX
) ? find_previous_brace(sci
, pos
) :
2017 find_start_bracket(sci
, pos
);
2022 /* the style 1 before the brace (which may be highlighted) */
2023 style
= sci_get_style_at(sci
, pos
- 1);
2024 if (! highlighting_is_code_style(lexer
, style
))
2027 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
2030 /* skip possible generic/template specification, like foo<int>() */
2031 if (sci_get_char_at(sci
, pos
- 1) == '>')
2033 pos
= sci_find_matching_brace(sci
, pos
- 1);
2037 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
2042 editor_find_current_word(editor
, pos
- 1, word
, sizeof word
, NULL
);
2043 if (word
[0] == '\0')
2046 str
= find_calltip(word
, editor
->document
->file_type
);
2049 g_free(calltip
.text
); /* free the old calltip */
2051 calltip
.pos
= orig_pos
;
2054 utils_wrap_string(calltip
.text
, -1);
2055 SSM(sci
, SCI_CALLTIPSHOW
, orig_pos
, (sptr_t
) calltip
.text
);
2062 /* Current document & global tags autocompletion */
2064 autocomplete_tags(GeanyEditor
*editor
, GeanyFiletype
*ft
, const gchar
*root
, gsize rootlen
)
2066 GeanyDocument
*doc
= editor
->document
;
2067 const gchar
*current_scope
= NULL
;
2072 g_return_val_if_fail(editor
&& doc
, FALSE
);
2074 symbols_get_current_function(doc
, ¤t_scope
);
2075 current_line
= sci_get_current_line(editor
->sci
) + 1;
2077 tags
= tm_workspace_find_prefix(root
, doc
->tm_file
, current_line
, current_scope
,
2078 editor_prefs
.autocompletion_max_entries
);
2079 found
= tags
->len
> 0;
2081 show_tags_list(editor
, tags
, rootlen
);
2082 g_ptr_array_free(tags
, TRUE
);
2088 static gboolean
autocomplete_check_html(GeanyEditor
*editor
, gint style
, gint pos
)
2090 GeanyFiletype
*ft
= editor
->document
->file_type
;
2091 gboolean
try = FALSE
;
2093 /* use entity completion when style is not JavaScript, ASP, Python, PHP, ...
2094 * (everything after SCE_HJ_START is for embedded scripting languages) */
2095 if (ft
->id
== GEANY_FILETYPES_HTML
&& style
< SCE_HJ_START
)
2097 else if (sci_get_lexer(editor
->sci
) == SCLEX_XML
&& style
< SCE_HJ_START
)
2099 else if (ft
->id
== GEANY_FILETYPES_PHP
)
2101 /* use entity completion when style is outside of PHP styles */
2102 if (! is_style_php(style
))
2107 gchar root
[GEANY_MAX_WORD_LENGTH
];
2110 read_current_word(editor
, pos
, root
, sizeof(root
), GEANY_WORDCHARS
"&", TRUE
);
2112 /* Allow something like ""some text"".
2113 * for entity completion we want to have completion for '&' within words. */
2114 tmp
= strchr(root
, '&');
2117 return autocomplete_tags(editor
, filetypes_index(GEANY_FILETYPES_HTML
), tmp
, strlen(tmp
));
2124 /* Algorithm based on based on Scite's StartAutoCompleteWord()
2125 * @returns a sorted list of words matching @p root */
2126 static GSList
*get_doc_words(ScintillaObject
*sci
, gchar
*root
, gsize rootlen
)
2129 gint len
, current
, word_end
;
2130 gint pos_find
, flags
;
2133 GSList
*words
= NULL
;
2134 struct Sci_TextToFind ttf
;
2136 len
= sci_get_length(sci
);
2137 current
= sci_get_current_position(sci
) - rootlen
;
2139 ttf
.lpstrText
= root
;
2141 ttf
.chrg
.cpMax
= len
;
2142 ttf
.chrgText
.cpMin
= 0;
2143 ttf
.chrgText
.cpMax
= 0;
2144 flags
= SCFIND_WORDSTART
| SCFIND_MATCHCASE
;
2146 /* search the whole document for the word root and collect results */
2147 pos_find
= SSM(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2148 while (pos_find
>= 0 && pos_find
< len
)
2150 word_end
= pos_find
+ rootlen
;
2151 if (pos_find
!= current
)
2153 word_end
= sci_word_end_position(sci
, word_end
, TRUE
);
2155 word_length
= word_end
- pos_find
;
2156 if (word_length
> rootlen
)
2158 word
= sci_get_contents_range(sci
, pos_find
, word_end
);
2159 /* search whether we already have the word in, otherwise add it */
2160 if (g_slist_find_custom(words
, word
, (GCompareFunc
)strcmp
) != NULL
)
2164 words
= g_slist_prepend(words
, word
);
2168 if (nmatches
== editor_prefs
.autocompletion_max_entries
)
2172 ttf
.chrg
.cpMin
= word_end
;
2173 pos_find
= SSM(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2176 return g_slist_sort(words
, (GCompareFunc
)utils_str_casecmp
);
2180 static gboolean
autocomplete_doc_word(GeanyEditor
*editor
, gchar
*root
, gsize rootlen
)
2182 ScintillaObject
*sci
= editor
->sci
;
2183 GSList
*words
, *node
;
2187 words
= get_doc_words(sci
, root
, rootlen
);
2190 SSM(sci
, SCI_AUTOCCANCEL
, 0, 0);
2194 str
= g_string_sized_new(rootlen
* 2 * 10);
2195 foreach_slist(node
, words
)
2197 g_string_append(str
, node
->data
);
2200 g_string_append_c(str
, '\n');
2203 if (n_words
>= editor_prefs
.autocompletion_max_entries
)
2204 g_string_append(str
, "\n...");
2206 g_slist_free(words
);
2208 show_autocomplete(sci
, rootlen
, str
);
2209 g_string_free(str
, TRUE
);
2214 gboolean
editor_start_auto_complete(GeanyEditor
*editor
, gint pos
, gboolean force
)
2216 gint rootlen
, lexer
, style
;
2218 gchar cword
[GEANY_MAX_WORD_LENGTH
];
2219 ScintillaObject
*sci
;
2220 gboolean ret
= FALSE
;
2221 const gchar
*wordchars
;
2224 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2226 if (! editor_prefs
.auto_complete_symbols
&& ! force
)
2229 /* If we are at the beginning of the document, we skip autocompletion as we can't determine the
2230 * necessary styling information */
2231 if (G_UNLIKELY(pos
< 2))
2235 ft
= editor
->document
->file_type
;
2237 lexer
= sci_get_lexer(sci
);
2238 style
= sci_get_style_at(sci
, pos
- 2);
2240 /* don't autocomplete in comments and strings */
2241 if (!force
&& !highlighting_is_code_style(lexer
, style
))
2244 ret
= autocomplete_check_html(editor
, style
, pos
);
2246 if (ft
->id
== GEANY_FILETYPES_LATEX
)
2247 wordchars
= GEANY_WORDCHARS
"\\"; /* add \ to word chars if we are in a LaTeX file */
2248 else if (ft
->id
== GEANY_FILETYPES_CSS
)
2249 wordchars
= GEANY_WORDCHARS
"-"; /* add - because they are part of property names */
2251 wordchars
= GEANY_WORDCHARS
;
2253 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, TRUE
);
2255 rootlen
= strlen(root
);
2259 if (autocomplete_scope_shown
)
2261 autocomplete_scope_shown
= FALSE
;
2263 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2268 ret
= autocomplete_scope(editor
, root
, rootlen
);
2269 if (!ret
&& autocomplete_scope_shown
)
2270 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2271 autocomplete_scope_shown
= ret
;
2274 if (!ret
&& rootlen
> 0)
2276 if (ft
->id
== GEANY_FILETYPES_PHP
&& style
== SCE_HPHP_DEFAULT
&&
2277 rootlen
== 3 && strcmp(root
, "php") == 0 && pos
>= 5 &&
2278 sci_get_char_at(sci
, pos
- 5) == '<' &&
2279 sci_get_char_at(sci
, pos
- 4) == '?')
2281 /* nothing, don't complete PHP open tags */
2285 /* force is set when called by keyboard shortcut, otherwise start at the
2286 * editor_prefs.symbolcompletion_min_chars'th char */
2287 if (force
|| rootlen
>= editor_prefs
.symbolcompletion_min_chars
)
2289 /* complete tags, except if forcing when completion is already visible */
2290 if (!(force
&& SSM(sci
, SCI_AUTOCACTIVE
, 0, 0)))
2291 ret
= autocomplete_tags(editor
, editor
->document
->file_type
, root
, rootlen
);
2293 /* If forcing and there's nothing else to show, complete from words in document */
2294 if (!ret
&& (force
|| editor_prefs
.autocomplete_doc_words
))
2295 ret
= autocomplete_doc_word(editor
, root
, rootlen
);
2306 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
)
2308 gchar
*result
= NULL
;
2311 g_return_val_if_fail(type
!= NULL
&& name
!= NULL
, NULL
);
2313 tmp
= g_hash_table_lookup(snippet_hash
, type
);
2316 result
= g_hash_table_lookup(tmp
, name
);
2318 /* whether nothing is set for the current filetype(tmp is NULL) or
2319 * the particular completion for this filetype is not set (result is NULL) */
2320 if (tmp
== NULL
|| result
== NULL
)
2322 tmp
= g_hash_table_lookup(snippet_hash
, "Default");
2325 result
= g_hash_table_lookup(tmp
, name
);
2328 /* if result is still NULL here, no completion could be found */
2330 /* result is owned by the hash table and will be freed when the table will destroyed */
2335 static void snippets_replace_specials(gpointer key
, gpointer value
, gpointer user_data
)
2338 GString
*pattern
= user_data
;
2340 g_return_if_fail(key
!= NULL
);
2341 g_return_if_fail(value
!= NULL
);
2343 needle
= g_strconcat("%", (gchar
*) key
, "%", NULL
);
2345 utils_string_replace_all(pattern
, needle
, (gchar
*) value
);
2350 static void fix_indentation(GeanyEditor
*editor
, GString
*buf
)
2352 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
2355 gint cflags
= G_REGEX_MULTILINE
;
2357 /* transform leading tabs into indent widths (in spaces) */
2358 whitespace
= g_strnfill(iprefs
->width
, ' ');
2359 regex
= g_regex_new("^ *(\t)", cflags
, 0, NULL
);
2360 while (utils_string_regex_replace_all(buf
, regex
, 1, whitespace
, TRUE
));
2361 g_regex_unref(regex
);
2363 /* remaining tabs are for alignment */
2364 if (iprefs
->type
!= GEANY_INDENT_TYPE_TABS
)
2365 utils_string_replace_all(buf
, "\t", whitespace
);
2367 /* use leading tabs */
2368 if (iprefs
->type
!= GEANY_INDENT_TYPE_SPACES
)
2372 /* for tabs+spaces mode we want the real tab width, not indent width */
2373 SETPTR(whitespace
, g_strnfill(sci_get_tab_width(editor
->sci
), ' '));
2374 str
= g_strdup_printf("^\t*(%s)", whitespace
);
2376 regex
= g_regex_new(str
, cflags
, 0, NULL
);
2377 while (utils_string_regex_replace_all(buf
, regex
, 1, "\t", TRUE
));
2378 g_regex_unref(regex
);
2387 Sci_Position start
, len
;
2391 #define CURSOR_PLACEHOLDER "_" /* Would rather use … but not all docs are unicode */
2394 /* Replaces the internal cursor markers with the placeholder suitable for
2395 * display. Except for the first cursor if indicator_for_first is FALSE,
2396 * which is simply deleted.
2398 * Returns insertion points as SelectionRange list, so that the caller
2399 * can use the positions (currently for indicators). */
2400 static GSList
*replace_cursor_markers(GeanyEditor
*editor
, GString
*template,
2401 gboolean indicator_for_first
)
2404 GSList
*temp_list
= NULL
;
2405 gint cursor_steps
= 0;
2406 SelectionRange
*sel
;
2410 cursor_steps
= utils_string_find(template, cursor_steps
, -1, geany_cursor_marker
);
2411 if (cursor_steps
== -1)
2414 sel
= g_new0(SelectionRange
, 1);
2415 sel
->start
= cursor_steps
;
2416 g_string_erase(template, cursor_steps
, strlen(geany_cursor_marker
));
2417 if (i
> 0 || indicator_for_first
)
2419 g_string_insert(template, cursor_steps
, CURSOR_PLACEHOLDER
);
2420 sel
->len
= sizeof(CURSOR_PLACEHOLDER
) - 1;
2423 temp_list
= g_slist_append(temp_list
, sel
);
2430 /** Inserts text, replacing \\t tab chars (@c 0x9) and \\n newline chars (@c 0xA)
2431 * accordingly for the document.
2432 * - Leading tabs are replaced with the correct indentation.
2433 * - Non-leading tabs are replaced with spaces (except when using 'Tabs' indent type).
2434 * - Newline chars are replaced with the correct line ending string.
2435 * This is very useful for inserting code without having to handle the indent
2436 * type yourself (Tabs & Spaces mode can be tricky).
2437 * @param editor Editor.
2438 * @param text Intended as e.g. @c "if (foo)\n\tbar();".
2439 * @param insert_pos Document position to insert text at.
2440 * @param cursor_index If >= 0, the index into @a text to place the cursor.
2441 * @param newline_indent_size Indentation size (in spaces) to insert for each newline; use
2442 * -1 to read the indent size from the line with @a insert_pos on it.
2443 * @param replace_newlines Whether to replace newlines. If
2444 * newlines have been replaced already, this should be false, to avoid errors e.g. on Windows.
2445 * @warning Make sure all \\t tab chars in @a text are intended as indent widths or alignment,
2446 * not hard tabs, as those won't be preserved.
2447 * @note This doesn't scroll the cursor in view afterwards. **/
2449 void editor_insert_text_block(GeanyEditor
*editor
, const gchar
*text
, gint insert_pos
,
2450 gint cursor_index
, gint newline_indent_size
, gboolean replace_newlines
)
2452 ScintillaObject
*sci
= editor
->sci
;
2453 gint line_start
= sci_get_line_from_position(sci
, insert_pos
);
2455 const gchar
*eol
= editor_get_eol_char(editor
);
2456 GSList
*jump_locs
, *item
;
2458 g_return_if_fail(text
);
2459 g_return_if_fail(editor
!= NULL
);
2460 g_return_if_fail(insert_pos
>= 0);
2462 buf
= g_string_new(text
);
2464 if (cursor_index
>= 0)
2465 g_string_insert(buf
, cursor_index
, geany_cursor_marker
); /* remember cursor pos */
2467 if (newline_indent_size
== -1)
2469 /* count indent size up to insert_pos instead of asking sci
2470 * because there may be spaces after it */
2471 gchar
*tmp
= sci_get_line(sci
, line_start
);
2474 idx
= insert_pos
- sci_get_position_from_line(sci
, line_start
);
2476 newline_indent_size
= count_indent_size(editor
, tmp
);
2480 /* Add line indents (in spaces) */
2481 if (newline_indent_size
> 0)
2483 const gchar
*nl
= replace_newlines
? "\n" : eol
;
2486 whitespace
= g_strnfill(newline_indent_size
, ' ');
2487 SETPTR(whitespace
, g_strconcat(nl
, whitespace
, NULL
));
2488 utils_string_replace_all(buf
, nl
, whitespace
);
2492 /* transform line endings */
2493 if (replace_newlines
)
2494 utils_string_replace_all(buf
, "\n", eol
);
2496 fix_indentation(editor
, buf
);
2498 jump_locs
= replace_cursor_markers(editor
, buf
, cursor_index
< 0);
2499 sci_insert_text(sci
, insert_pos
, buf
->str
);
2501 foreach_list(item
, jump_locs
)
2503 SelectionRange
*sel
= item
->data
;
2504 gint start
= insert_pos
+ sel
->start
;
2505 gint end
= start
+ sel
->len
;
2506 editor_indicator_set_on_range(editor
, GEANY_INDICATOR_SNIPPET
, start
, end
);
2507 /* jump to first cursor position initially */
2508 if (item
== jump_locs
)
2509 sci_set_selection(sci
, start
, end
);
2512 /* Set cursor to the requested index, or by default to after the snippet */
2513 if (cursor_index
>= 0)
2514 sci_set_current_position(sci
, insert_pos
+ cursor_index
, FALSE
);
2515 else if (jump_locs
== NULL
)
2516 sci_set_current_position(sci
, insert_pos
+ buf
->len
, FALSE
);
2518 g_slist_free_full(jump_locs
, g_free
);
2519 g_string_free(buf
, TRUE
);
2523 static gboolean
find_next_snippet_indicator(GeanyEditor
*editor
, SelectionRange
*sel
)
2525 ScintillaObject
*sci
= editor
->sci
;
2526 gint pos
= sci_get_current_position(sci
);
2528 if (pos
== sci_get_length(sci
))
2529 return FALSE
; /* EOF */
2531 /* Rewind the cursor a bit if we're in the middle (or start) of an indicator,
2532 * and treat that as the next indicator. */
2533 while (SSM(sci
, SCI_INDICATORVALUEAT
, GEANY_INDICATOR_SNIPPET
, pos
) && pos
> 0)
2536 /* Be careful at the beginning of the file */
2537 if (SSM(sci
, SCI_INDICATORVALUEAT
, GEANY_INDICATOR_SNIPPET
, pos
))
2540 sel
->start
= SSM(sci
, SCI_INDICATOREND
, GEANY_INDICATOR_SNIPPET
, pos
);
2541 sel
->len
= SSM(sci
, SCI_INDICATOREND
, GEANY_INDICATOR_SNIPPET
, sel
->start
) - sel
->start
;
2543 /* 0 if there is no remaining cursor */
2544 return sel
->len
> 0;
2548 /* Move the cursor to the next specified cursor position in an inserted snippet.
2549 * Can, and should, be optimized to give better results */
2550 gboolean
editor_goto_next_snippet_cursor(GeanyEditor
*editor
)
2552 ScintillaObject
*sci
= editor
->sci
;
2555 if (find_next_snippet_indicator(editor
, &sel
))
2557 sci_indicator_set(sci
, GEANY_INDICATOR_SNIPPET
);
2558 sci_set_selection(sci
, sel
.start
, sel
.start
+ sel
.len
);
2568 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
)
2570 GHashTable
*specials
;
2572 /* replace 'special' completions */
2573 specials
= g_hash_table_lookup(snippet_hash
, "Special");
2574 if (G_LIKELY(specials
!= NULL
))
2576 g_hash_table_foreach(specials
, snippets_replace_specials
, pattern
);
2579 /* now transform other wildcards */
2580 utils_string_replace_all(pattern
, "%newline%", "\n");
2581 utils_string_replace_all(pattern
, "%ws%", "\t");
2583 /* replace %cursor% by a very unlikely string marker */
2584 utils_string_replace_all(pattern
, "%cursor%", geany_cursor_marker
);
2586 /* unescape '%' after all %wildcards% */
2587 templates_replace_valist(pattern
, "{pc}", "%", NULL
);
2589 /* replace any template {foo} wildcards */
2590 templates_replace_common(pattern
, editor
->document
->file_name
, editor
->document
->file_type
, NULL
);
2594 static gboolean
snippets_complete_constructs(GeanyEditor
*editor
, gint pos
, const gchar
*word
)
2596 ScintillaObject
*sci
= editor
->sci
;
2598 const gchar
*completion
;
2600 gint ft_id
= editor
->document
->file_type
->id
;
2602 str
= g_strdup(word
);
2605 completion
= snippets_find_completion_by_name(filetypes
[ft_id
]->name
, str
);
2606 if (completion
== NULL
)
2612 /* remove the typed word, it will be added again by the used auto completion
2613 * (not really necessary but this makes the auto completion more flexible,
2614 * e.g. with a completion like hi=hello, so typing "hi<TAB>" will result in "hello") */
2615 str_len
= strlen(str
);
2616 sci_set_selection_start(sci
, pos
- str_len
);
2617 sci_set_selection_end(sci
, pos
);
2618 sci_replace_sel(sci
, "");
2619 pos
-= str_len
; /* pos has changed while deleting */
2621 editor_insert_snippet(editor
, pos
, completion
);
2622 sci_scroll_caret(sci
);
2629 static gboolean
at_eol(ScintillaObject
*sci
, gint pos
)
2631 gint line
= sci_get_line_from_position(sci
, pos
);
2634 /* skip any trailing spaces */
2637 c
= sci_get_char_at(sci
, pos
);
2638 if (c
== ' ' || c
== '\t')
2644 return (pos
== sci_get_line_end_position(sci
, line
));
2648 gboolean
editor_complete_snippet(GeanyEditor
*editor
, gint pos
)
2650 gboolean result
= FALSE
;
2653 ScintillaObject
*sci
;
2655 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2658 if (sci_has_selection(sci
))
2660 /* return if we are editing an existing line (chars on right of cursor) */
2661 if (keybindings_lookup_item(GEANY_KEY_GROUP_EDITOR
,
2662 GEANY_KEYS_EDITOR_COMPLETESNIPPET
)->key
== GDK_KEY_space
&&
2663 ! editor_prefs
.complete_snippets_whilst_editing
&& ! at_eol(sci
, pos
))
2666 wc
= snippets_find_completion_by_name("Special", "wordchars");
2667 word
= editor_read_word_stem(editor
, pos
, wc
);
2669 /* prevent completion of "for " */
2671 ! isspace(sci_get_char_at(sci
, pos
- 1))) /* pos points to the line end char so use pos -1 */
2673 sci_start_undo_action(sci
); /* needed because we insert a space separately from construct */
2674 result
= snippets_complete_constructs(editor
, pos
, word
);
2675 sci_end_undo_action(sci
);
2677 sci_cancel(sci
); /* cancel any autocompletion list, etc */
2683 static void insert_closing_tag(GeanyEditor
*editor
, gint pos
, gchar ch
, const gchar
*tag_name
)
2685 ScintillaObject
*sci
= editor
->sci
;
2686 gchar
*to_insert
= NULL
;
2690 const gchar
*gt
= ">";
2691 /* if there is already a '>' behind the cursor, don't add it */
2692 if (sci_get_char_at(sci
, pos
) == '>')
2695 to_insert
= g_strconcat(tag_name
, gt
, NULL
);
2698 to_insert
= g_strconcat("</", tag_name
, ">", NULL
);
2700 sci_start_undo_action(sci
);
2701 sci_replace_sel(sci
, to_insert
);
2703 sci_set_selection(sci
, pos
, pos
);
2704 sci_end_undo_action(sci
);
2710 * (stolen from anjuta and heavily modified)
2711 * This routine will auto complete XML or HTML tags that are still open by closing them
2712 * @param ch The character we are dealing with, currently only works with the '>' character
2713 * @return True if handled, false otherwise
2715 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
)
2717 ScintillaObject
*sci
= editor
->sci
;
2718 gint lexer
= sci_get_lexer(sci
);
2719 gint min
, size
, style
;
2720 gchar
*str_found
, sel
[512];
2721 gboolean result
= FALSE
;
2723 /* If the user has turned us off, quit now.
2724 * This may make sense only in certain languages */
2725 if (! editor_prefs
.auto_close_xml_tags
|| (lexer
!= SCLEX_HTML
&& lexer
!= SCLEX_XML
))
2728 /* return if we are inside any embedded script */
2729 style
= sci_get_style_at(sci
, pos
);
2730 if (style
> SCE_H_XCCOMMENT
&& ! highlighting_is_string_style(lexer
, style
))
2733 /* if ch is /, check for </, else quit */
2734 if (ch
== '/' && sci_get_char_at(sci
, pos
- 2) != '<')
2737 /* Grab the last 512 characters or so */
2738 min
= pos
- (sizeof(sel
) - 1);
2739 if (min
< 0) min
= 0;
2742 return FALSE
; /* Smallest tag is 3 characters e.g. <p> */
2744 sci_get_text_range(sci
, min
, pos
, sel
);
2745 sel
[sizeof(sel
) - 1] = '\0';
2747 if (ch
== '>' && sel
[pos
- min
- 2] == '/')
2748 /* User typed something like "<br/>" */
2753 size
-= 2; /* skip </ */
2754 str_found
= utils_find_open_xml_tag(sel
, size
);
2756 if (lexer
== SCLEX_HTML
&& utils_is_short_html_tag(str_found
))
2760 else if (!EMPTY(str_found
))
2762 insert_closing_tag(editor
, pos
, ch
, str_found
);
2770 /* like sci_get_line_indentation(), but for a string. */
2771 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
)
2774 gsize tab_size
= sci_get_tab_width(editor
->sci
);
2777 g_return_val_if_fail(base_indent
, 0);
2779 for (ptr
= base_indent
; *ptr
!= 0; ptr
++)
2797 /* Handles special cases where HTML is embedded in another language or
2798 * another language is embedded in HTML */
2799 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
)
2801 gint style
, line_start
;
2802 GeanyFiletype
*current_ft
;
2804 g_return_val_if_fail(editor
!= NULL
, NULL
);
2805 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, NULL
);
2807 current_ft
= editor
->document
->file_type
;
2808 line_start
= sci_get_position_from_line(editor
->sci
, line
);
2809 style
= sci_get_style_at(editor
->sci
, line_start
);
2811 /* Handle PHP filetype with embedded HTML */
2812 if (current_ft
->id
== GEANY_FILETYPES_PHP
&& ! is_style_php(style
))
2813 current_ft
= filetypes
[GEANY_FILETYPES_HTML
];
2815 /* Handle languages embedded in HTML */
2816 if (current_ft
->id
== GEANY_FILETYPES_HTML
)
2819 if (style
>= SCE_HJ_DEFAULT
&& style
<= SCE_HJ_REGEX
)
2820 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2822 else if (style
>= SCE_HJA_DEFAULT
&& style
<= SCE_HJA_REGEX
)
2823 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2825 else if (style
>= SCE_HB_DEFAULT
&& style
<= SCE_HB_STRINGEOL
)
2826 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2828 else if (style
>= SCE_HBA_DEFAULT
&& style
<= SCE_HBA_STRINGEOL
)
2829 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2830 /* Embedded Python */
2831 else if (style
>= SCE_HP_DEFAULT
&& style
<= SCE_HP_IDENTIFIER
)
2832 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2834 else if (style
>= SCE_HPA_DEFAULT
&& style
<= SCE_HPA_IDENTIFIER
)
2835 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2837 else if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
2838 style
== SCE_HPHP_COMPLEX_VARIABLE
)
2840 current_ft
= filetypes
[GEANY_FILETYPES_PHP
];
2844 /* Ensure the filetype's config is loaded */
2845 filetypes_load_config(current_ft
->id
, FALSE
);
2851 static void real_comment_multiline(GeanyEditor
*editor
, gint line_start
, gint last_line
)
2854 gchar
*str_begin
, *str_end
;
2855 const gchar
*co
, *cc
;
2859 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
2861 ft
= editor_get_filetype_at_line(editor
, line_start
);
2863 eol
= editor_get_eol_char(editor
);
2864 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2865 g_return_if_reached();
2866 str_begin
= g_strdup_printf("%s%s", (co
!= NULL
) ? co
: "", eol
);
2867 str_end
= g_strdup_printf("%s%s", (cc
!= NULL
) ? cc
: "", eol
);
2869 /* insert the comment strings */
2870 sci_insert_text(editor
->sci
, line_start
, str_begin
);
2871 line_len
= sci_get_position_from_line(editor
->sci
, last_line
+ 2);
2872 sci_insert_text(editor
->sci
, line_len
, str_end
);
2879 /* find @p text inside the range of the current style */
2880 static gint
find_in_current_style(ScintillaObject
*sci
, const gchar
*text
, gboolean backwards
)
2882 gint start
= sci_get_current_position(sci
);
2884 gint len
= sci_get_length(sci
);
2885 gint current_style
= sci_get_style_at(sci
, start
);
2886 struct Sci_TextToFind ttf
;
2888 while (start
> 0 && sci_get_style_at(sci
, start
- 1) == current_style
)
2890 while (end
< len
&& sci_get_style_at(sci
, end
+ 1) == current_style
)
2893 ttf
.lpstrText
= (gchar
*) text
;
2894 ttf
.chrg
.cpMin
= backwards
? end
+ 1 : start
;
2895 ttf
.chrg
.cpMax
= backwards
? start
: end
+ 1;
2896 return sci_find_text(sci
, 0, &ttf
);
2900 static void sci_delete_line(ScintillaObject
*sci
, gint line
)
2902 gint start
= sci_get_position_from_line(sci
, line
);
2903 gint len
= sci_get_line_length(sci
, line
);
2904 SSM(sci
, SCI_DELETERANGE
, start
, len
);
2908 static gboolean
real_uncomment_multiline(GeanyEditor
*editor
)
2910 /* find the beginning of the multi line comment */
2911 gint start
, end
, start_line
, end_line
;
2913 const gchar
*co
, *cc
;
2915 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, FALSE
);
2917 ft
= editor_get_filetype_at_line(editor
, sci_get_current_line(editor
->sci
));
2918 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2919 g_return_val_if_reached(FALSE
);
2921 start
= find_in_current_style(editor
->sci
, co
, TRUE
);
2922 end
= find_in_current_style(editor
->sci
, cc
, FALSE
);
2924 if (start
< 0 || end
< 0 || start
> end
/* who knows */)
2927 start_line
= sci_get_line_from_position(editor
->sci
, start
);
2928 end_line
= sci_get_line_from_position(editor
->sci
, end
);
2930 /* remove comment close chars */
2931 SSM(editor
->sci
, SCI_DELETERANGE
, end
, strlen(cc
));
2932 if (sci_is_blank_line(editor
->sci
, end_line
))
2933 sci_delete_line(editor
->sci
, end_line
);
2935 /* remove comment open chars (do it last since it would move the end position) */
2936 SSM(editor
->sci
, SCI_DELETERANGE
, start
, strlen(co
));
2937 if (sci_is_blank_line(editor
->sci
, start_line
))
2938 sci_delete_line(editor
->sci
, start_line
);
2944 static gint
get_multiline_comment_style(GeanyEditor
*editor
, gint line_start
)
2946 gint lexer
= sci_get_lexer(editor
->sci
);
2949 /* List only those lexers which support multi line comments */
2954 case SCLEX_PHPSCRIPT
:
2956 if (is_style_php(sci_get_style_at(editor
->sci
, line_start
)))
2957 style_comment
= SCE_HPHP_COMMENT
;
2959 style_comment
= SCE_H_COMMENT
;
2963 case SCLEX_LITERATEHASKELL
:
2964 style_comment
= SCE_HA_COMMENTBLOCK
; break;
2965 case SCLEX_LUA
: style_comment
= SCE_LUA_COMMENT
; break;
2966 case SCLEX_CSS
: style_comment
= SCE_CSS_COMMENT
; break;
2967 case SCLEX_SQL
: style_comment
= SCE_SQL_COMMENT
; break;
2968 case SCLEX_CAML
: style_comment
= SCE_CAML_COMMENT
; break;
2969 case SCLEX_D
: style_comment
= SCE_D_COMMENT
; break;
2970 case SCLEX_PASCAL
: style_comment
= SCE_PAS_COMMENT
; break;
2971 case SCLEX_RUST
: style_comment
= SCE_RUST_COMMENTBLOCK
; break;
2972 default: style_comment
= SCE_C_COMMENT
;
2975 return style_comment
;
2979 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise
2980 * returns the amount of uncommented single comment lines, in case of multi line uncomment
2981 * it returns just 1 */
2982 gint
editor_do_uncomment(GeanyEditor
*editor
, gint line
, gboolean toggle
)
2984 gint first_line
, last_line
;
2985 gint x
, i
, line_start
, line_len
;
2986 gint sel_start
, sel_end
;
2990 const gchar
*co
, *cc
;
2991 gboolean single_line
= FALSE
;
2994 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
2997 { /* use selection or current line */
2998 sel_start
= sci_get_selection_start(editor
->sci
);
2999 sel_end
= sci_get_selection_end(editor
->sci
);
3001 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3002 /* Find the last line with chars selected (not EOL char) */
3003 last_line
= sci_get_line_from_position(editor
->sci
,
3004 sel_end
- editor_get_eol_char_len(editor
));
3005 last_line
= MAX(first_line
, last_line
);
3009 first_line
= last_line
= line
;
3010 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3013 ft
= editor_get_filetype_at_line(editor
, first_line
);
3015 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3018 co_len
= strlen(co
);
3022 sci_start_undo_action(editor
->sci
);
3024 for (i
= first_line
; i
<= last_line
; i
++)
3028 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3029 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3032 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3035 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3036 sel
[buf_len
] = '\0';
3038 while (isspace(sel
[x
])) x
++;
3040 /* to skip blank lines */
3041 if (x
< line_len
&& sel
[x
] != '\0')
3043 /* use single line comment */
3050 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3051 if (strncmp(sel
+ x
, co
, co_len
) != 0 ||
3052 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) != 0)
3059 if (strncmp(sel
+ x
, co
, co_len
) != 0)
3063 sci_set_selection(editor
->sci
, line_start
+ x
, line_start
+ x
+ co_len
);
3064 sci_replace_sel(editor
->sci
, "");
3067 /* use multi line comment */
3072 /* skip lines which are already comments */
3073 style_comment
= get_multiline_comment_style(editor
, line_start
);
3074 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3076 if (real_uncomment_multiline(editor
))
3080 /* break because we are already on the last line */
3085 sci_end_undo_action(editor
->sci
);
3087 /* restore selection if there is one
3088 * but don't touch the selection if caller is editor_do_comment_toggle */
3089 if (! toggle
&& sel_start
< sel_end
)
3093 sci_set_selection_start(editor
->sci
, sel_start
- co_len
);
3094 sci_set_selection_end(editor
->sci
, sel_end
- (count
* co_len
));
3098 gint eol_len
= editor_get_eol_char_len(editor
);
3099 sci_set_selection_start(editor
->sci
, sel_start
- co_len
- eol_len
);
3100 sci_set_selection_end(editor
->sci
, sel_end
- co_len
- eol_len
);
3108 void editor_do_comment_toggle(GeanyEditor
*editor
)
3110 gint first_line
, last_line
;
3111 gint x
, i
, line_start
, line_len
, first_line_start
, last_line_start
;
3112 gint sel_start
, sel_end
;
3113 gint count_commented
= 0, count_uncommented
= 0;
3115 const gchar
*co
, *cc
;
3116 gboolean single_line
= FALSE
;
3117 gboolean first_line_was_comment
= FALSE
;
3118 gboolean last_line_was_comment
= FALSE
;
3120 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3123 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3125 sel_start
= sci_get_selection_start(editor
->sci
);
3126 sel_end
= sci_get_selection_end(editor
->sci
);
3128 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3129 /* Find the last line with chars selected (not EOL char) */
3130 last_line
= sci_get_line_from_position(editor
->sci
,
3131 sel_end
- editor_get_eol_char_len(editor
));
3132 last_line
= MAX(first_line
, last_line
);
3134 first_line_start
= sci_get_position_from_line(editor
->sci
, first_line
);
3135 last_line_start
= sci_get_position_from_line(editor
->sci
, last_line
);
3137 ft
= editor_get_filetype_at_line(editor
, first_line
);
3139 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3142 co_len
= strlen(co
);
3146 sci_start_undo_action(editor
->sci
);
3148 for (i
= first_line
; i
<= last_line
; i
++)
3152 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3153 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3156 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3159 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3160 sel
[buf_len
] = '\0';
3162 while (isspace(sel
[x
])) x
++;
3164 /* use single line comment */
3167 gboolean do_continue
= FALSE
;
3170 if (strncmp(sel
+ x
, co
, co_len
) == 0 &&
3171 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) == 0)
3176 if (do_continue
&& i
== first_line
)
3177 first_line_was_comment
= TRUE
;
3178 last_line_was_comment
= do_continue
;
3182 count_uncommented
+= editor_do_uncomment(editor
, i
, TRUE
);
3186 /* we are still here, so the above lines were not already comments, so comment it */
3187 count_commented
+= editor_do_comment(editor
, i
, FALSE
, TRUE
, TRUE
);
3189 /* use multi line comment */
3194 /* skip lines which are already comments */
3195 style_comment
= get_multiline_comment_style(editor
, line_start
);
3196 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3198 if (real_uncomment_multiline(editor
))
3199 count_uncommented
++;
3203 real_comment_multiline(editor
, line_start
, last_line
);
3207 /* break because we are already on the last line */
3212 sci_end_undo_action(editor
->sci
);
3216 /* restore selection or caret position */
3219 gint a
= (first_line_was_comment
) ? - (gint
) co_len
: (gint
) co_len
;
3222 /* don't modify sel_start when the selection starts within indentation */
3223 read_indent(editor
, sel_start
);
3224 indent_len
= (gint
) strlen(indent
);
3225 if ((sel_start
- first_line_start
) <= indent_len
)
3227 /* if the selection start was inside the comment mark, adjust the position */
3228 else if (first_line_was_comment
&&
3229 sel_start
>= (first_line_start
+ indent_len
) &&
3230 sel_start
<= (first_line_start
+ indent_len
+ (gint
) co_len
))
3232 a
= (first_line_start
+ indent_len
) - sel_start
;
3235 if (sel_start
< sel_end
)
3237 gint b
= (count_commented
* (gint
) co_len
) - (count_uncommented
* (gint
) co_len
);
3239 /* same for selection end, but here we add an offset on the offset above */
3240 read_indent(editor
, sel_end
+ b
);
3241 indent_len
= (gint
) strlen(indent
);
3242 if ((sel_end
- last_line_start
) < indent_len
)
3243 b
+= last_line_was_comment
? (gint
) co_len
: -(gint
) co_len
;
3244 else if (last_line_was_comment
&&
3245 sel_end
>= (last_line_start
+ indent_len
) &&
3246 sel_end
<= (last_line_start
+ indent_len
+ (gint
) co_len
))
3248 b
+= (gint
) co_len
- (sel_end
- (last_line_start
+ indent_len
));
3251 sci_set_selection_start(editor
->sci
, sel_start
+ a
);
3252 sci_set_selection_end(editor
->sci
, sel_end
+ b
);
3255 sci_set_current_position(editor
->sci
, sel_start
+ a
, TRUE
);
3259 gint eol_len
= editor_get_eol_char_len(editor
);
3260 if (count_uncommented
> 0)
3262 sci_set_selection_start(editor
->sci
, sel_start
- (gint
) co_len
+ eol_len
);
3263 sci_set_selection_end(editor
->sci
, sel_end
- (gint
) co_len
+ eol_len
);
3265 else if (count_commented
> 0)
3267 sci_set_selection_start(editor
->sci
, sel_start
+ (gint
) co_len
- eol_len
);
3268 sci_set_selection_end(editor
->sci
, sel_end
+ (gint
) co_len
- eol_len
);
3270 if (sel_start
>= sel_end
)
3271 sci_scroll_caret(editor
->sci
);
3276 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise */
3277 gint
editor_do_comment(GeanyEditor
*editor
, gint line
, gboolean allow_empty_lines
, gboolean toggle
,
3278 gboolean single_comment
)
3280 gint first_line
, last_line
;
3281 gint x
, i
, line_start
, line_len
;
3282 gint sel_start
, sel_end
, co_len
;
3285 const gchar
*co
, *cc
;
3286 gboolean single_line
= FALSE
;
3289 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
3292 { /* use selection or current line */
3293 sel_start
= sci_get_selection_start(editor
->sci
);
3294 sel_end
= sci_get_selection_end(editor
->sci
);
3296 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3297 /* Find the last line with chars selected (not EOL char) */
3298 last_line
= sci_get_line_from_position(editor
->sci
,
3299 sel_end
- editor_get_eol_char_len(editor
));
3300 last_line
= MAX(first_line
, last_line
);
3304 first_line
= last_line
= line
;
3305 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3308 ft
= editor_get_filetype_at_line(editor
, first_line
);
3310 if (! filetype_get_comment_open_close(ft
, single_comment
, &co
, &cc
))
3313 co_len
= strlen(co
);
3317 sci_start_undo_action(editor
->sci
);
3319 for (i
= first_line
; i
<= last_line
; i
++)
3323 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3324 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3327 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3330 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3331 sel
[buf_len
] = '\0';
3333 while (isspace(sel
[x
])) x
++;
3335 /* to skip blank lines */
3336 if (allow_empty_lines
|| (x
< line_len
&& sel
[x
] != '\0'))
3338 /* use single line comment */
3341 gint start
= line_start
;
3344 if (ft
->comment_use_indent
)
3345 start
= line_start
+ x
;
3349 gchar
*text
= g_strconcat(co
, editor_prefs
.comment_toggle_mark
, NULL
);
3350 sci_insert_text(editor
->sci
, start
, text
);
3354 sci_insert_text(editor
->sci
, start
, co
);
3357 /* use multi line comment */
3362 /* skip lines which are already comments */
3363 style_comment
= get_multiline_comment_style(editor
, line_start
);
3364 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3367 real_comment_multiline(editor
, line_start
, last_line
);
3370 /* break because we are already on the last line */
3375 sci_end_undo_action(editor
->sci
);
3377 /* restore selection if there is one
3378 * but don't touch the selection if caller is editor_do_comment_toggle */
3379 if (! toggle
&& sel_start
< sel_end
)
3383 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
);
3384 sci_set_selection_end(editor
->sci
, sel_end
+ (count
* co_len
));
3388 gint eol_len
= editor_get_eol_char_len(editor
);
3389 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
+ eol_len
);
3390 sci_set_selection_end(editor
->sci
, sel_end
+ co_len
+ eol_len
);
3397 static gboolean brace_timeout_active
= FALSE
;
3399 static gboolean
delay_match_brace(G_GNUC_UNUSED gpointer user_data
)
3401 GeanyDocument
*doc
= document_get_current();
3402 GeanyEditor
*editor
;
3403 gint brace_pos
= GPOINTER_TO_INT(user_data
);
3404 gint end_pos
, cur_pos
;
3406 brace_timeout_active
= FALSE
;
3410 editor
= doc
->editor
;
3411 cur_pos
= sci_get_current_position(editor
->sci
) - 1;
3413 if (cur_pos
!= brace_pos
)
3416 if (cur_pos
!= brace_pos
)
3418 /* we have moved past the original brace_pos, but after the timeout
3419 * we may now be on a new brace, so check again */
3420 editor_highlight_braces(editor
, cur_pos
);
3424 if (!utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3426 editor_highlight_braces(editor
, cur_pos
);
3429 end_pos
= sci_find_matching_brace(editor
->sci
, brace_pos
);
3433 gint col
= MIN(sci_get_col_from_position(editor
->sci
, brace_pos
),
3434 sci_get_col_from_position(editor
->sci
, end_pos
));
3435 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, col
, 0);
3436 SSM(editor
->sci
, SCI_BRACEHIGHLIGHT
, brace_pos
, end_pos
);
3440 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3441 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, brace_pos
, 0);
3447 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
)
3449 gint brace_pos
= cur_pos
- 1;
3451 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3452 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, (uptr_t
)-1, 0);
3454 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3457 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3462 if (!brace_timeout_active
)
3464 brace_timeout_active
= TRUE
;
3465 /* delaying matching makes scrolling faster e.g. holding down arrow keys */
3466 g_timeout_add(100, delay_match_brace
, GINT_TO_POINTER(brace_pos
));
3471 static gboolean
in_block_comment(gint lexer
, gint style
)
3477 return (style
== SCE_C_COMMENT
||
3478 style
== SCE_C_COMMENTDOC
);
3481 return (style
== SCE_PAS_COMMENT
||
3482 style
== SCE_PAS_COMMENT2
);
3485 return (style
== SCE_D_COMMENT
||
3486 style
== SCE_D_COMMENTDOC
||
3487 style
== SCE_D_COMMENTNESTED
);
3490 case SCLEX_PHPSCRIPT
:
3491 return (style
== SCE_HPHP_COMMENT
);
3494 return (style
== SCE_CSS_COMMENT
);
3497 return (style
== SCE_RUST_COMMENTBLOCK
||
3498 style
== SCE_RUST_COMMENTBLOCKDOC
);
3506 static gboolean
is_comment_char(gchar c
, gint lexer
)
3508 if ((c
== '*' || c
== '+') && lexer
== SCLEX_D
)
3518 static void auto_multiline(GeanyEditor
*editor
, gint cur_line
)
3520 ScintillaObject
*sci
= editor
->sci
;
3521 gint indent_pos
, style
;
3522 gint lexer
= sci_get_lexer(sci
);
3524 /* Use the start of the line enter was pressed on, to avoid any doc keyword styles */
3525 indent_pos
= sci_get_line_indent_position(sci
, cur_line
- 1);
3526 style
= sci_get_style_at(sci
, indent_pos
);
3527 if (!in_block_comment(lexer
, style
))
3530 /* Check whether the comment block continues on this line */
3531 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3532 if (sci_get_style_at(sci
, indent_pos
) == style
|| indent_pos
>= sci_get_length(sci
))
3534 gchar
*previous_line
= sci_get_line(sci
, cur_line
- 1);
3535 /* the type of comment, '*' (C/C++/Java), '+' D comment that nests */
3536 const gchar
*continuation
= (style
== SCE_D_COMMENTNESTED
) ? "+" : "*";
3537 const gchar
*whitespace
= ""; /* to hold whitespace if needed */
3539 gint len
= strlen(previous_line
);
3542 /* find and stop at end of multi line comment */
3544 while (i
>= 0 && isspace(previous_line
[i
])) i
--;
3545 if (i
>= 1 && is_comment_char(previous_line
[i
- 1], lexer
) && previous_line
[i
] == '/')
3547 gint indent_len
, indent_width
;
3549 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3550 indent_len
= sci_get_col_from_position(sci
, indent_pos
);
3551 indent_width
= editor_get_indent_prefs(editor
)->width
;
3553 /* if there is one too many spaces, delete the last space,
3554 * to return to the indent used before the multiline comment was started. */
3555 if (indent_len
% indent_width
== 1)
3556 SSM(sci
, SCI_DELETEBACKNOTLINE
, 0, 0); /* remove whitespace indent */
3557 g_free(previous_line
);
3560 /* check whether we are on the second line of multi line comment */
3562 while (i
< len
&& isspace(previous_line
[i
])) i
++; /* get to start of the line */
3565 previous_line
[i
] == '/' && is_comment_char(previous_line
[i
+ 1], lexer
))
3566 { /* we are on the second line of a multi line comment, so we have to insert white space */
3569 else if (!(g_str_has_prefix(previous_line
+ i
, continuation
) &&
3570 (i
+ 1 == len
|| isspace(previous_line
[i
+ 1]))))
3572 // previous line isn't formatted so abort
3573 g_free(previous_line
);
3576 result
= g_strconcat(whitespace
, continuation
, " ", NULL
);
3577 sci_add_text(sci
, result
);
3580 g_free(previous_line
);
3586 static gboolean
editor_lexer_is_c_like(gint lexer
)
3601 /* inserts a three-line comment at one line above current cursor position */
3602 void editor_insert_multiline_comment(GeanyEditor
*editor
)
3608 gboolean have_multiline_comment
= FALSE
;
3610 const gchar
*co
, *cc
;
3612 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3614 if (! filetype_get_comment_open_close(editor
->document
->file_type
, FALSE
, &co
, &cc
))
3615 g_return_if_reached();
3617 have_multiline_comment
= TRUE
;
3619 sci_start_undo_action(editor
->sci
);
3621 doc
= editor
->document
;
3623 /* insert three lines one line above of the current position */
3624 line
= sci_get_line_from_position(editor
->sci
, editor_info
.click_pos
);
3625 pos
= sci_get_position_from_line(editor
->sci
, line
);
3627 /* use the indent on the current line but only when comment indentation is used
3628 * and we don't have multi line comment characters */
3629 if (editor
->auto_indent
&&
3630 ! have_multiline_comment
&& doc
->file_type
->comment_use_indent
)
3632 read_indent(editor
, editor_info
.click_pos
);
3633 text
= g_strdup_printf("%s\n%s\n%s\n", indent
, indent
, indent
);
3634 text_len
= strlen(text
);
3638 text
= g_strdup("\n\n\n");
3641 sci_insert_text(editor
->sci
, pos
, text
);
3644 /* select the inserted lines for commenting */
3645 sci_set_selection_start(editor
->sci
, pos
);
3646 sci_set_selection_end(editor
->sci
, pos
+ text_len
);
3648 editor_do_comment(editor
, -1, TRUE
, FALSE
, FALSE
);
3650 /* set the current position to the start of the first inserted line */
3653 /* on multi line comment jump to the next line, otherwise add the length of added indentation */
3654 if (have_multiline_comment
)
3657 pos
+= strlen(indent
);
3659 sci_set_current_position(editor
->sci
, pos
, TRUE
);
3660 /* reset the selection */
3661 sci_set_anchor(editor
->sci
, pos
);
3663 sci_end_undo_action(editor
->sci
);
3667 /* Note: If the editor is pending a redraw, set document::scroll_percent instead.
3668 * Scroll the view to make line appear at percent_of_view.
3669 * line can be -1 to use the current position. */
3670 void editor_scroll_to_line(GeanyEditor
*editor
, gint line
, gfloat percent_of_view
)
3675 g_return_if_fail(editor
!= NULL
);
3677 wid
= GTK_WIDGET(editor
->sci
);
3679 if (! gtk_widget_get_window(wid
) || ! gdk_window_is_viewable(gtk_widget_get_window(wid
)))
3680 return; /* prevent gdk_window_scroll warning */
3683 line
= sci_get_current_line(editor
->sci
);
3685 /* sci 'visible line' != doc line number because of folding and line wrapping */
3686 /* calling SCI_VISIBLEFROMDOCLINE for line is more accurate than calling
3687 * SCI_DOCLINEFROMVISIBLE for vis1. */
3688 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0);
3689 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
3690 line
= line
- los
* percent_of_view
;
3691 SSM(editor
->sci
, SCI_SETFIRSTVISIBLELINE
, line
, 0);
3692 sci_scroll_caret(editor
->sci
); /* needed for horizontal scrolling */
3696 /* creates and inserts one tab or whitespace of the amount of the tab width */
3697 void editor_insert_alternative_whitespace(GeanyEditor
*editor
)
3700 GeanyIndentPrefs iprefs
= *editor_get_indent_prefs(editor
);
3702 g_return_if_fail(editor
!= NULL
);
3704 switch (iprefs
.type
)
3706 case GEANY_INDENT_TYPE_TABS
:
3707 iprefs
.type
= GEANY_INDENT_TYPE_SPACES
;
3709 case GEANY_INDENT_TYPE_SPACES
:
3710 case GEANY_INDENT_TYPE_BOTH
: /* most likely we want a tab */
3711 iprefs
.type
= GEANY_INDENT_TYPE_TABS
;
3714 text
= get_whitespace(&iprefs
, iprefs
.width
);
3715 sci_add_text(editor
->sci
, text
);
3720 void editor_select_word(GeanyEditor
*editor
)
3726 g_return_if_fail(editor
!= NULL
);
3728 pos
= SSM(editor
->sci
, SCI_GETCURRENTPOS
, 0, 0);
3729 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
3730 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
3732 if (start
== end
) /* caret in whitespaces sequence */
3734 /* look forward but reverse the selection direction,
3735 * so the caret end up stay as near as the original position. */
3736 end
= sci_word_end_position(editor
->sci
, pos
, FALSE
);
3737 start
= sci_word_end_position(editor
->sci
, end
, TRUE
);
3742 sci_set_selection(editor
->sci
, start
, end
);
3746 /* extra_line is for selecting the cursor line (or anchor line) at the bottom of a selection,
3747 * when those lines have no selection (cursor at start of line). */
3748 void editor_select_lines(GeanyEditor
*editor
, gboolean extra_line
)
3750 gint start
, end
, line
;
3752 g_return_if_fail(editor
!= NULL
);
3754 start
= sci_get_selection_start(editor
->sci
);
3755 end
= sci_get_selection_end(editor
->sci
);
3757 /* check if whole lines are already selected */
3758 if (! extra_line
&& start
!= end
&&
3759 sci_get_col_from_position(editor
->sci
, start
) == 0 &&
3760 sci_get_col_from_position(editor
->sci
, end
) == 0)
3763 line
= sci_get_line_from_position(editor
->sci
, start
);
3764 start
= sci_get_position_from_line(editor
->sci
, line
);
3766 line
= sci_get_line_from_position(editor
->sci
, end
);
3767 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
3769 sci_set_selection(editor
->sci
, start
, end
);
3773 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
)
3775 return sci_get_line_indent_position(sci
, line
) ==
3776 sci_get_line_end_position(sci
, line
);
3780 /* Returns first line of paragraph for GTK_DIR_UP, line after paragraph
3781 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3782 static gint
find_paragraph_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3785 ScintillaObject
*sci
= editor
->sci
;
3787 /* first check current line and return -1 if it is empty to skip creating of a selection */
3788 if (sci_is_blank_line(sci
, line
))
3791 if (direction
== GTK_DIR_UP
)
3801 /* start of document */
3805 if (line
== sci_get_line_count(sci
))
3808 if (sci_is_blank_line(sci
, line
))
3810 /* return line paragraph starts on */
3811 if (direction
== GTK_DIR_UP
)
3820 void editor_select_paragraph(GeanyEditor
*editor
)
3822 gint pos_start
, pos_end
, line_start
, line_found
;
3824 g_return_if_fail(editor
!= NULL
);
3826 line_start
= sci_get_current_line(editor
->sci
);
3828 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_UP
);
3829 if (line_found
== -1)
3832 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3834 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_DOWN
);
3835 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3837 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3841 /* Returns first line of block for GTK_DIR_UP, line after block
3842 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3843 static gint
find_block_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3846 ScintillaObject
*sci
= editor
->sci
;
3848 /* first check current line and return -1 if it is empty to skip creating of a selection */
3849 if (sci_is_blank_line(sci
, line
))
3852 if (direction
== GTK_DIR_UP
)
3857 ind
= sci_get_line_indentation(sci
, line
);
3863 /* start of document */
3867 if (line
== sci_get_line_count(sci
))
3870 if (sci_get_line_indentation(sci
, line
) != ind
||
3871 sci_is_blank_line(sci
, line
))
3873 /* return line block starts on */
3874 if (direction
== GTK_DIR_UP
)
3883 void editor_select_indent_block(GeanyEditor
*editor
)
3885 gint pos_start
, pos_end
, line_start
, line_found
;
3887 g_return_if_fail(editor
!= NULL
);
3889 line_start
= sci_get_current_line(editor
->sci
);
3891 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_UP
);
3892 if (line_found
== -1)
3895 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3897 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_DOWN
);
3898 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3900 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3904 /* simple indentation to indent the current line with the same indent as the previous one */
3905 static void smart_line_indentation(GeanyEditor
*editor
, gint first_line
, gint last_line
)
3907 gint i
, sel_start
= 0, sel_end
= 0;
3909 /* get previous line and use it for read_indent to use that line
3910 * (otherwise it would fail on a line only containing "{" in advanced indentation mode) */
3911 read_indent(editor
, sci_get_position_from_line(editor
->sci
, first_line
- 1));
3913 for (i
= first_line
; i
<= last_line
; i
++)
3915 /* skip the first line or if the indentation of the previous and current line are equal */
3917 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
- 1, 0) ==
3918 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
, 0))
3921 sel_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3922 sel_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3923 if (sel_start
< sel_end
)
3925 sci_set_selection(editor
->sci
, sel_start
, sel_end
);
3926 sci_replace_sel(editor
->sci
, "");
3928 sci_insert_text(editor
->sci
, sel_start
, indent
);
3933 /* simple indentation to indent the current line with the same indent as the previous one */
3934 void editor_smart_line_indentation(GeanyEditor
*editor
)
3936 gint first_line
, last_line
;
3937 gint first_sel_start
, first_sel_end
;
3938 ScintillaObject
*sci
;
3940 g_return_if_fail(editor
!= NULL
);
3944 first_sel_start
= sci_get_selection_start(sci
);
3945 first_sel_end
= sci_get_selection_end(sci
);
3947 first_line
= sci_get_line_from_position(sci
, first_sel_start
);
3948 /* Find the last line with chars selected (not EOL char) */
3949 last_line
= sci_get_line_from_position(sci
, first_sel_end
- editor_get_eol_char_len(editor
));
3950 last_line
= MAX(first_line
, last_line
);
3952 sci_start_undo_action(sci
);
3954 smart_line_indentation(editor
, first_line
, last_line
);
3956 /* set cursor position if there was no selection */
3957 if (first_sel_start
== first_sel_end
)
3959 gint indent_pos
= SSM(sci
, SCI_GETLINEINDENTPOSITION
, first_line
, 0);
3961 /* use indent position as user may wish to change indentation afterwards */
3962 sci_set_current_position(sci
, indent_pos
, FALSE
);
3966 /* fully select all the lines affected */
3967 sci_set_selection_start(sci
, sci_get_position_from_line(sci
, first_line
));
3968 sci_set_selection_end(sci
, sci_get_position_from_line(sci
, last_line
+ 1));
3971 sci_end_undo_action(sci
);
3975 /* increase / decrease current line or selection by one space */
3976 void editor_indentation_by_one_space(GeanyEditor
*editor
, gint pos
, gboolean decrease
)
3978 gint i
, first_line
, last_line
, line_start
, indentation_end
, count
= 0;
3979 gint sel_start
, sel_end
, first_line_offset
= 0;
3981 g_return_if_fail(editor
!= NULL
);
3983 sel_start
= sci_get_selection_start(editor
->sci
);
3984 sel_end
= sci_get_selection_end(editor
->sci
);
3986 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3987 /* Find the last line with chars selected (not EOL char) */
3988 last_line
= sci_get_line_from_position(editor
->sci
, sel_end
- editor_get_eol_char_len(editor
));
3989 last_line
= MAX(first_line
, last_line
);
3994 sci_start_undo_action(editor
->sci
);
3996 for (i
= first_line
; i
<= last_line
; i
++)
3998 indentation_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
4001 line_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
4002 /* searching backwards for a space to remove */
4003 while (sci_get_char_at(editor
->sci
, indentation_end
) != ' ' && indentation_end
> line_start
)
4006 if (sci_get_char_at(editor
->sci
, indentation_end
) == ' ')
4008 sci_set_selection(editor
->sci
, indentation_end
, indentation_end
+ 1);
4009 sci_replace_sel(editor
->sci
, "");
4011 if (i
== first_line
)
4012 first_line_offset
= -1;
4017 sci_insert_text(editor
->sci
, indentation_end
, " ");
4019 if (i
== first_line
)
4020 first_line_offset
= 1;
4024 /* set cursor position */
4025 if (sel_start
< sel_end
)
4027 gint start
= sel_start
+ first_line_offset
;
4028 if (first_line_offset
< 0)
4029 start
= MAX(sel_start
+ first_line_offset
,
4030 SSM(editor
->sci
, SCI_POSITIONFROMLINE
, first_line
, 0));
4032 sci_set_selection_start(editor
->sci
, start
);
4033 sci_set_selection_end(editor
->sci
, sel_end
+ count
);
4036 sci_set_current_position(editor
->sci
, pos
+ count
, FALSE
);
4038 sci_end_undo_action(editor
->sci
);
4042 void editor_finalize(void)
4044 scintilla_release_resources();
4048 /* wordchars: NULL or a string containing characters to match a word.
4049 * Returns: the current selection or the current word.
4051 * Passing NULL as wordchars is NOT the same as passing GEANY_WORDCHARS: NULL means
4052 * using Scintillas's word boundaries. */
4053 gchar
*editor_get_default_selection(GeanyEditor
*editor
, gboolean use_current_word
,
4054 const gchar
*wordchars
)
4058 g_return_val_if_fail(editor
!= NULL
, NULL
);
4060 if (sci_get_lines_selected(editor
->sci
) == 1)
4061 s
= sci_get_selection_contents(editor
->sci
);
4062 else if (sci_get_lines_selected(editor
->sci
) == 0 && use_current_word
)
4063 { /* use the word at current cursor position */
4064 gchar word
[GEANY_MAX_WORD_LENGTH
];
4066 if (wordchars
!= NULL
)
4067 editor_find_current_word(editor
, -1, word
, sizeof(word
), wordchars
);
4069 editor_find_current_word_sciwc(editor
, -1, word
, sizeof(word
));
4071 if (word
[0] != '\0')
4078 /* Note: Usually the line should be made visible (not folded) before calling this.
4079 * Returns: TRUE if line is/will be displayed to the user, or FALSE if it is
4080 * outside the *vertical* view.
4081 * Warning: You may need horizontal scrolling to make the cursor visible - so always call
4082 * sci_scroll_caret() when this returns TRUE. */
4083 gboolean
editor_line_in_view(GeanyEditor
*editor
, gint line
)
4087 g_return_val_if_fail(editor
!= NULL
, FALSE
);
4089 /* If line is wrapped the result may occur on another virtual line than the first and may be
4090 * still hidden, so increase the line number to check for the next document line */
4091 if (SSM(editor
->sci
, SCI_WRAPCOUNT
, line
, 0) > 1)
4094 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0); /* convert to visible line number */
4095 vis1
= SSM(editor
->sci
, SCI_GETFIRSTVISIBLELINE
, 0, 0);
4096 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
4098 return (line
>= vis1
&& line
< vis1
+ los
);
4102 /* If the current line is outside the current view window, scroll the line
4103 * so it appears at percent_of_view. */
4104 void editor_display_current_line(GeanyEditor
*editor
, gfloat percent_of_view
)
4108 g_return_if_fail(editor
!= NULL
);
4110 line
= sci_get_current_line(editor
->sci
);
4112 /* unfold maybe folded results */
4113 sci_ensure_line_is_visible(editor
->sci
, line
);
4115 /* scroll the line if it's off screen */
4116 if (! editor_line_in_view(editor
, line
))
4117 editor
->scroll_percent
= percent_of_view
;
4119 sci_scroll_caret(editor
->sci
); /* may need horizontal scrolling */
4124 * Deletes all currently set indicators in the @a editor window.
4125 * Error indicators (red squiggly underlines) and usual line markers are removed.
4127 * @param editor The editor to operate on.
4129 void editor_indicator_clear_errors(GeanyEditor
*editor
)
4131 editor_indicator_clear(editor
, GEANY_INDICATOR_ERROR
);
4132 sci_marker_delete_all(editor
->sci
, 0); /* remove the yellow error line marker */
4137 * Deletes all currently set indicators matching @a indic in the @a editor window.
4139 * @param editor The editor to operate on.
4140 * @param indic The indicator number to clear, this is a value of @ref GeanyIndicator.
4145 void editor_indicator_clear(GeanyEditor
*editor
, gint indic
)
4149 g_return_if_fail(editor
!= NULL
);
4151 last_pos
= sci_get_length(editor
->sci
);
4154 sci_indicator_set(editor
->sci
, indic
);
4155 sci_indicator_clear(editor
->sci
, 0, last_pos
);
4161 * Sets an indicator @a indic on @a line.
4162 * Whitespace at the start and the end of the line is not marked.
4164 * @param editor The editor to operate on.
4165 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4166 * @param line The line number which should be marked.
4171 void editor_indicator_set_on_line(GeanyEditor
*editor
, gint indic
, gint line
)
4177 g_return_if_fail(editor
!= NULL
);
4178 g_return_if_fail(line
>= 0);
4180 start
= sci_get_position_from_line(editor
->sci
, line
);
4181 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
4183 /* skip blank lines */
4184 if ((start
+ 1) == end
||
4186 (sci_get_line_end_position(editor
->sci
, line
) - start
) == 0)
4192 linebuf
= sci_get_line(editor
->sci
, line
);
4194 /* don't set the indicator on whitespace */
4195 while (isspace(linebuf
[i
]))
4197 while (len
> 1 && len
> i
&& isspace(linebuf
[len
- 1]))
4204 editor_indicator_set_on_range(editor
, indic
, start
+ i
, end
);
4209 * Sets an indicator on the range specified by @a start and @a end.
4210 * No error checking or whitespace removal is performed, this should be done by the calling
4211 * function if necessary.
4213 * @param editor The editor to operate on.
4214 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4215 * @param start The starting position for the marker.
4216 * @param end The ending position for the marker.
4221 void editor_indicator_set_on_range(GeanyEditor
*editor
, gint indic
, gint start
, gint end
)
4223 g_return_if_fail(editor
!= NULL
);
4227 sci_indicator_set(editor
->sci
, indic
);
4228 sci_indicator_fill(editor
->sci
, start
, end
- start
);
4232 /* Inserts the given colour (format should be #...), if there is a selection starting with 0x...
4233 * the replacement will also start with 0x... */
4234 void editor_insert_color(GeanyEditor
*editor
, const gchar
*colour
)
4236 g_return_if_fail(editor
!= NULL
);
4238 if (sci_has_selection(editor
->sci
))
4240 gint start
= sci_get_selection_start(editor
->sci
);
4241 const gchar
*replacement
= colour
;
4243 if (sci_get_char_at(editor
->sci
, start
) == '0' &&
4244 sci_get_char_at(editor
->sci
, start
+ 1) == 'x')
4246 gint end
= sci_get_selection_end(editor
->sci
);
4248 sci_set_selection_start(editor
->sci
, start
+ 2);
4249 /* we need to also re-set the selection end in case the anchor was located before
4250 * the cursor, since set_selection_start() always moves the cursor, not the anchor */
4251 sci_set_selection_end(editor
->sci
, end
);
4252 replacement
++; /* skip the leading "0x" */
4254 else if (sci_get_char_at(editor
->sci
, start
- 1) == '#')
4255 { /* double clicking something like #00ffff may only select 00ffff because of wordchars */
4256 replacement
++; /* so skip the '#' to only replace the colour value */
4258 sci_replace_sel(editor
->sci
, replacement
);
4261 sci_add_text(editor
->sci
, colour
);
4266 * Retrieves the end of line characters mode (LF, CR/LF, CR) in the given editor.
4267 * If @a editor is @c NULL, the default end of line characters are used.
4269 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4270 * @return The used end of line characters mode.
4275 gint
editor_get_eol_char_mode(GeanyEditor
*editor
)
4277 gint mode
= file_prefs
.default_eol_character
;
4280 mode
= sci_get_eol_mode(editor
->sci
);
4287 * Retrieves the localized name (for displaying) of the used end of line characters
4288 * (LF, CR/LF, CR) in the given editor.
4289 * If @a editor is @c NULL, the default end of line characters are used.
4291 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4292 * @return The name of the end of line characters.
4297 const gchar
*editor_get_eol_char_name(GeanyEditor
*editor
)
4299 gint mode
= file_prefs
.default_eol_character
;
4302 mode
= sci_get_eol_mode(editor
->sci
);
4304 return utils_get_eol_name(mode
);
4309 * Retrieves the length of the used end of line characters (LF, CR/LF, CR) in the given editor.
4310 * If @a editor is @c NULL, the default end of line characters are used.
4311 * The returned value is 1 for CR and LF and 2 for CR/LF.
4313 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4314 * @return The length of the end of line characters.
4319 gint
editor_get_eol_char_len(GeanyEditor
*editor
)
4321 gint mode
= file_prefs
.default_eol_character
;
4324 mode
= sci_get_eol_mode(editor
->sci
);
4328 case SC_EOL_CRLF
: return 2; break;
4329 default: return 1; break;
4335 * Retrieves the used end of line characters (LF, CR/LF, CR) in the given editor.
4336 * If @a editor is @c NULL, the default end of line characters are used.
4337 * The returned value is either "\n", "\r\n" or "\r".
4339 * @param editor @nullable The editor to operate on, or @c NULL to query the default value.
4340 * @return The end of line characters.
4345 const gchar
*editor_get_eol_char(GeanyEditor
*editor
)
4347 gint mode
= file_prefs
.default_eol_character
;
4350 mode
= sci_get_eol_mode(editor
->sci
);
4352 return utils_get_eol_char(mode
);
4356 static void fold_all(GeanyEditor
*editor
, gboolean want_fold
)
4358 gint lines
, first
, i
;
4360 if (editor
== NULL
|| ! editor_prefs
.folding
)
4363 lines
= sci_get_line_count(editor
->sci
);
4364 first
= sci_get_first_visible_line(editor
->sci
);
4366 for (i
= 0; i
< lines
; i
++)
4368 gint level
= sci_get_fold_level(editor
->sci
, i
);
4370 if (level
& SC_FOLDLEVELHEADERFLAG
)
4372 if (sci_get_fold_expanded(editor
->sci
, i
) == want_fold
)
4373 sci_toggle_fold(editor
->sci
, i
);
4376 editor_scroll_to_line(editor
, first
, 0.0F
);
4380 void editor_unfold_all(GeanyEditor
*editor
)
4382 fold_all(editor
, FALSE
);
4386 void editor_fold_all(GeanyEditor
*editor
)
4388 fold_all(editor
, TRUE
);
4392 void editor_replace_tabs(GeanyEditor
*editor
, gboolean ignore_selection
)
4394 gint anchor_pos
, caret_pos
;
4395 struct Sci_TextToFind ttf
;
4397 g_return_if_fail(editor
!= NULL
);
4399 sci_start_undo_action(editor
->sci
);
4400 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4402 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4403 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4408 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4410 ttf
.lpstrText
= (gchar
*) "\t";
4412 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4413 caret_pos
= sci_get_current_position(editor
->sci
);
4416 gint search_pos
, pos_in_line
, current_tab_true_length
;
4420 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4421 if (search_pos
== -1)
4424 tab_len
= sci_get_tab_width(editor
->sci
);
4425 pos_in_line
= sci_get_col_from_position(editor
->sci
, search_pos
);
4426 current_tab_true_length
= tab_len
- (pos_in_line
% tab_len
);
4427 tab_str
= g_strnfill(current_tab_true_length
, ' ');
4428 sci_set_target_start(editor
->sci
, search_pos
);
4429 sci_set_target_end(editor
->sci
, search_pos
+ 1);
4430 sci_replace_target(editor
->sci
, tab_str
, FALSE
);
4431 /* next search starts after replacement */
4432 ttf
.chrg
.cpMin
= search_pos
+ current_tab_true_length
- 1;
4433 /* update end of range now text has changed */
4434 ttf
.chrg
.cpMax
+= current_tab_true_length
- 1;
4437 if (anchor_pos
> search_pos
)
4438 anchor_pos
+= current_tab_true_length
- 1;
4439 if (caret_pos
> search_pos
)
4440 caret_pos
+= current_tab_true_length
- 1;
4442 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4443 sci_end_undo_action(editor
->sci
);
4447 /* Replaces all occurrences all spaces of the length of a given tab_width,
4448 * optionally restricting the search to the current selection. */
4449 void editor_replace_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4452 gint anchor_pos
, caret_pos
;
4453 static gdouble tab_len_f
= -1.0; /* keep the last used value */
4456 struct Sci_TextToFind ttf
;
4458 g_return_if_fail(editor
!= NULL
);
4460 if (tab_len_f
< 0.0)
4461 tab_len_f
= sci_get_tab_width(editor
->sci
);
4463 if (! dialogs_show_input_numeric(
4464 _("Enter Tab Width"),
4465 _("Enter the amount of spaces which should be replaced by a tab character."),
4466 &tab_len_f
, 1, 100, 1))
4470 tab_len
= (gint
) tab_len_f
;
4471 text
= g_strnfill(tab_len
, ' ');
4473 sci_start_undo_action(editor
->sci
);
4474 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4476 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4477 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4482 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4484 ttf
.lpstrText
= text
;
4486 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4487 caret_pos
= sci_get_current_position(editor
->sci
);
4490 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4491 if (search_pos
== -1)
4493 /* only replace indentation because otherwise we can mess up alignment */
4494 if (search_pos
> sci_get_line_indent_position(editor
->sci
,
4495 sci_get_line_from_position(editor
->sci
, search_pos
)))
4497 ttf
.chrg
.cpMin
= search_pos
+ tab_len
;
4500 sci_set_target_start(editor
->sci
, search_pos
);
4501 sci_set_target_end(editor
->sci
, search_pos
+ tab_len
);
4502 sci_replace_target(editor
->sci
, "\t", FALSE
);
4503 ttf
.chrg
.cpMin
= search_pos
;
4504 /* update end of range now text has changed */
4505 ttf
.chrg
.cpMax
-= tab_len
- 1;
4507 if (anchor_pos
> search_pos
)
4508 anchor_pos
-= tab_len
- 1;
4509 if (caret_pos
> search_pos
)
4510 caret_pos
-= tab_len
- 1;
4512 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4513 sci_end_undo_action(editor
->sci
);
4518 void editor_strip_line_trailing_spaces(GeanyEditor
*editor
, gint line
)
4520 gint line_start
= sci_get_position_from_line(editor
->sci
, line
);
4521 gint line_end
= sci_get_line_end_position(editor
->sci
, line
);
4522 gint i
= line_end
- 1;
4523 gchar ch
= sci_get_char_at(editor
->sci
, i
);
4525 /* Diff hunks should keep trailing spaces */
4526 if (editor
->document
->file_type
->id
== GEANY_FILETYPES_DIFF
)
4529 while ((i
>= line_start
) && ((ch
== ' ') || (ch
== '\t')))
4532 ch
= sci_get_char_at(editor
->sci
, i
);
4534 if (i
< (line_end
- 1))
4536 sci_set_target_start(editor
->sci
, i
+ 1);
4537 sci_set_target_end(editor
->sci
, line_end
);
4538 sci_replace_target(editor
->sci
, "", FALSE
);
4543 void editor_strip_trailing_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4549 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4551 gint selection_start
= sci_get_selection_start(editor
->sci
);
4552 gint selection_end
= sci_get_selection_end(editor
->sci
);
4554 start_line
= sci_get_line_from_position(editor
->sci
, selection_start
);
4555 end_line
= sci_get_line_from_position(editor
->sci
, selection_end
);
4557 if (sci_get_col_from_position(editor
->sci
, selection_end
) > 0)
4563 end_line
= sci_get_line_count(editor
->sci
);
4566 sci_start_undo_action(editor
->sci
);
4568 for (line
= start_line
; line
< end_line
; line
++)
4570 editor_strip_line_trailing_spaces(editor
, line
);
4572 sci_end_undo_action(editor
->sci
);
4576 void editor_ensure_final_newline(GeanyEditor
*editor
)
4578 gint max_lines
= sci_get_line_count(editor
->sci
);
4579 gboolean append_newline
= (max_lines
== 1);
4580 gint end_document
= sci_get_position_from_line(editor
->sci
, max_lines
);
4584 append_newline
= end_document
> sci_get_position_from_line(editor
->sci
, max_lines
- 1);
4588 const gchar
*eol
= editor_get_eol_char(editor
);
4590 sci_insert_text(editor
->sci
, end_document
, eol
);
4595 /* Similar to editor_set_font() but *only* sets the font, and doesn't take care
4596 * of updating properties that might depend on the font */
4597 static void set_font(ScintillaObject
*sci
, const gchar
*font
)
4601 PangoFontDescription
*pfd
;
4604 g_return_if_fail(sci
);
4606 pfd
= pango_font_description_from_string(font
);
4607 size
= pango_font_description_get_size(pfd
) / (gdouble
) PANGO_SCALE
;
4608 font_name
= g_strdup_printf("!%s", pango_font_description_get_family(pfd
));
4609 pango_font_description_free(pfd
);
4611 for (style
= 0; style
<= STYLE_MAX
; style
++)
4612 sci_set_font_fractional(sci
, style
, font_name
, size
);
4618 void editor_set_font(GeanyEditor
*editor
, const gchar
*font
)
4620 g_return_if_fail(editor
);
4622 set_font(editor
->sci
, font
);
4623 update_margins(editor
->sci
);
4624 /* zoom to 100% to prevent confusion */
4625 sci_zoom_off(editor
->sci
);
4629 void editor_set_line_wrapping(GeanyEditor
*editor
, gboolean wrap
)
4631 g_return_if_fail(editor
!= NULL
);
4633 editor
->line_wrapping
= wrap
;
4634 sci_set_lines_wrapped(editor
->sci
, wrap
);
4638 /** Sets the indent type for @a editor.
4639 * @param editor Editor.
4640 * @param type Indent type.
4645 void editor_set_indent_type(GeanyEditor
*editor
, GeanyIndentType type
)
4647 editor_set_indent(editor
, type
, editor
->indent_width
);
4651 /** Sets the indent width for @a editor.
4652 * @param editor Editor.
4653 * @param width New indent width.
4655 * @since 1.27 (API 227)
4658 void editor_set_indent_width(GeanyEditor
*editor
, gint width
)
4660 editor_set_indent(editor
, editor
->indent_type
, width
);
4664 void editor_set_indent(GeanyEditor
*editor
, GeanyIndentType type
, gint width
)
4666 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
4667 ScintillaObject
*sci
= editor
->sci
;
4668 gboolean use_tabs
= type
!= GEANY_INDENT_TYPE_SPACES
;
4670 editor
->indent_type
= type
;
4671 editor
->indent_width
= width
;
4672 sci_set_use_tabs(sci
, use_tabs
);
4674 if (type
== GEANY_INDENT_TYPE_BOTH
)
4676 sci_set_tab_width(sci
, iprefs
->hard_tab_width
);
4677 if (iprefs
->hard_tab_width
!= 8)
4679 static gboolean warn
= TRUE
;
4681 ui_set_statusbar(TRUE
, _("Warning: non-standard hard tab width: %d != 8!"),
4682 iprefs
->hard_tab_width
);
4687 sci_set_tab_width(sci
, width
);
4689 SSM(sci
, SCI_SETINDENT
, width
, 0);
4691 /* remove indent spaces on backspace, if using any spaces to indent */
4692 SSM(sci
, SCI_SETBACKSPACEUNINDENTS
, editor_prefs
.backspace_unindent
&& (type
!= GEANY_INDENT_TYPE_TABS
), 0);
4696 /* Convenience function for editor_goto_pos() to pass a line number.
4697 * line_no is 1 based */
4698 gboolean
editor_goto_line(GeanyEditor
*editor
, gint line_no
, gboolean offset
)
4700 g_return_val_if_fail(editor
, FALSE
);
4701 gint line_count
= sci_get_line_count(editor
->sci
);
4704 line_no
+= sci_get_current_line(editor
->sci
) + 1;
4706 /* ensure line_no is in bounds and determine whether to set line marker */
4707 gboolean set_marker
= line_no
> 0 && line_no
< line_count
;
4708 line_no
= line_no
<= 0 ? 0
4709 : line_no
>= line_count
? line_count
- 1
4712 gint pos
= sci_get_position_from_line(editor
->sci
, line_no
);
4713 return editor_goto_pos(editor
, pos
, set_marker
);
4717 /** Moves to position @a pos, switching to the document if necessary,
4718 * setting a marker if @a mark is set.
4720 * @param editor Editor.
4721 * @param pos The position.
4722 * @param mark Whether to set a mark on the position.
4723 * @return @c TRUE if action has been performed, otherwise @c FALSE.
4728 gboolean
editor_goto_pos(GeanyEditor
*editor
, gint pos
, gboolean mark
)
4730 g_return_val_if_fail(editor
, FALSE
);
4731 if (G_UNLIKELY(pos
< 0))
4736 gint line
= sci_get_line_from_position(editor
->sci
, pos
);
4738 /* mark the tag with the yellow arrow */
4739 sci_marker_delete_all(editor
->sci
, 0);
4740 sci_set_marker_at_line(editor
->sci
, line
, 0);
4743 sci_goto_pos(editor
->sci
, pos
, TRUE
);
4744 editor
->scroll_percent
= 0.25F
;
4746 /* switch to the page, via idle callback in case of batch-opening */
4747 if (main_status
.opening_session_files
)
4748 document_show_tab_idle(editor
->document
);
4750 document_show_tab(editor
->document
);
4757 on_editor_scroll_event(GtkWidget
*widget
, GdkEventScroll
*event
, gpointer user_data
)
4759 GeanyEditor
*editor
= user_data
;
4761 /* we only handle up and down, leave the rest to Scintilla */
4762 if (event
->direction
!= GDK_SCROLL_UP
&& event
->direction
!= GDK_SCROLL_DOWN
)
4765 /* Handle scroll events if Alt is pressed and scroll whole pages instead of a
4766 * few lines only, maybe this could/should be done in Scintilla directly */
4767 if (event
->state
& GDK_MOD1_MASK
)
4769 sci_send_command(editor
->sci
, (event
->direction
== GDK_SCROLL_DOWN
) ? SCI_PAGEDOWN
: SCI_PAGEUP
);
4772 else if (event
->state
& GDK_SHIFT_MASK
)
4774 gint amount
= (event
->direction
== GDK_SCROLL_DOWN
) ? 8 : -8;
4776 sci_scroll_columns(editor
->sci
, amount
);
4780 return FALSE
; /* let Scintilla handle all other cases */
4784 static gboolean
editor_check_colourise(GeanyEditor
*editor
)
4786 GeanyDocument
*doc
= editor
->document
;
4788 if (!doc
->priv
->colourise_needed
)
4791 doc
->priv
->colourise_needed
= FALSE
;
4792 sci_colourise(editor
->sci
, 0, -1);
4794 /* now that the current document is colourised, fold points are now accurate,
4795 * so force an update of the current function/tag. */
4796 symbols_get_current_function(NULL
, NULL
);
4797 ui_update_statusbar(NULL
, -1);
4803 /* We only want to colourise just before drawing, to save startup time and
4804 * prevent unnecessary recolouring other documents after one is saved.
4805 * Really we want a "draw" signal but there doesn't seem to be one (expose is too late,
4806 * and "show" doesn't work). */
4807 static gboolean
on_editor_focus_in(GtkWidget
*widget
, GdkEventFocus
*event
, gpointer user_data
)
4809 GeanyEditor
*editor
= user_data
;
4811 editor_check_colourise(editor
);
4816 static gboolean
on_editor_draw(GtkWidget
*widget
, cairo_t
*cr
, gpointer user_data
)
4818 GeanyEditor
*editor
= user_data
;
4820 /* This is just to catch any uncolourised documents being drawn that didn't receive focus
4821 * for some reason, maybe it's not necessary but just in case. */
4822 editor_check_colourise(editor
);
4827 static void setup_sci_keys(ScintillaObject
*sci
)
4829 /* disable some Scintilla keybindings to be able to redefine them cleanly */
4830 sci_clear_cmdkey(sci
, 'A' | (SCMOD_CTRL
<< 16)); /* select all */
4831 sci_clear_cmdkey(sci
, 'D' | (SCMOD_CTRL
<< 16)); /* duplicate */
4832 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16)); /* line transpose */
4833 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line copy */
4834 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16)); /* line cut */
4835 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line delete */
4836 sci_clear_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to end delete */
4837 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to beginning delete */
4838 sci_clear_cmdkey(sci
, '/' | (SCMOD_CTRL
<< 16)); /* Previous word part */
4839 sci_clear_cmdkey(sci
, '\\' | (SCMOD_CTRL
<< 16)); /* Next word part */
4840 sci_clear_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16)); /* scroll line up */
4841 sci_clear_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16)); /* scroll line down */
4842 sci_clear_cmdkey(sci
, SCK_HOME
); /* line start */
4843 sci_clear_cmdkey(sci
, SCK_END
); /* line end */
4844 sci_clear_cmdkey(sci
, SCK_END
| (SCMOD_ALT
<< 16)); /* visual line end */
4846 if (editor_prefs
.use_gtk_word_boundaries
)
4848 /* use GtkEntry-like word boundaries */
4849 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16), SCI_WORDRIGHTEND
);
4850 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_WORDRIGHTENDEXTEND
);
4851 sci_assign_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16), SCI_DELWORDRIGHTEND
);
4853 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_ALT
<< 16), SCI_LINESCROLLUP
);
4854 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_ALT
<< 16), SCI_LINESCROLLDOWN
);
4855 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16), SCI_PARAUP
);
4856 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARAUPEXTEND
);
4857 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16), SCI_PARADOWN
);
4858 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARADOWNEXTEND
);
4860 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_ALT
<< 16)); /* clear Alt-Backspace (Undo) */
4864 /* registers a Scintilla image from a named icon from the theme */
4865 static gboolean
register_named_icon(ScintillaObject
*sci
, guint id
, const gchar
*name
)
4867 GError
*error
= NULL
;
4869 gint n_channels
, rowstride
, width
, height
;
4872 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &size
, NULL
);
4873 pixbuf
= gtk_icon_theme_load_icon(gtk_icon_theme_get_default(), name
, size
, 0, &error
);
4876 g_warning("failed to load icon '%s': %s", name
, error
->message
);
4877 g_error_free(error
);
4881 n_channels
= gdk_pixbuf_get_n_channels(pixbuf
);
4882 rowstride
= gdk_pixbuf_get_rowstride(pixbuf
);
4883 width
= gdk_pixbuf_get_width(pixbuf
);
4884 height
= gdk_pixbuf_get_height(pixbuf
);
4886 if (gdk_pixbuf_get_bits_per_sample(pixbuf
) != 8 ||
4887 ! gdk_pixbuf_get_has_alpha(pixbuf
) ||
4889 rowstride
!= width
* n_channels
)
4891 g_warning("incompatible image data for icon '%s'", name
);
4892 g_object_unref(pixbuf
);
4896 SSM(sci
, SCI_RGBAIMAGESETWIDTH
, width
, 0);
4897 SSM(sci
, SCI_RGBAIMAGESETHEIGHT
, height
, 0);
4898 SSM(sci
, SCI_REGISTERRGBAIMAGE
, id
, (sptr_t
)gdk_pixbuf_get_pixels(pixbuf
));
4900 g_object_unref(pixbuf
);
4905 /* Create new editor widget (scintilla).
4906 * @note The @c "sci-notify" signal is connected separately. */
4907 static ScintillaObject
*create_new_sci(GeanyEditor
*editor
)
4909 ScintillaObject
*sci
;
4910 int rectangular_selection_modifier
;
4913 sci
= SCINTILLA(scintilla_new());
4915 /* Scintilla doesn't support RTL languages properly and is primarily
4916 * intended to be used with LTR source code, so override the
4917 * GTK+ default text direction for the Scintilla widget. */
4918 gtk_widget_set_direction(GTK_WIDGET(sci
), GTK_TEXT_DIR_LTR
);
4920 gtk_widget_show(GTK_WIDGET(sci
));
4922 sci_set_codepage(sci
, SC_CP_UTF8
);
4923 /*SSM(sci, SCI_SETWRAPSTARTINDENT, 4, 0);*/
4924 /* disable scintilla provided popup menu */
4925 sci_use_popup(sci
, FALSE
);
4927 setup_sci_keys(sci
);
4929 sci_set_lines_wrapped(sci
, editor
->line_wrapping
);
4930 sci_set_caret_policy_x(sci
, CARET_JUMPS
| CARET_EVEN
, 0);
4931 /* Y policy is set in editor_apply_update_prefs() */
4932 SSM(sci
, SCI_AUTOCSETSEPARATOR
, '\n', 0);
4933 SSM(sci
, SCI_SETSCROLLWIDTHTRACKING
, 1, 0);
4935 /* tag autocompletion images */
4936 for (i
= 0; i
< TM_N_ICONS
; i
++)
4938 const gchar
*icon_name
= symbols_get_icon_name(i
);
4939 register_named_icon(sci
, i
+ 1, icon_name
);
4942 /* necessary for column mode editing, implemented in Scintilla since 2.0 */
4943 SSM(sci
, SCI_SETADDITIONALSELECTIONTYPING
, 1, 0);
4945 /* rectangular selection modifier for creating rectangular selections with the mouse.
4946 * We use the historical Scintilla values by default. */
4948 rectangular_selection_modifier
= SCMOD_ALT
;
4950 rectangular_selection_modifier
= SCMOD_CTRL
;
4952 SSM(sci
, SCI_SETRECTANGULARSELECTIONMODIFIER
, rectangular_selection_modifier
, 0);
4955 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
4957 /* input method editor's candidate window behaviour */
4958 SSM(sci
, SCI_SETIMEINTERACTION
, editor_prefs
.ime_interaction
, 0);
4960 /* only connect signals if this is for the document notebook, not split window */
4961 if (editor
->sci
== NULL
)
4963 g_signal_connect(sci
, "button-press-event", G_CALLBACK(on_editor_button_press_event
), editor
);
4964 g_signal_connect(sci
, "scroll-event", G_CALLBACK(on_editor_scroll_event
), editor
);
4965 g_signal_connect(sci
, "motion-notify-event", G_CALLBACK(on_motion_event
), NULL
);
4966 g_signal_connect(sci
, "focus-in-event", G_CALLBACK(on_editor_focus_in
), editor
);
4967 g_signal_connect(sci
, "draw", G_CALLBACK(on_editor_draw
), editor
);
4973 /** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
4974 * @param editor Editor settings.
4975 * @return @transfer{floating} The new widget.
4980 ScintillaObject
*editor_create_widget(GeanyEditor
*editor
)
4982 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4983 ScintillaObject
*old
, *sci
;
4984 GeanyIndentType old_indent_type
= editor
->indent_type
;
4985 gint old_indent_width
= editor
->indent_width
;
4987 /* temporarily change editor to use the new sci widget */
4989 sci
= create_new_sci(editor
);
4992 editor_set_indent(editor
, iprefs
->type
, iprefs
->width
);
4993 set_font(editor
->sci
, interface_prefs
.editor_font
);
4994 editor_apply_update_prefs(editor
);
4996 /* if editor already had a widget, restore it */
4999 editor
->indent_type
= old_indent_type
;
5000 editor
->indent_width
= old_indent_width
;
5007 GeanyEditor
*editor_create(GeanyDocument
*doc
)
5009 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
5010 GeanyEditor
*editor
= g_new0(GeanyEditor
, 1);
5012 editor
->document
= doc
;
5013 doc
->editor
= editor
; /* needed in case some editor functions/callbacks expect it */
5015 editor
->auto_indent
= (iprefs
->auto_indent_mode
!= GEANY_AUTOINDENT_NONE
);
5016 editor
->line_wrapping
= get_project_pref(line_wrapping
);
5017 editor
->scroll_percent
= -1.0F
;
5018 editor
->line_breaking
= FALSE
;
5020 editor
->sci
= editor_create_widget(editor
);
5025 /* in case we need to free some fields in future */
5026 void editor_destroy(GeanyEditor
*editor
)
5032 static void on_document_save(GObject
*obj
, GeanyDocument
*doc
)
5034 gchar
*f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
5036 if (utils_str_equal(doc
->real_path
, f
))
5038 /* reload snippets */
5039 editor_snippets_free();
5040 editor_snippets_init();
5046 gboolean
editor_complete_word_part(GeanyEditor
*editor
)
5050 g_return_val_if_fail(editor
, FALSE
);
5052 if (!SSM(editor
->sci
, SCI_AUTOCACTIVE
, 0, 0))
5055 entry
= sci_get_string(editor
->sci
, SCI_AUTOCGETCURRENTTEXT
, 0);
5057 /* if no word part, complete normally */
5058 if (!check_partial_completion(editor
, entry
))
5059 SSM(editor
->sci
, SCI_AUTOCCOMPLETE
, 0, 0);
5066 void editor_init(void)
5068 static GeanyIndentPrefs indent_prefs
;
5071 memset(&editor_prefs
, 0, sizeof(GeanyEditorPrefs
));
5072 memset(&indent_prefs
, 0, sizeof(GeanyIndentPrefs
));
5073 editor_prefs
.indentation
= &indent_prefs
;
5075 /* use g_signal_connect_after() to allow plugins connecting to the signal before the default
5076 * handler (on_editor_notify) is called */
5077 g_signal_connect_after(geany_object
, "editor-notify", G_CALLBACK(on_editor_notify
), NULL
);
5079 f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
5080 ui_add_config_file_menu_item(f
, NULL
, NULL
);
5082 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
5086 /* TODO: Should these be user-defined instead of hard-coded? */
5087 void editor_set_indentation_guides(GeanyEditor
*editor
)
5092 g_return_if_fail(editor
!= NULL
);
5094 if (! editor_prefs
.show_indent_guide
)
5096 sci_set_indentation_guides(editor
->sci
, SC_IV_NONE
);
5100 lexer
= sci_get_lexer(editor
->sci
);
5103 /* Lines added/removed are prefixed with +/- characters, so
5104 * those lines will not be shown with any indentation guides.
5105 * It can be distracting that only a few of lines in a diff/patch
5106 * file will show the guides. */
5111 /* These languages use indentation for control blocks; the "look forward" method works
5115 case SCLEX_MAKEFILE
:
5119 case SCLEX_PROPERTIES
:
5120 case SCLEX_FORTRAN
: /* Is this the best option for Fortran? */
5122 mode
= SC_IV_LOOKFORWARD
;
5125 /* C-like (structured) languages benefit from the "look both" method */
5128 case SCLEX_PHPSCRIPT
:
5140 case SCLEX_FREEBASIC
:
5144 mode
= SC_IV_LOOKBOTH
;
5152 sci_set_indentation_guides(editor
->sci
, mode
);
5156 /* Apply non-document prefs that can change in the Preferences dialog */
5157 void editor_apply_update_prefs(GeanyEditor
*editor
)
5159 ScintillaObject
*sci
;
5162 g_return_if_fail(editor
!= NULL
);
5164 if (main_status
.quitting
)
5169 sci_set_mark_long_lines(sci
, editor_get_long_line_type(),
5170 editor_get_long_line_column(), editor_prefs
.long_line_color
);
5172 /* update indent width, tab width */
5173 editor_set_indent(editor
, editor
->indent_type
, editor
->indent_width
);
5174 sci_set_tab_indents(sci
, editor_prefs
.use_tab_to_indent
);
5176 sci_assign_cmdkey(sci
, SCK_HOME
| (SCMOD_SHIFT
<< 16),
5177 editor_prefs
.smart_home_key
? SCI_VCHOMEEXTEND
: SCI_HOMEEXTEND
);
5178 sci_assign_cmdkey(sci
, SCK_HOME
| ((SCMOD_SHIFT
| SCMOD_ALT
) << 16),
5179 editor_prefs
.smart_home_key
? SCI_VCHOMERECTEXTEND
: SCI_HOMERECTEXTEND
);
5181 sci_set_autoc_max_height(sci
, editor_prefs
.symbolcompletion_max_height
);
5182 SSM(sci
, SCI_AUTOCSETDROPRESTOFWORD
, editor_prefs
.completion_drops_rest_of_word
, 0);
5184 editor_set_indentation_guides(editor
);
5186 sci_set_visible_white_spaces(sci
, editor_prefs
.show_white_space
);
5187 sci_set_visible_eols(sci
, editor_prefs
.show_line_endings
);
5188 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
5189 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
5190 sci_set_eol_representation_characters(sci
, sci_get_eol_mode(sci
));
5192 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
5195 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
5197 /* Change history */
5198 guint change_history_mask
;
5199 change_history_mask
= SC_CHANGE_HISTORY_DISABLED
;
5200 if (editor_prefs
.change_history_markers
)
5201 change_history_mask
|= SC_CHANGE_HISTORY_ENABLED
|SC_CHANGE_HISTORY_MARKERS
;
5202 if (editor_prefs
.change_history_indicators
)
5203 change_history_mask
|= SC_CHANGE_HISTORY_ENABLED
|SC_CHANGE_HISTORY_INDICATORS
;
5204 SSM(sci
, SCI_SETCHANGEHISTORY
, change_history_mask
, 0);
5206 /* caret Y policy */
5207 caret_y_policy
= CARET_EVEN
;
5208 if (editor_prefs
.scroll_lines_around_cursor
> 0)
5209 caret_y_policy
|= CARET_SLOP
| CARET_STRICT
;
5210 sci_set_caret_policy_y(sci
, caret_y_policy
, editor_prefs
.scroll_lines_around_cursor
);
5212 /* (dis)allow scrolling past end of document */
5213 sci_set_scroll_stop_at_last_line(sci
, editor_prefs
.scroll_stop_at_last_line
);
5215 sci_set_scrollbar_mode(sci
, editor_prefs
.show_scrollbars
);
5219 /* This is for tab-indents, space aligns formatted code. Spaces should be preserved. */
5220 static void change_tab_indentation(GeanyEditor
*editor
, gint line
, gboolean increase
)
5222 ScintillaObject
*sci
= editor
->sci
;
5223 gint pos
= sci_get_position_from_line(sci
, line
);
5227 sci_insert_text(sci
, pos
, "\t");
5231 if (sci_get_char_at(sci
, pos
) == '\t')
5233 sci_set_selection(sci
, pos
, pos
+ 1);
5234 sci_replace_sel(sci
, "");
5236 else /* remove spaces only if no tabs */
5238 gint width
= sci_get_line_indentation(sci
, line
);
5240 width
-= editor_get_indent_prefs(editor
)->width
;
5241 sci_set_line_indentation(sci
, line
, width
);
5247 static void editor_change_line_indent(GeanyEditor
*editor
, gint line
, gboolean increase
)
5249 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
5250 ScintillaObject
*sci
= editor
->sci
;
5252 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
)
5253 change_tab_indentation(editor
, line
, increase
);
5256 gint width
= sci_get_line_indentation(sci
, line
);
5258 width
+= increase
? iprefs
->width
: -iprefs
->width
;
5259 sci_set_line_indentation(sci
, line
, width
);
5264 void editor_indent(GeanyEditor
*editor
, gboolean increase
)
5266 ScintillaObject
*sci
= editor
->sci
;
5267 gint caret_pos
, caret_line
, caret_offset
, caret_indent_pos
, caret_line_len
;
5268 gint anchor_pos
, anchor_line
, anchor_offset
, anchor_indent_pos
, anchor_line_len
;
5270 /* backup information needed to restore caret and anchor */
5271 caret_pos
= sci_get_current_position(sci
);
5272 anchor_pos
= SSM(sci
, SCI_GETANCHOR
, 0, 0);
5273 caret_line
= sci_get_line_from_position(sci
, caret_pos
);
5274 anchor_line
= sci_get_line_from_position(sci
, anchor_pos
);
5275 caret_offset
= caret_pos
- sci_get_position_from_line(sci
, caret_line
);
5276 anchor_offset
= anchor_pos
- sci_get_position_from_line(sci
, anchor_line
);
5277 caret_indent_pos
= sci_get_line_indent_position(sci
, caret_line
);
5278 anchor_indent_pos
= sci_get_line_indent_position(sci
, anchor_line
);
5279 caret_line_len
= sci_get_line_length(sci
, caret_line
);
5280 anchor_line_len
= sci_get_line_length(sci
, anchor_line
);
5282 if (sci_get_lines_selected(sci
) <= 1)
5284 editor_change_line_indent(editor
, sci_get_current_line(sci
), increase
);
5289 gint line
, lstart
, lend
;
5291 editor_select_lines(editor
, FALSE
);
5292 start
= sci_get_selection_start(sci
);
5293 end
= sci_get_selection_end(sci
);
5294 lstart
= sci_get_line_from_position(sci
, start
);
5295 lend
= sci_get_line_from_position(sci
, end
);
5296 if (end
== sci_get_length(sci
))
5297 lend
++; /* for last line with text on it */
5299 sci_start_undo_action(sci
);
5300 for (line
= lstart
; line
< lend
; line
++)
5302 editor_change_line_indent(editor
, line
, increase
);
5304 sci_end_undo_action(sci
);
5307 /* restore caret and anchor position */
5308 if (caret_pos
>= caret_indent_pos
)
5309 caret_offset
+= sci_get_line_length(sci
, caret_line
) - caret_line_len
;
5310 if (anchor_pos
>= anchor_indent_pos
)
5311 anchor_offset
+= sci_get_line_length(sci
, anchor_line
) - anchor_line_len
;
5313 SSM(sci
, SCI_SETCURRENTPOS
, sci_get_position_from_line(sci
, caret_line
) + caret_offset
, 0);
5314 SSM(sci
, SCI_SETANCHOR
, sci_get_position_from_line(sci
, anchor_line
) + anchor_offset
, 0);
5318 /** Gets snippet by name.
5320 * If @a editor is passed, returns a snippet specific to the document filetype.
5321 * If @a editor is @c NULL, returns a snippet from the default set.
5323 * @param editor @nullable Editor or @c NULL.
5324 * @param snippet_name Snippet name.
5325 * @return @nullable snippet or @c NULL if it was not found. Must not be freed.
5328 const gchar
*editor_find_snippet(GeanyEditor
*editor
, const gchar
*snippet_name
)
5330 const gchar
*subhash_name
= editor
? editor
->document
->file_type
->name
: "Default";
5331 GHashTable
*subhash
= g_hash_table_lookup(snippet_hash
, subhash_name
);
5333 return subhash
? g_hash_table_lookup(subhash
, snippet_name
) : NULL
;
5337 /** Replaces all special sequences in @a snippet and inserts it at @a pos.
5338 * If you insert at the current position, consider calling @c sci_scroll_caret()
5339 * after this function.
5345 void editor_insert_snippet(GeanyEditor
*editor
, gint pos
, const gchar
*snippet
)
5349 pattern
= g_string_new(snippet
);
5350 snippets_make_replacements(editor
, pattern
);
5351 editor_insert_text_block(editor
, pattern
->str
, pos
, -1, -1, TRUE
);
5352 g_string_free(pattern
, TRUE
);
5355 static void *copy_(void *src
) { return src
; }
5356 static void free_(void *doc
) { }
5359 * Gets the GType of GeanyEditor
5361 * @return the GeanyEditor type */
5363 GType
editor_get_type (void);
5365 G_DEFINE_BOXED_TYPE(GeanyEditor
, editor
, copy_
, free_
);