175a4d1042
This version contains a fix for an issue that can affect complex bc scripts that use multiple read() functions that receive input from an interactive user. The same value could be returned multiple times. MFC after: 2 weeks
373 lines
6.8 KiB
C
373 lines
6.8 KiB
C
/*
|
|
* *****************************************************************************
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* Copyright (c) 2018-2023 Gavin D. Howard and contributors.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* * Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* *****************************************************************************
|
|
*
|
|
* The public header for the bc library.
|
|
*
|
|
*/
|
|
|
|
#ifndef BC_BCL_H
|
|
#define BC_BCL_H
|
|
|
|
// TODO: Add a generation index when building with Valgrind to check for
|
|
// use-after-free's or double frees.
|
|
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <limits.h>
|
|
#include <stdint.h>
|
|
|
|
#ifndef NDEBUG
|
|
#define BC_DEBUG (1)
|
|
#else // NDEBUG
|
|
#define BC_DEBUG (0)
|
|
#endif // NDEBUG
|
|
|
|
#ifdef _WIN32
|
|
#include <Windows.h>
|
|
#include <BaseTsd.h>
|
|
#include <stdio.h>
|
|
#include <io.h>
|
|
#endif // _WIN32
|
|
|
|
#ifdef _WIN32
|
|
#define ssize_t SSIZE_T
|
|
#endif // _WIN32
|
|
|
|
#define BCL_SEED_ULONGS (4)
|
|
#define BCL_SEED_SIZE (sizeof(long) * BCL_SEED_ULONGS)
|
|
|
|
// For some reason, LONG_BIT is not defined in some versions of gcc.
|
|
// I define it here to the minimum accepted value in the POSIX standard.
|
|
#ifndef LONG_BIT
|
|
#define LONG_BIT (32)
|
|
#endif // LONG_BIT
|
|
|
|
#ifndef BC_LONG_BIT
|
|
#define BC_LONG_BIT LONG_BIT
|
|
#endif // BC_LONG_BIT
|
|
|
|
#if BC_LONG_BIT > LONG_BIT
|
|
#error BC_LONG_BIT cannot be greater than LONG_BIT
|
|
#endif // BC_LONG_BIT > LONG_BIT
|
|
|
|
// For more information about the items here, see the either the
|
|
// manuals/bcl.3.md or manuals/bcl.3 manuals.
|
|
|
|
// BclBigDig is a fixed-size integer type that bcl can convert numbers to.
|
|
//
|
|
// BclRandInt is the type of fixed-size integer natively returned by the
|
|
// pseudo-random number generator.
|
|
#if BC_LONG_BIT >= 64
|
|
|
|
typedef uint64_t BclBigDig;
|
|
typedef uint64_t BclRandInt;
|
|
|
|
#elif BC_LONG_BIT >= 32
|
|
|
|
typedef uint32_t BclBigDig;
|
|
typedef uint32_t BclRandInt;
|
|
|
|
#else
|
|
|
|
#error BC_LONG_BIT must be at least 32
|
|
|
|
#endif // BC_LONG_BIT >= 64
|
|
|
|
#ifndef BC_ENABLE_LIBRARY
|
|
#define BC_ENABLE_LIBRARY (1)
|
|
#endif // BC_ENABLE_LIBRARY
|
|
|
|
#if BC_ENABLE_LIBRARY
|
|
|
|
typedef enum BclError
|
|
{
|
|
BCL_ERROR_NONE,
|
|
|
|
BCL_ERROR_INVALID_NUM,
|
|
BCL_ERROR_INVALID_CONTEXT,
|
|
BCL_ERROR_SIGNAL,
|
|
|
|
BCL_ERROR_MATH_NEGATIVE,
|
|
BCL_ERROR_MATH_NON_INTEGER,
|
|
BCL_ERROR_MATH_OVERFLOW,
|
|
BCL_ERROR_MATH_DIVIDE_BY_ZERO,
|
|
|
|
BCL_ERROR_PARSE_INVALID_STR,
|
|
|
|
BCL_ERROR_FATAL_ALLOC_ERR,
|
|
BCL_ERROR_FATAL_UNKNOWN_ERR,
|
|
|
|
BCL_ERROR_NELEMS,
|
|
|
|
} BclError;
|
|
|
|
typedef struct BclNumber
|
|
{
|
|
size_t i;
|
|
|
|
} BclNumber;
|
|
|
|
struct BclCtxt;
|
|
|
|
typedef struct BclCtxt* BclContext;
|
|
|
|
BclError
|
|
bcl_start(void);
|
|
|
|
void
|
|
bcl_end(void);
|
|
|
|
BclError
|
|
bcl_init(void);
|
|
|
|
void
|
|
bcl_free(void);
|
|
|
|
bool
|
|
bcl_abortOnFatalError(void);
|
|
|
|
void
|
|
bcl_setAbortOnFatalError(bool abrt);
|
|
|
|
bool
|
|
bcl_leadingZeroes(void);
|
|
|
|
void
|
|
bcl_setLeadingZeroes(bool leadingZeroes);
|
|
|
|
bool
|
|
bcl_digitClamp(void);
|
|
|
|
void
|
|
bcl_setDigitClamp(bool digitClamp);
|
|
|
|
void
|
|
bcl_gc(void);
|
|
|
|
BclError
|
|
bcl_pushContext(BclContext ctxt);
|
|
|
|
void
|
|
bcl_popContext(void);
|
|
|
|
BclContext
|
|
bcl_context(void);
|
|
|
|
BclContext
|
|
bcl_ctxt_create(void);
|
|
|
|
void
|
|
bcl_ctxt_free(BclContext ctxt);
|
|
|
|
void
|
|
bcl_ctxt_freeNums(BclContext ctxt);
|
|
|
|
size_t
|
|
bcl_ctxt_scale(BclContext ctxt);
|
|
|
|
void
|
|
bcl_ctxt_setScale(BclContext ctxt, size_t scale);
|
|
|
|
size_t
|
|
bcl_ctxt_ibase(BclContext ctxt);
|
|
|
|
void
|
|
bcl_ctxt_setIbase(BclContext ctxt, size_t ibase);
|
|
|
|
size_t
|
|
bcl_ctxt_obase(BclContext ctxt);
|
|
|
|
void
|
|
bcl_ctxt_setObase(BclContext ctxt, size_t obase);
|
|
|
|
BclError
|
|
bcl_err(BclNumber n);
|
|
|
|
BclNumber
|
|
bcl_num_create(void);
|
|
|
|
void
|
|
bcl_num_free(BclNumber n);
|
|
|
|
bool
|
|
bcl_num_neg(BclNumber n);
|
|
|
|
void
|
|
bcl_num_setNeg(BclNumber n, bool neg);
|
|
|
|
size_t
|
|
bcl_num_scale(BclNumber n);
|
|
|
|
BclError
|
|
bcl_num_setScale(BclNumber n, size_t scale);
|
|
|
|
size_t
|
|
bcl_num_len(BclNumber n);
|
|
|
|
BclError
|
|
bcl_copy(BclNumber d, BclNumber s);
|
|
|
|
BclNumber
|
|
bcl_dup(BclNumber s);
|
|
|
|
BclError
|
|
bcl_bigdig(BclNumber n, BclBigDig* result);
|
|
|
|
BclError
|
|
bcl_bigdig_keep(BclNumber n, BclBigDig* result);
|
|
|
|
BclNumber
|
|
bcl_bigdig2num(BclBigDig val);
|
|
|
|
BclNumber
|
|
bcl_add(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_add_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_sub(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_sub_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_mul(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_mul_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_div(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_div_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_mod(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_mod_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_pow(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_pow_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_lshift(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_lshift_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_rshift(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_rshift_keep(BclNumber a, BclNumber b);
|
|
|
|
BclNumber
|
|
bcl_sqrt(BclNumber a);
|
|
|
|
BclNumber
|
|
bcl_sqrt_keep(BclNumber a);
|
|
|
|
BclError
|
|
bcl_divmod(BclNumber a, BclNumber b, BclNumber* c, BclNumber* d);
|
|
|
|
BclError
|
|
bcl_divmod_keep(BclNumber a, BclNumber b, BclNumber* c, BclNumber* d);
|
|
|
|
BclNumber
|
|
bcl_modexp(BclNumber a, BclNumber b, BclNumber c);
|
|
|
|
BclNumber
|
|
bcl_modexp_keep(BclNumber a, BclNumber b, BclNumber c);
|
|
|
|
ssize_t
|
|
bcl_cmp(BclNumber a, BclNumber b);
|
|
|
|
void
|
|
bcl_zero(BclNumber n);
|
|
|
|
void
|
|
bcl_one(BclNumber n);
|
|
|
|
BclNumber
|
|
bcl_parse(const char* restrict val);
|
|
|
|
char*
|
|
bcl_string(BclNumber n);
|
|
|
|
char*
|
|
bcl_string_keep(BclNumber n);
|
|
|
|
BclNumber
|
|
bcl_irand(BclNumber a);
|
|
|
|
BclNumber
|
|
bcl_irand_keep(BclNumber a);
|
|
|
|
BclNumber
|
|
bcl_frand(size_t places);
|
|
|
|
BclNumber
|
|
bcl_ifrand(BclNumber a, size_t places);
|
|
|
|
BclNumber
|
|
bcl_ifrand_keep(BclNumber a, size_t places);
|
|
|
|
BclError
|
|
bcl_rand_seedWithNum(BclNumber n);
|
|
|
|
BclError
|
|
bcl_rand_seedWithNum_keep(BclNumber n);
|
|
|
|
BclError
|
|
bcl_rand_seed(unsigned char seed[BCL_SEED_SIZE]);
|
|
|
|
void
|
|
bcl_rand_reseed(void);
|
|
|
|
BclNumber
|
|
bcl_rand_seed2num(void);
|
|
|
|
BclRandInt
|
|
bcl_rand_int(void);
|
|
|
|
BclRandInt
|
|
bcl_rand_bounded(BclRandInt bound);
|
|
|
|
#endif // BC_ENABLE_LIBRARY
|
|
|
|
#endif // BC_BCL_H
|