forthgforth

What does "local variable" mean in the Forth programming language?


In C, local variables exist inside of a function and contain the values like this:

void main(){
    int a = 5;
    int b = 9;
}

In the Gforth manual, they describe the local variables like this:

: swap { a b -- b a }
  b a ;
1 2 swap .s 2drop

but it seems like a function which is taking two arguments, a and b.

Another tutorial on the Forth language shows a variable like this:

variable a
3 a !    ( ! to store the value )

So, which one is correct?


Solution

  • In Forth, local variables are described by the following syntax (see also 13.6.2.2550 {:):

    {: args [ | vals ] [ ā€“ā€“ outs ] :}

    where each of args, vals and outs represents space-delimited names (the parts in square brackets are optional). These names are interpreted as follows:

    Gforth uses { ... } notation for locals as an alternative to the standard one.

    So, swap can be defined as:

    : swap {: a b :} b a ;
    

    It takes two values from the stack into a and b local variables, and then puts them back on the stack in the reversed order.

    An example of use an uninitialized local variable:

    : exch ( x2 addr -- x1 ) {: a | x1 :}
      a @ to x1 a ! x1
    ;
    

    The optional -- ... part is allowed to mimic a stack diagram, i.e., to unite the declaration of locals and the stack diagram for a word. For example:

    : umin {: u2 u1 -- u2|u1 :} u2 u1 u< if u2 else u1 then ;
    

    Without special optimizations, performance of local variables is slightly worse than of a little stack juggling.