catmsgfmt.c

Go to the documentation of this file.

#pragma ident "@(#)92/msgnew/catmsgfmt.c        92.2    06/03/99 09:59:18"

/*

  Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.

  This program is free software; you can redistribute it and/or modify it
  under the terms of version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  This program is distributed in the hope that it would be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

  Further, this software is distributed without any warranty that it is
  free of the rightful claim of any third person regarding infringement 
  or the like.  Any license provided herein, whether implied or 
  otherwise, applies only to this software file.  Patent licenses, if 
  any, provided herein do not apply to combinations of this program with 
  other software, or any other product whatsoever.  

  You should have received a copy of the GNU General Public License along
  with this program; if not, write the Free Software Foundation, Inc., 59
  Temple Place - Suite 330, Boston MA 02111-1307, USA.

  Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
  Mountain View, CA 94043, or:

  http://www.sgi.com

  For further information regarding this notice, see:

  http://oss.sgi.com/projects/GenInfo/NoticeExplan

*/

#ifdef  _LITTLE_ENDIAN
        #pragma weak _catmsgfmt = catmsgfmt
#else                                   /* Else _LITTLE_ENDIAN */
#if defined(__STDC__) && !defined(_LIBU)
        #pragma weak catmsgfmt = _catmsgfmt
#endif
#endif                                  /* End _LITTLE_ENDIAN */

/*
 * IMPORTANT:
 * This section is needed since this file also resides in the compilers'
 * libcsup/msg (v7.2 and higher). Once the compilers drop support for
 * pre-IRIX 6.5 releases this can be removed. Please build a libu before
 * checking in any changes to this file.
 *
 */
/* patch these two definitions to Solaris's <nl_types.h>
 * there is one more symbol 'NL_MSGSET' undefined on Solaris,
 * but I put its definition NL_MSGSET = NL_SEFD into compiler
 * command line
 */

#define DISABLE_NL_TYPES_SYMBOL_RENAMING 1 /* for our <nl_types.h> */

#include <locale.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <time.h>
#include <nl_types.h>

#include <cray/nlcatmsg.h> /* Open64 header */

/* SGI's <nl_types.h> defines MSG_FORMAT and D_MSG_FORMAT when
   __NLS_INTERNALS is defined */
#ifndef MSG_FORMAT
# define MSG_FORMAT "MSG_FORMAT"
#endif

#ifndef D_MSG_FORMAT
# define D_MSG_FORMAT "%G-%N %C: %S %P\n  %M\n"
#endif

#define OCTAL           8
#define HEXADECIMAL     16
#define MAXTIME         51

/*
 *      catmsgfmt - format an error message
 *
 *      char *
 *      catmsgfmt(
 *              char    *cmdname,
 *              char    *groupcode,
 *              int     msg_num,
 *              char    *severity,
 *              char    *msgtext,
 *              char    *buf,
 *              int     buflen,
 *              char    *position,
 *              char    *debug)
 *
 *      catmsgfmt() formats up to "buflen" characters a message containing
 *      the command name "cmdname", group code "groupcode", message number
 *      "msg_num", severity level "severity", the text of the message
 *      "msgtext", and a debug parameter "debug".  The formatted
 *      message is placed in the user-supplied buffer "buf".
 *
 *      The msg_num parameter is an integer which is converted to an ASCII
 *      string of digits.  The cmdname, groupcode, severity, and msgtext
 *      parameters are all null-terminated character strings.
 *
 *      The MSG_FORMAT environment variable controls how the message
 *      is formatted.  If the MSG_FORMAT environment variable is not
 *      defined, a default formatting value is used.
 */

