Merge pull request #3011 from dolik-rce/fix-context-menus-on-wayland

[geany-mirror.git] / src / editor.c

/*
 *      editor.c - this file is part of Geany, a fast and lightweight IDE
 *
 *      Copyright 2005 The Geany contributors
 *
 *      This program is free software; you can redistribute it and/or modify
 *      it under the terms of the GNU General Public License as published by
 *      the Free Software Foundation; either version 2 of the License, or
 *      (at your option) any later version.
 *
 *      This program is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *      GNU General Public License for more details.
 *
 *      You should have received a copy of the GNU General Public License along
 *      with this program; if not, write to the Free Software Foundation, Inc.,
 *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

/**
 * @file editor.h
 * Editor-related functions for @ref GeanyEditor.
 * Geany uses the Scintilla editing widget, and this file is mostly built around
 * Scintilla's functionality.
 * @see sciwrappers.h.
 */
/* Callbacks for the Scintilla widget (ScintillaObject).
 * Most important is the sci-notify callback, handled in on_editor_notification().
 * This includes auto-indentation, comments, auto-completion, calltips, etc.
 * Also some general Scintilla-related functions.
 */

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include "editor.h"

#include "app.h"
#include "callbacks.h"
#include "dialogs.h"
#include "documentprivate.h"
#include "filetypesprivate.h"
#include "geanyobject.h"
#include "highlighting.h"
#include "keybindings.h"
#include "main.h"
#include "prefs.h"
#include "projectprivate.h"
#include "sciwrappers.h"
#include "support.h"
#include "symbols.h"
#include "templates.h"
#include "ui_utils.h"
#include "utils.h"

#include "SciLexer.h"

#include <ctype.h>
#include <string.h>

#include <gtk/gtk.h>
#include <gdk/gdkkeysyms.h>


static GHashTable *snippet_hash = NULL;
static GtkAccelGroup *snippet_accel_group = NULL;
static gboolean autocomplete_scope_shown = FALSE;

static const gchar geany_cursor_marker[] = "__GEANY_CURSOR_MARKER__";

/* holds word under the mouse or keyboard cursor */
static gchar current_word[GEANY_MAX_WORD_LENGTH];

/* Initialised in keyfile.c. */
GeanyEditorPrefs editor_prefs;

EditorInfo editor_info = {current_word, -1};

static struct
{
        gchar *text;
        gboolean set;
        gchar *last_word;
        guint tag_index;
        gint pos;
        ScintillaObject *sci;
} calltip = {NULL, FALSE, NULL, 0, 0, NULL};

static gchar indent[100];


static void on_new_line_added(GeanyEditor *editor);
static gboolean handle_xml(GeanyEditor *editor, gint pos, gchar ch);
static void insert_indent_after_line(GeanyEditor *editor, gint line);
static void auto_multiline(GeanyEditor *editor, gint pos);
static void auto_close_chars(ScintillaObject *sci, gint pos, gchar c);
static void close_block(GeanyEditor *editor, gint pos);
static void editor_highlight_braces(GeanyEditor *editor, gint cur_pos);
static void read_current_word(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen,
                const gchar *wc, gboolean stem);
static gsize count_indent_size(GeanyEditor *editor, const gchar *base_indent);
static const gchar *snippets_find_completion_by_name(const gchar *type, const gchar *name);
static void snippets_make_replacements(GeanyEditor *editor, GString *pattern);
static GeanyFiletype *editor_get_filetype_at_line(GeanyEditor *editor, gint line);
static gboolean sci_is_blank_line(ScintillaObject *sci, gint line);


void editor_snippets_free(void)
{
        g_hash_table_destroy(snippet_hash);
        gtk_window_remove_accel_group(GTK_WINDOW(main_widgets.window), snippet_accel_group);
}


static void snippets_load(GKeyFile *sysconfig, GKeyFile *userconfig)
{
        gsize i, j, len = 0, len_keys = 0;
        gchar **groups_user, **groups_sys;
        gchar **keys_user, **keys_sys;
        gchar *value;
        GHashTable *tmp;

        /* keys are strings, values are GHashTables, so use g_free and g_hash_table_destroy */
        snippet_hash =
                g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_hash_table_destroy);

        /* first read all globally defined auto completions */
        groups_sys = g_key_file_get_groups(sysconfig, &len);
        for (i = 0; i < len; i++)
        {
                if (strcmp(groups_sys[i], "Keybindings") == 0)
                        continue;
                keys_sys = g_key_file_get_keys(sysconfig, groups_sys[i], &len_keys, NULL);
                /* create new hash table for the read section (=> filetype) */
                tmp = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
                g_hash_table_insert(snippet_hash, g_strdup(groups_sys[i]), tmp);

                for (j = 0; j < len_keys; j++)
                {
                        g_hash_table_insert(tmp, g_strdup(keys_sys[j]),
                                                utils_get_setting_string(sysconfig, groups_sys[i], keys_sys[j], ""));
                }
                g_strfreev(keys_sys);
        }
        g_strfreev(groups_sys);

        /* now read defined completions in user's configuration directory and add / replace them */
        groups_user = g_key_file_get_groups(userconfig, &len);
        for (i = 0; i < len; i++)
        {
                if (strcmp(groups_user[i], "Keybindings") == 0)
                        continue;
                keys_user = g_key_file_get_keys(userconfig, groups_user[i], &len_keys, NULL);

                tmp = g_hash_table_lookup(snippet_hash, groups_user[i]);
                if (tmp == NULL)
                {       /* new key found, create hash table */
                        tmp = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
                        g_hash_table_insert(snippet_hash, g_strdup(groups_user[i]), tmp);
                }
                for (j = 0; j < len_keys; j++)
                {
                        value = g_hash_table_lookup(tmp, keys_user[j]);
                        if (value == NULL)
                        {       /* value = NULL means the key doesn't yet exist, so insert */
                                g_hash_table_insert(tmp, g_strdup(keys_user[j]),
                                                utils_get_setting_string(userconfig, groups_user[i], keys_user[j], ""));
                        }
                        else
                        {       /* old key and value will be freed by destroy function (g_free) */
                                g_hash_table_replace(tmp, g_strdup(keys_user[j]),
                                                utils_get_setting_string(userconfig, groups_user[i], keys_user[j], ""));
                        }
                }
                g_strfreev(keys_user);
        }
        g_strfreev(groups_user);
}


static gboolean on_snippet_keybinding_activate(gchar *key)
{
        GeanyDocument *doc = document_get_current();
        const gchar *s;

        if (!doc || !gtk_widget_has_focus(GTK_WIDGET(doc->editor->sci)))
                return FALSE;

        s = snippets_find_completion_by_name(doc->file_type->name, key);
        if (!s) /* allow user to specify keybindings for "special" snippets */
        {
                GHashTable *specials = g_hash_table_lookup(snippet_hash, "Special");

                if (G_LIKELY(specials != NULL))
                        s = g_hash_table_lookup(specials, key);
        }
        if (!s)
        {
                utils_beep();
                return FALSE;
        }

        editor_insert_snippet(doc->editor, sci_get_current_position(doc->editor->sci), s);
        sci_scroll_caret(doc->editor->sci);

        return TRUE;
}


static void add_kb(GKeyFile *keyfile, const gchar *group, gchar **keys)
{
        gsize i;

        if (!keys)
                return;
        for (i = 0; i < g_strv_length(keys); i++)
        {
                guint key;
                GdkModifierType mods;
                gchar *accel_string = g_key_file_get_value(keyfile, group, keys[i], NULL);

                gtk_accelerator_parse(accel_string, &key, &mods);

                if (key == 0 && mods == 0)
                {
                        g_warning("Can not parse accelerator \"%s\" from user snippets.conf", accel_string);
                        g_free(accel_string);
                        continue;
                }
                g_free(accel_string);

                gtk_accel_group_connect(snippet_accel_group, key, mods, 0,
                        g_cclosure_new_swap((GCallback)on_snippet_keybinding_activate,
                                g_strdup(keys[i]), (GClosureNotify)g_free));
        }
}


static void load_kb(GKeyFile *sysconfig, GKeyFile *userconfig)
{
        const gchar kb_group[] = "Keybindings";
        gchar **keys = g_key_file_get_keys(userconfig, kb_group, NULL, NULL);
        gchar **ptr;

        /* remove overridden keys from system keyfile */
        foreach_strv(ptr, keys)
                g_key_file_remove_key(sysconfig, kb_group, *ptr, NULL);

        add_kb(userconfig, kb_group, keys);
        g_strfreev(keys);

        keys = g_key_file_get_keys(sysconfig, kb_group, NULL, NULL);
        add_kb(sysconfig, kb_group, keys);
        g_strfreev(keys);
}


void editor_snippets_init(void)
{
        gchar *sysconfigfile, *userconfigfile;
        GKeyFile *sysconfig = g_key_file_new();
        GKeyFile *userconfig = g_key_file_new();

        sysconfigfile = g_build_filename(app->datadir, "snippets.conf", NULL);
        userconfigfile = g_build_filename(app->configdir, "snippets.conf", NULL);

        /* check for old autocomplete.conf files (backwards compatibility) */
        if (! g_file_test(userconfigfile, G_FILE_TEST_IS_REGULAR))
                SETPTR(userconfigfile, g_build_filename(app->configdir, "autocomplete.conf", NULL));

        /* load the actual config files */
        g_key_file_load_from_file(sysconfig, sysconfigfile, G_KEY_FILE_NONE, NULL);
        g_key_file_load_from_file(userconfig, userconfigfile, G_KEY_FILE_NONE, NULL);

        snippets_load(sysconfig, userconfig);

        /* setup snippet keybindings */
        snippet_accel_group = gtk_accel_group_new();
        gtk_window_add_accel_group(GTK_WINDOW(main_widgets.window), snippet_accel_group);
        load_kb(sysconfig, userconfig);

        g_free(sysconfigfile);
        g_free(userconfigfile);
        g_key_file_free(sysconfig);
        g_key_file_free(userconfig);
}


static gboolean on_editor_button_press_event(GtkWidget *widget, GdkEventButton *event,
                                                                                         gpointer data)
{
        GeanyEditor *editor = data;
        GeanyDocument *doc = editor->document;

        /* it's very unlikely we got a 'real' click even on 0, 0, so assume it is a
         * fake event to show the editor menu triggered by a key event where we want to use the
         * text cursor position. */
        if (event->x > 0.0 && event->y > 0.0)
                editor_info.click_pos = sci_get_position_from_xy(editor->sci,
                        (gint)event->x, (gint)event->y, FALSE);
        else
                editor_info.click_pos = sci_get_current_position(editor->sci);

        if (event->button == 1)
        {
                guint state = keybindings_get_modifiers(event->state);

                if (event->type == GDK_BUTTON_PRESS && editor_prefs.disable_dnd)
                {
                        gint ss = sci_get_selection_start(editor->sci);
                        sci_set_selection_end(editor->sci, ss);
                }
                if (event->type == GDK_BUTTON_PRESS && state == GEANY_PRIMARY_MOD_MASK)
                {
                        sci_set_current_position(editor->sci, editor_info.click_pos, FALSE);

                        editor_find_current_word(editor, editor_info.click_pos,
                                current_word, sizeof current_word, NULL);
                        if (*current_word)
                                return symbols_goto_tag(current_word, TRUE);
                        else
                                keybindings_send_command(GEANY_KEY_GROUP_GOTO, GEANY_KEYS_GOTO_MATCHINGBRACE);
                        return TRUE;
                }
                return document_check_disk_status(doc, FALSE);
        }

        /* calls the edit popup menu in the editor */
        if (event->button == 3)
        {
                gboolean can_goto;

                /* ensure the editor widget has the focus after this operation */
                gtk_widget_grab_focus(widget);

                editor_find_current_word(editor, editor_info.click_pos,
                        current_word, sizeof current_word, NULL);

                can_goto = sci_has_selection(editor->sci) || current_word[0] != '\0';
                ui_update_popup_goto_items(can_goto);
                ui_update_popup_copy_items(doc);
                ui_update_insert_include_item(doc, 0);

                g_signal_emit_by_name(geany_object, "update-editor-menu",
                        current_word, editor_info.click_pos, doc);

                ui_menu_popup(GTK_MENU(main_widgets.editor_menu), NULL, NULL, event->button, event->time);
                return TRUE;
        }
        return FALSE;
}


static gboolean is_style_php(gint style)
{
        if ((style >= SCE_HPHP_DEFAULT && style <= SCE_HPHP_OPERATOR) ||
                style == SCE_HPHP_COMPLEX_VARIABLE)
        {
                return TRUE;
        }

        return FALSE;
}


static gint editor_get_long_line_type(void)
{
        if (app->project)
                switch (app->project->priv->long_line_behaviour)
                {
                        case 0: /* marker disabled */
                                return 2;
                        case 1: /* use global settings */
                                break;
                        case 2: /* custom (enabled) */
                                return editor_prefs.long_line_type;
                }

        if (!editor_prefs.long_line_enabled)
                return 2;
        else
                return editor_prefs.long_line_type;
}


static gint editor_get_long_line_column(void)
{
        if (app->project && app->project->priv->long_line_behaviour != 1 /* use global settings */)
                return app->project->priv->long_line_column;
        else
                return editor_prefs.long_line_column;
}


#define get_project_pref(id)\
        (app->project ? app->project->priv->id : editor_prefs.id)

static const GeanyEditorPrefs *
get_default_prefs(void)
{
        static GeanyEditorPrefs eprefs;

        eprefs = editor_prefs;

        /* project overrides */
        eprefs.indentation = (GeanyIndentPrefs*)editor_get_indent_prefs(NULL);
        eprefs.long_line_type = editor_get_long_line_type();
        eprefs.long_line_column = editor_get_long_line_column();
        eprefs.line_wrapping = get_project_pref(line_wrapping);
        eprefs.line_break_column = get_project_pref(line_break_column);
        eprefs.auto_continue_multiline = get_project_pref(auto_continue_multiline);
        return &eprefs;
}


/* Gets the prefs for the editor.
 * Prefs can be different according to project or document.
 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
 * settings may have changed, or if this function has been called for a different editor.
 * @param editor The editor, or @c NULL to get the default prefs.
 * @return The prefs. */
const GeanyEditorPrefs *editor_get_prefs(GeanyEditor *editor)
{
        static GeanyEditorPrefs eprefs;
        const GeanyEditorPrefs *dprefs = get_default_prefs();

        /* Return the address of the default prefs to allow returning default and editor
         * pref pointers without invalidating the contents of either. */
        if (editor == NULL)
                return dprefs;

        eprefs = *dprefs;
        eprefs.indentation = (GeanyIndentPrefs*)editor_get_indent_prefs(editor);
        /* add other editor & document overrides as needed */
        return &eprefs;
}


void editor_toggle_fold(GeanyEditor *editor, gint line, gint modifiers)
{
        ScintillaObject *sci;
        gint header;

        g_return_if_fail(editor != NULL);

        sci = editor->sci;
        /* When collapsing a fold range whose starting line is offscreen,
         * scroll the starting line to display at the top of the view.
         * Otherwise it can be confusing when the document scrolls down to hide
         * the folded lines. */
        if ((sci_get_fold_level(sci, line) & SC_FOLDLEVELNUMBERMASK) > SC_FOLDLEVELBASE &&
                !(sci_get_fold_level(sci, line) & SC_FOLDLEVELHEADERFLAG))
        {
                gint parent = sci_get_fold_parent(sci, line);
                gint first = sci_get_first_visible_line(sci);

                parent = SSM(sci, SCI_VISIBLEFROMDOCLINE, parent, 0);
                if (first > parent)
                        SSM(sci, SCI_SETFIRSTVISIBLELINE, parent, 0);
        }

        /* find the fold header of the given line in case the one clicked isn't a fold point */
        if (sci_get_fold_level(sci, line) & SC_FOLDLEVELHEADERFLAG)
                header = line;
        else
                header = sci_get_fold_parent(sci, line);

        if ((editor_prefs.unfold_all_children && ! (modifiers & SCMOD_SHIFT)) ||
                (! editor_prefs.unfold_all_children && (modifiers & SCMOD_SHIFT)))
        {
                SSM(sci, SCI_FOLDCHILDREN, header, SC_FOLDACTION_TOGGLE);
        }
        else
        {
                SSM(sci, SCI_FOLDLINE, header, SC_FOLDACTION_TOGGLE);
        }
}


static void on_margin_click(GeanyEditor *editor, SCNotification *nt)
{
        /* left click to marker margin marks the line */
        if (nt->margin == 1)
        {
                gint line = sci_get_line_from_position(editor->sci, nt->position);

                /*sci_marker_delete_all(editor->sci, 1);*/
                sci_toggle_marker_at_line(editor->sci, line, 1);        /* toggle the marker */
        }
        /* left click on the folding margin to toggle folding state of current line */
        else if (nt->margin == 2 && editor_prefs.folding)
        {
                gint line = sci_get_line_from_position(editor->sci, nt->position);
                editor_toggle_fold(editor, line, nt->modifiers);
        }
}


static void on_update_ui(GeanyEditor *editor, G_GNUC_UNUSED SCNotification *nt)
{
        ScintillaObject *sci = editor->sci;
        gint pos = sci_get_current_position(sci);

        /* since Scintilla 2.24, SCN_UPDATEUI is also sent on scrolling though we don't need to handle
         * this and so ignore every SCN_UPDATEUI events except for content and selection changes */
        if (! (nt->updated & SC_UPDATE_CONTENT) && ! (nt->updated & SC_UPDATE_SELECTION))
                return;

        /* undo / redo menu update */
        ui_update_popup_reundo_items(editor->document);

        /* brace highlighting */
        editor_highlight_braces(editor, pos);

        ui_update_statusbar(editor->document, pos);

#if 0
        /** experimental code for inverting selections */
        {
        gint i;
        for (i = SSM(sci, SCI_GETSELECTIONSTART, 0, 0); i < SSM(sci, SCI_GETSELECTIONEND, 0, 0); i++)
        {
                /* need to get colour from getstyleat(), but how? */
                SSM(sci, SCI_STYLESETFORE, STYLE_DEFAULT, 0);
                SSM(sci, SCI_STYLESETBACK, STYLE_DEFAULT, 0);
        }

        sci_get_style_at(sci, pos);
        }
#endif
}


static void check_line_breaking(GeanyEditor *editor, gint pos)
{
        ScintillaObject *sci = editor->sci;
        gint line, lstart, col;
        gchar c;

        if (!editor->line_breaking || sci_get_selection_mode(editor->sci) != SC_SEL_STREAM)
                return;

        col = sci_get_col_from_position(sci, pos);

        line = sci_get_current_line(sci);

        lstart = sci_get_position_from_line(sci, line);

        /* use column instead of position which might be different with multibyte characters */
        if (col < get_project_pref(line_break_column))
                return;

        /* look for the last space before line_break_column */
        pos = sci_get_position_from_col(sci, line, get_project_pref(line_break_column));

        while (pos > lstart)
        {
                c = sci_get_char_at(sci, --pos);
                if (c == ' ')
                {
                        gint diff, last_pos, last_col;

                        /* remember the distance between the current column and the last column on the line
                         * (we use column position in case the previous line gets altered, such as removing
                         * trailing spaces or in case it contains multibyte characters) */
                        last_pos = sci_get_line_end_position(sci, line);
                        last_col = sci_get_col_from_position(sci, last_pos);
                        diff = last_col - col;

                        /* break the line after the space */
                        sci_set_current_position(sci, pos + 1, FALSE);
                        sci_cancel(sci);        /* don't select from completion list */
                        sci_send_command(sci, SCI_NEWLINE);
                        line++;

                        /* correct cursor position (might not be at line end) */
                        last_pos = sci_get_line_end_position(sci, line);
                        last_col = sci_get_col_from_position(sci, last_pos); /* get last column on line */
                        /* last column - distance is the desired column, then retrieve its document position */
                        pos = sci_get_position_from_col(sci, line, last_col - diff);
                        sci_set_current_position(sci, pos, FALSE);
                        sci_scroll_caret(sci);
                        return;
                }
        }
}


static void show_autocomplete(ScintillaObject *sci, gsize rootlen, GString *words)
{
        /* hide autocompletion if only option is already typed */
        if (rootlen >= words->len ||
                (words->str[rootlen] == '?' && rootlen >= words->len - 2))
        {
                sci_send_command(sci, SCI_AUTOCCANCEL);
                return;
        }
        /* store whether a calltip is showing, so we can reshow it after autocompletion */
        calltip.set = (gboolean) SSM(sci, SCI_CALLTIPACTIVE, 0, 0);
        SSM(sci, SCI_AUTOCSETORDER, SC_ORDER_CUSTOM, 0);
        SSM(sci, SCI_AUTOCSHOW, rootlen, (sptr_t) words->str);
}


static void show_tags_list(GeanyEditor *editor, const GPtrArray *tags, gsize rootlen)
{
        ScintillaObject *sci = editor->sci;

        g_return_if_fail(tags);

        if (tags->len > 0)
        {
                GString *words = g_string_sized_new(150);
                guint j;

                for (j = 0; j < tags->len; ++j)
                {
                        TMTag *tag = tags->pdata[j];
                        gint group;
                        guint icon_id;

                        if (j > 0)
                                g_string_append_c(words, '\n');

                        if (j == editor_prefs.autocompletion_max_entries)
                        {
                                g_string_append(words, "...");
                                break;
                        }
                        g_string_append(words, tag->name);

                        group = tm_parser_get_sidebar_group(tag->lang, tag->type);
                        if (group >= 0 && tm_parser_get_sidebar_info(tag->lang, group, &icon_id))
                        {
                                gchar buf[10];
                                sprintf(buf, "?%u", icon_id + 1);
                                g_string_append(words, buf);
                        }
                }
                show_autocomplete(sci, rootlen, words);
                g_string_free(words, TRUE);
        }
}


