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 dc only.
33 *
34 */
35
36#ifndef BC_DC_H
37#define BC_DC_H
38
39#if DC_ENABLED
40
41#include <status.h>
42#include <lex.h>
43#include <parse.h>
44
45/**
46 * The main function for dc. It just sets variables and passes its arguments
47 * through to @a bc_vm_boot().
48 */
49void
50dc_main(int argc, char* argv[]);
51
52// A reference to the dc help text.
53extern const char dc_help[];
54
55/**
56 * The @a BcLexNext function for dc. (See include/lex.h for a definition of
57 * @a BcLexNext.)
58 * @param l  The lexer.
59 */
60void
61dc_lex_token(BcLex* l);
62
63/**
64 * Returns true if the negative char `_` should be treated as a command or not.
65 * dc considers negative a command if it does *not* immediately proceed a
66 * number. Otherwise, it's just considered a negative.
67 * @param l  The lexer.
68 * @return   True if a negative should be treated as a command, false if it
69 *           should be treated as a negative sign on a number.
70 */
71bool
72dc_lex_negCommand(BcLex* l);
73
74// References to the signal message and its length.
75extern const char dc_sig_msg[];
76extern const uchar dc_sig_msg_len;
77
78// References to an array and its length. This array is an array of lex tokens
79// that, when encountered, should be treated as commands that take a register.
80extern const uint8_t dc_lex_regs[];
81extern const size_t dc_lex_regs_len;
82
83// References to an array of tokens and its length. This array corresponds to
84// the ASCII table, starting at double quotes. This makes it easy to look up
85// tokens for characters.
86extern const uint8_t dc_lex_tokens[];
87extern const uint8_t dc_parse_insts[];
88
89/**
90 * The @a BcParseParse function for dc. (See include/parse.h for a definition of
91 * @a BcParseParse.)
92 * @param p  The parser.
93 */
94void
95dc_parse_parse(BcParse* p);
96
97/**
98 * The @a BcParseExpr function for dc. (See include/parse.h for a definition of
99 * @a BcParseExpr.)
100 * @param p      The parser.
101 * @param flags  Flags that define the requirements that the parsed code must
102 *               meet or an error will result. See @a BcParseExpr for more info.
103 */
104void
105dc_parse_expr(BcParse* p, uint8_t flags);
106
107#endif // DC_ENABLED
108
109#endif // BC_DC_H
110