diff --git a/contrib/bc/LICENSE.md b/contrib/bc/LICENSE.md index 8e6b7e0b9051..b65095edc26c 100644 --- a/contrib/bc/LICENSE.md +++ b/contrib/bc/LICENSE.md @@ -1,113 +1,113 @@ # License -Copyright (c) 2018-2023 Gavin D. Howard +Copyright (c) 2018-2023 Gavin D. Howard 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. ## History The files `src/history.c` and `include/history.h` are under the following copyrights and license: Copyright (c) 2010-2014, Salvatore Sanfilippo
Copyright (c) 2010-2013, Pieter Noordhuis
Copyright (c) 2018 rain-1
-Copyright (c) 2018-2023, Gavin D. Howard +Copyright (c) 2018-2023, Gavin D. Howard 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. ## Rand The files `src/rand.c` and `include/rand.h` are under the following copyrights and license: Copyright (c) 2014-2017 Melissa O'Neill and PCG Project contributors -Copyright (c) 2018-2023 Gavin D. Howard +Copyright (c) 2018-2023 Gavin D. Howard Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ## `scripts/safe-install.sh` The file `scripts/safe-install.sh` is under the following copyright and license: Copyright (c) 2021 Rich Felker Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ## `scripts/ministat.c` The file `scripts/ministat.c` is under the following license: "THE BEER-WARE LICENSE" (Revision 42): wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp diff --git a/contrib/bc/NEWS.md b/contrib/bc/NEWS.md index 36952fdaf582..4601db456f86 100644 --- a/contrib/bc/NEWS.md +++ b/contrib/bc/NEWS.md @@ -1,1432 +1,1450 @@ # News +## 6.2.4 + +This is a production release that fixes a test failure that happens when +`tests/bc/scripts/timeconst.bc` doesn't exist. This should only affect +packagers. + +This bug happened because I forgot something I added in the previous release: +better error checking in tests to help packagers. Unfortunately, I was too +zealous with the error checking. + +## 6.2.3 + +This is a production release that moves `bc` to . + +That's all it does: update links. Users do ***NOT*** need to upgrade; there are +redirects that will stay in place indefinitely. This release is only for new +users. + ## 6.2.2 This is a production release that fixes a bug. The bug was that if an array element was used as a parameter, and then a later parameter had the same name as the array whose element was used, `bc` would grab the element from the new array parameter, not the actual element from before the function call. ## 6.2.1 This is a production release with one bug fix for a memory bug in history. ## 6.2.0 This is a production release with a new feature and a few bug fixes. The bug fixes include: * A crash when `bc` and `dc` are built using editline, but history is not activated. * A missing local in the `uint*()` family of functions in the extended math library. * A failure to clear the tail call list in `dc` on error. * A crash when attempting to swap characters in command-line history when no characters exist. * `SIGWINCH` was activated even when history was not. The new feature is that stack traces are now given for runtime errors. In debug mode, the C source file and line of errors are given as well. ## 6.1.1 This is a production release that fixes a build issue with predefined builds and generated tests. ## 6.1.0 This is a production release that fixes a discrepancy from the `bc` standard, a couple of memory bugs, and adds new features. The discrepancy from the `bc` standard was with regards to the behavior of the `quit` command. This `bc` used to quit whenever it encountered `quit` during parsing, even if it was parsing a full file. Now, `bc` only quits when encountering `quit` *after* it has executed all executable statements up to that point. This behavior is slightly different from GNU `bc`, but users will only notice the difference if they put `quit` on the same line as other statements. The first memory bug could be reproduced by assigning a string to a non-local variable in a function, then redefining the function with use of the same non-local variable, which would still refer to a string in the previous version of the function. The second memory bug was caused by passing an array argument to the `asciify()` built-in function. In certain cases, that was wrongly allowed, and the interpreter just assumed everything was correct and accessed memory. Now that arrays are allowed as arguments (see below), this is not an issue. The first feature was the addition of the `is_number()` built-in function (`u` in `dc`) that returns 1 if the runtime argument is a number and 0 otherwise. The second feature was the addition of the `is_string()` built-in function (`t` in `dc`) that returns 1 if the runtime argument is a string and 0 otherwise. These features were added because I realized that type-checking is necessary now that strings can be assigned to variables in `bc` and because they've always been assignable to variables in `dc`. The last added feature is the ability of the `asciify()` built-in function in `bc` to convert a full array of numbers into a string. This means that character-by-character printing will not be necessary, and more strings than just single-character ones will be able to be created. ## 6.0.4 This is a production release that most users will not need to upgrade to. This fixes a build bug for `bcl` only on OpenBSD. Users that do not need `bcl` or have not run into build errors with `bcl` do ***NOT*** need to upgrade. ## 6.0.3 This is a production release that fixes a build bug for cross-compilation. Users that do not need cross-compilation do ***NOT*** need to upgrade. ## 6.0.2 This is a production release that fixes two bugs: * The `-l` option overrode the `-S` option. * A double-free and crash when sending a `SIGINT` while executing expressions given on the command-line. ## 6.0.1 This is a production release that fixes memory bugs and memory leaks in `bcl`. Users that do not use `bcl` (use only `bc` and/or `dc`) do ***NOT*** need to upgrade. These happened because I was unaware that the `bcl` test was not hooked into the Valgrind test infrastructure. Then, when I ran the release script, which tests everything under Valgrind (or so I thought), it caught nothing, and I thought it was safe. But it was not. Nevertheless, I have now run it under Valgrind and fixed all of the memory bugs (caused by not using `memset()` where I should have but previously didn't have to) and memory leaks. ## 6.0.0 This is a production release that fixes an oversight in the `bc` parser (that sometimes caused the wrong error message) and adds a feature for compatibility with the BSD `bc` and `dc`: turning off digit clamping when parsing numbers. The default for clamping can be set during the build (see the [build manual][13]), it can be set with the `BC_DIGIT_CLAMP` and `DC_DIGIT_CLAMP` environment variables, and it can be set with the `-c` and `-C` command-line options. Turning off clamping was also added to the `bcl` library. In addition, signal handling was removed from the `bcl` library in order to add the capability for multi-threading. This required a major version bump. I apologize to all library users (I don't know of any), but signals and threads do not play well together. To help with building, a convenience option (`-p`) to `configure.sh` was added to build a `bc` and `dc` that is by default compatible with either the BSD `bc` and `dc` or the GNU `bc` and `dc`. ## 5.3.3 This is a production release that fixes a build problem in the FreeBSD base system. All other users do **NOT** need to upgrade. ## 5.3.2 This is a production release that fixes prompt bugs with editline and readline where the `BC_PROMPT` environment variable was not being respected. This also fixes editline and readline output on `EOF`. ## 5.3.1 This is a production release that fixes a build problem in the FreeBSD base system, as well as a problem in the `en_US` locale. If you don't have problems with either, you do not need to upgrade. ## 5.3.0 This is a production release that adds features and has a few bug fixes. First, support for editline and readline history has been added. To use editline, pass `-e` to `configure.sh`, and to use readline, pass `-r`. Second, history support for Windows has been fixed and re-enabled. Third, command-line options to set `scale`, `ibase`, `obase`, and `seed` were added. This was requested long ago, and I originally disagreed with the idea. Fourth, the manuals had typos and were missing information. That has been fixed. Fifth, the manuals received different formatting to be more readable as manpages. ## 5.2.5 This is a production release that fixes this `bc`'s behavior on `^D` to match GNU `bc`. ## 5.2.4 This is a production release that fixes two bugs in history: * Without prompt, the cursor could not be placed on the first character in a line. * Home and End key handling in `tmux` was fixed. Any users that do not care about these improvements do not need to upgrade. ## 5.2.3 This is a production release that fixes one bug, a parse error when passing a file to `bc` using `-f` if that file had a multiline comment or string in it. ## 5.2.2 This is a production release that fixes one bug, a segmentation fault if `argv[0]` equals `NULL`. This is not a critical bug; there will be no vulnerability as far as I can tell. There is no need to update if you do not wish to. ## 5.2.1 This is a production release that fixes two parse bugs when in POSIX standard mode. One of these bugs was due to a quirk of the POSIX grammar, and the other was because `bc` was too strict. ## 5.2.0 This is a production release that adds a new feature, fixes some bugs, and adds out-of-source builds and a `pkg-config` file for `bcl`. The new feature is the ability to turn off exiting on expressions. It is also possible to set the default using `configure.sh`. This behavior used to exist with the `BC_EXPR_EXIT` environment variable, which is now used again. Bugs fixed include: * Some possible race conditions with error handling. * Install and uninstall targets for `bcl` did not work. ## 5.1.1 This is a production release that completes a bug fix from `5.1.0`. The bug exists in all versions of `bc`. The bug was that `if` statements without `else` statements would not be handled correctly at the end of files or right before a function definition. ## 5.1.0 This is a production release with some fixes and new features. * Fixed a bug where an `if` statement without an `else` before defining a function caused an error. * Fixed a bug with the `bc` banner and `-q`. * Fixed a bug on Windows where files were not read correctly. * Added a command-line flag (`-z`) to make `bc` and `dc` print leading zeroes on numbers `-1 < x < 1`. * Added four functions to `lib2.bc` (`plz()`, `plznl()`, `pnlz()`, and `pnlznl()`) to allow printing numbers with or without leading zeros, despite the use of `-z` or not. * Added builtin functions to query global state like line length, global stacks, and leading zeroes. * Added a command-line flag (`-L`) to disable wrapping when printing numbers. * Improved builds on Windows. ## 5.0.2 This is a production release with one fix for a flaky test. If you have not experienced problems with the test suite, you do ***NOT*** need to upgrade. The test was one that tested whether `bc` fails gracefully when it can't allocate memory. Unfortunately, there are cases when Linux and FreeBSD lie and pretend to allocate the memory. The reason they do this is because a lot of programs don't use all of the memory they allocate, so those OS's usually get away with it. However, this `bc` uses all of the memory it allocates (at least at page granularity), so when it tries to use the memory, FreeBSD and Linux kill it. This only happens sometimes, however. Other times (on my machine), they do, in fact, refuse the request. So I changed the test to not test for that because I think the graceful failure code won't really change much. ## 5.0.1 This is a production release with two fixes: * Fix for the build on Mac OSX. * Fix for the build on Android. Users that do not use those platforms do ***NOT*** need to update. ## 5.0.0 This is a major production release with several changes: * Added support for OpenBSD's `pledge()` and `unveil()`. * Fixed print bug where a backslash newline combo was printed even if only one digit was left, something I blindly copied from GNU `bc`, like a fool. * Fixed bugs in the manuals. * Fixed a possible multiplication overflow in power. * Temporary numbers are garbage collected if allocation fails, and the allocation is retried. This is to make `bc` and `dc` more resilient to running out of memory. * Limited the number of temporary numbers and made the space for them static so that allocating more space for them cannot fail. * Allowed integers with non-zero `scale` to be used with power, places, and shift operators. * Added greatest common divisor and least common multiple to `lib2.bc`. * Added `SIGQUIT` handling to history. * Added a command to `dc` (`y`) to get the length of register stacks. * Fixed multi-digit bugs in `lib2.bc`. * Removed the no prompt build option. * Created settings that builders can set defaults for and users can set their preferences for. This includes the `bc` banner, resetting on `SIGINT`, TTY mode, and prompt. * Added history support to Windows. * Fixed bugs with the handling of register names in `dc`. * Fixed bugs with multi-line comments and strings in both calculators. * Added a new error type and message for `dc` when register stacks don't have enough items. * Optimized string allocation. * Made `bc` and `dc` UTF-8 capable. * Fixed a bug with `void` functions. * Fixed a misspelled symbol in `bcl`. This is technically a breaking change, which requires this to be `5.0.0`. * Added the ability for users to get the copyright banner back. * Added the ability for users to have `bc` and `dc` quit on `SIGINT`. * Added the ability for users to disable prompt and TTY mode by environment variables. * Added the ability for users to redefine keywords. This is another reason this is `5.0.0`. * Added `dc`'s modular exponentiation and divmod to `bc`. * Added the ability to assign strings to variables and array elements and pass them to functions in `bc`. * Added `dc`'s asciify command and stream printing to `bc`. * Added a command to `dc` (`Y`) to get the length of an array. * Added a command to `dc` (`,`) to get the depth of the execution stack. * Added bitwise and, or, xor, left shift, right shift, reverse, left rotate, right rotate, and mod functions to `lib2.bc`. * Added the functions `s2u(x)` and `s2un(x,n)`, to `lib2.bc`. ## 4.0.2 This is a production release that fixes two bugs: 1. If no files are used and the first statement on `stdin` is invalid, `scale` would not be set to `20` even if `-l` was used. 2. When using history, `bc` failed to respond properly to `SIGSTOP` and `SIGTSTP`. ## 4.0.1 This is a production release that only adds one thing: flushing output when it is printed with a print statement. ## 4.0.0 This is a production release with many fixes, a new command-line option, and a big surprise: * A bug was fixed in `dc`'s `P` command where the item on the stack was *not* popped. * Various bugs in the manuals have been fixed. * A known bug was fixed where history did not interact well with prompts printed by user code without newlines. * A new command-line option, `-R` and `--no-read-prompt` was added to disable just the prompt when using `read()` (`bc`) or `?` (`dc`). * And finally, **official support for Windows was added**. The last item is why this is a major version bump. Currently, only one set of build options (extra math and prompt enabled, history and NLS/locale support disabled, both calculators enabled) is supported on Windows. However, both debug and release builds are supported. In addition, Windows builds are supported for the the library (`bcl`). For more details about how to build on Windows, see the [README][5] or the [build manual][13]. ## 3.3.4 This is a production release that fixes a small bug. The bug was that output was not flushed before a `read()` call, so prompts without a newline on the end were not flushed before the `read()` call. This is such a tiny bug that users only need to upgrade if they are affected. ## 3.3.3 This is a production release with one tweak and fixes for manuals. The tweak is that `length(0)` returns `1` instead of `0`. In `3.3.1`, I changed it so `length(0.x)`, where `x` could be any number of digits, returned the `scale`, but `length(0)` still returned `0` because I believe that `0` has `0` significant digits. After request of FreeBSD and considering the arguments of a mathematician, compatibility with other `bc`'s, and the expectations of users, I decided to make the change. The fixes for manuals fixed a bug where `--` was rendered as `-`. ## 3.3.2 This is a production release that fixes a divide-by-zero bug in `root()` in the [extended math library][16]. All previous versions with `root()` have the bug. ## 3.3.1 This is a production release that fixes a bug. The bug was in the reporting of number length when the value was 0. ## 3.3.0 This is a production release that changes one behavior and fixes documentation bugs. The changed behavior is the treatment of `-e` and `-f` when given through `BC_ENV_ARGS` or `DC_ENV_ARGS`. Now `bc` and `dc` do not exit when those options (or their equivalents) are given through those environment variables. However, `bc` and `dc` still exit when they or their equivalents are given on the command-line. ## 3.2.7 This is a production release that removes a small non-portable shell operation in `configure.sh`. This problem was only noticed on OpenBSD, not FreeBSD or Linux. Non-OpenBSD users do ***NOT*** need to upgrade, although NetBSD users may also need to upgrade. ## 3.2.6 This is a production release that fixes the build on FreeBSD. There was a syntax error in `configure.sh` that the Linux shell did not catch, and FreeBSD depends on the existence of `tests/all.sh`. All users that already upgraded to `3.2.5` should update to this release, with my apologies for the poor release of `3.2.5`. Other users should skip `3.2.5` in favor of this version. ## 3.2.5 This is a production release that fixes several bugs and adds a couple small things. The two most important bugs were bugs that causes `dc` to access memory out-of-bounds (crash in debug builds). This was found by upgrading to `afl++` from `afl`. Both were caused by a failure to distinguish between the same two cases. Another bug was the failure to put all of the licenses in the `LICENSE.md` file. Third, some warnings by `scan-build` were found and eliminated. This needed one big change: `bc` and `dc` now bail out as fast as possible on fatal errors instead of unwinding the stack. Fourth, the pseudo-random number now attempts to seed itself with `/dev/random` if `/dev/urandom` fails. Finally, this release has a few quality-of-life changes to the build system. The usage should not change at all; the only thing that changed was making sure the `Makefile.in` was written to rebuild properly when headers changed and to not rebuild when not necessary. ## 3.2.4 This is a production release that fixes a warning on `gcc` 6 or older, which does not have an attribute that is used. Users do ***NOT*** need to upgrade if they don't use `gcc` 6 or older. ## 3.2.3 This is a production release that fixes a bug in `gen/strgen.sh`. I recently changed `gen/strgen.c`, but I did not change `gen/strgen.sh`. Users that do not use `gen/strgen.sh` do not need to upgrade. ## 3.2.2 This is a production release that fixes a portability bug in `configure.sh`. The bug was using the GNU `find` extension `-wholename`. ## 3.2.1 This is a production release that has one fix for `bcl(3)`. It is technically not a bug fix since the behavior is undefined, but the `BclNumber`s that `bcl_divmod()` returns will be set to `BCL_ERROR_INVALID_NUM` if there is an error. Previously, they were not set. ## 3.2.0 This is a production release that has one bug fix and a major addition. The bug fix was a missing `auto` variable in the bessel `j()` function in the math library. The major addition is a way to build a version of `bc`'s math code as a library. This is done with the `-a` option to `configure.sh`. The API for the library can be read in `./manuals/bcl.3.md` or `man bcl` once the library is installed with `make install`. This library was requested by developers before I even finished version 1.0, but I could not figure out how to do it until now. If the library has API breaking changes, the major version of `bc` will be incremented. ## 3.1.6 This is a production release that fixes a new warning from Clang 12 for FreeBSD and also removes some possible undefined behavior found by UBSan that compilers did not seem to take advantage of. Users do ***NOT*** need to upgrade, if they do not want to. ## 3.1.5 This is a production release that fixes the Chinese locales (which caused `bc` to crash) and a crash caused by `bc` executing code when it should not have been able to. ***ALL USERS SHOULD UPGRADE.*** ## 3.1.4 This is a production release that fixes one bug, changes two behaviors, and removes one environment variable. The bug is like the one in the last release except it applies if files are being executed. I also made the fix more general. The behavior that was changed is that `bc` now exits when given `-e`, `-f`, `--expression` or `--file`. However, if the last one of those is `-f-` (using `stdin` as the file), `bc` does not exit. If `-f-` exists and is not the last of the `-e` and `-f` options (and equivalents), `bc` gives a fatal error and exits. Next, I removed the `BC_EXPR_EXIT` and `DC_EXPR_EXIT` environment variables since their use is not needed with the behavior change. Finally, I made it so `bc` does not print the header, though the `-q` and `--quiet` options were kept for compatibility with GNU `bc`. ## 3.1.3 This is a production release that fixes one minor bug: if `bc` was invoked like the following, it would error: ``` echo "if (1 < 3) 1" | bc ``` Unless users run into this bug, they do not need to upgrade, but it is suggested that they do. ## 3.1.2 This is a production release that adds a way to install *all* locales. Users do ***NOT*** need to upgrade. For package maintainers wishing to make use of the change, just pass `-l` to `configure.sh`. ## 3.1.1 This is a production release that adds two Spanish locales. Users do ***NOT*** need to upgrade, unless they want those locales. ## 3.1.0 This is a production release that adjusts one behavior, fixes eight bugs, and improves manpages for FreeBSD. Because this release fixes bugs, **users and package maintainers should update to this version as soon as possible**. The behavior that was adjusted was how code from the `-e` and `-f` arguments (and equivalents) were executed. They used to be executed as one big chunk, but in this release, they are now executed line-by-line. The first bug fix in how output to `stdout` was handled in `SIGINT`. If a `SIGINT` came in, the `stdout` buffer was not correctly flushed. In fact, a clean-up function was not getting called. This release fixes that bug. The second bug is in how `dc` handled input from `stdin`. This affected `bc` as well since it was a mishandling of the `stdin` buffer. The third fixed bug was that `bc` and `dc` could `abort()` (in debug mode) when receiving a `SIGTERM`. This one was a race condition with pushing and popping items onto and out of vectors. The fourth bug fixed was that `bc` could leave extra items on the stack and thus, not properly clean up some memory. (The memory would still get `free()`'ed, but it would not be `free()`'ed when it could have been.) The next two bugs were bugs in `bc`'s parser that caused crashes when executing the resulting code. The last two bugs were crashes in `dc` that resulted from mishandling of strings. The manpage improvement was done by switching from [ronn][20] to [Pandoc][21] to generate manpages. Pandoc generates much cleaner manpages and doesn't leave blank lines where they shouldn't be. ## 3.0.3 This is a production release that adds one new feature: specific manpages. Before this release, `bc` and `dc` only used one manpage each that referred to various build options. This release changes it so there is one manpage set per relevant build type. Each manual only has information about its particular build, and `configure.sh` selects the correct set for install. ## 3.0.2 This is a production release that adds `utf8` locale symlinks and removes an unused `auto` variable from the `ceil()` function in the [extended math library][16]. Users do ***NOT*** need to update unless they want the locales. ## 3.0.1 This is a production release with two small changes. Users do ***NOT*** need to upgrade to this release; however, if they haven't upgraded to `3.0.0` yet, it may be worthwhile to upgrade to this release. The first change is fixing a compiler warning on FreeBSD with strict warnings on. The second change is to make the new implementation of `ceil()` in `lib2.bc` much more efficient. ## 3.0.0 *Notes for package maintainers:* *First, the `2.7.0` release series saw a change in the option parsing. This made me change one error message and add a few others. The error message that was changed removed one format specifier. This means that `printf()` will seqfault on old locale files. Unfortunately, `bc` cannot use any locale files except the global ones that are already installed, so it will use the previous ones while running tests during install. **If `bc` segfaults while running arg tests when updating, it is because the global locale files have not been replaced. Make sure to either prevent the test suite from running on update or remove the old locale files before updating.** (Removing the locale files can be done with `make uninstall` or by running the [`locale_uninstall.sh`][22] script.) Once this is done, `bc` should install without problems.* *Second, **the option to build without signal support has been removed**. See below for the reasons why.* This is a production release with some small bug fixes, a few improvements, three major bug fixes, and a complete redesign of `bc`'s error and signal handling. **Users and package maintainers should update to this version as soon as possible.** The first major bug fix was in how `bc` executed files. Previously, a whole file was parsed before it was executed, but if a function is defined *after* code, especially if the function definition was actually a redefinition, and the code before the definition referred to the previous function, this `bc` would replace the function before executing any code. The fix was to make sure that all code that existed before a function definition was executed. The second major bug fix was in `bc`'s `lib2.bc`. The `ceil()` function had a bug where a `0` in the decimal place after the truncation position, caused it to output the wrong numbers if there was any non-zero digit after. The third major bug is that when passing parameters to functions, if an expression included an array (not an array element) as a parameter, it was accepted, when it should have been rejected. It is now correctly rejected. Beyond that, this `bc` got several improvements that both sped it up, improved the handling of signals, and improved the error handling. First, the requirements for `bc` were pushed back to POSIX 2008. `bc` uses one function, `strdup()`, which is not in POSIX 2001, and it is in the X/Open System Interfaces group 2001. It is, however, in POSIX 2008, and since POSIX 2008 is old enough to be supported anywhere that I care, that should be the requirement. Second, the BcVm global variable was put into `bss`. This actually slightly reduces the size of the executable from a massive code shrink, and it will stop `bc` from allocating a large set of memory when `bc` starts. Third, the default Karatsuba length was updated from 64 to 32 after making the optimization changes below, since 32 is going to be better than 64 after the changes. Fourth, Spanish translations were added. Fifth, the interpreter received a speedup to make performance on non-math-heavy scripts more competitive with GNU `bc`. While improvements did, in fact, get it much closer (see the [benchmarks][19]), it isn't quite there. There were several things done to speed up the interpreter: First, several small inefficiencies were removed. These inefficiencies included calling the function `bc_vec_pop(v)` twice instead of calling `bc_vec_npop(v, 2)`. They also included an extra function call for checking the size of the stack and checking the size of the stack more than once on several operations. Second, since the current `bc` function is the one that stores constants and strings, the program caches pointers to the current function's vectors of constants and strings to prevent needing to grab the current function in order to grab a constant or a string. Third, `bc` tries to reuse `BcNum`'s (the internal representation of arbitary-precision numbers). If a `BcNum` has the default capacity of `BC_NUM_DEF_SIZE` (32 on 64-bit and 16 on 32-bit) when it is freed, it is added to a list of available `BcNum`'s. And then, when a `BcNum` is allocated with a capacity of `BC_NUM_DEF_SIZE` and any `BcNum`'s exist on the list of reusable ones, one of those ones is grabbed instead. In order to support these changes, the `BC_NUM_DEF_SIZE` was changed. It used to be 16 bytes on all systems, but it was changed to more closely align with the minimum allocation size on Linux, which is either 32 bytes (64-bit musl), 24 bytes (64-bit glibc), 16 bytes (32-bit musl), or 12 bytes (32-bit glibc). Since these are the minimum allocation sizes, these are the sizes that would be allocated anyway, making it worth it to just use the whole space, so the value of `BC_NUM_DEF_SIZE` on 64-bit systems was changed to 32 bytes. On top of that, at least on 64-bit, `BC_NUM_DEF_SIZE` supports numbers with either 72 integer digits or 45 integer digits and 27 fractional digits. This should be more than enough for most cases since `bc`'s default `scale` values are 0 or 20, meaning that, by default, it has at most 20 fractional digits. And 45 integer digits are *a lot*; it's enough to calculate the amount of mass in the Milky Way galaxy in kilograms. Also, 72 digits is enough to calculate the diameter of the universe in Planck lengths. (For 32-bit, these numbers are either 32 integer digits or 12 integer digits and 20 fractional digits. These are also quite big, and going much bigger on a 32-bit system seems a little pointless since 12 digits is just under a trillion and 20 fractional digits is still enough for about any use since `10^-20` light years is just under a millimeter.) All of this together means that for ordinary uses, and even uses in scientific work, the default number size will be all that is needed, which means that nearly all, if not all, numbers will be reused, relieving pressure on the system allocator. I did several experiments to find the changes that had the most impact, especially with regard to reusing `BcNum`'s. One was putting `BcNum`'s into buckets according to their capacity in powers of 2 up to 512. That performed worse than `bc` did in `2.7.2`. Another was putting any `BcNum` on the reuse list that had a capacity of `BC_NUM_DEF_SIZE * 2` and reusing them for `BcNum`'s that requested `BC_NUM_DEF_SIZE`. This did reduce the amount of time spent, but it also spent a lot of time in the system allocator for an unknown reason. (When using `strace`, a bunch more `brk` calls showed up.) Just reusing `BcNum`'s that had exactly `BC_NUM_DEF_SIZE` capacity spent the smallest amount of time in both user and system time. This makes sense, especially with the changes to make `BC_NUM_DEF_SIZE` bigger on 64-bit systems, since the vast majority of numbers will only ever use numbers with a size less than or equal to `BC_NUM_DEF_SIZE`. Last of all, `bc`'s signal handling underwent a complete redesign. (This is the reason that this version is `3.0.0` and not `2.8.0`.) The change was to move from a polling approach to signal handling to an interrupt-based approach. Previously, every single loop condition had a check for signals. I suspect that this could be expensive when in tight loops. Now, the signal handler just uses `longjmp()` (actually `siglongjmp()`) to start an unwinding of the stack until it is stopped or the stack is unwound to `main()`, which just returns. If `bc` is currently executing code that cannot be safely interrupted (according to POSIX), then signals are "locked." The signal handler checks if the lock is taken, and if it is, it just sets the status to indicate that a signal arrived. Later, when the signal lock is released, the status is checked to see if a signal came in. If so, the stack unwinding starts. This design eliminates polling in favor of maintaining a stack of `jmp_buf`'s. This has its own performance implications, but it gives better interaction. And the cost of pushing and popping a `jmp_buf` in a function is paid at most twice. Most functions do not pay that price, and most of the rest only pay it once. (There are only some 3 functions in `bc` that push and pop a `jmp_buf` twice.) As a side effect of this change, I had to eliminate the use of `stdio.h` in `bc` because `stdio` does not play nice with signals and `longjmp()`. I implemented custom I/O buffer code that takes a fraction of the size. This means that static builds will be smaller, but non-static builds will be bigger, though they will have less linking time. This change is also good because my history implementation was already bypassing `stdio` for good reasons, and unifying the architecture was a win. Another reason for this change is that my `bc` should *always* behave correctly in the presence of signals like `SIGINT`, `SIGTERM`, and `SIGQUIT`. With the addition of my own I/O buffering, I needed to also make sure that the buffers were correctly flushed even when such signals happened. For this reason, I **removed the option to build without signal support**. As a nice side effect of this change, the error handling code could be changed to take advantage of the stack unwinding that signals used. This means that signals and error handling use the same code paths, which means that the stack unwinding is well-tested. (Errors are tested heavily in the test suite.) It also means that functions do not need to return a status code that ***every*** caller needs to check. This eliminated over 100 branches that simply checked return codes and then passed that return code up the stack if necessary. The code bloat savings from this is at least 1700 bytes on `x86_64`, *before* taking into account the extra code from removing `stdio.h`. ## 2.7.2 This is a production release with one major bug fix. The `length()` built-in function can take either a number or an array. If it takes an array, it returns the length of the array. Arrays can be passed by reference. The bug is that the `length()` function would not properly dereference arrays that were references. This is a bug that affects all users. **ALL USERS SHOULD UPDATE `bc`**. ## 2.7.1 This is a production release with fixes for new locales and fixes for compiler warnings on FreeBSD. ## 2.7.0 This is a production release with a bug fix for Linux, new translations, and new features. Bug fixes: * Option parsing in `BC_ENV_ARGS` was broken on Linux in 2.6.1 because `glibc`'s `getopt_long()` is broken. To get around that, and to support long options on every platform, an adapted version of [`optparse`][17] was added. Now, `bc` does not even use `getopt()`. * Parsing `BC_ENV_ARGS` with quotes now works. It isn't the smartest, but it does the job if there are spaces in file names. The following new languages are supported: * Dutch * Polish * Russian * Japanes * Simplified Chinese All of these translations were generated using [DeepL][18], so improvements are welcome. There is only one new feature: **`bc` now has a built-in pseudo-random number generator** (PRNG). The PRNG is seeded, making it useful for applications where `/dev/urandom` does not work because output needs to be reproducible. However, it also uses `/dev/urandom` to seed itself by default, so it will start with a good seed by default. It also outputs 32 bits on 32-bit platforms and 64 bits on 64-bit platforms, far better than the 15 bits of C's `rand()` and `bash`'s `$RANDOM`. In addition, the PRNG can take a bound, and when it gets a bound, it automatically adjusts to remove bias. It can also generate numbers of arbitrary size. (As of the time of release, the largest pseudo-random number generated by this `bc` was generated with a bound of `2^(2^20)`.) ***IMPORTANT: read the [`bc` manual][9] and the [`dc` manual][10] to find out exactly what guarantees the PRNG provides. The underlying implementation is not guaranteed to stay the same, but the guarantees that it provides are guaranteed to stay the same regardless of the implementation.*** On top of that, four functions were added to `bc`'s [extended math library][16] to make using the PRNG easier: * `frand(p)`: Generates a number between `[0,1)` to `p` decimal places. * `ifrand(i, p)`: Generates an integer with bound `i` and adds it to `frand(p)`. * `srand(x)`: Randomizes the sign of `x`. In other words, it flips the sign of `x` with probability `0.5`. * `brand()`: Returns a random boolean value (either `0` or `1`). ## 2.6.1 This is a production release with a bug fix for FreeBSD. The bug was that when `bc` was built without long options, it would give a fatal error on every run. This was caused by a mishandling of `optind`. ## 2.6.0 This release is a production release ***with no bugfixes***. If you do not want to upgrade, you don't have to. No source code changed; the only thing that changed was `lib2.bc`. This release adds one function to the [extended math library][16]: `p(x, y)`, which calculates `x` to the power of `y`, whether or not `y` is an integer. (The `^` operator can only accept integer powers.) This release also includes a couple of small tweaks to the [extended math library][16], mostly to fix returning numbers with too high of `scale`. ## 2.5.3 This release is a production release which addresses inconsistencies in the Portuguese locales. No `bc` code was changed. The issues were that the ISO files used different naming, and also that the files that should have been symlinks were not. I did not catch that because GitHub rendered them the exact same way. ## 2.5.2 This release is a production release. No code was changed, but the build system was changed to allow `CFLAGS` to be given to `CC`, like this: ``` CC="gcc -O3 -march=native" ./configure.sh ``` If this happens, the flags are automatically put into `CFLAGS`, and the compiler is set appropriately. In the example above this means that `CC` will be "gcc" and `CFLAGS` will be "-O3 -march=native". This behavior was added to conform to GNU autotools practices. ## 2.5.1 This is a production release which addresses portability concerns discovered in the `bc` build system. No `bc` code was changed. * Support for Solaris SPARC and AIX were added. * Minor documentations edits were performed. * An option for `configure.sh` was added to disable long options if `getopt_long()` is missing. ## 2.5.0 This is a production release with new translations. No code changed. The translations were contributed by [bugcrazy][15], and they are for Portuguese, both Portugal and Brazil locales. ## 2.4.0 This is a production release primarily aimed at improving `dc`. * A couple of copy and paste errors in the [`dc` manual][10] were fixed. * `dc` startup was optimized by making sure it didn't have to set up `bc`-only things. * The `bc` `&&` and `||` operators were made available to `dc` through the `M` and `m` commands, respectively. * `dc` macros were changed to be tail call-optimized. The last item, tail call optimization, means that if the last thing in a macro is a call to another macro, then the old macro is popped before executing the new macro. This change was made to stop `dc` from consuming more and more memory as macros are executed in a loop. The `q` and `Q` commands still respect the "hidden" macros by way of recording how many macros were removed by tail call optimization. ## 2.3.2 This is a production release meant to fix warnings in the Gentoo `ebuild` by making it possible to disable binary stripping. Other users do *not* need to upgrade. ## 2.3.1 This is a production release. It fixes a bug that caused `-1000000000 < -1` to return `0`. This only happened with negative numbers and only if the value on the left was more negative by a certain amount. That said, this bug *is* a bad bug, and needs to be fixed. **ALL USERS SHOULD UPDATE `bc`**. ## 2.3.0 This is a production release with changes to the build system. ## 2.2.0 This release is a production release. It only has new features and performance improvements. 1. The performance of `sqrt(x)` was improved. 2. The new function `root(x, n)` was added to the extended math library to calculate `n`th roots. 3. The new function `cbrt(x)` was added to the extended math library to calculate cube roots. ## 2.1.3 This is a non-critical release; it just changes the build system, and in non-breaking ways: 1. Linked locale files were changed to link to their sources with a relative link. 2. A bug in `configure.sh` that caused long option parsing to fail under `bash` was fixed. ## 2.1.2 This release is not a critical release. 1. A few codes were added to history. 2. Multiplication was optimized a bit more. 3. Addition and subtraction were both optimized a bit more. ## 2.1.1 This release contains a fix for the test suite made for Linux from Scratch: now the test suite prints `pass` when a test is passed. Other than that, there is no change in this release, so distros and other users do not need to upgrade. ## 2.1.0 This release is a production release. The following bugs were fixed: 1. A `dc` bug that caused stack mishandling was fixed. 2. A warning on OpenBSD was fixed. 3. Bugs in `ctrl+arrow` operations in history were fixed. 4. The ability to paste multiple lines in history was added. 5. A `bc` bug, mishandling of array arguments to functions, was fixed. 6. A crash caused by freeing the wrong pointer was fixed. 7. A `dc` bug where strings, in a rare case, were mishandled in parsing was fixed. In addition, the following changes were made: 1. Division was slightly optimized. 2. An option was added to the build to disable printing of prompts. 3. The special case of empty arguments is now handled. This is to prevent errors in scripts that end up passing empty arguments. 4. A harmless bug was fixed. This bug was that, with the pop instructions (mostly) removed (see below), `bc` would leave extra values on its stack for `void` functions and in a few other cases. These extra items would not affect anything put on the stack and would not cause any sort of crash or even buggy behavior, but they would cause `bc` to take more memory than it needed. On top of the above changes, the following optimizations were added: 1. The need for pop instructions in `bc` was removed. 2. Extra tests on every iteration of the interpreter loop were removed. 3. Updating function and code pointers on every iteration of the interpreter loop was changed to only updating them when necessary. 4. Extra assignments to pointers were removed. Altogether, these changes sped up the interpreter by around 2x. ***NOTE***: This is the last release with new features because this `bc` is now considered complete. From now on, only bug fixes and new translations will be added to this `bc`. ## 2.0.3 This is a production, bug-fix release. Two bugs were fixed in this release: 1. A rare and subtle signal handling bug was fixed. 2. A misbehavior on `0` to a negative power was fixed. The last bug bears some mentioning. When I originally wrote power, I did not thoroughly check its error cases; instead, I had it check if the first number was `0` and then if so, just return `0`. However, `0` to a negative power means that `1` will be divided by `0`, which is an error. I caught this, but only after I stopped being cocky. You see, sometime later, I had noticed that GNU `bc` returned an error, correctly, but I thought it was wrong simply because that's not what my `bc` did. I saw it again later and had a double take. I checked for real, finally, and found out that my `bc` was wrong all along. That was bad on me. But the bug was easy to fix, so it is fixed now. There are two other things in this release: 1. Subtraction was optimized by [Stefan Eßer][14]. 2. Division was also optimized, also by Stefan Eßer. ## 2.0.2 This release contains a fix for a possible overflow in the signal handling. I would be surprised if any users ran into it because it would only happen after 2 billion (`2^31-1`) `SIGINT`'s, but I saw it and had to fix it. ## 2.0.1 This release contains very few things that will apply to any users. 1. A slight bug in `dc`'s interactive mode was fixed. 2. A bug in the test suite that was only triggered on NetBSD was fixed. 3. **The `-P`/`--no-prompt` option** was added for users that do not want a prompt. 4. A `make check` target was added as an alias for `make test`. 5. `dc` got its own read prompt: `?> `. ## 2.0.0 This release is a production release. This release is also a little different from previous releases. From here on out, I do not plan on adding any more features to this `bc`; I believe that it is complete. However, there may be bug fix releases in the future, if I or any others manage to find bugs. This release has only a few new features: 1. `atan2(y, x)` was added to the extended math library as both `a2(y, x)` and `atan2(y, x)`. 2. Locales were fixed. 3. A **POSIX shell-compatible script was added as an alternative to compiling `gen/strgen.c`** on a host machine. More details about making the choice between the two can be found by running `./configure.sh --help` or reading the [build manual][13]. 4. Multiplication was optimized by using **diagonal multiplication**, rather than straight brute force. 5. The `locale_install.sh` script was fixed. 6. `dc` was given the ability to **use the environment variable `DC_ENV_ARGS`**. 7. `dc` was also given the ability to **use the `-i` or `--interactive`** options. 8. Printing the prompt was fixed so that it did not print when it shouldn't. 9. Signal handling was fixed. 10. **Handling of `SIGTERM` and `SIGQUIT`** was fixed. 11. The **built-in functions `maxibase()`, `maxobase()`, and `maxscale()`** (the commands `T`, `U`, `V` in `dc`, respectively) were added to allow scripts to query for the max allowable values of those globals. 12. Some incompatibilities with POSIX were fixed. In addition, this release is `2.0.0` for a big reason: the internal format for numbers changed. They used to be a `char` array. Now, they are an array of larger integers, packing more decimal digits into each integer. This has delivered ***HUGE*** performance improvements, especially for multiplication, division, and power. This `bc` should now be the fastest `bc` available, but I may be wrong. ## 1.2.8 This release contains a fix for a harmless bug (it is harmless in that it still works, but it just copies extra data) in the [`locale_install.sh`][12] script. ## 1.2.7 This version contains fixes for the build on Arch Linux. ## 1.2.6 This release removes the use of `local` in shell scripts because it's not POSIX shell-compatible, and also updates a man page that should have been updated a long time ago but was missed. ## 1.2.5 This release contains some missing locale `*.msg` files. ## 1.2.4 This release contains a few bug fixes and new French translations. ## 1.2.3 This release contains a fix for a bug: use of uninitialized data. Such data was only used when outputting an error message, but I am striving for perfection. As Michelangelo said, "Trifles make perfection, and perfection is no trifle." ## 1.2.2 This release contains fixes for OpenBSD. ## 1.2.1 This release contains bug fixes for some rare bugs. ## 1.2.0 This is a production release. There have been several changes since `1.1.0`: 1. The build system had some changes. 2. Locale support has been added. (Patches welcome for translations.) 3. **The ability to turn `ibase`, `obase`, and `scale` into stacks** was added with the `-g` command-line option. (See the [`bc` manual][9] for more details.) 4. Support for compiling on Mac OSX out of the box was added. 5. The extended math library got `t(x)`, `ceil(x)`, and some aliases. 6. The extended math library also got `r2d(x)` (for converting from radians to degrees) and `d2r(x)` (for converting from degrees to radians). This is to allow using degrees with the standard library. 7. Both calculators now accept numbers in **scientific notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details. 8. Both calculators can **output in either scientific or engineering notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details. 9. Some inefficiencies were removed. 10. Some bugs were fixed. 11. Some bugs in the extended library were fixed. 12. Some defects from [Coverity Scan][11] were fixed. ## 1.1.4 This release contains a fix to the build system that allows it to build on older versions of `glibc`. ## 1.1.3 This release contains a fix for a bug in the test suite where `bc` tests and `dc` tests could not be run in parallel. ## 1.1.2 This release has a fix for a history bug; the down arrow did not work. ## 1.1.1 This release fixes a bug in the `1.1.0` build system. The source is exactly the same. The bug that was fixed was a failure to install if no `EXECSUFFIX` was used. ## 1.1.0 This is a production release. However, many new features were added since `1.0`. 1. **The build system has been changed** to use a custom, POSIX shell-compatible configure script ([`configure.sh`][6]) to generate a POSIX make-compatible `Makefile`, which means that `bc` and `dc` now build out of the box on any POSIX-compatible system. 2. Out-of-memory and output errors now cause the `bc` to report the error, clean up, and die, rather than just reporting and trying to continue. 3. **Strings and constants are now garbage collected** when possible. 4. Signal handling and checking has been made more simple and more thorough. 5. `BcGlobals` was refactored into `BcVm` and `BcVm` was made global. Some procedure names were changed to reflect its difference to everything else. 6. Addition got a speed improvement. 7. Some common code for addition and multiplication was refactored into its own procedure. 8. A bug was removed where `dc` could have been selected, but the internal `#define` that returned `true` for a query about `dc` would not have returned `true`. 9. Useless calls to `bc_num_zero()` were removed. 10. **History support was added.** The history support is based off of a [UTF-8 aware fork][7] of [`linenoise`][8], which has been customized with `bc`'s own data structures and signal handling. 11. Generating C source from the math library now removes tabs from the library, shrinking the size of the executable. 12. The math library was shrunk. 13. Error handling and reporting was improved. 14. Reallocations were reduced by giving access to the request size for each operation. 15. **`abs()` (`b` command for `dc`) was added as a builtin.** 16. Both calculators were tested on FreeBSD. 17. Many obscure parse bugs were fixed. 18. Markdown and man page manuals were added, and the man pages are installed by `make install`. 19. Executable size was reduced, though the added features probably made the executable end up bigger. 20. **GNU-style array references were added as a supported feature.** 21. Allocations were reduced. 22. **New operators were added**: `$` (`$` for `dc`), `@` (`@` for `dc`), `@=`, `<<` (`H` for `dc`), `<<=`, `>>` (`h` for `dc`), and `>>=`. See the [`bc` manual][9] and the [`dc` manual][10] for more details. 23. **An extended math library was added.** This library contains code that makes it so I can replace my desktop calculator with this `bc`. See the [`bc` manual][3] for more details. 24. Support for all capital letters as numbers was added. 25. **Support for GNU-style void functions was added.** 26. A bug fix for improper handling of function parameters was added. 27. Precedence for the or (`||`) operator was changed to match GNU `bc`. 28. `dc` was given an explicit negation command. 29. `dc` was changed to be able to handle strings in arrays. ## 1.1 Release Candidate 3 This release is the eighth release candidate for 1.1, though it is the third release candidate meant as a general release candidate. The new code has not been tested as thoroughly as it should for release. ## 1.1 Release Candidate 2 This release is the seventh release candidate for 1.1, though it is the second release candidate meant as a general release candidate. The new code has not been tested as thoroughly as it should for release. ## 1.1 FreeBSD Beta 5 This release is the sixth release candidate for 1.1, though it is the fifth release candidate meant specifically to test if `bc` works on FreeBSD. The new code has not been tested as thoroughly as it should for release. ## 1.1 FreeBSD Beta 4 This release is the fifth release candidate for 1.1, though it is the fourth release candidate meant specifically to test if `bc` works on FreeBSD. The new code has not been tested as thoroughly as it should for release. ## 1.1 FreeBSD Beta 3 This release is the fourth release candidate for 1.1, though it is the third release candidate meant specifically to test if `bc` works on FreeBSD. The new code has not been tested as thoroughly as it should for release. ## 1.1 FreeBSD Beta 2 This release is the third release candidate for 1.1, though it is the second release candidate meant specifically to test if `bc` works on FreeBSD. The new code has not been tested as thoroughly as it should for release. ## 1.1 FreeBSD Beta 1 This release is the second release candidate for 1.1, though it is meant specifically to test if `bc` works on FreeBSD. The new code has not been tested as thoroughly as it should for release. ## 1.1 Release Candidate 1 This is the first release candidate for 1.1. The new code has not been tested as thoroughly as it should for release. ## 1.0 This is the first non-beta release. `bc` is ready for production use. As such, a lot has changed since 0.5. 1. `dc` has been added. It has been tested even more thoroughly than `bc` was for `0.5`. It does not have the `!` command, and for security reasons, it never will, so it is complete. 2. `bc` has been more thoroughly tested. An entire section of the test suite (for both programs) has been added to test for errors. 3. A prompt (`>>> `) has been added for interactive mode, making it easier to see inputs and outputs. 4. Interrupt handling has been improved, including elimination of race conditions (as much as possible). 5. MinGW and [Windows Subsystem for Linux][1] support has been added (see [xstatic][2] for binaries). 6. Memory leaks and errors have been eliminated (as far as ASan and Valgrind can tell). 7. Crashes have been eliminated (as far as [afl][3] can tell). 8. Karatsuba multiplication was added (and thoroughly) tested, speeding up multiplication and power by orders of magnitude. 9. Performance was further enhanced by using a "divmod" function to reduce redundant divisions and by removing superfluous `memset()` calls. 10. To switch between Karatsuba and `O(n^2)` multiplication, the config variable `BC_NUM_KARATSUBA_LEN` was added. It is set to a sane default, but the optimal number can be found with [`karatsuba.py`][4] (requires Python 3) and then configured through `make`. 11. The random math test generator script was changed to Python 3 and improved. `bc` and `dc` have together been run through 30+ million random tests. 12. All known math bugs have been fixed, including out of control memory allocations in `sine` and `cosine` (that was actually a parse bug), certain cases of infinite loop on square root, and slight inaccuracies (as much as possible; see the [README][5]) in transcendental functions. 13. Parsing has been fixed as much as possible. 14. Test coverage was improved to 94.8%. The only paths not covered are ones that happen when `malloc()` or `realloc()` fails. 15. An extension to get the length of an array was added. 16. The boolean not (`!`) had its precedence change to match negation. 17. Data input was hardened. 18. `bc` was made fully compliant with POSIX when the `-s` flag is used or `POSIXLY_CORRECT` is defined. 19. Error handling was improved. 20. `bc` now checks that files it is given are not directories. ## 1.0 Release Candidate 7 This is the seventh release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 6. ## 1.0 Release Candidate 6 This is the sixth release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 5. ## 1.0 Release Candidate 5 This is the fifth release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 4. ## 1.0 Release Candidate 4 This is the fourth release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 3. ## 1.0 Release Candidate 3 This is the third release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 2. ## 1.0 Release Candidate 2 This is the second release candidate for 1.0. It fixes a few bugs in 1.0 Release Candidate 1. ## 1.0 Release Candidate 1 This is the first Release Candidate for 1.0. `bc` is complete, with `dc`, but it is not tested. ## 0.5 This beta release completes more features, but it is still not complete nor tested as thoroughly as necessary. ## 0.4.1 This beta release fixes a few bugs in 0.4. ## 0.4 This is a beta release. It does not have the complete set of features, and it is not thoroughly tested. [1]: https://docs.microsoft.com/en-us/windows/wsl/install-win10 [2]: https://pkg.musl.cc/bc/ [3]: http://lcamtuf.coredump.cx/afl/ [4]: ./scripts/karatsuba.py [5]: ./README.md [6]: ./configure.sh [7]: https://github.com/rain-1/linenoise-mob [8]: https://github.com/antirez/linenoise [9]: ./manuals/bc/A.1.md [10]: ./manuals/dc/A.1.md [11]: https://scan.coverity.com/projects/gavinhoward-bc [12]: ./scripts/locale_install.sh [13]: ./manuals/build.md [14]: https://github.com/stesser [15]: https://github.com/bugcrazy [16]: ./manuals/bc/A.1.md#extended-library [17]: https://github.com/skeeto/optparse [18]: https://www.deepl.com/translator [19]: ./manuals/benchmarks.md [20]: https://github.com/apjanke/ronn-ng [21]: https://pandoc.org/ [22]: ./scripts/locale_uninstall.sh diff --git a/contrib/bc/README.md b/contrib/bc/README.md index 438cab0d1694..9d395f747185 100644 --- a/contrib/bc/README.md +++ b/contrib/bc/README.md @@ -1,498 +1,502 @@ # `bc` -***WARNING: New user registration for https://git.yzena.com/ is disabled because -of spam. If you need to report a bug with `bc`, email gavin at this site minus -the `git.` part for an account, and I will create one for you. Or you can report -an issue at [GitHub][29].*** +***WARNING: New user registration for is disabled +because of spam. If you need to report a bug with `bc`, email gavin at this site +minus the `git.` part for an account, and I will create one for you. Or you can +report an issue at [GitHub][29].*** -***WARNING: This project has moved to [https://git.yzena.com/][20] for [these -reasons][21], though GitHub will remain a mirror.*** +***WARNING: This project has moved to [https://git.gavinhoward.com/][20] for +[these reasons][21], though GitHub will remain a mirror.*** This is an implementation of the [POSIX `bc` calculator][12] that implements [GNU `bc`][1] extensions, as well as the period (`.`) extension for the BSD flavor of `bc`. For more information, see this `bc`'s full manual. This `bc` also includes an implementation of `dc` in the same binary, accessible via a symbolic link, which implements all FreeBSD and GNU extensions. (If a standalone `dc` binary is desired, `bc` can be copied and renamed to `dc`.) The `!` command is omitted; I believe this poses security concerns and that such functionality is unnecessary. For more information, see the `dc`'s full manual. This `bc` also provides `bc`'s math as a library with C bindings, called `bcl`. For more information, see the full manual for `bcl`. ## License This `bc` is Free and Open Source Software (FOSS). It is offered under the BSD 2-clause License. Full license text may be found in the [`LICENSE.md`][4] file. ## Prerequisites This `bc` only requires either: 1. Windows 10 or later, or 2. A C99-compatible compiler and a (mostly) POSIX 2008-compatible system with the XSI (X/Open System Interfaces) option group. Since POSIX 2008 with XSI requires the existence of a C99 compiler as `c99`, any POSIX and XSI-compatible system will have everything needed. POSIX-compatible systems that are known to work: * Linux * FreeBSD * OpenBSD * NetBSD * Mac OSX * Solaris* (as long as the Solaris version supports POSIX 2008) * AIX * HP-UX* (except for history) In addition, there is compatibility code to make this `bc` work on Windows. Please submit bug reports if this `bc` does not build out of the box on any system. ## Build This `bc` should build unmodified on any POSIX-compliant system or on Windows starting with Windows 10 (though earlier versions may work). For more complex build requirements than the ones below, see the [build manual][5]. ### Windows There is no guarantee that this `bc` will work on any version of Windows earlier than Windows 10 (I cannot test on earlier versions), but it is guaranteed to work on Windows 10 at least. Also, if building with MSBuild, the MSBuild bundled with Visual Studio is required. **Note**: Unlike the POSIX-compatible platforms, only one build configuration is supported on Windows: extra math and history enabled, NLS (locale support) disabled, with both calculators built. #### `bc` To build `bc`, you can open the `vs/bc.sln` file in Visual Studio, select the configuration, and build. You can also build using MSBuild with the following from the root directory: ``` msbuild -property:Configuration= vs/bc.sln ``` where `` is either one of `Debug` or `Release`. On Windows, the calculators are built as `vs/bin///bc.exe` and `vs/bin///dc.exe`, where `` can be either `Win32` or `x64`, and `` can be `Debug` or `Release`. **Note**: On Windows, `dc.exe` is just copied from `bc.exe`; it is not linked. Patches are welcome for a way to do that. #### `bcl` (Library) To build the library, you can open the `vs/bcl.sln` file in Visual Studio, select the configuration, and build. You can also build using MSBuild with the following from the root directory: ``` msbuild -property:Configuration= vs/bcl.sln ``` where `` is either one of `Debug`, `ReleaseMD`, or `ReleaseMT`. On Windows, the library is built as `vs/lib///bcl.lib`, where `` can be either `Win32` or `x64`, and `` can be `Debug`, `ReleaseMD`, or `ReleaseMT`. ### POSIX-Compatible Systems On POSIX-compatible systems, `bc` is built as `bin/bc` and `dc` is built as `bin/dc` by default. #### Default For the default build with optimization, use the following commands in the root directory: ``` ./configure.sh -O3 make ``` #### One Calculator To only build `bc`, use the following commands: ``` ./configure.sh --disable-dc make ``` To only build `dc`, use the following commands: ``` ./configure.sh --disable-bc make ``` #### Debug For debug builds, use the following commands in the root directory: ``` ./configure.sh -g make ``` #### Install To install, use the following command: ``` make install ``` By default, `bc` and `dc` will be installed in `/usr/local`. For installing in other locations, use the `PREFIX` environment variable when running `configure.sh` or pass the `--prefix=` option to `configure.sh`. See the [build manual][5], or run `./configure.sh --help`, for more details. #### Library To build the math library, pass the `-a` or `--library` options to `configure.sh`: ``` ./configure.sh -a ``` When building the library, the executables are not built. For more information, see the [build manual][5]. The library API can be found in [`manuals/bcl.3.md`][26] or `man bcl` once the library is installed. #### Package and Distro Maintainers This section is for package and distro maintainers. ##### Out-of-Source Builds Out-of-source builds are supported; just call `configure.sh` from the directory where the actual build will happen. For example, if the source is in `bc`, the build should happen in `build`, then call `configure.sh` and `make` like so: ``` ../bc/configure.sh make ``` ***WARNING***: The path to `configure.sh` from the build directory must not have spaces because `make` does not support target names with spaces. ##### Recommended Compiler When I ran benchmarks with my `bc` compiled under `clang`, it performed much better than when compiled under `gcc`. I recommend compiling this `bc` with `clang`. I also recommend building this `bc` with C11 if you can because `bc` will detect a C11 compiler and add `_Noreturn` to any relevant function(s). ##### Recommended Optimizations I wrote this `bc` with Separation of Concerns, which means that there are many small functions that could be inlined. However, they are often called across file boundaries, and the default optimizer can only look at the current file, which means that they are not inlined. Thus, because of the way this `bc` is built, it will automatically be slower than other `bc` implementations when running scripts with no math. (My `bc`'s math is *much* faster, so any non-trivial script should run faster in my `bc`.) Some, or all, of the difference can be made up with the right optimizations. The optimizations I recommend are: 1. `-O3` 2. `-flto` (link-time optimization) in that order. Link-time optimization, in particular, speeds up the `bc` a lot. This is because when link-time optimization is turned on, the optimizer can look across files and inline *much* more heavily. However, I recommend ***NOT*** using `-march=native`. Doing so will reduce this `bc`'s performance, at least when building with link-time optimization. See the [benchmarks][19] for more details. ##### Stripping Binaries By default, non-debug binaries are stripped, but stripping can be disabled with the `-T` option to `configure.sh`. ##### Using This `bc` as an Alternative If this `bc` is packaged as an alternative to an already existing `bc` package, it is possible to rename it in the build to prevent name collision. To prepend to the name, just run the following: ``` EXECPREFIX= ./configure.sh ``` To append to the name, just run the following: ``` EXECSUFFIX= ./configure.sh ``` If a package maintainer wishes to add both a prefix and a suffix, that is allowed. **Note**: The suggested name (and package name) when `bc` is not available is `bc-gh`. ##### Karatsuba Number Package and distro maintainers have one tool at their disposal to build this `bc` in the optimal configuration: `scripts/karatsuba.py`. This script is not a compile-time or runtime prerequisite; it is for package and distro maintainers to run once when a package is being created. It finds the optimal Karatsuba number (see the [algorithms manual][7] for more information) for the machine that it is running on. The easiest way to run this script is with `make karatsuba`. If desired, maintainers can also skip running this script because there is a sane default for the Karatsuba number. ## Status This `bc` is robust. It is well-tested, fuzzed, and fully standards-compliant (though not certified) with POSIX `bc`. The math has been tested with 40+ million random problems, so it is as correct as I can make it. This `bc` can be used as a drop-in replacement for any existing `bc`. This `bc` is also compatible with MinGW toolchains. In addition, this `bc` is considered complete; i.e., there will be no more releases with additional features. However, it *is* actively maintained, so if any bugs are found, they will be fixed in new releases. Also, additional translations will also be added as they are provided. ### Development If I (Gavin D. Howard) get [hit by a bus][27] and future programmers need to handle work themselves, the best place to start is the [Development manual][28]. ## Vim Syntax I have developed (using other people's code to start) [`vim` syntax files][17] for this `bc` and `dc`, including the extensions. ## `bc` Libs I have gathered some excellent [`bc` and `dc` libraries][18]. These libraries may prove useful to any serious users. ## Comparison to GNU `bc` This `bc` compares favorably to GNU `bc`. * This `bc` builds natively on Windows. * It has more extensions, which make this `bc` more useful for scripting. (See [Extensions](#extensions).) * This `bc` is a bit more POSIX compliant. * It has a much less buggy parser. The GNU `bc` will give parse errors for what is actually valid `bc` code, or should be. For example, putting an `else` on a new line after a brace can cause GNU `bc` to give a parse error. * This `bc` has fewer crashes. * GNU `bc` calculates the wrong number of significant digits for `length(x)`. * GNU `bc` will sometimes print numbers incorrectly. For example, when running it on the file `tests/bc/power.txt` in this repo, GNU `bc` gets all the right answers, but it fails to wrap the numbers at the proper place when outputting to a file. * This `bc` is faster. (See [Performance](#performance).) ### Performance Because this `bc` packs more than `1` decimal digit per hardware integer, this `bc` is faster than GNU `bc` and can be *much* faster. Full benchmarks can be found at [manuals/benchmarks.md][19]. There is one instance where this `bc` is slower: if scripts are light on math. This is because this `bc`'s intepreter is slightly slower than GNU `bc`, but that is because it is more robust. See the [benchmarks][19]. ### Extensions Below is a non-comprehensive list of extensions that this `bc` and `dc` have that all others do not. * An extended math library. (See [here][30] for more information.) * A command-line prompt. * Turning on and off digit clamping. (Digit clamping is about how to treat "invalid" digits for a particular base. GNU `bc` uses it, and the BSD `bc` does not. Mine does both.) * A pseudo-random number generator. This includes the ability to set the seed and get reproducible streams of random numbers. * The ability to use stacks for the globals `scale`, `ibase`, and `obase` instead of needing to restore them in *every* function. * The ability to *not* use non-standard keywords. For example, `abs` is a keyword (a built-in function), but if some script actually defines a function called that, it's possible to tell my `bc` to not treat it as a keyword, which will make the script parses correctly. * The ability to turn on and off printing leading zeroes on numbers greater than `-1` and less than `1`. * Outputting in scientific and engineering notation. * Accepting input in scientific and engineering notation. * Passing strings and arrays to the `length()` built-in function. (In `dc`, the `Y` command will do this for arrays, and the `Z` command will do this for both numbers and strings.) * The `abs()` built-in function. (This is the `b` command in `dc`.) * The `is_number()` and `is_string()` built-in functions. (These tell whether a variable is holding a string or a number, for runtime type checking. The commands are `u` and `t` in `dc`.) * For `bc` only, the `divmod()` built-in function for computing a quotient and remainder at the same time. * For `bc` only, the `asciify()` built-in function for converting an array to a string. * The `$` truncation operator. (It's the same in `bc` and `dc`.) * The `@` "set scale" operator. (It's the same in `bc` and `dc`.) * The decimal shift operators. (`<<` and `>>` in `bc`, `H` and `h` in `dc`.) * Built-in functions or commands to get the max of `scale`, `ibase`, and `obase`. * The ability to put strings into variables in `bc`. (This always existed in `dc`.) * The `'` command in `dc` for the depth of the execution stack. * The `y` command in `dc` for the depth of register stacks. * Built-in functions or commands to get the value of certain environment variables that might affect execution. * The `stream` keyword to do the same thing as the `P` command in `dc`. * Defined order of evaluation. * Defined exit statuses. * All environment variables other than `POSIXLY_CORRECT`, `BC_ENV_ARGS`, and `BC_LINE_LENGTH`. * The ability for users to define their own defaults for various options during build. (See [here][31] for more information.) ## Algorithms To see what algorithms this `bc` uses, see the [algorithms manual][7]. ## Locales Currently, there is no locale support on Windows. Additionally, this `bc` only has support for English (and US English), French, German, Portuguese, Dutch, Polish, Russian, Japanese, and Chinese locales. Patches are welcome for translations; use the existing `*.msg` files in `locales/` as a starting point. In addition, patches for improvements are welcome; the last two messages in Portuguese were made with Google Translate, and the Dutch, Polish, Russian, Japanese, and Chinese locales were all generated with [DeepL][22]. The message files provided assume that locales apply to all regions where a language is used, but this might not be true for, e.g., `fr_CA` and `fr_CH`. Any corrections or a confirmation that the current texts are acceptable for those regions would be appreciated, too. ## Other Projects Other projects based on this bc are: * [busybox `bc`][8]. The busybox maintainers have made their own changes, so any bugs in the busybox `bc` should be reported to them. * [toybox `bc`][9]. The maintainer has also made his own changes, so bugs in the toybox `bc` should be reported there. * [FreeBSD `bc`][23]. While the `bc` in FreeBSD is kept up-to-date, it is better to [report bugs there][24], as well as [submit patches][25], and the maintainers of the package will contact me if necessary. ## Language This `bc` is written in pure ISO C99, using POSIX 2008 APIs with custom Windows compatibility code. ## Commit Messages This `bc` uses the commit message guidelines laid out in [this blog post][10]. ## Semantic Versioning This `bc` uses [semantic versioning][11]. +## AI-Free + +This repository is 100% AI-Free code. + ## Contents Items labeled with `(maintainer use only)` are not included in release source tarballs. Files: .gitignore The git ignore file (maintainer use only). .gitattributes The git attributes file (maintainer use only). bcl.pc.in A template pkg-config file for bcl. configure A symlink to configure.sh to make packaging easier. configure.sh The configure script. LICENSE.md A Markdown form of the BSD 2-clause License. Makefile.in The Makefile template. NEWS.md The changelog. NOTICE.md List of contributors and copyright owners. Folders: benchmarks A folder of benchmarks for various aspects of bc performance. gen The bc math library, help texts, and code to generate C source. include All header files. locales Locale files, in .msg format. Patches welcome for translations. manuals Manuals for both programs. src All source code. scripts A bunch of shell scripts to help with development and building. tests All tests. vs Files needed for the build on Windows. [1]: https://www.gnu.org/software/bc/ [4]: ./LICENSE.md [5]: ./manuals/build.md [7]: ./manuals/algorithms.md [8]: https://git.busybox.net/busybox/tree/miscutils/bc.c [9]: https://github.com/landley/toybox/blob/master/toys/pending/bc.c [10]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html [11]: http://semver.org/ [12]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html -[17]: https://git.yzena.com/gavin/vim-bc -[18]: https://git.yzena.com/gavin/bc_libs +[17]: https://git.gavinhoward.com/gavin/vim-bc +[18]: https://git.gavinhoward.com/gavin/bc_libs [19]: ./manuals/benchmarks.md -[20]: https://git.yzena.com/gavin/bc +[20]: https://git.gavinhoward.com/gavin/bc [21]: https://gavinhoward.com/2020/04/i-am-moving-away-from-github/ [22]: https://www.deepl.com/translator [23]: https://cgit.freebsd.org/src/tree/contrib/bc [24]: https://bugs.freebsd.org/ [25]: https://reviews.freebsd.org/ [26]: ./manuals/bcl.3.md [27]: https://en.wikipedia.org/wiki/Bus_factor [28]: ./manuals/development.md [29]: https://github.com/gavinhoward/bc [30]: ./manuals/bc/A.1.md#extended-library [31]: ./manuals/build.md#settings diff --git a/contrib/bc/gen/bc_help.txt b/contrib/bc/gen/bc_help.txt index f78ba9e71dd3..c51ba186db15 100644 --- a/contrib/bc/gen/bc_help.txt +++ b/contrib/bc/gen/bc_help.txt @@ -1,256 +1,256 @@ /* * ***************************************************************************** * * 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 bc help text. * */ usage: %s [options] [file...] bc is a command-line, arbitrary-precision calculator with a Turing-complete language. For details, use `man %s` or see the online documentation at -https://git.yzena.com/gavin/bc/src/tag/%s/manuals/bc/%s.1.md. +https://git.gavinhoward.com/gavin/bc/src/tag/%s/manuals/bc/%s.1.md. This bc is compatible with both the GNU bc and the POSIX bc spec. See the GNU bc manual (https://www.gnu.org/software/bc/manual/bc.html) and bc spec (http://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) for details. This bc has three differences to the GNU bc: 1) Arrays can be passed to the builtin "length" function to get the number of elements currently in the array. The following example prints "1": a[0] = 0 length(a[]) 2) The precedence of the boolean "not" operator (!) is equal to that of the unary minus (-), or negation, operator. This still allows POSIX-compliant scripts to work while somewhat preserving expected behavior (versus C) and making parsing easier. 3) This bc has many more extensions than the GNU bc does. For details, see the man page or online documentation. This bc also implements the dot (.) extension of the BSD bc. Options: -C --no-digit-clamp Disables clamping of digits that are larger than or equal to the current ibase when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If multiple of this option and the -c option are given, the last is used. -c --digit-clamp Enables clamping of digits that are larger than or equal to the current ibase when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If multiple of this option and the -C option are given, the last is used. {{ A H N HN }} -E seed --seed=seed Sets the builtin variable seed to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. {{ end }} -e expr --expression=expr Run "expr" and quit. If multiple expressions or files (see below) are given, they are all run before executing from stdin. -f file --file=file Run the bc code in "file" and exit. See above as well. -g --global-stacks Turn scale, ibase, and obase into stacks. This makes the value of each be be restored on returning from functions. See the man page or online documentation for more details. -h --help Print this usage message and exit. -I ibase --ibase=ibase Sets the builtin variable ibase to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -i --interactive Force interactive mode. -L --no-line-length Disable line length checking. -l --mathlib Use predefined math routines: s(expr) = sine of expr in radians c(expr) = cosine of expr in radians a(expr) = arctangent of expr, returning radians l(expr) = natural log of expr e(expr) = raises e to the power of expr j(n, x) = Bessel function of integer order n of x This bc may load more functions with these options. See the manpage or online documentation for details. -O obase --obase=obase Sets the builtin variable obase to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -P --no-prompt Disable the prompts in interactive mode. -R --no-read-prompt Disable the read prompt in interactive mode. -r keyword --redefine=keyword Redefines "keyword" and allows it to be used as a function, variable, and array name. This is useful when this bc gives parse errors on scripts meant for other bc implementations. Only keywords that are not in the POSIX bc spec may be redefined. It is a fatal error to attempt to redefine a keyword that cannot be redefined or does not exist. -q --quiet Don't print version and copyright. -S scale --scale=scale Sets the builtin variable scale to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -s --standard Error if any non-POSIX extensions are used. -w --warn Warn if any non-POSIX extensions are used. -v --version Print version information and copyright and exit. -z --leading-zeroes Enable leading zeroes on numbers greater than -1 and less than 1. Environment variables: POSIXLY_CORRECT Error if any non-POSIX extensions are used. BC_ENV_ARGS Command-line arguments to use on every run. BC_LINE_LENGTH If an integer, the number of characters to print on a line before wrapping. Using 0 will disable line length checking. BC_BANNER If an integer and non-zero, display the copyright banner in interactive mode. If zero, disable the banner. Overrides the default, which is %s print the banner. BC_SIGINT_RESET If an integer and non-zero, reset on SIGINT, rather than exit, when in interactive mode. If zero, do not reset on SIGINT in all cases, but exit instead. Overrides the default, which is %s. BC_TTY_MODE If an integer and non-zero, enable TTY mode when it is available. If zero, disable TTY mode in all cases. Overrides the default, which is TTY mode %s. BC_PROMPT If an integer and non-zero, enable prompt when TTY mode is possible. If zero, disable prompt in all cases. Overrides the default, which is prompt %s. BC_EXPR_EXIT If an integer and non-zero, exit when expressions or expression files are given on the command-line, and does not exit when an integer and zero. Overrides the default, which is %s. BC_DIGIT_CLAMP If an integer and non-zero, clamp digits larger than or equal to the current ibase when parsing numbers. Overrides the default, which is %s. diff --git a/contrib/bc/gen/dc_help.txt b/contrib/bc/gen/dc_help.txt index 8b313f8d9e07..7d9e7ec28d25 100644 --- a/contrib/bc/gen/dc_help.txt +++ b/contrib/bc/gen/dc_help.txt @@ -1,213 +1,213 @@ /* * ***************************************************************************** * * 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 dc help text. * */ usage: %s [options] [file...] dc is a reverse-polish notation command-line calculator which supports unlimited precision arithmetic. For details, use `man %s` or see the online documentation -at https://git.yzena.com/gavin/bc/src/tag/%s/manuals/bc/%s.1.md. +at https://git.gavinhoward.com/gavin/bc/src/tag/%s/manuals/bc/%s.1.md. This dc is (mostly) compatible with the OpenBSD dc and the GNU dc. See the OpenBSD man page (http://man.openbsd.org/OpenBSD-current/man1/dc.1) and the GNU dc manual (https://www.gnu.org/software/bc/manual/dc-1.05/html_mono/dc.html) for details. This dc has a few differences from the two above: 1) When printing a byte stream (command "P"), this bc follows what the FreeBSD dc does. 2) This dc implements the GNU extensions for divmod ("~") and modular exponentiation ("|"). 3) This dc implements all FreeBSD extensions, except for "J" and "M". 4) This dc does not implement the run command ("!"), for security reasons. 5) Like the FreeBSD dc, this dc supports extended registers. However, they are implemented differently. When it encounters whitespace where a register should be, it skips the whitespace. If the character following is not a lowercase letter, an error is issued. Otherwise, the register name is parsed by the following regex: [a-z][a-z0-9_]* This generally means that register names will be surrounded by whitespace. Examples: l idx s temp L index S temp2 < do_thing Also note that, unlike the FreeBSD dc, extended registers are not even parsed unless the "-x" option is given. Instead, the space after a command that requires a register name is taken as the register name. Options: -C --no-digit-clamp Disables clamping of digits that are larger than or equal to the current ibase when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If multiple of this option and the -c option are given, the last is used. -c --digit-clamp Enables clamping of digits that are larger than or equal to the current ibase when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If multiple of this option and the -C option are given, the last is used. {{ A H N HN }} -E seed --seed=seed Sets the builtin variable seed to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. {{ end }} -e expr --expression=expr Run "expr" and quit. If multiple expressions or files (see below) are given, they are all run. After running, dc will exit. -f file --file=file Run the dc code in "file" and exit. See above. -h --help Print this usage message and exit. -I ibase --ibase=ibase Sets the builtin variable ibase to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -i --interactive Put dc into interactive mode. See the man page for more details. -L --no-line-length Disable line length checking. -O obase --obase=obase Sets the builtin variable obase to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -P --no-prompt Disable the prompts in interactive mode. -R --no-read-prompt Disable the read prompt in interactive mode. -S scale --scale=scale Sets the builtin variable scale to the given value assuming that the given value is in base 10. It is a fatal error if the given value is not a valid number. -V --version Print version and copyright and exit. -x --extended-register Enable extended register mode. -z --leading-zeroes Enable leading zeroes on numbers greater than -1 and less than 1. Environment variables: DC_ENV_ARGS Command-line arguments to use on every run. DC_LINE_LENGTH If an integer, the number of characters to print on a line before wrapping. Using 0 will disable line length checking. DC_SIGINT_RESET If an integer and non-zero, reset on SIGINT, rather than exit, when in interactive mode. If zero, do not reset on SIGINT in all cases, but exit instead. Overrides the default, which is %s. DC_TTY_MODE If an integer and non-zero, enable TTY mode when it is available. If zero, disable TTY mode in all cases. Overrides the default, which is TTY mode %s. DC_PROMPT If an integer and non-zero, enable prompt when TTY mode is possible. If zero, disable prompt in all cases. Overrides the default, which is prompt %s. DC_EXPR_EXIT If an integer and non-zero, exit when expressions or expression files are given on the command-line, and does not exit when an integer and zero. Overrides the default, which is %s. DC_DIGIT_CLAMP If an integer and non-zero, clamp digits larger than or equal to the current ibase when parsing numbers. Overrides the default, which is %s. diff --git a/contrib/bc/gen/strgen.sh b/contrib/bc/gen/strgen.sh index 5ef66fb2d8c8..a65e221ad0b4 100755 --- a/contrib/bc/gen/strgen.sh +++ b/contrib/bc/gen/strgen.sh @@ -1,104 +1,116 @@ #! /bin/sh # # 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. # export LANG=C export LC_CTYPE=C progname=${0##*/} script="$0" scriptdir=$(dirname "$script") . "$scriptdir/../scripts/functions.sh" +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s input output exclude name [label [define [remove_tabs]]]\n' "$progname" + exit 1 +} + # See strgen.c comment on main() for what these mean. Note, however, that this # script generates a string literal, not a char array. To understand the # consequences of that, see manuals/development.md#strgenc. if [ $# -lt 3 ]; then - echo "usage: $progname input output exclude name [label [define [remove_tabs]]]" - exit 1 + usage "Not enough arguments" fi input="$1" +check_file_arg "$input" output="$2" exclude="$3" name="$4" label="$5" define="$6" remove_tabs="$7" +check_bool_arg "$remove_tabs" tmpinput=$(mktemp -t "${input##*/}_XXXXXX") if [ "$exclude" -ne 0 ]; then filter_text "$input" "$tmpinput" "E" else filter_text "$input" "$tmpinput" "A" fi exec < "$tmpinput" exec > "$output" rm -f "$tmpinput" if [ -n "$label" ]; then nameline="const char *${label} = \"${input}\";" labelexternline="extern const char *${label};" fi if [ -n "$define" ]; then condstart="#if ${define}" condend="#endif" fi if [ -n "$remove_tabs" ]; then if [ "$remove_tabs" -ne 0 ]; then remtabsexpr='s: ::g;' fi fi cat<&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]seed\f[R] .IP "7." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if \f[B]seed\f[R] is queried again immediately. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will \f[I]not\f[R] produce unique sequences of pseudo-random numbers. The value of \f[B]seed\f[R] will change after any use of the \f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the \f[I]Operands\f[R] subsection below), except if the parameter passed to \f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "23." 4 \f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). Using this operand will change the value of \f[B]seed\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "24." 4 \f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and the value of \f[B]E\f[R] (exclusive). If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s \f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of \f[B]seed\f[R], unless the value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. This is a \f[B]non-portable extension\f[R]. .IP "25." 4 \f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. This is a \f[B]non-portable extension\f[R]. .PP The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to \f[I]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to \f[B]0.0042890\f[R]. .PP Using scientific notation is an error or warning if the \f[B]-s\f[R] or \f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if bc(1) is given the number string \f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP Description: \f[B]truncation\f[R] .RE .TP \f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]set precision\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The \f[B]truncation\f[R] operator returns a copy of the given expression with all of its \f[I]scale\f[R] removed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The \f[B]set precision\f[R] operator takes two expressions and returns a copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]<<\f[R] The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the right. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]>>\f[R] The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the left. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .PP The \f[B]assignment\f[R] operators that correspond to operators that are extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math library (see the \f[I]Extended Library\f[R] subsection below), are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given, except that the extended math library is not available when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Extended Library .PP The extended library is \f[I]not\f[R] loaded when the \f[B]-s\f[R]/\f[B]--standard\f[R] or \f[B]-w\f[R]/\f[B]--warn\f[R] options are given since they are not part of the library defined by the standard (see the \f[B]STANDARDS\f[R] section). .PP The extended library is a \f[B]non-portable extension\f[R]. .TP \f[B]p(x, y)\f[R] Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] is not an integer, and returns the result to the current \f[B]scale\f[R]. .RS .PP It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is \f[B]0\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round half away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP \f[B]ceil(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP \f[B]f(x)\f[R] Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP \f[B]perm(n, k)\f[R] Returns the permutation of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]comb(n, k)\f[R] Returns the combination of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]l2(x)\f[R] Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l10(x)\f[R] Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]log(x, b)\f[R] Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cbrt(x)\f[R] Returns the cube root of \f[B]x\f[R]. .TP \f[B]root(x, n)\f[R] Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even and \f[B]x\f[R] is negative. .RE .TP \f[B]gcd(a, b)\f[R] Returns the greatest common divisor (factor) of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]lcm(a, b)\f[R] Returns the least common multiple of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]pi(p)\f[R] Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]t(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]sin(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cos(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]tan(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r2d(x)\f[R] Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]d2r(x)\f[R] Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]frand(p)\f[R] Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]. If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .TP \f[B]ifrand(i, p)\f[R] Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If the absolute value of \f[B]i\f[R] is greater than or equal to \f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] is returned and \f[B]seed\f[R] is not changed. .TP \f[B]srand(x)\f[R] Returns \f[B]x\f[R] with its sign flipped with probability \f[B]0.5\f[R]. In other words, it randomizes the sign of \f[B]x\f[R]. .TP \f[B]brand()\f[R] Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP \f[B]band(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]and\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]or\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bxor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]xor\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshl(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of \f[B]a\f[R] bit-shifted left by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshr(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the truncated result of \f[B]a\f[R] bit-shifted right by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnotn(x, n)\f[R] Takes the truncated absolute value of \f[B]x\f[R] and does a bitwise not as though it has the same number of bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot8(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]8\f[R] binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot16(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]16\f[R] binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot32(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]32\f[R] binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot64(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]64\f[R] binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brevn(x, n)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the same number of 8-bit bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev8(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 8 binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev16(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 16 binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev32(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 32 binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev64(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 64 binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]broln(x, p, n)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol8(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol16(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol32(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol64(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brorn(x, p, n)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror8(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror16(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror32(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror64(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmodn(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of the multiplication of the truncated absolute value of \f[B]n\f[R] and \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod8(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod16(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod32(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod64(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bunrev(t)\f[R] Assumes \f[B]t\f[R] is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. .RS .PP This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. .RE .TP \f[B]plz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]plznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]pnlz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]pnlznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of \f[B]x\f[R]. .TP \f[B]sbytes(x)\f[R] Returns the numbers of signed, two\[cq]s-complement integer bytes required to hold the truncated value of \f[B]x\f[R]. .TP \f[B]s2u(x)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer and returns the non-negative integer that would have the same representation in binary. .TP \f[B]s2un(x,n)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer with \f[B]n\f[R] bytes and returns the non-negative integer that would have the same representation in binary. If \f[B]x\f[R] cannot fit into \f[B]n\f[R] 2\[cq]s-complement signed bytes, it is truncated to fit. .TP \f[B]hex(x)\f[R] Outputs the hexadecimal (base \f[B]16\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary(x)\f[R] Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output(x, b)\f[R] Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uintn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]intn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]hex_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_byte(x, i)\f[R] Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes - 1\f[R] is the most significant byte. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 \f[B]l2(x)\f[R] .IP \[bu] 2 \f[B]l10(x)\f[R] .IP \[bu] 2 \f[B]log(x, b)\f[R] .IP \[bu] 2 \f[B]pi(p)\f[R] .IP \[bu] 2 \f[B]t(x)\f[R] .IP \[bu] 2 \f[B]a2(y, x)\f[R] .IP \[bu] 2 \f[B]sin(x)\f[R] .IP \[bu] 2 \f[B]cos(x)\f[R] .IP \[bu] 2 \f[B]tan(x)\f[R] .IP \[bu] 2 \f[B]atan(x)\f[R] .IP \[bu] 2 \f[B]atan2(y, x)\f[R] .IP \[bu] 2 \f[B]r2d(x)\f[R] .IP \[bu] 2 \f[B]d2r(x)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]rand()\f[R] operand. Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their corresponding assignment operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]BC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP bc(1) supports interactive command-line editing. .PP If bc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]BC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If history is enabled, previous lines can be recalled and edited with the arrow keys. .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/A.1.md b/contrib/bc/manuals/bc/A.1.md index 40cfa5fcdad6..e7b4c8212190 100644 --- a/contrib/bc/manuals/bc/A.1.md +++ b/contrib/bc/manuals/bc/A.1.md @@ -1,2505 +1,2505 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, **scale**, and **seed** into stacks. This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. (**Note**: the function **output(x,b)** exists in the extended math library. See the **LIBRARY** section.) However, since using this flag means that functions cannot set **ibase**, **obase**, **scale**, or **seed** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, **scale**, or **seed** globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. For functions that set **seed**, the value assigned to **seed** is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once **seed** has been set. If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same **seed**, it can use the following line: seed = seed If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. To learn what is in the libraries, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **irand** * **last** * **limits** * **maxibase** * **maxobase** * **maxrand** * **maxscale** * **modexp** * **print** * **rand** * **read** * **seed** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **seed** 7. **last** or a single dot (**.**) Numbers 6 and 7 are **non-portable extensions**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is assigned to **seed** and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if **seed** is queried again immediately. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will *not* produce unique sequences of pseudo-random numbers. The value of **seed** will change after any use of the **rand()** and **irand(E)** operands (see the *Operands* subsection below), except if the parameter passed to **irand(E)** is **0**, **1**, or negative. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 22. **rand()**: A pseudo-random integer between **0** (inclusive) and **BC_RAND_MAX** (inclusive). Using this operand will change the value of **seed**. This is a **non-portable extension**. 23. **irand(E)**: A pseudo-random integer between **0** (inclusive) and the value of **E** (exclusive). If **E** is negative or is a non-integer (**E**'s *scale* is not **0**), an error is raised, and bc(1) resets (see the **RESET** section) while **seed** remains unchanged. If **E** is larger than **BC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **BC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of **seed**, unless the value of **E** is **0** or **1**. In that case, **0** is returned, and **seed** is *not* changed. This is a **non-portable extension**. 24. **maxrand()**: The max integer returned by **rand()**. This is a **non-portable extension**. The integers generated by **rand()** and **irand(E)** are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. **Note**: The values returned by the pseudo-random number generator with **rand()** and **irand(E)** are guaranteed to *NOT* be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, bc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and bc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if bc(1) is given the number string **10e-4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\$** : Type: Postfix Associativity: None Description: **truncation** **\@** : Type: Binary Associativity: Right Description: **set precision** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **\<\<** **\>\>** : Type: Binary Associativity: Left Description: **shift left**, **shift right** **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\$** : The **truncation** operator returns a copy of the given expression with all of its *scale* removed. This is a **non-portable extension**. **\@** : The **set precision** operator takes two expressions and returns a copy of the first with its *scale* equal to the value of the second expression. That could either mean that the number is returned without change (if the *scale* of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **\<\<** : The **left shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the right. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\>\>** : The **right shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the left. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. The **assignment** operators that correspond to operators that are extensions are themselves **non-portable extensions**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning **0** to **obase**, and engineering notation is activated by assigning **1** to **obase**. To deactivate them, just assign a different value to **obase**. Scientific notation and engineering notation are disabled if bc(1) is run with either the **-s** or **-w** command-line options (or equivalents). Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below, including the functions in the extended math library (see the *Extended Library* subsection below), are available when the **-l** or **-\-mathlib** command-line flags are given, except that the extended math library is not available when the **-s** option, the **-w** option, or equivalents are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Extended Library The extended library is *not* loaded when the **-s**/**-\-standard** or **-w**/**-\-warn** options are given since they are not part of the library defined by the standard (see the **STANDARDS** section). The extended library is a **non-portable extension**. **p(x, y)** : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. It is an error if **y** is negative and **x** is **0**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round half away from **0** (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). **ceil(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round away from **0** (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). **f(x)** : Returns the factorial of the truncated absolute value of **x**. **perm(n, k)** : Returns the permutation of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **comb(n, k)** : Returns the combination of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **l2(x)** : Returns the logarithm base **2** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **l10(x)** : Returns the logarithm base **10** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **log(x, b)** : Returns the logarithm base **b** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cbrt(x)** : Returns the cube root of **x**. **root(x, n)** : Calculates the truncated value of **n**, **r**, and returns the **r**th root of **x** to the current **scale**. If **r** is **0** or negative, this raises an error and causes bc(1) to reset (see the **RESET** section). It also raises an error and causes bc(1) to reset if **r** is even and **x** is negative. **gcd(a, b)** : Returns the greatest common divisor (factor) of the truncated absolute value of **a** and the truncated absolute value of **b**. **lcm(a, b)** : Returns the least common multiple of the truncated absolute value of **a** and the truncated absolute value of **b**. **pi(p)** : Returns **pi** to **p** decimal places. This is a transcendental function (see the *Transcendental Functions* subsection below). **t(x)** : Returns the tangent of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is a transcendental function (see the *Transcendental Functions* subsection below). **sin(x)** : Returns the sine of **x**, which is assumed to be in radians. This is an alias of **s(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cos(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is an alias of **c(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **tan(x)** : Returns the tangent of **x**, which is assumed to be in radians. If **x** is equal to **1** or **-1**, this raises an error and causes bc(1) to reset (see the **RESET** section). This is an alias of **t(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan(x)** : Returns the arctangent of **x**, in radians. This is an alias of **a(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is an alias of **a2(y, x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r2d(x)** : Converts **x** from radians to degrees and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **d2r(x)** : Converts **x** from degrees to radians and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **frand(p)** : Generates a pseudo-random number between **0** (inclusive) and **1** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If **p** is not **0**, then calling this function will change the value of **seed**. If **p** is **0**, then **0** is returned, and **seed** is *not* changed. **ifrand(i, p)** : Generates a pseudo-random number that is between **0** (inclusive) and the truncated absolute value of **i** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If the absolute value of **i** is greater than or equal to **2**, and **p** is not **0**, then calling this function will change the value of **seed**; otherwise, **0** is returned and **seed** is not changed. **srand(x)** : Returns **x** with its sign flipped with probability **0.5**. In other words, it randomizes the sign of **x**. **brand()** : Returns a random boolean value (either **0** or **1**). **band(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **and** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **or** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bxor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **xor** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshl(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of **a** bit-shifted left by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshr(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the truncated result of **a** bit-shifted right by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bnotn(x, n)** : Takes the truncated absolute value of **x** and does a bitwise not as though it has the same number of bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot8(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **8** binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot16(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **16** binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot32(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **32** binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot64(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **64** binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brevn(x, n)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the same number of 8-bit bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev8(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 8 binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev16(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 16 binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev32(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 32 binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev64(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 64 binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **broln(x, p, n)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol8(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol16(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol32(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol64(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brorn(x, p, n)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror8(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror16(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror32(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror64(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmodn(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of the multiplication of the truncated absolute value of **n** and **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod8(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod16(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod32(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod64(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bunrev(t)** : Assumes **t** is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. **plz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **plznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **pnlz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **pnlznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **ubytes(x)** : Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of **x**. **sbytes(x)** : Returns the numbers of signed, two's-complement integer bytes required to hold the truncated value of **x**. **s2u(x)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer and returns the non-negative integer that would have the same representation in binary. **s2un(x,n)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer with **n** bytes and returns the non-negative integer that would have the same representation in binary. If **x** cannot fit into **n** 2's-complement signed bytes, it is truncated to fit. **hex(x)** : Outputs the hexadecimal (base **16**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary(x)** : Outputs the binary (base **2**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output(x, b)** : Outputs the base **b** representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uintn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **intn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **hex_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in hexadecimal using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in binary using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in the current **obase** (see the **SYNTAX** section) using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_byte(x, i)** : Outputs byte **i** of the truncated absolute value of **x**, where **0** is the least significant byte and **number_of_bytes - 1** is the most significant byte. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** The transcendental functions in the extended math library are: * **l2(x)** * **l10(x)** * **log(x, b)** * **pi(p)** * **t(x)** * **a2(y, x)** * **sin(x)** * **cos(x)** * **tan(x)** * **atan(x)** * **atan2(y, x)** * **r2d(x)** * **d2r(x)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. **BC_RAND_MAX** : The maximum integer (inclusive) returned by the **rand()** operand. Set at **2\^BC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**\<\<**), and right shift (**\>\>**) operators and their corresponding assignment operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **BC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when bc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause bc(1) to clean up and exit. # COMMAND LINE HISTORY bc(1) supports interactive command-line editing. If bc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **BC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). If history is enabled, previous lines can be recalled and edited with the arrow keys. **Note**: tabs are converted to 8 spaces. # LOCALES This bc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. This bc(1) supports error messages for different locales, and thus, it supports **LC_MESSAGES**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/E.1 b/contrib/bc/manuals/bc/E.1 index 89f95ef81cfa..fea1cecdc4c5 100644 --- a/contrib/bc/manuals/bc/E.1 +++ b/contrib/bc/manuals/bc/E.1 @@ -1,1817 +1,1817 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator and the corresponding assignment operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]BC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP bc(1) supports interactive command-line editing. .PP If bc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]BC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If history is enabled, previous lines can be recalled and edited with the arrow keys. .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/E.1.md b/contrib/bc/manuals/bc/E.1.md index 30451dabd64b..3631267f2dc9 100644 --- a/contrib/bc/manuals/bc/E.1.md +++ b/contrib/bc/manuals/bc/E.1.md @@ -1,1513 +1,1513 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, and **scale** into stacks. This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. However, since using this flag means that functions cannot set **ibase**, **obase**, or **scale** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, or **scale** globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library before running any code, including any expressions or files specified on the command line. To learn what is in the library, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **last** * **limits** * **maxibase** * **maxobase** * **maxscale** * **modexp** * **print** * **read** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **last** or a single dot (**.**) Number 6 is a **non-portable extension**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below are available when the **-l** or **-\-mathlib** command-line flags are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator and the corresponding assignment operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **BC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when bc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause bc(1) to clean up and exit. # COMMAND LINE HISTORY bc(1) supports interactive command-line editing. If bc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **BC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). If history is enabled, previous lines can be recalled and edited with the arrow keys. **Note**: tabs are converted to 8 spaces. # LOCALES This bc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. This bc(1) supports error messages for different locales, and thus, it supports **LC_MESSAGES**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/EH.1 b/contrib/bc/manuals/bc/EH.1 index e006a5c41c84..2a36cab7f778 100644 --- a/contrib/bc/manuals/bc/EH.1 +++ b/contrib/bc/manuals/bc/EH.1 @@ -1,1788 +1,1788 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator and the corresponding assignment operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/EH.1.md b/contrib/bc/manuals/bc/EH.1.md index 28f874c36ebe..f2f49ea76944 100644 --- a/contrib/bc/manuals/bc/EH.1.md +++ b/contrib/bc/manuals/bc/EH.1.md @@ -1,1487 +1,1487 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, and **scale** into stacks. This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. However, since using this flag means that functions cannot set **ibase**, **obase**, or **scale** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, or **scale** globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library before running any code, including any expressions or files specified on the command line. To learn what is in the library, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **last** * **limits** * **maxibase** * **maxobase** * **maxscale** * **modexp** * **print** * **read** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **last** or a single dot (**.**) Number 6 is a **non-portable extension**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below are available when the **-l** or **-\-mathlib** command-line flags are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator and the corresponding assignment operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. # LOCALES This bc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. This bc(1) supports error messages for different locales, and thus, it supports **LC_MESSAGES**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/EHN.1 b/contrib/bc/manuals/bc/EHN.1 index e77148710255..75768a03c141 100644 --- a/contrib/bc/manuals/bc/EHN.1 +++ b/contrib/bc/manuals/bc/EHN.1 @@ -1,1781 +1,1781 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator and the corresponding assignment operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/EHN.1.md b/contrib/bc/manuals/bc/EHN.1.md index 09288c577a5c..a38503cc8a24 100644 --- a/contrib/bc/manuals/bc/EHN.1.md +++ b/contrib/bc/manuals/bc/EHN.1.md @@ -1,1479 +1,1479 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, and **scale** into stacks. This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. However, since using this flag means that functions cannot set **ibase**, **obase**, or **scale** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, or **scale** globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library before running any code, including any expressions or files specified on the command line. To learn what is in the library, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **last** * **limits** * **maxibase** * **maxobase** * **maxscale** * **modexp** * **print** * **read** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **last** or a single dot (**.**) Number 6 is a **non-portable extension**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below are available when the **-l** or **-\-mathlib** command-line flags are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator and the corresponding assignment operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/EN.1 b/contrib/bc/manuals/bc/EN.1 index 99ecfd2056e2..9c0158583199 100644 --- a/contrib/bc/manuals/bc/EN.1 +++ b/contrib/bc/manuals/bc/EN.1 @@ -1,1810 +1,1810 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R] globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator and the corresponding assignment operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]BC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP bc(1) supports interactive command-line editing. .PP If bc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]BC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If history is enabled, previous lines can be recalled and edited with the arrow keys. .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/EN.1.md b/contrib/bc/manuals/bc/EN.1.md index 52bacfa5df63..28b558d8b21d 100644 --- a/contrib/bc/manuals/bc/EN.1.md +++ b/contrib/bc/manuals/bc/EN.1.md @@ -1,1505 +1,1505 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, and **scale** into stacks. This has the effect that a copy of the current value of all three are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. However, since using this flag means that functions cannot set **ibase**, **obase**, or **scale** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, or **scale** globally for any other purpose, it could be split into one to three functions (based on how many globals it sets) and each of those functions could return the desired value for a global. If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library before running any code, including any expressions or files specified on the command line. To learn what is in the library, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **last** * **limits** * **maxibase** * **maxobase** * **maxscale** * **modexp** * **print** * **read** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **last** or a single dot (**.**) Number 6 is a **non-portable extension**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **=** **+=** **-=** **\*=** **/=** **%=** **\^=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below are available when the **-l** or **-\-mathlib** command-line flags are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator and the corresponding assignment operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **BC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when bc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause bc(1) to clean up and exit. # COMMAND LINE HISTORY bc(1) supports interactive command-line editing. If bc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **BC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). If history is enabled, previous lines can be recalled and edited with the arrow keys. **Note**: tabs are converted to 8 spaces. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/H.1 b/contrib/bc/manuals/bc/H.1 index 856d2c604dee..cbd93da0df81 100644 --- a/contrib/bc/manuals/bc/H.1 +++ b/contrib/bc/manuals/bc/H.1 @@ -1,2955 +1,2955 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP (\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the extended math library. See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP For functions that set \f[B]seed\f[R], the value assigned to \f[B]seed\f[R] is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once \f[B]seed\f[R] has been set. .PP If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] seed = seed \f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]irand\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxrand\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]rand\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]seed\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]seed\f[R] .IP "7." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if \f[B]seed\f[R] is queried again immediately. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will \f[I]not\f[R] produce unique sequences of pseudo-random numbers. The value of \f[B]seed\f[R] will change after any use of the \f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the \f[I]Operands\f[R] subsection below), except if the parameter passed to \f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "23." 4 \f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). Using this operand will change the value of \f[B]seed\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "24." 4 \f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and the value of \f[B]E\f[R] (exclusive). If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s \f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of \f[B]seed\f[R], unless the value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. This is a \f[B]non-portable extension\f[R]. .IP "25." 4 \f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. This is a \f[B]non-portable extension\f[R]. .PP The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to \f[I]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to \f[B]0.0042890\f[R]. .PP Using scientific notation is an error or warning if the \f[B]-s\f[R] or \f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if bc(1) is given the number string \f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP Description: \f[B]truncation\f[R] .RE .TP \f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]set precision\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The \f[B]truncation\f[R] operator returns a copy of the given expression with all of its \f[I]scale\f[R] removed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The \f[B]set precision\f[R] operator takes two expressions and returns a copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]<<\f[R] The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the right. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]>>\f[R] The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the left. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .PP The \f[B]assignment\f[R] operators that correspond to operators that are extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math library (see the \f[I]Extended Library\f[R] subsection below), are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given, except that the extended math library is not available when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Extended Library .PP The extended library is \f[I]not\f[R] loaded when the \f[B]-s\f[R]/\f[B]--standard\f[R] or \f[B]-w\f[R]/\f[B]--warn\f[R] options are given since they are not part of the library defined by the standard (see the \f[B]STANDARDS\f[R] section). .PP The extended library is a \f[B]non-portable extension\f[R]. .TP \f[B]p(x, y)\f[R] Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] is not an integer, and returns the result to the current \f[B]scale\f[R]. .RS .PP It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is \f[B]0\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round half away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP \f[B]ceil(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP \f[B]f(x)\f[R] Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP \f[B]perm(n, k)\f[R] Returns the permutation of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]comb(n, k)\f[R] Returns the combination of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]l2(x)\f[R] Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l10(x)\f[R] Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]log(x, b)\f[R] Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cbrt(x)\f[R] Returns the cube root of \f[B]x\f[R]. .TP \f[B]root(x, n)\f[R] Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even and \f[B]x\f[R] is negative. .RE .TP \f[B]gcd(a, b)\f[R] Returns the greatest common divisor (factor) of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]lcm(a, b)\f[R] Returns the least common multiple of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]pi(p)\f[R] Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]t(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]sin(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cos(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]tan(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r2d(x)\f[R] Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]d2r(x)\f[R] Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]frand(p)\f[R] Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]. If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .TP \f[B]ifrand(i, p)\f[R] Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If the absolute value of \f[B]i\f[R] is greater than or equal to \f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] is returned and \f[B]seed\f[R] is not changed. .TP \f[B]srand(x)\f[R] Returns \f[B]x\f[R] with its sign flipped with probability \f[B]0.5\f[R]. In other words, it randomizes the sign of \f[B]x\f[R]. .TP \f[B]brand()\f[R] Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP \f[B]band(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]and\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]or\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bxor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]xor\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshl(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of \f[B]a\f[R] bit-shifted left by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshr(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the truncated result of \f[B]a\f[R] bit-shifted right by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnotn(x, n)\f[R] Takes the truncated absolute value of \f[B]x\f[R] and does a bitwise not as though it has the same number of bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot8(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]8\f[R] binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot16(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]16\f[R] binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot32(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]32\f[R] binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot64(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]64\f[R] binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brevn(x, n)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the same number of 8-bit bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev8(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 8 binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev16(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 16 binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev32(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 32 binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev64(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 64 binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]broln(x, p, n)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol8(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol16(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol32(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol64(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brorn(x, p, n)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror8(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror16(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror32(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror64(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmodn(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of the multiplication of the truncated absolute value of \f[B]n\f[R] and \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod8(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod16(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod32(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod64(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bunrev(t)\f[R] Assumes \f[B]t\f[R] is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. .RS .PP This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. .RE .TP \f[B]plz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]plznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]pnlz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]pnlznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of \f[B]x\f[R]. .TP \f[B]sbytes(x)\f[R] Returns the numbers of signed, two\[cq]s-complement integer bytes required to hold the truncated value of \f[B]x\f[R]. .TP \f[B]s2u(x)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer and returns the non-negative integer that would have the same representation in binary. .TP \f[B]s2un(x,n)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer with \f[B]n\f[R] bytes and returns the non-negative integer that would have the same representation in binary. If \f[B]x\f[R] cannot fit into \f[B]n\f[R] 2\[cq]s-complement signed bytes, it is truncated to fit. .TP \f[B]hex(x)\f[R] Outputs the hexadecimal (base \f[B]16\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary(x)\f[R] Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output(x, b)\f[R] Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uintn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]intn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]hex_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_byte(x, i)\f[R] Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes - 1\f[R] is the most significant byte. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 \f[B]l2(x)\f[R] .IP \[bu] 2 \f[B]l10(x)\f[R] .IP \[bu] 2 \f[B]log(x, b)\f[R] .IP \[bu] 2 \f[B]pi(p)\f[R] .IP \[bu] 2 \f[B]t(x)\f[R] .IP \[bu] 2 \f[B]a2(y, x)\f[R] .IP \[bu] 2 \f[B]sin(x)\f[R] .IP \[bu] 2 \f[B]cos(x)\f[R] .IP \[bu] 2 \f[B]tan(x)\f[R] .IP \[bu] 2 \f[B]atan(x)\f[R] .IP \[bu] 2 \f[B]atan2(y, x)\f[R] .IP \[bu] 2 \f[B]r2d(x)\f[R] .IP \[bu] 2 \f[B]d2r(x)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]rand()\f[R] operand. Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their corresponding assignment operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/H.1.md b/contrib/bc/manuals/bc/H.1.md index 4a1278dbec86..ac35def9019f 100644 --- a/contrib/bc/manuals/bc/H.1.md +++ b/contrib/bc/manuals/bc/H.1.md @@ -1,2479 +1,2479 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, **scale**, and **seed** into stacks. This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. (**Note**: the function **output(x,b)** exists in the extended math library. See the **LIBRARY** section.) However, since using this flag means that functions cannot set **ibase**, **obase**, **scale**, or **seed** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, **scale**, or **seed** globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. For functions that set **seed**, the value assigned to **seed** is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once **seed** has been set. If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same **seed**, it can use the following line: seed = seed If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. To learn what is in the libraries, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **irand** * **last** * **limits** * **maxibase** * **maxobase** * **maxrand** * **maxscale** * **modexp** * **print** * **rand** * **read** * **seed** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **seed** 7. **last** or a single dot (**.**) Numbers 6 and 7 are **non-portable extensions**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is assigned to **seed** and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if **seed** is queried again immediately. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will *not* produce unique sequences of pseudo-random numbers. The value of **seed** will change after any use of the **rand()** and **irand(E)** operands (see the *Operands* subsection below), except if the parameter passed to **irand(E)** is **0**, **1**, or negative. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 22. **rand()**: A pseudo-random integer between **0** (inclusive) and **BC_RAND_MAX** (inclusive). Using this operand will change the value of **seed**. This is a **non-portable extension**. 23. **irand(E)**: A pseudo-random integer between **0** (inclusive) and the value of **E** (exclusive). If **E** is negative or is a non-integer (**E**'s *scale* is not **0**), an error is raised, and bc(1) resets (see the **RESET** section) while **seed** remains unchanged. If **E** is larger than **BC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **BC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of **seed**, unless the value of **E** is **0** or **1**. In that case, **0** is returned, and **seed** is *not* changed. This is a **non-portable extension**. 24. **maxrand()**: The max integer returned by **rand()**. This is a **non-portable extension**. The integers generated by **rand()** and **irand(E)** are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. **Note**: The values returned by the pseudo-random number generator with **rand()** and **irand(E)** are guaranteed to *NOT* be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, bc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and bc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if bc(1) is given the number string **10e-4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\$** : Type: Postfix Associativity: None Description: **truncation** **\@** : Type: Binary Associativity: Right Description: **set precision** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **\<\<** **\>\>** : Type: Binary Associativity: Left Description: **shift left**, **shift right** **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\$** : The **truncation** operator returns a copy of the given expression with all of its *scale* removed. This is a **non-portable extension**. **\@** : The **set precision** operator takes two expressions and returns a copy of the first with its *scale* equal to the value of the second expression. That could either mean that the number is returned without change (if the *scale* of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **\<\<** : The **left shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the right. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\>\>** : The **right shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the left. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. The **assignment** operators that correspond to operators that are extensions are themselves **non-portable extensions**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning **0** to **obase**, and engineering notation is activated by assigning **1** to **obase**. To deactivate them, just assign a different value to **obase**. Scientific notation and engineering notation are disabled if bc(1) is run with either the **-s** or **-w** command-line options (or equivalents). Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below, including the functions in the extended math library (see the *Extended Library* subsection below), are available when the **-l** or **-\-mathlib** command-line flags are given, except that the extended math library is not available when the **-s** option, the **-w** option, or equivalents are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Extended Library The extended library is *not* loaded when the **-s**/**-\-standard** or **-w**/**-\-warn** options are given since they are not part of the library defined by the standard (see the **STANDARDS** section). The extended library is a **non-portable extension**. **p(x, y)** : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. It is an error if **y** is negative and **x** is **0**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round half away from **0** (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). **ceil(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round away from **0** (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). **f(x)** : Returns the factorial of the truncated absolute value of **x**. **perm(n, k)** : Returns the permutation of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **comb(n, k)** : Returns the combination of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **l2(x)** : Returns the logarithm base **2** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **l10(x)** : Returns the logarithm base **10** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **log(x, b)** : Returns the logarithm base **b** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cbrt(x)** : Returns the cube root of **x**. **root(x, n)** : Calculates the truncated value of **n**, **r**, and returns the **r**th root of **x** to the current **scale**. If **r** is **0** or negative, this raises an error and causes bc(1) to reset (see the **RESET** section). It also raises an error and causes bc(1) to reset if **r** is even and **x** is negative. **gcd(a, b)** : Returns the greatest common divisor (factor) of the truncated absolute value of **a** and the truncated absolute value of **b**. **lcm(a, b)** : Returns the least common multiple of the truncated absolute value of **a** and the truncated absolute value of **b**. **pi(p)** : Returns **pi** to **p** decimal places. This is a transcendental function (see the *Transcendental Functions* subsection below). **t(x)** : Returns the tangent of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is a transcendental function (see the *Transcendental Functions* subsection below). **sin(x)** : Returns the sine of **x**, which is assumed to be in radians. This is an alias of **s(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cos(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is an alias of **c(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **tan(x)** : Returns the tangent of **x**, which is assumed to be in radians. If **x** is equal to **1** or **-1**, this raises an error and causes bc(1) to reset (see the **RESET** section). This is an alias of **t(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan(x)** : Returns the arctangent of **x**, in radians. This is an alias of **a(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is an alias of **a2(y, x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r2d(x)** : Converts **x** from radians to degrees and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **d2r(x)** : Converts **x** from degrees to radians and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **frand(p)** : Generates a pseudo-random number between **0** (inclusive) and **1** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If **p** is not **0**, then calling this function will change the value of **seed**. If **p** is **0**, then **0** is returned, and **seed** is *not* changed. **ifrand(i, p)** : Generates a pseudo-random number that is between **0** (inclusive) and the truncated absolute value of **i** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If the absolute value of **i** is greater than or equal to **2**, and **p** is not **0**, then calling this function will change the value of **seed**; otherwise, **0** is returned and **seed** is not changed. **srand(x)** : Returns **x** with its sign flipped with probability **0.5**. In other words, it randomizes the sign of **x**. **brand()** : Returns a random boolean value (either **0** or **1**). **band(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **and** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **or** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bxor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **xor** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshl(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of **a** bit-shifted left by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshr(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the truncated result of **a** bit-shifted right by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bnotn(x, n)** : Takes the truncated absolute value of **x** and does a bitwise not as though it has the same number of bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot8(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **8** binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot16(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **16** binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot32(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **32** binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot64(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **64** binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brevn(x, n)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the same number of 8-bit bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev8(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 8 binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev16(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 16 binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev32(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 32 binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev64(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 64 binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **broln(x, p, n)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol8(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol16(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol32(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol64(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brorn(x, p, n)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror8(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror16(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror32(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror64(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmodn(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of the multiplication of the truncated absolute value of **n** and **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod8(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod16(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod32(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod64(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bunrev(t)** : Assumes **t** is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. **plz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **plznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **pnlz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **pnlznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **ubytes(x)** : Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of **x**. **sbytes(x)** : Returns the numbers of signed, two's-complement integer bytes required to hold the truncated value of **x**. **s2u(x)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer and returns the non-negative integer that would have the same representation in binary. **s2un(x,n)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer with **n** bytes and returns the non-negative integer that would have the same representation in binary. If **x** cannot fit into **n** 2's-complement signed bytes, it is truncated to fit. **hex(x)** : Outputs the hexadecimal (base **16**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary(x)** : Outputs the binary (base **2**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output(x, b)** : Outputs the base **b** representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uintn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **intn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **hex_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in hexadecimal using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in binary using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in the current **obase** (see the **SYNTAX** section) using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_byte(x, i)** : Outputs byte **i** of the truncated absolute value of **x**, where **0** is the least significant byte and **number_of_bytes - 1** is the most significant byte. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** The transcendental functions in the extended math library are: * **l2(x)** * **l10(x)** * **log(x, b)** * **pi(p)** * **t(x)** * **a2(y, x)** * **sin(x)** * **cos(x)** * **tan(x)** * **atan(x)** * **atan2(y, x)** * **r2d(x)** * **d2r(x)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. **BC_RAND_MAX** : The maximum integer (inclusive) returned by the **rand()** operand. Set at **2\^BC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**\<\<**), and right shift (**\>\>**) operators and their corresponding assignment operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. # LOCALES This bc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. This bc(1) supports error messages for different locales, and thus, it supports **LC_MESSAGES**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/HN.1 b/contrib/bc/manuals/bc/HN.1 index 5356950aa68c..5893d2a7f9a9 100644 --- a/contrib/bc/manuals/bc/HN.1 +++ b/contrib/bc/manuals/bc/HN.1 @@ -1,2948 +1,2948 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP (\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the extended math library. See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP For functions that set \f[B]seed\f[R], the value assigned to \f[B]seed\f[R] is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once \f[B]seed\f[R] has been set. .PP If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] seed = seed \f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]irand\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxrand\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]rand\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]seed\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]seed\f[R] .IP "7." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if \f[B]seed\f[R] is queried again immediately. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will \f[I]not\f[R] produce unique sequences of pseudo-random numbers. The value of \f[B]seed\f[R] will change after any use of the \f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the \f[I]Operands\f[R] subsection below), except if the parameter passed to \f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "23." 4 \f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). Using this operand will change the value of \f[B]seed\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "24." 4 \f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and the value of \f[B]E\f[R] (exclusive). If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s \f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of \f[B]seed\f[R], unless the value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. This is a \f[B]non-portable extension\f[R]. .IP "25." 4 \f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. This is a \f[B]non-portable extension\f[R]. .PP The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to \f[I]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to \f[B]0.0042890\f[R]. .PP Using scientific notation is an error or warning if the \f[B]-s\f[R] or \f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if bc(1) is given the number string \f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP Description: \f[B]truncation\f[R] .RE .TP \f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]set precision\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The \f[B]truncation\f[R] operator returns a copy of the given expression with all of its \f[I]scale\f[R] removed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The \f[B]set precision\f[R] operator takes two expressions and returns a copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]<<\f[R] The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the right. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]>>\f[R] The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the left. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .PP The \f[B]assignment\f[R] operators that correspond to operators that are extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math library (see the \f[I]Extended Library\f[R] subsection below), are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given, except that the extended math library is not available when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Extended Library .PP The extended library is \f[I]not\f[R] loaded when the \f[B]-s\f[R]/\f[B]--standard\f[R] or \f[B]-w\f[R]/\f[B]--warn\f[R] options are given since they are not part of the library defined by the standard (see the \f[B]STANDARDS\f[R] section). .PP The extended library is a \f[B]non-portable extension\f[R]. .TP \f[B]p(x, y)\f[R] Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] is not an integer, and returns the result to the current \f[B]scale\f[R]. .RS .PP It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is \f[B]0\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round half away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP \f[B]ceil(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP \f[B]f(x)\f[R] Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP \f[B]perm(n, k)\f[R] Returns the permutation of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]comb(n, k)\f[R] Returns the combination of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]l2(x)\f[R] Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l10(x)\f[R] Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]log(x, b)\f[R] Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cbrt(x)\f[R] Returns the cube root of \f[B]x\f[R]. .TP \f[B]root(x, n)\f[R] Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even and \f[B]x\f[R] is negative. .RE .TP \f[B]gcd(a, b)\f[R] Returns the greatest common divisor (factor) of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]lcm(a, b)\f[R] Returns the least common multiple of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]pi(p)\f[R] Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]t(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]sin(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cos(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]tan(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r2d(x)\f[R] Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]d2r(x)\f[R] Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]frand(p)\f[R] Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]. If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .TP \f[B]ifrand(i, p)\f[R] Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If the absolute value of \f[B]i\f[R] is greater than or equal to \f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] is returned and \f[B]seed\f[R] is not changed. .TP \f[B]srand(x)\f[R] Returns \f[B]x\f[R] with its sign flipped with probability \f[B]0.5\f[R]. In other words, it randomizes the sign of \f[B]x\f[R]. .TP \f[B]brand()\f[R] Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP \f[B]band(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]and\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]or\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bxor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]xor\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshl(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of \f[B]a\f[R] bit-shifted left by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshr(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the truncated result of \f[B]a\f[R] bit-shifted right by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnotn(x, n)\f[R] Takes the truncated absolute value of \f[B]x\f[R] and does a bitwise not as though it has the same number of bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot8(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]8\f[R] binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot16(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]16\f[R] binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot32(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]32\f[R] binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot64(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]64\f[R] binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brevn(x, n)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the same number of 8-bit bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev8(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 8 binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev16(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 16 binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev32(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 32 binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev64(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 64 binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]broln(x, p, n)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol8(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol16(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol32(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol64(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brorn(x, p, n)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror8(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror16(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror32(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror64(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmodn(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of the multiplication of the truncated absolute value of \f[B]n\f[R] and \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod8(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod16(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod32(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod64(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bunrev(t)\f[R] Assumes \f[B]t\f[R] is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. .RS .PP This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. .RE .TP \f[B]plz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]plznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]pnlz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]pnlznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of \f[B]x\f[R]. .TP \f[B]sbytes(x)\f[R] Returns the numbers of signed, two\[cq]s-complement integer bytes required to hold the truncated value of \f[B]x\f[R]. .TP \f[B]s2u(x)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer and returns the non-negative integer that would have the same representation in binary. .TP \f[B]s2un(x,n)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer with \f[B]n\f[R] bytes and returns the non-negative integer that would have the same representation in binary. If \f[B]x\f[R] cannot fit into \f[B]n\f[R] 2\[cq]s-complement signed bytes, it is truncated to fit. .TP \f[B]hex(x)\f[R] Outputs the hexadecimal (base \f[B]16\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary(x)\f[R] Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output(x, b)\f[R] Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uintn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]intn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]hex_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_byte(x, i)\f[R] Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes - 1\f[R] is the most significant byte. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 \f[B]l2(x)\f[R] .IP \[bu] 2 \f[B]l10(x)\f[R] .IP \[bu] 2 \f[B]log(x, b)\f[R] .IP \[bu] 2 \f[B]pi(p)\f[R] .IP \[bu] 2 \f[B]t(x)\f[R] .IP \[bu] 2 \f[B]a2(y, x)\f[R] .IP \[bu] 2 \f[B]sin(x)\f[R] .IP \[bu] 2 \f[B]cos(x)\f[R] .IP \[bu] 2 \f[B]tan(x)\f[R] .IP \[bu] 2 \f[B]atan(x)\f[R] .IP \[bu] 2 \f[B]atan2(y, x)\f[R] .IP \[bu] 2 \f[B]r2d(x)\f[R] .IP \[bu] 2 \f[B]d2r(x)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]rand()\f[R] operand. Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their corresponding assignment operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/HN.1.md b/contrib/bc/manuals/bc/HN.1.md index 8dd0674512ac..82a99addd344 100644 --- a/contrib/bc/manuals/bc/HN.1.md +++ b/contrib/bc/manuals/bc/HN.1.md @@ -1,2471 +1,2471 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, **scale**, and **seed** into stacks. This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. (**Note**: the function **output(x,b)** exists in the extended math library. See the **LIBRARY** section.) However, since using this flag means that functions cannot set **ibase**, **obase**, **scale**, or **seed** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, **scale**, or **seed** globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. For functions that set **seed**, the value assigned to **seed** is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once **seed** has been set. If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same **seed**, it can use the following line: seed = seed If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. To learn what is in the libraries, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **irand** * **last** * **limits** * **maxibase** * **maxobase** * **maxrand** * **maxscale** * **modexp** * **print** * **rand** * **read** * **seed** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **seed** 7. **last** or a single dot (**.**) Numbers 6 and 7 are **non-portable extensions**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is assigned to **seed** and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if **seed** is queried again immediately. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will *not* produce unique sequences of pseudo-random numbers. The value of **seed** will change after any use of the **rand()** and **irand(E)** operands (see the *Operands* subsection below), except if the parameter passed to **irand(E)** is **0**, **1**, or negative. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 22. **rand()**: A pseudo-random integer between **0** (inclusive) and **BC_RAND_MAX** (inclusive). Using this operand will change the value of **seed**. This is a **non-portable extension**. 23. **irand(E)**: A pseudo-random integer between **0** (inclusive) and the value of **E** (exclusive). If **E** is negative or is a non-integer (**E**'s *scale* is not **0**), an error is raised, and bc(1) resets (see the **RESET** section) while **seed** remains unchanged. If **E** is larger than **BC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **BC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of **seed**, unless the value of **E** is **0** or **1**. In that case, **0** is returned, and **seed** is *not* changed. This is a **non-portable extension**. 24. **maxrand()**: The max integer returned by **rand()**. This is a **non-portable extension**. The integers generated by **rand()** and **irand(E)** are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. **Note**: The values returned by the pseudo-random number generator with **rand()** and **irand(E)** are guaranteed to *NOT* be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, bc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and bc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if bc(1) is given the number string **10e-4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\$** : Type: Postfix Associativity: None Description: **truncation** **\@** : Type: Binary Associativity: Right Description: **set precision** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **\<\<** **\>\>** : Type: Binary Associativity: Left Description: **shift left**, **shift right** **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\$** : The **truncation** operator returns a copy of the given expression with all of its *scale* removed. This is a **non-portable extension**. **\@** : The **set precision** operator takes two expressions and returns a copy of the first with its *scale* equal to the value of the second expression. That could either mean that the number is returned without change (if the *scale* of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **\<\<** : The **left shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the right. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\>\>** : The **right shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the left. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. The **assignment** operators that correspond to operators that are extensions are themselves **non-portable extensions**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning **0** to **obase**, and engineering notation is activated by assigning **1** to **obase**. To deactivate them, just assign a different value to **obase**. Scientific notation and engineering notation are disabled if bc(1) is run with either the **-s** or **-w** command-line options (or equivalents). Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below, including the functions in the extended math library (see the *Extended Library* subsection below), are available when the **-l** or **-\-mathlib** command-line flags are given, except that the extended math library is not available when the **-s** option, the **-w** option, or equivalents are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Extended Library The extended library is *not* loaded when the **-s**/**-\-standard** or **-w**/**-\-warn** options are given since they are not part of the library defined by the standard (see the **STANDARDS** section). The extended library is a **non-portable extension**. **p(x, y)** : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. It is an error if **y** is negative and **x** is **0**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round half away from **0** (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). **ceil(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round away from **0** (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). **f(x)** : Returns the factorial of the truncated absolute value of **x**. **perm(n, k)** : Returns the permutation of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **comb(n, k)** : Returns the combination of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **l2(x)** : Returns the logarithm base **2** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **l10(x)** : Returns the logarithm base **10** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **log(x, b)** : Returns the logarithm base **b** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cbrt(x)** : Returns the cube root of **x**. **root(x, n)** : Calculates the truncated value of **n**, **r**, and returns the **r**th root of **x** to the current **scale**. If **r** is **0** or negative, this raises an error and causes bc(1) to reset (see the **RESET** section). It also raises an error and causes bc(1) to reset if **r** is even and **x** is negative. **gcd(a, b)** : Returns the greatest common divisor (factor) of the truncated absolute value of **a** and the truncated absolute value of **b**. **lcm(a, b)** : Returns the least common multiple of the truncated absolute value of **a** and the truncated absolute value of **b**. **pi(p)** : Returns **pi** to **p** decimal places. This is a transcendental function (see the *Transcendental Functions* subsection below). **t(x)** : Returns the tangent of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is a transcendental function (see the *Transcendental Functions* subsection below). **sin(x)** : Returns the sine of **x**, which is assumed to be in radians. This is an alias of **s(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cos(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is an alias of **c(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **tan(x)** : Returns the tangent of **x**, which is assumed to be in radians. If **x** is equal to **1** or **-1**, this raises an error and causes bc(1) to reset (see the **RESET** section). This is an alias of **t(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan(x)** : Returns the arctangent of **x**, in radians. This is an alias of **a(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is an alias of **a2(y, x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r2d(x)** : Converts **x** from radians to degrees and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **d2r(x)** : Converts **x** from degrees to radians and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **frand(p)** : Generates a pseudo-random number between **0** (inclusive) and **1** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If **p** is not **0**, then calling this function will change the value of **seed**. If **p** is **0**, then **0** is returned, and **seed** is *not* changed. **ifrand(i, p)** : Generates a pseudo-random number that is between **0** (inclusive) and the truncated absolute value of **i** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If the absolute value of **i** is greater than or equal to **2**, and **p** is not **0**, then calling this function will change the value of **seed**; otherwise, **0** is returned and **seed** is not changed. **srand(x)** : Returns **x** with its sign flipped with probability **0.5**. In other words, it randomizes the sign of **x**. **brand()** : Returns a random boolean value (either **0** or **1**). **band(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **and** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **or** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bxor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **xor** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshl(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of **a** bit-shifted left by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshr(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the truncated result of **a** bit-shifted right by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bnotn(x, n)** : Takes the truncated absolute value of **x** and does a bitwise not as though it has the same number of bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot8(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **8** binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot16(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **16** binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot32(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **32** binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot64(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **64** binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brevn(x, n)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the same number of 8-bit bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev8(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 8 binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev16(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 16 binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev32(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 32 binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev64(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 64 binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **broln(x, p, n)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol8(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol16(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol32(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol64(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brorn(x, p, n)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror8(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror16(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror32(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror64(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmodn(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of the multiplication of the truncated absolute value of **n** and **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod8(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod16(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod32(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod64(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bunrev(t)** : Assumes **t** is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. **plz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **plznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **pnlz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **pnlznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **ubytes(x)** : Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of **x**. **sbytes(x)** : Returns the numbers of signed, two's-complement integer bytes required to hold the truncated value of **x**. **s2u(x)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer and returns the non-negative integer that would have the same representation in binary. **s2un(x,n)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer with **n** bytes and returns the non-negative integer that would have the same representation in binary. If **x** cannot fit into **n** 2's-complement signed bytes, it is truncated to fit. **hex(x)** : Outputs the hexadecimal (base **16**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary(x)** : Outputs the binary (base **2**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output(x, b)** : Outputs the base **b** representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uintn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **intn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **hex_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in hexadecimal using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in binary using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in the current **obase** (see the **SYNTAX** section) using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_byte(x, i)** : Outputs byte **i** of the truncated absolute value of **x**, where **0** is the least significant byte and **number_of_bytes - 1** is the most significant byte. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** The transcendental functions in the extended math library are: * **l2(x)** * **l10(x)** * **log(x, b)** * **pi(p)** * **t(x)** * **a2(y, x)** * **sin(x)** * **cos(x)** * **tan(x)** * **atan(x)** * **atan2(y, x)** * **r2d(x)** * **d2r(x)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. **BC_RAND_MAX** : The maximum integer (inclusive) returned by the **rand()** operand. Set at **2\^BC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**\<\<**), and right shift (**\>\>**) operators and their corresponding assignment operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bc/N.1 b/contrib/bc/manuals/bc/N.1 index 517e403aa6ca..791f47407001 100644 --- a/contrib/bc/manuals/bc/N.1 +++ b/contrib/bc/manuals/bc/N.1 @@ -1,2977 +1,2977 @@ .\" .\" 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. .\" .TH "BC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH NAME .PP bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP \f[B]bc\f[R] [\f[B]-cCghilPqRsvVw\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--global-stacks\f[R]] [\f[B]--help\f[R]] [\f[B]--interactive\f[R]] [\f[B]--mathlib\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--quiet\f[R]] [\f[B]--standard\f[R]] [\f[B]--warn\f[R]] [\f[B]--version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the \f[B]STANDARDS\f[R] section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from \f[B]stdin\f[R]. .PP This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. .PP \f[B]Note\f[R]: If running this bc(1) on \f[I]any\f[R] script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option \f[B]-r\f[R] \f[I]keyword\f[R], where \f[I]keyword\f[R] is the keyword that is used as a name in the script. For more information, see the \f[B]OPTIONS\f[R] section. .PP If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the \f[B]BUGS\f[R] section. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see the \f[B]-f\f[R] and \f[B]--file\f[R] options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]BC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see the \f[B]-e\f[R] and \f[B]--expression\f[R] options), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]BC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, bc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, bc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-g\f[R], \f[B]--global-stacks\f[R] Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] define void output(x, b) { obase=b x } \f[R] .fi .PP instead of like this: .IP .nf \f[C] define void output(x, b) { auto c c=obase obase=b x obase=c } \f[R] .fi .PP This makes writing functions much easier. .PP (\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the extended math library. See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: .IP .nf \f[C] alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] \f[R] .fi .PP Second, if the purpose of a function is to set \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. .PP For functions that set \f[B]seed\f[R], the value assigned to \f[B]seed\f[R] is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once \f[B]seed\f[R] has been set. .PP If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] seed = seed \f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-l\f[R], \f[B]--mathlib\f[R] Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP These options override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-q\f[R], \f[B]--quiet\f[R] This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the \f[B]-v\f[R], \f[B]-V\f[R], or \f[B]--version\f[R] options are given unless the \f[B]BC_BANNER\f[R] environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If \f[I]any\f[R] of that is the case, then this option \f[I]does\f[R] prevent bc(1) from printing the header. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]read()\f[R] built-in function is called. .PP These options \f[I]do\f[R] override the \f[B]BC_PROMPT\f[R] and \f[B]BC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-r\f[R] \f[I]keyword\f[R], \f[B]--redefine\f[R]=\f[I]keyword\f[R] Redefines \f[I]keyword\f[R] in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. .RS .PP The keywords this bc(1) allows to be redefined are: .IP \[bu] 2 \f[B]abs\f[R] .IP \[bu] 2 \f[B]asciify\f[R] .IP \[bu] 2 \f[B]continue\f[R] .IP \[bu] 2 \f[B]divmod\f[R] .IP \[bu] 2 \f[B]else\f[R] .IP \[bu] 2 \f[B]halt\f[R] .IP \[bu] 2 \f[B]irand\f[R] .IP \[bu] 2 \f[B]last\f[R] .IP \[bu] 2 \f[B]limits\f[R] .IP \[bu] 2 \f[B]maxibase\f[R] .IP \[bu] 2 \f[B]maxobase\f[R] .IP \[bu] 2 \f[B]maxrand\f[R] .IP \[bu] 2 \f[B]maxscale\f[R] .IP \[bu] 2 \f[B]modexp\f[R] .IP \[bu] 2 \f[B]print\f[R] .IP \[bu] 2 \f[B]rand\f[R] .IP \[bu] 2 \f[B]read\f[R] .IP \[bu] 2 \f[B]seed\f[R] .IP \[bu] 2 \f[B]stream\f[R] .PP If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. .PP Keywords are \f[I]not\f[R] redefined when parsing the builtin math library (see the \f[B]LIBRARY\f[R] section). .PP It is a fatal error to redefine keywords mandated by the POSIX standard (see the \f[B]STANDARDS\f[R] section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-s\f[R], \f[B]--standard\f[R] Process exactly the language defined by the standard (see the \f[B]STANDARDS\f[R] section) and error if any extensions are used. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-w\f[R], \f[B]--warn\f[R] Like \f[B]-s\f[R] and \f[B]--standard\f[R], except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes bc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then bc(1) reads from \f[B]stdin\f[R]. .PP However, there are a few caveats to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, \f[B]if\f[R] statement, or loop without ending it will also cause bc(1) to not execute. .PP Second, after an \f[B]if\f[R] statement, bc(1) doesn\[cq]t know if an \f[B]else\f[R] statement will follow, so it will not execute until it knows there will not be an \f[B]else\f[R] statement. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]bc >&-\f[R], it will quit with an error. This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the \f[B]STANDARDS\f[R] section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means statement, and \f[B]I\f[R] means identifier. .PP Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores (\f[B]_\f[R]). The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a \f[B]non-portable extension\f[R]. .PP \f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. If the \f[B]-s\f[R] (\f[B]--standard\f[R]) and \f[B]-w\f[R] (\f[B]--warn\f[R]) flags were not given on the command line, the max allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. Otherwise, it is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) programs with the \f[B]maxibase()\f[R] built-in function. .PP \f[B]obase\f[R] is a global variable determining how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] built-in function. .PP bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. All \f[I]local\f[R] variables are local to the function; they are parameters or are introduced in the \f[B]auto\f[R] list of a function (see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the \f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. If a parent function has a \f[I]local\f[R] variable version of a variable that a child function considers \f[I]global\f[R], the value of that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual \f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable \f[B]last\f[R]. A single dot (\f[B].\f[R]) may also be used as a synonym for \f[B]last\f[R]. These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 Line comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 Variables: \f[B]I\f[R] .IP "2." 3 Array Elements: \f[B]I[E]\f[R] .IP "3." 3 \f[B]ibase\f[R] .IP "4." 3 \f[B]obase\f[R] .IP "5." 3 \f[B]scale\f[R] .IP "6." 3 \f[B]seed\f[R] .IP "7." 3 \f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if \f[B]seed\f[R] is queried again immediately. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will \f[I]not\f[R] produce unique sequences of pseudo-random numbers. The value of \f[B]seed\f[R] will change after any use of the \f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the \f[I]Operands\f[R] subsection below), except if the parameter passed to \f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of \f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 \f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 \f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. \f[B]E\f[R] must be non-negative. .IP " 5." 4 \f[B]length(E)\f[R]: The number of significant decimal digits in \f[B]E\f[R]. Returns \f[B]1\f[R] for \f[B]0\f[R] with no decimal places. If given a string, the length of the string is returned. Passing a string to \f[B]length(E)\f[R] is a \f[B]non-portable extension\f[R]. .IP " 6." 4 \f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 \f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 \f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 \f[B]is_number(E)\f[R]: \f[B]1\f[R] if the given argument is a number, \f[B]0\f[R] if it is a string. This is a \f[B]non-portable extension\f[R]. .IP "10." 4 \f[B]is_string(E)\f[R]: \f[B]1\f[R] if the given argument is a string, \f[B]0\f[R] if it is a number. This is a \f[B]non-portable extension\f[R]. .IP "11." 4 \f[B]modexp(E, E, E)\f[R]: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a \f[B]non-portable extension\f[R]. .IP "12." 4 \f[B]divmod(E, E, I[])\f[R]: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index \f[B]0\f[R] of the provided array (the last argument). This is a \f[B]non-portable extension\f[R]. .IP "13." 4 \f[B]asciify(E)\f[R]: If \f[B]E\f[R] is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod \f[B]256\f[R] and returns that number as a one-character string. This is a \f[B]non-portable extension\f[R]. .IP "14." 4 \f[B]asciify(I[])\f[R]: A string that is made up of the characters that would result from running \f[B]asciify(E)\f[R] on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a \f[B]non-portable extension\f[R]. .IP "15." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .IP "16." 4 \f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. The result of that expression is the result of the \f[B]read()\f[R] operand. This is a \f[B]non-portable extension\f[R]. .IP "17." 4 \f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "18." 4 \f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "19." 4 \f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "20." 4 \f[B]line_length()\f[R]: The line length set with \f[B]BC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This is a \f[B]non-portable extension\f[R]. .IP "21." 4 \f[B]global_stacks()\f[R]: \f[B]0\f[R] if global stacks are not enabled with the \f[B]-g\f[R] or \f[B]--global-stacks\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "22." 4 \f[B]leading_zero()\f[R]: \f[B]0\f[R] if leading zeroes are not enabled with the \f[B]-z\f[R] or \f[B]\[en]leading-zeroes\f[R] options, non-zero otherwise. See the \f[B]OPTIONS\f[R] section. This is a \f[B]non-portable extension\f[R]. .IP "23." 4 \f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). Using this operand will change the value of \f[B]seed\f[R]. This is a \f[B]non-portable extension\f[R]. .IP "24." 4 \f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] (inclusive) and the value of \f[B]E\f[R] (exclusive). If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s \f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of \f[B]seed\f[R], unless the value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. This is a \f[B]non-portable extension\f[R]. .IP "25." 4 \f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. This is a \f[B]non-portable extension\f[R]. .PP The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to \f[I]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet, starting from \f[B]1\f[R] (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]BC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to \f[B]0.0042890\f[R]. .PP Using scientific notation is an error or warning if the \f[B]-s\f[R] or \f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if bc(1) is given the number string \f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP \f[B]++\f[R] \f[B]--\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP \f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP \f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP Description: \f[B]truncation\f[R] .RE .TP \f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]set precision\f[R] .RE .TP \f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]power\f[R] .RE .TP \f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP \f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP \f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP Description: \f[B]assignment\f[R] .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]relational\f[R] .RE .TP \f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean and\f[R] .RE .TP \f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP \f[B]++\f[R] \f[B]--\f[R] The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP The prefix versions of these operators are more efficient; use them where possible. .RE .TP \f[B]-\f[R] The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. .TP \f[B]!\f[R] The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The \f[B]truncation\f[R] operator returns a copy of the given expression with all of its \f[I]scale\f[R] removed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The \f[B]set precision\f[R] operator takes two expressions and returns a copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]), and if it is negative, the first value must be non-zero. .RE .TP \f[B]*\f[R] The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]%\f[R] The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R] and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP The second expression must be non-zero. .RE .TP \f[B]+\f[R] The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]-\f[R] The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP \f[B]<<\f[R] The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the right. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]>>\f[R] The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its decimal point moved \f[B]b\f[R] places to the left. .RS .PP The second expression must be an integer (no \f[I]scale\f[R]) and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and \f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named Expressions\f[R] subsection). .RS .PP For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to \f[B]a\f[R]. For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to the corresponding arithmetic operator and the result is assigned to \f[B]a\f[R]. .PP The \f[B]assignment\f[R] operators that correspond to operators that are extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP \f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] and \f[B]b\f[R], and if the relation holds, according to C language semantics, the result is \f[B]1\f[R]. Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the \f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (see the \f[B]STANDARDS\f[R] section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]&&\f[R] The \f[B]boolean and\f[R] operator takes two expressions and returns \f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]||\f[R] The \f[B]boolean or\f[R] operator takes two expressions and returns \f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] otherwise. .RS .PP This is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 \f[B]E\f[R] .IP " 2." 4 \f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] \f[B]}\f[R] .IP " 3." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 \f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] \f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 \f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 \f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 \f[B]break\f[R] .IP " 9." 4 \f[B]continue\f[R] .IP "10." 4 \f[B]quit\f[R] .IP "11." 4 \f[B]halt\f[R] .IP "12." 4 \f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 \f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 \f[B]stream\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "16." 4 \f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where \f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). The \f[B]E\f[R] argument(s) may also be arrays of the form \f[B]I[]\f[R], which will automatically be turned into array references (see the \f[I]Array References\f[R] subsection of the \f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the function definition is an array reference. .PP Numbers 4, 9, 11, 12, 14, 15, and 16 are \f[B]non-portable extensions\f[R]. .PP Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant \f[B]1\f[R]. .PP The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). .PP \f[B]Warning\f[R]: The behavior of this bc(1) on \f[B]quit\f[R] is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a \f[B]quit\f[R] command is on. This bc(1) will execute any completed and executable statements that occur before the \f[B]quit\f[R] statement before exiting. .PP In other words, for the bc(1) code below: .IP .nf \f[C] for (i = 0; i < 3; ++i) i; quit \f[R] .fi .PP Other bc(1) implementations will print nothing, and this bc(1) will print \f[B]0\f[R], \f[B]1\f[R], and \f[B]2\f[R] on successive lines before exiting. .PP The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. (Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .SS Strings .PP If strings appear as a statement by themselves, they are printed without a trailing newline. .PP In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. .PP If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. .PP If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the \f[B]RESET\f[R] section). .PP Assigning strings to variables and array elements and passing them to functions are \f[B]non-portable extensions\f[R]. .SS Print Statement .PP The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: .PP \f[B]\[rs]a\f[R]: \f[B]\[rs]a\f[R] .PP \f[B]\[rs]b\f[R]: \f[B]\[rs]b\f[R] .PP \f[B]\[rs]\[rs]\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]e\f[R]: \f[B]\[rs]\f[R] .PP \f[B]\[rs]f\f[R]: \f[B]\[rs]f\f[R] .PP \f[B]\[rs]n\f[R]: \f[B]\[rs]n\f[R] .PP \f[B]\[rs]q\f[R]: \f[B]\[lq]\f[R] .PP \f[B]\[rs]r\f[R]: \f[B]\[rs]r\f[R] .PP \f[B]\[rs]t\f[R]: \f[B]\[rs]t\f[R] .PP Any other character following a backslash causes the backslash and character to be printed as-is. .PP Any non-string expression in a print statement shall be assigned to \f[B]last\f[R], like any other expression that is printed. .SS Stream Statement .PP The \[lq]expressions in a \f[B]stream\f[R] statement may also be strings. .PP If a \f[B]stream\f[R] statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the \f[B]stream\f[R] statement prints strings normally, without a newline. .PP If a \f[B]stream\f[R] statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that \f[B]i\f[R] is equal to \f[B]0\f[R], in the expression .IP .nf \f[C] a[i++] = i++ \f[R] .fi .PP the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and \f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in the expression .IP .nf \f[C] x(i++, i++) \f[R] .fi .PP the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to \f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] define I(I,...,I){ auto I,...,I S;...;S return(E) } \f[R] .fi .PP Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an array, and any \f[B]I\f[R] in the parameter list may be replaced with \f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP As a \f[B]non-portable extension\f[R], the opening brace of a \f[B]define\f[R] statement may appear on the next line. .PP As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 \f[B]return\f[R] .IP "2." 3 \f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 \f[B]return\f[R] \f[B]E\f[R] .PP The first two, or not specifying a \f[B]return\f[R] statement, is equivalent to \f[B]return (0)\f[R], unless the function is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] define void I(I,...,I){ auto I,...,I S;...;S return } \f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP The word \[lq]void\[rq] is not treated as a keyword; it is still possible to have variables, arrays, and functions named \f[B]void\f[R]. The word \[lq]void\[rq] is only treated specially right after the \f[B]define\f[R] keyword. .PP This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the form .IP .nf \f[C] *I[] \f[R] .fi .PP it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math library (see the \f[I]Extended Library\f[R] subsection below), are available when the \f[B]-l\f[R] or \f[B]--mathlib\f[R] command-line flags are given, except that the extended math library is not available when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP The standard (see the \f[B]STANDARDS\f[R] section) defines the following functions for the math library: .TP \f[B]s(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]c(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l(x)\f[R] Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]e(x)\f[R] Returns the mathematical constant \f[B]e\f[R] raised to the power of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]j(x, n)\f[R] Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .SS Extended Library .PP The extended library is \f[I]not\f[R] loaded when the \f[B]-s\f[R]/\f[B]--standard\f[R] or \f[B]-w\f[R]/\f[B]--warn\f[R] options are given since they are not part of the library defined by the standard (see the \f[B]STANDARDS\f[R] section). .PP The extended library is a \f[B]non-portable extension\f[R]. .TP \f[B]p(x, y)\f[R] Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] is not an integer, and returns the result to the current \f[B]scale\f[R]. .RS .PP It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is \f[B]0\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round half away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP \f[B]ceil(x, p)\f[R] Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to the rounding mode round away from \f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP \f[B]f(x)\f[R] Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP \f[B]perm(n, k)\f[R] Returns the permutation of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]comb(n, k)\f[R] Returns the combination of the truncated absolute value of \f[B]n\f[R] of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. If not, it returns \f[B]0\f[R]. .TP \f[B]l2(x)\f[R] Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]l10(x)\f[R] Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]log(x, b)\f[R] Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cbrt(x)\f[R] Returns the cube root of \f[B]x\f[R]. .TP \f[B]root(x, n)\f[R] Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even and \f[B]x\f[R] is negative. .RE .TP \f[B]gcd(a, b)\f[R] Returns the greatest common divisor (factor) of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]lcm(a, b)\f[R] Returns the least common multiple of the truncated absolute value of \f[B]a\f[R] and the truncated absolute value of \f[B]b\f[R]. .TP \f[B]pi(p)\f[R] Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]t(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]a2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]sin(x)\f[R] Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]cos(x)\f[R] Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]tan(x)\f[R] Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan(x)\f[R] Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]atan2(y, x)\f[R] Returns the arctangent of \f[B]y/x\f[R], in radians. If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns \f[B]a(y/x)\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than \f[B]0\f[R], it returns \f[B]pi/2\f[R]. If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than \f[B]0\f[R], it returns \f[B]-pi/2\f[R]. .RS .PP This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]r2d(x)\f[R] Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]d2r(x)\f[R] Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental Functions\f[R] subsection below). .RE .TP \f[B]frand(p)\f[R] Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]. If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .TP \f[B]ifrand(i, p)\f[R] Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of \f[B]p\f[R]. If the absolute value of \f[B]i\f[R] is greater than or equal to \f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] is returned and \f[B]seed\f[R] is not changed. .TP \f[B]srand(x)\f[R] Returns \f[B]x\f[R] with its sign flipped with probability \f[B]0.5\f[R]. In other words, it randomizes the sign of \f[B]x\f[R]. .TP \f[B]brand()\f[R] Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP \f[B]band(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]and\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]or\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bxor(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of the bitwise \f[B]xor\f[R] operation between them. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshl(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the result of \f[B]a\f[R] bit-shifted left by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bshr(a, b)\f[R] Takes the truncated absolute value of both \f[B]a\f[R] and \f[B]b\f[R] and calculates and returns the truncated result of \f[B]a\f[R] bit-shifted right by \f[B]b\f[R] places. .RS .PP If you want to use signed two\[cq]s complement arguments, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnotn(x, n)\f[R] Takes the truncated absolute value of \f[B]x\f[R] and does a bitwise not as though it has the same number of bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot8(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]8\f[R] binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot16(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]16\f[R] binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot32(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]32\f[R] binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot64(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has \f[B]64\f[R] binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bnot(x)\f[R] Does a bitwise not of the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brevn(x, n)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the same number of 8-bit bytes as the truncated absolute value of \f[B]n\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev8(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 8 binary digits (1 unsigned byte). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev16(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 16 binary digits (2 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev32(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 32 binary digits (4 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev64(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has 64 binary digits (8 unsigned bytes). .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brev(x)\f[R] Runs a bit reversal on the truncated absolute value of \f[B]x\f[R] as though it has the minimum number of power of two unsigned bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]broln(x, p, n)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol8(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol16(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol32(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol64(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brol(x, p)\f[R] Does a left bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]brorn(x, p, n)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of \f[B]n\f[R], by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by the \f[B]2\f[R] to the power of the number of binary digits in \f[B]n\f[R] 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror8(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]8\f[R] binary digits (\f[B]1\f[R] unsigned byte), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror16(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]16\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror32(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]32\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror64(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has \f[B]64\f[R] binary digits (\f[B]2\f[R] unsigned bytes), by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bror(x, p)\f[R] Does a right bitwise rotatation of the truncated absolute value of \f[B]x\f[R], as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of \f[B]p\f[R] modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmodn(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of the multiplication of the truncated absolute value of \f[B]n\f[R] and \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod8(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]8\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod16(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]16\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod32(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]32\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bmod64(x, n)\f[R] Returns the modulus of the truncated absolute value of \f[B]x\f[R] by \f[B]2\f[R] to the power of \f[B]64\f[R]. .RS .PP If you want to a use signed two\[cq]s complement argument, use \f[B]s2u(x)\f[R] to convert. .RE .TP \f[B]bunrev(t)\f[R] Assumes \f[B]t\f[R] is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. .RS .PP This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. .RE .TP \f[B]plz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]plznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed with a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]pnlz(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and without a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, without a trailing newline. .RE .TP \f[B]pnlznl(x)\f[R] If \f[B]x\f[R] is not equal to \f[B]0\f[R] and greater that \f[B]-1\f[R] and less than \f[B]1\f[R], it is printed without a leading zero, regardless of the use of the \f[B]-z\f[R] option (see the \f[B]OPTIONS\f[R] section) and with a trailing newline. .RS .PP Otherwise, \f[B]x\f[R] is printed normally, with a trailing newline. .RE .TP \f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of \f[B]x\f[R]. .TP \f[B]sbytes(x)\f[R] Returns the numbers of signed, two\[cq]s-complement integer bytes required to hold the truncated value of \f[B]x\f[R]. .TP \f[B]s2u(x)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer and returns the non-negative integer that would have the same representation in binary. .TP \f[B]s2un(x,n)\f[R] Returns \f[B]x\f[R] if it is non-negative. If it \f[I]is\f[R] negative, then it calculates what \f[B]x\f[R] would be as a 2\[cq]s-complement signed integer with \f[B]n\f[R] bytes and returns the non-negative integer that would have the same representation in binary. If \f[B]x\f[R] cannot fit into \f[B]n\f[R] 2\[cq]s-complement signed bytes, it is truncated to fit. .TP \f[B]hex(x)\f[R] Outputs the hexadecimal (base \f[B]16\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary(x)\f[R] Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output(x, b)\f[R] Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uintn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]intn(x, n)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int8(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int16(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int32(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]uint64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer, is negative, or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]int64(x)\f[R] Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]hex_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]binary_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_uint(x, n)\f[R] Outputs the representation of the truncated absolute value of \f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP \f[B]output_byte(x, i)\f[R] Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes - 1\f[R] is the most significant byte. .RS .PP This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/\[ti]wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. If exact results are \f[I]absolutely\f[R] required, users can double the precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 \f[B]s(x)\f[R] .IP \[bu] 2 \f[B]c(x)\f[R] .IP \[bu] 2 \f[B]a(x)\f[R] .IP \[bu] 2 \f[B]l(x)\f[R] .IP \[bu] 2 \f[B]e(x)\f[R] .IP \[bu] 2 \f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 \f[B]l2(x)\f[R] .IP \[bu] 2 \f[B]l10(x)\f[R] .IP \[bu] 2 \f[B]log(x, b)\f[R] .IP \[bu] 2 \f[B]pi(p)\f[R] .IP \[bu] 2 \f[B]t(x)\f[R] .IP \[bu] 2 \f[B]a2(y, x)\f[R] .IP \[bu] 2 \f[B]sin(x)\f[R] .IP \[bu] 2 \f[B]cos(x)\f[R] .IP \[bu] 2 \f[B]tan(x)\f[R] .IP \[bu] 2 \f[B]atan(x)\f[R] .IP \[bu] 2 \f[B]atan2(y, x)\f[R] .IP \[bu] 2 \f[B]r2d(x)\f[R] .IP \[bu] 2 \f[B]d2r(x)\f[R] .SH RESET .PP When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. .PP Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]rand()\f[R] operand. Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP The actual values can be queried with the \f[B]limits\f[R] statement. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], bc(1) recognizes the following environment variables: .TP \f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if the \f[B]-s\f[R] option was given. .TP \f[B]BC_ENV_ARGS\f[R] This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `bc' file.bc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, including the backslash (\f[B]\[rs]\f[R]). The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]BC_BANNER\f[R] If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. .RS .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_SIGINT_RESET\f[R] If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because bc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes bc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then bc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and \f[B]BC_TTY_MODE\f[R] does, then the value of the \f[B]BC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]BC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]BC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their corresponding assignment operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the \f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), giving an invalid \f[B]auto\f[R] list, having a duplicate \f[B]auto\f[R]/function parameter, failing to find the end of a code block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a \f[B]void\f[R] function call as a value in an expression. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (see the \f[B]STANDARDS\f[R] section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, bc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. bc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]BC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]BC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then bc(1) will not turn TTY mode on. .PP If the environment variable \f[B]BC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]BC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]BC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]BC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]BC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]BC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause bc(1) to do one of two things. .PP If bc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]BC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, bc(1) will exit. .PP However, if bc(1) is in interactive mode, and the \f[B]BC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If bc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP bc(1) supports interactive command-line editing. .PP If bc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]BC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If history is enabled, previous lines can be recalled and edited with the arrow keys. .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP bc(1) is compliant with the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP In addition, the behavior of the \f[B]quit\f[R] implements an interpretation of that specification that is different from all known implementations. For more information see the \f[B]Statements\f[R] subsection of the \f[B]SYNTAX\f[R] section. .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP Before version \f[B]6.1.0\f[R], this bc(1) had incorrect behavior for the \f[B]quit\f[R] statement. .PP No other bugs are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bc/N.1.md b/contrib/bc/manuals/bc/N.1.md index 2c85180f670f..b8339ea31a5e 100644 --- a/contrib/bc/manuals/bc/N.1.md +++ b/contrib/bc/manuals/bc/N.1.md @@ -1,2497 +1,2497 @@ # NAME bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS **bc** [**-cCghilPqRsvVw**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-global-stacks**] [**-\-help**] [**-\-interactive**] [**-\-mathlib**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-quiet**] [**-\-standard**] [**-\-warn**] [**-\-version**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION bc(1) is an interactive processor for a language first standardized in 1991 by POSIX. (See the **STANDARDS** section.) The language provides unlimited precision decimal arithmetic and is somewhat C-like, but there are differences. Such differences will be noted in this document. After parsing and handling options, this bc(1) reads any files given on the command line and executes them before reading from **stdin**. This bc(1) is a drop-in replacement for *any* bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. **Note**: If running this bc(1) on *any* script meant for another bc(1) gives a parse error, it is probably because a word this bc(1) reserves as a keyword is used as the name of a function, variable, or array. To fix that, use the command-line option **-r** *keyword*, where *keyword* is the keyword that is used as a name in the script. For more information, see the **OPTIONS** section. If parsing scripts meant for other bc(1) implementations still does not work, that is a bug and should be reported. See the **BUGS** section. # OPTIONS The following are the options that bc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see the **-f** and **-\-file** options), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **BC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see the **-e** and **-\-expression** options), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **BC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, bc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, bc(1) will give a fatal error and exit. This is a **non-portable extension**. **-g**, **-\-global-stacks** : Turns the globals **ibase**, **obase**, **scale**, and **seed** into stacks. This has the effect that a copy of the current value of all four are pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. Thus, a hypothetical function named **output(x,b)** that simply printed **x** in base **b** could be written like this: define void output(x, b) { obase=b x } instead of like this: define void output(x, b) { auto c c=obase obase=b x obase=c } This makes writing functions much easier. (**Note**: the function **output(x,b)** exists in the extended math library. See the **LIBRARY** section.) However, since using this flag means that functions cannot set **ibase**, **obase**, **scale**, or **seed** globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. First, if a function is called on startup to turn bc(1) into a number converter, it is possible to replace that capability with various shell aliases. Examples: alias d2o="bc -e ibase=A -e obase=8" alias h2b="bc -e ibase=G -e obase=2" Second, if the purpose of a function is to set **ibase**, **obase**, **scale**, or **seed** globally for any other purpose, it could be split into one to four functions (based on how many globals it sets) and each of those functions could return the desired value for a global. For functions that set **seed**, the value assigned to **seed** is not propagated to parent functions. This means that the sequence of pseudo-random numbers that they see will not be the same sequence of pseudo-random numbers that any parent sees. This is only the case once **seed** has been set. If a function desires to not affect the sequence of pseudo-random numbers of its parents, but wants to use the same **seed**, it can use the following line: seed = seed If the behavior of this option is desired for every run of bc(1), then users could make sure to define **BC_ENV_ARGS** and include this option (see the **ENVIRONMENT VARIABLES** section for more details). If **-s**, **-w**, or any equivalents are used, this option is ignored. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-l**, **-\-mathlib** : Sets **scale** (see the **SYNTAX** section) to **20** and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. To learn what is in the libraries, see the **LIBRARY** section. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). These options override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-q**, **-\-quiet** : This option is for compatibility with the GNU bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the **-v**, **-V**, or **-\-version** options are given unless the **BC_BANNER** environment variable is set and contains a non-zero integer or if this bc(1) was built with the header displayed by default. If *any* of that is the case, then this option *does* prevent bc(1) from printing the header. This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in bc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of bc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **read()** built-in function is called. These options *do* override the **BC_PROMPT** and **BC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-r** *keyword*, **-\-redefine**=*keyword* : Redefines *keyword* in order to allow it to be used as a function, variable, or array name. This is useful when this bc(1) gives parse errors when parsing scripts meant for other bc(1) implementations. The keywords this bc(1) allows to be redefined are: * **abs** * **asciify** * **continue** * **divmod** * **else** * **halt** * **irand** * **last** * **limits** * **maxibase** * **maxobase** * **maxrand** * **maxscale** * **modexp** * **print** * **rand** * **read** * **seed** * **stream** If any of those keywords are used as a function, variable, or array name in a script, use this option with the keyword as the argument. If multiple are used, use this option for all of them; it can be used multiple times. Keywords are *not* redefined when parsing the builtin math library (see the **LIBRARY** section). It is a fatal error to redefine keywords mandated by the POSIX standard (see the **STANDARDS** section). It is a fatal error to attempt to redefine words that this bc(1) does not reserve as keywords. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-s**, **-\-standard** : Process exactly the language defined by the standard (see the **STANDARDS** section) and error if any extensions are used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. This is a **non-portable extension**. **-w**, **-\-warn** : Like **-s** and **-\-standard**, except that warnings (and not errors) are printed for non-standard extensions and execution continues normally. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes bc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then bc(1) reads from **stdin**. However, there are a few caveats to this. First, **stdin** is evaluated a line at a time. The only exception to this is if the parse cannot complete. That means that starting a string without ending it or starting a function, **if** statement, or loop without ending it will also cause bc(1) to not execute. Second, after an **if** statement, bc(1) doesn't know if an **else** statement will follow, so it will not execute until it knows there will not be an **else** statement. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **bc >&-**, it will quit with an error. This is done so that bc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other bc(1) implementations, this bc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **bc 2>&-**, it will quit with an error. This is done so that bc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (see the **STANDARDS** section), which is a much more thorough resource for the language this bc(1) accepts. This section is meant to be a summary and a listing of all the extensions to the standard. In the sections below, **E** means expression, **S** means statement, and **I** means identifier. Identifiers (**I**) start with a lowercase letter and can be followed by any number (up to **BC_NAME_MAX-1**) of lowercase letters (**a-z**), digits (**0-9**), and underscores (**\_**). The regex is **\[a-z\]\[a-z0-9\_\]\***. Identifiers with more than one character (letter) are a **non-portable extension**. **ibase** is a global variable determining how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. If the **-s** (**-\-standard**) and **-w** (**-\-warn**) flags were not given on the command line, the max allowable value for **ibase** is **36**. Otherwise, it is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in bc(1) programs with the **maxibase()** built-in function. **obase** is a global variable determining how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **BC_BASE_MAX** and can be queried in bc(1) programs with the **maxobase()** built-in function. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a global variable that sets the precision of any operations, with exceptions. **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** is **BC_SCALE_MAX** and can be queried in bc(1) programs with the **maxscale()** built-in function. bc(1) has both *global* variables and *local* variables. All *local* variables are local to the function; they are parameters or are introduced in the **auto** list of a function (see the **FUNCTIONS** section). If a variable is accessed which is not a parameter or in the **auto** list, it is assumed to be *global*. If a parent function has a *local* variable version of a variable that a child function considers *global*, the value of that *global* variable in the child function is the value of the variable in the parent function, not the value of the actual *global* variable. All of the above applies to arrays as well. The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence operator is an assignment operator *and* the expression is notsurrounded by parentheses. The value that is printed is also assigned to the special variable **last**. A single dot (**.**) may also be used as a synonym for **last**. These are **non-portable extensions**. Either semicolons or newlines may separate statements. ## Comments There are two kinds of comments: 1. Block comments are enclosed in **/\*** and **\*/**. 2. Line comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. ## Named Expressions The following are named expressions in bc(1): 1. Variables: **I** 2. Array Elements: **I[E]** 3. **ibase** 4. **obase** 5. **scale** 6. **seed** 7. **last** or a single dot (**.**) Numbers 6 and 7 are **non-portable extensions**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is assigned to **seed** and used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if **seed** is queried again immediately. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will *not* produce unique sequences of pseudo-random numbers. The value of **seed** will change after any use of the **rand()** and **irand(E)** operands (see the *Operands* subsection below), except if the parameter passed to **irand(E)** is **0**, **1**, or negative. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. Variables and arrays do not interfere; users can have arrays named the same as variables. This also applies to functions (see the **FUNCTIONS** section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. Named expressions are required as the operand of **increment**/**decrement** operators and as the left side of **assignment** operators (see the *Operators* subsection). ## Operands The following are valid operands in bc(1): 1. Numbers (see the *Numbers* subsection below). 2. Array indices (**I[E]**). 3. **(E)**: The value of **E** (used to change precedence). 4. **sqrt(E)**: The square root of **E**. **E** must be non-negative. 5. **length(E)**: The number of significant decimal digits in **E**. Returns **1** for **0** with no decimal places. If given a string, the length of the string is returned. Passing a string to **length(E)** is a **non-portable extension**. 6. **length(I[])**: The number of elements in the array **I**. This is a **non-portable extension**. 7. **scale(E)**: The *scale* of **E**. 8. **abs(E)**: The absolute value of **E**. This is a **non-portable extension**. 9. **is_number(E)**: **1** if the given argument is a number, **0** if it is a string. This is a **non-portable extension**. 10. **is_string(E)**: **1** if the given argument is a string, **0** if it is a number. This is a **non-portable extension**. 11. **modexp(E, E, E)**: Modular exponentiation, where the first expression is the base, the second is the exponent, and the third is the modulus. All three values must be integers. The second argument must be non-negative. The third argument must be non-zero. This is a **non-portable extension**. 11. **divmod(E, E, I[])**: Division and modulus in one operation. This is for optimization. The first expression is the dividend, and the second is the divisor, which must be non-zero. The return value is the quotient, and the modulus is stored in index **0** of the provided array (the last argument). This is a **non-portable extension**. 12. **asciify(E)**: If **E** is a string, returns a string that is the first letter of its argument. If it is a number, calculates the number mod **256** and returns that number as a one-character string. This is a **non-portable extension**. 13. **asciify(I[])**: A string that is made up of the characters that would result from running **asciify(E)** on each element of the array identified by the argument. This allows creating multi-character strings and storing them. This is a **non-portable extension**. 14. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a non-**void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. 15. **read()**: Reads a line from **stdin** and uses that as an expression. The result of that expression is the result of the **read()** operand. This is a **non-portable extension**. 16. **maxibase()**: The max allowable **ibase**. This is a **non-portable extension**. 17. **maxobase()**: The max allowable **obase**. This is a **non-portable extension**. 18. **maxscale()**: The max allowable **scale**. This is a **non-portable extension**. 19. **line_length()**: The line length set with **BC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. 20. **global_stacks()**: **0** if global stacks are not enabled with the **-g** or **-\-global-stacks** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 21. **leading_zero()**: **0** if leading zeroes are not enabled with the **-z** or **--leading-zeroes** options, non-zero otherwise. See the **OPTIONS** section. This is a **non-portable extension**. 22. **rand()**: A pseudo-random integer between **0** (inclusive) and **BC_RAND_MAX** (inclusive). Using this operand will change the value of **seed**. This is a **non-portable extension**. 23. **irand(E)**: A pseudo-random integer between **0** (inclusive) and the value of **E** (exclusive). If **E** is negative or is a non-integer (**E**'s *scale* is not **0**), an error is raised, and bc(1) resets (see the **RESET** section) while **seed** remains unchanged. If **E** is larger than **BC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **BC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. Using this operand will change the value of **seed**, unless the value of **E** is **0** or **1**. In that case, **0** is returned, and **seed** is *not* changed. This is a **non-portable extension**. 24. **maxrand()**: The max integer returned by **rand()**. This is a **non-portable extension**. The integers generated by **rand()** and **irand(E)** are guaranteed to be as unbiased as possible, subject to the limitations of the pseudo-random number generator. **Note**: The values returned by the pseudo-random number generator with **rand()** and **irand(E)** are guaranteed to *NOT* be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from bc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. ## Numbers Numbers are strings made up of digits, uppercase letters, and at most **1** period for a radix. Numbers can have up to **BC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet, starting from **1** (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **BC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, bc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and bc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if bc(1) is given the number string **10e-4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. ## Operators The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. **++** **-\-** : Type: Prefix and Postfix Associativity: None Description: **increment**, **decrement** **-** **!** : Type: Prefix Associativity: None Description: **negation**, **boolean not** **\$** : Type: Postfix Associativity: None Description: **truncation** **\@** : Type: Binary Associativity: Right Description: **set precision** **\^** : Type: Binary Associativity: Right Description: **power** **\*** **/** **%** : Type: Binary Associativity: Left Description: **multiply**, **divide**, **modulus** **+** **-** : Type: Binary Associativity: Left Description: **add**, **subtract** **\<\<** **\>\>** : Type: Binary Associativity: Left Description: **shift left**, **shift right** **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : Type: Binary Associativity: Right Description: **assignment** **==** **\<=** **\>=** **!=** **\<** **\>** : Type: Binary Associativity: Left Description: **relational** **&&** : Type: Binary Associativity: Left Description: **boolean and** **||** : Type: Binary Associativity: Left Description: **boolean or** The operators will be described in more detail below. **++** **-\-** : The prefix and postfix **increment** and **decrement** operators behave exactly like they would in C. They require a named expression (see the *Named Expressions* subsection) as an operand. The prefix versions of these operators are more efficient; use them where possible. **-** : The **negation** operator returns **0** if a user attempts to negate any expression with the value **0**. Otherwise, a copy of the expression with its sign flipped is returned. **!** : The **boolean not** operator returns **1** if the expression is **0**, or **0** otherwise. This is a **non-portable extension**. **\$** : The **truncation** operator returns a copy of the given expression with all of its *scale* removed. This is a **non-portable extension**. **\@** : The **set precision** operator takes two expressions and returns a copy of the first with its *scale* equal to the value of the second expression. That could either mean that the number is returned without change (if the *scale* of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\^** : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. **\*** : The **multiply** operator takes two expressions, multiplies them, and returns the product. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The **divide** operator takes two expressions, divides them, and returns the quotient. The *scale* of the result shall be the value of **scale**. The second expression must be non-zero. **%** : The **modulus** operator takes two expressions, **a** and **b**, and evaluates them by 1) Computing **a/b** to current **scale** and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The second expression must be non-zero. **+** : The **add** operator takes two expressions, **a** and **b**, and returns the sum, with a *scale* equal to the max of the *scale*s of **a** and **b**. **-** : The **subtract** operator takes two expressions, **a** and **b**, and returns the difference, with a *scale* equal to the max of the *scale*s of **a** and **b**. **\<\<** : The **left shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the right. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **\>\>** : The **right shift** operator takes two expressions, **a** and **b**, and returns a copy of the value of **a** with its decimal point moved **b** places to the left. The second expression must be an integer (no *scale*) and non-negative. This is a **non-portable extension**. **=** **\<\<=** **\>\>=** **+=** **-=** **\*=** **/=** **%=** **\^=** **\@=** : The **assignment** operators take two expressions, **a** and **b** where **a** is a named expression (see the *Named Expressions* subsection). For **=**, **b** is copied and the result is assigned to **a**. For all others, **a** and **b** are applied as operands to the corresponding arithmetic operator and the result is assigned to **a**. The **assignment** operators that correspond to operators that are extensions are themselves **non-portable extensions**. **==** **\<=** **\>=** **!=** **\<** **\>** : The **relational** operators compare two expressions, **a** and **b**, and if the relation holds, according to C language semantics, the result is **1**. Otherwise, it is **0**. Note that unlike in C, these operators have a lower precedence than the **assignment** operators, which means that **a=b\>c** is interpreted as **(a=b)\>c**. Also, unlike the standard (see the **STANDARDS** section) requires, these operators can appear anywhere any other expressions can be used. This allowance is a **non-portable extension**. **&&** : The **boolean and** operator takes two expressions and returns **1** if both expressions are non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. **||** : The **boolean or** operator takes two expressions and returns **1** if one of the expressions is non-zero, **0** otherwise. This is *not* a short-circuit operator. This is a **non-portable extension**. ## Statements The following items are statements: 1. **E** 2. **{** **S** **;** ... **;** **S** **}** 3. **if** **(** **E** **)** **S** 4. **if** **(** **E** **)** **S** **else** **S** 5. **while** **(** **E** **)** **S** 6. **for** **(** **E** **;** **E** **;** **E** **)** **S** 7. An empty statement 8. **break** 9. **continue** 10. **quit** 11. **halt** 12. **limits** 13. A string of characters, enclosed in double quotes 14. **print** **E** **,** ... **,** **E** 15. **stream** **E** **,** ... **,** **E** 16. **I()**, **I(E)**, **I(E, E)**, and so on, where **I** is an identifier for a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). The **E** argument(s) may also be arrays of the form **I[]**, which will automatically be turned into array references (see the *Array References* subsection of the **FUNCTIONS** section) if the corresponding parameter in the function definition is an array reference. Numbers 4, 9, 11, 12, 14, 15, and 16 are **non-portable extensions**. Also, as a **non-portable extension**, any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a constant **1**. The **break** statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. The **continue** statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. The **if** **else** statement does the same thing as in C. The **quit** statement causes bc(1) to quit, even if it is on a branch that will not be executed (it is a compile-time command). **Warning**: The behavior of this bc(1) on **quit** is slightly different from other bc(1) implementations. Other bc(1) implementations will exit as soon as they finish parsing the line that a **quit** command is on. This bc(1) will execute any completed and executable statements that occur before the **quit** statement before exiting. In other words, for the bc(1) code below: for (i = 0; i < 3; ++i) i; quit Other bc(1) implementations will print nothing, and this bc(1) will print **0**, **1**, and **2** on successive lines before exiting. The **halt** statement causes bc(1) to quit, if it is executed. (Unlike **quit** if it is on a branch of an **if** statement that is not executed, bc(1) does not quit.) The **limits** statement prints the limits that this bc(1) is subject to. This is like the **quit** statement in that it is a compile-time command. An expression by itself is evaluated and printed, followed by a newline. Both scientific notation and engineering notation are available for printing the results of expressions. Scientific notation is activated by assigning **0** to **obase**, and engineering notation is activated by assigning **1** to **obase**. To deactivate them, just assign a different value to **obase**. Scientific notation and engineering notation are disabled if bc(1) is run with either the **-s** or **-w** command-line options (or equivalents). Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. ## Strings If strings appear as a statement by themselves, they are printed without a trailing newline. In addition to appearing as a lone statement by themselves, strings can be assigned to variables and array elements. They can also be passed to functions in variable parameters. If any statement that expects a string is given a variable that had a string assigned to it, the statement acts as though it had received a string. If any math operation is attempted on a string or a variable or array element that has been assigned a string, an error is raised, and bc(1) resets (see the **RESET** section). Assigning strings to variables and array elements and passing them to functions are **non-portable extensions**. ## Print Statement The "expressions" in a **print** statement may also be strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown below: **\\a**: **\\a** **\\b**: **\\b** **\\\\**: **\\** **\\e**: **\\** **\\f**: **\\f** **\\n**: **\\n** **\\q**: **"** **\\r**: **\\r** **\\t**: **\\t** Any other character following a backslash causes the backslash and character to be printed as-is. Any non-string expression in a print statement shall be assigned to **last**, like any other expression that is printed. ## Stream Statement The "expressions in a **stream** statement may also be strings. If a **stream** statement is given a string, it prints the string as though the string had appeared as its own statement. In other words, the **stream** statement prints strings normally, without a newline. If a **stream** statement is given a number, a copy of it is truncated and its absolute value is calculated. The result is then printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. ## Order of Evaluation All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. This means, for example, assuming that **i** is equal to **0**, in the expression a[i++] = i++ the first (or 0th) element of **a** is set to **1**, and **i** is equal to **2** at the end of the expression. This includes function arguments. Thus, assuming **i** is equal to **0**, this means that in the expression x(i++, i++) the first argument passed to **x()** is **0**, and the second argument is **1**, while **i** is equal to **2** before the function starts executing. # FUNCTIONS Function definitions are as follows: ``` define I(I,...,I){ auto I,...,I S;...;S return(E) } ``` Any **I** in the parameter list or **auto** list may be replaced with **I[]** to make a parameter or **auto** var an array, and any **I** in the parameter list may be replaced with **\*I[]** to make a parameter an array reference. Callers of functions that take array references should not put an asterisk in the call; they must be called with just **I[]** like normal array parameters and will be automatically converted into references. As a **non-portable extension**, the opening brace of a **define** statement may appear on the next line. As a **non-portable extension**, the return statement may also be in one of the following forms: 1. **return** 2. **return** **(** **)** 3. **return** **E** The first two, or not specifying a **return** statement, is equivalent to **return (0)**, unless the function is a **void** function (see the *Void Functions* subsection below). ## Void Functions Functions can also be **void** functions, defined as follows: ``` define void I(I,...,I){ auto I,...,I S;...;S return } ``` They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. Void functions can only use the first two **return** statements listed above. They can also omit the return statement entirely. The word "void" is not treated as a keyword; it is still possible to have variables, arrays, and functions named **void**. The word "void" is only treated specially right after the **define** keyword. This is a **non-portable extension**. ## Array References For any array in the parameter list, if the array is declared in the form ``` *I[] ``` it is a **reference**. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. Other than this, all function arguments are passed by value. This is a **non-portable extension**. # LIBRARY All of the functions below, including the functions in the extended math library (see the *Extended Library* subsection below), are available when the **-l** or **-\-mathlib** command-line flags are given, except that the extended math library is not available when the **-s** option, the **-w** option, or equivalents are given. ## Standard Library The standard (see the **STANDARDS** section) defines the following functions for the math library: **s(x)** : Returns the sine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **c(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a(x)** : Returns the arctangent of **x**, in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **l(x)** : Returns the natural logarithm of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **e(x)** : Returns the mathematical constant **e** raised to the power of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **j(x, n)** : Returns the bessel integer order **n** (truncated) of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). ## Extended Library The extended library is *not* loaded when the **-s**/**-\-standard** or **-w**/**-\-warn** options are given since they are not part of the library defined by the standard (see the **STANDARDS** section). The extended library is a **non-portable extension**. **p(x, y)** : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. It is an error if **y** is negative and **x** is **0**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round half away from **0** (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). **ceil(x, p)** : Returns **x** rounded to **p** decimal places according to the rounding mode round away from **0** (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). **f(x)** : Returns the factorial of the truncated absolute value of **x**. **perm(n, k)** : Returns the permutation of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **comb(n, k)** : Returns the combination of the truncated absolute value of **n** of the truncated absolute value of **k**, if **k \<= n**. If not, it returns **0**. **l2(x)** : Returns the logarithm base **2** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **l10(x)** : Returns the logarithm base **10** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **log(x, b)** : Returns the logarithm base **b** of **x**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cbrt(x)** : Returns the cube root of **x**. **root(x, n)** : Calculates the truncated value of **n**, **r**, and returns the **r**th root of **x** to the current **scale**. If **r** is **0** or negative, this raises an error and causes bc(1) to reset (see the **RESET** section). It also raises an error and causes bc(1) to reset if **r** is even and **x** is negative. **gcd(a, b)** : Returns the greatest common divisor (factor) of the truncated absolute value of **a** and the truncated absolute value of **b**. **lcm(a, b)** : Returns the least common multiple of the truncated absolute value of **a** and the truncated absolute value of **b**. **pi(p)** : Returns **pi** to **p** decimal places. This is a transcendental function (see the *Transcendental Functions* subsection below). **t(x)** : Returns the tangent of **x**, which is assumed to be in radians. This is a transcendental function (see the *Transcendental Functions* subsection below). **a2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is a transcendental function (see the *Transcendental Functions* subsection below). **sin(x)** : Returns the sine of **x**, which is assumed to be in radians. This is an alias of **s(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **cos(x)** : Returns the cosine of **x**, which is assumed to be in radians. This is an alias of **c(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **tan(x)** : Returns the tangent of **x**, which is assumed to be in radians. If **x** is equal to **1** or **-1**, this raises an error and causes bc(1) to reset (see the **RESET** section). This is an alias of **t(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan(x)** : Returns the arctangent of **x**, in radians. This is an alias of **a(x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **atan2(y, x)** : Returns the arctangent of **y/x**, in radians. If both **y** and **x** are equal to **0**, it raises an error and causes bc(1) to reset (see the **RESET** section). Otherwise, if **x** is greater than **0**, it returns **a(y/x)**. If **x** is less than **0**, and **y** is greater than or equal to **0**, it returns **a(y/x)+pi**. If **x** is less than **0**, and **y** is less than **0**, it returns **a(y/x)-pi**. If **x** is equal to **0**, and **y** is greater than **0**, it returns **pi/2**. If **x** is equal to **0**, and **y** is less than **0**, it returns **-pi/2**. This function is the same as the **atan2()** function in many programming languages. This is an alias of **a2(y, x)**. This is a transcendental function (see the *Transcendental Functions* subsection below). **r2d(x)** : Converts **x** from radians to degrees and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **d2r(x)** : Converts **x** from degrees to radians and returns the result. This is a transcendental function (see the *Transcendental Functions* subsection below). **frand(p)** : Generates a pseudo-random number between **0** (inclusive) and **1** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If **p** is not **0**, then calling this function will change the value of **seed**. If **p** is **0**, then **0** is returned, and **seed** is *not* changed. **ifrand(i, p)** : Generates a pseudo-random number that is between **0** (inclusive) and the truncated absolute value of **i** (exclusive) with the number of decimal digits after the decimal point equal to the truncated absolute value of **p**. If the absolute value of **i** is greater than or equal to **2**, and **p** is not **0**, then calling this function will change the value of **seed**; otherwise, **0** is returned and **seed** is not changed. **srand(x)** : Returns **x** with its sign flipped with probability **0.5**. In other words, it randomizes the sign of **x**. **brand()** : Returns a random boolean value (either **0** or **1**). **band(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **and** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **or** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bxor(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of the bitwise **xor** operation between them. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshl(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the result of **a** bit-shifted left by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bshr(a, b)** : Takes the truncated absolute value of both **a** and **b** and calculates and returns the truncated result of **a** bit-shifted right by **b** places. If you want to use signed two's complement arguments, use **s2u(x)** to convert. **bnotn(x, n)** : Takes the truncated absolute value of **x** and does a bitwise not as though it has the same number of bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot8(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **8** binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot16(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **16** binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot32(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **32** binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot64(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has **64** binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bnot(x)** : Does a bitwise not of the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brevn(x, n)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the same number of 8-bit bytes as the truncated absolute value of **n**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev8(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 8 binary digits (1 unsigned byte). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev16(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 16 binary digits (2 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev32(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 32 binary digits (4 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev64(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has 64 binary digits (8 unsigned bytes). If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brev(x)** : Runs a bit reversal on the truncated absolute value of **x** as though it has the minimum number of power of two unsigned bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **broln(x, p, n)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol8(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol16(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol32(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol64(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brol(x, p)** : Does a left bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **brorn(x, p, n)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the same number of unsigned 8-bit bytes as the truncated absolute value of **n**, by the number of places equal to the truncated absolute value of **p** modded by the **2** to the power of the number of binary digits in **n** 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror8(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **8** binary digits (**1** unsigned byte), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror16(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **16** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror32(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **32** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror64(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has **64** binary digits (**2** unsigned bytes), by the number of places equal to the truncated absolute value of **p** modded by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bror(x, p)** : Does a right bitwise rotatation of the truncated absolute value of **x**, as though it has the minimum number of power of two unsigned 8-bit bytes, by the number of places equal to the truncated absolute value of **p** modded by 2 to the power of the number of binary digits in the minimum number of 8-bit bytes. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmodn(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of the multiplication of the truncated absolute value of **n** and **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod8(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **8**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod16(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **16**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod32(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **32**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bmod64(x, n)** : Returns the modulus of the truncated absolute value of **x** by **2** to the power of **64**. If you want to a use signed two's complement argument, use **s2u(x)** to convert. **bunrev(t)** : Assumes **t** is a bitwise-reversed number with an extra set bit one place more significant than the real most significant bit (which was the least significant bit in the original number). This number is reversed and returned without the extra set bit. This function is used to implement other bitwise functions; it is not meant to be used by users, but it can be. **plz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **plznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed with a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **pnlz(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and without a trailing newline. Otherwise, **x** is printed normally, without a trailing newline. **pnlznl(x)** : If **x** is not equal to **0** and greater that **-1** and less than **1**, it is printed without a leading zero, regardless of the use of the **-z** option (see the **OPTIONS** section) and with a trailing newline. Otherwise, **x** is printed normally, with a trailing newline. **ubytes(x)** : Returns the numbers of unsigned integer bytes required to hold the truncated absolute value of **x**. **sbytes(x)** : Returns the numbers of signed, two's-complement integer bytes required to hold the truncated value of **x**. **s2u(x)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer and returns the non-negative integer that would have the same representation in binary. **s2un(x,n)** : Returns **x** if it is non-negative. If it *is* negative, then it calculates what **x** would be as a 2's-complement signed integer with **n** bytes and returns the non-negative integer that would have the same representation in binary. If **x** cannot fit into **n** 2's-complement signed bytes, it is truncated to fit. **hex(x)** : Outputs the hexadecimal (base **16**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary(x)** : Outputs the binary (base **2**) representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output(x, b)** : Outputs the base **b** representation of **x**. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer or is negative, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. If **x** is not an integer, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uintn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **intn(x, n)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **n** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **n** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int8(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **1** byte. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **1** byte, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int16(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **2** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **2** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int32(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **4** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **4** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **uint64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as an unsigned integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer, is negative, or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **int64(x)** : Outputs the representation, in binary and hexadecimal, of **x** as a signed, two's-complement integer in **8** bytes. Both outputs are split into bytes separated by spaces. If **x** is not an integer or cannot fit into **8** bytes, an error message is printed instead, but bc(1) is not reset (see the **RESET** section). This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **hex_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in hexadecimal using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **binary_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in binary using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_uint(x, n)** : Outputs the representation of the truncated absolute value of **x** as an unsigned integer in the current **obase** (see the **SYNTAX** section) using **n** bytes. Not all of the value will be output if **n** is too small. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). **output_byte(x, i)** : Outputs byte **i** of the truncated absolute value of **x**, where **0** is the least significant byte and **number_of_bytes - 1** is the most significant byte. This is a **void** function (see the *Void Functions* subsection of the **FUNCTIONS** section). ## Transcendental Functions All transcendental functions can return slightly inaccurate results, up to 1 ULP (https://en.wikipedia.org/wiki/Unit_in_the_last_place). This is unavoidable, and the article at https://people.eecs.berkeley.edu/~wkahan/LOG10HAF.TXT explains why it is impossible and unnecessary to calculate exact results for the transcendental functions. Because of the possible inaccuracy, I recommend that users call those functions with the precision (**scale**) set to at least 1 higher than is necessary. If exact results are *absolutely* required, users can double the precision (**scale**) and then truncate. The transcendental functions in the standard math library are: * **s(x)** * **c(x)** * **a(x)** * **l(x)** * **e(x)** * **j(x, n)** The transcendental functions in the extended math library are: * **l2(x)** * **l10(x)** * **log(x, b)** * **pi(p)** * **t(x)** * **a2(y, x)** * **sin(x)** * **cos(x)** * **tan(x)** * **atan(x)** * **atan2(y, x)** * **r2d(x)** * **d2r(x)** # RESET When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any functions that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all functions returned) is skipped. Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. Note that this reset behavior is different from the GNU bc(1), which attempts to start executing the statement right after the one that caused an error. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This bc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. The actual values of **BC_LONG_BIT** and **BC_BASE_DIGS** can be queried with the **limits** statement. In addition, this bc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bc(1): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_STRING_MAX** : The maximum length of strings. Set at **BC_OVERFLOW_MAX-1**. **BC_NAME_MAX** : The maximum length of identifiers. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. **BC_RAND_MAX** : The maximum integer (inclusive) returned by the **rand()** operand. Set at **2\^BC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. The actual values can be queried with the **limits** statement. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, bc(1) recognizes the following environment variables: **POSIXLY_CORRECT** : If this variable exists (no matter the contents), bc(1) behaves as if the **-s** option was given. **BC_ENV_ARGS** : This is another way to give command-line arguments to bc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **BC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. The code that parses **BC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some bc file.bc"** will be correctly parsed, but the string **"/home/gavin/some \"bc\" file.bc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **BC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **BC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), bc(1) will output lines to that length, including the backslash (**\\**). The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **BC_BANNER** : If this environment variable exists and contains an integer, then a non-zero value activates the copyright banner when bc(1) is in interactive mode, while zero deactivates it. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) does not print the banner when not in interactive mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_SIGINT_RESET** : If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because bc(1) exits on **SIGINT** when not in interactive mode. However, when bc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) reset on **SIGINT**, rather than exit, and zero makes bc(1) exit. If this environment variable exists and is *not* an integer, then bc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes bc(1) use TTY mode, and zero makes bc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) use a prompt, and zero or a non-integer makes bc(1) not use a prompt. If this environment variable does not exist and **BC_TTY_MODE** does, then the value of the **BC_TTY_MODE** environment variable is used. This environment variable and the **BC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **BC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes bc(1) exit after executing the expressions and expression files, and a zero value makes bc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **BC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes bc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS bc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**\<\<**), and right shift (**\>\>**) operators and their corresponding assignment operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the *Named Expressions* subsection of the **SYNTAX** section), giving an invalid **auto** list, having a duplicate **auto**/function parameter, failing to find the end of a code block, attempting to return a value from a **void** function, attempting to use a variable as a reference, and using any extensions when the option **-s** or any equivalents were given. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors, passing the wrong number of arguments to functions, attempting to call an undefined function, and attempting to use a **void** function call as a value in an expression. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, bc(1) always exits and returns **4**, no matter what mode bc(1) is in. The other statuses will only be returned when bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since bc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Per the standard (see the **STANDARDS** section), bc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, bc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. bc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, bc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **BC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, bc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **BC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then bc(1) will not turn TTY mode on. If the environment variable **BC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) standard (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **BC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **BC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **BC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **BC_PROMPT** does not exist, the prompt can be enabled or disabled with the **BC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause bc(1) to do one of two things. If bc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **BC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, bc(1) will exit. However, if bc(1) is in interactive mode, and the **BC_SIGINT_RESET** or its default is an integer and non-zero, then bc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If bc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If bc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to bc(1) as it is executing a file, it can seem as though bc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause bc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when bc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause bc(1) to clean up and exit. # COMMAND LINE HISTORY bc(1) supports interactive command-line editing. If bc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **BC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). If history is enabled, previous lines can be recalled and edited with the arrow keys. **Note**: tabs are converted to 8 spaces. # SEE ALSO dc(1) # STANDARDS bc(1) is compliant with the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . The flags **-efghiqsvVw**, all long options, and the extensions noted above are extensions to that specification. In addition, the behavior of the **quit** implements an interpretation of that specification that is different from all known implementations. For more information see the **Statements** subsection of the **SYNTAX** section. Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. # BUGS Before version **6.1.0**, this bc(1) had incorrect behavior for the **quit** statement. -No other bugs are known. Report bugs at https://git.yzena.com/gavin/bc . +No other bugs are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/bcl.3 b/contrib/bc/manuals/bcl.3 index e066103d02f4..6bebaa8f02cd 100644 --- a/contrib/bc/manuals/bcl.3 +++ b/contrib/bc/manuals/bcl.3 @@ -1,1453 +1,1453 @@ .\" .\" 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. .\" .TH "BCL" "3" "October 2022" "Gavin D. Howard" "Libraries Manual" .nh .ad l .SH NAME .PP bcl - library of arbitrary precision decimal arithmetic .SH SYNOPSIS .SS Use .PP \f[I]#include \f[R] .PP Link with \f[I]-lbcl\f[R], and on POSIX systems, \f[I]-lpthread\f[R] is also required. .SS Setup .PP These items allow clients to set up bcl(3). .PP \f[B]BclError bcl_start(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_end(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_init(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_free(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]bool bcl_abortOnFatalError(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_setAbortOnFatalError(bool\f[R] \f[I]abrt\f[R]\f[B]);\f[R] .PP \f[B]bool bcl_leadingZeroes(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_setLeadingZeroes(bool\f[R] \f[I]leadingZeroes\f[R]\f[B]);\f[R] .PP \f[B]void bcl_gc(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]bool bcl_digitClamp(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_setDigitClamp(bool\f[R] \f[I]digitClamp\f[R]\f[B]);\f[R] .SS Contexts .PP These items will allow clients to handle contexts, which are isolated from each other. This allows more than one client to use bcl(3) in the same program. .PP \f[B]struct BclCtxt;\f[R] .PP \f[B]typedef struct BclCtxt* BclContext;\f[R] .PP \f[B]BclContext bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_ctxt_free(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_pushContext(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]void bcl_popContext(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]BclContext bcl_context(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_ctxt_freeNums(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]size_t bcl_ctxt_scale(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]void bcl_ctxt_setScale(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B]);\f[R] .PP \f[B]size_t bcl_ctxt_ibase(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]void bcl_ctxt_setIbase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]ibase\f[R]\f[B]);\f[R] .PP \f[B]size_t bcl_ctxt_obase(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] .PP \f[B]void bcl_ctxt_setObase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]obase\f[R]\f[B]);\f[R] .SS Errors .PP These items allow clients to handle errors. .PP \f[B]typedef enum BclError BclError;\f[R] .PP \f[B]BclError bcl_err(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .SS Numbers .PP These items allow clients to manipulate and query the arbitrary-precision numbers managed by bcl(3). .PP \f[B]typedef struct { size_t i; } BclNumber;\f[R] .PP \f[B]BclNumber bcl_num_create(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]void bcl_num_free(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]bool bcl_num_neg(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]void bcl_num_setNeg(BclNumber\f[R] \f[I]n\f[R]\f[B], bool\f[R] \f[I]neg\f[R]\f[B]);\f[R] .PP \f[B]size_t bcl_num_scale(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_num_setScale(BclNumber\f[R] \f[I]n\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B]);\f[R] .PP \f[B]size_t bcl_num_len(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .SS Conversion .PP These items allow clients to convert numbers into and from strings and integers. .PP \f[B]BclNumber bcl_parse(const char *restrict\f[R] \f[I]val\f[R]\f[B]);\f[R] .PP \f[B]char* bcl_string(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_bigdig(BclNumber\f[R] \f[I]n\f[R]\f[B], BclBigDig *\f[R]\f[I]result\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_bigdig2num(BclBigDig\f[R] \f[I]val\f[R]\f[B]);\f[R] .SS Math .PP These items allow clients to run math on numbers. .PP \f[B]BclNumber bcl_add(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_sub(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_mul(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_div(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_mod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_pow(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_lshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_rshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_sqrt(BclNumber\f[R] \f[I]a\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_divmod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber *\f[R]\f[I]c\f[R]\f[B], BclNumber *\f[R]\f[I]d\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_modexp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber\f[R] \f[I]c\f[R]\f[B]);\f[R] .SS Miscellaneous .PP These items are miscellaneous. .PP \f[B]void bcl_zero(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]void bcl_one(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]ssize_t bcl_cmp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_copy(BclNumber\f[R] \f[I]d\f[R]\f[B], BclNumber\f[R] \f[I]s\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_dup(BclNumber\f[R] \f[I]s\f[R]\f[B]);\f[R] .SS Pseudo-Random Number Generator .PP These items allow clients to manipulate the seeded pseudo-random number generator in bcl(3). .PP \f[B]#define BCL_SEED_ULONGS\f[R] .PP \f[B]#define BCL_SEED_SIZE\f[R] .PP \f[B]typedef unsigned long BclBigDig;\f[R] .PP \f[B]typedef unsigned long BclRandInt;\f[R] .PP \f[B]BclNumber bcl_irand(BclNumber\f[R] \f[I]a\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_frand(size_t\f[R] \f[I]places\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_ifrand(BclNumber\f[R] \f[I]a\f[R]\f[B], size_t\f[R] \f[I]places\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_rand_seedWithNum(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] .PP \f[B]BclError bcl_rand_seed(unsigned char\f[R] \f[I]seed\f[R]\f[B][\f[R]\f[I]BCL_SEED_SIZE\f[R]\f[B]]);\f[R] .PP \f[B]void bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]BclNumber bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]BclRandInt bcl_rand_int(\f[R]\f[I]void\f[R]\f[B]);\f[R] .PP \f[B]BclRandInt bcl_rand_bounded(BclRandInt\f[R] \f[I]bound\f[R]\f[B]);\f[R] .SH DESCRIPTION .PP bcl(3) is a library that implements arbitrary-precision decimal math, as standardized by POSIX (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) in bc(1). .PP bcl(3) assumes that it is allowed to use the \f[B]bcl\f[R], \f[B]Bcl\f[R], \f[B]bc\f[R], and \f[B]Bc\f[R] prefixes for symbol names without collision. .PP All of the items in its interface are described below. See the documentation for each function for what each function can return. .SS Setup .TP \f[B]BclError bcl_start(\f[R]\f[I]void\f[R]\f[B])\f[R] Initializes this library. This function can be called multiple times, but \f[B]bcl_end()\f[R] must only be called \f[I]once\f[R]. This is to make it possible for multiple libraries and applications to initialize bcl(3) without problem. .RS .PP It is suggested that client libraries call this function, but do not call \f[B]bcl_end()\f[R], and client applications should call both. .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .PP This function must be the first one clients call. Calling any other function without calling this one first is undefined behavior. .RE .TP \f[B]void bcl_end(\f[R]\f[I]void\f[R]\f[B])\f[R] Deinitializes this library. This function must only be called \f[I]once\f[R]. .RS .PP All data must have been freed before calling this function. .PP This function must be the last one clients call. Calling this function before calling any other function is undefined behavior. .RE .TP \f[B]BclError bcl_init(\f[R]\f[I]void\f[R]\f[B])\f[R] Initializes the library for the current thread. This function can be called multiple times, but each call must be matched by a call to \f[B]bcl_free(\f[R]\f[I]void\f[R]\f[B])\f[R]. This is to make it possible for multiple libraries and applications to initialize threads for bcl(3) without problem. .RS .PP This function \f[I]must\f[R] be called from the thread that it is supposed to initialize. .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .PP This function must be the second one clients call. Calling any other function without calling \f[B]bcl_start()\f[R] and then this one first is undefined behavior, except in the case of new threads. New threads can safely call this function without calling \f[B]bcl_start()\f[R] if another thread has previously called \f[B]bcl_start()\f[R]. But this function must still be the first function in bcl(3) called by that new thread. .RE .TP \f[B]void bcl_free(\f[R]\f[I]void\f[R]\f[B])\f[R] Decrements bcl(3)\[cq]s reference count and frees the data associated with it if the reference count is \f[B]0\f[R]. .RS .PP This function \f[I]must\f[R] be called from the thread that it is supposed to deinitialize. .PP This function must be the second to last one clients call. Calling this function before calling any other function besides \f[B]bcl_end()\f[R] is undefined behavior. .RE .TP \f[B]bool bcl_abortOnFatalError(\f[R]\f[I]void\f[R]\f[B])\f[R] Queries and returns the current state of calling \f[B]abort()\f[R] on fatal errors. If \f[B]true\f[R] is returned, bcl(3) will cause a \f[B]SIGABRT\f[R] if a fatal error occurs. .RS .PP If activated, clients do not need to check for fatal errors. .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is read on. .PP The default is \f[B]false\f[R]. .RE .TP \f[B]void bcl_setAbortOnFatalError(bool\f[R] \f[I]abrt\f[R]\f[B])\f[R] Sets the state of calling \f[B]abort()\f[R] on fatal errors. If \f[I]abrt\f[R] is \f[B]false\f[R], bcl(3) will not cause a \f[B]SIGABRT\f[R] on fatal errors after the call. If \f[I]abrt\f[R] is \f[B]true\f[R], bcl(3) will cause a \f[B]SIGABRT\f[R] on fatal errors after the call. .RS .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is set on. .PP If activated, clients do not need to check for fatal errors. .RE .TP \f[B]bool bcl_leadingZeroes(\f[R]\f[I]void\f[R]\f[B])\f[R] Queries and returns the state of whether leading zeroes are added to strings returned by \f[B]bcl_string()\f[R] when numbers are greater than \f[B]-1\f[R], less than \f[B]1\f[R], and not equal to \f[B]0\f[R]. If \f[B]true\f[R] is returned, then leading zeroes will be added. .RS .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is read on. .PP The default is \f[B]false\f[R]. .RE .TP \f[B]void bcl_setLeadingZeroes(bool\f[R] \f[I]leadingZeroes\f[R]\f[B])\f[R] Sets the state of whether leading zeroes are added to strings returned by \f[B]bcl_string()\f[R] when numbers are greater than \f[B]-1\f[R], less than \f[B]1\f[R], and not equal to \f[B]0\f[R]. If \f[I]leadingZeroes\f[R] is \f[B]true\f[R], leading zeroes will be added to strings returned by \f[B]bcl_string()\f[R]. .RS .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is set on. .RE .TP \f[B]bool bcl_digitClamp(\f[R]\f[I]void\f[R]\f[B])\f[R] Queries and returns the state of whether digits in number strings that are greater than or equal to the current \f[B]ibase\f[R] are clamped or not. .RS .PP If \f[B]true\f[R] is returned, then digits are treated as though they are equal to the value of \f[B]ibase\f[R] minus \f[B]1\f[R]. If this is \f[I]not\f[R] true, then digits are treated as though they are equal to the value they would have if \f[B]ibase\f[R] was large enough. They are then multiplied by the appropriate power of \f[B]ibase\f[R]. .PP For example, with clamping off and an \f[B]ibase\f[R] of \f[B]3\f[R], the string \[lq]AB\[rq] would equal \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R], while with clamping on and an \f[B]ibase\f[R] of \f[B]3\f[R], the string \[lq]AB\[rq] would be equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is read on. .PP The default is \f[B]true\f[R]. .RE .TP \f[B]void bcl_setDigitClamp(bool\f[R] \f[I]digitClamp\f[R]\f[B])\f[R] Sets the state of whether digits in number strings that are greater than or equal to the current \f[B]ibase\f[R] are clamped or not. For more information, see the \f[B]bcl_digitClamp(\f[R]\f[I]void\f[R]\f[B])\f[R] function. .RS .PP This value is \f[I]thread-local\f[R]; it applies to just the thread it is set on. .RE .TP \f[B]void bcl_gc(\f[R]\f[I]void\f[R]\f[B])\f[R] Garbage collects cached instances of arbitrary-precision numbers. This only frees the memory of numbers that are \f[I]not\f[R] in use, so it is safe to call at any time. .SS Contexts .PP All procedures that take a \f[B]BclContext\f[R] parameter a require a valid context as an argument. .TP \f[B]struct BclCtxt\f[R] A forward declaration for a hidden \f[B]struct\f[R] type. Clients cannot access the internals of the \f[B]struct\f[R] type directly. All interactions with the type are done through pointers. See \f[B]BclContext\f[R] below. .TP \f[B]BclContext\f[R] A typedef to a pointer of \f[B]struct BclCtxt\f[R]. This is the only handle clients can get to \f[B]struct BclCtxt\f[R]. .RS .PP A \f[B]BclContext\f[R] contains the values \f[B]scale\f[R], \f[B]ibase\f[R], and \f[B]obase\f[R], as well as a list of numbers. .PP \f[B]scale\f[R] is a value used to control how many decimal places calculations should use. A value of \f[B]0\f[R] means that calculations are done on integers only, where applicable, and a value of 20, for example, means that all applicable calculations return results with 20 decimal places. The default is \f[B]0\f[R]. .PP \f[B]ibase\f[R] is a value used to control the input base. The minimum \f[B]ibase\f[R] is \f[B]2\f[R], and the maximum is \f[B]36\f[R]. If \f[B]ibase\f[R] is \f[B]2\f[R], numbers are parsed as though they are in binary, and any digits larger than \f[B]1\f[R] are clamped. Likewise, a value of \f[B]10\f[R] means that numbers are parsed as though they are decimal, and any larger digits are clamped. The default is \f[B]10\f[R]. .PP \f[B]obase\f[R] is a value used to control the output base. The minimum \f[B]obase\f[R] is \f[B]0\f[R] and the maximum is \f[B]BC_BASE_MAX\f[R] (see the \f[B]LIMITS\f[R] section). .PP Numbers created in one context are not valid in another context. It is undefined behavior to use a number created in a different context. Contexts are meant to isolate the numbers used by different clients in the same application. .PP Different threads also have different contexts, so any numbers created in one thread are not valid in another thread. To pass values between contexts and threads, use \f[B]bcl_string()\f[R] to produce a string to pass around, and use \f[B]bcl_parse()\f[R] to parse the string. It is suggested that the \f[B]obase\f[R] used to create the string be passed around with the string and used as the \f[B]ibase\f[R] for \f[B]bcl_parse()\f[R] to ensure that the number will be the same. .RE .TP \f[B]BclContext bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B])\f[R] Creates a context and returns it. Returns \f[B]NULL\f[R] if there was an error. .TP \f[B]void bcl_ctxt_free(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Frees \f[I]ctxt\f[R], after which it is no longer valid. It is undefined behavior to attempt to use an invalid context. .TP \f[B]BclError bcl_pushContext(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Pushes \f[I]ctxt\f[R] onto bcl(3)\[cq]s stack of contexts. \f[I]ctxt\f[R] must have been created with \f[B]bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B])\f[R]. .RS .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .PP There \f[I]must\f[R] be a valid context to do any arithmetic. .RE .TP \f[B]void bcl_popContext(\f[R]\f[I]void\f[R]\f[B])\f[R] Pops the current context off of the stack, if one exists. .TP \f[B]BclContext bcl_context(\f[R]\f[I]void\f[R]\f[B])\f[R] Returns the current context, or \f[B]NULL\f[R] if no context exists. .TP \f[B]void bcl_ctxt_freeNums(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Frees all numbers in use that are associated with \f[I]ctxt\f[R]. It is undefined behavior to attempt to use a number associated with \f[I]ctxt\f[R] after calling this procedure unless such numbers have been created with \f[B]bcl_num_create(\f[R]\f[I]void\f[R]\f[B])\f[R] after calling this procedure. .TP \f[B]size_t bcl_ctxt_scale(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Returns the \f[B]scale\f[R] for given context. .TP \f[B]void bcl_ctxt_setScale(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B])\f[R] Sets the \f[B]scale\f[R] for the given context to the argument \f[I]scale\f[R]. .TP \f[B]size_t bcl_ctxt_ibase(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Returns the \f[B]ibase\f[R] for the given context. .TP \f[B]void bcl_ctxt_setIbase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]ibase\f[R]\f[B])\f[R] Sets the \f[B]ibase\f[R] for the given context to the argument \f[I]ibase\f[R]. If the argument \f[I]ibase\f[R] is invalid, it clamped, so an \f[I]ibase\f[R] of \f[B]0\f[R] or \f[B]1\f[R] is clamped to \f[B]2\f[R], and any values above \f[B]36\f[R] are clamped to \f[B]36\f[R]. .TP \f[B]size_t bcl_ctxt_obase(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] Returns the \f[B]obase\f[R] for the given context. .TP \f[B]void bcl_ctxt_setObase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]obase\f[R]\f[B])\f[R] Sets the \f[B]obase\f[R] for the given context to the argument \f[I]obase\f[R]. .SS Errors .TP \f[B]BclError\f[R] An \f[B]enum\f[R] of possible error codes. See the \f[B]ERRORS\f[R] section for a complete listing the codes. .TP \f[B]BclError bcl_err(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Checks for errors in a \f[B]BclNumber\f[R]. All functions that can return a \f[B]BclNumber\f[R] can encode an error in the number, and this function will return the error, if any. If there was no error, it will return \f[B]BCL_ERROR_NONE\f[R]. .RS .PP There must be a valid current context. .RE .SS Numbers .PP All procedures in this section require a valid current context. .TP \f[B]BclNumber\f[R] A handle to an arbitrary-precision number. The actual number type is not exposed; the \f[B]BclNumber\f[R] handle is the only way clients can refer to instances of arbitrary-precision numbers. .TP \f[B]BclNumber bcl_num_create(\f[R]\f[I]void\f[R]\f[B])\f[R] Creates and returns a \f[B]BclNumber\f[R]. .RS .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]void bcl_num_free(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Frees \f[I]n\f[R]. It is undefined behavior to use \f[I]n\f[R] after calling this function. .TP \f[B]bool bcl_num_neg(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Returns \f[B]true\f[R] if \f[I]n\f[R] is negative, \f[B]false\f[R] otherwise. .TP \f[B]void bcl_num_setNeg(BclNumber\f[R] \f[I]n\f[R]\f[B], bool\f[R] \f[I]neg\f[R]\f[B])\f[R] Sets \f[I]n\f[R]\[cq]s sign to \f[I]neg\f[R], where \f[B]true\f[R] is negative, and \f[B]false\f[R] is positive. .TP \f[B]size_t bcl_num_scale(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Returns the \f[I]scale\f[R] of \f[I]n\f[R]. .RS .PP The \f[I]scale\f[R] of a number is the number of decimal places it has after the radix (decimal point). .RE .TP \f[B]BclError bcl_num_setScale(BclNumber\f[R] \f[I]n\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B])\f[R] Sets the \f[I]scale\f[R] of \f[I]n\f[R] to the argument \f[I]scale\f[R]. If the argument \f[I]scale\f[R] is greater than the \f[I]scale\f[R] of \f[I]n\f[R], \f[I]n\f[R] is extended. If the argument \f[I]scale\f[R] is less than the \f[I]scale\f[R] of \f[I]n\f[R], \f[I]n\f[R] is truncated. .RS .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]size_t bcl_num_len(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Returns the number of \f[I]significant decimal digits\f[R] in \f[I]n\f[R]. .SS Conversion .PP All procedures in this section require a valid current context. .PP All procedures in this section consume the given \f[B]BclNumber\f[R] arguments that are not given to pointer arguments. See the \f[B]Consumption and Propagation\f[R] subsection below. .TP \f[B]BclNumber bcl_parse(const char *restrict\f[R] \f[I]val\f[R]\f[B])\f[R] Parses a number string according to the current context\[cq]s \f[B]ibase\f[R] and returns the resulting number. .RS .PP \f[I]val\f[R] must be non-\f[B]NULL\f[R] and a valid string. See \f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] in the \f[B]ERRORS\f[R] section for more information. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]char* bcl_string(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Returns a string representation of \f[I]n\f[R] according the the current context\[cq]s \f[B]ibase\f[R]. The string is dynamically allocated and must be freed by the caller. .RS .PP \f[I]n\f[R] is consumed; it cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .RE .TP \f[B]BclError bcl_bigdig(BclNumber\f[R] \f[I]n\f[R]\f[B], BclBigDig *\f[R]\f[I]result\f[R]\f[B])\f[R] Converts \f[I]n\f[R] into a \f[B]BclBigDig\f[R] and returns the result in the space pointed to by \f[I]result\f[R]. .RS .PP \f[I]a\f[R] must be smaller than \f[B]BC_OVERFLOW_MAX\f[R]. See the \f[B]LIMITS\f[R] section. .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_OVERFLOW\f[R] .PP \f[I]n\f[R] is consumed; it cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .RE .TP \f[B]BclNumber bcl_bigdig2num(BclBigDig\f[R] \f[I]val\f[R]\f[B])\f[R] Creates a \f[B]BclNumber\f[R] from \f[I]val\f[R]. .RS .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .SS Math .PP All procedures in this section require a valid current context. .PP All procedures in this section can return the following errors: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .TP \f[B]BclNumber bcl_add(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Adds \f[I]a\f[R] and \f[I]b\f[R] and returns the result. The \f[I]scale\f[R] of the result is the max of the \f[I]scale\f[R]s of \f[I]a\f[R] and \f[I]b\f[R]. .RS .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_sub(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Subtracts \f[I]b\f[R] from \f[I]a\f[R] and returns the result. The \f[I]scale\f[R] of the result is the max of the \f[I]scale\f[R]s of \f[I]a\f[R] and \f[I]b\f[R]. .RS .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_mul(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Multiplies \f[I]a\f[R] and \f[I]b\f[R] and returns the result. If \f[I]ascale\f[R] is the \f[I]scale\f[R] of \f[I]a\f[R] and \f[I]bscale\f[R] is the \f[I]scale\f[R] of \f[I]b\f[R], the \f[I]scale\f[R] of the result is equal to \f[B]min(ascale+bscale,max(scale,ascale,bscale))\f[R], where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .RS .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_div(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Divides \f[I]a\f[R] by \f[I]b\f[R] and returns the result. The \f[I]scale\f[R] of the result is the \f[I]scale\f[R] of the current context. .RS .PP \f[I]b\f[R] cannot be \f[B]0\f[R]. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_mod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Divides \f[I]a\f[R] by \f[I]b\f[R] to the \f[I]scale\f[R] of the current context, computes the modulus \f[B]a-(a/b)*b\f[R], and returns the modulus. .RS .PP \f[I]b\f[R] cannot be \f[B]0\f[R]. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_pow(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Calculates \f[I]a\f[R] to the power of \f[I]b\f[R] to the \f[I]scale\f[R] of the current context. \f[I]b\f[R] must be an integer, but can be negative. If it is negative, \f[I]a\f[R] must be non-zero. .RS .PP \f[I]b\f[R] must be an integer. If \f[I]b\f[R] is negative, \f[I]a\f[R] must not be \f[B]0\f[R]. .PP \f[I]a\f[R] must be smaller than \f[B]BC_OVERFLOW_MAX\f[R]. See the \f[B]LIMITS\f[R] section. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_OVERFLOW\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_lshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Shifts \f[I]a\f[R] left (moves the radix right) by \f[I]b\f[R] places and returns the result. This is done in decimal. \f[I]b\f[R] must be an integer. .RS .PP \f[I]b\f[R] must be an integer. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_rshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Shifts \f[I]a\f[R] right (moves the radix left) by \f[I]b\f[R] places and returns the result. This is done in decimal. \f[I]b\f[R] must be an integer. .RS .PP \f[I]b\f[R] must be an integer. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]a\f[R] and \f[I]b\f[R] can be the same number. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_sqrt(BclNumber\f[R] \f[I]a\f[R]\f[B])\f[R] Calculates the square root of \f[I]a\f[R] and returns the result. The \f[I]scale\f[R] of the result is equal to the \f[B]scale\f[R] of the current context. .RS .PP \f[I]a\f[R] cannot be negative. .PP \f[I]a\f[R] is consumed; it cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NEGATIVE\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclError bcl_divmod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber *\f[R]\f[I]c\f[R]\f[B], BclNumber *\f[R]\f[I]d\f[R]\f[B])\f[R] Divides \f[I]a\f[R] by \f[I]b\f[R] and returns the quotient in a new number which is put into the space pointed to by \f[I]c\f[R], and puts the modulus in a new number which is put into the space pointed to by \f[I]d\f[R]. .RS .PP \f[I]b\f[R] cannot be \f[B]0\f[R]. .PP \f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP \f[I]c\f[R] and \f[I]d\f[R] cannot point to the same place, nor can they point to the space occupied by \f[I]a\f[R] or \f[I]b\f[R]. .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_modexp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber\f[R] \f[I]c\f[R]\f[B])\f[R] Computes a modular exponentiation where \f[I]a\f[R] is the base, \f[I]b\f[R] is the exponent, and \f[I]c\f[R] is the modulus, and returns the result. The \f[I]scale\f[R] of the result is equal to the \f[B]scale\f[R] of the current context. .RS .PP \f[I]a\f[R], \f[I]b\f[R], and \f[I]c\f[R] must be integers. \f[I]c\f[R] must not be \f[B]0\f[R]. \f[I]b\f[R] must not be negative. .PP \f[I]a\f[R], \f[I]b\f[R], and \f[I]c\f[R] are consumed; they cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NEGATIVE\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .SS Miscellaneous .TP \f[B]void bcl_zero(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Sets \f[I]n\f[R] to \f[B]0\f[R]. .TP \f[B]void bcl_one(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Sets \f[I]n\f[R] to \f[B]1\f[R]. .TP \f[B]ssize_t bcl_cmp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] Compares \f[I]a\f[R] and \f[I]b\f[R] and returns \f[B]0\f[R] if \f[I]a\f[R] and \f[I]b\f[R] are equal, \f[B]<0\f[R] if \f[I]a\f[R] is less than \f[I]b\f[R], and \f[B]>0\f[R] if \f[I]a\f[R] is greater than \f[I]b\f[R]. .TP \f[B]BclError bcl_copy(BclNumber\f[R] \f[I]d\f[R]\f[B], BclNumber\f[R] \f[I]s\f[R]\f[B])\f[R] Copies \f[I]s\f[R] into \f[I]d\f[R]. .RS .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_dup(BclNumber\f[R] \f[I]s\f[R]\f[B])\f[R] Creates and returns a new \f[B]BclNumber\f[R] that is a copy of \f[I]s\f[R]. .RS .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .SS Pseudo-Random Number Generator .PP The pseudo-random number generator in bcl(3) is a \f[I]seeded\f[R] PRNG. Given the same seed twice, it will produce the same sequence of pseudo-random numbers twice. .PP By default, bcl(3) attempts to seed the PRNG with data from \f[B]/dev/urandom\f[R]. If that fails, it seeds itself with by calling \f[B]libc\f[R]\[cq]s \f[B]srand(time(NULL))\f[R] and then calling \f[B]rand()\f[R] for each byte, since \f[B]rand()\f[R] is only guaranteed to return \f[B]15\f[R] bits. .PP This should provide fairly good seeding in the standard case while also remaining fairly portable. .PP If necessary, the PRNG can be reseeded with one of the following functions: .IP \[bu] 2 \f[B]bcl_rand_seedWithNum(BclNumber)\f[R] .IP \[bu] 2 \f[B]bcl_rand_seed(unsigned char[\f[R]\f[I]BCL_SEED_SIZE\f[R]\f[B]])\f[R] .IP \[bu] 2 \f[B]bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B])\f[R] .PP The following items allow clients to use the pseudo-random number generator. All procedures require a valid current context. .TP \f[B]BCL_SEED_ULONGS\f[R] The number of \f[B]unsigned long\f[R]\[cq]s in a seed for bcl(3)\[cq]s random number generator. .TP \f[B]BCL_SEED_SIZE\f[R] The size, in \f[B]char\f[R]\[cq]s, of a seed for bcl(3)\[cq]s random number generator. .TP \f[B]BclBigDig\f[R] bcl(3)\[cq]s overflow type (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BclRandInt\f[R] An unsigned integer type returned by bcl(3)\[cq]s random number generator. .TP \f[B]BclNumber bcl_irand(BclNumber\f[R] \f[I]a\f[R]\f[B])\f[R] Returns a random number that is not larger than \f[I]a\f[R] in a new number. If \f[I]a\f[R] is \f[B]0\f[R] or \f[B]1\f[R], the new number is equal to \f[B]0\f[R]. The bound is unlimited, so it is not bound to the size of \f[B]BclRandInt\f[R]. This is done by generating as many random numbers as necessary, multiplying them by certain exponents, and adding them all together. .RS .PP \f[I]a\f[R] must be an integer and non-negative. .PP \f[I]a\f[R] is consumed; it cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP This procedure requires a valid current context. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NEGATIVE\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_frand(size_t\f[R] \f[I]places\f[R]\f[B])\f[R] Returns a random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] (exclusive) that has \f[I]places\f[R] decimal digits after the radix (decimal point). There are no limits on \f[I]places\f[R]. .RS .PP This procedure requires a valid current context. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclNumber bcl_ifrand(BclNumber\f[R] \f[I]a\f[R]\f[B], size_t\f[R] \f[I]places\f[R]\f[B])\f[R] Returns a random number less than \f[I]a\f[R] with \f[I]places\f[R] decimal digits after the radix (decimal point). There are no limits on \f[I]a\f[R] or \f[I]places\f[R]. .RS .PP \f[I]a\f[R] must be an integer and non-negative. .PP \f[I]a\f[R] is consumed; it cannot be used after the call. See the \f[B]Consumption and Propagation\f[R] subsection below. .PP This procedure requires a valid current context. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NEGATIVE\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclError bcl_rand_seedWithNum(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] Seeds the PRNG with \f[I]n\f[R]. .RS .PP \f[I]n\f[R] is \f[I]not\f[R] consumed. .PP This procedure requires a valid current context. .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_NUM\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .PP Note that if \f[B]bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B])\f[R] or \f[B]bcl_rand_seed2num_err(BclNumber)\f[R] are called right after this function, they are not guaranteed to return a number equal to \f[I]n\f[R]. .RE .TP \f[B]BclError bcl_rand_seed(unsigned char\f[R] \f[I]seed\f[R]\f[B][\f[R]\f[I]BCL_SEED_SIZE\f[R]\f[B]])\f[R] Seeds the PRNG with the bytes in \f[I]seed\f[R]. .RS .PP If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. Otherwise, this function can return: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .RE .TP \f[B]void bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B])\f[R] Reseeds the PRNG with the default reseeding behavior. First, it attempts to read data from \f[B]/dev/urandom\f[R] and falls back to \f[B]libc\f[R]\[cq]s \f[B]rand()\f[R]. .RS .PP This procedure cannot fail. .RE .TP \f[B]BclNumber bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B])\f[R] Returns the current seed of the PRNG as a \f[B]BclNumber\f[R]. .RS .PP This procedure requires a valid current context. .PP bcl(3) will encode an error in the return value, if there was one. The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. Possible errors include: .IP \[bu] 2 \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] .IP \[bu] 2 \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] .RE .TP \f[B]BclRandInt bcl_rand_int(\f[R]\f[I]void\f[R]\f[B])\f[R] Returns a random integer between \f[B]0\f[R] and \f[B]BC_RAND_MAX\f[R] (inclusive). .RS .PP This procedure cannot fail. .RE .TP \f[B]BclRandInt bcl_rand_bounded(BclRandInt\f[R] \f[I]bound\f[R]\f[B])\f[R] Returns a random integer between \f[B]0\f[R] and \f[I]bound\f[R] (exclusive). Bias is removed before returning the integer. .RS .PP This procedure cannot fail. .RE .SS Consumption and Propagation .PP Some functions are listed as consuming some or all of their arguments. This means that the arguments are freed, regardless of if there were errors or not. .PP This is to enable compact code like the following: .IP .nf \f[C] BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); \f[R] .fi .PP If arguments to those functions were not consumed, memory would be leaked until reclaimed with \f[B]bcl_ctxt_freeNums(BclContext)\f[R]. .PP When errors occur, they are propagated through. The result should always be checked with \f[B]bcl_err(BclNumber)\f[R], so the example above should properly be: .IP .nf \f[C] BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); if (bc_num_err(n) != BCL_ERROR_NONE) { // Handle the error. } \f[R] .fi .SH ERRORS .PP Most functions in bcl(3) return, directly or indirectly, any one of the error codes defined in \f[B]BclError\f[R]. The complete list of codes is the following: .TP \f[B]BCL_ERROR_NONE\f[R] Success; no error occurred. .TP \f[B]BCL_ERROR_INVALID_NUM\f[R] An invalid \f[B]BclNumber\f[R] was given as a parameter. .TP \f[B]BCL_ERROR_INVALID_CONTEXT\f[R] An invalid \f[B]BclContext\f[R] is being used. .TP \f[B]BCL_ERROR_MATH_NEGATIVE\f[R] A negative number was given as an argument to a parameter that cannot accept negative numbers, such as for square roots. .TP \f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] A non-integer was given as an argument to a parameter that cannot accept non-integer numbers, such as for the second parameter of \f[B]bcl_num_pow()\f[R]. .TP \f[B]BCL_ERROR_MATH_OVERFLOW\f[R] A number that would overflow its result was given as an argument, such as for converting a \f[B]BclNumber\f[R] to a \f[B]BclBigDig\f[R]. .TP \f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] A divide by zero occurred. .TP \f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] An invalid number string was passed to a parsing function. .RS .PP A valid number string can only be one radix (period). In addition, any lowercase ASCII letters, symbols, or non-ASCII characters are invalid. It is allowed for the first character to be a dash. In that case, the number is considered to be negative. .PP There is one exception to the above: one lowercase \f[B]e\f[R] is allowed in the number, after the radix, if it exists. If the letter \f[B]e\f[R] exists, the number is considered to be in scientific notation, where the part before the \f[B]e\f[R] is the number, and the part after, which must be an integer, is the exponent. There can be a dash right after the \f[B]e\f[R] to indicate a negative exponent. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bcl(3) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if bcl(3) is given the number string \f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .RE .TP \f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] bcl(3) failed to allocate memory. .RS .PP If clients call \f[B]bcl_setAbortOnFatalError()\f[R] with an \f[B]true\f[R] argument, this error will cause bcl(3) to throw a \f[B]SIGABRT\f[R]. This behavior can also be turned off later by calling that same function with a \f[B]false\f[R] argument. By default, this behavior is off. .PP It is highly recommended that client libraries do \f[I]not\f[R] activate this behavior. .RE .TP \f[B]BCL_ERROR_FATAL_UNKNOWN_ERR\f[R] An unknown error occurred. .RS .PP If clients call \f[B]bcl_setAbortOnFatalError()\f[R] with an \f[B]true\f[R] argument, this error will cause bcl(3) to throw a \f[B]SIGABRT\f[R]. This behavior can also be turned off later by calling that same function with a \f[B]false\f[R] argument. By default, this behavior is off. .PP It is highly recommended that client libraries do \f[I]not\f[R] activate this behavior. .RE .SH ATTRIBUTES .PP bcl(3) is \f[I]MT-Safe\f[R]: it is safe to call any functions from more than one thread. However, is is \f[I]not\f[R] safe to pass any data between threads except for strings returned by \f[B]bcl_string()\f[R]. .PP bcl(3) is not \f[I]async-signal-safe\f[R]. It was not possible to make bcl(3) safe with signals and also make it safe with multiple threads. If it is necessary to be able to interrupt bcl(3), spawn a separate thread to run the calculation. .SH PERFORMANCE .PP Most bc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. bcl(3) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]BC_BASE_DIGS\f[R]. .PP In addition, this bcl(3) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bcl(3): .TP \f[B]BC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where bcl(3) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]BC_BASE_DIGS\f[R]. .TP \f[B]BC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]BC_LONG_BIT\f[R]. .TP \f[B]BC_BASE_MAX\f[R] The maximum output base. Set at \f[B]BC_BASE_POW\f[R]. .TP \f[B]BC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP \f[B]BC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]bcl_rand_int()\f[R] function. Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]BC_OVERFLOW_MAX\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH SEE ALSO .PP bc(1) and dc(1) .SH STANDARDS .PP bcl(3) is compliant with the arithmetic defined in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html for bc(1). .PP Note that the specification explicitly says that bc(1) only accepts numbers that use a period (\f[B].\f[R]) as a radix point, regardless of the value of \f[B]LC_NUMERIC\f[R]. This is also true of bcl(3). .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc. +Report bugs at https://git.gavinhoward.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/bcl.3.md b/contrib/bc/manuals/bcl.3.md index e2d92866ddbe..6c6967b44770 100644 --- a/contrib/bc/manuals/bcl.3.md +++ b/contrib/bc/manuals/bcl.3.md @@ -1,1237 +1,1237 @@ # NAME bcl - library of arbitrary precision decimal arithmetic # SYNOPSIS ## Use *#include * Link with *-lbcl*, and on POSIX systems, *-lpthread* is also required. ## Setup These items allow clients to set up bcl(3). **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_**);** **void bcl_gc(**_void_**);** **bool bcl_digitClamp(**_void_**);** **void bcl_setDigitClamp(bool** _digitClamp_**);** ## Contexts These items will allow clients to handle contexts, which are isolated from each other. This allows more than one client to use bcl(3) in the same program. **struct BclCtxt;** **typedef struct BclCtxt\* BclContext;** **BclContext bcl_ctxt_create(**_void_**);** **void bcl_ctxt_free(BclContext** _ctxt_**);** **BclError bcl_pushContext(BclContext** _ctxt_**);** **void bcl_popContext(**_void_**);** **BclContext bcl_context(**_void_**);** **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_**);** ## Errors These items allow clients to handle errors. **typedef enum BclError BclError;** **BclError bcl_err(BclNumber** _n_**);** ## Numbers These items allow clients to manipulate and query the arbitrary-precision numbers managed by bcl(3). **typedef struct { size_t i; } BclNumber;** **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_**);** ## Conversion These items allow clients to convert numbers into and from strings and integers. **BclNumber bcl_parse(const char \*restrict** _val_**);** **char\* bcl_string(BclNumber** _n_**);** **BclError bcl_bigdig(BclNumber** _n_**, BclBigDig \***_result_**);** **BclNumber bcl_bigdig2num(BclBigDig** _val_**);** ## Math These items allow clients to run math on numbers. **BclNumber bcl_add(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_sub(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_mul(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_div(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_mod(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_pow(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_lshift(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_rshift(BclNumber** _a_**, BclNumber** _b_**);** **BclNumber bcl_sqrt(BclNumber** _a_**);** **BclError bcl_divmod(BclNumber** _a_**, BclNumber** _b_**, BclNumber \***_c_**, BclNumber \***_d_**);** **BclNumber bcl_modexp(BclNumber** _a_**, BclNumber** _b_**, BclNumber** _c_**);** ## Miscellaneous These items are miscellaneous. **void bcl_zero(BclNumber** _n_**);** **void bcl_one(BclNumber** _n_**);** **ssize_t bcl_cmp(BclNumber** _a_**, BclNumber** _b_**);** **BclError bcl_copy(BclNumber** _d_**, BclNumber** _s_**);** **BclNumber bcl_dup(BclNumber** _s_**);** ## Pseudo-Random Number Generator These items allow clients to manipulate the seeded pseudo-random number generator in bcl(3). **#define BCL_SEED_ULONGS** **#define BCL_SEED_SIZE** **typedef unsigned long BclBigDig;** **typedef unsigned long BclRandInt;** **BclNumber bcl_irand(BclNumber** _a_**);** **BclNumber bcl_frand(size_t** _places_**);** **BclNumber bcl_ifrand(BclNumber** _a_**, size_t** _places_**);** **BclError bcl_rand_seedWithNum(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_**);** # DESCRIPTION bcl(3) is a library that implements arbitrary-precision decimal math, as standardized by POSIX (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) in bc(1). bcl(3) assumes that it is allowed to use the **bcl**, **Bcl**, **bc**, and **Bc** prefixes for symbol names without collision. All of the items in its interface are described below. See the documentation for each function for what each function can return. ## Setup **BclError bcl_start(**_void_**)** : Initializes this library. This function can be called multiple times, but **bcl_end()** must only be called *once*. This is to make it possible for multiple libraries and applications to initialize bcl(3) without problem. It is suggested that client libraries call this function, but do not call **bcl_end()**, and client applications should call both. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_FATAL_ALLOC_ERR** This function must be the first one clients call. Calling any other function without calling this one first is undefined behavior. **void bcl_end(**_void_**)** : Deinitializes this library. This function must only be called *once*. All data must have been freed before calling this function. This function must be the last one clients call. Calling this function before calling any other function is undefined behavior. **BclError bcl_init(**_void_**)** : Initializes the library for the current thread. This function can be called multiple times, but each call must be matched by a call to **bcl_free(**_void_**)**. This is to make it possible for multiple libraries and applications to initialize threads for bcl(3) without problem. This function *must* be called from the thread that it is supposed to initialize. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_FATAL_ALLOC_ERR** This function must be the second one clients call. Calling any other function without calling **bcl_start()** and then this one first is undefined behavior, except in the case of new threads. New threads can safely call this function without calling **bcl_start()** if another thread has previously called **bcl_start()**. But this function must still be the first function in bcl(3) called by that new thread. **void bcl_free(**_void_**)** : Decrements bcl(3)'s reference count and frees the data associated with it if the reference count is **0**. This function *must* be called from the thread that it is supposed to deinitialize. This function must be the second to last one clients call. Calling this function before calling any other function besides **bcl_end()** is undefined behavior. **bool bcl_abortOnFatalError(**_void_**)** : Queries and returns the current state of calling **abort()** on fatal errors. If **true** is returned, bcl(3) will cause a **SIGABRT** if a fatal error occurs. If activated, clients do not need to check for fatal errors. This value is *thread-local*; it applies to just the thread it is read on. The default is **false**. **void bcl_setAbortOnFatalError(bool** _abrt_**)** : Sets the state of calling **abort()** on fatal errors. If *abrt* is **false**, bcl(3) will not cause a **SIGABRT** on fatal errors after the call. If *abrt* is **true**, bcl(3) will cause a **SIGABRT** on fatal errors after the call. This value is *thread-local*; it applies to just the thread it is set on. If activated, clients do not need to check for fatal errors. **bool bcl_leadingZeroes(**_void_**)** : Queries and returns the state of whether leading zeroes are added to strings returned by **bcl_string()** when numbers are greater than **-1**, less than **1**, and not equal to **0**. If **true** is returned, then leading zeroes will be added. This value is *thread-local*; it applies to just the thread it is read on. The default is **false**. **void bcl_setLeadingZeroes(bool** _leadingZeroes_**)** : Sets the state of whether leading zeroes are added to strings returned by **bcl_string()** when numbers are greater than **-1**, less than **1**, and not equal to **0**. If *leadingZeroes* is **true**, leading zeroes will be added to strings returned by **bcl_string()**. This value is *thread-local*; it applies to just the thread it is set on. **bool bcl_digitClamp(**_void_**)** : Queries and returns the state of whether digits in number strings that are greater than or equal to the current **ibase** are clamped or not. If **true** is returned, then digits are treated as though they are equal to the value of **ibase** minus **1**. If this is *not* true, then digits are treated as though they are equal to the value they would have if **ibase** was large enough. They are then multiplied by the appropriate power of **ibase**. For example, with clamping off and an **ibase** of **3**, the string "AB" would equal **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**, while with clamping on and an **ibase** of **3**, the string "AB" would be equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. This value is *thread-local*; it applies to just the thread it is read on. The default is **true**. **void bcl_setDigitClamp(bool** _digitClamp_**)** : Sets the state of whether digits in number strings that are greater than or equal to the current **ibase** are clamped or not. For more information, see the **bcl_digitClamp(**_void_**)** function. This value is *thread-local*; it applies to just the thread it is set on. **void bcl_gc(**_void_**)** : Garbage collects cached instances of arbitrary-precision numbers. This only frees the memory of numbers that are *not* in use, so it is safe to call at any time. ## Contexts All procedures that take a **BclContext** parameter a require a valid context as an argument. **struct BclCtxt** : A forward declaration for a hidden **struct** type. Clients cannot access the internals of the **struct** type directly. All interactions with the type are done through pointers. See **BclContext** below. **BclContext** : A typedef to a pointer of **struct BclCtxt**. This is the only handle clients can get to **struct BclCtxt**. A **BclContext** contains the values **scale**, **ibase**, and **obase**, as well as a list of numbers. **scale** is a value used to control how many decimal places calculations should use. A value of **0** means that calculations are done on integers only, where applicable, and a value of 20, for example, means that all applicable calculations return results with 20 decimal places. The default is **0**. **ibase** is a value used to control the input base. The minimum **ibase** is **2**, and the maximum is **36**. If **ibase** is **2**, numbers are parsed as though they are in binary, and any digits larger than **1** are clamped. Likewise, a value of **10** means that numbers are parsed as though they are decimal, and any larger digits are clamped. The default is **10**. **obase** is a value used to control the output base. The minimum **obase** is **0** and the maximum is **BC_BASE_MAX** (see the **LIMITS** section). Numbers created in one context are not valid in another context. It is undefined behavior to use a number created in a different context. Contexts are meant to isolate the numbers used by different clients in the same application. Different threads also have different contexts, so any numbers created in one thread are not valid in another thread. To pass values between contexts and threads, use **bcl_string()** to produce a string to pass around, and use **bcl_parse()** to parse the string. It is suggested that the **obase** used to create the string be passed around with the string and used as the **ibase** for **bcl_parse()** to ensure that the number will be the same. **BclContext bcl_ctxt_create(**_void_**)** : Creates a context and returns it. Returns **NULL** if there was an error. **void bcl_ctxt_free(BclContext** _ctxt_**)** : Frees *ctxt*, after which it is no longer valid. It is undefined behavior to attempt to use an invalid context. **BclError bcl_pushContext(BclContext** _ctxt_**)** : Pushes *ctxt* onto bcl(3)'s stack of contexts. *ctxt* must have been created with **bcl_ctxt_create(**_void_**)**. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_FATAL_ALLOC_ERR** There *must* be a valid context to do any arithmetic. **void bcl_popContext(**_void_**)** : Pops the current context off of the stack, if one exists. **BclContext bcl_context(**_void_**)** : Returns the current context, or **NULL** if no context exists. **void bcl_ctxt_freeNums(BclContext** _ctxt_**)** : Frees all numbers in use that are associated with *ctxt*. It is undefined behavior to attempt to use a number associated with *ctxt* after calling this procedure unless such numbers have been created with **bcl_num_create(**_void_**)** after calling this procedure. **size_t bcl_ctxt_scale(BclContext** _ctxt_**)** : Returns the **scale** for given context. **void bcl_ctxt_setScale(BclContext** _ctxt_**, size_t** _scale_**)** : Sets the **scale** for the given context to the argument *scale*. **size_t bcl_ctxt_ibase(BclContext** _ctxt_**)** : Returns the **ibase** for the given context. **void bcl_ctxt_setIbase(BclContext** _ctxt_**, size_t** _ibase_**)** : Sets the **ibase** for the given context to the argument *ibase*. If the argument *ibase* is invalid, it clamped, so an *ibase* of **0** or **1** is clamped to **2**, and any values above **36** are clamped to **36**. **size_t bcl_ctxt_obase(BclContext** _ctxt_**)** : Returns the **obase** for the given context. **void bcl_ctxt_setObase(BclContext** _ctxt_**, size_t** _obase_**)** : Sets the **obase** for the given context to the argument *obase*. ## Errors **BclError** : An **enum** of possible error codes. See the **ERRORS** section for a complete listing the codes. **BclError bcl_err(BclNumber** _n_**)** : Checks for errors in a **BclNumber**. All functions that can return a **BclNumber** can encode an error in the number, and this function will return the error, if any. If there was no error, it will return **BCL_ERROR_NONE**. There must be a valid current context. ## Numbers All procedures in this section require a valid current context. **BclNumber** : A handle to an arbitrary-precision number. The actual number type is not exposed; the **BclNumber** handle is the only way clients can refer to instances of arbitrary-precision numbers. **BclNumber bcl_num_create(**_void_**)** : Creates and returns a **BclNumber**. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **void bcl_num_free(BclNumber** _n_**)** : Frees *n*. It is undefined behavior to use *n* after calling this function. **bool bcl_num_neg(BclNumber** _n_**)** : Returns **true** if *n* is negative, **false** otherwise. **void bcl_num_setNeg(BclNumber** _n_**, bool** _neg_**)** : Sets *n*'s sign to *neg*, where **true** is negative, and **false** is positive. **size_t bcl_num_scale(BclNumber** _n_**)** : Returns the *scale* of *n*. The *scale* of a number is the number of decimal places it has after the radix (decimal point). **BclError bcl_num_setScale(BclNumber** _n_**, size_t** _scale_**)** : Sets the *scale* of *n* to the argument *scale*. If the argument *scale* is greater than the *scale* of *n*, *n* is extended. If the argument *scale* is less than the *scale* of *n*, *n* is truncated. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **size_t bcl_num_len(BclNumber** _n_**)** : Returns the number of *significant decimal digits* in *n*. ## Conversion All procedures in this section require a valid current context. All procedures in this section consume the given **BclNumber** arguments that are not given to pointer arguments. See the **Consumption and Propagation** subsection below. **BclNumber bcl_parse(const char \*restrict** _val_**)** : Parses a number string according to the current context's **ibase** and returns the resulting number. *val* must be non-**NULL** and a valid string. See **BCL_ERROR_PARSE_INVALID_STR** in the **ERRORS** section for more information. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_PARSE_INVALID_STR** * **BCL_ERROR_FATAL_ALLOC_ERR** **char\* bcl_string(BclNumber** _n_**)** : Returns a string representation of *n* according the the current context's **ibase**. The string is dynamically allocated and must be freed by the caller. *n* is consumed; it cannot be used after the call. See the **Consumption and Propagation** subsection below. **BclError bcl_bigdig(BclNumber** _n_**, BclBigDig \***_result_**)** : Converts *n* into a **BclBigDig** and returns the result in the space pointed to by *result*. *a* must be smaller than **BC_OVERFLOW_MAX**. See the **LIMITS** section. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_OVERFLOW** *n* is consumed; it cannot be used after the call. See the **Consumption and Propagation** subsection below. **BclNumber bcl_bigdig2num(BclBigDig** _val_**)** : Creates a **BclNumber** from *val*. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** ## Math All procedures in this section require a valid current context. All procedures in this section can return the following errors: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_add(BclNumber** _a_**, BclNumber** _b_**)** : Adds *a* and *b* and returns the result. The *scale* of the result is the max of the *scale*s of *a* and *b*. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_sub(BclNumber** _a_**, BclNumber** _b_**)** : Subtracts *b* from *a* and returns the result. The *scale* of the result is the max of the *scale*s of *a* and *b*. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_mul(BclNumber** _a_**, BclNumber** _b_**)** : Multiplies *a* and *b* and returns the result. If *ascale* is the *scale* of *a* and *bscale* is the *scale* of *b*, the *scale* of the result is equal to **min(ascale+bscale,max(scale,ascale,bscale))**, where **min()** and **max()** return the obvious values. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_div(BclNumber** _a_**, BclNumber** _b_**)** : Divides *a* by *b* and returns the result. The *scale* of the result is the *scale* of the current context. *b* cannot be **0**. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_mod(BclNumber** _a_**, BclNumber** _b_**)** : Divides *a* by *b* to the *scale* of the current context, computes the modulus **a-(a/b)\*b**, and returns the modulus. *b* cannot be **0**. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_pow(BclNumber** _a_**, BclNumber** _b_**)** : Calculates *a* to the power of *b* to the *scale* of the current context. *b* must be an integer, but can be negative. If it is negative, *a* must be non-zero. *b* must be an integer. If *b* is negative, *a* must not be **0**. *a* must be smaller than **BC_OVERFLOW_MAX**. See the **LIMITS** section. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_MATH_OVERFLOW** * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_lshift(BclNumber** _a_**, BclNumber** _b_**)** : Shifts *a* left (moves the radix right) by *b* places and returns the result. This is done in decimal. *b* must be an integer. *b* must be an integer. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_rshift(BclNumber** _a_**, BclNumber** _b_**)** : Shifts *a* right (moves the radix left) by *b* places and returns the result. This is done in decimal. *b* must be an integer. *b* must be an integer. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *a* and *b* can be the same number. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_sqrt(BclNumber** _a_**)** : Calculates the square root of *a* and returns the result. The *scale* of the result is equal to the **scale** of the current context. *a* cannot be negative. *a* is consumed; it cannot be used after the call. See the **Consumption and Propagation** subsection below. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NEGATIVE** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclError bcl_divmod(BclNumber** _a_**, BclNumber** _b_**, BclNumber \***_c_**, BclNumber \***_d_**)** : Divides *a* by *b* and returns the quotient in a new number which is put into the space pointed to by *c*, and puts the modulus in a new number which is put into the space pointed to by *d*. *b* cannot be **0**. *a* and *b* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. *c* and *d* cannot point to the same place, nor can they point to the space occupied by *a* or *b*. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_modexp(BclNumber** _a_**, BclNumber** _b_**, BclNumber** _c_**)** : Computes a modular exponentiation where *a* is the base, *b* is the exponent, and *c* is the modulus, and returns the result. The *scale* of the result is equal to the **scale** of the current context. *a*, *b*, and *c* must be integers. *c* must not be **0**. *b* must not be negative. *a*, *b*, and *c* are consumed; they cannot be used after the call. See the **Consumption and Propagation** subsection below. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NEGATIVE** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** * **BCL_ERROR_FATAL_ALLOC_ERR** ## Miscellaneous **void bcl_zero(BclNumber** _n_**)** : Sets *n* to **0**. **void bcl_one(BclNumber** _n_**)** : Sets *n* to **1**. **ssize_t bcl_cmp(BclNumber** _a_**, BclNumber** _b_**)** : Compares *a* and *b* and returns **0** if *a* and *b* are equal, **<0** if *a* is less than *b*, and **>0** if *a* is greater than *b*. **BclError bcl_copy(BclNumber** _d_**, BclNumber** _s_**)** : Copies *s* into *d*. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_dup(BclNumber** _s_**)** : Creates and returns a new **BclNumber** that is a copy of *s*. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** ## Pseudo-Random Number Generator The pseudo-random number generator in bcl(3) is a *seeded* PRNG. Given the same seed twice, it will produce the same sequence of pseudo-random numbers twice. By default, bcl(3) attempts to seed the PRNG with data from **/dev/urandom**. If that fails, it seeds itself with by calling **libc**'s **srand(time(NULL))** and then calling **rand()** for each byte, since **rand()** is only guaranteed to return **15** bits. This should provide fairly good seeding in the standard case while also remaining fairly portable. If necessary, the PRNG can be reseeded with one of the following functions: * **bcl_rand_seedWithNum(BclNumber)** * **bcl_rand_seed(unsigned char[**_BCL_SEED_SIZE_**])** * **bcl_rand_reseed(**_void_**)** The following items allow clients to use the pseudo-random number generator. All procedures require a valid current context. **BCL_SEED_ULONGS** : The number of **unsigned long**'s in a seed for bcl(3)'s random number generator. **BCL_SEED_SIZE** : The size, in **char**'s, of a seed for bcl(3)'s random number generator. **BclBigDig** : bcl(3)'s overflow type (see the **PERFORMANCE** section). **BclRandInt** : An unsigned integer type returned by bcl(3)'s random number generator. **BclNumber bcl_irand(BclNumber** _a_**)** : Returns a random number that is not larger than *a* in a new number. If *a* is **0** or **1**, the new number is equal to **0**. The bound is unlimited, so it is not bound to the size of **BclRandInt**. This is done by generating as many random numbers as necessary, multiplying them by certain exponents, and adding them all together. *a* must be an integer and non-negative. *a* is consumed; it cannot be used after the call. See the **Consumption and Propagation** subsection below. This procedure requires a valid current context. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NEGATIVE** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_frand(size_t** _places_**)** : Returns a random number between **0** (inclusive) and **1** (exclusive) that has *places* decimal digits after the radix (decimal point). There are no limits on *places*. This procedure requires a valid current context. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclNumber bcl_ifrand(BclNumber** _a_**, size_t** _places_**)** : Returns a random number less than *a* with *places* decimal digits after the radix (decimal point). There are no limits on *a* or *places*. *a* must be an integer and non-negative. *a* is consumed; it cannot be used after the call. See the **Consumption and Propagation** subsection below. This procedure requires a valid current context. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_MATH_NEGATIVE** * **BCL_ERROR_MATH_NON_INTEGER** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclError bcl_rand_seedWithNum(BclNumber** _n_**)** : Seeds the PRNG with *n*. *n* is *not* consumed. This procedure requires a valid current context. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_NUM** * **BCL_ERROR_INVALID_CONTEXT** Note that if **bcl_rand_seed2num(**_void_**)** or **bcl_rand_seed2num_err(BclNumber)** are called right after this function, they are not guaranteed to return a number equal to *n*. **BclError bcl_rand_seed(unsigned char** _seed_**[**_BCL_SEED_SIZE_**])** : Seeds the PRNG with the bytes in *seed*. If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this function can return: * **BCL_ERROR_INVALID_CONTEXT** **void bcl_rand_reseed(**_void_**)** : Reseeds the PRNG with the default reseeding behavior. First, it attempts to read data from **/dev/urandom** and falls back to **libc**'s **rand()**. This procedure cannot fail. **BclNumber bcl_rand_seed2num(**_void_**)** : Returns the current seed of the PRNG as a **BclNumber**. This procedure requires a valid current context. bcl(3) will encode an error in the return value, if there was one. The error can be queried with **bcl_err(BclNumber)**. Possible errors include: * **BCL_ERROR_INVALID_CONTEXT** * **BCL_ERROR_FATAL_ALLOC_ERR** **BclRandInt bcl_rand_int(**_void_**)** : Returns a random integer between **0** and **BC_RAND_MAX** (inclusive). This procedure cannot fail. **BclRandInt bcl_rand_bounded(BclRandInt** _bound_**)** : Returns a random integer between **0** and *bound* (exclusive). Bias is removed before returning the integer. This procedure cannot fail. ## Consumption and Propagation Some functions are listed as consuming some or all of their arguments. This means that the arguments are freed, regardless of if there were errors or not. This is to enable compact code like the following: BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); If arguments to those functions were not consumed, memory would be leaked until reclaimed with **bcl_ctxt_freeNums(BclContext)**. When errors occur, they are propagated through. The result should always be checked with **bcl_err(BclNumber)**, so the example above should properly be: BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); if (bc_num_err(n) != BCL_ERROR_NONE) { // Handle the error. } # ERRORS Most functions in bcl(3) return, directly or indirectly, any one of the error codes defined in **BclError**. The complete list of codes is the following: **BCL_ERROR_NONE** : Success; no error occurred. **BCL_ERROR_INVALID_NUM** : An invalid **BclNumber** was given as a parameter. **BCL_ERROR_INVALID_CONTEXT** : An invalid **BclContext** is being used. **BCL_ERROR_MATH_NEGATIVE** : A negative number was given as an argument to a parameter that cannot accept negative numbers, such as for square roots. **BCL_ERROR_MATH_NON_INTEGER** : A non-integer was given as an argument to a parameter that cannot accept non-integer numbers, such as for the second parameter of **bcl_num_pow()**. **BCL_ERROR_MATH_OVERFLOW** : A number that would overflow its result was given as an argument, such as for converting a **BclNumber** to a **BclBigDig**. **BCL_ERROR_MATH_DIVIDE_BY_ZERO** : A divide by zero occurred. **BCL_ERROR_PARSE_INVALID_STR** : An invalid number string was passed to a parsing function. A valid number string can only be one radix (period). In addition, any lowercase ASCII letters, symbols, or non-ASCII characters are invalid. It is allowed for the first character to be a dash. In that case, the number is considered to be negative. There is one exception to the above: one lowercase **e** is allowed in the number, after the radix, if it exists. If the letter **e** exists, the number is considered to be in scientific notation, where the part before the **e** is the number, and the part after, which must be an integer, is the exponent. There can be a dash right after the **e** to indicate a negative exponent. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and bcl(3) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if bcl(3) is given the number string **10e-4**, the resulting decimal number will be **0.0016**. **BCL_ERROR_FATAL_ALLOC_ERR** : bcl(3) failed to allocate memory. If clients call **bcl_setAbortOnFatalError()** with an **true** argument, this error will cause bcl(3) to throw a **SIGABRT**. This behavior can also be turned off later by calling that same function with a **false** argument. By default, this behavior is off. It is highly recommended that client libraries do *not* activate this behavior. **BCL_ERROR_FATAL_UNKNOWN_ERR** : An unknown error occurred. If clients call **bcl_setAbortOnFatalError()** with an **true** argument, this error will cause bcl(3) to throw a **SIGABRT**. This behavior can also be turned off later by calling that same function with a **false** argument. By default, this behavior is off. It is highly recommended that client libraries do *not* activate this behavior. # ATTRIBUTES bcl(3) is *MT-Safe*: it is safe to call any functions from more than one thread. However, is is *not* safe to pass any data between threads except for strings returned by **bcl_string()**. bcl(3) is not *async-signal-safe*. It was not possible to make bcl(3) safe with signals and also make it safe with multiple threads. If it is necessary to be able to interrupt bcl(3), spawn a separate thread to run the calculation. # PERFORMANCE Most bc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. bcl(3) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **BC_BASE_DIGS**. In addition, this bcl(3) uses an even larger integer for overflow checking. This integer type depends on the value of **BC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on bcl(3): **BC_LONG_BIT** : The number of bits in the **long** type in the environment where bcl(3) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **BC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **BC_LONG_BIT**. **BC_BASE_POW** : The max decimal number that each large integer can store (see **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. **BC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **BC_LONG_BIT**. **BC_BASE_MAX** : The maximum output base. Set at **BC_BASE_POW**. **BC_SCALE_MAX** : The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. **BC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **BC_OVERFLOW_MAX-1**. **BC_RAND_MAX** : The maximum integer (inclusive) returned by the **bcl_rand_int()** function. Set at **2\^BC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **BC_OVERFLOW_MAX**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # SEE ALSO bc(1) and dc(1) # STANDARDS bcl(3) is compliant with the arithmetic defined in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html for bc(1). Note that the specification explicitly says that bc(1) only accepts numbers that use a period (**.**) as a radix point, regardless of the value of **LC_NUMERIC**. This is also true of bcl(3). # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc. +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc. # AUTHORS -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/build.md b/contrib/bc/manuals/build.md index 5cec45f596b4..d9c46ae22602 100644 --- a/contrib/bc/manuals/build.md +++ b/contrib/bc/manuals/build.md @@ -1,995 +1,995 @@ # Build This `bc` attempts to be as portable as possible. It can be built on any POSIX-compliant system. To accomplish that, a POSIX-compatible, custom `configure.sh` script is used to select build options, compiler, and compiler flags and generate a `Makefile`. The general form of configuring, building, and installing this `bc` is as follows: ``` [ENVIRONMENT_VARIABLE=...] ./configure.sh [build_options...] make make install ``` To get all of the options, including any useful environment variables, use either one of the following commands: ``` ./configure.sh -h ./configure.sh --help ``` ***WARNING***: even though `configure.sh` supports both option types, short and long, it does not support handling both at the same time. Use only one type. To learn the available `make` targets run the following command after running the `configure.sh` script: ``` make help ``` See [Build Environment Variables][4] for a more detailed description of all accepted environment variables and [Build Options][5] for more detail about all accepted build options. ## Windows For releases, Windows builds of `bc`, `dc`, and `bcl` are available for download -from and GitHub. +from and GitHub. However, if you wish to build it yourself, this `bc` can be built using Visual Studio or MSBuild. Unfortunately, only one build configuration (besides Debug or Release) is supported: extra math and history enabled, NLS (locale support) disabled, with both calculators built. The default [settings][11] are `BC_BANNER=1`, `{BC,DC}_SIGINT_RESET=0`, `{BC,DC}_TTY_MODE=1`, `{BC,DC}_PROMPT=1`. The library can also be built on Windows. ### Visual Studio In Visual Studio, open up the solution file (`bc.sln` for `bc`, or `bcl.sln` for the library), select the desired configuration, and build. ### MSBuild To build with MSBuild, first, *be sure that you are using the MSBuild that comes with Visual Studio*. To build `bc`, run the following from the root directory: ``` msbuild -property:Configuration= vs/bc.sln ``` where `` is either one of `Debug` or `Release`. To build the library, run the following from the root directory: ``` msbuild -property:Configuration= vs/bcl.sln ``` where `` is either one of `Debug`, `ReleaseMD`, or `ReleaseMT`. ## POSIX-Compatible Systems Building `bc`, `dc`, and `bcl` (the library) is more complex than on Windows because many build options are supported. ### Out-of-Source Builds Out-of-source builds are done by calling `configure.sh` from the directory where the build will happen. The `Makefile` is generated into that directory, and the build can happen normally from there. For example, if the source is in `bc`, the build should happen in `build`, then call `configure.sh` and `make` like so: ``` ../bc/configure.sh make ``` ***WARNING***: The path to `configure.sh` from the build directory must not have spaces because `make` does not support target names with spaces. ### Cross Compiling To cross-compile this `bc`, an appropriate compiler must be present and assigned to the environment variable `HOSTCC` or `HOST_CC` (the two are equivalent, though `HOSTCC` is prioritized). This is in order to bootstrap core file(s), if the architectures are not compatible (i.e., unlike i686 on x86_64). Thus, the approach is: ``` HOSTCC="/path/to/native/compiler" ./configure.sh make make install ``` `HOST_CC` will work in exactly the same way. `HOSTCFLAGS` and `HOST_CFLAGS` can be used to set compiler flags for `HOSTCC`. (The two are equivalent, as `HOSTCC` and `HOST_CC` are.) `HOSTCFLAGS` is prioritized over `HOST_CFLAGS`. If neither are present, `HOSTCC` (or `HOST_CC`) uses `CFLAGS` (see [Build Environment Variables][4] for more details). It is expected that `CC` produces code for the target system and `HOSTCC` produces code for the host system. See [Build Environment Variables][4] for more details. If an emulator is necessary to run the bootstrap binaries, it can be set with the environment variable `GEN_EMU`. ### Build Environment Variables This `bc` supports `CC`, `HOSTCC`, `HOST_CC`, `CFLAGS`, `HOSTCFLAGS`, `HOST_CFLAGS`, `CPPFLAGS`, `LDFLAGS`, `LDLIBS`, `PREFIX`, `DESTDIR`, `BINDIR`, `DATAROOTDIR`, `DATADIR`, `MANDIR`, `MAN1DIR`, `MAN3DIR`, `EXECSUFFIX`, `EXECPREFIX`, `LONG_BIT`, `GEN_HOST`, and `GEN_EMU` environment variables in `configure.sh`. Any values of those variables given to `configure.sh` will be put into the generated Makefile. More detail on what those environment variables do can be found in the following sections. #### `CC` C compiler for the target system. `CC` must be compatible with POSIX `c99` behavior and options. However, **I encourage users to use any C99 or C11 compatible compiler they wish.** If there is a space in the basename of the compiler, the items after the first space are assumed to be compiler flags, and in that case, the flags are automatically moved into CFLAGS. Defaults to `c99`. #### `HOSTCC` or `HOST_CC` C compiler for the host system, used only in [cross compiling][6]. Must be compatible with POSIX `c99` behavior and options. If there is a space in the basename of the compiler, the items after the first space are assumed to be compiler flags, and in that case, the flags are automatically moved into HOSTCFLAGS. Defaults to `$CC`. #### `CFLAGS` Command-line flags that will be passed verbatim to `CC`. Defaults to empty. #### `HOSTCFLAGS` or `HOST_CFLAGS` Command-line flags that will be passed verbatim to `HOSTCC` or `HOST_CC`. Defaults to `$CFLAGS`. #### `CPPFLAGS` Command-line flags for the C preprocessor. These are also passed verbatim to both compilers (`CC` and `HOSTCC`); they are supported just for legacy reasons. Defaults to empty. #### `LDFLAGS` Command-line flags for the linker. These are also passed verbatim to both compilers (`CC` and `HOSTCC`); they are supported just for legacy reasons. Defaults to empty. #### `LDLIBS` Libraries to link to. These are also passed verbatim to both compilers (`CC` and `HOSTCC`); they are supported just for legacy reasons and for cross compiling with different C standard libraries (like [musl][3]). Defaults to empty. #### `PREFIX` The prefix to install to. Can be overridden by passing the `--prefix` option to `configure.sh`. Defaults to `/usr/local`. ***WARNING***: Locales ignore the prefix because they *must* be installed at a fixed location to work at all. If you do not want that to happen, you must disable locales (NLS) completely. #### `DESTDIR` Path to prepend onto `PREFIX`. This is mostly for distro and package maintainers. This can be passed either to `configure.sh` or `make install`. If it is passed to both, the one given to `configure.sh` takes precedence. Defaults to empty. #### `BINDIR` The directory to install binaries in. Can be overridden by passing the `--bindir` option to `configure.sh`. Defaults to `$PREFIX/bin`. #### `INCLUDEDIR` The directory to install header files in. Can be overridden by passing the `--includedir` option to `configure.sh`. Defaults to `$PREFIX/include`. #### `LIBDIR` The directory to install libraries in. Can be overridden by passing the `--libdir` option to `configure.sh`. Defaults to `$PREFIX/lib`. #### `DATAROOTDIR` The root directory to install data files in. Can be overridden by passing the `--datarootdir` option to `configure.sh`. Defaults to `$PREFIX/share`. #### `DATADIR` The directory to install data files in. Can be overridden by passing the `--datadir` option to `configure.sh`. Defaults to `$DATAROOTDIR`. #### `MANDIR` The directory to install manpages in. Can be overridden by passing the `--mandir` option to `configure.sh`. Defaults to `$DATADIR/man` #### `MAN1DIR` The directory to install Section 1 manpages in. Because both `bc` and `dc` are Section 1 commands, this is the only relevant section directory. Can be overridden by passing the `--man1dir` option to `configure.sh`. Defaults to `$MANDIR/man1`. #### `MAN3DIR` The directory to install Section 3 manpages in. Can be overridden by passing the `--man3dir` option to `configure.sh`. Defaults to `$MANDIR/man3`. #### `EXECSUFFIX` The suffix to append onto the executable names *when installing*. This is for packagers and distro maintainers who want this `bc` as an option, but do not want to replace the default `bc`. Defaults to empty. #### `EXECPREFIX` The prefix to append onto the executable names *when building and installing*. This is for packagers and distro maintainers who want this `bc` as an option, but do not want to replace the default `bc`. Defaults to empty. #### `LONG_BIT` The number of bits in a C `long` type. This is mostly for the embedded space. This `bc` uses `long`s internally for overflow checking. In C99, a `long` is required to be 32 bits. For this reason, on 8-bit and 16-bit microcontrollers, the generated code to do math with `long` types may be inefficient. For most normal desktop systems, setting this is unnecessary, except that 32-bit platforms with 64-bit longs may want to set it to `32`. Defaults to the default value of `LONG_BIT` for the target platform. For compliance with the `bc` spec, the minimum allowed value is `32`. It is an error if the specified value is greater than the default value of `LONG_BIT` for the target platform. #### `GEN_HOST` Whether to use `gen/strgen.c`, instead of `gen/strgen.sh`, to produce the C files that contain the help texts as well as the math libraries. By default, `gen/strgen.c` is used, compiled by `$HOSTCC` and run on the host machine. Using `gen/strgen.sh` removes the need to compile and run an executable on the host machine since `gen/strgen.sh` is a POSIX shell script. However, `gen/lib2.bc` is perilously close to 4095 characters, the max supported length of a string literal in C99 (and it could be added to in the future), and `gen/strgen.sh` generates a string literal instead of an array, as `gen/strgen.c` does. For most production-ready compilers, this limit probably is not enforced, but it could be. Both options are still available for this reason. If you are sure your compiler does not have the limit and do not want to compile and run a binary on the host machine, set this variable to "0". Any other value, or a non-existent value, will cause the build system to compile and run `gen/strgen.c`. Default is "". #### `GEN_EMU` The emulator to run bootstrap binaries under. This is only if the binaries produced by `HOSTCC` (or `HOST_CC`) need to be run under an emulator to work. Defaults to empty. ### Build Options This `bc` comes with several build options, all of which are enabled by default. All options can be used with each other, with a few exceptions that will be noted below. **NOTE**: All long options with mandatory argumenst accept either one of the following forms: ``` --option arg --option=arg ``` #### Predefined Builds To quickly get a release build of a `bc` and `dc` that is (by default) compatible with the BSD `bc` and `dc`, use the `-p` or `--predefined-build-type` options: ``` ./configure.sh -pBSD ./configure.sh --predefined-build-type=BSD ``` Both commands are equivalent. To quickly get a release build of a `bc` and `dc` that is (by default) compatible with the GNU `bc` and `dc`, use the `-p` or `--predefined-build-type` options: ``` ./configure.sh -pGNU ./configure.sh --predefined-build-type=GNU ``` Both commands are equivalent. #### Library To build the math library, use the following commands for the configure step: ``` ./configure.sh -a ./configure.sh --library ``` Both commands are equivalent. When the library is built, history and locales are disabled, and the functionality for `bc` and `dc` are both enabled, though the executables are *not* built. This is because the library's options clash with the executables. To build an optimized version of the library, users can pass optimization options to `configure.sh` or include them in `CFLAGS`. The library API can be found in `manuals/bcl.3.md` or `man bcl` once the library is installed. The library is built as `bin/libbcl.a`. #### `bc` Only To build `bc` only (no `dc`), use any one of the following commands for the configure step: ``` ./configure.sh -b ./configure.sh --bc-only ./configure.sh -D ./configure.sh --disable-dc ``` Those commands are all equivalent. ***Warning***: It is an error to use those options if `bc` has also been disabled (see below). #### `dc` Only To build `dc` only (no `bc`), use either one of the following commands for the configure step: ``` ./configure.sh -d ./configure.sh --dc-only ./configure.sh -B ./configure.sh --disable-bc ``` Those commands are all equivalent. ***Warning***: It is an error to use those options if `dc` has also been disabled (see above). #### History To disable hisory, pass either the `-H` flag or the `--disable-history` option to `configure.sh`, as follows: ``` ./configure.sh -H ./configure.sh --disable-history ``` Both commands are equivalent. ***WARNING***: Of all of the code in the `bc`, this is the only code that is not completely portable. If the `bc` does not work on your platform, your first step should be to retry with history disabled. This option affects the [build type][7]. ##### Editline History support can be provided by editline, in order to implement `vi`-like keybindings and other features. To enable editline support, pass either the `-e` flag or the `--enable-editline` option to `configure.sh`, as follows: ``` ./configure.sh -e ./configure.sh --enable-editline ``` Both commands are equivalent. This is ignored if history is disabled. This option is only used if it is after any other `-e`/`--enable-editline` options, any `-r`/`--enable-readline` options, and any `-i`/`--enable-internal-history` options. ##### Readline History support can be provided by readline, in order to implement `vi`-like keybindings and other features. To enable readline support, pass either the `-r` flag or the `--enable-readline` option to `configure.sh`, as follows: ``` ./configure.sh -r ./configure.sh --enable-readline ``` Both commands are equivalent. This is ignored if history is disabled. This option is only used if it is after any other `-r`/`--enable-readline` options, any `-e`/`--enable-editline` options, and any `-i`/`--enable-internal-history` options. ##### Internal History History support is also available as an internal implementation with no dependencies. This is the default if editline and readline are not selected. However, if `-p` option is used, then this option can be useful for selecting the internal history regardless of what the predefined build has. To enable the internal history, pass either the `-i` flag or the `--enable-internal-history` option to `configure.sh` as follows: ``` ./configure.sh -i ./configure.sh --enable-internal-history ``` This option is only used if it is after any other `-i`/`--enable-internal-history` options, any `-e`/`--enable-editline` options, and any `-r`/`--enable-readline` options. #### NLS (Locale Support) To disable locale support (use only English), pass either the `-N` flag or the `--disable-nls` option to `configure.sh`, as follows: ``` ./configure.sh -N ./configure.sh --disable-nls ``` Both commands are equivalent. NLS (locale support) is automatically disabled when building for Windows or on another platform that does not support the POSIX locale API or utilities. This option affects the [build type][7]. ***WARNING***: Locales ignore the prefix because they *must* be installed at a fixed location to work at all. If you do not want that to happen, you must disable locales (NLS) completely. #### Extra Math This `bc` has 7 extra operators: * `$` (truncation to integer) * `@` (set precision) * `@=` (set precision and assign) * `<<` (shift number left, shifts radix right) * `<<=` (shift number left and assign) * `>>` (shift number right, shifts radix left) * `>>=` (shift number right and assign) There is no assignment version of `$` because it is a unary operator. The assignment versions of the above operators are not available in `dc`, but the others are, as the operators `$`, `@`, `H`, and `h`, respectively. In addition, this `bc` has the option of outputting in scientific notation or engineering notation. It can also take input in scientific or engineering notation. On top of that, it has a pseudo-random number generator. (See the full manual for more details.) Extra operators, scientific notation, engineering notation, and the pseudo-random number generator can be disabled by passing either the `-E` flag or the `--disable-extra-math` option to `configure.sh`, as follows: ``` ./configure.sh -E ./configure.sh --disable-extra-math ``` Both commands are equivalent. This `bc` also has a larger library that is only enabled if extra operators and the pseudo-random number generator are. More information about the functions can be found in the Extended Library section of the full manual. This option affects the [build type][7]. #### Karatsuba Length The Karatsuba length is the point at which `bc` and `dc` switch from Karatsuba multiplication to brute force, `O(n^2)` multiplication. It can be set by passing the `-k` flag or the `--karatsuba-len` option to `configure.sh` as follows: ``` ./configure.sh -k32 ./configure.sh --karatsuba-len 32 ``` Both commands are equivalent. Default is `32`. ***WARNING***: The Karatsuba Length must be a **integer** greater than or equal to `16` (to prevent stack overflow). If it is not, `configure.sh` will give an error. #### Settings This `bc` and `dc` have a few settings to override default behavior. The defaults for these settings can be set by package maintainers, and the settings themselves can be overriden by users. To set a default to **on**, use the `-s` or `--set-default-on` option to `configure.sh`, with the name of the setting, as follows: ``` ./configure.sh -s bc.banner ./configure.sh --set-default-on=bc.banner ``` Both commands are equivalent. To set a default to **off**, use the `-S` or `--set-default-off` option to `configure.sh`, with the name of the setting, as follows: ``` ./configure.sh -S bc.banner ./configure.sh --set-default-off=bc.banner ``` Both commands are equivalent. Users can override the default settings set by packagers with environment variables. If the environment variable has an integer, then the setting is turned **on** for a non-zero integer, and **off** for zero. The table of the available settings, along with their defaults and the environment variables to override them, is below: ``` | Setting | Description | Default | Env Variable | | =============== | ==================== | ============ | ==================== | | bc.banner | Whether to display | 0 | BC_BANNER | | | the bc version | | | | | banner when in | | | | | interactive mode. | | | | --------------- | -------------------- | ------------ | -------------------- | | bc.sigint_reset | Whether SIGINT will | 1 | BC_SIGINT_RESET | | | reset bc, instead of | | | | | exiting, when in | | | | | interactive mode. | | | | --------------- | -------------------- | ------------ | -------------------- | | dc.sigint_reset | Whether SIGINT will | 1 | DC_SIGINT_RESET | | | reset dc, instead of | | | | | exiting, when in | | | | | interactive mode. | | | | --------------- | -------------------- | ------------ | -------------------- | | bc.tty_mode | Whether TTY mode for | 1 | BC_TTY_MODE | | | bc should be on when | | | | | available. | | | | --------------- | -------------------- | ------------ | -------------------- | | dc.tty_mode | Whether TTY mode for | 0 | BC_TTY_MODE | | | dc should be on when | | | | | available. | | | | --------------- | -------------------- | ------------ | -------------------- | | bc.prompt | Whether the prompt | $BC_TTY_MODE | BC_PROMPT | | | for bc should be on | | | | | in tty mode. | | | | --------------- | -------------------- | ------------ | -------------------- | | dc.prompt | Whether the prompt | $DC_TTY_MODE | DC_PROMPT | | | for dc should be on | | | | | in tty mode. | | | | --------------- | -------------------- | ------------ | -------------------- | | bc.expr_exit | Whether to exit bc | 1 | BC_EXPR_EXIT | | | if an expression or | | | | | expression file is | | | | | given with the -e or | | | | | -f options. | | | | --------------- | -------------------- | ------------ | -------------------- | | dc.expr_exit | Whether to exit dc | 1 | DC_EXPR_EXIT | | | if an expression or | | | | | expression file is | | | | | given with the -e or | | | | | -f options. | | | | --------------- | -------------------- | ------------ | -------------------- | | bc.digit_clamp | Whether to have bc | 0 | BC_DIGIT_CLAMP | | | clamp digits that | | | | | are greater than or | | | | | equal to the current | | | | | ibase when parsing | | | | | numbers. | | | | --------------- | -------------------- | ------------ | -------------------- | | dc.digit_clamp | Whether to have dc | 0 | DC_DIGIT_CLAMP | | | clamp digits that | | | | | are greater than or | | | | | equal to the current | | | | | ibase when parsing | | | | | numbers. | | | | --------------- | -------------------- | ------------ | -------------------- | ``` These settings are not meant to be changed on a whim. They are meant to ensure that this bc and dc will conform to the expectations of the user on each platform. #### Install Options The relevant `autotools`-style install options are supported in `configure.sh`: * `--prefix` * `--bindir` * `--datarootdir` * `--datadir` * `--mandir` * `--man1dir` * `--man3dir` An example is: ``` ./configure.sh --prefix=/usr make make install ``` They correspond to the environment variables `$PREFIX`, `$BINDIR`, `$DATAROOTDIR`, `$DATADIR`, `$MANDIR`, `$MAN1DIR`, `$MAN3DIR`, and respectively. ***WARNING***: Locales ignore the prefix because they *must* be installed at a fixed location to work at all. If you do not want that to happen, you must disable locales (NLS) completely. ***WARNING***: If the option is given, the value of the corresponding environment variable is overridden. ***WARNING***: If any long command-line options are used, the long form of all other command-line options must be used. Mixing long and short options is not supported. ##### Manpages To disable installing manpages, pass either the `-M` flag or the `--disable-man-pages` option to `configure.sh` as follows: ``` ./configure.sh -M ./configure.sh --disable-man-pages ``` Both commands are equivalent. ##### Locales By default, `bc` and `dc` do not install all locales, but only the enabled locales. If `DESTDIR` exists and is not empty, then they will install all of the locales that exist on the system. The `-l` flag or `--install-all-locales` option skips all of that and just installs all of the locales that `bc` and `dc` have, regardless. To enable that behavior, you can pass the `-l` flag or the `--install-all-locales` option to `configure.sh`, as follows: ``` ./configure.sh -l ./configure.sh --install-all-locales ``` Both commands are equivalent. ***WARNING***: Locales ignore the prefix because they *must* be installed at a fixed location to work at all. If you do not want that to happen, you must disable locales (NLS) completely. ### Optimization The `configure.sh` script will accept an optimization level to pass to the compiler. Because `bc` is orders of magnitude faster with optimization, I ***highly*** recommend package and distro maintainers pass the highest optimization level available in `CC` to `configure.sh` with the `-O` flag or `--opt` option, as follows: ``` ./configure.sh -O3 ./configure.sh --opt 3 ``` Both commands are equivalent. The build and install can then be run as normal: ``` make make install ``` As usual, `configure.sh` will also accept additional `CFLAGS` on the command line, so for SSE4 architectures, the following can add a bit more speed: ``` CFLAGS="-march=native -msse4" ./configure.sh -O3 make make install ``` Building with link-time optimization (`-flto` in clang) can further increase the performance. I ***highly*** recommend doing so. I do ***NOT*** recommend building with `-march=native`; doing so reduces this `bc`'s performance. Manual stripping is not necessary; non-debug builds are automatically stripped in the link stage. ### Debug Builds Debug builds (which also disable optimization if no optimization level is given and if no extra `CFLAGS` are given) can be enabled with either the `-g` flag or the `--debug` option, as follows: ``` ./configure.sh -g ./configure.sh --debug ``` Both commands are equivalent. The build and install can then be run as normal: ``` make make install ``` ### Stripping Binaries By default, when `bc` and `dc` are not built in debug mode, the binaries are stripped. Stripping can be disabled with either the `-T` or the `--disable-strip` option, as follows: ``` ./configure.sh -T ./configure.sh --disable-strip ``` Both commands are equivalent. The build and install can then be run as normal: ``` make make install ``` ### Build Type `bc` and `dc` have 8 build types, affected by the [History][8], [NLS (Locale Support)][9], and [Extra Math][10] build options. The build types are as follows: * `A`: Nothing disabled. * `E`: Extra math disabled. * `H`: History disabled. * `N`: NLS disabled. * `EH`: Extra math and History disabled. * `EN`: Extra math and NLS disabled. * `HN`: History and NLS disabled. * `EHN`: Extra math, History, and NLS all disabled. These build types correspond to the generated manuals in `manuals/bc` and `manuals/dc`. ### Binary Size When built with both calculators, all available features, and `-Os` using `clang` and `musl`, the executable is 140.4 kb (140,386 bytes) on `x86_64`. That isn't much for what is contained in the binary, but if necessary, it can be reduced. The single largest user of space is the `bc` calculator. If just `dc` is needed, the size can be reduced to 107.6 kb (107,584 bytes). The next largest user of space is history support. If that is not needed, size can be reduced (for a build with both calculators) to 119.9 kb (119,866 bytes). There are several reasons that history is a bigger user of space than `dc` itself: * `dc`'s lexer and parser are *tiny* compared to `bc`'s because `dc` code is almost already in the form that it is executed in, while `bc` has to not only adjust the form to be executable, it has to parse functions, loops, `if` statements, and other extra features. * `dc` does not have much extra code in the interpreter. * History has a lot of const data for supporting `UTF-8` terminals. * History pulls in a bunch of more code from the `libc`. The next biggest user is extra math support. Without it, the size is reduced to 124.0 kb (123,986 bytes) with history and 107.6 kb (107,560 bytes) without history. The reasons why extra math support is bigger than `dc`, besides the fact that `dc` is small already, are: * Extra math supports adds an extra math library that takes several kilobytes of constant data space. * Extra math support includes support for a pseudo-random number generator, including the code to convert a series of pseudo-random numbers into a number of arbitrary size. * Extra math support adds several operators. The next biggest user is `dc`, so if just `bc` is needed, the size can be reduced to 128.1 kb (128,096 bytes) with history and extra math support, 107.6 kb (107,576 bytes) without history and with extra math support, and 95.3 kb (95,272 bytes) without history and without extra math support. *Note*: all of these binary sizes were compiled using `musl` `1.2.0` as the `libc`, making a fully static executable, with `clang` `9.0.1` (well, `musl-clang` using `clang` `9.0.1`) as the compiler and using `-Os` optimizations. These builds were done on an `x86_64` machine running Gentoo Linux. ### Testing The default test suite can be run with the following command: ``` make test ``` To test `bc` only, run the following command: ``` make test_bc ``` To test `dc` only, run the following command: ``` make test_dc ``` This `bc`, if built, assumes a working, GNU-compatible `bc`, installed on the system and in the `PATH`, to generate some tests, unless the `-G` flag or `--disable-generated-tests` option is given to `configure.sh`, as follows: ``` ./configure.sh -G ./configure.sh --disable-generated-tests ``` After running `configure.sh`, build and run tests as follows: ``` make make test ``` This `dc` also assumes a working, GNU-compatible `dc`, installed on the system and in the `PATH`, to generate some tests, unless one of the above options is given to `configure.sh`. To generate test coverage, pass the `-c` flag or the `--coverage` option to `configure.sh` as follows: ``` ./configure.sh -c ./configure.sh --coverage ``` Both commands are equivalent. ***WARNING***: Both `bc` and `dc` must be built for test coverage. Otherwise, `configure.sh` will give an error. #### Problematic Tests Some tests are problematic, in that they can cause `SIGKILL` on FreeBSD or `SIGSEGV` on Linux from being killed by the "OOM Killer" part of the kernel. On Linux, these tests are usually fine, but on FreeBSD, they are usually a problem. To disable problematic tests, pass the `-P` flag or the `--disable-problematic-tests` option to `configure.sh` as follows: ``` ./configure.sh -P ./configure.sh --disable-problematic-tests ``` Both commands are equivalent. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ [3]: https://www.musl-libc.org/ [4]: #build-environment-variables [5]: #build-options [6]: #cross-compiling [7]: #build-type [8]: #history [9]: #nls-locale-support [10]: #extra-math [11]: #settings diff --git a/contrib/bc/manuals/dc/A.1 b/contrib/bc/manuals/dc/A.1 index 6500bf9129e2..13ed8c4cf808 100644 --- a/contrib/bc/manuals/dc/A.1 +++ b/contrib/bc/manuals/dc/A.1 @@ -1,1725 +1,1725 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .PP \f[B]seed\f[R] is a register containing the current seed for the pseudo-random number generator. If the current value of \f[B]seed\f[R] is queried and stored, then if it is assigned to \f[B]seed\f[R] later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of \f[B]seed\f[R] was first queried. .PP Multiple values assigned to \f[B]seed\f[R] can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to \f[B]seed\f[R], it is not guaranteed that querying \f[B]seed\f[R] immediately after will return the same value. In addition, the value of \f[B]seed\f[R] will change after any call to the \f[B]\[cq]\f[R] command or the \f[B]\[lq]\f[R] command that does not get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. The maximum integer returned by the \f[B]\[cq]\f[R] command can be queried with the \f[B]W\f[R] command. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with the \f[B]\[cq]\f[R] and \f[B]\[lq]\f[R] commands are guaranteed to \f[B]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .PP The pseudo-random number generator, \f[B]seed\f[R], and all associated operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to \f[B]0.0042890\f[R]. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if dc(1) is given the number string \f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using \f[B]1o\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Pseudo-Random Number Generator .PP dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the \f[B]seed\f[R] value that controls the pseudo-random number generator.) .PP The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP \f[B]\[cq]\f[R] Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[lq]\f[R] Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of \f[B]seed\f[R], unless the operand is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]0\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and the \f[B]NUMBERS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]j\f[R] Pops the value off of the top of the stack and uses it to set \f[B]seed\f[R]. The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if the \f[B]J\f[R] command is used. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will not produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]J\f[R] Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the \f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]DC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP dc(1) supports interactive command-line editing. .PP If dc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]DC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/A.1.md b/contrib/bc/manuals/dc/A.1.md index 4c40e38dcee8..b656650cb820 100644 --- a/contrib/bc/manuals/dc/A.1.md +++ b/contrib/bc/manuals/dc/A.1.md @@ -1,1524 +1,1524 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. **seed** is a register containing the current seed for the pseudo-random number generator. If the current value of **seed** is queried and stored, then if it is assigned to **seed** later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of **seed** was first queried. Multiple values assigned to **seed** can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to **seed**, it is not guaranteed that querying **seed** immediately after will return the same value. In addition, the value of **seed** will change after any call to the **'** command or the **"** command that does not get receive a value of **0** or **1**. The maximum integer returned by the **'** command can be queried with the **W** command. **Note**: The values returned by the pseudo-random number generator with the **'** and **"** commands are guaranteed to **NOT** be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. The pseudo-random number generator, **seed**, and all associated operations are **non-portable extensions**. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, dc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and dc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if dc(1) is given the number string **10e_4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning **0** to **obase** using **0o**, and engineering notation is activated by assigning **1** to **obase** using **1o**. To deactivate them, just assign a different value to **obase**. Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **\$** : The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. This is a **non-portable extension**. **\@** : The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **H** : The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **h** : The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Pseudo-Random Number Generator dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the **seed** value that controls the pseudo-random number generator.) The pseudo-random number generator is guaranteed to **NOT** be cryptographically secure. **'** : Generates an integer between 0 and **DC_RAND_MAX**, inclusive (see the **LIMITS** section). The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. **"** : Pops a value off of the stack, which is used as an **exclusive** upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the **RESET** section) while **seed** remains unchanged. If the bound is larger than **DC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **DC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of **seed**, unless the operand is **0** or **1**. In that case, **0** is pushed onto the stack, and **seed** is *not* changed. The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, **scale**, and **seed**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **0** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section and the **NUMBERS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **j** : Pops the value off of the top of the stack and uses it to set **seed**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if the **J** command is used. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will not produce unique sequences of pseudo-random numbers. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. This is a **non-portable extension**. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **J** : Pushes the current value of **seed** onto the main stack. This is a **non-portable extension**. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. **W** : Pushes the maximum (inclusive) integer that can be generated with the **'** pseudo-random number generator command. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. **DC_RAND_MAX** : The maximum integer (inclusive) returned by the **'** command, if dc(1). Set at **2\^DC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**H**), and right shift (**h**) operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **DC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when dc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause dc(1) to clean up and exit. # COMMAND LINE HISTORY dc(1) supports interactive command-line editing. If dc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **DC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). **Note**: tabs are converted to 8 spaces. # LOCALES This dc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/E.1 b/contrib/bc/manuals/dc/E.1 index 7f2477f10772..3fb69dfe70da 100644 --- a/contrib/bc/manuals/dc/E.1 +++ b/contrib/bc/manuals/dc/E.1 @@ -1,1503 +1,1503 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]2\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]DC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP dc(1) supports interactive command-line editing. .PP If dc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]DC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/E.1.md b/contrib/bc/manuals/dc/E.1.md index 437fc645937a..0bbe97612889 100644 --- a/contrib/bc/manuals/dc/E.1.md +++ b/contrib/bc/manuals/dc/E.1.md @@ -1,1348 +1,1348 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, and **scale**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **2** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **DC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when dc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause dc(1) to clean up and exit. # COMMAND LINE HISTORY dc(1) supports interactive command-line editing. If dc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **DC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). **Note**: tabs are converted to 8 spaces. # LOCALES This dc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/EH.1 b/contrib/bc/manuals/dc/EH.1 index ba4e67507028..da7776edd538 100644 --- a/contrib/bc/manuals/dc/EH.1 +++ b/contrib/bc/manuals/dc/EH.1 @@ -1,1477 +1,1477 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]2\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/EH.1.md b/contrib/bc/manuals/dc/EH.1.md index 6d1dd78985b2..0751d3f78d21 100644 --- a/contrib/bc/manuals/dc/EH.1.md +++ b/contrib/bc/manuals/dc/EH.1.md @@ -1,1325 +1,1325 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, and **scale**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **2** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. # LOCALES This dc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/EHN.1 b/contrib/bc/manuals/dc/EHN.1 index 5f454d01cc2e..10ef283ea056 100644 --- a/contrib/bc/manuals/dc/EHN.1 +++ b/contrib/bc/manuals/dc/EHN.1 @@ -1,1473 +1,1473 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]2\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/EHN.1.md b/contrib/bc/manuals/dc/EHN.1.md index e3786886a035..9ba7fe13e0ad 100644 --- a/contrib/bc/manuals/dc/EHN.1.md +++ b/contrib/bc/manuals/dc/EHN.1.md @@ -1,1320 +1,1320 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, and **scale**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **2** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/EN.1 b/contrib/bc/manuals/dc/EN.1 index 6f08fc8d3c0c..abdcbe8c63f8 100644 --- a/contrib/bc/manuals/dc/EN.1 +++ b/contrib/bc/manuals/dc/EN.1 @@ -1,1499 +1,1499 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], and \f[B]scale\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]2\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]) operator. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]DC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP dc(1) supports interactive command-line editing. .PP If dc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]DC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/EN.1.md b/contrib/bc/manuals/dc/EN.1.md index b97e121e2226..5c0590c53aee 100644 --- a/contrib/bc/manuals/dc/EN.1.md +++ b/contrib/bc/manuals/dc/EN.1.md @@ -1,1343 +1,1343 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **2**. Values are output in the specified base. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, and **scale**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **2** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**) operator. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **DC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when dc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause dc(1) to clean up and exit. # COMMAND LINE HISTORY dc(1) supports interactive command-line editing. If dc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **DC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). **Note**: tabs are converted to 8 spaces. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/H.1 b/contrib/bc/manuals/dc/H.1 index cc2f156205e6..c96100e51bc5 100644 --- a/contrib/bc/manuals/dc/H.1 +++ b/contrib/bc/manuals/dc/H.1 @@ -1,1699 +1,1699 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .PP \f[B]seed\f[R] is a register containing the current seed for the pseudo-random number generator. If the current value of \f[B]seed\f[R] is queried and stored, then if it is assigned to \f[B]seed\f[R] later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of \f[B]seed\f[R] was first queried. .PP Multiple values assigned to \f[B]seed\f[R] can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to \f[B]seed\f[R], it is not guaranteed that querying \f[B]seed\f[R] immediately after will return the same value. In addition, the value of \f[B]seed\f[R] will change after any call to the \f[B]\[cq]\f[R] command or the \f[B]\[lq]\f[R] command that does not get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. The maximum integer returned by the \f[B]\[cq]\f[R] command can be queried with the \f[B]W\f[R] command. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with the \f[B]\[cq]\f[R] and \f[B]\[lq]\f[R] commands are guaranteed to \f[B]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .PP The pseudo-random number generator, \f[B]seed\f[R], and all associated operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to \f[B]0.0042890\f[R]. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if dc(1) is given the number string \f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using \f[B]1o\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Pseudo-Random Number Generator .PP dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the \f[B]seed\f[R] value that controls the pseudo-random number generator.) .PP The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP \f[B]\[cq]\f[R] Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[lq]\f[R] Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of \f[B]seed\f[R], unless the operand is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]0\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and the \f[B]NUMBERS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]j\f[R] Pops the value off of the top of the stack and uses it to set \f[B]seed\f[R]. The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if the \f[B]J\f[R] command is used. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will not produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]J\f[R] Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the \f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/H.1.md b/contrib/bc/manuals/dc/H.1.md index b8ad29b28a85..0dddf66d700a 100644 --- a/contrib/bc/manuals/dc/H.1.md +++ b/contrib/bc/manuals/dc/H.1.md @@ -1,1501 +1,1501 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. **seed** is a register containing the current seed for the pseudo-random number generator. If the current value of **seed** is queried and stored, then if it is assigned to **seed** later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of **seed** was first queried. Multiple values assigned to **seed** can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to **seed**, it is not guaranteed that querying **seed** immediately after will return the same value. In addition, the value of **seed** will change after any call to the **'** command or the **"** command that does not get receive a value of **0** or **1**. The maximum integer returned by the **'** command can be queried with the **W** command. **Note**: The values returned by the pseudo-random number generator with the **'** and **"** commands are guaranteed to **NOT** be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. The pseudo-random number generator, **seed**, and all associated operations are **non-portable extensions**. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, dc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and dc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if dc(1) is given the number string **10e_4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning **0** to **obase** using **0o**, and engineering notation is activated by assigning **1** to **obase** using **1o**. To deactivate them, just assign a different value to **obase**. Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **\$** : The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. This is a **non-portable extension**. **\@** : The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **H** : The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **h** : The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Pseudo-Random Number Generator dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the **seed** value that controls the pseudo-random number generator.) The pseudo-random number generator is guaranteed to **NOT** be cryptographically secure. **'** : Generates an integer between 0 and **DC_RAND_MAX**, inclusive (see the **LIMITS** section). The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. **"** : Pops a value off of the stack, which is used as an **exclusive** upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the **RESET** section) while **seed** remains unchanged. If the bound is larger than **DC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **DC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of **seed**, unless the operand is **0** or **1**. In that case, **0** is pushed onto the stack, and **seed** is *not* changed. The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, **scale**, and **seed**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **0** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section and the **NUMBERS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **j** : Pops the value off of the top of the stack and uses it to set **seed**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if the **J** command is used. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will not produce unique sequences of pseudo-random numbers. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. This is a **non-portable extension**. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **J** : Pushes the current value of **seed** onto the main stack. This is a **non-portable extension**. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. **W** : Pushes the maximum (inclusive) integer that can be generated with the **'** pseudo-random number generator command. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. **DC_RAND_MAX** : The maximum integer (inclusive) returned by the **'** command, if dc(1). Set at **2\^DC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**H**), and right shift (**h**) operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. # LOCALES This dc(1) ships with support for adding error messages for different locales and thus, supports **LC_MESSAGES**. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/HN.1 b/contrib/bc/manuals/dc/HN.1 index 8d16b10a23de..a6644ecd575b 100644 --- a/contrib/bc/manuals/dc/HN.1 +++ b/contrib/bc/manuals/dc/HN.1 @@ -1,1695 +1,1695 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .PP \f[B]seed\f[R] is a register containing the current seed for the pseudo-random number generator. If the current value of \f[B]seed\f[R] is queried and stored, then if it is assigned to \f[B]seed\f[R] later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of \f[B]seed\f[R] was first queried. .PP Multiple values assigned to \f[B]seed\f[R] can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to \f[B]seed\f[R], it is not guaranteed that querying \f[B]seed\f[R] immediately after will return the same value. In addition, the value of \f[B]seed\f[R] will change after any call to the \f[B]\[cq]\f[R] command or the \f[B]\[lq]\f[R] command that does not get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. The maximum integer returned by the \f[B]\[cq]\f[R] command can be queried with the \f[B]W\f[R] command. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with the \f[B]\[cq]\f[R] and \f[B]\[lq]\f[R] commands are guaranteed to \f[B]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .PP The pseudo-random number generator, \f[B]seed\f[R], and all associated operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to \f[B]0.0042890\f[R]. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if dc(1) is given the number string \f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using \f[B]1o\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Pseudo-Random Number Generator .PP dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the \f[B]seed\f[R] value that controls the pseudo-random number generator.) .PP The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP \f[B]\[cq]\f[R] Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[lq]\f[R] Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of \f[B]seed\f[R], unless the operand is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]0\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and the \f[B]NUMBERS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]j\f[R] Pops the value off of the top of the stack and uses it to set \f[B]seed\f[R]. The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if the \f[B]J\f[R] command is used. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will not produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]J\f[R] Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the \f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/HN.1.md b/contrib/bc/manuals/dc/HN.1.md index d658409b8362..d39a7497d3ac 100644 --- a/contrib/bc/manuals/dc/HN.1.md +++ b/contrib/bc/manuals/dc/HN.1.md @@ -1,1496 +1,1496 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. **seed** is a register containing the current seed for the pseudo-random number generator. If the current value of **seed** is queried and stored, then if it is assigned to **seed** later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of **seed** was first queried. Multiple values assigned to **seed** can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to **seed**, it is not guaranteed that querying **seed** immediately after will return the same value. In addition, the value of **seed** will change after any call to the **'** command or the **"** command that does not get receive a value of **0** or **1**. The maximum integer returned by the **'** command can be queried with the **W** command. **Note**: The values returned by the pseudo-random number generator with the **'** and **"** commands are guaranteed to **NOT** be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. The pseudo-random number generator, **seed**, and all associated operations are **non-portable extensions**. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, dc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and dc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if dc(1) is given the number string **10e_4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning **0** to **obase** using **0o**, and engineering notation is activated by assigning **1** to **obase** using **1o**. To deactivate them, just assign a different value to **obase**. Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **\$** : The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. This is a **non-portable extension**. **\@** : The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **H** : The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **h** : The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Pseudo-Random Number Generator dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the **seed** value that controls the pseudo-random number generator.) The pseudo-random number generator is guaranteed to **NOT** be cryptographically secure. **'** : Generates an integer between 0 and **DC_RAND_MAX**, inclusive (see the **LIMITS** section). The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. **"** : Pops a value off of the stack, which is used as an **exclusive** upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the **RESET** section) while **seed** remains unchanged. If the bound is larger than **DC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **DC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of **seed**, unless the operand is **0** or **1**. In that case, **0** is pushed onto the stack, and **seed** is *not* changed. The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, **scale**, and **seed**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **0** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section and the **NUMBERS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **j** : Pops the value off of the top of the stack and uses it to set **seed**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if the **J** command is used. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will not produce unique sequences of pseudo-random numbers. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. This is a **non-portable extension**. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **J** : Pushes the current value of **seed** onto the main stack. This is a **non-portable extension**. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. **W** : Pushes the maximum (inclusive) integer that can be generated with the **'** pseudo-random number generator command. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. **DC_RAND_MAX** : The maximum integer (inclusive) returned by the **'** command, if dc(1). Set at **2\^DC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**H**), and right shift (**h**) operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/manuals/dc/N.1 b/contrib/bc/manuals/dc/N.1 index 54fbadeed09c..f9aeb1acfb6c 100644 --- a/contrib/bc/manuals/dc/N.1 +++ b/contrib/bc/manuals/dc/N.1 @@ -1,1721 +1,1721 @@ .\" .\" 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. .\" .TH "DC" "1" "October 2022" "Gavin D. Howard" "General Commands Manual" .nh .ad l .SH Name .PP dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP \f[B]dc\f[R] [\f[B]-cChiPRvVx\f[R]] [\f[B]--version\f[R]] [\f[B]--help\f[R]] [\f[B]--digit-clamp\f[R]] [\f[B]--no-digit-clamp\f[R]] [\f[B]--interactive\f[R]] [\f[B]--no-prompt\f[R]] [\f[B]--no-read-prompt\f[R]] [\f[B]--extended-register\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] [\f[B]--expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] \f[I]file\f[R]\&...] [\f[B]--file\f[R]=\f[I]file\f[R]\&...] [\f[I]file\f[R]\&...] [\f[B]-I\f[R] \f[I]ibase\f[R]] [\f[B]--ibase\f[R]=\f[I]ibase\f[R]] [\f[B]-O\f[R] \f[I]obase\f[R]] [\f[B]--obase\f[R]=\f[I]obase\f[R]] [\f[B]-S\f[R] \f[I]scale\f[R]] [\f[B]--scale\f[R]=\f[I]scale\f[R]] [\f[B]-E\f[R] \f[I]seed\f[R]] [\f[B]--seed\f[R]=\f[I]seed\f[R]] .SH DESCRIPTION .PP dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP If no files are given on the command-line, then dc(1) reads from \f[B]stdin\f[R] (see the \f[B]STDIN\f[R] section). Otherwise, those files are processed, and dc(1) will then exit. .PP If a user wants to set up a standard environment, they can use \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). For example, if a user wants the \f[B]scale\f[R] always set to \f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP \f[B]-C\f[R], \f[B]--no-digit-clamp\f[R] Disables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that the value added to a number from a digit is always that digit\[cq]s value multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-c\f[R] or \f[B]--digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-c\f[R], \f[B]--digit-clamp\f[R] Enables clamping of digits greater than or equal to the current \f[B]ibase\f[R] when parsing numbers. .RS .PP This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit\[cq]s position, which starts from 0 at the least significant digit. .PP If this and/or the \f[B]-C\f[R] or \f[B]--no-digit-clamp\f[R] options are given multiple times, the last one given is used. .PP This option overrides the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-E\f[R] \f[I]seed\f[R], \f[B]--seed\f[R]=\f[I]seed\f[R] Sets the builtin variable \f[B]seed\f[R] to the value \f[I]seed\f[R] assuming that \f[I]seed\f[R] is in base 10. It is a fatal error if \f[I]seed\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-e\f[R] \f[I]expr\f[R], \f[B]--expression\f[R]=\f[I]expr\f[R] Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R], whether on the command-line or in \f[B]DC_ENV_ARGS\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-f\f[R] \f[I]file\f[R], \f[B]--file\f[R]=\f[I]file\f[R] Reads in \f[I]file\f[R] and evaluates it, line by line, as though it were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP If this option is given on the command-line (i.e., not in \f[B]DC_ENV_ARGS\f[R], see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then after processing all expressions and files, dc(1) will exit, unless \f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to \f[B]-f\f[R] or \f[B]--file\f[R]. However, if any other \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R] arguments are given after \f[B]-f-\f[R] or equivalent is given, dc(1) will give a fatal error and exit. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-h\f[R], \f[B]--help\f[R] Prints a usage message and exits. .TP \f[B]-I\f[R] \f[I]ibase\f[R], \f[B]--ibase\f[R]=\f[I]ibase\f[R] Sets the builtin variable \f[B]ibase\f[R] to the value \f[I]ibase\f[R] assuming that \f[I]ibase\f[R] is in base 10. It is a fatal error if \f[I]ibase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-i\f[R], \f[B]--interactive\f[R] Forces interactive mode. (See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-L\f[R], \f[B]--no-line-length\f[R] Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets \f[B]BC_LINE_LENGTH\f[R] to \f[B]0\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-O\f[R] \f[I]obase\f[R], \f[B]--obase\f[R]=\f[I]obase\f[R] Sets the builtin variable \f[B]obase\f[R] to the value \f[I]obase\f[R] assuming that \f[I]obase\f[R] is in base 10. It is a fatal error if \f[I]obase\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-P\f[R], \f[B]--no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]DC_ENV_ARGS\f[R]. .RS .PP These options override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-R\f[R], \f[B]--no-read-prompt\f[R] Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the \f[B]TTY MODE\f[R] section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in \f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. .RS .PP This option does not disable the regular prompt because the read prompt is only used when the \f[B]?\f[R] command is used. .PP These options \f[I]do\f[R] override the \f[B]DC_PROMPT\f[R] and \f[B]DC_TTY_MODE\f[R] environment variables (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), but only for the read prompt. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-S\f[R] \f[I]scale\f[R], \f[B]--scale\f[R]=\f[I]scale\f[R] Sets the builtin variable \f[B]scale\f[R] to the value \f[I]scale\f[R] assuming that \f[I]scale\f[R] is in base 10. It is a fatal error if \f[I]scale\f[R] is not a valid number. .RS .PP If multiple instances of this option are given, the last is used. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-v\f[R], \f[B]-V\f[R], \f[B]--version\f[R] Print the version information (copyright header) and exits. .TP \f[B]-x\f[R] \f[B]--extended-register\f[R] Enables extended register mode. See the \f[I]Extended Register Mode\f[R] subsection of the \f[B]REGISTERS\f[R] section for more information. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]-z\f[R], \f[B]--leading-zeroes\f[R] Makes dc(1) print all numbers greater than \f[B]-1\f[R] and less than \f[B]1\f[R], and not equal to \f[B]0\f[R], with a leading zero. .RS .PP This can be set for individual numbers with the \f[B]plz(x)\f[R], plznl(x)**, \f[B]pnlz(x)\f[R], and \f[B]pnlznl(x)\f[R] functions in the extended math library (see the \f[B]LIBRARY\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .PP All long options are \f[B]non-portable extensions\f[R]. .SH STDIN .PP If no files are given on the command-line and no files or expressions are given by the \f[B]-f\f[R], \f[B]--file\f[R], \f[B]-e\f[R], or \f[B]--expression\f[R] options, then dc(1) reads from \f[B]stdin\f[R]. .PP However, there is a caveat to this. .PP First, \f[B]stdin\f[R] is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. .SH STDOUT .PP Any non-error output is written to \f[B]stdout\f[R]. In addition, if history (see the \f[B]HISTORY\f[R] section) and the prompt (see the \f[B]TTY MODE\f[R] section) are enabled, both are output to \f[B]stdout\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in \f[B]dc >&-\f[R], it will quit with an error. This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP Any error output is written to \f[B]stderr\f[R]. .PP \f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in \f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when \f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the \f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP \f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. It is the \[lq]input\[rq] base, or the number base used for interpreting input numbers. \f[B]ibase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) programs with the \f[B]T\f[R] command. .PP \f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. It is the \[lq]output\[rq] base, or the number base used for outputting numbers. \f[B]obase\f[R] is initially \f[B]10\f[R]. The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and can be queried with the \f[B]U\f[R] command. The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP Outputting in scientific and engineering notations are \f[B]non-portable extensions\f[R]. .PP The \f[I]scale\f[R] of an expression is the number of digits in the result of the expression right of the decimal point, and \f[B]scale\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). \f[B]scale\f[R] is initially \f[B]0\f[R]. \f[B]scale\f[R] cannot be negative. The max allowable value for \f[B]scale\f[R] can be queried in dc(1) programs with the \f[B]V\f[R] command. .PP \f[B]seed\f[R] is a register containing the current seed for the pseudo-random number generator. If the current value of \f[B]seed\f[R] is queried and stored, then if it is assigned to \f[B]seed\f[R] later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of \f[B]seed\f[R] was first queried. .PP Multiple values assigned to \f[B]seed\f[R] can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to \f[B]seed\f[R], it is not guaranteed that querying \f[B]seed\f[R] immediately after will return the same value. In addition, the value of \f[B]seed\f[R] will change after any call to the \f[B]\[cq]\f[R] command or the \f[B]\[lq]\f[R] command that does not get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. The maximum integer returned by the \f[B]\[cq]\f[R] command can be queried with the \f[B]W\f[R] command. .PP \f[B]Note\f[R]: The values returned by the pseudo-random number generator with the \f[B]\[cq]\f[R] and \f[B]\[lq]\f[R] commands are guaranteed to \f[B]NOT\f[R] be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they \f[I]are\f[R] guaranteed to be reproducible with identical \f[B]seed\f[R] values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is \f[I]ESSENTIAL\f[R]. In any other case, use a non-seeded pseudo-random number generator. .PP The pseudo-random number generator, \f[B]seed\f[R], and all associated operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP Comments go from \f[B]#\f[R] until, and not including, the next newline. This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to \f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. Uppercase letters are equal to \f[B]9\f[R] plus their position in the alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). .PP If a digit or letter makes no sense with the current value of \f[B]ibase\f[R] (i.e., they are greater than or equal to the current value of \f[B]ibase\f[R]), then the behavior depends on the existence of the \f[B]-c\f[R]/\f[B]--digit-clamp\f[R] or \f[B]-C\f[R]/\f[B]--no-digit-clamp\f[R] options (see the \f[B]OPTIONS\f[R] section), the existence and setting of the \f[B]DC_DIGIT_CLAMP\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or the default, which can be queried with the \f[B]-h\f[R]/\f[B]--help\f[R] option. .PP If clamping is off, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are not changed. Instead, their given value is multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*A+3\[ha]0*B\f[R], which is \f[B]3\f[R] times \f[B]10\f[R] plus \f[B]11\f[R], or \f[B]41\f[R]. .PP If clamping is on, then digits or letters that are greater than or equal to the current value of \f[B]ibase\f[R] are set to the value of the highest valid digit in \f[B]ibase\f[R] before being multiplied by the appropriate power of \f[B]ibase\f[R] and added into the number. This means that, with an \f[B]ibase\f[R] of \f[B]3\f[R], the number \f[B]AB\f[R] is equal to \f[B]3\[ha]1*2+3\[ha]0*2\f[R], which is \f[B]3\f[R] times \f[B]2\f[R] plus \f[B]2\f[R], or \f[B]8\f[R]. .PP There is one exception to clamping: single-character numbers (i.e., \f[B]A\f[R] alone). Such numbers are never clamped and always take the value they would have in the highest possible \f[B]ibase\f[R]. This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and \f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current \f[B]ibase\f[R] (with the \f[B]i\f[R] command) regardless of the current value of \f[B]ibase\f[R]. .PP If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for \f[B]A\f[R], use \f[B]0A\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. These have the form \f[B]e\f[R]. The exponent (the portion after the \f[B]e\f[R]) must be an integer. An example is \f[B]1.89237e9\f[R], which is equal to \f[B]1892370000\f[R]. Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to \f[B]0.0042890\f[R]. .PP \f[B]WARNING\f[R]: Both the number and the exponent in scientific notation are interpreted according to the current \f[B]ibase\f[R], but the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless of the current \f[B]ibase\f[R]. For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the number string \f[B]FFeA\f[R], the resulting decimal number will be \f[B]2550000000000\f[R], and if dc(1) is given the number string \f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. .PP Accepting input as scientific notation is a \f[B]non-portable extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. .SS Printing .PP These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning \f[B]0\f[R] to \f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using \f[B]1o\f[R]. To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a \f[B]non-portable extension\f[R]. .TP \f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS .PP This does not alter the stack. .RE .TP \f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. .TP \f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the result is printed as though \f[B]obase\f[R] is \f[B]256\f[R] and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS .PP Users should use this command when they get lost. .RE .SS Arithmetic .PP These are the commands used for arithmetic. .TP \f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. .TP \f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and \f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the \f[I]scale\f[R] of the result is equal to \f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. .TP \f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current \f[B]scale\f[R], and 2) Using the result of step 1 to calculate \f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] \f[B]max(scale+scale(b),scale(a))\f[R]. .PP The first value popped off of the stack must be non-zero. .RE .TP \f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and \f[B]y\f[R] are only evaluated once. .RS .PP The first value popped off of the stack must be non-zero. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. .RE .TP \f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The value popped off of the stack must be non-negative. .RE .TP \f[B]_\f[R] If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and non-negative. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]N\f[R] The top value is popped off of the stack, and if it a \f[B]0\f[R], a \f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B](\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is less than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B])\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a \f[B]1\f[R] is pushed if the first is greater than or equal to the second, or \f[B]0\f[R] otherwise. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]M\f[R] The top two values are popped off of the stack. If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]m\f[R] The top two values are popped off of the stack. If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] a short-circuit operator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Pseudo-Random Number Generator .PP dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the \f[B]seed\f[R] value that controls the pseudo-random number generator.) .PP The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP \f[B]\[cq]\f[R] Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]\[lq]\f[R] Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of \f[B]seed\f[R], unless the operand is \f[B]0\f[R] or \f[B]1\f[R]. In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP \f[B]c\f[R] Removes all items from (\[lq]clears\[rq]) the stack. .TP \f[B]d\f[R] Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes the copy onto the stack. .TP \f[B]r\f[R] Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP \f[B]R\f[R] Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP \f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register \f[I]r\f[R]. .TP \f[B]l\f[R]\f[I]r\f[R] Copies the value in register \f[I]r\f[R] and pushes it onto the stack. This does not alter the contents of \f[I]r\f[R]. .TP \f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. .TP \f[B]L\f[R]\f[I]r\f[R] Pops the value off the top of the stack for register \f[I]r\f[R] and push it onto the main stack. The previous value in the stack for register \f[I]r\f[R], if any, is now accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and \f[B]seed\f[R]. Also see the \f[B]SYNTAX\f[R] section. .TP \f[B]i\f[R] Pops the value off of the top of the stack and uses it to set \f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]o\f[R] Pops the value off of the top of the stack and uses it to set \f[B]obase\f[R], which must be between \f[B]0\f[R] and \f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and the \f[B]NUMBERS\f[R] section). .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]k\f[R] Pops the value off of the top of the stack and uses it to set \f[B]scale\f[R], which must be non-negative. .RS .PP If the value on top of the stack has any \f[I]scale\f[R], the \f[I]scale\f[R] is ignored. .RE .TP \f[B]j\f[R] Pops the value off of the top of the stack and uses it to set \f[B]seed\f[R]. The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP The \f[I]scale\f[R] and sign of the value may be significant. .PP If a previously used \f[B]seed\f[R] value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP The exact value assigned to \f[B]seed\f[R] is not guaranteed to be returned if the \f[B]J\f[R] command is used. However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both values, when assigned to \f[B]seed\f[R], are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to \f[B]seed\f[R] will not produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]I\f[R] Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP \f[B]O\f[R] Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP \f[B]K\f[R] Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP \f[B]J\f[R] Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]T\f[R] Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]U\f[R] Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]V\f[R] Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the \f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the \f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. For example, if the string \f[B][1pR]\f[R] is executed as a macro, then the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP \f[B][\f[R]\f[I]characters\f[R]\f[B]]\f[R] Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. .RE .TP \f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. The result mod \f[B]256\f[R] is calculated. If that result is \f[B]0\f[R], push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP If it is a number, it is pushed back onto the stack. .PP If it is a string, it is executed as a macro. .PP This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP \f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP For example, \f[B]0 1>a\f[R] will execute the contents of register \f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .RE .TP \f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an error and reset (see the \f[B]RESET\f[R] section). .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]?\f[R] Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. .TP \f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. .TP \f[B]Q\f[R] Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. .TP \f[B],\f[R] Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the \f[B]Q\f[R] command, so the sequence \f[B],Q\f[R] will make dc(1) exit. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Status .PP These commands query status of the stack or its top value. .TP \f[B]Z\f[R] Pops a value off of the stack. .RS .PP If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push \f[B]1\f[R] if the argument is \f[B]0\f[R] with no decimal places. .PP If it is a string, pushes the number of characters the string has. .RE .TP \f[B]X\f[R] Pops a value off of the stack. .RS .PP If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP If it is a string, pushes \f[B]0\f[R]. .RE .TP \f[B]u\f[R] Pops one value off of the stack. If the value is a number, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a string), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]t\f[R] Pops one value off of the stack. If the value is a string, this pushes \f[B]1\f[R] onto the stack. Otherwise (if it is a number), it pushes \f[B]0\f[R]. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .TP \f[B]z\f[R] Pushes the current depth of the stack (before execution of this command) onto the stack. .TP \f[B]y\f[R]\f[I]r\f[R] Pushes the current stack depth of the register \f[I]r\f[R] onto the main stack. .RS .PP Because each register has a depth of \f[B]1\f[R] (with the value \f[B]0\f[R] in the top item) when dc(1) starts, dc(1) requires that each register\[cq]s stack must always have at least one item; dc(1) will give an error and reset otherwise (see the \f[B]RESET\f[R] section). This means that this command will never push \f[B]0\f[R]. .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Arrays .PP These commands manipulate arrays. .TP \f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. The second value will be stored in the array \f[I]r\f[R] (see the \f[B]REGISTERS\f[R] section), indexed by the first value. .TP \f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the array \f[I]r\f[R]. The selected value is then pushed onto the stack. .TP \f[B]Y\f[R]\f[I]r\f[R] Pushes the length of the array \f[I]r\f[R] onto the stack. .RS .PP This is a \f[B]non-portable extension\f[R]. .RE .SS Global Settings .PP These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter \f[B]g\f[R]. Only the characters below are allowed after the character \f[B]g\f[R]; any other character produces a parse error (see the \f[B]ERRORS\f[R] section). .TP \f[B]gl\f[R] Pushes the line length set by \f[B]DC_LINE_LENGTH\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) onto the stack. .TP \f[B]gz\f[R] Pushes \f[B]0\f[R] onto the stack if the leading zero setting has not been enabled with the \f[B]-z\f[R] or \f[B]--leading-zeroes\f[R] options (see the \f[B]OPTIONS\f[R] section), non-zero otherwise. .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) .PP Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. .PP In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (\f[B]`\[rs]n'\f[R]) and a left bracket (\f[B]`['\f[R]); it is a parse error for a newline or a left bracket to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP If extended register mode is enabled (\f[B]-x\f[R] or \f[B]--extended-register\f[R] command-line arguments are given), then normal single character registers are used \f[I]unless\f[R] the character immediately following a command that needs a register name is a space (according to \f[B]isspace()\f[R]) and not a newline (\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex \f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. .SH RESET .PP When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. .PP Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP Most dc(1) implementations use \f[B]char\f[R] types to calculate the value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the \f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has \f[B]9\f[R] decimal digits. If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called \f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP \f[B]DC_LONG_BIT\f[R] The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the \f[B]PERFORMANCE\f[R] section). .TP \f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the \f[B]PERFORMANCE\f[R] section). Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see \f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. Depends on \f[B]DC_BASE_DIGS\f[R]. .TP \f[B]DC_OVERFLOW_MAX\f[R] The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. Depends on \f[B]DC_LONG_BIT\f[R]. .TP \f[B]DC_BASE_MAX\f[R] The maximum output base. Set at \f[B]DC_BASE_POW\f[R]. .TP \f[B]DC_DIM_MAX\f[R] The maximum size of arrays. Set at \f[B]SIZE_MAX-1\f[R]. .TP \f[B]DC_SCALE_MAX\f[R] The maximum \f[B]scale\f[R]. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_STRING_MAX\f[R] The maximum length of strings. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP \f[B]DC_RAND_MAX\f[R] The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP Exponent The maximum allowable exponent (positive or negative). Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP Number of vars The maximum number of vars/arrays. Set at \f[B]SIZE_MAX-1\f[R]. .PP These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP As \f[B]non-portable extensions\f[R], dc(1) recognizes the following environment variables: .TP \f[B]DC_ENV_ARGS\f[R] This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in \f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given on the command-line. This gives the user the ability to set up \[lq]standard\[rq] options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the \f[B]-e\f[R] option to set \f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some \[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. .PP The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or \f[B]\[lq]\f[R]. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in \f[B]\[lq]some `dc' file.dc\[rq]\f[R], and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in \f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. .RE .TP \f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] (\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, including the backslash newline combo. The default line length is \f[B]70\f[R]. .RS .PP The special value of \f[B]0\f[R] will disable line length checking and print numbers without regard to line length and without backslashes and newlines. .RE .TP \f[B]DC_SIGINT_RESET\f[R] If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), then this environment variable has no effect because dc(1) exits on \f[B]SIGINT\f[R] when not in interactive mode. .RS .PP However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on \f[B]SIGINT\f[R], rather than exit, and zero makes dc(1) exit. If this environment variable exists and is \f[I]not\f[R] an integer, then dc(1) will exit on \f[B]SIGINT\f[R]. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_TTY_MODE\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_PROMPT\f[R] If TTY mode is \f[I]not\f[R] available (see the \f[B]TTY MODE\f[R] section), then this environment variable has no effect. .RS .PP However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and \f[B]DC_TTY_MODE\f[R] does, then the value of the \f[B]DC_TTY_MODE\f[R] environment variable is used. .PP This environment variable and the \f[B]DC_TTY_MODE\f[R] environment variable override the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_EXPR_EXIT\f[R] If any expressions or expression files are given on the command-line with \f[B]-e\f[R], \f[B]--expression\f[R], \f[B]-f\f[R], or \f[B]--file\f[R], then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. .RS .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .TP \f[B]DC_DIGIT_CLAMP\f[R] When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current \f[B]ibase\f[R] so that all such digits are considered equal to the \f[B]ibase\f[R] minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the \f[B]ibase\f[R]. .RS .PP This never applies to single-digit numbers, as per the bc(1) standard (see the \f[B]STANDARDS\f[R] section). .PP This environment variable overrides the default, which can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP \f[B]0\f[R] No error. .TP \f[B]1\f[R] A math error occurred. This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift (\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP \f[B]2\f[R] A parse error occurred. .RS .PP Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP \f[B]3\f[R] A runtime error occurred. .RS .PP Runtime errors include assigning an invalid number to any global (\f[B]ibase\f[R], \f[B]obase\f[R], or \f[B]scale\f[R]), giving a bad expression to a \f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a \f[B]read()\f[R] call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. .RE .TP \f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. .RE .PP The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the \f[B]-i\f[R] flag or \f[B]--interactive\f[R] option. .SH INTERACTIVE MODE .PP Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both \f[B]stdin\f[R] and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag and \f[B]--interactive\f[R] option can turn it on in other situations. .PP In interactive mode, dc(1) attempts to recover from errors (see the \f[B]RESET\f[R] section), and in normal execution, flushes \f[B]stdout\f[R] as soon as execution is done for the current input. dc(1) may also reset on \f[B]SIGINT\f[R] instead of exit, depending on the contents of, or default for, the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .SH TTY MODE .PP If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY, then \[lq]TTY mode\[rq] is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. .PP If there is the environment variable \f[B]DC_TTY_MODE\f[R] in the environment (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. If the \f[B]DC_TTY_MODE\f[R] environment variable exists but is \f[I]not\f[R] a non-zero integer, then dc(1) will not turn TTY mode on. .PP If the environment variable \f[B]DC_TTY_MODE\f[R] does \f[I]not\f[R] exist, the default setting is used. The default setting can be queried with the \f[B]-h\f[R] or \f[B]--help\f[R] options. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the \f[B]STANDARDS\f[R] section), and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] to be connected to a terminal. .SS Command-Line History .PP Command-line history is only enabled if TTY mode is, i.e., that \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]DC_TTY_MODE\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section) and its default do not disable TTY mode. See the \f[B]COMMAND LINE HISTORY\f[R] section for more information. .SS Prompt .PP If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: \f[B]DC_PROMPT\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP If the environment variable \f[B]DC_PROMPT\f[R] exists and is a non-zero integer, then the prompt is turned on when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are connected to a TTY and the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options were not used. The read prompt will be turned on under the same conditions, except that the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options must also not be used. .PP However, if \f[B]DC_PROMPT\f[R] does not exist, the prompt can be enabled or disabled with the \f[B]DC_TTY_MODE\f[R] environment variable, the \f[B]-P\f[R] and \f[B]--no-prompt\f[R] options, and the \f[B]-R\f[R] and \f[B]--no-read-prompt\f[R] options. See the \f[B]ENVIRONMENT VARIABLES\f[R] and \f[B]OPTIONS\f[R] sections for more details. .SH SIGNAL HANDLING .PP Sending a \f[B]SIGINT\f[R] will cause dc(1) to do one of two things. .PP If dc(1) is not in interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), or the \f[B]DC_SIGINT_RESET\f[R] environment variable (see the \f[B]ENVIRONMENT VARIABLES\f[R] section), or its default, is either not an integer or it is zero, dc(1) will exit. .PP However, if dc(1) is in interactive mode, and the \f[B]DC_SIGINT_RESET\f[R] or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the \f[B]RESET\f[R] section) upon receiving a \f[B]SIGINT\f[R]. .PP Note that \[lq]current input\[rq] can mean one of two things. If dc(1) is processing input from \f[B]stdin\f[R] in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from \f[B]stdin\f[R] if no other file exists. .PP This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP \f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is \f[B]SIGHUP\f[R]; in that case, and only when dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP dc(1) supports interactive command-line editing. .PP If dc(1) can be in TTY mode (see the \f[B]TTY MODE\f[R] section), history can be enabled. This means that command-line history can only be enabled when \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all connected to a TTY. .PP Like TTY mode itself, it can be turned on or off with the environment variable \f[B]DC_TTY_MODE\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .PP \f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (\[lq]POSIX.1-2017\[rq]) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . .SH BUGS .PP None are known. -Report bugs at https://git.yzena.com/gavin/bc . +Report bugs at https://git.gavinhoward.com/gavin/bc . .SH AUTHOR .PP Gavin D. -Howard and contributors. +Howard and contributors. diff --git a/contrib/bc/manuals/dc/N.1.md b/contrib/bc/manuals/dc/N.1.md index 35573c49da90..3c36661d3902 100644 --- a/contrib/bc/manuals/dc/N.1.md +++ b/contrib/bc/manuals/dc/N.1.md @@ -1,1519 +1,1519 @@ # Name dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS **dc** [**-cChiPRvVx**] [**-\-version**] [**-\-help**] [**-\-digit-clamp**] [**-\-no-digit-clamp**] [**-\-interactive**] [**-\-no-prompt**] [**-\-no-read-prompt**] [**-\-extended-register**] [**-e** *expr*] [**-\-expression**=*expr*...] [**-f** *file*...] [**-\-file**=*file*...] [*file*...] [**-I** *ibase*] [**-\-ibase**=*ibase*] [**-O** *obase*] [**-\-obase**=*obase*] [**-S** *scale*] [**-\-scale**=*scale*] [**-E** *seed*] [**-\-seed**=*seed*] # DESCRIPTION dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. If no files are given on the command-line, then dc(1) reads from **stdin** (see the **STDIN** section). Otherwise, those files are processed, and dc(1) will then exit. If a user wants to set up a standard environment, they can use **DC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). For example, if a user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to **-e 10k**, and this dc(1) will always start with a **scale** of **10**. # OPTIONS The following are the options that dc(1) accepts. **-C**, **-\-no-digit-clamp** : Disables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that the value added to a number from a digit is always that digit's value multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-c** or **-\-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-c**, **-\-digit-clamp** : Enables clamping of digits greater than or equal to the current **ibase** when parsing numbers. This means that digits that the value added to a number from a digit that is greater than or equal to the ibase is the value of ibase minus 1 all multiplied by the value of ibase raised to the power of the digit's position, which starts from 0 at the least significant digit. If this and/or the **-C** or **-\-no-digit-clamp** options are given multiple times, the last one given is used. This option overrides the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section) and the default, which can be queried with the **-h** or **-\-help** options. This is a **non-portable extension**. **-E** *seed*, **-\-seed**=*seed* : Sets the builtin variable **seed** to the value *seed* assuming that *seed* is in base 10. It is a fatal error if *seed* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-e** *expr*, **-\-expression**=*expr* : Evaluates *expr*. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. This means that if a file is given before an expression, the file is read in and evaluated first. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**, whether on the command-line or in **DC_ENV_ARGS**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-f** *file*, **-\-file**=*file* : Reads in *file* and evaluates it, line by line, as though it were read through **stdin**. If expressions are also given (see above), the expressions are evaluated in the order given. If this option is given on the command-line (i.e., not in **DC_ENV_ARGS**, see the **ENVIRONMENT VARIABLES** section), then after processing all expressions and files, dc(1) will exit, unless **-** (**stdin**) was given as an argument at least once to **-f** or **-\-file**. However, if any other **-e**, **-\-expression**, **-f**, or **-\-file** arguments are given after **-f-** or equivalent is given, dc(1) will give a fatal error and exit. This is a **non-portable extension**. **-h**, **-\-help** : Prints a usage message and exits. **-I** *ibase*, **-\-ibase**=*ibase* : Sets the builtin variable **ibase** to the value *ibase* assuming that *ibase* is in base 10. It is a fatal error if *ibase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-i**, **-\-interactive** : Forces interactive mode. (See the **INTERACTIVE MODE** section.) This is a **non-portable extension**. **-L**, **-\-no-line-length** : Disables line length checking and prints numbers without backslashes and newlines. In other words, this option sets **BC_LINE_LENGTH** to **0** (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-O** *obase*, **-\-obase**=*obase* : Sets the builtin variable **obase** to the value *obase* assuming that *obase* is in base 10. It is a fatal error if *obase* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-P**, **-\-no-prompt** : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in **DC_ENV_ARGS**. These options override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section). This is a **non-portable extension**. **-R**, **-\-no-read-prompt** : Disables the read prompt in TTY mode. (The read prompt is only enabled in TTY mode. See the **TTY MODE** section.) This is mostly for those users that do not want a read prompt or are not used to having them in dc(1). Most of those users would want to put this option in **BC_ENV_ARGS** (see the **ENVIRONMENT VARIABLES** section). This option is also useful in hash bang lines of dc(1) scripts that prompt for user input. This option does not disable the regular prompt because the read prompt is only used when the **?** command is used. These options *do* override the **DC_PROMPT** and **DC_TTY_MODE** environment variables (see the **ENVIRONMENT VARIABLES** section), but only for the read prompt. This is a **non-portable extension**. **-S** *scale*, **-\-scale**=*scale* : Sets the builtin variable **scale** to the value *scale* assuming that *scale* is in base 10. It is a fatal error if *scale* is not a valid number. If multiple instances of this option are given, the last is used. This is a **non-portable extension**. **-v**, **-V**, **-\-version** : Print the version information (copyright header) and exits. **-x** **-\-extended-register** : Enables extended register mode. See the *Extended Register Mode* subsection of the **REGISTERS** section for more information. This is a **non-portable extension**. **-z**, **-\-leading-zeroes** : Makes dc(1) print all numbers greater than **-1** and less than **1**, and not equal to **0**, with a leading zero. This can be set for individual numbers with the **plz(x)**, plznl(x)**, **pnlz(x)**, and **pnlznl(x)** functions in the extended math library (see the **LIBRARY** section). This is a **non-portable extension**. All long options are **non-portable extensions**. # STDIN If no files are given on the command-line and no files or expressions are given by the **-f**, **-\-file**, **-e**, or **-\-expression** options, then dc(1) reads from **stdin**. However, there is a caveat to this. First, **stdin** is evaluated a line at a time. The only exception to this is if a string has been finished, but not ended. This means that, except for escaped brackets, all brackets must be balanced before dc(1) parses and executes. # STDOUT Any non-error output is written to **stdout**. In addition, if history (see the **HISTORY** section) and the prompt (see the **TTY MODE** section) are enabled, both are output to **stdout**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if **stdout** is closed, as in **dc >&-**, it will quit with an error. This is done so that dc(1) can report problems when **stdout** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stdout** to **/dev/null**. # STDERR Any error output is written to **stderr**. **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if **stderr** is closed, as in **dc 2>&-**, it will quit with an error. This is done so that dc(1) can exit with an error code when **stderr** is redirected to a file. If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to redirect **stderr** to **/dev/null**. # SYNTAX Each item in the input source code, either a number (see the **NUMBERS** section) or a command (see the **COMMANDS** section), is processed and executed, in order. Input is processed immediately when entered. **ibase** is a register (see the **REGISTERS** section) that determines how to interpret constant numbers. It is the "input" base, or the number base used for interpreting input numbers. **ibase** is initially **10**. The max allowable value for **ibase** is **16**. The min allowable value for **ibase** is **2**. The max allowable value for **ibase** can be queried in dc(1) programs with the **T** command. **obase** is a register (see the **REGISTERS** section) that determines how to output results. It is the "output" base, or the number base used for outputting numbers. **obase** is initially **10**. The max allowable value for **obase** is **DC_BASE_MAX** and can be queried with the **U** command. The min allowable value for **obase** is **0**. If **obase** is **0**, values are output in scientific notation, and if **obase** is **1**, values are output in engineering notation. Otherwise, values are output in the specified base. Outputting in scientific and engineering notations are **non-portable extensions**. The *scale* of an expression is the number of digits in the result of the expression right of the decimal point, and **scale** is a register (see the **REGISTERS** section) that sets the precision of any operations (with exceptions). **scale** is initially **0**. **scale** cannot be negative. The max allowable value for **scale** can be queried in dc(1) programs with the **V** command. **seed** is a register containing the current seed for the pseudo-random number generator. If the current value of **seed** is queried and stored, then if it is assigned to **seed** later, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers that were generated after the value of **seed** was first queried. Multiple values assigned to **seed** can produce the same sequence of pseudo-random numbers. Likewise, when a value is assigned to **seed**, it is not guaranteed that querying **seed** immediately after will return the same value. In addition, the value of **seed** will change after any call to the **'** command or the **"** command that does not get receive a value of **0** or **1**. The maximum integer returned by the **'** command can be queried with the **W** command. **Note**: The values returned by the pseudo-random number generator with the **'** and **"** commands are guaranteed to **NOT** be cryptographically secure. This is a consequence of using a seeded pseudo-random number generator. However, they *are* guaranteed to be reproducible with identical **seed** values. This means that the pseudo-random values from dc(1) should only be used where a reproducible stream of pseudo-random numbers is *ESSENTIAL*. In any other case, use a non-seeded pseudo-random number generator. The pseudo-random number generator, **seed**, and all associated operations are **non-portable extensions**. ## Comments Comments go from **#** until, and not including, the next newline. This is a **non-portable extension**. # NUMBERS Numbers are strings made up of digits, uppercase letters up to **F**, and at most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits. Uppercase letters are equal to **9** plus their position in the alphabet (i.e., **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the current value of **ibase** (i.e., they are greater than or equal to the current value of **ibase**), then the behavior depends on the existence of the **-c**/**-\-digit-clamp** or **-C**/**-\-no-digit-clamp** options (see the **OPTIONS** section), the existence and setting of the **DC_DIGIT_CLAMP** environment variable (see the **ENVIRONMENT VARIABLES** section), or the default, which can be queried with the **-h**/**-\-help** option. If clamping is off, then digits or letters that are greater than or equal to the current value of **ibase** are not changed. Instead, their given value is multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*A+3\^0\*B**, which is **3** times **10** plus **11**, or **41**. If clamping is on, then digits or letters that are greater than or equal to the current value of **ibase** are set to the value of the highest valid digit in **ibase** before being multiplied by the appropriate power of **ibase** and added into the number. This means that, with an **ibase** of **3**, the number **AB** is equal to **3\^1\*2+3\^0\*2**, which is **3** times **2** plus **2**, or **8**. There is one exception to clamping: single-character numbers (i.e., **A** alone). Such numbers are never clamped and always take the value they would have in the highest possible **ibase**. This means that **A** alone always equals decimal **10** and **Z** alone always equals decimal **35**. This behavior is mandated by the standard for bc(1) (see the STANDARDS section) and is meant to provide an easy way to set the current **ibase** (with the **i** command) regardless of the current value of **ibase**. If clamping is on, and the clamped value of a character is needed, use a leading zero, i.e., for **A**, use **0A**. In addition, dc(1) accepts numbers in scientific notation. These have the form **\e\**. The exponent (the portion after the **e**) must be an integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still multiplied by **10\^exponent** regardless of the current **ibase**. For example, if **ibase** is **16** and dc(1) is given the number string **FFeA**, the resulting decimal number will be **2550000000000**, and if dc(1) is given the number string **10e_4**, the resulting decimal number will be **0.0016**. Accepting input as scientific notation is a **non-portable extension**. # COMMANDS The valid commands are listed below. ## Printing These commands are used for printing. Note that both scientific notation and engineering notation are available for printing numbers. Scientific notation is activated by assigning **0** to **obase** using **0o**, and engineering notation is activated by assigning **1** to **obase** using **1o**. To deactivate them, just assign a different value to **obase**. Printing numbers in scientific notation and/or engineering notation is a **non-portable extension**. **p** : Prints the value on top of the stack, whether number or string, and prints a newline after. This does not alter the stack. **n** : Prints the value on top of the stack, whether number or string, and pops it off of the stack. **P** : Pops a value off the stack. If the value is a number, it is truncated and the absolute value of the result is printed as though **obase** is **256** and each digit is interpreted as an 8-bit ASCII character, making it a byte stream. If the value is a string, it is printed without a trailing newline. This is a **non-portable extension**. **f** : Prints the entire contents of the stack, in order from newest to oldest, without altering anything. Users should use this command when they get lost. ## Arithmetic These are the commands used for arithmetic. **+** : The top two values are popped off the stack, added, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **-** : The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. The *scale* of the result is equal to the max *scale* of both operands. **\*** : The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. If **a** is the *scale* of the first expression and **b** is the *scale* of the second expression, the *scale* of the result is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return the obvious values. **/** : The top two values are popped off the stack, divided, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be non-zero. **%** : The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale* **max(scale+scale(b),scale(a))**. The first value popped off of the stack must be non-zero. **~** : The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. This is equivalent to **x y / x y %** except that **x** and **y** are only evaluated once. The first value popped off of the stack must be non-zero. This is a **non-portable extension**. **\^** : The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be non-zero. **v** : The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. The *scale* of the result is equal to **scale**. The value popped off of the stack must be non-negative. **\_** : If this command *immediately* precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. This behavior without a number is a **non-portable extension**. **b** : The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. This is a **non-portable extension**. **|** : The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. The first value popped is used as the reduction modulus and must be an integer and non-zero. The second value popped is used as the exponent and must be an integer and non-negative. The third value popped is the base and must be an integer. This is a **non-portable extension**. **\$** : The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. This is a **non-portable extension**. **\@** : The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **H** : The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **h** : The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. The first value popped off of the stack must be an integer and non-negative. This is a **non-portable extension**. **G** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if they are equal, or **0** otherwise. This is a **non-portable extension**. **N** : The top value is popped off of the stack, and if it a **0**, a **1** is pushed; otherwise, a **0** is pushed. This is a **non-portable extension**. **(** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than the second, or **0** otherwise. This is a **non-portable extension**. **{** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is less than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **)** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than the second, or **0** otherwise. This is a **non-portable extension**. **}** : The top two values are popped off of the stack, they are compared, and a **1** is pushed if the first is greater than or equal to the second, or **0** otherwise. This is a **non-portable extension**. **M** : The top two values are popped off of the stack. If they are both non-zero, a **1** is pushed onto the stack. If either of them is zero, or both of them are, then a **0** is pushed onto the stack. This is like the **&&** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. **m** : The top two values are popped off of the stack. If at least one of them is non-zero, a **1** is pushed onto the stack. If both of them are zero, then a **0** is pushed onto the stack. This is like the **||** operator in bc(1), and it is *not* a short-circuit operator. This is a **non-portable extension**. ## Pseudo-Random Number Generator dc(1) has a built-in pseudo-random number generator. These commands query the pseudo-random number generator. (See Parameters for more information about the **seed** value that controls the pseudo-random number generator.) The pseudo-random number generator is guaranteed to **NOT** be cryptographically secure. **'** : Generates an integer between 0 and **DC_RAND_MAX**, inclusive (see the **LIMITS** section). The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. **"** : Pops a value off of the stack, which is used as an **exclusive** upper bound on the integer that will be generated. If the bound is negative or is a non-integer, an error is raised, and dc(1) resets (see the **RESET** section) while **seed** remains unchanged. If the bound is larger than **DC_RAND_MAX**, the higher bound is honored by generating several pseudo-random integers, multiplying them by appropriate powers of **DC_RAND_MAX+1**, and adding them together. Thus, the size of integer that can be generated with this command is unbounded. Using this command will change the value of **seed**, unless the operand is **0** or **1**. In that case, **0** is pushed onto the stack, and **seed** is *not* changed. The generated integer is made as unbiased as possible, subject to the limitations of the pseudo-random number generator. This is a **non-portable extension**. ## Stack Control These commands control the stack. **c** : Removes all items from ("clears") the stack. **d** : Copies the item on top of the stack ("duplicates") and pushes the copy onto the stack. **r** : Swaps ("reverses") the two top items on the stack. **R** : Pops ("removes") the top value from the stack. ## Register Control These commands control registers (see the **REGISTERS** section). **s**_r_ : Pops the value off the top of the stack and stores it into register *r*. **l**_r_ : Copies the value in register *r* and pushes it onto the stack. This does not alter the contents of *r*. **S**_r_ : Pops the value off the top of the (main) stack and pushes it onto the stack of register *r*. The previous value of the register becomes inaccessible. **L**_r_ : Pops the value off the top of the stack for register *r* and push it onto the main stack. The previous value in the stack for register *r*, if any, is now accessible via the **l**_r_ command. ## Parameters These commands control the values of **ibase**, **obase**, **scale**, and **seed**. Also see the **SYNTAX** section. **i** : Pops the value off of the top of the stack and uses it to set **ibase**, which must be between **2** and **16**, inclusive. If the value on top of the stack has any *scale*, the *scale* is ignored. **o** : Pops the value off of the top of the stack and uses it to set **obase**, which must be between **0** and **DC_BASE_MAX**, inclusive (see the **LIMITS** section and the **NUMBERS** section). If the value on top of the stack has any *scale*, the *scale* is ignored. **k** : Pops the value off of the top of the stack and uses it to set **scale**, which must be non-negative. If the value on top of the stack has any *scale*, the *scale* is ignored. **j** : Pops the value off of the top of the stack and uses it to set **seed**. The meaning of **seed** is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. The *scale* and sign of the value may be significant. If a previously used **seed** value is used again, the pseudo-random number generator is guaranteed to produce the same sequence of pseudo-random numbers as it did when the **seed** value was previously used. The exact value assigned to **seed** is not guaranteed to be returned if the **J** command is used. However, if **seed** *does* return a different value, both values, when assigned to **seed**, are guaranteed to produce the same sequence of pseudo-random numbers. This means that certain values assigned to **seed** will not produce unique sequences of pseudo-random numbers. There is no limit to the length (number of significant decimal digits) or *scale* of the value that can be assigned to **seed**. This is a **non-portable extension**. **I** : Pushes the current value of **ibase** onto the main stack. **O** : Pushes the current value of **obase** onto the main stack. **K** : Pushes the current value of **scale** onto the main stack. **J** : Pushes the current value of **seed** onto the main stack. This is a **non-portable extension**. **T** : Pushes the maximum allowable value of **ibase** onto the main stack. This is a **non-portable extension**. **U** : Pushes the maximum allowable value of **obase** onto the main stack. This is a **non-portable extension**. **V** : Pushes the maximum allowable value of **scale** onto the main stack. This is a **non-portable extension**. **W** : Pushes the maximum (inclusive) integer that can be generated with the **'** pseudo-random number generator command. This is a **non-portable extension**. ## Strings The following commands control strings. dc(1) can work with both numbers and strings, and registers (see the **REGISTERS** section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. Strings can also be executed as macros. For example, if the string **[1pR]** is executed as a macro, then the code **1pR** is executed, meaning that the **1** will be printed with a newline after and then popped from the stack. **\[**_characters_**\]** : Makes a string containing *characters* and pushes it onto the stack. If there are brackets (**\[** and **\]**) in the string, then they must be balanced. Unbalanced brackets can be escaped using a backslash (**\\**) character. If there is a backslash character in the string, the character after it (even another backslash) is put into the string verbatim, but the (first) backslash is not. **a** : The value on top of the stack is popped. If it is a number, it is truncated and its absolute value is taken. The result mod **256** is calculated. If that result is **0**, push an empty string; otherwise, push a one-character string where the character is the result of the mod interpreted as an ASCII character. If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to create the new string as a one-character string. The new string is then pushed onto the stack. This is a **non-portable extension**. **x** : Pops a value off of the top of the stack. If it is a number, it is pushed back onto the stack. If it is a string, it is executed as a macro. This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. **\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of register *r* are executed. For example, **0 1>a** will execute the contents of register **a**, and **1 0>a** will not. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\>**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\>**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!\<**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal to), then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!\<**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **!=**_r_ : Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of register *r* are executed. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). **!=**_r_**e**_s_ : Like the above, but will execute register *s* if the comparison fails. If either or both of the values are not numbers, dc(1) will raise an error and reset (see the **RESET** section). This is a **non-portable extension**. **?** : Reads a line from the **stdin** and executes it. This is to allow macros to request input from users. **q** : During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. **Q** : Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. **,** : Pushes the depth of the execution stack onto the stack. The execution stack is the stack of string executions. The number that is pushed onto the stack is exactly as many as is needed to make dc(1) exit with the **Q** command, so the sequence **,Q** will make dc(1) exit. This is a **non-portable extension**. ## Status These commands query status of the stack or its top value. **Z** : Pops a value off of the stack. If it is a number, calculates the number of significant decimal digits it has and pushes the result. It will push **1** if the argument is **0** with no decimal places. If it is a string, pushes the number of characters the string has. **X** : Pops a value off of the stack. If it is a number, pushes the *scale* of the value onto the stack. If it is a string, pushes **0**. **u** : Pops one value off of the stack. If the value is a number, this pushes **1** onto the stack. Otherwise (if it is a string), it pushes **0**. This is a **non-portable extension**. **t** : Pops one value off of the stack. If the value is a string, this pushes **1** onto the stack. Otherwise (if it is a number), it pushes **0**. This is a **non-portable extension**. **z** : Pushes the current depth of the stack (before execution of this command) onto the stack. **y**_r_ : Pushes the current stack depth of the register *r* onto the main stack. Because each register has a depth of **1** (with the value **0** in the top item) when dc(1) starts, dc(1) requires that each register's stack must always have at least one item; dc(1) will give an error and reset otherwise (see the **RESET** section). This means that this command will never push **0**. This is a **non-portable extension**. ## Arrays These commands manipulate arrays. **:**_r_ : Pops the top two values off of the stack. The second value will be stored in the array *r* (see the **REGISTERS** section), indexed by the first value. **;**_r_ : Pops the value on top of the stack and uses it as an index into the array *r*. The selected value is then pushed onto the stack. **Y**_r_ : Pushes the length of the array *r* onto the stack. This is a **non-portable extension**. ## Global Settings These commands retrieve global settings. These are the only commands that require multiple specific characters, and all of them begin with the letter **g**. Only the characters below are allowed after the character **g**; any other character produces a parse error (see the **ERRORS** section). **gl** : Pushes the line length set by **DC_LINE_LENGTH** (see the **ENVIRONMENT VARIABLES** section) onto the stack. **gz** : Pushes **0** onto the stack if the leading zero setting has not been enabled with the **-z** or **-\-leading-zeroes** options (see the **OPTIONS** section), non-zero otherwise. # REGISTERS Registers are names that can store strings, numbers, and arrays. (Number/string registers do not interfere with array registers.) Each register is also its own stack, so the current register value is the top of the stack for the register. All registers, when first referenced, have one value (**0**) in their stack, and it is a runtime error to attempt to pop that item off of the register stack. In non-extended register mode, a register name is just the single character that follows any command that needs a register name. The only exceptions are: a newline (**'\\n'**) and a left bracket (**'['**); it is a parse error for a newline or a left bracket to be used as a register name. ## Extended Register Mode Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. If extended register mode is enabled (**-x** or **-\-extended-register** command-line arguments are given), then normal single character registers are used *unless* the character immediately following a command that needs a register name is a space (according to **isspace()**) and not a newline (**'\\n'**). In that case, the register name is found according to the regex **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if the next non-space characters do not match that regex. # RESET When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. First, any macros that are executing are stopped and popped off the stack. The behavior is not unlike that of exceptions in programming languages. Then the execution point is set so that any code waiting to execute (after all macros returned) is skipped. Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error (see the **EXIT STATUS** section), it asks for more input; otherwise, it exits with the appropriate return code. # PERFORMANCE Most dc(1) implementations use **char** types to calculate the value of **1** decimal digit at a time, but that can be slow. This dc(1) does something different. It uses large integers to calculate more than **1** decimal digit at a time. If built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is **64**, then each integer has **9** decimal digits. If built in an environment where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This value (the number of decimal digits per large integer) is called **DC_BASE_DIGS**. In addition, this dc(1) uses an even larger integer for overflow checking. This integer type depends on the value of **DC_LONG_BIT**, but is always at least twice as large as the integer type used to store digits. # LIMITS The following are the limits on dc(1): **DC_LONG_BIT** : The number of bits in the **long** type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large integer (see the **PERFORMANCE** section). **DC_BASE_DIGS** : The number of decimal digits per large integer (see the **PERFORMANCE** section). Depends on **DC_LONG_BIT**. **DC_BASE_POW** : The max decimal number that each large integer can store (see **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**. **DC_OVERFLOW_MAX** : The max number that the overflow type (see the **PERFORMANCE** section) can hold. Depends on **DC_LONG_BIT**. **DC_BASE_MAX** : The maximum output base. Set at **DC_BASE_POW**. **DC_DIM_MAX** : The maximum size of arrays. Set at **SIZE_MAX-1**. **DC_SCALE_MAX** : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**. **DC_STRING_MAX** : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**. **DC_NAME_MAX** : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**. **DC_NUM_MAX** : The maximum length of a number (in decimal digits), which includes digits after the decimal point. Set at **DC_OVERFLOW_MAX-1**. **DC_RAND_MAX** : The maximum integer (inclusive) returned by the **'** command, if dc(1). Set at **2\^DC_LONG_BIT-1**. Exponent : The maximum allowable exponent (positive or negative). Set at **DC_OVERFLOW_MAX**. Number of vars : The maximum number of vars/arrays. Set at **SIZE_MAX-1**. These limits are meant to be effectively non-existent; the limits are so large (at least on 64-bit machines) that there should not be any point at which they become a problem. In fact, memory should be exhausted before these limits should be hit. # ENVIRONMENT VARIABLES As **non-portable extensions**, dc(1) recognizes the following environment variables: **DC_ENV_ARGS** : This is another way to give command-line arguments to dc(1). They should be in the same format as all other command-line arguments. These are always processed first, so any files given in **DC_ENV_ARGS** will be processed before arguments and files given on the command-line. This gives the user the ability to set up "standard" options and files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. Another use would be to use the **-e** option to set **scale** to a value other than **0**. The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments, but it does not understand escape sequences. For example, the string **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string **"/home/gavin/some \"dc\" file.dc"** will include the backslashes. The quote parsing will handle either kind of quotes, **'** or **"**. Thus, if you have a file with any number of single quotes in the name, you can use double quotes as the outside quotes, as in **"some 'dc' file.dc"**, and vice versa if you have a file with double quotes. However, handling a file with both kinds of quotes in **DC_ENV_ARGS** is not supported due to the complexity of the parsing, though such files are still supported on the command-line where the parsing is done by the shell. **DC_LINE_LENGTH** : If this environment variable exists and contains an integer that is greater than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output lines to that length, including the backslash newline combo. The default line length is **70**. The special value of **0** will disable line length checking and print numbers without regard to line length and without backslashes and newlines. **DC_SIGINT_RESET** : If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), then this environment variable has no effect because dc(1) exits on **SIGINT** when not in interactive mode. However, when dc(1) is in interactive mode, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) reset on **SIGINT**, rather than exit, and zero makes dc(1) exit. If this environment variable exists and is *not* an integer, then dc(1) will exit on **SIGINT**. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_TTY_MODE** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, then a non-zero value makes dc(1) use TTY mode, and zero makes dc(1) not use TTY mode. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_PROMPT** : If TTY mode is *not* available (see the **TTY MODE** section), then this environment variable has no effect. However, when TTY mode is available, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) use a prompt, and zero or a non-integer makes dc(1) not use a prompt. If this environment variable does not exist and **DC_TTY_MODE** does, then the value of the **DC_TTY_MODE** environment variable is used. This environment variable and the **DC_TTY_MODE** environment variable override the default, which can be queried with the **-h** or **-\-help** options. **DC_EXPR_EXIT** : If any expressions or expression files are given on the command-line with **-e**, **-\-expression**, **-f**, or **-\-file**, then if this environment variable exists and contains an integer, a non-zero value makes dc(1) exit after executing the expressions and expression files, and a zero value makes dc(1) not exit. This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. **DC_DIGIT_CLAMP** : When parsing numbers and if this environment variable exists and contains an integer, a non-zero value makes dc(1) clamp digits that are greater than or equal to the current **ibase** so that all such digits are considered equal to the **ibase** minus 1, and a zero value disables such clamping so that those digits are always equal to their value, which is multiplied by the power of the **ibase**. This never applies to single-digit numbers, as per the bc(1) standard (see the **STANDARDS** section). This environment variable overrides the default, which can be queried with the **-h** or **-\-help** options. # EXIT STATUS dc(1) returns the following exit statuses: **0** : No error. **1** : A math error occurred. This follows standard practice of using **1** for expected errors, since math errors will happen in the process of normal execution. Math errors include divide by **0**, taking the square root of a negative number, using a negative number as a bound for the pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, overflow when calculating the size of a number, and attempting to use a non-integer where an integer is required. Converting to a hardware integer happens for the second operand of the power (**\^**), places (**\@**), left shift (**H**), and right shift (**h**) operators. **2** : A parse error occurred. Parse errors include unexpected **EOF**, using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. **3** : A runtime error occurred. Runtime errors include assigning an invalid number to any global (**ibase**, **obase**, or **scale**), giving a bad expression to a **read()** call, calling **read()** inside of a **read()** call, type errors (including attempting to execute a number), and attempting an operation when the stack has too few elements. **4** : A fatal error occurred. Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a directory as a file, and giving invalid command-line options. The exit status **4** is special; when a fatal error occurs, dc(1) always exits and returns **4**, no matter what mode dc(1) is in. The other statuses will only be returned when dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the **RESET** section) and accepts more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the **-i** flag or **-\-interactive** option. These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the **-i** flag or **-\-interactive** option. # INTERACTIVE MODE Like bc(1), dc(1) has an interactive mode and a non-interactive mode. Interactive mode is turned on automatically when both **stdin** and **stdout** are hooked to a terminal, but the **-i** flag and **-\-interactive** option can turn it on in other situations. In interactive mode, dc(1) attempts to recover from errors (see the **RESET** section), and in normal execution, flushes **stdout** as soon as execution is done for the current input. dc(1) may also reset on **SIGINT** instead of exit, depending on the contents of, or default for, the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section). # TTY MODE If **stdin**, **stdout**, and **stderr** are all connected to a TTY, then "TTY mode" is considered to be available, and thus, dc(1) can turn on TTY mode, subject to some settings. If there is the environment variable **DC_TTY_MODE** in the environment (see the **ENVIRONMENT VARIABLES** section), then if that environment variable contains a non-zero integer, dc(1) will turn on TTY mode when **stdin**, **stdout**, and **stderr** are all connected to a TTY. If the **DC_TTY_MODE** environment variable exists but is *not* a non-zero integer, then dc(1) will not turn TTY mode on. If the environment variable **DC_TTY_MODE** does *not* exist, the default setting is used. The default setting can be queried with the **-h** or **-\-help** options. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (see the **STANDARDS** section), and interactive mode requires only **stdin** and **stdout** to be connected to a terminal. ## Command-Line History Command-line history is only enabled if TTY mode is, i.e., that **stdin**, **stdout**, and **stderr** are connected to a TTY and the **DC_TTY_MODE** environment variable (see the **ENVIRONMENT VARIABLES** section) and its default do not disable TTY mode. See the **COMMAND LINE HISTORY** section for more information. ## Prompt If TTY mode is available, then a prompt can be enabled. Like TTY mode itself, it can be turned on or off with an environment variable: **DC_PROMPT** (see the **ENVIRONMENT VARIABLES** section). If the environment variable **DC_PROMPT** exists and is a non-zero integer, then the prompt is turned on when **stdin**, **stdout**, and **stderr** are connected to a TTY and the **-P** and **-\-no-prompt** options were not used. The read prompt will be turned on under the same conditions, except that the **-R** and **-\-no-read-prompt** options must also not be used. However, if **DC_PROMPT** does not exist, the prompt can be enabled or disabled with the **DC_TTY_MODE** environment variable, the **-P** and **-\-no-prompt** options, and the **-R** and **-\-no-read-prompt** options. See the **ENVIRONMENT VARIABLES** and **OPTIONS** sections for more details. # SIGNAL HANDLING Sending a **SIGINT** will cause dc(1) to do one of two things. If dc(1) is not in interactive mode (see the **INTERACTIVE MODE** section), or the **DC_SIGINT_RESET** environment variable (see the **ENVIRONMENT VARIABLES** section), or its default, is either not an integer or it is zero, dc(1) will exit. However, if dc(1) is in interactive mode, and the **DC_SIGINT_RESET** or its default is an integer and non-zero, then dc(1) will stop executing the current input and reset (see the **RESET** section) upon receiving a **SIGINT**. Note that "current input" can mean one of two things. If dc(1) is processing input from **stdin** in interactive mode, it will ask for more input. If dc(1) is processing input from a file in interactive mode, it will stop processing the file and start processing the next file, if one exists, or ask for input from **stdin** if no other file exists. This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it can seem as though dc(1) did not respond to the signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the default handler for all other signals. The one exception is **SIGHUP**; in that case, and only when dc(1) is in TTY mode (see the **TTY MODE** section), a **SIGHUP** will cause dc(1) to clean up and exit. # COMMAND LINE HISTORY dc(1) supports interactive command-line editing. If dc(1) can be in TTY mode (see the **TTY MODE** section), history can be enabled. This means that command-line history can only be enabled when **stdin**, **stdout**, and **stderr** are all connected to a TTY. Like TTY mode itself, it can be turned on or off with the environment variable **DC_TTY_MODE** (see the **ENVIRONMENT VARIABLES** section). **Note**: tabs are converted to 8 spaces. # SEE ALSO bc(1) # STANDARDS The dc(1) utility operators and some behavior are compliant with the operators in the IEEE Std 1003.1-2017 (“POSIX.1-2017”) bc(1) specification at https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html . # BUGS -None are known. Report bugs at https://git.yzena.com/gavin/bc . +None are known. Report bugs at https://git.gavinhoward.com/gavin/bc . # AUTHOR -Gavin D. Howard and contributors. +Gavin D. Howard and contributors. diff --git a/contrib/bc/scripts/functions.sh b/contrib/bc/scripts/functions.sh index 98cb5cf7aae0..8ae765859e51 100755 --- a/contrib/bc/scripts/functions.sh +++ b/contrib/bc/scripts/functions.sh @@ -1,419 +1,501 @@ #! /bin/sh # # 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. # # This script is NOT meant to be run! It is meant to be sourced by other # scripts. # Reads and follows a link until it finds a real file. This is here because the # readlink utility is not part of the POSIX standard. Sigh... # @param f The link to find the original file for. readlink() { _readlink_f="$1" shift _readlink_arrow="-> " _readlink_d=$(dirname "$_readlink_f") _readlink_lsout="" _readlink_link="" _readlink_lsout=$(ls -dl "$_readlink_f") _readlink_link=$(printf '%s' "${_readlink_lsout#*$_readlink_arrow}") while [ -z "${_readlink_lsout##*$_readlink_arrow*}" ]; do _readlink_f="$_readlink_d/$_readlink_link" _readlink_d=$(dirname "$_readlink_f") _readlink_lsout=$(ls -dl "$_readlink_f") _readlink_link=$(printf '%s' "${_readlink_lsout#*$_readlink_arrow}") done printf '%s' "${_readlink_f##*$_readlink_d/}" } # Quick function for exiting with an error. # @param 1 A message to print. # @param 2 The exit code to use. err_exit() { if [ "$#" -ne 2 ]; then printf 'Invalid number of args to err_exit\n' exit 1 fi printf '%s\n' "$1" exit "$2" } +# Function for checking the "d"/"dir" argument of scripts. This function expects +# a usage() function to exist in the caller. +# @param 1 The argument to check. +check_d_arg() { + + if [ "$#" -ne 1 ]; then + printf 'Invalid number of args to check_d_arg\n' + exit 1 + fi + + _check_d_arg_arg="$1" + shift + + if [ "$_check_d_arg_arg" != "bc" ] && [ "$_check_d_arg_arg" != "dc" ]; then + _check_d_arg_msg=$(printf 'Invalid d arg: %s\nMust be either "bc" or "dc".\n\n' \ + "$_check_d_arg_arg") + usage "$_check_d_arg_msg" + fi +} + +# Function for checking the boolean arguments of scripts. This function expects +# a usage() function to exist in the caller. +# @param 1 The argument to check. +check_bool_arg() { + + if [ "$#" -ne 1 ]; then + printf 'Invalid number of args to check_bool_arg\n' + exit 1 + fi + + _check_bool_arg_arg="$1" + shift + + if [ "$_check_bool_arg_arg" != "0" ] && [ "$_check_bool_arg_arg" != "1" ]; then + _check_bool_arg_msg=$(printf 'Invalid bool arg: %s\nMust be either "0" or "1".\n\n' \ + "$_check_bool_arg_arg") + usage "$_check_bool_arg_msg" + fi +} + +# Function for checking the executable arguments of scripts. This function +# expects a usage() function to exist in the caller. +# @param 1 The argument to check. +check_exec_arg() { + + if [ "$#" -ne 1 ]; then + printf 'Invalid number of args to check_exec_arg\n' + exit 1 + fi + + _check_exec_arg_arg="$1" + shift + + if [ ! -x "$_check_exec_arg_arg" ]; then + if ! command -v "$_check_exec_arg_arg" >/dev/null 2>&1; then + _check_exec_arg_msg=$(printf 'Invalid exec arg: %s\nMust be an executable file.\n\n' \ + "$_check_exec_arg_arg") + usage "$_check_exec_arg_msg" + fi + fi +} + +# Function for checking the file arguments of scripts. This function expects a +# usage() function to exist in the caller. +# @param 1 The argument to check. +check_file_arg() { + + if [ "$#" -ne 1 ]; then + printf 'Invalid number of args to check_file_arg\n' + exit 1 + fi + + _check_file_arg_arg="$1" + shift + + if [ ! -f "$_check_file_arg_arg" ]; then + _check_file_arg_msg=$(printf 'Invalid file arg: %s\nMust be a file.\n\n' \ + "$_check_file_arg_arg") + usage "$_check_file_arg_msg" + fi +} + # Check the return code on a test and exit with a fail if it's non-zero. # @param d The calculator under test. # @param err The return code. # @param name The name of the test. checktest_retcode() { _checktest_retcode_d="$1" shift _checktest_retcode_err="$1" shift _checktest_retcode_name="$1" shift if [ "$_checktest_retcode_err" -ne 0 ]; then printf 'FAIL!!!\n' err_exit "$_checktest_retcode_d failed test '$_checktest_retcode_name' with error code $_checktest_retcode_err" 1 fi } # Check the result of a test. First, it checks the error code using # checktest_retcode(). Then it checks the output against the expected output # and fails if it doesn't match. # @param d The calculator under test. # @param err The error code. # @param name The name of the test. # @param test_path The path to the test. # @param results_name The path to the file with the expected result. checktest() { _checktest_d="$1" shift _checktest_err="$1" shift _checktest_name="$1" shift _checktest_test_path="$1" shift _checktest_results_name="$1" shift checktest_retcode "$_checktest_d" "$_checktest_err" "$_checktest_name" _checktest_diff=$(diff "$_checktest_test_path" "$_checktest_results_name") _checktest_err="$?" if [ "$_checktest_err" -ne 0 ]; then printf 'FAIL!!!\n' printf '%s\n' "$_checktest_diff" err_exit "$_checktest_d failed test $_checktest_name" 1 fi } # Die. With a message. # @param d The calculator under test. # @param msg The message to print. # @param name The name of the test. # @param err The return code from the test. die() { _die_d="$1" shift _die_msg="$1" shift _die_name="$1" shift _die_err="$1" shift _die_str=$(printf '\n%s %s on test:\n\n %s\n' "$_die_d" "$_die_msg" "$_die_name") err_exit "$_die_str" "$_die_err" } # Check that a test did not crash and die if it did. # @param d The calculator under test. # @param error The error code. # @param name The name of the test. checkcrash() { _checkcrash_d="$1" shift _checkcrash_error="$1" shift _checkcrash_name="$1" shift if [ "$_checkcrash_error" -gt 127 ]; then die "$_checkcrash_d" "crashed ($_checkcrash_error)" \ "$_checkcrash_name" "$_checkcrash_error" fi } # Check that a test had an error or crash. # @param d The calculator under test. # @param error The error code. # @param name The name of the test. # @param out The file that the test results were output to. # @param exebase The name of the executable. checkerrtest() { _checkerrtest_d="$1" shift _checkerrtest_error="$1" shift _checkerrtest_name="$1" shift _checkerrtest_out="$1" shift _checkerrtest_exebase="$1" shift checkcrash "$_checkerrtest_d" "$_checkerrtest_error" "$_checkerrtest_name" if [ "$_checkerrtest_error" -eq 0 ]; then die "$_checkerrtest_d" "returned no error" "$_checkerrtest_name" 127 fi # This is to check for memory errors with Valgrind, which is told to return # 100 on memory errors. if [ "$_checkerrtest_error" -eq 100 ]; then _checkerrtest_output=$(cat "$_checkerrtest_out") _checkerrtest_fatal_error="Fatal error" if [ "${_checkerrtest_output##*$_checkerrtest_fatal_error*}" ]; then printf "%s\n" "$_checkerrtest_output" die "$_checkerrtest_d" "had memory errors on a non-fatal error" \ "$_checkerrtest_name" "$_checkerrtest_error" fi fi if [ ! -s "$_checkerrtest_out" ]; then die "$_checkerrtest_d" "produced no error message" "$_checkerrtest_name" "$_checkerrtest_error" fi # To display error messages, uncomment this line. This is useful when # debugging. #cat "$_checkerrtest_out" } # Replace a substring in a string with another. This function is the *real* # workhorse behind configure.sh's generation of a Makefile. # # This function uses a sed call that uses exclamation points `!` as delimiters. # As a result, needle can never contain an exclamation point. Oh well. # # @param str The string that will have any of the needle replaced by # replacement. # @param needle The needle to replace in str with replacement. # @param replacement The replacement for needle in str. substring_replace() { _substring_replace_str="$1" shift _substring_replace_needle="$1" shift _substring_replace_replacement="$1" shift _substring_replace_result=$(printf '%s\n' "$_substring_replace_str" | \ sed -e "s!$_substring_replace_needle!$_substring_replace_replacement!g") printf '%s' "$_substring_replace_result" } # Generates an NLS path based on the locale and executable name. # # This is a monstrosity for a reason. # # @param nlspath The $NLSPATH # @param locale The locale. # @param execname The name of the executable. gen_nlspath() { _gen_nlspath_nlspath="$1" shift _gen_nlspath_locale="$1" shift _gen_nlspath_execname="$1" shift # Split the locale into its modifier and other parts. _gen_nlspath_char="@" _gen_nlspath_modifier="${_gen_nlspath_locale#*$_gen_nlspath_char}" _gen_nlspath_tmplocale="${_gen_nlspath_locale%%$_gen_nlspath_char*}" # Split the locale into charset and other parts. _gen_nlspath_char="." _gen_nlspath_charset="${_gen_nlspath_tmplocale#*$_gen_nlspath_char}" _gen_nlspath_tmplocale="${_gen_nlspath_tmplocale%%$_gen_nlspath_char*}" # Check for an empty charset. if [ "$_gen_nlspath_charset" = "$_gen_nlspath_tmplocale" ]; then _gen_nlspath_charset="" fi # Split the locale into territory and language. _gen_nlspath_char="_" _gen_nlspath_territory="${_gen_nlspath_tmplocale#*$_gen_nlspath_char}" _gen_nlspath_language="${_gen_nlspath_tmplocale%%$_gen_nlspath_char*}" # Check for empty territory and language. if [ "$_gen_nlspath_territory" = "$_gen_nlspath_tmplocale" ]; then _gen_nlspath_territory="" fi if [ "$_gen_nlspath_language" = "$_gen_nlspath_tmplocale" ]; then _gen_nlspath_language="" fi # Prepare to replace the format specifiers. This is done by wrapping the in # pipe characters. It just makes it easier to split them later. _gen_nlspath_needles="%%:%L:%N:%l:%t:%c" _gen_nlspath_needles=$(printf '%s' "$_gen_nlspath_needles" | tr ':' '\n') for _gen_nlspath_i in $_gen_nlspath_needles; do _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "$_gen_nlspath_i" "|$_gen_nlspath_i|") done # Replace all the format specifiers. _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%%" "%") _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%L" "$_gen_nlspath_locale") _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%N" "$_gen_nlspath_execname") _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%l" "$_gen_nlspath_language") _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%t" "$_gen_nlspath_territory") _gen_nlspath_nlspath=$(substring_replace "$_gen_nlspath_nlspath" "%c" "$_gen_nlspath_charset") # Get rid of pipe characters. _gen_nlspath_nlspath=$(printf '%s' "$_gen_nlspath_nlspath" | tr -d '|') # Return the result. printf '%s' "$_gen_nlspath_nlspath" } ALL=0 NOSKIP=1 SKIP=2 # Filters text out of a file according to the build type. # @param in File to filter. # @param out File to write the filtered output to. # @param type Build type. filter_text() { _filter_text_in="$1" shift _filter_text_out="$1" shift _filter_text_buildtype="$1" shift # Set up some local variables. _filter_text_status="$ALL" _filter_text_last_line="" # We need to set IFS, so we store it here for restoration later. _filter_text_ifs="$IFS" # Remove the file- that will be generated. rm -rf "$_filter_text_out" # Here is the magic. This loop reads the template line-by-line, and based on # _filter_text_status, either prints it to the markdown manual or not. # # Here is how the template is set up: it is a normal markdown file except # that there are sections surrounded tags that look like this: # # {{ }} # ... # {{ end }} # # Those tags mean that whatever build types are found in the # get to keep that section. Otherwise, skip. # # Obviously, the tag itself and its end are not printed to the markdown # manual. while IFS= read -r _filter_text_line; do # If we have found an end, reset the status. if [ "$_filter_text_line" = "{{ end }}" ]; then # Some error checking. This helps when editing the templates. if [ "$_filter_text_status" -eq "$ALL" ]; then err_exit "{{ end }} tag without corresponding start tag" 2 fi _filter_text_status="$ALL" # We have found a tag that allows our build type to use it. elif [ "${_filter_text_line#\{\{* $_filter_text_buildtype *\}\}}" != "$_filter_text_line" ]; then # More error checking. We don't want tags nested. if [ "$_filter_text_status" -ne "$ALL" ]; then err_exit "start tag nested in start tag" 3 fi _filter_text_status="$NOSKIP" # We have found a tag that is *not* allowed for our build type. elif [ "${_filter_text_line#\{\{*\}\}}" != "$_filter_text_line" ]; then if [ "$_filter_text_status" -ne "$ALL" ]; then err_exit "start tag nested in start tag" 3 fi _filter_text_status="$SKIP" # This is for normal lines. If we are not skipping, print. else if [ "$_filter_text_status" -ne "$SKIP" ]; then if [ "$_filter_text_line" != "$_filter_text_last_line" ]; then printf '%s\n' "$_filter_text_line" >> "$_filter_text_out" fi _filter_text_last_line="$_filter_text_line" fi fi done < "$_filter_text_in" # Reset IFS. IFS="$_filter_text_ifs" } diff --git a/contrib/bc/scripts/locale_install.sh b/contrib/bc/scripts/locale_install.sh index a2d9ccda7ade..75534a735cdb 100755 --- a/contrib/bc/scripts/locale_install.sh +++ b/contrib/bc/scripts/locale_install.sh @@ -1,299 +1,308 @@ #! /bin/sh # # 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. # # Just print the usage and exit with an error. +# @param 1 A message to print. usage() { if [ $# -eq 1 ]; then printf '%s\n' "$1" fi printf "usage: %s [-l] NLSPATH main_exec [DESTDIR]\n" "$0" 1>&2 exit 1 } # Run gencat on one file. # @param loc The location of the resulting cat file. # @param file The file to use as the source for the cat file. gencatfile() { _gencatfile_loc="$1" shift _gencatfile_file="$1" shift mkdir -p $(dirname "$_gencatfile_loc") gencat "$_gencatfile_loc" "$_gencatfile_file" > /dev/null 2>&1 } # Return an exit code based on whether a locale exists. # @param locales The list of locales. # @param locale The locale to search for. # @param destdir The DESTDIR that locales should be installed to. localeexists() { _localeexists_locales="$1" shift _localeexists_locale="$1" shift _localeexists_destdir="$1" shift if [ "$_localeexists_destdir" != "" ]; then _localeexists_char="@" _localeexists_locale="${_localeexists_locale%%_localeexists_char*}" _localeexists_char="." _localeexists_locale="${_localeexists_locale##*$_localeexists_char}" fi test ! -z "${_localeexists_locales##*$_localeexists_locale*}" return $? } # Split a path into its components. They will be separated by newlines, so paths # cannot have newlines in them. # @param path The path to split. splitpath() { _splitpath_path="$1" shift if [ "$_splitpath_path" = "${_splitpath_path#/}" ]; then printf 'Must use absolute paths\n' exit 1 fi if [ "${_splitpath_path#\n*}" != "$_splitpath_path" ]; then exit 1 fi _splitpath_list="" _splitpath_item="" while [ "$_splitpath_path" != "/" ]; do _splitpath_item=$(basename "$_splitpath_path") _splitpath_list=$(printf '\n%s%s' "$_splitpath_item" "$_splitpath_list") _splitpath_path=$(dirname "$_splitpath_path") done if [ "$_splitpath_list" != "/" ]; then _splitpath_list="${_splitpath_list#?}" fi printf '%s' "$_splitpath_list" } # Generate a relative path from one path to another. # @param path1 The target path. # @param path2 The other path. relpath() { _relpath_path1="$1" shift _relpath_path2="$1" shift # Very carefully set IFS in a portable way. No, you cannot do IFS=$'\n'. _relpath_nl=$(printf '\nx') _relpath_nl="${_relpath_nl%x}" _relpath_splitpath1=`splitpath "$_relpath_path1"` _relpath_splitpath2=`splitpath "$_relpath_path2"` _relpath_path="" _relpath_temp1="$_relpath_splitpath1" IFS="$_relpath_nl" # What this function does is find the parts that are the same and then # calculates the difference based on how many folders up and down you must # go. # This first loop basically removes the parts that are the same between # them. for _relpath_part in $_relpath_temp1; do _relpath_temp2="${_relpath_splitpath2#$_relpath_part$_relpath_nl}" if [ "$_relpath_temp2" = "$_relpath_splitpath2" ]; then break fi _relpath_splitpath2="$_relpath_temp2" _relpath_splitpath1="${_relpath_splitpath1#$_relpath_part$_relpath_nl}" done # Go up the appropriate number of times. for _relpath_part in $_relpath_splitpath2; do _relpath_path="../$_relpath_path" done _relpath_path="${_relpath_path%../}" # Go down the appropriate number of times. for _relpath_part in $_relpath_splitpath1; do _relpath_path="$_relpath_path$_relpath_part/" done _relpath_path="${_relpath_path%/}" unset IFS printf '%s\n' "$_relpath_path" } script="$0" scriptdir=$(dirname "$script") . "$scriptdir/functions.sh" # Set a default. all_locales=0 # Process command-line args. while getopts "l" opt; do case "$opt" in l) all_locales=1 ; shift ;; ?) usage "Invalid option: $opt" ;; esac done -test "$#" -ge 2 || usage +test "$#" -ge 2 || usage "Must have at least two arguments" nlspath="$1" shift main_exec="$1" shift if [ "$#" -ge 1 ]; then destdir="$1" shift else destdir="" fi # Uninstall locales first. "$scriptdir/locale_uninstall.sh" "$nlspath" "$main_exec" "$destdir" locales_dir="$scriptdir/../locales" # What this does is if installing to a package, it installs all locales that # match supported charsets instead of installing all directly supported locales. if [ "$destdir" = "" ]; then locales=$(locale -a) else locales=$(locale -m) fi # For each relevant .msg file, run gencat. for file in $locales_dir/*.msg; do locale=$(basename "$file" ".msg") # If we are not installing all locales, there's a possibility we need to # skip this one. if [ "$all_locales" -eq 0 ]; then # Check if the locale exists and if not skip. localeexists "$locales" "$locale" "$destdir" err="$?" if [ "$err" -eq 0 ]; then continue fi fi # We skip the symlinks for now. if [ -L "$file" ]; then continue fi + printf 'Installing %s...' "$locale" + # Generate the proper location for the cat file. loc=$(gen_nlspath "$destdir/$nlspath" "$locale" "$main_exec") gencatfile "$loc" "$file" + printf 'done\n' + done # Now that we have done the non-symlinks, it's time to do the symlinks. Think # that this second loop is unnecessary and that you can combine the two? Well, # make sure that when you figure out you are wrong that you add to this comment # with your story. Fortunately for me, I learned fast. for file in $locales_dir/*.msg; do locale=$(basename "$file" ".msg") # Do the same skip as the above loop. if [ "$all_locales" -eq 0 ]; then localeexists "$locales" "$locale" "$destdir" err="$?" if [ "$err" -eq 0 ]; then continue fi fi # Generate the proper location for the cat file. loc=$(gen_nlspath "$destdir/$nlspath" "$locale" "$main_exec") # Make sure the directory exists. mkdir -p $(dirname "$loc") # Make sure to skip non-symlinks; they are already done. if [ -L "$file" ]; then + printf 'Linking %s...' "$locale" + # This song and dance is because we want to generate relative symlinks. # They take less space, but also, they are more resilient to being # moved. link=$(readlink "$file") linkdir=$(dirname "$file") locale=$(basename "$link" .msg) linksrc=$(gen_nlspath "$nlspath" "$locale" "$main_exec") relloc="${loc##$destdir/}" rel=$(relpath "$linksrc" "$relloc") # If the target file doesn't exist (because it's for a locale that is # not installed), generate it anyway. It's easier this way. if [ ! -f "$destdir/$linksrc" ]; then gencatfile "$destdir/$linksrc" "$linkdir/$link" fi # Finally, symlink to the install of the generated cat file that # corresponds to the correct msg file. ln -fs "$rel" "$loc" + + printf 'done\n' fi done diff --git a/contrib/bc/src/data.c b/contrib/bc/src/data.c index 1694bb684718..284d3de7b642 100644 --- a/contrib/bc/src/data.c +++ b/contrib/bc/src/data.c @@ -1,1347 +1,1347 @@ /* * ***************************************************************************** * * 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. * * ***************************************************************************** * * Constant data for bc. * */ #include #include #include #include #include #include #include #include #include #include #include #include #include #if !BC_ENABLE_LIBRARY #if BC_ENABLED /// The bc signal message and its length. const char bc_sig_msg[] = "\ninterrupt (type \"quit\" to exit)\n"; const uchar bc_sig_msg_len = (uchar) (sizeof(bc_sig_msg) - 1); #endif // BC_ENABLED #if DC_ENABLED /// The dc signal message and its length. const char dc_sig_msg[] = "\ninterrupt (type \"q\" to exit)\n"; const uchar dc_sig_msg_len = (uchar) (sizeof(dc_sig_msg) - 1); #endif // DC_ENABLED // clang-format off /// The copyright banner. const char bc_copyright[] = "Copyright (c) 2018-2023 Gavin D. Howard and contributors\n" - "Report bugs at: https://git.yzena.com/gavin/bc\n\n" + "Report bugs at: https://git.gavinhoward.com/gavin/bc\n\n" "This is free software with ABSOLUTELY NO WARRANTY.\n"; // clang-format on #ifdef __OpenBSD__ #if BC_ENABLE_EXTRA_MATH #if BC_ENABLE_HISTORY /// The pledges for starting bc. const char bc_pledge_start[] = "rpath stdio tty unveil"; /// The final pledges with history enabled. const char bc_pledge_end_history[] = "rpath stdio tty"; #else // BC_ENABLE_HISTORY /// The pledges for starting bc. const char bc_pledge_start[] = "rpath stdio unveil"; #endif // BC_ENABLE_HISTORY /// The final pledges with history history disabled. const char bc_pledge_end[] = "rpath stdio"; #else // BC_ENABLE_EXTRA_MATH #if BC_ENABLE_HISTORY /// The pledges for starting bc. const char bc_pledge_start[] = "rpath stdio tty"; /// The final pledges with history enabled. const char bc_pledge_end_history[] = "stdio tty"; #else // BC_ENABLE_HISTORY /// The pledges for starting bc. const char bc_pledge_start[] = "rpath stdio"; #endif // BC_ENABLE_HISTORY /// The final pledges with history history disabled. const char bc_pledge_end[] = "stdio"; #endif // BC_ENABLE_EXTRA_MATH #else // __OpenBSD__ /// The pledges for starting bc. const char bc_pledge_start[] = ""; #if BC_ENABLE_HISTORY /// The final pledges with history enabled. const char bc_pledge_end_history[] = ""; #endif // BC_ENABLE_HISTORY /// The final pledges with history history disabled. const char bc_pledge_end[] = ""; #endif // __OpenBSD__ /// The list of long options. There is a zero set at the end for detecting the /// end. const BcOptLong bc_args_lopt[] = { { "digit-clamp", BC_OPT_NONE, 'c' }, { "expression", BC_OPT_REQUIRED, 'e' }, { "file", BC_OPT_REQUIRED, 'f' }, { "help", BC_OPT_NONE, 'h' }, { "interactive", BC_OPT_NONE, 'i' }, { "ibase", BC_OPT_REQUIRED, 'I' }, { "leading-zeroes", BC_OPT_NONE, 'z' }, { "no-line-length", BC_OPT_NONE, 'L' }, { "obase", BC_OPT_REQUIRED, 'O' }, { "no-digit-clamp", BC_OPT_NONE, 'C' }, { "no-prompt", BC_OPT_NONE, 'P' }, { "no-read-prompt", BC_OPT_NONE, 'R' }, { "scale", BC_OPT_REQUIRED, 'S' }, #if BC_ENABLE_EXTRA_MATH { "seed", BC_OPT_REQUIRED, 'E' }, #endif // BC_ENABLE_EXTRA_MATH #if BC_ENABLED { "global-stacks", BC_OPT_BC_ONLY, 'g' }, { "mathlib", BC_OPT_BC_ONLY, 'l' }, { "quiet", BC_OPT_BC_ONLY, 'q' }, { "redefine", BC_OPT_REQUIRED_BC_ONLY, 'r' }, { "standard", BC_OPT_BC_ONLY, 's' }, { "warn", BC_OPT_BC_ONLY, 'w' }, #endif // BC_ENABLED { "version", BC_OPT_NONE, 'v' }, { "version", BC_OPT_NONE, 'V' }, #if DC_ENABLED { "extended-register", BC_OPT_DC_ONLY, 'x' }, #endif // DC_ENABLED { NULL, 0, 0 }, }; // clang-format off /// The default error category strings. const char *bc_errs[] = { "Math error:", "Parse error:", "Runtime error:", "Fatal error:", #if BC_ENABLED "Warning:", #endif // BC_ENABLED }; // clang-format on /// The error category for each error. const uchar bc_err_ids[] = { BC_ERR_IDX_MATH, BC_ERR_IDX_MATH, BC_ERR_IDX_MATH, BC_ERR_IDX_MATH, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_FATAL, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_EXEC, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, #if BC_ENABLED BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, BC_ERR_IDX_PARSE, #endif // BC_ENABLED }; /// The default error messages. There are NULL pointers because the positions /// must be preserved for the locales. const char* const bc_err_msgs[] = { "negative number", "non-integer number", "overflow: number cannot fit", "divide by 0", "memory allocation failed", "I/O error", "cannot open file: %s", "file is not text: %s", "path is a directory: %s", "bad command-line option: \"%s\"", "option requires an argument: '%c' (\"%s\")", "option takes no arguments: '%c' (\"%s\")", "bad option argument: \"%s\"", "bad ibase: must be [%lu, %lu]", "bad obase: must be [%lu, %lu]", "bad scale: must be [%lu, %lu]", "bad read() expression", "read() call inside of a read() call", "variable or array element is the wrong type", #if DC_ENABLED "stack has too few elements", "stack for register \"%s\" has too few elements", #else // DC_ENABLED NULL, NULL, #endif // DC_ENABLED #if BC_ENABLED "wrong number of parameters; need %zu, have %zu", "undefined function: %s()", "cannot use a void value in an expression", #else NULL, NULL, NULL, #endif // BC_ENABLED "end of file", "bad character '%c'", "string end cannot be found", "comment end cannot be found", "bad token", #if BC_ENABLED "bad expression", "empty expression", "bad print or stream statement", "bad function definition", ("bad assignment: left side must be scale, ibase, " "obase, seed, last, var, or array element"), "no auto variable found", "function parameter or auto \"%s%s\" already exists", "block end cannot be found", "cannot return a value from void function: %s()", "var cannot be a reference: %s", "POSIX does not allow names longer than 1 character: %s", "POSIX does not allow '#' script comments", "POSIX does not allow the following keyword: %s", "POSIX does not allow a period ('.') as a shortcut for the last result", "POSIX requires parentheses around return expressions", "POSIX does not allow the following operator: %s", "POSIX does not allow comparison operators outside if statements or loops", "POSIX requires 0 or 1 comparison operators per condition", "POSIX requires all 3 parts of a for loop to be non-empty", "POSIX requires a newline between a semicolon and a function definition", #if BC_ENABLE_EXTRA_MATH "POSIX does not allow exponential notation", #else NULL, #endif // BC_ENABLE_EXTRA_MATH "POSIX does not allow array references as function parameters", "POSIX does not allow void functions", "POSIX requires the left brace be on the same line as the function header", "POSIX does not allow strings to be assigned to variables or arrays", #endif // BC_ENABLED }; #endif // !BC_ENABLE_LIBRARY /// The destructors corresponding to BcDtorType enum items. const BcVecFree bc_vec_dtors[] = { NULL, bc_vec_free, bc_num_free, #if !BC_ENABLE_LIBRARY #ifndef NDEBUG bc_func_free, #endif // NDEBUG bc_slab_free, bc_const_free, bc_result_free, #if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB bc_history_string_free, #endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB #else // !BC_ENABLE_LIBRARY bcl_num_destruct, #endif // !BC_ENABLE_LIBRARY }; #if !BC_ENABLE_LIBRARY #if BC_ENABLE_EDITLINE /// The normal path to the editrc. const char bc_history_editrc[] = "/.editrc"; /// The length of the normal path to the editrc. const size_t bc_history_editrc_len = sizeof(bc_history_editrc) - 1; #endif // BC_ENABLE_EDITLINE #if BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB /// A flush type for not clearing current extras but not saving new ones either. const BcFlushType bc_flush_none = BC_FLUSH_NO_EXTRAS_NO_CLEAR; /// A flush type for clearing extras and not saving new ones. const BcFlushType bc_flush_err = BC_FLUSH_NO_EXTRAS_CLEAR; /// A flush type for clearing previous extras and saving new ones. const BcFlushType bc_flush_save = BC_FLUSH_SAVE_EXTRAS_CLEAR; /// A list of known bad terminals. const char* bc_history_bad_terms[] = { "dumb", "cons25", "emacs", NULL }; /// A constant for tabs and its length. My tab handling is dumb and always /// outputs the entire thing. const char bc_history_tab[] = "\t"; const size_t bc_history_tab_len = sizeof(bc_history_tab) - 1; /// A list of wide chars. These are listed in ascending order for efficiency. const uint32_t bc_history_wchars[][2] = { { 0x1100, 0x115F }, { 0x231A, 0x231B }, { 0x2329, 0x232A }, { 0x23E9, 0x23EC }, { 0x23F0, 0x23F0 }, { 0x23F3, 0x23F3 }, { 0x25FD, 0x25FE }, { 0x2614, 0x2615 }, { 0x2648, 0x2653 }, { 0x267F, 0x267F }, { 0x2693, 0x2693 }, { 0x26A1, 0x26A1 }, { 0x26AA, 0x26AB }, { 0x26BD, 0x26BE }, { 0x26C4, 0x26C5 }, { 0x26CE, 0x26CE }, { 0x26D4, 0x26D4 }, { 0x26EA, 0x26EA }, { 0x26F2, 0x26F3 }, { 0x26F5, 0x26F5 }, { 0x26FA, 0x26FA }, { 0x26FD, 0x26FD }, { 0x2705, 0x2705 }, { 0x270A, 0x270B }, { 0x2728, 0x2728 }, { 0x274C, 0x274C }, { 0x274E, 0x274E }, { 0x2753, 0x2755 }, { 0x2757, 0x2757 }, { 0x2795, 0x2797 }, { 0x27B0, 0x27B0 }, { 0x27BF, 0x27BF }, { 0x2B1B, 0x2B1C }, { 0x2B50, 0x2B50 }, { 0x2B55, 0x2B55 }, { 0x2E80, 0x2E99 }, { 0x2E9B, 0x2EF3 }, { 0x2F00, 0x2FD5 }, { 0x2FF0, 0x2FFB }, { 0x3001, 0x303E }, { 0x3041, 0x3096 }, { 0x3099, 0x30FF }, { 0x3105, 0x312D }, { 0x3131, 0x318E }, { 0x3190, 0x31BA }, { 0x31C0, 0x31E3 }, { 0x31F0, 0x321E }, { 0x3220, 0x3247 }, { 0x3250, 0x32FE }, { 0x3300, 0x4DBF }, { 0x4E00, 0xA48C }, { 0xA490, 0xA4C6 }, { 0xA960, 0xA97C }, { 0xAC00, 0xD7A3 }, { 0xF900, 0xFAFF }, { 0xFE10, 0xFE19 }, { 0xFE30, 0xFE52 }, { 0xFE54, 0xFE66 }, { 0xFE68, 0xFE6B }, { 0x16FE0, 0x16FE0 }, { 0x17000, 0x187EC }, { 0x18800, 0x18AF2 }, { 0x1B000, 0x1B001 }, { 0x1F004, 0x1F004 }, { 0x1F0CF, 0x1F0CF }, { 0x1F18E, 0x1F18E }, { 0x1F191, 0x1F19A }, { 0x1F200, 0x1F202 }, { 0x1F210, 0x1F23B }, { 0x1F240, 0x1F248 }, { 0x1F250, 0x1F251 }, { 0x1F300, 0x1F320 }, { 0x1F32D, 0x1F335 }, { 0x1F337, 0x1F37C }, { 0x1F37E, 0x1F393 }, { 0x1F3A0, 0x1F3CA }, { 0x1F3CF, 0x1F3D3 }, { 0x1F3E0, 0x1F3F0 }, { 0x1F3F4, 0x1F3F4 }, { 0x1F3F8, 0x1F43E }, { 0x1F440, 0x1F440 }, { 0x1F442, 0x1F4FC }, { 0x1F4FF, 0x1F53D }, { 0x1F54B, 0x1F54E }, { 0x1F550, 0x1F567 }, { 0x1F57A, 0x1F57A }, { 0x1F595, 0x1F596 }, { 0x1F5A4, 0x1F5A4 }, { 0x1F5FB, 0x1F64F }, { 0x1F680, 0x1F6C5 }, { 0x1F6CC, 0x1F6CC }, { 0x1F6D0, 0x1F6D2 }, { 0x1F6EB, 0x1F6EC }, { 0x1F6F4, 0x1F6F6 }, { 0x1F910, 0x1F91E }, { 0x1F920, 0x1F927 }, { 0x1F930, 0x1F930 }, { 0x1F933, 0x1F93E }, { 0x1F940, 0x1F94B }, { 0x1F950, 0x1F95E }, { 0x1F980, 0x1F991 }, { 0x1F9C0, 0x1F9C0 }, { 0x20000, 0x2FFFD }, { 0x30000, 0x3FFFD }, }; /// The length of the wide chars list. const size_t bc_history_wchars_len = sizeof(bc_history_wchars) / sizeof(bc_history_wchars[0]); /// A list of combining characters in Unicode. These are listed in ascending /// order for efficiency. const uint32_t bc_history_combo_chars[] = { 0x0300, 0x0301, 0x0302, 0x0303, 0x0304, 0x0305, 0x0306, 0x0307, 0x0308, 0x0309, 0x030A, 0x030B, 0x030C, 0x030D, 0x030E, 0x030F, 0x0310, 0x0311, 0x0312, 0x0313, 0x0314, 0x0315, 0x0316, 0x0317, 0x0318, 0x0319, 0x031A, 0x031B, 0x031C, 0x031D, 0x031E, 0x031F, 0x0320, 0x0321, 0x0322, 0x0323, 0x0324, 0x0325, 0x0326, 0x0327, 0x0328, 0x0329, 0x032A, 0x032B, 0x032C, 0x032D, 0x032E, 0x032F, 0x0330, 0x0331, 0x0332, 0x0333, 0x0334, 0x0335, 0x0336, 0x0337, 0x0338, 0x0339, 0x033A, 0x033B, 0x033C, 0x033D, 0x033E, 0x033F, 0x0340, 0x0341, 0x0342, 0x0343, 0x0344, 0x0345, 0x0346, 0x0347, 0x0348, 0x0349, 0x034A, 0x034B, 0x034C, 0x034D, 0x034E, 0x034F, 0x0350, 0x0351, 0x0352, 0x0353, 0x0354, 0x0355, 0x0356, 0x0357, 0x0358, 0x0359, 0x035A, 0x035B, 0x035C, 0x035D, 0x035E, 0x035F, 0x0360, 0x0361, 0x0362, 0x0363, 0x0364, 0x0365, 0x0366, 0x0367, 0x0368, 0x0369, 0x036A, 0x036B, 0x036C, 0x036D, 0x036E, 0x036F, 0x0483, 0x0484, 0x0485, 0x0486, 0x0487, 0x0591, 0x0592, 0x0593, 0x0594, 0x0595, 0x0596, 0x0597, 0x0598, 0x0599, 0x059A, 0x059B, 0x059C, 0x059D, 0x059E, 0x059F, 0x05A0, 0x05A1, 0x05A2, 0x05A3, 0x05A4, 0x05A5, 0x05A6, 0x05A7, 0x05A8, 0x05A9, 0x05AA, 0x05AB, 0x05AC, 0x05AD, 0x05AE, 0x05AF, 0x05B0, 0x05B1, 0x05B2, 0x05B3, 0x05B4, 0x05B5, 0x05B6, 0x05B7, 0x05B8, 0x05B9, 0x05BA, 0x05BB, 0x05BC, 0x05BD, 0x05BF, 0x05C1, 0x05C2, 0x05C4, 0x05C5, 0x05C7, 0x0610, 0x0611, 0x0612, 0x0613, 0x0614, 0x0615, 0x0616, 0x0617, 0x0618, 0x0619, 0x061A, 0x064B, 0x064C, 0x064D, 0x064E, 0x064F, 0x0650, 0x0651, 0x0652, 0x0653, 0x0654, 0x0655, 0x0656, 0x0657, 0x0658, 0x0659, 0x065A, 0x065B, 0x065C, 0x065D, 0x065E, 0x065F, 0x0670, 0x06D6, 0x06D7, 0x06D8, 0x06D9, 0x06DA, 0x06DB, 0x06DC, 0x06DF, 0x06E0, 0x06E1, 0x06E2, 0x06E3, 0x06E4, 0x06E7, 0x06E8, 0x06EA, 0x06EB, 0x06EC, 0x06ED, 0x0711, 0x0730, 0x0731, 0x0732, 0x0733, 0x0734, 0x0735, 0x0736, 0x0737, 0x0738, 0x0739, 0x073A, 0x073B, 0x073C, 0x073D, 0x073E, 0x073F, 0x0740, 0x0741, 0x0742, 0x0743, 0x0744, 0x0745, 0x0746, 0x0747, 0x0748, 0x0749, 0x074A, 0x07A6, 0x07A7, 0x07A8, 0x07A9, 0x07AA, 0x07AB, 0x07AC, 0x07AD, 0x07AE, 0x07AF, 0x07B0, 0x07EB, 0x07EC, 0x07ED, 0x07EE, 0x07EF, 0x07F0, 0x07F1, 0x07F2, 0x07F3, 0x0816, 0x0817, 0x0818, 0x0819, 0x081B, 0x081C, 0x081D, 0x081E, 0x081F, 0x0820, 0x0821, 0x0822, 0x0823, 0x0825, 0x0826, 0x0827, 0x0829, 0x082A, 0x082B, 0x082C, 0x082D, 0x0859, 0x085A, 0x085B, 0x08D4, 0x08D5, 0x08D6, 0x08D7, 0x08D8, 0x08D9, 0x08DA, 0x08DB, 0x08DC, 0x08DD, 0x08DE, 0x08DF, 0x08E0, 0x08E1, 0x08E3, 0x08E4, 0x08E5, 0x08E6, 0x08E7, 0x08E8, 0x08E9, 0x08EA, 0x08EB, 0x08EC, 0x08ED, 0x08EE, 0x08EF, 0x08F0, 0x08F1, 0x08F2, 0x08F3, 0x08F4, 0x08F5, 0x08F6, 0x08F7, 0x08F8, 0x08F9, 0x08FA, 0x08FB, 0x08FC, 0x08FD, 0x08FE, 0x08FF, 0x0900, 0x0901, 0x0902, 0x093A, 0x093C, 0x0941, 0x0942, 0x0943, 0x0944, 0x0945, 0x0946, 0x0947, 0x0948, 0x094D, 0x0951, 0x0952, 0x0953, 0x0954, 0x0955, 0x0956, 0x0957, 0x0962, 0x0963, 0x0981, 0x09BC, 0x09C1, 0x09C2, 0x09C3, 0x09C4, 0x09CD, 0x09E2, 0x09E3, 0x0A01, 0x0A02, 0x0A3C, 0x0A41, 0x0A42, 0x0A47, 0x0A48, 0x0A4B, 0x0A4C, 0x0A4D, 0x0A51, 0x0A70, 0x0A71, 0x0A75, 0x0A81, 0x0A82, 0x0ABC, 0x0AC1, 0x0AC2, 0x0AC3, 0x0AC4, 0x0AC5, 0x0AC7, 0x0AC8, 0x0ACD, 0x0AE2, 0x0AE3, 0x0B01, 0x0B3C, 0x0B3F, 0x0B41, 0x0B42, 0x0B43, 0x0B44, 0x0B4D, 0x0B56, 0x0B62, 0x0B63, 0x0B82, 0x0BC0, 0x0BCD, 0x0C00, 0x0C3E, 0x0C3F, 0x0C40, 0x0C46, 0x0C47, 0x0C48, 0x0C4A, 0x0C4B, 0x0C4C, 0x0C4D, 0x0C55, 0x0C56, 0x0C62, 0x0C63, 0x0C81, 0x0CBC, 0x0CBF, 0x0CC6, 0x0CCC, 0x0CCD, 0x0CE2, 0x0CE3, 0x0D01, 0x0D41, 0x0D42, 0x0D43, 0x0D44, 0x0D4D, 0x0D62, 0x0D63, 0x0DCA, 0x0DD2, 0x0DD3, 0x0DD4, 0x0DD6, 0x0E31, 0x0E34, 0x0E35, 0x0E36, 0x0E37, 0x0E38, 0x0E39, 0x0E3A, 0x0E47, 0x0E48, 0x0E49, 0x0E4A, 0x0E4B, 0x0E4C, 0x0E4D, 0x0E4E, 0x0EB1, 0x0EB4, 0x0EB5, 0x0EB6, 0x0EB7, 0x0EB8, 0x0EB9, 0x0EBB, 0x0EBC, 0x0EC8, 0x0EC9, 0x0ECA, 0x0ECB, 0x0ECC, 0x0ECD, 0x0F18, 0x0F19, 0x0F35, 0x0F37, 0x0F39, 0x0F71, 0x0F72, 0x0F73, 0x0F74, 0x0F75, 0x0F76, 0x0F77, 0x0F78, 0x0F79, 0x0F7A, 0x0F7B, 0x0F7C, 0x0F7D, 0x0F7E, 0x0F80, 0x0F81, 0x0F82, 0x0F83, 0x0F84, 0x0F86, 0x0F87, 0x0F8D, 0x0F8E, 0x0F8F, 0x0F90, 0x0F91, 0x0F92, 0x0F93, 0x0F94, 0x0F95, 0x0F96, 0x0F97, 0x0F99, 0x0F9A, 0x0F9B, 0x0F9C, 0x0F9D, 0x0F9E, 0x0F9F, 0x0FA0, 0x0FA1, 0x0FA2, 0x0FA3, 0x0FA4, 0x0FA5, 0x0FA6, 0x0FA7, 0x0FA8, 0x0FA9, 0x0FAA, 0x0FAB, 0x0FAC, 0x0FAD, 0x0FAE, 0x0FAF, 0x0FB0, 0x0FB1, 0x0FB2, 0x0FB3, 0x0FB4, 0x0FB5, 0x0FB6, 0x0FB7, 0x0FB8, 0x0FB9, 0x0FBA, 0x0FBB, 0x0FBC, 0x0FC6, 0x102D, 0x102E, 0x102F, 0x1030, 0x1032, 0x1033, 0x1034, 0x1035, 0x1036, 0x1037, 0x1039, 0x103A, 0x103D, 0x103E, 0x1058, 0x1059, 0x105E, 0x105F, 0x1060, 0x1071, 0x1072, 0x1073, 0x1074, 0x1082, 0x1085, 0x1086, 0x108D, 0x109D, 0x135D, 0x135E, 0x135F, 0x1712, 0x1713, 0x1714, 0x1732, 0x1733, 0x1734, 0x1752, 0x1753, 0x1772, 0x1773, 0x17B4, 0x17B5, 0x17B7, 0x17B8, 0x17B9, 0x17BA, 0x17BB, 0x17BC, 0x17BD, 0x17C6, 0x17C9, 0x17CA, 0x17CB, 0x17CC, 0x17CD, 0x17CE, 0x17CF, 0x17D0, 0x17D1, 0x17D2, 0x17D3, 0x17DD, 0x180B, 0x180C, 0x180D, 0x1885, 0x1886, 0x18A9, 0x1920, 0x1921, 0x1922, 0x1927, 0x1928, 0x1932, 0x1939, 0x193A, 0x193B, 0x1A17, 0x1A18, 0x1A1B, 0x1A56, 0x1A58, 0x1A59, 0x1A5A, 0x1A5B, 0x1A5C, 0x1A5D, 0x1A5E, 0x1A60, 0x1A62, 0x1A65, 0x1A66, 0x1A67, 0x1A68, 0x1A69, 0x1A6A, 0x1A6B, 0x1A6C, 0x1A73, 0x1A74, 0x1A75, 0x1A76, 0x1A77, 0x1A78, 0x1A79, 0x1A7A, 0x1A7B, 0x1A7C, 0x1A7F, 0x1AB0, 0x1AB1, 0x1AB2, 0x1AB3, 0x1AB4, 0x1AB5, 0x1AB6, 0x1AB7, 0x1AB8, 0x1AB9, 0x1ABA, 0x1ABB, 0x1ABC, 0x1ABD, 0x1B00, 0x1B01, 0x1B02, 0x1B03, 0x1B34, 0x1B36, 0x1B37, 0x1B38, 0x1B39, 0x1B3A, 0x1B3C, 0x1B42, 0x1B6B, 0x1B6C, 0x1B6D, 0x1B6E, 0x1B6F, 0x1B70, 0x1B71, 0x1B72, 0x1B73, 0x1B80, 0x1B81, 0x1BA2, 0x1BA3, 0x1BA4, 0x1BA5, 0x1BA8, 0x1BA9, 0x1BAB, 0x1BAC, 0x1BAD, 0x1BE6, 0x1BE8, 0x1BE9, 0x1BED, 0x1BEF, 0x1BF0, 0x1BF1, 0x1C2C, 0x1C2D, 0x1C2E, 0x1C2F, 0x1C30, 0x1C31, 0x1C32, 0x1C33, 0x1C36, 0x1C37, 0x1CD0, 0x1CD1, 0x1CD2, 0x1CD4, 0x1CD5, 0x1CD6, 0x1CD7, 0x1CD8, 0x1CD9, 0x1CDA, 0x1CDB, 0x1CDC, 0x1CDD, 0x1CDE, 0x1CDF, 0x1CE0, 0x1CE2, 0x1CE3, 0x1CE4, 0x1CE5, 0x1CE6, 0x1CE7, 0x1CE8, 0x1CED, 0x1CF4, 0x1CF8, 0x1CF9, 0x1DC0, 0x1DC1, 0x1DC2, 0x1DC3, 0x1DC4, 0x1DC5, 0x1DC6, 0x1DC7, 0x1DC8, 0x1DC9, 0x1DCA, 0x1DCB, 0x1DCC, 0x1DCD, 0x1DCE, 0x1DCF, 0x1DD0, 0x1DD1, 0x1DD2, 0x1DD3, 0x1DD4, 0x1DD5, 0x1DD6, 0x1DD7, 0x1DD8, 0x1DD9, 0x1DDA, 0x1DDB, 0x1DDC, 0x1DDD, 0x1DDE, 0x1DDF, 0x1DE0, 0x1DE1, 0x1DE2, 0x1DE3, 0x1DE4, 0x1DE5, 0x1DE6, 0x1DE7, 0x1DE8, 0x1DE9, 0x1DEA, 0x1DEB, 0x1DEC, 0x1DED, 0x1DEE, 0x1DEF, 0x1DF0, 0x1DF1, 0x1DF2, 0x1DF3, 0x1DF4, 0x1DF5, 0x1DFB, 0x1DFC, 0x1DFD, 0x1DFE, 0x1DFF, 0x20D0, 0x20D1, 0x20D2, 0x20D3, 0x20D4, 0x20D5, 0x20D6, 0x20D7, 0x20D8, 0x20D9, 0x20DA, 0x20DB, 0x20DC, 0x20E1, 0x20E5, 0x20E6, 0x20E7, 0x20E8, 0x20E9, 0x20EA, 0x20EB, 0x20EC, 0x20ED, 0x20EE, 0x20EF, 0x20F0, 0x2CEF, 0x2CF0, 0x2CF1, 0x2D7F, 0x2DE0, 0x2DE1, 0x2DE2, 0x2DE3, 0x2DE4, 0x2DE5, 0x2DE6, 0x2DE7, 0x2DE8, 0x2DE9, 0x2DEA, 0x2DEB, 0x2DEC, 0x2DED, 0x2DEE, 0x2DEF, 0x2DF0, 0x2DF1, 0x2DF2, 0x2DF3, 0x2DF4, 0x2DF5, 0x2DF6, 0x2DF7, 0x2DF8, 0x2DF9, 0x2DFA, 0x2DFB, 0x2DFC, 0x2DFD, 0x2DFE, 0x2DFF, 0x302A, 0x302B, 0x302C, 0x302D, 0x3099, 0x309A, 0xA66F, 0xA674, 0xA675, 0xA676, 0xA677, 0xA678, 0xA679, 0xA67A, 0xA67B, 0xA67C, 0xA67D, 0xA69E, 0xA69F, 0xA6F0, 0xA6F1, 0xA802, 0xA806, 0xA80B, 0xA825, 0xA826, 0xA8C4, 0xA8C5, 0xA8E0, 0xA8E1, 0xA8E2, 0xA8E3, 0xA8E4, 0xA8E5, 0xA8E6, 0xA8E7, 0xA8E8, 0xA8E9, 0xA8EA, 0xA8EB, 0xA8EC, 0xA8ED, 0xA8EE, 0xA8EF, 0xA8F0, 0xA8F1, 0xA926, 0xA927, 0xA928, 0xA929, 0xA92A, 0xA92B, 0xA92C, 0xA92D, 0xA947, 0xA948, 0xA949, 0xA94A, 0xA94B, 0xA94C, 0xA94D, 0xA94E, 0xA94F, 0xA950, 0xA951, 0xA980, 0xA981, 0xA982, 0xA9B3, 0xA9B6, 0xA9B7, 0xA9B8, 0xA9B9, 0xA9BC, 0xA9E5, 0xAA29, 0xAA2A, 0xAA2B, 0xAA2C, 0xAA2D, 0xAA2E, 0xAA31, 0xAA32, 0xAA35, 0xAA36, 0xAA43, 0xAA4C, 0xAA7C, 0xAAB0, 0xAAB2, 0xAAB3, 0xAAB4, 0xAAB7, 0xAAB8, 0xAABE, 0xAABF, 0xAAC1, 0xAAEC, 0xAAED, 0xAAF6, 0xABE5, 0xABE8, 0xABED, 0xFB1E, 0xFE00, 0xFE01, 0xFE02, 0xFE03, 0xFE04, 0xFE05, 0xFE06, 0xFE07, 0xFE08, 0xFE09, 0xFE0A, 0xFE0B, 0xFE0C, 0xFE0D, 0xFE0E, 0xFE0F, 0xFE20, 0xFE21, 0xFE22, 0xFE23, 0xFE24, 0xFE25, 0xFE26, 0xFE27, 0xFE28, 0xFE29, 0xFE2A, 0xFE2B, 0xFE2C, 0xFE2D, 0xFE2E, 0xFE2F, 0x101FD, 0x102E0, 0x10376, 0x10377, 0x10378, 0x10379, 0x1037A, 0x10A01, 0x10A02, 0x10A03, 0x10A05, 0x10A06, 0x10A0C, 0x10A0D, 0x10A0E, 0x10A0F, 0x10A38, 0x10A39, 0x10A3A, 0x10A3F, 0x10AE5, 0x10AE6, 0x11001, 0x11038, 0x11039, 0x1103A, 0x1103B, 0x1103C, 0x1103D, 0x1103E, 0x1103F, 0x11040, 0x11041, 0x11042, 0x11043, 0x11044, 0x11045, 0x11046, 0x1107F, 0x11080, 0x11081, 0x110B3, 0x110B4, 0x110B5, 0x110B6, 0x110B9, 0x110BA, 0x11100, 0x11101, 0x11102, 0x11127, 0x11128, 0x11129, 0x1112A, 0x1112B, 0x1112D, 0x1112E, 0x1112F, 0x11130, 0x11131, 0x11132, 0x11133, 0x11134, 0x11173, 0x11180, 0x11181, 0x111B6, 0x111B7, 0x111B8, 0x111B9, 0x111BA, 0x111BB, 0x111BC, 0x111BD, 0x111BE, 0x111CA, 0x111CB, 0x111CC, 0x1122F, 0x11230, 0x11231, 0x11234, 0x11236, 0x11237, 0x1123E, 0x112DF, 0x112E3, 0x112E4, 0x112E5, 0x112E6, 0x112E7, 0x112E8, 0x112E9, 0x112EA, 0x11300, 0x11301, 0x1133C, 0x11340, 0x11366, 0x11367, 0x11368, 0x11369, 0x1136A, 0x1136B, 0x1136C, 0x11370, 0x11371, 0x11372, 0x11373, 0x11374, 0x11438, 0x11439, 0x1143A, 0x1143B, 0x1143C, 0x1143D, 0x1143E, 0x1143F, 0x11442, 0x11443, 0x11444, 0x11446, 0x114B3, 0x114B4, 0x114B5, 0x114B6, 0x114B7, 0x114B8, 0x114BA, 0x114BF, 0x114C0, 0x114C2, 0x114C3, 0x115B2, 0x115B3, 0x115B4, 0x115B5, 0x115BC, 0x115BD, 0x115BF, 0x115C0, 0x115DC, 0x115DD, 0x11633, 0x11634, 0x11635, 0x11636, 0x11637, 0x11638, 0x11639, 0x1163A, 0x1163D, 0x1163F, 0x11640, 0x116AB, 0x116AD, 0x116B0, 0x116B1, 0x116B2, 0x116B3, 0x116B4, 0x116B5, 0x116B7, 0x1171D, 0x1171E, 0x1171F, 0x11722, 0x11723, 0x11724, 0x11725, 0x11727, 0x11728, 0x11729, 0x1172A, 0x1172B, 0x11C30, 0x11C31, 0x11C32, 0x11C33, 0x11C34, 0x11C35, 0x11C36, 0x11C38, 0x11C39, 0x11C3A, 0x11C3B, 0x11C3C, 0x11C3D, 0x11C3F, 0x11C92, 0x11C93, 0x11C94, 0x11C95, 0x11C96, 0x11C97, 0x11C98, 0x11C99, 0x11C9A, 0x11C9B, 0x11C9C, 0x11C9D, 0x11C9E, 0x11C9F, 0x11CA0, 0x11CA1, 0x11CA2, 0x11CA3, 0x11CA4, 0x11CA5, 0x11CA6, 0x11CA7, 0x11CAA, 0x11CAB, 0x11CAC, 0x11CAD, 0x11CAE, 0x11CAF, 0x11CB0, 0x11CB2, 0x11CB3, 0x11CB5, 0x11CB6, 0x16AF0, 0x16AF1, 0x16AF2, 0x16AF3, 0x16AF4, 0x16B30, 0x16B31, 0x16B32, 0x16B33, 0x16B34, 0x16B35, 0x16B36, 0x16F8F, 0x16F90, 0x16F91, 0x16F92, 0x1BC9D, 0x1BC9E, 0x1D167, 0x1D168, 0x1D169, 0x1D17B, 0x1D17C, 0x1D17D, 0x1D17E, 0x1D17F, 0x1D180, 0x1D181, 0x1D182, 0x1D185, 0x1D186, 0x1D187, 0x1D188, 0x1D189, 0x1D18A, 0x1D18B, 0x1D1AA, 0x1D1AB, 0x1D1AC, 0x1D1AD, 0x1D242, 0x1D243, 0x1D244, 0x1DA00, 0x1DA01, 0x1DA02, 0x1DA03, 0x1DA04, 0x1DA05, 0x1DA06, 0x1DA07, 0x1DA08, 0x1DA09, 0x1DA0A, 0x1DA0B, 0x1DA0C, 0x1DA0D, 0x1DA0E, 0x1DA0F, 0x1DA10, 0x1DA11, 0x1DA12, 0x1DA13, 0x1DA14, 0x1DA15, 0x1DA16, 0x1DA17, 0x1DA18, 0x1DA19, 0x1DA1A, 0x1DA1B, 0x1DA1C, 0x1DA1D, 0x1DA1E, 0x1DA1F, 0x1DA20, 0x1DA21, 0x1DA22, 0x1DA23, 0x1DA24, 0x1DA25, 0x1DA26, 0x1DA27, 0x1DA28, 0x1DA29, 0x1DA2A, 0x1DA2B, 0x1DA2C, 0x1DA2D, 0x1DA2E, 0x1DA2F, 0x1DA30, 0x1DA31, 0x1DA32, 0x1DA33, 0x1DA34, 0x1DA35, 0x1DA36, 0x1DA3B, 0x1DA3C, 0x1DA3D, 0x1DA3E, 0x1DA3F, 0x1DA40, 0x1DA41, 0x1DA42, 0x1DA43, 0x1DA44, 0x1DA45, 0x1DA46, 0x1DA47, 0x1DA48, 0x1DA49, 0x1DA4A, 0x1DA4B, 0x1DA4C, 0x1DA4D, 0x1DA4E, 0x1DA4F, 0x1DA50, 0x1DA51, 0x1DA52, 0x1DA53, 0x1DA54, 0x1DA55, 0x1DA56, 0x1DA57, 0x1DA58, 0x1DA59, 0x1DA5A, 0x1DA5B, 0x1DA5C, 0x1DA5D, 0x1DA5E, 0x1DA5F, 0x1DA60, 0x1DA61, 0x1DA62, 0x1DA63, 0x1DA64, 0x1DA65, 0x1DA66, 0x1DA67, 0x1DA68, 0x1DA69, 0x1DA6A, 0x1DA6B, 0x1DA6C, 0x1DA75, 0x1DA84, 0x1DA9B, 0x1DA9C, 0x1DA9D, 0x1DA9E, 0x1DA9F, 0x1DAA1, 0x1DAA2, 0x1DAA3, 0x1DAA4, 0x1DAA5, 0x1DAA6, 0x1DAA7, 0x1DAA8, 0x1DAA9, 0x1DAAA, 0x1DAAB, 0x1DAAC, 0x1DAAD, 0x1DAAE, 0x1DAAF, 0x1E000, 0x1E001, 0x1E002, 0x1E003, 0x1E004, 0x1E005, 0x1E006, 0x1E008, 0x1E009, 0x1E00A, 0x1E00B, 0x1E00C, 0x1E00D, 0x1E00E, 0x1E00F, 0x1E010, 0x1E011, 0x1E012, 0x1E013, 0x1E014, 0x1E015, 0x1E016, 0x1E017, 0x1E018, 0x1E01B, 0x1E01C, 0x1E01D, 0x1E01E, 0x1E01F, 0x1E020, 0x1E021, 0x1E023, 0x1E024, 0x1E026, 0x1E027, 0x1E028, 0x1E029, 0x1E02A, 0x1E8D0, 0x1E8D1, 0x1E8D2, 0x1E8D3, 0x1E8D4, 0x1E8D5, 0x1E8D6, 0x1E944, 0x1E945, 0x1E946, 0x1E947, 0x1E948, 0x1E949, 0x1E94A, 0xE0100, 0xE0101, 0xE0102, 0xE0103, 0xE0104, 0xE0105, 0xE0106, 0xE0107, 0xE0108, 0xE0109, 0xE010A, 0xE010B, 0xE010C, 0xE010D, 0xE010E, 0xE010F, 0xE0110, 0xE0111, 0xE0112, 0xE0113, 0xE0114, 0xE0115, 0xE0116, 0xE0117, 0xE0118, 0xE0119, 0xE011A, 0xE011B, 0xE011C, 0xE011D, 0xE011E, 0xE011F, 0xE0120, 0xE0121, 0xE0122, 0xE0123, 0xE0124, 0xE0125, 0xE0126, 0xE0127, 0xE0128, 0xE0129, 0xE012A, 0xE012B, 0xE012C, 0xE012D, 0xE012E, 0xE012F, 0xE0130, 0xE0131, 0xE0132, 0xE0133, 0xE0134, 0xE0135, 0xE0136, 0xE0137, 0xE0138, 0xE0139, 0xE013A, 0xE013B, 0xE013C, 0xE013D, 0xE013E, 0xE013F, 0xE0140, 0xE0141, 0xE0142, 0xE0143, 0xE0144, 0xE0145, 0xE0146, 0xE0147, 0xE0148, 0xE0149, 0xE014A, 0xE014B, 0xE014C, 0xE014D, 0xE014E, 0xE014F, 0xE0150, 0xE0151, 0xE0152, 0xE0153, 0xE0154, 0xE0155, 0xE0156, 0xE0157, 0xE0158, 0xE0159, 0xE015A, 0xE015B, 0xE015C, 0xE015D, 0xE015E, 0xE015F, 0xE0160, 0xE0161, 0xE0162, 0xE0163, 0xE0164, 0xE0165, 0xE0166, 0xE0167, 0xE0168, 0xE0169, 0xE016A, 0xE016B, 0xE016C, 0xE016D, 0xE016E, 0xE016F, 0xE0170, 0xE0171, 0xE0172, 0xE0173, 0xE0174, 0xE0175, 0xE0176, 0xE0177, 0xE0178, 0xE0179, 0xE017A, 0xE017B, 0xE017C, 0xE017D, 0xE017E, 0xE017F, 0xE0180, 0xE0181, 0xE0182, 0xE0183, 0xE0184, 0xE0185, 0xE0186, 0xE0187, 0xE0188, 0xE0189, 0xE018A, 0xE018B, 0xE018C, 0xE018D, 0xE018E, 0xE018F, 0xE0190, 0xE0191, 0xE0192, 0xE0193, 0xE0194, 0xE0195, 0xE0196, 0xE0197, 0xE0198, 0xE0199, 0xE019A, 0xE019B, 0xE019C, 0xE019D, 0xE019E, 0xE019F, 0xE01A0, 0xE01A1, 0xE01A2, 0xE01A3, 0xE01A4, 0xE01A5, 0xE01A6, 0xE01A7, 0xE01A8, 0xE01A9, 0xE01AA, 0xE01AB, 0xE01AC, 0xE01AD, 0xE01AE, 0xE01AF, 0xE01B0, 0xE01B1, 0xE01B2, 0xE01B3, 0xE01B4, 0xE01B5, 0xE01B6, 0xE01B7, 0xE01B8, 0xE01B9, 0xE01BA, 0xE01BB, 0xE01BC, 0xE01BD, 0xE01BE, 0xE01BF, 0xE01C0, 0xE01C1, 0xE01C2, 0xE01C3, 0xE01C4, 0xE01C5, 0xE01C6, 0xE01C7, 0xE01C8, 0xE01C9, 0xE01CA, 0xE01CB, 0xE01CC, 0xE01CD, 0xE01CE, 0xE01CF, 0xE01D0, 0xE01D1, 0xE01D2, 0xE01D3, 0xE01D4, 0xE01D5, 0xE01D6, 0xE01D7, 0xE01D8, 0xE01D9, 0xE01DA, 0xE01DB, 0xE01DC, 0xE01DD, 0xE01DE, 0xE01DF, 0xE01E0, 0xE01E1, 0xE01E2, 0xE01E3, 0xE01E4, 0xE01E5, 0xE01E6, 0xE01E7, 0xE01E8, 0xE01E9, 0xE01EA, 0xE01EB, 0xE01EC, 0xE01ED, 0xE01EE, 0xE01EF, }; /// The length of the combining characters list. const size_t bc_history_combo_chars_len = sizeof(bc_history_combo_chars) / sizeof(bc_history_combo_chars[0]); #endif // BC_ENABLE_HISTORY && !BC_ENABLE_LINE_LIB /// The human-readable name of the main function in bc source code. const char bc_func_main[] = "(main)"; /// The human-readable name of the read function in bc source code. const char bc_func_read[] = "(read)"; #if BC_DEBUG_CODE /// A list of names of instructions for easy debugging output. const char* bc_inst_names[] = { #if BC_ENABLED "BC_INST_INC", "BC_INST_DEC", #endif // BC_ENABLED "BC_INST_NEG", "BC_INST_BOOL_NOT", #if BC_ENABLE_EXTRA_MATH "BC_INST_TRUNC", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_POWER", "BC_INST_MULTIPLY", "BC_INST_DIVIDE", "BC_INST_MODULUS", "BC_INST_PLUS", "BC_INST_MINUS", #if BC_ENABLE_EXTRA_MATH "BC_INST_PLACES", "BC_INST_LSHIFT", "BC_INST_RSHIFT", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_REL_EQ", "BC_INST_REL_LE", "BC_INST_REL_GE", "BC_INST_REL_NE", "BC_INST_REL_LT", "BC_INST_REL_GT", "BC_INST_BOOL_OR", "BC_INST_BOOL_AND", #if BC_ENABLED "BC_INST_ASSIGN_POWER", "BC_INST_ASSIGN_MULTIPLY", "BC_INST_ASSIGN_DIVIDE", "BC_INST_ASSIGN_MODULUS", "BC_INST_ASSIGN_PLUS", "BC_INST_ASSIGN_MINUS", #if BC_ENABLE_EXTRA_MATH "BC_INST_ASSIGN_PLACES", "BC_INST_ASSIGN_LSHIFT", "BC_INST_ASSIGN_RSHIFT", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_ASSIGN", "BC_INST_ASSIGN_POWER_NO_VAL", "BC_INST_ASSIGN_MULTIPLY_NO_VAL", "BC_INST_ASSIGN_DIVIDE_NO_VAL", "BC_INST_ASSIGN_MODULUS_NO_VAL", "BC_INST_ASSIGN_PLUS_NO_VAL", "BC_INST_ASSIGN_MINUS_NO_VAL", #if BC_ENABLE_EXTRA_MATH "BC_INST_ASSIGN_PLACES_NO_VAL", "BC_INST_ASSIGN_LSHIFT_NO_VAL", "BC_INST_ASSIGN_RSHIFT_NO_VAL", #endif // BC_ENABLE_EXTRA_MATH #endif // BC_ENABLED "BC_INST_ASSIGN_NO_VAL", "BC_INST_NUM", "BC_INST_VAR", "BC_INST_ARRAY_ELEM", "BC_INST_ARRAY", "BC_INST_ZERO", "BC_INST_ONE", #if BC_ENABLED "BC_INST_LAST", #endif // BC_ENABLED "BC_INST_IBASE", "BC_INST_OBASE", "BC_INST_SCALE", #if BC_ENABLE_EXTRA_MATH "BC_INST_SEED", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_LENGTH", "BC_INST_SCALE_FUNC", "BC_INST_SQRT", "BC_INST_ABS", "BC_INST_IS_NUMBER", "BC_INST_IS_STRING", #if BC_ENABLE_EXTRA_MATH "BC_INST_IRAND", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_ASCIIFY", "BC_INST_READ", #if BC_ENABLE_EXTRA_MATH "BC_INST_RAND", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_MAXIBASE", "BC_INST_MAXOBASE", "BC_INST_MAXSCALE", #if BC_ENABLE_EXTRA_MATH "BC_INST_MAXRAND", #endif // BC_ENABLE_EXTRA_MATH "BC_INST_PRINT", "BC_INST_PRINT_POP", "BC_INST_STR", #if BC_ENABLED "BC_INST_PRINT_STR", "BC_INST_JUMP", "BC_INST_JUMP_ZERO", "BC_INST_CALL", "BC_INST_RET", "BC_INST_RET0", "BC_INST_RET_VOID", "BC_INST_HALT", #endif // BC_ENABLED "BC_INST_POP", "BC_INST_SWAP", "BC_INST_MODEXP", "BC_INST_DIVMOD", "BC_INST_PRINT_STREAM", #if DC_ENABLED "BC_INST_POP_EXEC", "BC_INST_EXECUTE", "BC_INST_EXEC_COND", "BC_INST_PRINT_STACK", "BC_INST_CLEAR_STACK", "BC_INST_REG_STACK_LEN", "BC_INST_STACK_LEN", "BC_INST_DUPLICATE", "BC_INST_LOAD", "BC_INST_PUSH_VAR", "BC_INST_PUSH_TO_VAR", "BC_INST_QUIT", "BC_INST_NQUIT", "BC_INST_EXEC_STACK_LEN", #endif // DC_ENABLED "BC_INST_INVALID", }; #endif // BC_DEBUG_CODE /// A constant string for 0. const char bc_parse_zero[2] = "0"; /// A constant string for 1. const char bc_parse_one[2] = "1"; #if BC_ENABLED /// A list of keywords for bc. This needs to be updated if keywords change. const BcLexKeyword bc_lex_kws[] = { BC_LEX_KW_ENTRY("auto", 4, true), BC_LEX_KW_ENTRY("break", 5, true), BC_LEX_KW_ENTRY("continue", 8, false), BC_LEX_KW_ENTRY("define", 6, true), BC_LEX_KW_ENTRY("for", 3, true), BC_LEX_KW_ENTRY("if", 2, true), BC_LEX_KW_ENTRY("limits", 6, false), BC_LEX_KW_ENTRY("return", 6, true), BC_LEX_KW_ENTRY("while", 5, true), BC_LEX_KW_ENTRY("halt", 4, false), BC_LEX_KW_ENTRY("last", 4, false), BC_LEX_KW_ENTRY("ibase", 5, true), BC_LEX_KW_ENTRY("obase", 5, true), BC_LEX_KW_ENTRY("scale", 5, true), #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("seed", 4, false), #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("length", 6, true), BC_LEX_KW_ENTRY("print", 5, false), BC_LEX_KW_ENTRY("sqrt", 4, true), BC_LEX_KW_ENTRY("abs", 3, false), BC_LEX_KW_ENTRY("is_number", 9, false), BC_LEX_KW_ENTRY("is_string", 9, false), #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("irand", 5, false), #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("asciify", 7, false), BC_LEX_KW_ENTRY("modexp", 6, false), BC_LEX_KW_ENTRY("divmod", 6, false), BC_LEX_KW_ENTRY("quit", 4, true), BC_LEX_KW_ENTRY("read", 4, false), #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("rand", 4, false), #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("maxibase", 8, false), BC_LEX_KW_ENTRY("maxobase", 8, false), BC_LEX_KW_ENTRY("maxscale", 8, false), #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("maxrand", 7, false), #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_ENTRY("line_length", 11, false), BC_LEX_KW_ENTRY("global_stacks", 13, false), BC_LEX_KW_ENTRY("leading_zero", 12, false), BC_LEX_KW_ENTRY("stream", 6, false), BC_LEX_KW_ENTRY("else", 4, false), }; /// The length of the list of bc keywords. const size_t bc_lex_kws_len = sizeof(bc_lex_kws) / sizeof(BcLexKeyword); #if BC_C11 // This is here to ensure that BC_LEX_NKWS, which is needed for the // redefined_kws in BcVm, is correct. If it's correct under C11, it will be // correct under C99, and I did not know any other way of ensuring they remained // synchronized. _Static_assert(sizeof(bc_lex_kws) / sizeof(BcLexKeyword) == BC_LEX_NKWS, "BC_LEX_NKWS is wrong."); #endif // BC_C11 /// An array of booleans that correspond to token types. An entry is true if the /// token is valid in an expression, false otherwise. This will need to change /// if tokens change. const uint8_t bc_parse_exprs[] = { // Starts with BC_LEX_EOF. BC_PARSE_EXPR_ENTRY(false, false, true, true, true, true, true, true), // Starts with BC_LEX_OP_MULTIPLY if extra math is enabled, BC_LEX_OP_DIVIDE // otherwise. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, true), // Starts with BC_LEX_OP_REL_EQ if extra math is enabled, BC_LEX_OP_REL_LT // otherwise. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, true), #if BC_ENABLE_EXTRA_MATH // Starts with BC_LEX_OP_ASSIGN_POWER. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, true), // Starts with BC_LEX_OP_ASSIGN_RSHIFT. BC_PARSE_EXPR_ENTRY(true, true, false, false, true, true, false, false), // Starts with BC_LEX_RBRACKET. BC_PARSE_EXPR_ENTRY(false, false, false, false, true, true, true, false), // Starts with BC_LEX_KW_BREAK. BC_PARSE_EXPR_ENTRY(false, false, false, false, false, false, false, false), // Starts with BC_LEX_KW_HALT. BC_PARSE_EXPR_ENTRY(false, true, true, true, true, true, true, false), // Starts with BC_LEX_KW_SQRT. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, true), // Starts with BC_LEX_KW_QUIT. BC_PARSE_EXPR_ENTRY(false, true, true, true, true, true, true, true), // Starts with BC_LEX_KW_GLOBAL_STACKS. BC_PARSE_EXPR_ENTRY(true, true, false, false, 0, 0, 0, 0) #else // BC_ENABLE_EXTRA_MATH // Starts with BC_LEX_OP_ASSIGN_PLUS. BC_PARSE_EXPR_ENTRY(true, true, true, false, false, true, true, false), // Starts with BC_LEX_COMMA. BC_PARSE_EXPR_ENTRY(false, false, false, false, false, true, true, true), // Starts with BC_LEX_KW_AUTO. BC_PARSE_EXPR_ENTRY(false, false, false, false, false, false, false, false), // Starts with BC_LEX_KW_WHILE. BC_PARSE_EXPR_ENTRY(false, false, true, true, true, true, true, false), // Starts with BC_LEX_KW_SQRT. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, false), // Starts with BC_LEX_KW_MAXIBASE. BC_PARSE_EXPR_ENTRY(true, true, true, true, true, true, true, false), // Starts with BC_LEX_KW_ELSE. BC_PARSE_EXPR_ENTRY(false, 0, 0, 0, 0, 0, 0, 0) #endif // BC_ENABLE_EXTRA_MATH }; /// An array of data for operators that correspond to token types. Note that a /// lower precedence *value* means a higher precedence. const uchar bc_parse_ops[] = { BC_PARSE_OP(0, false), BC_PARSE_OP(0, false), BC_PARSE_OP(1, false), BC_PARSE_OP(1, false), #if BC_ENABLE_EXTRA_MATH BC_PARSE_OP(2, false), #endif // BC_ENABLE_EXTRA_MATH BC_PARSE_OP(4, false), BC_PARSE_OP(5, true), BC_PARSE_OP(5, true), BC_PARSE_OP(5, true), BC_PARSE_OP(6, true), BC_PARSE_OP(6, true), #if BC_ENABLE_EXTRA_MATH BC_PARSE_OP(3, false), BC_PARSE_OP(7, true), BC_PARSE_OP(7, true), #endif // BC_ENABLE_EXTRA_MATH BC_PARSE_OP(9, true), BC_PARSE_OP(9, true), BC_PARSE_OP(9, true), BC_PARSE_OP(9, true), BC_PARSE_OP(9, true), BC_PARSE_OP(9, true), BC_PARSE_OP(11, true), BC_PARSE_OP(10, true), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), #if BC_ENABLE_EXTRA_MATH BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), BC_PARSE_OP(8, false), #endif // BC_ENABLE_EXTRA_MATH BC_PARSE_OP(8, false), }; // These identify what tokens can come after expressions in certain cases. /// The valid next tokens for normal expressions. const BcParseNext bc_parse_next_expr = BC_PARSE_NEXT(4, BC_LEX_NLINE, BC_LEX_SCOLON, BC_LEX_RBRACE, BC_LEX_EOF); /// The valid next tokens for function argument expressions. const BcParseNext bc_parse_next_arg = BC_PARSE_NEXT(2, BC_LEX_RPAREN, BC_LEX_COMMA); /// The valid next tokens for expressions in print statements. const BcParseNext bc_parse_next_print = BC_PARSE_NEXT(4, BC_LEX_COMMA, BC_LEX_NLINE, BC_LEX_SCOLON, BC_LEX_EOF); /// The valid next tokens for if statement conditions or loop conditions. This /// is used in for loops for the update expression and for builtin function. /// /// The name is an artifact of history, and is related to @a BC_PARSE_REL (see /// include/parse.h). It refers to how POSIX only allows some operators as part /// of the conditional of for loops, while loops, and if statements. const BcParseNext bc_parse_next_rel = BC_PARSE_NEXT(1, BC_LEX_RPAREN); /// The valid next tokens for array element expressions. const BcParseNext bc_parse_next_elem = BC_PARSE_NEXT(1, BC_LEX_RBRACKET); /// The valid next tokens for for loop initialization expressions and condition /// expressions. const BcParseNext bc_parse_next_for = BC_PARSE_NEXT(1, BC_LEX_SCOLON); /// The valid next tokens for read expressions. const BcParseNext bc_parse_next_read = BC_PARSE_NEXT(2, BC_LEX_NLINE, BC_LEX_EOF); /// The valid next tokens for the arguments of a builtin function with multiple /// arguments. const BcParseNext bc_parse_next_builtin = BC_PARSE_NEXT(1, BC_LEX_COMMA); #endif // BC_ENABLED #if DC_ENABLED /// A list of instructions that need register arguments in dc. const uint8_t dc_lex_regs[] = { BC_LEX_OP_REL_EQ, BC_LEX_OP_REL_LE, BC_LEX_OP_REL_GE, BC_LEX_OP_REL_NE, BC_LEX_OP_REL_LT, BC_LEX_OP_REL_GT, BC_LEX_SCOLON, BC_LEX_COLON, BC_LEX_KW_ELSE, BC_LEX_LOAD, BC_LEX_LOAD_POP, BC_LEX_OP_ASSIGN, BC_LEX_STORE_PUSH, BC_LEX_REG_STACK_LEVEL, BC_LEX_ARRAY_LENGTH, }; /// The length of the list of register instructions. const size_t dc_lex_regs_len = sizeof(dc_lex_regs) / sizeof(uint8_t); /// A list corresponding to characters starting at double quote ("). If an entry /// is BC_LEX_INVALID, then that character needs extra lexing in dc. If it does /// not, the character can trivially be replaced by the entry. Positions are /// kept because it corresponds to the ASCII table. This may need to be changed /// if tokens change. const uchar dc_lex_tokens[] = { #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_IRAND, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #if BC_ENABLE_EXTRA_MATH BC_LEX_OP_TRUNC, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_OP_MODULUS, BC_LEX_INVALID, #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_RAND, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_LPAREN, BC_LEX_RPAREN, BC_LEX_OP_MULTIPLY, BC_LEX_OP_PLUS, BC_LEX_EXEC_STACK_LENGTH, BC_LEX_OP_MINUS, BC_LEX_INVALID, BC_LEX_OP_DIVIDE, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_COLON, BC_LEX_SCOLON, BC_LEX_OP_REL_GT, BC_LEX_OP_REL_EQ, BC_LEX_OP_REL_LT, BC_LEX_KW_READ, #if BC_ENABLE_EXTRA_MATH BC_LEX_OP_PLACES, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_EQ_NO_REG, #if BC_ENABLE_EXTRA_MATH BC_LEX_OP_LSHIFT, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_IBASE, #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_SEED, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_KW_SCALE, BC_LEX_LOAD_POP, BC_LEX_OP_BOOL_AND, BC_LEX_OP_BOOL_NOT, BC_LEX_KW_OBASE, BC_LEX_KW_STREAM, BC_LEX_NQUIT, BC_LEX_POP, BC_LEX_STORE_PUSH, BC_LEX_KW_MAXIBASE, BC_LEX_KW_MAXOBASE, BC_LEX_KW_MAXSCALE, #if BC_ENABLE_EXTRA_MATH BC_LEX_KW_MAXRAND, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_SCALE_FACTOR, BC_LEX_ARRAY_LENGTH, BC_LEX_KW_LENGTH, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_INVALID, BC_LEX_OP_POWER, BC_LEX_NEG, BC_LEX_INVALID, BC_LEX_KW_ASCIIFY, BC_LEX_KW_ABS, BC_LEX_CLEAR_STACK, BC_LEX_DUPLICATE, BC_LEX_KW_ELSE, BC_LEX_PRINT_STACK, BC_LEX_INVALID, #if BC_ENABLE_EXTRA_MATH BC_LEX_OP_RSHIFT, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_STORE_IBASE, #if BC_ENABLE_EXTRA_MATH BC_LEX_STORE_SEED, #else // BC_ENABLE_EXTRA_MATH BC_LEX_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_LEX_STORE_SCALE, BC_LEX_LOAD, BC_LEX_OP_BOOL_OR, BC_LEX_PRINT_POP, BC_LEX_STORE_OBASE, BC_LEX_KW_PRINT, BC_LEX_KW_QUIT, BC_LEX_SWAP, BC_LEX_OP_ASSIGN, BC_LEX_KW_IS_STRING, BC_LEX_KW_IS_NUMBER, BC_LEX_KW_SQRT, BC_LEX_INVALID, BC_LEX_EXECUTE, BC_LEX_REG_STACK_LEVEL, BC_LEX_STACK_LEVEL, BC_LEX_LBRACE, BC_LEX_KW_MODEXP, BC_LEX_RBRACE, BC_LEX_KW_DIVMOD, BC_LEX_INVALID }; /// A list of instructions that correspond to lex tokens. If an entry is /// @a BC_INST_INVALID, that lex token needs extra parsing in the dc parser. /// Otherwise, the token can trivially be replaced by the entry. This needs to /// be updated if the tokens change. const uchar dc_parse_insts[] = { BC_INST_INVALID, BC_INST_INVALID, #if BC_ENABLED BC_INST_INVALID, BC_INST_INVALID, #endif // BC_ENABLED BC_INST_INVALID, BC_INST_BOOL_NOT, #if BC_ENABLE_EXTRA_MATH BC_INST_TRUNC, #endif // BC_ENABLE_EXTRA_MATH BC_INST_POWER, BC_INST_MULTIPLY, BC_INST_DIVIDE, BC_INST_MODULUS, BC_INST_PLUS, BC_INST_MINUS, #if BC_ENABLE_EXTRA_MATH BC_INST_PLACES, BC_INST_LSHIFT, BC_INST_RSHIFT, #endif // BC_ENABLE_EXTRA_MATH BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_BOOL_OR, BC_INST_BOOL_AND, #if BC_ENABLED BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, #if BC_ENABLE_EXTRA_MATH BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, #endif // BC_ENABLE_EXTRA_MATH #endif // BC_ENABLED BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_REL_GT, BC_INST_REL_LT, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_REL_GE, BC_INST_INVALID, BC_INST_REL_LE, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, #if BC_ENABLED BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, #endif // BC_ENABLED BC_INST_IBASE, BC_INST_OBASE, BC_INST_SCALE, #if BC_ENABLE_EXTRA_MATH BC_INST_SEED, #endif // BC_ENABLE_EXTRA_MATH BC_INST_LENGTH, BC_INST_PRINT, BC_INST_SQRT, BC_INST_ABS, BC_INST_IS_NUMBER, BC_INST_IS_STRING, #if BC_ENABLE_EXTRA_MATH BC_INST_IRAND, #endif // BC_ENABLE_EXTRA_MATH BC_INST_ASCIIFY, BC_INST_MODEXP, BC_INST_DIVMOD, BC_INST_QUIT, BC_INST_INVALID, #if BC_ENABLE_EXTRA_MATH BC_INST_RAND, #endif // BC_ENABLE_EXTRA_MATH BC_INST_MAXIBASE, BC_INST_MAXOBASE, BC_INST_MAXSCALE, #if BC_ENABLE_EXTRA_MATH BC_INST_MAXRAND, #endif // BC_ENABLE_EXTRA_MATH BC_INST_LINE_LENGTH, #if BC_ENABLED BC_INST_INVALID, #endif // BC_ENABLED BC_INST_LEADING_ZERO, BC_INST_PRINT_STREAM, BC_INST_INVALID, BC_INST_REL_EQ, BC_INST_INVALID, BC_INST_EXECUTE, BC_INST_PRINT_STACK, BC_INST_CLEAR_STACK, BC_INST_INVALID, BC_INST_STACK_LEN, BC_INST_DUPLICATE, BC_INST_SWAP, BC_INST_POP, BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, #if BC_ENABLE_EXTRA_MATH BC_INST_INVALID, #endif // BC_ENABLE_EXTRA_MATH BC_INST_INVALID, BC_INST_INVALID, BC_INST_INVALID, BC_INST_PRINT_POP, BC_INST_NQUIT, BC_INST_EXEC_STACK_LEN, BC_INST_SCALE_FUNC, BC_INST_INVALID, }; #endif // DC_ENABLED #endif // !BC_ENABLE_LIBRARY #if BC_ENABLE_EXTRA_MATH /// A constant for the rand multiplier. const BcRandState bc_rand_multiplier = BC_RAND_MULTIPLIER; #endif // BC_ENABLE_EXTRA_MATH // clang-format off #if BC_LONG_BIT >= 64 /// A constant array for the max of a bigdig number as a BcDig array. const BcDig bc_num_bigdigMax[] = { 709551616U, 446744073U, 18U, }; /// A constant array for the max of 2 times a bigdig number as a BcDig array. const BcDig bc_num_bigdigMax2[] = { 768211456U, 374607431U, 938463463U, 282366920U, 340U, }; #else // BC_LONG_BIT >= 64 /// A constant array for the max of a bigdig number as a BcDig array. const BcDig bc_num_bigdigMax[] = { 7296U, 9496U, 42U, }; /// A constant array for the max of 2 times a bigdig number as a BcDig array. const BcDig bc_num_bigdigMax2[] = { 1616U, 955U, 737U, 6744U, 1844U, }; #endif // BC_LONG_BIT >= 64 // clang-format on /// The size of the bigdig max array. const size_t bc_num_bigdigMax_size = sizeof(bc_num_bigdigMax) / sizeof(BcDig); /// The size of the bigdig max times 2 array. const size_t bc_num_bigdigMax2_size = sizeof(bc_num_bigdigMax2) / sizeof(BcDig); /// A string of digits for easy conversion from characters to digits. const char bc_num_hex_digits[] = "0123456789ABCDEF"; // clang-format off /// An array for easy conversion from exponent to power of 10. const BcBigDig bc_num_pow10[BC_BASE_DIGS + 1] = { 1, 10, 100, 1000, 10000, #if BC_BASE_DIGS > 4 100000, 1000000, 10000000, 100000000, 1000000000, #endif // BC_BASE_DIGS > 4 }; // clang-format on #if !BC_ENABLE_LIBRARY /// An array of functions for binary operators corresponding to the order of /// the instructions for the operators. const BcNumBinaryOp bc_program_ops[] = { bc_num_pow, bc_num_mul, bc_num_div, bc_num_mod, bc_num_add, bc_num_sub, #if BC_ENABLE_EXTRA_MATH bc_num_places, bc_num_lshift, bc_num_rshift, #endif // BC_ENABLE_EXTRA_MATH }; /// An array of functions for binary operators allocation requests corresponding /// to the order of the instructions for the operators. const BcNumBinaryOpReq bc_program_opReqs[] = { bc_num_powReq, bc_num_mulReq, bc_num_divReq, bc_num_divReq, bc_num_addReq, bc_num_addReq, #if BC_ENABLE_EXTRA_MATH bc_num_placesReq, bc_num_placesReq, bc_num_placesReq, #endif // BC_ENABLE_EXTRA_MATH }; /// An array of unary operator functions corresponding to the order of the /// instructions. const BcProgramUnary bc_program_unarys[] = { bc_program_negate, bc_program_not, #if BC_ENABLE_EXTRA_MATH bc_program_trunc, #endif // BC_ENABLE_EXTRA_MATH }; /// A filename for when parsing expressions. const char bc_program_exprs_name[] = ""; /// A filename for when parsing stdin.. const char bc_program_stdin_name[] = ""; /// A ready message for SIGINT catching. const char bc_program_ready_msg[] = "ready for more input\n"; /// The length of the ready message. const size_t bc_program_ready_msg_len = sizeof(bc_program_ready_msg) - 1; /// A list of escape characters that a print statement should treat specially. const char bc_program_esc_chars[] = "ab\\efnqrt"; /// A list of characters corresponding to the escape characters above. const char bc_program_esc_seqs[] = "\a\b\\\\\f\n\"\r\t"; #endif // !BC_ENABLE_LIBRARY diff --git a/contrib/bc/tests/all.sh b/contrib/bc/tests/all.sh index 0ef8ae6cb49b..099804777c13 100755 --- a/contrib/bc/tests/all.sh +++ b/contrib/bc/tests/all.sh @@ -1,221 +1,246 @@ #! /bin/sh # # 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. # script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + print 'usage: %s [-n] dir [run_extra_tests] [run_stack_tests] [gen_tests] [run_problematic_tests] [time_tests] [exec args...]\n' \ + "$script" + exit 1 +} + # We need to figure out if we should run stuff in parallel. pll=1 while getopts "n" opt; do case "$opt" in n) pll=0 ; shift ; set -e ;; ?) usage "Invalid option: $opt" ;; esac done # Command-line processing. if [ "$#" -ge 1 ]; then d="$1" shift + check_d_arg "$d" else - err_exit "usage: $script [-n] dir [run_extra_tests] [run_stack_tests] [gen_tests] [run_problematic_tests] [time_tests] [exec args...]" 1 + usage "Not enough arguments" fi if [ "$#" -lt 1 ]; then extra=1 + check_bool_arg "$extra" else extra="$1" shift + check_bool_arg "$extra" fi if [ "$#" -lt 1 ]; then run_stack_tests=1 + check_bool_arg "$run_stack_tests" else run_stack_tests="$1" shift + check_bool_arg "$run_stack_tests" fi if [ "$#" -lt 1 ]; then generate_tests=1 + check_bool_arg "$generate_tests" else generate_tests="$1" shift + check_bool_arg "$generate_tests" fi if [ "$#" -lt 1 ]; then problematic_tests=1 + check_bool_arg "$problematic_tests" else problematic_tests="$1" shift + check_bool_arg "$problematic_tests" fi if [ "$#" -lt 1 ]; then time_tests=0 + check_bool_arg "$time_tests" else time_tests="$1" shift + check_bool_arg "$time_tests" fi if [ "$#" -lt 1 ]; then exe="$testdir/../bin/$d" + check_exec_arg "$exe" else exe="$1" shift + check_exec_arg "$exe" fi stars="***********************************************************************" printf '%s\n' "$stars" # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then halt="quit" else halt="q" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH # Get the list of tests that require extra math. extra_required=$(cat "$testdir/extra_required.txt") pids="" printf '\nRunning %s tests...\n\n' "$d" # Run the tests one at a time. while read t; do # If it requires extra, then skip if we don't have it. if [ "$extra" -eq 0 ]; then if [ -z "${extra_required##*$t*}" ]; then printf 'Skipping %s %s\n' "$d" "$t" continue fi fi if [ "$pll" -ne 0 ]; then sh "$testdir/test.sh" "$d" "$t" "$generate_tests" "$time_tests" "$exe" "$@" & pids="$pids $!" else sh "$testdir/test.sh" "$d" "$t" "$generate_tests" "$time_tests" "$exe" "$@" fi done < "$testdir/$d/all.txt" # stdin tests. if [ "$pll" -ne 0 ]; then sh "$testdir/stdin.sh" "$d" "$exe" "$@" & pids="$pids $!" else sh "$testdir/stdin.sh" "$d" "$exe" "$@" fi # Script tests. if [ "$pll" -ne 0 ]; then sh "$testdir/scripts.sh" "$d" "$extra" "$run_stack_tests" "$generate_tests" \ "$time_tests" "$exe" "$@" & pids="$pids $!" else sh "$testdir/scripts.sh" -n "$d" "$extra" "$run_stack_tests" "$generate_tests" \ "$time_tests" "$exe" "$@" fi # Read tests. if [ "$pll" -ne 0 ]; then sh "$testdir/read.sh" "$d" "$exe" "$@" & pids="$pids $!" else sh "$testdir/read.sh" "$d" "$exe" "$@" fi # Error tests. if [ "$pll" -ne 0 ]; then sh "$testdir/errors.sh" "$d" "$exe" "$@" & pids="$pids $!" else sh "$testdir/errors.sh" "$d" "$exe" "$@" fi # Test all the files in the errors directory. While the other error test (in # tests/errors.sh) does a test for every line, this does one test per file, but # it runs the file through stdin and as a file on the command-line. for testfile in $testdir/$d/errors/*.txt; do b=$(basename "$testfile") if [ "$pll" -ne 0 ]; then sh "$testdir/error.sh" "$d" "$b" "$problematic_tests" "$@" & pids="$pids $!" else sh "$testdir/error.sh" "$d" "$b" "$problematic_tests" "$@" fi done # Other tests. if [ "$pll" -ne 0 ]; then sh "$testdir/other.sh" "$d" "$extra" "$exe" "$@" & pids="$pids $!" else sh "$testdir/other.sh" "$d" "$extra" "$exe" "$@" fi if [ "$pll" -ne 0 ]; then exit_err=0 for p in $pids; do wait "$p" err="$?" if [ "$err" -ne 0 ]; then printf 'A test failed!\n' exit_err=1 fi done if [ "$exit_err" -ne 0 ]; then exit 1 fi fi printf '\nAll %s tests passed.\n' "$d" printf '\n%s\n' "$stars" diff --git a/contrib/bc/tests/bc/timeconst.sh b/contrib/bc/tests/bc/timeconst.sh index 3751700077f7..fbd2909e0992 100755 --- a/contrib/bc/tests/bc/timeconst.sh +++ b/contrib/bc/tests/bc/timeconst.sh @@ -1,115 +1,131 @@ #! /bin/sh # # 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. # # Tests the timeconst.bc script from the Linux kernel build. # You can find the script at kernel/time/timeconst.bc in any Linux repo. # One such repo is: https://github.com/torvalds/linux script="$0" testdir=$(dirname "$script") outputdir=${BC_TEST_OUTPUT_DIR:-$testdir/..} -# Gets the timeconst script, which could be a command-line argument. +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s [timeconst_script] [exec args...]\n' "$0" + exit 1 +} + +. "$testdir/../../scripts/functions.sh" + +# Gets the timeconst script, which could be a command-line argument. I don't +# need to check for error because we just skip if it doesn't work. if [ "$#" -gt 0 ]; then timeconst="$1" shift else timeconst="$testdir/scripts/timeconst.bc" fi # Gets the executable, which could also be a command-line argument. if [ "$#" -gt 0 ]; then bc="$1" shift + check_exec_arg "$bc" else bc="$testdir/../../bin/bc" + check_exec_arg "$bc" fi out1="$outputdir/bc_outputs/bc_timeconst.txt" out2="$outputdir/bc_outputs/bc_timeconst_results.txt" outdir=$(dirname "$out1") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi base=$(basename "$timeconst") # If the script does not exist, just skip. Running this test is not necessary. if [ ! -f "$timeconst" ]; then printf 'Warning: %s does not exist\n' "$timeconst" printf 'Skipping...\n' exit 0 fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH printf 'Running %s...' "$base" # Get a list of numbers. Funny how bc can help with that. nums=$(printf 'for (i = 0; i <= 1000; ++i) { i }\n' | bc) # Run each number through the script. for i in $nums; do # Run the GNU bc on the test. printf '%s\n' "$i" | bc -q "$timeconst" > "$out1" err="$?" # If the other bc failed, it's not GNU bc, or this bc. if [ "$err" -ne 0 ]; then printf '\nOther bc is not GNU compatible. Skipping...\n' exit 0 fi # Run the built bc on the test. printf '%s\n' "$i" | "$bc" "$@" -q "$timeconst" > "$out2" diff "$out1" "$out2" error="$?" # If fail, bail. if [ "$error" -ne 0 ]; then printf '\nFailed on input: %s\n' "$i" exit "$error" fi done rm -f "$out1" rm -f "$out2" exec printf 'pass\n' diff --git a/contrib/bc/tests/dc/scripts/easter.sh b/contrib/bc/tests/dc/scripts/easter.sh index 27dfe34580ea..1f8e7aa797fb 100755 --- a/contrib/bc/tests/dc/scripts/easter.sh +++ b/contrib/bc/tests/dc/scripts/easter.sh @@ -1,47 +1,93 @@ #!/bin/sh +# +# 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. +# + +set -e + +script="$0" + +testdir=$(dirname "${script}") + +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s dc_exec year [options...]\n' "$script" + exit 1 +} + +. "$testdir/../../../scripts/functions.sh" if test $# -lt 2 then - echo usage: $0 dc_exec year [options...] - exit 1 + usage "Not enough arguments; need 2" fi dc_exec="$1" shift +check_exec_arg "$dc_exec" year="$1" shift echo $year ' [ ddsf [ lfp [too early ]P q ]s@ 1583>@ ddd19%1+sg100/1+d3*4/12-sx8*5+25/5-sz5*4/lx-10-sdlg11*20+lz+lx-30% d [30+]s@ 0>@d [ [1+]s@ lg11<@ ]s@ 25=@d [1+]s@ 24=@se44le-d [30+]s@ 21>@dld+7%-7+ [March ]sm d [ 31- [April ]sm ]s@ 31<@psnlmPpsn1z>p ]sp lpx' | "$dc_exec" "$@" | tr '\012' ' ' echo '' diff --git a/contrib/bc/tests/error.sh b/contrib/bc/tests/error.sh index 35a6af0edf3f..11d7a8126a27 100755 --- a/contrib/bc/tests/error.sh +++ b/contrib/bc/tests/error.sh @@ -1,133 +1,144 @@ #! /bin/sh # # 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. # script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -lt 2 ]; then - +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi printf 'usage: %s dir test problematic_tests [exec args...]\n' "$script" exit 1 +} +# Command-line processing. +if [ "$#" -lt 3 ]; then + usage "Not enough arguments" else d="$1" shift + check_d_arg "$d" t="$1" shift problematic="$1" shift + check_bool_arg "$problematic" fi +testfile="$testdir/$d/errors/$t" +check_file_arg "$testfile" + if [ "$#" -lt 1 ]; then exe="$testdir/../bin/$d" else exe="$1" shift fi # Just skip tests that are problematic on FreeBSD. These tests can cause FreeBSD # to kill bc from memory exhaustion because of overcommit. if [ "$d" = "bc" ] && [ "$problematic" -eq 0 ]; then if [ "$t" = "33.txt" ]; then printf 'Skipping problematic %s error file %s...\n' "$d" "$t" exit 0 fi fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH out="$outputdir/${d}_outputs/error_results_${t}" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then opts="-l" halt="halt" read_call="read()" read_expr="${read_call}\n5+5;" else opts="-x" halt="q" fi -testfile="$testdir/$d/errors/$t" - printf 'Running %s error file %s with clamping...' "$d" "$t" printf '%s\n' "$halt" | "$exe" "$@" $opts -c "$testfile" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$testfile" "$out" "$exebase" > /dev/null printf 'pass\n' printf 'Running %s error file %s without clamping...' "$d" "$t" printf '%s\n' "$halt" | "$exe" "$@" $opts -C "$testfile" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$testfile" "$out" "$exebase" > /dev/null printf 'pass\n' printf 'Running %s error file %s through cat with clamping...' "$d" "$t" cat "$testfile" | "$exe" "$@" $opts -c 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$testfile" "$out" "$exebase" printf 'pass\n' printf 'Running %s error file %s through cat without clamping...' "$d" "$t" cat "$testfile" | "$exe" "$@" $opts -C 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$testfile" "$out" "$exebase" printf 'pass\n' diff --git a/contrib/bc/tests/errors.sh b/contrib/bc/tests/errors.sh index 5005f3e9aeb1..11d03299b418 100755 --- a/contrib/bc/tests/errors.sh +++ b/contrib/bc/tests/errors.sh @@ -1,149 +1,162 @@ #! /bin/sh # # 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. # # WARNING: Test files cannot have empty lines! script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -eq 0 ]; then +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi printf 'usage: %s dir [exec args...]\n' "$script" exit 1 +} + +# Command-line processing. +if [ "$#" -eq 0 ]; then + usage "Not enough arguments" else d="$1" shift + check_d_arg "$d" fi if [ "$#" -lt 1 ]; then exe="$testdir/../bin/$d" + check_exec_arg "$exe" else exe="$1" shift + check_exec_arg "$exe" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH out="$outputdir/${d}_outputs/errors_results.txt" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi exebase=$(basename "$exe") # These are the filenames for the extra tests. posix="posix_errors" read_errors="read_errors" # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then opts="-l" halt="halt" read_call="read()" read_expr="${read_call}\n5+5;" else opts="-x" halt="q" fi printf 'Running %s command-line error tests...' "$d" printf '%s\n' "$halt" | "$exe" "$@" -e "1+1" -f- -e "2+2" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "command-line -e test" "$out" "$exebase" printf '%s\n' "$halt" | "$exe" "$@" -e "1+1" -f- -f "$testdir/$d/decimal.txt" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "command-line -f test" "$out" "$exebase" printf 'pass\n' # Now test the error files in the standard tests directory. for testfile in $testdir/$d/*errors.txt; do if [ -z "${testfile##*$read_errors*}" ]; then # We don't test read errors here. Skip. continue fi # Test bc POSIX errors and warnings. if [ -z "${testfile##*$posix*}" ]; then # Just test warnings. line="last" printf '%s\n' "$line" | "$exe" "$@" "-lw" 2> "$out" > /dev/null err="$?" if [ "$err" -ne 0 ]; then die "$d" "returned an error ($err)" "POSIX warning" 1 fi checkerrtest "$d" "1" "$line" "$out" "$exebase" # Set the options for standard mode. options="-ls" else options="$opts" fi # Output something pretty. base=$(basename "$testfile") base="${base%.*}" printf 'Running %s %s...' "$d" "$base" # Test errors on each line of the file. Yes, each line has a separate error # case. while read -r line; do rm -f "$out" printf '%s\n' "$line" | "$exe" "$@" "$options" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$line" "$out" "$exebase" done < "$testfile" printf 'pass\n' done diff --git a/contrib/bc/tests/history.py b/contrib/bc/tests/history.py index b9acf73cb58d..ced05fe7219f 100755 --- a/contrib/bc/tests/history.py +++ b/contrib/bc/tests/history.py @@ -1,1157 +1,1157 @@ #! /usr/bin/python # # 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. # import os, sys import time import signal import traceback try: import pexpect except ImportError: print("Could not find pexpect. Skipping...") sys.exit(0) # Housekeeping. script = sys.argv[0] testdir = os.path.dirname(script) if "BC_TEST_OUTPUT_DIR" in os.environ: outputdir = os.environ["BC_TEST_OUTPUT_DIR"] else: outputdir = testdir prompt = ">>> " # This array is for escaping characters that are necessary to escape when # outputting to pexpect. Since pexpect takes regexes, these characters confuse # it unless we escape them. escapes = [ ']', '[', '+', ] # UTF-8 stress tests. utf8_stress1 = "ᆬḰ䋔䗅㜲ತ咡䒢岤䳰稨⣡嶣㷡嶏ⵐ䄺嵕ਅ奰痚㆜䊛拂䅙૩➋䛿ቬ竳Ϳᅠ❄产翷䮊௷Ỉ䷒䳜㛠➕傎ᗋᏯਕ䆐悙癐㺨" utf8_stress2 = "韠싧돳넨큚ꉿ뮴픷ꉲ긌�최릙걆鳬낽ꪁ퍼鈴핐黙헶ꪈ뮩쭀锻끥鉗겉욞며뛯꬐�ﻼ�度錐�" utf8_stress3 = "곻�䣹昲蜴Ὓ桢㎏⚦珢畣갴ﭱ鶶ๅ⶛뀁彻ꖒ䔾ꢚﱤ햔햞㐹�鼳뵡▿ⶾ꠩�纞⊐佧�ⵟ霘紳㱔籠뎼⊓搧硤" utf8_stress4 = "ᄀ𖢾🏴��" # An easy array for UTF-8 tests. utf8_stress_strs = [ utf8_stress1, utf8_stress2, utf8_stress3, utf8_stress4, ] def expect(child, data): child.expect(data) # Eats all of the child's data. # @param child The child whose data should be eaten. def eat(child): while child.buffer is not None and len(child.buffer) > 0: expect(child, ".+") # Send data to a child. This makes sure the buffers are empty first. # @param child The child to send data to. # @param data The data to send. def send(child, data): eat(child) child.send(data) def wait(child): if child.isalive(): child.sendeof() time.sleep(1) if child.isalive(): child.kill(signal.SIGTERM) time.sleep(1) if child.isalive(): child.kill(signal.SIGKILL) child.wait() # Check that the child output the expected line. If history is false, then # the output should change. def check_line(child, expected, prompt=">>> ", history=True): send(child, "\n") prefix = "\r\n" if history else "" expect(child, prefix + expected + "\r\n" + prompt) # Write a string to output, checking all of the characters are output, # one-by-one. def write_str(child, s): for c in s: send(child, c) if c in escapes: expect(child, "\\{}".format(c)) else: expect(child, c) # Check the bc banner. # @param child The child process. def bc_banner(child): bc_banner1 = "bc [0-9]+\.[0-9]+\.[0-9]+\r\n" bc_banner2 = "Copyright \(c\) 2018-[2-9][0-9][0-9][0-9] Gavin D. Howard and contributors\r\n" - bc_banner3 = "Report bugs at: https://git.yzena.com/gavin/bc\r\n\r\n" + bc_banner3 = "Report bugs at: https://git.gavinhoward.com/gavin/bc\r\n\r\n" bc_banner4 = "This is free software with ABSOLUTELY NO WARRANTY.\r\n\r\n" expect(child, bc_banner1) expect(child, bc_banner2) expect(child, bc_banner3) expect(child, bc_banner4) expect(child, prompt) # Common UTF-8 testing function. The index is the index into utf8_stress_strs # for which stress string to use. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. # @param idx The index of the UTF-8 stress string. def test_utf8(exe, args, env, idx, bc=True): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env, encoding='utf-8', codec_errors='ignore') try: # Write the stress string. send(child, utf8_stress_strs[idx]) send(child, "\n") if bc: send(child, "quit") else: send(child, "q") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # A random UTF-8 test with insert. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_utf8_0(exe, args, env, bc=True): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env, encoding='utf-8', codec_errors='ignore') try: # Just random UTF-8 I generated somewhow, plus ensuring that insert works. write_str(child, "ﴪáá̵̗🈐ã") send(child, "\x1b[D\x1b[D\x1b[D\x1b\x1b[Aℐ") send(child, "\n") if bc: send(child, "quit") else: send(child, "q") send(child, "\n") eat(child) wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child def test_utf8_1(exe, args, env, bc=True): return test_utf8(exe, args, env, 0, bc) def test_utf8_2(exe, args, env, bc=True): return test_utf8(exe, args, env, 1, bc) def test_utf8_3(exe, args, env, bc=True): return test_utf8(exe, args, env, 2, bc) def test_utf8_4(exe, args, env, bc=True): return test_utf8(exe, args, env, 3, bc) # This tests a SIGINT with reset followed by a SIGQUIT. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_sigint_sigquit(exe, args, env): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env) try: send(child, "\t") expect(child, "\t") send(child, "\x03") # send(child, "\x1c") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Test for EOF. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_eof(exe, args, env): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env) try: send(child, "123") expect(child, "123") send(child, "\x01") send(child, "\x04") send(child, "\x04") send(child, "\x04") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Test for quiting SIGINT. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_sigint(exe, args, env): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" env["BC_SIGINT_RESET"] = "0" env["DC_SIGINT_RESET"] = "0" child = pexpect.spawn(exe, args=args, env=env) try: send(child, "\t") expect(child, "\t") send(child, "\x03") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Test for SIGTSTP. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_sigtstp(exe, args, env): # This test does not work on FreeBSD, so skip. if sys.platform.startswith("freebsd"): sys.exit(0) # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env) try: send(child, "\t") expect(child, "\t") send(child, "\x13") time.sleep(1) if not child.isalive(): print("child exited early") print(str(child)) print(str(child.buffer)) sys.exit(1) child.kill(signal.SIGCONT) send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Test for SIGSTOP. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_sigstop(exe, args, env): # Because both bc and dc use this, make sure the banner doesn't pop. env["BC_BANNER"] = "0" child = pexpect.spawn(exe, args=args, env=env) try: send(child, "\t") expect(child, "\t") send(child, "\x14") time.sleep(1) if not child.isalive(): print("child exited early") print(str(child)) print(str(child.buffer)) sys.exit(1) send(child, "\x13") time.sleep(1) if not child.isalive(): print("child exited early") print(str(child)) print(str(child.buffer)) sys.exit(1) child.kill(signal.SIGCONT) send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child def test_bc_utf8_0(exe, args, env): return test_utf8_0(exe, args, env, True) def test_bc_utf8_1(exe, args, env): return test_utf8_1(exe, args, env, True) def test_bc_utf8_2(exe, args, env): return test_utf8_2(exe, args, env, True) def test_bc_utf8_3(exe, args, env): return test_utf8_3(exe, args, env, True) def test_bc_utf8_4(exe, args, env): return test_utf8_4(exe, args, env, True) # Basic bc test. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc1(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) write_str(child, "1") check_line(child, "1") write_str(child, "1") check_line(child, "1") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # SIGINT with no history. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc2(exe, args, env): env["TERM"] = "dumb" child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) child.sendline("1") check_line(child, "1", history=False) time.sleep(1) child.sendintr() child.sendline("quit") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Left and right arrows. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc3(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1b[D\x1b[D\x1b[C\x1b[C") send(child, "\n") expect(child, prompt) send(child, "12\x1b[D3\x1b[C4\x1bOD5\x1bOC6") send(child, "\n") check_line(child, "132546") send(child, "12\x023\x064") send(child, "\n") check_line(child, "1324") send(child, "12\x1b[H3\x1bOH\x01\x1b[H45\x1bOF6\x05\x1b[F7\x1bOH8") send(child, "\n") check_line(child, "84531267") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Up and down arrows. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc4(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1b[A\x1bOA\x1b[B\x1bOB") send(child, "\n") expect(child, prompt) write_str(child, "15") check_line(child, "15") write_str(child, "2^16") check_line(child, "65536") send(child, "\x1b[A\x1bOA") send(child, "\n") check_line(child, "15") send(child, "\x1b[A\x1bOA\x1b[A\x1b[B") check_line(child, "65536") send(child, "\x1b[A\x1bOA\x0e\x1b[A\x1b[A\x1b[A\x1b[B\x10\x1b[B\x1b[B\x1bOB\x1b[B\x1bOA") send(child, "\n") check_line(child, "65536") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Clear screen. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc5(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x0c") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Printed material without a newline. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc6(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "print \"Enter number: \"") send(child, "\n") expect(child, "Enter number: ") send(child, "4\x1b[A\x1b[A") send(child, "\n") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Word start and word end. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc7(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1bb\x1bb\x1bf\x1bf") send(child, "\n") expect(child, prompt) send(child, "\x1b[0~\x1b[3a") send(child, "\n") expect(child, prompt) send(child, "\x1b[0;4\x1b[0A") send(child, "\n") expect(child, prompt) send(child, "\t") send(child, "\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb") send(child, "\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf") send(child, "\n") expect(child, prompt) write_str(child, "12 + 34 + 56 + 78 + 90") check_line(child, "270") send(child, "\x1b[A") send(child, "\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb\x1bb") send(child, "\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf\x1bf") check_line(child, "270") send(child, "\x1b[A") send(child, "\x1bh\x1bh\x1bf + 14 ") send(child, "\n") check_line(child, "284") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Backspace. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc8(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "12\x1b[D3\x1b[C4\x08\x7f") send(child, "\n") check_line(child, "13") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Backspace and delete words. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc9(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1b[0;5D\x1b[0;5D\x1b[0;5D\x1b[0;5C\x1b[0;5D\x1bd\x1b[3~\x1b[d\x1b[d\x1b[d\x1b[d\x7f\x7f\x7f") send(child, "\n") expect(child, prompt) write_str(child, "12 + 34 + 56 + 78 + 90") check_line(child, "270") send(child, "\x1b[A") send(child, "\x1b[0;5D\x1b[0;5D\x1b[0;5D\x1b[0;5C\x1b[0;5D\x1bd\x1b[3~\x1b[d\x1b[d\x1b[d\x1b[d\x7f\x7f\x7f") send(child, "\n") check_line(child, "102") send(child, "\x1b[A") send(child, "\x17\x17") send(child, "\n") check_line(child, "46") send(child, "\x17\x17") send(child, "\n") expect(child, prompt) send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Backspace and delete words 2. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc10(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1b[3~\x1b[3~") send(child, "\n") expect(child, prompt) send(child, " \x1b[3~\x1b[3~") send(child, "\n") expect(child, prompt) write_str(child, "12 + 34 + 56 + 78 + 90") check_line(child, "270") send(child, "\x1b[A\x1b[A\x1b[A\x1b[B\x1b[B\x1b[B\x1b[A") send(child, "\n") check_line(child, "270") send(child, "\x1b[A\x1b[0;5D\x1b[0;5D\x0b") send(child, "\n") check_line(child, "180") send(child, "\x1b[A\x1521") check_line(child, "21") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Swap. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc11(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "\x1b[A\x02\x14") send(child, "\n") expect(child, prompt) write_str(child, "12 + 34 + 56 + 78") check_line(child, "180") send(child, "\x1b[A\x02\x14") check_line(child, "189") send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Non-fatal error. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_bc12(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: bc_banner(child) send(child, "12 +") send(child, "\n") time.sleep(1) if not child.isalive(): print("child exited early") print(str(child)) print(str(child.buffer)) sys.exit(1) send(child, "quit") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child def test_dc_utf8_0(exe, args, env): return test_utf8_0(exe, args, env, False) def test_dc_utf8_1(exe, args, env): return test_utf8_1(exe, args, env, False) def test_dc_utf8_2(exe, args, env): return test_utf8_2(exe, args, env, False) def test_dc_utf8_3(exe, args, env): return test_utf8_3(exe, args, env, False) def test_dc_utf8_4(exe, args, env): return test_utf8_4(exe, args, env, False) # Basic dc test. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_dc1(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: write_str(child, "1pR") check_line(child, "1") write_str(child, "1pR") check_line(child, "1") write_str(child, "q") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # SIGINT with quit. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_dc2(exe, args, env): env["TERM"] = "dumb" child = pexpect.spawn(exe, args=args, env=env) try: child.sendline("1pR") check_line(child, "1", history=False) time.sleep(1) child.sendintr() child.sendline("q") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # Execute string. # @param exe The executable. # @param args The arguments to pass to the executable. # @param env The environment. def test_dc3(exe, args, env): child = pexpect.spawn(exe, args=args, env=env) try: write_str(child, "[1 15+pR]x") check_line(child, "16") write_str(child, "1pR") check_line(child, "1") write_str(child, "q") send(child, "\n") wait(child) except pexpect.TIMEOUT: traceback.print_tb(sys.exc_info()[2]) print("timed out") print(str(child)) sys.exit(2) except pexpect.EOF: print("EOF") print(str(child)) print(str(child.buffer)) print(str(child.before)) sys.exit(2) return child # The array of bc tests. bc_tests = [ test_bc_utf8_0, test_bc_utf8_1, test_bc_utf8_2, test_bc_utf8_3, test_bc_utf8_4, test_sigint_sigquit, test_eof, test_sigint, test_sigtstp, test_sigstop, test_bc1, test_bc2, test_bc3, test_bc4, test_bc5, test_bc6, test_bc7, test_bc8, test_bc9, test_bc10, test_bc11, test_bc12, ] # The array of dc tests. dc_tests = [ test_dc_utf8_0, test_dc_utf8_1, test_dc_utf8_2, test_dc_utf8_3, test_dc_utf8_4, test_sigint_sigquit, test_eof, test_sigint, test_dc1, test_dc2, test_dc3, ] # Print the usage and exit with an error. def usage(): print("usage: {} [-t] dir [-a] test_idx [exe options...]".format(script)) print(" The valid values for dir are: 'bc' and 'dc'.") print(" The max test_idx for bc is {}.".format(len(bc_tests) - 1)) print(" The max test_idx for dc is {}.".format(len(dc_tests) - 1)) print(" If -a is given, the number of tests for dir is printed.") print(" No tests are run.") sys.exit(1) # Must run this script alone. if __name__ != "__main__": usage() if len(sys.argv) < 2: usage() idx = 1 exedir = sys.argv[idx] idx += 1 if exedir == "-t": do_test = True exedir = sys.argv[idx] idx += 1 else: do_test = False test_idx = sys.argv[idx] idx += 1 if test_idx == "-a": if exedir == "bc": l = len(bc_tests) else: l = len(dc_tests) print("{}".format(l)) sys.exit(0) test_idx = int(test_idx) # Set a default executable unless we have one. if len(sys.argv) >= idx + 1: exe = sys.argv[idx] else: exe = testdir + "/../bin/" + exedir exebase = os.path.basename(exe) # Use the correct options. if exebase == "bc": halt = "halt\n" options = "-l" test_array = bc_tests else: halt = "q\n" options = "-x" test_array = dc_tests # More command-line processing. if len(sys.argv) > idx + 1: exe = [ exe, sys.argv[idx + 1:], options ] else: exe = [ exe, options ] # This is the environment necessary for most tests. env = { "BC_BANNER": "1", "BC_PROMPT": "1", "DC_PROMPT": "1", "BC_TTY_MODE": "1", "DC_TTY_MODE": "1", "BC_SIGINT_RESET": "1", "DC_SIGINT_RESET": "1", } # Make sure to include the outside environment. env.update(os.environ) env.pop("BC_ENV_ARGS", None) env.pop("BC_LINE_LENGTH", None) env.pop("DC_ENV_ARGS", None) env.pop("DC_LINE_LENGTH", None) # Run the correct test. child = test_array[test_idx](exe[0], exe[1:], env) child.close() exit = child.exitstatus if exit is not None and exit != 0: print("child failed; expected exit code 0, got {}".format(exit)) print(str(child)) sys.exit(1) diff --git a/contrib/bc/tests/history.sh b/contrib/bc/tests/history.sh index ff4ffa562ca8..e68d568dcec1 100755 --- a/contrib/bc/tests/history.sh +++ b/contrib/bc/tests/history.sh @@ -1,110 +1,126 @@ #! /bin/sh # # 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. # script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" -# usage: history.sh dir -a|idx [exe args...] +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s dir -a|idx [exe args...]\n' "$script" + exit 1 +} # If Python does not exist, then just skip. py=$(command -v python3) err=$? if [ "$err" -ne 0 ]; then py=$(command -v python) err=$? if [ "$err" -ne 0 ]; then printf 'Could not find Python 3.\n' printf 'Skipping %s history tests...\n' "$d" exit 0 fi fi +if [ "$#" -lt 2 ]; then + usage "Not enough arguments; expect 2 arguments" +fi + # d is "bc" or "dc" d="$1" shift +check_d_arg "$d" # idx is either an index of the test to run or "-a". If it is "-a", then all # tests are run. idx="$1" shift if [ "$#" -gt 0 ]; then # exe is the executable to run. exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" + check_exec_arg "$exe" fi if [ "$d" = "bc" ]; then flip="! %s" addone="%s + 1" else flip="%s Np" addone="%s 1+p" fi # Set the test range correctly for all tests or one test. st is the start index. if [ "$idx" = "-a" ]; then idx=$("$py" "$testdir/history.py" "$d" -a) idx=$(printf '%s - 1\n' "$idx" | bc) st=0 else st="$idx" fi # Run all of the tests. for i in $(seq "$st" "$idx"); do printf 'Running %s history test %d...' "$d" "$i" for j in $(seq 1 5); do "$py" "$testdir/history.py" "$d" "$i" "$exe" "$@" err="$?" if [ "$err" -eq 0 ]; then break fi done checktest_retcode "$d" "$err" "$d history test $i" printf 'pass\n' done diff --git a/contrib/bc/tests/other.sh b/contrib/bc/tests/other.sh index fe228eec3317..4f491a64c770 100755 --- a/contrib/bc/tests/other.sh +++ b/contrib/bc/tests/other.sh @@ -1,548 +1,563 @@ #! /bin/sh # # 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. # set -e script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s dir extra_math [exec args...]\n' "$script" + exit 1 +} + # Command-line processing. if [ "$#" -ge 2 ]; then d="$1" shift + check_d_arg "$d" extra_math="$1" shift + check_bool_arg "$extra_math" else - err_exit "usage: $script dir extra_math [exec args...]" 1 + usage "Not enough arguments; need 2" fi if [ "$#" -lt 1 ]; then exe="$testdir/../bin/$d" + check_exec_arg "$exe" else exe="$1" shift + check_exec_arg "$exe" fi if [ "$d" = "bc" ]; then halt="quit" else halt="q" fi mkdir -p "$outputdir" # For tests later. num=100000000000000000000000000000000000000000000000000000000000000000000000000000 num2="$num" numres="$num" num70="10000000000000000000000000000000000000000000000000000000000000000000\\ 0000000000" # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then halt="halt" opt="x" lopt="extended-register" line_var="BC_LINE_LENGTH" lltest="line_length()" else halt="q" opt="l" lopt="mathlib" line_var="DC_LINE_LENGTH" num="$num pR" lltest="glpR" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH set +e printf '\nRunning %s quit test...' "$d" printf '%s\n' "$halt" | "$exe" "$@" > /dev/null 2>&1 checktest_retcode "$d" "$?" "quit" # bc has two halt or quit commands, so test the second as well. if [ "$d" = bc ]; then printf '%s\n' "quit" | "$exe" "$@" > /dev/null 2>&1 checktest_retcode "$d" "$?" quit two=$("$exe" "$@" -e 1+1 -e quit) checktest_retcode "$d" "$?" quit if [ "$two" != "2" ]; then err_exit "$d failed test quit" 1 fi fi printf 'pass\n' base=$(basename "$exe") printf 'Running %s environment var tests...' "$d" if [ "$d" = "bc" ]; then export BC_ENV_ARGS=" '-l' '' -q" printf 's(.02893)\n' | "$exe" "$@" > /dev/null checktest_retcode "$d" "$?" "environment var" printf 'halt\n' | "$exe" "$@" -e 4 > /dev/null err="$?" checktest_retcode "$d" "$?" "environment var" printf 'pass\n' printf 'Running keyword redefinition test...' unset BC_ENV_ARGS redefine_res="$outputdir/bc_outputs/redefine.txt" redefine_out="$outputdir/bc_outputs/redefine_results.txt" outdir=$(dirname "$redefine_out") if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi printf '5\n0\n' > "$redefine_res" printf 'halt\n' | "$exe" "$@" --redefine=print -e 'define print(x) { x }' -e 'print(5)' > "$redefine_out" err="$?" checktest "$d" "$err" "keyword redefinition" "$redefine_res" "$redefine_out" printf 'halt\n' | "$exe" "$@" -r "abs" -r "else" -e 'abs = 5;else = 0' -e 'abs;else' > "$redefine_out" err="$?" checktest "$d" "$err" "keyword redefinition" "$redefine_res" "$redefine_out" if [ "$extra_math" -ne 0 ]; then printf 'halt\n' | "$exe" "$@" -lr abs -e "perm(5, 1)" -e "0" > "$redefine_out" err="$?" checktest "$d" "$err" "keyword not redefined in builtin library" "$redefine_res" "$redefine_out" fi "$exe" "$@" -r "break" -e 'define break(x) { x }' 2> "$redefine_out" err="$?" checkerrtest "$d" "$err" "keyword redefinition error" "$redefine_out" "$d" "$exe" "$@" -e 'define read(x) { x }' 2> "$redefine_out" err="$?" checkerrtest "$d" "$err" "Keyword redefinition error without BC_REDEFINE_KEYWORDS" "$redefine_out" "$d" printf 'pass\n' printf 'Running multiline comment expression file test...' multiline_expr_res="" multiline_expr_out="$outputdir/bc_outputs/multiline_expr_results.txt" # tests/bc/misc1.txt happens to have a multiline comment in it. printf 'halt\n' | "$exe" "$@" -f "$testdir/bc/misc1.txt" > "$multiline_expr_out" err="$?" checktest "$d" "$err" "multiline comment in expression file" "$testdir/bc/misc1_results.txt" \ "$multiline_expr_out" printf 'pass\n' printf 'Running multiline comment expression file error test...' printf 'halt\n' | "$exe" "$@" -f "$testdir/bc/errors/05.txt" 2> "$multiline_expr_out" err="$?" checkerrtest "$d" "$err" "multiline comment in expression file error" \ "$multiline_expr_out" "$d" printf 'pass\n' printf 'Running multiline string expression file test...' # tests/bc/strings.txt happens to have a multiline string in it. printf 'halt\n' | "$exe" "$@" -f "$testdir/bc/strings.txt" > "$multiline_expr_out" err="$?" checktest "$d" "$err" "multiline string in expression file" "$testdir/bc/strings_results.txt" \ "$multiline_expr_out" printf 'pass\n' printf 'Running multiline string expression file error test...' printf 'halt\n' | "$exe" "$@" -f "$testdir/bc/errors/16.txt" 2> "$multiline_expr_out" err="$?" checkerrtest "$d" "$err" "multiline string in expression file with backslash error" \ "$multiline_expr_out" "$d" printf 'halt\n' | "$exe" "$@" -f "$testdir/bc/errors/04.txt" 2> "$multiline_expr_out" err="$?" checkerrtest "$d" "$err" "multiline string in expression file error" \ "$multiline_expr_out" "$d" printf 'pass\n' else export DC_ENV_ARGS="'-x'" export DC_EXPR_EXIT="1" printf '4s stuff\n' | "$exe" "$@" > /dev/null checktest_retcode "$d" "$?" "environment var" "$exe" "$@" -e 4pR > /dev/null checktest_retcode "$d" "$?" "environment var" printf 'pass\n' set +e # dc has an extra test for a case that someone found running this easter.dc # script. It went into an infinite loop, so we want to check that we did not # regress. printf 'three\n' | cut -c1-3 > /dev/null err=$? if [ "$err" -eq 0 ]; then printf 'Running dc Easter script...' easter_res="$outputdir/dc_outputs/easter.txt" easter_out="$outputdir/dc_outputs/easter_results.txt" outdir=$(dirname "$easter_out") if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi printf '4 April 2021\n' > "$easter_res" "$testdir/dc/scripts/easter.sh" "$exe" 2021 "$@" | cut -c1-12 > "$easter_out" err="$?" checktest "$d" "$err" "Easter script" "$easter_res" "$easter_out" printf 'pass\n' fi fi out1="$outputdir/${d}_outputs/${d}_other.txt" out2="$outputdir/${d}_outputs/${d}_other_test.txt" printf 'Running %s line length tests...' "$d" printf '%s\n' "$numres" > "$out1" export "$line_var"=80 printf '%s\n' "$num" | "$exe" "$@" > "$out2" checktest "$d" "$?" "line length" "$out1" "$out2" printf '%s\n' "$num70" > "$out1" export "$line_var"=2147483647 printf '%s\n' "$num" | "$exe" "$@" > "$out2" checktest "$d" "$?" "line length 2" "$out1" "$out2" printf '%s\n' "$num2" > "$out1" export "$line_var"=62 printf '%s\n' "$num" | "$exe" "$@" -L > "$out2" checktest "$d" "$?" "line length 3" "$out1" "$out2" printf '0\n' > "$out1" printf '%s\n' "$lltest" | "$exe" "$@" -L > "$out2" checktest "$d" "$?" "line length 3" "$out1" "$out2" printf 'pass\n' printf '%s\n' "$numres" > "$out1" export "$line_var"=2147483647 printf 'Running %s arg tests...' "$d" f="$testdir/$d/add.txt" exprs=$(cat "$f") results=$(cat "$testdir/$d/add_results.txt") printf '%s\n%s\n%s\n%s\n' "$results" "$results" "$results" "$results" > "$out1" "$exe" "$@" -e "$exprs" -f "$f" --expression "$exprs" --file "$f" -e "$halt" > "$out2" checktest "$d" "$?" "arg" "$out1" "$out2" printf '%s\n' "$halt" | "$exe" "$@" -- "$f" "$f" "$f" "$f" > "$out2" checktest "$d" "$?" "arg" "$out1" "$out2" if [ "$d" = "bc" ]; then printf '%s\n' "$halt" | "$exe" "$@" -i > /dev/null 2>&1 fi printf '%s\n' "$halt" | "$exe" "$@" -h > /dev/null checktest_retcode "$d" "$?" "arg" printf '%s\n' "$halt" | "$exe" "$@" -P > /dev/null checktest_retcode "$d" "$?" "arg" printf '%s\n' "$halt" | "$exe" "$@" -R > /dev/null checktest_retcode "$d" "$?" "arg" printf '%s\n' "$halt" | "$exe" "$@" -v > /dev/null checktest_retcode "$d" "$?" "arg" printf '%s\n' "$halt" | "$exe" "$@" -V > /dev/null checktest_retcode "$d" "$?" "arg" out=$(printf '0.1\n-0.1\n1.1\n-1.1\n0.1\n-0.1\n') printf '%s\n' "$out" > "$out1" if [ "$d" = "bc" ]; then data=$(printf '0.1\n-0.1\n1.1\n-1.1\n.1\n-.1\n') else data=$(printf '0.1pR\n_0.1pR\n1.1pR\n_1.1pR\n.1pR\n_.1pR\n') fi printf '%s\n' "$data" | "$exe" "$@" -z > "$out2" checktest "$d" "$?" "leading zero" "$out1" "$out2" if [ "$d" = "bc" ] && [ "$extra_math" -ne 0 ]; then printf '%s\n' "$halt" | "$exe" "$@" -lz "$testdir/bc/leadingzero.txt" > "$out2" checktest "$d" "$?" "leading zero script" "$testdir/bc/leadingzero_results.txt" "$out2" fi "$exe" "$@" -f "saotehasotnehasthistohntnsahxstnhalcrgxgrlpyasxtsaosysxsatnhoy.txt" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "invalid file argument" "$out2" "$d" "$exe" "$@" "-$opt" -e "$exprs" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "invalid option argument" "$out2" "$d" "$exe" "$@" "--$lopt" -e "$exprs" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "invalid long option argument" "$out2" "$d" "$exe" "$@" "-u" -e "$exprs" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "unrecognized option argument" "$out2" "$d" "$exe" "$@" "--uniform" -e "$exprs" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "unrecognized long option argument" "$out2" "$d" "$exe" "$@" -f > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "missing required argument to short option" "$out2" "$d" "$exe" "$@" --file > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "missing required argument to long option" "$out2" "$d" "$exe" "$@" --version=5 > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "given argument to long option with no argument" "$out2" "$d" "$exe" "$@" -: > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "colon short option" "$out2" "$d" "$exe" "$@" --: > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "colon long option" "$out2" "$d" printf 'pass\n' printf 'Running %s builtin variable arg tests...' "$d" if [ "$extra_math" -ne 0 ]; then out=$(printf '14\n15\n16\n17.25\n') printf '%s\n' "$out" > "$out1" if [ "$d" = "bc" ]; then data=$(printf 's=scale;i=ibase;o=obase;t=seed@2;ibase=A;obase=A;s;i;o;t;') else data=$(printf 'J2@OIKAiAopRpRpRpR') fi printf '%s\n' "$data" | "$exe" "$@" -S14 -I15 -O16 -E17.25 > "$out2" checktest "$d" "$?" "builtin variable args" "$out1" "$out2" printf '%s\n' "$data" | "$exe" "$@" --scale=14 --ibase=15 --obase=16 --seed=17.25 > "$out2" checktest "$d" "$?" "builtin variable long args" "$out1" "$out2" else out=$(printf '14\n15\n16\n') printf '%s\n' "$out" > "$out1" if [ "$d" = "bc" ]; then data=$(printf 's=scale;i=ibase;o=obase;ibase=A;obase=A;s;i;o;') else data=$(printf 'OIKAiAopRpRpR') fi printf '%s\n' "$data" | "$exe" "$@" -S14 -I15 -O16 > "$out2" checktest "$d" "$?" "builtin variable args" "$out1" "$out2" printf '%s\n' "$data" | "$exe" "$@" --scale=14 --ibase=15 --obase=16 > "$out2" checktest "$d" "$?" "builtin variable long args" "$out1" "$out2" fi if [ "$d" = "bc" ]; then out=$(printf '100\n') printf '%s\n' "$out" > "$out1" printf 'scale\n' | "$exe" "$@" -S100 -l > "$out2" checktest "$d" "$?" "builtin variable args with math lib" "$out1" "$out2" printf 'scale\n' | "$exe" "$@" --scale=100 --mathlib > "$out2" checktest "$d" "$?" "builtin variable long args with math lib" "$out1" "$out2" export BC_ENV_ARGS="-l" printf 'scale\n' | "$exe" "$@" -S100 > "$out2" checktest "$d" "$?" "builtin variable args with math lib env arg" "$out1" "$out2" printf 'scale\n' | "$exe" "$@" --scale=100 > "$out2" checktest "$d" "$?" "builtin variable long args with math lib env arg" "$out1" "$out2" export BC_ENV_ARGS="-S100" printf 'scale\n' | "$exe" "$@" -l > "$out2" checktest "$d" "$?" "builtin variable args with math lib arg" "$out1" "$out2" export BC_ENV_ARGS="--scale=100" printf 'scale\n' | "$exe" "$@" -l > "$out2" checktest "$d" "$?" "builtin variable long args with math lib arg" "$out1" "$out2" fi printf 'scale\n' | "$exe" "$@" --scale=18923c.rlg > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "invalid command-line arg for builtin variable" "$out2" "$d" if [ "$extra_math" -ne 0 ]; then printf 'seed\n' | "$exe" "$@" --seed=18923c.rlg > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "invalid command-line arg for seed" "$out2" "$d" fi printf 'pass\n' printf 'Running %s directory test...' "$d" "$exe" "$@" "$testdir" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "directory" "$out2" "$d" printf 'pass\n' printf 'Running %s binary file test...' "$d" bin="/bin/sh" "$exe" "$@" "$bin" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "binary file" "$out2" "$d" printf 'pass\n' printf 'Running %s binary stdin test...' "$d" cat "$bin" | "$exe" "$@" > /dev/null 2> "$out2" err="$?" checkerrtest "$d" "$err" "binary stdin" "$out2" "$d" printf 'pass\n' if [ "$d" = "bc" ]; then printf 'Running %s limits tests...' "$d" printf 'limits\n' | "$exe" "$@" /dev/null > "$out2" 2>&1 checktest_retcode "$d" "$?" "limits" if [ ! -s "$out2" ]; then err_exit "$d did not produce output on the limits test" 1 fi exec printf 'pass\n' fi diff --git a/contrib/bc/tests/read.sh b/contrib/bc/tests/read.sh index a5c66d9d4fec..d7be18fdcecb 100755 --- a/contrib/bc/tests/read.sh +++ b/contrib/bc/tests/read.sh @@ -1,140 +1,153 @@ #! /bin/sh # # 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. # set -e script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -lt 1 ]; then - printf 'usage: %s dir [exe [args...]]\n' "$0" +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s dir [exe [args...]]\n' "$script" printf 'valid dirs are:\n' printf '\n' cat "$testdir/all.txt" printf '\n' exit 1 +} + +# Command-line processing. +if [ "$#" -lt 1 ]; then + usage "Not enough arguments" fi d="$1" shift +check_d_arg "$d" if [ "$#" -gt 0 ]; then exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" + check_exec_arg "$exe" fi name="$testdir/$d/read.txt" results="$testdir/$d/read_results.txt" errors="$testdir/$d/read_errors.txt" out="$outputdir/${d}_outputs/read_results.txt" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi exebase=$(basename "$exe") # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then options="-lq" halt="halt" read_call="read()" read_expr="${read_call}\n5+5;" else options="-x" halt="q" read_call="?" read_expr="${read_call}" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH printf 'Running %s read...' "$d" set +e # Run read() on every line. while read line; do printf '%s\n%s\n' "$read_call" "$line" | "$exe" "$@" "$options" > "$out" checktest "$d" "$?" 'read' "$results" "$out" done < "$name" printf 'pass\n' printf 'Running %s read errors...' "$d" # Run read on every line. while read line; do printf '%s\n%s\n' "$read_call" "$line" | "$exe" "$@" "$options" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$line" "$out" "$exebase" done < "$errors" printf 'pass\n' printf 'Running %s empty read...' "$d" read_test=$(printf '%s\n' "$read_call") printf '%s\n' "$read_test" | "$exe" "$@" "$opts" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$read_test" "$out" "$exebase" printf 'pass\n' printf 'Running %s read EOF...' "$d" read_test=$(printf '%s' "$read_call") printf '%s' "$read_test" | "$exe" "$@" "$opts" 2> "$out" > /dev/null err="$?" checkerrtest "$d" "$err" "$read_test" "$out" "$exebase" exec printf 'pass\n' diff --git a/contrib/bc/tests/script.sh b/contrib/bc/tests/script.sh index d720878fafa3..460940a21388 100755 --- a/contrib/bc/tests/script.sh +++ b/contrib/bc/tests/script.sh @@ -1,200 +1,221 @@ #! /bin/sh # # 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. # set -e script="$0" testdir=$(dirname "${script}") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -lt 2 ]; then +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi printf 'usage: %s dir script [run_extra_tests] [run_stack_tests] [generate_tests] [time_tests] [exec args...]\n' "$script" exit 1 +} + +# Command-line processing. +if [ "$#" -lt 2 ]; then + usage "Not enough arguments; expect 2 arguments" fi d="$1" shift +check_d_arg "$d" + +scriptdir="$testdir/$d/scripts" f="$1" shift +check_file_arg "$scriptdir/$f" if [ "$#" -gt 0 ]; then run_extra_tests="$1" shift + check_bool_arg "$run_extra_tests" else run_extra_tests=1 + check_bool_arg "$run_extra_tests" fi if [ "$#" -gt 0 ]; then run_stack_tests="$1" shift + check_bool_arg "$run_stack_tests" else run_stack_tests=1 + check_bool_arg "$run_stack_tests" fi if [ "$#" -gt 0 ]; then generate="$1" shift + check_bool_arg "$generate" else generate=1 + check_bool_arg "$generate" fi if [ "$#" -gt 0 ]; then time_tests="$1" shift + check_bool_arg "$time_tests" else time_tests=0 + check_bool_arg "$generate" fi if [ "$#" -gt 0 ]; then exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" fi # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then if [ "$run_stack_tests" -ne 0 ]; then options="-lgqC" else options="-lqC" fi halt="halt" else options="-xC" halt="q" fi -scriptdir="$testdir/$d/scripts" - name="${f%.*}" # We specifically want to skip this because it is handled specially. if [ "$f" = "timeconst.bc" ]; then exit 0 fi # Skip the tests that require extra math if we don't have it. if [ "$run_extra_tests" -eq 0 ]; then if [ "$f" = "rand.bc" ]; then printf 'Skipping %s script: %s\n' "$d" "$f" exit 0 fi fi # Skip the tests that require global stacks flag if we are not allowed to run # them. if [ "$run_stack_tests" -eq 0 ]; then if [ "$f" = "globals.bc" ] || [ "$f" = "references.bc" ] || [ "$f" = "rand.bc" ]; then printf 'Skipping %s script: %s\n' "$d" "$f" exit 0 fi fi out="$outputdir/${d}_outputs/${name}_script_results.txt" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH s="$scriptdir/$f" orig="$testdir/$name.txt" results="$scriptdir/$name.txt" if [ -f "$orig" ]; then res="$orig" elif [ -f "$results" ]; then res="$results" elif [ "$generate" -eq 0 ]; then printf 'Skipping %s script %s\n' "$d" "$f" exit 0 else set +e # This is to check that the command exists. If not, we should not try to # generate the test. Instead, we should just skip. command -v "$d" 1>/dev/null 2>&1 err="$?" set -e if [ "$err" -ne 0 ]; then printf 'Could not find %s to generate results; skipping %s script %s\n' "$d" "$d" "$f" exit 0 fi # This sed, and the script, are to remove an incompatibility with GNU bc, # where GNU bc is wrong. See the development manual # (manuals/development.md#script-tests) for more information. printf 'Generating %s results...' "$f" printf '%s\n' "$halt" | "$d" "$s" | sed -n -f "$testdir/script.sed" > "$results" printf 'done\n' res="$results" fi set +e printf 'Running %s script %s...' "$d" "$f" # Yes this is poor timing, but it works. if [ "$time_tests" -ne 0 ]; then printf '\n' printf '%s\n' "$halt" | /usr/bin/time -p "$exe" "$@" $options "$s" > "$out" err="$?" printf '\n' else printf '%s\n' "$halt" | "$exe" "$@" $options "$s" > "$out" err="$?" fi checktest "$d" "$err" "script $f" "$res" "$out" rm -f "$out" exec printf 'pass\n' diff --git a/contrib/bc/tests/scripts.sh b/contrib/bc/tests/scripts.sh index ee21b2a9be6d..5c3b6fc3d02c 100755 --- a/contrib/bc/tests/scripts.sh +++ b/contrib/bc/tests/scripts.sh @@ -1,132 +1,153 @@ #! /bin/sh # # 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. # script="$0" testdir=$(dirname "${script}") +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi + printf 'usage: %s [-n] dir [run_extra_tests] [run_stack_tests] [generate_tests] [time_tests] [exec args...]\n' "$script" + exit 1 +} + pids="" # We need to figure out if we should run stuff in parallel. pll=1 while getopts "n" opt; do case "$opt" in n) pll=0 ; shift ; set -e ;; ?) usage "Invalid option: $opt" ;; esac done # Command-line processing. if [ "$#" -eq 0 ]; then - printf 'usage: %s [-n] dir [run_extra_tests] [run_stack_tests] [generate_tests] [time_tests] [exec args...]\n' "$script" - exit 1 + usage "Need at least 1 argument" else d="$1" shift + check_d_arg "$d" fi if [ "$#" -gt 0 ]; then run_extra_tests="$1" shift + check_bool_arg "$run_extra_tests" else run_extra_tests=1 + check_bool_arg "$run_extra_tests" fi if [ "$#" -gt 0 ]; then run_stack_tests="$1" shift + check_bool_arg "$run_stack_tests" else run_stack_tests=1 + check_bool_arg "$run_stack_tests" fi if [ "$#" -gt 0 ]; then generate="$1" shift + check_bool_arg "$generate" else generate=1 + check_bool_arg "$generate" fi if [ "$#" -gt 0 ]; then time_tests="$1" shift + check_bool_arg "$time_tests" else time_tests=0 + check_bool_arg "$time_tests" fi if [ "$#" -gt 0 ]; then exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" + check_exec_arg "$exe" fi scriptdir="$testdir/$d/scripts" scripts=$(cat "$scriptdir/all.txt") # Run each script test individually. for s in $scripts; do f=$(basename "$s") if [ "$pll" -ne 0 ]; then sh "$testdir/script.sh" "$d" "$f" "$run_extra_tests" "$run_stack_tests" \ "$generate" "$time_tests" "$exe" "$@" & pids="$pids $!" else sh "$testdir/script.sh" "$d" "$f" "$run_extra_tests" "$run_stack_tests" \ "$generate" "$time_tests" "$exe" "$@" fi done if [ "$pll" -ne 0 ]; then exit_err=0 for p in $pids; do wait "$p" err="$?" if [ "$err" -ne 0 ]; then printf 'A script failed!\n' exit_err=1 fi done if [ "$exit_err" -ne 0 ]; then exit 1 fi fi diff --git a/contrib/bc/tests/stdin.sh b/contrib/bc/tests/stdin.sh index d8585052bf04..a650c5b996a6 100755 --- a/contrib/bc/tests/stdin.sh +++ b/contrib/bc/tests/stdin.sh @@ -1,103 +1,116 @@ #! /bin/sh # # 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. # set -e script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -lt 1 ]; then +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi printf 'usage: %s dir [exe [args...]]\n' "$0" printf 'valid dirs are:\n' printf '\n' cat "$testdir/all.txt" printf '\n' exit 1 +} + +# Command-line processing. +if [ "$#" -lt 1 ]; then + usage "Not enough arguments" fi d="$1" shift +check_d_arg "$d" if [ "$#" -gt 0 ]; then exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" + check_exec_arg "$exe" fi out="$outputdir/${d}_outputs/stdin_results.txt" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then options="-lq" else options="-x" fi rm -f "$out" # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH set +e printf 'Running %s stdin tests...' "$d" # Run the file through stdin. cat "$testdir/$d/stdin.txt" | "$exe" "$@" "$options" > "$out" 2> /dev/null checktest "$d" "$?" "stdin" "$testdir/$d/stdin_results.txt" "$out" # bc has some more tests; run those. if [ "$d" = "bc" ]; then cat "$testdir/$d/stdin1.txt" | "$exe" "$@" "$options" > "$out" 2> /dev/null checktest "$d" "$?" "stdin1" "$testdir/$d/stdin1_results.txt" "$out" cat "$testdir/$d/stdin2.txt" | "$exe" "$@" "$options" > "$out" 2> /dev/null checktest "$d" "$?" "stdin2" "$testdir/$d/stdin2_results.txt" "$out" fi rm -f "$out" exec printf 'pass\n' diff --git a/contrib/bc/tests/test.sh b/contrib/bc/tests/test.sh index 95606ded4f9e..11c7e05f739a 100755 --- a/contrib/bc/tests/test.sh +++ b/contrib/bc/tests/test.sh @@ -1,153 +1,172 @@ #! /bin/sh # # 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. # set -e script="$0" testdir=$(dirname "$script") . "$testdir/../scripts/functions.sh" outputdir=${BC_TEST_OUTPUT_DIR:-$testdir} -# Command-line processing. -if [ "$#" -lt 2 ]; then +# Just print the usage and exit with an error. This can receive a message to +# print. +# @param 1 A message to print. +usage() { + if [ $# -eq 1 ]; then + printf '%s\n\n' "$1" + fi printf 'usage: %s dir test [generate_tests] [time_tests] [exe [args...]]\n' "$0" printf 'valid dirs are:\n' printf '\n' cat "$testdir/all.txt" printf '\n' exit 1 +} + +# Command-line processing. +if [ "$#" -lt 2 ]; then + usage "Need at least 2 arguments" fi d="$1" shift +check_d_arg "$d" +# We don't use check_file_arg on the test or the result because they might be +# generated. t="$1" name="$testdir/$d/$t.txt" results="$testdir/$d/${t}_results.txt" shift if [ "$#" -gt 0 ]; then generate_tests="$1" shift + check_bool_arg "$generate_tests" else generate_tests=1 + check_bool_arg "$generate_tests" fi if [ "$#" -gt 0 ]; then time_tests="$1" shift + check_bool_arg "$time_tests" else time_tests=0 + check_bool_arg "$time_tests" fi if [ "$#" -gt 0 ]; then exe="$1" shift + check_exec_arg "$exe" else exe="$testdir/../bin/$d" + check_exec_arg "$exe" fi out="$outputdir/${d}_outputs/${t}_results.txt" outdir=$(dirname "$out") # Make sure the directory exists. if [ ! -d "$outdir" ]; then mkdir -p "$outdir" fi # I use these, so unset them to make the tests work. unset BC_ENV_ARGS unset BC_LINE_LENGTH unset DC_ENV_ARGS unset DC_LINE_LENGTH # Set stuff for the correct calculator. if [ "$d" = "bc" ]; then options="-lq" var="BC_LINE_LENGTH" halt="halt" else options="" var="DC_LINE_LENGTH" halt="q" fi # If the test does not exist... if [ ! -f "$name" ]; then # Skip if we can't generate. if [ "$generate_tests" -eq 0 ]; then printf 'Skipping %s %s test\n' "$d" "$t" exit 0 fi # Generate. printf 'Generating %s %s...' "$d" "$t" "$d" "$testdir/$d/scripts/$t.$d" > "$name" printf 'done\n' fi # If the results do not exist, generate.. if [ ! -f "$results" ]; then printf 'Generating %s %s results...' "$d" "$t" printf '%s\n' "$halt" | "$d" $options "$name" > "$results" printf 'done\n' fi # We set this here because GNU bc and dc does not have these options. if [ "$d" = "bc" ]; then options="-lqc" else options="-xc" fi export $var=string set +e printf 'Running %s %s...' "$d" "$t" if [ "$time_tests" -ne 0 ]; then printf '\n' printf '%s\n' "$halt" | /usr/bin/time -p "$exe" "$@" $options "$name" > "$out" err="$?" printf '\n' else printf '%s\n' "$halt" | "$exe" "$@" $options "$name" > "$out" err="$?" fi checktest "$d" "$err" "$t" "$results" "$out" rm -f "$out" exec printf 'pass\n' diff --git a/usr.bin/gh-bc/Makefile b/usr.bin/gh-bc/Makefile index a3e3bfd5aab2..68725d420b24 100644 --- a/usr.bin/gh-bc/Makefile +++ b/usr.bin/gh-bc/Makefile @@ -1,134 +1,134 @@ # $FreeBSD$ .include PROG= gh-bc PROGNAME= bc BCDIR= ${SRCTOP}/contrib/${PROGNAME} SRCS= args.c bc.c bc_lex.c bc_parse.c data.c dc.c dc_lex.c dc_parse.c file.c history.c SRCS+= lang.c lex.c main.c num.c opt.c parse.c program.c rand.c read.c vector.c vm.c SRCS+= bc_help.c dc_help.c lib.c lib2.c LIBADD= edit MAN= bc.1 dc.1 LINKS= ${BINDIR}/bc ${BINDIR}/dc .PATH: ${BCDIR}/src ${BCDIR}/gen ${BCDIR}/manuals ${.OBJDIR} CATALOGS= en_US.UTF-8 CATALOGS+= de_DE.UTF-8 de_DE.ISO8859-1 CATALOGS+= es_ES.UTF-8 es_ES.ISO8859-1 CATALOGS+= fr_FR.UTF-8 fr_FR.ISO8859-1 CATALOGS+= ja_JP.UTF-8 ja_JP.eucJP CATALOGS+= nl_NL.UTF-8 nl_NL.ISO8859-1 CATALOGS+= pl_PL.UTF-8 pl_PL.ISO8859-2 CATALOGS+= pt_PT.UTF-8 pt_PT.ISO8859-1 CATALOGS+= ru_RU.UTF-8 ru_RU.ISO8859-5 ru_RU.CP1251 ru_RU.CP866 ru_RU.KOI8-R CATALOGS+= zh_CN.UTF-8 zh_CN.eucCN zh_CN.GB18030 zh_CN.GB2312 zh_CN.GBK NLSNAME= bc NLSSRCDIR= ${BCDIR}/locales #CFLAGS=-g -O0 CFLAGS+= -DBC_DEFAULT_BANNER=0 CFLAGS+= -DBC_DEFAULT_DIGIT_CLAMP=0 CFLAGS+= -DBC_DEFAULT_EXPR_EXIT=1 CFLAGS+= -DBC_DEFAULT_PROMPT=0 CFLAGS+= -DBC_DEFAULT_SIGINT_RESET=1 CFLAGS+= -DBC_DEFAULT_TTY_MODE=1 CFLAGS+= -DBC_ENABLED=1 CFLAGS+= -DBC_ENABLE_AFL=0 CFLAGS+= -DBC_ENABLE_EDITLINE=1 CFLAGS+= -DBC_ENABLE_EXTRA_MATH=1 CFLAGS+= -DBC_ENABLE_HISTORY=1 CFLAGS+= -DBC_ENABLE_LIBRARY=0 CFLAGS+= -DBC_ENABLE_MEMCHECK=0 CFLAGS+= -DBC_EXCLUDE_EXTRA_MATH=0 CFLAGS+= -DDC_DEFAULT_DIGIT_CLAMP=0 CFLAGS+= -DDC_DEFAULT_EXPR_EXIT=1 CFLAGS+= -DDC_DEFAULT_PROMPT=0 CFLAGS+= -DDC_DEFAULT_SIGINT_RESET=1 CFLAGS+= -DDC_DEFAULT_TTY_MODE=0 CFLAGS+= -DDC_ENABLED=1 CFLAGS+= -DBUILD_TYPE=A CFLAGS+= -DMAINEXEC=${PROGNAME} CFLAGS+= -DNDEBUG CFLAGS+= -DNLSPATH=/usr/share/nls/%L/%N.cat CFLAGS+= -I${BCDIR}/include .if ${MK_NLS_CATALOGS} == "no" CFLAGS+= -DBC_ENABLE_NLS=0 MAN_SRC_BC= bc/N.1 MAN_SRC_DC= dc/N.1 .else CFLAGS+= -DBC_ENABLE_NLS=1 MAN_SRC_BC= bc/A.1 MAN_SRC_DC= dc/A.1 # prevent floating point incompatibilities caused by -flto on some architectures .if ${MACHINE_ARCH:Mmips*} == "" && ${MACHINE_ARCH} != powerpc64 && \ ${MACHINE_ARCH} != riscv64 #CFLAGS+= -flto .endif HAS_TESTS= yes SUBDIR.${MK_TESTS}+= tests .for catalog in ${CATALOGS} NLS+= ${catalog:C/.*://} NLSSRCFILES_${catalog:C/.*://}= ${catalog:C/.*://}.msg .endfor NLSLINKS_en_US.UTF-8+= en_AU.UTF-8 en_CA.UTF-8 en_GB.UTF-8 en_IE.UTF-8 \ en_NZ.UTF-8 C NLSLINKS_en_US.UTF-8+= en_AU.US-ASCII en_CA.US-ASCII en_GB.US-ASCII \ en_NZ.US-ASCII NLSLINKS_en_US.UTF-8+= en_AU.ISO8859-1 en_CA.ISO8859-1 en_GB.ISO8859-1 \ en_NZ.ISO8859-1 en_US.ISO8859-1 NLSLINKS_en_US.UTF-8+= en_AU.ISO8859-15 en_CA.ISO8859-15 en_GB.ISO8859-15 \ en_NZ.ISO8859-15 en_US.ISO8859-15 NLSLINKS_de_DE.UTF-8+= de_AT.UTF-8 de_CH.UTF-8 NLSLINKS_de_DE.ISO8859-1+= de_AT.ISO8859-1 de_CH.ISO8859-1 NLSLINKS_de_DE.ISO8859-1+= de_AT.ISO8859-15 de_CH.ISO8859-15 de_DE.ISO8859-15 NLSLINKS_es_ES.ISO8859-1+= es_ES.ISO8859-15 NLSLINKS_fr_FR.UTF-8+= fr_BE.UTF-8 fr_CA.UTF-8 fr_CH.UTF-8 NLSLINKS_fr_FR.ISO8859-1+= fr_BE.ISO8859-1 fr_CA.ISO8859-1 fr_CH.ISO8859-1 NLSLINKS_fr_FR.ISO8859-1+= fr_BE.ISO8859-15 fr_CA.ISO8859-15 fr_CH.ISO8859-15 \ fr_FR.ISO8859-15 NLSLINKS_nl_NL.ISO8859-1+= nl_BE.ISO8859-1 NLSLINKS_nl_NL.ISO8859-1+= nl_BE.ISO8859-15 nl_NL.ISO8859-15 NLSLINKS_pt_PT.UTF-8+= pt_BR.UTF-8 NLSLINKS_pt_PT.ISO8859-1+= pt_BR.ISO8859-1 NLSLINKS_pt_PT.ISO8859-1+= pt_PT.ISO8859-15 .endif lib.c: lib.bc Makefile cd ${BCDIR} && sh gen/strgen.sh gen/lib.bc ${.OBJDIR}/lib.c 0 bc_lib bc_lib_name 1 1 lib2.c: lib2.bc Makefile cd ${BCDIR} && sh gen/strgen.sh gen/lib2.bc ${.OBJDIR}/lib2.c 0 bc_lib2 bc_lib2_name 1 1 bc_help.c: bc_help.txt Makefile - cd ${BCDIR} && sh gen/strgen.sh gen/bc_help.txt ${.OBJDIR}/bc_help.c 0 bc_help + cd ${BCDIR} && sh gen/strgen.sh gen/bc_help.txt ${.OBJDIR}/bc_help.c 0 bc_help "" 1 0 dc_help.c: dc_help.txt Makefile - cd ${BCDIR} && sh gen/strgen.sh gen/dc_help.txt ${.OBJDIR}/dc_help.c 0 dc_help + cd ${BCDIR} && sh gen/strgen.sh gen/dc_help.txt ${.OBJDIR}/dc_help.c 0 dc_help "" 1 0 bc.1: ${CP} ${BCDIR}/manuals/${MAN_SRC_BC} ${.OBJDIR}/bc.1 dc.1: ${CP} ${BCDIR}/manuals/${MAN_SRC_DC} ${.OBJDIR}/dc.1 .include