static gint scope_autocomplete_suffix(ScintillaObject *sci, TMParserType lang,
        gint pos, gboolean *scope_sep)
{
        const gchar *sep = tm_parser_scope_separator(lang);
        const gsize max_len = 3;
        gboolean is_scope_sep;
        gchar *buf;

        buf = g_alloca(max_len + 1);
        sci_get_text_range(sci, pos - max_len, pos, buf);

        is_scope_sep = g_str_has_suffix(buf, sep);
        if (scope_sep)
                *scope_sep = is_scope_sep;
        if (is_scope_sep)
                return strlen(sep);
        return tm_parser_scope_autocomplete_suffix(lang, buf);
}


static gboolean reshow_calltip(gpointer data)
{
        GeanyDocument *doc;

        g_return_val_if_fail(calltip.sci != NULL, FALSE);

        SSM(calltip.sci, SCI_CALLTIPCANCEL, 0, 0);
        doc = document_get_current();

        if (doc && doc->editor->sci == calltip.sci)
        {
                /* we use the position where the calltip was previously started as SCI_GETCURRENTPOS
                 * may be completely wrong in case the user cancelled the auto completion with the mouse */
                SSM(calltip.sci, SCI_CALLTIPSHOW, calltip.pos, (sptr_t) calltip.text);
        }
        return FALSE;
}


static void request_reshowing_calltip(SCNotification *nt)
{
        if (calltip.set)
        {
                /* delay the reshow of the calltip window to make sure it is actually displayed,
                 * without it might be not visible on SCN_AUTOCCANCEL. the priority is set to
                 * low to hopefully make Scintilla's events happen before reshowing since they
                 * seem to re-cancel the calltip on autoc menu hiding too */
                g_idle_add_full(G_PRIORITY_LOW, reshow_calltip, NULL, NULL);
        }
}


static gboolean autocomplete_scope(GeanyEditor *editor, const gchar *root, gsize rootlen)
{
        ScintillaObject *sci = editor->sci;
        gint pos = sci_get_current_position(editor->sci);
        gint line = sci_get_current_line(editor->sci) + 1;
        gchar typed = sci_get_char_at(sci, pos - 1);
        gchar brace_char;
        gchar *name;
        GeanyFiletype *ft = editor->document->file_type;
        GPtrArray *tags;
        gboolean function = FALSE;
        gboolean member;
        gboolean scope_sep_typed = FALSE;
        gboolean ret = FALSE;
        const gchar *current_scope;
        gint autocomplete_suffix_len;

        if (autocomplete_scope_shown)
        {
                /* move at the operator position */
                pos -= rootlen;

                /* allow for a space between word and operator */
                while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                        pos--;

                if (pos > 0)
                        typed = sci_get_char_at(sci, pos - 1);
        }

        autocomplete_suffix_len = scope_autocomplete_suffix(sci, ft->lang, pos,
                &scope_sep_typed);
        if (autocomplete_suffix_len == 0)
                return FALSE;

        pos -= autocomplete_suffix_len;

        /* allow for a space between word and operator */
        while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                pos--;

        /* if function or array index, skip to matching brace */
        brace_char = sci_get_char_at(sci, pos - 1);
        if (pos > 0 && (brace_char == ')' || brace_char == ']'))
        {
                gint brace_pos = sci_find_matching_brace(sci, pos - 1);

                if (brace_pos != -1)
                {
                        pos = brace_pos;
                        function = brace_char == ')';
                }

                /* allow for a space between opening brace and name */
                while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                        pos--;
        }

        name = editor_get_word_at_pos(editor, pos, NULL);
        if (!name)
                return FALSE;

        /* check if invoked on member */
        pos -= strlen(name);
        while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                pos--;
        member = scope_autocomplete_suffix(sci, ft->lang, pos, NULL) > 0;

        if (symbols_get_current_scope(editor->document, &current_scope) == -1)
                current_scope = "";
        tags = tm_workspace_find_scope_members(editor->document->tm_file, name, function,
                                member, current_scope, line, scope_sep_typed);
        if (tags)
        {
                GPtrArray *filtered = g_ptr_array_new();
                TMTag *tag;
                guint i;

                foreach_ptr_array(tag, i, tags)
                {
                        if (g_str_has_prefix(tag->name, root))
                                g_ptr_array_add(filtered, tag);
                }

                if (filtered->len > 0)
                {
                        show_tags_list(editor, filtered, rootlen);
                        ret = TRUE;
                }

                g_ptr_array_free(tags, TRUE);
                g_ptr_array_free(filtered, TRUE);
        }

        g_free(name);
        return ret;
}


static void on_char_added(GeanyEditor *editor, SCNotification *nt)
{
        ScintillaObject *sci = editor->sci;
        gint pos = sci_get_current_position(sci);

        switch (nt->ch)
        {
                case '\r':
                {       /* simple indentation (only for CR format) */
                        if (sci_get_eol_mode(sci) == SC_EOL_CR)
                                on_new_line_added(editor);
                        break;
                }
                case '\n':
                {       /* simple indentation (for CR/LF and LF format) */
                        on_new_line_added(editor);
                        break;
                }
                case '>':
                        editor_start_auto_complete(editor, pos, FALSE); /* C/C++ ptr-> scope completion */
                        /* fall through */
                case '/':
                {       /* close xml-tags */
                        handle_xml(editor, pos, nt->ch);
                        break;
                }
                case '(':
                {
                        auto_close_chars(sci, pos, nt->ch);
                        /* show calltips */
                        editor_show_calltip(editor, --pos);
                        break;
                }
                case ')':
                {       /* hide calltips */
                        if (SSM(sci, SCI_CALLTIPACTIVE, 0, 0))
                        {
                                SSM(sci, SCI_CALLTIPCANCEL, 0, 0);
                        }
                        g_free(calltip.text);
                        calltip.text = NULL;
                        calltip.pos = 0;
                        calltip.sci = NULL;
                        calltip.set = FALSE;
                        break;
                }
                case '{':
                case '[':
                case '"':
                case '\'':
                {
                        auto_close_chars(sci, pos, nt->ch);
                        break;
                }
                case '}':
                {       /* closing bracket handling */
                        if (editor->auto_indent)
                                close_block(editor, pos - 1);
                        break;
                }
                /* scope autocompletion */
                case '.':
                case ':':       /* C/C++ class:: syntax */
                /* tag autocompletion */
                default:
#if 0
                        if (! editor_start_auto_complete(editor, pos, FALSE))
                                request_reshowing_calltip(nt);
#else
                        editor_start_auto_complete(editor, pos, FALSE);
#endif
        }
        check_line_breaking(editor, pos);
}


/* expand() and fold_changed() are copied from SciTE (thanks) to fix #1923350. */
static void expand(ScintillaObject *sci, gint *line, gboolean doExpand,
                gboolean force, gint visLevels, gint level)
{
        gint lineMaxSubord = SSM(sci, SCI_GETLASTCHILD, *line, level & SC_FOLDLEVELNUMBERMASK);
        gint levelLine = level;
        (*line)++;
        while (*line <= lineMaxSubord)
        {
                if (force)
                {
                        if (visLevels > 0)
                                SSM(sci, SCI_SHOWLINES, *line, *line);
                        else
                                SSM(sci, SCI_HIDELINES, *line, *line);
                }
                else
                {
                        if (doExpand)
                                SSM(sci, SCI_SHOWLINES, *line, *line);
                }
                if (levelLine == -1)
                        levelLine = SSM(sci, SCI_GETFOLDLEVEL, *line, 0);
                if (levelLine & SC_FOLDLEVELHEADERFLAG)
                {
                        if (force)
                        {
                                if (visLevels > 1)
                                        SSM(sci, SCI_SETFOLDEXPANDED, *line, 1);
                                else
                                        SSM(sci, SCI_SETFOLDEXPANDED, *line, 0);
                                expand(sci, line, doExpand, force, visLevels - 1, -1);
                        }
                        else
                        {
                                if (doExpand)
                                {
                                        if (!sci_get_fold_expanded(sci, *line))
                                                SSM(sci, SCI_SETFOLDEXPANDED, *line, 1);
                                        expand(sci, line, TRUE, force, visLevels - 1, -1);
                                }
                                else
                                {
                                        expand(sci, line, FALSE, force, visLevels - 1, -1);
                                }
                        }
                }
                else
                {
                        (*line)++;
                }
        }
}


static void fold_changed(ScintillaObject *sci, gint line, gint levelNow, gint levelPrev)
{
        if (levelNow & SC_FOLDLEVELHEADERFLAG)
        {
                if (! (levelPrev & SC_FOLDLEVELHEADERFLAG))
                {
                        /* Adding a fold point */
                        SSM(sci, SCI_SETFOLDEXPANDED, line, 1);
                        if (!SSM(sci, SCI_GETALLLINESVISIBLE, 0, 0))
                                expand(sci, &line, TRUE, FALSE, 0, levelPrev);
                }
        }
        else if (levelPrev & SC_FOLDLEVELHEADERFLAG)
        {
                if (! sci_get_fold_expanded(sci, line))
                {       /* Removing the fold from one that has been contracted so should expand
                         * otherwise lines are left invisible with no way to make them visible */
                        SSM(sci, SCI_SETFOLDEXPANDED, line, 1);
                        if (!SSM(sci, SCI_GETALLLINESVISIBLE, 0, 0))
                                expand(sci, &line, TRUE, FALSE, 0, levelPrev);
                }
        }
        if (! (levelNow & SC_FOLDLEVELWHITEFLAG) &&
                        ((levelPrev & SC_FOLDLEVELNUMBERMASK) > (levelNow & SC_FOLDLEVELNUMBERMASK)))
        {
                if (!SSM(sci, SCI_GETALLLINESVISIBLE, 0, 0)) {
                        /* See if should still be hidden */
                        gint parentLine = sci_get_fold_parent(sci, line);
                        if (parentLine < 0)
                        {
                                SSM(sci, SCI_SHOWLINES, line, line);
                        }
                        else if (sci_get_fold_expanded(sci, parentLine) &&
                                        sci_get_line_is_visible(sci, parentLine))
                        {
                                SSM(sci, SCI_SHOWLINES, line, line);
                        }
                }
        }
}


static void ensure_range_visible(ScintillaObject *sci, gint posStart, gint posEnd,
                gboolean enforcePolicy)
{
        gint lineStart = sci_get_line_from_position(sci, MIN(posStart, posEnd));
        gint lineEnd = sci_get_line_from_position(sci, MAX(posStart, posEnd));
        gint line;

        for (line = lineStart; line <= lineEnd; line++)
        {
                SSM(sci, enforcePolicy ? SCI_ENSUREVISIBLEENFORCEPOLICY : SCI_ENSUREVISIBLE, line, 0);
        }
}


static void auto_update_margin_width(GeanyEditor *editor)
{
        gint next_linecount = 1;
        gint linecount = sci_get_line_count(editor->sci);
        GeanyDocument *doc = editor->document;

        while (next_linecount <= linecount)
                next_linecount *= 10;

        if (editor->document->priv->line_count != next_linecount)
        {
                doc->priv->line_count = next_linecount;
                sci_set_line_numbers(editor->sci, TRUE);
        }
}


static void partial_complete(ScintillaObject *sci, const gchar *text)
{
        gint pos = sci_get_current_position(sci);

        sci_insert_text(sci, pos, text);
        sci_set_current_position(sci, pos + strlen(text), TRUE);
}


/* Complete the next word part from @a entry */
static gboolean check_partial_completion(GeanyEditor *editor, const gchar *entry)
{
        gchar *stem, *ptr, *text = utils_strdupa(entry);

        read_current_word(editor, -1, current_word, sizeof current_word, NULL, TRUE);
        stem = current_word;
        if (strstr(text, stem) != text)
                return FALSE;   /* shouldn't happen */
        if (strlen(text) <= strlen(stem))
                return FALSE;

        text += strlen(stem); /* skip stem */
        ptr = strstr(text + 1, "_");
        if (ptr)
        {
                ptr[1] = '\0';
                partial_complete(editor->sci, text);
                return TRUE;
        }
        else
        {
                /* CamelCase */
                foreach_str(ptr, text + 1)
                {
                        if (!ptr[0])
                                break;
                        if (g_ascii_isupper(*ptr) && g_ascii_islower(ptr[1]))
                        {
                                ptr[0] = '\0';
                                partial_complete(editor->sci, text);
                                return TRUE;
                        }
                }
        }
        return FALSE;
}


/* Callback for the "sci-notify" signal to emit a "editor-notify" signal.
 * Plugins can connect to the "editor-notify" signal. */
void editor_sci_notify_cb(G_GNUC_UNUSED GtkWidget *widget, G_GNUC_UNUSED gint scn,
                                                  gpointer scnt, gpointer data)
{
        GeanyEditor *editor = data;
        gboolean retval;

        g_return_if_fail(editor != NULL);

        g_signal_emit_by_name(geany_object, "editor-notify", editor, scnt, &retval);
}


/* recalculate margins width */
static void update_margins(ScintillaObject *sci)
{
        sci_set_line_numbers(sci, editor_prefs.show_linenumber_margin);
        sci_set_symbol_margin(sci, editor_prefs.show_markers_margin);
        sci_set_folding_margin_visible(sci, editor_prefs.folding);
}


static gboolean on_editor_notify(G_GNUC_UNUSED GObject *object, GeanyEditor *editor,
                                                                 SCNotification *nt, G_GNUC_UNUSED gpointer data)
{
        ScintillaObject *sci = editor->sci;
        GeanyDocument *doc = editor->document;

        switch (nt->nmhdr.code)
        {
                case SCN_SAVEPOINTLEFT:
                        document_set_text_changed(doc, TRUE);
                        break;

                case SCN_SAVEPOINTREACHED:
                        document_set_text_changed(doc, FALSE);
                        break;

                case SCN_MODIFYATTEMPTRO:
                        utils_beep();
                        break;

                case SCN_MARGINCLICK:
                        on_margin_click(editor, nt);
                        break;

                case SCN_UPDATEUI:
                        on_update_ui(editor, nt);
                        break;

                case SCN_PAINTED:
                        /* Visible lines are only laid out accurately just before painting,
                         * so we need to only call editor_scroll_to_line here, because the document
                         * may have line wrapping and folding enabled.
                         * http://scintilla.sourceforge.net/ScintillaDoc.html#LineWrapping
                         * This is important e.g. when loading a session and switching pages
                         * and having the cursor scroll in view. */
                         /* FIXME: Really we want to do this just before painting, not after it
                          * as it will cause repainting. */
                        if (editor->scroll_percent > 0.0F)
                        {
                                editor_scroll_to_line(editor, -1, editor->scroll_percent);
                                /* disable further scrolling */
                                editor->scroll_percent = -1.0F;
                        }
                        break;

                case SCN_MODIFIED:
                        if (editor_prefs.show_linenumber_margin && (nt->modificationType & (SC_MOD_INSERTTEXT | SC_MOD_DELETETEXT)) && nt->linesAdded)
                        {
                                /* automatically adjust Scintilla's line numbers margin width */
                                auto_update_margin_width(editor);
                        }
                        if (nt->modificationType & SC_STARTACTION && ! ignore_callback)
                        {
                                /* get notified about undo changes */
                                document_undo_add(doc, UNDO_SCINTILLA, NULL);
                        }
                        if (editor_prefs.folding && (nt->modificationType & SC_MOD_CHANGEFOLD) != 0)
                        {
                                /* handle special fold cases, e.g. #1923350 */
                                fold_changed(sci, nt->line, nt->foldLevelNow, nt->foldLevelPrev);
                        }
                        if (nt->modificationType & (SC_MOD_INSERTTEXT | SC_MOD_DELETETEXT))
                        {
                                document_update_tag_list_in_idle(doc);
                        }
                        break;

                case SCN_CHARADDED:
                        on_char_added(editor, nt);
                        break;

                case SCN_USERLISTSELECTION:
                        if (nt->listType == 1)
                        {
                                sci_add_text(sci, nt->text);
                        }
                        break;

                case SCN_AUTOCSELECTION:
                        if (g_str_equal(nt->text, "..."))
                        {
                                sci_cancel(sci);
                                utils_beep();
                                break;
                        }
                        /* fall through */
                case SCN_AUTOCCANCELLED:
                        /* now that autocomplete is finishing or was cancelled, reshow calltips
                         * if they were showing */
                        autocomplete_scope_shown = FALSE;
                        request_reshowing_calltip(nt);
                        break;
                case SCN_NEEDSHOWN:
                        ensure_range_visible(sci, nt->position, nt->position + nt->length, FALSE);
                        break;

                case SCN_URIDROPPED:
                        if (nt->text != NULL)
                        {
                                document_open_file_list(nt->text, strlen(nt->text));
                        }
                        break;

                case SCN_CALLTIPCLICK:
                        if (nt->position > 0)
                        {
                                switch (nt->position)
                                {
                                        case 1: /* up arrow */
                                                if (calltip.tag_index > 0)
                                                        calltip.tag_index--;
                                                break;

                                        case 2: calltip.tag_index++; break;     /* down arrow */
                                }
                                editor_show_calltip(editor, -1);
                        }
                        break;

                case SCN_ZOOM:
                        update_margins(sci);
                        break;
        }
        /* we always return FALSE here to let plugins handle the event too */
        return FALSE;
}


/* Note: this is the same as sci_get_tab_width(), but is still useful when you don't have
 * a scintilla pointer. */
static gint get_tab_width(const GeanyIndentPrefs *indent_prefs)
{
        if (indent_prefs->type == GEANY_INDENT_TYPE_BOTH)
                return indent_prefs->hard_tab_width;

        return indent_prefs->width;     /* tab width = indent width */
}


/* Returns a string containing width chars of whitespace, filled with simple space
 * characters or with the right number of tab characters, according to the indent prefs.
 * (Result is filled with tabs *and* spaces if width isn't a multiple of
 * the tab width). */
static gchar *
get_whitespace(const GeanyIndentPrefs *iprefs, gint width)
{
        g_return_val_if_fail(width >= 0, NULL);

        if (width == 0)
                return g_strdup("");

        if (iprefs->type == GEANY_INDENT_TYPE_SPACES)
        {
                return g_strnfill(width, ' ');
        }
        else
        {       /* first fill text with tabs and fill the rest with spaces */
                const gint tab_width = get_tab_width(iprefs);
                gint tabs = width / tab_width;
                gint spaces = width % tab_width;
                gint len = tabs + spaces;
                gchar *str;

                str = g_malloc(len + 1);

                memset(str, '\t', tabs);
                memset(str + tabs, ' ', spaces);
                str[len] = '\0';
                return str;
        }
}


static const GeanyIndentPrefs *
get_default_indent_prefs(void)
{
        static GeanyIndentPrefs iprefs;

        iprefs = app->project ? *app->project->priv->indentation : *editor_prefs.indentation;
        return &iprefs;
}


/** Gets the indentation prefs for the editor.
 * Prefs can be different according to project or document.
 * @warning Always get a fresh result instead of keeping a pointer to it if the editor/project
 * settings may have changed, or if this function has been called for a different editor.
 * @param editor @nullable The editor, or @c NULL to get the default indent prefs.
 * @return The indent prefs. */
GEANY_API_SYMBOL
const GeanyIndentPrefs *
editor_get_indent_prefs(GeanyEditor *editor)
{
        static GeanyIndentPrefs iprefs;
        const GeanyIndentPrefs *dprefs = get_default_indent_prefs();

        /* Return the address of the default prefs to allow returning default and editor
         * pref pointers without invalidating the contents of either. */
        if (editor == NULL)
                return dprefs;

        iprefs = *dprefs;
        iprefs.type = editor->indent_type;
        iprefs.width = editor->indent_width;

        /* if per-document auto-indent is enabled, but we don't have a global mode set,
         * just use basic auto-indenting */
        if (editor->auto_indent && iprefs.auto_indent_mode == GEANY_AUTOINDENT_NONE)
                iprefs.auto_indent_mode = GEANY_AUTOINDENT_BASIC;

        if (!editor->auto_indent)
                iprefs.auto_indent_mode = GEANY_AUTOINDENT_NONE;

        return &iprefs;
}


static void on_new_line_added(GeanyEditor *editor)
{
        ScintillaObject *sci = editor->sci;
        gint line = sci_get_current_line(sci);

        /* simple indentation */
        if (editor->auto_indent)
        {
                insert_indent_after_line(editor, line - 1);
        }

        if (get_project_pref(auto_continue_multiline))
        {       /* " * " auto completion in multiline C/C++/D/Java comments */
                auto_multiline(editor, line);
        }

        if (editor_prefs.newline_strip)
        {       /* strip the trailing spaces on the previous line */
                editor_strip_line_trailing_spaces(editor, line - 1);
        }
}


static gboolean lexer_has_braces(ScintillaObject *sci)
{
        gint lexer = sci_get_lexer(sci);

        switch (lexer)
        {
                case SCLEX_CPP:
                case SCLEX_D:
                case SCLEX_HTML:        /* for PHP & JS */
                case SCLEX_PHPSCRIPT:
                case SCLEX_PASCAL:      /* for multiline comments? */
                case SCLEX_BASH:
                case SCLEX_PERL:
                case SCLEX_TCL:
                case SCLEX_R:
                case SCLEX_RUST:
                        return TRUE;
                default:
                        return FALSE;
        }
}


/* Read indent chars for the line that pos is on into indent global variable.
 * Note: Use sci_get_line_indentation() and get_whitespace()/editor_insert_text_block()
 * instead in any new code.  */
