chiark - git - mdw - mLib/blob - struct/buf.h

   1 /* -*-c-*-
   2  *
   3  * Reading and writing packet buffers
   4  *
   5  * (c) 2001 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 #ifndef MLIB_BUF_H
  29 #define MLIB_BUF_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #include <stdarg.h>
  38 #include <stddef.h>
  39
  40 #ifndef MLIB_BITS_H
  41 #  include "bits.h"
  42 #endif
  43
  44 #ifndef MLIB_CONTROL_H
  45 #  include "control.h"
  46 #endif
  47
  48 #ifndef MLIB_DSTR_H
  49 #  include "dstr.h"
  50 #endif
  51
  52 #ifndef MLIB_MACROS_H
  53 #  include "macros.h"
  54 #endif
  55
  56 /*----- Data structures ---------------------------------------------------*/
  57
  58 /* --- Buffers --- *
  59  *
  60  * Buffers provide a simple stream-like interface for building and parsing
  61  * packets.
  62  */
  63
  64 typedef struct buf {
  65   octet *base, *p, *limit;              /* Pointers to the buffer */
  66   unsigned f;                           /* Various flags */
  67 } buf;
  68
  69 #define BF_BROKEN 1u                    /* Buffer is broken */
  70 #define BF_ALLOC 2u                     /* Buffer is dynamic */
  71 #define BF_WRITE 4u                     /* Currently writing to buffer */
  72
  73 typedef struct dbuf {
  74   buf _b;
  75   arena *a;                             /* Allocation arena */
  76   size_t sz;                            /* Allocated size */
  77 } dbuf;
  78
  79 #define DBUF_INIT { { 0, 0, 0, BF_ALLOC | BF_WRITE}, &arena_stdlib, 0 }
  80 #define DBUF_BUF(db) (&(db)->_b)
  81
  82 extern const struct gprintf_ops buf_printops;
  83
  84 /*----- Useful macros -----------------------------------------------------*/
  85
  86 #define BBASE(b) ((b)->base)
  87 #define BLIM(b) ((b)->limit)
  88 #define BCUR(b) ((b)->p)
  89 #define BSZ(b) ((b)->limit - (b)->base)
  90 #define BLEN(b) ((b)->p - (b)->base)
  91 #define BLEFT(b) ((b)->limit - (b)->p)
  92 #define BSTEP(b, sz) ((b)->p += (sz))
  93 #define BBAD(b) ((b)->f & BF_BROKEN)
  94 #define BOK(b) (!BBAD(b))
  95
  96 #define BENSURE(b, sz)                                          \
  97      (BBAD(b) ? -1 : (sz) > BLEFT(b) ? buf_tryextend(b, sz) : 0)
  98
  99 #define DBBASE(db) BBASE(DBUF_BUF(db))
 100 #define DBLIM(db) BLIM(DBUF_BUF(db))
 101 #define DBCUR(db) BCUR(DBUF_BUF(db))
 102 #define DBSZ(db) BSZ(DBUF_BUF(db))
 103 #define DBLEN(db) BLEN(DBUF_BUF(db))
 104 #define DBLEFT(db) BLEFT(DBUF_BUF(db))
 105 #define DBSTEP(db, sz) BSTEP(DBUF_BUF(db), (sz))
 106 #define DBBAD(db) BBAD(DBUF_BUF(db))
 107 #define DBOK(db) BOK(DBUF_BUF(db))
 108 #define DBENSURE(b, sz) BENSURE(DBUF_BUF(db), (sz))
 109
 110 #ifdef HAVE_UINT64
 111 #  define BUF_DOKLUDGESUFFIXES(_)
 112 #else
 113 #  define BUF_DOKLUDGESUFFIXES(_)                                       \
 114         _(64, 64, 64) _(64, 64_B, 64b) _(64, 64_L, 64l)
 115 #endif
 116
 117 #define BUF_DOSUFFIXES(_) DOUINTCONV(_) BUF_DOKLUDGESUFFIXES(_) _(z, z, z)
 118
 119 /*----- Functions provided ------------------------------------------------*/
 120
 121 /* --- @buf_init@ --- *
 122  *
 123  * Arguments:   @buf *b@ = pointer to a buffer block
 124  *              @void *p@ = pointer to a buffer
 125  *              @size_t sz@ = size of the buffer
 126  *
 127  * Returns:     ---
 128  *
 129  * Use:         Initializes the buffer block appropriately.
 130  */
 131
 132 extern void buf_init(buf */*b*/, void */*p*/, size_t /*sz*/);
 133
 134 /* --- @dbuf_create@ --- *
 135  *
 136  * Arguments:   @dbuf *db@ = pointer to a dynamic buffer block
 137  *
 138  * Returns:     ---
 139  *
 140  * Use:         Initializes a dynamic buffer.  The buffer is initially empty,
 141  *              and ready for writing.
 142  */
 143
 144 extern void dbuf_create(dbuf */*db*/);
 145 #define DBCREATE(db) do {                                               \
 146   (db)->_b.base = (db)->_b.p = (db)->_b.limit = 0;                      \
 147   (db)->_b.f = BF_ALLOC | BF_WRITE;                                     \
 148   (db)->a = &arena_stdlib; (db)->sz = 0;                                \
 149 } while (0)
 150
 151 /* --- @dbuf_reset@ --- *
 152  *
 153  * Arguments:   @dbuf *db@ = pointer to a buffer block
 154  *
 155  * Returns:     ---
 156  *
 157  * Use:         Resets a buffer so that it can be written again.
 158  */
 159
 160 extern void dbuf_reset(dbuf */*db*/);
 161 #define DBRESET(db) do {                                                \
 162   (db)->_b.p = (db)->_b.base; (db)->_b.limit = (db)->_b.base + (db)->sz; \
 163   (db)->_b.f = ((db)->_b.f&~BF_BROKEN) | BF_WRITE;                      \
 164 } while (0)
 165
 166 /* --- @dbuf_destroy@ --- *
 167  *
 168  * Arguments:   @dbuf *db@ = pointer to a buffer block
 169  *
 170  * Returns:     ---
 171  *
 172  * Use:         Release all of the resources held by a dynamic buffer.
 173  */
 174
 175 extern void dbuf_destroy(dbuf */*db*/);
 176 #define DBDESTROY(db) do {                                              \
 177   if ((db)->_b.base) x_free((db)->a, (db)->_b.base);                    \
 178   (db)->_b.base = (db)->_b.p = (db)->_b.limit = 0;                      \
 179   (db)->_b.f = BF_ALLOC | BF_WRITE; (db)->sz = 0;                       \
 180 } while (0)
 181
 182 /* --- @{,d}buf_break@ --- *
 183  *
 184  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 185  *
 186  * Returns:     Some negative value.
 187  *
 188  * Use:         Marks a buffer as broken.
 189  */
 190
 191 extern int buf_break(buf */*b*/);
 192 extern int dbuf_break(dbuf */*db*/);
 193 #define dbuf_break(db) (buf_break(DBUF_BUF(db)))
 194 #define BBREAK(b) do { (b)->f |= BF_BROKEN; } while (0)
 195 #define DBBREAK(db) BBREAK(DBUF_BUF(db))
 196
 197 /* --- @{,d}buf_flip@ --- *
 198  *
 199  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 200  *
 201  * Returns:     ---
 202  *
 203  * Use:         Flips a buffer so that if you've just been writing to it,
 204  *              you can now read from the bit you've written.
 205  */
 206
 207 extern void buf_flip(buf */*b*/);
 208 extern void dbuf_flip(dbuf */*db*/);
 209 #define dbuf_flip(db) (buf_flip(DBUF_BUF(db)))
 210
 211 #define BFLIP(b) do {                                                   \
 212   (b)->limit = (b)->p; (b)->p = (b)->base;                              \
 213   (b)->f &= ~BF_WRITE;                                                  \
 214 } while (0)
 215 #define DBFLIP(db) BFLIP(DBUF_BUF(db))
 216
 217 /* --- @{,d}buf_ensure@ --- *
 218  *
 219  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 220  *              @size_t sz@ = size of data wanted
 221  *
 222  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 223  *
 224  * Use:         Ensures that there are @sz@ bytes still in the buffer.
 225  */
 226
 227 extern int buf_ensure(buf */*b*/, size_t /*sz*/);
 228 extern int dbuf_ensure(dbuf */*db*/, size_t /*sz*/);
 229 #define dbuf_ensure(db, sz) (buf_ensure(DBUF_BUF(db), (sz)))
 230
 231 /* --- @{,d}buf_tryextend@ --- *
 232  *
 233  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 234  *              @size_t sz@ = size of data wanted
 235  *
 236  * Returns:     Zero if it worked, nonzero if the buffer won't grow.
 237  *
 238  * Use:         Extend the buffer so that at least @sz@ bytes are available.
 239  *              This only works if the buffer is allocated.
 240  */
 241
 242 extern int buf_tryextend(buf */*b*/, size_t /*sz*/);
 243 extern int dbuf_tryextend(dbuf */*db*/, size_t /*sz*/);
 244 #define dbuf_tryextend(db, sz) (buf_tryextend(DBUF_BUF(db), (sz)))
 245
 246 /* --- @{,d}buf_get@ --- *
 247  *
 248  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 249  *              @size_t sz@ = size of the buffer
 250  *
 251  * Returns:     Pointer to the place in the buffer.
 252  *
 253  * Use:         Reserves a space in the buffer of the requested size, and
 254  *              returns its start address.
 255  */
 256
 257 extern void *buf_get(buf */*b*/, size_t /*sz*/);
 258 extern void *dbuf_get(dbuf */*db*/, size_t /*sz*/);
 259 #define dbuf_get(db, sz) (buf_get(DBUF_BUF(db), (sz)))
 260
 261 /* --- @{,d}buf_put@ --- *
 262  *
 263  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 264  *              @const void *p@ = pointer to a buffer
 265  *              @size_t sz@ = size of the buffer
 266  *
 267  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 268  *
 269  * Use:         Fetches data from some place and puts it in the buffer
 270  */
 271
 272 extern int buf_put(buf */*b*/, const void */*p*/, size_t /*sz*/);
 273 extern int dbuf_put(dbuf */*db*/, const void */*p*/, size_t /*sz*/);
 274 #define dbuf_put(db, p, sz) (buf_put(DBUF_BUF(db), (p), (sz)))
 275
 276 /* --- @{,d}buf_fill@ --- *
 277  *
 278  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 279  *              @int ch@ = fill character
 280  *              @size_t sz@ = size to fill
 281  *
 282  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 283  *
 284  * Use:         Write @sz@ bytes with value @ch@ to the buffer, as if with
 285  *              @memset@.
 286  */
 287
 288 extern int buf_fill(buf */*b*/, int /*ch*/, size_t /*sz*/);
 289 extern int dbuf_fill(dbuf */*db*/, int /*ch*/, size_t /*sz*/);
 290 #define dbuf_fill(db, ch, sz) (buf_fill(DBUF_BUF(db), (ch), (sz)))
 291
 292 /* --- @{,d}buf_getbyte@ --- *
 293  *
 294  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 295  *
 296  * Returns:     A byte, or less than zero if there wasn't a byte there.
 297  *
 298  * Use:         Gets a single byte from a buffer.
 299  */
 300
 301 extern int buf_getbyte(buf */*b*/);
 302 extern int dbuf_getbyte(dbuf */*db*/);
 303 #define dbuf_getbyte(db) (buf_getbyte(DBUF_BUF(db)))
 304
 305 /* --- @{,d}buf_putbyte@ --- *
 306  *
 307  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 308  *              @int ch@ = byte to write
 309  *
 310  * Returns:     Zero if OK, nonzero if there wasn't enough space.
 311  *
 312  * Use:         Puts a single byte in a buffer.
 313  */
 314
 315 extern int buf_putbyte(buf */*b*/, int /*ch*/);
 316 extern int dbuf_putbyte(dbuf */*db*/, int /*ch*/);
 317 #define dbuf_putbyte(db, ch) (buf_putbyte(DBUF_BUF(db), (ch)))
 318
 319 /* --- @{,d}buf_getu{8,{16,24,32,64}{,l,b}}@ --- *
 320  *
 321  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 322  *              @uintSZ *w@ = where to put the word
 323  *
 324  * Returns:     Zero if OK, or nonzero if there wasn't a word there.
 325  *
 326  * Use:         Gets a word of appropriate size and order from a buffer.
 327  */
 328
 329 #define BUF_DECL_GETU_(n, W, w)                                         \
 330   extern int buf_getu##w(buf */*b*/, uint##n */*w*/);                   \
 331   extern int dbuf_getu##w(dbuf */*db*/, uint##n */*w*/);
 332 DOUINTCONV(BUF_DECL_GETU_)
 333 #define dbuf_getu8(db, w) (buf_getu8(DBUF_BUF(db), (w)))
 334 #define dbuf_getu16(db, w) (buf_getu16(DBUF_BUF(db), (w)))
 335 #define dbuf_getu16l(db, w) (buf_getu16l(DBUF_BUF(db), (w)))
 336 #define dbuf_getu16b(db, w) (buf_getu16b(DBUF_BUF(db), (w)))
 337 #define dbuf_getu24(db, w) (buf_getu24(DBUF_BUF(db), (w)))
 338 #define dbuf_getu24l(db, w) (buf_getu24l(DBUF_BUF(db), (w)))
 339 #define dbuf_getu24b(db, w) (buf_getu24b(DBUF_BUF(db), (w)))
 340 #define dbuf_getu32(db, w) (buf_getu32(DBUF_BUF(db), (w)))
 341 #define dbuf_getu32l(db, w) (buf_getu32l(DBUF_BUF(db), (w)))
 342 #define dbuf_getu32b(db, w) (buf_getu32b(DBUF_BUF(db), (w)))
 343 #ifdef HAVE_UINT64
 344 #  define dbuf_getu64(db, w) (buf_getu64(DBUF_BUF(db), (w)))
 345 #  define dbuf_getu64l(db, w) (buf_getu64l(DBUF_BUF(db), (w)))
 346 #  define dbuf_getu64b(db, w) (buf_getu64b(DBUF_BUF(db), (w)))
 347 #endif
 348
 349 /* --- @{,d}buf_getk64{,l,b}@ --- *
 350  *
 351  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 352  *              @kludge64 *w@ = where to put the word
 353  *
 354  * Returns:     Zero if OK, or nonzero if there wasn't a word there.
 355  *
 356  * Use:         Gets a word of appropriate size and order from a buffer.
 357  */
 358
 359 extern int buf_getk64(buf */*b*/, kludge64 */*w*/);
 360 extern int buf_getk64l(buf */*b*/, kludge64 */*w*/);
 361 extern int buf_getk64b(buf */*b*/, kludge64 */*w*/);
 362 extern int dbuf_getk64(dbuf */*db*/, kludge64 */*w*/);
 363 extern int dbuf_getk64l(dbuf */*db*/, kludge64 */*w*/);
 364 extern int dbuf_getk64b(dbuf */*db*/, kludge64 */*w*/);
 365 #define dbuf_getk64(db, w) (buf_getk64(DBUF_BUF(db), (w)))
 366 #define dbuf_getk64l(db, w) (buf_getk64l(DBUF_BUF(db), (w)))
 367 #define dbuf_getk64b(db, w) (buf_getk64b(DBUF_BUF(db), (w)))
 368
 369 /* --- @{,d}buf_putu{8,{16,24,32,64}{,l,b}}@ --- *
 370  *
 371  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 372  *              @uintSZ w@ = word to write
 373  *
 374  * Returns:     Zero if OK, or nonzero if there wasn't enough space
 375  *
 376  * Use:         Puts a word into a buffer with appropriate size and order.
 377  */
 378
 379 #define BUF_DECL_PUTU_(n, W, w)                                         \
 380   extern int buf_putu##w(buf */*b*/, uint##n /*w*/);                    \
 381   extern int dbuf_putu##w(dbuf */*db*/, uint##n /*w*/);
 382 DOUINTCONV(BUF_DECL_PUTU_)
 383 #define dbuf_putu8(db, w) (buf_putu8(DBUF_BUF(db), (w)))
 384 #define dbuf_putu16(db, w) (buf_putu16(DBUF_BUF(db), (w)))
 385 #define dbuf_putu16l(db, w) (buf_putu16l(DBUF_BUF(db), (w)))
 386 #define dbuf_putu16b(db, w) (buf_putu16b(DBUF_BUF(db), (w)))
 387 #define dbuf_putu24(db, w) (buf_putu24(DBUF_BUF(db), (w)))
 388 #define dbuf_putu24l(db, w) (buf_putu24l(DBUF_BUF(db), (w)))
 389 #define dbuf_putu24b(db, w) (buf_putu24b(DBUF_BUF(db), (w)))
 390 #define dbuf_putu32(db, w) (buf_putu32(DBUF_BUF(db), (w)))
 391 #define dbuf_putu32l(db, w) (buf_putu32l(DBUF_BUF(db), (w)))
 392 #define dbuf_putu32b(db, w) (buf_putu32b(DBUF_BUF(db), (w)))
 393 #ifdef HAVE_UINT64
 394 #  define dbuf_putu64(db, w) (buf_putu64(DBUF_BUF(db), (w)))
 395 #  define dbuf_putu64l(db, w) (buf_putu64l(DBUF_BUF(db), (w)))
 396 #  define dbuf_putu64b(db, w) (buf_putu64b(DBUF_BUF(db), (w)))
 397 #endif
 398
 399 /* --- @{,d}buf_putk64{,l,b}@ --- *
 400  *
 401  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 402  *              @kludge64 w@ = word to write
 403  *
 404  * Returns:     Zero if OK, or nonzero if there wasn't enough space
 405  *
 406  * Use:         Gets a word of appropriate size and order from a buffer.
 407  */
 408
 409 extern int buf_putk64(buf */*b*/, kludge64 /*w*/);
 410 extern int buf_putk64l(buf */*b*/, kludge64 /*w*/);
 411 extern int buf_putk64b(buf */*b*/, kludge64 /*w*/);
 412 extern int dbuf_putk64(dbuf */*db*/, kludge64 /*w*/);
 413 extern int dbuf_putk64l(dbuf */*db*/, kludge64 /*w*/);
 414 extern int dbuf_putk64b(dbuf */*db*/, kludge64 /*w*/);
 415 #define dbuf_putk64(db, w) (buf_putk64(DBUF_BUF(db), (w)))
 416 #define dbuf_putk64l(db, w) (buf_putk64l(DBUF_BUF(db), (w)))
 417 #define dbuf_putk64b(db, w) (buf_putk64b(DBUF_BUF(db), (w)))
 418
 419 /* --- @buf_getf{32,64}{,l,b} --- *
 420  *
 421  * Arguments:   @buf *b@ = a buffer to read from
 422  *              @float *x_out@, @double *x_out@ = where to put the result
 423  *
 424  * Returns:     Zero on success, %$-1$% on failure (and the buffer is
 425  *              broken).
 426  *
 427  * Use:         Get an IEEE Binary32 or Binary64 value from the buffer.
 428  *              Conversion is performed using the `fltfmt' machinery, with
 429  *              the usual round-to-nearest/ties-to-even rounding mode.
 430  */
 431
 432 extern int buf_getf32(buf */*b*/, float */*x_out*/);
 433 extern int buf_getf32l(buf */*b*/, float */*x_out*/);
 434 extern int buf_getf32b(buf */*b*/, float */*x_out*/);
 435 #define dbuf_getf32(db, x_out) (buf_getf32(DBUF_BUF(db), (x_out)))
 436 #define dbuf_getf32l(db, x_out) (buf_getf32l(DBUF_BUF(db), (x_out)))
 437 #define dbuf_getf32b(db, x_out) (buf_getf32b(DBUF_BUF(db), (x_out)))
 438
 439 extern int buf_getf64(buf */*b*/, double */*x_out*/);
 440 extern int buf_getf64l(buf */*b*/, double */*x_out*/);
 441 extern int buf_getf64b(buf */*b*/, double */*x_out*/);
 442 #define dbuf_getf64(db, x_out) (buf_getf64(DBUF_BUF(db), (x_out)))
 443 #define dbuf_getf64l(db, x_out) (buf_getf64l(DBUF_BUF(db), (x_out)))
 444 #define dbuf_getf64b(db, x_out) (buf_getf64b(DBUF_BUF(db), (x_out)))
 445
 446 /* --- @buf_putf{32,64}{,l,b} --- *
 447  *
 448  * Arguments:   @buf *b@ = a buffer to write to
 449  *              @double x@ = a number to write
 450  *
 451  * Returns:     Zero on success, %$-1$% on failure (and the buffer is
 452  *              broken).
 453  *
 454  * Use:         Get an IEEE Binary32 or Binary64 value from the buffer.
 455  *              Conversion is performed using the `fltfmt' machinery, with
 456  *              the usual round-to-nearest/ties-to-even rounding mode.
 457  */
 458
 459 extern int buf_putf32(buf */*b*/, float /*x*/);
 460 extern int buf_putf32l(buf */*b*/, float /*x*/);
 461 extern int buf_putf32b(buf */*b*/, float /*x*/);
 462 #define dbuf_putf32(db, x) (buf_putf32(DBUF_BUF(db), (x)))
 463 #define dbuf_putf32l(db, x) (buf_putf32l(DBUF_BUF(db), (x)))
 464 #define dbuf_putf32b(db, x) (buf_putf32b(DBUF_BUF(db), (x)))
 465
 466 extern int buf_putf64(buf */*b*/, double /*x*/);
 467 extern int buf_putf64l(buf */*b*/, double /*x*/);
 468 extern int buf_putf64b(buf */*b*/, double /*x*/);
 469 #define dbuf_putf64(db, x) (buf_putf64(DBUF_BUF(db), (x)))
 470 #define dbuf_putf64l(db, x) (buf_putf64l(DBUF_BUF(db), (x)))
 471 #define dbuf_putf64b(db, x) (buf_putf64b(DBUF_BUF(db), (x)))
 472
 473 /* --- @{,d}buf_getmem{8,{16,24,32,64}{,l,b},z} --- *
 474  *
 475  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 476  *              @size_t *nn@ = where to put the length
 477  *
 478  * Returns:     Pointer to the buffer data, or null.
 479  *
 480  * Use:         Gets a chunk of memory from a buffer.  The suffix is the
 481  *              width and byte order of the length; @z@ means null-
 482  *              terminated.
 483  */
 484
 485 #define BUF_DECL_GETMEM_(n, W, w)                                       \
 486   extern void *buf_getmem##w(buf */*b*/, size_t */*nn*/);               \
 487   extern void *dbuf_getmem##w(dbuf */*db*/, size_t */*nn*/);
 488 BUF_DOSUFFIXES(BUF_DECL_GETMEM_)
 489 #define dbuf_getmem8(db, nn) (buf_getmem8(DBUF_BUF(db), (nn)))
 490 #define dbuf_getmem16(db, nn) (buf_getmem16(DBUF_BUF(db), (nn)))
 491 #define dbuf_getmem16l(db, nn) (buf_getmem16l(DBUF_BUF(db), (nn)))
 492 #define dbuf_getmem16b(db, nn) (buf_getmem16b(DBUF_BUF(db), (nn)))
 493 #define dbuf_getmem24(db, nn) (buf_getmem24(DBUF_BUF(db), (nn)))
 494 #define dbuf_getmem24l(db, nn) (buf_getmem24l(DBUF_BUF(db), (nn)))
 495 #define dbuf_getmem24b(db, nn) (buf_getmem24b(DBUF_BUF(db), (nn)))
 496 #define dbuf_getmem32(db, nn) (buf_getmem32(DBUF_BUF(db), (nn)))
 497 #define dbuf_getmem32l(db, nn) (buf_getmem32l(DBUF_BUF(db), (nn)))
 498 #define dbuf_getmem32b(db, nn) (buf_getmem32b(DBUF_BUF(db), (nn)))
 499 #define dbuf_getmem64(db, nn) (buf_getmem64(DBUF_BUF(db), (nn)))
 500 #define dbuf_getmem64l(db, nn) (buf_getmem64l(DBUF_BUF(db), (nn)))
 501 #define dbuf_getmem64b(db, nn) (buf_getmem64b(DBUF_BUF(db), (nn)))
 502 #define dbuf_getmemz(db, nn) (buf_getmemz(DBUF_BUF(db), (nn)))
 503
 504 /* --- @{,d}buf_putmem{8,{16,24,32,64}{,l,b},z} --- *
 505  *
 506  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 507  *              @const void *p@ = pointer to data to write
 508  *              @size_t n@ = length to write
 509  *
 510  * Returns:     Zero if OK, nonzero if there wasn't enough space.
 511  *
 512  * Use:         Writes a chunk of data to a buffer.  The suffix is the
 513  *              width and byte order of the length; @z@ means null-
 514  *              terminated.
 515  */
 516
 517 #define BUF_DECL_PUTMEM_(n, W, w)                                       \
 518   extern int buf_putmem##w(buf */*b*/, const void */*p*/, size_t /*nn*/); \
 519   extern int dbuf_putmem##w(dbuf */*db*/, const void */*p*/, size_t /*nn*/);
 520 BUF_DOSUFFIXES(BUF_DECL_PUTMEM_)
 521 #define dbuf_putmem8(db, p, nn) (buf_putmem8(DBUF_BUF(db), (p), (nn)))
 522 #define dbuf_putmem16(db, p, nn) (buf_putmem16(DBUF_BUF(db), (p), (nn)))
 523 #define dbuf_putmem16l(db, p, nn) (buf_putmem16l(DBUF_BUF(db), (p), (nn)))
 524 #define dbuf_putmem16b(db, p, nn) (buf_putmem16b(DBUF_BUF(db), (p), (nn)))
 525 #define dbuf_putmem24(db, p, nn) (buf_putmem24(DBUF_BUF(db), (p), (nn)))
 526 #define dbuf_putmem24l(db, p, nn) (buf_putmem24l(DBUF_BUF(db), (p), (nn)))
 527 #define dbuf_putmem24b(db, p, nn) (buf_putmem24b(DBUF_BUF(db), (p), (nn)))
 528 #define dbuf_putmem32(db, p, nn) (buf_putmem32(DBUF_BUF(db), (p), (nn)))
 529 #define dbuf_putmem32l(db, p, nn) (buf_putmem32l(DBUF_BUF(db), (p), (nn)))
 530 #define dbuf_putmem32b(db, p, nn) (buf_putmem32b(DBUF_BUF(db), (p), (nn)))
 531 #define dbuf_putmem64(db, p, nn) (buf_putmem64(DBUF_BUF(db), (p), (nn)))
 532 #define dbuf_putmem64l(db, p, nn) (buf_putmem64l(DBUF_BUF(db), (p), (nn)))
 533 #define dbuf_putmem64b(db, p, nn) (buf_putmem64b(DBUF_BUF(db), (p), (nn)))
 534 #define dbuf_putmemz(db, p, nn) (buf_putmemz(DBUF_BUF(db), (p), (nn)))
 535
 536 /* --- @{,d}buf_getbuf{8,{16,24,32,64}{,l,b},z} --- *
 537  *
 538  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 539  *              @buf *bb@ = where to put the result
 540  *
 541  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 542  *
 543  * Use:         Gets a block of data from a buffer, and writes its bounds to
 544  *              another buffer.
 545  */
 546
 547 #define BUF_DECL_GETBUF_(n, W, w)                                       \
 548   extern int buf_getbuf##w(buf */*b*/, buf */*bb*/);                    \
 549   extern int dbuf_getbuf##w(dbuf */*db*/, buf */*bb*/);
 550 BUF_DOSUFFIXES(BUF_DECL_GETBUF_)
 551 #define dbuf_getbuf8(db, bb) (buf_getbuf8(DBUF_BUF(db), (bb)))
 552 #define dbuf_getbuf16(db, bb) (buf_getbuf16(DBUF_BUF(db), (bb)))
 553 #define dbuf_getbuf16l(db, bb) (buf_getbuf16l(DBUF_BUF(db), (bb)))
 554 #define dbuf_getbuf16b(db, bb) (buf_getbuf16b(DBUF_BUF(db), (bb)))
 555 #define dbuf_getbuf24(db, bb) (buf_getbuf24(DBUF_BUF(db), (bb)))
 556 #define dbuf_getbuf24l(db, bb) (buf_getbuf24l(DBUF_BUF(db), (bb)))
 557 #define dbuf_getbuf24b(db, bb) (buf_getbuf24b(DBUF_BUF(db), (bb)))
 558 #define dbuf_getbuf32(db, bb) (buf_getbuf32(DBUF_BUF(db), (bb)))
 559 #define dbuf_getbuf32l(db, bb) (buf_getbuf32l(DBUF_BUF(db), (bb)))
 560 #define dbuf_getbuf32b(db, bb) (buf_getbuf32b(DBUF_BUF(db), (bb)))
 561 #define dbuf_getbuf64(db, bb) (buf_getbuf64(DBUF_BUF(db), (bb)))
 562 #define dbuf_getbuf64l(db, bb) (buf_getbuf64l(DBUF_BUF(db), (bb)))
 563 #define dbuf_getbuf64b(db, bb) (buf_getbuf64b(DBUF_BUF(db), (bb)))
 564 #define dbuf_getbufz(db, bb) (buf_getbufz(DBUF_BUF(db), (bb)))
 565
 566 /* --- @{,d}buf_putbuf{8,{16,24,32,64}{,l,b},z} --- *
 567  *
 568  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 569  *              @buf *bb@ = buffer to write
 570  *
 571  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 572  *
 573  * Use:         Puts the contents of a buffer to a buffer.
 574  */
 575
 576 #define BUF_DECL_PUTBUF_(n, W, w)                                       \
 577   extern int buf_putbuf##w(buf */*b*/, buf */*bb*/);                    \
 578   extern int dbuf_putbuf##w(dbuf */*db*/, buf */*bb*/);
 579 BUF_DOSUFFIXES(BUF_DECL_PUTBUF_)
 580 #define dbuf_putbuf8(db, bb) (buf_putbuf8(DBUF_BUF(db), (bb)))
 581 #define dbuf_putbuf16(db, bb) (buf_putbuf16(DBUF_BUF(db), (bb)))
 582 #define dbuf_putbuf16l(db, bb) (buf_putbuf16l(DBUF_BUF(db), (bb)))
 583 #define dbuf_putbuf16b(db, bb) (buf_putbuf16b(DBUF_BUF(db), (bb)))
 584 #define dbuf_putbuf24(db, bb) (buf_putbuf24(DBUF_BUF(db), (bb)))
 585 #define dbuf_putbuf24l(db, bb) (buf_putbuf24l(DBUF_BUF(db), (bb)))
 586 #define dbuf_putbuf24b(db, bb) (buf_putbuf24b(DBUF_BUF(db), (bb)))
 587 #define dbuf_putbuf32(db, bb) (buf_putbuf32(DBUF_BUF(db), (bb)))
 588 #define dbuf_putbuf32l(db, bb) (buf_putbuf32l(DBUF_BUF(db), (bb)))
 589 #define dbuf_putbuf32b(db, bb) (buf_putbuf32b(DBUF_BUF(db), (bb)))
 590 #define dbuf_putbuf64(db, bb) (buf_putbuf64(DBUF_BUF(db), (bb)))
 591 #define dbuf_putbuf64l(db, bb) (buf_putbuf64l(DBUF_BUF(db), (bb)))
 592 #define dbuf_putbuf64b(db, bb) (buf_putbuf64b(DBUF_BUF(db), (bb)))
 593 #define dbuf_putbufz(db, bb) (buf_putbufz(DBUF_BUF(db), (bb)))
 594
 595 /* --- @{,d}buf_getdstr{8,{16,24,32,64}{,l,b},z} --- *
 596  *
 597  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 598  *              @dstr *d@ = where to put the result
 599  *
 600  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 601  *
 602  * Use:         Gets a block of data from a buffer, and writes its contents
 603  *              to a string.
 604  */
 605
 606 #define BUF_DECL_GETDSTR_(n, W, w)                                      \
 607   extern int buf_getdstr##w(buf */*b*/, dstr */*d*/);                   \
 608   extern int dbuf_getdstr##w(dbuf */*db*/, dstr */*d*/);
 609 BUF_DOSUFFIXES(BUF_DECL_GETDSTR_)
 610 #define dbuf_getdstr8(db, d) (buf_getdstr8(DBUF_BUF(db), (d)))
 611 #define dbuf_getdstr16(db, d) (buf_getdstr16(DBUF_BUF(db), (d)))
 612 #define dbuf_getdstr16l(db, d) (buf_getdstr16l(DBUF_BUF(db), (d)))
 613 #define dbuf_getdstr16b(db, d) (buf_getdstr16b(DBUF_BUF(db), (d)))
 614 #define dbuf_getdstr24(db, d) (buf_getdstr24(DBUF_BUF(db), (d)))
 615 #define dbuf_getdstr24l(db, d) (buf_getdstr24l(DBUF_BUF(db), (d)))
 616 #define dbuf_getdstr24b(db, d) (buf_getdstr24b(DBUF_BUF(db), (d)))
 617 #define dbuf_getdstr32(db, d) (buf_getdstr32(DBUF_BUF(db), (d)))
 618 #define dbuf_getdstr32l(db, d) (buf_getdstr32l(DBUF_BUF(db), (d)))
 619 #define dbuf_getdstr32b(db, d) (buf_getdstr32b(DBUF_BUF(db), (d)))
 620 #define dbuf_getdstr64(db, d) (buf_getdstr64(DBUF_BUF(db), (d)))
 621 #define dbuf_getdstr64l(db, d) (buf_getdstr64l(DBUF_BUF(db), (d)))
 622 #define dbuf_getdstr64b(db, d) (buf_getdstr64b(DBUF_BUF(db), (d)))
 623 #define dbuf_getdstrz(db, d) (buf_getdstrz(DBUF_BUF(db), (d)))
 624
 625 /* --- @{,d}buf_putdstr{8,{16,24,32,64}{,l,b},z} --- *
 626  *
 627  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 628  *              @dstr *d@ = string to write
 629  *
 630  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 631  *
 632  * Use:         Puts a dynamic string to a buffer.
 633  */
 634
 635 #define BUF_DECL_PUTDSTR_(n, W, w)                                      \
 636   extern int buf_putdstr##w(buf */*b*/, dstr */*d*/);                   \
 637   extern int dbuf_putdstr##w(dbuf */*db*/, dstr */*d*/);
 638 BUF_DOSUFFIXES(BUF_DECL_PUTDSTR_)
 639 #define dbuf_putdstr8(db, d) (buf_putdstr8(DBUF_BUF(db), (d)))
 640 #define dbuf_putdstr16(db, d) (buf_putdstr16(DBUF_BUF(db), (d)))
 641 #define dbuf_putdstr16l(db, d) (buf_putdstr16l(DBUF_BUF(db), (d)))
 642 #define dbuf_putdstr16b(db, d) (buf_putdstr16b(DBUF_BUF(db), (d)))
 643 #define dbuf_putdstr24(db, d) (buf_putdstr24(DBUF_BUF(db), (d)))
 644 #define dbuf_putdstr24l(db, d) (buf_putdstr24l(DBUF_BUF(db), (d)))
 645 #define dbuf_putdstr24b(db, d) (buf_putdstr24b(DBUF_BUF(db), (d)))
 646 #define dbuf_putdstr32(db, d) (buf_putdstr32(DBUF_BUF(db), (d)))
 647 #define dbuf_putdstr32l(db, d) (buf_putdstr32l(DBUF_BUF(db), (d)))
 648 #define dbuf_putdstr32b(db, d) (buf_putdstr32b(DBUF_BUF(db), (d)))
 649 #define dbuf_putdstr64(db, d) (buf_putdstr64(DBUF_BUF(db), (d)))
 650 #define dbuf_putdstr64l(db, d) (buf_putdstr64l(DBUF_BUF(db), (d)))
 651 #define dbuf_putdstr64b(db, d) (buf_putdstr64b(DBUF_BUF(db), (d)))
 652 #define dbuf_putdstrz(db, d) (buf_putdstrz(DBUF_BUF(db), (d)))
 653
 654 /* --- @{,d}buf_putstr{8,{16,24,32,64}{,l,b},z} --- *
 655  *
 656  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 657  *              @const char *p@ = string to write
 658  *
 659  * Returns:     Zero if it worked, nonzero if there wasn't enough space.
 660  *
 661  * Use:         Puts a null-terminated string to a buffer.
 662  */
 663
 664 #define BUF_DECL_PUTSTR_(n, W, w)                                       \
 665   extern int buf_putstr##w(buf */*b*/, const char */*p*/);              \
 666   extern int dbuf_putstr##w(dbuf */*db*/, const char */*p*/);
 667 BUF_DOSUFFIXES(BUF_DECL_PUTSTR_)
 668 #define dbuf_putstr8(db, p) (buf_putstr8(DBUF_BUF(db), (p)))
 669 #define dbuf_putstr16(db, p) (buf_putstr16(DBUF_BUF(db), (p)))
 670 #define dbuf_putstr16l(db, p) (buf_putstr16l(DBUF_BUF(db), (p)))
 671 #define dbuf_putstr16b(db, p) (buf_putstr16b(DBUF_BUF(db), (p)))
 672 #define dbuf_putstr24(db, p) (buf_putstr24(DBUF_BUF(db), (p)))
 673 #define dbuf_putstr24l(db, p) (buf_putstr24l(DBUF_BUF(db), (p)))
 674 #define dbuf_putstr24b(db, p) (buf_putstr24b(DBUF_BUF(db), (p)))
 675 #define dbuf_putstr32(db, p) (buf_putstr32(DBUF_BUF(db), (p)))
 676 #define dbuf_putstr32l(db, p) (buf_putstr32l(DBUF_BUF(db), (p)))
 677 #define dbuf_putstr32b(db, p) (buf_putstr32b(DBUF_BUF(db), (p)))
 678 #define dbuf_putstr64(db, p) (buf_putstr64(DBUF_BUF(db), (p)))
 679 #define dbuf_putstr64l(db, p) (buf_putstr64l(DBUF_BUF(db), (p)))
 680 #define dbuf_putstr64b(db, p) (buf_putstr64b(DBUF_BUF(db), (p)))
 681 #define dbuf_putstrz(db, p) (buf_putstrz(DBUF_BUF(db), (p)))
 682
 683 /* --- @{,D}BUF_ENCLOSETAG@ --- *
 684  *
 685  * Arguments:   @tag@ = a control-structure macro tag
 686  *              @buf *b@ or @dbuf *db@ = pointer to a buffer block
 687  *              @size_t mk@ = temporary, used to stash starting offset
 688  *              @check@ = expression which is true if the length @_delta@
 689  *                      is representable
 690  *              @poke@ = function or macro called as @poke(octet *, size_t)@
 691  *                      to store the final size at the given address
 692  *              @size_t lensz@ = space to leave for the length
 693  *
 694  * Use:         This is a statement head.  It ensures that there is enough
 695  *              space in the buffer, saves the current output offset in @mk,
 696  *              and reserves @lensz@ bytes for a length prefix.  It then
 697  *              executes the @body@, which should contribute zero or more
 698  *              further bytes to the buffer.  Finally, it invokes @poke@ to
 699  *              store the length of the material written by @body@ in the
 700  *              space reserved.
 701  */
 702
 703 #define BUF_ENCLOSETAG(tag, b, mk, check, poke, lensz)                  \
 704   MC_BEFORE(tag##__save, {                                              \
 705     (mk) = BLEN(b);                                                     \
 706     if (!BENSURE(b, lensz)) BSTEP(b, (lensz));                          \
 707   })                                                                    \
 708   MC_AFTER(tag##__poke, {                                               \
 709     size_t _delta = BLEN(b) - (mk) - (lensz);                           \
 710     if (!(check)) (b)->f |= BF_BROKEN;                                  \
 711     else if (BOK(b)) poke(BBASE(b) + (mk), _delta);                     \
 712   })
 713
 714 #define DBUF_ENCLOSETAG(tag, b, mk, check, poke, lensz)                 \
 715   BUF_ENCLOSETAG(tag, DBUF_BUF(b), (mk), (check), poke, (lensz))
 716
 717 /* --- @{,D}BUF_ENCLOSE{I,K,Z}TAG@ --- *
 718  *
 719  * Arguments:   @tag@ = a control-structure macro tag
 720  *              @buf *b@ or @dbuf *db@ = pointer to a buffer block
 721  *              @size_t mk@ = temporary, used to stash starting offset
 722  *              @W@ = word-size and -order suffix
 723  *
 724  * Use:         Specialized versions of @BUF_ENCLOSETAG@ above.
 725  *
 726  *              @BUF_ENCLOSEZTAG@ just writes a terminating zero byte.
 727  *              @BUF_ENCLOSEITAG@ writes a word with the given size and
 728  *              byte ordering.  @BUF_ENCLOSEKTAG@ does the same using the
 729  *              @kludge64@ machinery.
 730  */
 731
 732 #define MLIB__BUF_STORESZK64(p, sz)                                             \
 733   do { kludge64 _k; ASSIGN64(_k, (sz)); STORE64_((p), _k); } while (0)
 734 #define MLIB__BUF_STORESZK64_B(p, sz)                                           \
 735   do { kludge64 _k; ASSIGN64(_k, (sz)); STORE64_B_((p), _k); } while (0)
 736 #define MLIB__BUF_STORESZK64_L(p, sz)                                           \
 737   do { kludge64 _k; ASSIGN64(_k, (sz)); STORE64_L_((p), _k); } while (0)
 738
 739 #define BUF_ENCLOSEITAG(tag, b, mk, W)                                  \
 740   BUF_ENCLOSETAG(tag, (b), (mk), (_delta <= MASK##W), STORE##W, SZ_##W)
 741 #define BUF_ENCLOSEKTAG(tag, b, mk, W)                                  \
 742   BUF_ENCLOSETAG(tag, (b), (mk), 1, MLIB__BUF_STORESZK##W, 8)
 743 #define BUF_ENCLOSEZTAG(tag, b)                                         \
 744   MC_AFTER(tag##__zero, { buf_putbyte((b), 0); })
 745
 746 #define DBUF_ENCLOSEITAG(tag, b, mk, W)                                 \
 747   BUF_ENCLOSEITAG(tag, DBUF_BUF(b), (mk), W)
 748 #define DBUF_ENCLOSEKTAG(tag, b, mk, W)                                 \
 749   BUF_ENCLOSEKTAG(tag, DBUF_BUF(b), (mk), W)
 750 #define DBUF_ENCLOSEZTAG(tag, b)                                        \
 751   BUF_ENCLOSEZTAG(tag, DBUF_BUF(b))
 752
 753 /* --- @{,D}BUF_ENCLOSE{8,{16,24,32,64}{,_L,_B},Z}@ --- *
 754  *
 755  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 756  *              @size_t mk@ = temporary, used to stash starting offset
 757  *              @W@ = word-size and -order suffix
 758  *
 759  * Use:         User versions of @BUF_ENCLOSETAG@; see that macro for
 760  *              details.
 761  *
 762  *              These are statement heads.  They reserve space for a length
 763  *              prefix and execute the statement.  When the statement
 764  *              completes, they patch the length of material written by the
 765  *              statement into the reserved space.
 766  */
 767
 768 #define BUF_ENCLOSE8(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 8)
 769 #define BUF_ENCLOSE16(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 16)
 770 #define BUF_ENCLOSE16_L(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 16_L)
 771 #define BUF_ENCLOSE16_B(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 16_B)
 772 #define BUF_ENCLOSE24(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 24)
 773 #define BUF_ENCLOSE24_L(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 24_L)
 774 #define BUF_ENCLOSE24_B(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 24_B)
 775 #define BUF_ENCLOSE32(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 32)
 776 #define BUF_ENCLOSE32_L(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 32_L)
 777 #define BUF_ENCLOSE32_B(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 32_B)
 778 #ifdef HAVE_UINT64
 779 #  define BUF_ENCLOSE64(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 64)
 780 #  define BUF_ENCLOSE64_L(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 64_L)
 781 #  define BUF_ENCLOSE64_B(b, mk) BUF_ENCLOSEITAG(encl, (b), (mk), 64_B)
 782 #else
 783 #  define BUF_ENCLOSE64(b, mk) BUF_ENCLOSEKTAG(encl, (b), (mk), 64)
 784 #  define BUF_ENCLOSE64_L(b, mk) BUF_ENCLOSEKTAG(encl, (b), (mk), 64_L)
 785 #  define BUF_ENCLOSE64_B(b, mk) BUF_ENCLOSEKTAG(encl, (b), (mk), 64_B)
 786 #endif
 787 #define BUF_ENCLOSEZ(b) BUF_ENCLOSEZTAG(encl, (b))
 788
 789 #define DBUF_ENCLOSE8(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 8)
 790 #define DBUF_ENCLOSE16(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 16)
 791 #define DBUF_ENCLOSE16_L(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 16_L)
 792 #define DBUF_ENCLOSE16_B(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 16_B)
 793 #define DBUF_ENCLOSE24(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 24)
 794 #define DBUF_ENCLOSE24_L(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 24_L)
 795 #define DBUF_ENCLOSE24_B(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 24_B)
 796 #define DBUF_ENCLOSE32(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 32)
 797 #define DBUF_ENCLOSE32_L(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 32_L)
 798 #define DBUF_ENCLOSE32_B(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 32_B)
 799 #ifdef HAVE_UINT64
 800 #  define DBUF_ENCLOSE64(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 64)
 801 #  define DBUF_ENCLOSE64_L(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 64_L)
 802 #  define DBUF_ENCLOSE64_B(db, mk) DBUF_ENCLOSEITAG(encl, (db), (mk), 64_B)
 803 #else
 804 #  define DBUF_ENCLOSE64(db, mk) DBUF_ENCLOSEKTAG(encl, (db), (mk), 64)
 805 #  define DBUF_ENCLOSE64_L(db, mk) DBUF_ENCLOSEKTAG(encl, (db), (mk), 64_L)
 806 #  define DBUF_ENCLOSE64_B(db, mk) DBUF_ENCLOSEKTAG(encl, (db), (mk), 64_B)
 807 #endif
 808 #define DBUF_ENCLOSEZ(db) DBUF_ENCLOSEZTAG(encl, (db))
 809
 810 /* --- @{,d}buf_putstrf@, @{,d}buf_vputstrf@ --- *
 811  *
 812  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 813  *              @const char *p@ = pointer to @printf@-style format string
 814  *              @va_list *ap@ = argument handle
 815  *
 816  * Returns:     The number of characters written to the string, or @-1@ on
 817  *              failure.
 818  *
 819  * Use:         Format a string to a buffer.  The resulting output is not
 820  *              null-terminated.
 821  */
 822
 823 extern PRINTF_LIKE(2, 3)
 824   int buf_putstrf(buf */*b*/, const char */*p*/, ...);
 825 extern PRINTF_LIKE(2, 3)
 826   int dbuf_putstrf(dbuf */*db*/, const char */*p*/, ...);
 827 #if __STDC__ >= 199901
 828 #  define dbuf_putstrf(db, /*p*/...) (buf_putstr(DBUF_BUF(db), __VA_ARGS__))
 829 #endif
 830 extern int buf_vputstrf(buf */*b*/, const char */*p*/, va_list */*ap*/);
 831 extern int dbuf_vputstrf(dbuf */*db*/, const char */*p*/, va_list */*ap*/);
 832 #define dbuf_vputstrf(db, p, ap) (buf_vputstrf(DBUF_BUF(db), (p), (ap)))
 833
 834 /* --- @{,d}buf_{,v}putstrf{8,{16,24,32,64}{,b,l},z}@ --- *
 835  *
 836  * Arguments:   @buf *b@ or @dbuf *db@ = pointer to a buffer block
 837  *              @const char *p@ = pointer to @printf@-style format string
 838  *              @va_list *ap@ = argument handle
 839  *
 840  * Returns:     The number of characters written to the string, or @-1@ on
 841  *              failure.
 842  *
 843  * Use:         As for @buf_putstr@, but using a format string.
 844  */
 845
 846 #define BUF_DECL_PUTSTRF_(n, W, w)                                      \
 847   extern PRINTF_LIKE(2, 3)                                              \
 848     int buf_putstrf##w(buf */*b*/, const char */*p*/, ...);             \
 849   extern PRINTF_LIKE(2, 3)                                              \
 850     int dbuf_putstrf##w(dbuf */*db*/, const char */*p*/, ...);          \
 851   extern int buf_vputstrf##w(buf */*b*/,                                \
 852                              const char */*p*/, va_list */*ap*/);       \
 853   extern int dbuf_vputstrf##w(dbuf */*db*/,                             \
 854                               const char */*p*/, va_list */*ap*/);
 855 BUF_DOSUFFIXES(BUF_DECL_PUTSTRF_)
 856 #if __STDC__ >= 199901
 857 #  define dbuf_putstrf8(db, /*p*/...)                                   \
 858      (buf_putstrf8(DBUF_BUF(db), __VA_ARGS__))
 859 #  define dbuf_putstrf16(db, /*p*/...)                                  \
 860      (buf_putstrf16(DBUF_BUF(db), __VA_ARGS__))
 861 #  define dbuf_putstrf16l(db, /*p*/...)                                 \
 862      (buf_putstrf16l(DBUF_BUF(db), __VA_ARGS__))
 863 #  define dbuf_putstrf16b(db, /*p*/...)                                 \
 864      (buf_putstrf16b(DBUF_BUF(db), __VA_ARGS__))
 865 #  define dbuf_putstrf24(db, /*p*/...)                                  \
 866      (buf_putstrf24(DBUF_BUF(db), __VA_ARGS__))
 867 #  define dbuf_putstrf24l(db, /*p*/...)                                 \
 868      (buf_putstrf24l(DBUF_BUF(db), __VA_ARGS__))
 869 #  define dbuf_putstrf24b(db, /*p*/...)                                 \
 870      (buf_putstrf24b(DBUF_BUF(db), __VA_ARGS__))
 871 #  define dbuf_putstrf32(db, /*p*/...)                                  \
 872      (buf_putstrf32(DBUF_BUF(db), __VA_ARGS__))
 873 #  define dbuf_putstrf32l(db, /*p*/...)                                 \
 874      (buf_putstrf32l(DBUF_BUF(db), __VA_ARGS__))
 875 #  define dbuf_putstrf32b(db, /*p*/...)                                 \
 876      (buf_putstrf32b(DBUF_BUF(db), __VA_ARGS__))
 877 #  define dbuf_putstrf64(db, /*p*/...)                                  \
 878      (buf_putstrf64(DBUF_BUF(db), __VA_ARGS__))
 879 #  define dbuf_putstrf64l(db, /*p*/...)                                 \
 880      (buf_putstrf64l(DBUF_BUF(db), __VA_ARGS__))
 881 #  define dbuf_putstrf64b(db, /*p*/...)                                 \
 882      (buf_putstrf64b(DBUF_BUF(db), __VA_ARGS__))
 883 #  define dbuf_putstrfz(db, /*p*/...)                                   \
 884      (buf_putstrfz(DBUF_BUF(db), __VA_ARGS__))
 885 #endif
 886 #define dbuf_vputstrf8(db, p, ap) (buf_vputstrf8(DBUF_BUF(db), (p), (ap)))
 887 #define dbuf_vputstrf16(db, p, ap) (buf_vputstrf16(DBUF_BUF(db), (p), (ap)))
 888 #define dbuf_vputstrf16l(db, p, ap) (buf_vputstrf16l(DBUF_BUF(db), (p), (ap)))
 889 #define dbuf_vputstrf16b(db, p, ap) (buf_vputstrf16b(DBUF_BUF(db), (p), (ap)))
 890 #define dbuf_vputstrf24(db, p, ap) (buf_vputstrf24(DBUF_BUF(db), (p), (ap)))
 891 #define dbuf_vputstrf24l(db, p, ap) (buf_vputstrf24l(DBUF_BUF(db), (p), (ap)))
 892 #define dbuf_vputstrf24b(db, p, ap) (buf_vputstrf24b(DBUF_BUF(db), (p), (ap)))
 893 #define dbuf_vputstrf32(db, p, ap) (buf_vputstrf32(DBUF_BUF(db), (p), (ap)))
 894 #define dbuf_vputstrf32l(db, p, ap) (buf_vputstrf32l(DBUF_BUF(db), (p), (ap)))
 895 #define dbuf_vputstrf32b(db, p, ap) (buf_vputstrf32b(DBUF_BUF(db), (p), (ap)))
 896 #define dbuf_vputstrf64(db, p, ap) (buf_vputstrf64(DBUF_BUF(db), (p), (ap)))
 897 #define dbuf_vputstrf64l(db, p, ap) (buf_vputstrf64l(DBUF_BUF(db), (p), (ap)))
 898 #define dbuf_vputstrf64b(db, p, ap) (buf_vputstrf64b(DBUF_BUF(db), (p), (ap)))
 899 #define dbuf_vputstrfz(db, p, ap) (buf_vputstrfz(DBUF_BUF(db), (p), (ap)))
 900
 901 /*----- That's all, folks -------------------------------------------------*/
 902
 903 #ifdef __cplusplus
 904   }
 905 #endif
 906
 907 #endif