Annotation of gforth/kernel/vars.fs, revision 1.18
1.1 anton 1: \ VARS.FS Kernal variables
2:
1.6 anton 3: \ Copyright (C) 1995,1996,1997,1998 Free Software Foundation, Inc.
1.1 anton 4:
5: \ This file is part of Gforth.
6:
7: \ Gforth is free software; you can redistribute it and/or
8: \ modify it under the terms of the GNU General Public License
9: \ as published by the Free Software Foundation; either version 2
10: \ of the License, or (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; if not, write to the Free Software
19: \ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20:
21: hex \ everything now hex! 11may93jaw
22:
23: \ important constants 17dec92py
24:
25: \ dpANS6 (sect 3.1.3.1) says
26: \ "a true flag ... [is] a single-cell value with all bits set"
27: \ better definition: 0 0= constant true ( no dependence on 2's compl)
1.10 crook 28: -1 Constant true ( -- f ) \ core-ext
1.17 crook 29: \G CONSTANT: @i{f} is a cell with all bits set.
1.10 crook 30: \ see starts looking for primitives after this word!
31:
32: 0 Constant false ( -- f ) \ core-ext
1.17 crook 33: \G CONSTANT: @i{f} is a cell with all bits clear.
1.1 anton 34:
1.16 jwilke 35: [IFUNDEF] cell
1.1 anton 36: 1 cells Constant cell ( -- u ) \ gforth
1.17 crook 37: \G CONSTANT: the number of address units corresponding to 1 cell.
1.16 jwilke 38: [THEN]
1.17 crook 39:
1.1 anton 40: 1 floats Constant float ( -- u ) \ gforth
1.17 crook 41: \G CONSTANT: the number of address units corresponding to a floating-point number.
1.1 anton 42:
1.10 crook 43: 20 Constant bl ( -- c-char ) \ core
1.17 crook 44: \G @i{c-char} is the character value for a space.
1.10 crook 45: \ used by docon:, must be constant
1.1 anton 46:
47: FF Constant /line
48:
49: 40 Constant c/l
50: 10 Constant l/s
51: 400 Constant chars/block
52:
1.18 ! jwilke 53: 20 8 2* cells + 2 + cell+ constant word-pno-size ( -- u )
1.11 anton 54: create holdbuf word-pno-size chars allot
55: holdbuf word-pno-size chars + aconstant holdbuf-end
56: avariable holdptr holdbuf-end holdptr a!
1.12 anton 57: avariable holdend holdbuf-end holdend a!
1.11 anton 58:
1.2 anton 59: 84 constant pad-minsize ( -- u )
1.11 anton 60:
1.2 anton 61:
1.1 anton 62: \ that's enough so long
63:
64: \ User variables 13feb93py
65:
66: \ initialized by COLD
67:
1.7 pazsan 68: Create main-task has? OS [IF] 100 [ELSE] 40 [THEN] cells allot
1.3 jwilke 69:
70: \ set user-pointer from cross-compiler right
71: main-task
72: UNLOCK tup ! LOCK
1.1 anton 73:
1.8 anton 74: Variable udp \ user area size? -anton
1.1 anton 75:
76: AUser next-task main-task next-task !
77: AUser prev-task main-task prev-task !
78: AUser save-task 0 save-task !
1.10 crook 79: AUser sp0 ( -- a-addr ) \ gforth
80: \G USER VARIABLE: Initial value of the data stack pointer.
81: \ sp0 is used by douser:, must be user
82: ' sp0 Alias s0 ( -- a-addr ) \ gforth
83: \G OBSOLETE alias of @code{sp0}
84:
85: AUser rp0 ( -- a-addr ) \ gforth
86: \G USER VARIABLE: Initial value of the return stack pointer.
87: ' rp0 Alias r0 ( -- a-addr ) \ gforth
88: \G OBSOLETE alias of @code{rp0}
89:
90: AUser fp0 ( -- a-addr ) \ gforth
91: \G USER VARIABLE: Initial value of the floating-point stack pointer.
92: \ no f0, because this leads to unexpected results when using hex
93:
94: AUser lp0 ( -- a-addr ) \ gforth
95: \G USER VARIABLE: Initial value of the locals stack pointer.
96: ' lp0 Alias l0 ( -- a-addr ) \ gforth
97: \G OBSOLETE alias of @code{lp0}
98:
1.3 jwilke 99: AUser handler \ pointer to last throw frame
1.18 ! jwilke 100: has? backtrace [IF]
1.13 anton 101: User backtrace-empty \ true if the next THROW should store a backtrace
102: AUser backtrace-rp0 \ rp at last call of interpret
1.18 ! jwilke 103: [THEN]
1.1 anton 104: \ AUser output
105: \ AUser input
106:
107: AUser errorhandler
108:
109: AUser "error 0 "error !
110:
1.3 jwilke 111: [IFUNDEF] #tib \ in ec-Version we may define this ourself
112: User tibstack \ saves >tib in execute
113: User >tib \ pointer to terminal input buffer
1.10 crook 114: User #tib ( -- a-addr ) \ core-ext
1.17 crook 115: \G USER VARIABLE: @i{a-addr} is the address of a cell containing
1.10 crook 116: \G the number of characters in the terminal input buffer.
117: \G OBSOLESCENT: @code{source} superceeds the function of this word.
118:
119: User >in ( -- a-addr ) \ core
1.17 crook 120: \G USER VARIABLE: @i{a-addr} is the address of a cell containing the
121: \G char offset from the start of the input buffer to the start of the
122: \G parse area.
1.10 crook 123: 0 >in ! \ char number currently processed in tib
1.3 jwilke 124: [THEN]
1.7 pazsan 125: has? file [IF]
1.10 crook 126: User blk ( -- a-addr ) \ block
1.17 crook 127: \G USER VARIABLE: @i{a-addr} is the address of a cell containing zero
1.10 crook 128: \G (in which case the input source is not a block and can be identified
129: \G by @code{source-id}) or the number of the block currently being
130: \G interpreted. A Standard program should not alter @code{blk} directly.
131: 0 blk !
132:
1.1 anton 133: User loadfile 0 loadfile !
134:
135: User loadfilename# 0 loadfilename# !
136:
137: User loadline \ number of the currently interpreted
138: \ (in TIB) line if the interpretation
139: \ is in a textfile
140: \ the first line is 1
141:
142: 2User linestart \ starting file postition of
143: \ the current interpreted line (in TIB)
1.7 pazsan 144: [THEN]
1.1 anton 145:
1.10 crook 146: User base ( -- a-addr ) \ core
1.17 crook 147: \G USER VARIABLE: @i{a-addr} is the address of a cell that stores the
1.10 crook 148: \G number base used by default for number conversion during input and output.
149: A base !
1.17 crook 150: User dpl ( -- a-addr ) \ gforth
151: \G USER VARIABLE: @i{a-addr} is the address of a cell that stores the
152: \G position of the decimal point in the most recent numeric conversion.
153: \G Initialised to -1. After the conversion of a number containing no
154: \G decimal point, @code{@ dpl} is -1. After the conversion of @code{2.} it holds
155: \G 0. After the conversion of 234123.9 it contains 1, and so forth.
156: -1 dpl !
1.1 anton 157:
1.10 crook 158: User state ( -- a-addr ) \ core,tools-ext
1.17 crook 159: \G USER VARIABLE: @i{a-addr} is the address of a cell containing the
160: \G compilation state flag. 0 => interpreting, -1 => compiling. A
161: \G program shall not directly alter the value of @code{state}. The
162: \G following Standard words alter the value in @code{state}: @code{:}
163: \G (colon) @code{;} (semicolon) @code{abort} @code{quit}
164: \G @code{:noname} @code{[} (left-bracket) @code{]} (right-bracket)
165: \G @code{;code}. Don't use @code{state}! @xref{Interpretation and
166: \G Compilation Semantics} for an alternative.
167: \ Recommended reading: @cite{@code{State}-smartness--Why it is evil
168: \ and how to exorcise it},
169: \ @url{http://www.complang.tuwien.ac.at/papers/ertl98.ps.gz}; short
170: \ version: Don't use @code{state}!
171: 0 state !
1.10 crook 172:
1.1 anton 173: AUser normal-dp \ the usual dictionary pointer
174: AUser dpp normal-dp dpp !
175: \ the pointer to the current dictionary pointer
176: \ ist reset to normal-dp on (doerror)
177: \ (i.e. any throw caught by quit)
178: AUser LastCFA
179: AUser Last
180:
1.7 pazsan 181: has? glocals [IF]
1.1 anton 182: User locals-size \ this is the current size of the locals stack
183: \ frame of the current word
1.7 pazsan 184: [THEN]
1.1 anton 185:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>