Mercurial > emacs
annotate src/indent.h @ 94409:e0901c47caf2
Massive changes in all parts of the documentation.
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Sun, 27 Apr 2008 18:18:27 +0000 |
parents | 107ccd98fa12 |
children | 606f2d163a64 29adfc9354e7 |
rev | line source |
---|---|
484 | 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 | 3 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
484 | 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 | |
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 | 10 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; see the file COPYING. If not, write to | |
64084 | 19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 Boston, MA 02110-1301, USA. */ | |
484 | 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 | 39 |
40 struct position | |
41 { | |
84951 | 42 EMACS_INT bufpos; |
43 EMACS_INT bytepos; | |
44 EMACS_INT hpos; | |
45 EMACS_INT vpos; | |
46 EMACS_INT prevhpos; | |
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 | 50 EMACS_INT ovstring_chars_done; |
51 EMACS_INT tab_offset; | |
484 | 52 }; |
53 | |
84951 | 54 struct position *compute_motion P_ ((EMACS_INT from, EMACS_INT fromvpos, |
55 EMACS_INT fromhpos, int did_motion, | |
56 EMACS_INT to, EMACS_INT tovpos, | |
57 EMACS_INT tohpos, | |
58 EMACS_INT width, EMACS_INT hscroll, | |
59 EMACS_INT tab_offset, struct window *)); | |
60 struct position *vmotion P_ ((EMACS_INT from, EMACS_INT vtarget, | |
61 struct window *)); | |
62 EMACS_INT skip_invisible P_ ((EMACS_INT pos, EMACS_INT *next_boundary_p, | |
63 EMACS_INT to, Lisp_Object window)); | |
484 | 64 |
65 /* Value of point when current_column was called */ | |
84951 | 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 | 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 | 81 /* arch-tag: f9feb373-5bff-4f4f-9198-94805d00cfd7 |
82 (do not change this comment) */ |