src/editor/edit.h

   1 /*
   2    Editor public API
   3  */
   4
   5 /** \file edit.h
   6  *  \brief Header: editor public API
   7  *  \author Paul Sheer
   8  *  \date 1996, 1997
   9  *  \author Andrew Borodin
  10  *  \date 2009, 2012
  11  */
  12
  13 #ifndef MC__EDIT_H
  14 #define MC__EDIT_H
  15
  16 #include "lib/global.h"         /* PATH_SEP_STR */
  17 #include "lib/fileloc.h"
  18 #include "lib/vfs/vfs.h"        /* vfs_path_t */
  19
  20 /*** typedefs(not structures) and defined constants **********************************************/
  21
  22 #define DEFAULT_WRAP_LINE_LENGTH 72
  23
  24 /*** enums ***************************************************************************************/
  25
  26 /*** structures declarations (and typedefs of structures)*****************************************/
  27
  28 /* Editor widget */
  29 struct WEdit;
  30 typedef struct WEdit WEdit;
  31
  32 /*** global variables defined in .c file *********************************************************/
  33
  34 extern int option_word_wrap_line_length;
  35 extern int option_typewriter_wrap;
  36 extern int option_auto_para_formatting;
  37 extern int option_fill_tabs_with_spaces;
  38 extern int option_return_does_auto_indent;
  39 extern int option_backspace_through_tabs;
  40 extern int option_fake_half_tabs;
  41 extern int option_persistent_selections;
  42 extern int option_cursor_beyond_eol;
  43 extern gboolean option_cursor_after_inserted_block;
  44 extern int option_line_state;
  45 extern int option_save_mode;
  46 extern int option_save_position;
  47 extern int option_syntax_highlighting;
  48 extern int option_group_undo;
  49 extern char *option_backup_ext;
  50
  51 extern int edit_confirm_save;
  52
  53 extern int visible_tabs;
  54 extern int visible_tws;
  55
  56 extern int simple_statusbar;
  57 extern int option_check_nl_at_eof;
  58 extern int show_right_margin;
  59
  60 /*** declarations of public functions ************************************************************/
  61
  62 /* used in main() */
  63 void edit_stack_init (void);
  64 void edit_stack_free (void);
  65
  66 gboolean edit_file (const vfs_path_t * file_vpath, long line);
  67 gboolean edit_files (const GList * files);
  68
  69 char *edit_get_file_name (const WEdit * edit);
  70 long edit_get_curs_col (const WEdit * edit);
  71 const char *edit_get_syntax_type (const WEdit * edit);
  72
  73 /*** inline functions ****************************************************************************/
  74 #endif /* MC__EDIT_H */