annotate src/indent.h @ 91409:db373dffa2b5

Adjust dates of unicode merge entries to UTC. (unidata/UnicodeData.txt): Adjust date of copying to match unidata/README.
author Glenn Morris <rgm@gnu.org>
date Sat, 02 Feb 2008 03:48:58 +0000
parents 107ccd98fa12
children 606f2d163a64 29adfc9354e7
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
75227
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 68651
diff changeset
2 Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004,
79759
fc2bcd2a8aad Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78501
diff changeset
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 This file is part of GNU Emacs.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 GNU Emacs is free software; you can redistribute it and/or modify
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
78260
922696f363b0 Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 75227
diff changeset
9 the Free Software Foundation; either version 3, or (at your option)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 any later version.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU General Public License for more details.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 along with GNU Emacs; see the file COPYING. If not, write to
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
20 Boston, MA 02110-1301, USA. */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
22 /* 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
23 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
24 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
25 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
26
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
27 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
28 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
29 abcdefgh\\
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
30 W_
17018
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
31 ----------
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
32
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
33 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
34 tab_offset += width;
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
35
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 25026
diff changeset
36 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
37
f13a67b3ec8d (struct position): New member tab_offset to accumulate tab offset.
Karl Heuer <kwzh@gnu.org>
parents: 16403
diff changeset
38 */
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 struct position
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 {
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
42 EMACS_INT bufpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
43 EMACS_INT bytepos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
44 EMACS_INT hpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
45 EMACS_INT vpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
46 EMACS_INT prevhpos;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
47 EMACS_INT contin;
16403
a388d0109b9e (struct position): New field ovstring_chars_done.
Richard M. Stallman <rms@gnu.org>
parents: 14186
diff changeset
48 /* 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
49 from the before and after strings at this position. */
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
50 EMACS_INT ovstring_chars_done;
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
51 EMACS_INT tab_offset;
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52 };
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
54 struct position *compute_motion P_ ((EMACS_INT from, EMACS_INT fromvpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
55 EMACS_INT fromhpos, int did_motion,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
56 EMACS_INT to, EMACS_INT tovpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
57 EMACS_INT tohpos,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
58 EMACS_INT width, EMACS_INT hscroll,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
59 EMACS_INT tab_offset, struct window *));
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
60 struct position *vmotion P_ ((EMACS_INT from, EMACS_INT vtarget,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
61 struct window *));
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
62 EMACS_INT skip_invisible P_ ((EMACS_INT pos, EMACS_INT *next_boundary_p,
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
63 EMACS_INT to, Lisp_Object window));
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
65 /* Value of point when current_column was called */
84951
55a892948dea * indent.h:
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 78501
diff changeset
66 extern EMACS_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
67
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
68 /* 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
69
78501
1677cf1c2509 Replace `iff' in comments.
Glenn Morris <rgm@gnu.org>
parents: 78260
diff changeset
70 /* Return true if the display table DISPTAB specifies the same widths
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
71 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
72 invalidate the buffer's column_cache. */
25026
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
73 int disptab_matches_widthtab P_ ((struct Lisp_Char_Table *disptab,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
74 struct Lisp_Vector *widthtab));
9408
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
75
99429d6c8b4e * indent.h (disptab_matches_widthtab, recompute_width_table): New
Jim Blandy <jimb@redhat.com>
parents: 484
diff changeset
76 /* 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
77 void recompute_width_table P_ ((struct buffer *buf,
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
78 struct Lisp_Char_Table *disptab));
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
79
488e6b8dc9ae (toplevel): Add function prototypes.
Gerd Moellmann <gerd@gnu.org>
parents: 20540
diff changeset
80
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
81 /* arch-tag: f9feb373-5bff-4f4f-9198-94805d00cfd7
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
82 (do not change this comment) */