retroforth/interface/scripting.retro

75 lines
2.1 KiB
Forth
Raw Normal View History

# Scripting Support
This is the scripting interface words for use with retro-unix
or other interfaces providing device type 9 support.
## Rev. 0
The initial version of this I/O device provides support for some
basic interactions.
- obtaining the name of the script
- obtaining the number of arguments passed
- obtaining the arguments passed
- "including" a file (which has RETRO process the file as inuput)
## Rev. 1
In 2020.10, the device was extended to add support for new additional
introspection and control of the `include` process.
- obtaining the current file name
- obtaining the current line number
- direct RETRO to ignore the rest of the current line
- direct RETRO to ignore any remaining lines in the file
## Rev. 2
Adds support for `abort`.
## Rev. 3
Adds support for obtaining current source line text
# The Code
~~~
{{
:script:operation
DEVICE:SCRIPTING io:scan-for
dup n:negative? [ drop 'Error:_scripting_device_not_found s:put nl ] if;
io:invoke ;
---reveal---
:script:arguments (:-n) #0 script:operation ;
:script:get-argument (:n-s) s:empty swap #1 script:operation ;
:include (:s-) #2 script:operation ;
:script:name (:-s) s:empty #3 script:operation ;
:script:current-file (:-s) s:empty #4 script:operation ;
:script:current-line (:-n) #5 script:operation class:data ; immediate
:script:ignore-to-eol (:-) #6 script:operation ;
:script:abort-include (:-) #7 script:operation ;
:abort (:-) &Compiler v:off #8 script:operation ;
:script:current-line-text (:-s) s:empty [ #9 script:operation ] sip ;
}}
~~~
## d:source
~~~
'interface/scripting.retro
dup 'abort d:set-source
dup 'script:abort-include d:set-source
dup 'script:ignore-to-eol d:set-source
dup 'script:current-line d:set-source
dup 'script:current-file d:set-source
dup 'script:name d:set-source
dup 'include d:set-source
dup 'script:get-argument d:set-source
dup 'script:arguments d:set-source
dup 'script:current-line-text d:set-source
drop
~~~