term_private.h revision 1.21
1 /* $NetBSD: term_private.h,v 1.21 2025/09/23 20:26:57 js Exp $ */ 2 3 /* 4 * Copyright (c) 2009, 2010, 2013, 2020 The NetBSD Foundation, Inc. 5 * 6 * This code is derived from software contributed to The NetBSD Foundation 7 * by Roy Marples. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 #ifndef _TERM_PRIVATE_H_ 31 #define _TERM_PRIVATE_H_ 32 33 /* This header should only be used by libterminfo, tic and infocmp. */ 34 35 /* The terminfo database structure is private to us, 36 * so it's documented here. 37 * 38 * Version 1 - types 1 and 2. 39 * terminfo defines the largest number as 32767 and the largest 40 * compiled entry as 4093 bytes long. Negative numbers are not allowed. 41 * Thus, we store all numbers as uint16_t, including string length. 42 * We reserve negative numbers -1 and -2 to mean absent or cancelled. 43 * All strings are prefixed by length, including the null terminator. 44 * The largest string length we can handle is 65535 bytes, 45 * including the null terminator. 46 * The largest capability block we can handle is 65535 bytes. 47 * 48 * Version 2 - type 3 49 * Extends terminfo numbers upto 2147483647 by storing the value as a uint32_t. 50 * This means that we exceed the current terminfo defined limits in every way. 51 * 52 * Type 1 capabilities are defined as: 53 * header byte (always 1) 54 * name 55 * description, 56 * cap length, num flags, index, char, 57 * cap length, num numbers, index, number, 58 * cap length, num strings, index, string, 59 * cap length, num undefined caps, name, type (char), flag, number, string 60 * 61 * Type 2 entries are aliases and defined as: 62 * header byte (always 2) 63 * 32bit id of the corresponding terminal in the file 64 * name 65 * 66 * Type 3 extends Type 1 so that it can store terminfo numbers 67 * as uint32_t. All other numerics are still stored as uint16_t. 68 * 69 * The database itself is created using cdbw(3) and the numbers are 70 * always stored as little endian. 71 */ 72 73 #ifdef HAVE_SYS_ENDIAN_H 74 # include <sys/endian.h> 75 #endif 76 #include <sys/types.h> 77 #include <assert.h> 78 #include <limits.h> 79 80 #define _TERMINFO 81 #define TERMINFO_RTYPE_O1 1 82 #define TERMINFO_ALIAS 2 83 #define TERMINFO_RTYPE 3 84 85 /* , and | are the two print characters now allowed 86 * in terminfo aliases or long descriptions. 87 * As | is generally used to delimit aliases inside the 88 * description, we use a comma. */ 89 #define TERMINFO_VDELIM ',' 90 #define TERMINFO_VDELIMSTR "," 91 92 /* We use the same ncurses tic macros so that our data is identical 93 * when a caller uses the long name macros to access te terminfo data 94 * directly. */ 95 #define ABSENT_BOOLEAN ((signed char)-1) /* 255 */ 96 #define ABSENT_NUMERIC (-1) 97 #define ABSENT_STRING (char *)0 98 #define CANCELLED_BOOLEAN ((signed char)-2) /* 254 */ 99 #define CANCELLED_NUMERIC (-2) 100 #define CANCELLED_STRING (char *)(-1) 101 #define VALID_BOOLEAN(s) ((unsigned char)(s) <= 1) /* reject "-1" */ 102 #define VALID_NUMERIC(s) ((s) >= 0) 103 #define VALID_STRING(s) ((s) != CANCELLED_STRING && (s) != ABSENT_STRING) 104 105 typedef struct { 106 const char *id; 107 char type; 108 char flag; 109 int num; 110 const char *str; 111 } TERMUSERDEF; 112 113 typedef struct { 114 int fildes; 115 /* We need to expose these so that the macros work */ 116 const char *name; 117 const char *desc; 118 signed char *flags; 119 int *nums; 120 const char **strs; 121 /* Storage area for terminfo data */ 122 char *_area; 123 size_t _arealen; 124 size_t _nuserdefs; 125 TERMUSERDEF *_userdefs; 126 /* So we don't rely on the global ospeed */ 127 short _ospeed; 128 /* Output buffer for tparm */ 129 char *_buf; 130 size_t _buflen; 131 size_t _bufpos; 132 /* A-Z static variables for tparm */ 133 long _snums[26]; 134 /* aliases of the terminal, | separated */ 135 const char *_alias; 136 } TERMINAL; 137 138 extern const char * _ti_database; 139 140 ssize_t _ti_flagindex(const char *); 141 ssize_t _ti_numindex(const char *); 142 ssize_t _ti_strindex(const char *); 143 const char * _ti_flagid(ssize_t); 144 const char * _ti_numid(ssize_t); 145 const char * _ti_strid(ssize_t); 146 int _ti_getterm(TERMINAL *, const char *, int); 147 void _ti_setospeed(TERMINAL *); 148 149 /* libterminfo can compile terminfo strings too */ 150 #define TIC_WARNING (1 << 0) 151 #define TIC_DESCRIPTION (1 << 1) 152 #define TIC_ALIAS (1 << 2) 153 #define TIC_COMMENT (1 << 3) 154 #define TIC_EXTRA (1 << 4) 155 #define TIC_COMPAT_V1 (1 << 5) 156 157 typedef struct { 158 char *buf; 159 size_t buflen; 160 size_t bufpos; 161 size_t entries; 162 } TBUF; 163 164 typedef struct { 165 char *name; 166 char *alias; 167 char *desc; 168 int rtype; 169 TBUF flags; 170 TBUF nums; 171 TBUF strs; 172 TBUF extras; 173 } TIC; 174 175 #define _ti_numsize(tic) \ 176 ((tic)->rtype == TERMINFO_RTYPE_O1 ? sizeof(uint16_t) : sizeof(uint32_t)) 177 178 int _ti_promote(TIC *); 179 char *_ti_grow_tbuf(TBUF *, size_t); 180 char *_ti_get_token(char **, char); 181 const char *_ti_find_cap(TIC *, TBUF *, char, short); 182 const char *_ti_find_extra(TIC *, TBUF *, const char *); 183 char *_ti_getname(int, const char *); 184 size_t _ti_store_extra(TIC *, int, const char *, char, char, int, 185 const char *, size_t, int); 186 TIC *_ti_compile(char *, int); 187 ssize_t _ti_flatten(uint8_t **, const TIC *); 188 void _ti_freetic(TIC *); 189 190 int _ti_encode_buf_id_num(TBUF *, int, int, size_t); 191 int _ti_encode_buf_id_count_str(TBUF *, int, const void *, size_t); 192 int _ti_encode_buf_id_flags(TBUF *, int, int); 193 194 #define TPARM_MAX 9 /* not likely to change */ 195 int _ti_parm_analyse(const char *, int *, int); 196 197 static __inline int 198 _ti_decode_16(const char **cap) 199 { 200 int num = (int16_t)le16dec(*cap); 201 202 *cap += sizeof(uint16_t); 203 return num; 204 } 205 206 static __inline int 207 _ti_decode_32(const char **cap) 208 { 209 int num = (int32_t)le32dec(*cap); 210 211 *cap += sizeof(uint32_t); 212 return num; 213 } 214 215 static __inline int 216 _ti_decode_num(const char **cap, int rtype) 217 { 218 if (rtype == TERMINFO_RTYPE_O1) { 219 return _ti_decode_16(cap); 220 } else { 221 return _ti_decode_32(cap); 222 } 223 } 224 225 static __inline void 226 _ti_encode_16(char **cap, size_t num) 227 { 228 _DIAGASSERT(num <= UINT16_MAX); 229 le16enc(*cap, (uint16_t)num); 230 *cap += sizeof(uint16_t); 231 } 232 233 static __inline void 234 _ti_encode_32(char **cap, size_t num) 235 { 236 _DIAGASSERT(num <= UINT32_MAX); 237 le32enc(*cap, (uint32_t)num); 238 *cap += sizeof(uint32_t); 239 } 240 241 static __inline void 242 _ti_encode_str(char **cap, const void *buf, size_t len) 243 { 244 memcpy(*cap, buf, len); 245 *cap += len; 246 } 247 248 static __inline void 249 _ti_encode_count_str(char **cap, const char *name, size_t len) 250 { 251 _ti_encode_16(cap, (uint16_t)len); 252 if (name == NULL) 253 return; 254 _ti_encode_str(cap, name, len); 255 } 256 257 static __inline void 258 _ti_encode_buf_16(TBUF *tbuf, size_t num) 259 { 260 _DIAGASSERT(num <= UINT16_MAX); 261 le16enc(tbuf->buf + tbuf->bufpos, (uint16_t)num); 262 tbuf->bufpos += sizeof(uint16_t); 263 } 264 265 static __inline void 266 _ti_encode_buf_32(TBUF *tbuf, size_t num) 267 { 268 _DIAGASSERT(num <= UINT32_MAX); 269 le32enc(tbuf->buf + tbuf->bufpos, (uint32_t)num); 270 tbuf->bufpos += sizeof(uint32_t); 271 } 272 273 static __inline void 274 _ti_encode_buf_count_str(TBUF *tbuf, const void *buf, size_t len) 275 { 276 _ti_encode_buf_16(tbuf, len); 277 memcpy(tbuf->buf + tbuf->bufpos, buf, len); 278 tbuf->bufpos += len; 279 } 280 281 static __inline void 282 _ti_encode_buf_num(TBUF *tbuf, int num, int rtype) 283 { 284 if (rtype == TERMINFO_RTYPE_O1) { 285 if (num > INT16_MAX) 286 num = INT16_MAX; 287 _ti_encode_buf_16(tbuf, (uint16_t)num); 288 } else { 289 if (num > INT32_MAX) 290 num = INT32_MAX; 291 _ti_encode_buf_32(tbuf, (uint32_t)num); 292 } 293 } 294 295 #endif 296
Indexes created Fri Oct 17 03:10:13 GMT 2025