1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2008-2013 Peter Miller
* Written by Peter Miller <pmiller@opensource.org.au>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBEXPLAIN_OPTION_H
#define LIBEXPLAIN_OPTION_H
/**
* The explain_option_numeric_errno function may be used to obtain
* the EXPLAIN_OPTIONS (no-)numeric-errno flag, used to control
* whether or not the numeric value of errno is displayed. This is
* commonly turned off for the test suite, to cope with capricious
* errno numbering on different UNIX dialects.
*
* @returns
* int; true (non-zero) if numeric errno values are to be displayed
* (this is the default), false (zero) if they are not to be
* dislayed.
*/
int explain_option_numeric_errno(void);
/**
* The explain_option_dialect_specific function may be used to
* obtain the EXPLAIN_OPTIONS (no-)dialect-specific flag, used to
* control whether or not informative text that is specific to a given
* UNIX dialect is to be displayed. This is commonly turned off for
* the test suite.
*
* @returns
* int; true (non-zero) if additional dialect specific text is to be
* displayed (this is the default), false (zero) if it is not to be
* dislayed.
*/
int explain_option_dialect_specific(void);
/**
* The explain_option_debug function may be used to obtain the
* EXPLAIN_OPTIONS (no-)debug flag, used to control whether or not
* debug behaviour is enabled. Defaults to off.
*
* @returns
* int; true (non-zero) if additional dialect specific text is to be
* displayed (this is the default), false (zero) if it is not to be
* dislayed.
*/
int explain_option_debug(void);
/**
* The explain_option_assemble_program_name option is used to determine
* whether or not the #explain_output_error, #explain_output_error_and_die and
* #explain_output_warning functions should include the program name at the
* start the messages.
*
* @returns
* int; true (non-zero) is shall include program name, zero (false)
* if shall not include program name.
*/
int explain_option_assemble_program_name(void);
#if 0
/**
* The explain_program_name_assemble_internal function is used
* to control whether or not the name of the calling process is to
* be included in error messages issued by the explain_*_or_die
* functions. This will have a precedence below the EXPLAIN_OPTIONS
* environment variable, but higher than default. It is intended for
* use by the explain_*_or_die functions.
*
* @param yesno
* non-zero (true) to have program name included,
* zero (false) to have program name excluded.
*/
void explain_program_name_assemble_internal(int yesno);
#endif
/**
* The explain_option_symbolic_mode_bits function may be used to obtain
* the EXPLAIN_OPTIONS (no-)symbolic-mode-bits flag, used to control
* whether or not symbolic mode bits are to be used. Default to false,
* meaning print octal mode bits.
*
* @returns
* true (non-zero) if symbolic mode bits are to be printed (e.g. S_IRUSR),
* false (zero) if octal mode bits are to be printed.
*/
int explain_option_symbolic_mode_bits(void);
/**
* The explain_option_internal_strerror function may be used to obtain
* the "(no-)internal-strerror" flag. Defaults to false, meaning use
* the system strerror. Useful for avoiding false negatives in the
* automatic test suite.
*
* @returns
* true (non-zero) if are to use internal strerror strings,
* false (zero) if are to use system strerror.
*/
int explain_option_internal_strerror(void);
/**
* The explain_option_hanging_indent function may be used to obtain
* the "hanging-indent" option value.
*
* @param width
* The width of the output line. The hanging indent must be less
* than 10% of this.
*/
int explain_option_hanging_indent(int width);
int explain_option_extra_device_info(void);
#endif /* LIBEXPLAIN_OPTION_H */
/* vim: set ts=8 sw=4 et : */
|
