xref: /freebsd/contrib/bc/include/args.h (revision 12e0d316644a4f80f5f1f78cf07bd93def43b1ca)
1252884aeSStefan Eßer /*
2252884aeSStefan Eßer  * *****************************************************************************
3252884aeSStefan Eßer  *
43aa99676SStefan Eßer  * SPDX-License-Identifier: BSD-2-Clause
5252884aeSStefan Eßer  *
6a970610aSStefan Eßer  * Copyright (c) 2018-2024 Gavin D. Howard and contributors.
7252884aeSStefan Eßer  *
8252884aeSStefan Eßer  * Redistribution and use in source and binary forms, with or without
9252884aeSStefan Eßer  * modification, are permitted provided that the following conditions are met:
10252884aeSStefan Eßer  *
11252884aeSStefan Eßer  * * Redistributions of source code must retain the above copyright notice, this
12252884aeSStefan Eßer  *   list of conditions and the following disclaimer.
13252884aeSStefan Eßer  *
14252884aeSStefan Eßer  * * Redistributions in binary form must reproduce the above copyright notice,
15252884aeSStefan Eßer  *   this list of conditions and the following disclaimer in the documentation
16252884aeSStefan Eßer  *   and/or other materials provided with the distribution.
17252884aeSStefan Eßer  *
18252884aeSStefan Eßer  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19252884aeSStefan Eßer  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20252884aeSStefan Eßer  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21252884aeSStefan Eßer  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22252884aeSStefan Eßer  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23252884aeSStefan Eßer  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24252884aeSStefan Eßer  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25252884aeSStefan Eßer  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26252884aeSStefan Eßer  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27252884aeSStefan Eßer  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28252884aeSStefan Eßer  * POSSIBILITY OF SUCH DAMAGE.
29252884aeSStefan Eßer  *
30252884aeSStefan Eßer  * *****************************************************************************
31252884aeSStefan Eßer  *
32252884aeSStefan Eßer  * Definitions for processing command-line arguments.
33252884aeSStefan Eßer  *
34252884aeSStefan Eßer  */
35252884aeSStefan Eßer 
36252884aeSStefan Eßer #ifndef BC_ARGS_H
37252884aeSStefan Eßer #define BC_ARGS_H
38252884aeSStefan Eßer 
39252884aeSStefan Eßer #include <status.h>
4044d4804dSStefan Eßer #include <opt.h>
41252884aeSStefan Eßer #include <vm.h>
42252884aeSStefan Eßer 
4344d4804dSStefan Eßer /**
4444d4804dSStefan Eßer  * Processes command-line arguments.
4544d4804dSStefan Eßer  * @param argc        How many arguments there are.
4644d4804dSStefan Eßer  * @param argv        The array of arguments.
4744d4804dSStefan Eßer  * @param exit_exprs  True if bc/dc should exit when there are expressions,
4844d4804dSStefan Eßer  *                    false otherwise.
49d101cdd6SStefan Eßer  * @param scale       A pointer to return the scale that the arguments set, if
50d101cdd6SStefan Eßer  *                    any.
51d101cdd6SStefan Eßer  * @param ibase       A pointer to return the ibase that the arguments set, if
52d101cdd6SStefan Eßer  *                    any.
53d101cdd6SStefan Eßer  * @param obase       A pointer to return the obase that the arguments set, if
54d101cdd6SStefan Eßer  *                    any.
5544d4804dSStefan Eßer  */
5678bc019dSStefan Eßer void
57*12e0d316SStefan Eßer bc_args(int argc, const char* argv[], bool exit_exprs, BcBigDig* scale,
58d101cdd6SStefan Eßer         BcBigDig* ibase, BcBigDig* obase);
59d101cdd6SStefan Eßer 
60d101cdd6SStefan Eßer #if BC_ENABLED
61d101cdd6SStefan Eßer 
62d101cdd6SStefan Eßer #if DC_ENABLED
63d101cdd6SStefan Eßer 
64d101cdd6SStefan Eßer /// Returns true if the banner should be quieted.
65d101cdd6SStefan Eßer #define BC_ARGS_SHOULD_BE_QUIET (BC_IS_DC || vm->exprs.len > 1)
66d101cdd6SStefan Eßer 
67d101cdd6SStefan Eßer #else // DC_ENABLED
68d101cdd6SStefan Eßer 
69d101cdd6SStefan Eßer /// Returns true if the banner should be quieted.
70d101cdd6SStefan Eßer #define BC_ARGS_SHOULD_BE_QUIET (vm->exprs.len > 1)
71d101cdd6SStefan Eßer 
72d101cdd6SStefan Eßer #endif // DC_ENABLED
73d101cdd6SStefan Eßer 
74d101cdd6SStefan Eßer #else // BC_ENABLED
75d101cdd6SStefan Eßer 
76d101cdd6SStefan Eßer /// Returns true if the banner should be quieted.
77d101cdd6SStefan Eßer #define BC_ARGS_SHOULD_BE_QUIET (BC_IS_DC)
78d101cdd6SStefan Eßer 
79d101cdd6SStefan Eßer #endif // BC_ENABLED
80252884aeSStefan Eßer 
8144d4804dSStefan Eßer // A reference to the list of long options.
8244d4804dSStefan Eßer extern const BcOptLong bc_args_lopt[];
83252884aeSStefan Eßer 
84252884aeSStefan Eßer #endif // BC_ARGS_H
85