static void read_indent(GeanyEditor *editor, gint pos)
{
        ScintillaObject *sci = editor->sci;
        guint i, len, j = 0;
        gint line;
        gchar *linebuf;

        line = sci_get_line_from_position(sci, pos);

        len = sci_get_line_length(sci, line);
        linebuf = sci_get_line(sci, line);

        for (i = 0; i < len && j <= (sizeof(indent) - 1); i++)
        {
                if (linebuf[i] == ' ' || linebuf[i] == '\t')    /* simple indentation */
                        indent[j++] = linebuf[i];
                else
                        break;
        }
        indent[j] = '\0';
        g_free(linebuf);
}


static gint get_brace_indent(ScintillaObject *sci, gint line)
{
        gint start = sci_get_position_from_line(sci, line);
        gint end = sci_get_line_end_position(sci, line) - 1;
        gint lexer = sci_get_lexer(sci);
        gint count = 0;
        gint pos;

        for (pos = end; pos >= start && count < 1; pos--)
        {
                if (highlighting_is_code_style(lexer, sci_get_style_at(sci, pos)))
                {
                        gchar c = sci_get_char_at(sci, pos);

                        if (c == '{')
                                count ++;
                        else if (c == '}')
                                count --;
                }
        }

        return count > 0 ? 1 : 0;
}


/* gets the last code position on a line
 * warning: if there is no code position on the line, returns the start position */
static gint get_sci_line_code_end_position(ScintillaObject *sci, gint line)
{
        gint start = sci_get_position_from_line(sci, line);
        gint lexer = sci_get_lexer(sci);
        gint pos;

        for (pos = sci_get_line_end_position(sci, line) - 1; pos > start; pos--)
        {
                gint style = sci_get_style_at(sci, pos);

                if (highlighting_is_code_style(lexer, style) && ! isspace(sci_get_char_at(sci, pos)))
                        break;
        }

        return pos;
}


static gint get_python_indent(ScintillaObject *sci, gint line)
{
        gint last_char = get_sci_line_code_end_position(sci, line);

        /* add extra indentation for Python after colon */
        if (sci_get_char_at(sci, last_char) == ':' &&
                sci_get_style_at(sci, last_char) == SCE_P_OPERATOR)
        {
                return 1;
        }
        return 0;
}


static gint get_xml_indent(ScintillaObject *sci, gint line)
{
        gboolean need_close = FALSE;
        gint end = get_sci_line_code_end_position(sci, line);
        gint pos;

        /* don't indent if there's a closing tag to the right of the cursor */
        pos = sci_get_current_position(sci);
        if (sci_get_char_at(sci, pos) == '<' &&
                sci_get_char_at(sci, pos + 1) == '/')
                return 0;

        if (sci_get_char_at(sci, end) == '>' &&
                sci_get_char_at(sci, end - 1) != '/')
        {
                gint style = sci_get_style_at(sci, end);

                if (style == SCE_H_TAG || style == SCE_H_TAGUNKNOWN)
                {
                        gint start = sci_get_position_from_line(sci, line);
                        gchar *line_contents = sci_get_contents_range(sci, start, end + 1);
                        gchar *opened_tag_name = utils_find_open_xml_tag(line_contents, end + 1 - start);

                        if (!EMPTY(opened_tag_name))
                        {
                                need_close = TRUE;
                                if (sci_get_lexer(sci) == SCLEX_HTML && utils_is_short_html_tag(opened_tag_name))
                                        need_close = FALSE;
                        }
                        g_free(line_contents);
                        g_free(opened_tag_name);
                }
        }

        return need_close ? 1 : 0;
}


static gint get_indent_size_after_line(GeanyEditor *editor, gint line)
{
        ScintillaObject *sci = editor->sci;
        gint size;
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);

        g_return_val_if_fail(line >= 0, 0);

        size = sci_get_line_indentation(sci, line);

        if (iprefs->auto_indent_mode > GEANY_AUTOINDENT_BASIC)
        {
                gint additional_indent = 0;

                if (lexer_has_braces(sci))
                        additional_indent = iprefs->width * get_brace_indent(sci, line);
                else if (sci_get_lexer(sci) == SCLEX_PYTHON) /* Python/Cython */
                        additional_indent = iprefs->width * get_python_indent(sci, line);

                /* HTML lexer "has braces" because of PHP and JavaScript.  If get_brace_indent() did not
                 * recommend us to insert additional indent, we are probably not in PHP/JavaScript chunk and
                 * should make the XML-related check */
                if (additional_indent == 0 &&
                        (sci_get_lexer(sci) == SCLEX_HTML ||
                        sci_get_lexer(sci) == SCLEX_XML) &&
                        editor->document->file_type->priv->xml_indent_tags)
                {
                        size += iprefs->width * get_xml_indent(sci, line);
                }

                size += additional_indent;
        }
        return size;
}


static void insert_indent_after_line(GeanyEditor *editor, gint line)
{
        ScintillaObject *sci = editor->sci;
        gint line_indent = sci_get_line_indentation(sci, line);
        gint size = get_indent_size_after_line(editor, line);
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);
        gchar *text;

        if (size == 0)
                return;

        if (iprefs->type == GEANY_INDENT_TYPE_TABS && size == line_indent)
        {
                /* support tab indents, space aligns style - copy last line 'indent' exactly */
                gint start = sci_get_position_from_line(sci, line);
                gint end = sci_get_line_indent_position(sci, line);

                text = sci_get_contents_range(sci, start, end);
        }
        else
        {
                text = get_whitespace(iprefs, size);
        }
        sci_add_text(sci, text);
        g_free(text);
}


static void auto_close_chars(ScintillaObject *sci, gint pos, gchar c)
{
        const gchar *closing_char = NULL;
        gint end_pos = -1;

        if (utils_isbrace(c, 0))
                end_pos = sci_find_matching_brace(sci, pos - 1);

        switch (c)
        {
                case '(':
                        if ((editor_prefs.autoclose_chars & GEANY_AC_PARENTHESIS) && end_pos == -1)
                                closing_char = ")";
                        break;
                case '{':
                        if ((editor_prefs.autoclose_chars & GEANY_AC_CBRACKET) && end_pos == -1)
                                closing_char = "}";
                        break;
                case '[':
                        if ((editor_prefs.autoclose_chars & GEANY_AC_SBRACKET) && end_pos == -1)
                                closing_char = "]";
                        break;
                case '\'':
                        if (editor_prefs.autoclose_chars & GEANY_AC_SQUOTE)
                                closing_char = "'";
                        break;
                case '"':
                        if (editor_prefs.autoclose_chars & GEANY_AC_DQUOTE)
                                closing_char = "\"";
                        break;
        }

        if (closing_char != NULL)
        {
                sci_add_text(sci, closing_char);
                sci_set_current_position(sci, pos, TRUE);
        }
}


/* Finds a corresponding matching brace to the given pos
 * (this is taken from Scintilla Editor.cxx,
 * fit to work with close_block) */
static gint brace_match(ScintillaObject *sci, gint pos)
{
        gchar chBrace = sci_get_char_at(sci, pos);
        gchar chSeek = utils_brace_opposite(chBrace);
        gchar chAtPos;
        gint direction = -1;
        gint styBrace;
        gint depth = 1;
        gint styAtPos;

        /* Hack: we need the style at @p pos but it isn't computed yet, so force styling
         * of this very position */
        sci_colourise(sci, pos, pos + 1);

        styBrace = sci_get_style_at(sci, pos);

        if (utils_is_opening_brace(chBrace, editor_prefs.brace_match_ltgt))
                direction = 1;

        pos += direction;
        while ((pos >= 0) && (pos < sci_get_length(sci)))
        {
                chAtPos = sci_get_char_at(sci, pos);
                styAtPos = sci_get_style_at(sci, pos);

                if ((pos > sci_get_end_styled(sci)) || (styAtPos == styBrace))
                {
                        if (chAtPos == chBrace)
                                depth++;
                        if (chAtPos == chSeek)
                                depth--;
                        if (depth == 0)
                                return pos;
                }
                pos += direction;
        }
        return -1;
}


/* Called after typing '}'. */
static void close_block(GeanyEditor *editor, gint pos)
{
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);
        gint x = 0, cnt = 0;
        gint line, line_len;
        gchar *line_buf;
        ScintillaObject *sci;
        gint line_indent, last_indent;

        if (iprefs->auto_indent_mode < GEANY_AUTOINDENT_CURRENTCHARS)
                return;
        g_return_if_fail(editor != NULL && editor->document->file_type != NULL);

        sci = editor->sci;

        if (! lexer_has_braces(sci))
                return;

        line = sci_get_line_from_position(sci, pos);
        line_len = sci_get_line_end_position(sci, line) - sci_get_position_from_line(sci, line);

        /* check that the line is empty, to not kill text in the line */
        line_buf = sci_get_line(sci, line);
        line_buf[line_len] = '\0';
        while (x < line_len)
        {
                if (isspace(line_buf[x]))
                        cnt++;
                x++;
        }
        g_free(line_buf);

        if ((line_len - 1) != cnt)
                return;

        if (iprefs->auto_indent_mode == GEANY_AUTOINDENT_MATCHBRACES)
        {
                gint start_brace = brace_match(sci, pos);

                if (start_brace >= 0)
                {
                        gint line_start;
                        gint brace_line = sci_get_line_from_position(sci, start_brace);
                        gint size = sci_get_line_indentation(sci, brace_line);
                        gchar *ind = get_whitespace(iprefs, size);
                        gchar *text = g_strconcat(ind, "}", NULL);

                        line_start = sci_get_position_from_line(sci, line);
                        sci_set_anchor(sci, line_start);
                        sci_replace_sel(sci, text);
                        g_free(text);
                        g_free(ind);
                        return;
                }
                /* fall through - unmatched brace (possibly because of TCL, PHP lexer bugs) */
        }

        /* GEANY_AUTOINDENT_CURRENTCHARS */
        line_indent = sci_get_line_indentation(sci, line);
        last_indent = sci_get_line_indentation(sci, line - 1);

        if (line_indent < last_indent)
                return;
        line_indent -= iprefs->width;
        line_indent = MAX(0, line_indent);
        sci_set_line_indentation(sci, line, line_indent);
}


/* checks whether @p c is an ASCII character (e.g. < 0x80) */
#define IS_ASCII(c) (((unsigned char)(c)) < 0x80)


/* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
 * position can be -1, then the current position is used.
 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
static void read_current_word(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen,
                const gchar *wc, gboolean stem)
{
        gint line, line_start, startword, endword;
        gchar *chunk;
        ScintillaObject *sci;

        g_return_if_fail(editor != NULL);
        sci = editor->sci;

        if (pos == -1)
                pos = sci_get_current_position(sci);

        line = sci_get_line_from_position(sci, pos);
        line_start = sci_get_position_from_line(sci, line);
        startword = pos - line_start;
        endword = pos - line_start;

        word[0] = '\0';
        chunk = sci_get_line(sci, line);

        if (wc == NULL)
                wc = GEANY_WORDCHARS;

        /* the checks for "c < 0" are to allow any Unicode character which should make the code
         * a little bit more Unicode safe, anyway, this allows also any Unicode punctuation,
         * TODO: improve this code */
        while (startword > 0 && (strchr(wc, chunk[startword - 1]) || ! IS_ASCII(chunk[startword - 1])))
                startword--;
        if (!stem)
        {
                while (chunk[endword] != 0 && (strchr(wc, chunk[endword]) || ! IS_ASCII(chunk[endword])))
                        endword++;
        }

        if (startword != endword)
        {
                chunk[endword] = '\0';

                g_strlcpy(word, chunk + startword, wordlen); /* ensure null terminated */
        }
        else
                g_strlcpy(word, "", wordlen);

        g_free(chunk);
}


/* Reads the word at given cursor position and writes it into the given buffer. The buffer will be
 * NULL terminated in any case, even when the word is truncated because wordlen is too small.
 * position can be -1, then the current position is used.
 * wc are the wordchars to use, if NULL, GEANY_WORDCHARS will be used */
void editor_find_current_word(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen,
                                                          const gchar *wc)
{
        read_current_word(editor, pos, word, wordlen, wc, FALSE);
}


/* Same as editor_find_current_word() but uses editor's word boundaries to decide what the word
 * is.  This should be used e.g. to get the word to search for */
void editor_find_current_word_sciwc(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen)
{
        gint start;
        gint end;

        g_return_if_fail(editor != NULL);

        if (pos == -1)
                pos = sci_get_current_position(editor->sci);

        start = sci_word_start_position(editor->sci, pos, TRUE);
        end = sci_word_end_position(editor->sci, pos, TRUE);

        if (start == end) /* caret in whitespaces sequence */
                *word = 0;
        else
        {
                if ((guint)(end - start) >= wordlen)
                        end = start + (wordlen - 1);
                sci_get_text_range(editor->sci, start, end, word);
        }
}


/**
 *  Finds the word at the position specified by @a pos. If any word is found, it is returned.
 *  Otherwise NULL is returned.
 *  Additional wordchars can be specified to define what to consider as a word.
 *
 *  @param editor The editor to operate on.
 *  @param pos The position where the word should be read from.
 *             May be @c -1 to use the current position.
 *  @param wordchars The wordchars to separate words. wordchars mean all characters to count
 *                   as part of a word. May be @c NULL to use the default wordchars,
 *                   see @ref GEANY_WORDCHARS.
 *
 *  @return @nullable A newly-allocated string containing the word at the given @a pos or @c NULL.
 *          Should be freed when no longer needed.
 *
 *  @since 0.16
 */
GEANY_API_SYMBOL
gchar *editor_get_word_at_pos(GeanyEditor *editor, gint pos, const gchar *wordchars)
{
        static gchar cword[GEANY_MAX_WORD_LENGTH];

        g_return_val_if_fail(editor != NULL, FALSE);

        read_current_word(editor, pos, cword, sizeof(cword), wordchars, FALSE);

        return (*cword == '\0') ? NULL : g_strdup(cword);
}


/* Read the word up to position @a pos. */
static const gchar *
editor_read_word_stem(GeanyEditor *editor, gint pos, const gchar *wordchars)
{
        static gchar word[GEANY_MAX_WORD_LENGTH];

        read_current_word(editor, pos, word, sizeof word, wordchars, TRUE);

        return (*word) ? word : NULL;
}


static gint find_previous_brace(ScintillaObject *sci, gint pos)
{
        gint orig_pos = pos;

        while (pos >= 0 && pos > orig_pos - 300)
        {
                gchar c = sci_get_char_at(sci, pos);
                if (utils_is_opening_brace(c, editor_prefs.brace_match_ltgt))
                        return pos;
                pos--;
        }
        return -1;
}


static gint find_start_bracket(ScintillaObject *sci, gint pos)
{
        gint brackets = 0;
        gint orig_pos = pos;

        while (pos > 0 && pos > orig_pos - 300)
        {
                gchar c = sci_get_char_at(sci, pos);

                if (c == ')') brackets++;
                else if (c == '(') brackets--;
                if (brackets < 0) return pos;   /* found start bracket */
                pos--;
        }
        return -1;
}


static gchar *find_calltip(const gchar *word, GeanyFiletype *ft)
{
        const gchar *constructor_method;
        GPtrArray *tags;
        TMTag *tag;
        GString *str = NULL;
        guint i;

        g_return_val_if_fail(ft && word && *word, NULL);

        /* use all types in case language uses wrong tag type e.g. python "members" instead of "methods" */
        tags = tm_workspace_find(word, NULL, tm_tag_max_t, NULL, ft->lang);
        if (tags->len == 0)
        {
                g_ptr_array_free(tags, TRUE);
                return NULL;
        }

        tag = TM_TAG(tags->pdata[0]);

        /* user typed e.g. 'a = Classname(' in Python so lookup __init__() arguments */
        constructor_method = tm_parser_get_constructor_method(tag->lang);
        if (constructor_method && (tag->type == tm_tag_class_t || tag->type == tm_tag_struct_t))
        {
                const TMTagType arg_types = tm_tag_function_t | tm_tag_prototype_t |
                        tm_tag_method_t | tm_tag_macro_with_arg_t;
                const gchar *scope_sep = tm_parser_scope_separator(ft->lang);
                gchar *scope = EMPTY(tag->scope) ? g_strdup(tag->name) :
                        g_strjoin(scope_sep, tag->scope, tag->name, NULL);

                g_ptr_array_free(tags, TRUE);
                tags = tm_workspace_find(constructor_method, scope, arg_types, NULL, ft->lang);
                g_free(scope);
                if (tags->len == 0)
                {
                        g_ptr_array_free(tags, TRUE);
                        return NULL;
                }
        }

        /* remove tags with no argument list */
        for (i = 0; i < tags->len; i++)
        {
                tag = TM_TAG(tags->pdata[i]);

                if (! tag->arglist)
                        tags->pdata[i] = NULL;
        }
        tm_tags_prune((GPtrArray *) tags);
        if (tags->len == 0)
        {
                g_ptr_array_free(tags, TRUE);
                return NULL;
        }
        else
        {       /* remove duplicate calltips */
                TMTagAttrType sort_attr[] = {tm_tag_attr_name_t, tm_tag_attr_scope_t,
                        tm_tag_attr_arglist_t, 0};

                tm_tags_sort((GPtrArray *) tags, sort_attr, TRUE, FALSE);
        }

        /* if the current word has changed since last time, start with the first tag match */
        if (! utils_str_equal(word, calltip.last_word))
                calltip.tag_index = 0;
        /* cache the current word for next time */
        g_free(calltip.last_word);
        calltip.last_word = g_strdup(word);
        calltip.tag_index = MIN(calltip.tag_index, tags->len - 1);      /* ensure tag_index is in range */

        for (i = calltip.tag_index; i < tags->len; i++)
        {
                tag = TM_TAG(tags->pdata[i]);

                if (str == NULL)
                {
                        gchar *f = tm_parser_format_function(tag->lang, tag->name,
                                tag->arglist, tag->var_type, tag->scope);
                        str = g_string_new(NULL);
                        if (calltip.tag_index > 0)
                                g_string_prepend(str, "\001 "); /* up arrow */
                        g_string_append(str, f);
                        g_free(f);
                }
                else /* add a down arrow */
                {
                        if (calltip.tag_index > 0)      /* already have an up arrow */
                                g_string_insert_c(str, 1, '\002');
                        else
                                g_string_prepend(str, "\002 ");
                        break;
                }
        }

        g_ptr_array_free(tags, TRUE);

        if (str)
        {
                gchar *result = str->str;

                g_string_free(str, FALSE);
                return result;
        }
        return NULL;
}


/* use pos = -1 to search for the previous unmatched open bracket. */
gboolean editor_show_calltip(GeanyEditor *editor, gint pos)
{
        gint orig_pos = pos; /* the position for the calltip */
        gint lexer;
        gint style;
        gchar word[GEANY_MAX_WORD_LENGTH];
        gchar *str;
        ScintillaObject *sci;

        g_return_val_if_fail(editor != NULL, FALSE);
        g_return_val_if_fail(editor->document->file_type != NULL, FALSE);

        sci = editor->sci;

        lexer = sci_get_lexer(sci);

        if (pos == -1)
        {
                /* position of '(' is unknown, so go backwards from current position to find it */
                pos = sci_get_current_position(sci);
                pos--;
                orig_pos = pos;
                pos = (lexer == SCLEX_LATEX) ? find_previous_brace(sci, pos) :
                        find_start_bracket(sci, pos);
                if (pos == -1)
                        return FALSE;
        }

        /* the style 1 before the brace (which may be highlighted) */
        style = sci_get_style_at(sci, pos - 1);
        if (! highlighting_is_code_style(lexer, style))
                return FALSE;

        while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                pos--;

        /* skip possible generic/template specification, like foo<int>() */
        if (sci_get_char_at(sci, pos - 1) == '>')
        {
                pos = sci_find_matching_brace(sci, pos - 1);
                if (pos == -1)
                        return FALSE;

                while (pos > 0 && isspace(sci_get_char_at(sci, pos - 1)))
                        pos--;
        }

        word[0] = '\0';
        editor_find_current_word(editor, pos - 1, word, sizeof word, NULL);
        if (word[0] == '\0')
                return FALSE;

        str = find_calltip(word, editor->document->file_type);
        if (str)
        {
                g_free(calltip.text);   /* free the old calltip */
                calltip.text = str;
                calltip.pos = orig_pos;
                calltip.sci = sci;
                calltip.set = TRUE;
                utils_wrap_string(calltip.text, -1);
                SSM(sci, SCI_CALLTIPSHOW, orig_pos, (sptr_t) calltip.text);
                return TRUE;
        }
        return FALSE;
}


/* Current document & global tags autocompletion */
static gboolean
autocomplete_tags(GeanyEditor *editor, GeanyFiletype *ft, const gchar *root, gsize rootlen)
{
        GeanyDocument *doc = editor->document;
        const gchar *current_scope = NULL;
        guint current_line;
        GPtrArray *tags;
        gboolean found;

        g_return_val_if_fail(editor && doc, FALSE);

        symbols_get_current_function(doc, &current_scope);
        current_line = sci_get_current_line(editor->sci) + 1;

        tags = tm_workspace_find_prefix(root, doc->tm_file, current_line, current_scope,
                editor_prefs.autocompletion_max_entries);
        found = tags->len > 0;
        if (found)
                show_tags_list(editor, tags, rootlen);
        g_ptr_array_free(tags, TRUE);

        return found;
}


