Home | History | Annotate | Line # | Download | only in include
      1 /*	$NetBSD: fmtmsg.h,v 1.4 2023/12/08 21:46:02 andvar Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Klaus Klein.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _FMTMSG_H_
     33 #define _FMTMSG_H_
     34 
     35 /* Major Classifications: identifies the source of the condition. */
     36 #define MM_HARD		0x01L	/* Hardware */
     37 #define MM_SOFT		0x02L	/* Software */
     38 #define MM_FIRM		0x03L	/* Firmware */
     39 
     40 /* Message Source Subclassifications: type of software. */
     41 #define MM_APPL		0x04L	/* Application */
     42 #define MM_UTIL		0x08L	/* Utility */
     43 #define MM_OPSYS	0x0cL	/* Operating system */
     44 
     45 /* Display Subclassifications: where to display the message. */
     46 #define MM_PRINT	0x10L	/* Display on standard error */
     47 #define MM_CONSOLE	0x20L	/* Display on system console */
     48 
     49 /* Status subclassifications: whether the application will recover. */
     50 #define MM_RECOVER	0x40L	/* Recoverable */
     51 #define MM_NRECOV	0x80L	/* Non-recoverable */
     52 
     53 /* Severity: seriousness of the condition. */
     54 #define MM_NOSEV	0	/* No severity level provided */
     55 #define MM_HALT		1	/* Error causing application to halt */
     56 #define MM_ERROR	2	/* Encountered a non-fatal fault */
     57 #define MM_WARNING	3	/* Unusual non-error condition */
     58 #define MM_INFO		4	/* Informative message */
     59 
     60 /* `Null' values for message components. */
     61 #define MM_NULLMC	0L		/* `Null' classification component */
     62 #define MM_NULLLBL	(char *)0	/* `Null' label component */
     63 #define MM_NULLSEV	0		/* `Null' severity component */
     64 #define MM_NULLTXT	(char *)0	/* `Null' text component */
     65 #define MM_NULLACT	(char *)0	/* `Null' action component */
     66 #define MM_NULLTAG	(char *)0	/* `Null' tag component */
     67 
     68 /* Return values for fmtmsg(). */
     69 #define MM_OK		0	/* Function succeeded */
     70 #define MM_NOTOK	(-1)	/* Function failed completely */
     71 #define MM_NOMSG	0x01	/* Unable to perform MM_PRINT */
     72 #define MM_NOCON	0x02	/* Unable to perform MM_CONSOLE */
     73 
     74 #include <sys/cdefs.h>
     75 
     76 __BEGIN_DECLS
     77 int	fmtmsg(long, const char *, int, const char *, const char *,
     78 	    const char *);
     79 __END_DECLS
     80 
     81 #endif /* !_FMTMSG_H_ */
     82