char *
catmsgfmt(
          const char *cmdname,
          const char *groupcode,
          int msg_num,
          const char *severity,
          const char *msgtext,
          char *buf,
          int buflen,
          char *pos,
          char *dbg
          )
{
        char    c;              /* Current character */
        char    *fmtp;          /* Pointer to format */
        char    *cmsp;          /* Pointer to current position in message */
        char    *tknp;          /* Pointer to current token */
        char    *tncp;          /* Pointer to terminating number character */
        char    *tfmt;          /* Timestamp format */
        char    num[20];        /* Converted message number */
        char    tms[MAXTIME];   /* Converted timestamp */
        int     cmsl;           /* Bytes remaining in message */
        time_t  cts;            /* Current timestamp */
        struct tm       *ltsp;  /* Local time structure */

        if ((buflen < 1) || (msg_num < 1))
                return( (char *) NULL);

        /* Convert number */
        (void) sprintf(num, "%d", msg_num);

        /* Clear timestamp string */
        *tms    = '\0';

        /* Find format */
        if ((fmtp = getenv(MSG_FORMAT)) == NULL) /* If format not defined */
                fmtp    = D_MSG_FORMAT; /* Set default format */

        cmsl    = 1;                    /* Current length (save 1 byte for \0 */
        cmsp    = buf;                  /* Set current position in message */

        while ((*fmtp != '\0') && (cmsl < buflen))
                if ((c  = *fmtp++) != '%') {
                        cmsl++;
                        if (c != '\\')
                                *cmsp++ = c;
                        else {
                                switch (*fmtp) {        /* Process escapes */

                                        case 'a' : c    = '\a';
                                                   break;

                                        case 'b' : c    = '\b';
                                                   break;

                                        case 'f' : c    = '\f';
                                                   break;

                                        case 'n' : c    = '\n';
                                                   break;

                                        case 'r' : c    = '\r';
                                                   break;

                                        case 't' : c    = '\t';
                                                   break;

                                        case 'v' : c    = '\v';
                                                   break;

                                        case 'x' : /* Do hex character */
                                                   c    = (char)strtol(fmtp + 1,
                                                        &tncp, HEXADECIMAL); 
                                                   if (tncp == (fmtp + 1))
                                                        c       = *fmtp;
                                                   else
                                                        fmtp    = tncp - 1;
                                                   break;

                                        case '\\': c    = '\\';
                                                   break;

                                        case '?' : c    = '?';
                                                   break;

                                        case '\'': c    = '\'';
                                                   break;

                                        case '"' : c    = '"';
                                                   break;

                                        case '0' :
                                        case '1' :
                                        case '2' :
                                        case '3' :
                                        case '4' :
                                        case '5' :
                                        case '6' :
                                        case '7' : /* Do octal character */
                                                   c    = (char) strtol(fmtp,
                                                        &tncp, OCTAL);
                                                   if (tncp == fmtp)
                                                        c       = *fmtp;
                                                   else
                                                        fmtp    = tncp - 1;
                                                   break;

                                        default  : c    = *fmtp;
                                }

                                *cmsp++ = c;
                                fmtp++;
                        }
                }
                else {
                        switch (*fmtp) {

                                case '%':       /* Percent */
                                        tknp    = "%";
                                        break;

                                case 'C':       /* Command */
                                        tknp    = (char *) cmdname;
                                        break;

                                case 'D':       /* Debug */
                                        tknp    = dbg;
                                        break;

                                case 'G':       /* Group name */
                                        tknp    = (char *) groupcode;
                                        break;

                                case 'N':       /* Message number */
                                        tknp    = num;
                                        break;

                                case 'P':       /* Position */
                                        tknp    = pos;
                                        break;

                                case 'S':       /* Severity */
                                        tknp    = (char *) severity;
                                        break;

                                case 'T':       /* Timestamp */
                                        tknp    = tms;

                                        if (*tms == '\0') {     /* If not set */
                                                (void) time(&cts);
                                                ltsp    = localtime(&cts);
                                                tfmt    = getenv("CFTIME");
                                                if (tfmt == NULL ||
                                                    *tfmt == '\0')
                                                        /* date(1) format */
                                                        tfmt = "%a %b %e %H:%M:%S %Z %Y";
                                                (void) strftime(tms, MAXTIME,
                                                                tfmt, ltsp);
                                        }
                                        break;

                                case 'M':       /* Message text */
                                        tknp    = (char *) msgtext;
                                        break;

                                default:        /* Everything else */
                                        *cmsp++ = c;
                                        if (cmsl++ < buflen)
                                                *cmsp++ = *fmtp;
                                        cmsl++;
                                        tknp    = "";
                        }

                        if (tknp != NULL) {
                          while ((*tknp != '\0') && (cmsl++ < buflen))
                            *cmsp++ = *tknp++;
                        }
                        fmtp++;

                }

        *cmsp   = '\0';         /* Terminate formatted message */

        return(buf);
}