static gboolean autocomplete_check_html(GeanyEditor *editor, gint style, gint pos)
{
        GeanyFiletype *ft = editor->document->file_type;
        gboolean try = FALSE;

        /* use entity completion when style is not JavaScript, ASP, Python, PHP, ...
         * (everything after SCE_HJ_START is for embedded scripting languages) */
        if (ft->id == GEANY_FILETYPES_HTML && style < SCE_HJ_START)
                try = TRUE;
        else if (sci_get_lexer(editor->sci) == SCLEX_XML && style < SCE_HJ_START)
                try = TRUE;
        else if (ft->id == GEANY_FILETYPES_PHP)
        {
                /* use entity completion when style is outside of PHP styles */
                if (! is_style_php(style))
                        try = TRUE;
        }
        if (try)
        {
                gchar root[GEANY_MAX_WORD_LENGTH];
                gchar *tmp;

                read_current_word(editor, pos, root, sizeof(root), GEANY_WORDCHARS"&", TRUE);

                /* Allow something like "&quot;some text&quot;".
                 * for entity completion we want to have completion for '&' within words. */
                tmp = strchr(root, '&');
                if (tmp != NULL)
                {
                        return autocomplete_tags(editor, filetypes_index(GEANY_FILETYPES_HTML), tmp, strlen(tmp));
                }
        }
        return FALSE;
}


/* Algorithm based on based on Scite's StartAutoCompleteWord()
 * @returns a sorted list of words matching @p root */
static GSList *get_doc_words(ScintillaObject *sci, gchar *root, gsize rootlen)
{
        gchar *word;
        gint len, current, word_end;
        gint pos_find, flags;
        guint word_length;
        gsize nmatches = 0;
        GSList *words = NULL;
        struct Sci_TextToFind ttf;

        len = sci_get_length(sci);
        current = sci_get_current_position(sci) - rootlen;

        ttf.lpstrText = root;
        ttf.chrg.cpMin = 0;
        ttf.chrg.cpMax = len;
        ttf.chrgText.cpMin = 0;
        ttf.chrgText.cpMax = 0;
        flags = SCFIND_WORDSTART | SCFIND_MATCHCASE;

        /* search the whole document for the word root and collect results */
        pos_find = SSM(sci, SCI_FINDTEXT, flags, (uptr_t) &ttf);
        while (pos_find >= 0 && pos_find < len)
        {
                word_end = pos_find + rootlen;
                if (pos_find != current)
                {
                        word_end = sci_word_end_position(sci, word_end, TRUE);

                        word_length = word_end - pos_find;
                        if (word_length > rootlen)
                        {
                                word = sci_get_contents_range(sci, pos_find, word_end);
                                /* search whether we already have the word in, otherwise add it */
                                if (g_slist_find_custom(words, word, (GCompareFunc)strcmp) != NULL)
                                        g_free(word);
                                else
                                {
                                        words = g_slist_prepend(words, word);
                                        nmatches++;
                                }

                                if (nmatches == editor_prefs.autocompletion_max_entries)
                                        break;
                        }
                }
                ttf.chrg.cpMin = word_end;
                pos_find = SSM(sci, SCI_FINDTEXT, flags, (uptr_t) &ttf);
        }

        return g_slist_sort(words, (GCompareFunc)utils_str_casecmp);
}


static gboolean autocomplete_doc_word(GeanyEditor *editor, gchar *root, gsize rootlen)
{
        ScintillaObject *sci = editor->sci;
        GSList *words, *node;
        GString *str;
        guint n_words = 0;

        words = get_doc_words(sci, root, rootlen);
        if (!words)
        {
                SSM(sci, SCI_AUTOCCANCEL, 0, 0);
                return FALSE;
        }

        str = g_string_sized_new(rootlen * 2 * 10);
        foreach_slist(node, words)
        {
                g_string_append(str, node->data);
                g_free(node->data);
                if (node->next)
                        g_string_append_c(str, '\n');
                n_words++;
        }
        if (n_words >= editor_prefs.autocompletion_max_entries)
                g_string_append(str, "\n...");

        g_slist_free(words);

        show_autocomplete(sci, rootlen, str);
        g_string_free(str, TRUE);
        return TRUE;
}


gboolean editor_start_auto_complete(GeanyEditor *editor, gint pos, gboolean force)
{
        gint rootlen, lexer, style;
        gchar *root;
        gchar cword[GEANY_MAX_WORD_LENGTH];
        ScintillaObject *sci;
        gboolean ret = FALSE;
        const gchar *wordchars;
        GeanyFiletype *ft;

        g_return_val_if_fail(editor != NULL, FALSE);

        if (! editor_prefs.auto_complete_symbols && ! force)
                return FALSE;

        /* If we are at the beginning of the document, we skip autocompletion as we can't determine the
         * necessary styling information */
        if (G_UNLIKELY(pos < 2))
                return FALSE;

        sci = editor->sci;
        ft = editor->document->file_type;

        lexer = sci_get_lexer(sci);
        style = sci_get_style_at(sci, pos - 2);

        /* don't autocomplete in comments and strings */
        if (!force && !highlighting_is_code_style(lexer, style))
                return FALSE;

        ret = autocomplete_check_html(editor, style, pos);

        if (ft->id == GEANY_FILETYPES_LATEX)
                wordchars = GEANY_WORDCHARS"\\"; /* add \ to word chars if we are in a LaTeX file */
        else if (ft->id == GEANY_FILETYPES_CSS)
                wordchars = GEANY_WORDCHARS"-"; /* add - because they are part of property names */
        else
                wordchars = GEANY_WORDCHARS;

        read_current_word(editor, pos, cword, sizeof(cword), wordchars, TRUE);
        root = cword;
        rootlen = strlen(root);

        if (ret || force)
        {
                if (autocomplete_scope_shown)
                {
                        autocomplete_scope_shown = FALSE;
                        if (!ret)
                                sci_send_command(sci, SCI_AUTOCCANCEL);
                }
        }
        else
        {
                ret = autocomplete_scope(editor, root, rootlen);
                if (!ret && autocomplete_scope_shown)
                        sci_send_command(sci, SCI_AUTOCCANCEL);
                autocomplete_scope_shown = ret;
        }

        if (!ret && rootlen > 0)
        {
                if (ft->id == GEANY_FILETYPES_PHP && style == SCE_HPHP_DEFAULT &&
                        rootlen == 3 && strcmp(root, "php") == 0 && pos >= 5 &&
                        sci_get_char_at(sci, pos - 5) == '<' &&
                        sci_get_char_at(sci, pos - 4) == '?')
                {
                        /* nothing, don't complete PHP open tags */
                }
                else
                {
                        /* force is set when called by keyboard shortcut, otherwise start at the
                         * editor_prefs.symbolcompletion_min_chars'th char */
                        if (force || rootlen >= editor_prefs.symbolcompletion_min_chars)
                        {
                                /* complete tags, except if forcing when completion is already visible */
                                if (!(force && SSM(sci, SCI_AUTOCACTIVE, 0, 0)))
                                        ret = autocomplete_tags(editor, editor->document->file_type, root, rootlen);

                                /* If forcing and there's nothing else to show, complete from words in document */
                                if (!ret && (force || editor_prefs.autocomplete_doc_words))
                                        ret = autocomplete_doc_word(editor, root, rootlen);
                        }
                }
        }
        if (!ret && force)
                utils_beep();

        return ret;
}


static const gchar *snippets_find_completion_by_name(const gchar *type, const gchar *name)
{
        gchar *result = NULL;
        GHashTable *tmp;

        g_return_val_if_fail(type != NULL && name != NULL, NULL);

        tmp = g_hash_table_lookup(snippet_hash, type);
        if (tmp != NULL)
        {
                result = g_hash_table_lookup(tmp, name);
        }
        /* whether nothing is set for the current filetype(tmp is NULL) or
         * the particular completion for this filetype is not set (result is NULL) */
        if (tmp == NULL || result == NULL)
        {
                tmp = g_hash_table_lookup(snippet_hash, "Default");
                if (tmp != NULL)
                {
                        result = g_hash_table_lookup(tmp, name);
                }
        }
        /* if result is still NULL here, no completion could be found */

        /* result is owned by the hash table and will be freed when the table will destroyed */
        return result;
}


static void snippets_replace_specials(gpointer key, gpointer value, gpointer user_data)
{
        gchar *needle;
        GString *pattern = user_data;

        g_return_if_fail(key != NULL);
        g_return_if_fail(value != NULL);

        needle = g_strconcat("%", (gchar*) key, "%", NULL);

        utils_string_replace_all(pattern, needle, (gchar*) value);
        g_free(needle);
}


static void fix_indentation(GeanyEditor *editor, GString *buf)
{
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);
        gchar *whitespace;
        GRegex *regex;
        gint cflags = G_REGEX_MULTILINE;

        /* transform leading tabs into indent widths (in spaces) */
        whitespace = g_strnfill(iprefs->width, ' ');
        regex = g_regex_new("^ *(\t)", cflags, 0, NULL);
        while (utils_string_regex_replace_all(buf, regex, 1, whitespace, TRUE));
        g_regex_unref(regex);

        /* remaining tabs are for alignment */
        if (iprefs->type != GEANY_INDENT_TYPE_TABS)
                utils_string_replace_all(buf, "\t", whitespace);

        /* use leading tabs */
        if (iprefs->type != GEANY_INDENT_TYPE_SPACES)
        {
                gchar *str;

                /* for tabs+spaces mode we want the real tab width, not indent width */
                SETPTR(whitespace, g_strnfill(sci_get_tab_width(editor->sci), ' '));
                str = g_strdup_printf("^\t*(%s)", whitespace);

                regex = g_regex_new(str, cflags, 0, NULL);
                while (utils_string_regex_replace_all(buf, regex, 1, "\t", TRUE));
                g_regex_unref(regex);
                g_free(str);
        }
        g_free(whitespace);
}


typedef struct
{
        Sci_Position start, len;
} SelectionRange;


#define CURSOR_PLACEHOLDER "_" /* Would rather use … but not all docs are unicode */


/* Replaces the internal cursor markers with the placeholder suitable for
 * display. Except for the first cursor if indicator_for_first is FALSE,
 * which is simply deleted.
 *
 * Returns insertion points as SelectionRange list, so that the caller
 * can use the positions (currently for indicators). */
static GSList *replace_cursor_markers(GeanyEditor *editor, GString *template,
                                                                          gboolean indicator_for_first)
{
        gint i = 0;
        GSList *temp_list = NULL;
        gint cursor_steps = 0;
        SelectionRange *sel;

        while (TRUE)
        {
                cursor_steps = utils_string_find(template, cursor_steps, -1, geany_cursor_marker);
                if (cursor_steps == -1)
                        break;

                sel = g_new0(SelectionRange, 1);
                sel->start = cursor_steps;
                g_string_erase(template, cursor_steps, strlen(geany_cursor_marker));
                if (i > 0 || indicator_for_first)
                {
                        g_string_insert(template, cursor_steps, CURSOR_PLACEHOLDER);
                        sel->len = sizeof(CURSOR_PLACEHOLDER) - 1;
                }
                i += 1;
                temp_list = g_slist_append(temp_list, sel);
        }

        return temp_list;
}


/** Inserts text, replacing \\t tab chars (@c 0x9) and \\n newline chars (@c 0xA)
 * accordingly for the document.
 * - Leading tabs are replaced with the correct indentation.
 * - Non-leading tabs are replaced with spaces (except when using 'Tabs' indent type).
 * - Newline chars are replaced with the correct line ending string.
 * This is very useful for inserting code without having to handle the indent
 * type yourself (Tabs & Spaces mode can be tricky).
 * @param editor Editor.
 * @param text Intended as e.g. @c "if (foo)\n\tbar();".
 * @param insert_pos Document position to insert text at.
 * @param cursor_index If >= 0, the index into @a text to place the cursor.
 * @param newline_indent_size Indentation size (in spaces) to insert for each newline; use
 * -1 to read the indent size from the line with @a insert_pos on it.
 * @param replace_newlines Whether to replace newlines. If
 * newlines have been replaced already, this should be false, to avoid errors e.g. on Windows.
 * @warning Make sure all \\t tab chars in @a text are intended as indent widths or alignment,
 * not hard tabs, as those won't be preserved.
 * @note This doesn't scroll the cursor in view afterwards. **/
GEANY_API_SYMBOL
void editor_insert_text_block(GeanyEditor *editor, const gchar *text, gint insert_pos,
                gint cursor_index, gint newline_indent_size, gboolean replace_newlines)
{
        ScintillaObject *sci = editor->sci;
        gint line_start = sci_get_line_from_position(sci, insert_pos);
        GString *buf;
        const gchar *eol = editor_get_eol_char(editor);
        GSList *jump_locs, *item;

        g_return_if_fail(text);
        g_return_if_fail(editor != NULL);
        g_return_if_fail(insert_pos >= 0);

        buf = g_string_new(text);

        if (cursor_index >= 0)
                g_string_insert(buf, cursor_index, geany_cursor_marker);        /* remember cursor pos */

        if (newline_indent_size == -1)
        {
                /* count indent size up to insert_pos instead of asking sci
                 * because there may be spaces after it */
                gchar *tmp = sci_get_line(sci, line_start);
                gint idx;

                idx = insert_pos - sci_get_position_from_line(sci, line_start);
                tmp[idx] = '\0';
                newline_indent_size = count_indent_size(editor, tmp);
                g_free(tmp);
        }

        /* Add line indents (in spaces) */
        if (newline_indent_size > 0)
        {
                const gchar *nl = replace_newlines ? "\n" : eol;
                gchar *whitespace;

                whitespace = g_strnfill(newline_indent_size, ' ');
                SETPTR(whitespace, g_strconcat(nl, whitespace, NULL));
                utils_string_replace_all(buf, nl, whitespace);
                g_free(whitespace);
        }

        /* transform line endings */
        if (replace_newlines)
                utils_string_replace_all(buf, "\n", eol);

        fix_indentation(editor, buf);

        jump_locs = replace_cursor_markers(editor, buf, cursor_index < 0);
        sci_insert_text(sci, insert_pos, buf->str);

        foreach_list(item, jump_locs)
        {
                SelectionRange *sel = item->data;
                gint start = insert_pos + sel->start;
                gint end = start + sel->len;
                editor_indicator_set_on_range(editor, GEANY_INDICATOR_SNIPPET, start, end);
                /* jump to first cursor position initially */
                if (item == jump_locs)
                        sci_set_selection(sci, start, end);
        }

        /* Set cursor to the requested index, or by default to after the snippet */
        if (cursor_index >= 0)
                sci_set_current_position(sci, insert_pos + cursor_index, FALSE);
        else if (jump_locs == NULL)
                sci_set_current_position(sci, insert_pos + buf->len, FALSE);

        g_slist_free_full(jump_locs, g_free);
        g_string_free(buf, TRUE);
}


static gboolean find_next_snippet_indicator(GeanyEditor *editor, SelectionRange *sel)
{
        ScintillaObject *sci = editor->sci;
        gint pos = sci_get_current_position(sci);

        if (pos == sci_get_length(sci))
                return FALSE; /* EOF */

        /* Rewind the cursor a bit if we're in the middle (or start) of an indicator,
         * and treat that as the next indicator. */
        while (SSM(sci, SCI_INDICATORVALUEAT, GEANY_INDICATOR_SNIPPET, pos) && pos > 0)
                pos -= 1;

        /* Be careful at the beginning of the file */
        if (SSM(sci, SCI_INDICATORVALUEAT, GEANY_INDICATOR_SNIPPET, pos))
                sel->start = pos;
        else
                sel->start = SSM(sci, SCI_INDICATOREND, GEANY_INDICATOR_SNIPPET, pos);
        sel->len = SSM(sci, SCI_INDICATOREND, GEANY_INDICATOR_SNIPPET, sel->start) - sel->start;

        /* 0 if there is no remaining cursor */
        return sel->len > 0;
}


/* Move the cursor to the next specified cursor position in an inserted snippet.
 * Can, and should, be optimized to give better results */
gboolean editor_goto_next_snippet_cursor(GeanyEditor *editor)
{
        ScintillaObject *sci = editor->sci;
        SelectionRange sel;

        if (find_next_snippet_indicator(editor, &sel))
        {
                sci_indicator_set(sci, GEANY_INDICATOR_SNIPPET);
                sci_set_selection(sci, sel.start, sel.start + sel.len);
                return TRUE;
        }
        else
        {
                return FALSE;
        }
}


static void snippets_make_replacements(GeanyEditor *editor, GString *pattern)
{
        GHashTable *specials;

        /* replace 'special' completions */
        specials = g_hash_table_lookup(snippet_hash, "Special");
        if (G_LIKELY(specials != NULL))
        {
                g_hash_table_foreach(specials, snippets_replace_specials, pattern);
        }

        /* now transform other wildcards */
        utils_string_replace_all(pattern, "%newline%", "\n");
        utils_string_replace_all(pattern, "%ws%", "\t");

        /* replace %cursor% by a very unlikely string marker */
        utils_string_replace_all(pattern, "%cursor%", geany_cursor_marker);

        /* unescape '%' after all %wildcards% */
        templates_replace_valist(pattern, "{pc}", "%", NULL);

        /* replace any template {foo} wildcards */
        templates_replace_common(pattern, editor->document->file_name, editor->document->file_type, NULL);
}


static gboolean snippets_complete_constructs(GeanyEditor *editor, gint pos, const gchar *word)
{
        ScintillaObject *sci = editor->sci;
        gchar *str;
        const gchar *completion;
        gint str_len;
        gint ft_id = editor->document->file_type->id;

        str = g_strdup(word);
        g_strstrip(str);

        completion = snippets_find_completion_by_name(filetypes[ft_id]->name, str);
        if (completion == NULL)
        {
                g_free(str);
                return FALSE;
        }

        /* remove the typed word, it will be added again by the used auto completion
         * (not really necessary but this makes the auto completion more flexible,
         *  e.g. with a completion like hi=hello, so typing "hi<TAB>" will result in "hello") */
        str_len = strlen(str);
        sci_set_selection_start(sci, pos - str_len);
        sci_set_selection_end(sci, pos);
        sci_replace_sel(sci, "");
        pos -= str_len; /* pos has changed while deleting */

        editor_insert_snippet(editor, pos, completion);
        sci_scroll_caret(sci);

        g_free(str);
        return TRUE;
}


static gboolean at_eol(ScintillaObject *sci, gint pos)
{
        gint line = sci_get_line_from_position(sci, pos);
        gchar c;

        /* skip any trailing spaces */
        while (TRUE)
        {
                c = sci_get_char_at(sci, pos);
                if (c == ' ' || c == '\t')
                        pos++;
                else
                        break;
        }

        return (pos == sci_get_line_end_position(sci, line));
}


gboolean editor_complete_snippet(GeanyEditor *editor, gint pos)
{
        gboolean result = FALSE;
        const gchar *wc;
        const gchar *word;
        ScintillaObject *sci;

        g_return_val_if_fail(editor != NULL, FALSE);

        sci = editor->sci;
        if (sci_has_selection(sci))
                return FALSE;
        /* return if we are editing an existing line (chars on right of cursor) */
        if (keybindings_lookup_item(GEANY_KEY_GROUP_EDITOR,
                        GEANY_KEYS_EDITOR_COMPLETESNIPPET)->key == GDK_KEY_space &&
                ! editor_prefs.complete_snippets_whilst_editing && ! at_eol(sci, pos))
                return FALSE;

        wc = snippets_find_completion_by_name("Special", "wordchars");
        word = editor_read_word_stem(editor, pos, wc);

        /* prevent completion of "for " */
        if (!EMPTY(word) &&
                ! isspace(sci_get_char_at(sci, pos - 1))) /* pos points to the line end char so use pos -1 */
        {
                sci_start_undo_action(sci);     /* needed because we insert a space separately from construct */
                result = snippets_complete_constructs(editor, pos, word);
                sci_end_undo_action(sci);
                if (result)
                        sci_cancel(sci);        /* cancel any autocompletion list, etc */
        }
        return result;
}


static void insert_closing_tag(GeanyEditor *editor, gint pos, gchar ch, const gchar *tag_name)
{
        ScintillaObject *sci = editor->sci;
        gchar *to_insert = NULL;

        if (ch == '/')
        {
                const gchar *gt = ">";
                /* if there is already a '>' behind the cursor, don't add it */
                if (sci_get_char_at(sci, pos) == '>')
                        gt = "";

                to_insert = g_strconcat(tag_name, gt, NULL);
        }
        else
                to_insert = g_strconcat("</", tag_name, ">", NULL);

        sci_start_undo_action(sci);
        sci_replace_sel(sci, to_insert);
        if (ch == '>')
                sci_set_selection(sci, pos, pos);
        sci_end_undo_action(sci);
        g_free(to_insert);
}


/*
 * (stolen from anjuta and heavily modified)
 * This routine will auto complete XML or HTML tags that are still open by closing them
 * @param ch The character we are dealing with, currently only works with the '>' character
 * @return True if handled, false otherwise
 */
static gboolean handle_xml(GeanyEditor *editor, gint pos, gchar ch)
{
        ScintillaObject *sci = editor->sci;
        gint lexer = sci_get_lexer(sci);
        gint min, size, style;
        gchar *str_found, sel[512];
        gboolean result = FALSE;

        /* If the user has turned us off, quit now.
         * This may make sense only in certain languages */
        if (! editor_prefs.auto_close_xml_tags || (lexer != SCLEX_HTML && lexer != SCLEX_XML))
                return FALSE;

        /* return if we are inside any embedded script */
        style = sci_get_style_at(sci, pos);
        if (style > SCE_H_XCCOMMENT && ! highlighting_is_string_style(lexer, style))
                return FALSE;

        /* if ch is /, check for </, else quit */
        if (ch == '/' && sci_get_char_at(sci, pos - 2) != '<')
                return FALSE;

        /* Grab the last 512 characters or so */
        min = pos - (sizeof(sel) - 1);
        if (min < 0) min = 0;

        if (pos - min < 3)
                return FALSE; /* Smallest tag is 3 characters e.g. <p> */

        sci_get_text_range(sci, min, pos, sel);
        sel[sizeof(sel) - 1] = '\0';

        if (ch == '>' && sel[pos - min - 2] == '/')
                /* User typed something like "<br/>" */
                return FALSE;

        size = pos - min;
        if (ch == '/')
                size -= 2; /* skip </ */
        str_found = utils_find_open_xml_tag(sel, size);

        if (lexer == SCLEX_HTML && utils_is_short_html_tag(str_found))
        {
                /* ignore tag */
        }
        else if (!EMPTY(str_found))
        {
                insert_closing_tag(editor, pos, ch, str_found);
                result = TRUE;
        }
        g_free(str_found);
        return result;
}


