src/indent.h

   1 /* Definitions for interface to indent.c
   2    Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008, 2009, 2010, 2011  Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs 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 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs 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
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /* We introduce new member `tab_offset'.  We need it because of the
  21    existence of wide-column characters.  There is a case that the
  22    line-break occurs at a wide-column character and the number of
  23    colums of the line gets less than width.
  24
  25    Example (where W_ stands for a wide-column character):
  26              ----------
  27              abcdefgh\\
  28              W_
  29              ----------
  30
  31    To handle this case, we should not calculate the tab offset by
  32         tab_offset += width;
  33
  34    Instead, we must remember tab_offset of the line.
  35
  36  */
  37
  38 struct position
  39   {
  40     EMACS_INT bufpos;
  41     EMACS_INT bytepos;
  42     EMACS_INT hpos;
  43     EMACS_INT vpos;
  44     EMACS_INT prevhpos;
  45     EMACS_INT contin;
  46     /* Number of characters we have already handled
  47        from the before and after strings at this position.  */
  48     EMACS_INT ovstring_chars_done;
  49     EMACS_INT tab_offset;
  50   };
  51
  52 struct position *compute_motion (EMACS_INT from, EMACS_INT fromvpos,
  53                                  EMACS_INT fromhpos, int did_motion,
  54                                  EMACS_INT to, EMACS_INT tovpos,
  55                                  EMACS_INT tohpos,
  56                                  EMACS_INT width, EMACS_INT hscroll,
  57                                  EMACS_INT tab_offset, struct window *);
  58 struct position *vmotion (EMACS_INT from, EMACS_INT vtarget,
  59                           struct window *);
  60 EMACS_INT skip_invisible (EMACS_INT pos, EMACS_INT *next_boundary_p,
  61                           EMACS_INT to, Lisp_Object window);
  62
  63 /* Value of point when current_column was called */
  64 extern EMACS_INT last_known_column_point;
  65
  66 /* Functions for dealing with the column cache.  */
  67
  68 /* Return true if the display table DISPTAB specifies the same widths
  69    for characters as WIDTHTAB.  We use this to decide when to
  70    invalidate the buffer's column_cache.  */
  71 int disptab_matches_widthtab (struct Lisp_Char_Table *disptab,
  72                               struct Lisp_Vector *widthtab);
  73
  74 /* Recompute BUF's width table, using the display table DISPTAB.  */
  75 void recompute_width_table (struct buffer *buf,
  76                             struct Lisp_Char_Table *disptab);
  77
  78