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