/* like sci_get_line_indentation(), but for a string. */
static gsize count_indent_size(GeanyEditor *editor, const gchar *base_indent)
{
        const gchar *ptr;
        gsize tab_size = sci_get_tab_width(editor->sci);
        gsize count = 0;

        g_return_val_if_fail(base_indent, 0);

        for (ptr = base_indent; *ptr != 0; ptr++)
        {
                switch (*ptr)
                {
                        case ' ':
                                count++;
                                break;
                        case '\t':
                                count += tab_size;
                                break;
                        default:
                                return count;
                }
        }
        return count;
}


/* Handles special cases where HTML is embedded in another language or
 * another language is embedded in HTML */
static GeanyFiletype *editor_get_filetype_at_line(GeanyEditor *editor, gint line)
{
        gint style, line_start;
        GeanyFiletype *current_ft;

        g_return_val_if_fail(editor != NULL, NULL);
        g_return_val_if_fail(editor->document->file_type != NULL, NULL);

        current_ft = editor->document->file_type;
        line_start = sci_get_position_from_line(editor->sci, line);
        style = sci_get_style_at(editor->sci, line_start);

        /* Handle PHP filetype with embedded HTML */
        if (current_ft->id == GEANY_FILETYPES_PHP && ! is_style_php(style))
                current_ft = filetypes[GEANY_FILETYPES_HTML];

        /* Handle languages embedded in HTML */
        if (current_ft->id == GEANY_FILETYPES_HTML)
        {
                /* Embedded JS */
                if (style >= SCE_HJ_DEFAULT && style <= SCE_HJ_REGEX)
                        current_ft = filetypes[GEANY_FILETYPES_JS];
                /* ASP JS */
                else if (style >= SCE_HJA_DEFAULT && style <= SCE_HJA_REGEX)
                        current_ft = filetypes[GEANY_FILETYPES_JS];
                /* Embedded VB */
                else if (style >= SCE_HB_DEFAULT && style <= SCE_HB_STRINGEOL)
                        current_ft = filetypes[GEANY_FILETYPES_BASIC];
                /* ASP VB */
                else if (style >= SCE_HBA_DEFAULT && style <= SCE_HBA_STRINGEOL)
                        current_ft = filetypes[GEANY_FILETYPES_BASIC];
                /* Embedded Python */
                else if (style >= SCE_HP_DEFAULT && style <= SCE_HP_IDENTIFIER)
                        current_ft = filetypes[GEANY_FILETYPES_PYTHON];
                /* ASP Python */
                else if (style >= SCE_HPA_DEFAULT && style <= SCE_HPA_IDENTIFIER)
                        current_ft = filetypes[GEANY_FILETYPES_PYTHON];
                /* Embedded PHP */
                else if ((style >= SCE_HPHP_DEFAULT && style <= SCE_HPHP_OPERATOR) ||
                        style == SCE_HPHP_COMPLEX_VARIABLE)
                {
                        current_ft = filetypes[GEANY_FILETYPES_PHP];
                }
        }

        /* Ensure the filetype's config is loaded */
        filetypes_load_config(current_ft->id, FALSE);

        return current_ft;
}


static void real_comment_multiline(GeanyEditor *editor, gint line_start, gint last_line)
{
        const gchar *eol;
        gchar *str_begin, *str_end;
        const gchar *co, *cc;
        gint line_len;
        GeanyFiletype *ft;

        g_return_if_fail(editor != NULL && editor->document->file_type != NULL);

        ft = editor_get_filetype_at_line(editor, line_start);

        eol = editor_get_eol_char(editor);
        if (! filetype_get_comment_open_close(ft, FALSE, &co, &cc))
                g_return_if_reached();
        str_begin = g_strdup_printf("%s%s", (co != NULL) ? co : "", eol);
        str_end = g_strdup_printf("%s%s", (cc != NULL) ? cc : "", eol);

        /* insert the comment strings */
        sci_insert_text(editor->sci, line_start, str_begin);
        line_len = sci_get_position_from_line(editor->sci, last_line + 2);
        sci_insert_text(editor->sci, line_len, str_end);

        g_free(str_begin);
        g_free(str_end);
}


/* find @p text inside the range of the current style */
static gint find_in_current_style(ScintillaObject *sci, const gchar *text, gboolean backwards)
{
        gint start = sci_get_current_position(sci);
        gint end = start;
        gint len = sci_get_length(sci);
        gint current_style = sci_get_style_at(sci, start);
        struct Sci_TextToFind ttf;

        while (start > 0 && sci_get_style_at(sci, start - 1) == current_style)
                start -= 1;
        while (end < len && sci_get_style_at(sci, end + 1) == current_style)
                end += 1;

        ttf.lpstrText = (gchar*) text;
        ttf.chrg.cpMin = backwards ? end + 1 : start;
        ttf.chrg.cpMax = backwards ? start : end + 1;
        return sci_find_text(sci, 0, &ttf);
}


static void sci_delete_line(ScintillaObject *sci, gint line)
{
        gint start = sci_get_position_from_line(sci, line);
        gint len = sci_get_line_length(sci, line);
        SSM(sci, SCI_DELETERANGE, start, len);
}


static gboolean real_uncomment_multiline(GeanyEditor *editor)
{
        /* find the beginning of the multi line comment */
        gint start, end, start_line, end_line;
        GeanyFiletype *ft;
        const gchar *co, *cc;

        g_return_val_if_fail(editor != NULL && editor->document->file_type != NULL, FALSE);

        ft = editor_get_filetype_at_line(editor, sci_get_current_line(editor->sci));
        if (! filetype_get_comment_open_close(ft, FALSE, &co, &cc))
                g_return_val_if_reached(FALSE);

        start = find_in_current_style(editor->sci, co, TRUE);
        end = find_in_current_style(editor->sci, cc, FALSE);

        if (start < 0 || end < 0 || start > end /* who knows */)
                return FALSE;

        start_line = sci_get_line_from_position(editor->sci, start);
        end_line = sci_get_line_from_position(editor->sci, end);

        /* remove comment close chars */
        SSM(editor->sci, SCI_DELETERANGE, end, strlen(cc));
        if (sci_is_blank_line(editor->sci, end_line))
                sci_delete_line(editor->sci, end_line);

        /* remove comment open chars (do it last since it would move the end position) */
        SSM(editor->sci, SCI_DELETERANGE, start, strlen(co));
        if (sci_is_blank_line(editor->sci, start_line))
                sci_delete_line(editor->sci, start_line);

        return TRUE;
}


static gint get_multiline_comment_style(GeanyEditor *editor, gint line_start)
{
        gint lexer = sci_get_lexer(editor->sci);
        gint style_comment;

        /* List only those lexers which support multi line comments */
        switch (lexer)
        {
                case SCLEX_XML:
                case SCLEX_HTML:
                case SCLEX_PHPSCRIPT:
                {
                        if (is_style_php(sci_get_style_at(editor->sci, line_start)))
                                style_comment = SCE_HPHP_COMMENT;
                        else
                                style_comment = SCE_H_COMMENT;
                        break;
                }
                case SCLEX_HASKELL:
                case SCLEX_LITERATEHASKELL:
                        style_comment = SCE_HA_COMMENTBLOCK; break;
                case SCLEX_LUA: style_comment = SCE_LUA_COMMENT; break;
                case SCLEX_CSS: style_comment = SCE_CSS_COMMENT; break;
                case SCLEX_SQL: style_comment = SCE_SQL_COMMENT; break;
                case SCLEX_CAML: style_comment = SCE_CAML_COMMENT; break;
                case SCLEX_D: style_comment = SCE_D_COMMENT; break;
                case SCLEX_PASCAL: style_comment = SCE_PAS_COMMENT; break;
                case SCLEX_RUST: style_comment = SCE_RUST_COMMENTBLOCK; break;
                default: style_comment = SCE_C_COMMENT;
        }

        return style_comment;
}


/* set toggle to TRUE if the caller is the toggle function, FALSE otherwise
 * returns the amount of uncommented single comment lines, in case of multi line uncomment
 * it returns just 1 */
gint editor_do_uncomment(GeanyEditor *editor, gint line, gboolean toggle)
{
        gint first_line, last_line;
        gint x, i, line_start, line_len;
        gint sel_start, sel_end;
        gint count = 0;
        gsize co_len;
        gchar sel[256];
        const gchar *co, *cc;
        gboolean single_line = FALSE;
        GeanyFiletype *ft;

        g_return_val_if_fail(editor != NULL && editor->document->file_type != NULL, 0);

        if (line < 0)
        {       /* use selection or current line */
                sel_start = sci_get_selection_start(editor->sci);
                sel_end = sci_get_selection_end(editor->sci);

                first_line = sci_get_line_from_position(editor->sci, sel_start);
                /* Find the last line with chars selected (not EOL char) */
                last_line = sci_get_line_from_position(editor->sci,
                        sel_end - editor_get_eol_char_len(editor));
                last_line = MAX(first_line, last_line);
        }
        else
        {
                first_line = last_line = line;
                sel_start = sel_end = sci_get_position_from_line(editor->sci, line);
        }

        ft = editor_get_filetype_at_line(editor, first_line);

        if (! filetype_get_comment_open_close(ft, TRUE, &co, &cc))
                return 0;

        co_len = strlen(co);
        if (co_len == 0)
                return 0;

        sci_start_undo_action(editor->sci);

        for (i = first_line; i <= last_line; i++)
        {
                gint buf_len;

                line_start = sci_get_position_from_line(editor->sci, i);
                line_len = sci_get_line_end_position(editor->sci, i) - line_start;
                x = 0;

                buf_len = MIN((gint)sizeof(sel) - 1, line_len);
                if (buf_len <= 0)
                        continue;
                sci_get_text_range(editor->sci, line_start, line_start + buf_len, sel);
                sel[buf_len] = '\0';

                while (isspace(sel[x])) x++;

                /* to skip blank lines */
                if (x < line_len && sel[x] != '\0')
                {
                        /* use single line comment */
                        if (EMPTY(cc))
                        {
                                single_line = TRUE;

                                if (toggle)
                                {
                                        gsize tm_len = strlen(editor_prefs.comment_toggle_mark);
                                        if (strncmp(sel + x, co, co_len) != 0 ||
                                                strncmp(sel + x + co_len, editor_prefs.comment_toggle_mark, tm_len) != 0)
                                                continue;

                                        co_len += tm_len;
                                }
                                else
                                {
                                        if (strncmp(sel + x, co, co_len) != 0)
                                                continue;
                                }

                                sci_set_selection(editor->sci, line_start + x, line_start + x + co_len);
                                sci_replace_sel(editor->sci, "");
                                count++;
                        }
                        /* use multi line comment */
                        else
                        {
                                gint style_comment;

                                /* skip lines which are already comments */
                                style_comment = get_multiline_comment_style(editor, line_start);
                                if (sci_get_style_at(editor->sci, line_start + x) == style_comment)
                                {
                                        if (real_uncomment_multiline(editor))
                                                count = 1;
                                }

                                /* break because we are already on the last line */
                                break;
                        }
                }
        }
        sci_end_undo_action(editor->sci);

        /* restore selection if there is one
         * but don't touch the selection if caller is editor_do_comment_toggle */
        if (! toggle && sel_start < sel_end)
        {
                if (single_line)
                {
                        sci_set_selection_start(editor->sci, sel_start - co_len);
                        sci_set_selection_end(editor->sci, sel_end - (count * co_len));
                }
                else
                {
                        gint eol_len = editor_get_eol_char_len(editor);
                        sci_set_selection_start(editor->sci, sel_start - co_len - eol_len);
                        sci_set_selection_end(editor->sci, sel_end - co_len - eol_len);
                }
        }

        return count;
}


void editor_do_comment_toggle(GeanyEditor *editor)
{
        gint first_line, last_line;
        gint x, i, line_start, line_len, first_line_start, last_line_start;
        gint sel_start, sel_end;
        gint count_commented = 0, count_uncommented = 0;
        gchar sel[256];
        const gchar *co, *cc;
        gboolean single_line = FALSE;
        gboolean first_line_was_comment = FALSE;
        gboolean last_line_was_comment = FALSE;
        gsize co_len;
        gsize tm_len = strlen(editor_prefs.comment_toggle_mark);
        GeanyFiletype *ft;

        g_return_if_fail(editor != NULL && editor->document->file_type != NULL);

        sel_start = sci_get_selection_start(editor->sci);
        sel_end = sci_get_selection_end(editor->sci);

        first_line = sci_get_line_from_position(editor->sci, sel_start);
        /* Find the last line with chars selected (not EOL char) */
        last_line = sci_get_line_from_position(editor->sci,
                sel_end - editor_get_eol_char_len(editor));
        last_line = MAX(first_line, last_line);

        first_line_start = sci_get_position_from_line(editor->sci, first_line);
        last_line_start = sci_get_position_from_line(editor->sci, last_line);

        ft = editor_get_filetype_at_line(editor, first_line);

        if (! filetype_get_comment_open_close(ft, TRUE, &co, &cc))
                return;

        co_len = strlen(co);
        if (co_len == 0)
                return;

        sci_start_undo_action(editor->sci);

        for (i = first_line; i <= last_line; i++)
        {
                gint buf_len;

                line_start = sci_get_position_from_line(editor->sci, i);
                line_len = sci_get_line_end_position(editor->sci, i) - line_start;
                x = 0;

                buf_len = MIN((gint)sizeof(sel) - 1, line_len);
                if (buf_len < 0)
                        continue;
                sci_get_text_range(editor->sci, line_start, line_start + buf_len, sel);
                sel[buf_len] = '\0';

                while (isspace(sel[x])) x++;

                /* use single line comment */
                if (EMPTY(cc))
                {
                        gboolean do_continue = FALSE;
                        single_line = TRUE;

                        if (strncmp(sel + x, co, co_len) == 0 &&
                                strncmp(sel + x + co_len, editor_prefs.comment_toggle_mark, tm_len) == 0)
                        {
                                do_continue = TRUE;
                        }

                        if (do_continue && i == first_line)
                                first_line_was_comment = TRUE;
                        last_line_was_comment = do_continue;

                        if (do_continue)
                        {
                                count_uncommented += editor_do_uncomment(editor, i, TRUE);
                                continue;
                        }

                        /* we are still here, so the above lines were not already comments, so comment it */
                        count_commented += editor_do_comment(editor, i, FALSE, TRUE, TRUE);
                }
                /* use multi line comment */
                else
                {
                        gint style_comment;

                        /* skip lines which are already comments */
                        style_comment = get_multiline_comment_style(editor, line_start);
                        if (sci_get_style_at(editor->sci, line_start + x) == style_comment)
                        {
                                if (real_uncomment_multiline(editor))
                                        count_uncommented++;
                        }
                        else
                        {
                                real_comment_multiline(editor, line_start, last_line);
                                count_commented++;
                        }

                        /* break because we are already on the last line */
                        break;
                }
        }

        sci_end_undo_action(editor->sci);

        co_len += tm_len;

        /* restore selection or caret position */
        if (single_line)
        {
                gint a = (first_line_was_comment) ? - (gint) co_len : (gint) co_len;
                gint indent_len;

                /* don't modify sel_start when the selection starts within indentation */
                read_indent(editor, sel_start);
                indent_len = (gint) strlen(indent);
                if ((sel_start - first_line_start) <= indent_len)
                        a = 0;
                /* if the selection start was inside the comment mark, adjust the position */
                else if (first_line_was_comment &&
                                 sel_start >= (first_line_start + indent_len) &&
                                 sel_start <= (first_line_start + indent_len + (gint) co_len))
                {
                        a = (first_line_start + indent_len) - sel_start;
                }

                if (sel_start < sel_end)
                {
                        gint b = (count_commented * (gint) co_len) - (count_uncommented * (gint) co_len);

                        /* same for selection end, but here we add an offset on the offset above */
                        read_indent(editor, sel_end + b);
                        indent_len = (gint) strlen(indent);
                        if ((sel_end - last_line_start) < indent_len)
                                b += last_line_was_comment ? (gint) co_len : -(gint) co_len;
                        else if (last_line_was_comment &&
                                         sel_end >= (last_line_start + indent_len) &&
                                         sel_end <= (last_line_start + indent_len + (gint) co_len))
                        {
                                b += (gint) co_len - (sel_end - (last_line_start + indent_len));
                        }

                        sci_set_selection_start(editor->sci, sel_start + a);
                        sci_set_selection_end(editor->sci, sel_end + b);
                }
                else
                        sci_set_current_position(editor->sci, sel_start + a, TRUE);
        }
        else
        {
                gint eol_len = editor_get_eol_char_len(editor);
                if (count_uncommented > 0)
                {
                        sci_set_selection_start(editor->sci, sel_start - (gint) co_len + eol_len);
                        sci_set_selection_end(editor->sci, sel_end - (gint) co_len + eol_len);
                }
                else if (count_commented > 0)
                {
                        sci_set_selection_start(editor->sci, sel_start + (gint) co_len - eol_len);
                        sci_set_selection_end(editor->sci, sel_end + (gint) co_len - eol_len);
                }
                if (sel_start >= sel_end)
                        sci_scroll_caret(editor->sci);
        }
}


/* set toggle to TRUE if the caller is the toggle function, FALSE otherwise */
gint editor_do_comment(GeanyEditor *editor, gint line, gboolean allow_empty_lines, gboolean toggle,
                gboolean single_comment)
{
        gint first_line, last_line;
        gint x, i, line_start, line_len;
        gint sel_start, sel_end, co_len;
        gint count = 0;
        gchar sel[256];
        const gchar *co, *cc;
        gboolean single_line = FALSE;
        GeanyFiletype *ft;

        g_return_val_if_fail(editor != NULL && editor->document->file_type != NULL, 0);

        if (line < 0)
        {       /* use selection or current line */
                sel_start = sci_get_selection_start(editor->sci);
                sel_end = sci_get_selection_end(editor->sci);

                first_line = sci_get_line_from_position(editor->sci, sel_start);
                /* Find the last line with chars selected (not EOL char) */
                last_line = sci_get_line_from_position(editor->sci,
                        sel_end - editor_get_eol_char_len(editor));
                last_line = MAX(first_line, last_line);
        }
        else
        {
                first_line = last_line = line;
                sel_start = sel_end = sci_get_position_from_line(editor->sci, line);
        }

        ft = editor_get_filetype_at_line(editor, first_line);

        if (! filetype_get_comment_open_close(ft, single_comment, &co, &cc))
                return 0;

        co_len = strlen(co);
        if (co_len == 0)
                return 0;

        sci_start_undo_action(editor->sci);

        for (i = first_line; i <= last_line; i++)
        {
                gint buf_len;

                line_start = sci_get_position_from_line(editor->sci, i);
                line_len = sci_get_line_end_position(editor->sci, i) - line_start;
                x = 0;

                buf_len = MIN((gint)sizeof(sel) - 1, line_len);
                if (buf_len < 0)
                        continue;
                sci_get_text_range(editor->sci, line_start, line_start + buf_len, sel);
                sel[buf_len] = '\0';

                while (isspace(sel[x])) x++;

                /* to skip blank lines */
                if (allow_empty_lines || (x < line_len && sel[x] != '\0'))
                {
                        /* use single line comment */
                        if (EMPTY(cc))
                        {
                                gint start = line_start;
                                single_line = TRUE;

                                if (ft->comment_use_indent)
                                        start = line_start + x;

                                if (toggle)
                                {
                                        gchar *text = g_strconcat(co, editor_prefs.comment_toggle_mark, NULL);
                                        sci_insert_text(editor->sci, start, text);
                                        g_free(text);
                                }
                                else
                                        sci_insert_text(editor->sci, start, co);
                                count++;
                        }
                        /* use multi line comment */
                        else
                        {
                                gint style_comment;

                                /* skip lines which are already comments */
                                style_comment = get_multiline_comment_style(editor, line_start);
                                if (sci_get_style_at(editor->sci, line_start + x) == style_comment)
                                        continue;

                                real_comment_multiline(editor, line_start, last_line);
                                count = 1;

                                /* break because we are already on the last line */
                                break;
                        }
                }
        }
        sci_end_undo_action(editor->sci);

        /* restore selection if there is one
         * but don't touch the selection if caller is editor_do_comment_toggle */
        if (! toggle && sel_start < sel_end)
        {
                if (single_line)
                {
                        sci_set_selection_start(editor->sci, sel_start + co_len);
                        sci_set_selection_end(editor->sci, sel_end + (count * co_len));
                }
                else
                {
                        gint eol_len = editor_get_eol_char_len(editor);
                        sci_set_selection_start(editor->sci, sel_start + co_len + eol_len);
                        sci_set_selection_end(editor->sci, sel_end + co_len + eol_len);
                }
        }
        return count;
}


static gboolean brace_timeout_active = FALSE;

