1/*
2 * *****************************************************************************
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 *
6 * Copyright (c) 2018-2023 Gavin D. Howard and contributors.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * * Redistributions of source code must retain the above copyright notice, this
12 *   list of conditions and the following disclaimer.
13 *
14 * * Redistributions in binary form must reproduce the above copyright notice,
15 *   this list of conditions and the following disclaimer in the documentation
16 *   and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 * *****************************************************************************
31 *
32 * Definitions for processing command-line arguments.
33 *
34 */
35
36#ifndef BC_ARGS_H
37#define BC_ARGS_H
38
39#include <status.h>
40#include <opt.h>
41#include <vm.h>
42
43/**
44 * Processes command-line arguments.
45 * @param argc        How many arguments there are.
46 * @param argv        The array of arguments.
47 * @param exit_exprs  True if bc/dc should exit when there are expressions,
48 *                    false otherwise.
49 * @param scale       A pointer to return the scale that the arguments set, if
50 *                    any.
51 * @param ibase       A pointer to return the ibase that the arguments set, if
52 *                    any.
53 * @param obase       A pointer to return the obase that the arguments set, if
54 *                    any.
55 */
56void
57bc_args(int argc, char* argv[], bool exit_exprs, BcBigDig* scale,
58        BcBigDig* ibase, BcBigDig* obase);
59
60#if BC_ENABLED
61
62#if DC_ENABLED
63
64/// Returns true if the banner should be quieted.
65#define BC_ARGS_SHOULD_BE_QUIET (BC_IS_DC || vm->exprs.len > 1)
66
67#else // DC_ENABLED
68
69/// Returns true if the banner should be quieted.
70#define BC_ARGS_SHOULD_BE_QUIET (vm->exprs.len > 1)
71
72#endif // DC_ENABLED
73
74#else // BC_ENABLED
75
76/// Returns true if the banner should be quieted.
77#define BC_ARGS_SHOULD_BE_QUIET (BC_IS_DC)
78
79#endif // BC_ENABLED
80
81// A reference to the list of long options.
82extern const BcOptLong bc_args_lopt[];
83
84#endif // BC_ARGS_H
85