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