common/msg.c

   1 /*-
   2  * Copyright (c) 1991, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1991, 1993, 1994, 1995, 1996
   5  *      Keith Bostic.  All rights reserved.
   6  *
   7  * See the LICENSE file for redistribution information.
   8  */
   9
  10 #include "config.h"
  11
  12 #ifndef lint
  13 static const char sccsid[] = "$Id: msg.c,v 10.52 2000/06/25 17:34:38 skimo Exp $ (Berkeley) $Date: 2000/06/25 17:34:38 $";
  14 #endif /* not lint */
  15
  16 #include <sys/param.h>
  17 #include <sys/types.h>          /* XXX: param.h may not have included types.h */
  18 #include <sys/queue.h>
  19 #include <sys/stat.h>
  20 #include <sys/time.h>
  21
  22 #include <bitstring.h>
  23 #include <ctype.h>
  24 #include <errno.h>
  25 #include <fcntl.h>
  26 #include <limits.h>
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <unistd.h>
  31
  32 #ifdef __STDC__
  33 #include <stdarg.h>
  34 #else
  35 #include <varargs.h>
  36 #endif
  37
  38 #include "common.h"
  39 #include "../vi/vi.h"
  40
  41 /*
  42  * msgq --
  43  *      Display a message.
  44  *
  45  * PUBLIC: void msgq __P((SCR *, mtype_t, const char *, ...));
  46  */
  47 void
  48 #ifdef __STDC__
  49 msgq(SCR *sp, mtype_t mt, const char *fmt, ...)
  50 #else
  51 msgq(sp, mt, fmt, va_alist)
  52         SCR *sp;
  53         mtype_t mt;
  54         const char *fmt;
  55         va_dcl
  56 #endif
  57 {
  58 #ifndef NL_ARGMAX
  59 #define __NL_ARGMAX     20              /* Set to 9 by System V. */
  60         struct {
  61                 const char *str;        /* String pointer. */
  62                 size_t   arg;           /* Argument number. */
  63                 size_t   prefix;        /* Prefix string length. */
  64                 size_t   skip;          /* Skipped string length. */
  65                 size_t   suffix;        /* Suffix string length. */
  66         } str[__NL_ARGMAX];
  67 #endif
  68         static int reenter;             /* STATIC: Re-entrancy check. */
  69         CHAR_T ch;
  70         GS *gp;
  71         WIN *wp;
  72         size_t blen, cnt1, cnt2, len, mlen, nlen, soff;
  73         const char *p, *t, *u;
  74         char *bp, *mp, *rbp, *s_rbp;
  75         va_list ap;
  76
  77         /*
  78          * !!!
  79          * It's possible to enter msg when there's no screen to hold the
  80          * message.  If sp is NULL, ignore the special cases and put the
  81          * message out to stderr.
  82          */
  83         if (sp == NULL) {
  84                 gp = NULL;
  85                 if (mt == M_BERR)
  86                         mt = M_ERR;
  87                 else if (mt == M_VINFO)
  88                         mt = M_INFO;
  89         } else {
  90                 gp = sp->gp;
  91                 wp = sp->wp;
  92                 switch (mt) {
  93                 case M_BERR:
  94                         if (F_ISSET(sp, SC_VI) && !O_ISSET(sp, O_VERBOSE)) {
  95                                 F_SET(gp, G_BELLSCHED);
  96                                 return;
  97                         }
  98                         mt = M_ERR;
  99                         break;
 100                 case M_VINFO:
 101                         if (!O_ISSET(sp, O_VERBOSE))
 102                                 return;
 103                         mt = M_INFO;
 104                         /* FALLTHROUGH */
 105                 case M_INFO:
 106                         if (F_ISSET(sp, SC_EX_SILENT))
 107                                 return;
 108                         break;
 109                 case M_ERR:
 110                 case M_SYSERR:
 111                 case M_DBERR:
 112                         break;
 113                 default:
 114                         abort();
 115                 }
 116         }
 117
 118         /*
 119          * It's possible to reenter msg when it allocates space.  We're
 120          * probably dead anyway, but there's no reason to drop core.
 121          *
 122          * XXX
 123          * Yes, there's a race, but it should only be two instructions.
 124          */
 125         if (reenter++)
 126                 return;
 127
 128         /* Get space for the message. */
 129         nlen = 1024;
 130         if (0) {
 131 retry:          FREE_SPACE(sp, bp, blen);
 132                 nlen *= 2;
 133         }
 134         bp = NULL;
 135         blen = 0;
 136         GET_SPACE_GOTO(sp, bp, blen, nlen);
 137
 138         /*
 139          * Error prefix.
 140          *
 141          * mp:   pointer to the current next character to be written
 142          * mlen: length of the already written characters
 143          * blen: total length of the buffer
 144          */
 145 #define REM     (blen - mlen)
 146         mp = bp;
 147         mlen = 0;
 148         if (mt == M_SYSERR || mt == M_DBERR) {
 149                 p = msg_cat(sp, "020|Error: ", &len);
 150                 if (REM < len)
 151                         goto retry;
 152                 memcpy(mp, p, len);
 153                 mp += len;
 154                 mlen += len;
 155         }
 156
 157         /*
 158          * If we're running an ex command that the user didn't enter, display
 159          * the file name and line number prefix.
 160          */
 161         if ((mt == M_ERR || mt == M_SYSERR) &&
 162             sp != NULL && wp != NULL && wp->if_name != NULL) {
 163                 for (p = wp->if_name; *p != '\0'; ++p) {
 164                         len = snprintf(mp, REM, "%s", KEY_NAME(sp, *p));
 165                         mp += len;
 166                         if ((mlen += len) > blen)
 167                                 goto retry;
 168                 }
 169                 len = snprintf(mp, REM, ", %d: ", wp->if_lno);
 170                 mp += len;
 171                 if ((mlen += len) > blen)
 172                         goto retry;
 173         }
 174
 175         /* If nothing to format, we're done. */
 176         if (fmt == NULL)
 177                 goto nofmt;
 178         fmt = msg_cat(sp, fmt, NULL);
 179
 180 #ifndef NL_ARGMAX
 181         /*
 182          * Nvi should run on machines that don't support the numbered argument
 183          * specifications (%[digit]*$).  We do this by reformatting the string
 184          * so that we can hand it to vsprintf(3) and it will use the arguments
 185          * in the right order.  When vsprintf returns, we put the string back
 186          * into the right order.  It's undefined, according to SVID III, to mix
 187          * numbered argument specifications with the standard style arguments,
 188          * so this should be safe.
 189          *
 190          * In addition, we also need a character that is known to not occur in
 191          * any vi message, for separating the parts of the string.  As callers
 192          * of msgq are responsible for making sure that all the non-printable
 193          * characters are formatted for printing before calling msgq, we use a
 194          * random non-printable character selected at terminal initialization
 195          * time.  This code isn't fast by any means, but as messages should be
 196          * relatively short and normally have only a few arguments, it won't be
 197          * too bad.  Regardless, nobody has come up with any other solution.
 198          *
 199          * The result of this loop is an array of pointers into the message
 200          * string, with associated lengths and argument numbers.  The array
 201          * is in the "correct" order, and the arg field contains the argument
 202          * order.
 203          */
 204         for (p = fmt, soff = 0; soff < __NL_ARGMAX;) {
 205                 for (t = p; *p != '\0' && *p != '%'; ++p);
 206                 if (*p == '\0')
 207                         break;
 208                 ++p;
 209                 if (!isdigit(*p)) {
 210                         if (*p == '%')
 211                                 ++p;
 212                         continue;
 213                 }
 214                 for (u = p; *++p != '\0' && isdigit(*p););
 215                 if (*p != '$')
 216                         continue;
 217
 218                 /* Up to, and including the % character. */
 219                 str[soff].str = t;
 220                 str[soff].prefix = u - t;
 221
 222                 /* Up to, and including the $ character. */
 223                 str[soff].arg = atoi(u);
 224                 str[soff].skip = (p - u) + 1;
 225                 if (str[soff].arg >= __NL_ARGMAX)
 226                         goto ret;
 227
 228                 /* Up to, and including the conversion character. */
 229                 for (u = p; (ch = *++p) != '\0';)
 230                         if (isalpha(ch) &&
 231                             strchr("diouxXfeEgGcspn", ch) != NULL)
 232                                 break;
 233                 str[soff].suffix = p - u;
 234                 if (ch != '\0')
 235                         ++p;
 236                 ++soff;
 237         }
 238
 239         /* If no magic strings, we're done. */
 240         if (soff == 0)
 241                 goto format;
 242
 243          /* Get space for the reordered strings. */
 244         if ((rbp = malloc(nlen)) == NULL)
 245                 goto ret;
 246         s_rbp = rbp;
 247
 248         /*
 249          * Reorder the strings into the message string based on argument
 250          * order.
 251          *
 252          * !!!
 253          * We ignore arguments that are out of order, i.e. if we don't find
 254          * an argument, we continue.  Assume (almost certainly incorrectly)
 255          * that whoever created the string knew what they were doing.
 256          *
 257          * !!!
 258          * Brute force "sort", but since we don't expect more than one or two
 259          * arguments in a string, the setup cost of a fast sort will be more
 260          * expensive than the loop.
 261          */
 262         for (cnt1 = 1; cnt1 <= soff; ++cnt1)
 263                 for (cnt2 = 0; cnt2 < soff; ++cnt2)
 264                         if (cnt1 == str[cnt2].arg) {
 265                                 memmove(s_rbp, str[cnt2].str, str[cnt2].prefix);
 266                                 memmove(s_rbp + str[cnt2].prefix,
 267                                     str[cnt2].str + str[cnt2].prefix +
 268                                     str[cnt2].skip, str[cnt2].suffix);
 269                                 s_rbp += str[cnt2].prefix + str[cnt2].suffix;
 270                                 *s_rbp++ =
 271                                     gp == NULL ? DEFAULT_NOPRINT : gp->noprint;
 272                                 break;
 273                         }
 274         *s_rbp = '\0';
 275         fmt = rbp;
 276 #endif
 277
 278 format: /* Format the arguments into the string. */
 279 #ifdef __STDC__
 280         va_start(ap, fmt);
 281 #else
 282         va_start(ap);
 283 #endif
 284         len = vsnprintf(mp, REM, fmt, ap);
 285         va_end(ap);
 286         if (len >= nlen)
 287                 goto retry;
 288
 289 #ifndef NL_ARGMAX
 290         if (soff == 0)
 291                 goto nofmt;
 292
 293         /*
 294          * Go through the resulting string, and, for each separator character
 295          * separated string, enter its new starting position and length in the
 296          * array.
 297          */
 298         for (p = t = mp, cnt1 = 1,
 299             ch = gp == NULL ? DEFAULT_NOPRINT : gp->noprint; *p != '\0'; ++p)
 300                 if (*p == ch) {
 301                         for (cnt2 = 0; cnt2 < soff; ++cnt2)
 302                                 if (str[cnt2].arg == cnt1)
 303                                         break;
 304                         str[cnt2].str = t;
 305                         str[cnt2].prefix = p - t;
 306                         t = p + 1;
 307                         ++cnt1;
 308                 }
 309
 310         /*
 311          * Reorder the strings once again, putting them back into the
 312          * message buffer.
 313          *
 314          * !!!
 315          * Note, the length of the message gets decremented once for
 316          * each substring, when we discard the separator character.
 317          */
 318         for (s_rbp = rbp, cnt1 = 0; cnt1 < soff; ++cnt1) {
 319                 memmove(rbp, str[cnt1].str, str[cnt1].prefix);
 320                 rbp += str[cnt1].prefix;
 321                 --len;
 322         }
 323         memmove(mp, s_rbp, rbp - s_rbp);
 324
 325         /* Free the reordered string memory. */
 326         free(s_rbp);
 327 #endif
 328
 329 nofmt:  mp += len;
 330         if ((mlen += len) > blen)
 331                 goto retry;
 332         if (mt == M_SYSERR) {
 333                 len = snprintf(mp, REM, ": %s", strerror(errno));
 334                 mp += len;
 335                 if ((mlen += len) > blen)
 336                         goto retry;
 337                 mt = M_ERR;
 338         }
 339         if (mt == M_DBERR) {
 340                 len = snprintf(mp, REM, ": %s", db_strerror(sp->db_error));
 341                 mp += len;
 342                 if ((mlen += len) > blen)
 343                         goto retry;
 344                 mt = M_ERR;
 345         }
 346
 347         /* Add trailing newline. */
 348         if ((mlen += 1) > blen)
 349                 goto retry;
 350         *mp = '\n';
 351
 352         if (sp != NULL)
 353                 (void)ex_fflush(sp);
 354         if (gp != NULL)
 355                 gp->scr_msg(sp, mt, bp, mlen);
 356         else
 357                 (void)fprintf(stderr, "%.*s", (int)mlen, bp);
 358
 359         /* Cleanup. */
 360 ret:    FREE_SPACE(sp, bp, blen);
 361 alloc_err:
 362         reenter = 0;
 363 }
 364
 365 /*
 366  * msgq_str --
 367  *      Display a message with an embedded string.
 368  *
 369  * PUBLIC: void msgq_str __P((SCR *, mtype_t, char *, char *));
 370  */
 371 void
 372 msgq_str(sp, mtype, str, fmt)
 373         SCR *sp;
 374         mtype_t mtype;
 375         char *str, *fmt;
 376 {
 377         int nf, sv_errno;
 378         char *p;
 379
 380         if (str == NULL) {
 381                 msgq(sp, mtype, fmt);
 382                 return;
 383         }
 384
 385         sv_errno = errno;
 386         p = msg_print(sp, str, &nf);
 387         errno = sv_errno;
 388         msgq(sp, mtype, fmt, p);
 389         if (nf)
 390                 FREE_SPACE(sp, p, 0);
 391 }
 392
 393 /*
 394  * mod_rpt --
 395  *      Report on the lines that changed.
 396  *
 397  * !!!
 398  * Historic vi documentation (USD:15-8) claimed that "The editor will also
 399  * always tell you when a change you make affects text which you cannot see."
 400  * This wasn't true -- edit a large file and do "100d|1".  We don't implement
 401  * this semantic since it requires tracking each line that changes during a
 402  * command instead of just keeping count.
 403  *
 404  * Line counts weren't right in historic vi, either.  For example, given the
 405  * file:
 406  *      abc
 407  *      def
 408  * the command 2d}, from the 'b' would report that two lines were deleted,
 409  * not one.
 410  *
 411  * PUBLIC: void mod_rpt __P((SCR *));
 412  */
 413 void
 414 mod_rpt(sp)
 415         SCR *sp;
 416 {
 417         static char * const action[] = {
 418                 "293|added",
 419                 "294|changed",
 420                 "295|deleted",
 421                 "296|joined",
 422                 "297|moved",
 423                 "298|shifted",
 424                 "299|yanked",
 425         };
 426         static char * const lines[] = {
 427                 "300|line",
 428                 "301|lines",
 429         };
 430         db_recno_t total;
 431         u_long rptval;
 432         int first, cnt;
 433         size_t blen, len, tlen;
 434         const char *t;
 435         char * const *ap;
 436         char *bp, *p;
 437
 438         /* Change reports are turned off in batch mode. */
 439         if (F_ISSET(sp, SC_EX_SILENT))
 440                 return;
 441
 442         /* Reset changing line number. */
 443         sp->rptlchange = OOBLNO;
 444
 445         /*
 446          * Don't build a message if not enough changed.
 447          *
 448          * !!!
 449          * And now, a vi clone test.  Historically, vi reported if the number
 450          * of changed lines was > than the value, not >=, unless it was a yank
 451          * command, which used >=.  No lie.  Furthermore, an action was never
 452          * reported for a single line action.  This is consistent for actions
 453          * other than yank, but yank didn't report single line actions even if
 454          * the report edit option was set to 1.  In addition, setting report to
 455          * 0 in the 4BSD historic vi was equivalent to setting it to 1, for an
 456          * unknown reason (this bug was fixed in System III/V at some point).
 457          * I got complaints, so nvi conforms to System III/V historic practice
 458          * except that we report a yank of 1 line if report is set to 1.
 459          */
 460 #define ARSIZE(a)       sizeof(a) / sizeof (*a)
 461 #define MAXNUM          25
 462         rptval = O_VAL(sp, O_REPORT);
 463         for (cnt = 0, total = 0; cnt < ARSIZE(action); ++cnt)
 464                 total += sp->rptlines[cnt];
 465         if (total == 0)
 466                 return;
 467         if (total <= rptval && sp->rptlines[L_YANKED] < rptval) {
 468                 for (cnt = 0; cnt < ARSIZE(action); ++cnt)
 469                         sp->rptlines[cnt] = 0;
 470                 return;
 471         }
 472
 473         /* Build and display the message. */
 474         GET_SPACE_GOTO(sp, bp, blen, sizeof(action) * MAXNUM + 1);
 475         for (p = bp, first = 1, tlen = 0,
 476             ap = action, cnt = 0; cnt < ARSIZE(action); ++ap, ++cnt)
 477                 if (sp->rptlines[cnt] != 0) {
 478                         if (first)
 479                                 first = 0;
 480                         else {
 481                                 *p++ = ';';
 482                                 *p++ = ' ';
 483                                 tlen += 2;
 484                         }
 485                         len = snprintf(p, MAXNUM, "%lu ", sp->rptlines[cnt]);
 486                         p += len;
 487                         tlen += len;
 488                         t = msg_cat(sp,
 489                             lines[sp->rptlines[cnt] == 1 ? 0 : 1], &len);
 490                         memcpy(p, t, len);
 491                         p += len;
 492                         tlen += len;
 493                         *p++ = ' ';
 494                         ++tlen;
 495                         t = msg_cat(sp, *ap, &len);
 496                         memcpy(p, t, len);
 497                         p += len;
 498                         tlen += len;
 499                         sp->rptlines[cnt] = 0;
 500                 }
 501
 502         /* Add trailing newline. */
 503         *p = '\n';
 504         ++tlen;
 505
 506         (void)ex_fflush(sp);
 507         sp->gp->scr_msg(sp, M_INFO, bp, tlen);
 508
 509         FREE_SPACE(sp, bp, blen);
 510 alloc_err:
 511         return;
 512
 513 #undef ARSIZE
 514 #undef MAXNUM
 515 }
 516
 517 /*
 518  * msgq_status --
 519  *      Report on the file's status.
 520  *
 521  * PUBLIC: void msgq_status __P((SCR *, db_recno_t, u_int));
 522  */
 523 void
 524 msgq_status(sp, lno, flags)
 525         SCR *sp;
 526         db_recno_t lno;
 527         u_int flags;
 528 {
 529         db_recno_t last;
 530         size_t blen, len;
 531         int cnt, needsep;
 532         const char *t;
 533         char **ap, *bp, *np, *p, *s;
 534
 535         /* Get sufficient memory. */
 536         len = strlen(sp->frp->name);
 537         GET_SPACE_GOTO(sp, bp, blen, len * MAX_CHARACTER_COLUMNS + 128);
 538         p = bp;
 539
 540         /* Copy in the filename. */
 541         for (p = bp, t = sp->frp->name; *t != '\0'; ++t) {
 542                 len = KEY_LEN(sp, *t);
 543                 memcpy(p, KEY_NAME(sp, *t), len);
 544                 p += len;
 545         }
 546         np = p;
 547         *p++ = ':';
 548         *p++ = ' ';
 549
 550         /* Copy in the argument count. */
 551         if (F_ISSET(sp, SC_STATUS_CNT) && sp->argv != NULL) {
 552                 for (cnt = 0, ap = sp->argv; *ap != NULL; ++ap, ++cnt);
 553                 if (cnt > 1) {
 554                         (void)sprintf(p,
 555                             msg_cat(sp, "317|%d files to edit", NULL), cnt);
 556                         p += strlen(p);
 557                         *p++ = ':';
 558                         *p++ = ' ';
 559                 }
 560                 F_CLR(sp, SC_STATUS_CNT);
 561         }
 562
 563         /*
 564          * See nvi/exf.c:file_init() for a description of how and when the
 565          * read-only bit is set.
 566          *
 567          * !!!
 568          * The historic display for "name changed" was "[Not edited]".
 569          */
 570         needsep = 0;
 571         if (F_ISSET(sp->frp, FR_NEWFILE)) {
 572                 F_CLR(sp->frp, FR_NEWFILE);
 573                 t = msg_cat(sp, "021|new file", &len);
 574                 memcpy(p, t, len);
 575                 p += len;
 576                 needsep = 1;
 577         } else {
 578                 if (F_ISSET(sp->frp, FR_NAMECHANGE)) {
 579                         t = msg_cat(sp, "022|name changed", &len);
 580                         memcpy(p, t, len);
 581                         p += len;
 582                         needsep = 1;
 583                 }
 584                 if (needsep) {
 585                         *p++ = ',';
 586                         *p++ = ' ';
 587                 }
 588                 if (F_ISSET(sp->ep, F_MODIFIED))
 589                         t = msg_cat(sp, "023|modified", &len);
 590                 else
 591                         t = msg_cat(sp, "024|unmodified", &len);
 592                 memcpy(p, t, len);
 593                 p += len;
 594                 needsep = 1;
 595         }
 596         if (F_ISSET(sp->frp, FR_UNLOCKED)) {
 597                 if (needsep) {
 598                         *p++ = ',';
 599                         *p++ = ' ';
 600                 }
 601                 t = msg_cat(sp, "025|UNLOCKED", &len);
 602                 memcpy(p, t, len);
 603                 p += len;
 604                 needsep = 1;
 605         }
 606         if (O_ISSET(sp, O_READONLY)) {
 607                 if (needsep) {
 608                         *p++ = ',';
 609                         *p++ = ' ';
 610                 }
 611                 t = msg_cat(sp, "026|readonly", &len);
 612                 memcpy(p, t, len);
 613                 p += len;
 614                 needsep = 1;
 615         }
 616         if (needsep) {
 617                 *p++ = ':';
 618                 *p++ = ' ';
 619         }
 620         if (LF_ISSET(MSTAT_SHOWLAST)) {
 621                 if (db_last(sp, &last))
 622                         return;
 623                 if (last == 0) {
 624                         t = msg_cat(sp, "028|empty file", &len);
 625                         memcpy(p, t, len);
 626                         p += len;
 627                 } else {
 628                         t = msg_cat(sp, "027|line %lu of %lu [%ld%%]", &len);
 629                         (void)sprintf(p, t, lno, last, (lno * 100) / last);
 630                         p += strlen(p);
 631                 }
 632         } else {
 633                 t = msg_cat(sp, "029|line %lu", &len);
 634                 (void)sprintf(p, t, lno);
 635                 p += strlen(p);
 636         }
 637 #ifdef DEBUG
 638         (void)sprintf(p, " (pid %lu)", (u_long)getpid());
 639         p += strlen(p);
 640 #endif
 641         *p++ = '\n';
 642         len = p - bp;
 643
 644         /*
 645          * There's a nasty problem with long path names.  Cscope and tags files
 646          * can result in long paths and vi will request a continuation key from
 647          * the user as soon as it starts the screen.  Unfortunately, the user
 648          * has already typed ahead, and chaos results.  If we assume that the
 649          * characters in the filenames and informational messages only take a
 650          * single screen column each, we can trim the filename.
 651          *
 652          * XXX
 653          * Status lines get put up at fairly awkward times.  For example, when
 654          * you do a filter read (e.g., :read ! echo foo) in the top screen of a
 655          * split screen, we have to repaint the status lines for all the screens
 656          * below the top screen.  We don't want users having to enter continue
 657          * characters for those screens.  Make it really hard to screw this up.
 658          */
 659         s = bp;
 660         if (LF_ISSET(MSTAT_TRUNCATE) && len > sp->cols) {
 661                 for (; s < np && (*s != '/' || (p - s) > sp->cols - 3); ++s);
 662                 if (s == np) {
 663                         s = p - (sp->cols - 5);
 664                         *--s = ' ';
 665                 }
 666                 *--s = '.';
 667                 *--s = '.';
 668                 *--s = '.';
 669                 len = p - s;
 670         }
 671
 672         /* Flush any waiting ex messages. */
 673         (void)ex_fflush(sp);
 674
 675         sp->gp->scr_msg(sp, M_INFO, s, len);
 676
 677         FREE_SPACE(sp, bp, blen);
 678 alloc_err:
 679         return;
 680 }
 681
 682 /*
 683  * msg_open --
 684  *      Open the message catalogs.
 685  *
 686  * PUBLIC: int msg_open __P((SCR *, char *));
 687  */
 688 int
 689 msg_open(sp, file)
 690         SCR *sp;
 691         char *file;
 692 {
 693         /*
 694          * !!!
 695          * Assume that the first file opened is the system default, and that
 696          * all subsequent ones user defined.  Only display error messages
 697          * if we can't open the user defined ones -- it's useful to know if
 698          * the system one wasn't there, but if nvi is being shipped with an
 699          * installed system, the file will be there, if it's not, then the
 700          * message will be repeated every time nvi is started up.
 701          */
 702         static int first = 1;
 703         DB *db;
 704         DBT data, key;
 705         db_recno_t msgno;
 706         char *p, *t, buf[MAXPATHLEN];
 707
 708         if ((p = strrchr(file, '/')) != NULL && p[1] == '\0' &&
 709             (((t = getenv("LC_MESSAGES")) != NULL && t[0] != '\0') ||
 710             ((t = getenv("LANG")) != NULL && t[0] != '\0'))) {
 711                 (void)snprintf(buf, sizeof(buf), "%s%s", file, t);
 712                 p = buf;
 713         } else
 714                 p = file;
 715         if ((sp->db_error = db_create(&db, sp->gp->env, 0)) != 0 ||
 716             (sp->db_error = db->set_re_source(db, p)) != 0 ||
 717             (sp->db_error = db->open(db, NULL, NULL, DB_RECNO, 0, 0)) != 0) {
 718                 if (first) {
 719                         first = 0;
 720                         return (1);
 721                 }
 722                 msgq_str(sp, M_DBERR, p, "%s");
 723                 return (1);
 724         }
 725
 726         /*
 727          * Test record 1 for the magic string.  The msgq call is here so
 728          * the message catalog build finds it.
 729          */
 730 #define VMC     "VI_MESSAGE_CATALOG"
 731         memset(&key, 0, sizeof(key));
 732         key.data = &msgno;
 733         key.size = sizeof(db_recno_t);
 734         memset(&data, 0, sizeof(data));
 735         msgno = 1;
 736         if ((sp->db_error = db->get(db, NULL, &key, &data, 0)) != 0 ||
 737             data.size != sizeof(VMC) - 1 ||
 738             memcmp(data.data, VMC, sizeof(VMC) - 1)) {
 739                 (void)db->close(db, DB_NOSYNC);
 740                 if (first) {
 741                         first = 0;
 742                         return (1);
 743                 }
 744                 msgq_str(sp, M_DBERR, p,
 745                     "030|The file %s is not a message catalog");
 746                 return (1);
 747         }
 748         first = 0;
 749
 750         if (sp->gp->msg != NULL)
 751                 (void)sp->gp->msg->close(sp->gp->msg, DB_NOSYNC);
 752         sp->gp->msg = db;
 753         return (0);
 754 }
 755
 756 /*
 757  * msg_close --
 758  *      Close the message catalogs.
 759  *
 760  * PUBLIC: void msg_close __P((GS *));
 761  */
 762 void
 763 msg_close(gp)
 764         GS *gp;
 765 {
 766         if (gp->msg != NULL)
 767                 (void)gp->msg->close(gp->msg, 0);
 768 }
 769
 770 /*
 771  * msg_cont --
 772  *      Return common continuation messages.
 773  *
 774  * PUBLIC: const char *msg_cmsg __P((SCR *, cmsg_t, size_t *));
 775  */
 776 const char *
 777 msg_cmsg(sp, which, lenp)
 778         SCR *sp;
 779         cmsg_t which;
 780         size_t *lenp;
 781 {
 782         switch (which) {
 783         case CMSG_CONF:
 784                 return (msg_cat(sp, "268|confirm? [ynq]", lenp));
 785         case CMSG_CONT:
 786                 return (msg_cat(sp, "269|Press any key to continue: ", lenp));
 787         case CMSG_CONT_EX:
 788                 return (msg_cat(sp,
 789             "270|Press any key to continue [: to enter more ex commands]: ",
 790                     lenp));
 791         case CMSG_CONT_R:
 792                 return (msg_cat(sp, "161|Press Enter to continue: ", lenp));
 793         case CMSG_CONT_S:
 794                 return (msg_cat(sp, "275| cont?", lenp));
 795         case CMSG_CONT_Q:
 796                 return (msg_cat(sp,
 797                     "271|Press any key to continue [q to quit]: ", lenp));
 798         default:
 799                 abort();
 800         }
 801         /* NOTREACHED */
 802 }
 803
 804 /*
 805  * msg_cat --
 806  *      Return a single message from the catalog, plus its length.
 807  *
 808  * !!!
 809  * Only a single catalog message can be accessed at a time, if multiple
 810  * ones are needed, they must be copied into local memory.
 811  *
 812  * PUBLIC: const char *msg_cat __P((SCR *, const char *, size_t *));
 813  */
 814 const char *
 815 msg_cat(sp, str, lenp)
 816         SCR *sp;
 817         const char *str;
 818         size_t *lenp;
 819 {
 820         GS *gp;
 821         DBT data, key;
 822         db_recno_t msgno;
 823
 824         /*
 825          * If it's not a catalog message, i.e. has doesn't have a leading
 826          * number and '|' symbol, we're done.
 827          */
 828         if (isdigit(str[0]) &&
 829             isdigit(str[1]) && isdigit(str[2]) && str[3] == '|') {
 830                 memset(&key, 0, sizeof(key));
 831                 key.data = &msgno;
 832                 key.size = sizeof(db_recno_t);
 833                 memset(&data, 0, sizeof(data));
 834                 msgno = atoi(str);
 835
 836                 /*
 837                  * XXX
 838                  * Really sleazy hack -- we put an extra character on the
 839                  * end of the format string, and then we change it to be
 840                  * the nul termination of the string.  There ought to be
 841                  * a better way.  Once we can allocate multiple temporary
 842                  * memory buffers, maybe we can use one of them instead.
 843                  */
 844                 gp = sp == NULL ? NULL : sp->gp;
 845                 if (gp != NULL && gp->msg != NULL &&
 846                     gp->msg->get(gp->msg, NULL, &key, &data, 0) == 0 &&
 847                     data.size != 0) {
 848                         if (lenp != NULL)
 849                                 *lenp = data.size - 1;
 850                         ((char *)data.data)[data.size - 1] = '\0';
 851                         return (data.data);
 852                 }
 853                 str = &str[4];
 854         }
 855         if (lenp != NULL)
 856                 *lenp = strlen(str);
 857         return (str);
 858 }
 859
 860 /*
 861  * msg_print --
 862  *      Return a printable version of a string, in allocated memory.
 863  *
 864  * PUBLIC: char *msg_print __P((SCR *, const char *, int *));
 865  */
 866 char *
 867 msg_print(sp, s, needfree)
 868         SCR *sp;
 869         const char *s;
 870         int *needfree;
 871 {
 872         size_t blen, nlen;
 873         const char *cp;
 874         char *bp, *ep, *p, *t;
 875
 876         *needfree = 0;
 877
 878         for (cp = s; *cp != '\0'; ++cp)
 879                 if (!isprint(*cp))
 880                         break;
 881         if (*cp == '\0')
 882                 return ((char *)s);     /* SAFE: needfree set to 0. */
 883
 884         nlen = 0;
 885         if (0) {
 886 retry:          if (sp == NULL)
 887                         free(bp);
 888                 else
 889                         FREE_SPACE(sp, bp, blen);
 890                 needfree = 0;
 891         }
 892         nlen += 256;
 893         if (sp == NULL) {
 894                 if ((bp = malloc(nlen)) == NULL)
 895                         goto alloc_err;
 896         } else
 897                 GET_SPACE_GOTO(sp, bp, blen, nlen);
 898         if (0) {
 899 alloc_err:      return ("");
 900         }
 901         *needfree = 1;
 902
 903         for (p = bp, ep = (bp + blen) - 1, cp = s; *cp != '\0' && p < ep; ++cp)
 904                 for (t = KEY_NAME(sp, *cp); *t != '\0' && p < ep; *p++ = *t++);
 905         if (p == ep)
 906                 goto retry;
 907         *p = '\0';
 908         return (bp);
 909 }