src/editor/edit.h

   1 /* edit.h - editor public API
   2
   3    Copyright (C) 1996, 1997, 2009 Free Software Foundation, Inc.
   4
   5    Authors: 1996, 1997 Paul Sheer
   6    2009 Andrew Borodin
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22  */
  23
  24 /** \file edit.h
  25  *  \brief Header: editor public API
  26  *  \author Paul Sheer
  27  *  \date 1996, 1997
  28  *  \author Andrew Borodin
  29  *  \date 2009
  30  */
  31
  32 #ifndef MC__EDIT_H
  33 #define MC__EDIT_H
  34
  35 #include "lib/global.h"         /* PATH_SEP_STR */
  36 #include "lib/fileloc.h"
  37
  38 /*** typedefs(not structures) and defined constants **********************************************/
  39
  40 #define DEFAULT_WRAP_LINE_LENGTH 72
  41
  42 /*** enums ***************************************************************************************/
  43
  44 /*** structures declarations (and typedefs of structures)*****************************************/
  45
  46 /* Editor widget */
  47 struct WEdit;
  48 typedef struct WEdit WEdit;
  49
  50 /*** global variables defined in .c file *********************************************************/
  51
  52 extern int option_word_wrap_line_length;
  53 extern int option_typewriter_wrap;
  54 extern int option_auto_para_formatting;
  55 extern int option_fill_tabs_with_spaces;
  56 extern int option_return_does_auto_indent;
  57 extern int option_backspace_through_tabs;
  58 extern int option_fake_half_tabs;
  59 extern int option_persistent_selections;
  60 extern int option_cursor_beyond_eol;
  61 extern int option_line_state;
  62 extern int option_save_mode;
  63 extern int option_save_position;
  64 extern int option_syntax_highlighting;
  65 extern int option_group_undo;
  66 extern char *option_backup_ext;
  67
  68 extern int edit_confirm_save;
  69
  70 extern int visible_tabs;
  71 extern int visible_tws;
  72
  73 extern int simple_statusbar;
  74 extern int option_check_nl_at_eof;
  75 extern int show_right_margin;
  76
  77 /*** declarations of public functions ************************************************************/
  78
  79 /* used in main() */
  80 void edit_stack_init (void);
  81 void edit_stack_free (void);
  82
  83 int edit_file (const char *_file, int line);
  84
  85 const char *edit_get_file_name (const WEdit * edit);
  86 int edit_get_curs_col (const WEdit * edit);
  87 const char *edit_get_syntax_type (const WEdit * edit);
  88
  89 /*** inline functions ****************************************************************************/
  90 #endif /* MC__EDIT_H */