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