static gboolean delay_match_brace(G_GNUC_UNUSED gpointer user_data)
{
        GeanyDocument *doc = document_get_current();
        GeanyEditor *editor;
        gint brace_pos = GPOINTER_TO_INT(user_data);
        gint end_pos, cur_pos;

        brace_timeout_active = FALSE;
        if (!doc)
                return FALSE;

        editor = doc->editor;
        cur_pos = sci_get_current_position(editor->sci) - 1;

        if (cur_pos != brace_pos)
        {
                cur_pos++;
                if (cur_pos != brace_pos)
                {
                        /* we have moved past the original brace_pos, but after the timeout
                         * we may now be on a new brace, so check again */
                        editor_highlight_braces(editor, cur_pos);
                        return FALSE;
                }
        }
        if (!utils_isbrace(sci_get_char_at(editor->sci, brace_pos), editor_prefs.brace_match_ltgt))
        {
                editor_highlight_braces(editor, cur_pos);
                return FALSE;
        }
        end_pos = sci_find_matching_brace(editor->sci, brace_pos);

        if (end_pos >= 0)
        {
                gint col = MIN(sci_get_col_from_position(editor->sci, brace_pos),
                        sci_get_col_from_position(editor->sci, end_pos));
                SSM(editor->sci, SCI_SETHIGHLIGHTGUIDE, col, 0);
                SSM(editor->sci, SCI_BRACEHIGHLIGHT, brace_pos, end_pos);
        }
        else
        {
                SSM(editor->sci, SCI_SETHIGHLIGHTGUIDE, 0, 0);
                SSM(editor->sci, SCI_BRACEBADLIGHT, brace_pos, 0);
        }
        return FALSE;
}


static void editor_highlight_braces(GeanyEditor *editor, gint cur_pos)
{
        gint brace_pos = cur_pos - 1;

        SSM(editor->sci, SCI_SETHIGHLIGHTGUIDE, 0, 0);
        SSM(editor->sci, SCI_BRACEBADLIGHT, (uptr_t)-1, 0);

        if (! utils_isbrace(sci_get_char_at(editor->sci, brace_pos), editor_prefs.brace_match_ltgt))
        {
                brace_pos++;
                if (! utils_isbrace(sci_get_char_at(editor->sci, brace_pos), editor_prefs.brace_match_ltgt))
                {
                        return;
                }
        }
        if (!brace_timeout_active)
        {
                brace_timeout_active = TRUE;
                /* delaying matching makes scrolling faster e.g. holding down arrow keys */
                g_timeout_add(100, delay_match_brace, GINT_TO_POINTER(brace_pos));
        }
}


static gboolean in_block_comment(gint lexer, gint style)
{
        switch (lexer)
        {
                case SCLEX_COBOL:
                case SCLEX_CPP:
                        return (style == SCE_C_COMMENT ||
                                style == SCE_C_COMMENTDOC);

                case SCLEX_PASCAL:
                        return (style == SCE_PAS_COMMENT ||
                                style == SCE_PAS_COMMENT2);

                case SCLEX_D:
                        return (style == SCE_D_COMMENT ||
                                style == SCE_D_COMMENTDOC ||
                                style == SCE_D_COMMENTNESTED);

                case SCLEX_HTML:
                case SCLEX_PHPSCRIPT:
                        return (style == SCE_HPHP_COMMENT);

                case SCLEX_CSS:
                        return (style == SCE_CSS_COMMENT);

                case SCLEX_RUST:
                        return (style == SCE_RUST_COMMENTBLOCK ||
                                style == SCE_RUST_COMMENTBLOCKDOC);

                default:
                        return FALSE;
        }
}


static gboolean is_comment_char(gchar c, gint lexer)
{
        if ((c == '*' || c == '+') && lexer == SCLEX_D)
                return TRUE;
        else
        if (c == '*')
                return TRUE;

        return FALSE;
}


static void auto_multiline(GeanyEditor *editor, gint cur_line)
{
        ScintillaObject *sci = editor->sci;
        gint indent_pos, style;
        gint lexer = sci_get_lexer(sci);

        /* Use the start of the line enter was pressed on, to avoid any doc keyword styles */
        indent_pos = sci_get_line_indent_position(sci, cur_line - 1);
        style = sci_get_style_at(sci, indent_pos);
        if (!in_block_comment(lexer, style))
                return;

        /* Check whether the comment block continues on this line */
        indent_pos = sci_get_line_indent_position(sci, cur_line);
        if (sci_get_style_at(sci, indent_pos) == style || indent_pos >= sci_get_length(sci))
        {
                gchar *previous_line = sci_get_line(sci, cur_line - 1);
                /* the type of comment, '*' (C/C++/Java), '+' and the others (D) */
                const gchar *continuation = "*";
                const gchar *whitespace = ""; /* to hold whitespace if needed */
                gchar *result;
                gint len = strlen(previous_line);
                gint i;

                /* find and stop at end of multi line comment */
                i = len - 1;
                while (i >= 0 && isspace(previous_line[i])) i--;
                if (i >= 1 && is_comment_char(previous_line[i - 1], lexer) && previous_line[i] == '/')
                {
                        gint indent_len, indent_width;

                        indent_pos = sci_get_line_indent_position(sci, cur_line);
                        indent_len = sci_get_col_from_position(sci, indent_pos);
                        indent_width = editor_get_indent_prefs(editor)->width;

                        /* if there is one too many spaces, delete the last space,
                         * to return to the indent used before the multiline comment was started. */
                        if (indent_len % indent_width == 1)
                                SSM(sci, SCI_DELETEBACKNOTLINE, 0, 0);  /* remove whitespace indent */
                        g_free(previous_line);
                        return;
                }
                /* check whether we are on the second line of multi line comment */
                i = 0;
                while (i < len && isspace(previous_line[i])) i++; /* get to start of the line */

                if (i + 1 < len &&
                        previous_line[i] == '/' && is_comment_char(previous_line[i + 1], lexer))
                { /* we are on the second line of a multi line comment, so we have to insert white space */
                        whitespace = " ";
                }

                if (style == SCE_D_COMMENTNESTED)
                        continuation = "+"; /* for nested comments in D */

                result = g_strconcat(whitespace, continuation, " ", NULL);
                sci_add_text(sci, result);
                g_free(result);

                g_free(previous_line);
        }
}


#if 0
static gboolean editor_lexer_is_c_like(gint lexer)
{
        switch (lexer)
        {
                case SCLEX_CPP:
                case SCLEX_D:
                return TRUE;

                default:
                return FALSE;
        }
}
#endif


/* inserts a three-line comment at one line above current cursor position */
void editor_insert_multiline_comment(GeanyEditor *editor)
{
        gchar *text;
        gint text_len;
        gint line;
        gint pos;
        gboolean have_multiline_comment = FALSE;
        GeanyDocument *doc;
        const gchar *co, *cc;

        g_return_if_fail(editor != NULL && editor->document->file_type != NULL);

        if (! filetype_get_comment_open_close(editor->document->file_type, FALSE, &co, &cc))
                g_return_if_reached();
        if (!EMPTY(cc))
                have_multiline_comment = TRUE;

        sci_start_undo_action(editor->sci);

        doc = editor->document;

        /* insert three lines one line above of the current position */
        line = sci_get_line_from_position(editor->sci, editor_info.click_pos);
        pos = sci_get_position_from_line(editor->sci, line);

        /* use the indent on the current line but only when comment indentation is used
         * and we don't have multi line comment characters */
        if (editor->auto_indent &&
                ! have_multiline_comment &&     doc->file_type->comment_use_indent)
        {
                read_indent(editor, editor_info.click_pos);
                text = g_strdup_printf("%s\n%s\n%s\n", indent, indent, indent);
                text_len = strlen(text);
        }
        else
        {
                text = g_strdup("\n\n\n");
                text_len = 3;
        }
        sci_insert_text(editor->sci, pos, text);
        g_free(text);

        /* select the inserted lines for commenting */
        sci_set_selection_start(editor->sci, pos);
        sci_set_selection_end(editor->sci, pos + text_len);

        editor_do_comment(editor, -1, TRUE, FALSE, FALSE);

        /* set the current position to the start of the first inserted line */
        pos += strlen(co);

        /* on multi line comment jump to the next line, otherwise add the length of added indentation */
        if (have_multiline_comment)
                pos += 1;
        else
                pos += strlen(indent);

        sci_set_current_position(editor->sci, pos, TRUE);
        /* reset the selection */
        sci_set_anchor(editor->sci, pos);

        sci_end_undo_action(editor->sci);
}


/* Note: If the editor is pending a redraw, set document::scroll_percent instead.
 * Scroll the view to make line appear at percent_of_view.
 * line can be -1 to use the current position. */
void editor_scroll_to_line(GeanyEditor *editor, gint line, gfloat percent_of_view)
{
        gint los;
        GtkWidget *wid;

        g_return_if_fail(editor != NULL);

        wid = GTK_WIDGET(editor->sci);

        if (! gtk_widget_get_window(wid) || ! gdk_window_is_viewable(gtk_widget_get_window(wid)))
                return; /* prevent gdk_window_scroll warning */

        if (line == -1)
                line = sci_get_current_line(editor->sci);

        /* sci 'visible line' != doc line number because of folding and line wrapping */
        /* calling SCI_VISIBLEFROMDOCLINE for line is more accurate than calling
         * SCI_DOCLINEFROMVISIBLE for vis1. */
        line = SSM(editor->sci, SCI_VISIBLEFROMDOCLINE, line, 0);
        los = SSM(editor->sci, SCI_LINESONSCREEN, 0, 0);
        line = line - los * percent_of_view;
        SSM(editor->sci, SCI_SETFIRSTVISIBLELINE, line, 0);
        sci_scroll_caret(editor->sci); /* needed for horizontal scrolling */
}


/* creates and inserts one tab or whitespace of the amount of the tab width */
void editor_insert_alternative_whitespace(GeanyEditor *editor)
{
        gchar *text;
        GeanyIndentPrefs iprefs = *editor_get_indent_prefs(editor);

        g_return_if_fail(editor != NULL);

        switch (iprefs.type)
        {
                case GEANY_INDENT_TYPE_TABS:
                        iprefs.type = GEANY_INDENT_TYPE_SPACES;
                        break;
                case GEANY_INDENT_TYPE_SPACES:
                case GEANY_INDENT_TYPE_BOTH:    /* most likely we want a tab */
                        iprefs.type = GEANY_INDENT_TYPE_TABS;
                        break;
        }
        text = get_whitespace(&iprefs, iprefs.width);
        sci_add_text(editor->sci, text);
        g_free(text);
}


void editor_select_word(GeanyEditor *editor)
{
        gint pos;
        gint start;
        gint end;

        g_return_if_fail(editor != NULL);

        pos = SSM(editor->sci, SCI_GETCURRENTPOS, 0, 0);
        start = sci_word_start_position(editor->sci, pos, TRUE);
        end = sci_word_end_position(editor->sci, pos, TRUE);

        if (start == end) /* caret in whitespaces sequence */
        {
                /* look forward but reverse the selection direction,
                 * so the caret end up stay as near as the original position. */
                end = sci_word_end_position(editor->sci, pos, FALSE);
                start = sci_word_end_position(editor->sci, end, TRUE);
                if (start == end)
                        return;
        }

        sci_set_selection(editor->sci, start, end);
}


/* extra_line is for selecting the cursor line (or anchor line) at the bottom of a selection,
 * when those lines have no selection (cursor at start of line). */
void editor_select_lines(GeanyEditor *editor, gboolean extra_line)
{
        gint start, end, line;

        g_return_if_fail(editor != NULL);

        start = sci_get_selection_start(editor->sci);
        end = sci_get_selection_end(editor->sci);

        /* check if whole lines are already selected */
        if (! extra_line && start != end &&
                sci_get_col_from_position(editor->sci, start) == 0 &&
                sci_get_col_from_position(editor->sci, end) == 0)
                        return;

        line = sci_get_line_from_position(editor->sci, start);
        start = sci_get_position_from_line(editor->sci, line);

        line = sci_get_line_from_position(editor->sci, end);
        end = sci_get_position_from_line(editor->sci, line + 1);

        sci_set_selection(editor->sci, start, end);
}


static gboolean sci_is_blank_line(ScintillaObject *sci, gint line)
{
        return sci_get_line_indent_position(sci, line) ==
                sci_get_line_end_position(sci, line);
}


/* Returns first line of paragraph for GTK_DIR_UP, line after paragraph
 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
static gint find_paragraph_stop(GeanyEditor *editor, gint line, gint direction)
{
        gint step;
        ScintillaObject *sci = editor->sci;

        /* first check current line and return -1 if it is empty to skip creating of a selection */
        if (sci_is_blank_line(sci, line))
                return -1;

        if (direction == GTK_DIR_UP)
                step = -1;
        else
                step = 1;

        while (TRUE)
        {
                line += step;
                if (line == -1)
                {
                        /* start of document */
                        line = 0;
                        break;
                }
                if (line == sci_get_line_count(sci))
                        break;

                if (sci_is_blank_line(sci, line))
                {
                        /* return line paragraph starts on */
                        if (direction == GTK_DIR_UP)
                                line++;
                        break;
                }
        }
        return line;
}


void editor_select_paragraph(GeanyEditor *editor)
{
        gint pos_start, pos_end, line_start, line_found;

        g_return_if_fail(editor != NULL);

        line_start = sci_get_current_line(editor->sci);

        line_found = find_paragraph_stop(editor, line_start, GTK_DIR_UP);
        if (line_found == -1)
                return;

        pos_start = SSM(editor->sci, SCI_POSITIONFROMLINE, line_found, 0);

        line_found = find_paragraph_stop(editor, line_start, GTK_DIR_DOWN);
        pos_end = SSM(editor->sci, SCI_POSITIONFROMLINE, line_found, 0);

        sci_set_selection(editor->sci, pos_start, pos_end);
}


/* Returns first line of block for GTK_DIR_UP, line after block
 * ends for GTK_DIR_DOWN or -1 if called on an empty line. */
static gint find_block_stop(GeanyEditor *editor, gint line, gint direction)
{
        gint step, ind;
        ScintillaObject *sci = editor->sci;

        /* first check current line and return -1 if it is empty to skip creating of a selection */
        if (sci_is_blank_line(sci, line))
                return -1;

        if (direction == GTK_DIR_UP)
                step = -1;
        else
                step = 1;

        ind = sci_get_line_indentation(sci, line);
        while (TRUE)
        {
                line += step;
                if (line == -1)
                {
                        /* start of document */
                        line = 0;
                        break;
                }
                if (line == sci_get_line_count(sci))
                        break;

                if (sci_get_line_indentation(sci, line) != ind ||
                        sci_is_blank_line(sci, line))
                {
                        /* return line block starts on */
                        if (direction == GTK_DIR_UP)
                                line++;
                        break;
                }
        }
        return line;
}


void editor_select_indent_block(GeanyEditor *editor)
{
        gint pos_start, pos_end, line_start, line_found;

        g_return_if_fail(editor != NULL);

        line_start = sci_get_current_line(editor->sci);

        line_found = find_block_stop(editor, line_start, GTK_DIR_UP);
        if (line_found == -1)
                return;

        pos_start = SSM(editor->sci, SCI_POSITIONFROMLINE, line_found, 0);

        line_found = find_block_stop(editor, line_start, GTK_DIR_DOWN);
        pos_end = SSM(editor->sci, SCI_POSITIONFROMLINE, line_found, 0);

        sci_set_selection(editor->sci, pos_start, pos_end);
}


/* simple indentation to indent the current line with the same indent as the previous one */
static void smart_line_indentation(GeanyEditor *editor, gint first_line, gint last_line)
{
        gint i, sel_start = 0, sel_end = 0;

        /* get previous line and use it for read_indent to use that line
         * (otherwise it would fail on a line only containing "{" in advanced indentation mode) */
        read_indent(editor, sci_get_position_from_line(editor->sci, first_line - 1));

        for (i = first_line; i <= last_line; i++)
        {
                /* skip the first line or if the indentation of the previous and current line are equal */
                if (i == 0 ||
                        SSM(editor->sci, SCI_GETLINEINDENTATION, i - 1, 0) ==
                        SSM(editor->sci, SCI_GETLINEINDENTATION, i, 0))
                        continue;

                sel_start = SSM(editor->sci, SCI_POSITIONFROMLINE, i, 0);
                sel_end = SSM(editor->sci, SCI_GETLINEINDENTPOSITION, i, 0);
                if (sel_start < sel_end)
                {
                        sci_set_selection(editor->sci, sel_start, sel_end);
                        sci_replace_sel(editor->sci, "");
                }
                sci_insert_text(editor->sci, sel_start, indent);
        }
}


/* simple indentation to indent the current line with the same indent as the previous one */
void editor_smart_line_indentation(GeanyEditor *editor)
{
        gint first_line, last_line;
        gint first_sel_start, first_sel_end;
        ScintillaObject *sci;

        g_return_if_fail(editor != NULL);

        sci = editor->sci;

        first_sel_start = sci_get_selection_start(sci);
        first_sel_end = sci_get_selection_end(sci);

        first_line = sci_get_line_from_position(sci, first_sel_start);
        /* Find the last line with chars selected (not EOL char) */
        last_line = sci_get_line_from_position(sci, first_sel_end - editor_get_eol_char_len(editor));
        last_line = MAX(first_line, last_line);

        sci_start_undo_action(sci);

        smart_line_indentation(editor, first_line, last_line);

        /* set cursor position if there was no selection */
        if (first_sel_start == first_sel_end)
        {
                gint indent_pos = SSM(sci, SCI_GETLINEINDENTPOSITION, first_line, 0);

                /* use indent position as user may wish to change indentation afterwards */
                sci_set_current_position(sci, indent_pos, FALSE);
        }
        else
        {
                /* fully select all the lines affected */
                sci_set_selection_start(sci, sci_get_position_from_line(sci, first_line));
                sci_set_selection_end(sci, sci_get_position_from_line(sci, last_line + 1));
        }

        sci_end_undo_action(sci);
}


/* increase / decrease current line or selection by one space */
void editor_indentation_by_one_space(GeanyEditor *editor, gint pos, gboolean decrease)
{
        gint i, first_line, last_line, line_start, indentation_end, count = 0;
        gint sel_start, sel_end, first_line_offset = 0;

        g_return_if_fail(editor != NULL);

        sel_start = sci_get_selection_start(editor->sci);
        sel_end = sci_get_selection_end(editor->sci);

        first_line = sci_get_line_from_position(editor->sci, sel_start);
        /* Find the last line with chars selected (not EOL char) */
        last_line = sci_get_line_from_position(editor->sci, sel_end - editor_get_eol_char_len(editor));
        last_line = MAX(first_line, last_line);

        if (pos == -1)
                pos = sel_start;

        sci_start_undo_action(editor->sci);

        for (i = first_line; i <= last_line; i++)
        {
                indentation_end = SSM(editor->sci, SCI_GETLINEINDENTPOSITION, i, 0);
                if (decrease)
                {
                        line_start = SSM(editor->sci, SCI_POSITIONFROMLINE, i, 0);
                        /* searching backwards for a space to remove */
                        while (sci_get_char_at(editor->sci, indentation_end) != ' ' && indentation_end > line_start)
                                indentation_end--;

                        if (sci_get_char_at(editor->sci, indentation_end) == ' ')
                        {
                                sci_set_selection(editor->sci, indentation_end, indentation_end + 1);
                                sci_replace_sel(editor->sci, "");
                                count--;
                                if (i == first_line)
                                        first_line_offset = -1;
                        }
                }
                else
                {
                        sci_insert_text(editor->sci, indentation_end, " ");
                        count++;
                        if (i == first_line)
                                first_line_offset = 1;
                }
        }

        /* set cursor position */
        if (sel_start < sel_end)
        {
                gint start = sel_start + first_line_offset;
                if (first_line_offset < 0)
                        start = MAX(sel_start + first_line_offset,
                                                SSM(editor->sci, SCI_POSITIONFROMLINE, first_line, 0));

                sci_set_selection_start(editor->sci, start);
                sci_set_selection_end(editor->sci, sel_end + count);
        }
        else
                sci_set_current_position(editor->sci, pos + count, FALSE);

        sci_end_undo_action(editor->sci);
}


void editor_finalize(void)
{
        scintilla_release_resources();
}


/* wordchars: NULL or a string containing characters to match a word.
 * Returns: the current selection or the current word.
 *
 * Passing NULL as wordchars is NOT the same as passing GEANY_WORDCHARS: NULL means
 * using Scintillas's word boundaries. */
gchar *editor_get_default_selection(GeanyEditor *editor, gboolean use_current_word,
                                                                        const gchar *wordchars)
{
        gchar *s = NULL;

        g_return_val_if_fail(editor != NULL, NULL);

        if (sci_get_lines_selected(editor->sci) == 1)
                s = sci_get_selection_contents(editor->sci);
        else if (sci_get_lines_selected(editor->sci) == 0 && use_current_word)
        {       /* use the word at current cursor position */
                gchar word[GEANY_MAX_WORD_LENGTH];

                if (wordchars != NULL)
                        editor_find_current_word(editor, -1, word, sizeof(word), wordchars);
                else
                        editor_find_current_word_sciwc(editor, -1, word, sizeof(word));

                if (word[0] != '\0')
                        s = g_strdup(word);
        }
        return s;
}


/* Note: Usually the line should be made visible (not folded) before calling this.
 * Returns: TRUE if line is/will be displayed to the user, or FALSE if it is
 * outside the *vertical* view.
 * Warning: You may need horizontal scrolling to make the cursor visible - so always call
 * sci_scroll_caret() when this returns TRUE. */
gboolean editor_line_in_view(GeanyEditor *editor, gint line)
{
        gint vis1, los;

        g_return_val_if_fail(editor != NULL, FALSE);

        /* If line is wrapped the result may occur on another virtual line than the first and may be
         * still hidden, so increase the line number to check for the next document line */
        if (SSM(editor->sci, SCI_WRAPCOUNT, line, 0) > 1)
                line++;

        line = SSM(editor->sci, SCI_VISIBLEFROMDOCLINE, line, 0);       /* convert to visible line number */
        vis1 = SSM(editor->sci, SCI_GETFIRSTVISIBLELINE, 0, 0);
        los = SSM(editor->sci, SCI_LINESONSCREEN, 0, 0);

        return (line >= vis1 && line < vis1 + los);
}


