reference.adoc

   1 = RRQFORTH Reference Documentation
   2 :author: Ralph Ronnquist <ralph.ronnquist@gmail.com>
   3
   4 == Compilation words
   5 // include::compile.adoc[]
   6 include::adoc/p_allot.adoc[]
   7 include::separator.adoc[]
   8 include::adoc/p_base.adoc[]
   9 include::separator.adoc[]
  10 include::adoc/p_Ccomma.adoc[]
  11 include::separator.adoc[]
  12 include::adoc/p_colon.adoc[]
  13 include::separator.adoc[]
  14 include::adoc/p_comma.adoc[]
  15 include::separator.adoc[]
  16 include::adoc/p_create.adoc[]
  17 include::separator.adoc[]
  18 include::adoc/p_decimal.adoc[]
  19 include::separator.adoc[]
  20 include::adoc/p_div.adoc[]
  21 include::separator.adoc[]
  22 include::adoc/p_does.adoc[]
  23 include::separator.adoc[]
  24 include::adoc/p_evaluate_stream.adoc[]
  25 include::separator.adoc[]
  26 include::adoc/p_here.adoc[]
  27 include::separator.adoc[]
  28 include::adoc/p_hex.adoc[]
  29 include::separator.adoc[]
  30 include::adoc/p_immediate.adoc[]
  31 include::separator.adoc[]
  32 include::adoc/p_left_bracket.adoc[]
  33 include::separator.adoc[]
  34 include::adoc/p_literal.adoc[]
  35 include::separator.adoc[]
  36 include::adoc/p_literal_string.adoc[]
  37 include::separator.adoc[]
  38 include::adoc/p_number.adoc[]
  39 include::separator.adoc[]
  40 include::adoc/p_quote.adoc[]
  41 include::separator.adoc[]
  42 include::adoc/p_right_bracket.adoc[]
  43 include::separator.adoc[]
  44 include::adoc/p_semicolon.adoc[]
  45 include::separator.adoc[]
  46 include::adoc/p_state.adoc[]
  47 include::separator.adoc[]
  48 include::adoc/p_this_word.adoc[]
  49
  50 //include::control.adoc[]
  51 include::adoc/p_0branch.adoc[]
  52 include::separator.adoc[]
  53 include::adoc/p_1branch.adoc[]
  54 include::separator.adoc[]
  55 include::adoc/p_begin.adoc[]
  56 include::separator.adoc[]
  57 include::adoc/p_branch.adoc[]
  58 include::separator.adoc[]
  59 include::adoc/p_else.adoc[]
  60 include::separator.adoc[]
  61 include::adoc/p_end.adoc[]
  62 include::separator.adoc[]
  63 include::adoc/p_if.adoc[]
  64 include::separator.adoc[]
  65 include::adoc/p_ifagain.adoc[]
  66 include::separator.adoc[]
  67 include::adoc/p_ifbreak.adoc[]
  68 include::separator.adoc[]
  69 include::adoc/p_then.adoc[]
  70
  71 == Logic operation words
  72 //include::logic.adoc[]
  73 include::adoc/p_0equal.adoc[]
  74 include::separator.adoc[]
  75 include::adoc/p_0less.adoc[]
  76 include::separator.adoc[]
  77 include::adoc/p_and.adoc[]
  78 include::separator.adoc[]
  79 include::adoc/p_equal.adoc[]
  80 include::separator.adoc[]
  81 include::adoc/p_false.adoc[]
  82 include::separator.adoc[]
  83 include::adoc/p_greaterequal.adoc[]
  84 include::separator.adoc[]
  85 include::adoc/p_greaterthan.adoc[]
  86 include::separator.adoc[]
  87 include::adoc/p_lessequal.adoc[]
  88 include::separator.adoc[]
  89 include::adoc/p_lessthan.adoc[]
  90 include::separator.adoc[]
  91 include::adoc/p_not.adoc[]
  92 include::separator.adoc[]
  93 include::adoc/p_or.adoc[]
  94 include::separator.adoc[]
  95 include::adoc/p_true.adoc[]
  96 include::separator.adoc[]
  97 include::adoc/p_unequal.adoc[]
  98 include::separator.adoc[]
  99 include::adoc/p_within.adoc[]
 100 include::separator.adoc[]
 101 include::adoc/p_xor.adoc[]
 102
 103 == Math operation words
 104 // include::math.adoc[]
 105 include::adoc/p_abs.adoc[]
 106 include::separator.adoc[]
 107 include::adoc/p_divmod.adoc[]
 108 include::separator.adoc[]
 109 include::adoc/p_minus.adoc[]
 110 include::separator.adoc[]
 111 include::adoc/p_mult.adoc[]
 112 include::separator.adoc[]
 113 include::adoc/p_negate.adoc[]
 114 include::separator.adoc[]
 115 include::adoc/p_plus.adoc[]
 116
 117 == RRQFORTH main words
 118 //include::rrqforth.adoc[]
 119 include::adoc/data_stack.adoc[]
 120 include::separator.adoc[]
 121 include::adoc/inline_code.adoc[]
 122 include::separator.adoc[]
 123 include::adoc/p_0branch.adoc[]
 124 include::separator.adoc[]
 125 include::adoc/p_args.adoc[]
 126 include::separator.adoc[]
 127 include::adoc/p_branch.adoc[]
 128 include::separator.adoc[]
 129 include::adoc/p_dodoes.adoc[]
 130 include::separator.adoc[]
 131 include::adoc/p_dofasm.adoc[]
 132 include::separator.adoc[]
 133 include::adoc/p_doforth.adoc[]
 134 include::separator.adoc[]
 135 include::adoc/p_dostring.adoc[]
 136 include::separator.adoc[]
 137 include::adoc/p_dovalue.adoc[]
 138 include::separator.adoc[]
 139 include::adoc/p_dovariable.adoc[]
 140 include::separator.adoc[]
 141 include::adoc/p_execute.adoc[]
 142 include::separator.adoc[]
 143 include::adoc/p_exit.adoc[]
 144 include::separator.adoc[]
 145 include::adoc/p_lparen.adoc[]
 146 include::separator.adoc[]
 147 include::adoc/p_program_version.adoc[]
 148 include::separator.adoc[]
 149 include::adoc/p_quit.adoc[]
 150 include::separator.adoc[]
 151 include::adoc/p_stdin.adoc[]
 152 include::separator.adoc[]
 153 include::adoc/p_system.adoc[]
 154 include::separator.adoc[]
 155 include::adoc/p_terminate0.adoc[]
 156 include::separator.adoc[]
 157 include::adoc/return_stack.adoc[]
 158
 159 == Stack operation words
 160 //include::stack.adoc[]
 161 include::adoc/p_2drop.adoc[]
 162 include::separator.adoc[]
 163 include::adoc/p_2dup.adoc[]
 164 include::separator.adoc[]
 165 include::adoc/p_2over.adoc[]
 166 include::separator.adoc[]
 167 include::adoc/p_2swap.adoc[]
 168 include::separator.adoc[]
 169 include::adoc/p_depth.adoc[]
 170 include::separator.adoc[]
 171 include::adoc/p_drop.adoc[]
 172 include::separator.adoc[]
 173 include::adoc/p_dup.adoc[]
 174 include::separator.adoc[]
 175 include::adoc/p_gtR.adoc[]
 176 include::separator.adoc[]
 177 include::adoc/p_nip.adoc[]
 178 include::separator.adoc[]
 179 include::adoc/p_over.adoc[]
 180 include::separator.adoc[]
 181 include::adoc/p_pick.adoc[]
 182 include::separator.adoc[]
 183 include::adoc/p_Rget.adoc[]
 184 include::separator.adoc[]
 185 include::adoc/p_Rgt.adoc[]
 186 include::separator.adoc[]
 187 include::adoc/p_roll.adoc[]
 188 include::separator.adoc[]
 189 include::adoc/p_rot.adoc[]
 190 include::separator.adoc[]
 191 include::adoc/p_swap.adoc[]
 192 include::separator.adoc[]
 193 include::adoc/p_tuck.adoc[]
 194
 195 == Input/output words
 196 //include::stdio.adoc[]
 197 include::adoc/p_clear_stream.adoc[]
 198 include::separator.adoc[]
 199 include::adoc/p_digits.adoc[]
 200 include::separator.adoc[]
 201 include::adoc/p_dot.adoc[]
 202 include::separator.adoc[]
 203 include::adoc/p_double_quote.adoc[]
 204 include::separator.adoc[]
 205 include::adoc/p_emit.adoc[]
 206 include::separator.adoc[]
 207 include::adoc/p_malloc.adoc[]
 208 include::separator.adoc[]
 209 include::adoc/p_nl.adoc[]
 210 include::separator.adoc[]
 211 include::adoc/p_pad.adoc[]
 212 include::separator.adoc[]
 213 include::adoc/p_read_stream_char.adoc[]
 214 include::separator.adoc[]
 215 include::adoc/p_read_word.adoc[]
 216 include::separator.adoc[]
 217 include::adoc/p_sp.adoc[]
 218 include::separator.adoc[]
 219 include::adoc/p_stream.adoc[]
 220 include::separator.adoc[]
 221 include::adoc/p_stream_nchars.adoc[]
 222 include::separator.adoc[]
 223 include::adoc/p_tell.adoc[]
 224
 225 == Wordlist words
 226 //include::wordlists.adoc[]
 227 include::adoc/p_current_wordlist.adoc[]
 228 include::separator.adoc[]
 229 include::adoc/p_find.adoc[]
 230 include::separator.adoc[]
 231 include::adoc/p_forth.adoc[]
 232 include::separator.adoc[]
 233 include::adoc/p_strncmp.adoc[]
 234 include::separator.adoc[]
 235 include::adoc/p_words.adoc[]
 236
 237 == System calls
 238 //include::syscalls.adoc[]
 239
 240 RRQFORTH includes function wrapping for all "Linux syscalls", which
 241 generally are described in their "man pages. This wrapping takes the
 242 arguments fro the data stack in reverse order, i.e. the first argument
 243 is deepest.
 244
 245 Use +SYSTEM WORDS+ to get a list of all (321) available syscalls.
 246
 247
 248 include::wordindex.adoc[]