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