annotate src/indent.h @ 51318:0b5248964d32

Comment.
author Dave Love <fx@gnu.org>
date Thu, 29 May 2003 18:36:16 +0000
parents 23a1cea22d13
children 695cf19ef79e d7ddb3e565de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Definitions for interface to indent.c
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
2 Copyright (C) 1985, 1986 Free Software Foundation, Inc.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 9408
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 12244
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 12244
diff changeset
19 Boston, MA 02111-1307, USA. */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
21 /* We introduce new member `tab_offset'. We need it because of the
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
22 existence of wide-column characters. There is a case that the
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
23 line-break occurs at a wide-column character and the number of
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
24 colums of the line gets less than width.
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
25
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
26 Example (where W_ stands for a wide-column character):
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
27 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
28 abcdefgh\\
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
29 W_
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
30 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
31
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
32 To handle this case, we should not calculate the tab offset by
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
33 tab_offset += width;
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
34
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
35 Instead, we must remember tab_offset of the line.
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
36
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
37 */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 struct position
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 {
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 int bufpos;
20540
64b4e34d34c2 (struct position): New field bytepos.
Richard M. Stallman <rms@gnu.org>
parents: 17018
diff changeset
42 int bytepos;
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 int hpos;
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44 int vpos;
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 int prevhpos;
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
46 int contin;
16403
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
47 /* Number of characters we have already handled
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
48 from the before and after strings at this position. */
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
49 int ovstring_chars_done;
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
50 int tab_offset;
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51 };
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
53 struct position *compute_motion P_ ((int, int, int, int, int, int, int,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
54 int, int, int, struct window *));
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
55 struct position *vmotion P_ ((int, int, struct window *));
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
56 int skip_invisible P_ ((int, int *, int, Lisp_Object));
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 /* Value of point when current_column was called */
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 extern int last_known_column_point;
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
60
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
61 /* Functions for dealing with the column cache. */
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
62
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
63 /* Return true iff the display table DISPTAB specifies the same widths
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
64 for characters as WIDTHTAB. We use this to decide when to
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
65 invalidate the buffer's column_cache. */
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
66 int disptab_matches_widthtab P_ ((struct Lisp_Char_Table *disptab,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
67 struct Lisp_Vector *widthtab));
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
68
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
69 /* Recompute BUF's width table, using the display table DISPTAB. */
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
70 void recompute_width_table P_ ((struct buffer *buf,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
71 struct Lisp_Char_Table *disptab));
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
72
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
73