/* If the current line is outside the current view window, scroll the line
 * so it appears at percent_of_view. */
void editor_display_current_line(GeanyEditor *editor, gfloat percent_of_view)
{
        gint line;

        g_return_if_fail(editor != NULL);

        line = sci_get_current_line(editor->sci);

        /* unfold maybe folded results */
        sci_ensure_line_is_visible(editor->sci, line);

        /* scroll the line if it's off screen */
        if (! editor_line_in_view(editor, line))
                editor->scroll_percent = percent_of_view;
        else
                sci_scroll_caret(editor->sci); /* may need horizontal scrolling */
}


 /*
 *  Deletes all currently set indicators in the @a editor window.
 *  Error indicators (red squiggly underlines) and usual line markers are removed.
 *
 *  @param editor The editor to operate on.
 */
void editor_indicator_clear_errors(GeanyEditor *editor)
{
        editor_indicator_clear(editor, GEANY_INDICATOR_ERROR);
        sci_marker_delete_all(editor->sci, 0);  /* remove the yellow error line marker */
}


/**
 *  Deletes all currently set indicators matching @a indic in the @a editor window.
 *
 *  @param editor The editor to operate on.
 *  @param indic The indicator number to clear, this is a value of @ref GeanyIndicator.
 *
 *  @since 0.16
 */
GEANY_API_SYMBOL
void editor_indicator_clear(GeanyEditor *editor, gint indic)
{
        glong last_pos;

        g_return_if_fail(editor != NULL);

        last_pos = sci_get_length(editor->sci);
        if (last_pos > 0)
        {
                sci_indicator_set(editor->sci, indic);
                sci_indicator_clear(editor->sci, 0, last_pos);
        }
}


/**
 *  Sets an indicator @a indic on @a line.
 *  Whitespace at the start and the end of the line is not marked.
 *
 *  @param editor The editor to operate on.
 *  @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
 *  @param line The line number which should be marked.
 *
 *  @since 0.16
 */
GEANY_API_SYMBOL
void editor_indicator_set_on_line(GeanyEditor *editor, gint indic, gint line)
{
        gint start, end;
        guint i = 0, len;
        gchar *linebuf;

        g_return_if_fail(editor != NULL);
        g_return_if_fail(line >= 0);

        start = sci_get_position_from_line(editor->sci, line);
        end = sci_get_position_from_line(editor->sci, line + 1);

        /* skip blank lines */
        if ((start + 1) == end ||
                start > end ||
                (sci_get_line_end_position(editor->sci, line) - start) == 0)
        {
                return;
        }

        len = end - start;
        linebuf = sci_get_line(editor->sci, line);

        /* don't set the indicator on whitespace */
        while (isspace(linebuf[i]))
                i++;
        while (len > 1 && len > i && isspace(linebuf[len - 1]))
        {
                len--;
                end--;
        }
        g_free(linebuf);

        editor_indicator_set_on_range(editor, indic, start + i, end);
}


/**
 *  Sets an indicator on the range specified by @a start and @a end.
 *  No error checking or whitespace removal is performed, this should be done by the calling
 *  function if necessary.
 *
 *  @param editor The editor to operate on.
 *  @param indic The indicator number to use, this is a value of @ref GeanyIndicator.
 *  @param start The starting position for the marker.
 *  @param end The ending position for the marker.
 *
 *  @since 0.16
 */
GEANY_API_SYMBOL
void editor_indicator_set_on_range(GeanyEditor *editor, gint indic, gint start, gint end)
{
        g_return_if_fail(editor != NULL);
        if (start >= end)
                return;

        sci_indicator_set(editor->sci, indic);
        sci_indicator_fill(editor->sci, start, end - start);
}


/* Inserts the given colour (format should be #...), if there is a selection starting with 0x...
 * the replacement will also start with 0x... */
void editor_insert_color(GeanyEditor *editor, const gchar *colour)
{
        g_return_if_fail(editor != NULL);

        if (sci_has_selection(editor->sci))
        {
                gint start = sci_get_selection_start(editor->sci);
                const gchar *replacement = colour;

                if (sci_get_char_at(editor->sci, start) == '0' &&
                        sci_get_char_at(editor->sci, start + 1) == 'x')
                {
                        gint end = sci_get_selection_end(editor->sci);

                        sci_set_selection_start(editor->sci, start + 2);
                        /* we need to also re-set the selection end in case the anchor was located before
                         * the cursor, since set_selection_start() always moves the cursor, not the anchor */
                        sci_set_selection_end(editor->sci, end);
                        replacement++; /* skip the leading "0x" */
                }
                else if (sci_get_char_at(editor->sci, start - 1) == '#')
                {       /* double clicking something like #00ffff may only select 00ffff because of wordchars */
                        replacement++; /* so skip the '#' to only replace the colour value */
                }
                sci_replace_sel(editor->sci, replacement);
        }
        else
                sci_add_text(editor->sci, colour);
}


/**
 *  Retrieves the end of line characters mode (LF, CR/LF, CR) in the given editor.
 *  If @a editor is @c NULL, the default end of line characters are used.
 *
 *  @param editor @nullable The editor to operate on, or @c NULL to query the default value.
 *  @return The used end of line characters mode.
 *
 *  @since 0.20
 */
GEANY_API_SYMBOL
gint editor_get_eol_char_mode(GeanyEditor *editor)
{
        gint mode = file_prefs.default_eol_character;

        if (editor != NULL)
                mode = sci_get_eol_mode(editor->sci);

        return mode;
}


/**
 *  Retrieves the localized name (for displaying) of the used end of line characters
 *  (LF, CR/LF, CR) in the given editor.
 *  If @a editor is @c NULL, the default end of line characters are used.
 *
 *  @param editor @nullable The editor to operate on, or @c NULL to query the default value.
 *  @return The name of the end of line characters.
 *
 *  @since 0.19
 */
GEANY_API_SYMBOL
const gchar *editor_get_eol_char_name(GeanyEditor *editor)
{
        gint mode = file_prefs.default_eol_character;

        if (editor != NULL)
                mode = sci_get_eol_mode(editor->sci);

        return utils_get_eol_name(mode);
}


/**
 *  Retrieves the length of the used end of line characters (LF, CR/LF, CR) in the given editor.
 *  If @a editor is @c NULL, the default end of line characters are used.
 *  The returned value is 1 for CR and LF and 2 for CR/LF.
 *
 *  @param editor @nullable The editor to operate on, or @c NULL to query the default value.
 *  @return The length of the end of line characters.
 *
 *  @since 0.19
 */
GEANY_API_SYMBOL
gint editor_get_eol_char_len(GeanyEditor *editor)
{
        gint mode = file_prefs.default_eol_character;

        if (editor != NULL)
                mode = sci_get_eol_mode(editor->sci);

        switch (mode)
        {
                case SC_EOL_CRLF: return 2; break;
                default: return 1; break;
        }
}


/**
 *  Retrieves the used end of line characters (LF, CR/LF, CR) in the given editor.
 *  If @a editor is @c NULL, the default end of line characters are used.
 *  The returned value is either "\n", "\r\n" or "\r".
 *
 *  @param editor @nullable The editor to operate on, or @c NULL to query the default value.
 *  @return The end of line characters.
 *
 *  @since 0.19
 */
GEANY_API_SYMBOL
const gchar *editor_get_eol_char(GeanyEditor *editor)
{
        gint mode = file_prefs.default_eol_character;

        if (editor != NULL)
                mode = sci_get_eol_mode(editor->sci);

        return utils_get_eol_char(mode);
}


static void fold_all(GeanyEditor *editor, gboolean want_fold)
{
        gint lines, first, i;

        if (editor == NULL || ! editor_prefs.folding)
                return;

        lines = sci_get_line_count(editor->sci);
        first = sci_get_first_visible_line(editor->sci);

        for (i = 0; i < lines; i++)
        {
                gint level = sci_get_fold_level(editor->sci, i);

                if (level & SC_FOLDLEVELHEADERFLAG)
                {
                        if (sci_get_fold_expanded(editor->sci, i) == want_fold)
                                        sci_toggle_fold(editor->sci, i);
                }
        }
        editor_scroll_to_line(editor, first, 0.0F);
}


void editor_unfold_all(GeanyEditor *editor)
{
        fold_all(editor, FALSE);
}


void editor_fold_all(GeanyEditor *editor)
{
        fold_all(editor, TRUE);
}


void editor_replace_tabs(GeanyEditor *editor, gboolean ignore_selection)
{
        gint anchor_pos, caret_pos;
        struct Sci_TextToFind ttf;

        g_return_if_fail(editor != NULL);

        sci_start_undo_action(editor->sci);
        if (sci_has_selection(editor->sci) && !ignore_selection)
        {
                ttf.chrg.cpMin = sci_get_selection_start(editor->sci);
                ttf.chrg.cpMax = sci_get_selection_end(editor->sci);
        }
        else
        {
                ttf.chrg.cpMin = 0;
                ttf.chrg.cpMax = sci_get_length(editor->sci);
        }
        ttf.lpstrText = (gchar*) "\t";

        anchor_pos = SSM(editor->sci, SCI_GETANCHOR, 0, 0);
        caret_pos = sci_get_current_position(editor->sci);
        while (TRUE)
        {
                gint search_pos, pos_in_line, current_tab_true_length;
                gint tab_len;
                gchar *tab_str;

                search_pos = sci_find_text(editor->sci, SCFIND_MATCHCASE, &ttf);
                if (search_pos == -1)
                        break;

                tab_len = sci_get_tab_width(editor->sci);
                pos_in_line = sci_get_col_from_position(editor->sci, search_pos);
                current_tab_true_length = tab_len - (pos_in_line % tab_len);
                tab_str = g_strnfill(current_tab_true_length, ' ');
                sci_set_target_start(editor->sci, search_pos);
                sci_set_target_end(editor->sci, search_pos + 1);
                sci_replace_target(editor->sci, tab_str, FALSE);
                /* next search starts after replacement */
                ttf.chrg.cpMin = search_pos + current_tab_true_length - 1;
                /* update end of range now text has changed */
                ttf.chrg.cpMax += current_tab_true_length - 1;
                g_free(tab_str);

                if (anchor_pos > search_pos)
                        anchor_pos += current_tab_true_length - 1;
                if (caret_pos > search_pos)
                        caret_pos += current_tab_true_length - 1;
        }
        sci_set_selection(editor->sci, anchor_pos, caret_pos);
        sci_end_undo_action(editor->sci);
}


/* Replaces all occurrences all spaces of the length of a given tab_width,
 * optionally restricting the search to the current selection. */
void editor_replace_spaces(GeanyEditor *editor, gboolean ignore_selection)
{
        gint search_pos;
        gint anchor_pos, caret_pos;
        static gdouble tab_len_f = -1.0; /* keep the last used value */
        gint tab_len;
        gchar *text;
        struct Sci_TextToFind ttf;

        g_return_if_fail(editor != NULL);

        if (tab_len_f < 0.0)
                tab_len_f = sci_get_tab_width(editor->sci);

        if (! dialogs_show_input_numeric(
                _("Enter Tab Width"),
                _("Enter the amount of spaces which should be replaced by a tab character."),
                &tab_len_f, 1, 100, 1))
        {
                return;
        }
        tab_len = (gint) tab_len_f;
        text = g_strnfill(tab_len, ' ');

        sci_start_undo_action(editor->sci);
        if (sci_has_selection(editor->sci) && !ignore_selection)
        {
                ttf.chrg.cpMin = sci_get_selection_start(editor->sci);
                ttf.chrg.cpMax = sci_get_selection_end(editor->sci);
        }
        else
        {
                ttf.chrg.cpMin = 0;
                ttf.chrg.cpMax = sci_get_length(editor->sci);
        }
        ttf.lpstrText = text;

        anchor_pos = SSM(editor->sci, SCI_GETANCHOR, 0, 0);
        caret_pos = sci_get_current_position(editor->sci);
        while (TRUE)
        {
                search_pos = sci_find_text(editor->sci, SCFIND_MATCHCASE, &ttf);
                if (search_pos == -1)
                        break;
                /* only replace indentation because otherwise we can mess up alignment */
                if (search_pos > sci_get_line_indent_position(editor->sci,
                        sci_get_line_from_position(editor->sci, search_pos)))
                {
                        ttf.chrg.cpMin = search_pos + tab_len;
                        continue;
                }
                sci_set_target_start(editor->sci, search_pos);
                sci_set_target_end(editor->sci, search_pos + tab_len);
                sci_replace_target(editor->sci, "\t", FALSE);
                ttf.chrg.cpMin = search_pos;
                /* update end of range now text has changed */
                ttf.chrg.cpMax -= tab_len - 1;

                if (anchor_pos > search_pos)
                        anchor_pos -= tab_len - 1;
                if (caret_pos > search_pos)
                        caret_pos -= tab_len - 1;
        }
        sci_set_selection(editor->sci, anchor_pos, caret_pos);
        sci_end_undo_action(editor->sci);
        g_free(text);
}


void editor_strip_line_trailing_spaces(GeanyEditor *editor, gint line)
{
        gint line_start = sci_get_position_from_line(editor->sci, line);
        gint line_end = sci_get_line_end_position(editor->sci, line);
        gint i = line_end - 1;
        gchar ch = sci_get_char_at(editor->sci, i);

        /* Diff hunks should keep trailing spaces */
        if (editor->document->file_type->id == GEANY_FILETYPES_DIFF)
                return;

        while ((i >= line_start) && ((ch == ' ') || (ch == '\t')))
        {
                i--;
                ch = sci_get_char_at(editor->sci, i);
        }
        if (i < (line_end - 1))
        {
                sci_set_target_start(editor->sci, i + 1);
                sci_set_target_end(editor->sci, line_end);
                sci_replace_target(editor->sci, "", FALSE);
        }
}


void editor_strip_trailing_spaces(GeanyEditor *editor, gboolean ignore_selection)
{
        gint start_line;
        gint end_line;
        gint line;

        if (sci_has_selection(editor->sci) && !ignore_selection)
        {
                gint selection_start = sci_get_selection_start(editor->sci);
                gint selection_end = sci_get_selection_end(editor->sci);

                start_line = sci_get_line_from_position(editor->sci, selection_start);
                end_line = sci_get_line_from_position(editor->sci, selection_end);

                if (sci_get_col_from_position(editor->sci, selection_end) > 0)
                        end_line++;
        }
        else
        {
                start_line = 0;
                end_line = sci_get_line_count(editor->sci);
        }

        sci_start_undo_action(editor->sci);

        for (line = start_line; line < end_line; line++)
        {
                editor_strip_line_trailing_spaces(editor, line);
        }
        sci_end_undo_action(editor->sci);
}


void editor_ensure_final_newline(GeanyEditor *editor)
{
        gint max_lines = sci_get_line_count(editor->sci);
        gboolean append_newline = (max_lines == 1);
        gint end_document = sci_get_position_from_line(editor->sci, max_lines);

        if (max_lines > 1)
        {
                append_newline = end_document > sci_get_position_from_line(editor->sci, max_lines - 1);
        }
        if (append_newline)
        {
                const gchar *eol = editor_get_eol_char(editor);

                sci_insert_text(editor->sci, end_document, eol);
        }
}


/* Similar to editor_set_font() but *only* sets the font, and doesn't take care
 * of updating properties that might depend on the font */
static void set_font(ScintillaObject *sci, const gchar *font)
{
        gint style;
        gchar *font_name;
        PangoFontDescription *pfd;
        gdouble size;

        g_return_if_fail(sci);

        pfd = pango_font_description_from_string(font);
        size = pango_font_description_get_size(pfd) / (gdouble) PANGO_SCALE;
        font_name = g_strdup_printf("!%s", pango_font_description_get_family(pfd));
        pango_font_description_free(pfd);

        for (style = 0; style <= STYLE_MAX; style++)
                sci_set_font_fractional(sci, style, font_name, size);

        g_free(font_name);
}


void editor_set_font(GeanyEditor *editor, const gchar *font)
{
        g_return_if_fail(editor);

        set_font(editor->sci, font);
        update_margins(editor->sci);
        /* zoom to 100% to prevent confusion */
        sci_zoom_off(editor->sci);
}


void editor_set_line_wrapping(GeanyEditor *editor, gboolean wrap)
{
        g_return_if_fail(editor != NULL);

        editor->line_wrapping = wrap;
        sci_set_lines_wrapped(editor->sci, wrap);
}


/** Sets the indent type for @a editor.
 * @param editor Editor.
 * @param type Indent type.
 *
 *  @since 0.16
 */
GEANY_API_SYMBOL
void editor_set_indent_type(GeanyEditor *editor, GeanyIndentType type)
{
        editor_set_indent(editor, type, editor->indent_width);
}


/** Sets the indent width for @a editor.
 * @param editor Editor.
 * @param width New indent width.
 *
 * @since 1.27 (API 227)
 */
GEANY_API_SYMBOL
void editor_set_indent_width(GeanyEditor *editor, gint width)
{
        editor_set_indent(editor, editor->indent_type, width);
}


void editor_set_indent(GeanyEditor *editor, GeanyIndentType type, gint width)
{
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);
        ScintillaObject *sci = editor->sci;
        gboolean use_tabs = type != GEANY_INDENT_TYPE_SPACES;

        editor->indent_type = type;
        editor->indent_width = width;
        sci_set_use_tabs(sci, use_tabs);

        if (type == GEANY_INDENT_TYPE_BOTH)
        {
                sci_set_tab_width(sci, iprefs->hard_tab_width);
                if (iprefs->hard_tab_width != 8)
                {
                        static gboolean warn = TRUE;
                        if (warn)
                                ui_set_statusbar(TRUE, _("Warning: non-standard hard tab width: %d != 8!"),
                                        iprefs->hard_tab_width);
                        warn = FALSE;
                }
        }
        else
                sci_set_tab_width(sci, width);

        SSM(sci, SCI_SETINDENT, width, 0);

        /* remove indent spaces on backspace, if using any spaces to indent */
        SSM(sci, SCI_SETBACKSPACEUNINDENTS, type != GEANY_INDENT_TYPE_TABS, 0);
}


/* Convenience function for editor_goto_pos() to pass a line number.
 * line_no is 1 based */
gboolean editor_goto_line(GeanyEditor *editor, gint line_no, gboolean offset)
{
        g_return_val_if_fail(editor, FALSE);
        gint line_count = sci_get_line_count(editor->sci);

        if (offset)
                line_no += sci_get_current_line(editor->sci) + 1;

        /* ensure line_no is in bounds and determine whether to set line marker */
        gboolean set_marker = line_no > 0 && line_no < line_count;
        line_no = line_no <= 0          ? 0
                        : line_no >= line_count ? line_count - 1
                        : line_no - 1;

        gint pos = sci_get_position_from_line(editor->sci, line_no);
        return editor_goto_pos(editor, pos, set_marker);
}


/** Moves to position @a pos, switching to the document if necessary,
 *  setting a marker if @a mark is set.
 *
 * @param editor Editor.
 * @param pos The position.
 * @param mark Whether to set a mark on the position.
 * @return @c TRUE if action has been performed, otherwise @c FALSE.
 *
 *  @since 0.20
 **/
GEANY_API_SYMBOL
gboolean editor_goto_pos(GeanyEditor *editor, gint pos, gboolean mark)
{
        g_return_val_if_fail(editor, FALSE);
        if (G_UNLIKELY(pos < 0))
                return FALSE;

        if (mark)
        {
                gint line = sci_get_line_from_position(editor->sci, pos);

                /* mark the tag with the yellow arrow */
                sci_marker_delete_all(editor->sci, 0);
                sci_set_marker_at_line(editor->sci, line, 0);
        }

        sci_goto_pos(editor->sci, pos, TRUE);
        editor->scroll_percent = 0.25F;

        /* finally switch to the page */
        document_show_tab(editor->document);
        return TRUE;
}


static gboolean
on_editor_scroll_event(GtkWidget *widget, GdkEventScroll *event, gpointer user_data)
{
        GeanyEditor *editor = user_data;

        /* we only handle up and down, leave the rest to Scintilla */
        if (event->direction != GDK_SCROLL_UP && event->direction != GDK_SCROLL_DOWN)
                return FALSE;

        /* Handle scroll events if Alt is pressed and scroll whole pages instead of a
         * few lines only, maybe this could/should be done in Scintilla directly */
        if (event->state & GDK_MOD1_MASK)
        {
                sci_send_command(editor->sci, (event->direction == GDK_SCROLL_DOWN) ? SCI_PAGEDOWN : SCI_PAGEUP);
                return TRUE;
        }
        else if (event->state & GDK_SHIFT_MASK)
        {
                gint amount = (event->direction == GDK_SCROLL_DOWN) ? 8 : -8;

                sci_scroll_columns(editor->sci, amount);
                return TRUE;
        }

        return FALSE; /* let Scintilla handle all other cases */
}


static gboolean editor_check_colourise(GeanyEditor *editor)
{
        GeanyDocument *doc = editor->document;

        if (!doc->priv->colourise_needed)
                return FALSE;

        doc->priv->colourise_needed = FALSE;
        sci_colourise(editor->sci, 0, -1);

        /* now that the current document is colourised, fold points are now accurate,
         * so force an update of the current function/tag. */
        symbols_get_current_function(NULL, NULL);
        ui_update_statusbar(NULL, -1);

        return TRUE;
}


/* We only want to colourise just before drawing, to save startup time and
 * prevent unnecessary recolouring other documents after one is saved.
 * Really we want a "draw" signal but there doesn't seem to be one (expose is too late,
 * and "show" doesn't work). */
