src/editor.h

   1 /*
   2  *      editor.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22
  23 #ifndef GEANY_EDITOR_H
  24 #define GEANY_EDITOR_H 1
  25
  26 G_BEGIN_DECLS
  27
  28 #include "Scintilla.h"
  29 #include "ScintillaWidget.h"
  30
  31 /** Default character set to define which characters should be treated as part of a word. */
  32 #define GEANY_WORDCHARS                                 "_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
  33 #define GEANY_MAX_WORD_LENGTH                   192
  34
  35
  36 /** Whether to use tabs, spaces or both to indent. */
  37 typedef enum
  38 {
  39         GEANY_INDENT_TYPE_SPACES,       /**< Spaces. */
  40         GEANY_INDENT_TYPE_TABS,         /**< Tabs. */
  41         GEANY_INDENT_TYPE_BOTH          /**< Both. */
  42 }
  43 GeanyIndentType;
  44
  45 typedef enum
  46 {
  47         GEANY_AUTOINDENT_NONE = 0,
  48         GEANY_AUTOINDENT_BASIC,
  49         GEANY_AUTOINDENT_CURRENTCHARS,
  50         GEANY_AUTOINDENT_MATCHBRACES
  51 }
  52 GeanyAutoIndent;
  53
  54 typedef enum
  55 {
  56         GEANY_VIRTUAL_SPACE_DISABLED = 0,
  57         GEANY_VIRTUAL_SPACE_SELECTION = 1,
  58         GEANY_VIRTUAL_SPACE_ALWAYS = 3
  59 }
  60 GeanyVirtualSpace;
  61
  62
  63 /* Auto-close brackets/quotes */
  64 enum {
  65         GEANY_AC_PARENTHESIS    = 1,
  66         GEANY_AC_CBRACKET               = 2,
  67         GEANY_AC_SBRACKET               = 4,
  68         GEANY_AC_SQUOTE                 = 8,
  69         GEANY_AC_DQUOTE                 = 16
  70 };
  71
  72 /** Geany indicator types, can be used with Editor indicator functions to highlight
  73  *  text in the document. */
  74 typedef enum
  75 {
  76         /** Indicator to highlight errors in the document text. This is a red squiggly underline. */
  77         GEANY_INDICATOR_ERROR = 0,
  78         /** Indicator used to highlight search results in the document. This is a
  79          *  rounded box around the text. */
  80         /* start container indicator outside of lexer indicators (0..7), see Scintilla docs */
  81         GEANY_INDICATOR_SEARCH = 8
  82 }
  83 GeanyIndicator;
  84
  85 /** Indentation prefs that might be different according to project or filetype.
  86  * Use @c editor_get_indent_prefs() to lookup the prefs for a particular document.
  87  *
  88  * @since 0.15
  89  **/
  90 typedef struct GeanyIndentPrefs
  91 {
  92         gint                    width;                          /**< Indent width. */
  93         GeanyIndentType type;                           /**< Whether to use tabs, spaces or both to indent. */
  94         /** Width of a tab, but only when using GEANY_INDENT_TYPE_BOTH.
  95          * To get the display tab width, use sci_get_tab_width(). */
  96         gint                    hard_tab_width;
  97         GeanyAutoIndent auto_indent_mode;
  98         gboolean                detect_type;
  99         gboolean                detect_width;
 100 }
 101 GeanyIndentPrefs;
 102
 103
 104 /** Default prefs when creating a new editor window.
 105  * Some of these can be overridden per document or per project. */
 106 /* See editor_get_prefs(). */
 107 typedef struct GeanyEditorPrefs
 108 {
 109         GeanyIndentPrefs *indentation;  /* Default indentation prefs. Use editor_get_indent_prefs(). */
 110         gboolean        show_white_space;
 111         gboolean        show_indent_guide;
 112         gboolean        show_line_endings;
 113         /* 0 - line, 1 - background, 2 - disabled.
 114          * This setting may be overridden when a project is opened. Use @c editor_get_prefs(). */
 115         gint            long_line_type;
 116         /* This setting may be overridden when a project is opened. Use @c editor_get_prefs(). */
 117         gint            long_line_column;
 118         gchar           *long_line_color;
 119         gboolean        show_markers_margin;            /* view menu */
 120         gboolean        show_linenumber_margin;         /* view menu */
 121         gboolean        show_scrollbars;                        /* hidden pref */
 122         gboolean        scroll_stop_at_last_line;
 123         gboolean        line_wrapping;
 124         gboolean        use_indicators;
 125         gboolean        folding;
 126         gboolean        unfold_all_children;
 127         gboolean        disable_dnd;
 128         gboolean        use_tab_to_indent;      /* makes tab key indent instead of insert a tab char */
 129         gboolean        smart_home_key;
 130         gboolean        newline_strip;
 131         gboolean        auto_complete_symbols;
 132         gboolean        auto_close_xml_tags;
 133         gboolean        complete_snippets;
 134         gint            symbolcompletion_min_chars;
 135         gint            symbolcompletion_max_height;
 136         gboolean        brace_match_ltgt;       /* whether to highlight < and > chars (hidden pref) */
 137         gboolean        use_gtk_word_boundaries;        /* hidden pref */
 138         gboolean        complete_snippets_whilst_editing;       /* hidden pref */
 139         gint            line_break_column;
 140         gboolean        auto_continue_multiline;
 141         gchar           *comment_toggle_mark;
 142         guint           autocompletion_max_entries;
 143         guint           autoclose_chars;
 144         gboolean        autocomplete_doc_words;
 145         gboolean        completion_drops_rest_of_word;
 146         gchar           *color_scheme;
 147         gint            show_virtual_space;
 148         /* This setting may be overridden when a project is opened. Use @c editor_get_prefs(). */
 149         gboolean        long_line_enabled;
 150         gint            autocompletion_update_freq;
 151 }
 152 GeanyEditorPrefs;
 153
 154 extern GeanyEditorPrefs editor_prefs;
 155
 156
 157 /** Editor-owned fields for each document. */
 158 struct GeanyEditor
 159 {
 160         GeanyDocument   *document;              /**< The document associated with the editor. */
 161         ScintillaObject *sci;                   /**< The Scintilla editor @c GtkWidget. */
 162         gboolean                 line_wrapping; /**< @c TRUE if line wrapping is enabled. */
 163         gboolean                 auto_indent;   /**< @c TRUE if auto-indentation is enabled. */
 164         /** Percentage to scroll view by on paint, if positive. */
 165         gfloat                   scroll_percent;
 166         GeanyIndentType  indent_type;   /* Use editor_get_indent_prefs() instead. */
 167         gboolean                 line_breaking; /**< Whether to split long lines as you type. */
 168         gint                     indent_width;
 169 };
 170
 171
 172 typedef struct
 173 {
 174         gchar   *current_word;  /* holds word under the mouse or keyboard cursor */
 175         gint    click_pos;              /* text position where the mouse was clicked */
 176 } EditorInfo;
 177
 178 extern EditorInfo editor_info;
 179
 180 typedef struct SCNotification SCNotification;
 181
 182
 183 void editor_init(void);
 184
 185 GeanyEditor *editor_create(GeanyDocument *doc);
 186
 187 void editor_destroy(GeanyEditor *editor);
 188
 189 ScintillaObject *editor_create_widget(GeanyEditor *editor);
 190
 191 void editor_sci_notify_cb(GtkWidget *widget, gint scn, gpointer scnt, gpointer data);
 192
 193 gboolean editor_start_auto_complete(GeanyEditor *editor, gint pos, gboolean force);
 194
 195 gboolean editor_complete_word_part(GeanyEditor *editor);
 196
 197 void editor_goto_next_snippet_cursor(GeanyEditor *editor);
 198
 199 gboolean editor_complete_snippet(GeanyEditor *editor, gint pos);
 200
 201 void editor_show_macro_list(GeanyEditor *editor);
 202
 203 gboolean editor_show_calltip(GeanyEditor *editor, gint pos);
 204
 205 void editor_do_comment_toggle(GeanyEditor *editor);
 206
 207 gint editor_do_comment(GeanyEditor *editor, gint line, gboolean allow_empty_lines, gboolean toggle,
 208                 gboolean single_comment);
 209
 210 gint editor_do_uncomment(GeanyEditor *editor, gint line, gboolean toggle);
 211
 212 void editor_insert_multiline_comment(GeanyEditor *editor);
 213
 214 void editor_insert_alternative_whitespace(GeanyEditor *editor);
 215
 216 void editor_indent(GeanyEditor *editor, gboolean increase);
 217
 218 void editor_smart_line_indentation(GeanyEditor *editor, gint pos);
 219
 220 void editor_indentation_by_one_space(GeanyEditor *editor, gint pos, gboolean decrease);
 221
 222 gboolean editor_line_in_view(GeanyEditor *editor, gint line);
 223
 224 void editor_scroll_to_line(GeanyEditor *editor, gint line, gfloat percent_of_view);
 225
 226 void editor_display_current_line(GeanyEditor *editor, gfloat percent_of_view);
 227
 228 void editor_finalize(void);
 229
 230 void editor_snippets_init(void);
 231
 232 void editor_snippets_free(void);
 233
 234 const GeanyEditorPrefs *editor_get_prefs(GeanyEditor *editor);
 235
 236
 237 /* General editing functions */
 238
 239 void editor_find_current_word(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen,
 240         const gchar *wc);
 241
 242 void editor_find_current_word_sciwc(GeanyEditor *editor, gint pos, gchar *word, gsize wordlen);
 243
 244 gchar *editor_get_word_at_pos(GeanyEditor *editor, gint pos, const gchar *wordchars);
 245
 246 gchar *editor_get_default_selection(GeanyEditor *editor, gboolean use_current_word, const gchar *wordchars);
 247
 248
 249 void editor_select_word(GeanyEditor *editor);
 250
 251 void editor_select_lines(GeanyEditor *editor, gboolean extra_line);
 252
 253 void editor_select_paragraph(GeanyEditor *editor);
 254
 255 void editor_select_indent_block(GeanyEditor *editor);
 256
 257
 258 void editor_set_font(GeanyEditor *editor, const gchar *font);
 259
 260 void editor_indicator_set_on_line(GeanyEditor *editor, gint indic, gint line);
 261
 262 void editor_indicator_clear_errors(GeanyEditor *editor);
 263
 264 void editor_indicator_set_on_range(GeanyEditor *editor, gint indic, gint start, gint end);
 265
 266 void editor_indicator_clear(GeanyEditor *editor, gint indic);
 267
 268 gint editor_get_eol_char_mode(GeanyEditor *editor);
 269
 270 const gchar *editor_get_eol_char_name(GeanyEditor *editor);
 271
 272 gint editor_get_eol_char_len(GeanyEditor *editor);
 273
 274 const gchar *editor_get_eol_char(GeanyEditor *editor);
 275
 276 void editor_fold_all(GeanyEditor *editor);
 277
 278 void editor_unfold_all(GeanyEditor *editor);
 279
 280 void editor_replace_tabs(GeanyEditor *editor);
 281
 282 void editor_replace_spaces(GeanyEditor *editor);
 283
 284 void editor_strip_line_trailing_spaces(GeanyEditor *editor, gint line);
 285
 286 void editor_strip_trailing_spaces(GeanyEditor *editor);
 287
 288 void editor_ensure_final_newline(GeanyEditor *editor);
 289
 290 void editor_insert_color(GeanyEditor *editor, const gchar *colour);
 291
 292 const GeanyIndentPrefs *editor_get_indent_prefs(GeanyEditor *editor);
 293
 294 void editor_set_indent_type(GeanyEditor *editor, GeanyIndentType type);
 295
 296 void editor_set_indent_width(GeanyEditor *editor, gint width);
 297
 298 void editor_set_indent(GeanyEditor *editor, GeanyIndentType type, gint width);
 299
 300 void editor_set_line_wrapping(GeanyEditor *editor, gboolean wrap);
 301
 302 gboolean editor_goto_pos(GeanyEditor *editor, gint pos, gboolean mark);
 303
 304 gboolean editor_goto_line(GeanyEditor *editor, gint line_no, gint offset);
 305
 306 void editor_set_indentation_guides(GeanyEditor *editor);
 307
 308 void editor_apply_update_prefs(GeanyEditor *editor);
 309
 310 gchar *editor_get_calltip_text(GeanyEditor *editor, const TMTag *tag);
 311
 312 void editor_insert_text_block(GeanyEditor *editor, const gchar *text,
 313                                                           gint insert_pos, gint cursor_index,
 314                                                           gint newline_indent_size, gboolean replace_newlines);
 315
 316 void editor_toggle_fold(GeanyEditor *editor, gint line, gint modifiers);
 317
 318 const gchar *editor_find_snippet(GeanyEditor *editor, const gchar *snippet_name);
 319
 320 void editor_insert_snippet(GeanyEditor *editor, gint pos, const gchar *snippet);
 321
 322 G_END_DECLS
 323
 324 #endif