xref: /freebsd/contrib/bc/NEWS.md (revision e2eeea75eb8b6dd50c1298067a0655880d186734)
1# News
2
3## 3.1.6
4
5This is a production release that fixes a new warning from Clang 12 for FreeBSD
6and also removes some possible undefined behavior found by UBSan that compilers
7did not seem to take advantage of.
8
9Users do ***NOT*** need to upgrade, if they do not want to.
10
11## 3.1.5
12
13This is a production release that fixes the Chinese locales (which caused `bc`
14to crash) and a crash caused by `bc` executing code when it should not have been
15able to.
16
17***ALL USERS SHOULD UPGRADE.***
18
19## 3.1.4
20
21This is a production release that fixes one bug, changes two behaviors, and
22removes one environment variable.
23
24The bug is like the one in the last release except it applies if files are being
25executed. I also made the fix more general.
26
27The behavior that was changed is that `bc` now exits when given `-e`, `-f`,
28`--expression` or `--file`. However, if the last one of those is `-f-` (using
29`stdin` as the file), `bc` does not exit. If `-f-` exists and is not the last of
30the `-e` and `-f` options (and equivalents), `bc` gives a fatal error and exits.
31
32Next, I removed the `BC_EXPR_EXIT` and `DC_EXPR_EXIT` environment variables
33since their use is not needed with the behavior change.
34
35Finally, I made it so `bc` does not print the header, though the `-q` and
36`--quiet` options were kept for compatibility with GNU `bc`.
37
38## 3.1.3
39
40This is a production release that fixes one minor bug: if `bc` was invoked like
41the following, it would error:
42
43```
44echo "if (1 < 3) 1" | bc
45```
46
47Unless users run into this bug, they do not need to upgrade, but it is suggested
48that they do.
49
50## 3.1.2
51
52This is a production release that adds a way to install *all* locales. Users do
53***NOT*** need to upgrade.
54
55For package maintainers wishing to make use of the change, just pass `-l` to
56`configure.sh`.
57
58## 3.1.1
59
60This is a production release that adds two Spanish locales. Users do ***NOT***
61need to upgrade, unless they want those locales.
62
63## 3.1.0
64
65This is a production release that adjusts one behavior, fixes eight bugs, and
66improves manpages for FreeBSD. Because this release fixes bugs, **users and
67package maintainers should update to this version as soon as possible**.
68
69The behavior that was adjusted was how code from the `-e` and `-f` arguments
70(and equivalents) were executed. They used to be executed as one big chunk, but
71in this release, they are now executed line-by-line.
72
73The first bug fix in how output to `stdout` was handled in `SIGINT`. If a
74`SIGINT` came in, the `stdout` buffer was not correctly flushed. In fact, a
75clean-up function was not getting called. This release fixes that bug.
76
77The second bug is in how `dc` handled input from `stdin`. This affected `bc` as
78well since it was a mishandling of the `stdin` buffer.
79
80The third fixed bug was that `bc` and `dc` could `abort()` (in debug mode) when
81receiving a `SIGTERM`. This one was a race condition with pushing and popping
82items onto and out of vectors.
83
84The fourth bug fixed was that `bc` could leave extra items on the stack and
85thus, not properly clean up some memory. (The memory would still get
86`free()`'ed, but it would not be `free()`'ed when it could have been.)
87
88The next two bugs were bugs in `bc`'s parser that caused crashes when executing
89the resulting code.
90
91The last two bugs were crashes in `dc` that resulted from mishandling of
92strings.
93
94The manpage improvement was done by switching from [ronn][20] to [Pandoc][21] to
95generate manpages. Pandoc generates much cleaner manpages and doesn't leave
96blank lines where they shouldn't be.
97
98## 3.0.3
99
100This is a production release that adds one new feature: specific manpages.
101
102Before this release, `bc` and `dc` only used one manpage each that referred to
103various build options. This release changes it so there is one manpage set per
104relevant build type. Each manual only has information about its particular
105build, and `configure.sh` selects the correct set for install.
106
107## 3.0.2
108
109This is a production release that adds `utf8` locale symlinks and removes an
110unused `auto` variable from the `ceil()` function in the [extended math
111library][16].
112
113Users do ***NOT*** need to update unless they want the locales.
114
115## 3.0.1
116
117This is a production release with two small changes. Users do ***NOT*** need to
118upgrade to this release; however, if they haven't upgraded to `3.0.0` yet, it
119may be worthwhile to upgrade to this release.
120
121The first change is fixing a compiler warning on FreeBSD with strict warnings
122on.
123
124The second change is to make the new implementation of `ceil()` in `lib2.bc`
125much more efficient.
126
127## 3.0.0
128
129*Notes for package maintainers:*
130
131*First, the `2.7.0` release series saw a change in the option parsing. This made
132me change one error message and add a few others. The error message that was
133changed removed one format specifier. This means that `printf()` will seqfault
134on old locale files. Unfortunately, `bc` cannot use any locale files except the
135global ones that are already installed, so it will use the previous ones while
136running tests during install. **If `bc` segfaults while running arg tests when
137updating, it is because the global locale files have not been replaced. Make
138sure to either prevent the test suite from running on update or remove the old
139locale files before updating.** (Removing the locale files can be done with
140`make uninstall` or by running the `locale_uninstall.sh` script.) Once this is
141done, `bc` should install without problems.*
142
143*Second, **the option to build without signal support has been removed**. See
144below for the reasons why.*
145
146This is a production release with some small bug fixes, a few improvements,
147three major bug fixes, and a complete redesign of `bc`'s error and signal
148handling. **Users and package maintainers should update to this version as soon
149as possible.**
150
151The first major bug fix was in how `bc` executed files. Previously, a whole file
152was parsed before it was executed, but if a function is defined *after* code,
153especially if the function definition was actually a redefinition, and the code
154before the definition referred to the previous function, this `bc` would replace
155the function before executing any code. The fix was to make sure that all code
156that existed before a function definition was executed.
157
158The second major bug fix was in `bc`'s `lib2.bc`. The `ceil()` function had a
159bug where a `0` in the decimal place after the truncation position, caused it to
160output the wrong numbers if there was any non-zero digit after.
161
162The third major bug is that when passing parameters to functions, if an
163expression included an array (not an array element) as a parameter, it was
164accepted, when it should have been rejected. It is now correctly rejected.
165
166Beyond that, this `bc` got several improvements that both sped it up, improved
167the handling of signals, and improved the error handling.
168
169First, the requirements for `bc` were pushed back to POSIX 2008. `bc` uses one
170function, `strdup()`, which is not in POSIX 2001, and it is in the X/Open System
171Interfaces group 2001. It is, however, in POSIX 2008, and since POSIX 2008 is
172old enough to be supported anywhere that I care, that should be the requirement.
173
174Second, the BcVm global variable was put into `bss`. This actually slightly
175reduces the size of the executable from a massive code shrink, and it will stop
176`bc` from allocating a large set of memory when `bc` starts.
177
178Third, the default Karatsuba length was updated from 64 to 32 after making the
179optimization changes below, since 32 is going to be better than 64 after the
180changes.
181
182Fourth, Spanish translations were added.
183
184Fifth, the interpreter received a speedup to make performance on non-math-heavy
185scripts more competitive with GNU `bc`. While improvements did, in fact, get it
186much closer (see the [benchmarks][19]), it isn't quite there.
187
188There were several things done to speed up the interpreter:
189
190First, several small inefficiencies were removed. These inefficiencies included
191calling the function `bc_vec_pop(v)` twice instead of calling
192`bc_vec_npop(v, 2)`. They also included an extra function call for checking the
193size of the stack and checking the size of the stack more than once on several
194operations.
195
196Second, since the current `bc` function is the one that stores constants and
197strings, the program caches pointers to the current function's vectors of
198constants and strings to prevent needing to grab the current function in order
199to grab a constant or a string.
200
201Third, `bc` tries to reuse `BcNum`'s (the internal representation of
202arbitary-precision numbers). If a `BcNum` has the default capacity of
203`BC_NUM_DEF_SIZE` (32 on 64-bit and 16 on 32-bit) when it is freed, it is added
204to a list of available `BcNum`'s. And then, when a `BcNum` is allocated with a
205capacity of `BC_NUM_DEF_SIZE` and any `BcNum`'s exist on the list of reusable
206ones, one of those ones is grabbed instead.
207
208In order to support these changes, the `BC_NUM_DEF_SIZE` was changed. It used to
209be 16 bytes on all systems, but it was changed to more closely align with the
210minimum allocation size on Linux, which is either 32 bytes (64-bit musl), 24
211bytes (64-bit glibc), 16 bytes (32-bit musl), or 12 bytes (32-bit glibc). Since
212these are the minimum allocation sizes, these are the sizes that would be
213allocated anyway, making it worth it to just use the whole space, so the value
214of `BC_NUM_DEF_SIZE` on 64-bit systems was changed to 32 bytes.
215
216On top of that, at least on 64-bit, `BC_NUM_DEF_SIZE` supports numbers with
217either 72 integer digits or 45 integer digits and 27 fractional digits. This
218should be more than enough for most cases since `bc`'s default `scale` values
219are 0 or 20, meaning that, by default, it has at most 20 fractional digits. And
22045 integer digits are *a lot*; it's enough to calculate the amount of mass in
221the Milky Way galaxy in kilograms. Also, 72 digits is enough to calculate the
222diameter of the universe in Planck lengths.
223
224(For 32-bit, these numbers are either 32 integer digits or 12 integer digits and
22520 fractional digits. These are also quite big, and going much bigger on a
22632-bit system seems a little pointless since 12 digits in just under a trillion
227and 20 fractional digits is still enough for about any use since `10^-20` light
228years is just under a millimeter.)
229
230All of this together means that for ordinary uses, and even uses in scientific
231work, the default number size will be all that is needed, which means that
232nearly all, if not all, numbers will be reused, relieving pressure on the system
233allocator.
234
235I did several experiments to find the changes that had the most impact,
236especially with regard to reusing `BcNum`'s. One was putting `BcNum`'s into
237buckets according to their capacity in powers of 2 up to 512. That performed
238worse than `bc` did in `2.7.2`. Another was putting any `BcNum` on the reuse
239list that had a capacity of `BC_NUM_DEF_SIZE * 2` and reusing them for `BcNum`'s
240that requested `BC_NUM_DEF_SIZE`. This did reduce the amount of time spent, but
241it also spent a lot of time in the system allocator for an unknown reason. (When
242using `strace`, a bunch more `brk` calls showed up.) Just reusing `BcNum`'s that
243had exactly `BC_NUM_DEF_SIZE` capacity spent the smallest amount of time in both
244user and system time. This makes sense, especially with the changes to make
245`BC_NUM_DEF_SIZE` bigger on 64-bit systems, since the vast majority of numbers
246will only ever use numbers with a size less than or equal to `BC_NUM_DEF_SIZE`.
247
248Last of all, `bc`'s signal handling underwent a complete redesign. (This is the
249reason that this version is `3.0.0` and not `2.8.0`.) The change was to move
250from a polling approach to signal handling to an interrupt-based approach.
251
252Previously, every single loop condition had a check for signals. I suspect that
253this could be expensive when in tight loops.
254
255Now, the signal handler just uses `longjmp()` (actually `siglongjmp()`) to start
256an unwinding of the stack until it is stopped or the stack is unwound to
257`main()`, which just returns. If `bc` is currently executing code that cannot be
258safely interrupted (according to POSIX), then signals are "locked." The signal
259handler checks if the lock is taken, and if it is, it just sets the status to
260indicate that a signal arrived. Later, when the signal lock is released, the
261status is checked to see if a signal came in. If so, the stack unwinding starts.
262
263This design eliminates polling in favor of maintaining a stack of `jmp_buf`'s.
264This has its own performance implications, but it gives better interaction. And
265the cost of pushing and popping a `jmp_buf` in a function is paid at most twice.
266Most functions do not pay that price, and most of the rest only pay it once.
267(There are only some 3 functions in `bc` that push and pop a `jmp_buf` twice.)
268
269As a side effect of this change, I had to eliminate the use of `stdio.h` in `bc`
270because `stdio` does not play nice with signals and `longjmp()`. I implemented
271custom I/O buffer code that takes a fraction of the size. This means that static
272builds will be smaller, but non-static builds will be bigger, though they will
273have less linking time.
274
275This change is also good because my history implementation was already bypassing
276`stdio` for good reasons, and unifying the architecture was a win.
277
278Another reason for this change is that my `bc` should *always* behave correctly
279in the presence of signals like `SIGINT`, `SIGTERM`, and `SIGQUIT`. With the
280addition of my own I/O buffering, I needed to also make sure that the buffers
281were correctly flushed even when such signals happened.
282
283For this reason, I **removed the option to build without signal support**.
284
285As a nice side effect of this change, the error handling code could be changed
286to take advantage of the stack unwinding that signals used. This means that
287signals and error handling use the same code paths, which means that the stack
288unwinding is well-tested. (Errors are tested heavily in the test suite.)
289
290It also means that functions do not need to return a status code that
291***every*** caller needs to check. This eliminated over 100 branches that simply
292checked return codes and then passed that return code up the stack if necessary.
293The code bloat savings from this is at least 1700 bytes on `x86_64`, *before*
294taking into account the extra code from removing `stdio.h`.
295
296## 2.7.2
297
298This is a production release with one major bug fix.
299
300The `length()` built-in function can take either a number or an array. If it
301takes an array, it returns the length of the array. Arrays can be passed by
302reference. The bug is that the `length()` function would not properly
303dereference arrays that were references. This is a bug that affects all users.
304
305**ALL USERS SHOULD UPDATE `bc`**.
306
307## 2.7.1
308
309This is a production release with fixes for new locales and fixes for compiler
310warnings on FreeBSD.
311
312## 2.7.0
313
314This is a production release with a bug fix for Linux, new translations, and new
315features.
316
317Bug fixes:
318
319* Option parsing in `BC_ENV_ARGS` was broken on Linux in 2.6.1 because `glibc`'s
320  `getopt_long()` is broken. To get around that, and to support long options on
321  every platform, an adapted version of [`optparse`][17] was added. Now, `bc`
322  does not even use `getopt()`.
323* Parsing `BC_ENV_ARGS` with quotes now works. It isn't the smartest, but it
324  does the job if there are spaces in file names.
325
326The following new languages are supported:
327
328* Dutch
329* Polish
330* Russian
331* Japanes
332* Simplified Chinese
333
334All of these translations were generated using [DeepL][18], so improvements are
335welcome.
336
337There is only one new feature: **`bc` now has a built-in pseudo-random number
338generator** (PRNG).
339
340The PRNG is seeded, making it useful for applications where
341`/dev/urandom` does not work because output needs to be reproducible. However,
342it also uses `/dev/urandom` to seed itself by default, so it will start with a
343good seed by default.
344
345It also outputs 32 bits on 32-bit platforms and 64 bits on 64-bit platforms, far
346better than the 15 bits of C's `rand()` and `bash`'s `$RANDOM`.
347
348In addition, the PRNG can take a bound, and when it gets a bound, it
349automatically adjusts to remove bias. It can also generate numbers of arbitrary
350size. (As of the time of release, the largest pseudo-random number generated by
351this `bc` was generated with a bound of `2^(2^20)`.)
352
353***IMPORTANT: read the [`bc` manual][9] and the [`dc` manual][10] to find out
354exactly what guarantees the PRNG provides. The underlying implementation is not
355guaranteed to stay the same, but the guarantees that it provides are guaranteed
356to stay the same regardless of the implementation.***
357
358On top of that, four functions were added to `bc`'s [extended math library][16]
359to make using the PRNG easier:
360
361* `frand(p)`: Generates a number between `[0,1)` to `p` decimal places.
362* `ifrand(i, p)`: Generates an integer with bound `i` and adds it to `frand(p)`.
363* `srand(x)`: Randomizes the sign of `x`. In other words, it flips the sign of
364  `x` with probability `0.5`.
365* `brand()`: Returns a random boolean value (either `0` or `1`).
366
367## 2.6.1
368
369This is a production release with a bug fix for FreeBSD.
370
371The bug was that when `bc` was built without long options, it would give a fatal
372error on every run. This was caused by a mishandling of `optind`.
373
374## 2.6.0
375
376This release is a production release ***with no bugfixes***. If you do not want
377to upgrade, you don't have to.
378
379No source code changed; the only thing that changed was `lib2.bc`.
380
381This release adds one function to the [extended math library][16]: `p(x, y)`,
382which calculates `x` to the power of `y`, whether or not `y` is an integer. (The
383`^` operator can only accept integer powers.)
384
385This release also includes a couple of small tweaks to the [extended math
386library][16], mostly to fix returning numbers with too high of `scale`.
387
388## 2.5.3
389
390This release is a production release which addresses inconsistencies in the
391Portuguese locales. No `bc` code was changed.
392
393The issues were that the ISO files used different naming, and also that the
394files that should have been symlinks were not. I did not catch that because
395GitHub rendered them the exact same way.
396
397## 2.5.2
398
399This release is a production release.
400
401No code was changed, but the build system was changed to allow `CFLAGS` to be
402given to `CC`, like this:
403
404```
405CC="gcc -O3 -march=native" ./configure.sh
406```
407
408If this happens, the flags are automatically put into `CFLAGS`, and the compiler
409is set appropriately. In the example above this means that `CC` will be "gcc"
410and `CFLAGS` will be "-O3 -march=native".
411
412This behavior was added to conform to GNU autotools practices.
413
414## 2.5.1
415
416This is a production release which addresses portability concerns discovered
417in the `bc` build system. No `bc` code was changed.
418
419* Support for Solaris SPARC and AIX were added.
420* Minor documentations edits were performed.
421* An option for `configure.sh` was added to disable long options if
422  `getopt_long()` is missing.
423
424## 2.5.0
425
426This is a production release with new translations. No code changed.
427
428The translations were contributed by [bugcrazy][15], and they are for
429Portuguese, both Portugal and Brazil locales.
430
431## 2.4.0
432
433This is a production release primarily aimed at improving `dc`.
434
435* A couple of copy and paste errors in the [`dc` manual][10] were fixed.
436* `dc` startup was optimized by making sure it didn't have to set up `bc`-only
437  things.
438* The `bc` `&&` and `||` operators were made available to `dc` through the `M`
439  and `m` commands, respectively.
440* `dc` macros were changed to be tail call-optimized.
441
442The last item, tail call optimization, means that if the last thing in a macro
443is a call to another macro, then the old macro is popped before executing the
444new macro. This change was made to stop `dc` from consuming more and more memory
445as macros are executed in a loop.
446
447The `q` and `Q` commands still respect the "hidden" macros by way of recording
448how many macros were removed by tail call optimization.
449
450## 2.3.2
451
452This is a production release meant to fix warnings in the Gentoo `ebuild` by
453making it possible to disable binary stripping. Other users do *not* need to
454upgrade.
455
456## 2.3.1
457
458This is a production release. It fixes a bug that caused `-1000000000 < -1` to
459return `0`. This only happened with negative numbers and only if the value on
460the left was more negative by a certain amount. That said, this bug *is* a bad
461bug, and needs to be fixed.
462
463**ALL USERS SHOULD UPDATE `bc`**.
464
465## 2.3.0
466
467This is a production release with changes to the build system.
468
469## 2.2.0
470
471This release is a production release. It only has new features and performance
472improvements.
473
4741.	The performance of `sqrt(x)` was improved.
4752.	The new function `root(x, n)` was added to the extended math library to
476	calculate `n`th roots.
4773.	The new function `cbrt(x)` was added to the extended math library to
478	calculate cube roots.
479
480## 2.1.3
481
482This is a non-critical release; it just changes the build system, and in
483non-breaking ways:
484
4851.	Linked locale files were changed to link to their sources with a relative
486	link.
4872.	A bug in `configure.sh` that caused long option parsing to fail under `bash`
488	was fixed.
489
490## 2.1.2
491
492This release is not a critical release.
493
4941.	A few codes were added to history.
4952.	Multiplication was optimized a bit more.
4963.	Addition and subtraction were both optimized a bit more.
497
498## 2.1.1
499
500This release contains a fix for the test suite made for Linux from Scratch: now
501the test suite prints `pass` when a test is passed.
502
503Other than that, there is no change in this release, so distros and other users
504do not need to upgrade.
505
506## 2.1.0
507
508This release is a production release.
509
510The following bugs were fixed:
511
5121.	A `dc` bug that caused stack mishandling was fixed.
5132.	A warning on OpenBSD was fixed.
5143.	Bugs in `ctrl+arrow` operations in history were fixed.
5154.	The ability to paste multiple lines in history was added.
5165.	A `bc` bug, mishandling of array arguments to functions, was fixed.
5176.	A crash caused by freeing the wrong pointer was fixed.
5187.	A `dc` bug where strings, in a rare case, were mishandled in parsing was
519	fixed.
520
521In addition, the following changes were made:
522
5231.	Division was slightly optimized.
5242.	An option was added to the build to disable printing of prompts.
5253.	The special case of empty arguments is now handled. This is to prevent
526	errors in scripts that end up passing empty arguments.
5274.	A harmless bug was fixed. This bug was that, with the pop instructions
528	(mostly) removed (see below), `bc` would leave extra values on its stack for
529	`void` functions and in a few other cases. These extra items would not
530	affect anything put on the stack and would not cause any sort of crash or
531	even buggy behavior, but they would cause `bc` to take more memory than it
532	needed.
533
534On top of the above changes, the following optimizations were added:
535
5361.	The need for pop instructions in `bc` was removed.
5372.	Extra tests on every iteration of the interpreter loop were removed.
5383.	Updating function and code pointers on every iteration of the interpreter
539	loop was changed to only updating them when necessary.
5404.	Extra assignments to pointers were removed.
541
542Altogether, these changes sped up the interpreter by around 2x.
543
544***NOTE***: This is the last release with new features because this `bc` is now
545considered complete. From now on, only bug fixes and new translations will be
546added to this `bc`.
547
548## 2.0.3
549
550This is a production, bug-fix release.
551
552Two bugs were fixed in this release:
553
5541.	A rare and subtle signal handling bug was fixed.
5552.	A misbehavior on `0` to a negative power was fixed.
556
557The last bug bears some mentioning.
558
559When I originally wrote power, I did not thoroughly check its error cases;
560instead, I had it check if the first number was `0` and then if so, just return
561`0`. However, `0` to a negative power means that `1` will be divided by `0`,
562which is an error.
563
564I caught this, but only after I stopped being cocky. You see, sometime later, I
565had noticed that GNU `bc` returned an error, correctly, but I thought it was
566wrong simply because that's not what my `bc` did. I saw it again later and had a
567double take. I checked for real, finally, and found out that my `bc` was wrong
568all along.
569
570That was bad on me. But the bug was easy to fix, so it is fixed now.
571
572There are two other things in this release:
573
5741.	Subtraction was optimized by [Stefan Eßer][14].
5752.	Division was also optimized, also by Stefan Eßer.
576
577## 2.0.2
578
579This release contains a fix for a possible overflow in the signal handling. I
580would be surprised if any users ran into it because it would only happen after 2
581billion (`2^31-1`) `SIGINT`'s, but I saw it and had to fix it.
582
583## 2.0.1
584
585This release contains very few things that will apply to any users.
586
5871.	A slight bug in `dc`'s interactive mode was fixed.
5882.	A bug in the test suite that was only triggered on NetBSD was fixed.
5893.	**The `-P`/`--no-prompt` option** was added for users that do not want a
590	prompt.
5914.	A `make check` target was added as an alias for `make test`.
5925.	`dc` got its own read prompt: `?> `.
593
594## 2.0.0
595
596This release is a production release.
597
598This release is also a little different from previous releases. From here on
599out, I do not plan on adding any more features to this `bc`; I believe that it
600is complete. However, there may be bug fix releases in the future, if I or any
601others manage to find bugs.
602
603This release has only a few new features:
604
6051.	`atan2(y, x)` was added to the extended math library as both `a2(y, x)` and
606	`atan2(y, x)`.
6072.	Locales were fixed.
6083.	A **POSIX shell-compatible script was added as an alternative to compiling
609	`gen/strgen.c`** on a host machine. More details about making the choice
610	between the two can be found by running `./configure.sh --help` or reading
611	the [build manual][13].
6124.	Multiplication was optimized by using **diagonal multiplication**, rather
613	than straight brute force.
6145.	The `locale_install.sh` script was fixed.
6156.	`dc` was given the ability to **use the environment variable
616	`DC_ENV_ARGS`**.
6177.	`dc` was also given the ability to **use the `-i` or `--interactive`**
618	options.
6198.	Printing the prompt was fixed so that it did not print when it shouldn't.
6209.	Signal handling was fixed.
62110.	**Handling of `SIGTERM` and `SIGQUIT`** was fixed.
62211.	The **built-in functions `maxibase()`, `maxobase()`, and `maxscale()`** (the
623	commands `T`, `U`, `V` in `dc`, respectively) were added to allow scripts to
624	query for the max allowable values of those globals.
62512.	Some incompatibilities with POSIX were fixed.
626
627In addition, this release is `2.0.0` for a big reason: the internal format for
628numbers changed. They used to be a `char` array. Now, they are an array of
629larger integers, packing more decimal digits into each integer. This has
630delivered ***HUGE*** performance improvements, especially for multiplication,
631division, and power.
632
633This `bc` should now be the fastest `bc` available, but I may be wrong.
634
635## 1.2.8
636
637This release contains a fix for a harmless bug (it is harmless in that it still
638works, but it just copies extra data) in the [`locale_install.sh`][12] script.
639
640## 1.2.7
641
642This version contains fixes for the build on Arch Linux.
643
644## 1.2.6
645
646This release removes the use of `local` in shell scripts because it's not POSIX
647shell-compatible, and also updates a man page that should have been updated a
648long time ago but was missed.
649
650## 1.2.5
651
652This release contains some missing locale `*.msg` files.
653
654## 1.2.4
655
656This release contains a few bug fixes and new French translations.
657
658## 1.2.3
659
660This release contains a fix for a bug: use of uninitialized data. Such data was
661only used when outputting an error message, but I am striving for perfection. As
662Michelangelo said, "Trifles make perfection, and perfection is no trifle."
663
664## 1.2.2
665
666This release contains fixes for OpenBSD.
667
668## 1.2.1
669
670This release contains bug fixes for some rare bugs.
671
672## 1.2.0
673
674This is a production release.
675
676There have been several changes since `1.1.0`:
677
6781.	The build system had some changes.
6792.	Locale support has been added. (Patches welcome for translations.)
6803.	**The ability to turn `ibase`, `obase`, and `scale` into stacks** was added
681	with the `-g` command-line option. (See the [`bc` manual][9] for more
682	details.)
6834.	Support for compiling on Mac OSX out of the box was added.
6845.	The extended math library got `t(x)`, `ceil(x)`, and some aliases.
6856.	The extended math library also got `r2d(x)` (for converting from radians to
686	degrees) and `d2r(x)` (for converting from degrees to radians). This is to
687	allow using degrees with the standard library.
6887.	Both calculators now accept numbers in **scientific notation**. See the
689	[`bc` manual][9] and the [`dc` manual][10] for details.
6908.	Both calculators can **output in either scientific or engineering
691	notation**. See the [`bc` manual][9] and the [`dc` manual][10] for details.
6929.	Some inefficiencies were removed.
69310.	Some bugs were fixed.
69411.	Some bugs in the extended library were fixed.
69512.	Some defects from [Coverity Scan][11] were fixed.
696
697## 1.1.4
698
699This release contains a fix to the build system that allows it to build on older
700versions of `glibc`.
701
702## 1.1.3
703
704This release contains a fix for a bug in the test suite where `bc` tests and
705`dc` tests could not be run in parallel.
706
707## 1.1.2
708
709This release has a fix for a history bug; the down arrow did not work.
710
711## 1.1.1
712
713This release fixes a bug in the `1.1.0` build system. The source is exactly the
714same.
715
716The bug that was fixed was a failure to install if no `EXECSUFFIX` was used.
717
718## 1.1.0
719
720This is a production release. However, many new features were added since `1.0`.
721
7221.	**The build system has been changed** to use a custom, POSIX
723	shell-compatible configure script ([`configure.sh`][6]) to generate a POSIX
724	make-compatible `Makefile`, which means that `bc` and `dc` now build out of
725	the box on any POSIX-compatible system.
7262.	Out-of-memory and output errors now cause the `bc` to report the error,
727	clean up, and die, rather than just reporting and trying to continue.
7283.	**Strings and constants are now garbage collected** when possible.
7294.	Signal handling and checking has been made more simple and more thorough.
7305.	`BcGlobals` was refactored into `BcVm` and `BcVm` was made global. Some
731	procedure names were changed to reflect its difference to everything else.
7326.	Addition got a speed improvement.
7337.	Some common code for addition and multiplication was refactored into its own
734	procedure.
7358.	A bug was removed where `dc` could have been selected, but the internal
736	`#define` that returned `true` for a query about `dc` would not have
737	returned `true`.
7389.	Useless calls to `bc_num_zero()` were removed.
73910.	**History support was added.** The history support is based off of a
740	[UTF-8 aware fork][7] of [`linenoise`][8], which has been customized with
741	`bc`'s own data structures and signal handling.
74211.	Generating C source from the math library now removes tabs from the library,
743	shrinking the size of the executable.
74412.	The math library was shrunk.
74513.	Error handling and reporting was improved.
74614.	Reallocations were reduced by giving access to the request size for each
747	operation.
74815.	**`abs()` (`b` command for `dc`) was added as a builtin.**
74916.	Both calculators were tested on FreeBSD.
75017.	Many obscure parse bugs were fixed.
75118.	Markdown and man page manuals were added, and the man pages are installed by
752	`make install`.
75319.	Executable size was reduced, though the added features probably made the
754	executable end up bigger.
75520.	**GNU-style array references were added as a supported feature.**
75621.	Allocations were reduced.
75722.	**New operators were added**: `$` (`$` for `dc`), `@` (`@` for `dc`), `@=`,
758	`<<` (`H` for `dc`), `<<=`, `>>` (`h` for `dc`), and `>>=`. See the
759	[`bc` manual][9] and the [`dc` manual][10] for more details.
76023.	**An extended math library was added.** This library contains code that
761	makes it so I can replace my desktop calculator with this `bc`. See the
762	[`bc` manual][3] for more details.
76324.	Support for all capital letters as numbers was added.
76425.	**Support for GNU-style void functions was added.**
76526.	A bug fix for improper handling of function parameters was added.
76627.	Precedence for the or (`||`) operator was changed to match GNU `bc`.
76728.	`dc` was given an explicit negation command.
76829.	`dc` was changed to be able to handle strings in arrays.
769
770## 1.1 Release Candidate 3
771
772This release is the eighth release candidate for 1.1, though it is the third
773release candidate meant as a general release candidate. The new code has not
774been tested as thoroughly as it should for release.
775
776## 1.1 Release Candidate 2
777
778This release is the seventh release candidate for 1.1, though it is the second
779release candidate meant as a general release candidate. The new code has not
780been tested as thoroughly as it should for release.
781
782## 1.1 FreeBSD Beta 5
783
784This release is the sixth release candidate for 1.1, though it is the fifth
785release candidate meant specifically to test if `bc` works on FreeBSD. The new
786code has not been tested as thoroughly as it should for release.
787
788## 1.1 FreeBSD Beta 4
789
790This release is the fifth release candidate for 1.1, though it is the fourth
791release candidate meant specifically to test if `bc` works on FreeBSD. The new
792code has not been tested as thoroughly as it should for release.
793
794## 1.1 FreeBSD Beta 3
795
796This release is the fourth release candidate for 1.1, though it is the third
797release candidate meant specifically to test if `bc` works on FreeBSD. The new
798code has not been tested as thoroughly as it should for release.
799
800## 1.1 FreeBSD Beta 2
801
802This release is the third release candidate for 1.1, though it is the second
803release candidate meant specifically to test if `bc` works on FreeBSD. The new
804code has not been tested as thoroughly as it should for release.
805
806## 1.1 FreeBSD Beta 1
807
808This release is the second release candidate for 1.1, though it is meant
809specifically to test if `bc` works on FreeBSD. The new code has not been tested as
810thoroughly as it should for release.
811
812## 1.1 Release Candidate 1
813
814This is the first release candidate for 1.1. The new code has not been tested as
815thoroughly as it should for release.
816
817## 1.0
818
819This is the first non-beta release. `bc` is ready for production use.
820
821As such, a lot has changed since 0.5.
822
8231.	`dc` has been added. It has been tested even more thoroughly than `bc` was
824	for `0.5`. It does not have the `!` command, and for security reasons, it
825	never will, so it is complete.
8262.	`bc` has been more thoroughly tested. An entire section of the test suite
827	(for both programs) has been added to test for errors.
8283.	A prompt (`>>> `) has been added for interactive mode, making it easier to
829	see inputs and outputs.
8304.	Interrupt handling has been improved, including elimination of race
831	conditions (as much as possible).
8325.	MinGW and [Windows Subsystem for Linux][1] support has been added (see
833	[xstatic][2] for binaries).
8346.	Memory leaks and errors have been eliminated (as far as ASan and Valgrind
835	can tell).
8367.	Crashes have been eliminated (as far as [afl][3] can tell).
8378.	Karatsuba multiplication was added (and thoroughly) tested, speeding up
838	multiplication and power by orders of magnitude.
8399.	Performance was further enhanced by using a "divmod" function to reduce
840	redundant divisions and by removing superfluous `memset()` calls.
84110.	To switch between Karatsuba and `O(n^2)` multiplication, the config variable
842	`BC_NUM_KARATSUBA_LEN` was added. It is set to a sane default, but the
843	optimal number can be found with [`karatsuba.py`][4] (requires Python 3)
844	and then configured through `make`.
84511.	The random math test generator script was changed to Python 3 and improved.
846	`bc` and `dc` have together been run through 30+ million random tests.
84712.	All known math bugs have been fixed, including out of control memory
848	allocations in `sine` and `cosine` (that was actually a parse bug), certain
849	cases of infinite loop on square root, and slight inaccuracies (as much as
850	possible; see the [README][5]) in transcendental functions.
85113.	Parsing has been fixed as much as possible.
85214.	Test coverage was improved to 94.8%. The only paths not covered are ones
853	that happen when `malloc()` or `realloc()` fails.
85415.	An extension to get the length of an array was added.
85516.	The boolean not (`!`) had its precedence change to match negation.
85617.	Data input was hardened.
85718.	`bc` was made fully compliant with POSIX when the `-s` flag is used or
858	`POSIXLY_CORRECT` is defined.
85919.	Error handling was improved.
86020.	`bc` now checks that files it is given are not directories.
861
862## 1.0 Release Candidate 7
863
864This is the seventh release candidate for 1.0. It fixes a few bugs in 1.0
865Release Candidate 6.
866
867## 1.0 Release Candidate 6
868
869This is the sixth release candidate for 1.0. It fixes a few bugs in 1.0 Release
870Candidate 5.
871
872## 1.0 Release Candidate 5
873
874This is the fifth release candidate for 1.0. It fixes a few bugs in 1.0 Release
875Candidate 4.
876
877## 1.0 Release Candidate 4
878
879This is the fourth release candidate for 1.0. It fixes a few bugs in 1.0 Release
880Candidate 3.
881
882## 1.0 Release Candidate 3
883
884This is the third release candidate for 1.0. It fixes a few bugs in 1.0 Release
885Candidate 2.
886
887## 1.0 Release Candidate 2
888
889This is the second release candidate for 1.0. It fixes a few bugs in 1.0 Release
890Candidate 1.
891
892## 1.0 Release Candidate 1
893
894This is the first Release Candidate for 1.0. `bc` is complete, with `dc`, but it
895is not tested.
896
897## 0.5
898
899This beta release completes more features, but it is still not complete nor
900tested as thoroughly as necessary.
901
902## 0.4.1
903
904This beta release fixes a few bugs in 0.4.
905
906## 0.4
907
908This is a beta release. It does not have the complete set of features, and it is
909not thoroughly tested.
910
911[1]: https://docs.microsoft.com/en-us/windows/wsl/install-win10
912[2]: https://pkg.musl.cc/bc/
913[3]: http://lcamtuf.coredump.cx/afl/
914[4]: ./karatsuba.py
915[5]: ./README.md
916[6]: ./configure.sh
917[7]: https://github.com/rain-1/linenoise-mob
918[8]: https://github.com/antirez/linenoise
919[9]: ./manuals/bc/A.1.md
920[10]: ./manuals/dc/A.1.md
921[11]: https://scan.coverity.com/projects/gavinhoward-bc
922[12]: ./locale_install.sh
923[13]: ./manuals/build.md
924[14]: https://github.com/stesser
925[15]: https://github.com/bugcrazy
926[16]: ./manuals/bc/A.1.md#extended-library
927[17]: https://github.com/skeeto/optparse
928[18]: https://www.deepl.com/translator
929[19]: ./manuals/benchmarks.md
930[20]: https://github.com/apjanke/ronn-ng
931[21]: https://pandoc.org/
932