(Info-extract-menu-node-name)
[emacs.git] / src / termcap.c
blob8918f06d2440d2fff9dd830a7d0602120b7c9531
1 /* Work-alike for termcap, plus extra features.
2 Copyright (C) 1985, 86, 93, 94, 95, 2000, 2001
3 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
8 any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; see the file COPYING. If not, write to
17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. */
20 /* Emacs config.h may rename various library functions such as malloc. */
21 #ifdef HAVE_CONFIG_H
22 #include <config.h>
23 #endif
25 #ifdef emacs
27 #include <lisp.h> /* xmalloc is here */
28 /* Get the O_* definitions for open et al. */
29 #include <sys/file.h>
30 #ifdef HAVE_FCNTL_H
31 #include <fcntl.h>
32 #endif
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
37 #else /* not emacs */
39 #ifdef STDC_HEADERS
40 #include <stdlib.h>
41 #include <string.h>
42 #else
43 char *getenv ();
44 char *malloc ();
45 char *realloc ();
46 #endif
48 /* Do this after the include, in case string.h prototypes bcopy. */
49 #if (defined(HAVE_STRING_H) || defined(STDC_HEADERS)) && !defined(bcopy)
50 #define bcopy(s, d, n) memcpy ((d), (s), (n))
51 #endif
53 #ifdef HAVE_UNISTD_H
54 #include <unistd.h>
55 #endif
56 #ifdef _POSIX_VERSION
57 #include <fcntl.h>
58 #endif
60 #endif /* not emacs */
62 #ifndef NULL
63 #define NULL (char *) 0
64 #endif
66 #ifndef O_RDONLY
67 #define O_RDONLY 0
68 #endif
70 /* BUFSIZE is the initial size allocated for the buffer
71 for reading the termcap file.
72 It is not a limit.
73 Make it large normally for speed.
74 Make it variable when debugging, so can exercise
75 increasing the space dynamically. */
77 #ifndef BUFSIZE
78 #ifdef DEBUG
79 #define BUFSIZE bufsize
81 int bufsize = 128;
82 #else
83 #define BUFSIZE 2048
84 #endif
85 #endif
87 #ifndef TERMCAP_FILE
88 #define TERMCAP_FILE "/etc/termcap"
89 #endif
91 #ifndef emacs
92 static void
93 memory_out ()
95 write (2, "virtual memory exhausted\n", 25);
96 exit (1);
99 static char *
100 xmalloc (size)
101 unsigned size;
103 register char *tem = malloc (size);
105 if (!tem)
106 memory_out ();
107 return tem;
110 static char *
111 xrealloc (ptr, size)
112 char *ptr;
113 unsigned size;
115 register char *tem = realloc (ptr, size);
117 if (!tem)
118 memory_out ();
119 return tem;
121 #endif /* not emacs */
123 /* Looking up capabilities in the entry already found. */
125 /* The pointer to the data made by tgetent is left here
126 for tgetnum, tgetflag and tgetstr to find. */
127 static char *term_entry;
129 static char *tgetst1 ();
131 /* Search entry BP for capability CAP.
132 Return a pointer to the capability (in BP) if found,
133 0 if not found. */
135 static char *
136 find_capability (bp, cap)
137 register char *bp, *cap;
139 for (; *bp; bp++)
140 if (bp[0] == ':'
141 && bp[1] == cap[0]
142 && bp[2] == cap[1])
143 return &bp[4];
144 return NULL;
147 /* These are already defined in the System framework in Mac OS X and
148 cause prebinding to fail. */
149 #ifndef MAC_OSX
151 tgetnum (cap)
152 char *cap;
154 register char *ptr = find_capability (term_entry, cap);
155 if (!ptr || ptr[-1] != '#')
156 return -1;
157 return atoi (ptr);
161 tgetflag (cap)
162 char *cap;
164 register char *ptr = find_capability (term_entry, cap);
165 return ptr && ptr[-1] == ':';
168 /* Look up a string-valued capability CAP.
169 If AREA is non-null, it points to a pointer to a block in which
170 to store the string. That pointer is advanced over the space used.
171 If AREA is null, space is allocated with `malloc'. */
173 char *
174 tgetstr (cap, area)
175 char *cap;
176 char **area;
178 register char *ptr = find_capability (term_entry, cap);
179 if (!ptr || (ptr[-1] != '=' && ptr[-1] != '~'))
180 return NULL;
181 return tgetst1 (ptr, area);
183 #endif /* MAC_OSX */
185 #ifdef IS_EBCDIC_HOST
186 /* Table, indexed by a character in range 0200 to 0300 with 0200 subtracted,
187 gives meaning of character following \, or a space if no special meaning.
188 Sixteen characters per line within the string. */
190 static char esctab[]
191 = " \057\026 \047\014 \
192 \025 \015 \
193 \005 \013 \
195 #else
196 /* Table, indexed by a character in range 0100 to 0140 with 0100 subtracted,
197 gives meaning of character following \, or a space if no special meaning.
198 Eight characters per line within the string. */
200 static char esctab[]
201 = " \007\010 \033\014 \
202 \012 \
203 \015 \011 \013 \
205 #endif
207 /* PTR points to a string value inside a termcap entry.
208 Copy that value, processing \ and ^ abbreviations,
209 into the block that *AREA points to,
210 or to newly allocated storage if AREA is NULL.
211 Return the address to which we copied the value,
212 or NULL if PTR is NULL. */
214 static char *
215 tgetst1 (ptr, area)
216 char *ptr;
217 char **area;
219 register char *p, *r;
220 register int c;
221 register int size;
222 char *ret;
223 register int c1;
225 if (!ptr)
226 return NULL;
228 /* `ret' gets address of where to store the string. */
229 if (!area)
231 /* Compute size of block needed (may overestimate). */
232 p = ptr;
233 while ((c = *p++) && c != ':' && c != '\n')
235 ret = (char *) xmalloc (p - ptr + 1);
237 else
238 ret = *area;
240 /* Copy the string value, stopping at null or colon.
241 Also process ^ and \ abbreviations. */
242 p = ptr;
243 r = ret;
244 while ((c = *p++) && c != ':' && c != '\n')
246 if (c == '^')
248 c = *p++;
249 if (c == '?')
250 c = 0177;
251 else
252 c &= 037;
254 else if (c == '\\')
256 c = *p++;
257 if (c >= '0' && c <= '7')
259 c -= '0';
260 size = 0;
262 while (++size < 3 && (c1 = *p) >= '0' && c1 <= '7')
264 c *= 8;
265 c += c1 - '0';
266 p++;
269 #ifdef IS_EBCDIC_HOST
270 else if (c >= 0200 && c < 0360)
272 c1 = esctab[(c & ~0100) - 0200];
273 if (c1 != ' ')
274 c = c1;
276 #else
277 else if (c >= 0100 && c < 0200)
279 c1 = esctab[(c & ~040) - 0100];
280 if (c1 != ' ')
281 c = c1;
283 #endif
285 *r++ = c;
287 *r = '\0';
288 /* Update *AREA. */
289 if (area)
290 *area = r + 1;
291 return ret;
294 /* Outputting a string with padding. */
296 #ifndef emacs
297 short ospeed;
298 /* If OSPEED is 0, we use this as the actual baud rate. */
299 int tputs_baud_rate;
300 #endif
302 /* Already defined in the System framework in Mac OS X and causes
303 prebinding to fail. */
304 #ifndef MAC_OSX
305 char PC;
306 #endif /* MAC_OSX */
308 #ifndef emacs
309 /* Actual baud rate if positive;
310 - baud rate / 100 if negative. */
312 static int speeds[] =
314 #ifdef VMS
315 0, 50, 75, 110, 134, 150, -3, -6, -12, -18,
316 -20, -24, -36, -48, -72, -96, -192
317 #else /* not VMS */
318 0, 50, 75, 110, 135, 150, -2, -3, -6, -12,
319 -18, -24, -48, -96, -192, -288, -384, -576, -1152
320 #endif /* not VMS */
323 #endif /* not emacs */
325 /* Already defined in the System framework in Mac OS X and causes
326 prebinding to fail. */
327 #ifndef MAC_OSX
328 void
329 tputs (str, nlines, outfun)
330 register char *str;
331 int nlines;
332 register int (*outfun) ();
334 register int padcount = 0;
335 register int speed;
337 #ifdef emacs
338 extern EMACS_INT baud_rate;
339 speed = baud_rate;
340 /* For quite high speeds, convert to the smaller
341 units to avoid overflow. */
342 if (speed > 10000)
343 speed = - speed / 100;
344 #else
345 if (ospeed == 0)
346 speed = tputs_baud_rate;
347 else
348 speed = speeds[ospeed];
349 #endif
351 if (!str)
352 return;
354 while (*str >= '0' && *str <= '9')
356 padcount += *str++ - '0';
357 padcount *= 10;
359 if (*str == '.')
361 str++;
362 padcount += *str++ - '0';
364 if (*str == '*')
366 str++;
367 padcount *= nlines;
369 while (*str)
370 (*outfun) (*str++);
372 /* PADCOUNT is now in units of tenths of msec.
373 SPEED is measured in characters per 10 seconds
374 or in characters per .1 seconds (if negative).
375 We use the smaller units for larger speeds to avoid overflow. */
376 padcount *= speed;
377 padcount += 500;
378 padcount /= 1000;
379 if (speed < 0)
380 padcount = -padcount;
381 else
383 padcount += 50;
384 padcount /= 100;
387 while (padcount-- > 0)
388 (*outfun) (PC);
390 #endif /* MAC_OSX */
392 /* Finding the termcap entry in the termcap data base. */
394 struct termcap_buffer
396 char *beg;
397 int size;
398 char *ptr;
399 int ateof;
400 int full;
403 /* Forward declarations of static functions. */
405 static int scan_file ();
406 static char *gobble_line ();
407 static int compare_contin ();
408 static int name_match ();
410 #ifdef VMS
412 #include <rmsdef.h>
413 #include <fab.h>
414 #include <nam.h>
416 static int
417 valid_filename_p (fn)
418 char *fn;
420 struct FAB fab = cc$rms_fab;
421 struct NAM nam = cc$rms_nam;
422 char esa[NAM$C_MAXRSS];
424 fab.fab$l_fna = fn;
425 fab.fab$b_fns = strlen(fn);
426 fab.fab$l_nam = &nam;
427 fab.fab$l_fop = FAB$M_NAM;
429 nam.nam$l_esa = esa;
430 nam.nam$b_ess = sizeof esa;
432 return SYS$PARSE(&fab, 0, 0) == RMS$_NORMAL;
435 #else /* !VMS */
437 #ifdef MSDOS /* MW, May 1993 */
438 static int
439 valid_filename_p (fn)
440 char *fn;
442 return *fn == '/' || fn[1] == ':';
444 #else
445 #define valid_filename_p(fn) (*(fn) == '/')
446 #endif
448 #endif /* !VMS */
450 /* Find the termcap entry data for terminal type NAME
451 and store it in the block that BP points to.
452 Record its address for future use.
454 If BP is null, space is dynamically allocated.
456 Return -1 if there is some difficulty accessing the data base
457 of terminal types,
458 0 if the data base is accessible but the type NAME is not defined
459 in it, and some other value otherwise. */
461 /* Already defined in the System framework in Mac OS X and causes
462 prebinding to fail. */
463 #ifndef MAC_OSX
465 tgetent (bp, name)
466 char *bp, *name;
468 register char *termcap_name;
469 register int fd;
470 struct termcap_buffer buf;
471 register char *bp1;
472 char *tc_search_point;
473 char *term;
474 int malloc_size = 0;
475 register int c;
476 char *tcenv = NULL; /* TERMCAP value, if it contains :tc=. */
477 char *indirect = NULL; /* Terminal type in :tc= in TERMCAP value. */
478 int filep;
480 #ifdef INTERNAL_TERMINAL
481 /* For the internal terminal we don't want to read any termcap file,
482 so fake it. */
483 if (!strcmp (name, "internal"))
485 term = INTERNAL_TERMINAL;
486 if (!bp)
488 malloc_size = 1 + strlen (term);
489 bp = (char *) xmalloc (malloc_size);
491 strcpy (bp, term);
492 goto ret;
494 #endif /* INTERNAL_TERMINAL */
496 /* For compatibility with programs like `less' that want to
497 put data in the termcap buffer themselves as a fallback. */
498 if (bp)
499 term_entry = bp;
501 termcap_name = getenv ("TERMCAP");
502 if (termcap_name && *termcap_name == '\0')
503 termcap_name = NULL;
504 #if defined (MSDOS) && !defined (TEST)
505 if (termcap_name && (*termcap_name == '\\'
506 || *termcap_name == '/'
507 || termcap_name[1] == ':'))
508 dostounix_filename(termcap_name);
509 #endif
511 filep = termcap_name && valid_filename_p (termcap_name);
513 /* If termcap_name is non-null and starts with / (in the un*x case, that is),
514 it is a file name to use instead of /etc/termcap.
515 If it is non-null and does not start with /,
516 it is the entry itself, but only if
517 the name the caller requested matches the TERM variable. */
519 if (termcap_name && !filep && !strcmp (name, getenv ("TERM")))
521 indirect = tgetst1 (find_capability (termcap_name, "tc"), (char **) 0);
522 if (!indirect)
524 if (!bp)
525 bp = termcap_name;
526 else
527 strcpy (bp, termcap_name);
528 goto ret;
530 else
531 { /* It has tc=. Need to read /etc/termcap. */
532 tcenv = termcap_name;
533 termcap_name = NULL;
537 if (!termcap_name || !filep)
538 termcap_name = TERMCAP_FILE;
540 /* Here we know we must search a file and termcap_name has its name. */
542 #ifdef MSDOS
543 fd = open (termcap_name, O_RDONLY|O_TEXT, 0);
544 #else
545 fd = open (termcap_name, O_RDONLY, 0);
546 #endif
547 if (fd < 0)
548 return -1;
550 buf.size = BUFSIZE;
551 /* Add 1 to size to ensure room for terminating null. */
552 buf.beg = (char *) xmalloc (buf.size + 1);
553 term = indirect ? indirect : name;
555 if (!bp)
557 malloc_size = indirect ? strlen (tcenv) + 1 : buf.size;
558 bp = (char *) xmalloc (malloc_size);
560 tc_search_point = bp1 = bp;
562 if (indirect)
563 /* Copy the data from the environment variable. */
565 strcpy (bp, tcenv);
566 bp1 += strlen (tcenv);
569 while (term)
571 /* Scan the file, reading it via buf, till find start of main entry. */
572 if (scan_file (term, fd, &buf) == 0)
574 close (fd);
575 free (buf.beg);
576 if (malloc_size)
577 free (bp);
578 return 0;
581 /* Free old `term' if appropriate. */
582 if (term != name)
583 free (term);
585 /* If BP is malloc'd by us, make sure it is big enough. */
586 if (malloc_size)
588 int offset1 = bp1 - bp, offset2 = tc_search_point - bp;
589 malloc_size = offset1 + buf.size;
590 bp = termcap_name = (char *) xrealloc (bp, malloc_size);
591 bp1 = termcap_name + offset1;
592 tc_search_point = termcap_name + offset2;
595 /* Copy the line of the entry from buf into bp. */
596 termcap_name = buf.ptr;
597 while ((*bp1++ = c = *termcap_name++) && c != '\n')
598 /* Drop out any \ newline sequence. */
599 if (c == '\\' && *termcap_name == '\n')
601 bp1--;
602 termcap_name++;
604 *bp1 = '\0';
606 /* Does this entry refer to another terminal type's entry?
607 If something is found, copy it into heap and null-terminate it. */
608 tc_search_point = find_capability (tc_search_point, "tc");
609 term = tgetst1 (tc_search_point, (char **) 0);
612 close (fd);
613 free (buf.beg);
615 if (malloc_size)
616 bp = (char *) xrealloc (bp, bp1 - bp + 1);
618 ret:
619 term_entry = bp;
620 return 1;
622 #endif /* MAC_OSX */
624 /* Given file open on FD and buffer BUFP,
625 scan the file from the beginning until a line is found
626 that starts the entry for terminal type STR.
627 Return 1 if successful, with that line in BUFP,
628 or 0 if no entry is found in the file. */
630 static int
631 scan_file (str, fd, bufp)
632 char *str;
633 int fd;
634 register struct termcap_buffer *bufp;
636 register char *end;
638 bufp->ptr = bufp->beg;
639 bufp->full = 0;
640 bufp->ateof = 0;
641 *bufp->ptr = '\0';
643 lseek (fd, 0L, 0);
645 while (!bufp->ateof)
647 /* Read a line into the buffer. */
648 end = NULL;
651 /* if it is continued, append another line to it,
652 until a non-continued line ends. */
653 end = gobble_line (fd, bufp, end);
655 while (!bufp->ateof && end[-2] == '\\');
657 if (*bufp->ptr != '#'
658 && name_match (bufp->ptr, str))
659 return 1;
661 /* Discard the line just processed. */
662 bufp->ptr = end;
664 return 0;
667 /* Return nonzero if NAME is one of the names specified
668 by termcap entry LINE. */
670 static int
671 name_match (line, name)
672 char *line, *name;
674 register char *tem;
676 if (!compare_contin (line, name))
677 return 1;
678 /* This line starts an entry. Is it the right one? */
679 for (tem = line; *tem && *tem != '\n' && *tem != ':'; tem++)
680 if (*tem == '|' && !compare_contin (tem + 1, name))
681 return 1;
683 return 0;
686 static int
687 compare_contin (str1, str2)
688 register char *str1, *str2;
690 register int c1, c2;
691 while (1)
693 c1 = *str1++;
694 c2 = *str2++;
695 while (c1 == '\\' && *str1 == '\n')
697 str1++;
698 while ((c1 = *str1++) == ' ' || c1 == '\t');
700 if (c2 == '\0')
702 /* End of type being looked up. */
703 if (c1 == '|' || c1 == ':')
704 /* If end of name in data base, we win. */
705 return 0;
706 else
707 return 1;
709 else if (c1 != c2)
710 return 1;
714 /* Make sure that the buffer <- BUFP contains a full line
715 of the file open on FD, starting at the place BUFP->ptr
716 points to. Can read more of the file, discard stuff before
717 BUFP->ptr, or make the buffer bigger.
719 Return the pointer to after the newline ending the line,
720 or to the end of the file, if there is no newline to end it.
722 Can also merge on continuation lines. If APPEND_END is
723 non-null, it points past the newline of a line that is
724 continued; we add another line onto it and regard the whole
725 thing as one line. The caller decides when a line is continued. */
727 static char *
728 gobble_line (fd, bufp, append_end)
729 int fd;
730 register struct termcap_buffer *bufp;
731 char *append_end;
733 register char *end;
734 register int nread;
735 register char *buf = bufp->beg;
736 register char *tem;
738 if (!append_end)
739 append_end = bufp->ptr;
741 while (1)
743 end = append_end;
744 while (*end && *end != '\n') end++;
745 if (*end)
746 break;
747 if (bufp->ateof)
748 return buf + bufp->full;
749 if (bufp->ptr == buf)
751 if (bufp->full == bufp->size)
753 bufp->size *= 2;
754 /* Add 1 to size to ensure room for terminating null. */
755 tem = (char *) xrealloc (buf, bufp->size + 1);
756 bufp->ptr = (bufp->ptr - buf) + tem;
757 append_end = (append_end - buf) + tem;
758 bufp->beg = buf = tem;
761 else
763 append_end -= bufp->ptr - buf;
764 bcopy (bufp->ptr, buf, bufp->full -= bufp->ptr - buf);
765 bufp->ptr = buf;
767 if (!(nread = read (fd, buf + bufp->full, bufp->size - bufp->full)))
768 bufp->ateof = 1;
769 bufp->full += nread;
770 buf[bufp->full] = '\0';
772 return end + 1;
775 #ifdef TEST
777 #ifdef NULL
778 #undef NULL
779 #endif
781 #include <stdio.h>
783 main (argc, argv)
784 int argc;
785 char **argv;
787 char *term;
788 char *buf;
790 term = argv[1];
791 printf ("TERM: %s\n", term);
793 buf = (char *) tgetent (0, term);
794 if ((int) buf <= 0)
796 printf ("No entry.\n");
797 return 0;
800 printf ("Entry: %s\n", buf);
802 tprint ("cm");
803 tprint ("AL");
805 printf ("co: %d\n", tgetnum ("co"));
806 printf ("am: %d\n", tgetflag ("am"));
809 tprint (cap)
810 char *cap;
812 char *x = tgetstr (cap, 0);
813 register char *y;
815 printf ("%s: ", cap);
816 if (x)
818 for (y = x; *y; y++)
819 if (*y <= ' ' || *y == 0177)
820 printf ("\\%0o", *y);
821 else
822 putchar (*y);
823 free (x);
825 else
826 printf ("none");
827 putchar ('\n');
830 #endif /* TEST */