ncurses 5.9 - patch 20110807
[ncurses.git] / ncurses / tinfo / read_termcap.c
1 /****************************************************************************
2  * Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  *     and: Thomas E. Dickey                        1996-on                 *
33  ****************************************************************************/
34
35 /*
36  * Termcap compatibility support
37  *
38  * If your OS integrator didn't install a terminfo database, you can call
39  * _nc_read_termcap_entry() to support reading and translating capabilities
40  * from the system termcap file.  This is a kludge; it will bulk up and slow
41  * down every program that uses ncurses, and translated termcap entries cannot
42  * use full terminfo capabilities.  Don't use it unless you absolutely have to;
43  * instead, get your system people to run tic(1) from root on the terminfo
44  * master included with ncurses to translate it into a terminfo database.
45  *
46  * If USE_GETCAP is enabled, we use what is effectively a copy of the 4.4BSD
47  * getcap code to fetch entries.  There are disadvantages to this; mainly that
48  * getcap(3) does its own resolution, meaning that entries read in in this way
49  * can't reference the terminfo tree.  The only thing it buys is faster startup
50  * time, getcap(3) is much faster than our tic parser.
51  */
52
53 #include <curses.priv.h>
54
55 #include <ctype.h>
56 #include <sys/types.h>
57 #include <tic.h>
58
59 MODULE_ID("$Id: read_termcap.c,v 1.81 2011/08/07 18:56:35 tom Exp $")
60
61 #if !PURE_TERMINFO
62
63 #define TC_SUCCESS     0
64 #define TC_NOT_FOUND  -1
65 #define TC_SYS_ERR    -2
66 #define TC_REF_LOOP   -3
67 #define TC_UNRESOLVED -4        /* this is not returned by BSD cgetent */
68
69 static NCURSES_CONST char *
70 get_termpath(void)
71 {
72     NCURSES_CONST char *result;
73
74     if (!use_terminfo_vars() || (result = getenv("TERMPATH")) == 0)
75         result = TERMPATH;
76     T(("TERMPATH is %s", result));
77     return result;
78 }
79
80 /*
81  * Note:
82  * getcap(), cgetent(), etc., are BSD functions.  A copy of those was added to
83  * this file in November 1995, derived from the BSD4.4 Lite sources.
84  *
85  * The initial adaptation uses 518 lines from that source.
86  * The current source (in 2009) uses 183 lines of BSD4.4 Lite (441 ignoring
87  * whitespace).
88  */
89 #if USE_GETCAP
90
91 #if HAVE_BSD_CGETENT
92 #define _nc_cgetcap   cgetcap
93 #define _nc_cgetent(buf, oline, db_array, name) cgetent(buf, db_array, name)
94 #define _nc_cgetmatch cgetmatch
95 #define _nc_cgetset   cgetset
96 #else
97 static int _nc_cgetmatch(char *, const char *);
98 static int _nc_getent(char **, unsigned *, int *, int, char **, int, const char
99                       *, int, char *);
100 static int _nc_nfcmp(const char *, char *);
101
102 /*-
103  * Copyright (c) 1992, 1993
104  *      The Regents of the University of California.  All rights reserved.
105  *
106  * This code is derived from software contributed to Berkeley by
107  * Casey Leedom of Lawrence Livermore National Laboratory.
108  *
109  * Redistribution and use in source and binary forms, with or without
110  * modification, are permitted provided that the following conditions
111  * are met:
112  * 1. Redistributions of source code must retain the above copyright
113  *    notice, this list of conditions and the following disclaimer.
114  * 2. Redistributions in binary form must reproduce the above copyright
115  *    notice, this list of conditions and the following disclaimer in the
116  *    documentation and/or other materials provided with the distribution.
117  * 3. Neither the name of the University nor the names of its contributors
118  *    may be used to endorse or promote products derived from this software
119  *    without specific prior written permission.
120  *
121  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
122  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
123  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
124  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
125  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
126  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
127  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
128  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
129  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
130  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
131  * SUCH DAMAGE.
132  */
133
134 /* static char sccsid[] = "@(#)getcap.c 8.3 (Berkeley) 3/25/94"; */
135
136 #define BFRAG           1024
137 #define BSIZE           1024
138 #define MAX_RECURSION   32      /* maximum getent recursion */
139
140 static size_t topreclen;        /* toprec length */
141 static char *toprec;            /* Additional record specified by cgetset() */
142 static int gottoprec;           /* Flag indicating retrieval of toprecord */
143
144 /*
145  * Cgetset() allows the addition of a user specified buffer to be added to the
146  * database array, in effect "pushing" the buffer on top of the virtual
147  * database.  0 is returned on success, -1 on failure.
148  */
149 static int
150 _nc_cgetset(const char *ent)
151 {
152     if (ent == 0) {
153         FreeIfNeeded(toprec);
154         toprec = 0;
155         topreclen = 0;
156         return (0);
157     }
158     topreclen = strlen(ent);
159     if ((toprec = typeMalloc(char, topreclen + 1)) == 0) {
160         errno = ENOMEM;
161         return (-1);
162     }
163     gottoprec = 0;
164     (void) strcpy(toprec, ent);
165     return (0);
166 }
167
168 /*
169  * Cgetcap searches the capability record buf for the capability cap with type
170  * `type'.  A pointer to the value of cap is returned on success, 0 if the
171  * requested capability couldn't be found.
172  *
173  * Specifying a type of ':' means that nothing should follow cap (:cap:).  In
174  * this case a pointer to the terminating ':' or NUL will be returned if cap is
175  * found.
176  *
177  * If (cap, '@') or (cap, terminator, '@') is found before (cap, terminator)
178  * return 0.
179  */
180 static char *
181 _nc_cgetcap(char *buf, const char *cap, int type)
182 {
183     register const char *cp;
184     register char *bp;
185
186     bp = buf;
187     for (;;) {
188         /*
189          * Skip past the current capability field - it's either the
190          * name field if this is the first time through the loop, or
191          * the remainder of a field whose name failed to match cap.
192          */
193         for (;;) {
194             if (*bp == '\0')
195                 return (0);
196             else if (*bp++ == ':')
197                 break;
198         }
199
200         /*
201          * Try to match (cap, type) in buf.
202          */
203         for (cp = cap; *cp == *bp && *bp != '\0'; cp++, bp++)
204             continue;
205         if (*cp != '\0')
206             continue;
207         if (*bp == '@')
208             return (0);
209         if (type == ':') {
210             if (*bp != '\0' && *bp != ':')
211                 continue;
212             return (bp);
213         }
214         if (*bp != type)
215             continue;
216         bp++;
217         return (*bp == '@' ? 0 : bp);
218     }
219     /* NOTREACHED */
220 }
221
222 /*
223  * Cgetent extracts the capability record name from the NULL terminated file
224  * array db_array and returns a pointer to a malloc'd copy of it in buf.  Buf
225  * must be retained through all subsequent calls to cgetcap, cgetnum, cgetflag,
226  * and cgetstr, but may then be freed.
227  *
228  * Returns:
229  *
230  * positive #    on success (i.e., the index in db_array)
231  * TC_NOT_FOUND  if the requested record couldn't be found
232  * TC_SYS_ERR    if a system error was encountered (e.g.,couldn't open a file)
233  * TC_REF_LOOP   if a potential reference loop is detected
234  * TC_UNRESOLVED if we had too many recurrences to resolve
235  */
236 static int
237 _nc_cgetent(char **buf, int *oline, char **db_array, const char *name)
238 {
239     unsigned dummy;
240
241     return (_nc_getent(buf, &dummy, oline, 0, db_array, -1, name, 0, 0));
242 }
243
244 /*
245  * Getent implements the functions of cgetent.  If fd is non-negative,
246  * *db_array has already been opened and fd is the open file descriptor.  We
247  * do this to save time and avoid using up file descriptors for tc=
248  * recursions.
249  *
250  * Getent returns the same success/failure codes as cgetent.  On success, a
251  * pointer to a malloc'd capability record with all tc= capabilities fully
252  * expanded and its length (not including trailing ASCII NUL) are left in
253  * *cap and *len.
254  *
255  * Basic algorithm:
256  *      + Allocate memory incrementally as needed in chunks of size BFRAG
257  *        for capability buffer.
258  *      + Recurse for each tc=name and interpolate result.  Stop when all
259  *        names interpolated, a name can't be found, or depth exceeds
260  *        MAX_RECURSION.
261  */
262 #define DOALLOC(size) typeRealloc(char, size, record)
263 static int
264 _nc_getent(
265               char **cap,       /* termcap-content */
266               unsigned *len,    /* length, needed for recursion */
267               int *beginning,   /* line-number at match */
268               int in_array,     /* index in 'db_array[] */
269               char **db_array,  /* list of files to search */
270               int fd,
271               const char *name,
272               int depth,
273               char *nfield)
274 {
275     register char *r_end, *rp;
276     int myfd = FALSE;
277     char *record = 0;
278     int tc_not_resolved;
279     int current;
280     int lineno;
281
282     /*
283      * Return with ``loop detected'' error if we've recurred more than
284      * MAX_RECURSION times.
285      */
286     if (depth > MAX_RECURSION)
287         return (TC_REF_LOOP);
288
289     /*
290      * Check if we have a top record from cgetset().
291      */
292     if (depth == 0 && toprec != 0 && _nc_cgetmatch(toprec, name) == 0) {
293         if ((record = DOALLOC(topreclen + BFRAG)) == 0) {
294             errno = ENOMEM;
295             return (TC_SYS_ERR);
296         }
297         (void) strcpy(record, toprec);
298         rp = record + topreclen + 1;
299         r_end = rp + BFRAG;
300         current = in_array;
301     } else {
302         int foundit;
303
304         /*
305          * Allocate first chunk of memory.
306          */
307         if ((record = DOALLOC(BFRAG)) == 0) {
308             errno = ENOMEM;
309             return (TC_SYS_ERR);
310         }
311         rp = r_end = record + BFRAG;
312         foundit = FALSE;
313
314         /*
315          * Loop through database array until finding the record.
316          */
317         for (current = in_array; db_array[current] != 0; current++) {
318             int eof = FALSE;
319
320             /*
321              * Open database if not already open.
322              */
323             if (fd >= 0) {
324                 (void) lseek(fd, (off_t) 0, SEEK_SET);
325             } else if ((_nc_access(db_array[current], R_OK) < 0)
326                        || (fd = open(db_array[current], O_RDONLY, 0)) < 0) {
327                 /* No error on unfound file. */
328                 if (errno == ENOENT)
329                     continue;
330                 free(record);
331                 return (TC_SYS_ERR);
332             } else {
333                 myfd = TRUE;
334             }
335             lineno = 0;
336
337             /*
338              * Find the requested capability record ...
339              */
340             {
341                 char buf[2048];
342                 register char *b_end = buf;
343                 register char *bp = buf;
344                 register int c;
345
346                 /*
347                  * Loop invariants:
348                  *      There is always room for one more character in record.
349                  *      R_end always points just past end of record.
350                  *      Rp always points just past last character in record.
351                  *      B_end always points just past last character in buf.
352                  *      Bp always points at next character in buf.
353                  */
354
355                 for (;;) {
356                     int first = lineno + 1;
357
358                     /*
359                      * Read in a line implementing (\, newline)
360                      * line continuation.
361                      */
362                     rp = record;
363                     for (;;) {
364                         if (bp >= b_end) {
365                             int n;
366
367                             n = read(fd, buf, sizeof(buf));
368                             if (n <= 0) {
369                                 if (myfd)
370                                     (void) close(fd);
371                                 if (n < 0) {
372                                     free(record);
373                                     return (TC_SYS_ERR);
374                                 }
375                                 fd = -1;
376                                 eof = TRUE;
377                                 break;
378                             }
379                             b_end = buf + n;
380                             bp = buf;
381                         }
382
383                         c = *bp++;
384                         if (c == '\n') {
385                             lineno++;
386                             if (rp == record || *(rp - 1) != '\\')
387                                 break;
388                         }
389                         *rp++ = c;
390
391                         /*
392                          * Enforce loop invariant: if no room
393                          * left in record buffer, try to get
394                          * some more.
395                          */
396                         if (rp >= r_end) {
397                             unsigned pos;
398                             size_t newsize;
399
400                             pos = rp - record;
401                             newsize = r_end - record + BFRAG;
402                             record = DOALLOC(newsize);
403                             if (record == 0) {
404                                 if (myfd)
405                                     (void) close(fd);
406                                 errno = ENOMEM;
407                                 return (TC_SYS_ERR);
408                             }
409                             r_end = record + newsize;
410                             rp = record + pos;
411                         }
412                     }
413                     /* loop invariant lets us do this */
414                     *rp++ = '\0';
415
416                     /*
417                      * If encountered eof check next file.
418                      */
419                     if (eof)
420                         break;
421
422                     /*
423                      * Toss blank lines and comments.
424                      */
425                     if (*record == '\0' || *record == '#')
426                         continue;
427
428                     /*
429                      * See if this is the record we want ...
430                      */
431                     if (_nc_cgetmatch(record, name) == 0
432                         && (nfield == 0
433                             || !_nc_nfcmp(nfield, record))) {
434                         foundit = TRUE;
435                         *beginning = first;
436                         break;  /* found it! */
437                     }
438                 }
439             }
440             if (foundit)
441                 break;
442         }
443
444         if (!foundit) {
445             free(record);
446             return (TC_NOT_FOUND);
447         }
448     }
449
450     /*
451      * Got the capability record, but now we have to expand all tc=name
452      * references in it ...
453      */
454     {
455         register char *newicap, *s;
456         register int newilen;
457         unsigned ilen;
458         int diff, iret, tclen, oline;
459         char *icap = 0, *scan, *tc, *tcstart, *tcend;
460
461         /*
462          * Loop invariants:
463          *      There is room for one more character in record.
464          *      R_end points just past end of record.
465          *      Rp points just past last character in record.
466          *      Scan points at remainder of record that needs to be
467          *      scanned for tc=name constructs.
468          */
469         scan = record;
470         tc_not_resolved = FALSE;
471         for (;;) {
472             if ((tc = _nc_cgetcap(scan, "tc", '=')) == 0) {
473                 break;
474             }
475
476             /*
477              * Find end of tc=name and stomp on the trailing `:'
478              * (if present) so we can use it to call ourselves.
479              */
480             s = tc;
481             while (*s != '\0') {
482                 if (*s++ == ':') {
483                     *(s - 1) = '\0';
484                     break;
485                 }
486             }
487             tcstart = tc - 3;
488             tclen = s - tcstart;
489             tcend = s;
490
491             icap = 0;
492             iret = _nc_getent(&icap, &ilen, &oline, current, db_array, fd,
493                               tc, depth + 1, 0);
494             newicap = icap;     /* Put into a register. */
495             newilen = ilen;
496             if (iret != TC_SUCCESS) {
497                 /* an error */
498                 if (iret < TC_NOT_FOUND) {
499                     if (myfd)
500                         (void) close(fd);
501                     free(record);
502                     FreeIfNeeded(icap);
503                     return (iret);
504                 }
505                 if (iret == TC_UNRESOLVED) {
506                     tc_not_resolved = TRUE;
507                     /* couldn't resolve tc */
508                 } else if (iret == TC_NOT_FOUND) {
509                     *(s - 1) = ':';
510                     scan = s - 1;
511                     tc_not_resolved = TRUE;
512                     continue;
513                 }
514             }
515
516             /* not interested in name field of tc'ed record */
517             s = newicap;
518             while (*s != '\0' && *s++ != ':') ;
519             newilen -= s - newicap;
520             newicap = s;
521
522             /* make sure interpolated record is `:'-terminated */
523             s += newilen;
524             if (*(s - 1) != ':') {
525                 *s = ':';       /* overwrite NUL with : */
526                 newilen++;
527             }
528
529             /*
530              * Make sure there's enough room to insert the
531              * new record.
532              */
533             diff = newilen - tclen;
534             if (diff >= r_end - rp) {
535                 unsigned pos, tcpos, tcposend;
536                 size_t newsize;
537
538                 pos = rp - record;
539                 newsize = r_end - record + diff + BFRAG;
540                 tcpos = tcstart - record;
541                 tcposend = tcend - record;
542                 record = DOALLOC(newsize);
543                 if (record == 0) {
544                     if (myfd)
545                         (void) close(fd);
546                     free(icap);
547                     errno = ENOMEM;
548                     return (TC_SYS_ERR);
549                 }
550                 r_end = record + newsize;
551                 rp = record + pos;
552                 tcstart = record + tcpos;
553                 tcend = record + tcposend;
554             }
555
556             /*
557              * Insert tc'ed record into our record.
558              */
559             s = tcstart + newilen;
560             memmove(s, tcend, (size_t) (rp - tcend));
561             memmove(tcstart, newicap, (size_t) newilen);
562             rp += diff;
563             free(icap);
564
565             /*
566              * Start scan on `:' so next cgetcap works properly
567              * (cgetcap always skips first field).
568              */
569             scan = s - 1;
570         }
571     }
572
573     /*
574      * Close file (if we opened it), give back any extra memory, and
575      * return capability, length and success.
576      */
577     if (myfd)
578         (void) close(fd);
579     *len = rp - record - 1;     /* don't count NUL */
580     if (r_end > rp) {
581         if ((record = DOALLOC((size_t) (rp - record))) == 0) {
582             errno = ENOMEM;
583             return (TC_SYS_ERR);
584         }
585     }
586
587     *cap = record;
588     if (tc_not_resolved) {
589         return (TC_UNRESOLVED);
590     }
591     return (current);
592 }
593
594 /*
595  * Cgetmatch will return 0 if name is one of the names of the capability
596  * record buf, -1 if not.
597  */
598 static int
599 _nc_cgetmatch(char *buf, const char *name)
600 {
601     register const char *np;
602     register char *bp;
603
604     /*
605      * Start search at beginning of record.
606      */
607     bp = buf;
608     for (;;) {
609         /*
610          * Try to match a record name.
611          */
612         np = name;
613         for (;;) {
614             if (*np == '\0') {
615                 if (*bp == '|' || *bp == ':' || *bp == '\0')
616                     return (0);
617                 else
618                     break;
619             } else if (*bp++ != *np++) {
620                 break;
621             }
622         }
623
624         /*
625          * Match failed, skip to next name in record.
626          */
627         bp--;                   /* a '|' or ':' may have stopped the match */
628         for (;;) {
629             if (*bp == '\0' || *bp == ':')
630                 return (-1);    /* match failed totally */
631             else if (*bp++ == '|')
632                 break;          /* found next name */
633         }
634     }
635 }
636
637 /*
638  * Compare name field of record.
639  */
640 static int
641 _nc_nfcmp(const char *nf, char *rec)
642 {
643     char *cp, tmp;
644     int ret;
645
646     for (cp = rec; *cp != ':'; cp++) ;
647
648     tmp = *(cp + 1);
649     *(cp + 1) = '\0';
650     ret = strcmp(nf, rec);
651     *(cp + 1) = tmp;
652
653     return (ret);
654 }
655 #endif /* HAVE_BSD_CGETENT */
656
657 /*
658  * Since ncurses provides its own 'tgetent()', we cannot use the native one.
659  * So we reproduce the logic to get down to cgetent() -- or our cut-down
660  * version of that -- to circumvent the problem of configuring against the
661  * termcap library.
662  */
663 #define USE_BSD_TGETENT 1
664
665 #if USE_BSD_TGETENT
666 /*
667  * Copyright (c) 1980, 1993
668  *      The Regents of the University of California.  All rights reserved.
669  *
670  * Redistribution and use in source and binary forms, with or without
671  * modification, are permitted provided that the following conditions
672  * are met:
673  * 1. Redistributions of source code must retain the above copyright
674  *    notice, this list of conditions and the following disclaimer.
675  * 2. Redistributions in binary form must reproduce the above copyright
676  *    notice, this list of conditions and the following disclaimer in the
677  *    documentation and/or other materials provided with the distribution.
678  * 3. All advertising materials mentioning features or use of this software
679  *    must display the following acknowledgment:
680  *      This product includes software developed by the University of
681  *      California, Berkeley and its contributors.
682  * 4. Neither the name of the University nor the names of its contributors
683  *    may be used to endorse or promote products derived from this software
684  *    without specific prior written permission.
685  *
686  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
687  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
688  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
689  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
690  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
691  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
692  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
693  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
694  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
695  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
696  * SUCH DAMAGE.
697  */
698
699 /* static char sccsid[] = "@(#)termcap.c        8.1 (Berkeley) 6/4/93" */
700
701 #define PBUFSIZ         512     /* max length of filename path */
702 #define PVECSIZ         32      /* max number of names in path */
703 #define TBUFSIZ (2048*2)
704
705 static char *tbuf;
706
707 /*
708  * On entry, srcp points to a non ':' character which is the beginning of the
709  * token, if any.  We'll try to return a string that doesn't end with a ':'.
710  */
711 static char *
712 get_tc_token(char **srcp, int *endp)
713 {
714     int ch;
715     bool found = FALSE;
716     char *s, *base;
717     char *tok = 0;
718
719     *endp = TRUE;
720     for (s = base = *srcp; *s != '\0';) {
721         ch = *s++;
722         if (ch == '\\') {
723             if (*s == '\0') {
724                 break;
725             } else if (*s++ == '\n') {
726                 while (isspace(UChar(*s)))
727                     s++;
728             } else {
729                 found = TRUE;
730             }
731         } else if (ch == ':') {
732             if (found) {
733                 tok = base;
734                 s[-1] = '\0';
735                 *srcp = s;
736                 *endp = FALSE;
737                 break;
738             }
739             base = s;
740         } else if (isgraph(UChar(ch))) {
741             found = TRUE;
742         }
743     }
744
745     /* malformed entry may end without a ':' */
746     if (tok == 0 && found) {
747         tok = base;
748     }
749
750     return tok;
751 }
752
753 static char *
754 copy_tc_token(char *dst, const char *src, size_t len)
755 {
756     int ch;
757
758     while ((ch = *src++) != '\0') {
759         if (ch == '\\' && *src == '\n') {
760             while (isspace(UChar(*src)))
761                 src++;
762             continue;
763         }
764         if (--len == 0) {
765             dst = 0;
766             break;
767         }
768         *dst++ = ch;
769     }
770     return dst;
771 }
772
773 /*
774  * Get an entry for terminal name in buffer bp from the termcap file.
775  */
776 static int
777 _nc_tgetent(char *bp, char **sourcename, int *lineno, const char *name)
778 {
779     static char *the_source;
780
781     register char *p;
782     register char *cp;
783     char *dummy = NULL;
784     const char **fname;
785     char *home;
786     int i;
787     char pathbuf[PBUFSIZ];      /* holds raw path of filenames */
788     CGETENT_CONST char *pathvec[PVECSIZ];       /* point to names in pathbuf */
789     CGETENT_CONST char **pvec;  /* holds usable tail of path vector */
790     NCURSES_CONST char *termpath;
791     string_desc desc;
792
793     *lineno = 1;
794     fname = pathvec;
795     pvec = pathvec;
796     tbuf = bp;
797     p = pathbuf;
798     cp = use_terminfo_vars()? getenv("TERMCAP") : NULL;
799
800     /*
801      * TERMCAP can have one of two things in it.  It can be the name of a file
802      * to use instead of /etc/termcap.  In this case it better start with a
803      * "/".  Or it can be an entry to use so we don't have to read the file. 
804      * In this case it has to already have the newlines crunched out.  If
805      * TERMCAP does not hold a file name then a path of names is searched
806      * instead.  The path is found in the TERMPATH variable, or becomes
807      * "$HOME/.termcap /etc/termcap" if no TERMPATH exists.
808      */
809     _nc_str_init(&desc, pathbuf, sizeof(pathbuf));
810     if (cp == NULL) {
811         _nc_safe_strcpy(&desc, get_termpath());
812     } else if (!_nc_is_abs_path(cp)) {  /* TERMCAP holds an entry */
813         if ((termpath = get_termpath()) != 0) {
814             _nc_safe_strcat(&desc, termpath);
815         } else {
816             char temp[PBUFSIZ];
817             temp[0] = 0;
818             if ((home = getenv("HOME")) != 0 && *home != '\0'
819                 && strchr(home, ' ') == 0
820                 && strlen(home) < sizeof(temp) - 10) {  /* setup path */
821                 sprintf(temp, "%s/", home);     /* $HOME first */
822             }
823             /* if no $HOME look in current directory */
824             strcat(temp, ".termcap");
825             _nc_safe_strcat(&desc, temp);
826             _nc_safe_strcat(&desc, " ");
827             _nc_safe_strcat(&desc, get_termpath());
828         }
829     } else {                    /* user-defined name in TERMCAP */
830         _nc_safe_strcat(&desc, cp);     /* still can be tokenized */
831     }
832
833     *fname++ = pathbuf;         /* tokenize path into vector of names */
834     while (*++p) {
835         if (*p == ' ' || *p == NCURSES_PATHSEP) {
836             *p = '\0';
837             while (*++p)
838                 if (*p != ' ' && *p != NCURSES_PATHSEP)
839                     break;
840             if (*p == '\0')
841                 break;
842             *fname++ = p;
843             if (fname >= pathvec + PVECSIZ) {
844                 fname--;
845                 break;
846             }
847         }
848     }
849     *fname = 0;                 /* mark end of vector */
850 #if !HAVE_BSD_CGETENT
851     (void) _nc_cgetset(0);
852 #endif
853     if (_nc_is_abs_path(cp)) {
854         if (_nc_cgetset(cp) < 0) {
855             return (TC_SYS_ERR);
856         }
857     }
858
859     i = _nc_cgetent(&dummy, lineno, pathvec, name);
860
861     /* ncurses' termcap-parsing routines cannot handle multiple adjacent
862      * empty fields, and mistakenly use the last valid cap entry instead of
863      * the first (breaks tc= includes)
864      */
865     if (i >= 0) {
866         char *pd, *ps, *tok;
867         int endflag = FALSE;
868         char *list[1023];
869         size_t n, count = 0;
870
871         pd = bp;
872         ps = dummy;
873         while (!endflag && (tok = get_tc_token(&ps, &endflag)) != 0) {
874             bool ignore = FALSE;
875
876             for (n = 1; n < count; n++) {
877                 char *s = list[n];
878                 if (s[0] == tok[0]
879                     && s[1] == tok[1]) {
880                     ignore = TRUE;
881                     break;
882                 }
883             }
884             if (ignore != TRUE) {
885                 list[count++] = tok;
886                 pd = copy_tc_token(pd, tok, TBUFSIZ - (2 + pd - bp));
887                 if (pd == 0) {
888                     i = -1;
889                     break;
890                 }
891                 *pd++ = ':';
892                 *pd = '\0';
893             }
894         }
895     }
896
897     FreeIfNeeded(dummy);
898     FreeIfNeeded(the_source);
899     the_source = 0;
900
901     /* This is not related to the BSD cgetent(), but to fake up a suitable
902      * filename for ncurses' error reporting.  (If we are not using BSD
903      * cgetent, then it is the actual filename).
904      */
905     if (i >= 0) {
906 #if HAVE_BSD_CGETENT
907         char temp[PATH_MAX];
908
909         _nc_str_init(&desc, temp, sizeof(temp));
910         _nc_safe_strcpy(&desc, pathvec[i]);
911         _nc_safe_strcat(&desc, ".db");
912         if (_nc_access(temp, R_OK) == 0) {
913             _nc_safe_strcpy(&desc, pathvec[i]);
914         }
915         if ((the_source = strdup(temp)) != 0)
916             *sourcename = the_source;
917 #else
918         if ((the_source = strdup(pathvec[i])) != 0)
919             *sourcename = the_source;
920 #endif
921     }
922
923     return (i);
924 }
925 #endif /* USE_BSD_TGETENT */
926 #endif /* USE_GETCAP */
927
928 #define MAXPATHS        32
929
930 /*
931  * Add a filename to the list in 'termpaths[]', checking that we really have
932  * a right to open the file.
933  */
934 #if !USE_GETCAP
935 static int
936 add_tc(char *termpaths[], char *path, int count)
937 {
938     char *save = strchr(path, NCURSES_PATHSEP);
939     if (save != 0)
940         *save = '\0';
941     if (count < MAXPATHS
942         && _nc_access(path, R_OK) == 0) {
943         termpaths[count++] = path;
944         T(("Adding termpath %s", path));
945     }
946     termpaths[count] = 0;
947     if (save != 0)
948         *save = NCURSES_PATHSEP;
949     return count;
950 }
951 #define ADD_TC(path, count) filecount = add_tc(termpaths, path, count)
952 #endif /* !USE_GETCAP */
953
954 NCURSES_EXPORT(int)
955 _nc_read_termcap_entry(const char *const tn, TERMTYPE *const tp)
956 {
957     int found = TGETENT_NO;
958     ENTRY *ep;
959 #if USE_GETCAP_CACHE
960     char cwd_buf[PATH_MAX];
961 #endif
962 #if USE_GETCAP
963     char *p, tc[TBUFSIZ];
964     int status;
965     static char *source;
966     static int lineno;
967
968     T(("read termcap entry for %s", tn));
969
970     if (strlen(tn) == 0
971         || strcmp(tn, ".") == 0
972         || strcmp(tn, "..") == 0
973         || _nc_pathlast(tn) != 0) {
974         T(("illegal or missing entry name '%s'", tn));
975         return TGETENT_NO;
976     }
977
978     if (use_terminfo_vars() && (p = getenv("TERMCAP")) != 0
979         && !_nc_is_abs_path(p) && _nc_name_match(p, tn, "|:")) {
980         /* TERMCAP holds a termcap entry */
981         strncpy(tc, p, sizeof(tc) - 1);
982         tc[sizeof(tc) - 1] = '\0';
983         _nc_set_source("TERMCAP");
984     } else {
985         /* we're using getcap(3) */
986         if ((status = _nc_tgetent(tc, &source, &lineno, tn)) < 0)
987             return (status == TC_NOT_FOUND ? TGETENT_NO : TGETENT_ERR);
988
989         _nc_curr_line = lineno;
990         _nc_set_source(source);
991     }
992     _nc_read_entry_source((FILE *) 0, tc, FALSE, TRUE, NULLHOOK);
993 #else
994     /*
995      * Here is what the 4.4BSD termcap(3) page prescribes:
996      *
997      * It will look in the environment for a TERMCAP variable.  If found, and
998      * the value does not begin with a slash, and the terminal type name is the
999      * same as the environment string TERM, the TERMCAP string is used instead
1000      * of reading a termcap file.  If it does begin with a slash, the string is
1001      * used as a path name of the termcap file to search.  If TERMCAP does not
1002      * begin with a slash and name is different from TERM, tgetent() searches
1003      * the files $HOME/.termcap and /usr/share/misc/termcap, in that order,
1004      * unless the environment variable TERMPATH exists, in which case it
1005      * specifies a list of file pathnames (separated by spaces or colons) to be
1006      * searched instead.
1007      *
1008      * It goes on to state:
1009      *
1010      * Whenever multiple files are searched and a tc field occurs in the
1011      * requested entry, the entry it names must be found in the same file or
1012      * one of the succeeding files.
1013      *
1014      * However, this restriction is relaxed in ncurses; tc references to
1015      * previous files are permitted.
1016      *
1017      * This routine returns 1 if an entry is found, 0 if not found, and -1 if
1018      * the database is not accessible.
1019      */
1020     FILE *fp;
1021     char *tc, *termpaths[MAXPATHS];
1022     int filecount = 0;
1023     int j, k;
1024     bool use_buffer = FALSE;
1025     bool normal = TRUE;
1026     char tc_buf[1024];
1027     char pathbuf[PATH_MAX];
1028     char *copied = 0;
1029     char *cp;
1030     struct stat test_stat[MAXPATHS];
1031
1032     termpaths[filecount] = 0;
1033     if (use_terminfo_vars() && (tc = getenv("TERMCAP")) != 0) {
1034         if (_nc_is_abs_path(tc)) {      /* interpret as a filename */
1035             ADD_TC(tc, 0);
1036             normal = FALSE;
1037         } else if (_nc_name_match(tc, tn, "|:")) {      /* treat as a capability file */
1038             use_buffer = TRUE;
1039             (void) sprintf(tc_buf, "%.*s\n", (int) sizeof(tc_buf) - 2, tc);
1040             normal = FALSE;
1041         }
1042     }
1043
1044     if (normal) {               /* normal case */
1045         char envhome[PATH_MAX], *h;
1046
1047         copied = strdup(get_termpath());
1048         for (cp = copied; *cp; cp++) {
1049             if (*cp == NCURSES_PATHSEP)
1050                 *cp = '\0';
1051             else if (cp == copied || cp[-1] == '\0') {
1052                 ADD_TC(cp, filecount);
1053             }
1054         }
1055
1056 #define PRIVATE_CAP "%s/.termcap"
1057
1058         if (use_terminfo_vars() && (h = getenv("HOME")) != NULL && *h != '\0'
1059             && (strlen(h) + sizeof(PRIVATE_CAP)) < PATH_MAX) {
1060             /* user's .termcap, if any, should override it */
1061             (void) strcpy(envhome, h);
1062             (void) sprintf(pathbuf, PRIVATE_CAP, envhome);
1063             ADD_TC(pathbuf, filecount);
1064         }
1065     }
1066
1067     /*
1068      * Probably /etc/termcap is a symlink to /usr/share/misc/termcap.
1069      * Avoid reading the same file twice.
1070      */
1071 #if HAVE_LINK
1072     for (j = 0; j < filecount; j++) {
1073         bool omit = FALSE;
1074         if (stat(termpaths[j], &test_stat[j]) != 0
1075             || !S_ISREG(test_stat[j].st_mode)) {
1076             omit = TRUE;
1077         } else {
1078             for (k = 0; k < j; k++) {
1079                 if (test_stat[k].st_dev == test_stat[j].st_dev
1080                     && test_stat[k].st_ino == test_stat[j].st_ino) {
1081                     omit = TRUE;
1082                     break;
1083                 }
1084             }
1085         }
1086         if (omit) {
1087             T(("Path %s is a duplicate", termpaths[j]));
1088             for (k = j + 1; k < filecount; k++) {
1089                 termpaths[k - 1] = termpaths[k];
1090                 test_stat[k - 1] = test_stat[k];
1091             }
1092             --filecount;
1093             --j;
1094         }
1095     }
1096 #endif
1097
1098     /* parse the sources */
1099     if (use_buffer) {
1100         _nc_set_source("TERMCAP");
1101
1102         /*
1103          * We don't suppress warning messages here.  The presumption is
1104          * that since it's just a single entry, they won't be a pain.
1105          */
1106         _nc_read_entry_source((FILE *) 0, tc_buf, FALSE, FALSE, NULLHOOK);
1107     } else {
1108         int i;
1109
1110         for (i = 0; i < filecount; i++) {
1111
1112             T(("Looking for %s in %s", tn, termpaths[i]));
1113             if (_nc_access(termpaths[i], R_OK) == 0
1114                 && (fp = fopen(termpaths[i], "r")) != (FILE *) 0) {
1115                 _nc_set_source(termpaths[i]);
1116
1117                 /*
1118                  * Suppress warning messages.  Otherwise you get 400 lines of
1119                  * crap from archaic termcap files as ncurses complains about
1120                  * all the obsolete capabilities.
1121                  */
1122                 _nc_read_entry_source(fp, (char *) 0, FALSE, TRUE, NULLHOOK);
1123
1124                 (void) fclose(fp);
1125             }
1126         }
1127     }
1128     if (copied != 0)
1129         free(copied);
1130 #endif /* USE_GETCAP */
1131
1132     if (_nc_head == 0)
1133         return (TGETENT_ERR);
1134
1135     /* resolve all use references */
1136     _nc_resolve_uses2(TRUE, FALSE);
1137
1138     /* find a terminal matching tn, if we can */
1139 #if USE_GETCAP_CACHE
1140     if (getcwd(cwd_buf, sizeof(cwd_buf)) != 0) {
1141         _nc_set_writedir((char *) 0);   /* note: this does a chdir */
1142 #endif
1143         for_entry_list(ep) {
1144             if (_nc_name_match(ep->tterm.term_names, tn, "|:")) {
1145                 /*
1146                  * Make a local copy of the terminal capabilities, delinked
1147                  * from the list.
1148                  */
1149                 *tp = ep->tterm;
1150                 _nc_delink_entry(_nc_head, &(ep->tterm));
1151                 free(ep);
1152
1153                 /*
1154                  * OK, now try to write the type to user's terminfo directory. 
1155                  * Next time he loads this, it will come through terminfo.
1156                  *
1157                  * Advantage:  Second and subsequent fetches of this entry will
1158                  * be very fast.
1159                  *
1160                  * Disadvantage:  After the first time a termcap type is loaded
1161                  * by its user, editing it in the /etc/termcap file, or in
1162                  * TERMCAP, or in a local ~/.termcap, will be ineffective
1163                  * unless the terminfo entry is explicitly removed.
1164                  */
1165 #if USE_GETCAP_CACHE
1166                 (void) _nc_write_entry(tp);
1167 #endif
1168                 found = TGETENT_YES;
1169                 break;
1170             }
1171         }
1172 #if USE_GETCAP_CACHE
1173         chdir(cwd_buf);
1174     }
1175 #endif
1176
1177     return (found);
1178 }
1179 #else
1180 extern
1181 NCURSES_EXPORT(void)
1182 _nc_read_termcap(void);
1183 NCURSES_EXPORT(void)
1184 _nc_read_termcap(void)
1185 {
1186 }
1187 #endif /* PURE_TERMINFO */