Annotation of gforth/kernel/vars.fs, revision 1.47
1.1 anton 1: \ VARS.FS Kernal variables
2:
1.46 anton 3: \ Copyright (C) 1995,1996,1997,1998,2000,2003,2006,2007 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
1.47 ! anton 9: \ as published by the Free Software Foundation, either version 3
1.1 anton 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
1.47 ! anton 18: \ along with this program. If not, see http://www.gnu.org/licenses/.
1.1 anton 19:
20: hex \ everything now hex! 11may93jaw
21:
22: \ important constants 17dec92py
23:
24: \ dpANS6 (sect 3.1.3.1) says
25: \ "a true flag ... [is] a single-cell value with all bits set"
26: \ better definition: 0 0= constant true ( no dependence on 2's compl)
1.10 crook 27: -1 Constant true ( -- f ) \ core-ext
1.19 crook 28: \G @code{Constant} -- @i{f} is a cell with all bits set.
1.10 crook 29: \ see starts looking for primitives after this word!
30:
31: 0 Constant false ( -- f ) \ core-ext
1.19 crook 32: \G @code{Constant} -- @i{f} is a cell with all bits clear.
1.1 anton 33:
1.16 jwilke 34: [IFUNDEF] cell
1.1 anton 35: 1 cells Constant cell ( -- u ) \ gforth
1.22 anton 36: \G @code{Constant} -- @code{1 cells}
1.16 jwilke 37: [THEN]
1.17 crook 38:
1.25 pazsan 39: has? floating [IF]
1.1 anton 40: 1 floats Constant float ( -- u ) \ gforth
1.19 crook 41: \G @code{Constant} -- the number of address units corresponding to a floating-point number.
1.25 pazsan 42: [THEN]
1.1 anton 43:
1.20 crook 44: 20 Constant bl ( -- c-char ) \ core b-l
1.17 crook 45: \G @i{c-char} is the character value for a space.
1.10 crook 46: \ used by docon:, must be constant
1.1 anton 47:
1.42 pazsan 48: has? EC [IF] 40 [ELSE] FF [THEN] Constant /line
1.1 anton 49:
1.39 pazsan 50: has? file [IF]
1.1 anton 51: 40 Constant c/l
52: 10 Constant l/s
53: 400 Constant chars/block
1.38 pazsan 54: [THEN]
1.1 anton 55:
1.18 jwilke 56: 20 8 2* cells + 2 + cell+ constant word-pno-size ( -- u )
1.40 pazsan 57:
58: has? EC 0= [IF]
1.11 anton 59: create holdbuf word-pno-size chars allot
60: holdbuf word-pno-size chars + aconstant holdbuf-end
61: avariable holdptr holdbuf-end holdptr a!
1.12 anton 62: avariable holdend holdbuf-end holdend a!
1.40 pazsan 63: [THEN]
1.11 anton 64:
1.2 anton 65: 84 constant pad-minsize ( -- u )
1.11 anton 66:
1.25 pazsan 67: $400 Value def#tib
68: \G default size of terminal input buffer. Default size is 1K
1.2 anton 69:
1.1 anton 70: \ that's enough so long
71:
72: \ User variables 13feb93py
73:
74: \ initialized by COLD
75:
1.38 pazsan 76: has? no-userspace 0= [IF]
1.35 jwilke 77: Create main-task has? OS [IF] 100 [ELSE] 40 [THEN] cells dup allot
1.3 jwilke 78:
79: \ set user-pointer from cross-compiler right
80: main-task
1.35 jwilke 81: UNLOCK swap region user-region user-region setup-region LOCK
1.1 anton 82:
1.19 crook 83: Variable udp ( -- a-addr ) \ gforth
1.28 pazsan 84: \G user area size
1.1 anton 85:
86: AUser next-task main-task next-task !
87: AUser prev-task main-task prev-task !
88: AUser save-task 0 save-task !
1.38 pazsan 89: [THEN]
1.10 crook 90: AUser sp0 ( -- a-addr ) \ gforth
1.19 crook 91: \G @code{User} variable -- initial value of the data stack pointer.
1.10 crook 92: \ sp0 is used by douser:, must be user
1.38 pazsan 93: \ ' sp0 Alias s0 ( -- a-addr ) \ gforth
1.10 crook 94: \G OBSOLETE alias of @code{sp0}
95:
96: AUser rp0 ( -- a-addr ) \ gforth
1.19 crook 97: \G @code{User} variable -- initial value of the return stack pointer.
1.38 pazsan 98: \ ' rp0 Alias r0 ( -- a-addr ) \ gforth
1.10 crook 99: \G OBSOLETE alias of @code{rp0}
100:
1.25 pazsan 101: has? floating [IF]
1.10 crook 102: AUser fp0 ( -- a-addr ) \ gforth
1.19 crook 103: \G @code{User} variable -- initial value of the floating-point stack pointer.
1.10 crook 104: \ no f0, because this leads to unexpected results when using hex
1.25 pazsan 105: [THEN]
1.10 crook 106:
1.25 pazsan 107: has? glocals [IF]
1.10 crook 108: AUser lp0 ( -- a-addr ) \ gforth
1.19 crook 109: \G @code{User} variable -- initial value of the locals stack pointer.
1.38 pazsan 110: \ ' lp0 Alias l0 ( -- a-addr ) \ gforth
1.10 crook 111: \G OBSOLETE alias of @code{lp0}
1.25 pazsan 112: [THEN]
1.10 crook 113:
1.3 jwilke 114: AUser handler \ pointer to last throw frame
1.18 jwilke 115: has? backtrace [IF]
1.13 anton 116: AUser backtrace-rp0 \ rp at last call of interpret
1.18 jwilke 117: [THEN]
1.1 anton 118: \ AUser output
119: \ AUser input
120:
121: AUser errorhandler
122:
123: AUser "error 0 "error !
124:
1.25 pazsan 125: has? new-input [IF]
126: User current-input
127: [ELSE]
128: [IFUNDEF] #tib \ in ec-Version we may define this ourself
129: User tibstack \ saves >tib in execute
130: User >tib \ pointer to terminal input buffer
131: User #tib ( -- a-addr ) \ core-ext number-t-i-b
132: \G @code{User} variable -- @i{a-addr} is the address of a cell containing
133: \G the number of characters in the terminal input buffer.
134: \G OBSOLESCENT: @code{source} superceeds the function of this word.
135:
136: User >in ( -- a-addr ) \ core to-in
137: \G @code{User} variable -- @i{a-addr} is the address of a cell containing the
138: \G char offset from the start of the input buffer to the start of the
139: \G parse area.
140: 0 >in ! \ char number currently processed in tib
141: [THEN]
142:
1.7 pazsan 143: has? file [IF]
1.20 crook 144: User blk ( -- a-addr ) \ block b-l-k
1.19 crook 145: \G @code{User} variable -- @i{a-addr} is the address of a cell containing zero
1.10 crook 146: \G (in which case the input source is not a block and can be identified
147: \G by @code{source-id}) or the number of the block currently being
148: \G interpreted. A Standard program should not alter @code{blk} directly.
149: 0 blk !
150:
1.1 anton 151: User loadfile 0 loadfile !
152:
1.32 anton 153: 2user loadfilename 0 0 loadfilename 2! \ addr u for sourcefilename
1.37 anton 154:
1.1 anton 155: User loadline \ number of the currently interpreted
156: \ (in TIB) line if the interpretation
157: \ is in a textfile
158: \ the first line is 1
159:
160: 2User linestart \ starting file postition of
161: \ the current interpreted line (in TIB)
1.25 pazsan 162: [THEN]
1.7 pazsan 163: [THEN]
1.37 anton 164:
165: 2user includefilename 0 0 includefilename 2! \ innermost included file
166:
1.1 anton 167:
1.26 anton 168: User base ( -- a-addr ) \ core
1.45 anton 169: \G @code{User} variable -- @i{a-addr} is the address of a cell that
170: \G stores the number base used by default for number conversion during
171: \G input and output. Don't store to @code{base}, use
172: \G @code{base-execute} instead.
1.26 anton 173: A base !
174: User dpl ( -- a-addr ) \ gforth
175: \G @code{User} variable -- @i{a-addr} is the address of a cell that stores the
176: \G position of the decimal point in the most recent numeric conversion.
177: \G Initialised to -1. After the conversion of a number containing no
1.36 anton 178: \G decimal point, @code{dpl} is -1. After the conversion of @code{2.} it holds
1.26 anton 179: \G 0. After the conversion of 234123.9 it contains 1, and so forth.
180: -1 dpl !
1.1 anton 181:
1.26 anton 182: User state ( -- a-addr ) \ core,tools-ext
183: \G @code{User} variable -- @i{a-addr} is the address of a cell
184: \G containing the compilation state flag. 0 => interpreting, -1 =>
185: \G compiling. A program shall not directly alter the value of
186: \G @code{state}. The following Standard words alter the value in
187: \G @code{state}: @code{:} (colon) @code{;} (semicolon) @code{abort}
188: \G @code{quit} @code{:noname} @code{[} (left-bracket) @code{]}
189: \G (right-bracket) @code{;code}. Don't use @code{state}! For an
190: \G alternative see @ref{Interpretation and Compilation Semantics}.
191: \ Recommended reading: @cite{@code{State}-smartness--Why it is evil
192: \ and how to exorcise it},
193: \ @url{http://www.complang.tuwien.ac.at/papers/ertl98.ps.gz}; short
194: \ version: Don't use @code{state}!
195: 0 state !
1.10 crook 196:
1.1 anton 197: AUser normal-dp \ the usual dictionary pointer
198: AUser dpp normal-dp dpp !
199: \ the pointer to the current dictionary pointer
200: \ ist reset to normal-dp on (doerror)
201: \ (i.e. any throw caught by quit)
202: AUser LastCFA
203: AUser Last
1.26 anton 204:
1.41 pazsan 205: has? flash [IF]
206: AUser flash-dp
207: : rom flash-dp dpp ! ;
208: : ram normal-dp dpp ! ;
209: [THEN]
210:
1.33 anton 211: User max-name-length \ maximum length of all names defined yet
212: 32 max-name-length !
213:
214: \ has? peephole [IF]
215: \ 0 value peeptable \ initialized in boot
216: \ [THEN]
1.1 anton 217:
1.7 pazsan 218: has? glocals [IF]
1.1 anton 219: User locals-size \ this is the current size of the locals stack
220: \ frame of the current word
1.7 pazsan 221: [THEN]
1.1 anton 222:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to vars.fs CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth / kernel