static gboolean on_editor_focus_in(GtkWidget *widget, GdkEventFocus *event, gpointer user_data)
{
        GeanyEditor *editor = user_data;

        editor_check_colourise(editor);
        return FALSE;
}


static gboolean on_editor_draw(GtkWidget *widget, cairo_t *cr, gpointer user_data)
{
        GeanyEditor *editor = user_data;

        /* This is just to catch any uncolourised documents being drawn that didn't receive focus
         * for some reason, maybe it's not necessary but just in case. */
        editor_check_colourise(editor);
        return FALSE;
}


static void setup_sci_keys(ScintillaObject *sci)
{
        /* disable some Scintilla keybindings to be able to redefine them cleanly */
        sci_clear_cmdkey(sci, 'A' | (SCMOD_CTRL << 16)); /* select all */
        sci_clear_cmdkey(sci, 'D' | (SCMOD_CTRL << 16)); /* duplicate */
        sci_clear_cmdkey(sci, 'T' | (SCMOD_CTRL << 16)); /* line transpose */
        sci_clear_cmdkey(sci, 'T' | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16)); /* line copy */
        sci_clear_cmdkey(sci, 'L' | (SCMOD_CTRL << 16)); /* line cut */
        sci_clear_cmdkey(sci, 'L' | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16)); /* line delete */
        sci_clear_cmdkey(sci, SCK_DELETE | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16)); /* line to end delete */
        sci_clear_cmdkey(sci, SCK_BACK | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16)); /* line to beginning delete */
        sci_clear_cmdkey(sci, '/' | (SCMOD_CTRL << 16)); /* Previous word part */
        sci_clear_cmdkey(sci, '\\' | (SCMOD_CTRL << 16)); /* Next word part */
        sci_clear_cmdkey(sci, SCK_UP | (SCMOD_CTRL << 16)); /* scroll line up */
        sci_clear_cmdkey(sci, SCK_DOWN | (SCMOD_CTRL << 16)); /* scroll line down */
        sci_clear_cmdkey(sci, SCK_HOME); /* line start */
        sci_clear_cmdkey(sci, SCK_END); /* line end */
        sci_clear_cmdkey(sci, SCK_END | (SCMOD_ALT << 16));     /* visual line end */

        if (editor_prefs.use_gtk_word_boundaries)
        {
                /* use GtkEntry-like word boundaries */
                sci_assign_cmdkey(sci, SCK_RIGHT | (SCMOD_CTRL << 16), SCI_WORDRIGHTEND);
                sci_assign_cmdkey(sci, SCK_RIGHT | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16), SCI_WORDRIGHTENDEXTEND);
                sci_assign_cmdkey(sci, SCK_DELETE | (SCMOD_CTRL << 16), SCI_DELWORDRIGHTEND);
        }
        sci_assign_cmdkey(sci, SCK_UP | (SCMOD_ALT << 16), SCI_LINESCROLLUP);
        sci_assign_cmdkey(sci, SCK_DOWN | (SCMOD_ALT << 16), SCI_LINESCROLLDOWN);
        sci_assign_cmdkey(sci, SCK_UP | (SCMOD_CTRL << 16), SCI_PARAUP);
        sci_assign_cmdkey(sci, SCK_UP | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16), SCI_PARAUPEXTEND);
        sci_assign_cmdkey(sci, SCK_DOWN | (SCMOD_CTRL << 16), SCI_PARADOWN);
        sci_assign_cmdkey(sci, SCK_DOWN | (SCMOD_CTRL << 16) | (SCMOD_SHIFT << 16), SCI_PARADOWNEXTEND);

        sci_clear_cmdkey(sci, SCK_BACK | (SCMOD_ALT << 16)); /* clear Alt-Backspace (Undo) */
}


/* registers a Scintilla image from a named icon from the theme */
static gboolean register_named_icon(ScintillaObject *sci, guint id, const gchar *name)
{
        GError *error = NULL;
        GdkPixbuf *pixbuf;
        gint n_channels, rowstride, width, height;
        gint size;

        gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &size, NULL);
        pixbuf = gtk_icon_theme_load_icon(gtk_icon_theme_get_default(), name, size, 0, &error);
        if (! pixbuf)
        {
                g_warning("failed to load icon '%s': %s", name, error->message);
                g_error_free(error);
                return FALSE;
        }

        n_channels = gdk_pixbuf_get_n_channels(pixbuf);
        rowstride = gdk_pixbuf_get_rowstride(pixbuf);
        width = gdk_pixbuf_get_width(pixbuf);
        height = gdk_pixbuf_get_height(pixbuf);

        if (gdk_pixbuf_get_bits_per_sample(pixbuf) != 8 ||
                ! gdk_pixbuf_get_has_alpha(pixbuf) ||
                n_channels != 4 ||
                rowstride != width * n_channels)
        {
                g_warning("incompatible image data for icon '%s'", name);
                g_object_unref(pixbuf);
                return FALSE;
        }

        SSM(sci, SCI_RGBAIMAGESETWIDTH, width, 0);
        SSM(sci, SCI_RGBAIMAGESETHEIGHT, height, 0);
        SSM(sci, SCI_REGISTERRGBAIMAGE, id, (sptr_t)gdk_pixbuf_get_pixels(pixbuf));

        g_object_unref(pixbuf);
        return TRUE;
}


/* Create new editor widget (scintilla).
 * @note The @c "sci-notify" signal is connected separately. */
static ScintillaObject *create_new_sci(GeanyEditor *editor)
{
        ScintillaObject *sci;
        int rectangular_selection_modifier;
        guint i;

        sci = SCINTILLA(scintilla_new());

        /* Scintilla doesn't support RTL languages properly and is primarily
         * intended to be used with LTR source code, so override the
         * GTK+ default text direction for the Scintilla widget. */
        gtk_widget_set_direction(GTK_WIDGET(sci), GTK_TEXT_DIR_LTR);

        gtk_widget_show(GTK_WIDGET(sci));

        sci_set_codepage(sci, SC_CP_UTF8);
        /*SSM(sci, SCI_SETWRAPSTARTINDENT, 4, 0);*/
        /* disable scintilla provided popup menu */
        sci_use_popup(sci, FALSE);

        setup_sci_keys(sci);

        sci_set_lines_wrapped(sci, editor->line_wrapping);
        sci_set_caret_policy_x(sci, CARET_JUMPS | CARET_EVEN, 0);
        /* Y policy is set in editor_apply_update_prefs() */
        SSM(sci, SCI_AUTOCSETSEPARATOR, '\n', 0);
        SSM(sci, SCI_SETSCROLLWIDTHTRACKING, 1, 0);

        /* tag autocompletion images */
        for (i = 0; i < TM_N_ICONS; i++)
        {
                const gchar *icon_name = symbols_get_icon_name(i);
                register_named_icon(sci, i + 1, icon_name);
        }

        /* necessary for column mode editing, implemented in Scintilla since 2.0 */
        SSM(sci, SCI_SETADDITIONALSELECTIONTYPING, 1, 0);

        /* rectangular selection modifier for creating rectangular selections with the mouse.
         * We use the historical Scintilla values by default. */
#ifdef G_OS_WIN32
        rectangular_selection_modifier = SCMOD_ALT;
#else
        rectangular_selection_modifier = SCMOD_CTRL;
#endif
        SSM(sci, SCI_SETRECTANGULARSELECTIONMODIFIER, rectangular_selection_modifier, 0);

        /* virtual space */
        SSM(sci, SCI_SETVIRTUALSPACEOPTIONS, editor_prefs.show_virtual_space, 0);

        /* input method editor's candidate window behaviour */
        SSM(sci, SCI_SETIMEINTERACTION, editor_prefs.ime_interaction, 0);

#ifdef GDK_WINDOWING_QUARTZ
# if ! GTK_CHECK_VERSION(3,16,0)
        /* "retina" (HiDPI) display support on OS X - requires disabling buffered draw
         * on older GTK versions */
        SSM(sci, SCI_SETBUFFEREDDRAW, 0, 0);
# endif
#endif

        /* only connect signals if this is for the document notebook, not split window */
        if (editor->sci == NULL)
        {
                g_signal_connect(sci, "button-press-event", G_CALLBACK(on_editor_button_press_event), editor);
                g_signal_connect(sci, "scroll-event", G_CALLBACK(on_editor_scroll_event), editor);
                g_signal_connect(sci, "motion-notify-event", G_CALLBACK(on_motion_event), NULL);
                g_signal_connect(sci, "focus-in-event", G_CALLBACK(on_editor_focus_in), editor);
                g_signal_connect(sci, "draw", G_CALLBACK(on_editor_draw), editor);
        }
        return sci;
}


/** Creates a new Scintilla @c GtkWidget based on the settings for @a editor.
 * @param editor Editor settings.
 * @return @transfer{floating} The new widget.
 *
 * @since 0.15
 **/
GEANY_API_SYMBOL
ScintillaObject *editor_create_widget(GeanyEditor *editor)
{
        const GeanyIndentPrefs *iprefs = get_default_indent_prefs();
        ScintillaObject *old, *sci;
        GeanyIndentType old_indent_type = editor->indent_type;
        gint old_indent_width = editor->indent_width;

        /* temporarily change editor to use the new sci widget */
        old = editor->sci;
        sci = create_new_sci(editor);
        editor->sci = sci;

        editor_set_indent(editor, iprefs->type, iprefs->width);
        set_font(editor->sci, interface_prefs.editor_font);
        editor_apply_update_prefs(editor);

        /* if editor already had a widget, restore it */
        if (old)
        {
                editor->indent_type = old_indent_type;
                editor->indent_width = old_indent_width;
                editor->sci = old;
        }
        return sci;
}


GeanyEditor *editor_create(GeanyDocument *doc)
{
        const GeanyIndentPrefs *iprefs = get_default_indent_prefs();
        GeanyEditor *editor = g_new0(GeanyEditor, 1);

        editor->document = doc;
        doc->editor = editor;   /* needed in case some editor functions/callbacks expect it */

        editor->auto_indent = (iprefs->auto_indent_mode != GEANY_AUTOINDENT_NONE);
        editor->line_wrapping = get_project_pref(line_wrapping);
        editor->scroll_percent = -1.0F;
        editor->line_breaking = FALSE;

        editor->sci = editor_create_widget(editor);
        return editor;
}


/* in case we need to free some fields in future */
void editor_destroy(GeanyEditor *editor)
{
        g_free(editor);
}


static void on_document_save(GObject *obj, GeanyDocument *doc)
{
        gchar *f = g_build_filename(app->configdir, "snippets.conf", NULL);

        if (utils_str_equal(doc->real_path, f))
        {
                /* reload snippets */
                editor_snippets_free();
                editor_snippets_init();
        }
        g_free(f);
}


gboolean editor_complete_word_part(GeanyEditor *editor)
{
        gchar *entry;

        g_return_val_if_fail(editor, FALSE);

        if (!SSM(editor->sci, SCI_AUTOCACTIVE, 0, 0))
                return FALSE;

        entry = sci_get_string(editor->sci, SCI_AUTOCGETCURRENTTEXT, 0);

        /* if no word part, complete normally */
        if (!check_partial_completion(editor, entry))
                SSM(editor->sci, SCI_AUTOCCOMPLETE, 0, 0);

        g_free(entry);
        return TRUE;
}


void editor_init(void)
{
        static GeanyIndentPrefs indent_prefs;
        gchar *f;

        memset(&editor_prefs, 0, sizeof(GeanyEditorPrefs));
        memset(&indent_prefs, 0, sizeof(GeanyIndentPrefs));
        editor_prefs.indentation = &indent_prefs;

        /* use g_signal_connect_after() to allow plugins connecting to the signal before the default
         * handler (on_editor_notify) is called */
        g_signal_connect_after(geany_object, "editor-notify", G_CALLBACK(on_editor_notify), NULL);

        f = g_build_filename(app->configdir, "snippets.conf", NULL);
        ui_add_config_file_menu_item(f, NULL, NULL);
        g_free(f);
        g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
}


/* TODO: Should these be user-defined instead of hard-coded? */
void editor_set_indentation_guides(GeanyEditor *editor)
{
        gint mode;
        gint lexer;

        g_return_if_fail(editor != NULL);

        if (! editor_prefs.show_indent_guide)
        {
                sci_set_indentation_guides(editor->sci, SC_IV_NONE);
                return;
        }

        lexer = sci_get_lexer(editor->sci);
        switch (lexer)
        {
                /* Lines added/removed are prefixed with +/- characters, so
                 * those lines will not be shown with any indentation guides.
                 * It can be distracting that only a few of lines in a diff/patch
                 * file will show the guides. */
                case SCLEX_DIFF:
                        mode = SC_IV_NONE;
                        break;

                /* These languages use indentation for control blocks; the "look forward" method works
                 * best here */
                case SCLEX_PYTHON:
                case SCLEX_HASKELL:
                case SCLEX_MAKEFILE:
                case SCLEX_ASM:
                case SCLEX_SQL:
                case SCLEX_COBOL:
                case SCLEX_PROPERTIES:
                case SCLEX_FORTRAN: /* Is this the best option for Fortran? */
                case SCLEX_CAML:
                        mode = SC_IV_LOOKFORWARD;
                        break;

                /* C-like (structured) languages benefit from the "look both" method */
                case SCLEX_CPP:
                case SCLEX_HTML:
                case SCLEX_PHPSCRIPT:
                case SCLEX_XML:
                case SCLEX_PERL:
                case SCLEX_LATEX:
                case SCLEX_LUA:
                case SCLEX_PASCAL:
                case SCLEX_RUBY:
                case SCLEX_TCL:
                case SCLEX_F77:
                case SCLEX_CSS:
                case SCLEX_BASH:
                case SCLEX_VHDL:
                case SCLEX_FREEBASIC:
                case SCLEX_D:
                case SCLEX_OCTAVE:
                case SCLEX_RUST:
                        mode = SC_IV_LOOKBOTH;
                        break;

                default:
                        mode = SC_IV_REAL;
                        break;
        }

        sci_set_indentation_guides(editor->sci, mode);
}


/* Apply non-document prefs that can change in the Preferences dialog */
void editor_apply_update_prefs(GeanyEditor *editor)
{
        ScintillaObject *sci;
        int caret_y_policy;

        g_return_if_fail(editor != NULL);

        if (main_status.quitting)
                return;

        sci = editor->sci;

        sci_set_mark_long_lines(sci, editor_get_long_line_type(),
                editor_get_long_line_column(), editor_prefs.long_line_color);

        /* update indent width, tab width */
        editor_set_indent(editor, editor->indent_type, editor->indent_width);
        sci_set_tab_indents(sci, editor_prefs.use_tab_to_indent);

        sci_assign_cmdkey(sci, SCK_HOME | (SCMOD_SHIFT << 16),
                editor_prefs.smart_home_key ? SCI_VCHOMEEXTEND : SCI_HOMEEXTEND);
        sci_assign_cmdkey(sci, SCK_HOME | ((SCMOD_SHIFT | SCMOD_ALT) << 16),
                editor_prefs.smart_home_key ? SCI_VCHOMERECTEXTEND : SCI_HOMERECTEXTEND);

        sci_set_autoc_max_height(sci, editor_prefs.symbolcompletion_max_height);
        SSM(sci, SCI_AUTOCSETDROPRESTOFWORD, editor_prefs.completion_drops_rest_of_word, 0);

        editor_set_indentation_guides(editor);

        sci_set_visible_white_spaces(sci, editor_prefs.show_white_space);
        sci_set_visible_eols(sci, editor_prefs.show_line_endings);
        sci_set_symbol_margin(sci, editor_prefs.show_markers_margin);
        sci_set_line_numbers(sci, editor_prefs.show_linenumber_margin);

        sci_set_folding_margin_visible(sci, editor_prefs.folding);

        /* virtual space */
        SSM(sci, SCI_SETVIRTUALSPACEOPTIONS, editor_prefs.show_virtual_space, 0);

        /* caret Y policy */
        caret_y_policy = CARET_EVEN;
        if (editor_prefs.scroll_lines_around_cursor > 0)
                caret_y_policy |= CARET_SLOP | CARET_STRICT;
        sci_set_caret_policy_y(sci, caret_y_policy, editor_prefs.scroll_lines_around_cursor);

        /* (dis)allow scrolling past end of document */
        sci_set_scroll_stop_at_last_line(sci, editor_prefs.scroll_stop_at_last_line);

        sci_set_scrollbar_mode(sci, editor_prefs.show_scrollbars);
}


/* This is for tab-indents, space aligns formatted code. Spaces should be preserved. */
static void change_tab_indentation(GeanyEditor *editor, gint line, gboolean increase)
{
        ScintillaObject *sci = editor->sci;
        gint pos = sci_get_position_from_line(sci, line);

        if (increase)
        {
                sci_insert_text(sci, pos, "\t");
        }
        else
        {
                if (sci_get_char_at(sci, pos) == '\t')
                {
                        sci_set_selection(sci, pos, pos + 1);
                        sci_replace_sel(sci, "");
                }
                else /* remove spaces only if no tabs */
                {
                        gint width = sci_get_line_indentation(sci, line);

                        width -= editor_get_indent_prefs(editor)->width;
                        sci_set_line_indentation(sci, line, width);
                }
        }
}


static void editor_change_line_indent(GeanyEditor *editor, gint line, gboolean increase)
{
        const GeanyIndentPrefs *iprefs = editor_get_indent_prefs(editor);
        ScintillaObject *sci = editor->sci;

        if (iprefs->type == GEANY_INDENT_TYPE_TABS)
                change_tab_indentation(editor, line, increase);
        else
        {
                gint width = sci_get_line_indentation(sci, line);

                width += increase ? iprefs->width : -iprefs->width;
                sci_set_line_indentation(sci, line, width);
        }
}


void editor_indent(GeanyEditor *editor, gboolean increase)
{
        ScintillaObject *sci = editor->sci;
        gint caret_pos, caret_line, caret_offset, caret_indent_pos, caret_line_len;
        gint anchor_pos, anchor_line, anchor_offset, anchor_indent_pos, anchor_line_len;

        /* backup information needed to restore caret and anchor */
        caret_pos = sci_get_current_position(sci);
        anchor_pos = SSM(sci, SCI_GETANCHOR, 0, 0);
        caret_line = sci_get_line_from_position(sci, caret_pos);
        anchor_line = sci_get_line_from_position(sci, anchor_pos);
        caret_offset = caret_pos - sci_get_position_from_line(sci, caret_line);
        anchor_offset = anchor_pos - sci_get_position_from_line(sci, anchor_line);
        caret_indent_pos = sci_get_line_indent_position(sci, caret_line);
        anchor_indent_pos = sci_get_line_indent_position(sci, anchor_line);
        caret_line_len = sci_get_line_length(sci, caret_line);
        anchor_line_len = sci_get_line_length(sci, anchor_line);

        if (sci_get_lines_selected(sci) <= 1)
        {
                editor_change_line_indent(editor, sci_get_current_line(sci), increase);
        }
        else
        {
                gint start, end;
                gint line, lstart, lend;

                editor_select_lines(editor, FALSE);
                start = sci_get_selection_start(sci);
                end = sci_get_selection_end(sci);
                lstart = sci_get_line_from_position(sci, start);
                lend = sci_get_line_from_position(sci, end);
                if (end == sci_get_length(sci))
                        lend++; /* for last line with text on it */

                sci_start_undo_action(sci);
                for (line = lstart; line < lend; line++)
                {
                        editor_change_line_indent(editor, line, increase);
                }
                sci_end_undo_action(sci);
        }

        /* restore caret and anchor position */
        if (caret_pos >= caret_indent_pos)
                caret_offset += sci_get_line_length(sci, caret_line) - caret_line_len;
        if (anchor_pos >= anchor_indent_pos)
                anchor_offset += sci_get_line_length(sci, anchor_line) - anchor_line_len;

        SSM(sci, SCI_SETCURRENTPOS, sci_get_position_from_line(sci, caret_line) + caret_offset, 0);
        SSM(sci, SCI_SETANCHOR, sci_get_position_from_line(sci, anchor_line) + anchor_offset, 0);
}


/** Gets snippet by name.
 *
 * If @a editor is passed, returns a snippet specific to the document filetype.
 * If @a editor is @c NULL, returns a snippet from the default set.
 *
 * @param editor @nullable Editor or @c NULL.
 * @param snippet_name Snippet name.
 * @return @nullable snippet or @c NULL if it was not found. Must not be freed.
 */
GEANY_API_SYMBOL
const gchar *editor_find_snippet(GeanyEditor *editor, const gchar *snippet_name)
{
        const gchar *subhash_name = editor ? editor->document->file_type->name : "Default";
        GHashTable *subhash = g_hash_table_lookup(snippet_hash, subhash_name);

        return subhash ? g_hash_table_lookup(subhash, snippet_name) : NULL;
}


/** Replaces all special sequences in @a snippet and inserts it at @a pos.
 * If you insert at the current position, consider calling @c sci_scroll_caret()
 * after this function.
 * @param editor .
 * @param pos .
 * @param snippet .
 */
GEANY_API_SYMBOL
void editor_insert_snippet(GeanyEditor *editor, gint pos, const gchar *snippet)
{
        GString *pattern;

        pattern = g_string_new(snippet);
        snippets_make_replacements(editor, pattern);
        editor_insert_text_block(editor, pattern->str, pos, -1, -1, TRUE);
        g_string_free(pattern, TRUE);
}

static void        *copy_(void *src) { return src; }
static void         free_(void *doc) { }

/** @gironly
 * Gets the GType of GeanyEditor
 *
 * @return the GeanyEditor type */
GEANY_API_SYMBOL
GType editor_get_type (void);

G_DEFINE_BOXED_TYPE(GeanyEditor, editor, copy_, free_);