reference.adoc

   1 = RRQFORTH Reference Documentation
   2 :author: Ralph Ronnquist <ralph.ronnquist@gmail.com>
   3 :plus: +
   4
   5 == Compilation words
   6 // include::compile.adoc[]
   7 include::adoc/p_allot.adoc[]
   8 include::adoc/p_base.adoc[]
   9 include::adoc/p_Ccomma.adoc[]
  10 include::adoc/p_colon.adoc[]
  11 include::adoc/p_comma.adoc[]
  12 include::adoc/p_create.adoc[]
  13 include::adoc/p_decimal.adoc[]
  14 include::adoc/p_div.adoc[]
  15 include::adoc/p_does.adoc[]
  16 include::adoc/p_evaluate_stream.adoc[]
  17 include::adoc/p_here.adoc[]
  18 include::adoc/p_hex.adoc[]
  19 include::adoc/p_immediate.adoc[]
  20 include::adoc/p_left_bracket.adoc[]
  21 include::adoc/p_literal.adoc[]
  22 include::adoc/p_literal_string.adoc[]
  23 include::adoc/p_number.adoc[]
  24 include::adoc/p_quote.adoc[]
  25 include::adoc/p_right_bracket.adoc[]
  26 include::adoc/p_semicolon.adoc[]
  27 include::adoc/p_state.adoc[]
  28 include::adoc/p_this_word.adoc[]
  29
  30 //include::control.adoc[]
  31 include::adoc/p_0branch.adoc[]
  32 include::adoc/p_1branch.adoc[]
  33 include::adoc/p_begin.adoc[]
  34 include::adoc/p_branch.adoc[]
  35 include::adoc/p_else.adoc[]
  36 include::adoc/p_end.adoc[]
  37 include::adoc/p_if.adoc[]
  38 include::adoc/p_ifagain.adoc[]
  39 include::adoc/p_ifbreak.adoc[]
  40 include::adoc/p_then.adoc[]
  41
  42 == Logic operation words
  43 //include::logic.adoc[]
  44 include::adoc/p_0equal.adoc[]
  45 include::adoc/p_0less.adoc[]
  46 include::adoc/p_and.adoc[]
  47 include::adoc/p_equal.adoc[]
  48 include::adoc/p_false.adoc[]
  49 include::adoc/p_greaterequal.adoc[]
  50 include::adoc/p_greaterthan.adoc[]
  51 include::adoc/p_lessequal.adoc[]
  52 include::adoc/p_lessthan.adoc[]
  53 include::adoc/p_not.adoc[]
  54 include::adoc/p_or.adoc[]
  55 include::adoc/p_true.adoc[]
  56 include::adoc/p_unequal.adoc[]
  57 include::adoc/p_within.adoc[]
  58 include::adoc/p_xor.adoc[]
  59
  60 == Math operation words
  61 // include::math.adoc[]
  62 include::adoc/p_abs.adoc[]
  63 include::adoc/p_divmod.adoc[]
  64 include::adoc/p_minus.adoc[]
  65 include::adoc/p_mult.adoc[]
  66 include::adoc/p_negate.adoc[]
  67 include::adoc/p_plus.adoc[]
  68
  69 == RRQFORTH main words
  70 //include::rrqforth.adoc[]
  71 include::adoc/data_stack.adoc[]
  72 include::adoc/inline_code.adoc[]
  73 include::adoc/p_0branch.adoc[]
  74 include::adoc/p_args.adoc[]
  75 include::adoc/p_branch.adoc[]
  76 include::adoc/p_dodoes.adoc[]
  77 include::adoc/p_dofasm.adoc[]
  78 include::adoc/p_doforth.adoc[]
  79 include::adoc/p_dostring.adoc[]
  80 include::adoc/p_dovalue.adoc[]
  81 include::adoc/p_dovariable.adoc[]
  82 include::adoc/p_execute.adoc[]
  83 include::adoc/p_exit.adoc[]
  84 include::adoc/p_lparen.adoc[]
  85 include::adoc/p_program_version.adoc[]
  86 include::adoc/p_quit.adoc[]
  87 include::adoc/p_stdin.adoc[]
  88 include::adoc/p_system.adoc[]
  89 include::adoc/p_terminate0.adoc[]
  90 include::adoc/return_stack.adoc[]
  91
  92 == Stack operation words
  93 //include::stack.adoc[]
  94 include::adoc/p_2drop.adoc[]
  95 include::adoc/p_2dup.adoc[]
  96 include::adoc/p_2over.adoc[]
  97 include::adoc/p_2swap.adoc[]
  98 include::adoc/p_depth.adoc[]
  99 include::adoc/p_drop.adoc[]
 100 include::adoc/p_dup.adoc[]
 101 include::adoc/p_gtR.adoc[]
 102 include::adoc/p_nip.adoc[]
 103 include::adoc/p_over.adoc[]
 104 include::adoc/p_pick.adoc[]
 105 include::adoc/p_Rget.adoc[]
 106 include::adoc/p_Rgt.adoc[]
 107 include::adoc/p_roll.adoc[]
 108 include::adoc/p_rot.adoc[]
 109 include::adoc/p_swap.adoc[]
 110 include::adoc/p_tuck.adoc[]
 111
 112 == Input/output words
 113 //include::stdio.adoc[]
 114 include::adoc/p_clear_stream.adoc[]
 115 include::adoc/p_digits.adoc[]
 116 include::adoc/p_dot.adoc[]
 117 include::adoc/p_double_quote.adoc[]
 118 include::adoc/p_emit.adoc[]
 119 include::adoc/p_malloc.adoc[]
 120 include::adoc/p_nl.adoc[]
 121 include::adoc/p_pad.adoc[]
 122 include::adoc/p_read_stream_char.adoc[]
 123 include::adoc/p_read_word.adoc[]
 124 include::adoc/p_sp.adoc[]
 125 include::adoc/p_stream.adoc[]
 126 include::adoc/p_stream_nchars.adoc[]
 127 include::adoc/p_tell.adoc[]
 128
 129 == Wordlist words
 130 //include::wordlists.adoc[]
 131 include::adoc/p_current_wordlist.adoc[]
 132 include::adoc/p_find.adoc[]
 133 include::adoc/p_forth.adoc[]
 134 include::adoc/p_strncmp.adoc[]
 135 include::adoc/p_words.adoc[]
 136
 137 == System calls
 138 //include::syscalls.adoc[]
 139
 140 RRQFORTH includes function wrapping for all "Linux syscalls", which
 141 generally are described in their "man pages. This wrapping takes the
 142 arguments fro the data stack in reverse order, i.e. the first argument
 143 is deepest.
 144
 145 Use +SYSTEM WORDS+ to get a list of all (321) available syscalls.
 146
 147
 148 include::wordindex.adoc[]