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