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.
40 #include <gdk/gdkkeysyms.h>
48 #include "documentprivate.h"
49 #include "filetypes.h"
50 #include "filetypesprivate.h"
51 #include "sciwrappers.h"
56 #include "callbacks.h"
57 #include "templates.h"
58 #include "keybindings.h"
60 #include "projectprivate.h"
62 #include "highlighting.h"
63 #include "gtkcompat.h"
66 /* Note: use sciwrappers.h instead where possible.
67 * Do not use SSM in files unrelated to scintilla. */
68 #define SSM(s, m, w, l) scintilla_send_message(s, m, w, l)
71 static GHashTable
*snippet_hash
= NULL
;
72 static GQueue
*snippet_offsets
= NULL
;
73 static gint snippet_cursor_insert_pos
;
74 static GtkAccelGroup
*snippet_accel_group
= NULL
;
76 static const gchar geany_cursor_marker
[] = "__GEANY_CURSOR_MARKER__";
78 /* holds word under the mouse or keyboard cursor */
79 static gchar current_word
[GEANY_MAX_WORD_LENGTH
];
81 /* Initialised in keyfile.c. */
82 GeanyEditorPrefs editor_prefs
;
84 EditorInfo editor_info
= {current_word
, -1};
94 } calltip
= {NULL
, FALSE
, NULL
, 0, 0, NULL
};
96 static gchar indent
[100];
99 static void on_new_line_added(GeanyEditor
*editor
);
100 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
);
101 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
);
102 static void auto_multiline(GeanyEditor
*editor
, gint pos
);
103 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
);
104 static void close_block(GeanyEditor
*editor
, gint pos
);
105 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
);
106 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
107 const gchar
*wc
, gboolean stem
);
108 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
);
109 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
);
110 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
);
111 static gssize
replace_cursor_markers(GeanyEditor
*editor
, GString
*pattern
);
112 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
);
113 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
);
116 void editor_snippets_free(void)
118 g_hash_table_destroy(snippet_hash
);
119 g_queue_free(snippet_offsets
);
120 gtk_window_remove_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
124 static void snippets_load(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
126 gsize i
, j
, len
= 0, len_keys
= 0;
127 gchar
**groups_user
, **groups_sys
;
128 gchar
**keys_user
, **keys_sys
;
132 /* keys are strings, values are GHashTables, so use g_free and g_hash_table_destroy */
134 g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, (GDestroyNotify
) g_hash_table_destroy
);
136 /* first read all globally defined auto completions */
137 groups_sys
= g_key_file_get_groups(sysconfig
, &len
);
138 for (i
= 0; i
< len
; i
++)
140 if (strcmp(groups_sys
[i
], "Keybindings") == 0)
142 keys_sys
= g_key_file_get_keys(sysconfig
, groups_sys
[i
], &len_keys
, NULL
);
143 /* create new hash table for the read section (=> filetype) */
144 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
145 g_hash_table_insert(snippet_hash
, g_strdup(groups_sys
[i
]), tmp
);
147 for (j
= 0; j
< len_keys
; j
++)
149 g_hash_table_insert(tmp
, g_strdup(keys_sys
[j
]),
150 utils_get_setting_string(sysconfig
, groups_sys
[i
], keys_sys
[j
], ""));
152 g_strfreev(keys_sys
);
154 g_strfreev(groups_sys
);
156 /* now read defined completions in user's configuration directory and add / replace them */
157 groups_user
= g_key_file_get_groups(userconfig
, &len
);
158 for (i
= 0; i
< len
; i
++)
160 if (strcmp(groups_user
[i
], "Keybindings") == 0)
162 keys_user
= g_key_file_get_keys(userconfig
, groups_user
[i
], &len_keys
, NULL
);
164 tmp
= g_hash_table_lookup(snippet_hash
, groups_user
[i
]);
166 { /* new key found, create hash table */
167 tmp
= g_hash_table_new_full(g_str_hash
, g_str_equal
, g_free
, g_free
);
168 g_hash_table_insert(snippet_hash
, g_strdup(groups_user
[i
]), tmp
);
170 for (j
= 0; j
< len_keys
; j
++)
172 value
= g_hash_table_lookup(tmp
, keys_user
[j
]);
174 { /* value = NULL means the key doesn't yet exist, so insert */
175 g_hash_table_insert(tmp
, g_strdup(keys_user
[j
]),
176 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
179 { /* old key and value will be freed by destroy function (g_free) */
180 g_hash_table_replace(tmp
, g_strdup(keys_user
[j
]),
181 utils_get_setting_string(userconfig
, groups_user
[i
], keys_user
[j
], ""));
184 g_strfreev(keys_user
);
186 g_strfreev(groups_user
);
190 static void on_snippet_keybinding_activate(gchar
*key
)
192 GeanyDocument
*doc
= document_get_current();
194 GHashTable
*specials
;
196 if (!doc
|| !gtk_widget_has_focus(GTK_WIDGET(doc
->editor
->sci
)))
199 s
= snippets_find_completion_by_name(doc
->file_type
->name
, key
);
200 if (!s
) /* allow user to specify keybindings for "special" snippets */
202 specials
= g_hash_table_lookup(snippet_hash
, "Special");
203 if (G_LIKELY(specials
!= NULL
))
204 s
= g_hash_table_lookup(specials
, key
);
212 editor_insert_snippet(doc
->editor
, sci_get_current_position(doc
->editor
->sci
), s
);
213 sci_scroll_caret(doc
->editor
->sci
);
217 static void add_kb(GKeyFile
*keyfile
, const gchar
*group
, gchar
**keys
)
223 for (i
= 0; i
< g_strv_length(keys
); i
++)
226 GdkModifierType mods
;
227 gchar
*accel_string
= g_key_file_get_value(keyfile
, group
, keys
[i
], NULL
);
229 gtk_accelerator_parse(accel_string
, &key
, &mods
);
230 g_free(accel_string
);
232 if (key
== 0 && mods
== 0)
234 g_warning("Can not parse accelerator \"%s\" from user snippets.conf", accel_string
);
237 gtk_accel_group_connect(snippet_accel_group
, key
, mods
, 0,
238 g_cclosure_new_swap((GCallback
)on_snippet_keybinding_activate
,
239 g_strdup(keys
[i
]), (GClosureNotify
)g_free
));
244 static void load_kb(GKeyFile
*sysconfig
, GKeyFile
*userconfig
)
246 const gchar kb_group
[] = "Keybindings";
247 gchar
**keys
= g_key_file_get_keys(userconfig
, kb_group
, NULL
, NULL
);
250 /* remove overridden keys from system keyfile */
251 foreach_strv(ptr
, keys
)
252 g_key_file_remove_key(sysconfig
, kb_group
, *ptr
, NULL
);
254 add_kb(userconfig
, kb_group
, keys
);
257 keys
= g_key_file_get_keys(sysconfig
, kb_group
, NULL
, NULL
);
258 add_kb(sysconfig
, kb_group
, keys
);
263 void editor_snippets_init(void)
265 gchar
*sysconfigfile
, *userconfigfile
;
266 GKeyFile
*sysconfig
= g_key_file_new();
267 GKeyFile
*userconfig
= g_key_file_new();
269 snippet_offsets
= g_queue_new();
271 sysconfigfile
= g_build_filename(app
->datadir
, "snippets.conf", NULL
);
272 userconfigfile
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
274 /* check for old autocomplete.conf files (backwards compatibility) */
275 if (! g_file_test(userconfigfile
, G_FILE_TEST_IS_REGULAR
))
276 SETPTR(userconfigfile
, g_build_filename(app
->configdir
, "autocomplete.conf", NULL
));
278 /* load the actual config files */
279 g_key_file_load_from_file(sysconfig
, sysconfigfile
, G_KEY_FILE_NONE
, NULL
);
280 g_key_file_load_from_file(userconfig
, userconfigfile
, G_KEY_FILE_NONE
, NULL
);
282 snippets_load(sysconfig
, userconfig
);
284 /* setup snippet keybindings */
285 snippet_accel_group
= gtk_accel_group_new();
286 gtk_window_add_accel_group(GTK_WINDOW(main_widgets
.window
), snippet_accel_group
);
287 load_kb(sysconfig
, userconfig
);
289 g_free(sysconfigfile
);
290 g_free(userconfigfile
);
291 g_key_file_free(sysconfig
);
292 g_key_file_free(userconfig
);
296 static gboolean
on_editor_button_press_event(GtkWidget
*widget
, GdkEventButton
*event
,
299 GeanyEditor
*editor
= data
;
300 GeanyDocument
*doc
= editor
->document
;
302 /* it's very unlikely we got a 'real' click even on 0, 0, so assume it is a
303 * fake event to show the editor menu triggered by a key event where we want to use the
304 * text cursor position. */
305 if (event
->x
> 0.0 && event
->y
> 0.0)
306 editor_info
.click_pos
= sci_get_position_from_xy(editor
->sci
,
307 (gint
)event
->x
, (gint
)event
->y
, FALSE
);
309 editor_info
.click_pos
= sci_get_current_position(editor
->sci
);
311 if (event
->button
== 1)
313 guint state
= event
->state
& gtk_accelerator_get_default_mod_mask();
315 if (event
->type
== GDK_BUTTON_PRESS
&& editor_prefs
.disable_dnd
)
317 gint ss
= sci_get_selection_start(editor
->sci
);
318 sci_set_selection_end(editor
->sci
, ss
);
320 if (event
->type
== GDK_BUTTON_PRESS
&& state
== GDK_CONTROL_MASK
)
322 sci_set_current_position(editor
->sci
, editor_info
.click_pos
, FALSE
);
324 editor_find_current_word(editor
, editor_info
.click_pos
,
325 current_word
, sizeof current_word
, NULL
);
327 return symbols_goto_tag(current_word
, TRUE
);
329 keybindings_send_command(GEANY_KEY_GROUP_GOTO
, GEANY_KEYS_GOTO_MATCHINGBRACE
);
332 return document_check_disk_status(doc
, FALSE
);
335 /* calls the edit popup menu in the editor */
336 if (event
->button
== 3)
340 /* ensure the editor widget has the focus after this operation */
341 gtk_widget_grab_focus(widget
);
343 editor_find_current_word(editor
, editor_info
.click_pos
,
344 current_word
, sizeof current_word
, NULL
);
346 can_goto
= sci_has_selection(editor
->sci
) || current_word
[0] != '\0';
347 ui_update_popup_goto_items(can_goto
);
348 ui_update_popup_copy_items(doc
);
349 ui_update_insert_include_item(doc
, 0);
351 g_signal_emit_by_name(geany_object
, "update-editor-menu",
352 current_word
, editor_info
.click_pos
, doc
);
354 gtk_menu_popup(GTK_MENU(main_widgets
.editor_menu
),
355 NULL
, NULL
, NULL
, NULL
, event
->button
, event
->time
);
363 static gboolean
is_style_php(gint style
)
365 if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
366 style
== SCE_HPHP_COMPLEX_VARIABLE
)
375 static gint
editor_get_long_line_type(void)
378 switch (app
->project
->long_line_behaviour
)
380 case 0: /* marker disabled */
382 case 1: /* use global settings */
384 case 2: /* custom (enabled) */
385 return editor_prefs
.long_line_type
;
388 if (!editor_prefs
.long_line_enabled
)
391 return editor_prefs
.long_line_type
;
395 static gint
editor_get_long_line_column(void)
397 if (app
->project
&& app
->project
->long_line_behaviour
!= 1 /* use global settings */)
398 return app
->project
->long_line_column
;
400 return editor_prefs
.long_line_column
;
404 static const GeanyEditorPrefs
*
405 get_default_prefs(void)
407 static GeanyEditorPrefs eprefs
;
409 eprefs
= editor_prefs
;
411 /* project overrides */
412 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(NULL
);
413 eprefs
.long_line_type
= editor_get_long_line_type();
414 eprefs
.long_line_column
= editor_get_long_line_column();
419 /* Gets the prefs for the editor.
420 * Prefs can be different according to project or document.
421 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
422 * settings may have changed, or if this function has been called for a different editor.
423 * @param editor The editor, or @c NULL to get the default prefs.
424 * @return The prefs. */
425 const GeanyEditorPrefs
*editor_get_prefs(GeanyEditor
*editor
)
427 static GeanyEditorPrefs eprefs
;
428 const GeanyEditorPrefs
*dprefs
= get_default_prefs();
430 /* Return the address of the default prefs to allow returning default and editor
431 * pref pointers without invalidating the contents of either. */
436 eprefs
.indentation
= (GeanyIndentPrefs
*)editor_get_indent_prefs(editor
);
437 /* add other editor & document overrides as needed */
442 void editor_toggle_fold(GeanyEditor
*editor
, gint line
, gint modifiers
)
444 ScintillaObject
*sci
;
447 g_return_if_fail(editor
!= NULL
);
450 /* When collapsing a fold range whose starting line is offscreen,
451 * scroll the starting line to display at the top of the view.
452 * Otherwise it can be confusing when the document scrolls down to hide
453 * the folded lines. */
454 if ((sci_get_fold_level(sci
, line
) & SC_FOLDLEVELNUMBERMASK
) > SC_FOLDLEVELBASE
&&
455 !(sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
))
457 gint parent
= sci_get_fold_parent(sci
, line
);
458 gint first
= sci_get_first_visible_line(sci
);
460 parent
= SSM(sci
, SCI_VISIBLEFROMDOCLINE
, parent
, 0);
462 SSM(sci
, SCI_SETFIRSTVISIBLELINE
, parent
, 0);
465 /* find the fold header of the given line in case the one clicked isn't a fold point */
466 if (sci_get_fold_level(sci
, line
) & SC_FOLDLEVELHEADERFLAG
)
469 header
= sci_get_fold_parent(sci
, line
);
471 if ((editor_prefs
.unfold_all_children
&& ! (modifiers
& SCMOD_SHIFT
)) ||
472 (! editor_prefs
.unfold_all_children
&& (modifiers
& SCMOD_SHIFT
)))
474 SSM(sci
, SCI_FOLDCHILDREN
, header
, SC_FOLDACTION_TOGGLE
);
478 SSM(sci
, SCI_FOLDLINE
, header
, SC_FOLDACTION_TOGGLE
);
483 static void on_margin_click(GeanyEditor
*editor
, SCNotification
*nt
)
485 /* left click to marker margin marks the line */
488 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
490 /*sci_marker_delete_all(editor->sci, 1);*/
491 sci_toggle_marker_at_line(editor
->sci
, line
, 1); /* toggle the marker */
493 /* left click on the folding margin to toggle folding state of current line */
494 else if (nt
->margin
== 2 && editor_prefs
.folding
)
496 gint line
= sci_get_line_from_position(editor
->sci
, nt
->position
);
497 editor_toggle_fold(editor
, line
, nt
->modifiers
);
502 static void on_update_ui(GeanyEditor
*editor
, G_GNUC_UNUSED SCNotification
*nt
)
504 ScintillaObject
*sci
= editor
->sci
;
505 gint pos
= sci_get_current_position(sci
);
507 /* since Scintilla 2.24, SCN_UPDATEUI is also sent on scrolling though we don't need to handle
508 * this and so ignore every SCN_UPDATEUI events except for content and selection changes */
509 if (! (nt
->updated
& SC_UPDATE_CONTENT
) && ! (nt
->updated
& SC_UPDATE_SELECTION
))
512 /* undo / redo menu update */
513 ui_update_popup_reundo_items(editor
->document
);
515 /* brace highlighting */
516 editor_highlight_braces(editor
, pos
);
518 ui_update_statusbar(editor
->document
, pos
);
521 /** experimental code for inverting selections */
524 for (i
= SSM(sci
, SCI_GETSELECTIONSTART
, 0, 0); i
< SSM(sci
, SCI_GETSELECTIONEND
, 0, 0); i
++)
526 /* need to get colour from getstyleat(), but how? */
527 SSM(sci
, SCI_STYLESETFORE
, STYLE_DEFAULT
, 0);
528 SSM(sci
, SCI_STYLESETBACK
, STYLE_DEFAULT
, 0);
531 sci_get_style_at(sci
, pos
);
537 static void check_line_breaking(GeanyEditor
*editor
, gint pos
)
539 ScintillaObject
*sci
= editor
->sci
;
540 gint line
, lstart
, col
;
543 if (!editor
->line_breaking
)
546 col
= sci_get_col_from_position(sci
, pos
);
548 line
= sci_get_current_line(sci
);
550 lstart
= sci_get_position_from_line(sci
, line
);
552 /* use column instead of position which might be different with multibyte characters */
553 if (col
< editor_prefs
.line_break_column
)
556 /* look for the last space before line_break_column */
557 pos
= MIN(pos
, lstart
+ editor_prefs
.line_break_column
);
561 c
= sci_get_char_at(sci
, --pos
);
564 gint diff
, last_pos
, last_col
;
566 /* remember the distance between the current column and the last column on the line
567 * (we use column position in case the previous line gets altered, such as removing
568 * trailing spaces or in case it contains multibyte characters) */
569 last_pos
= sci_get_line_end_position(sci
, line
);
570 last_col
= sci_get_col_from_position(sci
, last_pos
);
571 diff
= last_col
- col
;
573 /* break the line after the space */
574 sci_set_current_position(sci
, pos
+ 1, FALSE
);
575 sci_cancel(sci
); /* don't select from completion list */
576 sci_send_command(sci
, SCI_NEWLINE
);
579 /* correct cursor position (might not be at line end) */
580 last_pos
= sci_get_line_end_position(sci
, line
);
581 last_col
= sci_get_col_from_position(sci
, last_pos
); /* get last column on line */
582 /* last column - distance is the desired column, then retrieve its document position */
583 pos
= sci_get_position_from_col(sci
, line
, last_col
- diff
);
584 sci_set_current_position(sci
, pos
, FALSE
);
585 sci_scroll_caret(sci
);
592 static void show_autocomplete(ScintillaObject
*sci
, gsize rootlen
, GString
*words
)
594 /* hide autocompletion if only option is already typed */
595 if (rootlen
>= words
->len
||
596 (words
->str
[rootlen
] == '?' && rootlen
>= words
->len
- 2))
598 sci_send_command(sci
, SCI_AUTOCCANCEL
);
601 /* store whether a calltip is showing, so we can reshow it after autocompletion */
602 calltip
.set
= (gboolean
) SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0);
603 SSM(sci
, SCI_AUTOCSHOW
, rootlen
, (sptr_t
) words
->str
);
607 static void show_tags_list(GeanyEditor
*editor
, const GPtrArray
*tags
, gsize rootlen
)
609 ScintillaObject
*sci
= editor
->sci
;
611 g_return_if_fail(tags
);
615 GString
*words
= g_string_sized_new(150);
618 for (j
= 0; j
< tags
->len
; ++j
)
620 TMTag
*tag
= tags
->pdata
[j
];
623 g_string_append_c(words
, '\n');
625 if (j
== editor_prefs
.autocompletion_max_entries
)
627 g_string_append(words
, "...");
630 g_string_append(words
, tag
->name
);
632 /* for now, tag types don't all follow C, so just look at arglist */
633 if (!EMPTY(tag
->atts
.entry
.arglist
))
634 g_string_append(words
, "?2");
636 g_string_append(words
, "?1");
638 show_autocomplete(sci
, rootlen
, words
);
639 g_string_free(words
, TRUE
);
644 /* do not use with long strings */
645 static gboolean
match_last_chars(ScintillaObject
*sci
, gint pos
, const gchar
*str
)
647 gsize len
= strlen(str
);
650 g_return_val_if_fail(len
< 100, FALSE
);
651 g_return_val_if_fail((gint
)len
<= pos
, FALSE
);
653 buf
= g_alloca(len
+ 1);
654 sci_get_text_range(sci
, pos
- len
, pos
, buf
);
655 return strcmp(str
, buf
) == 0;
659 static gboolean
reshow_calltip(gpointer data
)
663 g_return_val_if_fail(calltip
.sci
!= NULL
, FALSE
);
665 SSM(calltip
.sci
, SCI_CALLTIPCANCEL
, 0, 0);
666 doc
= document_get_current();
668 if (doc
&& doc
->editor
->sci
== calltip
.sci
)
670 /* we use the position where the calltip was previously started as SCI_GETCURRENTPOS
671 * may be completely wrong in case the user cancelled the auto completion with the mouse */
672 SSM(calltip
.sci
, SCI_CALLTIPSHOW
, calltip
.pos
, (sptr_t
) calltip
.text
);
678 static void request_reshowing_calltip(SCNotification
*nt
)
682 /* delay the reshow of the calltip window to make sure it is actually displayed,
683 * without it might be not visible on SCN_AUTOCCANCEL. the priority is set to
684 * low to hopefully make Scintilla's events happen before reshowing since they
685 * seem to re-cancel the calltip on autoc menu hiding too */
686 g_idle_add_full(G_PRIORITY_LOW
, reshow_calltip
, NULL
, NULL
);
691 static void autocomplete_scope(GeanyEditor
*editor
)
693 ScintillaObject
*sci
= editor
->sci
;
694 gint pos
= sci_get_current_position(editor
->sci
);
695 gchar typed
= sci_get_char_at(sci
, pos
- 1);
697 const GPtrArray
*tags
= NULL
;
699 GeanyFiletype
*ft
= editor
->document
->file_type
;
701 if (ft
->id
== GEANY_FILETYPES_C
|| ft
->id
== GEANY_FILETYPES_CPP
)
703 if (match_last_chars(sci
, pos
, "->") || match_last_chars(sci
, pos
, "::"))
705 else if (ft
->id
== GEANY_FILETYPES_CPP
&& match_last_chars(sci
, pos
, "->*"))
707 else if (typed
!= '.')
710 else if (typed
!= '.')
713 /* allow for a space between word and operator */
714 if (isspace(sci_get_char_at(sci
, pos
- 2)))
716 name
= editor_get_word_at_pos(editor
, pos
- 1, NULL
);
720 tags
= tm_workspace_find(name
, tm_tag_max_t
, NULL
, FALSE
, ft
->lang
);
722 if (!tags
|| tags
->len
== 0)
725 tag
= g_ptr_array_index(tags
, 0);
726 name
= tag
->atts
.entry
.var_type
;
729 TMWorkObject
*obj
= editor
->document
->tm_file
;
731 tags
= tm_workspace_find_scope_members(obj
? obj
->tags_array
: NULL
,
734 show_tags_list(editor
, tags
, 0);
739 static void on_char_added(GeanyEditor
*editor
, SCNotification
*nt
)
741 ScintillaObject
*sci
= editor
->sci
;
742 gint pos
= sci_get_current_position(sci
);
747 { /* simple indentation (only for CR format) */
748 if (sci_get_eol_mode(sci
) == SC_EOL_CR
)
749 on_new_line_added(editor
);
753 { /* simple indentation (for CR/LF and LF format) */
754 on_new_line_added(editor
);
758 editor_start_auto_complete(editor
, pos
, FALSE
); /* C/C++ ptr-> scope completion */
761 { /* close xml-tags */
762 handle_xml(editor
, pos
, nt
->ch
);
767 auto_close_chars(sci
, pos
, nt
->ch
);
769 editor_show_calltip(editor
, --pos
);
773 { /* hide calltips */
774 if (SSM(sci
, SCI_CALLTIPACTIVE
, 0, 0))
776 SSM(sci
, SCI_CALLTIPCANCEL
, 0, 0);
778 g_free(calltip
.text
);
790 auto_close_chars(sci
, pos
, nt
->ch
);
794 { /* closing bracket handling */
795 if (editor
->auto_indent
)
796 close_block(editor
, pos
- 1);
799 /* scope autocompletion */
801 case ':': /* C/C++ class:: syntax */
802 /* tag autocompletion */
805 if (! editor_start_auto_complete(editor
, pos
, FALSE
))
806 request_reshowing_calltip(nt
);
808 editor_start_auto_complete(editor
, pos
, FALSE
);
811 check_line_breaking(editor
, pos
);
815 /* expand() and fold_changed() are copied from SciTE (thanks) to fix #1923350. */
816 static void expand(ScintillaObject
*sci
, gint
*line
, gboolean doExpand
,
817 gboolean force
, gint visLevels
, gint level
)
819 gint lineMaxSubord
= SSM(sci
, SCI_GETLASTCHILD
, *line
, level
& SC_FOLDLEVELNUMBERMASK
);
820 gint levelLine
= level
;
822 while (*line
<= lineMaxSubord
)
827 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
829 SSM(sci
, SCI_HIDELINES
, *line
, *line
);
834 SSM(sci
, SCI_SHOWLINES
, *line
, *line
);
837 levelLine
= SSM(sci
, SCI_GETFOLDLEVEL
, *line
, 0);
838 if (levelLine
& SC_FOLDLEVELHEADERFLAG
)
843 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
845 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 0);
846 expand(sci
, line
, doExpand
, force
, visLevels
- 1, -1);
852 if (!sci_get_fold_expanded(sci
, *line
))
853 SSM(sci
, SCI_SETFOLDEXPANDED
, *line
, 1);
854 expand(sci
, line
, TRUE
, force
, visLevels
- 1, -1);
858 expand(sci
, line
, FALSE
, force
, visLevels
- 1, -1);
870 static void fold_changed(ScintillaObject
*sci
, gint line
, gint levelNow
, gint levelPrev
)
872 if (levelNow
& SC_FOLDLEVELHEADERFLAG
)
874 if (! (levelPrev
& SC_FOLDLEVELHEADERFLAG
))
876 /* Adding a fold point */
877 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
878 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
881 else if (levelPrev
& SC_FOLDLEVELHEADERFLAG
)
883 if (! sci_get_fold_expanded(sci
, line
))
884 { /* Removing the fold from one that has been contracted so should expand
885 * otherwise lines are left invisible with no way to make them visible */
886 SSM(sci
, SCI_SETFOLDEXPANDED
, line
, 1);
887 expand(sci
, &line
, TRUE
, FALSE
, 0, levelPrev
);
890 if (! (levelNow
& SC_FOLDLEVELWHITEFLAG
) &&
891 ((levelPrev
& SC_FOLDLEVELNUMBERMASK
) > (levelNow
& SC_FOLDLEVELNUMBERMASK
)))
893 /* See if should still be hidden */
894 gint parentLine
= sci_get_fold_parent(sci
, line
);
897 SSM(sci
, SCI_SHOWLINES
, line
, line
);
899 else if (sci_get_fold_expanded(sci
, parentLine
) &&
900 sci_get_line_is_visible(sci
, parentLine
))
902 SSM(sci
, SCI_SHOWLINES
, line
, line
);
908 static void ensure_range_visible(ScintillaObject
*sci
, gint posStart
, gint posEnd
,
909 gboolean enforcePolicy
)
911 gint lineStart
= sci_get_line_from_position(sci
, MIN(posStart
, posEnd
));
912 gint lineEnd
= sci_get_line_from_position(sci
, MAX(posStart
, posEnd
));
915 for (line
= lineStart
; line
<= lineEnd
; line
++)
917 SSM(sci
, enforcePolicy
? SCI_ENSUREVISIBLEENFORCEPOLICY
: SCI_ENSUREVISIBLE
, line
, 0);
922 static void auto_update_margin_width(GeanyEditor
*editor
)
924 gint next_linecount
= 1;
925 gint linecount
= sci_get_line_count(editor
->sci
);
926 GeanyDocument
*doc
= editor
->document
;
928 while (next_linecount
<= linecount
)
929 next_linecount
*= 10;
931 if (editor
->document
->priv
->line_count
!= next_linecount
)
933 doc
->priv
->line_count
= next_linecount
;
934 sci_set_line_numbers(editor
->sci
, TRUE
, 0);
939 static void partial_complete(ScintillaObject
*sci
, const gchar
*text
)
941 gint pos
= sci_get_current_position(sci
);
943 sci_insert_text(sci
, pos
, text
);
944 sci_set_current_position(sci
, pos
+ strlen(text
), TRUE
);
948 /* Complete the next word part from @a entry */
949 static gboolean
check_partial_completion(GeanyEditor
*editor
, const gchar
*entry
)
951 gchar
*stem
, *ptr
, *text
= utils_strdupa(entry
);
953 read_current_word(editor
, -1, current_word
, sizeof current_word
, NULL
, TRUE
);
955 if (strstr(text
, stem
) != text
)
956 return FALSE
; /* shouldn't happen */
957 if (strlen(text
) <= strlen(stem
))
960 text
+= strlen(stem
); /* skip stem */
961 ptr
= strstr(text
+ 1, "_");
965 partial_complete(editor
->sci
, text
);
971 foreach_str(ptr
, text
+ 1)
975 if (g_ascii_isupper(*ptr
) && g_ascii_islower(ptr
[1]))
978 partial_complete(editor
->sci
, text
);
987 /* Callback for the "sci-notify" signal to emit a "editor-notify" signal.
988 * Plugins can connect to the "editor-notify" signal. */
989 void editor_sci_notify_cb(G_GNUC_UNUSED GtkWidget
*widget
, G_GNUC_UNUSED gint scn
,
990 gpointer scnt
, gpointer data
)
992 GeanyEditor
*editor
= data
;
995 g_return_if_fail(editor
!= NULL
);
997 g_signal_emit_by_name(geany_object
, "editor-notify", editor
, scnt
, &retval
);
1001 static gboolean
on_editor_notify(G_GNUC_UNUSED GObject
*object
, GeanyEditor
*editor
,
1002 SCNotification
*nt
, G_GNUC_UNUSED gpointer data
)
1004 ScintillaObject
*sci
= editor
->sci
;
1005 GeanyDocument
*doc
= editor
->document
;
1007 switch (nt
->nmhdr
.code
)
1009 case SCN_SAVEPOINTLEFT
:
1010 document_set_text_changed(doc
, TRUE
);
1013 case SCN_SAVEPOINTREACHED
:
1014 document_set_text_changed(doc
, FALSE
);
1017 case SCN_MODIFYATTEMPTRO
:
1021 case SCN_MARGINCLICK
:
1022 on_margin_click(editor
, nt
);
1026 on_update_ui(editor
, nt
);
1030 /* Visible lines are only laid out accurately just before painting,
1031 * so we need to only call editor_scroll_to_line here, because the document
1032 * may have line wrapping and folding enabled.
1033 * http://scintilla.sourceforge.net/ScintillaDoc.html#LineWrapping
1034 * This is important e.g. when loading a session and switching pages
1035 * and having the cursor scroll in view. */
1036 /* FIXME: Really we want to do this just before painting, not after it
1037 * as it will cause repainting. */
1038 if (editor
->scroll_percent
> 0.0F
)
1040 editor_scroll_to_line(editor
, -1, editor
->scroll_percent
);
1041 /* disable further scrolling */
1042 editor
->scroll_percent
= -1.0F
;
1047 if (editor_prefs
.show_linenumber_margin
&& (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
)) && nt
->linesAdded
)
1049 /* automatically adjust Scintilla's line numbers margin width */
1050 auto_update_margin_width(editor
);
1052 if (nt
->modificationType
& SC_STARTACTION
&& ! ignore_callback
)
1054 /* get notified about undo changes */
1055 document_undo_add(doc
, UNDO_SCINTILLA
, NULL
);
1057 if (editor_prefs
.folding
&& (nt
->modificationType
& SC_MOD_CHANGEFOLD
) != 0)
1059 /* handle special fold cases, e.g. #1923350 */
1060 fold_changed(sci
, nt
->line
, nt
->foldLevelNow
, nt
->foldLevelPrev
);
1062 if (nt
->modificationType
& (SC_MOD_INSERTTEXT
| SC_MOD_DELETETEXT
))
1064 document_update_tag_list_in_idle(doc
);
1069 on_char_added(editor
, nt
);
1072 case SCN_USERLISTSELECTION
:
1073 if (nt
->listType
== 1)
1075 sci_add_text(sci
, nt
->text
);
1079 case SCN_AUTOCSELECTION
:
1080 if (g_str_equal(nt
->text
, "..."))
1087 case SCN_AUTOCCANCELLED
:
1088 /* now that autocomplete is finishing or was cancelled, reshow calltips
1089 * if they were showing */
1090 request_reshowing_calltip(nt
);
1094 case SCN_STYLENEEDED
:
1095 geany_debug("style");
1099 ensure_range_visible(sci
, nt
->position
, nt
->position
+ nt
->length
, FALSE
);
1102 case SCN_URIDROPPED
:
1103 if (nt
->text
!= NULL
)
1105 document_open_file_list(nt
->text
, strlen(nt
->text
));
1109 case SCN_CALLTIPCLICK
:
1110 if (nt
->position
> 0)
1112 switch (nt
->position
)
1114 case 1: /* up arrow */
1115 if (calltip
.tag_index
> 0)
1116 calltip
.tag_index
--;
1119 case 2: calltip
.tag_index
++; break; /* down arrow */
1121 editor_show_calltip(editor
, -1);
1126 /* recalculate line margin width */
1127 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
, 0);
1130 /* we always return FALSE here to let plugins handle the event too */
1135 /* Note: this is the same as sci_get_tab_width(), but is still useful when you don't have
1136 * a scintilla pointer. */
1137 static gint
get_tab_width(const GeanyIndentPrefs
*indent_prefs
)
1139 if (indent_prefs
->type
== GEANY_INDENT_TYPE_BOTH
)
1140 return indent_prefs
->hard_tab_width
;
1142 return indent_prefs
->width
; /* tab width = indent width */
1146 /* Returns a string containing width chars of whitespace, filled with simple space
1147 * characters or with the right number of tab characters, according to the indent prefs.
1148 * (Result is filled with tabs *and* spaces if width isn't a multiple of
1149 * the tab width). */
1151 get_whitespace(const GeanyIndentPrefs
*iprefs
, gint width
)
1153 g_return_val_if_fail(width
>= 0, NULL
);
1156 return g_strdup("");
1158 if (iprefs
->type
== GEANY_INDENT_TYPE_SPACES
)
1160 return g_strnfill(width
, ' ');
1163 { /* first fill text with tabs and fill the rest with spaces */
1164 const gint tab_width
= get_tab_width(iprefs
);
1165 gint tabs
= width
/ tab_width
;
1166 gint spaces
= width
% tab_width
;
1167 gint len
= tabs
+ spaces
;
1170 str
= g_malloc(len
+ 1);
1172 memset(str
, '\t', tabs
);
1173 memset(str
+ tabs
, ' ', spaces
);
1180 static const GeanyIndentPrefs
*
1181 get_default_indent_prefs(void)
1183 static GeanyIndentPrefs iprefs
;
1185 iprefs
= app
->project
? *app
->project
->priv
->indentation
: *editor_prefs
.indentation
;
1190 /** Gets the indentation prefs for the editor.
1191 * Prefs can be different according to project or document.
1192 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
1193 * settings may have changed, or if this function has been called for a different editor.
1194 * @param editor The editor, or @c NULL to get the default indent prefs.
1195 * @return The indent prefs. */
1196 const GeanyIndentPrefs
*
1197 editor_get_indent_prefs(GeanyEditor
*editor
)
1199 static GeanyIndentPrefs iprefs
;
1200 const GeanyIndentPrefs
*dprefs
= get_default_indent_prefs();
1202 /* Return the address of the default prefs to allow returning default and editor
1203 * pref pointers without invalidating the contents of either. */
1208 iprefs
.type
= editor
->indent_type
;
1209 iprefs
.width
= editor
->indent_width
;
1211 /* if per-document auto-indent is enabled, but we don't have a global mode set,
1212 * just use basic auto-indenting */
1213 if (editor
->auto_indent
&& iprefs
.auto_indent_mode
== GEANY_AUTOINDENT_NONE
)
1214 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_BASIC
;
1216 if (!editor
->auto_indent
)
1217 iprefs
.auto_indent_mode
= GEANY_AUTOINDENT_NONE
;
1223 static void on_new_line_added(GeanyEditor
*editor
)
1225 ScintillaObject
*sci
= editor
->sci
;
1226 gint line
= sci_get_current_line(sci
);
1228 /* simple indentation */
1229 if (editor
->auto_indent
)
1231 insert_indent_after_line(editor
, line
- 1);
1234 if (editor_prefs
.auto_continue_multiline
)
1235 { /* " * " auto completion in multiline C/C++/D/Java comments */
1236 auto_multiline(editor
, line
);
1239 if (editor_prefs
.newline_strip
)
1240 { /* strip the trailing spaces on the previous line */
1241 editor_strip_line_trailing_spaces(editor
, line
- 1);
1246 static gboolean
lexer_has_braces(ScintillaObject
*sci
)
1248 gint lexer
= sci_get_lexer(sci
);
1254 case SCLEX_HTML
: /* for PHP & JS */
1255 case SCLEX_PASCAL
: /* for multiline comments? */
1268 /* Read indent chars for the line that pos is on into indent global variable.
1269 * Note: Use sci_get_line_indentation() and get_whitespace()/editor_insert_text_block()
1270 * instead in any new code. */
1271 static void read_indent(GeanyEditor
*editor
, gint pos
)
1273 ScintillaObject
*sci
= editor
->sci
;
1274 guint i
, len
, j
= 0;
1278 line
= sci_get_line_from_position(sci
, pos
);
1280 len
= sci_get_line_length(sci
, line
);
1281 linebuf
= sci_get_line(sci
, line
);
1283 for (i
= 0; i
< len
&& j
<= (sizeof(indent
) - 1); i
++)
1285 if (linebuf
[i
] == ' ' || linebuf
[i
] == '\t') /* simple indentation */
1286 indent
[j
++] = linebuf
[i
];
1295 static gint
get_brace_indent(ScintillaObject
*sci
, gint line
)
1297 gint start
= sci_get_position_from_line(sci
, line
);
1298 gint end
= sci_get_line_end_position(sci
, line
) - 1;
1299 gint lexer
= sci_get_lexer(sci
);
1303 for (pos
= end
; pos
>= start
&& count
< 1; pos
--)
1305 if (highlighting_is_code_style(lexer
, sci_get_style_at(sci
, pos
)))
1307 gchar c
= sci_get_char_at(sci
, pos
);
1316 return count
> 0 ? 1 : 0;
1320 /* gets the last code position on a line
1321 * warning: if there is no code position on the line, returns the start position */
1322 static gint
get_sci_line_code_end_position(ScintillaObject
*sci
, gint line
)
1324 gint start
= sci_get_position_from_line(sci
, line
);
1325 gint lexer
= sci_get_lexer(sci
);
1328 for (pos
= sci_get_line_end_position(sci
, line
) - 1; pos
> start
; pos
--)
1330 gint style
= sci_get_style_at(sci
, pos
);
1332 if (highlighting_is_code_style(lexer
, style
) && ! isspace(sci_get_char_at(sci
, pos
)))
1340 static gint
get_python_indent(ScintillaObject
*sci
, gint line
)
1342 gint last_char
= get_sci_line_code_end_position(sci
, line
);
1344 /* add extra indentation for Python after colon */
1345 if (sci_get_char_at(sci
, last_char
) == ':' &&
1346 sci_get_style_at(sci
, last_char
) == SCE_P_OPERATOR
)
1354 static gint
get_xml_indent(ScintillaObject
*sci
, gint line
)
1356 gboolean need_close
= FALSE
;
1357 gint end
= get_sci_line_code_end_position(sci
, line
);
1360 /* don't indent if there's a closing tag to the right of the cursor */
1361 pos
= sci_get_current_position(sci
);
1362 if (sci_get_char_at(sci
, pos
) == '<' &&
1363 sci_get_char_at(sci
, pos
+ 1) == '/')
1366 if (sci_get_char_at(sci
, end
) == '>' &&
1367 sci_get_char_at(sci
, end
- 1) != '/')
1369 gint style
= sci_get_style_at(sci
, end
);
1371 if (style
== SCE_H_TAG
|| style
== SCE_H_TAGUNKNOWN
)
1373 gint start
= sci_get_position_from_line(sci
, line
);
1374 gchar
*line_contents
= sci_get_contents_range(sci
, start
, end
+ 1);
1375 gchar
*opened_tag_name
= utils_find_open_xml_tag(line_contents
, end
+ 1 - start
);
1377 if (!EMPTY(opened_tag_name
))
1380 if (sci_get_lexer(sci
) == SCLEX_HTML
&& utils_is_short_html_tag(opened_tag_name
))
1383 g_free(line_contents
);
1384 g_free(opened_tag_name
);
1388 return need_close
? 1 : 0;
1392 static gint
get_indent_size_after_line(GeanyEditor
*editor
, gint line
)
1394 ScintillaObject
*sci
= editor
->sci
;
1396 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1398 g_return_val_if_fail(line
>= 0, 0);
1400 size
= sci_get_line_indentation(sci
, line
);
1402 if (iprefs
->auto_indent_mode
> GEANY_AUTOINDENT_BASIC
)
1404 gint additional_indent
= 0;
1406 if (lexer_has_braces(sci
))
1407 additional_indent
= iprefs
->width
* get_brace_indent(sci
, line
);
1408 else if (sci_get_lexer(sci
) == SCLEX_PYTHON
) /* Python/Cython */
1409 additional_indent
= iprefs
->width
* get_python_indent(sci
, line
);
1411 /* HTML lexer "has braces" because of PHP and JavaScript. If get_brace_indent() did not
1412 * recommend us to insert additional indent, we are probably not in PHP/JavaScript chunk and
1413 * should make the XML-related check */
1414 if (additional_indent
== 0 &&
1415 (sci_get_lexer(sci
) == SCLEX_HTML
||
1416 sci_get_lexer(sci
) == SCLEX_XML
) &&
1417 editor
->document
->file_type
->priv
->xml_indent_tags
)
1419 size
+= iprefs
->width
* get_xml_indent(sci
, line
);
1422 size
+= additional_indent
;
1428 static void insert_indent_after_line(GeanyEditor
*editor
, gint line
)
1430 ScintillaObject
*sci
= editor
->sci
;
1431 gint line_indent
= sci_get_line_indentation(sci
, line
);
1432 gint size
= get_indent_size_after_line(editor
, line
);
1433 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1439 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
&& size
== line_indent
)
1441 /* support tab indents, space aligns style - copy last line 'indent' exactly */
1442 gint start
= sci_get_position_from_line(sci
, line
);
1443 gint end
= sci_get_line_indent_position(sci
, line
);
1445 text
= sci_get_contents_range(sci
, start
, end
);
1449 text
= get_whitespace(iprefs
, size
);
1451 sci_add_text(sci
, text
);
1456 static void auto_close_chars(ScintillaObject
*sci
, gint pos
, gchar c
)
1458 const gchar
*closing_char
= NULL
;
1461 if (utils_isbrace(c
, 0))
1462 end_pos
= sci_find_matching_brace(sci
, pos
- 1);
1467 if ((editor_prefs
.autoclose_chars
& GEANY_AC_PARENTHESIS
) && end_pos
== -1)
1471 if ((editor_prefs
.autoclose_chars
& GEANY_AC_CBRACKET
) && end_pos
== -1)
1475 if ((editor_prefs
.autoclose_chars
& GEANY_AC_SBRACKET
) && end_pos
== -1)
1479 if (editor_prefs
.autoclose_chars
& GEANY_AC_SQUOTE
)
1483 if (editor_prefs
.autoclose_chars
& GEANY_AC_DQUOTE
)
1484 closing_char
= "\"";
1488 if (closing_char
!= NULL
)
1490 sci_add_text(sci
, closing_char
);
1491 sci_set_current_position(sci
, pos
, TRUE
);
1496 /* Finds a corresponding matching brace to the given pos
1497 * (this is taken from Scintilla Editor.cxx,
1498 * fit to work with close_block) */
1499 static gint
brace_match(ScintillaObject
*sci
, gint pos
)
1501 gchar chBrace
= sci_get_char_at(sci
, pos
);
1502 gchar chSeek
= utils_brace_opposite(chBrace
);
1504 gint direction
= -1;
1509 /* Hack: we need the style at @p pos but it isn't computed yet, so force styling
1510 * of this very position */
1511 sci_colourise(sci
, pos
, pos
+ 1);
1513 styBrace
= sci_get_style_at(sci
, pos
);
1515 if (utils_is_opening_brace(chBrace
, editor_prefs
.brace_match_ltgt
))
1519 while ((pos
>= 0) && (pos
< sci_get_length(sci
)))
1521 chAtPos
= sci_get_char_at(sci
, pos
);
1522 styAtPos
= sci_get_style_at(sci
, pos
);
1524 if ((pos
> sci_get_end_styled(sci
)) || (styAtPos
== styBrace
))
1526 if (chAtPos
== chBrace
)
1528 if (chAtPos
== chSeek
)
1539 /* Called after typing '}'. */
1540 static void close_block(GeanyEditor
*editor
, gint pos
)
1542 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
1543 gint x
= 0, cnt
= 0;
1544 gint line
, line_len
;
1545 gchar
*text
, *line_buf
;
1546 ScintillaObject
*sci
;
1547 gint line_indent
, last_indent
;
1549 if (iprefs
->auto_indent_mode
< GEANY_AUTOINDENT_CURRENTCHARS
)
1551 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
1555 if (! lexer_has_braces(sci
))
1558 line
= sci_get_line_from_position(sci
, pos
);
1559 line_len
= sci_get_line_end_position(sci
, line
) - sci_get_position_from_line(sci
, line
);
1561 /* check that the line is empty, to not kill text in the line */
1562 line_buf
= sci_get_line(sci
, line
);
1563 line_buf
[line_len
] = '\0';
1564 while (x
< line_len
)
1566 if (isspace(line_buf
[x
]))
1572 if ((line_len
- 1) != cnt
)
1575 if (iprefs
->auto_indent_mode
== GEANY_AUTOINDENT_MATCHBRACES
)
1577 gint start_brace
= brace_match(sci
, pos
);
1579 if (start_brace
>= 0)
1582 gint brace_line
= sci_get_line_from_position(sci
, start_brace
);
1583 gint size
= sci_get_line_indentation(sci
, brace_line
);
1584 gchar
*ind
= get_whitespace(iprefs
, size
);
1586 text
= g_strconcat(ind
, "}", NULL
);
1587 line_start
= sci_get_position_from_line(sci
, line
);
1588 sci_set_anchor(sci
, line_start
);
1589 sci_replace_sel(sci
, text
);
1594 /* fall through - unmatched brace (possibly because of TCL, PHP lexer bugs) */
1597 /* GEANY_AUTOINDENT_CURRENTCHARS */
1598 line_indent
= sci_get_line_indentation(sci
, line
);
1599 last_indent
= sci_get_line_indentation(sci
, line
- 1);
1601 if (line_indent
< last_indent
)
1603 line_indent
-= iprefs
->width
;
1604 line_indent
= MAX(0, line_indent
);
1605 sci_set_line_indentation(sci
, line
, line_indent
);
1609 /* checks whether @p c is an ASCII character (e.g. < 0x80) */
1610 #define IS_ASCII(c) (((unsigned char)(c)) < 0x80)
1613 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1614 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1615 * position can be -1, then the current position is used.
1616 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1617 static void read_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1618 const gchar
*wc
, gboolean stem
)
1620 gint line
, line_start
, startword
, endword
;
1622 ScintillaObject
*sci
;
1624 g_return_if_fail(editor
!= NULL
);
1628 pos
= sci_get_current_position(sci
);
1630 line
= sci_get_line_from_position(sci
, pos
);
1631 line_start
= sci_get_position_from_line(sci
, line
);
1632 startword
= pos
- line_start
;
1633 endword
= pos
- line_start
;
1636 chunk
= sci_get_line(sci
, line
);
1639 wc
= GEANY_WORDCHARS
;
1641 /* the checks for "c < 0" are to allow any Unicode character which should make the code
1642 * a little bit more Unicode safe, anyway, this allows also any Unicode punctuation,
1643 * TODO: improve this code */
1644 while (startword
> 0 && (strchr(wc
, chunk
[startword
- 1]) || ! IS_ASCII(chunk
[startword
- 1])))
1648 while (chunk
[endword
] != 0 && (strchr(wc
, chunk
[endword
]) || ! IS_ASCII(chunk
[endword
])))
1652 if (startword
!= endword
)
1654 chunk
[endword
] = '\0';
1656 g_strlcpy(word
, chunk
+ startword
, wordlen
); /* ensure null terminated */
1659 g_strlcpy(word
, "", wordlen
);
1665 /* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
1666 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
1667 * position can be -1, then the current position is used.
1668 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
1669 void editor_find_current_word(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
,
1672 read_current_word(editor
, pos
, word
, wordlen
, wc
, FALSE
);
1676 /* Same as editor_find_current_word() but uses editor's word boundaries to decide what the word
1677 * is. This should be used e.g. to get the word to search for */
1678 void editor_find_current_word_sciwc(GeanyEditor
*editor
, gint pos
, gchar
*word
, gsize wordlen
)
1683 g_return_if_fail(editor
!= NULL
);
1686 pos
= sci_get_current_position(editor
->sci
);
1688 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
1689 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
1691 if (start
== end
) /* caret in whitespaces sequence */
1695 if ((guint
)(end
- start
) >= wordlen
)
1696 end
= start
+ (wordlen
- 1);
1697 sci_get_text_range(editor
->sci
, start
, end
, word
);
1703 * Finds the word at the position specified by @a pos. If any word is found, it is returned.
1704 * Otherwise NULL is returned.
1705 * Additional wordchars can be specified to define what to consider as a word.
1707 * @param editor The editor to operate on.
1708 * @param pos The position where the word should be read from.
1709 * May be @c -1 to use the current position.
1710 * @param wordchars The wordchars to separate words. wordchars mean all characters to count
1711 * as part of a word. May be @c NULL to use the default wordchars,
1712 * see @ref GEANY_WORDCHARS.
1714 * @return A newly-allocated string containing the word at the given @a pos or @c NULL.
1715 * Should be freed when no longer needed.
1719 gchar
*editor_get_word_at_pos(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1721 static gchar cword
[GEANY_MAX_WORD_LENGTH
];
1723 g_return_val_if_fail(editor
!= NULL
, FALSE
);
1725 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, FALSE
);
1727 return (*cword
== '\0') ? NULL
: g_strdup(cword
);
1731 /* Read the word up to position @a pos. */
1732 static const gchar
*
1733 editor_read_word_stem(GeanyEditor
*editor
, gint pos
, const gchar
*wordchars
)
1735 static gchar word
[GEANY_MAX_WORD_LENGTH
];
1737 read_current_word(editor
, pos
, word
, sizeof word
, wordchars
, TRUE
);
1739 return (*word
) ? word
: NULL
;
1743 static gint
find_previous_brace(ScintillaObject
*sci
, gint pos
)
1745 gint orig_pos
= pos
;
1747 while (pos
>= 0 && pos
> orig_pos
- 300)
1749 gchar c
= sci_get_char_at(sci
, pos
);
1750 if (utils_is_opening_brace(c
, editor_prefs
.brace_match_ltgt
))
1758 static gint
find_start_bracket(ScintillaObject
*sci
, gint pos
)
1761 gint orig_pos
= pos
;
1763 while (pos
> 0 && pos
> orig_pos
- 300)
1765 gchar c
= sci_get_char_at(sci
, pos
);
1767 if (c
== ')') brackets
++;
1768 else if (c
== '(') brackets
--;
1769 if (brackets
< 0) return pos
; /* found start bracket */
1776 static gboolean
append_calltip(GString
*str
, const TMTag
*tag
, filetype_id ft_id
)
1778 if (! tag
->atts
.entry
.arglist
)
1781 if (ft_id
!= GEANY_FILETYPES_PASCAL
)
1782 { /* usual calltips: "retval tagname (arglist)" */
1783 if (tag
->atts
.entry
.var_type
)
1787 g_string_append(str
, tag
->atts
.entry
.var_type
);
1788 for (i
= 0; i
< tag
->atts
.entry
.pointerOrder
; i
++)
1790 g_string_append_c(str
, '*');
1792 g_string_append_c(str
, ' ');
1794 if (tag
->atts
.entry
.scope
)
1796 const gchar
*cosep
= symbols_get_context_separator(ft_id
);
1798 g_string_append(str
, tag
->atts
.entry
.scope
);
1799 g_string_append(str
, cosep
);
1801 g_string_append(str
, tag
->name
);
1802 g_string_append_c(str
, ' ');
1803 g_string_append(str
, tag
->atts
.entry
.arglist
);
1806 { /* special case Pascal calltips: "tagname (arglist) : retval" */
1807 g_string_append(str
, tag
->name
);
1808 g_string_append_c(str
, ' ');
1809 g_string_append(str
, tag
->atts
.entry
.arglist
);
1811 if (!EMPTY(tag
->atts
.entry
.var_type
))
1813 g_string_append(str
, " : ");
1814 g_string_append(str
, tag
->atts
.entry
.var_type
);
1822 static gchar
*find_calltip(const gchar
*word
, GeanyFiletype
*ft
)
1824 const GPtrArray
*tags
;
1825 const gint arg_types
= tm_tag_function_t
| tm_tag_prototype_t
|
1826 tm_tag_method_t
| tm_tag_macro_with_arg_t
;
1827 TMTagAttrType
*attrs
= NULL
;
1829 GString
*str
= NULL
;
1832 g_return_val_if_fail(ft
&& word
&& *word
, NULL
);
1834 /* use all types in case language uses wrong tag type e.g. python "members" instead of "methods" */
1835 tags
= tm_workspace_find(word
, tm_tag_max_t
, attrs
, FALSE
, ft
->lang
);
1839 tag
= TM_TAG(tags
->pdata
[0]);
1841 if (ft
->id
== GEANY_FILETYPES_D
&&
1842 (tag
->type
== tm_tag_class_t
|| tag
->type
== tm_tag_struct_t
))
1844 /* user typed e.g. 'new Classname(' so lookup D constructor Classname::this() */
1845 tags
= tm_workspace_find_scoped("this", tag
->name
,
1846 arg_types
, attrs
, FALSE
, ft
->lang
, TRUE
);
1851 /* remove tags with no argument list */
1852 for (i
= 0; i
< tags
->len
; i
++)
1854 tag
= TM_TAG(tags
->pdata
[i
]);
1856 if (! tag
->atts
.entry
.arglist
)
1857 tags
->pdata
[i
] = NULL
;
1859 tm_tags_prune((GPtrArray
*) tags
);
1863 { /* remove duplicate calltips */
1864 TMTagAttrType sort_attr
[] = {tm_tag_attr_name_t
, tm_tag_attr_scope_t
,
1865 tm_tag_attr_arglist_t
, 0};
1867 tm_tags_sort((GPtrArray
*) tags
, sort_attr
, TRUE
);
1870 /* if the current word has changed since last time, start with the first tag match */
1871 if (! utils_str_equal(word
, calltip
.last_word
))
1872 calltip
.tag_index
= 0;
1873 /* cache the current word for next time */
1874 g_free(calltip
.last_word
);
1875 calltip
.last_word
= g_strdup(word
);
1876 calltip
.tag_index
= MIN(calltip
.tag_index
, tags
->len
- 1); /* ensure tag_index is in range */
1878 for (i
= calltip
.tag_index
; i
< tags
->len
; i
++)
1880 tag
= TM_TAG(tags
->pdata
[i
]);
1884 str
= g_string_new(NULL
);
1885 if (calltip
.tag_index
> 0)
1886 g_string_prepend(str
, "\001 "); /* up arrow */
1887 append_calltip(str
, tag
, FILETYPE_ID(ft
));
1889 else /* add a down arrow */
1891 if (calltip
.tag_index
> 0) /* already have an up arrow */
1892 g_string_insert_c(str
, 1, '\002');
1894 g_string_prepend(str
, "\002 ");
1900 gchar
*result
= str
->str
;
1902 g_string_free(str
, FALSE
);
1909 /* use pos = -1 to search for the previous unmatched open bracket. */
1910 gboolean
editor_show_calltip(GeanyEditor
*editor
, gint pos
)
1912 gint orig_pos
= pos
; /* the position for the calltip */
1915 gchar word
[GEANY_MAX_WORD_LENGTH
];
1917 ScintillaObject
*sci
;
1919 g_return_val_if_fail(editor
!= NULL
, FALSE
);
1920 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, FALSE
);
1924 lexer
= sci_get_lexer(sci
);
1928 /* position of '(' is unknown, so go backwards from current position to find it */
1929 pos
= sci_get_current_position(sci
);
1932 pos
= (lexer
== SCLEX_LATEX
) ? find_previous_brace(sci
, pos
) :
1933 find_start_bracket(sci
, pos
);
1938 /* the style 1 before the brace (which may be highlighted) */
1939 style
= sci_get_style_at(sci
, pos
- 1);
1940 if (! highlighting_is_code_style(lexer
, style
))
1944 editor_find_current_word(editor
, pos
- 1, word
, sizeof word
, NULL
);
1945 if (word
[0] == '\0')
1948 str
= find_calltip(word
, editor
->document
->file_type
);
1951 g_free(calltip
.text
); /* free the old calltip */
1953 calltip
.pos
= orig_pos
;
1956 utils_wrap_string(calltip
.text
, -1);
1957 SSM(sci
, SCI_CALLTIPSHOW
, orig_pos
, (sptr_t
) calltip
.text
);
1964 gchar
*editor_get_calltip_text(GeanyEditor
*editor
, const TMTag
*tag
)
1968 g_return_val_if_fail(editor
!= NULL
, NULL
);
1970 str
= g_string_new(NULL
);
1971 if (append_calltip(str
, tag
, editor
->document
->file_type
->id
))
1972 return g_string_free(str
, FALSE
);
1974 return g_string_free(str
, TRUE
);
1978 /* HTML entities auto completion from html_entities.tags text file */
1980 autocomplete_html(ScintillaObject
*sci
, const gchar
*root
, gsize rootlen
)
1983 gboolean found
= FALSE
;
1985 const gchar
**entities
= symbols_get_html_entities();
1987 if (*root
!= '&' || entities
== NULL
)
1990 words
= g_string_sized_new(500);
1993 if (entities
[i
] == NULL
)
1995 else if (entities
[i
][0] == '#')
1998 if (! strncmp(entities
[i
], root
, rootlen
))
2001 g_string_append_c(words
, '\n');
2003 g_string_append(words
, entities
[i
]);
2008 show_autocomplete(sci
, rootlen
, words
);
2010 g_string_free(words
, TRUE
);
2015 /* Current document & global tags autocompletion */
2017 autocomplete_tags(GeanyEditor
*editor
, const gchar
*root
, gsize rootlen
)
2019 TMTagAttrType attrs
[] = { tm_tag_attr_name_t
, 0 };
2020 const GPtrArray
*tags
;
2023 g_return_val_if_fail(editor
, FALSE
);
2025 doc
= editor
->document
;
2027 tags
= tm_workspace_find(root
, tm_tag_max_t
, attrs
, TRUE
, doc
->file_type
->lang
);
2030 show_tags_list(editor
, tags
, rootlen
);
2031 return tags
->len
> 0;
2037 static gboolean
autocomplete_check_html(GeanyEditor
*editor
, gint style
, gint pos
)
2039 GeanyFiletype
*ft
= editor
->document
->file_type
;
2040 gboolean
try = FALSE
;
2042 /* use entity completion when style is not JavaScript, ASP, Python, PHP, ...
2043 * (everything after SCE_HJ_START is for embedded scripting languages) */
2044 if (ft
->id
== GEANY_FILETYPES_HTML
&& style
< SCE_HJ_START
)
2046 else if (sci_get_lexer(editor
->sci
) == SCLEX_XML
&& style
< SCE_HJ_START
)
2048 else if (ft
->id
== GEANY_FILETYPES_PHP
)
2050 /* use entity completion when style is outside of PHP styles */
2051 if (! is_style_php(style
))
2056 gchar root
[GEANY_MAX_WORD_LENGTH
];
2059 read_current_word(editor
, pos
, root
, sizeof(root
), GEANY_WORDCHARS
"&", TRUE
);
2061 /* Allow something like ""some text"".
2062 * for entity completion we want to have completion for '&' within words. */
2063 tmp
= strchr(root
, '&');
2066 return autocomplete_html(editor
->sci
, tmp
, strlen(tmp
));
2073 /* Algorithm based on based on Scite's StartAutoCompleteWord()
2074 * @returns a sorted list of words matching @p root */
2075 static GSList
*get_doc_words(ScintillaObject
*sci
, gchar
*root
, gsize rootlen
)
2078 gint len
, current
, word_end
;
2079 gint pos_find
, flags
;
2082 GSList
*words
= NULL
;
2083 struct Sci_TextToFind ttf
;
2085 len
= sci_get_length(sci
);
2086 current
= sci_get_current_position(sci
) - rootlen
;
2088 ttf
.lpstrText
= root
;
2090 ttf
.chrg
.cpMax
= len
;
2091 ttf
.chrgText
.cpMin
= 0;
2092 ttf
.chrgText
.cpMax
= 0;
2093 flags
= SCFIND_WORDSTART
| SCFIND_MATCHCASE
;
2095 /* search the whole document for the word root and collect results */
2096 pos_find
= scintilla_send_message(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2097 while (pos_find
>= 0 && pos_find
< len
)
2099 word_end
= pos_find
+ rootlen
;
2100 if (pos_find
!= current
)
2102 word_end
= sci_word_end_position(sci
, word_end
, TRUE
);
2104 word_length
= word_end
- pos_find
;
2105 if (word_length
> rootlen
)
2107 word
= sci_get_contents_range(sci
, pos_find
, word_end
);
2108 /* search whether we already have the word in, otherwise add it */
2109 if (g_slist_find_custom(words
, word
, (GCompareFunc
)strcmp
) != NULL
)
2113 words
= g_slist_prepend(words
, word
);
2117 if (nmatches
== editor_prefs
.autocompletion_max_entries
)
2121 ttf
.chrg
.cpMin
= word_end
;
2122 pos_find
= scintilla_send_message(sci
, SCI_FINDTEXT
, flags
, (uptr_t
) &ttf
);
2125 return g_slist_sort(words
, (GCompareFunc
)utils_str_casecmp
);
2129 static gboolean
autocomplete_doc_word(GeanyEditor
*editor
, gchar
*root
, gsize rootlen
)
2131 ScintillaObject
*sci
= editor
->sci
;
2132 GSList
*words
, *node
;
2136 words
= get_doc_words(sci
, root
, rootlen
);
2139 scintilla_send_message(sci
, SCI_AUTOCCANCEL
, 0, 0);
2143 str
= g_string_sized_new(rootlen
* 2 * 10);
2144 foreach_slist(node
, words
)
2146 g_string_append(str
, node
->data
);
2149 g_string_append_c(str
, '\n');
2152 if (n_words
>= editor_prefs
.autocompletion_max_entries
)
2153 g_string_append(str
, "\n...");
2155 g_slist_free(words
);
2157 show_autocomplete(sci
, rootlen
, str
);
2158 g_string_free(str
, TRUE
);
2163 gboolean
editor_start_auto_complete(GeanyEditor
*editor
, gint pos
, gboolean force
)
2165 gint rootlen
, lexer
, style
;
2167 gchar cword
[GEANY_MAX_WORD_LENGTH
];
2168 ScintillaObject
*sci
;
2169 gboolean ret
= FALSE
;
2170 const gchar
*wordchars
;
2173 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2175 if (! editor_prefs
.auto_complete_symbols
&& ! force
)
2178 /* If we are at the beginning of the document, we skip autocompletion as we can't determine the
2179 * necessary styling information */
2180 if (G_UNLIKELY(pos
< 2))
2184 ft
= editor
->document
->file_type
;
2186 lexer
= sci_get_lexer(sci
);
2187 style
= sci_get_style_at(sci
, pos
- 2);
2189 /* don't autocomplete in comments and strings */
2190 if (!force
&& !highlighting_is_code_style(lexer
, style
))
2193 autocomplete_scope(editor
);
2194 ret
= autocomplete_check_html(editor
, style
, pos
);
2196 if (ft
->id
== GEANY_FILETYPES_LATEX
)
2197 wordchars
= GEANY_WORDCHARS
"\\"; /* add \ to word chars if we are in a LaTeX file */
2198 else if (ft
->id
== GEANY_FILETYPES_CSS
)
2199 wordchars
= GEANY_WORDCHARS
"-"; /* add - because they are part of property names */
2201 wordchars
= GEANY_WORDCHARS
;
2203 read_current_word(editor
, pos
, cword
, sizeof(cword
), wordchars
, TRUE
);
2205 rootlen
= strlen(root
);
2207 if (!ret
&& rootlen
> 0)
2209 if (ft
->id
== GEANY_FILETYPES_PHP
&& style
== SCE_HPHP_DEFAULT
&&
2210 rootlen
== 3 && strcmp(root
, "php") == 0 && pos
>= 5 &&
2211 sci_get_char_at(sci
, pos
- 5) == '<' &&
2212 sci_get_char_at(sci
, pos
- 4) == '?')
2214 /* nothing, don't complete PHP open tags */
2218 /* force is set when called by keyboard shortcut, otherwise start at the
2219 * editor_prefs.symbolcompletion_min_chars'th char */
2220 if (force
|| rootlen
>= editor_prefs
.symbolcompletion_min_chars
)
2222 /* complete tags, except if forcing when completion is already visible */
2223 if (!(force
&& SSM(sci
, SCI_AUTOCACTIVE
, 0, 0)))
2224 ret
= autocomplete_tags(editor
, root
, rootlen
);
2226 /* If forcing and there's nothing else to show, complete from words in document */
2227 if (!ret
&& (force
|| editor_prefs
.autocomplete_doc_words
))
2228 ret
= autocomplete_doc_word(editor
, root
, rootlen
);
2239 static const gchar
*snippets_find_completion_by_name(const gchar
*type
, const gchar
*name
)
2241 gchar
*result
= NULL
;
2244 g_return_val_if_fail(type
!= NULL
&& name
!= NULL
, NULL
);
2246 tmp
= g_hash_table_lookup(snippet_hash
, type
);
2249 result
= g_hash_table_lookup(tmp
, name
);
2251 /* whether nothing is set for the current filetype(tmp is NULL) or
2252 * the particular completion for this filetype is not set (result is NULL) */
2253 if (tmp
== NULL
|| result
== NULL
)
2255 tmp
= g_hash_table_lookup(snippet_hash
, "Default");
2258 result
= g_hash_table_lookup(tmp
, name
);
2261 /* if result is still NULL here, no completion could be found */
2263 /* result is owned by the hash table and will be freed when the table will destroyed */
2268 static void snippets_replace_specials(gpointer key
, gpointer value
, gpointer user_data
)
2271 GString
*pattern
= user_data
;
2273 g_return_if_fail(key
!= NULL
);
2274 g_return_if_fail(value
!= NULL
);
2276 needle
= g_strconcat("%", (gchar
*) key
, "%", NULL
);
2278 utils_string_replace_all(pattern
, needle
, (gchar
*) value
);
2283 static void fix_indentation(GeanyEditor
*editor
, GString
*buf
)
2285 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
2288 gint cflags
= G_REGEX_MULTILINE
;
2290 /* transform leading tabs into indent widths (in spaces) */
2291 whitespace
= g_strnfill(iprefs
->width
, ' ');
2292 regex
= g_regex_new("^ *(\t)", cflags
, 0, NULL
);
2293 while (utils_string_regex_replace_all(buf
, regex
, 1, whitespace
, TRUE
));
2294 g_regex_unref(regex
);
2296 /* remaining tabs are for alignment */
2297 if (iprefs
->type
!= GEANY_INDENT_TYPE_TABS
)
2298 utils_string_replace_all(buf
, "\t", whitespace
);
2300 /* use leading tabs */
2301 if (iprefs
->type
!= GEANY_INDENT_TYPE_SPACES
)
2305 /* for tabs+spaces mode we want the real tab width, not indent width */
2306 SETPTR(whitespace
, g_strnfill(sci_get_tab_width(editor
->sci
), ' '));
2307 str
= g_strdup_printf("^\t*(%s)", whitespace
);
2309 regex
= g_regex_new(str
, cflags
, 0, NULL
);
2310 while (utils_string_regex_replace_all(buf
, regex
, 1, "\t", TRUE
));
2311 g_regex_unref(regex
);
2318 /** Inserts text, replacing \\t tab chars (@c 0x9) and \\n newline chars (@c 0xA)
2319 * accordingly for the document.
2320 * - Leading tabs are replaced with the correct indentation.
2321 * - Non-leading tabs are replaced with spaces (except when using 'Tabs' indent type).
2322 * - Newline chars are replaced with the correct line ending string.
2323 * This is very useful for inserting code without having to handle the indent
2324 * type yourself (Tabs & Spaces mode can be tricky).
2325 * @param editor Editor.
2326 * @param text Intended as e.g. @c "if (foo)\n\tbar();".
2327 * @param insert_pos Document position to insert text at.
2328 * @param cursor_index If >= 0, the index into @a text to place the cursor.
2329 * @param newline_indent_size Indentation size (in spaces) to insert for each newline; use
2330 * -1 to read the indent size from the line with @a insert_pos on it.
2331 * @param replace_newlines Whether to replace newlines. If
2332 * newlines have been replaced already, this should be false, to avoid errors e.g. on Windows.
2333 * @warning Make sure all \\t tab chars in @a text are intended as indent widths or alignment,
2334 * not hard tabs, as those won't be preserved.
2335 * @note This doesn't scroll the cursor in view afterwards. **/
2336 void editor_insert_text_block(GeanyEditor
*editor
, const gchar
*text
, gint insert_pos
,
2337 gint cursor_index
, gint newline_indent_size
, gboolean replace_newlines
)
2339 ScintillaObject
*sci
= editor
->sci
;
2340 gint line_start
= sci_get_line_from_position(sci
, insert_pos
);
2342 const gchar
*eol
= editor_get_eol_char(editor
);
2345 g_return_if_fail(text
);
2346 g_return_if_fail(editor
!= NULL
);
2347 g_return_if_fail(insert_pos
>= 0);
2349 buf
= g_string_new(text
);
2351 if (cursor_index
>= 0)
2352 g_string_insert(buf
, cursor_index
, geany_cursor_marker
); /* remember cursor pos */
2354 if (newline_indent_size
== -1)
2356 /* count indent size up to insert_pos instead of asking sci
2357 * because there may be spaces after it */
2358 gchar
*tmp
= sci_get_line(sci
, line_start
);
2360 idx
= insert_pos
- sci_get_position_from_line(sci
, line_start
);
2362 newline_indent_size
= count_indent_size(editor
, tmp
);
2366 /* Add line indents (in spaces) */
2367 if (newline_indent_size
> 0)
2369 const gchar
*nl
= replace_newlines
? "\n" : eol
;
2372 whitespace
= g_strnfill(newline_indent_size
, ' ');
2373 SETPTR(whitespace
, g_strconcat(nl
, whitespace
, NULL
));
2374 utils_string_replace_all(buf
, nl
, whitespace
);
2378 /* transform line endings */
2379 if (replace_newlines
)
2380 utils_string_replace_all(buf
, "\n", eol
);
2382 fix_indentation(editor
, buf
);
2384 idx
= replace_cursor_markers(editor
, buf
);
2387 sci_insert_text(sci
, insert_pos
, buf
->str
);
2388 sci_set_current_position(sci
, insert_pos
+ idx
, FALSE
);
2391 sci_insert_text(sci
, insert_pos
, buf
->str
);
2393 snippet_cursor_insert_pos
= sci_get_current_position(sci
);
2395 g_string_free(buf
, TRUE
);
2399 /* Move the cursor to the next specified cursor position in an inserted snippet.
2400 * Can, and should, be optimized to give better results */
2401 void editor_goto_next_snippet_cursor(GeanyEditor
*editor
)
2403 ScintillaObject
*sci
= editor
->sci
;
2404 gint current_pos
= sci_get_current_position(sci
);
2406 if (snippet_offsets
&& !g_queue_is_empty(snippet_offsets
))
2410 offset
= GPOINTER_TO_INT(g_queue_pop_head(snippet_offsets
));
2411 if (current_pos
> snippet_cursor_insert_pos
)
2412 snippet_cursor_insert_pos
= offset
+ current_pos
;
2414 snippet_cursor_insert_pos
+= offset
;
2416 sci_set_current_position(sci
, snippet_cursor_insert_pos
, TRUE
);
2425 static void snippets_make_replacements(GeanyEditor
*editor
, GString
*pattern
)
2427 GHashTable
*specials
;
2429 /* replace 'special' completions */
2430 specials
= g_hash_table_lookup(snippet_hash
, "Special");
2431 if (G_LIKELY(specials
!= NULL
))
2433 g_hash_table_foreach(specials
, snippets_replace_specials
, pattern
);
2436 /* now transform other wildcards */
2437 utils_string_replace_all(pattern
, "%newline%", "\n");
2438 utils_string_replace_all(pattern
, "%ws%", "\t");
2440 /* replace %cursor% by a very unlikely string marker */
2441 utils_string_replace_all(pattern
, "%cursor%", geany_cursor_marker
);
2443 /* unescape '%' after all %wildcards% */
2444 templates_replace_valist(pattern
, "{pc}", "%", NULL
);
2446 /* replace any template {foo} wildcards */
2447 templates_replace_common(pattern
, editor
->document
->file_name
, editor
->document
->file_type
, NULL
);
2451 static gssize
replace_cursor_markers(GeanyEditor
*editor
, GString
*pattern
)
2453 gssize cur_index
= -1;
2455 GList
*temp_list
= NULL
;
2456 gint cursor_steps
= 0, old_cursor
= 0;
2461 cursor_steps
= utils_string_find(pattern
, cursor_steps
, -1, geany_cursor_marker
);
2462 if (cursor_steps
== -1)
2465 g_string_erase(pattern
, cursor_steps
, strlen(geany_cursor_marker
));
2469 /* save the relative offset to each cursor position */
2470 temp_list
= g_list_prepend(temp_list
, GINT_TO_POINTER(cursor_steps
- old_cursor
));
2474 /* first cursor already includes newline positions */
2475 cur_index
= cursor_steps
;
2477 old_cursor
= cursor_steps
;
2480 /* put the cursor positions for the most recent
2481 * parsed snippet first, followed by any remaining positions */
2487 temp_list
= g_list_reverse(temp_list
);
2488 foreach_list(node
, temp_list
)
2489 g_queue_push_nth(snippet_offsets
, node
->data
, i
++);
2491 /* limit length of queue */
2492 while (g_queue_get_length(snippet_offsets
) > 20)
2493 g_queue_pop_tail(snippet_offsets
);
2495 g_list_free(temp_list
);
2497 /* if there's no first cursor, skip whole snippet */
2499 cur_index
= pattern
->len
;
2505 static gboolean
snippets_complete_constructs(GeanyEditor
*editor
, gint pos
, const gchar
*word
)
2507 ScintillaObject
*sci
= editor
->sci
;
2509 const gchar
*completion
;
2511 gint ft_id
= editor
->document
->file_type
->id
;
2513 str
= g_strdup(word
);
2516 completion
= snippets_find_completion_by_name(filetypes
[ft_id
]->name
, str
);
2517 if (completion
== NULL
)
2523 /* remove the typed word, it will be added again by the used auto completion
2524 * (not really necessary but this makes the auto completion more flexible,
2525 * e.g. with a completion like hi=hello, so typing "hi<TAB>" will result in "hello") */
2526 str_len
= strlen(str
);
2527 sci_set_selection_start(sci
, pos
- str_len
);
2528 sci_set_selection_end(sci
, pos
);
2529 sci_replace_sel(sci
, "");
2530 pos
-= str_len
; /* pos has changed while deleting */
2532 editor_insert_snippet(editor
, pos
, completion
);
2533 sci_scroll_caret(sci
);
2540 static gboolean
at_eol(ScintillaObject
*sci
, gint pos
)
2542 gint line
= sci_get_line_from_position(sci
, pos
);
2545 /* skip any trailing spaces */
2548 c
= sci_get_char_at(sci
, pos
);
2549 if (c
== ' ' || c
== '\t')
2555 return (pos
== sci_get_line_end_position(sci
, line
));
2559 gboolean
editor_complete_snippet(GeanyEditor
*editor
, gint pos
)
2561 gboolean result
= FALSE
;
2564 ScintillaObject
*sci
;
2566 g_return_val_if_fail(editor
!= NULL
, FALSE
);
2569 if (sci_has_selection(sci
))
2571 /* return if we are editing an existing line (chars on right of cursor) */
2572 if (keybindings_lookup_item(GEANY_KEY_GROUP_EDITOR
,
2573 GEANY_KEYS_EDITOR_COMPLETESNIPPET
)->key
== GDK_space
&&
2574 ! editor_prefs
.complete_snippets_whilst_editing
&& ! at_eol(sci
, pos
))
2577 wc
= snippets_find_completion_by_name("Special", "wordchars");
2578 word
= editor_read_word_stem(editor
, pos
, wc
);
2580 /* prevent completion of "for " */
2582 ! isspace(sci_get_char_at(sci
, pos
- 1))) /* pos points to the line end char so use pos -1 */
2584 sci_start_undo_action(sci
); /* needed because we insert a space separately from construct */
2585 result
= snippets_complete_constructs(editor
, pos
, word
);
2586 sci_end_undo_action(sci
);
2588 sci_cancel(sci
); /* cancel any autocompletion list, etc */
2594 void editor_show_macro_list(GeanyEditor
*editor
)
2598 if (editor
== NULL
|| editor
->document
->file_type
== NULL
)
2601 words
= symbols_get_macro_list(editor
->document
->file_type
->lang
);
2605 SSM(editor
->sci
, SCI_USERLISTSHOW
, 1, (sptr_t
) words
->str
);
2606 g_string_free(words
, TRUE
);
2610 static void insert_closing_tag(GeanyEditor
*editor
, gint pos
, gchar ch
, const gchar
*tag_name
)
2612 ScintillaObject
*sci
= editor
->sci
;
2613 gchar
*to_insert
= NULL
;
2617 const gchar
*gt
= ">";
2618 /* if there is already a '>' behind the cursor, don't add it */
2619 if (sci_get_char_at(sci
, pos
) == '>')
2622 to_insert
= g_strconcat(tag_name
, gt
, NULL
);
2625 to_insert
= g_strconcat("</", tag_name
, ">", NULL
);
2627 sci_start_undo_action(sci
);
2628 sci_replace_sel(sci
, to_insert
);
2630 sci_set_selection(sci
, pos
, pos
);
2631 sci_end_undo_action(sci
);
2637 * (stolen from anjuta and heavily modified)
2638 * This routine will auto complete XML or HTML tags that are still open by closing them
2639 * @param ch The character we are dealing with, currently only works with the '>' character
2640 * @return True if handled, false otherwise
2642 static gboolean
handle_xml(GeanyEditor
*editor
, gint pos
, gchar ch
)
2644 ScintillaObject
*sci
= editor
->sci
;
2645 gint lexer
= sci_get_lexer(sci
);
2646 gint min
, size
, style
;
2647 gchar
*str_found
, sel
[512];
2648 gboolean result
= FALSE
;
2650 /* If the user has turned us off, quit now.
2651 * This may make sense only in certain languages */
2652 if (! editor_prefs
.auto_close_xml_tags
|| (lexer
!= SCLEX_HTML
&& lexer
!= SCLEX_XML
))
2655 /* return if we are inside any embedded script */
2656 style
= sci_get_style_at(sci
, pos
);
2657 if (style
> SCE_H_XCCOMMENT
&& ! highlighting_is_string_style(lexer
, style
))
2660 /* if ch is /, check for </, else quit */
2661 if (ch
== '/' && sci_get_char_at(sci
, pos
- 2) != '<')
2664 /* Grab the last 512 characters or so */
2665 min
= pos
- (sizeof(sel
) - 1);
2666 if (min
< 0) min
= 0;
2669 return FALSE
; /* Smallest tag is 3 characters e.g. <p> */
2671 sci_get_text_range(sci
, min
, pos
, sel
);
2672 sel
[sizeof(sel
) - 1] = '\0';
2674 if (ch
== '>' && sel
[pos
- min
- 2] == '/')
2675 /* User typed something like "<br/>" */
2680 size
-= 2; /* skip </ */
2681 str_found
= utils_find_open_xml_tag(sel
, size
);
2683 if (lexer
== SCLEX_HTML
&& utils_is_short_html_tag(str_found
))
2687 else if (!EMPTY(str_found
))
2689 insert_closing_tag(editor
, pos
, ch
, str_found
);
2697 /* like sci_get_line_indentation(), but for a string. */
2698 static gsize
count_indent_size(GeanyEditor
*editor
, const gchar
*base_indent
)
2701 gsize tab_size
= sci_get_tab_width(editor
->sci
);
2704 g_return_val_if_fail(base_indent
, 0);
2706 for (ptr
= base_indent
; *ptr
!= 0; ptr
++)
2724 /* Handles special cases where HTML is embedded in another language or
2725 * another language is embedded in HTML */
2726 static GeanyFiletype
*editor_get_filetype_at_line(GeanyEditor
*editor
, gint line
)
2728 gint style
, line_start
;
2729 GeanyFiletype
*current_ft
;
2731 g_return_val_if_fail(editor
!= NULL
, NULL
);
2732 g_return_val_if_fail(editor
->document
->file_type
!= NULL
, NULL
);
2734 current_ft
= editor
->document
->file_type
;
2735 line_start
= sci_get_position_from_line(editor
->sci
, line
);
2736 style
= sci_get_style_at(editor
->sci
, line_start
);
2738 /* Handle PHP filetype with embedded HTML */
2739 if (current_ft
->id
== GEANY_FILETYPES_PHP
&& ! is_style_php(style
))
2740 current_ft
= filetypes
[GEANY_FILETYPES_HTML
];
2742 /* Handle languages embedded in HTML */
2743 if (current_ft
->id
== GEANY_FILETYPES_HTML
)
2746 if (style
>= SCE_HJ_DEFAULT
&& style
<= SCE_HJ_REGEX
)
2747 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2749 else if (style
>= SCE_HJA_DEFAULT
&& style
<= SCE_HJA_REGEX
)
2750 current_ft
= filetypes
[GEANY_FILETYPES_JS
];
2752 else if (style
>= SCE_HB_DEFAULT
&& style
<= SCE_HB_STRINGEOL
)
2753 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2755 else if (style
>= SCE_HBA_DEFAULT
&& style
<= SCE_HBA_STRINGEOL
)
2756 current_ft
= filetypes
[GEANY_FILETYPES_BASIC
];
2757 /* Embedded Python */
2758 else if (style
>= SCE_HP_DEFAULT
&& style
<= SCE_HP_IDENTIFIER
)
2759 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2761 else if (style
>= SCE_HPA_DEFAULT
&& style
<= SCE_HPA_IDENTIFIER
)
2762 current_ft
= filetypes
[GEANY_FILETYPES_PYTHON
];
2764 else if ((style
>= SCE_HPHP_DEFAULT
&& style
<= SCE_HPHP_OPERATOR
) ||
2765 style
== SCE_HPHP_COMPLEX_VARIABLE
)
2767 current_ft
= filetypes
[GEANY_FILETYPES_PHP
];
2771 /* Ensure the filetype's config is loaded */
2772 filetypes_load_config(current_ft
->id
, FALSE
);
2778 static void real_comment_multiline(GeanyEditor
*editor
, gint line_start
, gint last_line
)
2781 gchar
*str_begin
, *str_end
;
2782 const gchar
*co
, *cc
;
2786 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
2788 ft
= editor_get_filetype_at_line(editor
, line_start
);
2790 eol
= editor_get_eol_char(editor
);
2791 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2792 g_return_if_reached();
2793 str_begin
= g_strdup_printf("%s%s", (co
!= NULL
) ? co
: "", eol
);
2794 str_end
= g_strdup_printf("%s%s", (cc
!= NULL
) ? cc
: "", eol
);
2796 /* insert the comment strings */
2797 sci_insert_text(editor
->sci
, line_start
, str_begin
);
2798 line_len
= sci_get_position_from_line(editor
->sci
, last_line
+ 2);
2799 sci_insert_text(editor
->sci
, line_len
, str_end
);
2806 /* find @p text inside the range of the current style */
2807 static gint
find_in_current_style(ScintillaObject
*sci
, const gchar
*text
, gboolean backwards
)
2809 gint start
= sci_get_current_position(sci
);
2811 gint len
= sci_get_length(sci
);
2812 gint current_style
= sci_get_style_at(sci
, start
);
2813 struct Sci_TextToFind ttf
;
2815 while (start
> 0 && sci_get_style_at(sci
, start
- 1) == current_style
)
2817 while (end
< len
&& sci_get_style_at(sci
, end
+ 1) == current_style
)
2820 ttf
.lpstrText
= (gchar
*) text
;
2821 ttf
.chrg
.cpMin
= backwards
? end
+ 1 : start
;
2822 ttf
.chrg
.cpMax
= backwards
? start
: end
+ 1;
2823 return sci_find_text(sci
, 0, &ttf
);
2827 static void sci_delete_line(ScintillaObject
*sci
, gint line
)
2829 gint start
= sci_get_position_from_line(sci
, line
);
2830 gint len
= sci_get_line_length(sci
, line
);
2831 SSM(sci
, SCI_DELETERANGE
, start
, len
);
2835 static gboolean
real_uncomment_multiline(GeanyEditor
*editor
)
2837 /* find the beginning of the multi line comment */
2838 gint start
, end
, start_line
, end_line
;
2840 const gchar
*co
, *cc
;
2842 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, FALSE
);
2844 ft
= editor_get_filetype_at_line(editor
, sci_get_current_line(editor
->sci
));
2845 if (! filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
))
2846 g_return_val_if_reached(FALSE
);
2848 start
= find_in_current_style(editor
->sci
, co
, TRUE
);
2849 end
= find_in_current_style(editor
->sci
, cc
, FALSE
);
2851 if (start
< 0 || end
< 0 || start
> end
/* who knows */)
2854 start_line
= sci_get_line_from_position(editor
->sci
, start
);
2855 end_line
= sci_get_line_from_position(editor
->sci
, end
);
2857 /* remove comment close chars */
2858 SSM(editor
->sci
, SCI_DELETERANGE
, end
, strlen(cc
));
2859 if (sci_is_blank_line(editor
->sci
, end_line
))
2860 sci_delete_line(editor
->sci
, end_line
);
2862 /* remove comment open chars (do it last since it would move the end position) */
2863 SSM(editor
->sci
, SCI_DELETERANGE
, start
, strlen(co
));
2864 if (sci_is_blank_line(editor
->sci
, start_line
))
2865 sci_delete_line(editor
->sci
, start_line
);
2871 static gint
get_multiline_comment_style(GeanyEditor
*editor
, gint line_start
)
2873 gint lexer
= sci_get_lexer(editor
->sci
);
2876 /* List only those lexers which support multi line comments */
2882 if (is_style_php(sci_get_style_at(editor
->sci
, line_start
)))
2883 style_comment
= SCE_HPHP_COMMENT
;
2885 style_comment
= SCE_H_COMMENT
;
2889 case SCLEX_LITERATEHASKELL
:
2890 style_comment
= SCE_HA_COMMENTBLOCK
; break;
2891 case SCLEX_LUA
: style_comment
= SCE_LUA_COMMENT
; break;
2892 case SCLEX_CSS
: style_comment
= SCE_CSS_COMMENT
; break;
2893 case SCLEX_SQL
: style_comment
= SCE_SQL_COMMENT
; break;
2894 case SCLEX_CAML
: style_comment
= SCE_CAML_COMMENT
; break;
2895 case SCLEX_D
: style_comment
= SCE_D_COMMENT
; break;
2896 case SCLEX_PASCAL
: style_comment
= SCE_PAS_COMMENT
; break;
2897 case SCLEX_RUST
: style_comment
= SCE_RUST_COMMENTBLOCK
; break;
2898 default: style_comment
= SCE_C_COMMENT
;
2901 return style_comment
;
2905 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise
2906 * returns the amount of uncommented single comment lines, in case of multi line uncomment
2907 * it returns just 1 */
2908 gint
editor_do_uncomment(GeanyEditor
*editor
, gint line
, gboolean toggle
)
2910 gint first_line
, last_line
;
2911 gint x
, i
, line_start
, line_len
;
2912 gint sel_start
, sel_end
;
2916 const gchar
*co
, *cc
;
2917 gboolean single_line
= FALSE
;
2920 g_return_val_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
, 0);
2923 { /* use selection or current line */
2924 sel_start
= sci_get_selection_start(editor
->sci
);
2925 sel_end
= sci_get_selection_end(editor
->sci
);
2927 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
2928 /* Find the last line with chars selected (not EOL char) */
2929 last_line
= sci_get_line_from_position(editor
->sci
,
2930 sel_end
- editor_get_eol_char_len(editor
));
2931 last_line
= MAX(first_line
, last_line
);
2935 first_line
= last_line
= line
;
2936 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
2939 ft
= editor_get_filetype_at_line(editor
, first_line
);
2941 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
2944 co_len
= strlen(co
);
2948 sci_start_undo_action(editor
->sci
);
2950 for (i
= first_line
; i
<= last_line
; i
++)
2954 line_start
= sci_get_position_from_line(editor
->sci
, i
);
2955 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
2958 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
2961 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
2962 sel
[buf_len
] = '\0';
2964 while (isspace(sel
[x
])) x
++;
2966 /* to skip blank lines */
2967 if (x
< line_len
&& sel
[x
] != '\0')
2969 /* use single line comment */
2976 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
2977 if (strncmp(sel
+ x
, co
, co_len
) != 0 ||
2978 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) != 0)
2985 if (strncmp(sel
+ x
, co
, co_len
) != 0)
2989 sci_set_selection(editor
->sci
, line_start
+ x
, line_start
+ x
+ co_len
);
2990 sci_replace_sel(editor
->sci
, "");
2993 /* use multi line comment */
2998 /* skip lines which are already comments */
2999 style_comment
= get_multiline_comment_style(editor
, line_start
);
3000 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3002 if (real_uncomment_multiline(editor
))
3006 /* break because we are already on the last line */
3011 sci_end_undo_action(editor
->sci
);
3013 /* restore selection if there is one
3014 * but don't touch the selection if caller is editor_do_comment_toggle */
3015 if (! toggle
&& sel_start
< sel_end
)
3019 sci_set_selection_start(editor
->sci
, sel_start
- co_len
);
3020 sci_set_selection_end(editor
->sci
, sel_end
- (count
* co_len
));
3024 gint eol_len
= editor_get_eol_char_len(editor
);
3025 sci_set_selection_start(editor
->sci
, sel_start
- co_len
- eol_len
);
3026 sci_set_selection_end(editor
->sci
, sel_end
- co_len
- eol_len
);
3034 void editor_do_comment_toggle(GeanyEditor
*editor
)
3036 gint first_line
, last_line
;
3037 gint x
, i
, line_start
, line_len
, first_line_start
, last_line_start
;
3038 gint sel_start
, sel_end
;
3039 gint count_commented
= 0, count_uncommented
= 0;
3041 const gchar
*co
, *cc
;
3042 gboolean break_loop
= FALSE
, single_line
= FALSE
;
3043 gboolean first_line_was_comment
= FALSE
;
3044 gboolean last_line_was_comment
= FALSE
;
3046 gsize tm_len
= strlen(editor_prefs
.comment_toggle_mark
);
3049 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3051 sel_start
= sci_get_selection_start(editor
->sci
);
3052 sel_end
= sci_get_selection_end(editor
->sci
);
3054 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3055 /* Find the last line with chars selected (not EOL char) */
3056 last_line
= sci_get_line_from_position(editor
->sci
,
3057 sel_end
- editor_get_eol_char_len(editor
));
3058 last_line
= MAX(first_line
, last_line
);
3060 first_line_start
= sci_get_position_from_line(editor
->sci
, first_line
);
3061 last_line_start
= sci_get_position_from_line(editor
->sci
, last_line
);
3063 ft
= editor_get_filetype_at_line(editor
, first_line
);
3065 if (! filetype_get_comment_open_close(ft
, TRUE
, &co
, &cc
))
3068 co_len
= strlen(co
);
3072 sci_start_undo_action(editor
->sci
);
3074 for (i
= first_line
; (i
<= last_line
) && (! break_loop
); i
++)
3078 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3079 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3082 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3085 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3086 sel
[buf_len
] = '\0';
3088 while (isspace(sel
[x
])) x
++;
3090 /* use single line comment */
3093 gboolean do_continue
= FALSE
;
3096 if (strncmp(sel
+ x
, co
, co_len
) == 0 &&
3097 strncmp(sel
+ x
+ co_len
, editor_prefs
.comment_toggle_mark
, tm_len
) == 0)
3102 if (do_continue
&& i
== first_line
)
3103 first_line_was_comment
= TRUE
;
3104 last_line_was_comment
= do_continue
;
3108 count_uncommented
+= editor_do_uncomment(editor
, i
, TRUE
);
3112 /* we are still here, so the above lines were not already comments, so comment it */
3113 editor_do_comment(editor
, i
, TRUE
, TRUE
, TRUE
);
3116 /* use multi line comment */
3121 /* skip lines which are already comments */
3122 style_comment
= get_multiline_comment_style(editor
, line_start
);
3123 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3125 if (real_uncomment_multiline(editor
))
3126 count_uncommented
++;
3130 real_comment_multiline(editor
, line_start
, last_line
);
3134 /* break because we are already on the last line */
3140 sci_end_undo_action(editor
->sci
);
3144 /* restore selection or caret position */
3147 gint a
= (first_line_was_comment
) ? - (gint
) co_len
: (gint
) co_len
;
3150 /* don't modify sel_start when the selection starts within indentation */
3151 read_indent(editor
, sel_start
);
3152 indent_len
= (gint
) strlen(indent
);
3153 if ((sel_start
- first_line_start
) <= indent_len
)
3155 /* if the selection start was inside the comment mark, adjust the position */
3156 else if (first_line_was_comment
&&
3157 sel_start
>= (first_line_start
+ indent_len
) &&
3158 sel_start
<= (first_line_start
+ indent_len
+ (gint
) co_len
))
3160 a
= (first_line_start
+ indent_len
) - sel_start
;
3163 if (sel_start
< sel_end
)
3165 gint b
= (count_commented
* (gint
) co_len
) - (count_uncommented
* (gint
) co_len
);
3167 /* same for selection end, but here we add an offset on the offset above */
3168 read_indent(editor
, sel_end
+ b
);
3169 indent_len
= (gint
) strlen(indent
);
3170 if ((sel_end
- last_line_start
) < indent_len
)
3171 b
+= last_line_was_comment
? (gint
) co_len
: -(gint
) co_len
;
3172 else if (last_line_was_comment
&&
3173 sel_end
>= (last_line_start
+ indent_len
) &&
3174 sel_end
<= (last_line_start
+ indent_len
+ (gint
) co_len
))
3176 b
+= (gint
) co_len
- (sel_end
- (last_line_start
+ indent_len
));
3179 sci_set_selection_start(editor
->sci
, sel_start
+ a
);
3180 sci_set_selection_end(editor
->sci
, sel_end
+ b
);
3183 sci_set_current_position(editor
->sci
, sel_start
+ a
, TRUE
);
3187 gint eol_len
= editor_get_eol_char_len(editor
);
3188 if (count_uncommented
> 0)
3190 sci_set_selection_start(editor
->sci
, sel_start
- (gint
) co_len
+ eol_len
);
3191 sci_set_selection_end(editor
->sci
, sel_end
- (gint
) co_len
+ eol_len
);
3193 else if (count_commented
> 0)
3195 sci_set_selection_start(editor
->sci
, sel_start
+ (gint
) co_len
- eol_len
);
3196 sci_set_selection_end(editor
->sci
, sel_end
+ (gint
) co_len
- eol_len
);
3198 if (sel_start
>= sel_end
)
3199 sci_scroll_caret(editor
->sci
);
3204 /* set toggle to TRUE if the caller is the toggle function, FALSE otherwise */
3205 void editor_do_comment(GeanyEditor
*editor
, gint line
, gboolean allow_empty_lines
, gboolean toggle
,
3206 gboolean single_comment
)
3208 gint first_line
, last_line
;
3209 gint x
, i
, line_start
, line_len
;
3210 gint sel_start
, sel_end
, co_len
;
3212 const gchar
*co
, *cc
;
3213 gboolean break_loop
= FALSE
, single_line
= FALSE
;
3216 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3219 { /* use selection or current line */
3220 sel_start
= sci_get_selection_start(editor
->sci
);
3221 sel_end
= sci_get_selection_end(editor
->sci
);
3223 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3224 /* Find the last line with chars selected (not EOL char) */
3225 last_line
= sci_get_line_from_position(editor
->sci
,
3226 sel_end
- editor_get_eol_char_len(editor
));
3227 last_line
= MAX(first_line
, last_line
);
3231 first_line
= last_line
= line
;
3232 sel_start
= sel_end
= sci_get_position_from_line(editor
->sci
, line
);
3235 ft
= editor_get_filetype_at_line(editor
, first_line
);
3237 if (! filetype_get_comment_open_close(ft
, single_comment
, &co
, &cc
))
3240 co_len
= strlen(co
);
3244 sci_start_undo_action(editor
->sci
);
3246 for (i
= first_line
; (i
<= last_line
) && (! break_loop
); i
++)
3250 line_start
= sci_get_position_from_line(editor
->sci
, i
);
3251 line_len
= sci_get_line_end_position(editor
->sci
, i
) - line_start
;
3254 buf_len
= MIN((gint
)sizeof(sel
) - 1, line_len
);
3257 sci_get_text_range(editor
->sci
, line_start
, line_start
+ buf_len
, sel
);
3258 sel
[buf_len
] = '\0';
3260 while (isspace(sel
[x
])) x
++;
3262 /* to skip blank lines */
3263 if (allow_empty_lines
|| (x
< line_len
&& sel
[x
] != '\0'))
3265 /* use single line comment */
3268 gint start
= line_start
;
3271 if (ft
->comment_use_indent
)
3272 start
= line_start
+ x
;
3276 gchar
*text
= g_strconcat(co
, editor_prefs
.comment_toggle_mark
, NULL
);
3277 sci_insert_text(editor
->sci
, start
, text
);
3281 sci_insert_text(editor
->sci
, start
, co
);
3283 /* use multi line comment */
3288 /* skip lines which are already comments */
3289 style_comment
= get_multiline_comment_style(editor
, line_start
);
3290 if (sci_get_style_at(editor
->sci
, line_start
+ x
) == style_comment
)
3293 real_comment_multiline(editor
, line_start
, last_line
);
3295 /* break because we are already on the last line */
3301 sci_end_undo_action(editor
->sci
);
3303 /* restore selection if there is one
3304 * but don't touch the selection if caller is editor_do_comment_toggle */
3305 if (! toggle
&& sel_start
< sel_end
)
3309 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
);
3310 sci_set_selection_end(editor
->sci
, sel_end
+ ((i
- first_line
) * co_len
));
3314 gint eol_len
= editor_get_eol_char_len(editor
);
3315 sci_set_selection_start(editor
->sci
, sel_start
+ co_len
+ eol_len
);
3316 sci_set_selection_end(editor
->sci
, sel_end
+ co_len
+ eol_len
);
3322 static gboolean brace_timeout_active
= FALSE
;
3324 static gboolean
delay_match_brace(G_GNUC_UNUSED gpointer user_data
)
3326 GeanyDocument
*doc
= document_get_current();
3327 GeanyEditor
*editor
;
3328 gint brace_pos
= GPOINTER_TO_INT(user_data
);
3329 gint end_pos
, cur_pos
;
3331 brace_timeout_active
= FALSE
;
3335 editor
= doc
->editor
;
3336 cur_pos
= sci_get_current_position(editor
->sci
) - 1;
3338 if (cur_pos
!= brace_pos
)
3341 if (cur_pos
!= brace_pos
)
3343 /* we have moved past the original brace_pos, but after the timeout
3344 * we may now be on a new brace, so check again */
3345 editor_highlight_braces(editor
, cur_pos
);
3349 if (!utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3351 editor_highlight_braces(editor
, cur_pos
);
3354 end_pos
= sci_find_matching_brace(editor
->sci
, brace_pos
);
3358 gint col
= MIN(sci_get_col_from_position(editor
->sci
, brace_pos
),
3359 sci_get_col_from_position(editor
->sci
, end_pos
));
3360 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, col
, 0);
3361 SSM(editor
->sci
, SCI_BRACEHIGHLIGHT
, brace_pos
, end_pos
);
3365 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3366 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, brace_pos
, 0);
3372 static void editor_highlight_braces(GeanyEditor
*editor
, gint cur_pos
)
3374 gint brace_pos
= cur_pos
- 1;
3376 SSM(editor
->sci
, SCI_SETHIGHLIGHTGUIDE
, 0, 0);
3377 SSM(editor
->sci
, SCI_BRACEBADLIGHT
, (uptr_t
)-1, 0);
3379 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3382 if (! utils_isbrace(sci_get_char_at(editor
->sci
, brace_pos
), editor_prefs
.brace_match_ltgt
))
3387 if (!brace_timeout_active
)
3389 brace_timeout_active
= TRUE
;
3390 /* delaying matching makes scrolling faster e.g. holding down arrow keys */
3391 g_timeout_add(100, delay_match_brace
, GINT_TO_POINTER(brace_pos
));
3396 static gboolean
in_block_comment(gint lexer
, gint style
)
3402 return (style
== SCE_C_COMMENT
||
3403 style
== SCE_C_COMMENTDOC
);
3406 return (style
== SCE_PAS_COMMENT
||
3407 style
== SCE_PAS_COMMENT2
);
3410 return (style
== SCE_D_COMMENT
||
3411 style
== SCE_D_COMMENTDOC
||
3412 style
== SCE_D_COMMENTNESTED
);
3415 return (style
== SCE_HPHP_COMMENT
);
3418 return (style
== SCE_CSS_COMMENT
);
3421 return (style
== SCE_RUST_COMMENTBLOCK
||
3422 style
== SCE_RUST_COMMENTBLOCKDOC
);
3430 static gboolean
is_comment_char(gchar c
, gint lexer
)
3432 if ((c
== '*' || c
== '+') && lexer
== SCLEX_D
)
3442 static void auto_multiline(GeanyEditor
*editor
, gint cur_line
)
3444 ScintillaObject
*sci
= editor
->sci
;
3445 gint indent_pos
, style
;
3446 gint lexer
= sci_get_lexer(sci
);
3448 /* Use the start of the line enter was pressed on, to avoid any doc keyword styles */
3449 indent_pos
= sci_get_line_indent_position(sci
, cur_line
- 1);
3450 style
= sci_get_style_at(sci
, indent_pos
);
3451 if (!in_block_comment(lexer
, style
))
3454 /* Check whether the comment block continues on this line */
3455 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3456 if (sci_get_style_at(sci
, indent_pos
) == style
|| indent_pos
>= sci_get_length(sci
))
3458 gchar
*previous_line
= sci_get_line(sci
, cur_line
- 1);
3459 /* the type of comment, '*' (C/C++/Java), '+' and the others (D) */
3460 const gchar
*continuation
= "*";
3461 const gchar
*whitespace
= ""; /* to hold whitespace if needed */
3463 gint len
= strlen(previous_line
);
3466 /* find and stop at end of multi line comment */
3468 while (i
>= 0 && isspace(previous_line
[i
])) i
--;
3469 if (i
>= 1 && is_comment_char(previous_line
[i
- 1], lexer
) && previous_line
[i
] == '/')
3471 gint indent_len
, indent_width
;
3473 indent_pos
= sci_get_line_indent_position(sci
, cur_line
);
3474 indent_len
= sci_get_col_from_position(sci
, indent_pos
);
3475 indent_width
= editor_get_indent_prefs(editor
)->width
;
3477 /* if there is one too many spaces, delete the last space,
3478 * to return to the indent used before the multiline comment was started. */
3479 if (indent_len
% indent_width
== 1)
3480 SSM(sci
, SCI_DELETEBACKNOTLINE
, 0, 0); /* remove whitespace indent */
3481 g_free(previous_line
);
3484 /* check whether we are on the second line of multi line comment */
3486 while (i
< len
&& isspace(previous_line
[i
])) i
++; /* get to start of the line */
3489 previous_line
[i
] == '/' && is_comment_char(previous_line
[i
+ 1], lexer
))
3490 { /* we are on the second line of a multi line comment, so we have to insert white space */
3494 if (style
== SCE_D_COMMENTNESTED
)
3495 continuation
= "+"; /* for nested comments in D */
3497 result
= g_strconcat(whitespace
, continuation
, " ", NULL
);
3498 sci_add_text(sci
, result
);
3501 g_free(previous_line
);
3507 static gboolean
editor_lexer_is_c_like(gint lexer
)
3522 /* inserts a three-line comment at one line above current cursor position */
3523 void editor_insert_multiline_comment(GeanyEditor
*editor
)
3529 gboolean have_multiline_comment
= FALSE
;
3531 const gchar
*co
, *cc
;
3533 g_return_if_fail(editor
!= NULL
&& editor
->document
->file_type
!= NULL
);
3535 if (! filetype_get_comment_open_close(editor
->document
->file_type
, FALSE
, &co
, &cc
))
3536 g_return_if_reached();
3538 have_multiline_comment
= TRUE
;
3540 sci_start_undo_action(editor
->sci
);
3542 doc
= editor
->document
;
3544 /* insert three lines one line above of the current position */
3545 line
= sci_get_line_from_position(editor
->sci
, editor_info
.click_pos
);
3546 pos
= sci_get_position_from_line(editor
->sci
, line
);
3548 /* use the indent on the current line but only when comment indentation is used
3549 * and we don't have multi line comment characters */
3550 if (editor
->auto_indent
&&
3551 ! have_multiline_comment
&& doc
->file_type
->comment_use_indent
)
3553 read_indent(editor
, editor_info
.click_pos
);
3554 text
= g_strdup_printf("%s\n%s\n%s\n", indent
, indent
, indent
);
3555 text_len
= strlen(text
);
3559 text
= g_strdup("\n\n\n");
3562 sci_insert_text(editor
->sci
, pos
, text
);
3565 /* select the inserted lines for commenting */
3566 sci_set_selection_start(editor
->sci
, pos
);
3567 sci_set_selection_end(editor
->sci
, pos
+ text_len
);
3569 editor_do_comment(editor
, -1, TRUE
, FALSE
, FALSE
);
3571 /* set the current position to the start of the first inserted line */
3574 /* on multi line comment jump to the next line, otherwise add the length of added indentation */
3575 if (have_multiline_comment
)
3578 pos
+= strlen(indent
);
3580 sci_set_current_position(editor
->sci
, pos
, TRUE
);
3581 /* reset the selection */
3582 sci_set_anchor(editor
->sci
, pos
);
3584 sci_end_undo_action(editor
->sci
);
3588 /* Note: If the editor is pending a redraw, set document::scroll_percent instead.
3589 * Scroll the view to make line appear at percent_of_view.
3590 * line can be -1 to use the current position. */
3591 void editor_scroll_to_line(GeanyEditor
*editor
, gint line
, gfloat percent_of_view
)
3596 g_return_if_fail(editor
!= NULL
);
3598 wid
= GTK_WIDGET(editor
->sci
);
3600 if (! gtk_widget_get_window(wid
) || ! gdk_window_is_viewable(gtk_widget_get_window(wid
)))
3601 return; /* prevent gdk_window_scroll warning */
3604 line
= sci_get_current_line(editor
->sci
);
3606 /* sci 'visible line' != doc line number because of folding and line wrapping */
3607 /* calling SCI_VISIBLEFROMDOCLINE for line is more accurate than calling
3608 * SCI_DOCLINEFROMVISIBLE for vis1. */
3609 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0);
3610 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
3611 line
= line
- los
* percent_of_view
;
3612 SSM(editor
->sci
, SCI_SETFIRSTVISIBLELINE
, line
, 0);
3613 sci_scroll_caret(editor
->sci
); /* needed for horizontal scrolling */
3617 /* creates and inserts one tab or whitespace of the amount of the tab width */
3618 void editor_insert_alternative_whitespace(GeanyEditor
*editor
)
3621 GeanyIndentPrefs iprefs
= *editor_get_indent_prefs(editor
);
3623 g_return_if_fail(editor
!= NULL
);
3625 switch (iprefs
.type
)
3627 case GEANY_INDENT_TYPE_TABS
:
3628 iprefs
.type
= GEANY_INDENT_TYPE_SPACES
;
3630 case GEANY_INDENT_TYPE_SPACES
:
3631 case GEANY_INDENT_TYPE_BOTH
: /* most likely we want a tab */
3632 iprefs
.type
= GEANY_INDENT_TYPE_TABS
;
3635 text
= get_whitespace(&iprefs
, iprefs
.width
);
3636 sci_add_text(editor
->sci
, text
);
3641 void editor_select_word(GeanyEditor
*editor
)
3647 g_return_if_fail(editor
!= NULL
);
3649 pos
= SSM(editor
->sci
, SCI_GETCURRENTPOS
, 0, 0);
3650 start
= sci_word_start_position(editor
->sci
, pos
, TRUE
);
3651 end
= sci_word_end_position(editor
->sci
, pos
, TRUE
);
3653 if (start
== end
) /* caret in whitespaces sequence */
3655 /* look forward but reverse the selection direction,
3656 * so the caret end up stay as near as the original position. */
3657 end
= sci_word_end_position(editor
->sci
, pos
, FALSE
);
3658 start
= sci_word_end_position(editor
->sci
, end
, TRUE
);
3663 sci_set_selection(editor
->sci
, start
, end
);
3667 /* extra_line is for selecting the cursor line (or anchor line) at the bottom of a selection,
3668 * when those lines have no selection (cursor at start of line). */
3669 void editor_select_lines(GeanyEditor
*editor
, gboolean extra_line
)
3671 gint start
, end
, line
;
3673 g_return_if_fail(editor
!= NULL
);
3675 start
= sci_get_selection_start(editor
->sci
);
3676 end
= sci_get_selection_end(editor
->sci
);
3678 /* check if whole lines are already selected */
3679 if (! extra_line
&& start
!= end
&&
3680 sci_get_col_from_position(editor
->sci
, start
) == 0 &&
3681 sci_get_col_from_position(editor
->sci
, end
) == 0)
3684 line
= sci_get_line_from_position(editor
->sci
, start
);
3685 start
= sci_get_position_from_line(editor
->sci
, line
);
3687 line
= sci_get_line_from_position(editor
->sci
, end
);
3688 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
3690 sci_set_selection(editor
->sci
, start
, end
);
3694 static gboolean
sci_is_blank_line(ScintillaObject
*sci
, gint line
)
3696 return sci_get_line_indent_position(sci
, line
) ==
3697 sci_get_line_end_position(sci
, line
);
3701 /* Returns first line of paragraph for GTK_DIR_UP, line after paragraph
3702 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3703 static gint
find_paragraph_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3706 ScintillaObject
*sci
= editor
->sci
;
3708 /* first check current line and return -1 if it is empty to skip creating of a selection */
3709 if (sci_is_blank_line(sci
, line
))
3712 if (direction
== GTK_DIR_UP
)
3722 /* start of document */
3726 if (line
== sci_get_line_count(sci
))
3729 if (sci_is_blank_line(sci
, line
))
3731 /* return line paragraph starts on */
3732 if (direction
== GTK_DIR_UP
)
3741 void editor_select_paragraph(GeanyEditor
*editor
)
3743 gint pos_start
, pos_end
, line_start
, line_found
;
3745 g_return_if_fail(editor
!= NULL
);
3747 line_start
= sci_get_current_line(editor
->sci
);
3749 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_UP
);
3750 if (line_found
== -1)
3753 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3755 line_found
= find_paragraph_stop(editor
, line_start
, GTK_DIR_DOWN
);
3756 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3758 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3762 /* Returns first line of block for GTK_DIR_UP, line after block
3763 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
3764 static gint
find_block_stop(GeanyEditor
*editor
, gint line
, gint direction
)
3767 ScintillaObject
*sci
= editor
->sci
;
3769 /* first check current line and return -1 if it is empty to skip creating of a selection */
3770 if (sci_is_blank_line(sci
, line
))
3773 if (direction
== GTK_DIR_UP
)
3778 ind
= sci_get_line_indentation(sci
, line
);
3784 /* start of document */
3788 if (line
== sci_get_line_count(sci
))
3791 if (sci_get_line_indentation(sci
, line
) != ind
||
3792 sci_is_blank_line(sci
, line
))
3794 /* return line block starts on */
3795 if (direction
== GTK_DIR_UP
)
3804 void editor_select_indent_block(GeanyEditor
*editor
)
3806 gint pos_start
, pos_end
, line_start
, line_found
;
3808 g_return_if_fail(editor
!= NULL
);
3810 line_start
= sci_get_current_line(editor
->sci
);
3812 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_UP
);
3813 if (line_found
== -1)
3816 pos_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3818 line_found
= find_block_stop(editor
, line_start
, GTK_DIR_DOWN
);
3819 pos_end
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, line_found
, 0);
3821 sci_set_selection(editor
->sci
, pos_start
, pos_end
);
3825 /* simple indentation to indent the current line with the same indent as the previous one */
3826 static void smart_line_indentation(GeanyEditor
*editor
, gint first_line
, gint last_line
)
3828 gint i
, sel_start
= 0, sel_end
= 0;
3830 /* get previous line and use it for read_indent to use that line
3831 * (otherwise it would fail on a line only containing "{" in advanced indentation mode) */
3832 read_indent(editor
, sci_get_position_from_line(editor
->sci
, first_line
- 1));
3834 for (i
= first_line
; i
<= last_line
; i
++)
3836 /* skip the first line or if the indentation of the previous and current line are equal */
3838 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
- 1, 0) ==
3839 SSM(editor
->sci
, SCI_GETLINEINDENTATION
, i
, 0))
3842 sel_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3843 sel_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3844 if (sel_start
< sel_end
)
3846 sci_set_selection(editor
->sci
, sel_start
, sel_end
);
3847 sci_replace_sel(editor
->sci
, "");
3849 sci_insert_text(editor
->sci
, sel_start
, indent
);
3854 /* simple indentation to indent the current line with the same indent as the previous one */
3855 void editor_smart_line_indentation(GeanyEditor
*editor
, gint pos
)
3857 gint first_line
, last_line
;
3858 gint first_sel_start
, first_sel_end
;
3859 ScintillaObject
*sci
;
3861 g_return_if_fail(editor
!= NULL
);
3865 first_sel_start
= sci_get_selection_start(sci
);
3866 first_sel_end
= sci_get_selection_end(sci
);
3868 first_line
= sci_get_line_from_position(sci
, first_sel_start
);
3869 /* Find the last line with chars selected (not EOL char) */
3870 last_line
= sci_get_line_from_position(sci
, first_sel_end
- editor_get_eol_char_len(editor
));
3871 last_line
= MAX(first_line
, last_line
);
3874 pos
= first_sel_start
;
3876 sci_start_undo_action(sci
);
3878 smart_line_indentation(editor
, first_line
, last_line
);
3880 /* set cursor position if there was no selection */
3881 if (first_sel_start
== first_sel_end
)
3883 gint indent_pos
= SSM(sci
, SCI_GETLINEINDENTPOSITION
, first_line
, 0);
3885 /* use indent position as user may wish to change indentation afterwards */
3886 sci_set_current_position(sci
, indent_pos
, FALSE
);
3890 /* fully select all the lines affected */
3891 sci_set_selection_start(sci
, sci_get_position_from_line(sci
, first_line
));
3892 sci_set_selection_end(sci
, sci_get_position_from_line(sci
, last_line
+ 1));
3895 sci_end_undo_action(sci
);
3899 /* increase / decrease current line or selection by one space */
3900 void editor_indentation_by_one_space(GeanyEditor
*editor
, gint pos
, gboolean decrease
)
3902 gint i
, first_line
, last_line
, line_start
, indentation_end
, count
= 0;
3903 gint sel_start
, sel_end
, first_line_offset
= 0;
3905 g_return_if_fail(editor
!= NULL
);
3907 sel_start
= sci_get_selection_start(editor
->sci
);
3908 sel_end
= sci_get_selection_end(editor
->sci
);
3910 first_line
= sci_get_line_from_position(editor
->sci
, sel_start
);
3911 /* Find the last line with chars selected (not EOL char) */
3912 last_line
= sci_get_line_from_position(editor
->sci
, sel_end
- editor_get_eol_char_len(editor
));
3913 last_line
= MAX(first_line
, last_line
);
3918 sci_start_undo_action(editor
->sci
);
3920 for (i
= first_line
; i
<= last_line
; i
++)
3922 indentation_end
= SSM(editor
->sci
, SCI_GETLINEINDENTPOSITION
, i
, 0);
3925 line_start
= SSM(editor
->sci
, SCI_POSITIONFROMLINE
, i
, 0);
3926 /* searching backwards for a space to remove */
3927 while (sci_get_char_at(editor
->sci
, indentation_end
) != ' ' && indentation_end
> line_start
)
3930 if (sci_get_char_at(editor
->sci
, indentation_end
) == ' ')
3932 sci_set_selection(editor
->sci
, indentation_end
, indentation_end
+ 1);
3933 sci_replace_sel(editor
->sci
, "");
3935 if (i
== first_line
)
3936 first_line_offset
= -1;
3941 sci_insert_text(editor
->sci
, indentation_end
, " ");
3943 if (i
== first_line
)
3944 first_line_offset
= 1;
3948 /* set cursor position */
3949 if (sel_start
< sel_end
)
3951 gint start
= sel_start
+ first_line_offset
;
3952 if (first_line_offset
< 0)
3953 start
= MAX(sel_start
+ first_line_offset
,
3954 SSM(editor
->sci
, SCI_POSITIONFROMLINE
, first_line
, 0));
3956 sci_set_selection_start(editor
->sci
, start
);
3957 sci_set_selection_end(editor
->sci
, sel_end
+ count
);
3960 sci_set_current_position(editor
->sci
, pos
+ count
, FALSE
);
3962 sci_end_undo_action(editor
->sci
);
3966 void editor_finalize(void)
3968 scintilla_release_resources();
3972 /* wordchars: NULL or a string containing characters to match a word.
3973 * Returns: the current selection or the current word.
3975 * Passing NULL as wordchars is NOT the same as passing GEANY_WORDCHARS: NULL means
3976 * using Scintillas's word boundaries. */
3977 gchar
*editor_get_default_selection(GeanyEditor
*editor
, gboolean use_current_word
,
3978 const gchar
*wordchars
)
3982 g_return_val_if_fail(editor
!= NULL
, NULL
);
3984 if (sci_get_lines_selected(editor
->sci
) == 1)
3985 s
= sci_get_selection_contents(editor
->sci
);
3986 else if (sci_get_lines_selected(editor
->sci
) == 0 && use_current_word
)
3987 { /* use the word at current cursor position */
3988 gchar word
[GEANY_MAX_WORD_LENGTH
];
3990 if (wordchars
!= NULL
)
3991 editor_find_current_word(editor
, -1, word
, sizeof(word
), wordchars
);
3993 editor_find_current_word_sciwc(editor
, -1, word
, sizeof(word
));
3995 if (word
[0] != '\0')
4002 /* Note: Usually the line should be made visible (not folded) before calling this.
4003 * Returns: TRUE if line is/will be displayed to the user, or FALSE if it is
4004 * outside the *vertical* view.
4005 * Warning: You may need horizontal scrolling to make the cursor visible - so always call
4006 * sci_scroll_caret() when this returns TRUE. */
4007 gboolean
editor_line_in_view(GeanyEditor
*editor
, gint line
)
4011 g_return_val_if_fail(editor
!= NULL
, FALSE
);
4013 /* If line is wrapped the result may occur on another virtual line than the first and may be
4014 * still hidden, so increase the line number to check for the next document line */
4015 if (SSM(editor
->sci
, SCI_WRAPCOUNT
, line
, 0) > 1)
4018 line
= SSM(editor
->sci
, SCI_VISIBLEFROMDOCLINE
, line
, 0); /* convert to visible line number */
4019 vis1
= SSM(editor
->sci
, SCI_GETFIRSTVISIBLELINE
, 0, 0);
4020 los
= SSM(editor
->sci
, SCI_LINESONSCREEN
, 0, 0);
4022 return (line
>= vis1
&& line
< vis1
+ los
);
4026 /* If the current line is outside the current view window, scroll the line
4027 * so it appears at percent_of_view. */
4028 void editor_display_current_line(GeanyEditor
*editor
, gfloat percent_of_view
)
4032 g_return_if_fail(editor
!= NULL
);
4034 line
= sci_get_current_line(editor
->sci
);
4036 /* unfold maybe folded results */
4037 sci_ensure_line_is_visible(editor
->sci
, line
);
4039 /* scroll the line if it's off screen */
4040 if (! editor_line_in_view(editor
, line
))
4041 editor
->scroll_percent
= percent_of_view
;
4043 sci_scroll_caret(editor
->sci
); /* may need horizontal scrolling */
4048 * Deletes all currently set indicators in the @a editor window.
4049 * Error indicators (red squiggly underlines) and usual line markers are removed.
4051 * @param editor The editor to operate on.
4053 void editor_indicator_clear_errors(GeanyEditor
*editor
)
4055 editor_indicator_clear(editor
, GEANY_INDICATOR_ERROR
);
4056 sci_marker_delete_all(editor
->sci
, 0); /* remove the yellow error line marker */
4061 * Deletes all currently set indicators matching @a indic in the @a editor window.
4063 * @param editor The editor to operate on.
4064 * @param indic The indicator number to clear, this is a value of @ref GeanyIndicator.
4068 void editor_indicator_clear(GeanyEditor
*editor
, gint indic
)
4072 g_return_if_fail(editor
!= NULL
);
4074 last_pos
= sci_get_length(editor
->sci
);
4077 sci_indicator_set(editor
->sci
, indic
);
4078 sci_indicator_clear(editor
->sci
, 0, last_pos
);
4084 * Sets an indicator @a indic on @a line.
4085 * Whitespace at the start and the end of the line is not marked.
4087 * @param editor The editor to operate on.
4088 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4089 * @param line The line number which should be marked.
4093 void editor_indicator_set_on_line(GeanyEditor
*editor
, gint indic
, gint line
)
4099 g_return_if_fail(editor
!= NULL
);
4100 g_return_if_fail(line
>= 0);
4102 start
= sci_get_position_from_line(editor
->sci
, line
);
4103 end
= sci_get_position_from_line(editor
->sci
, line
+ 1);
4105 /* skip blank lines */
4106 if ((start
+ 1) == end
||
4108 (sci_get_line_end_position(editor
->sci
, line
) - start
) == 0)
4114 linebuf
= sci_get_line(editor
->sci
, line
);
4116 /* don't set the indicator on whitespace */
4117 while (isspace(linebuf
[i
]))
4119 while (len
> 1 && len
> i
&& isspace(linebuf
[len
- 1]))
4126 editor_indicator_set_on_range(editor
, indic
, start
+ i
, end
);
4131 * Sets an indicator on the range specified by @a start and @a end.
4132 * No error checking or whitespace removal is performed, this should be done by the calling
4133 * function if necessary.
4135 * @param editor The editor to operate on.
4136 * @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
4137 * @param start The starting position for the marker.
4138 * @param end The ending position for the marker.
4142 void editor_indicator_set_on_range(GeanyEditor
*editor
, gint indic
, gint start
, gint end
)
4144 g_return_if_fail(editor
!= NULL
);
4148 sci_indicator_set(editor
->sci
, indic
);
4149 sci_indicator_fill(editor
->sci
, start
, end
- start
);
4153 /* Inserts the given colour (format should be #...), if there is a selection starting with 0x...
4154 * the replacement will also start with 0x... */
4155 void editor_insert_color(GeanyEditor
*editor
, const gchar
*colour
)
4157 g_return_if_fail(editor
!= NULL
);
4159 if (sci_has_selection(editor
->sci
))
4161 gint start
= sci_get_selection_start(editor
->sci
);
4162 const gchar
*replacement
= colour
;
4164 if (sci_get_char_at(editor
->sci
, start
) == '0' &&
4165 sci_get_char_at(editor
->sci
, start
+ 1) == 'x')
4167 sci_set_selection_start(editor
->sci
, start
+ 2);
4168 sci_set_selection_end(editor
->sci
, start
+ 8);
4169 replacement
++; /* skip the leading "0x" */
4171 else if (sci_get_char_at(editor
->sci
, start
- 1) == '#')
4172 { /* double clicking something like #00ffff may only select 00ffff because of wordchars */
4173 replacement
++; /* so skip the '#' to only replace the colour value */
4175 sci_replace_sel(editor
->sci
, replacement
);
4178 sci_add_text(editor
->sci
, colour
);
4183 * Retrieves the end of line characters mode (LF, CR/LF, CR) in the given editor.
4184 * If @a editor is @c NULL, the default end of line characters are used.
4186 * @param editor The editor to operate on, or @c NULL to query the default value.
4187 * @return The used end of line characters mode.
4191 gint
editor_get_eol_char_mode(GeanyEditor
*editor
)
4193 gint mode
= file_prefs
.default_eol_character
;
4196 mode
= sci_get_eol_mode(editor
->sci
);
4203 * Retrieves the localized name (for displaying) of the used end of line characters
4204 * (LF, CR/LF, CR) in the given editor.
4205 * If @a editor is @c NULL, the default end of line characters are used.
4207 * @param editor The editor to operate on, or @c NULL to query the default value.
4208 * @return The name of the end of line characters.
4212 const gchar
*editor_get_eol_char_name(GeanyEditor
*editor
)
4214 gint mode
= file_prefs
.default_eol_character
;
4217 mode
= sci_get_eol_mode(editor
->sci
);
4219 return utils_get_eol_name(mode
);
4224 * Retrieves the length of the used end of line characters (LF, CR/LF, CR) in the given editor.
4225 * If @a editor is @c NULL, the default end of line characters are used.
4226 * The returned value is 1 for CR and LF and 2 for CR/LF.
4228 * @param editor The editor to operate on, or @c NULL to query the default value.
4229 * @return The length of the end of line characters.
4233 gint
editor_get_eol_char_len(GeanyEditor
*editor
)
4235 gint mode
= file_prefs
.default_eol_character
;
4238 mode
= sci_get_eol_mode(editor
->sci
);
4242 case SC_EOL_CRLF
: return 2; break;
4243 default: return 1; break;
4249 * Retrieves the used end of line characters (LF, CR/LF, CR) in the given editor.
4250 * If @a editor is @c NULL, the default end of line characters are used.
4251 * The returned value is either "\n", "\r\n" or "\r".
4253 * @param editor The editor to operate on, or @c NULL to query the default value.
4254 * @return The end of line characters.
4258 const gchar
*editor_get_eol_char(GeanyEditor
*editor
)
4260 gint mode
= file_prefs
.default_eol_character
;
4263 mode
= sci_get_eol_mode(editor
->sci
);
4265 return utils_get_eol_char(mode
);
4269 static void fold_all(GeanyEditor
*editor
, gboolean want_fold
)
4271 gint lines
, first
, i
;
4273 if (editor
== NULL
|| ! editor_prefs
.folding
)
4276 lines
= sci_get_line_count(editor
->sci
);
4277 first
= sci_get_first_visible_line(editor
->sci
);
4279 for (i
= 0; i
< lines
; i
++)
4281 gint level
= sci_get_fold_level(editor
->sci
, i
);
4283 if (level
& SC_FOLDLEVELHEADERFLAG
)
4285 if (sci_get_fold_expanded(editor
->sci
, i
) == want_fold
)
4286 sci_toggle_fold(editor
->sci
, i
);
4289 editor_scroll_to_line(editor
, first
, 0.0F
);
4293 void editor_unfold_all(GeanyEditor
*editor
)
4295 fold_all(editor
, FALSE
);
4299 void editor_fold_all(GeanyEditor
*editor
)
4301 fold_all(editor
, TRUE
);
4305 void editor_replace_tabs(GeanyEditor
*editor
)
4307 gint search_pos
, pos_in_line
, current_tab_true_length
;
4310 struct Sci_TextToFind ttf
;
4312 g_return_if_fail(editor
!= NULL
);
4314 sci_start_undo_action(editor
->sci
);
4315 tab_len
= sci_get_tab_width(editor
->sci
);
4317 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4318 ttf
.lpstrText
= (gchar
*) "\t";
4322 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4323 if (search_pos
== -1)
4326 pos_in_line
= sci_get_col_from_position(editor
->sci
, search_pos
);
4327 current_tab_true_length
= tab_len
- (pos_in_line
% tab_len
);
4328 tab_str
= g_strnfill(current_tab_true_length
, ' ');
4329 sci_set_target_start(editor
->sci
, search_pos
);
4330 sci_set_target_end(editor
->sci
, search_pos
+ 1);
4331 sci_replace_target(editor
->sci
, tab_str
, FALSE
);
4332 /* next search starts after replacement */
4333 ttf
.chrg
.cpMin
= search_pos
+ current_tab_true_length
- 1;
4334 /* update end of range now text has changed */
4335 ttf
.chrg
.cpMax
+= current_tab_true_length
- 1;
4338 sci_end_undo_action(editor
->sci
);
4342 /* Replaces all occurrences all spaces of the length of a given tab_width. */
4343 void editor_replace_spaces(GeanyEditor
*editor
)
4346 static gdouble tab_len_f
= -1.0; /* keep the last used value */
4348 struct Sci_TextToFind ttf
;
4350 g_return_if_fail(editor
!= NULL
);
4352 if (tab_len_f
< 0.0)
4353 tab_len_f
= sci_get_tab_width(editor
->sci
);
4355 if (! dialogs_show_input_numeric(
4356 _("Enter Tab Width"),
4357 _("Enter the amount of spaces which should be replaced by a tab character."),
4358 &tab_len_f
, 1, 100, 1))
4362 tab_len
= (gint
) tab_len_f
;
4364 sci_start_undo_action(editor
->sci
);
4366 ttf
.chrg
.cpMax
= sci_get_length(editor
->sci
);
4367 ttf
.lpstrText
= g_strnfill(tab_len
, ' ');
4371 search_pos
= sci_find_text(editor
->sci
, SCFIND_MATCHCASE
, &ttf
);
4372 if (search_pos
== -1)
4374 /* only replace indentation because otherwise we can mess up alignment */
4375 if (search_pos
> sci_get_line_indent_position(editor
->sci
,
4376 sci_get_line_from_position(editor
->sci
, search_pos
)))
4378 ttf
.chrg
.cpMin
= search_pos
+ tab_len
;
4381 sci_set_target_start(editor
->sci
, search_pos
);
4382 sci_set_target_end(editor
->sci
, search_pos
+ tab_len
);
4383 sci_replace_target(editor
->sci
, "\t", FALSE
);
4384 ttf
.chrg
.cpMin
= search_pos
;
4385 /* update end of range now text has changed */
4386 ttf
.chrg
.cpMax
-= tab_len
- 1;
4388 sci_end_undo_action(editor
->sci
);
4389 g_free(ttf
.lpstrText
);
4393 void editor_strip_line_trailing_spaces(GeanyEditor
*editor
, gint line
)
4395 gint line_start
= sci_get_position_from_line(editor
->sci
, line
);
4396 gint line_end
= sci_get_line_end_position(editor
->sci
, line
);
4397 gint i
= line_end
- 1;
4398 gchar ch
= sci_get_char_at(editor
->sci
, i
);
4400 /* Diff hunks should keep trailing spaces */
4401 if (sci_get_lexer(editor
->sci
) == SCLEX_DIFF
)
4404 while ((i
>= line_start
) && ((ch
== ' ') || (ch
== '\t')))
4407 ch
= sci_get_char_at(editor
->sci
, i
);
4409 if (i
< (line_end
- 1))
4411 sci_set_target_start(editor
->sci
, i
+ 1);
4412 sci_set_target_end(editor
->sci
, line_end
);
4413 sci_replace_target(editor
->sci
, "", FALSE
);
4418 void editor_strip_trailing_spaces(GeanyEditor
*editor
)
4420 gint max_lines
= sci_get_line_count(editor
->sci
);
4423 sci_start_undo_action(editor
->sci
);
4425 for (line
= 0; line
< max_lines
; line
++)
4427 editor_strip_line_trailing_spaces(editor
, line
);
4429 sci_end_undo_action(editor
->sci
);
4433 void editor_ensure_final_newline(GeanyEditor
*editor
)
4435 gint max_lines
= sci_get_line_count(editor
->sci
);
4436 gboolean append_newline
= (max_lines
== 1);
4437 gint end_document
= sci_get_position_from_line(editor
->sci
, max_lines
);
4441 append_newline
= end_document
> sci_get_position_from_line(editor
->sci
, max_lines
- 1);
4445 const gchar
*eol
= editor_get_eol_char(editor
);
4447 sci_insert_text(editor
->sci
, end_document
, eol
);
4452 void editor_set_font(GeanyEditor
*editor
, const gchar
*font
)
4456 PangoFontDescription
*pfd
;
4458 g_return_if_fail(editor
);
4460 pfd
= pango_font_description_from_string(font
);
4461 size
= pango_font_description_get_size(pfd
) / PANGO_SCALE
;
4462 font_name
= g_strdup_printf("!%s", pango_font_description_get_family(pfd
));
4463 pango_font_description_free(pfd
);
4465 for (style
= 0; style
<= STYLE_MAX
; style
++)
4466 sci_set_font(editor
->sci
, style
, font_name
, size
);
4470 /* zoom to 100% to prevent confusion */
4471 sci_zoom_off(editor
->sci
);
4475 void editor_set_line_wrapping(GeanyEditor
*editor
, gboolean wrap
)
4477 g_return_if_fail(editor
!= NULL
);
4479 editor
->line_wrapping
= wrap
;
4480 sci_set_lines_wrapped(editor
->sci
, wrap
);
4484 /** Sets the indent type for @a editor.
4485 * @param editor Editor.
4486 * @param type Indent type.
4490 void editor_set_indent_type(GeanyEditor
*editor
, GeanyIndentType type
)
4492 editor_set_indent(editor
, type
, editor
->indent_width
);
4496 void editor_set_indent_width(GeanyEditor
*editor
, gint width
)
4498 editor_set_indent(editor
, editor
->indent_type
, width
);
4502 void editor_set_indent(GeanyEditor
*editor
, GeanyIndentType type
, gint width
)
4504 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
4505 ScintillaObject
*sci
= editor
->sci
;
4506 gboolean use_tabs
= type
!= GEANY_INDENT_TYPE_SPACES
;
4508 editor
->indent_type
= type
;
4509 editor
->indent_width
= width
;
4510 sci_set_use_tabs(sci
, use_tabs
);
4512 if (type
== GEANY_INDENT_TYPE_BOTH
)
4514 sci_set_tab_width(sci
, iprefs
->hard_tab_width
);
4515 if (iprefs
->hard_tab_width
!= 8)
4517 static gboolean warn
= TRUE
;
4519 ui_set_statusbar(TRUE
, _("Warning: non-standard hard tab width: %d != 8!"),
4520 iprefs
->hard_tab_width
);
4525 sci_set_tab_width(sci
, width
);
4527 SSM(sci
, SCI_SETINDENT
, width
, 0);
4529 /* remove indent spaces on backspace, if using any spaces to indent */
4530 SSM(sci
, SCI_SETBACKSPACEUNINDENTS
, type
!= GEANY_INDENT_TYPE_TABS
, 0);
4534 /* Convenience function for editor_goto_pos() to pass in a line number. */
4535 gboolean
editor_goto_line(GeanyEditor
*editor
, gint line_no
, gint offset
)
4539 g_return_val_if_fail(editor
, FALSE
);
4540 if (line_no
< 0 || line_no
>= sci_get_line_count(editor
->sci
))
4545 gint current_line
= sci_get_current_line(editor
->sci
);
4547 line_no
= current_line
+ line_no
;
4550 pos
= sci_get_position_from_line(editor
->sci
, line_no
);
4551 return editor_goto_pos(editor
, pos
, TRUE
);
4555 /** Moves to position @a pos, switching to the document if necessary,
4556 * setting a marker if @a mark is set.
4558 * @param editor Editor.
4559 * @param pos The position.
4560 * @param mark Whether to set a mark on the position.
4561 * @return @c TRUE if action has been performed, otherwise @c FALSE.
4565 gboolean
editor_goto_pos(GeanyEditor
*editor
, gint pos
, gboolean mark
)
4567 g_return_val_if_fail(editor
, FALSE
);
4568 if (G_UNLIKELY(pos
< 0))
4573 gint line
= sci_get_line_from_position(editor
->sci
, pos
);
4575 /* mark the tag with the yellow arrow */
4576 sci_marker_delete_all(editor
->sci
, 0);
4577 sci_set_marker_at_line(editor
->sci
, line
, 0);
4580 sci_goto_pos(editor
->sci
, pos
, TRUE
);
4581 editor
->scroll_percent
= 0.25F
;
4583 /* finally switch to the page */
4584 document_show_tab(editor
->document
);
4590 on_editor_scroll_event(GtkWidget
*widget
, GdkEventScroll
*event
, gpointer user_data
)
4592 GeanyEditor
*editor
= user_data
;
4594 /* Handle scroll events if Alt is pressed and scroll whole pages instead of a
4595 * few lines only, maybe this could/should be done in Scintilla directly */
4596 if (event
->state
& GDK_MOD1_MASK
)
4598 sci_send_command(editor
->sci
, (event
->direction
== GDK_SCROLL_DOWN
) ? SCI_PAGEDOWN
: SCI_PAGEUP
);
4601 else if (event
->state
& GDK_SHIFT_MASK
)
4603 gint amount
= (event
->direction
== GDK_SCROLL_DOWN
) ? 8 : -8;
4605 sci_scroll_columns(editor
->sci
, amount
);
4609 return FALSE
; /* let Scintilla handle all other cases */
4613 static gboolean
editor_check_colourise(GeanyEditor
*editor
)
4615 GeanyDocument
*doc
= editor
->document
;
4617 if (!doc
->priv
->colourise_needed
)
4620 doc
->priv
->colourise_needed
= FALSE
;
4621 sci_colourise(editor
->sci
, 0, -1);
4623 /* now that the current document is colourised, fold points are now accurate,
4624 * so force an update of the current function/tag. */
4625 symbols_get_current_function(NULL
, NULL
);
4626 ui_update_statusbar(NULL
, -1);
4632 /* We only want to colourise just before drawing, to save startup time and
4633 * prevent unnecessary recolouring other documents after one is saved.
4634 * Really we want a "draw" signal but there doesn't seem to be one (expose is too late,
4635 * and "show" doesn't work). */
4636 static gboolean
on_editor_focus_in(GtkWidget
*widget
, GdkEventFocus
*event
, gpointer user_data
)
4638 GeanyEditor
*editor
= user_data
;
4640 editor_check_colourise(editor
);
4645 static gboolean
on_editor_expose_event(GtkWidget
*widget
, GdkEventExpose
*event
,
4648 GeanyEditor
*editor
= user_data
;
4650 /* This is just to catch any uncolourised documents being drawn that didn't receive focus
4651 * for some reason, maybe it's not necessary but just in case. */
4652 editor_check_colourise(editor
);
4657 #if GTK_CHECK_VERSION(3, 0, 0)
4658 static gboolean
on_editor_draw(GtkWidget
*widget
, cairo_t
*cr
, gpointer user_data
)
4660 return on_editor_expose_event(widget
, NULL
, user_data
);
4665 static void setup_sci_keys(ScintillaObject
*sci
)
4667 /* disable some Scintilla keybindings to be able to redefine them cleanly */
4668 sci_clear_cmdkey(sci
, 'A' | (SCMOD_CTRL
<< 16)); /* select all */
4669 sci_clear_cmdkey(sci
, 'D' | (SCMOD_CTRL
<< 16)); /* duplicate */
4670 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16)); /* line transpose */
4671 sci_clear_cmdkey(sci
, 'T' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line copy */
4672 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16)); /* line cut */
4673 sci_clear_cmdkey(sci
, 'L' | (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line delete */
4674 sci_clear_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16)); /* line to end delete */
4675 sci_clear_cmdkey(sci
, '/' | (SCMOD_CTRL
<< 16)); /* Previous word part */
4676 sci_clear_cmdkey(sci
, '\\' | (SCMOD_CTRL
<< 16)); /* Next word part */
4677 sci_clear_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16)); /* scroll line up */
4678 sci_clear_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16)); /* scroll line down */
4679 sci_clear_cmdkey(sci
, SCK_HOME
); /* line start */
4680 sci_clear_cmdkey(sci
, SCK_END
); /* line end */
4681 sci_clear_cmdkey(sci
, SCK_END
| (SCMOD_ALT
<< 16)); /* visual line end */
4683 if (editor_prefs
.use_gtk_word_boundaries
)
4685 /* use GtkEntry-like word boundaries */
4686 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16), SCI_WORDRIGHTEND
);
4687 sci_assign_cmdkey(sci
, SCK_RIGHT
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_WORDRIGHTENDEXTEND
);
4688 sci_assign_cmdkey(sci
, SCK_DELETE
| (SCMOD_CTRL
<< 16), SCI_DELWORDRIGHTEND
);
4690 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_ALT
<< 16), SCI_LINESCROLLUP
);
4691 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_ALT
<< 16), SCI_LINESCROLLDOWN
);
4692 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16), SCI_PARAUP
);
4693 sci_assign_cmdkey(sci
, SCK_UP
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARAUPEXTEND
);
4694 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16), SCI_PARADOWN
);
4695 sci_assign_cmdkey(sci
, SCK_DOWN
| (SCMOD_CTRL
<< 16) | (SCMOD_SHIFT
<< 16), SCI_PARADOWNEXTEND
);
4697 sci_clear_cmdkey(sci
, SCK_BACK
| (SCMOD_ALT
<< 16)); /* clear Alt-Backspace (Undo) */
4701 /* registers a Scintilla image from a named icon from the theme */
4702 static gboolean
register_named_icon(ScintillaObject
*sci
, guint id
, const gchar
*name
)
4704 GError
*error
= NULL
;
4706 gint n_channels
, rowstride
, width
, height
;
4709 gtk_icon_size_lookup(GTK_ICON_SIZE_MENU
, &size
, NULL
);
4710 pixbuf
= gtk_icon_theme_load_icon(gtk_icon_theme_get_default(), name
, size
, 0, &error
);
4713 g_warning("failed to load icon '%s': %s", name
, error
->message
);
4714 g_error_free(error
);
4718 n_channels
= gdk_pixbuf_get_n_channels(pixbuf
);
4719 rowstride
= gdk_pixbuf_get_rowstride(pixbuf
);
4720 width
= gdk_pixbuf_get_width(pixbuf
);
4721 height
= gdk_pixbuf_get_height(pixbuf
);
4723 if (gdk_pixbuf_get_bits_per_sample(pixbuf
) != 8 ||
4724 ! gdk_pixbuf_get_has_alpha(pixbuf
) ||
4726 rowstride
!= width
* n_channels
)
4728 g_warning("incompatible image data for icon '%s'", name
);
4729 g_object_unref(pixbuf
);
4733 SSM(sci
, SCI_RGBAIMAGESETWIDTH
, width
, 0);
4734 SSM(sci
, SCI_RGBAIMAGESETHEIGHT
, height
, 0);
4735 SSM(sci
, SCI_REGISTERRGBAIMAGE
, id
, (sptr_t
)gdk_pixbuf_get_pixels(pixbuf
));
4737 g_object_unref(pixbuf
);
4742 /* Create new editor widget (scintilla).
4743 * @note The @c "sci-notify" signal is connected separately. */
4744 static ScintillaObject
*create_new_sci(GeanyEditor
*editor
)
4746 ScintillaObject
*sci
;
4748 sci
= SCINTILLA(scintilla_new());
4750 /* Scintilla doesn't support RTL languages properly and is primarily
4751 * intended to be used with LTR source code, so override the
4752 * GTK+ default text direction for the Scintilla widget. */
4753 gtk_widget_set_direction(GTK_WIDGET(sci
), GTK_TEXT_DIR_LTR
);
4755 gtk_widget_show(GTK_WIDGET(sci
));
4757 sci_set_codepage(sci
, SC_CP_UTF8
);
4758 /*SSM(sci, SCI_SETWRAPSTARTINDENT, 4, 0);*/
4759 /* disable scintilla provided popup menu */
4760 sci_use_popup(sci
, FALSE
);
4762 setup_sci_keys(sci
);
4764 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
4765 sci_set_lines_wrapped(sci
, editor_prefs
.line_wrapping
);
4766 sci_set_caret_policy_x(sci
, CARET_JUMPS
| CARET_EVEN
, 0);
4767 /*sci_set_caret_policy_y(sci, CARET_JUMPS | CARET_EVEN, 0);*/
4768 SSM(sci
, SCI_AUTOCSETSEPARATOR
, '\n', 0);
4769 SSM(sci
, SCI_SETSCROLLWIDTHTRACKING
, 1, 0);
4771 /* tag autocompletion images */
4772 register_named_icon(sci
, 1, "classviewer-var");
4773 register_named_icon(sci
, 2, "classviewer-method");
4775 /* necessary for column mode editing, implemented in Scintilla since 2.0 */
4776 SSM(sci
, SCI_SETADDITIONALSELECTIONTYPING
, 1, 0);
4779 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
4781 /* only connect signals if this is for the document notebook, not split window */
4782 if (editor
->sci
== NULL
)
4784 g_signal_connect(sci
, "button-press-event", G_CALLBACK(on_editor_button_press_event
), editor
);
4785 g_signal_connect(sci
, "scroll-event", G_CALLBACK(on_editor_scroll_event
), editor
);
4786 g_signal_connect(sci
, "motion-notify-event", G_CALLBACK(on_motion_event
), NULL
);
4787 g_signal_connect(sci
, "focus-in-event", G_CALLBACK(on_editor_focus_in
), editor
);
4788 #if GTK_CHECK_VERSION(3, 0, 0)
4789 g_signal_connect(sci
, "draw", G_CALLBACK(on_editor_draw
), editor
);
4791 g_signal_connect(sci
, "expose-event", G_CALLBACK(on_editor_expose_event
), editor
);
4798 /** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
4799 * @param editor Editor settings.
4800 * @return The new widget.
4804 ScintillaObject
*editor_create_widget(GeanyEditor
*editor
)
4806 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4807 ScintillaObject
*old
, *sci
;
4809 /* temporarily change editor to use the new sci widget */
4811 sci
= create_new_sci(editor
);
4814 editor_set_indent(editor
, iprefs
->type
, iprefs
->width
);
4815 editor_set_font(editor
, interface_prefs
.editor_font
);
4816 editor_apply_update_prefs(editor
);
4818 /* if editor already had a widget, restore it */
4825 GeanyEditor
*editor_create(GeanyDocument
*doc
)
4827 const GeanyIndentPrefs
*iprefs
= get_default_indent_prefs();
4828 GeanyEditor
*editor
= g_new0(GeanyEditor
, 1);
4830 editor
->document
= doc
;
4831 doc
->editor
= editor
; /* needed in case some editor functions/callbacks expect it */
4833 editor
->auto_indent
= (iprefs
->auto_indent_mode
!= GEANY_AUTOINDENT_NONE
);
4834 editor
->line_wrapping
= editor_prefs
.line_wrapping
;
4835 editor
->scroll_percent
= -1.0F
;
4836 editor
->line_breaking
= FALSE
;
4838 editor
->sci
= editor_create_widget(editor
);
4843 /* in case we need to free some fields in future */
4844 void editor_destroy(GeanyEditor
*editor
)
4850 static void on_document_save(GObject
*obj
, GeanyDocument
*doc
)
4852 gchar
*f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
4854 if (utils_str_equal(doc
->real_path
, f
))
4856 /* reload snippets */
4857 editor_snippets_free();
4858 editor_snippets_init();
4864 gboolean
editor_complete_word_part(GeanyEditor
*editor
)
4868 g_return_val_if_fail(editor
, FALSE
);
4870 if (!SSM(editor
->sci
, SCI_AUTOCACTIVE
, 0, 0))
4873 entry
= sci_get_string(editor
->sci
, SCI_AUTOCGETCURRENTTEXT
, 0);
4875 /* if no word part, complete normally */
4876 if (!check_partial_completion(editor
, entry
))
4877 SSM(editor
->sci
, SCI_AUTOCCOMPLETE
, 0, 0);
4884 void editor_init(void)
4886 static GeanyIndentPrefs indent_prefs
;
4889 memset(&editor_prefs
, 0, sizeof(GeanyEditorPrefs
));
4890 memset(&indent_prefs
, 0, sizeof(GeanyIndentPrefs
));
4891 editor_prefs
.indentation
= &indent_prefs
;
4893 /* use g_signal_connect_after() to allow plugins connecting to the signal before the default
4894 * handler (on_editor_notify) is called */
4895 g_signal_connect_after(geany_object
, "editor-notify", G_CALLBACK(on_editor_notify
), NULL
);
4897 f
= g_build_filename(app
->configdir
, "snippets.conf", NULL
);
4898 ui_add_config_file_menu_item(f
, NULL
, NULL
);
4900 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
4904 /* TODO: Should these be user-defined instead of hard-coded? */
4905 void editor_set_indentation_guides(GeanyEditor
*editor
)
4910 g_return_if_fail(editor
!= NULL
);
4912 if (! editor_prefs
.show_indent_guide
)
4914 sci_set_indentation_guides(editor
->sci
, SC_IV_NONE
);
4918 lexer
= sci_get_lexer(editor
->sci
);
4921 /* Lines added/removed are prefixed with +/- characters, so
4922 * those lines will not be shown with any indentation guides.
4923 * It can be distracting that only a few of lines in a diff/patch
4924 * file will show the guides. */
4929 /* These languages use indentation for control blocks; the "look forward" method works
4933 case SCLEX_MAKEFILE
:
4937 case SCLEX_PROPERTIES
:
4938 case SCLEX_FORTRAN
: /* Is this the best option for Fortran? */
4940 mode
= SC_IV_LOOKFORWARD
;
4943 /* C-like (structured) languages benefit from the "look both" method */
4957 case SCLEX_FREEBASIC
:
4961 mode
= SC_IV_LOOKBOTH
;
4969 sci_set_indentation_guides(editor
->sci
, mode
);
4973 /* Apply just the prefs that can change in the Preferences dialog */
4974 void editor_apply_update_prefs(GeanyEditor
*editor
)
4976 ScintillaObject
*sci
;
4978 g_return_if_fail(editor
!= NULL
);
4980 if (main_status
.quitting
)
4985 sci_set_mark_long_lines(sci
, editor_get_long_line_type(),
4986 editor_get_long_line_column(), editor_prefs
.long_line_color
);
4988 /* update indent width, tab width */
4989 editor_set_indent(editor
, editor
->indent_type
, editor
->indent_width
);
4990 sci_set_tab_indents(sci
, editor_prefs
.use_tab_to_indent
);
4992 sci_assign_cmdkey(sci
, SCK_HOME
| (SCMOD_SHIFT
<< 16),
4993 editor_prefs
.smart_home_key
? SCI_VCHOMEEXTEND
: SCI_HOMEEXTEND
);
4994 sci_assign_cmdkey(sci
, SCK_HOME
| ((SCMOD_SHIFT
| SCMOD_ALT
) << 16),
4995 editor_prefs
.smart_home_key
? SCI_VCHOMERECTEXTEND
: SCI_HOMERECTEXTEND
);
4997 sci_set_autoc_max_height(sci
, editor_prefs
.symbolcompletion_max_height
);
4998 SSM(sci
, SCI_AUTOCSETDROPRESTOFWORD
, editor_prefs
.completion_drops_rest_of_word
, 0);
5000 editor_set_indentation_guides(editor
);
5002 sci_set_visible_white_spaces(sci
, editor_prefs
.show_white_space
);
5003 sci_set_visible_eols(sci
, editor_prefs
.show_line_endings
);
5004 sci_set_symbol_margin(sci
, editor_prefs
.show_markers_margin
);
5005 sci_set_line_numbers(sci
, editor_prefs
.show_linenumber_margin
, 0);
5007 sci_set_folding_margin_visible(sci
, editor_prefs
.folding
);
5010 SSM(sci
, SCI_SETVIRTUALSPACEOPTIONS
, editor_prefs
.show_virtual_space
, 0);
5012 /* (dis)allow scrolling past end of document */
5013 sci_set_scroll_stop_at_last_line(sci
, editor_prefs
.scroll_stop_at_last_line
);
5015 sci_set_scrollbar_mode(sci
, editor_prefs
.show_scrollbars
);
5019 /* This is for tab-indents, space aligns formatted code. Spaces should be preserved. */
5020 static void change_tab_indentation(GeanyEditor
*editor
, gint line
, gboolean increase
)
5022 ScintillaObject
*sci
= editor
->sci
;
5023 gint pos
= sci_get_position_from_line(sci
, line
);
5027 sci_insert_text(sci
, pos
, "\t");
5031 if (sci_get_char_at(sci
, pos
) == '\t')
5033 sci_set_selection(sci
, pos
, pos
+ 1);
5034 sci_replace_sel(sci
, "");
5036 else /* remove spaces only if no tabs */
5038 gint width
= sci_get_line_indentation(sci
, line
);
5040 width
-= editor_get_indent_prefs(editor
)->width
;
5041 sci_set_line_indentation(sci
, line
, width
);
5047 static void editor_change_line_indent(GeanyEditor
*editor
, gint line
, gboolean increase
)
5049 const GeanyIndentPrefs
*iprefs
= editor_get_indent_prefs(editor
);
5050 ScintillaObject
*sci
= editor
->sci
;
5052 if (iprefs
->type
== GEANY_INDENT_TYPE_TABS
)
5053 change_tab_indentation(editor
, line
, increase
);
5056 gint width
= sci_get_line_indentation(sci
, line
);
5058 width
+= increase
? iprefs
->width
: -iprefs
->width
;
5059 sci_set_line_indentation(sci
, line
, width
);
5064 void editor_indent(GeanyEditor
*editor
, gboolean increase
)
5066 ScintillaObject
*sci
= editor
->sci
;
5067 gint caret_pos
, caret_line
, caret_offset
, caret_indent_pos
, caret_line_len
;
5068 gint anchor_pos
, anchor_line
, anchor_offset
, anchor_indent_pos
, anchor_line_len
;
5070 /* backup information needed to restore caret and anchor */
5071 caret_pos
= sci_get_current_position(sci
);
5072 anchor_pos
= SSM(sci
, SCI_GETANCHOR
, 0, 0);
5073 caret_line
= sci_get_line_from_position(sci
, caret_pos
);
5074 anchor_line
= sci_get_line_from_position(sci
, anchor_pos
);
5075 caret_offset
= caret_pos
- sci_get_position_from_line(sci
, caret_line
);
5076 anchor_offset
= anchor_pos
- sci_get_position_from_line(sci
, anchor_line
);
5077 caret_indent_pos
= sci_get_line_indent_position(sci
, caret_line
);
5078 anchor_indent_pos
= sci_get_line_indent_position(sci
, anchor_line
);
5079 caret_line_len
= sci_get_line_length(sci
, caret_line
);
5080 anchor_line_len
= sci_get_line_length(sci
, anchor_line
);
5082 if (sci_get_lines_selected(sci
) <= 1)
5084 editor_change_line_indent(editor
, sci_get_current_line(sci
), increase
);
5089 gint line
, lstart
, lend
;
5091 editor_select_lines(editor
, FALSE
);
5092 start
= sci_get_selection_start(sci
);
5093 end
= sci_get_selection_end(sci
);
5094 lstart
= sci_get_line_from_position(sci
, start
);
5095 lend
= sci_get_line_from_position(sci
, end
);
5096 if (end
== sci_get_length(sci
))
5097 lend
++; /* for last line with text on it */
5099 sci_start_undo_action(sci
);
5100 for (line
= lstart
; line
< lend
; line
++)
5102 editor_change_line_indent(editor
, line
, increase
);
5104 sci_end_undo_action(sci
);
5107 /* restore caret and anchor position */
5108 if (caret_pos
>= caret_indent_pos
)
5109 caret_offset
+= sci_get_line_length(sci
, caret_line
) - caret_line_len
;
5110 if (anchor_pos
>= anchor_indent_pos
)
5111 anchor_offset
+= sci_get_line_length(sci
, anchor_line
) - anchor_line_len
;
5113 SSM(sci
, SCI_SETCURRENTPOS
, sci_get_position_from_line(sci
, caret_line
) + caret_offset
, 0);
5114 SSM(sci
, SCI_SETANCHOR
, sci_get_position_from_line(sci
, anchor_line
) + anchor_offset
, 0);
5118 /** Gets snippet by name.
5120 * If @a editor is passed, returns a snippet specific to the document filetype.
5121 * If @a editor is @c NULL, returns a snippet from the default set.
5123 * @param editor Editor or @c NULL.
5124 * @param snippet_name Snippet name.
5125 * @return snippet or @c NULL if it was not found. Must not be freed.
5127 const gchar
*editor_find_snippet(GeanyEditor
*editor
, const gchar
*snippet_name
)
5129 const gchar
*subhash_name
= editor
? editor
->document
->file_type
->name
: "Default";
5130 GHashTable
*subhash
= g_hash_table_lookup(snippet_hash
, subhash_name
);
5132 return subhash
? g_hash_table_lookup(subhash
, snippet_name
) : NULL
;
5136 /** Replaces all special sequences in @a snippet and inserts it at @a pos.
5137 * If you insert at the current position, consider calling @c sci_scroll_caret()
5138 * after this function.
5143 void editor_insert_snippet(GeanyEditor
*editor
, gint pos
, const gchar
*snippet
)
5147 pattern
= g_string_new(snippet
);
5148 snippets_make_replacements(editor
, pattern
);
5149 editor_insert_text_block(editor
, pattern
->str
, pos
, -1, -1, TRUE
);
5150 g_string_free(pattern
, TRUE
);