Debian Codegraph @

upstream/mageia-cauldron/man1/bc.1

raw
1 .\"
2 .\" bc.1 - the *roff document processor source for the bc manual
3 .\"
4 .\" This file is part of GNU bc.
5 .\" Copyright (C) 1991-1994, 1997, 2000, 2003, 2006, 2017, 2024, 2025
6 .\" Free Software Foundation, Inc.
7 .\"
8 .\" This program is free software; you can redistribute it and/or modify
9 .\" it under the terms of the GNU General Public License as published by
10 .\" the Free Software Foundation; either version 2 of the License , or
11 .\" (at your option) any later version.
12 .\"
13 .\" This program is distributed in the hope that it will be useful,
14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 .\" GNU General Public License for more details.
17 .\"
18 .\" You should have received a copy of the GNU General Public License
19 .\" along with this program; see the file COPYING. If not, see
20 .\" <https://www.gnu.org/licenses/>.
21 .\"
22 .\" You may contact the author by:
23 .\" e-mail: [email protected]
24 .\" us-mail: Philip A. Nelson
25 .\" Computer Science Department, 9062
26 .\" Western Washington University
27 .\" Bellingham, WA 98226-9062
28 .\"
29 .TH bc 1 2025-01-10 "GNU Project"
30 .SH NAME
31 bc \- An arbitrary precision calculator language
32 .SH SYNTAX
33 \fBbc\fR [ \fB\-hlwsqv\fR ] [long-options] [ \fI file ...\fR ]
34 .SH DESCRIPTION
35 \fBbc\fR is a language that supports arbitrary precision numbers
36 with interactive execution of statements. There are some similarities
37 in the syntax to the C programming language.
38 A standard math library is available by command line option.
39 If requested, the math library is defined before processing any files.
40 \fBbc\fR starts by processing code from all the files listed
41 on the command line in the order listed. After all files have been
42 processed, \fBbc\fR reads from the standard input. All code is
43 executed as it is read. (If a file contains a command to halt the
44 processor, \fBbc\fR will never read from the standard input.)
45 .PP
46 This version of \fBbc\fR contains several extensions beyond
47 traditional \fBbc\fR implementations and the POSIX draft standard.
48 Command line options can cause these extensions to print a warning
49 or to be rejected. This
50 document describes the language accepted by this processor.
51 Extensions will be identified as such.
52 .SS OPTIONS
53 .IP "\-h, \-\-help"
54 Print the usage and exit.
55 .IP "\-i, \-\-interactive"
56 Force interactive mode.
57 .IP "\-l, \-\-mathlib"
58 Define the standard math library.
59 .IP "\-w, \-\-warn"
60 Give warnings for extensions to POSIX \fBbc\fR.
61 .IP "\-s, \-\-standard"
62 Process exactly the POSIX \fBbc\fR language.
63 .IP "\-q, \-\-quiet"
64 Do not print the normal GNU bc welcome.
65 .IP "\-v, \-\-version"
66 Print the version number and copyright and quit.
67 .SS NUMBERS
68 The most basic element in \fBbc\fR is the number. Numbers are
69 arbitrary precision numbers. This precision is both in the integer
70 part and the fractional part. All numbers are represented internally
71 in decimal and all computation is done in decimal. (This version
72 truncates results from divide and multiply operations.) There are two
73 attributes of numbers, the length and the scale. The length is the
74 total number of decimal digits used by \fBbc\fR to represent a number
75 and the scale is the total number of decimal digits after the decimal
76 point. For example:
77 .nf
78 .RS
79 .000001 has a length of 6 and scale of 6.
80 1935.000 has a length of 7 and a scale of 3.
81 .RE
82 .fi
83 .SS VARIABLES
84 Numbers are stored in two types of variables, simple variables and
85 arrays. Both simple variables and array variables are named. Names
86 begin with a letter followed by any number of letters, digits and
87 underscores. All letters must be lower case. (Full alphanumeric
88 names are an extension. In POSIX \fBbc\fR all names are a single
89 lower case letter.) The type of variable is clear by the context
90 because all array variable names will be followed by brackets ([]).
91 .PP
92 There are four special variables, \fBscale, ibase, obase,\fR and
93 \fBlast\fR. \fBscale\fR defines how some operations use digits after the
94 decimal point. The default value of \fBscale\fR is 0. \fBibase\fR
95 and \fBobase\fR define the conversion base for input and output
96 numbers. The default for both input and output is base 10.
97 \fBlast\fR (an extension) is a variable that has the value of the last
98 printed number. These will be discussed in further detail where
99 appropriate. All of these variables may have values assigned to them
100 as well as used in expressions.
101 .SS COMMENTS
102 Comments in \fBbc\fR start with the characters \fB/*\fR and end with
103 the characters \fB*/\fR. Comments may start anywhere and appear as a
104 single space in the input. (This causes comments to delimit other
105 input items. For example, a comment can not be found in the middle of
106 a variable name.) Comments include any newlines (end of line) between
107 the start and the end of the comment.
108 .PP
109 To support the use of scripts for \fBbc\fR, a single line comment has been
110 added as an extension. A single line comment starts at a \fB#\fR
111 character and continues to the next end of the line. The end of line
112 character is not part of the comment and is processed normally.
113 .SS EXPRESSIONS
114 The numbers are manipulated by expressions and statements. Since
115 the language was designed to be interactive, statements and expressions
116 are executed as soon as possible. There is no "main" program. Instead,
117 code is executed as it is encountered. (Functions, discussed in
118 detail later, are defined when encountered.)
119 .PP
120 A simple expression is just a constant. \fBbc\fR converts constants
121 into internal decimal numbers using the current input base, specified
122 by the variable \fBibase\fR. (There is an exception in functions.)
123 The valid values for \fBibase\fR are 2 through 36. (Bases greater than
124 16 are an extension.) Assigning a value outside this range to
125 \fBibase\fR will result in a value of 2 or 36. Input numbers may
126 contain the characters 0\(en9 and A\(enZ. (Note: They must be capitals.
127 Lower case letters are variable names.) Single digit numbers always
128 have the value of the digit regardless of the value of
129 \fBibase\fR. (i.e.\& A = 10.) For multi-digit numbers, \fBbc\fR changes
130 all input digits greater or equal to ibase to the value of
131 \fBibase\fR\-1. This makes the number \fBZZZ\fR always be the largest
132 3 digit number of the input base.
133 .PP
134 Full expressions are similar to many other high level languages.
135 Since there is only one kind of number, there are no rules for mixing
136 types. Instead, there are rules on the scale of expressions. Every
137 expression has a scale. This is derived from the scale of original
138 numbers, the operation performed and in many cases, the value of the
139 variable \fBscale\fR.
140 Valid values of the variable \fBscale\fR are
141 0 to the maximum number representable by a C integer.
142 .PP
143 In the following descriptions of valid expressions, "expr" refers to a
144 complete expression and "var" refers to a simple or an array variable.
145 A simple variable is just a
146 .RS
147 \fIname\fR
148 .RE
149 and an array variable is specified as
150 .RS
151 \fIname\fR[\fIexpr\fR]
152 .RE
153 Unless specifically
154 mentioned the scale of the result is the maximum scale of the
155 expressions involved.
156 .IP "\- expr"
157 The result is the negation of the expression.
158 .IP "++ var"
159 The variable is incremented by one and the new value is the result of
160 the expression.
161 .IP "\-\- var"
162 The variable
163 is decremented by one and the new value is the result of the
164 expression.
165 .IP "var ++"
166 The result of the expression is the value of
167 the variable and then the variable is incremented by one.
168 .IP "var \-\-"
169 The result of the expression is the value of the variable and then
170 the variable is decremented by one.
171 .IP "expr + expr"
172 The result of the expression is the sum of the two expressions.
173 .IP "expr \- expr"
174 The result of the expression is the difference of the two expressions.
175 .IP "expr * expr"
176 The result of the expression is the product of the two expressions.
177 .IP "expr / expr"
178 The result of the expression is the quotient of the two expressions.
179 The scale of the result is the value of the variable \fBscale\fR.
180 .IP "expr % expr"
181 The result of the expression is the "remainder" and it is computed in the
182 following way. To compute a%b, first a/b is computed to \fBscale\fR
183 digits. That result is used to compute a\-(a/b)*b to the scale of the
184 maximum of \fBscale\fR+scale(b) and scale(a). If \fBscale\fR is set
185 to zero and both expressions are integers this expression is the
186 integer remainder function.
187 .IP "expr ^ expr"
188 The result of the expression is the value of the first raised to the
189 second. The second expression must be an integer. (If the second
190 expression is not an integer, a warning is generated and the
191 expression is truncated to get an integer value.) The scale of the
192 result is \fBscale\fR if the exponent is negative. If the exponent
193 is positive the scale of the result is the minimum of the scale of the
194 first expression times the value of the exponent and the maximum of
195 \fBscale\fR and the scale of the first expression. (e.g.\& scale(a^b)
196 = min(scale(a)*b, max( \fBscale,\fR scale(a))).) It should be noted
197 that expr^0 will always return the value of 1.
198 .IP "( expr )"
199 This alters the standard precedence to force the evaluation of the
200 expression.
201 .IP "var = expr"
202 The variable is assigned the value of the expression.
203 .IP "var <op>= expr"
204 This is equivalent to "var = var <op> expr" with the exception that
205 the "var" part is evaluated only once. This can make a difference if
206 "var" is an array.
207 .PP
208 Relational expressions are a special kind of expression
209 that always evaluate to 0 or 1, 0 if the relation is false and 1 if
210 the relation is true. These may appear in any valid expression.
211 (POSIX bc requires that relational expressions are used only in if,
212 while, and for statements and that only one relational test may be
213 done in them.) The relational operators are
214 .IP "expr1 < expr2"
215 The result is 1 if expr1 is strictly less than expr2.
216 .IP "expr1 <= expr2"
217 The result is 1 if expr1 is less than or equal to expr2.
218 .IP "expr1 > expr2"
219 The result is 1 if expr1 is strictly greater than expr2.
220 .IP "expr1 >= expr2"
221 The result is 1 if expr1 is greater than or equal to expr2.
222 .IP "expr1 == expr2"
223 The result is 1 if expr1 is equal to expr2.
224 .IP "expr1 != expr2"
225 The result is 1 if expr1 is not equal to expr2.
226 .PP
227 Boolean operations are also valid. (POSIX \fBbc\fR does NOT have
228 boolean operations). The result of all boolean operations are 0 and 1
229 (for false and true) as in relational expressions. The boolean
230 operators are:
231 .IP "!expr"
232 The result is 1 if expr is 0.
233 .IP "expr && expr"
234 The result is 1 if both expressions are non-zero.
235 .IP "expr || expr"
236 The result is 1 if either expression is non-zero.
237 .PP
238 The expression precedence is as follows: (lowest to highest)
239 .nf
240 .RS
241 || operator, left associative
242 && operator, left associative
243 ! operator, nonassociative
244 Relational operators, left associative
245 Assignment operator, right associative
246 + and \- operators, left associative
247 *, / and % operators, left associative
248 ^ operator, right associative
249 unary \- operator, nonassociative
250 ++ and \-\- operators, nonassociative
251 .RE
252 .fi
253 .PP
254 This precedence was chosen so that POSIX compliant \fBbc\fR programs
255 will run correctly. This will cause the use of the relational and
256 logical operators to have some unusual behavior when used with
257 assignment expressions. Consider the expression:
258 .RS
259 a = 3 < 5
260 .RE
261 .PP
262 Most C programmers would assume this would assign the result of "3 <
263 5" (the value 1) to the variable "a". What this does in \fBbc\fR is
264 assign the value 3 to the variable "a" and then compare 3 to 5. It is
265 best to use parenthesis when using relational and logical operators
266 with the assignment operators.
267 .PP
268 There are a few more special expressions that are provided in \fBbc\fR.
269 These have to do with user defined functions and standard
270 functions. They all appear as "\fIname\fB(\fIparameters\fB)\fR".
271 See the section on functions for user defined functions. The standard
272 functions are:
273 .IP "length ( expression )"
274 The value of the length function is the number of significant digits in the
275 expression.
276 .IP "read ( )"
277 The read function (an extension) will read a number from the standard
278 input, regardless of where the function occurs. Beware, this can
279 cause problems with the mixing of data and program in the standard input.
280 The best use for this function is in a previously written program that
281 needs input from the user, but never allows program code to be input
282 from the user. The value of the read function is the number read from
283 the standard input using the current value of the variable
284 \fBibase\fR for the conversion base.
285 .IP "scale ( expression )"
286 The value of the scale function is the number of digits after the decimal
287 point in the expression.
288 .IP "sqrt ( expression )"
289 The value of the sqrt function is the square root of the expression. If
290 the expression is negative, a run time error is generated.
291 .SS STATEMENTS
292 Statements (as in most algebraic languages) provide the sequencing of
293 expression evaluation. In \fBbc\fR statements are executed "as soon
294 as possible". Execution happens when a newline in encountered and
295 there is one or more complete statements. Due to this immediate
296 execution, newlines are very important in \fBbc\fR. In fact, both a
297 semicolon and a newline are used as statement separators. An
298 improperly placed newline will cause a syntax error. Because newlines
299 are statement separators, it is possible to hide a newline by using
300 the backslash character. The sequence "\e<nl>", where <nl> is the
301 newline appears to \fBbc\fR as whitespace instead of a newline. A
302 statement list is a series of statements separated by semicolons and
303 newlines. The following is a list of \fBbc\fR statements and what
304 they do: (Things enclosed in brackets ([]) are optional parts of the
305 statement.)
306 .IP "expression"
307 This statement does one of two things. If the expression starts with
308 "<variable> <assignment> ...", it is considered to be an assignment
309 statement. If the expression is not an assignment statement, the
310 expression is evaluated and printed to the output. After the number
311 is printed, a newline is printed. For example, "a=1" is an assignment
312 statement and "(a=1)" is an expression that has an embedded
313 assignment. All numbers that are printed are printed in the base
314 specified by the variable \fBobase\fR.
315 The valid values for \fBobase\fR are 2 through BC_BASE_MAX.
316 (See the section LIMITS.) For
317 bases 2 through 16, the usual method of writing numbers is used. For
318 bases greater than 16, \fBbc\fR uses a multi-character digit method
319 of printing the numbers where each higher base digit is printed as a
320 base 10 number. The multi-character digits are separated by spaces.
321 Each digit contains the number of characters required to represent the
322 base ten value of "obase\-1". Since numbers are of arbitrary
323 precision, some numbers may not be printable on a single output line.
324 These long numbers will be split across lines using the "\e" as the
325 last character on a line. The maximum number of characters printed
326 per line is 70. Due to the interactive nature of \fBbc\fR, printing
327 a number causes the side effect of assigning the printed value to the
328 special variable \fBlast\fR. This allows the user to recover the
329 last value printed without having to retype the expression that
330 printed the number. Assigning to \fBlast\fR is valid and will
331 overwrite the last printed value with the assigned value. The newly
332 assigned value will remain until the next number is printed or another
333 value is assigned to \fBlast\fR. (Some installations may allow the
334 use of a single period (.) which is not part of a number as a short
335 hand notation for \fBlast\fR.)
336 .IP "string"
337 The string is printed to the output. Strings start with a double quote
338 character and contain all characters until the next double quote character.
339 All characters are take literally, including any newline. No newline
340 character is printed after the string.
341 .IP "\fBprint\fR list"
342 The print statement (an extension) provides another method of output.
343 The "list" is a list of strings and expressions separated by commas.
344 Each string or expression is printed in the order of the list. No
345 terminating newline is printed. Expressions are evaluated and their
346 value is printed and assigned to the variable \fBlast\fR. Strings
347 in the print statement are printed to the output and may contain
348 special characters. Special characters start with the backslash
349 character (\e). The special characters recognized by \fBbc\fR are
350 "a" (alert or bell), "b" (backspace), "f" (form feed), "n" (newline),
351 "r" (carriage return), "q" (double quote), "t" (tab), and "\e" (backslash).
352 Any other character following the backslash will be ignored.
353 .IP "{ statement_list }"
354 This is the compound statement. It allows multiple statements to be
355 grouped together for execution.
356 .IP "\fBif\fR ( expression ) statement1 [\fBelse\fR statement2]"
357 The if statement evaluates the expression and executes statement1 or
358 statement2 depending on the value of the expression. If the expression
359 is non-zero, statement1 is executed. If statement2 is present and
360 the value of the expression is 0, then statement2 is executed. (The
361 else clause is an extension.)
362 .IP "\fBwhile\fR ( expression ) statement"
363 The while statement will execute the statement while the expression
364 is non-zero. It evaluates the expression before each execution of
365 the statement. Termination of the loop is caused by a zero
366 expression value or the execution of a break statement.
367 .IP "\fBfor\fR ( [expression1] ; [expression2] ; [expression3] ) statement"
368 The for statement controls repeated execution of the statement.
369 Expression1 is evaluated before the loop. Expression2 is evaluated
370 before each execution of the statement. If it is non-zero, the statement
371 is evaluated. If it is zero, the loop is terminated. After each
372 execution of the statement, expression3 is evaluated before the reevaluation
373 of expression2. If expression1 or expression3 are missing, nothing is
374 evaluated at the point they would be evaluated.
375 If expression2 is missing, it is the same as substituting
376 the value 1 for expression2. (The optional expressions are an
377 extension. POSIX \fBbc\fR requires all three expressions.)
378 The following is equivalent code for the for statement:
379 .nf
380 .RS
381 expression1;
382 while (expression2) {
383 statement;
384 expression3;
385 }
386 .RE
387 .fi
388 .IP "\fBbreak\fR"
389 This statement causes a forced exit of the most recent enclosing while
390 statement or for statement.
391 .IP "\fBcontinue\fR"
392 The continue statement (an extension) causes the most recent enclosing
393 for statement to start the next iteration.
394 .IP "\fBhalt\fR"
395 The halt statement (an extension) is an executed statement that causes
396 the \fBbc\fR processor to quit only when it is executed. For example,
397 "if (0 == 1) halt" will not cause \fBbc\fR to terminate because the halt is
398 not executed.
399 .IP "\fBreturn\fR"
400 Return the value 0 from a function. (See the section on functions.)
401 .IP "\fBreturn\fR ( expression )"
402 Return the value of the expression from a function. (See the section on
403 functions.) As an extension, the parenthesis are not required.
404 .SS PSEUDO STATEMENTS
405 These statements are not statements in the traditional sense. They are
406 not executed statements. Their function is performed at "compile" time.
407 .IP "\fBlimits\fR"
408 Print the local limits enforced by the local version of \fBbc\fR. This
409 is an extension.
410 .IP "\fBquit\fR"
411 When the quit statement is read, the \fBbc\fR processor
412 is terminated, regardless of where the quit statement is found. For
413 example, "if (0 == 1) quit" will cause \fBbc\fR to terminate.
414 .IP "\fBwarranty\fR"
415 Print a longer warranty notice. This is an extension.
416 .SS FUNCTIONS
417 Functions provide a method of defining a computation that can be executed
418 later. Functions in
419 .B bc
420 always compute a value and return it to the caller. Function definitions
421 are "dynamic" in the sense that a function is undefined until a definition
422 is encountered in the input. That definition is then used until another
423 definition function for the same name is encountered. The new definition
424 then replaces the older definition. A function is defined as follows:
425 .nf
426 .RS
427 \fBdefine \fIname \fB( \fIparameters \fB) { \fInewline
428 \fI auto_list statement_list \fB}\fR
429 .RE
430 .fi
431 A function call is just an expression of the form
432 "\fIname\fB(\fIparameters\fB)\fR".
433 .PP
434 Parameters are numbers or arrays (an extension). In the function definition,
435 zero or more parameters are defined by listing their names separated by
436 commas. All parameters are call by value parameters.
437 Arrays are specified in the parameter definition by
438 the notation "\fIname\fB[]\fR". In the function call, actual parameters
439 are full expressions for number parameters. The same notation is used
440 for passing arrays as for defining array parameters. The named array is
441 passed by value to the function. Since function definitions are dynamic,
442 parameter numbers and types are checked when a function is called. Any
443 mismatch in number or types of parameters will cause a runtime error.
444 A runtime error will also occur for the call to an undefined function.
445 .PP
446 The \fIauto_list\fR is an optional list of variables that are for
447 "local" use. The syntax of the auto list (if present) is "\fBauto
448 \fIname\fR, ... ;". (The semicolon is optional.) Each \fIname\fR is
449 the name of an auto variable. Arrays may be specified by using the
450 same notation as used in parameters. These variables have their
451 values pushed onto a stack at the start of the function. The
452 variables are then initialized to zero and used throughout the
453 execution of the function. At function exit, these variables are
454 popped so that the original value (at the time of the function call)
455 of these variables are restored. The parameters are really auto
456 variables that are initialized to a value provided in the function
457 call. Auto variables are different than traditional local variables
458 because if function A calls function B, B may access function
459 A's auto variables by just using the same name, unless function B has
460 called them auto variables. Due to the fact that auto variables and
461 parameters are pushed onto a stack, \fBbc\fR supports recursive functions.
462 .PP
463 The function body is a list of \fBbc\fR statements. Again, statements
464 are separated by semicolons or newlines. Return statements cause the
465 termination of a function and the return of a value. There are two
466 versions of the return statement. The first form, "\fBreturn\fR", returns
467 the value 0 to the calling expression. The second form,
468 "\fBreturn ( \fIexpression \fB)\fR", computes the value of the expression
469 and returns that value to the calling expression. There is an implied
470 "\fBreturn (0)\fR" at the end of every function. This allows a function
471 to terminate and return 0 without an explicit return statement.
472 .PP
473 Functions also change the usage of the variable \fBibase\fR. All
474 constants in the function body will be converted using the value of
475 \fBibase\fR at the time of the function call. Changes of \fBibase\fR
476 will be ignored during the execution of the function except for the
477 standard function \fBread\fR, which will always use the current value
478 of \fBibase\fR for conversion of numbers.
479 .PP
480 Several extensions have been added to functions. First, the format of
481 the definition has been slightly relaxed. The standard requires the
482 opening brace be on the same line as the \fBdefine\fR keyword and all
483 other parts must be on following lines. This version of \fBbc\fR will
484 allow any number of newlines before and after the opening brace of the
485 function. For example, the following definitions are valid.
486 .nf
487 .RS
488 \f(CR
489 define d (n) { return (2*n); }
490 define d (n)
491 { return (2*n); }
492 .\fR
493 .RE
494 .fi
495 .PP
496 Functions may be defined as \fBvoid\fR. A void
497 function returns no value and thus may not be used in any place that needs
498 a value. A void function does not produce any output when called by itself
499 on an input line. The key word \fBvoid\fR is placed between the key word
500 \fBdefine\fR and the function name. For example, consider the following
501 session.
502 .nf
503 .RS
504 \f(CR
505 define py (y) { print "\-\-\->", y, "<\-\-\-", "\en"; }
506 define void px (x) { print "\-\-\->", x, "<\-\-\-", "\en"; }
507 py(1)
508 \-\-\->1<\-\-\-
509 0
510 px(1)
511 \-\-\->1<\-\-\-
512 .\fR
513 .RE
514 .fi
515 Since \fBpy\fR is not a void function, the call of \fBpy(1)\fR prints
516 the desired output and then prints a second line that is the value of
517 the function. Since the value of a function that is not given an
518 explicit return statement is zero, the zero is printed. For \fBpx(1)\fR,
519 no zero is printed because the function is a void function.
520 .PP
521 Also, call by variable for arrays was added. To declare
522 a call by variable array, the declaration of the array parameter in the
523 function definition looks like "\fI*name\fB[]\fR". The call to the
524 function remains the same as call by value arrays.
525 .SS MATH LIBRARY
526 If \fBbc\fR is invoked with the \fB\-l\fR option, a math library is preloaded
527 and the default scale is set to 20. The math functions will calculate their
528 results to the scale set at the time of their call.
529 The math library defines the following functions:
530 .IP "s (\fIx\fR)"
531 The sine of x, x is in radians.
532 .IP "c (\fIx\fR)"
533 The cosine of x, x is in radians.
534 .IP "a (\fIx\fR)"
535 The arctangent of x, arctangent returns radians.
536 .IP "l (\fIx\fR)"
537 The natural logarithm of x.
538 .IP "e (\fIx\fR)"
539 The exponential function of raising e to the value x.
540 .IP "j (\fIn,x\fR)"
541 The Bessel function of integer order n of x.
542 .SS EXAMPLES
543 In /bin/sh, the following will assign the value of "pi" to the shell
544 variable \fBpi\fR.
545 .RS
546 \f(CR
547 pi=$(echo "scale=10; 4*a(1)" | bc \-l)
548 .\fR
549 .RE
550 .PP
551 The following is the definition of the exponential function used in the
552 math library. This function is written in POSIX \fBbc\fR.
553 .nf
554 .RS
555 \f(CR
556 scale = 20
557
558 /* Uses the fact that e^x = (e^(x/2))^2
559 When x is small enough, we use the series:
560 e^x = 1 + x + x^2/2! + x^3/3! + ...
561 */
562
563 define e(x) {
564 auto a, d, e, f, i, m, v, z
565
566 /* Check the sign of x. */
567 if (x<0) {
568 m = 1
569 x = \-x
570 }
571
572 /* Precondition x. */
573 z = scale;
574 scale = 4 + z + .44*x;
575 while (x > 1) {
576 f += 1;
577 x /= 2;
578 }
579
580 /* Initialize the variables. */
581 v = 1+x
582 a = x
583 d = 1
584
585 for (i=2; 1; i++) {
586 e = (a *= x) / (d *= i)
587 if (e == 0) {
588 if (f>0) while (f\-\-) v = v*v;
589 scale = z
590 if (m) return (1/v);
591 return (v/1);
592 }
593 v += e
594 }
595 }
596 .\fR
597 .RE
598 .fi
599 .PP
600 The following is code that uses the extended features of \fBbc\fR to
601 implement a simple program for calculating checkbook balances. This
602 program is best kept in a file so that it can be used many times
603 without having to retype it at every use.
604 .nf
605 .RS
606 \f(CR
607 scale=2
608 print "\enCheck book program!\en"
609 print " Remember, deposits are negative transactions.\en"
610 print " Exit by a 0 transaction.\en\en"
611
612 print "Initial balance? "; bal = read()
613 bal /= 1
614 print "\en"
615 while (1) {
616 "current balance = "; bal
617 "transaction? "; trans = read()
618 if (trans == 0) break;
619 bal \-= trans
620 bal /= 1
621 }
622 quit
623 .\fR
624 .RE
625 .fi
626 .PP
627 The following is the definition of the recursive factorial function.
628 .nf
629 .RS
630 \f(CR
631 define f (x) {
632 if (x <= 1) return (1);
633 return (f(x\-1) * x);
634 }
635 .\fR
636 .RE
637 .fi
638 .SS READLINE AND LIBEDIT OPTIONS
639 GNU \fBbc\fR can be compiled (via a configure option) to use the GNU
640 \fBreadline\fR input editor library or the BSD \fBlibedit\fR library.
641 This allows the user to do editing of lines before sending them
642 to \fBbc\fR. It also allows for a history of previous lines typed.
643 When this option is selected, \fBbc\fR has one more special variable.
644 This special variable, \fBhistory\fR is the number of lines of history
645 retained. For \fBreadline\fR, a value of \-1 means that an unlimited
646 number of history lines are retained. Setting the value of
647 \fBhistory\fR to a positive number restricts the number of history
648 lines to the number given. The value of 0 disables the history
649 feature. The default value is 100. For more information, read the
650 user manuals for the GNU \fBreadline\fR, \fBhistory\fR and BSD \fBlibedit\fR
651 libraries. One can not enable both \fBreadline\fR and \fBlibedit\fR
652 at the same time.
653 .SS DIFFERENCES
654 This version of
655 .B bc
656 was implemented from the POSIX P1003.2/D11 draft and contains
657 several differences and extensions relative to the draft and
658 traditional implementations.
659 It is not implemented in the traditional way using
660 .BR dc (1).
661 This version is a single process which parses and runs a byte code
662 translation of the program. There is an "undocumented" option (\-c)
663 that causes the program to output the byte code to
664 the standard output instead of running it. It was mainly used for
665 debugging the parser and preparing the math library.
666 .PP
667 A major source of differences is
668 extensions, where a feature is extended to add more functionality and
669 additions, where new features are added.
670 The following is the list of differences and extensions.
671 .IP "LANG environment"
672 This version does not conform to the POSIX standard in the processing
673 of the LANG environment variable and all environment variables starting
674 with LC_.
675 .IP "names"
676 Traditional and POSIX
677 .B bc
678 have single letter names for functions, variables and arrays. They have
679 been extended to be multi-character names that start with a letter and
680 may contain letters, numbers and the underscore character.
681 .IP "Strings"
682 Strings are not allowed to contain NUL characters. POSIX says all characters
683 must be included in strings.
684 .IP "last"
685 POSIX \fBbc\fR does not have a \fBlast\fR variable. Some implementations
686 of \fBbc\fR use the period (.) in a similar way.
687 .IP "comparisons"
688 POSIX \fBbc\fR allows comparisons only in the if statement, the while
689 statement, and the second expression of the for statement. Also, only
690 one relational operation is allowed in each of those statements.
691 .IP "if statement, else clause"
692 POSIX \fBbc\fR does not have an else clause.
693 .IP "for statement"
694 POSIX \fBbc\fR requires all expressions to be present in the for statement.
695 .IP "&&, ||, !"
696 POSIX \fBbc\fR does not have the logical operators.
697 .IP "read function"
698 POSIX \fBbc\fR does not have a read function.
699 .IP "print statement"
700 POSIX \fBbc\fR does not have a print statement .
701 .IP "continue statement"
702 POSIX \fBbc\fR does not have a continue statement.
703 .IP "return statement"
704 POSIX \fBbc\fR requires parentheses around the return expression.
705 .IP "array parameters"
706 POSIX \fBbc\fR does not (currently) support array parameters in full.
707 The POSIX grammar allows for arrays in function definitions, but does
708 not provide a method to specify an array as an actual parameter. (This
709 is most likely an oversight in the grammar.) Traditional implementations
710 of \fBbc\fR have only call by value array parameters.
711 .IP "function format"
712 POSIX \fBbc\fR requires the opening brace on the same line as the
713 \fBdefine\fR key word and the \fBauto\fR statement on the next line.
714 .IP "=+, =\-, =*, =/, =%, =^"
715 POSIX \fBbc\fR does not require these "old style" assignment operators to
716 be defined. This version may allow these "old style" assignments. Use
717 the limits statement to see if the installed version supports them. If
718 it does support the "old style" assignment operators, the statement
719 "a =\- 1" will decrement \fBa\fR by 1 instead of setting \fBa\fR to the
720 value \-1.
721 .IP "spaces in numbers"
722 Other implementations of \fBbc\fR allow spaces in numbers. For example,
723 "x=1 3" would assign the value 13 to the variable x. The same statement
724 would cause a syntax error in this version of \fBbc\fR.
725 .IP "errors and execution"
726 This implementation varies from other implementations in terms of what
727 code will be executed when syntax and other errors are found in the
728 program. If a syntax error is found in a function definition, error
729 recovery tries to find the beginning of a statement and continue to
730 parse the function. Once a syntax error is found in the function, the
731 function will not be callable and becomes undefined.
732 Syntax errors in the interactive execution code will invalidate the
733 current execution block. The execution block is terminated by an
734 end of line that appears after a complete sequence of statements.
735 For example,
736 .nf
737 .RS
738 a = 1
739 b = 2
740 .RE
741 .fi
742 has two execution blocks and
743 .nf
744 .RS
745 { a = 1
746 b = 2 }
747 .RE
748 .fi
749 has one execution block. Any runtime error will terminate the execution
750 of the current execution block. A runtime warning will not terminate the
751 current execution block.
752 .IP "Interrupts"
753 During an interactive session, the SIGINT signal (usually generated by
754 the control-C character from the terminal) will cause execution of the
755 current execution block to be interrupted. It will display a "runtime"
756 error indicating which function was interrupted. After all runtime
757 structures have been cleaned up, a message will be printed to notify the
758 user that \fBbc\fR is ready for more input. All previously defined functions
759 remain defined and the value of all non-auto variables are the value at
760 the point of interruption. All auto variables and function parameters
761 are removed during the
762 clean up process. During a non-interactive
763 session, the SIGINT signal will terminate the entire run of \fBbc\fR.
764 .SS LIMITS
765 The following are the limits currently in place for this
766 .B bc
767 processor. Some of them may have been changed by an installation.
768 Use the limits statement to see the actual values.
769 .IP "BC_BASE_MAX"
770 The maximum output base is at least 10^9.
771 The maximum input base is 16.
772 .IP "BC_DIM_MAX"
773 This is currently an arbitrary limit of 65535 as distributed. Your
774 installation may be different.
775 .IP "BC_SCALE_MAX"
776 The number of digits after the decimal point is limited to INT_MAX digits.
777 Also, the number of digits before the decimal point is limited to INT_MAX
778 digits.
779 .IP "BC_STRING_MAX"
780 The limit on the number of characters in a string is INT_MAX characters.
781 .IP "exponent"
782 The value of the exponent in the raise operation (^) is limited to LONG_MAX.
783 .IP "variable names"
784 The current limit on the number of unique names is 32767 for each of
785 simple variables, arrays and functions.
786 .SH ENVIRONMENT VARIABLES
787 The following environment variables are processed by \fBbc\fR:
788 .IP "POSIXLY_CORRECT"
789 This is the same as the \fB\-s\fR option.
790 .IP "BC_ENV_ARGS"
791 This is another mechanism to get arguments to \fBbc\fR. The
792 format is the same as the command line arguments. These arguments
793 are processed first, so any files listed in the environment arguments
794 are processed before any command line argument files. This allows
795 the user to set up "standard" options and files to be processed
796 at every invocation of \fBbc\fR. The files in the environment
797 variables would typically contain function definitions for functions
798 the user wants defined every time \fBbc\fR is run.
799 .IP "BC_LINE_LENGTH"
800 This should be an integer specifying the number of characters in an
801 output line for numbers. This includes the backslash and newline characters
802 for long numbers. As an extension, the value of zero disables the
803 multi-line feature. Any other value of this variable that is less than
804 3 sets the line length to 70.
805 .SH DIAGNOSTICS
806 If any file on the command line can not be opened, \fBbc\fR will report
807 that the file is unavailable and terminate. Also, there are compile
808 and run time diagnostics that should be self-explanatory.
809 .SH BUGS
810 Error recovery is not very good yet.
811 .PP
812 Email bug reports to
813 .BR [email protected] .
814 Be sure to include the word ``bc'' somewhere in the ``Subject:'' field.
815 .SH AUTHOR
816 .nf
817 Philip A. Nelson
818 [email protected]
819 .fi
820 .SH ACKNOWLEDGEMENTS
821 The author would like to thank Steve Sommars ([email protected]) for
822 his extensive help in testing the implementation. Many great suggestions
823 were given. This is a much better product due to his involvement.