contrib/bc/include/dc.h

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