xref: /onnv-gate/usr/src/cmd/lvm/metassist/common/volume_output.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _VOLUME_OUTPUT_H
28*0Sstevel@tonic-gate #define	_VOLUME_OUTPUT_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #include <stdio.h>
37*0Sstevel@tonic-gate #include <stdarg.h>
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef DEBUG
40*0Sstevel@tonic-gate /*
41*0Sstevel@tonic-gate  * The environment variable that must be set for metassist to
42*0Sstevel@tonic-gate  * enable debug output
43*0Sstevel@tonic-gate  */
44*0Sstevel@tonic-gate #define	METASSIST_DEBUG_ENV	"METASSIST_DEBUG"
45*0Sstevel@tonic-gate #endif
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate /* Verbosity levels */
48*0Sstevel@tonic-gate #define	OUTPUT_QUIET	0
49*0Sstevel@tonic-gate #define	OUTPUT_TERSE	1
50*0Sstevel@tonic-gate #define	OUTPUT_VERBOSE	2
51*0Sstevel@tonic-gate #define	OUTPUT_DEBUG	3
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate /*
54*0Sstevel@tonic-gate  * Set the maximum level of verbosity to be reported to the user.
55*0Sstevel@tonic-gate  * Strings sent to oprintf() with a higher verbosity level than this
56*0Sstevel@tonic-gate  * maximum level will not be reported to the user.
57*0Sstevel@tonic-gate  *
58*0Sstevel@tonic-gate  * @param       verbosity
59*0Sstevel@tonic-gate  *              One of the predefined constants:
60*0Sstevel@tonic-gate  *                OUTPUT_QUIET
61*0Sstevel@tonic-gate  *                OUTPUT_TERSE
62*0Sstevel@tonic-gate  *                OUTPUT_VERBOSE
63*0Sstevel@tonic-gate  *                OUTPUT_DEBUG
64*0Sstevel@tonic-gate  *
65*0Sstevel@tonic-gate  * @param       stream
66*0Sstevel@tonic-gate  *              The stream to print all qualifying output to.
67*0Sstevel@tonic-gate  *
68*0Sstevel@tonic-gate  * @return      0 on success, non-zero otherwise.
69*0Sstevel@tonic-gate  */
70*0Sstevel@tonic-gate extern int set_max_verbosity(int verbosity, FILE *stream);
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate /*
73*0Sstevel@tonic-gate  * Get the maximum level of verbosity to be reported to the user.
74*0Sstevel@tonic-gate  *
75*0Sstevel@tonic-gate  * @return      OUTPUT_QUIET
76*0Sstevel@tonic-gate  *
77*0Sstevel@tonic-gate  * @return      OUTPUT_TERSE
78*0Sstevel@tonic-gate  *
79*0Sstevel@tonic-gate  * @return      OUTPUT_VERBOSE
80*0Sstevel@tonic-gate  *
81*0Sstevel@tonic-gate  * @return      OUTPUT_DEBUG
82*0Sstevel@tonic-gate  */
83*0Sstevel@tonic-gate extern int get_max_verbosity();
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate /*
86*0Sstevel@tonic-gate  * Prints the given formatted string arguments to a predefined stream,
87*0Sstevel@tonic-gate  * if the given verbosity is less than or equal to the set maximum
88*0Sstevel@tonic-gate  * verbosity.
89*0Sstevel@tonic-gate  *
90*0Sstevel@tonic-gate  * @param       verbosity
91*0Sstevel@tonic-gate  *              Same as for set_max_verbosity()
92*0Sstevel@tonic-gate  *
93*0Sstevel@tonic-gate  * @param       fmt, ...
94*0Sstevel@tonic-gate  *              printf-style arguments
95*0Sstevel@tonic-gate  *
96*0Sstevel@tonic-gate  * @return      the number of characters output
97*0Sstevel@tonic-gate  *              if successful
98*0Sstevel@tonic-gate  *
99*0Sstevel@tonic-gate  * @return      negative value
100*0Sstevel@tonic-gate  *              if unsuccessful
101*0Sstevel@tonic-gate  */
102*0Sstevel@tonic-gate extern int oprintf(int verbosity, char *fmt, ...);
103*0Sstevel@tonic-gate 
104*0Sstevel@tonic-gate /*
105*0Sstevel@tonic-gate  * Identical to oprintf but with a va_list instead of variable length
106*0Sstevel@tonic-gate  * argument list.  This function is provided for external printf-style
107*0Sstevel@tonic-gate  * wrappers.
108*0Sstevel@tonic-gate  *
109*0Sstevel@tonic-gate  * @param       verbosity
110*0Sstevel@tonic-gate  *              Same as for set_max_verbosity()
111*0Sstevel@tonic-gate  *
112*0Sstevel@tonic-gate  * @param       fmt
113*0Sstevel@tonic-gate  *              printf format string
114*0Sstevel@tonic-gate  *
115*0Sstevel@tonic-gate  * @param       ap
116*0Sstevel@tonic-gate  *              a va_list containing remaining printf-style arguments
117*0Sstevel@tonic-gate  *
118*0Sstevel@tonic-gate  * @return      the number of characters output
119*0Sstevel@tonic-gate  *              if successful
120*0Sstevel@tonic-gate  *
121*0Sstevel@tonic-gate  * @return      negative value
122*0Sstevel@tonic-gate  *              if unsuccessful
123*0Sstevel@tonic-gate  */
124*0Sstevel@tonic-gate extern int oprintf_va(int verbosity, char *fmt, va_list ap);
125*0Sstevel@tonic-gate 
126*0Sstevel@tonic-gate #ifdef __cplusplus
127*0Sstevel@tonic-gate }
128*0Sstevel@tonic-gate #endif
129*0Sstevel@tonic-gate 
130*0Sstevel@tonic-gate #endif /* _VOLUME_OUTPUT_H */
131