2 * editor.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
6 * Copyright 2009-2012 Frank Lanitz <frank(at)frank(dot)uvena(dot)de>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * Editor-related functions for @ref GeanyEditor.
26 * Geany uses the Scintilla editing widget, and this file is mostly built around
27 * Scintilla's functionality.
30 /* Callbacks for the Scintilla widget (ScintillaObject).
31 * Most important is the sci-notify callback, handled in on_editor_notification().
32 * This includes auto-indentation, comments, auto-completion, calltips, etc.
33 * Also some general Scintilla-related functions.
43 #include "callbacks.h"
45 #include "documentprivate.h"
46 #include "filetypesprivate.h"
47 #include "geanyobject.h"
48 #include "highlighting.h"
49 #include "keybindings.h"
52 #include "projectprivate.h"
53 #include "sciwrappers.h"
56 #include "templates.h"
62 #include "gtkcompat.h"
67 #include <gdk/gdkkeysyms.h>
70 /* Note: use sciwrappers.h instead where possible.
71 * Do not use SSM in files unrelated to scintilla. */
72 #define SSM(s, m, w, l) scintilla_send_message(s, m, w, l)
74 static GHashTable
*snippet_hash
= NULL
;
75 static GQueue
*snippet_offsets
= NULL
;
76 static gint snippet_cursor_insert_pos
;
77 static GtkAccelGroup
*snippet_accel_group
= NULL
;
78 static gboolean autocomplete_scope_shown
= FALSE
;
80 static const gchar geany_cursor_marker
[] = "__GEANY_CURSOR_MARKER__";
82 /* holds word under the mouse or keyboard cursor */
83 static gchar current_word
[GEANY_MAX_WORD_LENGTH
];
85 /* Initialised in keyfile.c. */
86 GeanyEditorPrefs editor_prefs
;
88 EditorInfo editor_info
= {current_word
, -1};
98 } calltip
= {NULL
, FALSE
, NULL
, 0, 0, NULL
};
100 static gchar indent
[100];
103 static void on_new_line_added(GeanyEditor
*editor
);
104 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
);
105 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
);
106 static void auto_multiline(GeanyEditor
*editor
, gint pos
);
107 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
);
108 static void close_block(GeanyEditor
*editor
, gint pos
);
109 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
);
110 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
111 const gchar
*wc
, gboolean stem
);
112 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
);
113 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
);
114 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
);
115 static gssize
replace_cursor_markers(GeanyEditor
*editor
, GString
*pattern
);
116 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
);
117 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
);
120 void editor_snippets_free(void)
122 g_hash_table_destroy(snippet_hash
);
123 g_queue_free(snippet_offsets
);
124 gtk_window_remove_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
128 static void snippets_load(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
130 gsize i
, j
, len
= 0, len_keys
= 0;
131 gchar
**groups_user
, **groups_sys
;
132 gchar
**keys_user
, **keys_sys
;
136 /* keys are strings, values are GHashTables, so use g_free and g_hash_table_destroy */
138 g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, (GDestroyNotify
) g_hash_table_destroy
);
140 /* first read all globally defined auto completions */
141 groups_sys
= g_key_file_get_groups(sysconfig
, &len
);
142 for (i
= 0; i
< len
; i
++)
144 if (strcmp(groups_sys
[i
], "Keybindings") == 0)
146 keys_sys
= g_key_file_get_keys(sysconfig
, groups_sys
[i
], &len_keys
, NULL
);
147 /* create new hash table for the read section (=> filetype) */
148 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
149 g_hash_table_insert(snippet_hash
, g_strdup(groups_sys
[i
]), tmp
);
151 for (j
= 0; j
< len_keys
; j
++)
153 g_hash_table_insert(tmp
, g_strdup(keys_sys
[j
]),
154 utils_get_setting_string(sysconfig
, groups_sys
[i
], keys_sys
[j
], ""));
156 g_strfreev(keys_sys
);
158 g_strfreev(groups_sys
);
160 /* now read defined completions in user's configuration directory and add / replace them */
161 groups_user
= g_key_file_get_groups(userconfig
, &len
);
162 for (i
= 0; i
< len
; i
++)
164 if (strcmp(groups_user
[i
], "Keybindings") == 0)
166 keys_user
= g_key_file_get_keys(userconfig
, groups_user
[i
], &len_keys
, NULL
);
168 tmp
= g_hash_table_lookup(snippet_hash
, groups_user
[i
]);
170 { /* new key found, create hash table */
171 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
172 g_hash_table_insert(snippet_hash
, g_strdup(groups_user
[i
]), tmp
);
174 for (j
= 0; j
< len_keys
; j
++)
176 value
= g_hash_table_lookup(tmp
, keys_user
[j
]);
178 { /* value = NULL means the key doesn't yet exist, so insert */
179 g_hash_table_insert(tmp
, g_strdup(keys_user
[j
]),
180 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
183 { /* old key and value will be freed by destroy function (g_free) */
184 g_hash_table_replace(tmp
, g_strdup(keys_user
[j
]),
185 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
188 g_strfreev(keys_user
);
190 g_strfreev(groups_user
);
194 static void on_snippet_keybinding_activate(gchar
*key
)
196 GeanyDocument
*doc
= document_get_current();
198 GHashTable
*specials
;
200 if (!doc
|| !gtk_widget_has_focus(GTK_WIDGET(doc
->editor
->sci
)))
203 s
= snippets_find_completion_by_name(doc
->file_type
->name
, key
);
204 if (!s
) /* allow user to specify keybindings for "special" snippets */
206 specials
= g_hash_table_lookup(snippet_hash
, "Special");
207 if (G_LIKELY(specials
!= NULL
))
208 s
= g_hash_table_lookup(specials
, key
);
216 editor_insert_snippet(doc
->editor
, sci_get_current_position(doc
->editor
->sci
), s
);
217 sci_scroll_caret(doc
->editor
->sci
);
221 static void add_kb(GKeyFile
*keyfile
, const gchar
*group
, gchar
**keys
)
227 for (i
= 0; i
< g_strv_length(keys
); i
++)
230 GdkModifierType mods
;
231 gchar
*accel_string
= g_key_file_get_value(keyfile
, group
, keys
[i
], NULL
);
233 gtk_accelerator_parse(accel_string
, &key
, &mods
);
234 g_free(accel_string
);
236 if (key
== 0 && mods
== 0)
238 g_warning("Can not parse accelerator \"%s\" from user snippets.conf", accel_string
);
241 gtk_accel_group_connect(snippet_accel_group
, key
, mods
, 0,
242 g_cclosure_new_swap((GCallback
)on_snippet_keybinding_activate
,
243 g_strdup(keys
[i
]), (GClosureNotify
)g_free
));
248 static void load_kb(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
250 const gchar kb_group
[] = "Keybindings";
251 gchar
**keys
= g_key_file_get_keys(userconfig
, kb_group
, NULL
, NULL
);
254 /* remove overridden keys from system keyfile */
255 foreach_strv(ptr
, keys
)
256 g_key_file_remove_key(sysconfig
, kb_group
, *ptr
, NULL
);
258 add_kb(userconfig
, kb_group
, keys
);
261 keys
= g_key_file_get_keys(sysconfig
, kb_group
, NULL
, NULL
);
262 add_kb(sysconfig
, kb_group
, keys
);
267 void editor_snippets_init(void)
269 gchar
*sysconfigfile
, *userconfigfile
;
270 GKeyFile
*sysconfig
= g_key_file_new();
271 GKeyFile
*userconfig
= g_key_file_new();
273 snippet_offsets
= g_queue_new();
275 sysconfigfile
= g_build_filename(app
->datadir
, "snippets.conf", NULL
);
276 userconfigfile
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
278 /* check for old autocomplete.conf files (backwards compatibility) */
279 if (! g_file_test(userconfigfile
, G_FILE_TEST_IS_REGULAR
))
280 SETPTR(userconfigfile
, g_build_filename(app
->configdir
, "autocomplete.conf", NULL
));
282 /* load the actual config files */
283 g_key_file_load_from_file(sysconfig
, sysconfigfile
, G_KEY_FILE_NONE
, NULL
);
284 g_key_file_load_from_file(userconfig
, userconfigfile
, G_KEY_FILE_NONE
, NULL
);
286 snippets_load(sysconfig
, userconfig
);
288 /* setup snippet keybindings */
289 snippet_accel_group
= gtk_accel_group_new();
290 gtk_window_add_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
291 load_kb(sysconfig
, userconfig
);
293 g_free(sysconfigfile
);
294 g_free(userconfigfile
);
295 g_key_file_free(sysconfig
);
296 g_key_file_free(userconfig
);
300 static gboolean
on_editor_button_press_event(GtkWidget
*widget
, GdkEventButton
*event
,
303 GeanyEditor
*editor
= data
;
304 GeanyDocument
*doc
= editor
->document
;
306 /* it's very unlikely we got a 'real' click even on 0, 0, so assume it is a
307 * fake event to show the editor menu triggered by a key event where we want to use the
308 * text cursor position. */
309 if (event
->x
> 0.0 && event
->y
> 0.0)
310 editor_info
.click_pos
= sci_get_position_from_xy(editor
->sci
,
311 (gint
)event
->x
, (gint
)event
->y
, FALSE
);
313 editor_info
.click_pos
= sci_get_current_position(editor
->sci
);
315 if (event
->button
== 1)
317 guint state
= keybindings_get_modifiers(event
->state
);
319 if (event
->type
== GDK_BUTTON_PRESS
&& editor_prefs
.disable_dnd
)
321 gint ss
= sci_get_selection_start(editor
->sci
);
322 sci_set_selection_end(editor
->sci
, ss
);
324 if (event
->type
== GDK_BUTTON_PRESS
&& state
== GEANY_PRIMARY_MOD_MASK
)
326 sci_set_current_position(editor
->sci
, editor_info
.click_pos
, FALSE
);
328 editor_find_current_word(editor
, editor_info
.click_pos
,
329 current_word
, sizeof current_word
, NULL
);
331 return symbols_goto_tag(current_word
, TRUE
);
333 keybindings_send_command(GEANY_KEY_GROUP_GOTO
, GEANY_KEYS_GOTO_MATCHINGBRACE
);
336 return document_check_disk_status(doc
, FALSE
);
339 /* calls the edit popup menu in the editor */
340 if (event
->button
== 3)
344 /* ensure the editor widget has the focus after this operation */
345 gtk_widget_grab_focus(widget
);
347 editor_find_current_word(editor
, editor_info
.click_pos
,
348 current_word
, sizeof current_word
, NULL
);
350 can_goto
= sci_has_selection(editor
->sci
) || current_word
[0] != '\0';
351 ui_update_popup_goto_items(can_goto
);
352 ui_update_popup_copy_items(doc
);
353 ui_update_insert_include_item(doc
, 0);
355 g_signal_emit_by_name(geany_object
, "update-editor-menu",
356 current_word
, editor_info
.click_pos
, doc
);
358 gtk_menu_popup(GTK_MENU(main_widgets
.editor_menu
),
359 NULL
, NULL
, NULL
, NULL
, event
->button
, event
->time
);
367 static gboolean
is_style_php(gint style
)
369 if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
370 style
== SCE_HPHP_COMPLEX_VARIABLE
)
379 static gint
editor_get_long_line_type(void)
382 switch (app
->project
->priv
->long_line_behaviour
)
384 case 0: /* marker disabled */
386 case 1: /* use global settings */
388 case 2: /* custom (enabled) */
389 return editor_prefs
.long_line_type
;
392 if (!editor_prefs
.long_line_enabled
)
395 return editor_prefs
.long_line_type
;
399 static gint
editor_get_long_line_column(void)
401 if (app
->project
&& app
->project
->priv
->long_line_behaviour
!= 1 /* use global settings */)
402 return app
->project
->priv
->long_line_column
;
404 return editor_prefs
.long_line_column
;
408 #define get_project_pref(id)\
409 (app->project ? app->project->priv->id : editor_prefs.id)
411 static const GeanyEditorPrefs
*
412 get_default_prefs(void)
414 static GeanyEditorPrefs eprefs
;
416 eprefs
= editor_prefs
;
418 /* project overrides */
419 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(NULL
);
420 eprefs
.long_line_type
= editor_get_long_line_type();
421 eprefs
.long_line_column
= editor_get_long_line_column();
422 eprefs
.line_wrapping
= get_project_pref(line_wrapping
);
423 eprefs
.line_break_column
= get_project_pref(line_break_column
);
424 eprefs
.auto_continue_multiline
= get_project_pref(auto_continue_multiline
);
429 /* Gets the prefs for the editor.
430 * Prefs can be different according to project or document.
431 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
432 * settings may have changed, or if this function has been called for a different editor.
433 * @param editor The editor, or @c NULL to get the default prefs.
434 * @return The prefs. */
435 const GeanyEditorPrefs
*editor_get_prefs(GeanyEditor
*editor
)
437 static GeanyEditorPrefs eprefs
;
438 const GeanyEditorPrefs
*dprefs
= get_default_prefs();
440 /* Return the address of the default prefs to allow returning default and editor
441 * pref pointers without invalidating the contents of either. */
446 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(editor
);
447 /* add other editor & document overrides as needed */
452 void editor_toggle_fold(GeanyEditor
*editor
, gint line
, gint modifiers
)
454 ScintillaObject
*sci
;
457 g_return_if_fail(editor
!= NULL
);
460 /* When collapsing a fold range whose starting line is offscreen,
461 * scroll the starting line to display at the top of the view.
462 * Otherwise it can be confusing when the document scrolls down to hide
463 * the folded lines. */
464 if ((sci_get_fold_level(sci
, line
) & SC_FOLDLEVELNUMBERMASK
) > SC_FOLDLEVELBASE
&&
465 !(sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
))
467 gint parent
= sci_get_fold_parent(sci
, line
);
468 gint first
= sci_get_first_visible_line(sci
);
470 parent
= SSM(sci
, SCI_VISIBLEFROMDOCLINE
, parent
, 0);
472 SSM(sci
, SCI_SETFIRSTVISIBLELINE
, parent
, 0);
475 /* find the fold header of the given line in case the one clicked isn't a fold point */
476 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
479 header
= sci_get_fold_parent(sci
, line
);
481 if ((editor_prefs
.unfold_all_children
&& ! (modifiers
& SCMOD_SHIFT
)) ||
482 (! editor_prefs
.unfold_all_children
&& (modifiers
& SCMOD_SHIFT
)))
484 SSM(sci
, SCI_FOLDCHILDREN
, header
, SC_FOLDACTION_TOGGLE
);
488 SSM(sci
, SCI_FOLDLINE
, header
, SC_FOLDACTION_TOGGLE
);
493 static void on_margin_click(GeanyEditor
*editor
, SCNotification
*nt
)
495 /* left click to marker margin marks the line */
498 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
500 /*sci_marker_delete_all(editor->sci, 1);*/
501 sci_toggle_marker_at_line(editor
->sci
, line
, 1); /* toggle the marker */
503 /* left click on the folding margin to toggle folding state of current line */
504 else if (nt
->margin
== 2 && editor_prefs
.folding
)
506 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
507 editor_toggle_fold(editor
, line
, nt
->modifiers
);
512 static void on_update_ui(GeanyEditor
*editor
, G_GNUC_UNUSED SCNotification
*nt
)
514 ScintillaObject
*sci
= editor
->sci
;
515 gint pos
= sci_get_current_position(sci
);
517 /* since Scintilla 2.24, SCN_UPDATEUI is also sent on scrolling though we don't need to handle
518 * this and so ignore every SCN_UPDATEUI events except for content and selection changes */
519 if (! (nt
->updated
& SC_UPDATE_CONTENT
) && ! (nt
->updated
& SC_UPDATE_SELECTION
))
522 /* undo / redo menu update */
523 ui_update_popup_reundo_items(editor
->document
);
525 /* brace highlighting */
526 editor_highlight_braces(editor
, pos
);
528 ui_update_statusbar(editor
->document
, pos
);
531 /** experimental code for inverting selections */
534 for (i
= SSM(sci
, SCI_GETSELECTIONSTART
, 0, 0); i
< SSM(sci
, SCI_GETSELECTIONEND
, 0, 0); i
++)
536 /* need to get colour from getstyleat(), but how? */
537 SSM(sci
, SCI_STYLESETFORE
, STYLE_DEFAULT
, 0);
538 SSM(sci
, SCI_STYLESETBACK
, STYLE_DEFAULT
, 0);
541 sci_get_style_at(sci
, pos
);
547 static void check_line_breaking(GeanyEditor
*editor
, gint pos
)
549 ScintillaObject
*sci
= editor
->sci
;
550 gint line
, lstart
, col
;
553 if (!editor
->line_breaking
)
556 col
= sci_get_col_from_position(sci
, pos
);
558 line
= sci_get_current_line(sci
);
560 lstart
= sci_get_position_from_line(sci
, line
);
562 /* use column instead of position which might be different with multibyte characters */
563 if (col
< get_project_pref(line_break_column
))
566 /* look for the last space before line_break_column */
567 pos
= MIN(pos
, lstart
+ get_project_pref(line_break_column
));
571 c
= sci_get_char_at(sci
, --pos
);
574 gint diff
, last_pos
, last_col
;
576 /* remember the distance between the current column and the last column on the line
577 * (we use column position in case the previous line gets altered, such as removing
578 * trailing spaces or in case it contains multibyte characters) */
579 last_pos
= sci_get_line_end_position(sci
, line
);
580 last_col
= sci_get_col_from_position(sci
, last_pos
);
581 diff
= last_col
- col
;
583 /* break the line after the space */
584 sci_set_current_position(sci
, pos
+ 1, FALSE
);
585 sci_cancel(sci
); /* don't select from completion list */
586 sci_send_command(sci
, SCI_NEWLINE
);
589 /* correct cursor position (might not be at line end) */
590 last_pos
= sci_get_line_end_position(sci
, line
);
591 last_col
= sci_get_col_from_position(sci
, last_pos
); /* get last column on line */
592 /* last column - distance is the desired column, then retrieve its document position */
593 pos
= sci_get_position_from_col(sci
, line
, last_col
- diff
);
594 sci_set_current_position(sci
, pos
, FALSE
);
595 sci_scroll_caret(sci
);
602 static void show_autocomplete(ScintillaObject
*sci
, gsize rootlen
, GString
*words
)
604 /* hide autocompletion if only option is already typed */
605 if (rootlen
>= words
->len
||
606 (words
->str
[rootlen
] == '?' && rootlen
>= words
->len
- 2))
608 sci_send_command(sci
, SCI_AUTOCCANCEL
);
611 /* store whether a calltip is showing, so we can reshow it after autocompletion */
612 calltip
.set
= (gboolean
) SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0);
613 SSM(sci
, SCI_AUTOCSHOW
, rootlen
, (sptr_t
) words
->str
);
617 static void show_tags_list(GeanyEditor
*editor
, const GPtrArray
*tags
, gsize rootlen
)
619 ScintillaObject
*sci
= editor
->sci
;
621 g_return_if_fail(tags
);
625 GString
*words
= g_string_sized_new(150);
628 for (j
= 0; j
< tags
->len
; ++j
)
630 TMTag
*tag
= tags
->pdata
[j
];
633 g_string_append_c(words
, '\n');
635 if (j
== editor_prefs
.autocompletion_max_entries
)
637 g_string_append(words
, "...");
640 g_string_append(words
, tag
->name
);
642 /* for now, tag types don't all follow C, so just look at arglist */
643 if (!EMPTY(tag
->arglist
))
644 g_string_append(words
, "?2");
646 g_string_append(words
, "?1");
648 show_autocomplete(sci
, rootlen
, words
);
649 g_string_free(words
, TRUE
);
654 /* do not use with long strings */
655 static gboolean
match_last_chars(ScintillaObject
*sci
, gint pos
, const gchar
*str
)
657 gsize len
= strlen(str
);
660 g_return_val_if_fail(len
< 100, FALSE
);
665 buf
= g_alloca(len
+ 1);
666 sci_get_text_range(sci
, pos
- len
, pos
, buf
);
667 return strcmp(str
, buf
) == 0;
671 static gboolean
reshow_calltip(gpointer data
)
675 g_return_val_if_fail(calltip
.sci
!= NULL
, FALSE
);
677 SSM(calltip
.sci
, SCI_CALLTIPCANCEL
, 0, 0);
678 doc
= document_get_current();
680 if (doc
&& doc
->editor
->sci
== calltip
.sci
)
682 /* we use the position where the calltip was previously started as SCI_GETCURRENTPOS
683 * may be completely wrong in case the user cancelled the auto completion with the mouse */
684 SSM(calltip
.sci
, SCI_CALLTIPSHOW
, calltip
.pos
, (sptr_t
) calltip
.text
);
690 static void request_reshowing_calltip(SCNotification
*nt
)
694 /* delay the reshow of the calltip window to make sure it is actually displayed,
695 * without it might be not visible on SCN_AUTOCCANCEL. the priority is set to
696 * low to hopefully make Scintilla's events happen before reshowing since they
697 * seem to re-cancel the calltip on autoc menu hiding too */
698 g_idle_add_full(G_PRIORITY_LOW
, reshow_calltip
, NULL
, NULL
);
703 static gboolean
autocomplete_scope(GeanyEditor
*editor
, const gchar
*root
, gsize rootlen
)
705 ScintillaObject
*sci
= editor
->sci
;
706 gint pos
= sci_get_current_position(editor
->sci
);
707 gchar typed
= sci_get_char_at(sci
, pos
- 1);
710 GeanyFiletype
*ft
= editor
->document
->file_type
;
712 gboolean function
= FALSE
;
714 gboolean ret
= FALSE
;
715 const gchar
*current_scope
;
716 const gchar
*context_sep
= tm_tag_context_separator(ft
->lang
);
718 if (autocomplete_scope_shown
)
720 /* move at the operator position */
723 /* allow for a space between word and operator */
724 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
728 typed
= sci_get_char_at(sci
, pos
- 1);
731 /* make sure to keep in sync with similar checks below */
734 else if (match_last_chars(sci
, pos
, context_sep
))
735 pos
-= strlen(context_sep
);
736 else if ((ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
) &&
737 match_last_chars(sci
, pos
, "->"))
739 else if (ft
->id
== GEANY_FILETYPES_CPP
&& match_last_chars(sci
, pos
, "->*"))
744 /* allow for a space between word and operator */
745 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
748 /* if function or array index, skip to matching brace */
749 brace_char
= sci_get_char_at(sci
, pos
- 1);
750 if (pos
> 0 && (brace_char
== ')' || brace_char
== ']'))
752 gint brace_pos
= sci_find_matching_brace(sci
, pos
- 1);
757 function
= brace_char
== ')';
760 /* allow for a space between opening brace and name */
761 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
765 name
= editor_get_word_at_pos(editor
, pos
, NULL
);
769 /* check if invoked on member */
771 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
773 /* make sure to keep in sync with similar checks above */
774 member
= match_last_chars(sci
, pos
, ".") || match_last_chars(sci
, pos
, context_sep
) ||
775 match_last_chars(sci
, pos
, "->") || match_last_chars(sci
, pos
, "->*");
777 if (symbols_get_current_scope(editor
->document
, ¤t_scope
) == -1)
779 tags
= tm_workspace_find_scope_members(editor
->document
->tm_file
, name
, function
,
780 member
, current_scope
);
783 GPtrArray
*filtered
= g_ptr_array_new();
787 foreach_ptr_array(tag
, i
, tags
)
789 if (g_str_has_prefix(tag
->name
, root
))
790 g_ptr_array_add(filtered
, tag
);
793 if (filtered
->len
> 0)
795 show_tags_list(editor
, filtered
, rootlen
);
799 g_ptr_array_free(tags
, TRUE
);
800 g_ptr_array_free(filtered
, TRUE
);
808 static void on_char_added(GeanyEditor
*editor
, SCNotification
*nt
)
810 ScintillaObject
*sci
= editor
->sci
;
811 gint pos
= sci_get_current_position(sci
);
816 { /* simple indentation (only for CR format) */
817 if (sci_get_eol_mode(sci
) == SC_EOL_CR
)
818 on_new_line_added(editor
);
822 { /* simple indentation (for CR/LF and LF format) */
823 on_new_line_added(editor
);
827 editor_start_auto_complete(editor
, pos
, FALSE
); /* C/C++ ptr-> scope completion */
830 { /* close xml-tags */
831 handle_xml(editor
, pos
, nt
->ch
);
836 auto_close_chars(sci
, pos
, nt
->ch
);
838 editor_show_calltip(editor
, --pos
);
842 { /* hide calltips */
843 if (SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0))
845 SSM(sci
, SCI_CALLTIPCANCEL
, 0, 0);
847 g_free(calltip
.text
);
859 auto_close_chars(sci
, pos
, nt
->ch
);
863 { /* closing bracket handling */
864 if (editor
->auto_indent
)
865 close_block(editor
, pos
- 1);
868 /* scope autocompletion */
870 case ':': /* C/C++ class:: syntax */
871 /* tag autocompletion */
874 if (! editor_start_auto_complete(editor
, pos
, FALSE
))
875 request_reshowing_calltip(nt
);
877 editor_start_auto_complete(editor
, pos
, FALSE
);
880 check_line_breaking(editor
, pos
);
884 /* expand() and fold_changed() are copied from SciTE (thanks) to fix #1923350. */
885 static void expand(ScintillaObject
*sci
, gint
*line
, gboolean doExpand
,
886 gboolean force
, gint visLevels
, gint level
)
888 gint lineMaxSubord
= SSM(sci
, SCI_GETLASTCHILD
, *line
, level
& SC_FOLDLEVELNUMBERMASK
);
889 gint levelLine
= level
;
891 while (*line
<= lineMaxSubord
)
896 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
898 SSM(sci
, SCI_HIDELINES
, *line
, *line
);
903 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
906 levelLine
= SSM(sci
, SCI_GETFOLDLEVEL
, *line
, 0);
907 if (levelLine
& SC_FOLDLEVELHEADERFLAG
)
912 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
914 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 0);
915 expand(sci
, line
, doExpand
, force
, visLevels
- 1, -1);
921 if (!sci_get_fold_expanded(sci
, *line
))
922 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
923 expand(sci
, line
, TRUE
, force
, visLevels
- 1, -1);
927 expand(sci
, line
, FALSE
, force
, visLevels
- 1, -1);
939 static void fold_changed(ScintillaObject
*sci
, gint line
, gint levelNow
, gint levelPrev
)
941 if (levelNow
& SC_FOLDLEVELHEADERFLAG
)
943 if (! (levelPrev
& SC_FOLDLEVELHEADERFLAG
))
945 /* Adding a fold point */
946 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
947 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
948 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
951 else if (levelPrev
& SC_FOLDLEVELHEADERFLAG
)
953 if (! sci_get_fold_expanded(sci
, line
))
954 { /* Removing the fold from one that has been contracted so should expand
955 * otherwise lines are left invisible with no way to make them visible */
956 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
957 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0))
958 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
961 if (! (levelNow
& SC_FOLDLEVELWHITEFLAG
) &&
962 ((levelPrev
& SC_FOLDLEVELNUMBERMASK
) > (levelNow
& SC_FOLDLEVELNUMBERMASK
)))
964 if (!SSM(sci
, SCI_GETALLLINESVISIBLE
, 0, 0)) {
965 /* See if should still be hidden */
966 gint parentLine
= sci_get_fold_parent(sci
, line
);
969 SSM(sci
, SCI_SHOWLINES
, line
, line
);
971 else if (sci_get_fold_expanded(sci
, parentLine
) &&
972 sci_get_line_is_visible(sci
, parentLine
))
974 SSM(sci
, SCI_SHOWLINES
, line
, line
);
981 static void ensure_range_visible(ScintillaObject
*sci
, gint posStart
, gint posEnd
,
982 gboolean enforcePolicy
)
984 gint lineStart
= sci_get_line_from_position(sci
, MIN(posStart
, posEnd
));
985 gint lineEnd
= sci_get_line_from_position(sci
, MAX(posStart
, posEnd
));
988 for (line
= lineStart
; line
<= lineEnd
; line
++)
990 SSM(sci
, enforcePolicy
? SCI_ENSUREVISIBLEENFORCEPOLICY
: SCI_ENSUREVISIBLE
, line
, 0);
995 static void auto_update_margin_width(GeanyEditor
*editor
)
997 gint next_linecount
= 1;
998 gint linecount
= sci_get_line_count(editor
->sci
);
999 GeanyDocument
*doc
= editor
->document
;
1001 while (next_linecount
<= linecount
)
1002 next_linecount
*= 10;
1004 if (editor
->document
->priv
->line_count
!= next_linecount
)
1006 doc
->priv
->line_count
= next_linecount
;
1007 sci_set_line_numbers(editor
->sci
, TRUE
);
1012 static void partial_complete(ScintillaObject
*sci
, const gchar
*text
)
1014 gint pos
= sci_get_current_position(sci
);
1016 sci_insert_text(sci
, pos
, text
);
1017 sci_set_current_position(sci
, pos
+ strlen(text
), TRUE
);
1021 /* Complete the next word part from @a entry */
1022 static gboolean
check_partial_completion(GeanyEditor
*editor
, const gchar
*entry
)
1024 gchar
*stem
, *ptr
, *text
= utils_strdupa(entry
);
1026 read_current_word(editor
, -1, current_word
, sizeof current_word
, NULL
, TRUE
);
1027 stem
= current_word
;
1028 if (strstr(text
, stem
) != text
)
1029 return FALSE
; /* shouldn't happen */
1030 if (strlen(text
) <= strlen(stem
))
1033 text
+= strlen(stem
); /* skip stem */
1034 ptr
= strstr(text
+ 1, "_");
1038 partial_complete(editor
->sci
, text
);
1044 foreach_str(ptr
, text
+ 1)
1048 if (g_ascii_isupper(*ptr
) && g_ascii_islower(ptr
[1]))
1051 partial_complete(editor
->sci
, text
);
1060 /* Callback for the "sci-notify" signal to emit a "editor-notify" signal.
1061 * Plugins can connect to the "editor-notify" signal. */
1062 void editor_sci_notify_cb(G_GNUC_UNUSED GtkWidget
*widget
, G_GNUC_UNUSED gint scn
,
1063 gpointer scnt
, gpointer data
)
1065 GeanyEditor
*editor
= data
;
1068 g_return_if_fail(editor
!= NULL
);
1070 g_signal_emit_by_name(geany_object
, "editor-notify", editor
, scnt
, &retval
);
1074 static gboolean
on_editor_notify(G_GNUC_UNUSED GObject
*object
, GeanyEditor
*editor
,
1075 SCNotification
*nt
, G_GNUC_UNUSED gpointer data
)
1077 ScintillaObject
*sci
= editor
->sci
;
1078 GeanyDocument
*doc
= editor
->document
;
1080 switch (nt
->nmhdr
.code
)
1082 case SCN_SAVEPOINTLEFT
:
1083 document_set_text_changed(doc
, TRUE
);
1086 case SCN_SAVEPOINTREACHED
:
1087 document_set_text_changed(doc
, FALSE
);
1090 case SCN_MODIFYATTEMPTRO
:
1094 case SCN_MARGINCLICK
:
1095 on_margin_click(editor
, nt
);
1099 on_update_ui(editor
, nt
);
1103 /* Visible lines are only laid out accurately just before painting,
1104 * so we need to only call editor_scroll_to_line here, because the document
1105 * may have line wrapping and folding enabled.
1106 * http://scintilla.sourceforge.net/ScintillaDoc.html#LineWrapping
1107 * This is important e.g. when loading a session and switching pages
1108 * and having the cursor scroll in view. */
1109 /* FIXME: Really we want to do this just before painting, not after it
1110 * as it will cause repainting. */
1111 if (editor
->scroll_percent
> 0.0F
)
1113 editor_scroll_to_line(editor
, -1, editor
->scroll_percent
);
1114 /* disable further scrolling */
1115 editor
->scroll_percent
= -1.0F
;
1120 if (editor_prefs
.show_linenumber_margin
&& (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
)) && nt
->linesAdded
)
1122 /* automatically adjust Scintilla's line numbers margin width */
1123 auto_update_margin_width(editor
);
1125 if (nt
->modificationType
& SC_STARTACTION
&& ! ignore_callback
)
1127 /* get notified about undo changes */
1128 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
1130 if (editor_prefs
.folding
&& (nt
->modificationType
& SC_MOD_CHANGEFOLD
) != 0)
1132 /* handle special fold cases, e.g. #1923350 */
1133 fold_changed(sci
, nt
->line
, nt
->foldLevelNow
, nt
->foldLevelPrev
);
1135 if (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
))
1137 document_update_tag_list_in_idle(doc
);
1142 on_char_added(editor
, nt
);
1145 case SCN_USERLISTSELECTION
:
1146 if (nt
->listType
== 1)
1148 sci_add_text(sci
, nt
->text
);
1152 case SCN_AUTOCSELECTION
:
1153 if (g_str_equal(nt
->text
, "..."))
1160 case SCN_AUTOCCANCELLED
:
1161 /* now that autocomplete is finishing or was cancelled, reshow calltips
1162 * if they were showing */
1163 autocomplete_scope_shown
= FALSE
;
1164 request_reshowing_calltip(nt
);
1167 ensure_range_visible(sci
, nt
->position
, nt
->position
+ nt
->length
, FALSE
);
1170 case SCN_URIDROPPED
:
1171 if (nt
->text
!= NULL
)
1173 document_open_file_list(nt
->text
, strlen(nt
->text
));
1177 case SCN_CALLTIPCLICK
:
1178 if (nt
->position
> 0)
1180 switch (nt
->position
)
1182 case 1: /* up arrow */
1183 if (calltip
.tag_index
> 0)
1184 calltip
.tag_index
--;
1187 case 2: calltip
.tag_index
++; break; /* down arrow */
1189 editor_show_calltip(editor
, -1);
1194 /* recalculate line margin width */
1195 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
1198 /* we always return FALSE here to let plugins handle the event too */
1203 /* Note: this is the same as sci_get_tab_width(), but is still useful when you don't have
1204 * a scintilla pointer. */
1205 static gint
get_tab_width(const GeanyIndentPrefs
*indent_prefs
)
1207 if (indent_prefs
->type
== GEANY_INDENT_TYPE_BOTH
)
1208 return indent_prefs
->hard_tab_width
;
1210 return indent_prefs
->width
; /* tab width = indent width */
1214 /* Returns a string containing width chars of whitespace, filled with simple space
1215 * characters or with the right number of tab characters, according to the indent prefs.
1216 * (Result is filled with tabs *and* spaces if width isn't a multiple of
1217 * the tab width). */
1219 get_whitespace(const GeanyIndentPrefs
*iprefs
, gint width
)
1221 g_return_val_if_fail(width
>= 0, NULL
);
1224 return g_strdup("");
1226 if (iprefs
->type
== GEANY_INDENT_TYPE_SPACES
)
1228 return g_strnfill(width
, ' ');
1231 { /* first fill text with tabs and fill the rest with spaces */
1232 const gint tab_width
= get_tab_width(iprefs
);
1233 gint tabs
= width
/ tab_width
;
1234 gint spaces
= width
% tab_width
;
1235 gint len
= tabs
+ spaces
;
1238 str
= g_malloc(len
+ 1);
1240 memset(str
, '\t', tabs
);
1241 memset(str
+ tabs
, ' ', spaces
);
1248 static const GeanyIndentPrefs
*
1249 get_default_indent_prefs(void)
1251 static GeanyIndentPrefs iprefs
;
1253 iprefs
= app
->project
? *app
->project
->priv
->indentation
: *editor_prefs
.indentation
;
1258 /** Gets the indentation prefs for the editor.
1259 * Prefs can be different according to project or document.
1260 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
1261 * settings may have changed, or if this function has been called for a different editor.
1262 * @param editor The editor, or @c NULL to get the default indent prefs.
1263 * @return The indent prefs. */
1265 const GeanyIndentPrefs
*
1266 editor_get_indent_prefs(GeanyEditor
*editor
)
1268 static GeanyIndentPrefs iprefs
;
1269 const GeanyIndentPrefs
*dprefs
= get_default_indent_prefs();
1271 /* Return the address of the default prefs to allow returning default and editor
1272 * pref pointers without invalidating the contents of either. */
1277 iprefs
.type
= editor
->indent_type
;
1278 iprefs
.width
= editor
->indent_width
;
1280 /* if per-document auto-indent is enabled, but we don't have a global mode set,
1281 * just use basic auto-indenting */
1282 if (editor
->auto_indent
&& iprefs
.auto_indent_mode
== GEANY_AUTOINDENT_NONE
)
1283 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_BASIC
;
1285 if (!editor
->auto_indent
)
1286 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_NONE
;
1292 static void on_new_line_added(GeanyEditor
*editor
)
1294 ScintillaObject
*sci
= editor
->sci
;
1295 gint line
= sci_get_current_line(sci
);
1297 /* simple indentation */
1298 if (editor
->auto_indent
)
1300 insert_indent_after_line(editor
, line
- 1);
1303 if (get_project_pref(auto_continue_multiline
))
1304 { /* " * " auto completion in multiline C/C++/D/Java comments */
1305 auto_multiline(editor
, line
);
1308 if (editor_prefs
.newline_strip
)
1309 { /* strip the trailing spaces on the previous line */
1310 editor_strip_line_trailing_spaces(editor
, line
- 1);
1315 static gboolean
lexer_has_braces(ScintillaObject
*sci
)
1317 gint lexer
= sci_get_lexer(sci
);
1323 case SCLEX_HTML
: /* for PHP & JS */
1324 case SCLEX_PHPSCRIPT
:
1325 case SCLEX_PASCAL
: /* for multiline comments? */
1338 /* Read indent chars for the line that pos is on into indent global variable.
1339 * Note: Use sci_get_line_indentation() and get_whitespace()/editor_insert_text_block()
1340 * instead in any new code. */
1341 static void read_indent(GeanyEditor
*editor
, gint pos
)
1343 ScintillaObject
*sci
= editor
->sci
;
1344 guint i
, len
, j
= 0;
1348 line
= sci_get_line_from_position(sci
, pos
);
1350 len
= sci_get_line_length(sci
, line
);
1351 linebuf
= sci_get_line(sci
, line
);
1353 for (i
= 0; i
< len
&& j
<= (sizeof(indent
) - 1); i
++)
1355 if (linebuf
[i
] == ' ' || linebuf
[i
] == '\t') /* simple indentation */
1356 indent
[j
++] = linebuf
[i
];
1365 static gint
get_brace_indent(ScintillaObject
*sci
, gint line
)
1367 gint start
= sci_get_position_from_line(sci
, line
);
1368 gint end
= sci_get_line_end_position(sci
, line
) - 1;
1369 gint lexer
= sci_get_lexer(sci
);
1373 for (pos
= end
; pos
>= start
&& count
< 1; pos
--)
1375 if (highlighting_is_code_style(lexer
, sci_get_style_at(sci
, pos
)))
1377 gchar c
= sci_get_char_at(sci
, pos
);
1386 return count
> 0 ? 1 : 0;
1390 /* gets the last code position on a line
1391 * warning: if there is no code position on the line, returns the start position */
1392 static gint
get_sci_line_code_end_position(ScintillaObject
*sci
, gint line
)
1394 gint start
= sci_get_position_from_line(sci
, line
);
1395 gint lexer
= sci_get_lexer(sci
);
1398 for (pos
= sci_get_line_end_position(sci
, line
) - 1; pos
> start
; pos
--)
1400 gint style
= sci_get_style_at(sci
, pos
);
1402 if (highlighting_is_code_style(lexer
, style
) && ! isspace(sci_get_char_at(sci
, pos
)))
1410 static gint
get_python_indent(ScintillaObject
*sci
, gint line
)
1412 gint last_char
= get_sci_line_code_end_position(sci
, line
);
1414 /* add extra indentation for Python after colon */
1415 if (sci_get_char_at(sci
, last_char
) == ':' &&
1416 sci_get_style_at(sci
, last_char
) == SCE_P_OPERATOR
)
1424 static gint
get_xml_indent(ScintillaObject
*sci
, gint line
)
1426 gboolean need_close
= FALSE
;
1427 gint end
= get_sci_line_code_end_position(sci
, line
);
1430 /* don't indent if there's a closing tag to the right of the cursor */
1431 pos
= sci_get_current_position(sci
);
1432 if (sci_get_char_at(sci
, pos
) == '<' &&
1433 sci_get_char_at(sci
, pos
+ 1) == '/')
1436 if (sci_get_char_at(sci
, end
) == '>' &&
1437 sci_get_char_at(sci
, end
- 1) != '/')
1439 gint style
= sci_get_style_at(sci
, end
);
1441 if (style
== SCE_H_TAG
|| style
== SCE_H_TAGUNKNOWN
)
1443 gint start
= sci_get_position_from_line(sci
, line
);
1444 gchar
*line_contents
= sci_get_contents_range(sci
, start
, end
+ 1);
1445 gchar
*opened_tag_name
= utils_find_open_xml_tag(line_contents
, end
+ 1 - start
);
1447 if (!EMPTY(opened_tag_name
))
1450 if (sci_get_lexer(sci
) == SCLEX_HTML
&& utils_is_short_html_tag(opened_tag_name
))
1453 g_free(line_contents
);
1454 g_free(opened_tag_name
);
1458 return need_close
? 1 : 0;
1462 static gint
get_indent_size_after_line(GeanyEditor
*editor
, gint line
)
1464 ScintillaObject
*sci
= editor
->sci
;
1466 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1468 g_return_val_if_fail(line
>= 0, 0);
1470 size
= sci_get_line_indentation(sci
, line
);
1472 if (iprefs
->auto_indent_mode
> GEANY_AUTOINDENT_BASIC
)
1474 gint additional_indent
= 0;
1476 if (lexer_has_braces(sci
))
1477 additional_indent
= iprefs
->width
* get_brace_indent(sci
, line
);
1478 else if (sci_get_lexer(sci
) == SCLEX_PYTHON
) /* Python/Cython */
1479 additional_indent
= iprefs
->width
* get_python_indent(sci
, line
);
1481 /* HTML lexer "has braces" because of PHP and JavaScript. If get_brace_indent() did not
1482 * recommend us to insert additional indent, we are probably not in PHP/JavaScript chunk and
1483 * should make the XML-related check */
1484 if (additional_indent
== 0 &&
1485 (sci_get_lexer(sci
) == SCLEX_HTML
||
1486 sci_get_lexer(sci
) == SCLEX_XML
) &&
1487 editor
->document
->file_type
->priv
->xml_indent_tags
)
1489 size
+= iprefs
->width
* get_xml_indent(sci
, line
);
1492 size
+= additional_indent
;
1498 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
)
1500 ScintillaObject
*sci
= editor
->sci
;
1501 gint line_indent
= sci_get_line_indentation(sci
, line
);
1502 gint size
= get_indent_size_after_line(editor
, line
);
1503 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1509 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
&& size
== line_indent
)
1511 /* support tab indents, space aligns style - copy last line 'indent' exactly */
1512 gint start
= sci_get_position_from_line(sci
, line
);
1513 gint end
= sci_get_line_indent_position(sci
, line
);
1515 text
= sci_get_contents_range(sci
, start
, end
);
1519 text
= get_whitespace(iprefs
, size
);
1521 sci_add_text(sci
, text
);
1526 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
)
1528 const gchar
*closing_char
= NULL
;
1531 if (utils_isbrace(c
, 0))
1532 end_pos
= sci_find_matching_brace(sci
, pos
- 1);
1537 if ((editor_prefs
.autoclose_chars
& GEANY_AC_PARENTHESIS
) && end_pos
== -1)
1541 if ((editor_prefs
.autoclose_chars
& GEANY_AC_CBRACKET
) && end_pos
== -1)
1545 if ((editor_prefs
.autoclose_chars
& GEANY_AC_SBRACKET
) && end_pos
== -1)
1549 if (editor_prefs
.autoclose_chars
& GEANY_AC_SQUOTE
)
1553 if (editor_prefs
.autoclose_chars
& GEANY_AC_DQUOTE
)
1554 closing_char
= "\"";
1558 if (closing_char
!= NULL
)
1560 sci_add_text(sci
, closing_char
);
1561 sci_set_current_position(sci
, pos
, TRUE
);
1566 /* Finds a corresponding matching brace to the given pos
1567 * (this is taken from Scintilla Editor.cxx,
1568 * fit to work with close_block) */
1569 static gint
brace_match(ScintillaObject
*sci
, gint pos
)
1571 gchar chBrace
= sci_get_char_at(sci
, pos
);
1572 gchar chSeek
= utils_brace_opposite(chBrace
);
1574 gint direction
= -1;
1579 /* Hack: we need the style at @p pos but it isn't computed yet, so force styling
1580 * of this very position */
1581 sci_colourise(sci
, pos
, pos
+ 1);
1583 styBrace
= sci_get_style_at(sci
, pos
);
1585 if (utils_is_opening_brace(chBrace
, editor_prefs
.brace_match_ltgt
))
1589 while ((pos
>= 0) && (pos
< sci_get_length(sci
)))
1591 chAtPos
= sci_get_char_at(sci
, pos
);
1592 styAtPos
= sci_get_style_at(sci
, pos
);
1594 if ((pos
> sci_get_end_styled(sci
)) || (styAtPos
== styBrace
))
1596 if (chAtPos
== chBrace
)
1598 if (chAtPos
== chSeek
)
1609 /* Called after typing '}'. */
1610 static void close_block(GeanyEditor
*editor
, gint pos
)
1612 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1613 gint x
= 0, cnt
= 0;
1614 gint line
, line_len
;
1615 gchar
*text
, *line_buf
;
1616 ScintillaObject
*sci
;
1617 gint line_indent
, last_indent
;
1619 if (iprefs
->auto_indent_mode
< GEANY_AUTOINDENT_CURRENTCHARS
)
1621 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
1625 if (! lexer_has_braces(sci
))
1628 line
= sci_get_line_from_position(sci
, pos
);
1629 line_len
= sci_get_line_end_position(sci
, line
) - sci_get_position_from_line(sci
, line
);
1631 /* check that the line is empty, to not kill text in the line */
1632 line_buf
= sci_get_line(sci
, line
);
1633 line_buf
[line_len
] = '\0';
1634 while (x
< line_len
)
1636 if (isspace(line_buf
[x
]))
1642 if ((line_len
- 1) != cnt
)
1645 if (iprefs
->auto_indent_mode
== GEANY_AUTOINDENT_MATCHBRACES
)
1647 gint start_brace
= brace_match(sci
, pos
);
1649 if (start_brace
>= 0)
1652 gint brace_line
= sci_get_line_from_position(sci
, start_brace
);
1653 gint size
= sci_get_line_indentation(sci
, brace_line
);
1654 gchar
*ind
= get_whitespace(iprefs
, size
);
1656 text
= g_strconcat(ind
, "}", NULL
);
1657 line_start
= sci_get_position_from_line(sci
, line
);
1658 sci_set_anchor(sci
, line_start
);
1659 sci_replace_sel(sci
, text
);
1664 /* fall through - unmatched brace (possibly because of TCL, PHP lexer bugs) */
1667 /* GEANY_AUTOINDENT_CURRENTCHARS */
1668 line_indent
= sci_get_line_indentation(sci
, line
);
1669 last_indent
= sci_get_line_indentation(sci
, line
- 1);
1671 if (line_indent
< last_indent
)
1673 line_indent
-= iprefs
->width
;
1674 line_indent
= MAX(0, line_indent
);
1675 sci_set_line_indentation(sci
, line
, line_indent
);
1679 /* checks whether @p c is an ASCII character (e.g. < 0x80) */
1680 #define IS_ASCII(c) (((unsigned char)(c)) < 0x80)
1683 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1684 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1685 * position can be -1, then the current position is used.
1686 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1687 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1688 const gchar
*wc
, gboolean stem
)
1690 gint line
, line_start
, startword
, endword
;
1692 ScintillaObject
*sci
;
1694 g_return_if_fail(editor
!= NULL
);
1698 pos
= sci_get_current_position(sci
);
1700 line
= sci_get_line_from_position(sci
, pos
);
1701 line_start
= sci_get_position_from_line(sci
, line
);
1702 startword
= pos
- line_start
;
1703 endword
= pos
- line_start
;
1706 chunk
= sci_get_line(sci
, line
);
1709 wc
= GEANY_WORDCHARS
;
1711 /* the checks for "c < 0" are to allow any Unicode character which should make the code
1712 * a little bit more Unicode safe, anyway, this allows also any Unicode punctuation,
1713 * TODO: improve this code */
1714 while (startword
> 0 && (strchr(wc
, chunk
[startword
- 1]) || ! IS_ASCII(chunk
[startword
- 1])))
1718 while (chunk
[endword
] != 0 && (strchr(wc
, chunk
[endword
]) || ! IS_ASCII(chunk
[endword
])))
1722 if (startword
!= endword
)
1724 chunk
[endword
] = '\0';
1726 g_strlcpy(word
, chunk
+ startword
, wordlen
); /* ensure null terminated */
1729 g_strlcpy(word
, "", wordlen
);
1735 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1736 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1737 * position can be -1, then the current position is used.
1738 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1739 void editor_find_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1742 read_current_word(editor
, pos
, word
, wordlen
, wc
, FALSE
);
1746 /* Same as editor_find_current_word() but uses editor's word boundaries to decide what the word
1747 * is. This should be used e.g. to get the word to search for */
1748 void editor_find_current_word_sciwc(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
)
1753 g_return_if_fail(editor
!= NULL
);
1756 pos
= sci_get_current_position(editor
->sci
);
1758 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
1759 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
1761 if (start
== end
) /* caret in whitespaces sequence */
1765 if ((guint
)(end
- start
) >= wordlen
)
1766 end
= start
+ (wordlen
- 1);
1767 sci_get_text_range(editor
->sci
, start
, end
, word
);
1773 * Finds the word at the position specified by @a pos. If any word is found, it is returned.
1774 * Otherwise NULL is returned.
1775 * Additional wordchars can be specified to define what to consider as a word.
1777 * @param editor The editor to operate on.
1778 * @param pos The position where the word should be read from.
1779 * May be @c -1 to use the current position.
1780 * @param wordchars The wordchars to separate words. wordchars mean all characters to count
1781 * as part of a word. May be @c NULL to use the default wordchars,
1782 * see @ref GEANY_WORDCHARS.
1784 * @return A newly-allocated string containing the word at the given @a pos or @c NULL.
1785 * Should be freed when no longer needed.
1790 gchar
*editor_get_word_at_pos(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1792 static gchar cword
[GEANY_MAX_WORD_LENGTH
];
1794 g_return_val_if_fail(editor
!= NULL
, FALSE
);
1796 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, FALSE
);
1798 return (*cword
== '\0') ? NULL
: g_strdup(cword
);
1802 /* Read the word up to position @a pos. */
1803 static const gchar
*
1804 editor_read_word_stem(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1806 static gchar word
[GEANY_MAX_WORD_LENGTH
];
1808 read_current_word(editor
, pos
, word
, sizeof word
, wordchars
, TRUE
);
1810 return (*word
) ? word
: NULL
;
1814 static gint
find_previous_brace(ScintillaObject
*sci
, gint pos
)
1816 gint orig_pos
= pos
;
1818 while (pos
>= 0 && pos
> orig_pos
- 300)
1820 gchar c
= sci_get_char_at(sci
, pos
);
1821 if (utils_is_opening_brace(c
, editor_prefs
.brace_match_ltgt
))
1829 static gint
find_start_bracket(ScintillaObject
*sci
, gint pos
)
1832 gint orig_pos
= pos
;
1834 while (pos
> 0 && pos
> orig_pos
- 300)
1836 gchar c
= sci_get_char_at(sci
, pos
);
1838 if (c
== ')') brackets
++;
1839 else if (c
== '(') brackets
--;
1840 if (brackets
< 0) return pos
; /* found start bracket */
1847 static gboolean
append_calltip(GString
*str
, const TMTag
*tag
, GeanyFiletypeID ft_id
)
1852 if (ft_id
!= GEANY_FILETYPES_PASCAL
&& ft_id
!= GEANY_FILETYPES_GO
)
1853 { /* usual calltips: "retval tagname (arglist)" */
1858 g_string_append(str
, tag
->var_type
);
1859 for (i
= 0; i
< tag
->pointerOrder
; i
++)
1861 g_string_append_c(str
, '*');
1863 g_string_append_c(str
, ' ');
1867 const gchar
*cosep
= symbols_get_context_separator(ft_id
);
1869 g_string_append(str
, tag
->scope
);
1870 g_string_append(str
, cosep
);
1872 g_string_append(str
, tag
->name
);
1873 g_string_append_c(str
, ' ');
1874 g_string_append(str
, tag
->arglist
);
1877 { /* special case Pascal/Go calltips: "tagname (arglist) : retval"
1878 * (with ':' omitted for Go) */
1879 g_string_append(str
, tag
->name
);
1880 g_string_append_c(str
, ' ');
1881 g_string_append(str
, tag
->arglist
);
1883 if (!EMPTY(tag
->var_type
))
1885 g_string_append(str
, ft_id
== GEANY_FILETYPES_PASCAL
? " : " : " ");
1886 g_string_append(str
, tag
->var_type
);
1894 static gchar
*find_calltip(const gchar
*word
, GeanyFiletype
*ft
)
1897 const TMTagType arg_types
= tm_tag_function_t
| tm_tag_prototype_t
|
1898 tm_tag_method_t
| tm_tag_macro_with_arg_t
;
1900 GString
*str
= NULL
;
1903 g_return_val_if_fail(ft
&& word
&& *word
, NULL
);
1905 /* use all types in case language uses wrong tag type e.g. python "members" instead of "methods" */
1906 tags
= tm_workspace_find(word
, NULL
, tm_tag_max_t
, NULL
, ft
->lang
);
1909 g_ptr_array_free(tags
, TRUE
);
1913 tag
= TM_TAG(tags
->pdata
[0]);
1915 if (ft
->id
== GEANY_FILETYPES_D
&&
1916 (tag
->type
== tm_tag_class_t
|| tag
->type
== tm_tag_struct_t
))
1918 g_ptr_array_free(tags
, TRUE
);
1919 /* user typed e.g. 'new Classname(' so lookup D constructor Classname::this() */
1920 tags
= tm_workspace_find("this", tag
->name
, arg_types
, NULL
, ft
->lang
);
1923 g_ptr_array_free(tags
, TRUE
);
1928 /* remove tags with no argument list */
1929 for (i
= 0; i
< tags
->len
; i
++)
1931 tag
= TM_TAG(tags
->pdata
[i
]);
1934 tags
->pdata
[i
] = NULL
;
1936 tm_tags_prune((GPtrArray
*) tags
);
1939 g_ptr_array_free(tags
, TRUE
);
1943 { /* remove duplicate calltips */
1944 TMTagAttrType sort_attr
[] = {tm_tag_attr_name_t
, tm_tag_attr_scope_t
,
1945 tm_tag_attr_arglist_t
, 0};
1947 tm_tags_sort((GPtrArray
*) tags
, sort_attr
, TRUE
, FALSE
);
1950 /* if the current word has changed since last time, start with the first tag match */
1951 if (! utils_str_equal(word
, calltip
.last_word
))
1952 calltip
.tag_index
= 0;
1953 /* cache the current word for next time */
1954 g_free(calltip
.last_word
);
1955 calltip
.last_word
= g_strdup(word
);
1956 calltip
.tag_index
= MIN(calltip
.tag_index
, tags
->len
- 1); /* ensure tag_index is in range */
1958 for (i
= calltip
.tag_index
; i
< tags
->len
; i
++)
1960 tag
= TM_TAG(tags
->pdata
[i
]);
1964 str
= g_string_new(NULL
);
1965 if (calltip
.tag_index
> 0)
1966 g_string_prepend(str
, "\001 "); /* up arrow */
1967 append_calltip(str
, tag
, FILETYPE_ID(ft
));
1969 else /* add a down arrow */
1971 if (calltip
.tag_index
> 0) /* already have an up arrow */
1972 g_string_insert_c(str
, 1, '\002');
1974 g_string_prepend(str
, "\002 ");
1979 g_ptr_array_free(tags
, TRUE
);
1983 gchar
*result
= str
->str
;
1985 g_string_free(str
, FALSE
);
1992 /* use pos = -1 to search for the previous unmatched open bracket. */
1993 gboolean
editor_show_calltip(GeanyEditor
*editor
, gint pos
)
1995 gint orig_pos
= pos
; /* the position for the calltip */
1998 gchar word
[GEANY_MAX_WORD_LENGTH
];
2000 ScintillaObject
*sci
;
2002 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2003 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, FALSE
);
2007 lexer
= sci_get_lexer(sci
);
2011 /* position of '(' is unknown, so go backwards from current position to find it */
2012 pos
= sci_get_current_position(sci
);
2015 pos
= (lexer
== SCLEX_LATEX
) ? find_previous_brace(sci
, pos
) :
2016 find_start_bracket(sci
, pos
);
2021 /* the style 1 before the brace (which may be highlighted) */
2022 style
= sci_get_style_at(sci
, pos
- 1);
2023 if (! highlighting_is_code_style(lexer
, style
))
2026 while (pos
> 0 && isspace(sci_get_char_at(sci
, pos
- 1)))
2030 editor_find_current_word(editor
, pos
- 1, word
, sizeof word
, NULL
);
2031 if (word
[0] == '\0')
2034 str
= find_calltip(word
, editor
->document
->file_type
);
2037 g_free(calltip
.text
); /* free the old calltip */
2039 calltip
.pos
= orig_pos
;
2042 utils_wrap_string(calltip
.text
, -1);
2043 SSM(sci
, SCI_CALLTIPSHOW
, orig_pos
, (sptr_t
) calltip
.text
);
2050 gchar
*editor_get_calltip_text(GeanyEditor
*editor
, const TMTag
*tag
)
2054 g_return_val_if_fail(editor
!= NULL
, NULL
);
2056 str
= g_string_new(NULL
);
2057 if (append_calltip(str
, tag
, editor
->document
->file_type
->id
))
2058 return g_string_free(str
, FALSE
);
2060 return g_string_free(str
, TRUE
);
2064 /* HTML entities auto completion from html_entities.tags text file */
2066 autocomplete_html(ScintillaObject
*sci
, const gchar
*root
, gsize rootlen
)
2069 gboolean found
= FALSE
;
2071 const gchar
**entities
= symbols_get_html_entities();
2073 if (*root
!= '&' || entities
== NULL
)
2076 words
= g_string_sized_new(500);
2079 if (entities
[i
] == NULL
)
2081 else if (entities
[i
][0] == '#')
2084 if (! strncmp(entities
[i
], root
, rootlen
))
2087 g_string_append_c(words
, '\n');
2089 g_string_append(words
, entities
[i
]);
2094 show_autocomplete(sci
, rootlen
, words
);
2096 g_string_free(words
, TRUE
);
2101 /* Current document & global tags autocompletion */
2103 autocomplete_tags(GeanyEditor
*editor
, const gchar
*root
, gsize rootlen
)
2109 g_return_val_if_fail(editor
, FALSE
);
2111 doc
= editor
->document
;
2113 tags
= tm_workspace_find_prefix(root
, doc
->file_type
->lang
, editor_prefs
.autocompletion_max_entries
);
2114 found
= tags
->len
> 0;
2116 show_tags_list(editor
, tags
, rootlen
);
2117 g_ptr_array_free(tags
, TRUE
);
2123 static gboolean
autocomplete_check_html(GeanyEditor
*editor
, gint style
, gint pos
)
2125 GeanyFiletype
*ft
= editor
->document
->file_type
;
2126 gboolean
try = FALSE
;
2128 /* use entity completion when style is not JavaScript, ASP, Python, PHP, ...
2129 * (everything after SCE_HJ_START is for embedded scripting languages) */
2130 if (ft
->id
== GEANY_FILETYPES_HTML
&& style
< SCE_HJ_START
)
2132 else if (sci_get_lexer(editor
->sci
) == SCLEX_XML
&& style
< SCE_HJ_START
)
2134 else if (ft
->id
== GEANY_FILETYPES_PHP
)
2136 /* use entity completion when style is outside of PHP styles */
2137 if (! is_style_php(style
))
2142 gchar root
[GEANY_MAX_WORD_LENGTH
];
2145 read_current_word(editor
, pos
, root
, sizeof(root
), GEANY_WORDCHARS
"&", TRUE
);
2147 /* Allow something like ""some text"".
2148 * for entity completion we want to have completion for '&' within words. */
2149 tmp
= strchr(root
, '&');
2152 return autocomplete_html(editor
->sci
, tmp
, strlen(tmp
));
2159 /* Algorithm based on based on Scite's StartAutoCompleteWord()
2160 * @returns a sorted list of words matching @p root */
2161 static GSList
*get_doc_words(ScintillaObject
*sci
, gchar
*root
, gsize rootlen
)
2164 gint len
, current
, word_end
;
2165 gint pos_find
, flags
;
2168 GSList
*words
= NULL
;
2169 struct Sci_TextToFind ttf
;
2171 len
= sci_get_length(sci
);
2172 current
= sci_get_current_position(sci
) - rootlen
;
2174 ttf
.lpstrText
= root
;
2176 ttf
.chrg
.cpMax
= len
;
2177 ttf
.chrgText
.cpMin
= 0;
2178 ttf
.chrgText
.cpMax
= 0;
2179 flags
= SCFIND_WORDSTART
| SCFIND_MATCHCASE
;
2181 /* search the whole document for the word root and collect results */
2182 pos_find
= scintilla_send_message(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2183 while (pos_find
>= 0 && pos_find
< len
)
2185 word_end
= pos_find
+ rootlen
;
2186 if (pos_find
!= current
)
2188 word_end
= sci_word_end_position(sci
, word_end
, TRUE
);
2190 word_length
= word_end
- pos_find
;
2191 if (word_length
> rootlen
)
2193 word
= sci_get_contents_range(sci
, pos_find
, word_end
);
2194 /* search whether we already have the word in, otherwise add it */
2195 if (g_slist_find_custom(words
, word
, (GCompareFunc
)strcmp
) != NULL
)
2199 words
= g_slist_prepend(words
, word
);
2203 if (nmatches
== editor_prefs
.autocompletion_max_entries
)
2207 ttf
.chrg
.cpMin
= word_end
;
2208 pos_find
= scintilla_send_message(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2211 return g_slist_sort(words
, (GCompareFunc
)utils_str_casecmp
);
2215 static gboolean
autocomplete_doc_word(GeanyEditor
*editor
, gchar
*root
, gsize rootlen
)
2217 ScintillaObject
*sci
= editor
->sci
;
2218 GSList
*words
, *node
;
2222 words
= get_doc_words(sci
, root
, rootlen
);
2225 scintilla_send_message(sci
, SCI_AUTOCCANCEL
, 0, 0);
2229 str
= g_string_sized_new(rootlen
* 2 * 10);
2230 foreach_slist(node
, words
)
2232 g_string_append(str
, node
->data
);
2235 g_string_append_c(str
, '\n');
2238 if (n_words
>= editor_prefs
.autocompletion_max_entries
)
2239 g_string_append(str
, "\n...");
2241 g_slist_free(words
);
2243 show_autocomplete(sci
, rootlen
, str
);
2244 g_string_free(str
, TRUE
);
2249 gboolean
editor_start_auto_complete(GeanyEditor
*editor
, gint pos
, gboolean force
)
2251 gint rootlen
, lexer
, style
;
2253 gchar cword
[GEANY_MAX_WORD_LENGTH
];
2254 ScintillaObject
*sci
;
2255 gboolean ret
= FALSE
;
2256 const gchar
*wordchars
;
2259 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2261 if (! editor_prefs
.auto_complete_symbols
&& ! force
)
2264 /* If we are at the beginning of the document, we skip autocompletion as we can't determine the
2265 * necessary styling information */
2266 if (G_UNLIKELY(pos
< 2))
2270 ft
= editor
->document
->file_type
;
2272 lexer
= sci_get_lexer(sci
);
2273 style
= sci_get_style_at(sci
, pos
- 2);
2275 /* don't autocomplete in comments and strings */
2276 if (!force
&& !highlighting_is_code_style(lexer
, style
))
2279 ret
= autocomplete_check_html(editor
, style
, pos
);
2281 if (ft
->id
== GEANY_FILETYPES_LATEX
)
2282 wordchars
= GEANY_WORDCHARS
"\\"; /* add \ to word chars if we are in a LaTeX file */
2283 else if (ft
->id
== GEANY_FILETYPES_CSS
)
2284 wordchars
= GEANY_WORDCHARS
"-"; /* add - because they are part of property names */
2286 wordchars
= GEANY_WORDCHARS
;
2288 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, TRUE
);
2290 rootlen
= strlen(root
);
2294 if (autocomplete_scope_shown
)
2296 autocomplete_scope_shown
= FALSE
;
2298 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2303 ret
= autocomplete_scope(editor
, root
, rootlen
);
2304 if (!ret
&& autocomplete_scope_shown
)
2305 sci_send_command(sci
, SCI_AUTOCCANCEL
);
2306 autocomplete_scope_shown
= ret
;
2309 if (!ret
&& rootlen
> 0)
2311 if (ft
->id
== GEANY_FILETYPES_PHP
&& style
== SCE_HPHP_DEFAULT
&&
2312 rootlen
== 3 && strcmp(root
, "php") == 0 && pos
>= 5 &&
2313 sci_get_char_at(sci
, pos
- 5) == '<' &&
2314 sci_get_char_at(sci
, pos
- 4) == '?')
2316 /* nothing, don't complete PHP open tags */
2320 /* force is set when called by keyboard shortcut, otherwise start at the
2321 * editor_prefs.symbolcompletion_min_chars'th char */
2322 if (force
|| rootlen
>= editor_prefs
.symbolcompletion_min_chars
)
2324 /* complete tags, except if forcing when completion is already visible */
2325 if (!(force
&& SSM(sci
, SCI_AUTOCACTIVE
, 0, 0)))
2326 ret
= autocomplete_tags(editor
, root
, rootlen
);
2328 /* If forcing and there's nothing else to show, complete from words in document */
2329 if (!ret
&& (force
|| editor_prefs
.autocomplete_doc_words
))
2330 ret
= autocomplete_doc_word(editor
, root
, rootlen
);
2341 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
)
2343 gchar
*result
= NULL
;
2346 g_return_val_if_fail(type
!= NULL
&& name
!= NULL
, NULL
);
2348 tmp
= g_hash_table_lookup(snippet_hash
, type
);
2351 result
= g_hash_table_lookup(tmp
, name
);
2353 /* whether nothing is set for the current filetype(tmp is NULL) or
2354 * the particular completion for this filetype is not set (result is NULL) */
2355 if (tmp
== NULL
|| result
== NULL
)
2357 tmp
= g_hash_table_lookup(snippet_hash
, "Default");
2360 result
= g_hash_table_lookup(tmp
, name
);
2363 /* if result is still NULL here, no completion could be found */
2365 /* result is owned by the hash table and will be freed when the table will destroyed */
2370 static void snippets_replace_specials(gpointer key
, gpointer value
, gpointer user_data
)
2373 GString
*pattern
= user_data
;
2375 g_return_if_fail(key
!= NULL
);
2376 g_return_if_fail(value
!= NULL
);
2378 needle
= g_strconcat("%", (gchar
*) key
, "%", NULL
);
2380 utils_string_replace_all(pattern
, needle
, (gchar
*) value
);
2385 static void fix_indentation(GeanyEditor
*editor
, GString
*buf
)
2387 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
2390 gint cflags
= G_REGEX_MULTILINE
;
2392 /* transform leading tabs into indent widths (in spaces) */
2393 whitespace
= g_strnfill(iprefs
->width
, ' ');
2394 regex
= g_regex_new("^ *(\t)", cflags
, 0, NULL
);
2395 while (utils_string_regex_replace_all(buf
, regex
, 1, whitespace
, TRUE
));
2396 g_regex_unref(regex
);
2398 /* remaining tabs are for alignment */
2399 if (iprefs
->type
!= GEANY_INDENT_TYPE_TABS
)
2400 utils_string_replace_all(buf
, "\t", whitespace
);
2402 /* use leading tabs */
2403 if (iprefs
->type
!= GEANY_INDENT_TYPE_SPACES
)
2407 /* for tabs+spaces mode we want the real tab width, not indent width */
2408 SETPTR(whitespace
, g_strnfill(sci_get_tab_width(editor
->sci
), ' '));
2409 str
= g_strdup_printf("^\t*(%s)", whitespace
);
2411 regex
= g_regex_new(str
, cflags
, 0, NULL
);
2412 while (utils_string_regex_replace_all(buf
, regex
, 1, "\t", TRUE
));
2413 g_regex_unref(regex
);
2420 /** Inserts text, replacing \\t tab chars (@c 0x9) and \\n newline chars (@c 0xA)
2421 * accordingly for the document.
2422 * - Leading tabs are replaced with the correct indentation.
2423 * - Non-leading tabs are replaced with spaces (except when using 'Tabs' indent type).
2424 * - Newline chars are replaced with the correct line ending string.
2425 * This is very useful for inserting code without having to handle the indent
2426 * type yourself (Tabs & Spaces mode can be tricky).
2427 * @param editor Editor.
2428 * @param text Intended as e.g. @c "if (foo)\n\tbar();".
2429 * @param insert_pos Document position to insert text at.
2430 * @param cursor_index If >= 0, the index into @a text to place the cursor.
2431 * @param newline_indent_size Indentation size (in spaces) to insert for each newline; use
2432 * -1 to read the indent size from the line with @a insert_pos on it.
2433 * @param replace_newlines Whether to replace newlines. If
2434 * newlines have been replaced already, this should be false, to avoid errors e.g. on Windows.
2435 * @warning Make sure all \\t tab chars in @a text are intended as indent widths or alignment,
2436 * not hard tabs, as those won't be preserved.
2437 * @note This doesn't scroll the cursor in view afterwards. **/
2439 void editor_insert_text_block(GeanyEditor
*editor
, const gchar
*text
, gint insert_pos
,
2440 gint cursor_index
, gint newline_indent_size
, gboolean replace_newlines
)
2442 ScintillaObject
*sci
= editor
->sci
;
2443 gint line_start
= sci_get_line_from_position(sci
, insert_pos
);
2445 const gchar
*eol
= editor_get_eol_char(editor
);
2448 g_return_if_fail(text
);
2449 g_return_if_fail(editor
!= NULL
);
2450 g_return_if_fail(insert_pos
>= 0);
2452 buf
= g_string_new(text
);
2454 if (cursor_index
>= 0)
2455 g_string_insert(buf
, cursor_index
, geany_cursor_marker
); /* remember cursor pos */
2457 if (newline_indent_size
== -1)
2459 /* count indent size up to insert_pos instead of asking sci
2460 * because there may be spaces after it */
2461 gchar
*tmp
= sci_get_line(sci
, line_start
);
2463 idx
= insert_pos
- sci_get_position_from_line(sci
, line_start
);
2465 newline_indent_size
= count_indent_size(editor
, tmp
);
2469 /* Add line indents (in spaces) */
2470 if (newline_indent_size
> 0)
2472 const gchar
*nl
= replace_newlines
? "\n" : eol
;
2475 whitespace
= g_strnfill(newline_indent_size
, ' ');
2476 SETPTR(whitespace
, g_strconcat(nl
, whitespace
, NULL
));
2477 utils_string_replace_all(buf
, nl
, whitespace
);
2481 /* transform line endings */
2482 if (replace_newlines
)
2483 utils_string_replace_all(buf
, "\n", eol
);
2485 fix_indentation(editor
, buf
);
2487 idx
= replace_cursor_markers(editor
, buf
);
2490 sci_insert_text(sci
, insert_pos
, buf
->str
);
2491 sci_set_current_position(sci
, insert_pos
+ idx
, FALSE
);
2494 sci_insert_text(sci
, insert_pos
, buf
->str
);
2496 snippet_cursor_insert_pos
= sci_get_current_position(sci
);
2498 g_string_free(buf
, TRUE
);
2502 /* Move the cursor to the next specified cursor position in an inserted snippet.
2503 * Can, and should, be optimized to give better results */
2504 void editor_goto_next_snippet_cursor(GeanyEditor
*editor
)
2506 ScintillaObject
*sci
= editor
->sci
;
2507 gint current_pos
= sci_get_current_position(sci
);
2509 if (snippet_offsets
&& !g_queue_is_empty(snippet_offsets
))
2513 offset
= GPOINTER_TO_INT(g_queue_pop_head(snippet_offsets
));
2514 if (current_pos
> snippet_cursor_insert_pos
)
2515 snippet_cursor_insert_pos
= offset
+ current_pos
;
2517 snippet_cursor_insert_pos
+= offset
;
2519 sci_set_current_position(sci
, snippet_cursor_insert_pos
, TRUE
);
2528 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
)
2530 GHashTable
*specials
;
2532 /* replace 'special' completions */
2533 specials
= g_hash_table_lookup(snippet_hash
, "Special");
2534 if (G_LIKELY(specials
!= NULL
))
2536 g_hash_table_foreach(specials
, snippets_replace_specials
, pattern
);
2539 /* now transform other wildcards */
2540 utils_string_replace_all(pattern
, "%newline%", "\n");
2541 utils_string_replace_all(pattern
, "%ws%", "\t");
2543 /* replace %cursor% by a very unlikely string marker */
2544 utils_string_replace_all(pattern
, "%cursor%", geany_cursor_marker
);
2546 /* unescape '%' after all %wildcards% */
2547 templates_replace_valist(pattern
, "{pc}", "%", NULL
);
2549 /* replace any template {foo} wildcards */
2550 templates_replace_common(pattern
, editor
->document
->file_name
, editor
->document
->file_type
, NULL
);
2554 static gssize
replace_cursor_markers(GeanyEditor
*editor
, GString
*pattern
)
2556 gssize cur_index
= -1;
2558 GList
*temp_list
= NULL
;
2559 gint cursor_steps
= 0, old_cursor
= 0;
2564 cursor_steps
= utils_string_find(pattern
, cursor_steps
, -1, geany_cursor_marker
);
2565 if (cursor_steps
== -1)
2568 g_string_erase(pattern
, cursor_steps
, strlen(geany_cursor_marker
));
2572 /* save the relative offset to each cursor position */
2573 temp_list
= g_list_prepend(temp_list
, GINT_TO_POINTER(cursor_steps
- old_cursor
));
2577 /* first cursor already includes newline positions */
2578 cur_index
= cursor_steps
;
2580 old_cursor
= cursor_steps
;
2583 /* put the cursor positions for the most recent
2584 * parsed snippet first, followed by any remaining positions */
2590 temp_list
= g_list_reverse(temp_list
);
2591 foreach_list(node
, temp_list
)
2592 g_queue_push_nth(snippet_offsets
, node
->data
, i
++);
2594 /* limit length of queue */
2595 while (g_queue_get_length(snippet_offsets
) > 20)
2596 g_queue_pop_tail(snippet_offsets
);
2598 g_list_free(temp_list
);
2600 /* if there's no first cursor, skip whole snippet */
2602 cur_index
= pattern
->len
;
2608 static gboolean
snippets_complete_constructs(GeanyEditor
*editor
, gint pos
, const gchar
*word
)
2610 ScintillaObject
*sci
= editor
->sci
;
2612 const gchar
*completion
;
2614 gint ft_id
= editor
->document
->file_type
->id
;
2616 str
= g_strdup(word
);
2619 completion
= snippets_find_completion_by_name(filetypes
[ft_id
]->name
, str
);
2620 if (completion
== NULL
)
2626 /* remove the typed word, it will be added again by the used auto completion
2627 * (not really necessary but this makes the auto completion more flexible,
2628 * e.g. with a completion like hi=hello, so typing "hi<TAB>" will result in "hello") */
2629 str_len
= strlen(str
);
2630 sci_set_selection_start(sci
, pos
- str_len
);
2631 sci_set_selection_end(sci
, pos
);
2632 sci_replace_sel(sci
, "");
2633 pos
-= str_len
; /* pos has changed while deleting */
2635 editor_insert_snippet(editor
, pos
, completion
);
2636 sci_scroll_caret(sci
);
2643 static gboolean
at_eol(ScintillaObject
*sci
, gint pos
)
2645 gint line
= sci_get_line_from_position(sci
, pos
);
2648 /* skip any trailing spaces */
2651 c
= sci_get_char_at(sci
, pos
);
2652 if (c
== ' ' || c
== '\t')
2658 return (pos
== sci_get_line_end_position(sci
, line
));
2662 gboolean
editor_complete_snippet(GeanyEditor
*editor
, gint pos
)
2664 gboolean result
= FALSE
;
2667 ScintillaObject
*sci
;
2669 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2672 if (sci_has_selection(sci
))
2674 /* return if we are editing an existing line (chars on right of cursor) */
2675 if (keybindings_lookup_item(GEANY_KEY_GROUP_EDITOR
,
2676 GEANY_KEYS_EDITOR_COMPLETESNIPPET
)->key
== GDK_space
&&
2677 ! editor_prefs
.complete_snippets_whilst_editing
&& ! at_eol(sci
, pos
))
2680 wc
= snippets_find_completion_by_name("Special", "wordchars");
2681 word
= editor_read_word_stem(editor
, pos
, wc
);
2683 /* prevent completion of "for " */
2685 ! isspace(sci_get_char_at(sci
, pos
- 1))) /* pos points to the line end char so use pos -1 */
2687 sci_start_undo_action(sci
); /* needed because we insert a space separately from construct */
2688 result
= snippets_complete_constructs(editor
, pos
, word
);
2689 sci_end_undo_action(sci
);
2691 sci_cancel(sci
); /* cancel any autocompletion list, etc */
2697 static void insert_closing_tag(GeanyEditor
*editor
, gint pos
, gchar ch
, const gchar
*tag_name
)
2699 ScintillaObject
*sci
= editor
->sci
;
2700 gchar
*to_insert
= NULL
;
2704 const gchar
*gt
= ">";
2705 /* if there is already a '>' behind the cursor, don't add it */
2706 if (sci_get_char_at(sci
, pos
) == '>')
2709 to_insert
= g_strconcat(tag_name
, gt
, NULL
);
2712 to_insert
= g_strconcat("</", tag_name
, ">", NULL
);
2714 sci_start_undo_action(sci
);
2715 sci_replace_sel(sci
, to_insert
);
2717 sci_set_selection(sci
, pos
, pos
);
2718 sci_end_undo_action(sci
);
2724 * (stolen from anjuta and heavily modified)
2725 * This routine will auto complete XML or HTML tags that are still open by closing them
2726 * @param ch The character we are dealing with, currently only works with the '>' character
2727 * @return True if handled, false otherwise
2729 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
)
2731 ScintillaObject
*sci
= editor
->sci
;
2732 gint lexer
= sci_get_lexer(sci
);
2733 gint min
, size
, style
;
2734 gchar
*str_found
, sel
[512];
2735 gboolean result
= FALSE
;
2737 /* If the user has turned us off, quit now.
2738 * This may make sense only in certain languages */
2739 if (! editor_prefs
.auto_close_xml_tags
|| (lexer
!= SCLEX_HTML
&& lexer
!= SCLEX_XML
))
2742 /* return if we are inside any embedded script */
2743 style
= sci_get_style_at(sci
, pos
);
2744 if (style
> SCE_H_XCCOMMENT
&& ! highlighting_is_string_style(lexer
, style
))
2747 /* if ch is /, check for </, else quit */
2748 if (ch
== '/' && sci_get_char_at(sci
, pos
- 2) != '<')
2751 /* Grab the last 512 characters or so */
2752 min
= pos
- (sizeof(sel
) - 1);
2753 if (min
< 0) min
= 0;
2756 return FALSE
; /* Smallest tag is 3 characters e.g. <p> */
2758 sci_get_text_range(sci
, min
, pos
, sel
);
2759 sel
[sizeof(sel
) - 1] = '\0';
2761 if (ch
== '>' && sel
[pos
- min
- 2] == '/')
2762 /* User typed something like "<br/>" */
2767 size
-= 2; /* skip </ */
2768 str_found
= utils_find_open_xml_tag(sel
, size
);
2770 if (lexer
== SCLEX_HTML
&& utils_is_short_html_tag(str_found
))
2774 else if (!EMPTY(str_found
))
2776 insert_closing_tag(editor
, pos
, ch
, str_found
);
2784 /* like sci_get_line_indentation(), but for a string. */
2785 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
)
2788 gsize tab_size
= sci_get_tab_width(editor
->sci
);
2791 g_return_val_if_fail(base_indent
, 0);
2793 for (ptr
= base_indent
; *ptr
!= 0; ptr
++)
2811 /* Handles special cases where HTML is embedded in another language or
2812 * another language is embedded in HTML */
2813 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
)
2815 gint style
, line_start
;
2816 GeanyFiletype
*current_ft
;
2818 g_return_val_if_fail(editor
!= NULL
, NULL
);
2819 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, NULL
);
2821 current_ft
= editor
->document
->file_type
;
2822 line_start
= sci_get_position_from_line(editor
->sci
, line
);
2823 style
= sci_get_style_at(editor
->sci
, line_start
);
2825 /* Handle PHP filetype with embedded HTML */
2826 if (current_ft
->id
== GEANY_FILETYPES_PHP
&& ! is_style_php(style
))
2827 current_ft
= filetypes
[GEANY_FILETYPES_HTML
];
2829 /* Handle languages embedded in HTML */
2830 if (current_ft
->id
== GEANY_FILETYPES_HTML
)
2833 if (style
>= SCE_HJ_DEFAULT
&& style
<= SCE_HJ_REGEX
)
2834 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2836 else if (style
>= SCE_HJA_DEFAULT
&& style
<= SCE_HJA_REGEX
)
2837 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2839 else if (style
>= SCE_HB_DEFAULT
&& style
<= SCE_HB_STRINGEOL
)
2840 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2842 else if (style
>= SCE_HBA_DEFAULT
&& style
<= SCE_HBA_STRINGEOL
)
2843 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2844 /* Embedded Python */
2845 else if (style
>= SCE_HP_DEFAULT
&& style
<= SCE_HP_IDENTIFIER
)
2846 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2848 else if (style
>= SCE_HPA_DEFAULT
&& style
<= SCE_HPA_IDENTIFIER
)
2849 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2851 else if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
2852 style
== SCE_HPHP_COMPLEX_VARIABLE
)
2854 current_ft
= filetypes
[GEANY_FILETYPES_PHP
];
2858 /* Ensure the filetype's config is loaded */
2859 filetypes_load_config(current_ft
->id
, FALSE
);
2865 static void real_comment_multiline(GeanyEditor
*editor
, gint line_start
, gint last_line
)
2868 gchar
*str_begin
, *str_end
;
2869 const gchar
*co
, *cc
;
2873 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
2875 ft
= editor_get_filetype_at_line(editor
, line_start
);
2877 eol
= editor_get_eol_char(editor
);
2878 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2879 g_return_if_reached();
2880 str_begin
= g_strdup_printf("%s%s", (co
!= NULL
) ? co
: "", eol
);
2881 str_end
= g_strdup_printf("%s%s", (cc
!= NULL
) ? cc
: "", eol
);
2883 /* insert the comment strings */
2884 sci_insert_text(editor
->sci
, line_start
, str_begin
);
2885 line_len
= sci_get_position_from_line(editor
->sci
, last_line
+ 2);
2886 sci_insert_text(editor
->sci
, line_len
, str_end
);
2893 /* find @p text inside the range of the current style */
2894 static gint
find_in_current_style(ScintillaObject
*sci
, const gchar
*text
, gboolean backwards
)
2896 gint start
= sci_get_current_position(sci
);
2898 gint len
= sci_get_length(sci
);
2899 gint current_style
= sci_get_style_at(sci
, start
);
2900 struct Sci_TextToFind ttf
;
2902 while (start
> 0 && sci_get_style_at(sci
, start
- 1) == current_style
)
2904 while (end
< len
&& sci_get_style_at(sci
, end
+ 1) == current_style
)
2907 ttf
.lpstrText
= (gchar
*) text
;
2908 ttf
.chrg
.cpMin
= backwards
? end
+ 1 : start
;
2909 ttf
.chrg
.cpMax
= backwards
? start
: end
+ 1;
2910 return sci_find_text(sci
, 0, &ttf
);
2914 static void sci_delete_line(ScintillaObject
*sci
, gint line
)
2916 gint start
= sci_get_position_from_line(sci
, line
);
2917 gint len
= sci_get_line_length(sci
, line
);
2918 SSM(sci
, SCI_DELETERANGE
, start
, len
);
2922 static gboolean
real_uncomment_multiline(GeanyEditor
*editor
)
2924 /* find the beginning of the multi line comment */
2925 gint start
, end
, start_line
, end_line
;
2927 const gchar
*co
, *cc
;
2929 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, FALSE
);
2931 ft
= editor_get_filetype_at_line(editor
, sci_get_current_line(editor
->sci
));
2932 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2933 g_return_val_if_reached(FALSE
);
2935 start
= find_in_current_style(editor
->sci
, co
, TRUE
);
2936 end
= find_in_current_style(editor
->sci
, cc
, FALSE
);
2938 if (start
< 0 || end
< 0 || start
> end
/* who knows */)
2941 start_line
= sci_get_line_from_position(editor
->sci
, start
);
2942 end_line
= sci_get_line_from_position(editor
->sci
, end
);
2944 /* remove comment close chars */
2945 SSM(editor
->sci
, SCI_DELETERANGE
, end
, strlen(cc
));
2946 if (sci_is_blank_line(editor
->sci
, end_line
))
2947 sci_delete_line(editor
->sci
, end_line
);
2949 /* remove comment open chars (do it last since it would move the end position) */
2950 SSM(editor
->sci
, SCI_DELETERANGE
, start
, strlen(co
));
2951 if (sci_is_blank_line(editor
->sci
, start_line
))
2952 sci_delete_line(editor
->sci
, start_line
);
2958 static gint
get_multiline_comment_style(GeanyEditor
*editor
, gint line_start
)
2960 gint lexer
= sci_get_lexer(editor
->sci
);
2963 /* List only those lexers which support multi line comments */
2968 case SCLEX_PHPSCRIPT
:
2970 if (is_style_php(sci_get_style_at(editor
->sci
, line_start
)))
2971 style_comment
= SCE_HPHP_COMMENT
;
2973 style_comment
= SCE_H_COMMENT
;
2977 case SCLEX_LITERATEHASKELL
:
2978 style_comment
= SCE_HA_COMMENTBLOCK
; break;
2979 case SCLEX_LUA
: style_comment
= SCE_LUA_COMMENT
; break;
2980 case SCLEX_CSS
: style_comment
= SCE_CSS_COMMENT
; break;
2981 case SCLEX_SQL
: style_comment
= SCE_SQL_COMMENT
; break;
2982 case SCLEX_CAML
: style_comment
= SCE_CAML_COMMENT
; break;
2983 case SCLEX_D
: style_comment
= SCE_D_COMMENT
; break;
2984 case SCLEX_PASCAL
: style_comment
= SCE_PAS_COMMENT
; break;
2985 case SCLEX_RUST
: style_comment
= SCE_RUST_COMMENTBLOCK
; break;
2986 default: style_comment
= SCE_C_COMMENT
;
2989 return style_comment
;
2993 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise
2994 * returns the amount of uncommented single comment lines, in case of multi line uncomment
2995 * it returns just 1 */
2996 gint
editor_do_uncomment(GeanyEditor
*editor
, gint line
, gboolean toggle
)
2998 gint first_line
, last_line
;
2999 gint x
, i
, line_start
, line_len
;
3000 gint sel_start
, sel_end
;
3004 const gchar
*co
, *cc
;
3005 gboolean single_line
= FALSE
;
3008 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
3011 { /* use selection or current line */
3012 sel_start
= sci_get_selection_start(editor
->sci
);
3013 sel_end
= sci_get_selection_end(editor
->sci
);
3015 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3016 /* Find the last line with chars selected (not EOL char) */
3017 last_line
= sci_get_line_from_position(editor
->sci
,
3018 sel_end
- editor_get_eol_char_len(editor
));
3019 last_line
= MAX(first_line
, last_line
);
3023 first_line
= last_line
= line
;
3024 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3027 ft
= editor_get_filetype_at_line(editor
, first_line
);
3029 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3032 co_len
= strlen(co
);
3036 sci_start_undo_action(editor
->sci
);
3038 for (i
= first_line
; i
<= last_line
; i
++)
3042 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3043 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3046 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3049 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3050 sel
[buf_len
] = '\0';
3052 while (isspace(sel
[x
])) x
++;
3054 /* to skip blank lines */
3055 if (x
< line_len
&& sel
[x
] != '\0')
3057 /* use single line comment */
3064 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3065 if (strncmp(sel
+ x
, co
, co_len
) != 0 ||
3066 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) != 0)
3073 if (strncmp(sel
+ x
, co
, co_len
) != 0)
3077 sci_set_selection(editor
->sci
, line_start
+ x
, line_start
+ x
+ co_len
);
3078 sci_replace_sel(editor
->sci
, "");
3081 /* use multi line comment */
3086 /* skip lines which are already comments */
3087 style_comment
= get_multiline_comment_style(editor
, line_start
);
3088 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3090 if (real_uncomment_multiline(editor
))
3094 /* break because we are already on the last line */
3099 sci_end_undo_action(editor
->sci
);
3101 /* restore selection if there is one
3102 * but don't touch the selection if caller is editor_do_comment_toggle */
3103 if (! toggle
&& sel_start
< sel_end
)
3107 sci_set_selection_start(editor
->sci
, sel_start
- co_len
);
3108 sci_set_selection_end(editor
->sci
, sel_end
- (count
* co_len
));
3112 gint eol_len
= editor_get_eol_char_len(editor
);
3113 sci_set_selection_start(editor
->sci
, sel_start
- co_len
- eol_len
);
3114 sci_set_selection_end(editor
->sci
, sel_end
- co_len
- eol_len
);
3122 void editor_do_comment_toggle(GeanyEditor
*editor
)
3124 gint first_line
, last_line
;
3125 gint x
, i
, line_start
, line_len
, first_line_start
, last_line_start
;
3126 gint sel_start
, sel_end
;
3127 gint count_commented
= 0, count_uncommented
= 0;
3129 const gchar
*co
, *cc
;
3130 gboolean break_loop
= FALSE
, single_line
= FALSE
;
3131 gboolean first_line_was_comment
= FALSE
;
3132 gboolean last_line_was_comment
= FALSE
;
3134 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3137 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3139 sel_start
= sci_get_selection_start(editor
->sci
);
3140 sel_end
= sci_get_selection_end(editor
->sci
);
3142 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3143 /* Find the last line with chars selected (not EOL char) */
3144 last_line
= sci_get_line_from_position(editor
->sci
,
3145 sel_end
- editor_get_eol_char_len(editor
));
3146 last_line
= MAX(first_line
, last_line
);
3148 first_line_start
= sci_get_position_from_line(editor
->sci
, first_line
);
3149 last_line_start
= sci_get_position_from_line(editor
->sci
, last_line
);
3151 ft
= editor_get_filetype_at_line(editor
, first_line
);
3153 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3156 co_len
= strlen(co
);
3160 sci_start_undo_action(editor
->sci
);
3162 for (i
= first_line
; (i
<= last_line
) && (! break_loop
); i
++)
3166 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3167 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3170 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3173 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3174 sel
[buf_len
] = '\0';
3176 while (isspace(sel
[x
])) x
++;
3178 /* use single line comment */
3181 gboolean do_continue
= FALSE
;
3184 if (strncmp(sel
+ x
, co
, co_len
) == 0 &&
3185 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) == 0)
3190 if (do_continue
&& i
== first_line
)
3191 first_line_was_comment
= TRUE
;
3192 last_line_was_comment
= do_continue
;
3196 count_uncommented
+= editor_do_uncomment(editor
, i
, TRUE
);
3200 /* we are still here, so the above lines were not already comments, so comment it */
3201 count_commented
+= editor_do_comment(editor
, i
, FALSE
, TRUE
, TRUE
);
3203 /* use multi line comment */
3208 /* skip lines which are already comments */
3209 style_comment
= get_multiline_comment_style(editor
, line_start
);
3210 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3212 if (real_uncomment_multiline(editor
))
3213 count_uncommented
++;
3217 real_comment_multiline(editor
, line_start
, last_line
);
3221 /* break because we are already on the last line */
3227 sci_end_undo_action(editor
->sci
);
3231 /* restore selection or caret position */
3234 gint a
= (first_line_was_comment
) ? - (gint
) co_len
: (gint
) co_len
;
3237 /* don't modify sel_start when the selection starts within indentation */
3238 read_indent(editor
, sel_start
);
3239 indent_len
= (gint
) strlen(indent
);
3240 if ((sel_start
- first_line_start
) <= indent_len
)
3242 /* if the selection start was inside the comment mark, adjust the position */
3243 else if (first_line_was_comment
&&
3244 sel_start
>= (first_line_start
+ indent_len
) &&
3245 sel_start
<= (first_line_start
+ indent_len
+ (gint
) co_len
))
3247 a
= (first_line_start
+ indent_len
) - sel_start
;
3250 if (sel_start
< sel_end
)
3252 gint b
= (count_commented
* (gint
) co_len
) - (count_uncommented
* (gint
) co_len
);
3254 /* same for selection end, but here we add an offset on the offset above */
3255 read_indent(editor
, sel_end
+ b
);
3256 indent_len
= (gint
) strlen(indent
);
3257 if ((sel_end
- last_line_start
) < indent_len
)
3258 b
+= last_line_was_comment
? (gint
) co_len
: -(gint
) co_len
;
3259 else if (last_line_was_comment
&&
3260 sel_end
>= (last_line_start
+ indent_len
) &&
3261 sel_end
<= (last_line_start
+ indent_len
+ (gint
) co_len
))
3263 b
+= (gint
) co_len
- (sel_end
- (last_line_start
+ indent_len
));
3266 sci_set_selection_start(editor
->sci
, sel_start
+ a
);
3267 sci_set_selection_end(editor
->sci
, sel_end
+ b
);
3270 sci_set_current_position(editor
->sci
, sel_start
+ a
, TRUE
);
3274 gint eol_len
= editor_get_eol_char_len(editor
);
3275 if (count_uncommented
> 0)
3277 sci_set_selection_start(editor
->sci
, sel_start
- (gint
) co_len
+ eol_len
);
3278 sci_set_selection_end(editor
->sci
, sel_end
- (gint
) co_len
+ eol_len
);
3280 else if (count_commented
> 0)
3282 sci_set_selection_start(editor
->sci
, sel_start
+ (gint
) co_len
- eol_len
);
3283 sci_set_selection_end(editor
->sci
, sel_end
+ (gint
) co_len
- eol_len
);
3285 if (sel_start
>= sel_end
)
3286 sci_scroll_caret(editor
->sci
);
3291 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise */
3292 gint
editor_do_comment(GeanyEditor
*editor
, gint line
, gboolean allow_empty_lines
, gboolean toggle
,
3293 gboolean single_comment
)
3295 gint first_line
, last_line
;
3296 gint x
, i
, line_start
, line_len
;
3297 gint sel_start
, sel_end
, co_len
;
3300 const gchar
*co
, *cc
;
3301 gboolean break_loop
= FALSE
, single_line
= FALSE
;
3304 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
3307 { /* use selection or current line */
3308 sel_start
= sci_get_selection_start(editor
->sci
);
3309 sel_end
= sci_get_selection_end(editor
->sci
);
3311 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3312 /* Find the last line with chars selected (not EOL char) */
3313 last_line
= sci_get_line_from_position(editor
->sci
,
3314 sel_end
- editor_get_eol_char_len(editor
));
3315 last_line
= MAX(first_line
, last_line
);
3319 first_line
= last_line
= line
;
3320 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3323 ft
= editor_get_filetype_at_line(editor
, first_line
);
3325 if (! filetype_get_comment_open_close(ft
, single_comment
, &co
, &cc
))
3328 co_len
= strlen(co
);
3332 sci_start_undo_action(editor
->sci
);
3334 for (i
= first_line
; (i
<= last_line
) && (! break_loop
); i
++)
3338 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3339 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3342 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3345 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3346 sel
[buf_len
] = '\0';
3348 while (isspace(sel
[x
])) x
++;
3350 /* to skip blank lines */
3351 if (allow_empty_lines
|| (x
< line_len
&& sel
[x
] != '\0'))
3353 /* use single line comment */
3356 gint start
= line_start
;
3359 if (ft
->comment_use_indent
)
3360 start
= line_start
+ x
;
3364 gchar
*text
= g_strconcat(co
, editor_prefs
.comment_toggle_mark
, NULL
);
3365 sci_insert_text(editor
->sci
, start
, text
);
3369 sci_insert_text(editor
->sci
, start
, co
);
3372 /* use multi line comment */
3377 /* skip lines which are already comments */
3378 style_comment
= get_multiline_comment_style(editor
, line_start
);
3379 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3382 real_comment_multiline(editor
, line_start
, last_line
);
3385 /* break because we are already on the last line */
3391 sci_end_undo_action(editor
->sci
);
3393 /* restore selection if there is one
3394 * but don't touch the selection if caller is editor_do_comment_toggle */
3395 if (! toggle
&& sel_start
< sel_end
)
3399 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
);
3400 sci_set_selection_end(editor
->sci
, sel_end
+ (count
* co_len
));
3404 gint eol_len
= editor_get_eol_char_len(editor
);
3405 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
+ eol_len
);
3406 sci_set_selection_end(editor
->sci
, sel_end
+ co_len
+ eol_len
);
3413 static gboolean brace_timeout_active
= FALSE
;
3415 static gboolean
delay_match_brace(G_GNUC_UNUSED gpointer user_data
)
3417 GeanyDocument
*doc
= document_get_current();
3418 GeanyEditor
*editor
;
3419 gint brace_pos
= GPOINTER_TO_INT(user_data
);
3420 gint end_pos
, cur_pos
;
3422 brace_timeout_active
= FALSE
;
3426 editor
= doc
->editor
;
3427 cur_pos
= sci_get_current_position(editor
->sci
) - 1;
3429 if (cur_pos
!= brace_pos
)
3432 if (cur_pos
!= brace_pos
)
3434 /* we have moved past the original brace_pos, but after the timeout
3435 * we may now be on a new brace, so check again */
3436 editor_highlight_braces(editor
, cur_pos
);
3440 if (!utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3442 editor_highlight_braces(editor
, cur_pos
);
3445 end_pos
= sci_find_matching_brace(editor
->sci
, brace_pos
);
3449 gint col
= MIN(sci_get_col_from_position(editor
->sci
, brace_pos
),
3450 sci_get_col_from_position(editor
->sci
, end_pos
));
3451 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, col
, 0);
3452 SSM(editor
->sci
, SCI_BRACEHIGHLIGHT
, brace_pos
, end_pos
);
3456 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3457 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, brace_pos
, 0);
3463 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
)
3465 gint brace_pos
= cur_pos
- 1;
3467 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3468 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, (uptr_t
)-1, 0);
3470 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3473 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3478 if (!brace_timeout_active
)
3480 brace_timeout_active
= TRUE
;
3481 /* delaying matching makes scrolling faster e.g. holding down arrow keys */
3482 g_timeout_add(100, delay_match_brace
, GINT_TO_POINTER(brace_pos
));
3487 static gboolean
in_block_comment(gint lexer
, gint style
)
3493 return (style
== SCE_C_COMMENT
||
3494 style
== SCE_C_COMMENTDOC
);
3497 return (style
== SCE_PAS_COMMENT
||
3498 style
== SCE_PAS_COMMENT2
);
3501 return (style
== SCE_D_COMMENT
||
3502 style
== SCE_D_COMMENTDOC
||
3503 style
== SCE_D_COMMENTNESTED
);
3506 case SCLEX_PHPSCRIPT
:
3507 return (style
== SCE_HPHP_COMMENT
);
3510 return (style
== SCE_CSS_COMMENT
);
3513 return (style
== SCE_RUST_COMMENTBLOCK
||
3514 style
== SCE_RUST_COMMENTBLOCKDOC
);
3522 static gboolean
is_comment_char(gchar c
, gint lexer
)
3524 if ((c
== '*' || c
== '+') && lexer
== SCLEX_D
)
3534 static void auto_multiline(GeanyEditor
*editor
, gint cur_line
)
3536 ScintillaObject
*sci
= editor
->sci
;
3537 gint indent_pos
, style
;
3538 gint lexer
= sci_get_lexer(sci
);
3540 /* Use the start of the line enter was pressed on, to avoid any doc keyword styles */
3541 indent_pos
= sci_get_line_indent_position(sci
, cur_line
- 1);
3542 style
= sci_get_style_at(sci
, indent_pos
);
3543 if (!in_block_comment(lexer
, style
))
3546 /* Check whether the comment block continues on this line */
3547 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3548 if (sci_get_style_at(sci
, indent_pos
) == style
|| indent_pos
>= sci_get_length(sci
))
3550 gchar
*previous_line
= sci_get_line(sci
, cur_line
- 1);
3551 /* the type of comment, '*' (C/C++/Java), '+' and the others (D) */
3552 const gchar
*continuation
= "*";
3553 const gchar
*whitespace
= ""; /* to hold whitespace if needed */
3555 gint len
= strlen(previous_line
);
3558 /* find and stop at end of multi line comment */
3560 while (i
>= 0 && isspace(previous_line
[i
])) i
--;
3561 if (i
>= 1 && is_comment_char(previous_line
[i
- 1], lexer
) && previous_line
[i
] == '/')
3563 gint indent_len
, indent_width
;
3565 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3566 indent_len
= sci_get_col_from_position(sci
, indent_pos
);
3567 indent_width
= editor_get_indent_prefs(editor
)->width
;
3569 /* if there is one too many spaces, delete the last space,
3570 * to return to the indent used before the multiline comment was started. */
3571 if (indent_len
% indent_width
== 1)
3572 SSM(sci
, SCI_DELETEBACKNOTLINE
, 0, 0); /* remove whitespace indent */
3573 g_free(previous_line
);
3576 /* check whether we are on the second line of multi line comment */
3578 while (i
< len
&& isspace(previous_line
[i
])) i
++; /* get to start of the line */
3581 previous_line
[i
] == '/' && is_comment_char(previous_line
[i
+ 1], lexer
))
3582 { /* we are on the second line of a multi line comment, so we have to insert white space */
3586 if (style
== SCE_D_COMMENTNESTED
)
3587 continuation
= "+"; /* for nested comments in D */
3589 result
= g_strconcat(whitespace
, continuation
, " ", NULL
);
3590 sci_add_text(sci
, result
);
3593 g_free(previous_line
);
3599 static gboolean
editor_lexer_is_c_like(gint lexer
)
3614 /* inserts a three-line comment at one line above current cursor position */
3615 void editor_insert_multiline_comment(GeanyEditor
*editor
)
3621 gboolean have_multiline_comment
= FALSE
;
3623 const gchar
*co
, *cc
;
3625 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3627 if (! filetype_get_comment_open_close(editor
->document
->file_type
, FALSE
, &co
, &cc
))
3628 g_return_if_reached();
3630 have_multiline_comment
= TRUE
;
3632 sci_start_undo_action(editor
->sci
);
3634 doc
= editor
->document
;
3636 /* insert three lines one line above of the current position */
3637 line
= sci_get_line_from_position(editor
->sci
, editor_info
.click_pos
);
3638 pos
= sci_get_position_from_line(editor
->sci
, line
);
3640 /* use the indent on the current line but only when comment indentation is used
3641 * and we don't have multi line comment characters */
3642 if (editor
->auto_indent
&&
3643 ! have_multiline_comment
&& doc
->file_type
->comment_use_indent
)
3645 read_indent(editor
, editor_info
.click_pos
);
3646 text
= g_strdup_printf("%s\n%s\n%s\n", indent
, indent
, indent
);
3647 text_len
= strlen(text
);
3651 text
= g_strdup("\n\n\n");
3654 sci_insert_text(editor
->sci
, pos
, text
);
3657 /* select the inserted lines for commenting */
3658 sci_set_selection_start(editor
->sci
, pos
);
3659 sci_set_selection_end(editor
->sci
, pos
+ text_len
);
3661 editor_do_comment(editor
, -1, TRUE
, FALSE
, FALSE
);
3663 /* set the current position to the start of the first inserted line */
3666 /* on multi line comment jump to the next line, otherwise add the length of added indentation */
3667 if (have_multiline_comment
)
3670 pos
+= strlen(indent
);
3672 sci_set_current_position(editor
->sci
, pos
, TRUE
);
3673 /* reset the selection */
3674 sci_set_anchor(editor
->sci
, pos
);
3676 sci_end_undo_action(editor
->sci
);
3680 /* Note: If the editor is pending a redraw, set document::scroll_percent instead.
3681 * Scroll the view to make line appear at percent_of_view.
3682 * line can be -1 to use the current position. */
3683 void editor_scroll_to_line(GeanyEditor
*editor
, gint line
, gfloat percent_of_view
)
3688 g_return_if_fail(editor
!= NULL
);
3690 wid
= GTK_WIDGET(editor
->sci
);
3692 if (! gtk_widget_get_window(wid
) || ! gdk_window_is_viewable(gtk_widget_get_window(wid
)))
3693 return; /* prevent gdk_window_scroll warning */
3696 line
= sci_get_current_line(editor
->sci
);
3698 /* sci 'visible line' != doc line number because of folding and line wrapping */
3699 /* calling SCI_VISIBLEFROMDOCLINE for line is more accurate than calling
3700 * SCI_DOCLINEFROMVISIBLE for vis1. */
3701 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0);
3702 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
3703 line
= line
- los
* percent_of_view
;
3704 SSM(editor
->sci
, SCI_SETFIRSTVISIBLELINE
, line
, 0);
3705 sci_scroll_caret(editor
->sci
); /* needed for horizontal scrolling */
3709 /* creates and inserts one tab or whitespace of the amount of the tab width */
3710 void editor_insert_alternative_whitespace(GeanyEditor
*editor
)
3713 GeanyIndentPrefs iprefs
= *editor_get_indent_prefs(editor
);
3715 g_return_if_fail(editor
!= NULL
);
3717 switch (iprefs
.type
)
3719 case GEANY_INDENT_TYPE_TABS
:
3720 iprefs
.type
= GEANY_INDENT_TYPE_SPACES
;
3722 case GEANY_INDENT_TYPE_SPACES
:
3723 case GEANY_INDENT_TYPE_BOTH
: /* most likely we want a tab */
3724 iprefs
.type
= GEANY_INDENT_TYPE_TABS
;
3727 text
= get_whitespace(&iprefs
, iprefs
.width
);
3728 sci_add_text(editor
->sci
, text
);
3733 void editor_select_word(GeanyEditor
*editor
)
3739 g_return_if_fail(editor
!= NULL
);
3741 pos
= SSM(editor
->sci
, SCI_GETCURRENTPOS
, 0, 0);
3742 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
3743 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
3745 if (start
== end
) /* caret in whitespaces sequence */
3747 /* look forward but reverse the selection direction,
3748 * so the caret end up stay as near as the original position. */
3749 end
= sci_word_end_position(editor
->sci
, pos
, FALSE
);
3750 start
= sci_word_end_position(editor
->sci
, end
, TRUE
);
3755 sci_set_selection(editor
->sci
, start
, end
);
3759 /* extra_line is for selecting the cursor line (or anchor line) at the bottom of a selection,
3760 * when those lines have no selection (cursor at start of line). */
3761 void editor_select_lines(GeanyEditor
*editor
, gboolean extra_line
)
3763 gint start
, end
, line
;
3765 g_return_if_fail(editor
!= NULL
);
3767 start
= sci_get_selection_start(editor
->sci
);
3768 end
= sci_get_selection_end(editor
->sci
);
3770 /* check if whole lines are already selected */
3771 if (! extra_line
&& start
!= end
&&
3772 sci_get_col_from_position(editor
->sci
, start
) == 0 &&
3773 sci_get_col_from_position(editor
->sci
, end
) == 0)
3776 line
= sci_get_line_from_position(editor
->sci
, start
);
3777 start
= sci_get_position_from_line(editor
->sci
, line
);
3779 line
= sci_get_line_from_position(editor
->sci
, end
);
3780 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
3782 sci_set_selection(editor
->sci
, start
, end
);
3786 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
)
3788 return sci_get_line_indent_position(sci
, line
) ==
3789 sci_get_line_end_position(sci
, line
);
3793 /* Returns first line of paragraph for GTK_DIR_UP, line after paragraph
3794 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3795 static gint
find_paragraph_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3798 ScintillaObject
*sci
= editor
->sci
;
3800 /* first check current line and return -1 if it is empty to skip creating of a selection */
3801 if (sci_is_blank_line(sci
, line
))
3804 if (direction
== GTK_DIR_UP
)
3814 /* start of document */
3818 if (line
== sci_get_line_count(sci
))
3821 if (sci_is_blank_line(sci
, line
))
3823 /* return line paragraph starts on */
3824 if (direction
== GTK_DIR_UP
)
3833 void editor_select_paragraph(GeanyEditor
*editor
)
3835 gint pos_start
, pos_end
, line_start
, line_found
;
3837 g_return_if_fail(editor
!= NULL
);
3839 line_start
= sci_get_current_line(editor
->sci
);
3841 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_UP
);
3842 if (line_found
== -1)
3845 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3847 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_DOWN
);
3848 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3850 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3854 /* Returns first line of block for GTK_DIR_UP, line after block
3855 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3856 static gint
find_block_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3859 ScintillaObject
*sci
= editor
->sci
;
3861 /* first check current line and return -1 if it is empty to skip creating of a selection */
3862 if (sci_is_blank_line(sci
, line
))
3865 if (direction
== GTK_DIR_UP
)
3870 ind
= sci_get_line_indentation(sci
, line
);
3876 /* start of document */
3880 if (line
== sci_get_line_count(sci
))
3883 if (sci_get_line_indentation(sci
, line
) != ind
||
3884 sci_is_blank_line(sci
, line
))
3886 /* return line block starts on */
3887 if (direction
== GTK_DIR_UP
)
3896 void editor_select_indent_block(GeanyEditor
*editor
)
3898 gint pos_start
, pos_end
, line_start
, line_found
;
3900 g_return_if_fail(editor
!= NULL
);
3902 line_start
= sci_get_current_line(editor
->sci
);
3904 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_UP
);
3905 if (line_found
== -1)
3908 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3910 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_DOWN
);
3911 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3913 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3917 /* simple indentation to indent the current line with the same indent as the previous one */
3918 static void smart_line_indentation(GeanyEditor
*editor
, gint first_line
, gint last_line
)
3920 gint i
, sel_start
= 0, sel_end
= 0;
3922 /* get previous line and use it for read_indent to use that line
3923 * (otherwise it would fail on a line only containing "{" in advanced indentation mode) */
3924 read_indent(editor
, sci_get_position_from_line(editor
->sci
, first_line
- 1));
3926 for (i
= first_line
; i
<= last_line
; i
++)
3928 /* skip the first line or if the indentation of the previous and current line are equal */
3930 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
- 1, 0) ==
3931 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
, 0))
3934 sel_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3935 sel_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3936 if (sel_start
< sel_end
)
3938 sci_set_selection(editor
->sci
, sel_start
, sel_end
);
3939 sci_replace_sel(editor
->sci
, "");
3941 sci_insert_text(editor
->sci
, sel_start
, indent
);
3946 /* simple indentation to indent the current line with the same indent as the previous one */
3947 void editor_smart_line_indentation(GeanyEditor
*editor
, gint pos
)
3949 gint first_line
, last_line
;
3950 gint first_sel_start
, first_sel_end
;
3951 ScintillaObject
*sci
;
3953 g_return_if_fail(editor
!= NULL
);
3957 first_sel_start
= sci_get_selection_start(sci
);
3958 first_sel_end
= sci_get_selection_end(sci
);
3960 first_line
= sci_get_line_from_position(sci
, first_sel_start
);
3961 /* Find the last line with chars selected (not EOL char) */
3962 last_line
= sci_get_line_from_position(sci
, first_sel_end
- editor_get_eol_char_len(editor
));
3963 last_line
= MAX(first_line
, last_line
);
3966 pos
= first_sel_start
;
3968 sci_start_undo_action(sci
);
3970 smart_line_indentation(editor
, first_line
, last_line
);
3972 /* set cursor position if there was no selection */
3973 if (first_sel_start
== first_sel_end
)
3975 gint indent_pos
= SSM(sci
, SCI_GETLINEINDENTPOSITION
, first_line
, 0);
3977 /* use indent position as user may wish to change indentation afterwards */
3978 sci_set_current_position(sci
, indent_pos
, FALSE
);
3982 /* fully select all the lines affected */
3983 sci_set_selection_start(sci
, sci_get_position_from_line(sci
, first_line
));
3984 sci_set_selection_end(sci
, sci_get_position_from_line(sci
, last_line
+ 1));
3987 sci_end_undo_action(sci
);
3991 /* increase / decrease current line or selection by one space */
3992 void editor_indentation_by_one_space(GeanyEditor
*editor
, gint pos
, gboolean decrease
)
3994 gint i
, first_line
, last_line
, line_start
, indentation_end
, count
= 0;
3995 gint sel_start
, sel_end
, first_line_offset
= 0;
3997 g_return_if_fail(editor
!= NULL
);
3999 sel_start
= sci_get_selection_start(editor
->sci
);
4000 sel_end
= sci_get_selection_end(editor
->sci
);
4002 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
4003 /* Find the last line with chars selected (not EOL char) */
4004 last_line
= sci_get_line_from_position(editor
->sci
, sel_end
- editor_get_eol_char_len(editor
));
4005 last_line
= MAX(first_line
, last_line
);
4010 sci_start_undo_action(editor
->sci
);
4012 for (i
= first_line
; i
<= last_line
; i
++)
4014 indentation_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
4017 line_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
4018 /* searching backwards for a space to remove */
4019 while (sci_get_char_at(editor
->sci
, indentation_end
) != ' ' && indentation_end
> line_start
)
4022 if (sci_get_char_at(editor
->sci
, indentation_end
) == ' ')
4024 sci_set_selection(editor
->sci
, indentation_end
, indentation_end
+ 1);
4025 sci_replace_sel(editor
->sci
, "");
4027 if (i
== first_line
)
4028 first_line_offset
= -1;
4033 sci_insert_text(editor
->sci
, indentation_end
, " ");
4035 if (i
== first_line
)
4036 first_line_offset
= 1;
4040 /* set cursor position */
4041 if (sel_start
< sel_end
)
4043 gint start
= sel_start
+ first_line_offset
;
4044 if (first_line_offset
< 0)
4045 start
= MAX(sel_start
+ first_line_offset
,
4046 SSM(editor
->sci
, SCI_POSITIONFROMLINE
, first_line
, 0));
4048 sci_set_selection_start(editor
->sci
, start
);
4049 sci_set_selection_end(editor
->sci
, sel_end
+ count
);
4052 sci_set_current_position(editor
->sci
, pos
+ count
, FALSE
);
4054 sci_end_undo_action(editor
->sci
);
4058 void editor_finalize(void)
4060 scintilla_release_resources();
4064 /* wordchars: NULL or a string containing characters to match a word.
4065 * Returns: the current selection or the current word.
4067 * Passing NULL as wordchars is NOT the same as passing GEANY_WORDCHARS: NULL means
4068 * using Scintillas's word boundaries. */
4069 gchar
*editor_get_default_selection(GeanyEditor
*editor
, gboolean use_current_word
,
4070 const gchar
*wordchars
)
4074 g_return_val_if_fail(editor
!= NULL
, NULL
);
4076 if (sci_get_lines_selected(editor
->sci
) == 1)
4077 s
= sci_get_selection_contents(editor
->sci
);
4078 else if (sci_get_lines_selected(editor
->sci
) == 0 && use_current_word
)
4079 { /* use the word at current cursor position */
4080 gchar word
[GEANY_MAX_WORD_LENGTH
];
4082 if (wordchars
!= NULL
)
4083 editor_find_current_word(editor
, -1, word
, sizeof(word
), wordchars
);
4085 editor_find_current_word_sciwc(editor
, -1, word
, sizeof(word
));
4087 if (word
[0] != '\0')
4094 /* Note: Usually the line should be made visible (not folded) before calling this.
4095 * Returns: TRUE if line is/will be displayed to the user, or FALSE if it is
4096 * outside the *vertical* view.
4097 * Warning: You may need horizontal scrolling to make the cursor visible - so always call
4098 * sci_scroll_caret() when this returns TRUE. */
4099 gboolean
editor_line_in_view(GeanyEditor
*editor
, gint line
)
4103 g_return_val_if_fail(editor
!= NULL
, FALSE
);
4105 /* If line is wrapped the result may occur on another virtual line than the first and may be
4106 * still hidden, so increase the line number to check for the next document line */
4107 if (SSM(editor
->sci
, SCI_WRAPCOUNT
, line
, 0) > 1)
4110 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0); /* convert to visible line number */
4111 vis1
= SSM(editor
->sci
, SCI_GETFIRSTVISIBLELINE
, 0, 0);
4112 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
4114 return (line
>= vis1
&& line
< vis1
+ los
);
4118 /* If the current line is outside the current view window, scroll the line
4119 * so it appears at percent_of_view. */
4120 void editor_display_current_line(GeanyEditor
*editor
, gfloat percent_of_view
)
4124 g_return_if_fail(editor
!= NULL
);
4126 line
= sci_get_current_line(editor
->sci
);
4128 /* unfold maybe folded results */
4129 sci_ensure_line_is_visible(editor
->sci
, line
);
4131 /* scroll the line if it's off screen */
4132 if (! editor_line_in_view(editor
, line
))
4133 editor
->scroll_percent
= percent_of_view
;
4135 sci_scroll_caret(editor
->sci
); /* may need horizontal scrolling */
4140 * Deletes all currently set indicators in the @a editor window.
4141 * Error indicators (red squiggly underlines) and usual line markers are removed.
4143 * @param editor The editor to operate on.
4145 void editor_indicator_clear_errors(GeanyEditor
*editor
)
4147 editor_indicator_clear(editor
, GEANY_INDICATOR_ERROR
);
4148 sci_marker_delete_all(editor
->sci
, 0); /* remove the yellow error line marker */
4153 * Deletes all currently set indicators matching @a indic in the @a editor window.
4155 * @param editor The editor to operate on.
4156 * @param indic The indicator number to clear, this is a value of @ref GeanyIndicator.
4161 void editor_indicator_clear(GeanyEditor
*editor
, gint indic
)
4165 g_return_if_fail(editor
!= NULL
);
4167 last_pos
= sci_get_length(editor
->sci
);
4170 sci_indicator_set(editor
->sci
, indic
);
4171 sci_indicator_clear(editor
->sci
, 0, last_pos
);
4177 * Sets an indicator @a indic on @a line.
4178 * Whitespace at the start and the end of the line is not marked.
4180 * @param editor The editor to operate on.
4181 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4182 * @param line The line number which should be marked.
4187 void editor_indicator_set_on_line(GeanyEditor
*editor
, gint indic
, gint line
)
4193 g_return_if_fail(editor
!= NULL
);
4194 g_return_if_fail(line
>= 0);
4196 start
= sci_get_position_from_line(editor
->sci
, line
);
4197 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
4199 /* skip blank lines */
4200 if ((start
+ 1) == end
||
4202 (sci_get_line_end_position(editor
->sci
, line
) - start
) == 0)
4208 linebuf
= sci_get_line(editor
->sci
, line
);
4210 /* don't set the indicator on whitespace */
4211 while (isspace(linebuf
[i
]))
4213 while (len
> 1 && len
> i
&& isspace(linebuf
[len
- 1]))
4220 editor_indicator_set_on_range(editor
, indic
, start
+ i
, end
);
4225 * Sets an indicator on the range specified by @a start and @a end.
4226 * No error checking or whitespace removal is performed, this should be done by the calling
4227 * function if necessary.
4229 * @param editor The editor to operate on.
4230 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4231 * @param start The starting position for the marker.
4232 * @param end The ending position for the marker.
4237 void editor_indicator_set_on_range(GeanyEditor
*editor
, gint indic
, gint start
, gint end
)
4239 g_return_if_fail(editor
!= NULL
);
4243 sci_indicator_set(editor
->sci
, indic
);
4244 sci_indicator_fill(editor
->sci
, start
, end
- start
);
4248 /* Inserts the given colour (format should be #...), if there is a selection starting with 0x...
4249 * the replacement will also start with 0x... */
4250 void editor_insert_color(GeanyEditor
*editor
, const gchar
*colour
)
4252 g_return_if_fail(editor
!= NULL
);
4254 if (sci_has_selection(editor
->sci
))
4256 gint start
= sci_get_selection_start(editor
->sci
);
4257 const gchar
*replacement
= colour
;
4259 if (sci_get_char_at(editor
->sci
, start
) == '0' &&
4260 sci_get_char_at(editor
->sci
, start
+ 1) == 'x')
4262 gint end
= sci_get_selection_end(editor
->sci
);
4264 sci_set_selection_start(editor
->sci
, start
+ 2);
4265 /* we need to also re-set the selection end in case the anchor was located before
4266 * the cursor, since set_selection_start() always moves the cursor, not the anchor */
4267 sci_set_selection_end(editor
->sci
, end
);
4268 replacement
++; /* skip the leading "0x" */
4270 else if (sci_get_char_at(editor
->sci
, start
- 1) == '#')
4271 { /* double clicking something like #00ffff may only select 00ffff because of wordchars */
4272 replacement
++; /* so skip the '#' to only replace the colour value */
4274 sci_replace_sel(editor
->sci
, replacement
);
4277 sci_add_text(editor
->sci
, colour
);
4282 * Retrieves the end of line characters mode (LF, CR/LF, CR) in the given editor.
4283 * If @a editor is @c NULL, the default end of line characters are used.
4285 * @param editor The editor to operate on, or @c NULL to query the default value.
4286 * @return The used end of line characters mode.
4291 gint
editor_get_eol_char_mode(GeanyEditor
*editor
)
4293 gint mode
= file_prefs
.default_eol_character
;
4296 mode
= sci_get_eol_mode(editor
->sci
);
4303 * Retrieves the localized name (for displaying) of the used end of line characters
4304 * (LF, CR/LF, CR) in the given editor.
4305 * If @a editor is @c NULL, the default end of line characters are used.
4307 * @param editor The editor to operate on, or @c NULL to query the default value.
4308 * @return The name of the end of line characters.
4313 const gchar
*editor_get_eol_char_name(GeanyEditor
*editor
)
4315 gint mode
= file_prefs
.default_eol_character
;
4318 mode
= sci_get_eol_mode(editor
->sci
);
4320 return utils_get_eol_name(mode
);
4325 * Retrieves the length of the used end of line characters (LF, CR/LF, CR) in the given editor.
4326 * If @a editor is @c NULL, the default end of line characters are used.
4327 * The returned value is 1 for CR and LF and 2 for CR/LF.
4329 * @param editor The editor to operate on, or @c NULL to query the default value.
4330 * @return The length of the end of line characters.
4335 gint
editor_get_eol_char_len(GeanyEditor
*editor
)
4337 gint mode
= file_prefs
.default_eol_character
;
4340 mode
= sci_get_eol_mode(editor
->sci
);
4344 case SC_EOL_CRLF
: return 2; break;
4345 default: return 1; break;
4351 * Retrieves the used end of line characters (LF, CR/LF, CR) in the given editor.
4352 * If @a editor is @c NULL, the default end of line characters are used.
4353 * The returned value is either "\n", "\r\n" or "\r".
4355 * @param editor The editor to operate on, or @c NULL to query the default value.
4356 * @return The end of line characters.
4361 const gchar
*editor_get_eol_char(GeanyEditor
*editor
)
4363 gint mode
= file_prefs
.default_eol_character
;
4366 mode
= sci_get_eol_mode(editor
->sci
);
4368 return utils_get_eol_char(mode
);
4372 static void fold_all(GeanyEditor
*editor
, gboolean want_fold
)
4374 gint lines
, first
, i
;
4376 if (editor
== NULL
|| ! editor_prefs
.folding
)
4379 lines
= sci_get_line_count(editor
->sci
);
4380 first
= sci_get_first_visible_line(editor
->sci
);
4382 for (i
= 0; i
< lines
; i
++)
4384 gint level
= sci_get_fold_level(editor
->sci
, i
);
4386 if (level
& SC_FOLDLEVELHEADERFLAG
)
4388 if (sci_get_fold_expanded(editor
->sci
, i
) == want_fold
)
4389 sci_toggle_fold(editor
->sci
, i
);
4392 editor_scroll_to_line(editor
, first
, 0.0F
);
4396 void editor_unfold_all(GeanyEditor
*editor
)
4398 fold_all(editor
, FALSE
);
4402 void editor_fold_all(GeanyEditor
*editor
)
4404 fold_all(editor
, TRUE
);
4408 void editor_replace_tabs(GeanyEditor
*editor
, gboolean ignore_selection
)
4410 gint search_pos
, pos_in_line
, current_tab_true_length
;
4411 gint anchor_pos
, caret_pos
;
4414 struct Sci_TextToFind ttf
;
4416 g_return_if_fail(editor
!= NULL
);
4418 sci_start_undo_action(editor
->sci
);
4419 tab_len
= sci_get_tab_width(editor
->sci
);
4420 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4422 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4423 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4428 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4430 ttf
.lpstrText
= (gchar
*) "\t";
4432 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4433 caret_pos
= sci_get_current_position(editor
->sci
);
4436 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4437 if (search_pos
== -1)
4440 pos_in_line
= sci_get_col_from_position(editor
->sci
, search_pos
);
4441 current_tab_true_length
= tab_len
- (pos_in_line
% tab_len
);
4442 tab_str
= g_strnfill(current_tab_true_length
, ' ');
4443 sci_set_target_start(editor
->sci
, search_pos
);
4444 sci_set_target_end(editor
->sci
, search_pos
+ 1);
4445 sci_replace_target(editor
->sci
, tab_str
, FALSE
);
4446 /* next search starts after replacement */
4447 ttf
.chrg
.cpMin
= search_pos
+ current_tab_true_length
- 1;
4448 /* update end of range now text has changed */
4449 ttf
.chrg
.cpMax
+= current_tab_true_length
- 1;
4452 if (anchor_pos
> search_pos
)
4453 anchor_pos
+= current_tab_true_length
- 1;
4454 if (caret_pos
> search_pos
)
4455 caret_pos
+= current_tab_true_length
- 1;
4457 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4458 sci_end_undo_action(editor
->sci
);
4462 /* Replaces all occurrences all spaces of the length of a given tab_width,
4463 * optionally restricting the search to the current selection. */
4464 void editor_replace_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4467 gint anchor_pos
, caret_pos
;
4468 static gdouble tab_len_f
= -1.0; /* keep the last used value */
4471 struct Sci_TextToFind ttf
;
4473 g_return_if_fail(editor
!= NULL
);
4475 if (tab_len_f
< 0.0)
4476 tab_len_f
= sci_get_tab_width(editor
->sci
);
4478 if (! dialogs_show_input_numeric(
4479 _("Enter Tab Width"),
4480 _("Enter the amount of spaces which should be replaced by a tab character."),
4481 &tab_len_f
, 1, 100, 1))
4485 tab_len
= (gint
) tab_len_f
;
4486 text
= g_strnfill(tab_len
, ' ');
4488 sci_start_undo_action(editor
->sci
);
4489 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4491 ttf
.chrg
.cpMin
= sci_get_selection_start(editor
->sci
);
4492 ttf
.chrg
.cpMax
= sci_get_selection_end(editor
->sci
);
4497 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4499 ttf
.lpstrText
= text
;
4501 anchor_pos
= SSM(editor
->sci
, SCI_GETANCHOR
, 0, 0);
4502 caret_pos
= sci_get_current_position(editor
->sci
);
4505 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4506 if (search_pos
== -1)
4508 /* only replace indentation because otherwise we can mess up alignment */
4509 if (search_pos
> sci_get_line_indent_position(editor
->sci
,
4510 sci_get_line_from_position(editor
->sci
, search_pos
)))
4512 ttf
.chrg
.cpMin
= search_pos
+ tab_len
;
4515 sci_set_target_start(editor
->sci
, search_pos
);
4516 sci_set_target_end(editor
->sci
, search_pos
+ tab_len
);
4517 sci_replace_target(editor
->sci
, "\t", FALSE
);
4518 ttf
.chrg
.cpMin
= search_pos
;
4519 /* update end of range now text has changed */
4520 ttf
.chrg
.cpMax
-= tab_len
- 1;
4522 if (anchor_pos
> search_pos
)
4523 anchor_pos
-= tab_len
- 1;
4524 if (caret_pos
> search_pos
)
4525 caret_pos
-= tab_len
- 1;
4527 sci_set_selection(editor
->sci
, anchor_pos
, caret_pos
);
4528 sci_end_undo_action(editor
->sci
);
4533 void editor_strip_line_trailing_spaces(GeanyEditor
*editor
, gint line
)
4535 gint line_start
= sci_get_position_from_line(editor
->sci
, line
);
4536 gint line_end
= sci_get_line_end_position(editor
->sci
, line
);
4537 gint i
= line_end
- 1;
4538 gchar ch
= sci_get_char_at(editor
->sci
, i
);
4540 /* Diff hunks should keep trailing spaces */
4541 if (sci_get_lexer(editor
->sci
) == SCLEX_DIFF
)
4544 while ((i
>= line_start
) && ((ch
== ' ') || (ch
== '\t')))
4547 ch
= sci_get_char_at(editor
->sci
, i
);
4549 if (i
< (line_end
- 1))
4551 sci_set_target_start(editor
->sci
, i
+ 1);
4552 sci_set_target_end(editor
->sci
, line_end
);
4553 sci_replace_target(editor
->sci
, "", FALSE
);
4558 void editor_strip_trailing_spaces(GeanyEditor
*editor
, gboolean ignore_selection
)
4564 if (sci_has_selection(editor
->sci
) && !ignore_selection
)
4566 gint selection_start
= sci_get_selection_start(editor
->sci
);
4567 gint selection_end
= sci_get_selection_end(editor
->sci
);
4569 start_line
= sci_get_line_from_position(editor
->sci
, selection_start
);
4570 end_line
= sci_get_line_from_position(editor
->sci
, selection_end
);
4572 if (sci_get_col_from_position(editor
->sci
, selection_end
) > 0)
4578 end_line
= sci_get_line_count(editor
->sci
);
4581 sci_start_undo_action(editor
->sci
);
4583 for (line
= start_line
; line
< end_line
; line
++)
4585 editor_strip_line_trailing_spaces(editor
, line
);
4587 sci_end_undo_action(editor
->sci
);
4591 void editor_ensure_final_newline(GeanyEditor
*editor
)
4593 gint max_lines
= sci_get_line_count(editor
->sci
);
4594 gboolean append_newline
= (max_lines
== 1);
4595 gint end_document
= sci_get_position_from_line(editor
->sci
, max_lines
);
4599 append_newline
= end_document
> sci_get_position_from_line(editor
->sci
, max_lines
- 1);
4603 const gchar
*eol
= editor_get_eol_char(editor
);
4605 sci_insert_text(editor
->sci
, end_document
, eol
);
4610 void editor_set_font(GeanyEditor
*editor
, const gchar
*font
)
4614 PangoFontDescription
*pfd
;
4616 g_return_if_fail(editor
);
4618 pfd
= pango_font_description_from_string(font
);
4619 size
= pango_font_description_get_size(pfd
) / PANGO_SCALE
;
4620 font_name
= g_strdup_printf("!%s", pango_font_description_get_family(pfd
));
4621 pango_font_description_free(pfd
);
4623 for (style
= 0; style
<= STYLE_MAX
; style
++)
4624 sci_set_font(editor
->sci
, style
, font_name
, size
);
4628 /* zoom to 100% to prevent confusion */
4629 sci_zoom_off(editor
->sci
);
4633 void editor_set_line_wrapping(GeanyEditor
*editor
, gboolean wrap
)
4635 g_return_if_fail(editor
!= NULL
);
4637 editor
->line_wrapping
= wrap
;
4638 sci_set_lines_wrapped(editor
->sci
, wrap
);
4642 /** Sets the indent type for @a editor.
4643 * @param editor Editor.
4644 * @param type Indent type.
4649 void editor_set_indent_type(GeanyEditor
*editor
, GeanyIndentType type
)
4651 editor_set_indent(editor
, type
, editor
->indent_width
);
4655 void editor_set_indent_width(GeanyEditor
*editor
, gint width
)
4657 editor_set_indent(editor
, editor
->indent_type
, width
);
4661 void editor_set_indent(GeanyEditor
*editor
, GeanyIndentType type
, gint width
)
4663 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
4664 ScintillaObject
*sci
= editor
->sci
;
4665 gboolean use_tabs
= type
!= GEANY_INDENT_TYPE_SPACES
;
4667 editor
->indent_type
= type
;
4668 editor
->indent_width
= width
;
4669 sci_set_use_tabs(sci
, use_tabs
);
4671 if (type
== GEANY_INDENT_TYPE_BOTH
)
4673 sci_set_tab_width(sci
, iprefs
->hard_tab_width
);
4674 if (iprefs
->hard_tab_width
!= 8)
4676 static gboolean warn
= TRUE
;
4678 ui_set_statusbar(TRUE
, _("Warning: non-standard hard tab width: %d != 8!"),
4679 iprefs
->hard_tab_width
);
4684 sci_set_tab_width(sci
, width
);
4686 SSM(sci
, SCI_SETINDENT
, width
, 0);
4688 /* remove indent spaces on backspace, if using any spaces to indent */
4689 SSM(sci
, SCI_SETBACKSPACEUNINDENTS
, type
!= GEANY_INDENT_TYPE_TABS
, 0);
4693 /* Convenience function for editor_goto_pos() to pass in a line number. */
4694 gboolean
editor_goto_line(GeanyEditor
*editor
, gint line_no
, gint offset
)
4698 g_return_val_if_fail(editor
, FALSE
);
4699 if (line_no
< 0 || line_no
>= sci_get_line_count(editor
->sci
))
4704 gint current_line
= sci_get_current_line(editor
->sci
);
4706 line_no
= current_line
+ line_no
;
4709 pos
= sci_get_position_from_line(editor
->sci
, line_no
);
4710 return editor_goto_pos(editor
, pos
, TRUE
);
4714 /** Moves to position @a pos, switching to the document if necessary,
4715 * setting a marker if @a mark is set.
4717 * @param editor Editor.
4718 * @param pos The position.
4719 * @param mark Whether to set a mark on the position.
4720 * @return @c TRUE if action has been performed, otherwise @c FALSE.
4725 gboolean
editor_goto_pos(GeanyEditor
*editor
, gint pos
, gboolean mark
)
4727 g_return_val_if_fail(editor
, FALSE
);
4728 if (G_UNLIKELY(pos
< 0))
4733 gint line
= sci_get_line_from_position(editor
->sci
, pos
);
4735 /* mark the tag with the yellow arrow */
4736 sci_marker_delete_all(editor
->sci
, 0);
4737 sci_set_marker_at_line(editor
->sci
, line
, 0);
4740 sci_goto_pos(editor
->sci
, pos
, TRUE
);
4741 editor
->scroll_percent
= 0.25F
;
4743 /* finally switch to the page */
4744 document_show_tab(editor
->document
);
4750 on_editor_scroll_event(GtkWidget
*widget
, GdkEventScroll
*event
, gpointer user_data
)
4752 GeanyEditor
*editor
= user_data
;
4754 /* Handle scroll events if Alt is pressed and scroll whole pages instead of a
4755 * few lines only, maybe this could/should be done in Scintilla directly */
4756 if (event
->state
& GDK_MOD1_MASK
)
4758 sci_send_command(editor
->sci
, (event
->direction
== GDK_SCROLL_DOWN
) ? SCI_PAGEDOWN
: SCI_PAGEUP
);
4761 else if (event
->state
& GDK_SHIFT_MASK
)
4763 gint amount
= (event
->direction
== GDK_SCROLL_DOWN
) ? 8 : -8;
4765 sci_scroll_columns(editor
->sci
, amount
);
4769 return FALSE
; /* let Scintilla handle all other cases */
4773 static gboolean
editor_check_colourise(GeanyEditor
*editor
)
4775 GeanyDocument
*doc
= editor
->document
;
4777 if (!doc
->priv
->colourise_needed
)
4780 doc
->priv
->colourise_needed
= FALSE
;
4782 if (doc
->priv
->full_colourise
)
4784 sci_colourise(editor
->sci
, 0, -1);
4786 /* now that the current document is colourised, fold points are now accurate,
4787 * so force an update of the current function/tag. */
4788 symbols_get_current_function(NULL
, NULL
);
4789 ui_update_statusbar(NULL
, -1);
4793 gint start_line
, end_line
, start
, end
;
4795 start_line
= SSM(doc
->editor
->sci
, SCI_GETFIRSTVISIBLELINE
, 0, 0);
4796 end_line
= start_line
+ SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
4797 start_line
= SSM(editor
->sci
, SCI_DOCLINEFROMVISIBLE
, start_line
, 0);
4798 end_line
= SSM(editor
->sci
, SCI_DOCLINEFROMVISIBLE
, end_line
, 0);
4799 start
= sci_get_position_from_line(editor
->sci
, start_line
);
4800 end
= sci_get_line_end_position(editor
->sci
, end_line
);
4801 sci_colourise(editor
->sci
, start
, end
);
4808 /* We only want to colourise just before drawing, to save startup time and
4809 * prevent unnecessary recolouring other documents after one is saved.
4810 * Really we want a "draw" signal but there doesn't seem to be one (expose is too late,
4811 * and "show" doesn't work). */
4812 static gboolean
on_editor_focus_in(GtkWidget
*widget
, GdkEventFocus
*event
, gpointer user_data
)
4814 GeanyEditor
*editor
= user_data
;
4816 editor_check_colourise(editor
);
4821 static gboolean
on_editor_expose_event(GtkWidget
*widget
, GdkEventExpose
*event
,
4824 GeanyEditor
*editor
= user_data
;
4826 /* This is just to catch any uncolourised documents being drawn that didn't receive focus
4827 * for some reason, maybe it's not necessary but just in case. */
4828 editor_check_colourise(editor
);
4833 #if GTK_CHECK_VERSION(3, 0, 0)
4834 static gboolean
on_editor_draw(GtkWidget
*widget
, cairo_t
*cr
, gpointer user_data
)
4836 return on_editor_expose_event(widget
, NULL
, user_data
);
4841 static void setup_sci_keys(ScintillaObject
*sci
)
4843 /* disable some Scintilla keybindings to be able to redefine them cleanly */
4844 sci_clear_cmdkey(sci
, 'A' | (SCMOD_CTRL
<< 16)); /* select all */
4845 sci_clear_cmdkey(sci
, 'D' | (SCMOD_CTRL
<< 16)); /* duplicate */
4846 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16)); /* line transpose */
4847 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line copy */
4848 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16)); /* line cut */
4849 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line delete */
4850 sci_clear_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to end delete */
4851 sci_clear_cmdkey(sci
, '/' | (SCMOD_CTRL
<< 16)); /* Previous word part */
4852 sci_clear_cmdkey(sci
, '\\' | (SCMOD_CTRL
<< 16)); /* Next word part */
4853 sci_clear_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16)); /* scroll line up */
4854 sci_clear_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16)); /* scroll line down */
4855 sci_clear_cmdkey(sci
, SCK_HOME
); /* line start */
4856 sci_clear_cmdkey(sci
, SCK_END
); /* line end */
4857 sci_clear_cmdkey(sci
, SCK_END
| (SCMOD_ALT
<< 16)); /* visual line end */
4859 if (editor_prefs
.use_gtk_word_boundaries
)
4861 /* use GtkEntry-like word boundaries */
4862 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16), SCI_WORDRIGHTEND
);
4863 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_WORDRIGHTENDEXTEND
);
4864 sci_assign_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16), SCI_DELWORDRIGHTEND
);
4866 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_ALT
<< 16), SCI_LINESCROLLUP
);
4867 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_ALT
<< 16), SCI_LINESCROLLDOWN
);
4868 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16), SCI_PARAUP
);
4869 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARAUPEXTEND
);
4870 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16), SCI_PARADOWN
);
4871 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARADOWNEXTEND
);
4873 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_ALT
<< 16)); /* clear Alt-Backspace (Undo) */
4877 /* registers a Scintilla image from a named icon from the theme */
4878 static gboolean
register_named_icon(ScintillaObject
*sci
, guint id
, const gchar
*name
)
4880 GError
*error
= NULL
;
4882 gint n_channels
, rowstride
, width
, height
;
4885 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &size
, NULL
);
4886 pixbuf
= gtk_icon_theme_load_icon(gtk_icon_theme_get_default(), name
, size
, 0, &error
);
4889 g_warning("failed to load icon '%s': %s", name
, error
->message
);
4890 g_error_free(error
);
4894 n_channels
= gdk_pixbuf_get_n_channels(pixbuf
);
4895 rowstride
= gdk_pixbuf_get_rowstride(pixbuf
);
4896 width
= gdk_pixbuf_get_width(pixbuf
);
4897 height
= gdk_pixbuf_get_height(pixbuf
);
4899 if (gdk_pixbuf_get_bits_per_sample(pixbuf
) != 8 ||
4900 ! gdk_pixbuf_get_has_alpha(pixbuf
) ||
4902 rowstride
!= width
* n_channels
)
4904 g_warning("incompatible image data for icon '%s'", name
);
4905 g_object_unref(pixbuf
);
4909 SSM(sci
, SCI_RGBAIMAGESETWIDTH
, width
, 0);
4910 SSM(sci
, SCI_RGBAIMAGESETHEIGHT
, height
, 0);
4911 SSM(sci
, SCI_REGISTERRGBAIMAGE
, id
, (sptr_t
)gdk_pixbuf_get_pixels(pixbuf
));
4913 g_object_unref(pixbuf
);
4918 /* Create new editor widget (scintilla).
4919 * @note The @c "sci-notify" signal is connected separately. */
4920 static ScintillaObject
*create_new_sci(GeanyEditor
*editor
)
4922 ScintillaObject
*sci
;
4924 sci
= SCINTILLA(scintilla_new());
4926 /* Scintilla doesn't support RTL languages properly and is primarily
4927 * intended to be used with LTR source code, so override the
4928 * GTK+ default text direction for the Scintilla widget. */
4929 gtk_widget_set_direction(GTK_WIDGET(sci
), GTK_TEXT_DIR_LTR
);
4931 gtk_widget_show(GTK_WIDGET(sci
));
4933 sci_set_codepage(sci
, SC_CP_UTF8
);
4934 /*SSM(sci, SCI_SETWRAPSTARTINDENT, 4, 0);*/
4935 /* disable scintilla provided popup menu */
4936 sci_use_popup(sci
, FALSE
);
4938 setup_sci_keys(sci
);
4940 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
4941 sci_set_lines_wrapped(sci
, editor
->line_wrapping
);
4942 sci_set_caret_policy_x(sci
, CARET_JUMPS
| CARET_EVEN
, 0);
4943 /*sci_set_caret_policy_y(sci, CARET_JUMPS | CARET_EVEN, 0);*/
4944 SSM(sci
, SCI_AUTOCSETSEPARATOR
, '\n', 0);
4945 SSM(sci
, SCI_SETSCROLLWIDTHTRACKING
, 1, 0);
4947 /* tag autocompletion images */
4948 register_named_icon(sci
, 1, "classviewer-var");
4949 register_named_icon(sci
, 2, "classviewer-method");
4951 /* necessary for column mode editing, implemented in Scintilla since 2.0 */
4952 SSM(sci
, SCI_SETADDITIONALSELECTIONTYPING
, 1, 0);
4955 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
4957 #ifdef GDK_WINDOWING_QUARTZ
4958 /* "retina" (HiDPI) display support on OS X - requires disabling buffered draw */
4959 SSM(sci
, SCI_SETBUFFEREDDRAW
, 0, 0);
4962 /* only connect signals if this is for the document notebook, not split window */
4963 if (editor
->sci
== NULL
)
4965 g_signal_connect(sci
, "button-press-event", G_CALLBACK(on_editor_button_press_event
), editor
);
4966 g_signal_connect(sci
, "scroll-event", G_CALLBACK(on_editor_scroll_event
), editor
);
4967 g_signal_connect(sci
, "motion-notify-event", G_CALLBACK(on_motion_event
), NULL
);
4968 g_signal_connect(sci
, "focus-in-event", G_CALLBACK(on_editor_focus_in
), editor
);
4969 #if GTK_CHECK_VERSION(3, 0, 0)
4970 g_signal_connect(sci
, "draw", G_CALLBACK(on_editor_draw
), editor
);
4972 g_signal_connect(sci
, "expose-event", G_CALLBACK(on_editor_expose_event
), editor
);
4979 /** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
4980 * @param editor Editor settings.
4981 * @return The new widget.
4986 ScintillaObject
*editor_create_widget(GeanyEditor
*editor
)
4988 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4989 ScintillaObject
*old
, *sci
;
4990 GeanyIndentType old_indent_type
= editor
->indent_type
;
4991 gint old_indent_width
= editor
->indent_width
;
4993 /* temporarily change editor to use the new sci widget */
4995 sci
= create_new_sci(editor
);
4998 editor_set_indent(editor
, iprefs
->type
, iprefs
->width
);
4999 editor_set_font(editor
, interface_prefs
.editor_font
);
5000 editor_apply_update_prefs(editor
);
5002 /* if editor already had a widget, restore it */
5005 editor
->indent_type
= old_indent_type
;
5006 editor
->indent_width
= old_indent_width
;
5013 GeanyEditor
*editor_create(GeanyDocument
*doc
)
5015 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
5016 GeanyEditor
*editor
= g_new0(GeanyEditor
, 1);
5018 editor
->document
= doc
;
5019 doc
->editor
= editor
; /* needed in case some editor functions/callbacks expect it */
5021 editor
->auto_indent
= (iprefs
->auto_indent_mode
!= GEANY_AUTOINDENT_NONE
);
5022 editor
->line_wrapping
= get_project_pref(line_wrapping
);
5023 editor
->scroll_percent
= -1.0F
;
5024 editor
->line_breaking
= FALSE
;
5026 editor
->sci
= editor_create_widget(editor
);
5031 /* in case we need to free some fields in future */
5032 void editor_destroy(GeanyEditor
*editor
)
5038 static void on_document_save(GObject
*obj
, GeanyDocument
*doc
)
5040 gchar
*f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
5042 if (utils_str_equal(doc
->real_path
, f
))
5044 /* reload snippets */
5045 editor_snippets_free();
5046 editor_snippets_init();
5052 gboolean
editor_complete_word_part(GeanyEditor
*editor
)
5056 g_return_val_if_fail(editor
, FALSE
);
5058 if (!SSM(editor
->sci
, SCI_AUTOCACTIVE
, 0, 0))
5061 entry
= sci_get_string(editor
->sci
, SCI_AUTOCGETCURRENTTEXT
, 0);
5063 /* if no word part, complete normally */
5064 if (!check_partial_completion(editor
, entry
))
5065 SSM(editor
->sci
, SCI_AUTOCCOMPLETE
, 0, 0);
5072 void editor_init(void)
5074 static GeanyIndentPrefs indent_prefs
;
5077 memset(&editor_prefs
, 0, sizeof(GeanyEditorPrefs
));
5078 memset(&indent_prefs
, 0, sizeof(GeanyIndentPrefs
));
5079 editor_prefs
.indentation
= &indent_prefs
;
5081 /* use g_signal_connect_after() to allow plugins connecting to the signal before the default
5082 * handler (on_editor_notify) is called */
5083 g_signal_connect_after(geany_object
, "editor-notify", G_CALLBACK(on_editor_notify
), NULL
);
5085 f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
5086 ui_add_config_file_menu_item(f
, NULL
, NULL
);
5088 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
5092 /* TODO: Should these be user-defined instead of hard-coded? */
5093 void editor_set_indentation_guides(GeanyEditor
*editor
)
5098 g_return_if_fail(editor
!= NULL
);
5100 if (! editor_prefs
.show_indent_guide
)
5102 sci_set_indentation_guides(editor
->sci
, SC_IV_NONE
);
5106 lexer
= sci_get_lexer(editor
->sci
);
5109 /* Lines added/removed are prefixed with +/- characters, so
5110 * those lines will not be shown with any indentation guides.
5111 * It can be distracting that only a few of lines in a diff/patch
5112 * file will show the guides. */
5117 /* These languages use indentation for control blocks; the "look forward" method works
5121 case SCLEX_MAKEFILE
:
5125 case SCLEX_PROPERTIES
:
5126 case SCLEX_FORTRAN
: /* Is this the best option for Fortran? */
5128 mode
= SC_IV_LOOKFORWARD
;
5131 /* C-like (structured) languages benefit from the "look both" method */
5134 case SCLEX_PHPSCRIPT
:
5146 case SCLEX_FREEBASIC
:
5150 mode
= SC_IV_LOOKBOTH
;
5158 sci_set_indentation_guides(editor
->sci
, mode
);
5162 /* Apply non-document prefs that can change in the Preferences dialog */
5163 void editor_apply_update_prefs(GeanyEditor
*editor
)
5165 ScintillaObject
*sci
;
5167 g_return_if_fail(editor
!= NULL
);
5169 if (main_status
.quitting
)
5174 sci_set_mark_long_lines(sci
, editor_get_long_line_type(),
5175 editor_get_long_line_column(), editor_prefs
.long_line_color
);
5177 /* update indent width, tab width */
5178 editor_set_indent(editor
, editor
->indent_type
, editor
->indent_width
);
5179 sci_set_tab_indents(sci
, editor_prefs
.use_tab_to_indent
);
5181 sci_assign_cmdkey(sci
, SCK_HOME
| (SCMOD_SHIFT
<< 16),
5182 editor_prefs
.smart_home_key
? SCI_VCHOMEEXTEND
: SCI_HOMEEXTEND
);
5183 sci_assign_cmdkey(sci
, SCK_HOME
| ((SCMOD_SHIFT
| SCMOD_ALT
) << 16),
5184 editor_prefs
.smart_home_key
? SCI_VCHOMERECTEXTEND
: SCI_HOMERECTEXTEND
);
5186 sci_set_autoc_max_height(sci
, editor_prefs
.symbolcompletion_max_height
);
5187 SSM(sci
, SCI_AUTOCSETDROPRESTOFWORD
, editor_prefs
.completion_drops_rest_of_word
, 0);
5189 editor_set_indentation_guides(editor
);
5191 sci_set_visible_white_spaces(sci
, editor_prefs
.show_white_space
);
5192 sci_set_visible_eols(sci
, editor_prefs
.show_line_endings
);
5193 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
5194 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
);
5196 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
5199 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
5201 /* (dis)allow scrolling past end of document */
5202 sci_set_scroll_stop_at_last_line(sci
, editor_prefs
.scroll_stop_at_last_line
);
5204 sci_set_scrollbar_mode(sci
, editor_prefs
.show_scrollbars
);
5208 /* This is for tab-indents, space aligns formatted code. Spaces should be preserved. */
5209 static void change_tab_indentation(GeanyEditor
*editor
, gint line
, gboolean increase
)
5211 ScintillaObject
*sci
= editor
->sci
;
5212 gint pos
= sci_get_position_from_line(sci
, line
);
5216 sci_insert_text(sci
, pos
, "\t");
5220 if (sci_get_char_at(sci
, pos
) == '\t')
5222 sci_set_selection(sci
, pos
, pos
+ 1);
5223 sci_replace_sel(sci
, "");
5225 else /* remove spaces only if no tabs */
5227 gint width
= sci_get_line_indentation(sci
, line
);
5229 width
-= editor_get_indent_prefs(editor
)->width
;
5230 sci_set_line_indentation(sci
, line
, width
);
5236 static void editor_change_line_indent(GeanyEditor
*editor
, gint line
, gboolean increase
)
5238 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
5239 ScintillaObject
*sci
= editor
->sci
;
5241 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
)
5242 change_tab_indentation(editor
, line
, increase
);
5245 gint width
= sci_get_line_indentation(sci
, line
);
5247 width
+= increase
? iprefs
->width
: -iprefs
->width
;
5248 sci_set_line_indentation(sci
, line
, width
);
5253 void editor_indent(GeanyEditor
*editor
, gboolean increase
)
5255 ScintillaObject
*sci
= editor
->sci
;
5256 gint caret_pos
, caret_line
, caret_offset
, caret_indent_pos
, caret_line_len
;
5257 gint anchor_pos
, anchor_line
, anchor_offset
, anchor_indent_pos
, anchor_line_len
;
5259 /* backup information needed to restore caret and anchor */
5260 caret_pos
= sci_get_current_position(sci
);
5261 anchor_pos
= SSM(sci
, SCI_GETANCHOR
, 0, 0);
5262 caret_line
= sci_get_line_from_position(sci
, caret_pos
);
5263 anchor_line
= sci_get_line_from_position(sci
, anchor_pos
);
5264 caret_offset
= caret_pos
- sci_get_position_from_line(sci
, caret_line
);
5265 anchor_offset
= anchor_pos
- sci_get_position_from_line(sci
, anchor_line
);
5266 caret_indent_pos
= sci_get_line_indent_position(sci
, caret_line
);
5267 anchor_indent_pos
= sci_get_line_indent_position(sci
, anchor_line
);
5268 caret_line_len
= sci_get_line_length(sci
, caret_line
);
5269 anchor_line_len
= sci_get_line_length(sci
, anchor_line
);
5271 if (sci_get_lines_selected(sci
) <= 1)
5273 editor_change_line_indent(editor
, sci_get_current_line(sci
), increase
);
5278 gint line
, lstart
, lend
;
5280 editor_select_lines(editor
, FALSE
);
5281 start
= sci_get_selection_start(sci
);
5282 end
= sci_get_selection_end(sci
);
5283 lstart
= sci_get_line_from_position(sci
, start
);
5284 lend
= sci_get_line_from_position(sci
, end
);
5285 if (end
== sci_get_length(sci
))
5286 lend
++; /* for last line with text on it */
5288 sci_start_undo_action(sci
);
5289 for (line
= lstart
; line
< lend
; line
++)
5291 editor_change_line_indent(editor
, line
, increase
);
5293 sci_end_undo_action(sci
);
5296 /* restore caret and anchor position */
5297 if (caret_pos
>= caret_indent_pos
)
5298 caret_offset
+= sci_get_line_length(sci
, caret_line
) - caret_line_len
;
5299 if (anchor_pos
>= anchor_indent_pos
)
5300 anchor_offset
+= sci_get_line_length(sci
, anchor_line
) - anchor_line_len
;
5302 SSM(sci
, SCI_SETCURRENTPOS
, sci_get_position_from_line(sci
, caret_line
) + caret_offset
, 0);
5303 SSM(sci
, SCI_SETANCHOR
, sci_get_position_from_line(sci
, anchor_line
) + anchor_offset
, 0);
5307 /** Gets snippet by name.
5309 * If @a editor is passed, returns a snippet specific to the document filetype.
5310 * If @a editor is @c NULL, returns a snippet from the default set.
5312 * @param editor Editor or @c NULL.
5313 * @param snippet_name Snippet name.
5314 * @return snippet or @c NULL if it was not found. Must not be freed.
5317 const gchar
*editor_find_snippet(GeanyEditor
*editor
, const gchar
*snippet_name
)
5319 const gchar
*subhash_name
= editor
? editor
->document
->file_type
->name
: "Default";
5320 GHashTable
*subhash
= g_hash_table_lookup(snippet_hash
, subhash_name
);
5322 return subhash
? g_hash_table_lookup(subhash
, snippet_name
) : NULL
;
5326 /** Replaces all special sequences in @a snippet and inserts it at @a pos.
5327 * If you insert at the current position, consider calling @c sci_scroll_caret()
5328 * after this function.
5334 void editor_insert_snippet(GeanyEditor
*editor
, gint pos
, const gchar
*snippet
)
5338 pattern
= g_string_new(snippet
);
5339 snippets_make_replacements(editor
, pattern
);
5340 editor_insert_text_block(editor
, pattern
->str
, pos
, -1, -1, TRUE
);
5341 g_string_free(pattern
, TRUE
);