Forth Lesson 2
Review
In the previous lesson we learned to:
- Display the stack with "showstack" and ".s"
- Push numbers on the stack by typing them
- Control the number base with "hex" and "decimal"
- Execute words by typing their names
Stack Diagrams
Pay attention to this section because it introduces notation that will be used over and over.
Since Forth words use the stack for arguments and results, their description must tell you the arguments that they pop from the stack and the results that they push back on the stack. That is done with a "stack diagram". Important: The following is notation that is used for documenting/describing Forth words; it is not what you type verbatim at the ok prompt. The only part of the following that you would actually type when interacting with Forth is the "+"; the stuff inside the parentheses is commentary to inform you what happens to the stack if you type "+". If you were writing Forth code into a text file, you probably would write the parenthesized stuff, as documentation, but it has no function other than as a note to a human.
+ ( n1 n2 -- n3 )
That indicates that the Forth word "+", which we saw in the last lesson, takes two numbers n1 and n2 off the stack and replaces them with one number n3. The list of items before the "--" is the arguments, the list after is the results. In each list, the item at the right is on the top of the stack, with other items below it.
In general, Forth words can take any number of arguments and leave any number of results.
This is purely a notation convention. The Forth interpreter skips stack diagrams without any other processing. The way it knows to skip them is because the Forth word "( " (which must be followed by a space, like all Forth words) introduces a comment, which is terminated by the next ")". You can write anything you want inside of comments "( ... )"; it doesn't have to be a stack diagram. By convention, though, if you see a comment that immediately follows the name of a newly-defined word, it is probably a stack diagram. When you write Forth code to save, you should include a stack diagram after the name of each word that you define.
Another example:
showstack ( -- )
That means that "showstack" has no net stack effect. It doesn't pop anything off the stack (no arguments) and it doesn't leave any extra items on the stack after it finishes. It might push and pop numbers while it is executing, but when it is done, the stack is the same as it was before.
. ( n -- )
The word "." (which displays a number), pops its one argument from the stack and leaves nothing in its place.
The names in the argument and result lists (e.g. "n1", "n2", "n3") are arbitrary, but as an aid to understanding, they are usually chosen to convey extra information. For example:
type ( adr len -- )
We haven't seen the word "type" yet, but clearly it takes two arguments, a length on the top of the stack and an address below that. It pops both of the arguments from the stack, leaving nothing in their place.
Conventionally, stack item names beginning with "n" refer to signed integers, "u" to unsigned integers, "d" to double numbers (two stack numbers interpreted as a 64-bit integer), "adr" to addresses, "flag" to values that are either true (0xfffffff) or false (0). But that is not a hard and fast rule.
How Comments Work
The following is in some sense an implementation detail, but it's good to understand it, because it is key to Forth's approach to syntax, which is vastly different to most other languages.
In the section above I mentioned that the word "(" skips to the next ")". That might seem like an exception to the rule that the interpreter only parses whitespace-delimited words, but it is not.
What actually happens is that the main interpreter loop only sees the "(". The "(" must be followed by whitespace, otherwise the interpreter will not parse just "(" but rather some longer string beginning with "(". The interpreter then looks in the list of defined words for one named "(", and executes it.
The behavior of the "(" word is to call the parser, asking it to collect a sequence of characters delimited by ")", and then to discard the result. So
- Any word - not just the main interpreter - can call the input parser.
- The parser itself can use any character - not just whitespace - as a delimiter. The main interpreter only asks the parser for whitespace-delimited words, but other words can and do parse using other delimiters.
- This same approach (main interpreter calls a word that then parses using a different delimiter) is also used for string literals where the delimiter is ".
- You can, if you wish, call the parser yourself from user code, to collect any kind of string you want. It's best to use this capability sparingly to avoid confusion, but it illustrates the fact that the entire Forth system is available to you; nothing is magic or hidden.
Comment to End of Line
The "( .... )" comment form stops at the ")"; stuff after it will be interpreted as usual. To comment out everything else on the line, use "\".
\ everything after the first \ will be ignored
Note that the "\" must be followed by whitespace, because "\" is just a word like anything else. The way that "\" works is to call the parser with a delimiter value (-1) that can't possibly match a character, discarding the result. The parser will stop at the end of the line, not having found a delimiter. (Recall from a previous lesson that input is processed a line at a time.)
Thus endeth the lesson.