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