]> Kevux Git Server - fll/blob
c91b19e35627e2be9d11818e201fb2e31ebc2753
[fll] /
1 .TH fake_build_print_warning_setting_both_cannot_when_language "3" "January 2026" "FLL - Featureless Make 0.8.0" "Program Functions"
2 .SH "NAME"
3 fake_build_print_warning_setting_both_cannot_when_language \-
4 .SH SYNOPSIS
5 .nf
6 .B #include <warning.h>
7 .sp
8 \fBf_status_t fake_build_print_warning_setting_both_cannot_when_language\fP(
9     \fBfl_print_t *const       \fP\fIprint\fP,
10     \fBconst f_string_static_t \fP\fIname_1\fP,
11     \fBconst f_string_static_t \fP\fIname_2\fP,
12     \fBconst f_string_static_t \fP\fIname_3\fP
13 );
14 .fi
15 .SH DESCRIPTION
16 .PP
17 Print warning message regarding two parameters being both false when using a given language.
18 .PP
19 This requires print.custom to be fake_main_t.
20 .PP
21 F_output_not (with error bit) if setting is NULL.
22 .SH PARAMETERS
23 .TP
24 .B print
25 The output structure to print to.
26
27 .TP
28 .B name_1
29 The name for the first setting.
30
31 .TP
32 .B name_2
33 The name for the second setting.
34
35 .TP
36 .B name_3
37
38 .SH STRUCTURES
39 .SS ""
40 .PP
41 .sp
42 .PP
43 Structure for facilitating colored or other managed printing.
44 .PP
45 custom: A pointer to a data structure determined by some caller for more advanced manipulation.
46 .sp
47 .RS
48 .nf
49 \fB
50 struct fl_print_t {
51   f_file_t                \fIto\fP;
52   uint8_t                 \fIverbosity\fP;
53   uint64_t                \fIflag\fP;
54   f_string_static_t       \fIprefix\fP;
55   f_string_static_t       \fIsuffix\fP;
56   f_color_set_t           \fIcontext\fP;
57   f_color_set_t           \fInotable\fP;
58   f_color_set_context_t  *\fIset\fP;
59   void                   *\fIcustom\fP;
60 };
61 \fP
62 .fi
63 .RE
64 .SS ""
65 .PP
66 .sp
67 .PP
68 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
69 .PP
70 The f_string_static_t type should always have size set to 0 to represent that it is a static string. This allows for easier integration with f_string_dynamic_t.
71 .PP
72 If size is set to some value other than 0 for a static string, then take special care not to intermix it with f_string_dynamic_t.
73 .PP
74 A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size.
75 .PP
76 size: Total amount of space available.
77 .sp
78 .RS
79 .nf
80 \fB
81 struct f_string_static_t {
82   f_string_t          \fIstring\fP;
83   f_number_unsigned_t \fIused\fP;
84   f_number_unsigned_t \fIsize\fP;
85 };
86 \fP
87 .fi
88 .RE
89 .SS ""
90 .PP
91 .sp
92 .PP
93 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
94 .PP
95 The f_string_static_t type should always have size set to 0 to represent that it is a static string. This allows for easier integration with f_string_dynamic_t.
96 .PP
97 If size is set to some value other than 0 for a static string, then take special care not to intermix it with f_string_dynamic_t.
98 .PP
99 A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size.
100 .PP
101 size: Total amount of space available.
102 .sp
103 .RS
104 .nf
105 \fB
106 struct f_string_static_t {
107   f_string_t          \fIstring\fP;
108   f_number_unsigned_t \fIused\fP;
109   f_number_unsigned_t \fIsize\fP;
110 };
111 \fP
112 .fi
113 .RE
114 .SS ""
115 .PP
116 .sp
117 .PP
118 A string that is analogous to f_string_dynamic_t but intended for static-only uses.
119 .PP
120 The f_string_static_t type should always have size set to 0 to represent that it is a static string. This allows for easier integration with f_string_dynamic_t.
121 .PP
122 If size is set to some value other than 0 for a static string, then take special care not to intermix it with f_string_dynamic_t.
123 .PP
124 A special macro_f_string_static_t_initialize_1() is provided to easily initialize a static string. A special macro_f_string_static_t_initialize_2() is provided to easily initialize a static string with an identical used and size.
125 .PP
126 size: Total amount of space available.
127 .sp
128 .RS
129 .nf
130 \fB
131 struct f_string_static_t {
132   f_string_t          \fIstring\fP;
133   f_number_unsigned_t \fIused\fP;
134   f_number_unsigned_t \fIsize\fP;
135 };
136 \fP
137 .fi
138 .RE
139 .SH RETURN VALUE
140 .PP
141 F_okay on success. F_output_not on success, but no printing is performed.
142 .SH SEE ALSO
143 .PP
144 .nh
145 .ad l
146 \fIwarning.h\fP(3), \fIfake_build_print_warning_parameters_contradict\fP(3), \fIfake_build_print_warning_setting_boolean_may_only_be\fP(3), \fIfake_build_print_warning_setting_both_cannot_when_language\fP(3), \fIfake_build_print_warning_setting_required_default_to\fP(3), \fIfake_build_print_warning_setting_slash_not_allowed\fP(3), \fIfake_build_print_warning_setting_version_may_only_be\fP(3), \fIfake_main_t\fP, \fIfake_print_context_wrapped_parameters()\fP
147 .ad
148 .hy
149 .SH AUTHOR
150 Written by Kevin Day.
151 .SH COPYRIGHT
152 .PP
153 Copyright \(co 2007-2026 Kevin Day, GNU LGPL Version 2.1 or later.