better documentation
[rrq/rrqforth.git] / adoc / p_temp.adoc
1 // temp.asm:    WORD p_temp,'TEMP',fasm
2
3 anchor:p_temp[]
4
5 === Word: TEMP
6
7 ****
8 Data stack: ( size -- addr )
9 ****
10
11 "TEMP" is a function word that "allocates" a <<p_tempspace,TEMPSPACE>>
12 area of given size and returns its base address. The allocation is
13 temporary and only valid until there is a later allocation that
14 overruns this area.
15
16 Allocations are done in succession until the requested size overruns
17 the <<p_tempspace,TEMPSPACE>>. If so, the allocation pointer is reset
18 and the space is allocated from start again. This is all intended for
19 small and short-lived data areas.
20
21