Debian Codegraph @

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