herkforth naming conventions

This is essential for the readability.

Prefixes

• $ hex number.
• , herkforth immediates
• _ (underscore) assembler word. This word takes operands off the stack, and compiles at least one instruction.
• - used to implement word without the - prefix (probably not useful otherwise)
• ? Either do something (generally the same word without the ?) or do nothing.
• ew- (Emit Word) part of the source printing code
• ed- EDitor
• cb- Current Block
• cg- Card Game (blocks 108 and 110)

Postfixes

• ? returns true or false

Other Conventions

loads and stores contain the following characters:

• @ load
• ! store
• h half-word (16 bits)
• b byte
• + increment. if this is before the @/! then it's pre-increment, after means post-increment
• - decrement. if this is before the @/! then it's pre-decrement, after means post-decrement
• s takes address off the stack
• a uses address in the A register

Defaults:

• When you are using a default, you leave off the symbol for it.
• load/store a word (32 bits). (hence there is no w prefix)
• Use address in the A register if their is a - or +, otherwise take address off stack.

Acceptable Characters

Use all lowercase.

The system supports any char you can type that's not mapped to some action, but for future compatibility, please only use lower case letters, numbers, and the following symbols: _,!@+-*/=<>?|.;

See Also:

herkforth coding conventions

herkforth words

herkforth immediates

herkforth internals

herkforth docs

herkforth