Commit | Line | Data |
---|---|---|
d427b66a | 1 | /* Cursor motion subroutines for GNU Emacs. |
429ab54e | 2 | Copyright (C) 1985, 1995, 2001, 2002, 2003, 2004, |
5df4f04c | 3 | 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. |
d427b66a JB |
4 | based primarily on public domain code written by Chris Torek |
5 | ||
6 | This file is part of GNU Emacs. | |
7 | ||
9ec0b715 | 8 | GNU Emacs is free software: you can redistribute it and/or modify |
d427b66a | 9 | it under the terms of the GNU General Public License as published by |
9ec0b715 GM |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
d427b66a JB |
12 | |
13 | GNU Emacs 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 | |
9ec0b715 | 19 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
d427b66a JB |
20 | |
21 | ||
18160b98 | 22 | #include <config.h> |
d427b66a | 23 | #include <stdio.h> |
d7306fe6 | 24 | #include <setjmp.h> |
28d440ab | 25 | |
28d440ab KL |
26 | #include "lisp.h" |
27 | #include "frame.h" | |
d427b66a JB |
28 | #include "cm.h" |
29 | #include "termhooks.h" | |
28d440ab KL |
30 | #include "termchar.h" |
31 | ||
d427b66a | 32 | |
ff23e1dd GM |
33 | /* For now, don't try to include termcap.h. On some systems, |
34 | configure finds a non-standard termcap.h that the main build | |
35 | won't find. */ | |
f57e2426 J |
36 | extern void tputs (const char *, int, int (*)(int)); |
37 | extern char *tgoto (const char *, int, int); | |
bb10ca93 | 38 | |
d427b66a JB |
39 | #define BIG 9999 /* 9999 good on VAXen. For 16 bit machines |
40 | use about 2000.... */ | |
41 | ||
d427b66a JB |
42 | extern char *BC, *UP; |
43 | ||
44 | int cost; /* sums up costs */ | |
45 | ||
46 | /* ARGSUSED */ | |
dfcf069d | 47 | int |
d3da34e0 | 48 | evalcost (int c) |
d427b66a JB |
49 | { |
50 | cost++; | |
97f11a9d | 51 | return c; |
d427b66a JB |
52 | } |
53 | ||
28d440ab | 54 | /* The terminal to use for low-level output. */ |
28d7d09f | 55 | struct tty_display_info *current_tty; |
28d440ab | 56 | |
dfcf069d | 57 | int |
d3da34e0 | 58 | cmputc (int c) |
d427b66a | 59 | { |
0b0d3e0b KL |
60 | if (current_tty->termscript) |
61 | putc (c & 0177, current_tty->termscript); | |
62 | putc (c & 0177, current_tty->output); | |
97f11a9d | 63 | return c; |
d427b66a JB |
64 | } |
65 | ||
66 | /* NEXT TWO ARE DONE WITH MACROS */ | |
67 | #if 0 | |
68 | /* | |
69 | * Assume the cursor is at row row, column col. Normally used only after | |
70 | * clearing the screen, when the cursor is at (0, 0), but what the heck, | |
71 | * let's let the guy put it anywhere. | |
72 | */ | |
73 | ||
74 | static | |
fca177d4 KL |
75 | at (tty, row, col) { |
76 | curY (tty) = row; | |
77 | curX (tty) = col; | |
d427b66a JB |
78 | } |
79 | ||
80 | /* | |
81 | * Add n columns to the current cursor position. | |
82 | */ | |
83 | ||
84 | static | |
fca177d4 KL |
85 | addcol (tty, n) { |
86 | curX (tty) += n; | |
d427b66a JB |
87 | |
88 | /* | |
89 | * If cursor hit edge of screen, what happened? | |
90 | * N.B.: DO NOT!! write past edge of screen. If you do, you | |
91 | * deserve what you get. Furthermore, on terminals with | |
92 | * autowrap (but not magicwrap), don't write in the last column | |
93 | * of the last line. | |
94 | */ | |
95 | ||
fca177d4 | 96 | if (curX (tty) == tty->Wcm->cm_cols) { |
d427b66a JB |
97 | /* |
98 | * Well, if magicwrap, still there, past the edge of the | |
99 | * screen (!). If autowrap, on the col 0 of the next line. | |
100 | * Otherwise on last column. | |
101 | */ | |
102 | ||
fca177d4 | 103 | if (tty->Wcm->cm_magicwrap) |
d427b66a | 104 | ; /* "limbo" */ |
fca177d4 KL |
105 | else if (tty->Wcm->cm_autowrap) { |
106 | curX (tty) = 0; | |
107 | curY (tty) ++; /* Beware end of screen! */ | |
d427b66a JB |
108 | } |
109 | else | |
fca177d4 | 110 | curX (tty)--; |
d427b66a JB |
111 | } |
112 | } | |
113 | #endif | |
114 | ||
902a3b86 KH |
115 | /* |
116 | * Terminals with magicwrap (xn) don't all behave identically. | |
117 | * The VT100 leaves the cursor in the last column but will wrap before | |
118 | * printing the next character. I hear that the Concept terminal does | |
119 | * the wrap immediately but ignores the next newline it sees. And some | |
120 | * terminals just have buggy firmware, and think that the cursor is still | |
121 | * in limbo if we use direct cursor addressing from the phantom column. | |
122 | * The only guaranteed safe thing to do is to emit a CRLF immediately | |
123 | * after we reach the last column; this takes us to a known state. | |
124 | */ | |
125 | void | |
28d7d09f | 126 | cmcheckmagic (struct tty_display_info *tty) |
902a3b86 | 127 | { |
6548cf00 | 128 | if (curX (tty) == FrameCols (tty)) |
902a3b86 | 129 | { |
6548cf00 | 130 | if (!MagicWrap (tty) || curY (tty) >= FrameRows (tty) - 1) |
902a3b86 | 131 | abort (); |
0b0d3e0b KL |
132 | if (tty->termscript) |
133 | putc ('\r', tty->termscript); | |
134 | putc ('\r', tty->output); | |
135 | if (tty->termscript) | |
136 | putc ('\n', tty->termscript); | |
137 | putc ('\n', tty->output); | |
6548cf00 KL |
138 | curX (tty) = 0; |
139 | curY (tty)++; | |
902a3b86 KH |
140 | } |
141 | } | |
142 | ||
143 | ||
d427b66a JB |
144 | /* |
145 | * (Re)Initialize the cost factors, given the output speed of the terminal | |
146 | * in the variable ospeed. (Note: this holds B300, B9600, etc -- ie stuff | |
147 | * out of <sgtty.h>.) | |
148 | */ | |
149 | ||
dfcf069d | 150 | void |
28d7d09f | 151 | cmcostinit (struct tty_display_info *tty) |
d427b66a JB |
152 | { |
153 | char *p; | |
154 | ||
155 | #define COST(x,e) (x ? (cost = 0, tputs (x, 1, e), cost) : BIG) | |
156 | #define CMCOST(x,e) ((x == 0) ? BIG : (p = tgoto(x, 0, 0), COST(p ,e))) | |
157 | ||
6548cf00 KL |
158 | tty->Wcm->cc_up = COST (tty->Wcm->cm_up, evalcost); |
159 | tty->Wcm->cc_down = COST (tty->Wcm->cm_down, evalcost); | |
160 | tty->Wcm->cc_left = COST (tty->Wcm->cm_left, evalcost); | |
161 | tty->Wcm->cc_right = COST (tty->Wcm->cm_right, evalcost); | |
162 | tty->Wcm->cc_home = COST (tty->Wcm->cm_home, evalcost); | |
163 | tty->Wcm->cc_cr = COST (tty->Wcm->cm_cr, evalcost); | |
164 | tty->Wcm->cc_ll = COST (tty->Wcm->cm_ll, evalcost); | |
165 | tty->Wcm->cc_tab = tty->Wcm->cm_tabwidth ? COST (tty->Wcm->cm_tab, evalcost) : BIG; | |
d427b66a JB |
166 | |
167 | /* | |
168 | * These last three are actually minimum costs. When (if) they are | |
169 | * candidates for the least-cost motion, the real cost is computed. | |
170 | * (Note that "0" is the assumed to generate the minimum cost. | |
171 | * While this is not necessarily true, I have yet to see a terminal | |
172 | * for which is not; all the terminals that have variable-cost | |
173 | * cursor motion seem to take straight numeric values. --ACT) | |
174 | */ | |
175 | ||
6548cf00 KL |
176 | tty->Wcm->cc_abs = CMCOST (tty->Wcm->cm_abs, evalcost); |
177 | tty->Wcm->cc_habs = CMCOST (tty->Wcm->cm_habs, evalcost); | |
178 | tty->Wcm->cc_vabs = CMCOST (tty->Wcm->cm_vabs, evalcost); | |
d427b66a JB |
179 | |
180 | #undef CMCOST | |
181 | #undef COST | |
182 | } | |
183 | ||
184 | /* | |
185 | * Calculate the cost to move from (srcy, srcx) to (dsty, dstx) using | |
186 | * up and down, and left and right, motions, and tabs. If doit is set | |
187 | * actually perform the motion. | |
188 | */ | |
189 | ||
dfcf069d | 190 | static int |
28d7d09f KL |
191 | calccost (struct tty_display_info *tty, |
192 | int srcy, int srcx, int dsty, int dstx, int doit) | |
d427b66a JB |
193 | { |
194 | register int deltay, | |
195 | deltax, | |
196 | c, | |
197 | totalcost; | |
198 | int ntabs, | |
199 | n2tabs, | |
200 | tabx, | |
201 | tab2x, | |
202 | tabcost; | |
203 | register char *p; | |
204 | ||
205 | /* If have just wrapped on a terminal with xn, | |
206 | don't believe the cursor position: give up here | |
207 | and force use of absolute positioning. */ | |
208 | ||
6548cf00 | 209 | if (curX (tty) == tty->Wcm->cm_cols) |
d427b66a JB |
210 | goto fail; |
211 | ||
212 | totalcost = 0; | |
213 | if ((deltay = dsty - srcy) == 0) | |
214 | goto x; | |
215 | if (deltay < 0) | |
6548cf00 | 216 | p = tty->Wcm->cm_up, c = tty->Wcm->cc_up, deltay = -deltay; |
d427b66a | 217 | else |
6548cf00 | 218 | p = tty->Wcm->cm_down, c = tty->Wcm->cc_down; |
d427b66a JB |
219 | if (c == BIG) { /* caint get thar from here */ |
220 | if (doit) | |
221 | printf ("OOPS"); | |
222 | return c; | |
223 | } | |
224 | totalcost = c * deltay; | |
225 | if (doit) | |
226 | while (--deltay >= 0) | |
28d440ab | 227 | emacs_tputs (tty, p, 1, cmputc); |
177c0ea7 | 228 | x: |
d427b66a JB |
229 | if ((deltax = dstx - srcx) == 0) |
230 | goto done; | |
231 | if (deltax < 0) { | |
6548cf00 | 232 | p = tty->Wcm->cm_left, c = tty->Wcm->cc_left, deltax = -deltax; |
d427b66a JB |
233 | goto dodelta; /* skip all the tab junk */ |
234 | } | |
235 | /* Tabs (the toughie) */ | |
6548cf00 | 236 | if (tty->Wcm->cc_tab >= BIG || !tty->Wcm->cm_usetabs) |
d427b66a JB |
237 | goto olddelta; /* forget it! */ |
238 | ||
177c0ea7 | 239 | /* |
d427b66a JB |
240 | * ntabs is # tabs towards but not past dstx; n2tabs is one more |
241 | * (ie past dstx), but this is only valid if that is not past the | |
242 | * right edge of the screen. We can check that at the same time | |
243 | * as we figure out where we would be if we use the tabs (which | |
244 | * we will put into tabx (for ntabs) and tab2x (for n2tabs)). | |
245 | */ | |
246 | ||
6548cf00 | 247 | ntabs = (deltax + srcx % tty->Wcm->cm_tabwidth) / tty->Wcm->cm_tabwidth; |
d427b66a | 248 | n2tabs = ntabs + 1; |
6548cf00 KL |
249 | tabx = (srcx / tty->Wcm->cm_tabwidth + ntabs) * tty->Wcm->cm_tabwidth; |
250 | tab2x = tabx + tty->Wcm->cm_tabwidth; | |
d427b66a | 251 | |
6548cf00 | 252 | if (tab2x >= tty->Wcm->cm_cols) /* too far (past edge) */ |
d427b66a JB |
253 | n2tabs = 0; |
254 | ||
177c0ea7 | 255 | /* |
d427b66a JB |
256 | * Now set tabcost to the cost for using ntabs, and c to the cost |
257 | * for using n2tabs, then pick the minimum. | |
258 | */ | |
259 | ||
c3b4957f | 260 | /* cost for ntabs + cost for right motion */ |
6548cf00 | 261 | tabcost = ntabs ? ntabs * tty->Wcm->cc_tab + (dstx - tabx) * tty->Wcm->cc_right |
d427b66a JB |
262 | : BIG; |
263 | ||
c3b4957f | 264 | /* cost for n2tabs + cost for left motion */ |
6548cf00 | 265 | c = n2tabs ? n2tabs * tty->Wcm->cc_tab + (tab2x - dstx) * tty->Wcm->cc_left |
d427b66a JB |
266 | : BIG; |
267 | ||
268 | if (c < tabcost) /* then cheaper to overshoot & back up */ | |
269 | ntabs = n2tabs, tabcost = c, tabx = tab2x; | |
270 | ||
271 | if (tabcost >= BIG) /* caint use tabs */ | |
272 | goto newdelta; | |
273 | ||
177c0ea7 | 274 | /* |
d427b66a JB |
275 | * See if tabcost is less than just moving right |
276 | */ | |
277 | ||
6548cf00 | 278 | if (tabcost < (deltax * tty->Wcm->cc_right)) { |
d427b66a JB |
279 | totalcost += tabcost; /* use the tabs */ |
280 | if (doit) | |
281 | while (--ntabs >= 0) | |
6548cf00 | 282 | emacs_tputs (tty, tty->Wcm->cm_tab, 1, cmputc); |
d427b66a JB |
283 | srcx = tabx; |
284 | } | |
285 | ||
177c0ea7 | 286 | /* |
d427b66a JB |
287 | * Now might as well just recompute the delta. |
288 | */ | |
289 | ||
177c0ea7 | 290 | newdelta: |
d427b66a JB |
291 | if ((deltax = dstx - srcx) == 0) |
292 | goto done; | |
177c0ea7 | 293 | olddelta: |
d427b66a | 294 | if (deltax > 0) |
6548cf00 | 295 | p = tty->Wcm->cm_right, c = tty->Wcm->cc_right; |
d427b66a | 296 | else |
6548cf00 | 297 | p = tty->Wcm->cm_left, c = tty->Wcm->cc_left, deltax = -deltax; |
d427b66a | 298 | |
177c0ea7 | 299 | dodelta: |
d427b66a JB |
300 | if (c == BIG) { /* caint get thar from here */ |
301 | fail: | |
302 | if (doit) | |
303 | printf ("OOPS"); | |
304 | return BIG; | |
305 | } | |
306 | totalcost += c * deltax; | |
307 | if (doit) | |
308 | while (--deltax >= 0) | |
28d440ab | 309 | emacs_tputs (tty, p, 1, cmputc); |
177c0ea7 | 310 | done: |
d427b66a JB |
311 | return totalcost; |
312 | } | |
313 | ||
314 | #if 0 | |
315 | losecursor () | |
316 | { | |
317 | curY = -1; | |
318 | } | |
319 | #endif | |
320 | ||
321 | #define USEREL 0 | |
322 | #define USEHOME 1 | |
323 | #define USELL 2 | |
324 | #define USECR 3 | |
325 | ||
dfcf069d | 326 | void |
d3da34e0 | 327 | cmgoto (struct tty_display_info *tty, int row, int col) |
d427b66a JB |
328 | { |
329 | int homecost, | |
330 | crcost, | |
331 | llcost, | |
332 | relcost, | |
333 | directcost; | |
334 | int use; | |
335 | char *p, | |
336 | *dcm; | |
337 | ||
338 | /* First the degenerate case */ | |
6548cf00 | 339 | if (row == curY (tty) && col == curX (tty)) /* already there */ |
d427b66a JB |
340 | return; |
341 | ||
6548cf00 | 342 | if (curY (tty) >= 0 && curX (tty) >= 0) |
d427b66a JB |
343 | { |
344 | /* We may have quick ways to go to the upper-left, bottom-left, | |
345 | * start-of-line, or start-of-next-line. Or it might be best to | |
346 | * start where we are. Examine the options, and pick the cheapest. | |
347 | */ | |
348 | ||
6548cf00 | 349 | relcost = calccost (tty, curY (tty), curX (tty), row, col, 0); |
d427b66a | 350 | use = USEREL; |
6548cf00 | 351 | if ((homecost = tty->Wcm->cc_home) < BIG) |
28d440ab | 352 | homecost += calccost (tty, 0, 0, row, col, 0); |
d427b66a | 353 | if (homecost < relcost) |
28d440ab | 354 | relcost = homecost, use = USEHOME; |
6548cf00 KL |
355 | if ((llcost = tty->Wcm->cc_ll) < BIG) |
356 | llcost += calccost (tty, tty->Wcm->cm_rows - 1, 0, row, col, 0); | |
d427b66a | 357 | if (llcost < relcost) |
28d440ab | 358 | relcost = llcost, use = USELL; |
6548cf00 KL |
359 | if ((crcost = tty->Wcm->cc_cr) < BIG) { |
360 | if (tty->Wcm->cm_autolf) | |
361 | if (curY (tty) + 1 >= tty->Wcm->cm_rows) | |
362 | crcost = BIG; | |
d427b66a | 363 | else |
6548cf00 | 364 | crcost += calccost (tty, curY (tty) + 1, 0, row, col, 0); |
d427b66a | 365 | else |
6548cf00 | 366 | crcost += calccost (tty, curY (tty), 0, row, col, 0); |
d427b66a JB |
367 | } |
368 | if (crcost < relcost) | |
369 | relcost = crcost, use = USECR; | |
6548cf00 KL |
370 | directcost = tty->Wcm->cc_abs, dcm = tty->Wcm->cm_abs; |
371 | if (row == curY (tty) && tty->Wcm->cc_habs < BIG) | |
372 | directcost = tty->Wcm->cc_habs, dcm = tty->Wcm->cm_habs; | |
373 | else if (col == curX (tty) && tty->Wcm->cc_vabs < BIG) | |
374 | directcost = tty->Wcm->cc_vabs, dcm = tty->Wcm->cm_vabs; | |
d427b66a JB |
375 | } |
376 | else | |
377 | { | |
378 | directcost = 0, relcost = 100000; | |
6548cf00 | 379 | dcm = tty->Wcm->cm_abs; |
d427b66a JB |
380 | } |
381 | ||
177c0ea7 | 382 | /* |
d427b66a JB |
383 | * In the following comparison, the = in <= is because when the costs |
384 | * are the same, it looks nicer (I think) to move directly there. | |
385 | */ | |
386 | if (directcost <= relcost) | |
387 | { | |
388 | /* compute REAL direct cost */ | |
389 | cost = 0; | |
c3b4957f KL |
390 | p = (dcm == tty->Wcm->cm_habs |
391 | ? tgoto (dcm, row, col) | |
392 | : tgoto (dcm, col, row)); | |
28d440ab | 393 | emacs_tputs (tty, p, 1, evalcost); |
d427b66a JB |
394 | if (cost <= relcost) |
395 | { /* really is cheaper */ | |
28d440ab | 396 | emacs_tputs (tty, p, 1, cmputc); |
6548cf00 | 397 | curY (tty) = row, curX (tty) = col; |
d427b66a JB |
398 | return; |
399 | } | |
400 | } | |
401 | ||
402 | switch (use) | |
403 | { | |
177c0ea7 | 404 | case USEHOME: |
6548cf00 KL |
405 | emacs_tputs (tty, tty->Wcm->cm_home, 1, cmputc); |
406 | curY (tty) = 0, curX (tty) = 0; | |
d427b66a JB |
407 | break; |
408 | ||
177c0ea7 | 409 | case USELL: |
6548cf00 KL |
410 | emacs_tputs (tty, tty->Wcm->cm_ll, 1, cmputc); |
411 | curY (tty) = tty->Wcm->cm_rows - 1, curX (tty) = 0; | |
d427b66a JB |
412 | break; |
413 | ||
177c0ea7 | 414 | case USECR: |
6548cf00 KL |
415 | emacs_tputs (tty, tty->Wcm->cm_cr, 1, cmputc); |
416 | if (tty->Wcm->cm_autolf) | |
417 | curY (tty)++; | |
418 | curX (tty) = 0; | |
d427b66a JB |
419 | break; |
420 | } | |
421 | ||
6548cf00 KL |
422 | (void) calccost (tty, curY (tty), curX (tty), row, col, 1); |
423 | curY (tty) = row, curX (tty) = col; | |
d427b66a JB |
424 | } |
425 | ||
426 | /* Clear out all terminal info. | |
427 | Used before copying into it the info on the actual terminal. | |
428 | */ | |
429 | ||
dfcf069d | 430 | void |
28d7d09f | 431 | Wcm_clear (struct tty_display_info *tty) |
d427b66a | 432 | { |
72af86bd | 433 | memset (tty->Wcm, 0, sizeof (struct cm)); |
d427b66a JB |
434 | UP = 0; |
435 | BC = 0; | |
436 | } | |
437 | ||
438 | /* | |
439 | * Initialized stuff | |
440 | * Return 0 if can do CM. | |
441 | * Return -1 if cannot. | |
442 | * Return -2 if size not specified. | |
443 | */ | |
444 | ||
dfcf069d | 445 | int |
28d7d09f | 446 | Wcm_init (struct tty_display_info *tty) |
d427b66a JB |
447 | { |
448 | #if 0 | |
6548cf00 | 449 | if (tty->Wcm->cm_abs && !tty->Wcm->cm_ds) |
d427b66a JB |
450 | return 0; |
451 | #endif | |
6548cf00 | 452 | if (tty->Wcm->cm_abs) |
d427b66a JB |
453 | return 0; |
454 | /* Require up and left, and, if no absolute, down and right */ | |
6548cf00 | 455 | if (!tty->Wcm->cm_up || !tty->Wcm->cm_left) |
d427b66a | 456 | return - 1; |
6548cf00 | 457 | if (!tty->Wcm->cm_abs && (!tty->Wcm->cm_down || !tty->Wcm->cm_right)) |
d427b66a JB |
458 | return - 1; |
459 | /* Check that we know the size of the screen.... */ | |
6548cf00 | 460 | if (tty->Wcm->cm_rows <= 0 || tty->Wcm->cm_cols <= 0) |
d427b66a JB |
461 | return - 2; |
462 | return 0; | |
463 | } | |
ab5796a9 MB |
464 | |
465 | /* arch-tag: bcf64c02-00f6-44ef-94b6-c56eab5b3dc4 | |
466 | (do not change this comment) */ |