amforth-devel

[Amforth-devel] "Help" word

[pito <pi...@vo...>]

Hi,
just as an inspiration - for people who use amforth with student for
education - in the FlashForth there is a nice worh "help" I like
(see ff36). You load the help and helpwords (~few kB) and:
help emit
emit    c --            Emit c to the serial port FIFO. FIFO is 46
chars. Execut
es pause.
ok<$,ram>
help rot
rot     x1 x2 x3 -- x2 x3 x1    Rotate three top stack items
ok<$,ram>
help cmove
cmove   addr1 addr2 u --        Move u chars from addr1 to addr2
ok<$,ram>
help tuck
tuck    x1 x2 -- x2 x1 x2       Insert x2 below x1 in the stack
ok<$,ram>

It fits to bigger atmegas.. P.

Re: [Amforth-devel] "Help" word

[Matthias T. <mt...@we...>]

Hi Pito,

> Hi,
> just as an inspiration - for people who use amforth with student for
> education - in the FlashForth there is a nice worh "help" I like
> (see ff36). You load the help and helpwords (~few kB) and:
> help emit
> emit    c --            Emit c to the serial port FIFO. FIFO is 46
> chars. Execut
> es pause.

smart idea. sound like a good target for the automatically
generated docu as well (just like the refcard and the html
pages).

> It fits to bigger atmegas.. P.

obviously ;=)

Matthias

Re: [Amforth-devel] "Help" word

[Matthias T. <mt...@we...>]

Pito,

> Hi,
> just as an inspiration - for people who use amforth with student for
> education - in the FlashForth there is a nice worh "help" I like
> (see ff36). You load the help and helpwords (~few kB) and:
> help emit

see repository: lib/help.frt and lib/help-words.frt.
the later will be automatically generated (later on)

\ small online help system

\ usage
\  help <word>
\ prints the stack effects and a short description 

\ requires words from dict_wl.inc

wordlist constant help-wl

: help
    bl word count
    help-wl search-wordlist
    if execute then
;


mt@ayla:~/projekte/Sourceforge/amforth/trunk/lib$ cat help-words.frt 

\ requires help
\ 

get-current
help-wl set-current

: emit 
  ." ( c -- ) "
  ." R:( -- ) "
  ." emits a single character on the terminal, calls pause" ;
  
: key 
  ." ( -- c ) "
  ." R: ( -- ) "
  ." waits for a key stroke, calls pause "
;


set-current


it uses a separate wordlist and if it finds a word there, it will
be executed. Not to be confused with the standard wordlists. One
should never add help-wl to the search-order ;=)

Again: great idea

Matthias

Re: [Amforth-devel] "Help" word

[pito <pi...@vo...>]

Matthias, YES I see now, you just updated the trunk\lib (i'm using
tortoiseSVN under xp)!! 
Thanks - So the next step is to start fill the help-words.frt, am I
right?
Pito.

Re: [Amforth-devel] "Help" word

[Matthias T. <mt...@we...>]

Hi,

> Matthias, YES I see now, you just updated the trunk\lib (i'm using
> tortoiseSVN under xp)!! 
> Thanks - So the next step is to start fill the help-words.frt, am I
> right?

Yes, absolutly. But I doubt that a automatically generated file
with _all_ words inside is really what we want. Its huge (a first
try gave me a 30KB file), its mostly redundant to the standard
(I dont think that standard words should be mentioned, at
least not those who are completly conforming to the standard) and
my comment headers are terribly bad.

There should be a smarter way do give help on the system itself..

Matthias

Re: [Amforth-devel] "Help" word

[pito <pi...@vo...>]

> There should be a smarter way do give help on the
> system itself..

A few years back I did as my first project on my brand new atari 520
a zif-lempel compression in 68k asm. It worked (Marcin hates this
words..)
... but this is just an another stupid idea. P.