reference.adoc

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