X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;f=reference.adoc;h=35455e56f5c3c07a063006a722605a6ba9b89ef6;hb=60057839785134cd60545fa503c31ab50d4056d2;hp=6237f826399003bc7f04ca9209e4c35b93d0e91f;hpb=f2b2acd5d5c79e2d65854eef7e23f7323bc6c4f2;p=rrq%2Frrqforth.git diff --git a/reference.adoc b/reference.adoc index 6237f82..35455e5 100644 --- a/reference.adoc +++ b/reference.adoc @@ -1,13 +1,69 @@ = RRQFORTH Reference Documentation :author: Ralph Ronnquist +:mult: * +:quote: " -== Compilation Words -// include::compile.adoc[] +include::wordindex.adoc[] + +== Word Descriptions + +include::adoc/inline_code.adoc[] +include::separator.adoc[] +include::adoc/p_0branch.adoc[] +include::separator.adoc[] +include::adoc/p_0equal.adoc[] +include::separator.adoc[] +include::adoc/p_0less.adoc[] +include::separator.adoc[] +include::adoc/p_1branch.adoc[] +include::separator.adoc[] +include::adoc/p_2drop.adoc[] +include::separator.adoc[] +include::adoc/p_2dup.adoc[] +include::separator.adoc[] +include::adoc/p_2get.adoc[] +include::separator.adoc[] +include::adoc/p_2over.adoc[] +include::separator.adoc[] +include::adoc/p_2put.adoc[] +include::separator.adoc[] +include::adoc/p_2swap.adoc[] +include::separator.adoc[] +include::adoc/p_Ccomma.adoc[] +include::separator.adoc[] +include::adoc/p_Cget.adoc[] +include::separator.adoc[] +include::adoc/p_Cput.adoc[] +include::separator.adoc[] +include::adoc/p_Rget.adoc[] +include::separator.adoc[] +include::adoc/p_Rgt.adoc[] +include::separator.adoc[] +include::adoc/p_abs.adoc[] +include::separator.adoc[] +include::adoc/p_again.adoc[] +include::separator.adoc[] include::adoc/p_allot.adoc[] include::separator.adoc[] +include::adoc/p_and.adoc[] +include::separator.adoc[] +include::adoc/p_args.adoc[] +include::separator.adoc[] include::adoc/p_base.adoc[] include::separator.adoc[] -include::adoc/p_Ccomma.adoc[] +include::adoc/p_begin.adoc[] +include::separator.adoc[] +include::adoc/p_bracketed_quote.adoc[] +include::separator.adoc[] +include::adoc/p_branch.adoc[] +include::separator.adoc[] +include::adoc/p_break.adoc[] +include::separator.adoc[] +include::adoc/p_calltrace.adoc[] +include::separator.adoc[] +include::adoc/p_cfa2flags_get.adoc[] +include::separator.adoc[] +include::adoc/p_clear_stream.adoc[] include::separator.adoc[] include::adoc/p_colon.adoc[] include::separator.adoc[] @@ -15,97 +71,113 @@ include::adoc/p_comma.adoc[] include::separator.adoc[] include::adoc/p_create.adoc[] include::separator.adoc[] -include::adoc/p_decimal.adoc[] +include::adoc/p_current_wordlist.adoc[] include::separator.adoc[] -include::adoc/p_div.adoc[] +include::adoc/data_stack.adoc[] include::separator.adoc[] -include::adoc/p_does.adoc[] +include::adoc/p_decimal.adoc[] include::separator.adoc[] -include::adoc/p_evaluate_stream.adoc[] +include::adoc/p_depth.adoc[] include::separator.adoc[] -include::adoc/p_here.adoc[] +include::adoc/p_dfa2tfa.adoc[] include::separator.adoc[] -include::adoc/p_hex.adoc[] +include::adoc/p_digits.adoc[] include::separator.adoc[] -include::adoc/p_immediate.adoc[] +include::adoc/p_div.adoc[] include::separator.adoc[] -include::adoc/p_left_bracket.adoc[] +include::adoc/p_divmod.adoc[] include::separator.adoc[] -include::adoc/p_literal.adoc[] +include::adoc/p_dodoes.adoc[] include::separator.adoc[] -include::adoc/p_literal_string.adoc[] +include::adoc/p_does.adoc[] include::separator.adoc[] -include::adoc/p_number.adoc[] +include::adoc/p_dofasm.adoc[] include::separator.adoc[] -include::adoc/p_quote.adoc[] +include::adoc/p_doforth.adoc[] include::separator.adoc[] -include::adoc/p_right_bracket.adoc[] +include::adoc/p_dostring.adoc[] include::separator.adoc[] -include::adoc/p_semicolon.adoc[] +include::adoc/p_dot.adoc[] include::separator.adoc[] -include::adoc/p_state.adoc[] +include::adoc/p_double_quote.adoc[] include::separator.adoc[] -include::adoc/p_this_word.adoc[] - -== Execution Control Words -//include::control.adoc[] -include::adoc/p_0branch.adoc[] +include::adoc/p_dovalue.adoc[] include::separator.adoc[] -include::adoc/p_1branch.adoc[] +include::adoc/p_dovariable.adoc[] include::separator.adoc[] -include::adoc/p_begin.adoc[] +include::adoc/p_drop.adoc[] include::separator.adoc[] -include::adoc/p_branch.adoc[] +include::adoc/p_dup.adoc[] include::separator.adoc[] include::adoc/p_else.adoc[] include::separator.adoc[] +include::adoc/p_emit.adoc[] +include::separator.adoc[] include::adoc/p_end.adoc[] include::separator.adoc[] -include::adoc/p_if.adoc[] +include::adoc/p_equal.adoc[] include::separator.adoc[] -include::adoc/p_ifagain.adoc[] +include::adoc/p_erase.adoc[] include::separator.adoc[] -include::adoc/p_ifbreak.adoc[] +include::adoc/p_evaluate_stream.adoc[] include::separator.adoc[] -include::adoc/p_then.adoc[] - -== Logic Operation Words -//include::logic.adoc[] -include::adoc/p_0equal.adoc[] +include::adoc/p_execute.adoc[] include::separator.adoc[] -include::adoc/p_0less.adoc[] +include::adoc/p_exit.adoc[] include::separator.adoc[] -include::adoc/p_and.adoc[] +include::adoc/p_false.adoc[] include::separator.adoc[] -include::adoc/p_equal.adoc[] +include::adoc/p_fdemit.adoc[] include::separator.adoc[] -include::adoc/p_false.adoc[] +include::adoc/p_fdtell.adoc[] +include::separator.adoc[] +include::adoc/p_find.adoc[] +include::separator.adoc[] +include::adoc/p_forth.adoc[] +include::separator.adoc[] +include::adoc/p_get.adoc[] +include::separator.adoc[] +include::adoc/p_get_n_decrement.adoc[] +include::separator.adoc[] +include::adoc/p_get_n_increment.adoc[] include::separator.adoc[] include::adoc/p_greaterequal.adoc[] include::separator.adoc[] include::adoc/p_greaterthan.adoc[] include::separator.adoc[] +include::adoc/p_gtR.adoc[] +include::separator.adoc[] +include::adoc/p_here.adoc[] +include::separator.adoc[] +include::adoc/p_hex.adoc[] +include::separator.adoc[] +include::adoc/p_if.adoc[] +include::separator.adoc[] +include::adoc/p_ifagain.adoc[] +include::separator.adoc[] +include::adoc/p_ifbreak.adoc[] +include::separator.adoc[] +include::adoc/p_immediate.adoc[] +include::separator.adoc[] +include::adoc/p_input.adoc[] +include::separator.adoc[] +include::adoc/p_left_bracket.adoc[] +include::separator.adoc[] include::adoc/p_lessequal.adoc[] include::separator.adoc[] include::adoc/p_lessthan.adoc[] include::separator.adoc[] -include::adoc/p_not.adoc[] -include::separator.adoc[] -include::adoc/p_or.adoc[] +include::adoc/p_literal.adoc[] include::separator.adoc[] -include::adoc/p_true.adoc[] +include::adoc/p_literal_string.adoc[] include::separator.adoc[] -include::adoc/p_unequal.adoc[] +include::adoc/p_load_buffer_size.adoc[] include::separator.adoc[] -include::adoc/p_within.adoc[] +include::adoc/p_load_file.adoc[] include::separator.adoc[] -include::adoc/p_xor.adoc[] - -== Math Operation Words -// include::math.adoc[] -include::adoc/p_abs.adoc[] +include::adoc/p_lparen.adoc[] include::separator.adoc[] -include::adoc/p_divmod.adoc[] +include::adoc/p_malloc.adoc[] include::separator.adoc[] include::adoc/p_minus.adoc[] include::separator.adoc[] @@ -113,129 +185,115 @@ include::adoc/p_mult.adoc[] include::separator.adoc[] include::adoc/p_negate.adoc[] include::separator.adoc[] -include::adoc/p_plus.adoc[] - -== RRQFORTH Main Words -//include::rrqforth.adoc[] -include::adoc/data_stack.adoc[] +include::adoc/p_nip.adoc[] include::separator.adoc[] -include::adoc/inline_code.adoc[] +include::adoc/p_nl.adoc[] include::separator.adoc[] -include::adoc/p_args.adoc[] +include::adoc/p_not.adoc[] include::separator.adoc[] -include::adoc/p_dodoes.adoc[] +include::adoc/p_number.adoc[] include::separator.adoc[] -include::adoc/p_dofasm.adoc[] +include::adoc/p_open_file.adoc[] include::separator.adoc[] -include::adoc/p_doforth.adoc[] +include::adoc/p_or.adoc[] include::separator.adoc[] -include::adoc/p_dostring.adoc[] +include::adoc/p_over.adoc[] include::separator.adoc[] -include::adoc/p_dovalue.adoc[] +include::adoc/p_pad.adoc[] include::separator.adoc[] -include::adoc/p_dovariable.adoc[] +include::adoc/p_pick.adoc[] include::separator.adoc[] -include::adoc/p_execute.adoc[] +include::adoc/p_plus.adoc[] include::separator.adoc[] -include::adoc/p_exit.adoc[] +include::adoc/p_program_version.adoc[] include::separator.adoc[] -include::adoc/p_lparen.adoc[] +include::adoc/p_put.adoc[] include::separator.adoc[] -include::adoc/p_program_version.adoc[] +include::adoc/p_put_plus.adoc[] include::separator.adoc[] include::adoc/p_quit.adoc[] include::separator.adoc[] -include::adoc/p_stdin.adoc[] -include::separator.adoc[] -include::adoc/p_system.adoc[] +include::adoc/p_quote.adoc[] include::separator.adoc[] -include::adoc/p_terminate0.adoc[] +include::adoc/p_rbp.adoc[] include::separator.adoc[] -include::adoc/return_stack.adoc[] - -== Stack operation words -//include::stack.adoc[] -include::adoc/p_2drop.adoc[] +include::adoc/p_rbpn.adoc[] include::separator.adoc[] -include::adoc/p_2dup.adoc[] +include::adoc/p_read_stream_char.adoc[] include::separator.adoc[] -include::adoc/p_2over.adoc[] +include::adoc/p_read_word.adoc[] include::separator.adoc[] -include::adoc/p_2swap.adoc[] +include::adoc/p_realloc.adoc[] include::separator.adoc[] -include::adoc/p_depth.adoc[] +include::adoc/p_right_bracket.adoc[] include::separator.adoc[] -include::adoc/p_drop.adoc[] +include::adoc/p_roll.adoc[] include::separator.adoc[] -include::adoc/p_dup.adoc[] +include::adoc/p_rot.adoc[] include::separator.adoc[] -include::adoc/p_gtR.adoc[] +include::adoc/p_semicolon.adoc[] include::separator.adoc[] -include::adoc/p_nip.adoc[] +include::adoc/p_setup_signals.adoc[] include::separator.adoc[] -include::adoc/p_over.adoc[] +include::adoc/p_shift_left.adoc[] include::separator.adoc[] -include::adoc/p_pick.adoc[] +include::adoc/p_shift_right.adoc[] include::separator.adoc[] -include::adoc/p_Rget.adoc[] +include::adoc/p_shift_signed_right.adoc[] include::separator.adoc[] -include::adoc/p_Rgt.adoc[] +include::adoc/p_sp.adoc[] include::separator.adoc[] -include::adoc/p_roll.adoc[] +include::adoc/p_state.adoc[] include::separator.adoc[] -include::adoc/p_rot.adoc[] +include::adoc/p_stdin.adoc[] include::separator.adoc[] -include::adoc/p_swap.adoc[] +include::adoc/p_stream.adoc[] include::separator.adoc[] -include::adoc/p_tuck.adoc[] - -== Input/output words -//include::stdio.adoc[] -include::adoc/p_clear_stream.adoc[] +include::adoc/p_stream_nchars.adoc[] include::separator.adoc[] -include::adoc/p_digits.adoc[] +include::adoc/p_strlen.adoc[] include::separator.adoc[] -include::adoc/p_dot.adoc[] +include::adoc/p_strncmp.adoc[] include::separator.adoc[] -include::adoc/p_double_quote.adoc[] +include::adoc/p_strncpy.adoc[] include::separator.adoc[] -include::adoc/p_emit.adoc[] +include::adoc/p_swap.adoc[] include::separator.adoc[] -include::adoc/p_malloc.adoc[] +include::adoc/p_system.adoc[] include::separator.adoc[] -include::adoc/p_nl.adoc[] +include::adoc/p_tell.adoc[] include::separator.adoc[] -include::adoc/p_pad.adoc[] +include::adoc/p_terminate0.adoc[] include::separator.adoc[] -include::adoc/p_read_stream_char.adoc[] +include::adoc/p_tfa2cfa.adoc[] include::separator.adoc[] -include::adoc/p_read_word.adoc[] +include::adoc/p_tfa2dfa.adoc[] include::separator.adoc[] -include::adoc/p_realloc.adoc[] +include::adoc/p_tfa2flags_get.adoc[] include::separator.adoc[] -include::adoc/p_sp.adoc[] +include::adoc/p_tfa2namez.adoc[] include::separator.adoc[] -include::adoc/p_stream.adoc[] +include::adoc/p_then.adoc[] include::separator.adoc[] -include::adoc/p_stream_nchars.adoc[] +include::adoc/p_this_word.adoc[] include::separator.adoc[] -include::adoc/p_tell.adoc[] - -== Wordlist words -//include::wordlists.adoc[] -include::adoc/p_current_wordlist.adoc[] +include::adoc/p_true.adoc[] include::separator.adoc[] -include::adoc/p_find.adoc[] +include::adoc/p_tuck.adoc[] include::separator.adoc[] -include::adoc/p_forth.adoc[] +include::adoc/p_unequal.adoc[] include::separator.adoc[] -include::adoc/p_strlen.adoc[] +include::adoc/p_unstream.adoc[] include::separator.adoc[] -include::adoc/p_strncmp.adoc[] +include::adoc/p_verboseQ.adoc[] include::separator.adoc[] -include::adoc/p_strncpy.adoc[] +include::adoc/p_within.adoc[] include::separator.adoc[] include::adoc/p_words.adoc[] +include::separator.adoc[] +include::adoc/p_xor.adoc[] +include::separator.adoc[] +include::adoc/return_stack.adoc[] == System calls //include::syscalls.adoc[] @@ -246,6 +304,3 @@ arguments fro the data stack in reverse order, i.e. the first argument is deepest. Use +SYSTEM WORDS+ to get a list of all (321) available syscalls. - - -include::wordindex.adoc[]